logo
搜索
我的图书馆

发文章

发文工具

其他工具

留言交流
搜索
分享

CXF系列（六）：CXF实现REST接口开发...

 昵称10087950 2022-09-01 发布于江苏

这一篇来实现REST开发接口，具体的概念以及和SOAP的区别参考上一篇文章。

1：pom.xml

<project xmlns="http://maven./POM/4.0.0" xmlns:xsi="http://www./2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven./POM/4.0.0 http://maven./xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.qqw</groupId>
  <artifactId>CXF_Spring_restful</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>CXF_Spring_restful</name>
  <url>http://maven.</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    
    <!-- 添加Spring支持 -->
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-core</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-beans</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	<dependency>
	     <groupId>org.springframework</groupId>
	     <artifactId>spring-tx</artifactId>
	     <version>4.1.7.RELEASE</version>
	    </dependency>
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-context</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-context-support</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	 
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-web</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	 
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-webmvc</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	 
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-aop</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	 
	 
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-aspects</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
	 
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-jdbc</artifactId>
	    <version>4.1.7.RELEASE</version>
	</dependency>
    
    
    <!-- 添加cxf支持  -->
	 
	<dependency>
	    <groupId>org.apache.cxf</groupId>
	    <artifactId>cxf-rt-transports-http</artifactId>
	    <version>3.1.5</version>
	</dependency>
        //项目里面所有的注解在这个api包下面
	<dependency>
	    <groupId>javax.ws.rs</groupId>
	    <artifactId>javax.ws.rs-api</artifactId>
	    <version>2.0.1</version>
	</dependency>
	//这是json处理的包，目前这知道这个，GSON和fastjson没尝试
	<dependency>
	    <groupId>org.codehaus.jackson</groupId>
	    <artifactId>jackson-jaxrs</artifactId>
	    <version>1.9.13</version>
	</dependency>
	
	<dependency>
	    <groupId>org.apache.cxf</groupId>
	    <artifactId>cxf-rt-frontend-jaxrs</artifactId>
	    <version>3.1.4</version>
	</dependency>
	
    <!--实现日志  -->
    <dependency>
	    <groupId>org.slf4j</groupId>
	    <artifactId>slf4j-log4j12</artifactId>
	    <version>1.7.22</version>
    </dependency>
    
    
  </dependencies>
</project>

2：web.xml这个和之前一样，没什么变化

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns:xsi="http://www./2001/XMLSchema-instance" xmlns="http://java./xml/ns/javaee" xmlns:web="http://java./xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java./xml/ns/javaee http://java./xml/ns/javaee/web-app_3_0.xsd" id="WebApp_ID" version="3.0">
  3.   <display-name>CXF_Spring_restful</display-name>
  4.   <welcome-file-list>
  5.     <welcome-file>index.html</welcome-file>
  6.     <welcome-file>index.htm</welcome-file>
  7.     <welcome-file>index.jsp</welcome-file>
  8.     <welcome-file>default.html</welcome-file>
  9.     <welcome-file>default.htm</welcome-file>
  10.     <welcome-file>default.jsp</welcome-file>
  11.   </welcome-file-list>
  13. 	<context-param>
  14. 		<param-name>webAppRootKey</param-name>
  15. 		<param-value>CXF_Spring_restful.root</param-value>
  16. 	</context-param>
  17.   <!-- 处理编码格式 -->
  18.     <filter>  
  19.         <filter-name>characterEncodingFilter</filter-name>  
  20.         <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
  21.         <init-param>  
  22.             <param-name>encoding</param-name>  
  23.             <param-value>UTF-8</param-value>  
  24.         </init-param>  
  25.         <init-param>  
  26.             <param-name>forceEncoding</param-name>  
  27.             <param-value>true</param-value>  
  28.         </init-param>  
  29.     </filter>  
  30.     <filter-mapping>  
  31.         <filter-name>characterEncodingFilter</filter-name>  
  32.         <url-pattern>/*</url-pattern>  
  33.     </filter-mapping>
  35.     <!-- Log4J Start -->
  36. 	<context-param>
  37. 		<param-name>log4jConfigLocation</param-name>
  38. 		<param-value>classpath:log4j.properties</param-value>
  39. 	</context-param>
  40. 	<context-param>
  41. 		<param-name>log4jRefreshInterval</param-name>
  42. 		<param-value>6000</param-value>
  43. 	</context-param>
  44. 	<!-- Spring Log4J config -->
  45. 	<listener>
  46. 		<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
  47. 	</listener>
  49. 	<!-- Spring配置文件 -->
  50. 	<context-param>
  51. 	    <param-name>contextConfigLocation</param-name>
  52. 	    <param-value>classpath:applicationContext.xml</param-value>
  53. 	</context-param>
  54. 	<listener>
  55. 	    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  56. 	</listener>
  58. 	<servlet>  
  59. 	 <servlet-name>CXFServlet</servlet-name>  
  60. 	 <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>  
  61. 	</servlet>  
  63. 	<servlet-mapping>  
  64. 	   <servlet-name>CXFServlet</servlet-name>  
  65. 	   <url-pattern>/webservice/*</url-pattern>  
  66. 	</servlet-mapping>
  69. </web-app>

3：applicationContext.xml和之前的不一样

  1. <?xml version="1.0" encoding="UTF-8"?>    
  2. <beans xmlns="http://www./schema/beans"    
  3.     xmlns:xsi="http://www./2001/XMLSchema-instance"   
  4.     xmlns:p="http://www./schema/p"  
  5.     xmlns:aop="http://www./schema/aop"   
  6.     xmlns:context="http://www./schema/context"  
  7.     xmlns:jee="http://www./schema/jee"  
  8.     xmlns:tx="http://www./schema/tx"  
  9.     xmlns:jaxrs="http://cxf./jaxrs"
  10.     xsi:schemaLocation="    
  11.         http://www./schema/aop http://www./schema/aop/spring-aop-4.0.xsd  
  12.         http://www./schema/beans http://www./schema/beans/spring-beans-4.0.xsd  
  13.         http://www./schema/context http://www./schema/context/spring-context-4.0.xsd  
  14.         http://www./schema/jee http://www./schema/jee/spring-jee-4.0.xsd  
  15.         http://www./schema/tx http://www./schema/tx/spring-tx-4.0.xsd
  16.         http://cxf./jaxrs http://cxf./schemas/jaxrs.xsd">    
  18.     <!-- 自动扫描 -->
  19. 	<context:component-scan base-package="com.qqw" />
  21. 	<!-- 定义服务提供者  -->
  22. 	<jaxrs:server id="webService" address="/">
  23.         <!--输入拦截器设置-->
  24.         <jaxrs:inInterceptors>
  25.             <bean class="org.apache.cxf.interceptor.LoggingInInterceptor"/>
  26.         </jaxrs:inInterceptors>
  28.         <!--输出拦截器设置-->
  29.         <jaxrs:outInterceptors>
  30.             <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor"/>
  31.         </jaxrs:outInterceptors>
  33.         <!--serviceBeans：暴露的WebService服务类-->
  34.         <jaxrs:serviceBeans>
  35.             <ref bean="studentService"/>
  36.         </jaxrs:serviceBeans>
  38.         <!--支持的协议-->
  39.         <jaxrs:extensionMappings>
  40.             <entry key="json" value="application/json"/>
  41.             <entry key="xml" value="application/xml"/>
  42.         </jaxrs:extensionMappings>
  43.         <!--编码格式-->
  44.         <jaxrs:languageMappings>
  46.         </jaxrs:languageMappings>
  47.         <!--对象转换-->
  48.         <jaxrs:providers>
  49.             <bean class="org.codehaus.jackson.jaxrs.JacksonJaxbJsonProvider"/>
  50.         </jaxrs:providers>
  52.     </jaxrs:server>
  53. </beans>

4：一个实体类 
  1. package com.qqw.entity;
  3. public class Student {
  5. 	private String name;
  6. 	private String sex;
  7. 	private Integer age;
  8. 	public Student() {
  9. 		super();
  10. 		// TODO Auto-generated constructor stub
  11. 	}
  12. 	public Student(String name, String sex, Integer age) {
  13. 		super();
  14. 		this.name = name;
  15. 		this.sex = sex;
  16. 		this.age = age;
  17. 	}
  18. 	public String getName() {
  19. 		return name;
  20. 	}
  21. 	public void setName(String name) {
  22. 		this.name = name;
  23. 	}
  24. 	public String getSex() {
  25. 		return sex;
  26. 	}
  27. 	public void setSex(String sex) {
  28. 		this.sex = sex;
  29. 	}
  30. 	public Integer getAge() {
  31. 		return age;
  32. 	}
  33. 	public void setAge(Integer age) {
  34. 		this.age = age;
  35. 	}
  39. }

5：在写接口前一些注解的概念参考这篇文章： JAX-RS规范-常用注解浅析

接口StudentService.java

  1. package com.qqw.webservice;
  3. import java.util.List;
  5. import javax.ws.rs.GET;
  6. import javax.ws.rs.Path;
  7. import javax.ws.rs.PathParam;
  8. import javax.ws.rs.Produces;
  9. import javax.ws.rs.core.MediaType;
  12. import com.qqw.entity.Student;
  14. @Path("/studentService")
  15. @Produces(MediaType.APPLICATION_JSON)
  16. public interface StudentService {
  18.     //参看是否有这个学生
  19.     @GET
  20.     @Path("/status/{name}/{age}")
  21.     public String getStatus(@PathParam("name") String name,@PathParam("age") Integer age);
  23.     //通过id查看学生信息
  24.     @GET
  25.     @Path("/student/{index}")
  26.     public Student getStudentById(@PathParam("index") Integer id);
  28.     //查看所有学生信息
  29.     @GET
  30.     @Path("/student")
  31.     public List<Student> getStudentList();
  33. }

6：接口实现类 
  1. package com.qqw.webserviceImpl;
  3. import java.util.List;
  4. import java.util.ArrayList;
  6. import javax.ws.rs.GET;
  7. import javax.ws.rs.Path;
  8. import javax.ws.rs.PathParam;
  10. import org.springframework.stereotype.Component;
  12. import com.qqw.entity.Student;
  13. import com.qqw.webservice.StudentService;
  15. @Component("studentService")
  16. public class StudenntServiceImpl implements StudentService {
  20. 	@Override
  22. 	public Student getStudentById( Integer id) {
  24. 		Student student=null;
  25. 		if(id==1){
  26. 			student=new Student("张三", "男", 20);
  27. 		}else{
  28. 			student=new Student("李四娘", "女", 30);
  29. 		}
  30. 		return student;
  31. 	}
  33. 	@Override
  34. 	public List<Student> getStudentList() {
  36. 		List<Student> list=new ArrayList<Student>();
  37. 		Student student=new Student("张三", "男", 20);
  38. 		Student student1=new Student("李四娘", "女", 30);
  39. 		Student student2=new Student("李1娘", "女", 31);
  40. 		Student student3=new Student("李2娘", "女", 32);
  41. 		Student student4=new Student("李3娘", "女", 20);
  42. 		list.add(student);
  43. 		list.add(student1);
  44. 		list.add(student2);
  45. 		list.add(student3);
  46. 		list.add(student4);
  47. 		return list;
  48. 	}
  50. 	@Override
  51. 	public String getStatus(String name, Integer age) {
  53. 		String flag="FAULSE";
  54. 		if("tom狗".equals(name) && age==20){
  55. 			 flag="TRUE";
  56. 		}
  57. 		return flag;
  58. 	}
  60. }

至此项目与spring整合完毕，把项目部署到tomcat。

测试第一个接口：http://localhost:8080/CXF_Spring_restful/webservice/studentService/status/tom狗/30，结果：

控制台信息：

测试第二个接口：

第三个接口：

到此，CXF系列完毕！！！完整代码

    本站是提供个人知识管理的网络存储空间，所有内容均由用户发布，不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息，谨防诈骗。如发现有害或侵权内容，请点击一键举报。
    转藏 分享 献花（0）

    来自： 昵称10087950 > 《JAVA》

    举报/认领

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多