Five ways to build web service clients with XFire

This does not involve the related applications of JSR 181 Annotations. The three specific methods are as follows

① Create a dynamic client through the WSDL address
② Create the client through the interface provided by the server
③ Use Ant to generate the client through the WSDL file

The first way: create a dynamic client through the WSDL address

package com.jadyer.client;
import java.net.MalformedURLException;
import java.net.URL;
import org.codehaus.xfire.client.Client;
/**
 * 通过WSDL来创建动态客户端
 * @see 此时需要在项目中引入XFire 1.2 Core Libraries和XFire 1.2 HTTP Client Libraries
 */
public class ClientFromWSDL {
 public static void main(String[] args) throws MalformedURLException, Exception {
 Client client = new Client(new URL("http://127.0.0.1:8080/XFire_demo/services/XFireServer?wsdl"));
 Object[] results11 = client.invoke("sayHello", new Object[]{"Jadyer22"});
 System.out.println(results11[0]);
 }
}

Second method: Create a client through the port provided by the server

package com.jadyer.client;
import java.net.MalformedURLException;
import java.util.List;
import org.codehaus.xfire.client.XFireProxyFactory;
import org.codehaus.xfire.service.Service;
import org.codehaus.xfire.service.binding.ObjectServiceFactory;
import com.jadyer.model.Person;
import com.jadyer.model.User;
import com.jadyer.server.HelloService;
/**
 * 通过Web服务端提供的接口来创建客户端
 * @see 客户端必须提供一个与服务端完全一致的接口，包名也要一致
 * @see 在本例中，需要在客户端(即该项目)中提供HelloService.java接口，以及Person和User两个POJO类
 * @see 并且此时需要在项目中引入XFire 1.2 Core Libraries和XFire 1.2 HTTP Client Libraries
 */
public class ClientFromInterface {
 public static void main(String[] args)throws MalformedURLException{
 //首先使用XFire的ObjectServiceFactory从HelloService接口创建一个服务模型serviceModel
 //serviceModel包含服务的说明，换句话说，就是服务的元数据
 //Create a metadata of the service
 Service serviceModel = new ObjectServiceFactory().create(HelloService.class);
 //访问的地址
 String serviceURL = "http://127.0.0.1:8080/XFire_demo/services/XFireServer";
 //通过查看org.codehaus.xfire.client.XFireProxyFactory源码发现
 //下面两行代码与这里直接new XFireProxyFactory()的作用是等效的
 //XFire xfire = XFireFactory.newInstance().getXFire();
 //XFireProxyFactory factory = new XFireProxyFactory(xfire);
 //为XFire获得一个代理工厂对象
 //Create a proxy for the deployed service
 XFireProxyFactory factory = new XFireProxyFactory();
 //通过proxyFactory，使用服务模型serviceModel和服务端点URL(用来获得WSDL)
 //得到一个服务的本地代理，这个代理就是实际的客户端
 HelloService client = (HelloService)factory.create(serviceModel, serviceURL);
 /**
  * Invoke the service
  * @see 调用服务的本地代理(即实际的客户端)中的方法，便得到我们需要的WebServcie
  */
 /*--处理简单对象--*/
 String serviceResponse = client.sayHello("Jadyer11");
 System.out.println(serviceResponse);
 /*--处理对象--*/
 User u = new User();
 u.setName("Jadyer99");
 Person pp = client.getPerson(u);
 System.out.println(pp.getName());
 /*--处理List--*/
 List<Person> personList = client.getPersonList(24, "Jadyer88");
 for(Person p : personList){
  System.out.println(p.getName());
 }
 }
}

This is the interface and two POJO classes it will use

/**
 * Web服务提供给客户端的接口
 * @see 这是第二种方式创建的客户端，要用到的接口
 */
package com.jadyer.server;
import java.util.List;
import com.jadyer.model.Person;
import com.jadyer.model.User;
public interface HelloService {
 public String sayHello(String name);
 public Person getPerson(User u);
 public List<Person> getPersonList(Integer age, String name);
}
/**
 * 第二种方式创建的客户端，要用到的两个POJO类
 */
package com.jadyer.model;
public class User {
 private String name;
 /*--getter和setter略--*/
}
package com.jadyer.model;
public class Person {
 private Integer age;
 private String name;
 /*--getter和setter略--*/
}

The third way: use Ant to generate the Ant file used by the client through the WSDL file

package com.jadyer.client;
/**
 * 使用Ant通过WSDL生成客户端
 * @see 这里的ClientFromAnt.java是我自己创建的，并非Ant生成
 * @see 这里要用到的JAR有：xfire-all-1.2.6.jar以及//xfire-distribution-1.2.6//lib//目录中的所有JAR包
 * @see 我们需要把这些JAR包都拷贝到Web Project//WebRoot//WEB-INF//lib//目录中
 * @see 然后把build.xml和MyFirstXFireServer.wsdl都拷贝到下Web Project的根目录下即可
 * @see 关于MyFirstXFireServer.wsdl文件，是我在WebServices服务启动后
 * @see 访问http://127.0.0.1:8080/XFire_demo/services/XFireServer?wsdl然后将其另存得到的
 */
public class ClientFromAnt {
 public static void main(String[] args) {
 XFireServerClient client = new XFireServerClient();
 //String url = "http://127.0.0.1:8080/XFire_demo/services/XFireServer";
 //String result = client.getXFireServerHttpPort(url).sayHello("Jadyer33");
 //上面的两行代码，与下面的这一行代码，同效~~
 String result = client.getXFireServerHttpPort().sayHello("Jadyer33");
 System.out.println(result);
 }
}

, as follows

<?xml version="1.0" encoding="UTF-8"?>
<project name="wsgen" default="wsgen" basedir=".">
 <path id="classpathId">
 <fileset dir="./WebRoot/WEB-INF/lib">
  <include name="*.jar" />
 </fileset>
 </path>
 <taskdef classpathref="classpathId" name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask"/>
 <target name="wsgen" description="generate client">
 <wsgen outputDirectory="./src/" wsdl="MyFirstXFireServer.wsdl" binding="xmlbeans" package="com.jadyer.client" overwrite="true"/>
 </target>
</project>

You can also use the following Ant file

<?xml version="1.0" encoding="UTF-8"?>
<project name="xfireAnt" basedir="." default="createClientCode">
 <property name="xfirelib" value="${basedir}/WebRoot/WEB-INF/lib"/>
 <property name="sources" value="${basedir}/src"/>
 <path id="classpath">
 <fileset dir="${xfirelib}">
  <include name="*.jar"/>
 </fileset>
 </path>
 <target name="createClientCode">
 <taskdef name="wsgen" classname="org.codehaus.xfire.gen.WsGenTask" classpathref="classpath"/>
 <wsgen outputDirectory="${sources}" wsdl="http://127.0.0.1:8080/XFire_demo/services/XFireServer?wsdl" package="com.jadyer.client" overwrite="true"/>
 </target>
</project>

Finally, I will append the content of MyFirstXFireServer.wsdl

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions targetNamespace="http://www.jadyer.com/XFireDemo"
xmlns:tns="http://www.jadyer.com/XFireDemo"
xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
 <wsdl:types>
 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   attributeFormDefault="qualified"
   elementFormDefault="qualified"
targetNamespace="http://www.jadyer.com/XFireDemo">
  <xsd:element name="sayHello">
  <xsd:complexType>
   <xsd:sequence>
   <xsd:element maxOccurs="1" minOccurs="1" name="in0" nillable="true" type="xsd:string" />
   </xsd:sequence>
  </xsd:complexType>
  </xsd:element>
  <xsd:element name="sayHelloResponse">
  <xsd:complexType>
   <xsd:sequence>
   <xsd:element maxOccurs="1" minOccurs="1" name="out" nillable="true" type="xsd:string" />
   </xsd:sequence>
  </xsd:complexType>
  </xsd:element>
 </xsd:schema>
 </wsdl:types>
 <wsdl:message name="sayHelloRequest">
 <wsdl:part name="parameters" element="tns:sayHello"></wsdl:part>
 </wsdl:message>
 <wsdl:message name="sayHelloResponse">
 <wsdl:part name="parameters" element="tns:sayHelloResponse"></wsdl:part>
 </wsdl:message>
 <wsdl:portType name="XFireServerPortType">
 <wsdl:operation name="sayHello">
  <wsdl:input name="sayHelloRequest" message="tns:sayHelloRequest">
  </wsdl:input>
  <wsdl:output name="sayHelloResponse" message="tns:sayHelloResponse">
  </wsdl:output>
 </wsdl:operation>
 </wsdl:portType>
 <wsdl:binding name="XFireServerHttpBinding" type="tns:XFireServerPortType">
 <wsdlsoap:binding style="document" mce_style="document" transport="http://schemas.xmlsoap.org/soap/http" />
 <wsdl:operation name="sayHello">
  <wsdlsoap:operation soapAction="" />
  <wsdl:input name="sayHelloRequest">
  <wsdlsoap:body use="literal" />
  </wsdl:input>
  <wsdl:output name="sayHelloResponse">
  <wsdlsoap:body use="literal" />
  </wsdl:output>
 </wsdl:operation>
 </wsdl:binding>
 <wsdl:service name="XFireServer">
 <wsdl:port name="XFireServerHttpPort" binding="tns:XFireServerHttpBinding">
  <wsdlsoap:address location="http://127.0.0.1:8080/XFire_demo/services/XFireServer" />
 </wsdl:port>
 </wsdl:service>
</wsdl:definitions>

The fourth method

This method uses the spring jar package. I was looking for XFire+Spring information a few days ago. When I saw it, I also made a record here. Similarly, this method and the second method mentioned above require the same interface on the client as the server, and the package name must also be the same.

(1) Create a new client.xml in the src directory (the name is not specific)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
 <bean id="baseService" class="org.codehaus.xfire.spring.remoting.XFireClientFactoryBean" lazy-init="false" abstract="true"/>
<!-- id的名字作为标识，用于客户端程序中获取service，若有多个service咋在下面添加多个bean即可-->
 <bean id="MathService" parent="baseService">
 <property name="serviceClass">
 <value>service.MathService</value>
 </property>
 <property name="wsdlDocumentUrl">
<value>http://localhost:8080/myservice/mathWebService?wsdl</value>
 </property>
 </bean>
</beans>

(2) Call the service code in the program Very simple

ApplicationContext ctx = new ClassPathXmlApplicationContext("client.xml");
MathService mathService = (MathService)ctx.getBean("MathService");
int result = mathService.add(int one,int two);

The fifth method

Get the wsdl file first, name it mathWebService.wsdl and put it in the src directory of the client. Then access the wsdl file through the program and call the required methods.

String wsdl = "mathWebService.wsdl " ; // 对应的WSDL文件
Resource resource = new ClassPathResource(wsdl);
Client client = new Client(resource.getInputStream(), null ); // 根据WSDL创建客户实例
Object[] objArray = new Object[ 2 ];
objArray[ 0 ] = 2 ;
obiArray[1] = 3;
 // 调用特定的Web Service方法
Object[] results = client.invoke( " add " , objArray);
System.out.println( " result: " + results[ 0 ]);

For these methods, if the parameters passed in the first method are entity objects on the server side, this seems to be more troublesome. I don’t know if it is on the client side. Is it possible to establish the same entity class as the server side? There is no practice. If the returned result is a complex data type, I don’t know if there are any problems or how to convert it. There is no in-depth study. And I personally feel that method calling is not that intuitive.

The above is the entire content of this article. I hope that the content of this article can bring some help to everyone's study or work. I also hope to support the PHP Chinese website!

For more articles related to the five ways XFire builds web service clients, please pay attention to the PHP Chinese website!