Jersey 및 Javabeans 시작하기

Jersey는 RESTful 웹 서비스 구축을 위한 JAX-RS(JSR311)의 오픈 소스 참조 구현입니다.

JSR 311에 표준화된 주석 및 API 표준화를 제공하여 코어 서버를 개발할 수 있습니다. 직관적인 방식으로 RESTful 웹 서비스를 제공합니다.

Core Client Jersey 클라이언트 API는 개발자가 RESTful 서비스와 쉽게 통신할 수 있도록 도와줍니다.

Integration Jersey는 Spring, Guice 및 Apache Abdera 라이브러리를 쉽게 상속할 수 있는 API도 제공합니다

Jersey 환경 설정

Maven

<!--jersey-->
<dependency>
    <groupId>org.glassfish.jersey.containers</groupId>
    <artifactId>jersey-container-servlet-core</artifactId>
    <version>2.0</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>

Jar 파일 방법 소개
Jersey 개발 패키지에서 다음 라이브러리를 WEB-INF 아래의 라이브러리 디렉터리에 복사합니다. ：

서버 Jersey-server.jar, Jersey-container-servlet-core.jar, Jersey-container-servlet.jar, javax.ws.rs-api-2.0.jar

클라이언트 터미널: Jersey-client.jar

공통: Jersey-common.jar

JSON 지원: json을 지원하려면 Jersey2.0에서 Jackson1.9가 필요합니다.

데모 Hello Wolrd

1단계: Http Get 요청을 수락하고 "Hello Jersey"로 응답하는 HelloResource라는 리소스를 작성합니다.

@Path("/hello")
public class HelloResource {
    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String sayHello() {
        return "Hello Jersey";
    }
}

2단계: JAX 작성 -RS 애플리케이션

public class APIApplication extends ResourceConfig {
    public APIApplication() {
        //加载Resource
        register(HelloResource.class);

        //注册数据转换器
        register(JacksonJsonProvider.class);

        // Logging.
        register(LoggingFilter.class);
    }
}

3단계: 모든 REST 요청을 Jersey 컨테이너로 보낼 목적으로 web.xml 파일에 Servelt 스케줄러를 정의합니다. Jersey Servlet 선언 외에도 JAX-RS 애플리케이션을 지정하기 위한 초기화 매개변수도 정의해야 합니다.

<!--用于定义 RESTful Web Service 接口-->
<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>cn.com.mink.resource.APIApplication</param-value>
    </init-param>

    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>JerseyServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
</servlet-mapping>

4단계: 프로그램 테스트
명령 터미널에 다음 명령을 입력하면 "Hello Jersey"가 표시됩니다.
curl http://host:port/services/hello
또는 브라우저에 다음 URL을 입력하면 "Hello Jersey"가 표시됩니다.
http://host:port/services/hello

리소스 사용

루트 리소스 및 하위 리소스
리소스는 RESTful 서비스의 핵심 부분이며 HTTP 메서드(예: GET, POST, PUT 및 DELETE) 운영 리소스. JAX-RX에서 리소스는 @Path 주석을 사용하여 식별자를 형성하는 POJO를 통해 구현됩니다. 리소스에는 하위 리소스가 있을 수 있습니다. 상위 리소스는 리소스 컬렉션이고 하위 리소스는 구성원 리소스입니다.
Resources는 "/services" URI로 구성된 리소스 모음이고 UserResource는 "/services/user" URI로 구성된 구성원 리소스입니다.

POJO는 간단한 Java 개체를 나타냅니다.

@Path("/services")
public class Resources {

    @Path("/user")
    public UserResource getUserResource() {
        ...
    }

    @Path("/book")
    public BookResource getBookResource() {
        ...
    }
}

UserResource는 "/user" URI로 구성된 리소스 모음이고, getUser는 "/user/{username}" URI로 구성된 리소스 메서드입니다.

curly의 내용입니다. 대괄호는 매개변수입니다. 사용자 이름은 URL에도 표시되고 경로는 URL을 의미하기 때문입니다.

@Path("/user")
public class UserResource {
    @GET
    @Path("{username"})
    @Produces("application/json")
    public User getUser(@PathParam("username") String userName) {
        ...
    }
}

HTTP 메서드
HTTP 메서드는 CRUD(생성, 읽기, 업데이트 및 삭제)에 매핑됩니다. 리소스 작업, 기본 모드 다음과 같습니다.

HTTP GET: 단일 리소스 읽기/나열/검색

HTTP POST: 새 리소스 생성

HTTP PUT: 업데이트 기존 리소스 또는 리소스 컬렉션

HTTP DELETE: 리소스 또는 리소스 컬렉션 삭제

@Produces
@Produces 주석은 반환될 데이터 식별 유형(MIME)을 지정하는 데 사용됩니다. 고객. @Produces는 클래스 주석 또는 메서드 주석으로 사용될 수 있습니다. 메서드의 @Produces 주석은 클래스 주석을 재정의합니다. 덮어쓰기의 의미는 메소드가 자체 Produce를 선언하는 경우 메소드가 우선하며 클래스는 참조용으로만 사용된다는 것입니다.
MIME 유형 지정
@Produces("application/json")
여러 MIME 유형 지정
@Produces({"application/json","application/xml"})

@Consumes
@Consumes는 MIME 유형을 지정하는 데 사용되는 @Produces의 반대입니다. 이는 클라이언트에서 허용할 수 있으며 클래스나 메소드에도 사용할 수 있으며 일반적으로 @PUT 및 @POST에 사용됩니다.

매개변수 주석
매개변수 주석은 클라이언트가 보낸 데이터를 얻는 데 사용됩니다. 이 문서에서는 일반적으로 사용되는 주석만 소개합니다. 자세한 내용은 Jersey 사용자 설명서
@PathParam
@PathParam을 사용하여

@GET
@Path("{username"})
@Produces(MediaType.APPLICATION_JSON)
public User getUser(@PathParam("username") String userName) {
    ...
}

브라우저가 http를 요청하는 경우 ://localhost/user/jack일 때 userName 값은 jack입니다.

여기서 사용자 이름은 키가 사용자 이름이고 값이 잭이라는 의미가 아니라 /usr/ 뒤에 오는 사용자 이름이 사용자 이름이라는 것을 의미합니다.

키와 값에 관해서는 양식에는

@QueryParam도 있습니다.

@QueryParam은 다음과 같이 GET 요청에서 쿼리 매개변수를 얻는 데 사용됩니다.

@GET
@Path("/user")
@Produces("text/plain")
public User getUser(@QueryParam("name") String name,
                    @QueryParam("age") int age) {
    ...
}

브라우저가 요청할 때

http://host :port/user?name=rose&age=25일 때 이름 값은 rose이고 age 값은 25입니다. 매개변수의 기본값을 설정해야 하는 경우 다음과 같이 @DefaultValue를 사용할 수 있습니다.

@GET
@Path("/user")
@Produces("text/plain")
public User getUser(@QueryParam("name") String name,
                    @DefaultValue("26") @QueryParam("age") int age) {
    ...
}

브라우저가 http://host:port/user?name=rose를 요청할 때 , 이름 값은 rose , age 값은 26입니다.

@FormParam

@FormParam은 이름에서 알 수 있듯이 POST 요청의 양식 매개변수에서 데이터를 가져옵니다. 예:

@POST
@Consumes("application/x-www-form-urlencoded")
public void post(@FormParam("name") String name) {
    // Store the message
}

表单我一直没弄清楚到底是什么东西，但就使用的情况来看，就是key,value之类的东西

BeanParam 
当请求参数很多时，比如客户端提交一个修改用户的PUT请求，请求中包含很多项用户信息。这时可以用@BeanParam。 
User Bean定义如下：

@XmlRootElement(name = "user")
public class User {
    @PathParam("userName) //我觉得这个应该是写错了，FormParam
    private String userName;

    @FormParam("name")
    private String name;

    @FormParam("telephone")
    private String telephone;

    @FormParam("email")
    private String email;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }
    ...
}

使用Map 
在一个大型的server中，因为参数的多变，参数结构的调整都会因为以上几种方式而遇到问题，这时可以考虑使用@Context 注释，并获取UriInfo实例，如下：

@GETpublic String get(@Context UriInfo ui) {
    MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
    MultivaluedMap<String, String> pathParams = ui.getPathParameters();
}

我觉得，可以认为map是上面几种情况的超集，因为它能够替代以上任意一种。map就是context

同样还可以通过@Context 注释获取ServletConfig、ServletContext、HttpServletRequest、HttpServletResponse和HttpHeaders等，如下：

@Path("/")
public class Resource {

    @Context
    HttpServletRequest req;

    @Context
    ServletConfig servletConfig;

    @Context
    ServletContext servletContext;

    @GET
    public String get(@Context HttpHeaders hh) {
        MultivaluedMap<String, String> headerParams = hh.getRequestHeaders();
        Map<String, Cookie> pathParams = hh.getCookies();
    }
}

Jersey返回Json和Xml 
JAX-RS支持使用JAXB（Java API for XML Binding）将JavaBean绑定到XML或JSON，反之亦然。JavaBean必须使用@XmlRootElement标注，没有@XmlElement注释的字段将包含一个名称与之相同的XML元素，如下：

这里就说明了javabean和xml, json的关系

@XmlRootElement
public class OptionResult {
    @XmlElement(name = "code")
    private String result;

    private String errorMsg;

    public String getResult() {
        return result;
    }

    public void setResult(String result) {
        this.result = result;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }
}

然后在REST服务中使用：

@Path("/user")
public class UserResource {
    @POST
    @Produces("application/json")
    public OptionResult create(@BeanParam User user) {
        ...
    }
}

最后，要注册数据转换器，该转换器会自动将JavaBean转换为json数据：

public class APIApplication extends ResourceConfig {
    public APIApplication() {
        //加载Model
        register(OptionResult.class);

        //加载与OptionResult同一个packge的Model
        //packages(OptionResult.class.getPackage().getName());

        //加载Resource
        register(UserResource.class);

        //注册数据转换器
        register(JacksonJsonProvider.class);

        // Logging.
        register(LoggingFilter.class);
    }
}

说明：返回XML数据的原理相同，仅仅是数据转换器不同，只需要在APIApplication中同时XML数据转换器即可。 

Wiki上关于REST的总结

含状态传输（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格.

　　资源是由URI来指定。

　　对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。

　　通过操作资源的表现形式来操作资源。

　　资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式。

应该注意区别应用的状态和连接协议的状态。HTTP连接是无状态的（也就是不记录每个连接的信息），而REST传输会包含应用的所有状态信息，因此可以大幅降低对HTTP连接的重复请求资源消耗。

实现举例：

每种操作都会对应一个函数

列举所有商品

GET http://www.store.com/products

呈现某一件商品

GET http://www.store.com/product/12345

下单购买

POST http://www.store.com/order 1803550bde68c49c85969c1aa6599a97   5083cbefc9e5095dae6431462e2af988 ... 6d04af7aa1cc3096ed7e7b950e1ecf7f e3f848c0fe507a9c805f80fb27ab2c32

REST的优点

　　可更高效利用缓存来提高响应速度

　　通讯本身的无状态性可以让不同的服务器的处理一系列请求中的不同请求，提高服务器的扩展性

　　浏览器即可作为客户端，简化软件需求

　　相对于其他叠加在HTTP协议之上的机制，REST的软件依赖性更小

　　不需要额外的资源发现机制

　　在软件技术演进中的长期的兼容性更好

 

JavaBean

JavaBeans是Java语言中可以重复使用的软件组件，它们是一种特殊的Java类[1]，将很多的对象封装到了一个对象(bean)中。特点是可序列化，提供无参构造器，提供getter方法和setter方法访问对象的属性。

优点

　　Bean可以控制它的属性，事件和方法是否暴露给其他程序

　　Bean可以接收来自其他对象的事件，也可以产生事件给其他对象

　　有软件可以配置Bean

　　Bean的属性可以被序列化，以供日后使用

JavaBean规范

要成为JavaBean类，必须遵循关于命名，构造器，方法的特定规范，有了这些规范，才能使用，复用，替代和连接javabean的工具。 
规范是：

　　有一个public 无参构造器

　　属性可以通过get, set, is方法或者遵循特定命名规范的其他方法访问。

　　可序列化

一个例子

public class PersonBean implements java.io.Serializable {

    /**
     * <code>name</code>属性(注意大小写)
     */
    private String name = null;

    private boolean deceased = false;

    /** 无参构造器(没有参数) */
    public PersonBean() {
    }

    /**
     * <code>name</code>属性的Getter方法
     */
    public String getName() {
        return name;
    }

    /**
     * <code>name</code>属性的Setter方法
     * @param value
     */
    public void setName(final String value) {
        name = value;
    }

    /**
     * "deceased"属性的Getter方法
     * 布尔型属性的Getter方法的不同形式(这里使用了is而非get)
     */
    public boolean isDeceased() {
        return deceased;
    }

    /**
     * <code>deceased</code>属性的Setter方法
     * @param value
     */
    public void setDeceased(final boolean value) {
        deceased = value;
    }
}

总结

1. Javabean提供了一种保证，即对于所有的成员变量，一定有get,set方法。并且还可以序列化

2. REST服务基于底层的保证来实现，因此可以简化很多事情，比如Javabean和XML的转换就可以写得相当简单。

更多Jersey 入门与Javabean相关文章请关注PHP中文网！