webservice 实例创建与调用「建议收藏」

全栈程序员站长

发布于 2022-09-13 20:47:32

6760

发布于 2022-09-13 20:47:32

文章被收录于专栏：全栈程序员必看

大家好，又见面了，我是你们的朋友全栈君。

webservice 实例创建与调用
序
webservice 选型
配置
代码
webservice 接口层
接口实现
实体
webservice 挂靠配置
启动服务测试
服务测试：
测试地址
客户端生成
环境配置
代码生成

序

对接SAP系统，指定要用webservice 做对接。不然打死也不用webservice，webService也不怎么流行了，有更好的选择。就java webservice而言，框架就有不下十种。网上的教程更是五花八门，零零碎碎，并且很多误导。本博将记录下项目里用的webservice，以及调用全过程，不误导。

webservice 选型

试用了几种，最终选型CXF，这里不做横向对比了。用它的原因很简单 1： CXF顺利跑起来了，很顺。 2：跟spring boot 配合得比较好，无需要启用新的端口（放在restful api 项目，并共用一端口）。

配置

Gradle 配置，maven自行转换。

compile("org.apache.cxf:cxf-spring-boot-starter-jaxws:3.2.8")

引进来之后下载了一大堆东西，如下

PS： 版本真心是难搞，需要耐心的去试配置，我的jdk是 1.8.0_144 ,Spring boot 版本为 2.0.4.RELEASE。

代码

webservice 接口层

package com.ly.mp.swcas.main.webService;

import com.ly.mp.common.entities.RestResult;
import com.ly.mp.swcas.main.wrap.*;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import java.util.List;

@WebService(name = "SwcasService"// 暴露服务名称

)
public interface SwcasService { 
   
    @WebMethod
    @WebResult(name = "String", targetNamespace = "")
    public String sayHello(@WebParam(name = "userName") String name);

    @WebMethod
    @WebResult(name = "WsResult", targetNamespace = "")
    public WsResult sayHello2(@WebParam(name = "userName") String name);
}

关键 1: 注解服务名称，这个服务名称将会是webservice 地址的一部分。如 http://localhost:10034/services/SwcasService?wsdl

@WebService(name = "SwcasService"// 暴露服务名称

关键 2: webservice 方法注解，包括方法以及结果返回注解。

 @WebMethod
 @WebResult(name = "WsResult", targetNamespace = "")

接口实现

package com.ly.mp.swcas.main.webService;

import javax.jws.WebService;

import com.ly.mp.common.entities.RestResult;
import com.ly.mp.component.entities.UserEntity;
import com.ly.mp.swcas.main.entities.*;
import com.ly.mp.swcas.main.ibiz.*;
import com.ly.mp.swcas.main.wrap.*;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

import java.util.ArrayList;
import java.util.List;

@WebService(serviceName = "SwcasService")
@Component
public class SwcasServiceImp implements SwcasService { 
   

    @Autowired
    private ICarConfigBiz carConfigBiz;

    @Autowired
    private IDealerBiz dealerBiz;

    @Autowired
    private IVehicleDespatchBiz vehicleDespatchBiz;

    @Autowired
    private ISupplierBiz supplierBiz;

    @Autowired
    private IPartBiz partBiz;
    @Override
    public String sayHello(String name) { 
   
        return "Hello ," + name;
    }

    @Override
    public WsResult sayHello2(String name) { 
   

        WsResult rs= new WsResult(1,"成功");
        rs.setMsg("测试成功");
        rs.setResult(1);

        WsResultItem resultItem =new WsResultItem("abc",1,"成功");
        rs.getData().add(resultItem);
        return rs;
    }

关键1： 类需要加上组件注解，

@Component

实体

WsResult

package com.ly.mp.swcas.main.webService;



import java.util.ArrayList;
import java.util.List;

public class WsResult { 
   

    private  int result;
    private String msg ;
    private List<WsResultItem> data ;


    { 
   
        data =new ArrayList<>();
    }


    public WsResult(int result, String msg) { 
   
        this.result = result;
        this.msg = msg;
    }

    public int getResult() { 
   
        return result;
    }

    public void setResult(int result) { 
   
        this.result = result;
    }

    public String getMsg() { 
   
        return msg;
    }

    public void setMsg(String msg) { 
   
        this.msg = msg;
    }

    public List<WsResultItem> getData() { 
   
        return data;
    }

    public void setData(List<WsResultItem> data) { 
   
        this.data = data;
    }

}

WsResultItem

package com.ly.mp.swcas.main.webService;



public class WsResultItem { 
   

    private  String Key;
    private  int Result;
    private  String Msg;

    public WsResultItem(String key, int result, String msg) { 
   
        Key = key;
        Result = result;
        Msg = msg;
    }

    public String getKey() { 
   
        return Key;
    }

    public void setKey(String key) { 
   
        Key = key;
    }

    public int getResult() { 
   
        return Result;
    }

    public void setResult(int result) { 
   
        Result = result;
    }

    public String getMsg() { 
   
        return Msg;
    }

    public void setMsg(String msg) { 
   
        Msg = msg;
    }
}

PS： 与SAP对接主要是同步业务数据，一次同步可能是多条，每第业务数据都带有唯一的key，我们这边返回值需要返回对应key以及处理状态。

webservice 挂靠配置

package com.ly.mp.swcas.main.config;

import javax.xml.ws.Endpoint;

import com.ly.mp.swcas.main.webService.SwcasService;
import org.apache.cxf.Bus;
import org.apache.cxf.jaxws.EndpointImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
public class CxfConfig { 
   
    @Autowired
    private Bus bus;

    @Autowired
    SwcasService swcasService;

    /** JAX-WS **/
    @Bean
    public Endpoint endpoint() { 
   
        EndpointImpl endpoint = new EndpointImpl(bus, swcasService);
        endpoint.publish("/SwcasService"); 
        
        System.out.println("---------------服务发布------------------");
        return endpoint;
    }
}

启动服务测试

1：输出日志里带有服务发布的字眼。

2：服务启动成功信息

服务测试：

测试地址

根据服务启动的信息可以知道，我们端口号是10034。本地webservice 的地址是：http://localhost:10034/services/SwcasService webservice 文档：http://localhost:10034/services/SwcasService?wsdl

如下图所示：