maven 项目 cxf+spring 发布rest风格webservice

    1 建立 maven 工程  因为我们要把工程 放到 tomcat容器中去 所以 建立一个  war的 maven 工程  （至于  建立maven 工程  楼主就不说了 原谅我）

     2  需要的maven 依赖

     <properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.7</java.version>
<spring.version>3.2.8.RELEASE</spring.version>
<servlet-api.version>2.5</servlet-api.version>
<slf4j.version>1.7.5</slf4j.version>
<cxf.version>2.7.12</cxf.version>
<jackson.version>2.1.4</jackson.version>
</properties>
<dependencies>
<!-- spring begin -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-orm</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc-portlet</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- spring end -->
<!-- servlet begin -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>${servlet-api.version}</version>
</dependency>
<!-- servlet end -->


<!-- cxf begin -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxrs</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-extension-providers</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.codehaus.jettison</groupId>
<artifactId>jettison</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>javax.ws.rs</groupId>
<artifactId>jsr311-api</artifactId>
<version>1.1.1</version>
</dependency>
<!-- cxf end -->

</dependencies>

3  因为是  war 工程  当然 让我们先从  web.xml  说起吧 

 直接上代码：

     

<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="2.4"
xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:beans.xml
                </param-value>
</context-param>
<servlet>
<servlet-name>CXFServlet</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>CXFServlet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>

1： 首先是 加载  spring 的 监听器  然后是 加载配置文件  当然就是spring的配置文件了  里面整合了 cxf的配置  （在beans.xml里面详解）

       在下面 就是 cxf的  servlet  其中 

• load-on-startup标记容器是否在启动的时候实例化并调用其init()方法的优先级。

• 它的值表示servlet应该被载入的顺序

• 当值为0或者大于0时，表示容器在应用启动时就加载并初始化这个servlet；

• 如果值小于0或未指定时，则表示只有在第一次请求的容器才在该servlet调用初始化函数

• 正值越小，servlet的优先级越高，应用启动时就越先加载。

• 值相同时，容器就会自己选择顺序来加载。

• 下面的  <url-pattern>/*</url-pattern> 表示  任何请求都会由 此servlet 来处理

2： 接下里  就是 beans.xml的配置

<?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:context="http://www.springframework.org/schema/context"
  xmlns:aop="http://www.springframework.org/schema/aop"
  xmlns:tx="http://www.springframework.org/schema/tx"
  xmlns:jaxws="http://cxf.apache.org/jaxws"
       xmlns:jaxrs="http://cxf.apache.org/jaxrs"
       xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
  xsi:schemaLocation="http://www.springframework.org/schema/beans 
        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-3.2.xsd
        http://www.springframework.org/schema/tx
        http://www.springframework.org/schema/tx/spring-tx-3.2.xsd
        http://www.springframework.org/schema/aop 
        http://www.springframework.org/schema/aop/spring-aop-3.2.xsd
        http://code.alibabatech.com/schema/dubbo  
                         http://code.alibabatech.com/schema/dubbo/dubbo.xsd 
                         http://cxf.apache.org/jaxrs
                         http://cxf.apache.org/schemas/jaxrs.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" />

<bean id="restSample" class="xtoy.service.RESTSampleSource" />


<!-- 这里的地址很重要，客户端需要通过这个地址来访问WebService -->
<jaxrs:server id="restServiceContainer"   address="/rest">
<jaxrs:serviceBeans>
<ref bean="restSample" />
</jaxrs:serviceBeans>
<jaxrs:extensionMappings>
<entry key="json" value="application/json" />
<entry key="xml" value="application/xml" />
</jaxrs:extensionMappings>
<jaxrs:languageMappings>
<entry key="en" value="en-gb" />
</jaxrs:languageMappings>
</jaxrs:server>
</beans>

这个里面   首先 是  约束文件   就是标红的那个   不然 下面的标签 都会不合法  

接下里 是 <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" />

这三个 文件  这三个cxf的 配置文件 很坑爹 一个是  cxf的配置 一个是  soap 的一个是 servlet的  但是 有些时候  启动会报错  找不到 这三个文件  这时候有个解决办法  

 就是  删了 他们 三个   貌似很无脑  但是 cxf  在 3.0之后  貌似就不需要他们了  楼主 亲测  有没有都行 3.0之后  

在下面 就是一个 注册的bean  这个简单 就是  你要发布的 webservice的具体实现  比如  输出 helloworld 的 方法 这个bean  要注入到 jaxrs 标签里面   

下面 详解  <jaxrs:server>标签   

<jaxrs:server id="restServiceContainer"   address="/rest">

 这个 id  我纠结了很久 开始我以为 是cxf 某个bean 的 id   结果后来我发现 这个是自己随便起的名字  于是 我们就叫他  restServiceContainter吧  顾名思义 就是  restservice的容器  后面的地址 很重要  是  我们访问路径的地址 每一个  访问路径 都是  ip：Port/address/path

                <jaxrs:serviceBeans>
<ref bean="restSample" />

</jaxrs:serviceBeans>

里面放的就是具体实现  helloworld 的代码   根据  id注入的  肯定要还有一个  <bean id="restSample" class="xtoy.service.RESTSampleSource" />关联到 具体实现的类 

<jaxrs:extensionMappings>

是返回数据的类型 解析方式 

<jaxrs:languageMappings>

是返回对象的编码格式

接下来就是实现类的代码了

接口类

@Path(value = "/sample")
public interface RESTSample {
@GET
@Path("/hello")
public void  sayHello();
}

@Path(value = "/sample")
public class RESTSampleSource implements RESTSample {

         @GET
@Path("/hello")
public void sayHello() {
// TODO Auto-generated method stub
System.out.println("hello");
}
}

因为  我想 在 这一篇中主要 讲 配置文件 的配置  所以 代码就没有多少了  也没有列举 其他各种  @post @delete@put  和返回 bean 和json  的方法   这些 会在以后（不知道什么时候 再讲了 ） 为了  弥补这些   特此 在附件 中附上 源码   源码里面包换  各种类型的列子  有兴趣的同学 可以去看   我cao 居然 我不能上传附件 还是我没找到  如果有想要的  可以给我发邮件  [e-mail]

此外 常用的 标签  简单说一下  

       （1）、@Path，标注资源类或方法的相对路径

（2）、@GET，@PUT，@POST，@DELETE，标注方法是用的HTTP请求的类型

（3）、@Produces，标注返回的MIME媒体类型，（ 注解标注，这个注解可以包含一组字符串，默认值是*/*，它指定REST 服务的响应结果的MIME 类型，例如：application/xml、application/json、image/jpeg 等），CXF 默认返回的是JSON 字符串。

（4）、@PathParam，@QueryParam，@HeaderParam，@CookieParam，@MatrixParam，@FormParam,分别标注方法的参数来自于HTTP请求的不同位置，例如@PathParam来自于URL的路径，@QueryParam来自于URL的查询参数，@HeaderParam来自于HTTP请求的头信息，@CookieParam来自于HTTP请求的Cookie。

 在剩下就没有了   如果有什么 说的 不对的  请 留言指正 如果 对你有帮助  只要看到你开心的笑容我就满意了