2. 程式人生 > >Java Restful Web Services （一）

Java Restful Web Services （一）

阿新 • • 發佈：2019-01-10

REST（Representational State Transfer，表述性狀態轉移），是Roy Thomas Fielding在他2000年的博士論文《Architectural Styles and the Design of Network-based Software Architectures》提出，與複雜的SOAP和XML-RPC相比，REST更加簡潔，越來越多的Web服務開始採用REST風格設計和實現。Rest是一種架構風格，在這樣的架構風格中，物件被抽象成為一種資源，資源的命名使用概念清晰的名詞來定義，HTTP+URI+XML是Rest的基本實現形式。JAX-RS是JAVA EE6 引入的一個新技術，是Java領域的Rest式的Web服務的標準規範，JAX-RS即Java API for RESTful Web Services，是一個Java 程式語言的

應用程式介面，支援按照表述性狀態轉移（REST）架構風格建立Web服務。JAX-RS使用了Java SE5引入的Java標註來簡化Web服務的客戶端和服務端的開發和部署。Jersey是JAX-RS標準的參考實現。

基於Jersey開發Restful服務，新建一個Web工程，引入我們需要的jar包，Jersey最新參考實現Jar包可通過Jersey官方網站下載。

新建一個package，定義資源類。

package cn.com.abc.rest;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;

@Path("helloworld")
public class HelloWorldResource {
	public static final String CLICHED_MESSAGE = "Hello World!";

	
	@GET
	@Path("/before")
	@Produces("text/plain")
	public String getHelloBefore() {
		return "hello before";
	}
	
	
	@GET
	@Produces("text/plain")
	public String getHello() {
		return CLICHED_MESSAGE;
	}
	
	@GET
	@Path("/{param}")
	@Produces("text/plain") 
	public String getHello(@PathParam("param")  String username) {
		return "Hello Path Param " + username;
	}
	
	
	@GET
	@Path("/user")
	@Produces("text/plain")
	public String getHelloWithQuery(@QueryParam("param") String username) {
		return "Hello Query Param " + username;
	}
	

	
}

修改web.xml 
<servlet>
    <servlet-name>Way REST Service</servlet-name>
    <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
    <init-param>
      <param-name>jersey.config.server.provider.packages</param-name>      
      <param-value>cn.com.abc.rest;com.fasterxml.jackson.jaxrs.json</param-value>
    </init-param>    
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>Way REST Service</servlet-name>
    <url-pattern>/rest/*</url-pattern>
  </servlet-mapping>

如果您的資源實現類放在不同的包中，那麼您可在屬性param-value中指定多個包名用以對外公佈REST服務介面。接下來是我們的測試類。 
package cn.com.abc.test;

import static org.junit.Assert.*;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;

import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

public class HelloWorldResourceTest {

	private WebTarget target;
	public static final String BASE_URI = "http://localhost:8090/NoteMail/rest/";

	@BeforeClass
	public static void setUpBeforeClass() throws Exception {
		System.out.println("setUpBeforeClass");
	}

	@AfterClass
	public static void tearDownAfterClass() throws Exception {
		System.out.println("tearDownAfterClass");
	}

	@Before
	public void setUp() throws Exception {
		System.out.println("setUp");
		Client c = ClientBuilder.newClient();
		target = c.target(BASE_URI);
		System.out.println(target.getUri());
	}

	@After
	public void tearDown() throws Exception {
		System.out.println("tearDown");
	}

	
	
	@Test
	public void testGetHello() {

		String responseMsg = target.path("helloworld").request()
				.get(String.class);		
		assertEquals("Hello World!", responseMsg);
		
	}
	
	@Test
	public void testGetHelloWithPathParam() {

		String responseMsg = target.path("helloworld/ABC").request().get(String.class);		
		assertEquals("Hello Path Param ABC", responseMsg);
		
	}
	
	
	@Test
	public void testGetHelloWithQueryParam() {

		String responseMsg = target.path("helloworld/user").queryParam("param", "ABC").request().get(String.class);		
		assertEquals("Hello Query Param ABC", responseMsg);
		
	}
	
	
	@Test
	public void testGetHelloBefore() {

		String responseMsg = target.path("helloworld/before/").request()
				.get(String.class);
		assertEquals("hello before", responseMsg);

	}


}

在資源實現類中包含了兩個不同註解的方法@PathParam和@QueryParam，兩種不同的方法呼叫方式也略有不同。各種不同的註解使用將在下一篇中介紹。

對於@PathParam,其呼叫方式為：

http://localhost:8090/NoteMail/rest/helloworld/ABC

對於@QueryParam，其呼叫方式為

http://localhost:8090/NoteMail/rest/helloworld/user?param=ABC

我們通過訪問“服務根路徑/application.wadl”（本示例為http://localhost:8090/NoteMail/rest/application.wadl）可以看到當前REST環境中所提供的REST伺服器介面，WADL（Web Application Description Language）是用來描述基於HTTP的Rest式Web服務部署情況。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<application xmlns="http://wadl.dev.java.net/2009/02">
    <doc xmlns:jersey="http://jersey.java.net/" jersey:generatedBy="Jersey: 2.15 2015-01-12 22:32:50"/>
    <doc xmlns:jersey="http://jersey.java.net/" jersey:hint="This is simplified WADL with user and core resources only. To get full WADL with extended resources use the query parameter detail. Link: http://localhost:8090/NoteMail/rest/application.wadl?detail=true"/>
    <grammars/>
    <resources base="http://localhost:8090/NoteMail/rest/">
        <resource path="helloworld">
            <method id="getHello" name="GET">
                <response>
                    <representation mediaType="text/plain"/>
                </response>
            </method>
            <resource path="/before">
                <method id="getHelloBefore" name="GET">
                    <response>
                        <representation mediaType="text/plain"/>
                    </response>
                </method>
            </resource>
            <resource path="/user">
                <method id="getHelloWithQuery" name="GET">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="param" style="query" type="xs:string"/>
                    </request>
                    <response>
                        <representation mediaType="text/plain"/>
                    </response>
                </method>
            </resource>
            <resource path="/{param}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="param" style="template" type="xs:string"/>
                <method id="getHello" name="GET">
                    <response>
                        <representation mediaType="text/plain"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="books">
            <method id="saveBook" name="POST">
                <request>
                    <representation mediaType="application/xml"/>
                    <representation mediaType="application/json"/>
                </request>
                <response>
                    <representation mediaType="application/xml"/>
                    <representation mediaType="application/json"/>
                </response>
            </method>
            <method id="getBooks" name="GET">
                <response>
                    <representation mediaType="application/json"/>
                    <representation mediaType="application/xml"/>
                </response>
            </method>
            <resource path="{bookid:[0-9]*}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="bookid" style="template" type="xs:int"/>
                <method id="updateBook" name="PUT">
                    <request>
                        <representation mediaType="application/xml"/>
                        <representation mediaType="application/json"/>
                        <representation mediaType="text/xml"/>
                    </request>
                    <response>
                        <representation mediaType="application/xml"/>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
                <method id="deleteBook" name="DELETE">
                    <response>
                        <representation mediaType="*/*"/>
                    </response>
                </method>
                <method id="getBookByPath" name="GET">
                    <response>
                        <representation mediaType="application/xml"/>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="/book">
                <method id="getBookByParam" name="GET">
                    <request>
                        <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="bookid" style="query" type="xs:int"/>
                    </request>
                    <response>
                        <representation mediaType="application/xml"/>
                        <representation mediaType="application/json"/>
                    </response>
                </method>
            </resource>
            <resource path="/booktest">
                <method id="sayHello" name="GET">
                    <response>
                        <representation mediaType="text/plain"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="users">
            <resource path="/{username}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="username" style="template" type="xs:string"/>
                <method id="getUserIgnore" name="GET">
                    <response>
                        <representation mediaType="text/plain"/>
                    </response>
                </method>
            </resource>
            <resource path="/{username: [a-zA-Z][a-zA-Z_0-9]*}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="username" style="template" type="xs:string"/>
                <method id="getUser" name="GET">
                    <response>
                        <representation mediaType="text/plain"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="/hellorestanother">
            <method id="sayHello" name="GET">
                <response>
                    <representation mediaType="text/plain"/>
                </response>
            </method>
            <resource path="/{param}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="param" style="template" type="xs:string"/>
                <method id="sayHelloToUTF8" name="GET">
                    <response>
                        <representation mediaType="text/plain; charset=UTF-8"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="/hellorest">
            <method id="sayHello" name="GET">
                <response>
                    <representation mediaType="text/plain"/>
                </response>
            </method>
            <resource path="/{param}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="param" style="template" type="xs:string"/>
                <method id="sayHelloToUTF8" name="GET">
                    <response>
                        <representation mediaType="text/plain; charset=UTF-8"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="/mail">
            <method id="mailREST" name="GET">
                <request>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="server" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="username" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="password" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="dbname" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="subject" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="sendto" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="content" style="query" type="xs:string"/>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ishtml" style="query" type="xs:string"/>
                </request>
                <response>
                    <representation mediaType="text/plain; charset=UTF-8"/>
                </response>
            </method>
            <resource path="/sendService">
                <method id="crunchifyREST" name="POST">
                    <request>
                        <representation mediaType="application/json"/>
                    </request>
                    <response>
                        <representation mediaType="text/plain; charset=UTF-8"/>
                    </response>
                </method>
            </resource>
        </resource>
        <resource path="device">
            <method id="get" name="GET">
                <request>
                    <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ip" style="query" type="xs:string"/>
                </request>
                <response>
                    <representation mediaType="application/xml"/>
                    <representation mediaType="application/json"/>
                </response>
            </method>
            <method id="put" name="PUT">
                <response>
                    <representation mediaType="application/xml"/>
                    <representation mediaType="application/json"/>
                </response>
            </method>
        </resource>
        <resource path="UserInfoService">
            <resource path="/name/{i}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="i" style="template" type="xs:string"/>
                <method id="userName" name="GET">
                    <response>
                        <representation mediaType="text/xml"/>
                    </response>
                </method>
            </resource>
            <resource path="/age/{j}">
                <param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="j" style="template" type="xs:int"/>
                <method id="userAge" name="GET">
                    <response>
                        <representation mediaType="text/xml"/>
                    </response>
                </method>
            </resource>
        </resource>
    </resources>
</application>


相關推薦

Java Restful Web Services （一）

REST（Representational State Transfer，表述性狀態轉移），是Roy Thomas Fielding在他2000年的博士論文《Architectural Styles and the Design of Network-based Sof

RESTful Web Service（一） 瞭解REST

1.1. REST是什麼？Roy Thomas Fielding博士2000年提出的REST是英文Representational State Transfer的縮寫  -表象化狀態轉變或者 表述性狀態

從零寫一個Java WEB框架（一）

該系列，其實是對《架構探險》這本書的實踐。本人想記錄自己的學習心得所寫下的。 從一個簡單的Servlet專案開始起步。對每一層進行優化，然後形成一個輕量級的框架。 每一篇，都是針對專案的不足點進行優化的。 專案已放上github

Java RESTful Web Service（Intellij+Tomcat+Jersey）

很多教程都到上一步為止，但執行Tomcat的時候會發現，並不能提供服務，因為依賴並沒有拷貝到web的lib下。 在Project Structure->Artifacts選擇Output Layout下Available Elements下所有的包，然後右鍵加入到web-INF/lib。

Java Web基礎（一）(HTML、Servlet/JSP)

       要成為牛逼的JavaWeb程式設計師， Java Web的基礎非常重要，現在有各種成熟的設計框架例如JQuery、Spring、Struts、Mybatis，將Java Web基礎的複雜

java-web系列（一）---搭建一個基於SSM框架的java-web專案

前言 extensible專案當前功能模組如下： 如對該專案有疑問，可在我的部落格/github下面留言，也可以以郵件的方式告知。 我的聯絡方式：[email protected] extensible 這是一個基礎的java web專案。後期我會

java後端開發（一）：基本認知之web開發是什麼

前言   前兩篇都是和資料庫基本知識有關的： 資料表設計與mysql入門（一）和 資料表設計與mysql入門（二） 。邏輯上會設計資料表操作資料庫了，但是還需要結合實際專案去加深印象。但是往下走之前，我們有必要先了解一下java web開發的相關背景知識和基礎

java web 筆記（一）

Web.xml詳解 <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application

java高級工程師（一）

jsb http協議 html tel url 實現負載均衡 為什麽 行為 get 一、無筆試題 不知道是不是職位原因還是沒遇到，面試時，都不需要做筆試題，而是填張個人信息表格，或者直接面試 二、三大框架方面問題 1、Spring 事務的隔離性，並說說每個

JAVA基礎實例（一）

actor oid 其它 返回 prime i++ con bsp factorial 1寫一個方法，用一個for循環打印九九乘法表 /** *一個for循環打印九九乘法表 */ public void nineNineMultiTable() { for

Java基礎知識整理（一）

顯式 sys 轉換 強制 print pri 字符 parse ger Java開發環境JDK(Java編輯器、Java運行工具（JRE作用）、Java文檔生成工具、Java打包工具) 1.Java是嚴格區分大小寫的。2.Java程序中一句連續的字符串不能分開在兩行書寫，

web框架（一）之基礎簡介

-a 程序 我想 pos 客戶 創建 當前 自動 art http的請求聲明周期：域名----DNS服務器---IP地址---基於tcp協議的http協議發送請求協議，服務端返回響應頭+響應體（我們所看到的頁面(是經過js渲染的，接收的是字符串)）服務端（web服務）根據我

Web service（一）

編程 壓力 iis服務器 src 都是 百度搜 方法 行程 分布式部署 概念：Web service就是可以實現不同平臺下的不同應用層程序之間數據通信，底層也是基於Socket。不同平臺之間要通信必須遵守一定的格式，所以使用開放式的XML來描述配置 一：創建第一個Web s

Yii2框架RESTful API教程（一） - 快速入門

比較 exp values cnblogs -- restful extends .cn pat 前不久做一個項目，是用Yii2框架寫一套RESTful風格的API，就去查了下《Yii 2.0 權威指南 》，發現上面寫得比較簡略。所以就在這裏寫一篇教程貼，希望幫助剛接觸Yi

Java多線程（一）

方法 trace 線程調度 lba 準備 sta pos per 退出 多線程作為Java中很重要的一個知識點，在此還是有必要總結一下的。 一.線程的生命周期及五種基本狀態 關於Java中線程的生命周期，首先看一下下面這張較為經典的圖： 上圖中基本上囊括了Jav

Java之集合初探（一）

lin 數據改變 排序。 方法 規則 找不到 集合 回收 for循環 一、集合概述、區別 集合是一種容器，數組也是一種容器 在Java編程中，裝各種各樣的對象（引用類型）的叫做容器。 為什麽出現集合類？ 面向對象語言對事物的體現都是以對象的形式，所以為了方便對多個對象的操作

Java IO學習總結（一）

file flush writer directory 創建 str java 資源 tab 一、File 類 Java中不管文件還是目錄都可以使用File類操作，File能新建、刪除、重命名文件和目錄，但是不能訪問文件內容本身，訪問文件內容需要使用輸入輸出流。 Fi

Java總結篇系列：Java多線程（一）

常見 而是 同時 private 狀態 過程 運行時 不同的 bstr Java總結篇系列：Java多線程（一） 多線程作為Java中很重要的一個知識點，在此還是有必要總結一下的。 一.線程的生命周期及五種基本狀態 關於Java中線程的生命周期，首先看一下下面這張較

Java集合框架學習（一）List

collect 有序集合 original package images 遍歷 容量 exp 子類 先附一張Java集合框架圖。 從上面的集合框架圖可以看到，Java集合框架主要包括兩種類型的容器，一種是集合（Collection），存儲一個元素集合，另一種是圖（M

編寫python web框架（一）：簡介

== web 方法 nvi ever pytho 必須 ext sim 編寫一個最簡單的應用： def app(environ, start_response): start_response(‘200 OK‘, [(‘Content-Type‘, ‘tex