webservice 基于restful

最新推荐文章于 2023-10-23 15:47:32 发布

原创最新推荐文章于 2023-10-23 15:47:32 发布 · 558 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

webservice 专栏收录该内容

1 篇文章

订阅专栏

这篇博客介绍了如何基于Java使用CXF框架创建RESTful Web Service。首先，通过Maven引入相关依赖，然后定义接口和实现类。接着，配置cxf-config.xml文件。完成配置后，可以在浏览器中输入特定URL查看可用的RESTful服务。最后，通过示例展示了如何获取JSON数据。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

maven依赖

<dependencies>
		<!-- 提供JacksonJsonProvider，非必需，学过jersey，所以在这块直接使用了，可以使用其他json转化替换，使用cxf的有很多问题，没法填 -->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-jersey</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-spring-boot-starter-jaxrs</artifactId>
			<version>3.1.11</version>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>1.3.1</version>
		</dependency>
 
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.7</version>
		</dependency>
		<dependency>
			<groupId>org.jsoup</groupId>
			<artifactId>jsoup</artifactId>
			<version>1.9.2</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxws</artifactId>
			<version>3.1.6</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-transports-http</artifactId>
			<version>3.1.6</version>
		</dependency>
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-transports-http-jetty</artifactId>
			<version>3.1.6</version>
		</dependency>
	</dependencies>

package com.pds.webservice;
 
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
 
import javax.xml.bind.annotation.XmlRootElement;
import java.io.Serializable;
 
/**
 * Created with IDEA
 *
 * @author yunfei.zhao
 * @Date:2019/6/26
 * @Time:10:33
 */
@XmlRootElement(name = "Student")
@Data
@ToString
@NoArgsConstructor//构造方法 无参
@AllArgsConstructor//构造方法全部
public class Student implements Serializable {
    private static final long serialVersionUID = 1L;
    private Integer id;
    private String name;
    private char sex;
    private String address;
    private Integer age;
}

package com.pds.webservice;
 
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
 
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import java.util.List;
 
/**
 * Created with IDEA
 *
 * @author yunfei.zhao
 * @Date:2019/6/26
 * @Time:10:32
 */
@XmlRootElement(name = "Students")
@NoArgsConstructor
@AllArgsConstructor
public class Students {
    public List<Student> students;
    @XmlElement(name = "student")
    public List<Student> getStudents() {
        return students;
    }
 
    public void setStudents(List<Student> students) {
        this.students = students;
    }
}

接口

package com.pds.webservice.result;

import com.pds.webservice.Student;
import com.pds.webservice.Students;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

/**
 * Created with IDEA
 *  // / 没有这个rest失效 只存在soap  配置在启动类上
   @ImportResource(locations = { "classpath:cxf-config.xml" })
 * @author yunfei.zhao
 * @Date:2019/6/26
 * @Time:14:43
 */
@Consumes({MediaType.APPLICATION_JSON,MediaType.APPLICATION_XML})
public interface StudentInterface {

    @GET
    @Produces({MediaType.APPLICATION_JSON,MediaType.APPLICATION_XML})
    @Path("/getone/{id:[0-9]{0,10}}") // 限制id只能是0~9的数组 不超过10位
    public Student GetStudent(@PathParam("id") Integer id );

    /**
     * 查找多个学生
     *
     * @param ids
     * @return
     */

    @GET
    @Produces({ MediaType.APPLICATION_JSON })
    @Path("/getmany/{ids}")
    public Students getAllStudent(@PathParam("ids") String ids);
    /**
     * 测试PUT方法，传人对象、普通参数；返回对象
     * id来源于url后面的参数
     * @param Student
     * @return
     */
    @PUT
    @Path("/put/{id}")
    @Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON})
    public Student put(@PathParam("id")String id,Student u);


    /**
     * 测试POST方法，传人对象、普通参数；返回对象
     *
     */
    @POST
    @Path("/post/{id}")
    @Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON})
    public Student post(@PathParam("id") String id,Student u);


    /**
     * 测试DELETE方法 ,传人普通参数；返回对象
     */
    @DELETE
    @Path("/delete/{id}")
    @Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON})
    public Student delete(@PathParam("id") String id);

}

实现类

package com.pds.webservice.result;

import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
import com.pds.webservice.Student;
import com.pds.webservice.Students;
import com.pds.webservice.soap.StudentService;
import org.springframework.beans.factory.annotation.Autowired;

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 java.util.ArrayList;

/**
 * Created with IDEA
 *
 * @author yunfei.zhao
 * @Date:2019/6/26
 * @Time:14:55
 */
@Path("/")
public class StudentInterfaceImpl implements StudentInterface {
    @Autowired
    private StudentService studentService;

    // 获取json
    @Override
    @GET
    @Path("/getjson/{id:[0-9]{0,10}}")
    @Produces({ MediaType.APPLICATION_JSON })
    public Student GetStudent(@PathParam("id") Integer id) {
        return studentService.getStudent(id);
    }

    // 获取xml
    @GET
    @Path("/getxml/{id}")
    @Produces({ MediaType.APPLICATION_XML })
    public Student getStudent2(@PathParam("id") Integer id) {
        return studentService.getStudent(id);
    }

    /**
     * 返回students集合，此方法没有测试，参数是一个json对象，该对象包含一个name为id的数组
     */
    @Override
    @GET
    @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
    @Path("/getmany/{ids}")
    public Students getAllStudent(@PathParam("ids") String ids) {
        Students students = new Students(new ArrayList<Student>());
        // 得到json对象
        JSONObject json = JSONObject.parseObject(ids);
        // 获取对象的id列表
        JSONArray sid = json.getJSONArray("id");

        for (int i = 0; i < sid.size(); i++) {
            Integer s = sid.getInteger(0);
            if (s != null) {
                students.getStudents().add(studentService.getStudent(s));
            } else {
                continue;
            }
        }
        return students;
    }

    @Override
    public Student put(String id, Student u) {
        return null;
    }

    @Override
    public Student post(String id, Student u) {
        return null;
    }

    @Override
    public Student delete(String id) {
        return null;
    }
}

配置文件cxf-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxrs="http://cxf.apache.org/jaxrs"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
       http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd
       http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- <import resource="classpath:META-INF/cxf/cxf.xml" /><
     <context:annotation-config />-->
    <!-- 将Bean托管给Spring -->
     <bean id="studentService" class="com.pds.webservice.result.StudentInterfaceImpl">
     </bean>
     <!-- 配置需要暴露的Rest ful Service -->
    <jaxrs:server id="restContainer" address="/students"> <!-- 暴露restful api 类似于前文提到的webService【暴露soap】 即访问的时候要加上这个address -->
        <jaxrs:serviceBeans>
            <!-- 相当于打包发布服务 -->
            <ref bean="studentService" />
        </jaxrs:serviceBeans>
        <jaxrs:extensionMappings>
            <entry key="json" value="application/json" />
            <entry key="xml" value="application/xml" />
        </jaxrs:extensionMappings>
        <jaxrs:providers>
            <ref bean="jsonProvider" /> <!-- 提供一个json转化，没有这个不能自动返回json jsonProvider就是前面@Bean生成的在CxfConfig -->
           <!-- <bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider" />-->
        </jaxrs:providers>
        <!--   跨域访问加上如下JSONP和CORS两种方式
        1、JSONP
            添加JSONP依赖
            <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-rs-extension-providers</artifactId>
            <version>${cxf.version}</version>
            </dependency>
        <jaxrs:providers>
            <bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider"/>
            <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpPreStreamInterceptor"/>
        </jaxrs:providers>
        <jaxrs:inInterceptors>
            <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpInInterceptor"/>
        </jaxrs:inInterceptors>
        <jaxrs:outInterceptors>
            <bean class="org.apache.cxf.jaxrs.provider.jsonp.JsonpPostStreamInterceptor"/>
        </jaxrs:outInterceptors>-->
        <!-- 2.添加CORS依赖
                <dependency>
                <groupId>org.apache.cxf</groupId>
                <artifactId>cxf-rt-rs-security-cors</artifactId>
                <version>${cxf.version}</version>
                </dependency>
             <jaxrs:providers>
                 <bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider"/>
                 <bean class="org.apache.cxf.rs.security.cors.CrossOriginResourceSharingFilter">
                     <property name="allowOrigins" value="http://localhost"/>
                     在 CrossOriginResourceSharingFilter 中配置 allowOrigins 属性，
                     将其设置为客户端的域名，示例中为“http://localhost”，需根据实际情况进行设置。
                 </bean>
             </jaxrs:providers>
              -->
         </jaxrs:server>


     </beans>

查看RestFul api

浏览器输入http://localhost:8082/cxf/ 就可以查看到多了 Available RESTful services:Endpoint address: http://localhost:8082/cxf/students

【因为soap和restful均是cxf处理】

最后测试restful请求

输入http://ip:port/cxf/students/getjson/1 获取json数据