使用cxf開發restful接口

原創 Min_Monk 2020-06-23 05:48

  1. 新建maven工程

    1. 新建maven工程

  2. 添加pom依賴

    2. <project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.demo</groupId>
	<artifactId>cxf-restful</artifactId>
	<packaging>war</packaging>
	<version>0.0.1-SNAPSHOT</version>
	<name>cxf-restful Maven Webapp</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
		<cxf-version>3.1.1</cxf-version>
		<spring-version>5.1.5.RELEASE</spring-version>
		<slfj-version>1.7.25</slfj-version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${spring-version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
			<version>${spring-version}</version>
		</dependency>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>${spring-version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-beans</artifactId>
			<version>${spring-version}</version>
		</dependency>
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-api</artifactId>
			<version>${slfj-version}</version>
		</dependency>
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-log4j12</artifactId>
			<version>${slfj-version}</version>
			<!--<scope>test</scope> -->
		</dependency>
		<dependency>
			<groupId>commons-lang</groupId>
			<artifactId>commons-lang</artifactId>
			<version>2.4</version>
		</dependency>

		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-core</artifactId>
			<version>${cxf-version}</version>
		</dependency>
		<dependency>
			<groupId>javax.ws.rs</groupId>
			<artifactId>javax.ws.rs-api</artifactId>
			<version>2.0.1</version>
		</dependency>
		<dependency>
			<groupId>javaee</groupId>
			<artifactId>javaee-api</artifactId>
			<version>5</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxrs</artifactId>
			<version>${cxf-version}</version>
		</dependency>
		<dependency>
			<groupId>org.codehaus.jackson</groupId>
			<artifactId>jackson-jaxrs</artifactId>
			<version>1.9.13</version>
		</dependency>
		<dependency>
			<groupId>org.codehaus.jackson</groupId>
			<artifactId>jackson-xc</artifactId>
			<version>1.9.13</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-transports-http</artifactId>
			<version>${cxf-version}</version>
			<scope>compile</scope>
		</dependency>


	</dependencies>
	<build>
		<finalName>cxf-restful</finalName>
	</build>
</project>

       

  3. 編輯web.xml

    2. <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4"
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">


	<display-name>CXF Restful Demo</display-name>

	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath*:META-INF/spring/applicationContext*.xml</param-value>
	</context-param>

	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>

	<!-- 配置CXFservlet -->
	<servlet>
		<servlet-name>CXFServlet</servlet-name>
		<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
		<load-on-startup>1</load-on-startup>
	</servlet>

	<servlet-mapping>
		<servlet-name>CXFServlet</servlet-name>
		<url-pattern>/service/*</url-pattern>
	</servlet-mapping>

	<!-- 設置允許跨域  視情況而定是否需要支持跨域-->
	<filter>
		<filter-name>CORSFilter</filter-name>
		<filter-class>com.demo.cxf.restful.filter.CORSFilter</filter-class>
	</filter>
	<filter-mapping>
		<filter-name>CORSFilter</filter-name>
		<url-pattern>/service/*</url-pattern>
	</filter-mapping>

</web-app>

       

  4. 編寫測試代碼

    1. 添加配置文件
      1. 添加log4j.properties配置文件，方便輸出日誌 
        log4j.rootLogger=INFO, console,dailyFile

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n


log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

         

      2. /src/main/resources/META-INF/spring目錄下新建applicationContent-rest.xml(cxf配置文件) 
        <?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:cxf="http://cxf.apache.org/core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:jaxrs="http://cxf.apache.org/jaxrs" 
	xsi:schemaLocation="
	http://cxf.apache.org/core 
	http://cxf.apache.org/schemas/core.xsd 
	http://cxf.apache.org/jaxrs 
	http://cxf.apache.org/schemas/jaxrs.xsd 
	http://www.springframework.org/schema/beans 
	http://www.springframework.org/schema/beans/spring-beans.xsd">
	
	<bean id="InquiryServiceImpl" class="com.demo.cxf.restful.service.impl.InquiryServiceImpl" />
	<bean id="logOutbound" class="org.apache.cxf.interceptor.LoggingOutInterceptor" />
	<bean id="logInbound" class="org.apache.cxf.interceptor.LoggingInInterceptor" />
	
	<jaxrs:server id="InquiryService" address="/InquiryService">
		<!--輸入攔截器設置 -->
		<jaxrs:inInterceptors>
			<ref bean="logInbound" />
		</jaxrs:inInterceptors>
		
		<!--serviceBeans：暴露的WebService服務類 -->
		<jaxrs:serviceBeans>
			<ref bean="InquiryServiceImpl"/>
		</jaxrs:serviceBeans>

		<!--輸出攔截器設置 -->
		<jaxrs:outInterceptors>
			<ref bean="logOutbound" />
		</jaxrs:outInterceptors>
		
		<!--支持的數據傳輸格式 -->
		<jaxrs:extensionMappings>
			<entry key="json" value="application/json"/>
			<entry key="xml" value="application/xml"/>
		</jaxrs:extensionMappings>
		
		<!--編碼格式 -->
		<jaxrs:languageMappings>
			<entry key="en" value="en-gb"/>
		</jaxrs:languageMappings>
		
		<!--對象轉換 -->
		<jaxrs:providers>
			<bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider" />
		</jaxrs:providers>
	</jaxrs:server>
</beans>
    2. 編寫java代碼
      1. 新建實體類  Student.java 
        package com.demo.cxf.restful.entity;

import java.io.Serializable;

import org.codehaus.jackson.annotate.JsonProperty;

public class Student implements Serializable{
    
    private static final long serialVersionUID = 2762010594480998117L;

    @JsonProperty("ID")
    private Long id;
    
    @JsonProperty("NAME")
    private String name;
    
    @JsonProperty("SEX")
    private String sex;
    
    @JsonProperty("AGE")
    private Integer age;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
    
    public Student() {
        
    }
    
    public Student(Long id, String name, String sex, Integer age) {
        super();
        this.id = id;
        this.name = name;
        this.sex = sex;
        this.age = age;
    }
}

         

      2. 新建接口類  InquiryService.java 
        package com.demo.cxf.restful.service.impl;

import java.util.List;

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

import com.demo.cxf.restful.entity.Student;

@Produces(MediaType.APPLICATION_JSON)
public interface InquiryService {

    @GET
    @Path("/student")
    public List<Student> list();

    @POST
    @Path("/getStudentById")
    @Consumes(MediaType.APPLICATION_JSON)
    public Student getStudentById(Student stu);

    @GET
    @Path("/getStudent/{id}")
    @Consumes({ MediaType.TEXT_XML, MediaType.APPLICATION_JSON })
    public Student getStudent(@PathParam("id") Integer id);

    @GET
    @Path("/studentParam")
    @Consumes({ MediaType.TEXT_XML, MediaType.APPLICATION_JSON })
    public Student studentParam(@QueryParam("id") Integer id);
}

         

      3. 新建接口實現類   InquiryServiceImpl.java 
        package com.demo.cxf.restful.service.impl;

import java.util.ArrayList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.demo.cxf.restful.entity.Student;

public class InquiryServiceImpl implements InquiryService {
private static final Logger logger = LoggerFactory.getLogger(InquiryServiceImpl.class);
    
    @Override
    public List<Student> list() {
        List<Student> result = initData();
        return result;
    }
    
    @Override
    public Student getStudentById(Student param) {
        logger.info("param" + param);
        List<Student> result = initData();
        return result.get(param.getId().intValue());
    }
    
    @Override
    public Student getStudent(Integer id){
        logger.info("id" + id);
        List<Student> result = initData();
        
        return result.get(id);
    }
    
    @Override
    public Student studentParam(Integer id) {
        logger.info("id" + id);
        List<Student> result = initData();
        return result.get(id);
    }
    
    private List<Student> initData(){
        List<Student> result = new ArrayList<Student>();
        for (int i = 0; i < 10; i++) {
            Student stu = null;
            if(i%2 == 0) {
                stu = new Student(Long.valueOf(i), "Jack" + i, "男", i);
            }else {
                stu = new Student(Long.valueOf(i), "Mary" + i, "女", i);
            }
            result.add(stu);
        }
        return result;
    }
}

         

      4. 自定義 跨域過濾器  CORSFilter.java 
        package com.demo.cxf.restful.filter;

import java.io.IOException;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class CORSFilter implements Filter{

    @Override
    public void destroy() {
        // TODO Auto-generated method stub
        
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
            throws IOException, ServletException {
      //設置跨域請求
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) res;
        String[] allowDomains = {"http://runapi.showdoc.cc"};
        Set allowOrigins = new HashSet(Arrays.asList(allowDomains));
        String originHeads = request.getHeader("origin");
        if(allowOrigins.contains(originHeads)){
            response.setHeader("Access-Control-Allow-Origin", originHeads);
            response.setHeader("Access-Control-Allow-Methods", "POST,GET,OPTIONS,DELETE,HEAD,PUT,PATCH");
            response.setHeader("Access-Control-Max-Age", "36000");
            response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept, Connection, User-Agent, Cookie");
            response.setHeader("Access-Control-Allow-Credentials","true");
        }
        chain.doFilter(req, response);
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
        // TODO Auto-generated method stub
        
    }
}

         

  5. 測試接口

    1. 至此，使用cxf開發rrestful接口已經開發完成了，下面就是測試接口訪問情況
發表評論
所有評論
還沒有人評論，想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章

分佈式系統各個節點狀態如何同步？淺談一下

寫在前面：2020年面試必備的Java後端進階面試題總結了一份複習指南在Github上，內容詳細，圖文並茂，有需要學習的朋友可以Star一下！ GitHub地址：https://github.com/abel-max/Java-S

毛发旺盛的程序员 2020-07-08 12:27:30

阿里年薪破百架構師推薦：鳥哥的Linux私房菜，搭配面試題，真香

在Linux實操的過程中，你是否有過這些疑問： 如何提取日誌中含有關鍵字的指定行，上一行或上幾行？ ln 做了符號鏈接，對符號鏈接進行權限修改，原文件是否會受到影響？ Shell 腳本里有很多特殊符號，到底該怎麼用？網上流傳的

毛发旺盛的程序员 2020-07-08 12:27:30

ZooKeeper 一致性協議 ZAB 原理，瞭解一下

一致性協議有很多種，比如 Paxos，Raft，2PC，3PC等等，在這講一種協議，ZAB 協議，該協議應該是所有一致性協議中生產環境中應用最多的了。爲什麼？因爲它是爲 Zookeeper 設計的分佈式一致性協議！ 1. 什麼是

毛发旺盛的程序员 2020-07-08 12:27:20

Spring中Transactional 失效的解決方案，讓我們一起探討一下

寫在前面：2020年面試必備的Java後端進階面試題總結了一份複習指南在Github上，內容詳細，圖文並茂，有需要學習的朋友可以Star一下！ GitHub地址：https://github.com/abel-max/Java-S

毛发旺盛的程序员 2020-07-08 12:27:20

太狠了,Spring全家桶筆記,一站式通關全攻略,已入職某廠漲薪18K

Spring 早已成爲 Java 後端開發事實上的行業標準，無數的公司選擇 Spring 作爲基礎的開發框架，大部分Java 後端程序員在日常工作中也會接觸到 Spring ，因此，如何用好 Spring ，也就成爲 Java

毛发旺盛的程序员 2020-07-08 12:27:20

面試準備季——MyBatis 面試專題（含答案）

寫在前面：2020年面試必備的Java後端進階面試題總結了一份複習指南在Github上，內容詳細，圖文並茂，有需要學習的朋友可以Star一下！ GitHub地址：https://github.com/abel-max/Java-S

毛发旺盛的程序员 2020-07-08 12:27:20

【JAVA】 try catch finally 中包含return的幾種情況，及返回結果

第一種情況：在try和catch中有return，finally中沒有return，且finally中沒有對try或catch中要 return。這種情況，無論如何finally中的代碼塊都會執行，然後再執行try或者finall

never疯 2020-07-08 12:23:53

劍指Offer_編程題_二叉搜索樹的後序遍歷序列

題目描述 輸入一個整數數組，判斷該數組是不是某二叉搜索樹的後序遍歷的結果。如果是則輸出Yes,否則輸出No。假設輸入的數組的任意兩個數字都互不相同。 補充： 二叉查找樹（Binary Search Tree）又：二叉搜索樹，二叉排序樹，它

浮煌 2020-07-08 11:43:28

劍指Offer_編程題_樹的子結構

題目描述 輸入兩棵二叉樹A，B，判斷B是不是A的子結構。（ps：我們約定空樹不是任意一個樹的子結構） 思路：將B與A，A的左子樹，A的右子樹分別進行判斷，如果元素不相等返回 false ,運用遞歸直到A子樹爲空此時返回 false /*

浮煌 2020-07-08 11:43:28

java的二分查找源碼分析

前言：         之前用到二分查找的時候，都是自己手寫一個，雖然並不難，但是有的時候會忽略邊界條件，然後時間久了還會忘記，然後今天發現，Java其實已經實現了數組的二分查找，這裏就分析一下它的源碼   1:該方法在 Arrays.j

Cison chen 2020-07-08 11:07:50

android程序退出方案

在Android中退出程序比較麻煩，尤其是在多個Activity的程序中，在2.2之前可以採用如下代碼退出程序： Java代碼   ActivityManager am = (ActivityManager)getSystemS

shangmin1990 2020-07-08 11:03:08

啥時候用interface，啥時候用abstract類？ 就一句話

有初學者問interface和abstract類該怎樣選擇的問題，不扯麪試題那些，其實就一句話：   定義爲abstract類， 就是爲了定義較多的已實現方法好讓人繼承；繼承者就不用寫這麼多的實現了，可以直接拿來用； 定義爲interfa

_躬行_ 2020-07-08 10:35:56

#idea#一個Java工程頻繁被idea修改jdk版本問題

困擾。。。 發現創建maven工程師pom.xml文件中編譯版本寫爲1.7了，修改後再沒出現。 <properties> <project.build.sourceEncoding>UTF-8</project.build.sou

码农丁丁 2020-07-08 10:28:41

Head First Servlet/JSP 學習筆記(1)

     一次在逛書店的時候，偶然發現這本書的，爲之驚豔，所以買了回來給學生看。過了幾個月，自己閒下來，也準備系統看看，雖然做了兩個Struts, Spring, Hibernate的項目，覺得知識還不是很系統。 1. servlet沒有

fan_7 2020-07-08 09:39:41

【MAVEN】編譯報錯Perhaps you are running on a JRE rather than a JDK?

問題：mvn -e clean package 報錯log： [ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.1:co

弘毅密令 2020-07-08 09:18:10