REST服务例子

1、接口类(IHello) 
Java代码   收藏代码
  1. import javax.ws.rs.GET;  
  2. import javax.ws.rs.Path;  
  3. import javax.ws.rs.PathParam;  
  4.   
  5. import com.bean.Result;  
  6.   
  7. @Path ("/find/")  
  8. public interface IHello {  
  9.   
  10.     /** 
  11.      * 登录  
  12.      * @param userName 帐号 
  13.          * @param userPass 密码 
  14.      * @return  
  15.      */  
  16.     @POST   
  17.     @Path ("/login")  
  18.     Result login(@FormParam("userName")String userName,@FormParam("userPass")String userPass);  
  19.   
  20.        /** 
  21.      * 按名称查询  
  22.      * @param who 名字 
  23.      * @return  
  24.      */  
  25.     @GET   
  26.     @Path ("/findByName/{who}")  
  27.     Result findByName(@PathParam("who")String who);  
  28.   
  29. }  


2、实现类(HelloImpl) 
Java代码   收藏代码
  1. public class HelloImpl implements IHello {  
  2.   
  3.     @Override  
  4.     public Result findByName(String who) {  
  5.        //逻辑实现  
  6.     }  
  7.   
  8.         @Override  
  9.     public Result login(String userName, String userPass) {  
  10.        //逻辑实现  
  11.     }  
  12.   
  13. }  


3、返回实体(Result) 
Java代码   收藏代码
  1. import java.util.List;  
  2.   
  3. import javax.xml.bind.annotation.XmlRootElement;  
  4.   
  5. @XmlRootElement(name = "result")  
  6. public class Result implements Serializable{  
  7.   
  8.     /** 
  9.      * 返回结果 
  10.      */  
  11.     private List<User> lstUser;  
  12.   
  13.     public List<User> getLstUser() {  
  14.         return lstUser;  
  15.     }  
  16.   
  17.     public void setLstUser(List<User> lstUser) {  
  18.         this.lstUser = lstUser;  
  19.     }  
  20. }  


4、app-rest.xml配置 
Xml代码   收藏代码
  1. <beans xmlns="http://www.springframework.org/schema/beans"  
  2.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxrs="http://cxf.apache.org/jaxrs"  
  3.     xsi:schemaLocation="  
  4. http://www.springframework.org/schema/beans  
  5. http://www.springframework.org/schema/beans/spring-beans.xsd  
  6. http://cxf.apache.org/jaxrs  
  7. http://cxf.apache.org/schemas/jaxrs.xsd">  
  8.   
  9.   
  10.     <import resource="classpath:META-INF/cxf/cxf.xml" />  
  11.     <import resource="classpath:META-INF/cxf/cxf-extension-jaxrs-binding.xml" />  
  12.     <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />  
  13.   
  14.     <jaxrs:server id="hello" address="/hello">  
  15.         <jaxrs:extensionMappings>  
  16.             <entry key="json" value="application/json" />  
  17.             <entry key="xml" value="application/xml" />  
  18.         </jaxrs:extensionMappings>  
  19.         <jaxrs:serviceBeans>  
  20.             <ref bean="helloImpl" />  
  21.         </jaxrs:serviceBeans>  
  22.     </jaxrs:server>  
  23.   
  24.     <bean id="helloImpl" class="com.HelloImpl" />  
  25. </beans>  


5、依赖jar包 
Xml代码   收藏代码
  1. <dependency>  
  2.     <groupId>org.apache.cxf</groupId>  
  3.     <artifactId>apache-cxf</artifactId>  
  4.     <version>2.2.7</version>  
  5.     <type>pom</type>  
  6.     <scope>compile</scope>  
  7. </dependency>  
  8. <dependency>  
  9.     <groupId>javax.ws.rs</groupId>  
  10.     <artifactId>jsr311-api</artifactId>  
  11.     <version>1.0</version>  
  12.     <type>jar</type>  
  13.     <scope>compile</scope>  
  14. </dependency>  
  15. <dependency>  
  16.     <groupId>commons-httpclient</groupId>  
  17.     <artifactId>commons-httpclient</artifactId>  
  18.     <version>3.1</version>  
  19. </dependency>  
  20. <dependency>  
  21.     <groupId>org.springframework</groupId>  
  22.     <artifactId>spring</artifactId>  
  23.     <version>2.5.4</version>  
  24. </dependency>  
  25. <dependency>  
  26.     <groupId>org.springframework</groupId>  
  27.     <artifactId>spring-webmvc</artifactId>  
  28.     <version>2.5.4</version>  
  29. </dependency>  
  30. <dependency>  
  31.     <groupId>javax.servlet</groupId>  
  32.     <artifactId>servlet-api</artifactId>  
  33.     <version>2.5</version>  
  34.     <type>jar</type>  
  35.     <scope>provided</scope>  
  36. </dependency>  


6、web.xml配置 
Xml代码   收藏代码
  1. <servlet>  
  2.     <servlet-name>CXFServlet</servlet-name>  
  3.     <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>  
  4.     <load-on-startup>1</load-on-startup>  
  5. </servlet>  
  6.   
  7. <servlet-mapping>  
  8.     <servlet-name>CXFServlet</servlet-name>  
  9.     <url-pattern>/rest/*</url-pattern>  
  10. </servlet-mapping>  


7、调用方法 
方法一: 
Java代码   收藏代码
  1. HttpClient httpClient = new HttpClient();  
  2. GetMethod getMethod = new GetMethod("http://localhost:8080/Test/rest/hello/find/findByName/jack.xml");  
  3. try {  
  4.     int status = httpClient.executeMethod(getMethod);  
  5.     if (status == 200) {  
  6.         XMLSource xmlSource = new XMLSource(getMethod.getResponseBodyAsStream());  
  7.         Result result = xmlSource.getNode("/", Result.class);  
  8.         System.out.println(result.getLstUser().size());  
  9.     }  
  10. catch (Exception e) {  
  11.     e.printStackTrace();  
  12. }  

方法二: 
Java代码   收藏代码
  1. IHello hello = (IHello) JAXRSClientFactory.create("http://localhost:8080/Test/rest/hello", IHello.class);  
  2. Result result = hello.findByName("jack");  
  3. System.out.println(result.getLstUser().size());  


8、优缺点和注意事项 
1.优缺点 
优点:跨平台(支持xml和json格式) 
缺点:效率低 
2.注意事项 
参数:如果不是java的基本类型需要封装成javabean,类必须加如下注解: 
Java代码   收藏代码
  1. @XmlRootElement  
  2. @XmlAccessorType(XmlAccessType.FIELD)  
  3. public class Param {  
  4. ...   
  5. }  

返回值:如果不是java基本类型需要封装成javabean,需要序列化,属性和类需要加如下注解: 
Java代码   收藏代码
  1. @XmlRootElement(name = "result")  
  2. public class Result implements Serializable {  
  3.  @Field   
  4.  private String id;  
  5.  ...  
  6. }  

你可能感兴趣的:(REST)