使用apach cxf+spring+tomcat搭建提供json格式的对外接口入门Demo

来源：互联网发布：linux sudo命令编辑：程序博客网时间：2024/04/29 19:51

apache cxf是一款可提供webservice服务的轻量级框架。主要格式有xml和json。下面就以apache cxf和spring以及tomcat框架为基础，搭建一个简单的对外提供json格式的接口服务。

下面就开始快乐的学习之旅吧！

由于apache cxf是基于servlet技术的SOA应用框架，所以当然第一件事情就是配置web.xml了。

<web-app>
<display-name>application</display-name>


<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:com/resources/spring-context.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>
<load-on-startup>1</load-on-startup>
</servlet>


<servlet-mapping>
<servlet-name>CXFServlet</servlet-name>
<url-pattern>/services/*</url-pattern>
</servlet-mapping>

<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
</web-app>

上面就把spring容器和cxf框架在servlet容器(此处用tomact)中定义好了。

下面就开始写接口服务了。先上我的项目结构图，如下图所示。

其中接口CxfTestService.java内容如下所示：

//@path指定访问的路径，这个注释是由jsr.jar来提供，下面的@GET注释也是由该jar包来提供，除此之外还提供了@POST(以post进行访问)，@QueryParam(用于接口参数声明),@FormParam(用于接口参数声明，如果访问用post方式进行，则若接口方法有参数则可以用该注释申明)等注释。

@Path("/test")
public interface CxfTestService {

@GET
@Path("/init")
public ResultDomain init();
}

上面用注释的方法把接口定义好了，当然也可以选择代码的方式进行声明，本文还是同一采用注释的方式(ps:本人习惯用注释的方式了)。

下面就来看接口实现类CxfTestService.java吧。下面上代码：

public class CxfTestServiceImpl implements CxfTestService{
public ResultDomain init() {
ResultDomain domain = new ResultDomain();
domain.setCode(1);
domain.setResult("成功了");
domain.setResultDesc("操作成功");
return domain;
}
}

大家不要骂我，就是一个用于测试的方法而已，和普通方法完全没区别，但注意了，我们进入这个方法返回ResultDomain去看一下有什么不同吧。

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class ResultDomain {
public String resultDesc;
public Integer code;
public Object result;

从上面可以看到，该实体类也进行了注释申明。因为cxf使用jaxb进行数据绑定时，要知道对应实体的属性，所以要将类申明为@XmlRootElement。这样jaxb才知道类里面有什么属性。而@XmlAccessorType(XmlAccessType.FIELD)则指定 JAXB 绑定类中的每个非静态、非瞬态字段将会自动绑定到 XML。

搞定了上面两块东西，下面就剩最后一块内容了，那就是spring容器和cxf的整合。本配置内容放在spring-cxf-out.xml文件中。上配置文件：

<property name="ignoreNamespaces" value="true" />

<property name="serializeAsArray" value="true" />
</bean>

<jaxrs:server id="cxfServices" address="/">
<jaxrs:serviceBeans>

<ref bean="cxfTestService" />
</jaxrs:serviceBeans>
<jaxrs:providers>
<ref bean="jsonProvider" />
</jaxrs:providers>
</jaxrs:server>
</beans>

好了，到此为止一个简易的对外提供json格式的服务已经搭好了，下面就开启服务进行访问吧！看下图所示，就可已用get方式来访问该接口服务并返回json格式的结果了。

资源下载地址：

http://download.csdn.net/detail/shihai1991/8021127

参考博文：

http://cxf.apache.org/docs/index.html

http://www.ibm.com/developerworks/cn/education/java/j-cxf/

0 0