SpringBoot发布webservice服务并调用(hutool yyds)
作者:故事我忘了¢
个人微信公众号:程序猿的月光宝盒
个人微信公众号:程序猿的月光宝盒
目录
前言
最近公司接的项目需要对接第三方服务,这个服务商是用的WebService开的接口提供调用
因为是内网项目,所以内网映射外网的服务器还没提供过来,所以为了自己以后不加班(这是真实存在的吗?自我安慰叭),所以自己写了个springboot服务发布WS服务,放到服务器上练练手
上一篇博客(《pringBoot打包到docker(idea+传统方式)》)其实是这篇博客之后的事儿
本来昨天就得写的,奈何家里的电脑,只能打游戏,昨天想写,发现连Typora都没有.别说图床,git了,写个钩叭~
另外,蒸汽厂打折了啊,还不买吗
开干
1.涉及技术点
SpringBoot+Webservice+Hutool(主要做一个调用WS的SoapClient)
上一张尴图先
都说Hutool用的越早,下班越早,但是不排除我不会用导致的加班
2.整体项目结构
3.Provider 发布Ws服务端
首先,肯定要修改pom文件
依赖加上
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 小辣椒,简化代码 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--发布ws需要用到的依赖-->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
<version>3.4.5</version>
</dependency>
<!-- hutool 的包 -->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.14</version>
</dependency>
</dependencies>
3.0 因为用对象的形式反参,所以建个对象
UserLoginVO
package com.jinsc.provider.vo;
import lombok.Data;
import java.io.Serializable;
/**
* 用户登录VO
*
* @author 金聖聰
* @version v1.0
* @email jinshengcong@163.com
* @since Created in 2021/10/21 23:28
*/
@Data
public class UserLoginVO implements Serializable {
private static final long serialVersionUID = 2673128718180426817L;
private Integer errorCode;
private String errMsg;
private String name;
public UserLoginVO() {
}
public UserLoginVO(Integer errorCode, String errMsg, String name) {
this.errorCode = errorCode;
this.errMsg = errMsg;
this.name = name;
}
}
3.1 首先写一个service,正常写就完事了,唯一不同的就是注解这块用WS的注解
LoginService
package com.jinsc.provider.service;
import com.jinsc.provider.vo.UserLoginVO;
import javax.jws.WebParam;
import javax.jws.WebService;
/**
* ws的登录接口
*
* @author 金聖聰
* @version v1.0
* @email jinshengcong@163.com
* @since Created in 2021/10/21 11:01
*/
@WebService(name = "LoginService", //暴露服务名称
targetNamespace = "http://jinsc.com" //空间名称
)
public interface LoginService {
UserLoginVO userLogin(@WebParam(name = "name") String name);
}
3.2 写他的实现类
LoginServiceImpl
package com.jinsc.provider.service.impl;
import com.jinsc.provider.service.LoginService;
import com.jinsc.provider.vo.UserLoginVO;
import org.springframework.stereotype.Service;
import javax.jws.WebParam;
import javax.jws.WebService;
/**
* ws的登录接口实现类
*
* @author 金聖聰
* @version v1.0
* @email jinshengcong@163.com
* @since Created in 2021/10/21 11:05
*/
@WebService(serviceName = "LoginService", // 与接口中的name保持一致
targetNamespace = "http://jinsc.com", // 与接口中的name保持一致
endpointInterface = "com.jinsc.provider.service.LoginService" // 接口包路径
)
// 用于配置类自动注入
@Service
public class LoginServiceImpl implements LoginService {
@Override
public UserLoginVO userLogin(@WebParam(name = "name") String name) {
return new UserLoginVO(500, "登录失败~~", name);
}
}
3.3 写WS的Cxf配置类
CxfConfig
package com.jinsc.provider.config;
import com.jinsc.provider.service.LoginService;
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.annotation.Resource;
import javax.xml.ws.Endpoint;
/**
* ws的配置类
*
* @author 金聖聰
* @version v1.0
* @email jinshengcong@163.com
* @since Created in 2021/10/21 11:14
*/
@Configuration
public class CxfConfig {
@Resource
private LoginService loginService;
/**
* 用于注册CXFServlet的
* 地址/webservice/*
* * 通配符 更上接口地址
*
* @return org.springframework.boot.web.servlet.ServletRegistrationBean<org.apache.cxf.transport.servlet.CXFServlet>
* @author 金聖聰
* @email jinshengcong@163.com
* Modification History:
* Date Author Description version
* --------------------------------------------------------*
* 2021/10/21 11:25 金聖聰 修改原因 1.0
*/
@Bean
public ServletRegistrationBean<CXFServlet> dispatcherServlet2() {
// 这里就是发布服务的跟路径,后面 * 是通配符,表示跟什么都行
return new ServletRegistrationBean<>(new CXFServlet(), "/webservice/*");
}
@Bean(name = Bus.DEFAULT_BUS_ID)
public SpringBus springBus() {
return new SpringBus();
}
@Bean
public Endpoint endpoint() {
// 建立一个端点 ,第一个参数是 springBus 对象,第二个参数是刚才的接口实现类(因为在实现类中用了@service,所以这里可以自动注入)
// PS: 要是有多个service,这个方法对象多写几个就行
EndpointImpl endpoint = new EndpointImpl(springBus(), loginService);
// 这里就是发布的这个接口的地址
endpoint.publish("/loginApi");
return endpoint;
}
}
这样,这个WS就可以发布了
地址是
ip:端口/webservice/loginApi?wsdl
本机启动就是
http://localhost:8080/webservice/loginApi?wsdl
以上,发布成功
4.consumer 调用Ws端所以我称之为消费端
同样,给上pom依赖
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 小辣椒简化代码 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- hutool的包 -->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.14</version>
</dependency>
</dependencies>
4.0 因为用对象形式解析参数所以创建对象
UserLoginDto
package com.jinsc.consumer.dto;
import lombok.Data;
import java.io.Serializable;
/**
* 用户登录Dto
*
* @author 金聖聰
* @version v1.0
* @email jinshengcong@163.com
* @since Created in 2021/10/21 23:36
*/
@Data
public class UserLoginDto implements Serializable {
private static final long serialVersionUID = 1292974846576856351L;
private String errMsg;
private String name;
private String errorCode;
}
4.1 创建个客户端去调用ws服务就ojbk了啊
不过在此之前,我们用SoapUI去解析下刚才的ws地址
由上,我们可以得到
命名空间: http://jinsc.com
方法名 : jin:userLogin
入参: name
所以我们可以创建SoapClient
了
TestWsConnect
package com.jinsc.consumer.client;
import cn.hutool.core.convert.Convert;
import cn.hutool.core.lang.Console;
import cn.hutool.core.util.XmlUtil;
import cn.hutool.http.webservice.SoapClient;
import com.jinsc.consumer.dto.UserLoginDto;
import org.w3c.dom.Document;
import javax.xml.xpath.XPathConstants;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
/**
* 测试ws连接
*
* @author 金聖聰
* @version v1.0
* @email jinshengcong@163.com
* @since Created in 2021/10/21 23:35
*/
public class TestWsConnect {
public static void main(String[] args) {
// 新建客户端
SoapClient client = SoapClient.create("http://localhost:8080/webservice/loginApi?wsdl")
// SoapClient client = SoapClient.create("http://服务器端口地址/webservice/loginApi?wsdl")
// 设置要请求的方法,此接口方法前缀为web,传入对应的命名空间
.setMethod("jin:userLogin", "http://jinsc.com")
// 设置参数,此处自动添加方法的前缀:jin
// false的意思就是没有前缀
.setParam("name", "jinshengcong3080ti", false);
// 发送请求,参数true表示返回一个格式化后的XML内容
// 返回内容为XML字符串,可以配合XmlUtil解析这个响应
String send = client.send(true);
Console.log(send);
// 把send返回的xml内容转换成document对象
Document document = XmlUtil.parseXml(send);
List<String> nameList = Arrays.asList("errMsg", "errorCode", "name");
HashMap<String, String> resultMap = new HashMap<>();
nameList.forEach(e -> {
// 循环上面的nameList列表,每个元素都是return后面的标签,得标签里面的值
String result = (String) XmlUtil.getByXPath("//return/" + e, document, XPathConstants.STRING);
// 然后给结果map赋值,key是name,value是标签中的值
resultMap.put(e, result);
});
// 得到结果map
Console.log(resultMap);
// map转Dto,其中属性要一致
UserLoginDto convert = Convert.convert(UserLoginDto.class, resultMap);
Console.log(convert);
}
}
这样就可以了
运行一下康康~
好了,ojbk