SpringBoot 项目中开发 webService+CXF接口

项目架构：SpringBoot+Orcal

前景： SpringBoot 项目中对外公布接口，故采用 WebService ，在论坛上看了许多的代码示例，大体是分为以下几步：

1）引入jar包；

2）建立接口 interface ,并添加注解 @WebService 声明接口以及属性定义；

3）建立接口实现类，也要添加注解式声明；

4 ）建立配置类随项目启动；

经过自己实践，发现其实不需要那么繁琐，特总结如下，供己备用；

首选一张图说明 webService

如果是多个 webService 业务层就注入多个 endpoint ;

效果展示图：je

soupUI 添加 wsdl 地址，测试接口：

接下来直接上代码：

1.pom 文件引入jar 包依赖

<!-- web-services -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web-services</artifactId>
    </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>
</dependencies>

2.定义webService类实现业务层

注： webServie接口方法的返回值最好以 String JSON 字符串的形式返回，否则会出现数据格式不统一难以维护；（使用原则：接口对外调用）；返回值若是实体类对象或者是实体类对象数组、集合形式，返回的数据格式会直接 XML 节点-属性化；



import com.alibaba.fastjson.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import java.util.ArrayList;
import java.util.List;

/**
 * @author 水上小白龙
 * @date 2021/10/22 15:03
 * @description
 */
public class MsgDealtWebService {

    @Autowired
    private WjzJcTsxxMapper jcTsxxMapper ;

    @Autowired
    private WjzJyTsxxMapper jyTsxxMapper ;

    @WebMethod
    public String getMsg(){
        return "欢迎来到管理系统！" ;
    }

    @WebMethod
    public String getMsg2(@WebParam String msg2){
        return "欢迎" + msg2 + "，二次来到管理系统！" ;
    }

    /**
     * 获取检查危急值列表
     * @return
     */
    @WebMethod
    public String getWjzJcNoDealtJcMsgs(){
        List<WjzJcTsxx> list = new ArrayList<>();
        list =  jcTsxxMapper.selectAllNoCl();
        return JSONObject.toJSONString(list) ;
    }

}

3.建立 webService 启动配置类：




import org.apache.cxf.Bus;
import org.apache.cxf.bus.spring.SpringBus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.transport.servlet.CXFServlet;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.xml.ws.Endpoint;

/**
 * @author 水上小白龙
 * @date 2021/10/22 11:39
 * @description  http://localhost:8077/wjz/webApi
 */

@Configuration
public class WebServiceCxfConfig {

    //1.第一步配置访问服务器名称  如：发布服务名称 localhost:8080/webApi
    @Bean
    public ServletRegistrationBean disServlet() {
        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(new CXFServlet(), "/webApi/*");
        return servletRegistrationBean;
    }
    //2. 第二步 注入 SpringBus
    @Bean(name = Bus.DEFAULT_BUS_ID)
    public SpringBus springBus() {
        return new SpringBus();
    }
    
    /**
    * 第三步：注入 webService 
    * 必须使用此方法注入服务接口，否则会抛出异常 Caused by: java.lang.NullPointerException: null
    */
    @Bean
    public MsgDealtWebService getmsgDealtWebService(){
       return  new MsgDealtWebService();
    }


    /**
     * 第4部：公布接口访问地址 ，若是多个 webService 则注入 多个 endPoint
     * @return
     */
    @Bean
    public Endpoint msgDealt() {
        EndpointImpl endpoint = new EndpointImpl(springBus(),getmsgDealtWebService());
        endpoint.publish("/msgDealt"); // 接口访问地址
        return endpoint;
    }

}

4.项目启动，访问接口：http://localhost:port/项目名/webService暴露的服务器名，如http://localhost:8077/demo/webApi

5.SoupUI 调用地址测试 http://localhost:8077/demo/webApi/msgDealt?wsdl

感谢论坛上的各路大神

原文地址：https://blog.csdn.net/qq_41639676/article/details/120954374

SpringBoot 项目中开发 webService+CXF接口

相关推荐