Web Service——CXF发布REST服务

阅读量：6757 次

发布时间：2019-06-26

本文共 9245 字，大约阅读时间需要 30 分钟。

1. 什么是REST

REST，英文representational state transfer(表象性状态转变)或者表述性状态转移，REST是web服务的一种架构风格，使用HTTP、URI、XML、JSON、HTML等广泛流行的标准和协议，轻量级、跨平台、跨语言的架构设计，它是一种设计风格，是一种思想，而不是一种标准。只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。

Rest要求对资源定位更加准确，如下：

非REST方式：http://ip:port/queryUser.action?userType=student&id=001

REST方式：http://ip:port/user/student/query/001

REST架构的主要原则

网络上的所有事物都被抽象为资源

每个资源都有一个唯一的资源标识符

同一个资源具有多种表现形式(xml,json等)

对资源的各种操作不会改变资源标识符

所有的操作都是无状态的

符合REST原则的架构方式即可称为RESTful

2. 发布REST服务

注意：REST 不等于WebService，JAX-RS 只是将REST 设计风格应用到Web 服务开发上。

2.1 需求

发布查询学生信息的服务，以json和xml数据格式返回。

2.2 服务端

第一步：导入jar包

第二步：创建学生pojo类，要加入@ XmlRootElement

import java.util.Date;import javax.xml.bind.annotation.XmlRootElement;@XmlRootElement(name = "student") // @XmlRootElement可以实现对象和XML数据之间的转换public class Student {    private long id;    private String name;    private Date birthday;    ···}

第三步：创建SEI接口（主要步骤，注意注解使用）

import java.util.List;import javax.jws.WebService;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.zang.ws.rest.pojo.Student;@WebService@Path("/student") // @Path("/student")就是将请求路径中的“/student”映射到接口上public interface StudentInterface {    // 查询单个学生    @GET // 指定请求方式，如果服务端发布的时候指定的是GET（POST），那么客户端访问时必须使用GET（POST）    @Produces(MediaType.APPLICATION_XML) // 指定服务数据类型    @Path("/query/{id}") // @Path("/query/{id}")就是将“/query”映射到方法上，“{id}”映射到参数上，多个参数，以“/”隔开，放到“{}”中    public Student query(@PathParam("id") long id);    // 查询多个学生    @GET // 指定请求方式，如果服务端发布的时候指定的是GET（POST），那么客户端访问时必须使用GET（POST）    @Produces({ "application/json;charset=utf-8", MediaType.APPLICATION_XML }) // 指定服务数据类型    @Path("/queryList/{name}") // @Path("/queryList/{name}")就是将“/queryList”映射到方法上，“{name}”映射到参数上，多个参数，以“/”隔开，放到“{}”中    public List
     
       queryList(@PathParam("name") String name);}

第四步：创建SEI实现类

import java.util.ArrayList;import java.util.Date;import java.util.List;import com.zang.ws.rest.pojo.Student;public class StudentInterfaceImpl implements StudentInterface {    @Override    public Student query(long id) {        Student st = new Student();        st.setId(101);        st.setName("小华");        st.setBirthday(new Date());        return st;    }    @Override    public List
     
       queryList(String name) {        Student s1 = new Student();        s1.setId(101);        s1.setName("小华");        s1.setBirthday(new Date());                Student s2 = new Student();        s2.setId(102);        s2.setName("小黄");        s2.setBirthday(new Date());                List
      
        list = new ArrayList
       
        ();        list.add(s1);        list.add(s2);        return list;    }}

第五步：发布服务，JAXRSServerFactoryBean发布服务，3个参数，1：服务实现类；2.设置资源类；3.设置服务地址

package com.zang.ws.rest.server;import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;public class StudentServer {    public static void main(String[] args) {        // JAXRSServerFactoryBean发布REST的服务        JAXRSServerFactoryBean jaxRSServerFactoryBean = new JAXRSServerFactoryBean();        // 设置服务实现类        jaxRSServerFactoryBean.setServiceBean(new StudentInterfaceImpl());        // 设置资源类，如果有多个资源类，可以以“,”隔开。        jaxRSServerFactoryBean.setResourceClasses(StudentInterfaceImpl.class);        // 设置服务地址        jaxRSServerFactoryBean.setAddress("http://127.0.0.1:12345/user");        // 发布服务        jaxRSServerFactoryBean.create();    }}

第六步：访问即可

1 查询单个学生，返回XML数据

查询多个学生，返回JSON

查询多个学生，返回XML

注意：

如果服务端发布时指定请求方式是GET（POST），客户端必须使用GET（POST）访问服务端，否则会报异常。

如果在同一方法上同时指定XML和JSON媒体类型，在GET请求下，默认返回XML，在POST请求下，默认返回JSON。

2.3 客户端

客户端主要获取服务端发布的数据并解析

测试POST请求，将StudentInterface接口中的queryList方法声明为@POST

import java.io.BufferedReader;import java.io.IOException;import java.io.InputStream;import java.io.InputStreamReader;import java.net.HttpURLConnection;import java.net.URL;public class HttpClient {    public static void main(String[] args) throws IOException {        //第一步：创建服务地址，不是WSDL地址        URL url = new URL("http://127.0.0.1:12345/user/student/queryList/101");        //第二步：打开一个通向服务地址的连接        HttpURLConnection connection = (HttpURLConnection) url.openConnection();        //第三步：设置参数        //3.1发送方式设置：POST必须大写        connection.setRequestMethod("POST");        //3.2设置数据格式：content-type        //3.3设置输入输出，因为默认新创建的connection没有读写权限，        connection.setDoInput(true);        //第五步：接收服务端响应，打印        int responseCode = connection.getResponseCode();        if(200 == responseCode){
   //表示服务端响应成功            InputStream is = connection.getInputStream();            InputStreamReader isr = new InputStreamReader(is);            BufferedReader br = new BufferedReader(isr);                        StringBuilder sb = new StringBuilder();            String temp = null;            while(null != (temp = br.readLine())){                sb.append(temp);            }            System.out.println(sb.toString());                        is.close();            isr.close();            br.close();        }    }}

3. CXF+Spring整合发布REST的服务

3.1 服务端

第一步：创建web项目（引入jar包）

第二步：创建POJO类

第三步：创建SEI接口

第四步：创建SEI实现类

第五步：配置Spring配置文件,applicationContext.xml，<jaxrs:server>，设置1.服务地址；2.服务实现类

第六步：配置web.xml


     
       
      
       ws_cxf_spring_rest_server
          
        
            
             
       
        contextConfigLocation
             
       
        classpath:applicationContext.xml
         
        
            
       
        org.springframework.web.context.ContextLoaderListener
         
          
        
            
       
        CXF
             
       
        org.apache.cxf.transport.servlet.CXFServlet
         
        
            
       
        CXF
             
       
        /ws/*

第七步：发布到tomcat并访问

REST服务的使用说明书地址：

客户端使用ajax或其他方式都可以，这里不再重复。

4. 案例整合

4.1 需求

集成公网手机号归属地查询服务

对外发布自己的手机号归属地查询服务

提供查询界面

4.2 开发

第一步：创建web项目（引入jar包）

第二步：生成公网客户端代码

wsdl2java -p com.zang.mobile -d . http://ws.webxml.com.cn/WebServices/MobileCodeWS.asmx?WSDL

第三步：创建SEI接口

import javax.jws.WebService;@WebServicepublic interface MobileInterface {    public String queryMobile(String phoneNum);}

第四步：创建SEI实现类

import com.zang.mobile.MobileCodeWSSoap;public class MobileInterfaceImpl implements MobileInterface {    private MobileCodeWSSoap mobileClient;        @Override    public String queryMobile(String phoneNum) {        return mobileClient.getMobileCodeInfo(phoneNum, "");    }    public MobileCodeWSSoap getMobileClient() {        return mobileClient;    }    public void setMobileClient(MobileCodeWSSoap mobileClient) {        this.mobileClient = mobileClient;    }}

第五步：创建queryMobile.jsp

<%@ page language="java" contentType="text/html; charset=utf-8"    pageEncoding="utf-8"%>
     手机号归属查询网站    
     
              手机号归属地查询：
        
      
      
        查询结果：${result}

第六步：创建MobileServlet.java

import java.io.IOException;import javax.servlet.ServletException;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import org.springframework.context.ApplicationContext;import org.springframework.web.context.support.WebApplicationContextUtils;import com.zang.mobile.server.MobileInterface;public class MobileServlet extends HttpServlet{    private MobileInterface mobileServer;    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {        String phoneNum = request.getParameter("phoneNum");        if(null != phoneNum && !"".equals(phoneNum)){            ApplicationContext context = WebApplicationContextUtils.getWebApplicationContext(this.getServletContext());            mobileServer = (MobileInterface) context.getBean("mobileServer");            String result = mobileServer.queryMobile(phoneNum);            request.setAttribute("result", result);        }        request.getRequestDispatcher("/WEB-INF/jsp/queryMobile.jsp").forward(request, response);    }    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {        this.doGet(request, response);    }}

第七步：配置spring配置文件，applicationContext.xml

第八步：配置web.xml


     
       
      
       cxf_rest_spring_mobile
           
        
            
             
       
        contextConfigLocation
             
       
        classpath:applicationContext.xml
         
        
            
       
        org.springframework.web.context.ContextLoaderListener
         
          
        
            
       
        CXF
             
       
        org.apache.cxf.transport.servlet.CXFServlet
         
        
            
       
        CXF
             
       
        /ws/*
         
        
        
            
       
        mobileServlet
             
       
        com.zang.mobile.server.servlet.MobileServlet
         
        
            
       
        mobileServlet
             
       
        *.action
         
            
          
       
        index.jsp