webService工程:spring+cxf

Apache CXF是一款比较主流的WebService开源框架,cxf开发时,主要提供了两种访问服务的方式WS和RS

  • JAX-WS 传输数据:就是XML格式,基于SOAP协议(Simple Object Access protocol,简单对象访问协议)
  • JAX-RS传输数据: 基于restFul风格,可以传输XML格式或者JSON格式,基于HTTP协议

直接上干货

 JAX-RS

 导入pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.demo.cxf</groupId>
    <artifactId>cxf</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>cxf</name>
    
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <spring-version>4.2.5.RELEASE</spring-version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxws</artifactId>
            <version>3.2.6</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.2.6</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</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-beans</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring-version}</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
    </dependencies>


</project>

service代码:

package com.demo.cxf.ws;

import javax.jws.WebMethod;
import javax.jws.WebService;

@WebService
public interface IWsTestService {

    @WebMethod
    public String sayHello(String str);
}

实现类代码:

package com.demo.cxf.ws.impl;

import com.demo.cxf.ws.IWsTestService;

public class WsTestService implements IWsTestService {
    @Override
    public String sayHello(String str) {
        return "Hello" + str;
    }
}

和spring结合的配置文件:

<?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-2.5.xsd
       http://cxf.apache.org/jaxws
       http://cxf.apache.org/schemas/jaxws.xsd">

    <!--
        address是访问路径;
        serviceClass是配置接口;
        serviceBean是配置实现类。
     -->
    <jaxws:server id="wsTestService" address="/ws"
                  serviceClass="com.demo.cxf.ws.IWsTestService">
        <jaxws:serviceBean>
            <bean class="com.demo.cxf.ws.impl.WsTestService" />
        </jaxws:serviceBean>
    </jaxws:server>
</beans>

配置文件中需要注意一下,如果接口类和实现类没有在同一个包下,需要在配置文件中指定接口类和实现类的路径,如果不指明最后调用接口时会报找不到实现类。

也可以在实现类中指明,endpointInterface指定接口所在包,targetNamespace:目标接口的命名空间,包路径的反写

见代码:

package com.demo.cxf.ws.impl;

import com.demo.cxf.ws.IWsTestService;

import javax.jws.WebService;

@WebService(endpointInterface="com.demo.cxf.ws.IWsTestService",
        targetNamespace="http://ws.cxf.demo.com/")

public class WsTestService implements IWsTestService {
    @Override
    public String sayHello(String str) {
        return "Hello" + str;
    }
}

如果实现类和接口类不在同一个包下,也未指定,运行时会报如下错误:

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:spring-*.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>/service/*</url-pattern>
  </servlet-mapping>

</web-app>

项目启动成功后,获取发布的接口信息:

控制台调用代码:

package com.demo.cxf;

import org.apache.cxf.endpoint.Client;
import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;

public class TestMain {
    public static void main(String[] args) {
        String url = "http://localhost:8080/cxf/service/ws?wsdl";
        JaxWsDynamicClientFactory factory = JaxWsDynamicClientFactory.newInstance();
        Object[] objects = null;
        try {
            /* 获取CXF客户端 */
            Client client = factory.createClient(url);
            /* 调用Web Service方法 */
            objects = client.invoke("sayHello", "word");
        } catch (Exception e) {
            e.printStackTrace();
        }

        /* 获取调用结果 */
        System.out.println("调用结果:" + objects[0]);

    }
}

JAX-WS

CXF的JAX-WS模式可以将接口发布后通过http请求来访问 

导入的pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.demo.cxf</groupId>
    <artifactId>cxf</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>cxf</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <spring-version>4.2.5.RELEASE</spring-version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-frontend-jaxrs</artifactId>
            <version>3.2.6</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.jaxrs</groupId>
            <artifactId>jackson-jaxrs-json-provider</artifactId>
            <version>2.8.9</version>
        </dependency>
        <dependency>
            <groupId>org.apache.cxf</groupId>
            <artifactId>cxf-rt-transports-http</artifactId>
            <version>3.2.6</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</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-beans</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring-version}</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
    </dependencies>


</project>

service接口类:

package com.demo.cxf.rs;

import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

public interface IRsServcie {

    @POST
    @Path("/saveResource")
    @Produces(MediaType.APPLICATION_JSON)
    String saveResource(String resource);

    @DELETE
    @Path("/deleteResource")
    @Produces(MediaType.APPLICATION_JSON)
    String deleteResource(String resource);

    @GET
    @Path("/getResource")
    @Produces(MediaType.APPLICATION_JSON)
    String getResource(@QueryParam("appId") String appId);

    @PUT
    @Path("/getResource")
    @Produces(MediaType.APPLICATION_JSON)
    String putResource(String resource);
}

实现类:

package com.demo.cxf.rs.impl;

import com.demo.cxf.rs.IRsServcie;
import org.springframework.stereotype.Service;

@Service
public class RsService implements IRsServcie {
    @Override
    public String saveResource(String resource) {
        return "saveResource success";
    }

    @Override
    public String deleteResource(String resource) {
        return "deleteResource success";
    }

    @Override
    public String getResource(String appId) {
        return "getResource success";
    }

    @Override
    public String putResource(String resource) {
        return "putResource success";
    }
}

spring配置文件:

<?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:jaxrs="http://cxf.apache.org/jaxrs" xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
       http://cxf.apache.org/jaxrs
       http://cxf.apache.org/schemas/jaxrs.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="com.demo.cxf.rs"/>
    

    <jaxrs:server address="/rs">
        <jaxrs:serviceBeans>
            <ref bean="rsService"/>
        </jaxrs:serviceBeans>
        <jaxrs:providers>
            <bean class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider"/>
        </jaxrs:providers>
    </jaxrs:server>


</beans>

web.xml:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:spring-*.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>/service/*</url-pattern>
  </servlet-mapping>

</web-app>

通过http发送请求可以调用已经发布的接口:

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值