Jersey 入門與Javabean-java教程-PHP中文網

Jersey是JAX-RS（JSR311）開源參考實作用於建立RESTful Web service，它包含三個部分：

　　核心伺服器（Core Server）透過提供JSR 311中標準化的註解和API標準化，可以用直覺的方式開發RESTful Web服務。

　　核心客戶端（Core Client） Jersey客戶端API能夠幫助開發者與RESTful服務輕鬆通訊；

　　整合（Integration） Jersey也提供可以輕鬆繼承Spring、Guice、Apache Abdera的庫庫內核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

　　common: jersey-common.jar

　　＀支持json。

Demo Hello Wolrd

第一步：編寫一個名為HelloResource的資源，它接受Http Get請求並回應」Hello Jerset」

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

登入後複製

第二步：編寫JAX-RS application

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

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

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

登入後複製

：在第三步web.xml檔案中定義servelt調度程序，目的是將所有REST請求傳送到Jersey容器。除了宣告Jersey Servlet外，還需定義一個初始化參數，指定JAX-RS application。

<!--用于定义 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>

登入後複製

第四步：測試程式

在命令終端機中輸入以下命令，將會看到「Hello Jersey」。

curl http://host:port/services/hello

或在瀏覽器中輸入以下URL，將會看到「Hello Jersey」

http://host:port/services/hello

使用

資源

Root Resource And Sub-Resource

資源是組成RESTful服務的關鍵部分，可以使用HTTP方法（如：GET、POST、PUT和DELETE）來操作資源。在JAX-RX中，資源透過POJO實現，使用@Path 註釋組成其識別符。資源可以有子資源，父資源是資源集合，子資源是成員資源。

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組成的資源方法

大括號裡的內容是參數，這樣設定是合理的，因為username也會出現在url中，而path就是url的意思

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

登入後複製

HTTP Methods

HTTP方法對應到資源的CRUD（建立、讀取、更新和刪除）操作，基本模式如下：

　　HTTP GET: 讀取/列出/檢索單一資源

　　HT
　　HTTP PUT: 更新現有資源或資源集合

　　HTTP DELETE: 刪除資源或資源集合

@Produces

@Produces註解類型用來指定將要傳回給識別碼端的資料識別碼（client）。 @Produces可以作為class註釋，也可以作為方法註釋，方法的@Produces註釋將會覆寫class的註釋。覆蓋的意思是假如方法宣告了自己的Produce，那麼以方法的為準，class的僅供參考

指定MIME類型

@Produces(“application/json”)

指定多個MIME類型

@Produces({“ application/json”,“application/xml”})

@Consumes
@Consumes與@Produces相反，用來指定可以接受client發送過來的MIME類型，同樣可以用於class或method，也可以指定多個或多個MEME型，一般用於@PUT，@POST 。

參數（Parameter Annotations）
Parameter Annotations用於取得client所傳送的資料。本文只介紹常用的註解，更多詳見Jersey使用手冊

@PathParam

使用@PathParam可以取得URI中指定規則的參數，例如：

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

登入後複製

當瀏覽器要求http://localhost/user/jack時， userName值為jack。

注意，這裡的username並不是說Key是username, value是jack而是說/usr/後面跟著的東西就是username,這裡username只是個變數

至於key,value的形式，下面也有

@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時，name值為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時，name值為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 ...

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中文网！