RESTEasy CRUD教程
最后修改于 2023 年 1 月 10 日
RESTEasy CRUD教程展示了如何使用RESTEasy创建JAX-RS CRUD示例。
RESTEasy
RESTEasy 是一个用于开发RESTful Web服务的Java框架。它是JAX-RS 2.0规范的一个完全认证且可移植的实现。JAX-RS 2.0规范是Java社区进程（JCP）的一项规范，它为HTTP协议上的RESTful Web服务提供了一个Java API。
RESTEasy可以在任何Servlet容器中运行。
JAX-RS HTTP注解
JAX-RS拥有用于响应HTTP请求的注解。
- @GET - 表示被注解的方法响应HTTP GET请求
- @POST - 表示被注解的方法响应HTTP POST请求
- @DELETE - 表示被注解的方法响应HTTP DELETE请求
- @PUT - 表示被注解的方法响应HTTP PUT请求
RESTEasy CRUD示例
下面的例子是一个简单的RESTful CRUD应用程序。 创建、读取、更新和删除（CRUD） 是持久化存储的四个基本功能。
数据在应用程序启动时通过Web监听器加载。有两个脚本：schema.sql创建表，data.sql向表中插入数据。
$ tree
.
├── nb-configuration.xml
├── pom.xml
└── src
├── main
│ ├── java
│ │ └── com
│ │ └── zetcode
│ │ ├── conf
│ │ │ ├── AppConfig.java
│ │ │ └── MyAppInitializer.java
│ │ ├── dao
│ │ │ ├── CityDao.java
│ │ │ └── ICityDao.java
│ │ ├── model
│ │ │ └── City.java
│ │ ├── resource
│ │ │ └── MyResource.java
│ │ └── service
│ │ ├── CityService.java
│ │ └── ICityService.java
│ ├── resources
│ │ └── sql
│ │ ├── data.sql
│ │ └── schema.sql
│ └── webapp
│ ├── META-INF
│ │ └── context.xml
│ └── WEB-INF
│ └── beans.xml
└── test
└── java
这是项目结构。
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.zetcode</groupId>
<artifactId>RestEasyLoadScripts</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>RestEasyLoadScripts</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
</properties>
<dependencies>
<!-- Set up RESTEasy-->
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jaxrs</artifactId>
<version>3.1.4.Final</version>
</dependency>
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-servlet-initializer</artifactId>
<version>3.1.4.Final</version>
</dependency>
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-jackson-provider</artifactId>
<version>3.1.4.Final</version>
</dependency>
<!-- CDI for RESTEasy-->
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-cdi</artifactId>
<version>3.1.4.Final</version>
</dependency>
<dependency>
<groupId>org.jboss.weld.servlet</groupId>
<artifactId>weld-servlet-shaded</artifactId>
<version>3.0.2.Final</version>
</dependency>
<!-- Spring JdbcTemplate -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.0.3.RELEASE</version>
</dependency>
<!-- H2 driver -->
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.4.196</version>
</dependency>
<!-- Needed for @WebListener -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.3</version>
<configuration>
<failOnMissingWebXml>false</failOnMissingWebXml>
</configuration>
</plugin>
</plugins>
</build>
</project>
这是Maven的POM文件。它包含了RESTEasy、CDI for RESTEasy、Jackson Provider、H2驱动、Spring JdbcTemplate以及Java Servlets（用于Web监听器）的依赖。
context.xml
<?xml version="1.0" encoding="UTF-8"?> <Context path="/RestEasyCrud"/>
在 Tomcat 的 context.xml 配置文件中，我们定义了应用的上下文路径。
beans.xml
<?xml version="1.0"?>
<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://xmlns.jcp.org/xml/ns/javaee/beans_1_1.xsd"
version="1.1" bean-discovery-mode="all">
</beans>
使用CDI的应用程序必须有一个定义的beans.xml文件。它可以是空的，就像我们的例子一样。对于Web应用程序，beans.xml文件必须位于WEB-INF目录下。对于EJB模块或JAR文件，beans.xml文件必须位于META-INF目录下。
schema.sql
CREATE TABLE cities(id INT PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(100), population INT);
schema.sql创建了一个数据库模式。
data.sql
INSERT INTO cities(name, population) VALUES('Bratislava', 432000);
INSERT INTO cities(name, population) VALUES('Budapest', 1759000);
INSERT INTO cities(name, population) VALUES('Prague', 1280000);
INSERT INTO cities(name, population) VALUES('Warsaw', 1748000);
INSERT INTO cities(name, population) VALUES('Los Angeles', 3971000);
INSERT INTO cities(name, population) VALUES('New York', 8550000);
INSERT INTO cities(name, population) VALUES('Edinburgh', 464000);
INSERT INTO cities(name, population) VALUES('Berlin', 3671000);
data.sql向数据库表中插入数据。
AppConfig.java
package com.zetcode.conf;
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;
@ApplicationPath("rest")
public class AppConfig extends Application {
}
这是应用程序配置类。Application 定义了 JAX-RS 应用程序的组件并提供额外的元数据。
@ApplicationPath("rest")
使用 @ApplicationPath 注解，我们设置了 RESTful Web 服务的路径。
MyAppInitializer.java
package com.zetcode.conf;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
import org.springframework.jdbc.datasource.SimpleDriverDataSource;
@WebListener
public class MyAppInitializer implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent sce) {
Logger lgr = Logger.getLogger(MyAppInitializer.class.getName());
lgr.log(Level.INFO, "executing contextInitialized()");
String url = "jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1;"
+ "INIT=RUNSCRIPT FROM 'classpath:/sql/schema.sql'"
+ "\\;RUNSCRIPT FROM 'classpath:/sql/data.sql'";
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl(url);
try (Connection con = ds.getConnection()) {
} catch (SQLException ex) {
lgr.log(Level.SEVERE, ex.getMessage(), ex);
}
}
@Override
public void contextDestroyed(ServletContextEvent sce) {
}
}
数据库脚本在Web监听器中进行初始化。
@WebListener
public class MyAppInitializer implements ServletContextListener {
@WebListener注解用于声明一个Web监听器。
@Override
public void contextInitialized(ServletContextEvent sce) {
当Web应用程序初始化开始时，会调用ServletContextListener的contextInitialized方法。
String url = "jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1;"
+ "INIT=RUNSCRIPT FROM 'classpath:/sql/schema.sql'"
+ "\\;RUNSCRIPT FROM 'classpath:/sql/data.sql'";
在这个连接字符串URL中，我们创建了一个名为testdb的内存数据库。DB_CLOSE_DELAY会保持内存数据库的内容，直到虚拟机关闭。否则，当连接关闭时，数据库将被删除。RUNSCRIPT命令会执行数据库脚本。
SimpleDriverDataSource ds = new SimpleDriverDataSource(); ds.setDriver(new org.h2.Driver()); ds.setUrl(url);
我们设置了一个SimpleDriverDataSource。它是一个不支持连接池的简单数据源。它为每次调用创建一个新连接。
try (Connection con = ds.getConnection()) {
} catch (SQLException ex) {
lgr.log(Level.SEVERE, ex.getMessage(), ex);
}
数据库脚本在创建连接时执行。
City.java
package com.zetcode.model;
import java.util.Objects;
public class City {
private Long id;
private String name;
private int population;
public City() {
}
public City(String name, int population) {
this.name = name;
this.population = population;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getPopulation() {
return population;
}
public void setPopulation(int population) {
this.population = population;
}
@Override
public int hashCode() {
int hash = 3;
hash = 71 * hash + Objects.hashCode(this.id);
hash = 71 * hash + Objects.hashCode(this.name);
hash = 71 * hash + this.population;
return hash;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final City other = (City) obj;
if (this.population != other.population) {
return false;
}
if (!Objects.equals(this.name, other.name)) {
return false;
}
return Objects.equals(this.id, other.id);
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append("City{id=").append(id).append(", name=")
.append(name).append(", population=")
.append(population).append("}");
return builder.toString();
}
}
这是一个 City 模型类。它包含三个属性：id、name 和 population。
ICityService.java
package com.zetcode.service;
import com.zetcode.model.City;
import java.util.List;
public interface ICityService {
public List<City> findAll();
public boolean save(City city);
public City find(Long id);
public boolean update(City city, Long id);
public boolean delete(Long id);
}
ICityService包含CRUD契约方法。我们有查找城市、保存城市、更新城市和删除城市的方法。
CityService.java
package com.zetcode.service;
import com.zetcode.dao.ICityDao;
import com.zetcode.model.City;
import java.util.List;
import javax.inject.Inject;
public class CityService implements ICityService {
@Inject
private ICityDao cityDao;
@Override
public List<City> findAll() {
return cityDao.findAll();
}
@Override
public boolean save(City city) {
return cityDao.save(city);
}
@Override
public City find(Long id) {
return cityDao.find(id);
}
@Override
public boolean update(City city, Long id) {
return cityDao.update(city, id);
}
@Override
public boolean delete(Long id) {
return cityDao.delete(id);
}
}
CityService包含服务方法的实现。它将实际工作委托给CityDao。
ICityDao.java
package com.zetcode.dao;
import com.zetcode.model.City;
import java.util.List;
public interface ICityDao {
public List<City> findAll();
public boolean save(City city);
public City find(Long id);
public boolean update(City city, Long id);
public boolean delete(Long id);
}
ICityDao包含契约方法。
CityDao.java
package com.zetcode.dao;
import com.zetcode.conf.AppConfig;
import com.zetcode.model.City;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.datasource.SimpleDriverDataSource;
public class CityDao implements ICityDao {
@Override
public List<City> findAll() {
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl("jdbc:h2:mem:testdb");
List<City> cities = new ArrayList<>();
String query = "SELECT * FROM cities;";
try {
JdbcTemplate jtm = new JdbcTemplate(ds);
cities = jtm.query(query,
new BeanPropertyRowMapper(City.class));
} catch (DataAccessException dae) {
Logger lgr = Logger.getLogger(CityDao.class.getName());
lgr.log(Level.SEVERE, dae.getMessage(), dae);
}
return cities;
}
@Override
public boolean save(City city) {
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl("jdbc:h2:mem:testdb");
String sql = "INSERT INTO cities(name, population) VALUES (?, ?)";
boolean ret = true;
try {
JdbcTemplate jtm = new JdbcTemplate(ds);
jtm.update(sql, new Object[]{city.getName(),
city.getPopulation()});
} catch (DataAccessException dae) {
Logger lgr = Logger.getLogger(CityDao.class.getName());
lgr.log(Level.SEVERE, dae.getMessage(), dae);
ret = false;
}
return ret;
}
@Override
public City find(Long id) {
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl("jdbc:h2:mem:testdb");
String sql = "SELECT * FROM cities WHERE Id=?";
City city = new City();
try {
JdbcTemplate jtm = new JdbcTemplate(ds);
city = (City) jtm.queryForObject(sql, new Object[]{id},
new BeanPropertyRowMapper(City.class));
} catch (DataAccessException dae) {
Logger lgr = Logger.getLogger(CityDao.class.getName());
lgr.log(Level.SEVERE, dae.getMessage(), dae);
}
return city;
}
@Override
public boolean update(City city, Long id) {
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl("jdbc:h2:mem:testdb");
boolean ret = true;
String sql = "UPDATE cities SET name=?, population=? WHERE Id=?";
try {
JdbcTemplate jtm = new JdbcTemplate(ds);
int nOfRows = jtm.update(sql, new Object[]{city.getName(),
city.getPopulation(), id});
if (nOfRows != 1) {
ret = false;
}
} catch (DataAccessException dae) {
Logger lgr = Logger.getLogger(CityDao.class.getName());
lgr.log(Level.SEVERE, dae.getMessage(), dae);
ret = false;
}
return ret;
}
@Override
public boolean delete(Long id) {
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl("jdbc:h2:mem:testdb");
boolean ret = true;
String sql = "DELETE FROM cities WHERE Id=?";
try {
JdbcTemplate jtm = new JdbcTemplate(ds);
int nOfRows = jtm.update(sql, new Object[]{id});
if (nOfRows != 1) {
ret = false;
}
} catch (DataAccessException dae) {
Logger lgr = Logger.getLogger(CityDao.class.getName());
lgr.log(Level.SEVERE, dae.getMessage(), dae);
ret = false;
}
return ret;
}
}
CityDao包含ICityDao方法的实现。
SimpleDriverDataSource ds = new SimpleDriverDataSource();
ds.setDriver(new org.h2.Driver());
ds.setUrl("jdbc:h2:mem:testdb");
使用SimpleDriverDataSource来构建内存H2数据库的数据源。
JdbcTemplate jtm = new JdbcTemplate(ds);
cities = jtm.query(query,
new BeanPropertyRowMapper(City.class));
使用Spring的JdbcTemplate来执行查询和其他JDBC语句。
} catch (DataAccessException dae) {
Logger lgr = Logger.getLogger(CityDao.class.getName());
lgr.log(Level.SEVERE, dae.getMessage(), dae);
}
Spring的DataAccessException是用于所有类型的JDBC异常的。
@Override
public boolean save(City city) {
save方法以及update和delete方法会返回一个布尔值，指示任务是否成功完成。这用于确定响应的状态码。
MyResource.java
package com.zetcode.resource;
import com.zetcode.model.City;
import com.zetcode.service.ICityService;
import java.util.List;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
@Path("cities")
public class MyResource {
@Inject
private ICityService cityService;
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response getCities() {
List<City> cities = cityService.findAll();
if (!cities.isEmpty()) {
return Response.ok(cities).build();
} else {
return Response.status(Response.Status.NOT_FOUND).build();
}
}
@Path("/{id}")
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response findCity(@PathParam("id") Long id) {
City city = cityService.find(id);
if (city.getId() != null) {
return Response.ok(city).build();
} else {
return Response.status(Response.Status.NOT_FOUND).build();
}
}
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public Response saveCity(@FormParam("name") String name,
@FormParam("population") int population) {
City city = new City();
city.setName(name);
city.setPopulation(population);
boolean r = cityService.save(city);
if (r) {
return Response.ok().status(Response.Status.CREATED).build();
} else {
return Response.notModified().build();
}
}
@Path("/{id}")
@PUT
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public Response updateCity(@FormParam("name") String name,
@FormParam("population") int population,
@PathParam("id") Long id) {
City city = new City();
city.setName(name);
city.setPopulation(population);
boolean r = cityService.update(city, id);
if (r) {
return Response.ok().status(Response.Status.NO_CONTENT).build();
} else {
return Response.notModified().build();
}
}
@Path("/{id}")
@DELETE
@Produces(MediaType.APPLICATION_JSON)
public Response deleteCity(@PathParam("id") Long id) {
boolean r = cityService.delete(id);
if (r) {
return Response.ok().status(Response.Status.NO_CONTENT).build();
} else {
return Response.notModified().build();
}
}
}
这是 MyResource 类。
@Path("cities")
public class MyResource {
@Path 指定资源响应的 URL。
@Inject private ICityService cityService;
使用 @Inject 注解，我们将 city service 对象注入到 cityService 字段中。
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response getCities() {
@GET注解表示被注解的方法响应HTTP GET请求。使用@Produces注解，我们定义该方法生成JSON。
List<City> cities = cityService.findAll();
if (!cities.isEmpty()) {
return Response.ok(cities).build();
} else {
return Response.status(Response.Status.NOT_FOUND).build();
}
我们调用findAll服务方法并返回所有城市的列表。成功时，我们返回带有Response.ok(cities).build的数据。如果服务方法未找到任何数据，我们返回Response.Status.NOT_FOUND。
@Path("/{id}")
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response findCity(@PathParam("id") Long id) {
要通过ID查找特定城市，我们有一个带@Path("/{id}")的路径参数。ID使用@PathParam("id")注解检索。
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public Response saveCity(@FormParam("name") String name,
@FormParam("population") int population) {
创建新资源时，我们使用@POST注解。使用@Consumes(MediaType.APPLICATION_FORM_URLENCODED)，我们设置saveCity从请求体中接收编码数据。请求体中的数据使用@FormParam注解检索。
return Response.ok().status(Response.Status.CREATED).build();
对于新创建的资源，我们返回Response.Status.CREATED。
@Path("/{id}")
@PUT
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public Response updateCity(@FormParam("name") String name,
@FormParam("population") int population,
@PathParam("id") Long id) {
要修改资源，我们使用@PUT注解。资源的ID从路径中检索，修改后的数据从请求体中检索。
@Path("/{id}")
@DELETE
@Produces(MediaType.APPLICATION_JSON)
public Response deleteCity(@PathParam("id") Long id) {
要删除资源，我们使用@DELETE注解。
return Response.ok().status(Response.Status.NO_CONTENT).build();
Response.Status.NO_CONTENT可用于资源更新和删除。
$ curl localhost:8084/RestEasyCrud/rest/cities/ -i
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 383
Date: Mon, 19 Feb 2018 12:19:24 GMT
[{"id":1,"name":"Bratislava","population":432000},
{"id":2,"name":"Budapest","population":1759000},
{"id":3,"name":"Prague","population":1280000},
{"id":4,"name":"Warsaw","population":1748000},
{"id":5,"name":"Los Angeles","population":3971000},
{"id":6,"name":"New York","population":8550000},
{"id":7,"name":"Edinburgh","population":464000},
{"id":8,"name":"Berlin","population":3671000}]
我们通过GET请求获取所有城市。
$ curl -X POST -d name=Kiev -d population=2877000 localhost:8084/RestEasyCrud/rest/cities/ -i HTTP/1.1 201 Created Server: Apache-Coyote/1.1 Content-Length: 0 Date: Mon, 19 Feb 2018 12:21:25 GMT
我们通过POST请求创建一个新的城市资源。
$ curl -X DELETE localhost:8084/RestEasyCrud/rest/cities/1 -i HTTP/1.1 204 No Content Server: Apache-Coyote/1.1 Date: Mon, 19 Feb 2018 12:23:20 GMT
我们通过DELETE请求删除一个资源。
$ curl localhost:8084/RestEasyCrud/rest/cities/ -i HTTP/1.1 200 OK Server: Apache-Coyote/1.1 Content-Type: application/json Content-Length: 428 Date: Mon, 19 Feb 2018 12:24:42 GMT
我们通过PUT请求修改一个资源。
在本教程中，我们使用RESTEasy和H2数据库创建了一个CRUD RESTFul应用程序。我们使用Spring的JdbcTemplate连接到H2。该应用程序部署在Tomcat上。