devbox
编程谜题解决者
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

在springboot中创建webservice服务_springboot webservice

作者：编程谜题解决者 | 2024-02-01 13:28:23

赞

踩

springboot webservice

        最近因为业务的需要，甲方让我在项目中提供webservice接口，在创建webservice的过程中，遇到了许多的坑，躺了许多雷，为了避免大家采坑，现整理如下。

        首先是springboot的pom.xml文件，主要是引入以下依赖

  1. <dependency>
  2. 	        <groupId>javax.xml.bind</groupId>
  3. 	        <artifactId>jaxb-api</artifactId>
  4. 	        <version>2.3.0</version>
  5. 	    </dependency>
  6. 	    <dependency>
  7. 	        <groupId>com.sun.xml.bind</groupId>
  8. 	        <artifactId>jaxb-impl</artifactId>
  9. 	        <version>2.3.0</version>
  10. 	    </dependency>
  11. 	    <dependency>
  12. 	        <groupId>com.sun.xml.bind</groupId>
  13. 	        <artifactId>jaxb-core</artifactId>
  14. 	        <version>2.3.0</version>
  15. 	    </dependency>
  16. 	    <dependency>
  17. 	        <groupId>javax.activation</groupId>
  18. 	        <artifactId>activation</artifactId>
  19. 	        <version>1.1.1</version>
  20. 	    </dependency>
  21. <dependency>
  22. 			<groupId>org.springframework.boot</groupId>
  23. 			<artifactId>spring-boot-starter-web-services</artifactId>
  24. 		</dependency>
  25.  
  26. 		<dependency>
  27. 			<groupId>org.apache.cxf</groupId>
  28. 			<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
  29. 			<version>3.3.1</version>
  30. 		</dependency>
  31. 		<dependency>
  32. 			<groupId>org.apache.cxf</groupId>
  33. 			<artifactId>cxf-rt-transports-http</artifactId>
  34. 			<version>3.2.2</version>
  35. 		</dependency>
  36.         <dependency>
  37. 			<groupId>org.codehaus.woodstox</groupId>
  38. 			<artifactId>stax2-api</artifactId>
  39. 			<version>4.0.0</version>
  40. 		</dependency>
  41. 		<dependency>
  42. 			<groupId>org.codehaus.woodstox</groupId>
  43. 			<artifactId>woodstox-core-asl</artifactId>
  44. 			<version>4.4.1</version>
  45. 		</dependency>
  46.         <!-- 这个主要是client访问的，但是问题多多-->
  47. 		<dependency>
  48. 			<groupId>org.apache.axis</groupId>
  49. 			<artifactId>axis</artifactId>
  50. 			<version>1.4</version>
  51. 		</dependency>
  52.  
  53. 		<dependency>
  54. 			<groupId>axis</groupId>
  55. 			<artifactId>axis-jaxrpc</artifactId>
  56. 			<version>1.4</version>
  57. 		</dependency>
  58.  
  59. 		<dependency>
  60. 			<groupId>commons-discovery</groupId>
  61. 			<artifactId>commons-discovery</artifactId>
  62. 			<version>0.2</version>
  63. 		</dependency>
  64. 		<dependency>
  65. 			<groupId>wsdl4j</groupId>
  66. 			<artifactId>wsdl4j</artifactId>
  67. 			<version>1.6.3</version>
  68. 		</dependency>

 我的jdk环境是jdk11,所以要引入最开始的4个依赖。

还有，springboot的版本不能太高，我原先的版本是2.3.3，跑不起来，后来在网上查到是版本不兼容导致的问题，于是把springboot的版本降到2.0.1，后来才跑起来。

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
         <version>2.0.1.RELEASE</version>
         <!--<version>2.3.3.RELEASE</version>-->
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

然后，新建webservice的接口文件，如下所示：

  1. package com.mango.jkm.webservice;
  2.  
  3. import java.util.List;
  4.  
  5. import javax.jws.WebMethod;
  6. import javax.jws.WebParam;
  7. import javax.jws.WebService;
  8.  
  9. @WebService(name = "Wbceshijk", targetNamespace = "http://server.webservice.example.com")
  10. public interface Wbceshijk {
  11. 	@WebMethod
  12.     String emrService(@WebParam(name = "data") String data,@WebParam(name = "data2") String data2);
  13. 	@WebMethod
  14. 	String student1111(@WebParam(name = "data") String data,@WebParam(name = "data2") String data2);
  15. 	@WebMethod
  16. 	String aboutstudent(@WebParam(name="student") Student student);
  17. 	@WebMethod
  18. 	String studentlist(List<Student> list1);
  19. }

然后是接口的实现类

  1. package com.mango.jkm.webservice;
  2.  
  3. import java.util.List;
  4.  
  5. import javax.jws.WebParam;
  6. import javax.jws.WebService;
  7.  
  8. import org.springframework.stereotype.Component;
  9.  
  10. @Component
  11. @WebService( targetNamespace = "http://server.webservice.example.com",
  12.         endpointInterface = "com.mango.jkm.webservice.Wbceshijk")
  13. public class Webserviceceshi implements Wbceshijk{
  14.  
  15. 	@Override
  16.     public String emrService( String data,String data2) {
  17.         if(null == data || "".equals(data.trim())){
  18.             return "传入的参数为空";
  19.         }
  20.         return "data="+data+"@data2="+data2;
  21.     }
  22.  
  23. 	@Override
  24. 	public String student1111(String data, String data2) {
  25. 		// TODO 自动生成的方法存根
  26. 		return "22222data="+data+"@data2="+data2;
  27. 	}
  28.  
  29. 	@Override
  30. 	public String aboutstudent(Student student) {
  31. 		// TODO 自动生成的方法存根
  32. 		System.out.println(student==null);
  33. 		return "student.getName()="+student.getName();
  34. 	}
  35.  
  36. 	@Override
  37. 	public String studentlist(List<Student> list1) {
  38. 		// TODO 自动生成的方法存根
  39. 		return "list1.size()="+list1.size();
  40. 	}
  41.  
  42.  
  43. }

 再然后是webservice的配置相关

  1. package com.mango.jkm.webservice;
  2.  
  3. import javax.xml.ws.Endpoint;
  4.  
  5. import org.apache.cxf.Bus;
  6. import org.apache.cxf.bus.spring.SpringBus;
  7. import org.apache.cxf.jaxws.EndpointImpl;
  8. import org.apache.cxf.transport.servlet.CXFServlet;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.boot.web.servlet.ServletRegistrationBean;
  11. import org.springframework.context.annotation.Bean;
  12. import org.springframework.context.annotation.Configuration;
  13.  
  14. @Configuration
  15. public class WebServiceConfig {
  16.  
  17.     @Autowired
  18.     private Wbceshijk serverServiceDemo;
  19.  
  20.     /**
  21.      * Apache CXF 核心架构是以BUS为核心，整合其他组件。
  22.      * Bus是CXF的主干, 为共享资源提供一个可配置的场所，作用类似于Spring的ApplicationContext，这些共享资源包括
  23.      * WSDl管理器、绑定工厂等。通过对BUS进行扩展，可以方便地容纳自己的资源，或者替换现有的资源。默认Bus实现基于Spring架构，
  24.      * 通过依赖注入，在运行时将组件串联起来。BusFactory负责Bus的创建。默认的BusFactory是SpringBusFactory，对应于默认
  25.      * 的Bus实现。在构造过程中，SpringBusFactory会搜索META-INF/cxf（包含在 CXF 的jar中）下的所有bean配置文件。
  26.      * 根据这些配置文件构建一个ApplicationContext。开发者也可以提供自己的配置文件来定制Bus。
  27.      */
  28.     @Bean(name = Bus.DEFAULT_BUS_ID)
  29.     public SpringBus springBus() {
  30.         return new SpringBus();
  31.     }
  32.  
  33.     /**
  34.      * 此方法作用是改变项目中服务名的前缀名，此处127.0.0.1或者localhost不能访问时，请使用ipconfig查看本机ip来访问
  35.      * 此方法被注释后, 即不改变前缀名(默认是services), wsdl访问地址为 http://127.0.0.1:8080/services/ws/api?wsdl
  36.      * 去掉注释后wsdl访问地址为：http://127.0.0.1:8080/soap/ws/api?wsdl
  37.      * http://127.0.0.1:8080/soap/列出服务列表 或 http://127.0.0.1:8080/soap/ws/api?wsdl 查看实际的服务
  38.      * 新建Servlet记得需要在启动类添加注解：@ServletComponentScan
  39.      *
  40.      * 如果启动时出现错误：not loaded because DispatcherServlet Registration found non dispatcher servlet dispatcherServlet
  41.      * 可能是springboot与cfx版本不兼容。
  42.      * 同时在spring boot2.0.6之后的版本与xcf集成，不需要在定义以下方法，直接在application.properties配置文件中添加：
  43.      * cxf.path=/service（默认是services）
  44.      */
  45. //    @Bean
  46. //    public ServletRegistrationBean dispatcherServlet() {
  47. //        return new ServletRegistrationBean(new CXFServlet(), "/soap/*");
  48. //    }
  49.  
  50.     @Bean
  51.     public Endpoint endpoint() {
  52.         EndpointImpl endpoint = new EndpointImpl(springBus(), serverServiceDemo);
  53.         endpoint.publish("/ws/api");
  54.         return endpoint;
  55.     }
  56. }

然后我在aplication.yml文件中添加了配置信息(非必要)

cxf:
  path: /service

这个是Student类

  1. package com.mango.jkm.webservice;
  2.  
  3. import java.io.Serializable;
  4.  
  5. import javax.xml.bind.annotation.XmlAccessType;
  6.  
  7. import javax.xml.bind.annotation.XmlAccessorType;
  8. import javax.xml.bind.annotation.XmlRootElement;
  9. import javax.xml.bind.annotation.XmlType;
  10.  
  11. @XmlRootElement(name="Student")
  12. @XmlAccessorType(XmlAccessType.FIELD)
  13. @XmlType(propOrder={"name", "address","age"})
  14. public class Student implements Serializable {
  15. 	/**
  16. 	 * 
  17. 	 */
  18. 	private static final long serialVersionUID = 3428504463675931746L;
  19. 	public String name;
  20. 	public String address;
  21. 	public String age;
  22. 	
  23. 	public String getName() {
  24. 		return name;
  25. 	}
  26.  
  27. 	public void setName(String name) {
  28. 		this.name = name;
  29. 	}
  30.  
  31. 	public String getAddress() {
  32. 		return address;
  33. 	}
  34.  
  35. 	public void setAddress(String address) {
  36. 		this.address = address;
  37. 	}
  38.  
  39. 	public String getAge() {
  40. 		return age;
  41. 	}
  42.  
  43. 	public void setAge(String age) {
  44. 		this.age = age;
  45. 	}
  46.  
  47. 	@Override
  48. 	public String toString() {
  49. 		return  "#" + this.name + "#";
  50. 	}
  51. }

 然后，启动springboot，访问对应的地址http://localhost:8081/service/ws/api?wsdl，得到熟悉的界面，可以看到webservice也启动成功了(webservice的端口号就是springboot项目自己的端口号)

然后，可以用soupui工具进行访问，

 

点击ok,就可以看到在接口文件中定义的4个方法

点击里面的emrService节点的request1,进行测试，可以看到返回数据结果

 

我感觉webservice也是post方式接口，因为我用apipost工具进行测试，body里放左侧的请求的xml，得到完全相同的的结果，为了验证我的猜想，我用springboot自带的RestTemplate类发送了一次post请求，发现也是得到了右侧的返回内容，这是我的测试类

  1. package com.mango.jkm.webservice;
  2.  
  3. import javax.xml.namespace.QName;
  4. import javax.xml.rpc.ParameterMode;
  5. import javax.xml.rpc.encoding.XMLType;
  6.  
  7. import org.apache.axis.client.Call;
  8. import org.apache.axis.client.Service;
  9. import org.apache.axis.encoding.ser.BeanDeserializerFactory;
  10. import org.apache.axis.encoding.ser.BeanSerializerFactory;
  11. import org.springframework.http.HttpEntity;
  12. import org.springframework.http.HttpHeaders;
  13. import org.springframework.http.MediaType;
  14. import org.springframework.http.ResponseEntity;
  15. import org.springframework.web.client.RestTemplate;
  16.  
  17. import com.alibaba.fastjson.JSONObject;
  18.  
  19.  
  20. public class WbClient {
  21. 	public static void invokeService3() {
  22. 		  try {
  23. 	            //1、直接引用远程的wsdl文件  
  24. 	            String endpoint = "http://localhost:8081/service/ws/api?wsdl";  
  25. 	            Service service = new Service();
  26. 	            Call call = (Call) service.createCall(); //创建服务
  27. 	            call.setTargetEndpointAddress(endpoint);  
  28. 	            //2、定义报名和接口方法
  29. 	            QName qn=new QName("http://server.webservice.example.com", //wsdl文件中的targetNamespace
  30. 	                    "aboutstudent");
  31. 	            call.setOperationName(qn);
  32.  
  33. 	            //3、设置参数
  34. 	        
  35. 	        
  36. 	            Student student=new Student();
  37. 	            student.setName("张小鑫");
  38. 	            student.setAddress("sssss");
  39. 	            student.setAge("10");
  40. 	            call.registerTypeMapping(Student.class,qn,  
  41.                         new BeanSerializerFactory(Student.class, qn),  
  42.                         new BeanDeserializerFactory(Student.class, qn));  
  43. 	            call.addParameter("student",
  44. 	            		new QName("http://server.webservice.example.com", "Student"), javax.xml.rpc.ParameterMode.IN);
  45. //	            call.addParameter("student", org.apache.axis.encoding.XMLType.XSD_ANYTYPE,
  46. //                        javax.xml.rpc.ParameterMode.IN);//接口的参数
  47. 	            call.setReturnType(org.apache.axis.encoding.XMLType.XSD_STRING);//设置返回类型  
  48.  
  49. 	            call.setUseSOAPAction(true);
  50. 	            String result = (String)call.invoke(new Object[]{student});
  51. 	            System.out.println("result="+result); 
  52. 	           
  53. 	           
  54. 	        } catch (Exception e) {  
  55. 	            e.printStackTrace();
  56. 	        }
  57. 		
  58. 	}
  59. 	public static void invokeService_2(){
  60.  
  61. 		  try {
  62. 	            //1、直接引用远程的wsdl文件  
  63. 	            String endpoint = "http://localhost:8081/service/ws/api?wsdl";  
  64. 	            Service service = new Service();
  65. 	            Call call = (Call) service.createCall(); //创建服务
  66. 	            call.setTargetEndpointAddress(endpoint);  
  67. 	            //2、定义报名和接口方法
  68. 	            call.setOperationName(new QName("http://server.webservice.example.com", //wsdl文件中的targetNamespace
  69. 	                    "emrService") //接口实现功能的方法
  70. 	                    );
  71. 	            
  72. 	            //3、设置参数
  73. 	            call.addParameter("data", XMLType.XSD_STRING,ParameterMode.IN);// 接口的参数  
  74. 	            call.addParameter("data2",XMLType.XSD_STRING,ParameterMode.IN);// 接口的参数  
  75. 	            call.setReturnType(XMLType.XSD_STRING);// 设置返回类型  
  76. 	           
  77. 	          
  78. 	            
  79. 	            //4、给方法传递参数，并且调用方法
  80. 	            String result = (String) call.invoke(new Object[] {"1111" ,"2222"});  
  81. 	            System.out.println("result="+result);
  82. 	        } catch (Exception e) {  
  83. 	            e.printStackTrace();
  84. 	        }
  85.  
  86. //		
  87. 	}
  88. 	public static void restfangwen() {
  89. 		RestTemplate restTemplate = new RestTemplate();
  90. 		HttpHeaders headers = new HttpHeaders();
  91. 		headers.setContentType(MediaType.APPLICATION_XML);
  92. 		String xml="<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ser=\"http://server.webservice.example.com\">\r\n"
  93. 				+ "   <soapenv:Header/>\r\n"
  94. 				+ "   <soapenv:Body>\r\n"
  95. 				+ "      <ser:aboutstudent>\r\n"
  96. 				+ "         <!--Optional:-->\r\n"
  97. 				+ "         <student>\r\n"
  98. 				+ "            <!--Optional:-->\r\n"
  99. 				+ "            <name>zx</name>\r\n"
  100. 				+ "            <!--Optional:-->\r\n"
  101. 				+ "            <address>address</address>\r\n"
  102. 				+ "            <!--Optional:-->\r\n"
  103. 				+ "            <age>18</age>\r\n"
  104. 				+ "         </student>\r\n"
  105. 				+ "      </ser:aboutstudent>\r\n"
  106. 				+ "   </soapenv:Body>\r\n"
  107. 				+ "</soapenv:Envelope>";
  108. 		HttpEntity requestEntity = new HttpEntity<>(xml, headers);
  109. 		ResponseEntity<String> resEntity = restTemplate.postForEntity("http://localhost:8081/service/ws/api",
  110. 				requestEntity, String.class);
  111. 		String result=resEntity.getBody();
  112. 		
  113. 		System.out.println("str="+result);
  114. 	}
  115. 	public static void main(String[] args) {
  116. 		WbClient.restfangwen();
  117. 	}
  118. }

 在这个测试类中，我访问的是webservice里的aboutstudent方法，能得到对应的返回内容

str=<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:aboutstudentResponse xmlns:ns2="http://server.webservice.example.com"><return>student.getName()=zx</return></ns2:aboutstudentResponse></soap:Body></soap:Envelope>

用axis能访问emrService方法，并且返回正确的数据。如果输入参数不是java基本类型而是类的话，怎么弄都不好使，网上各种办法都不好使，我也不知道为啥。各位大神如果你们成功了，就请在留言区说一下，小弟不胜感激。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/article/detail/53895
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号