webservice框架jersey简单总结[通俗易懂]

<!--jersey -->

<dependency>

<groupId>org.glassfish.jersey.containers</groupId>

<artifactId>jersey-container-servlet-core</artifactId>

<version>2.13</version>

</dependency>

<!--JAXB API -->

<dependency>

<groupId>javax.xml.ws</groupId>

<artifactId>jaxws-api</artifactId>

<version>2.1</version>

</dependency>

<!-- Json支持 -->

<dependency>

<groupId>org.codehaus.jackson</groupId>

<artifactId>jackson-core-asl</artifactId>

<version>1.9.12</version>

</dependency>

<dependency>

<groupId>org.codehaus.jackson</groupId>

<artifactId>jackson-mapper-asl</artifactId>

<version>1.9.12</version>

</dependency>

<dependency>

<groupId>org.codehaus.jackson</groupId>

<artifactId>jackson-jaxrs</artifactId>

<version>1.9.12</version>

</dependency>

<!-- 编译需要，tomcat里面有 -->

<dependency>

<groupId>javax.servlet</groupId>

<artifactId>servlet-api</artifactId>

<version>2.5</version>

<scope>provided</scope>

</dependency>

<servlet>

<servlet-name>JerseyServlet</servlet-name>

<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>

<!-- 配置自己的资源加载类去加载资源 -->

<init-param>

<param-name>javax.ws.rs.Application</param-name>

<param-value>com.cisdi.jersey.api.ApplicationAPI</param-value>

</init-param>

<!-- 配置默认的资源包路径，使用默认的配置类去加载资源 -->

<!-- <init-param> -->

<!-- <param-name>jersey.config.server.provider.packages</param-name> -->

<!-- <param-value>com.cisdi.jersey.api</param-value> -->

<!-- </init-param> -->

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>JerseyServlet</servlet-name>

<url-pattern>/api/*</url-pattern>

</servlet-mapping>

public class ApplicationAPI extends ResourceConfig {

public ApplicationAPI() {

// 加载resources

register(HelloResource.class);

register(UserResource.class);

// 注册数据转换器

register(JacksonJsonProvider.class);

// 注册日志

register(LoggingFilter.class);

}

}

先弄了一个简单的资源，HelloResource

@Path("/hello")

public class HelloResource {

@GET

@Produces(MediaType.TEXT_PLAIN)

public String sayHello() {

return "hello jersey!";

}

}

接着可以弄个复杂点得对象资源，UserResource
@XmlRootElement
public class User {
private int id;
@FormParam("name")
private String userName;
@FormParam("desc")
private String desc;
Setter/Getter...
}
下面就是UserResource的各个方法
@Path("user")
public class UserResource {
//这个类的方法都在下面 ｝
//这个方法主要介绍@GET，@Path，@Produces，@PathParam，@DefaultValue，@QueryParam注解的使用
@GET
@Path("{username}")
@Produces(MediaType.APPLICATION_XML)
// @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
public User getUser(@PathParam("username") String userName, @DefaultValue("description") @QueryParam("desc") String desc) {
User user = new User();
user.setId(new Random().nextInt());
user.setUserName(userName);
user.setDesc(desc);
return user;
}
//访问路径：{host}:{port}/{serviceName}/api/user/username?desc=xxx ;username可以随便写
//这个方法主要介绍@POST，@Consumes,@FormParam注解的使用
@POST
@Path("updateUser")
@Consumes("application/x-www-form-urlencoded")
public void updateUser(@FormParam("name") String userName, @FormParam("desc") String desc) {
User user = new User();
user.setId(1);
user.setUserName(userName);
user.setDesc(desc);
System.out.println(user);
}
//访问路径：{host}:{port}/{serviceName}/api/user/updateUser;这个是通过提交表单访问的
//这个方法主要介绍@BeanParam的使用
@POST
@Path("updateUser1")
@Produces(MediaType.APPLICATION_XML)
@Consumes("application/x-www-form-urlencoded")
public User updateUser1(@BeanParam User user) {//注意这个方法需要在User这个bean中使用@FromParam注解
System.out.println(user);
return user;
}
//访问路径：{host}:{port}/{serviceName}/api/user/updateUser1;这个是通过提交表单访问的
//这个方法主要介绍@Context注解的使用
@Context
HttpServletRequest request;
@Context
HttpServletResponse response;
@Context
ServletConfig servletConfig;
@Context
ServletContext servletContext;
@Context
HttpHeaders header;
@Context
UriInfo info;
@GET
@Path("/test/{param}")
@Produces(MediaType.APPLICATION_XML)
public User getContext() {
MultivaluedMap<String, String> queryParameters = info.getQueryParameters();
MultivaluedMap<String, String> pathParameters = info.getPathParameters();
System.out.println(queryParameters);
System.out.println(pathParameters);
System.out.println(this.request);
System.out.println(this.response);
System.out.println(this.servletConfig);
System.out.println(this.servletContext);
System.out.println(this.header);
System.out.println(this.info);
return new User(1, "gusi");
}
//访问路径：{host}:{port}/{serviceName}/api/user/test/xxx?xxx=xxx&xxx=xxx;xxx都是可以乱写的
说明：使用这种方式有很大的作用，当我们不知道client传递过来的参数名称，或者client传递过来的参数经常变化，
那么我们就可以使用这样方式动态的获得传递给service的参数，然后再进行后续的处理