CXF
CXF是在xfire的基础上实现的。
1)首先呢,还是包的问题,在http://cxf.apache.org/download.html这里可以下到最新版的CXF,当然,我用的是最新版的。接下来还是那句废话,建WEB项目,放入JAR包。而JAR包我们就不选择了,一堆全部放入。
我们会看到它包含了spring的JAR包,后面当我们需要把CXF作为WEB项目部署时,就需要用到spring的配置文件,这个后面再讲。
还是接口类和实现类:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
@WebService public interface IReaderService { public Reader getReader( @WebParam (name= "name" ) String name, @WebParam (name= "password" ) String password); public List<Reader> getReaders(); } @WebService (endpointInterface= "com.cxf.servlet.IReaderService" ,serviceName= "readerService" ) public class ReaderService implements IReaderService{ public Reader getReader( @WebParam (name= "name" ) String name, @WebParam (name= "password" ) String password) { return new Reader(name,password); } public List<Reader> getReaders(){ List<Reader> readerList = new ArrayList<Reader>(); readerList.add( new Reader( "shun1" , "123" )); readerList.add( new Reader( "shun2" , "123" )); return readerList; } } |
这两个类除了加入注解外,其他均和昨天讲的webservice的一样。这里就不多讲了,对注解的解释,大家可以看看JAVAEE的文档。不过按意思应该很容易理解的。
接下来就是JAVABEAN,还是那个Reader类:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
public class Reader{ private static final long serialVersionUID = 1L; private String name; private String password; public Reader(){} public Reader(String name,String password) { this .name = name; this .password = password; } //Get/Set方法省略 public String toString(){ return "Name:" +name+ ",Password:" +password; } } |
上面的已经写完了。
2)我们要用做WEB项目吗?不急,先不用,CXF自带了一个轻量的容器服务,相当于spring自己提供了IOC容器一样。我们可以先用它来测试一下我们部署成功没。
直接来一个测试类:
1
2
3
4
5
6
|
public static void main(String[] args) { System.out.println( "Server is starting..." ); ReaderService readerService = new ReaderService(); Endpoint.publish( "http://localhost:8080/readerService" ,readerService); System.out.println( "Server is started..." ); } |
简单得不得了吧。直接publish地址,然后指定接口或类就OK了。我这里用的是类,但尽量用接口,毕竟面向接口编程才是真正的面对对象思想。
我们启动看看结果:
我们看到启动已经完成,接着启动浏览器看看是否成功了。
直接在浏览器输入http://localhost:8080/readerService?wsdl,我们可以看到:
它生成了我们所需要的wsdl文件,说明我们部署成功了。
3)部署成功后,我们就是要调用啦,它的调用也相当简单,跟xfire类似,取得接口,然后就可以跟本地类一样调用方法了。
1
2
3
4
5
6
7
8
9
|
public static void main(String[] args) { JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean(); factoryBean.setServiceClass(IReaderService. class ); factoryBean.setAddress( "http://localhost:8080/readerService" ); IReaderService readerService = (IReaderService)factoryBean.create(); Reader reader = readerService.getReader( "shun" , "123" ); System.out.println( "Reader:" +reader); } |
这里很简单,也是取得一个工厂类,然后直接设接口和地址再create就可以得取相应的接口了,这里跟xfire一样,也是需要调用端先定义好接口原型,否则这些调用将无从说起。
我们运行得到结果:
没问题,跟我们预想的结果一致。
4)但很多情况下,我们并不希望我们的webservice和我们的应用分开两个服务器,而希望他们在同一个容器,tomcat或JBOSS或其他的,这样我们就必须通过WEB来部署我们前面完成的webservice。
注意,我们这里需要用到spring定义文件。
首先看看web.xml:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
<? xml version = "1.0" encoding = "UTF-8" ?> < web-app xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns = "http://java.sun.com/xml/ns/javaee" xmlns:web = "http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation = "http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id = "WebApp_ID" version = "3.0" > < context-param > < param-name >contextConfigLocation</ param-name > < param-value >WEB-INF/beans.xml</ param-value > </ context-param > < listener > < listener-class >org.springframework.web.context.ContextLoaderListener</ listener-class > </ listener > < servlet > < servlet-name >CXFServlet</ servlet-name > < servlet-class >org.apache.cxf.transport.servlet.CXFServlet</ servlet-class > </ servlet > < servlet-mapping > < servlet-name >CXFServlet</ servlet-name > < url-pattern >/webservice/*</ url-pattern > </ servlet-mapping > </ web-app > |
这里很简单,只是指定了spring的监听器和相应的配置文件路径,并且指定了CXF的拦截方式。
接下来看看beans.xml:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<? xml version = "1.0" encoding = "UTF-8" ?> < beans xmlns = "http://www.springframework.org/schema/beans" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws = "http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> < import resource = "classpath:META-INF/cxf/cxf.xml" /> < import resource = "classpath:META-INF/cxf/cxf-extension-soap.xml" /> < import resource = "classpath:META-INF/cxf/cxf-servlet.xml" /> < jaxws:endpoint id = "readerServicce2" implementor = "com.cxf.servlet.ReaderService" address = "/readerService2" /> </ beans > |
这里很简单,只是通过jaxws:endpoint定义了一个webservice,implementor是webservice的处理类,而address是它的访问路径,跟我们前面写的readerService类似。
这时我们可以把它部署到tomcat中,通过http://localhost:8080/CXFWebservice/webservice/readerService2?wsdl可以直接访问。
有些朋友会问,为什么这次访问的URL跟前面的不一样呢。其实前面的访问地址是我们自己定义的,而这里的webservice地址是我们在配置文件中配置好的,并且是通过web项目来部署的,这里就需要用项目名称,而且我们在CXFServlet那里配置了url-pattern是webservice,所以最后的URL就跟上面一致了。
我们可以看到效果:
这证明我们部署成功了。
可以再次用前面的测试类测试一下,注意,需要把address修改成我们发布后的URL。
CXF相比xfire又更简洁了一些,虽然它增加了一些注解,但这些无伤大雅,它只是把以前的services.xml中的信息集中到类中,反而更方便维护,但这还是见仁见智的,有些人就喜欢配置文件,而有些人就不喜欢。另外CXF的调用方式更加简洁,比起xfire它的代码量更小了,是一个较大的进步。
有些朋友在搭建的过程中出现了一些问题,免去一个个回复了,这里放出代码,有需要的朋友可以下载看看。
lib目录下的所有包均没有放入,把cxf的所有包放入即可。
注:所用IDE为idea,文件结构跟eclipse不通用,如果需要在eclipse下使用的,可以直接复制代码和文件到eclipse新建的项目即可。
Jersey
我们来看看它的基本用法。
直接来个项目看看。开始项目之前大家还是先自己去下载包:https://maven.java.net/content/repositories/releases/com/sun/jersey/要运行例子需要同时下载server和client。当然不想找那么多,可以直接下这个zip包,https://maven.java.net/service/local/artifact/maven/redirect?r=releases&g=com.sun.jersey&a=jersey-archive&v=1.10&e=zip
1)直接来个JAVABEAN
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
@XmlRootElement public class Reader implements Serializable{ private static final long serialVersionUID = 1L; private String name; private String password; public Reader(){} public Reader(String name,String password) { this .name = name; this .password = password; } //省略Get/Set方法 public String toString(){ return "Name:" +name+ ",Password:" +password; } } |
这里用到了一个标签,这里用到的表示它返回的时候的类型,即此Reader类可以用于XML返回。
2)来个service类,这时已经不用像以前的CXF和xfire一样要接口了,直接来个类就OK了。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
@Path ( "/readerService/{name}/{password}" ) public class ReaderService { @GET @Produces (MediaType.APPLICATION_JSON) public Reader getReader( @PathParam ( "name" ) String name, @PathParam ( "password" ) String password) { return new Reader(name,password); } public static void main(String[] args) throws IllegalArgumentException, IOException, URISyntaxException { HttpServer server = HttpServerFactory.create( "http://localhost:8080/" ); server.start(); } } |
这时用到了几个标签,Path相信用过springMVC的朋友应该知道这种写法,就是URL匹配,如果不清楚的,可以先去看看。Get标签表示这个方法只能通过Get方法来进行访问,而Produces表示生成的结果,它表示系统会把Reader对象封闭成JSON结果进行返回。
如果不理解不要紧,等一下看结果就可以理解了。
而这时有一个main方法,相信有很大疑问吧。这是jersey内部提供的一个轻量级的内部容器,它可以暂时供我们调试用,但真正使用肯定不能用这个。
3)我们写一个测试类
1
2
3
4
5
6
7
8
9
10
|
public class ReaderClient { public static void main(String[] args) { Client client = Client.create(); WebResource resource = client.resource( "http://localhost:8080/readerService/shun/123213" ); Reader reader = resource.get(Reader. class ); System.out.println(reader); } } |
很简单的代码,应该都看得懂的,一个client对象,请求webservice,返回一个resource,然后resource就直接调用相应的方法,当然这个方法是通过我们的URl来进行匹配的。
这里我们先用它自带的一个轻量级服务测试一下。直接运行ReaderService,它里面有包含一个main方法,运行后,我们再运行ReaderClient,我们可以看到结果为:
结果正确。
我们当然不想就这样用自带的轻量级服务来作为我我们的服务器,我们需要放到和我们的项目在同一个服务器,比如tomcat,jboss等。
4)WEB项目当然就少不了web.xml。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<? xml version = "1.0" encoding = "UTF-8" ?> < web-app xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns = "http://java.sun.com/xml/ns/javaee" xmlns:web = "http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation = "http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" id = "WebApp_ID" version = "3.0" > < servlet > < servlet-name >Jersey Web Application</ servlet-name > < servlet-class >com.sun.jersey.spi.container.servlet.ServletContainer</ servlet-class > < load-on-startup >1</ load-on-startup > </ servlet > < servlet-mapping > < servlet-name >Jersey Web Application</ servlet-name > < url-pattern >/rest/*</ url-pattern > </ servlet-mapping > < welcome-file-list > < welcome-file >index.jsp</ welcome-file > </ welcome-file-list > </ web-app > |
这时指定了rest路径下的所有都将被jersey进行拦截。
我们部署到tomcat下启动后再重新运行readerClient,注意先要修改resource的路径:
1
|
WebResource resource = client.resource("http://localhost:8080/jerseyWebService/rest/readerService/shun/123213"); |
我的项目名为jerseyWebService,请根据你的项目名进行修改。
修改后,我们重新运行,结果如下:
和上面的结果一致,说明部署的效果是一样的,也是正确的。