Spring Boot與JAX-RS框架Jersey的完美搭配 頂 原

Jeresy是一個輕量級的JAX-RS框架

添加Jeresy 2.x的依賴

compile group: 'org.glassfish.jersey.core', name: 'jersey-client', version: '2.26'
compile group: 'org.glassfish.jersey.containers', name: 'jersey-container-servlet', version: '2.26'
compile group: 'org.glassfish.jersey.media', name: 'jersey-media-json-jackson', version: '2.26'

build.gradle文件內容:

buildscript {
	ext {
		springBootVersion = '1.5.8.RELEASE'
	}
	repositories {
        mavenLocal()
        maven{ url "http://SVN:8081/nexus/content/groups/public"}
        mavenCentral()
        jcenter()
	}
	dependencies {
		classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
	}
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'

repositories {
    mavenLocal()
    maven{ url "http://SVN:8081/nexus/content/groups/public"}
    mavenCentral()
    jcenter()
}


dependencies {
	compile('org.springframework.boot:spring-boot-configuration-processor')
	compile('org.springframework.boot:spring-boot-starter-web')
	
	compile group: 'org.glassfish.jersey.core', name: 'jersey-client', version: '2.26'
	compile group: 'org.glassfish.jersey.containers', name: 'jersey-container-servlet', version: '2.26'
	compile group: 'org.glassfish.jersey.media', name: 'jersey-media-json-jackson', version: '2.26'
	
	
	testCompile('org.springframework.boot:spring-boot-starter-test')
}

創建一個 spring boot 項目

在IDE裏一路next

• Spring Boot啓動APP

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // @wjw 是Sprnig Boot項目的核心註解,主要目的是開啓自動配置.
public class JerseyApplication {

	public static void main(String[] args) {
		SpringApplication.run(JerseyApplication.class, args);
	}

}

• 註冊jersey servlet

這和原來在 web.xml 配置的是一樣的,設置 Mapping,設置 init 初始化參數,對應的 servlet class name .
所有的rest/*請求都將被 ServletContainer jersey servlet 容器接管.

package com.example.demo;

import org.glassfish.jersey.servlet.ServletContainer;
import org.glassfish.jersey.servlet.ServletProperties;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ConfigBean {

	@Bean
	public ServletRegistrationBean jerseyServlet() {
        //手動註冊servlet
		ServletRegistrationBean registrationBean = new ServletRegistrationBean(new ServletContainer(), "/rest/*");
		registrationBean.addInitParameter(ServletProperties.JAXRS_APPLICATION_CLASS,JerseyResourceConfig.class.getName());

		return registrationBean;
	}
}

• 創建jersey Resources

packages方式是採用掃描包的方式批量註冊
register 是單個註冊

package com.example.demo;

import org.glassfish.jersey.server.ResourceConfig;
import org.springframework.web.filter.RequestContextFilter;

public class JerseyResourceConfig extends ResourceConfig {

    public JerseyResourceConfig() {
        /*
         * Servlet Filter that exposes the request to the current thread, through both org.springframework.context.i18n.LocaleContextHolder and RequestContextHolder. To be registered as filter in web.xml.<br/> 
           Alternatively, Spring's org.springframework.web.context.request.RequestContextListener and Spring's org.springframework.web.servlet.DispatcherServlet also expose the same request context to the current thread.<br/> 
           This filter is mainly for use with third-party servlets, e.g. the JSF FacesServlet. Within Spring's own web support, DispatcherServlet's processing is perfectly sufficient.<br/>
         */
        register(RequestContextFilter.class);
        
    	// 加載資源文件,這裏直接掃描com.example.demo.controller下的所有api  
        packages("com.example.demo.controller");  
        //register(HelloController.class);  //@wjw_note: 這種是註冊單個的 JAX-RS component!
    }
}

• 創建jersey Controller,使用 JAX-RS 規範的註解進行設置即可

package com.example.demo.controller;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import com.example.demo.User;

@Path("/user/")
public class HelloController {

	@Path("{id}")
	@GET
	@Produces(MediaType.APPLICATION_JSON)
	public User hello(@PathParam("id") Long id) {
		User user = new User();
		user.setID(id);
		user.setUserName("mvc.");

		return user;
	}
}

啓動Spring Boot程序

默認端口號是:8080

在瀏覽器裏測試

輸入:http://127.0.0.1:8080/rest//user/123678

返回: {"userName": "mvc.","id": 123678}