背景
从事接口测试工作以来,接触了很多接口的测试和代码编写工作,但是没有自己从头新建并配置过一个工程。工作中接触的接口框架是基于jersey 进行二次开发的,并基于annotation进行接口定义。因此有了接下来的工作。
一、定义
RESTful架构(REST,Representational State Transfer,资源表现层状态转换)。REST指的是一组架构约束条件和原则。如果一个架构符合REST的约束条件和原则,就称它为RESTful架构。如:统一的接口原则:标准的HTTP方法如GET,PUT和POST,DELETE。
- different representations,各种表现方式 e.g., text, XML, JSON etc.
- 状态转换指的是客户端与服务端之间的状态变化和交互
Jersey是RESTful 框架在java中的应用。RESTful Web Services in Java.
二、Intellij IDEA中实现Jersey RESTful Web Services的例子
Jersey example with Intellij IDEA Ultimate and Tomcat
Jersey
- IntelliJ Idea 2017
- Jersey 2.17
- JDK 8
- Tomcat 8.5.20
-
新建工程,选择Java Enterprise并选中Web Application(自动生成web.xml文件)
-
在工程名上邮件选择 Add Framework Support,然后选择添加Maven。(或者新建maven工程,这里选择添加Web Application)
我新建的maven的groupId如下所示<groupId>test</groupId> <artifactId>test</artifactId> <version>1.0-SNAPSHOT</version>
-
pom.xml中添加jersey的依赖
<?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>test</groupId> <artifactId>test</artifactId> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> <groupId>org.glassfish.jersey.containers</groupId> <artifactId>jersey-container-servlet</artifactId> <version>2.17</version> </dependency> <dependency> <groupId>org.glassfish.jersey.core</groupId> <artifactId>jersey-client</artifactId> <version>2.17</version> </dependency> </dependencies> </project>
-
新建 java 类。首先在src/main/java路径下新建test 包(和groupId路径一致),然后在test路径下新建java类,eg: Hello.java。
-
类内容如下:
package test; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; @Path("/hello") public class Hello { // This method is called if TEXT_PLAIN is request @GET @Produces(MediaType.TEXT_PLAIN) public String sayPlainTextHello() { return "Hello Jersey"; } // This method is called if XML is request @GET @Produces(MediaType.TEXT_XML) public String sayXMLHello() { return "<?xml version=\"1.0\"?>" + "<hello> Hello Jersey" + "</hello>"; } // This method is called if HTML is request @GET @Produces(MediaType.TEXT_HTML) public String sayHtmlHello() { return "<html> " + "<title>" + "Hello Jersey" + "</title>" + "<body><h1>" + "Hello Jersey" + "</body></h1>" + "</html> "; } }
-
修改index.jsp文件(web application中的文件,前端代码),用来提供link路径
<%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>Jersey</title> </head> <body> <p><a href="rest/hello"></a></p> </body> </html>
-
Run -> Edit Configurations,检查并配置tomcat(apache-tomcat-8.5.20)
-
在web.xml中配置servlet,注册Jersey。Register Jersey as the servlet dispatcher for REST requests.
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0"> <display-name>com.vogella.jersey.first</display-name> <servlet> <servlet-name>Jersey REST Service</servlet-name> <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class> <!-- Register resources and providers under com.vogella.jersey.first package. --> <init-param> <param-name>jersey.config.server.provider.packages</param-name> <param-value>test</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Jersey REST Service</servlet-name> <url-pattern>/rest/*</url-pattern> </servlet-mapping>
-
因为最后运行jersey代码(运行web application),是把代码打成war包,然后在tomcat中运行。所以还需要配置依赖的Jersey jar包,运行时将其打入war包中。选择File->Project Structure->Artifacts,全选Jersey jar包,右键Put into /WEB-INF/lib。
-
运行启动tomcat,会打开网页http://localhost:8080/rest/hello,返回“Hello Jersey”。也可以使用curl来查看返回结果
curl http://localhost:8080/rest/hello Hello Jersey