详解使用IntelliJ IDEA新建Java Web后端resfulAPI模板

初始化项目

打开intellij idea，我的版本是version 2018.1.4。点击create new project。在左侧的列表中选择maven。然后在右侧勾选create from archetype。

然后在右侧的列表中选择org.apache.maven.archetypes:maven-archetype-webapp。点击next。

填写groupid和artifactid。groupid定义了项目属于哪个组织，例如，我们需要使用一个包，名字叫做fastjson，用户在项目中返回json数据的，是阿里的开源框架，被不少企业使用，是一个极其优秀的json框架。它的groupid是com.alibaba，artifactid是fastjson。

简单理解一下，拿github举个例子。groupid就相当于是你的用户名，而artifactid就相当于是你的具体某个项目的名称，也是我们当前的项目的根目录名称。例子如下。

groupid: com.detectivehlh.test
artifactid: testdemo

点击next，下两页不用设置，直接点击next。此时新建项目成功，右下角会弹出一个提示框，上面写着maven projects need to be imported.此时选择enable auto-import。就可以看到项目开始自动的去加载依赖包了。加载完成之后，项目会多出一个src目录。

引入jersey和servlet

打开根目录下pom.xml文件，在dependencies标签中添加如下代码，引入servlet。

<dependency>
 <groupid>org.glassfish.jersey.containers</groupid>
 <artifactid>jersey-container-servlet</artifactid>
 <version>2.22.2</version>
</dependency>

打开/src/main/webapp/web_inf/web.xml。在web-app标签之间添加如下代码。

<servlet>
 <servlet-name>jax-rs servlet</servlet-name>
 <servlet-class>org.glassfish.jersey.servlet.servletcontainer</servlet-class>
 <init-param>
  <param-name>jersey.config.server.provider.packages</param-name>
  <param-value>com.detectivehlh.test</param-value>
 </init-param>
 <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
 <servlet-name>jax-rs servlet</servlet-name>
 <url-pattern>/api/*</url-pattern>
</servlet-mapping>

新建项目目录和文件

在/src/main目录下新建java、resources目录，java放项目java源代码，resources放项目的静态资源文件。

打开file中的project structure，或者使用快捷键，command + ;就可以快捷打开了。将刚刚创建的名为java目录设置为sources，resources设置为resources。然后apply。然后在java目录下依次新建com.detectivehlh.test三个包，就是我们的groupid.

然后在com.detectivehlh.test中新建hello类。代码如下。

package com.detectivehlh.test;

import com.alibaba.fastjson.jsonobject;

import javax.ws.rs.get;
import javax.ws.rs.path;
import javax.ws.rs.produces;
import javax.ws.rs.core.mediatype;
import javax.ws.rs.core.response;
import java.util.arraylist;
import java.util.list;

@path("/hello")
public class hello {
 @path("get")
 @get
 @produces(mediatype.application_json)
 public response getstudent() {
  list<student> lists = new arraylist<student>();
  lists.add(new student("1","mayun",23));
  lists.add(new student("2","mahuateng",24));
  lists.add(new student("3","zhouhongyi",25));
  jsonobject json = new jsonobject();
  return response.status(response.status.ok).entity(json.tojsonstring(lists)).build();
 }
}

同样的地方新建student类。代码如下。

package com.detectivehlh.test;

public class student {
 private string id;
 private string name;
 private int age;

 public student(string id, string name, int age) {
  this.id = id;
  this.name = name;
  this.age = age;
 }

 public string getid() {
  return id;
 }
 public void setid(string id) {
  this.id = id;
 }
 public string getname() {
  return name;
 }
 public void setname(string name) {
  this.name = name;
 }
}

引入fastjson

这个时候可以看到，hello的class中有报错。是因为没有在pom.xml中没有引入对fastjson的依赖。在根目录下的pom.xml中添加如下依赖。

<dependency>
 <groupid>com.alibaba</groupid>
 <artifactid>fastjson</artifactid>
 <version>1.2.21</version>
</dependency>

再回到hello中就可以看到没有错误信息了。

配置tomcat

选择顶部菜单栏中的run->edit configurations。点击左侧的+，选择tomcat server->local。配置好tomcat后，选择server旁边的deployment标签，点击下方的+，选择artifact，选择testdemo:war exploded。点击apply。然后点击右上角的长得像播放键的按钮，启动项目。

就可以看到会新建一个浏览器标签页。显示"hello world!"，然后改变浏览器中的路由为我们写的接口的路由，/api/hello/get。就可以看到返回的json数据了。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。