您的位置: 首页  >  文章  >  CXF系列（三）：拦截器

CXF系列（三）：拦截器

分类: 文章 • 2025-04-18 23:47:34


拦截器这个概念基本上都已经熟悉了，本文要讲的CXF拦截器就是在客户端调用前拦截，以及调用服务端方法前拦截。因为考虑两个应用互相掉接口的权限和安全性问题，服务端要验证是否合理才传递东西给客户端，所以客户端可以把一些服务端需要的东西配置xml传递过去。

常用的一些拦截器，需要配置，比如日志，客户端分输出的和输入的，服务端分输入的和输出的，另外把服务端pom文件的依赖copy到客户端去。除了已经有的我们还可以自定义拦截器，比如客户端我们写一个拦截器在请求发出前我们配置一些服务端要验证的东西比如权限，服务端也写一个在请求到达后调用接口方法时验证，验证通过我们就返回数据给客户端。

1：服务端接口暴露方法

[java] view plain copy
  1. package com.qqw.webserviceImpl;  
  2.   
  3. import javax.xml.ws.Endpoint;  
  4.   
  5. import org.apache.cxf.interceptor.LoggingInInterceptor;  
  6. import org.apache.cxf.interceptor.LoggingOutInterceptor;  
  7. import org.apache.cxf.jaxws.JaxWsServerFactoryBean;  
  8.   
  9. import com.qqw.interceptor.MyInterceptor;  
  10. import com.qqw.webservice.HelloWorld;  
  11.   
  12. public class Server {  
  13.   
  14.     /** 
  15.      * @param args 
  16.      */  
  17.     public static void main(String[] args) {  
  18.           
  19.         System.out.println("ws is start");  
  20.         HelloWorld hwHelloWorld=new HelloWorldImpl();  
  21.         String address="http://172.16.10.123/helloWorld";  
  22.         //Endpoint.publish(address, hwHelloWorld);  
  23.         JaxWsServerFactoryBean factoryBean=new JaxWsServerFactoryBean();  
  24.         factoryBean.setAddress(address);  
  25.         factoryBean.setServiceClass(HelloWorld.class);  
  26.         factoryBean.setServiceBean(hwHelloWorld);  
  27.         factoryBean.getInInterceptors().add(new MyInterceptor());  
  28.         factoryBean.getInInterceptors().add(new LoggingInInterceptor());//添加in日志拦截器  
  29.         factoryBean.getOutInterceptors().add(new LoggingOutInterceptor());//添加out日志拦截器  
  30.         factoryBean.create();  
  31.         System.out.println("ws is started");  
  32.   
  33.     }  
  34.   
  35. }  


2：服务端的自定义拦截器

[java] view plain copy
  1. package com.qqw.interceptor;  
  2.   
  3. import java.util.List;  
  4.   
  5. import org.apache.cxf.binding.soap.SoapMessage;  
  6. import org.apache.cxf.headers.Header;  
  7. import org.apache.cxf.interceptor.Fault;  
  8. import org.apache.cxf.phase.AbstractPhaseInterceptor;  
  9. import org.apache.cxf.phase.Phase;  
  10. import org.w3c.dom.Element;  
  11. import org.w3c.dom.NodeList;  
  12.   
  13. public class MyInterceptor extends AbstractPhaseInterceptor<SoapMessage> {  
  14.   
  15.     public MyInterceptor() {  
  16.         super(Phase.PRE_INVOKE);//在调用接口方法之前拦截  
  17.           
  18.     }  
  19.   
  20.     @Override  
  21.     public void handleMessage(SoapMessage message) throws Fault {  
  22.           
  23.         List<Header> headers = message.getHeaders();  
  24.         if(headers==null || headers.size()==0){  
  25.             throw new Fault(new IllegalArgumentException("没有Header，拦截器实施拦截"));  
  26.         }  
  27.         Header header = headers.get(0);  
  28.         Element ele = (Element) header.getObject();  
  29.         NodeList uNode = ele.getElementsByTagName("userName");  
  30.         NodeList pNode = ele.getElementsByTagName("passWord");  
  31.         if(uNode.getLength()!=1){  
  32.             throw new Fault(new IllegalArgumentException("用户名格式不对"));  
  33.         }  
  34.         if(pNode.getLength()!=1){  
  35.             throw new Fault(new IllegalArgumentException("密码格式不对"));  
  36.         }  
  37.         if(!uNode.item(0).getTextContent().equals("qqw") || !pNode.item(0).getTextContent().equals("123456")){  
  38.             throw new Fault(new IllegalArgumentException("用户名或密码错误"));  
  39.         }  
  40.     }  
  41.   
  42. }  

3：客户端的调用

[java] view plain copy
  1. package com.qqw.webservice;  
  2.   
  3. import java.util.List;  
  4.   
  5. import org.apache.cxf.frontend.ClientProxy;  
  6. import org.apache.cxf.interceptor.LoggingInInterceptor;  
  7. import org.apache.cxf.interceptor.LoggingOutInterceptor;  
  8.   
  9. import com.qqw.interceptor.AddHeaderInterceptor;  
  10.   
  11. public class Client {  
  12.   
  13.     /** 
  14.      * @param args 
  15.      */  
  16.     public static void main(String[] args) {  
  17.         // TODO Auto-generated method stub  
  18.   
  19.         HelloWorldService hService=new HelloWorldService();  
  20.         HelloWorld helloWorld = hService.getHelloWorldPort();  
  21.           
  22.         org.apache.cxf.endpoint.Client client = ClientProxy.getClient(helloWorld);  
  23.         client.getOutInterceptors().add(new LoggingOutInterceptor());//out日志  
  24.         client.getInInterceptors().add(new LoggingInInterceptor());//in日志  
  25.         client.getOutInterceptors().add(new AddHeaderInterceptor("qqw","123456")); // 添加自定义拦截器  
  26.       
  27.         User user=new User();  
  28.         user.setName("qqw1");  
  29.         List<Role> roleList = helloWorld.getUserRole(user);  
  30.         for(int i=0;i<roleList.size();i++){  
  31.             System.out.println("编号："+roleList.get(i).getId()+"/角色名称："+roleList.get(i).getName());  
  32.         }  
  33.         MyRoleArray map = helloWorld.getMap();  
  34.         List<MyRole> list = map.item;  
  35.         for(int i=0;i<list.size();i++){  
  36.             System.out.print(list.get(i).getKey()+":");  
  37.             for(Role r:list.get(i).getValue()){  
  38.                 System.out.print(r.getId()+","+r.getName());  
  39.             }  
  40.             System.out.println("================");  
  41.         }  
  42.           
  43.           
  44.     }  
  45.   
  46. }  

4：客户端的自定义拦截器

[java] view plain copy
  1. package com.qqw.interceptor;  
  2.   
  3. import java.util.List;  
  4.   
  5. import javax.xml.namespace.QName;  
  6.   
  7. import org.apache.cxf.binding.soap.SoapMessage;  
  8. import org.apache.cxf.headers.Header;  
  9. import org.apache.cxf.helpers.DOMUtils;  
  10. import org.apache.cxf.interceptor.Fault;  
  11. import org.apache.cxf.phase.AbstractPhaseInterceptor;  
  12. import org.apache.cxf.phase.Phase;  
  13. import org.w3c.dom.Document;  
  14. import org.w3c.dom.Element;  
  15.   
  16. public class AddHeaderInterceptor extends AbstractPhaseInterceptor<SoapMessage> {  
  17.   
  18.     private String userName;  
  19.     private String passWord;  
  20.       
  21.     public AddHeaderInterceptor(String userName,String passWord) {  
  22.         super(Phase.PREPARE_SEND);//准备调用前调用  
  23.         this.userName=userName;  
  24.         this.passWord=passWord;  
  25.     }  
  26.   
  27.     public void handleMessage(SoapMessage message) throws Fault {  
  28.           
  29.         List<Header> headers = message.getHeaders();  
  30.           
  31.         Document document = DOMUtils.createDocument();  
  32.         Element element = document.createElement("authHeader");  
  33.         Element uelement = document.createElement("userName");  
  34.         uelement.setTextContent(userName);  
  35.         Element pelement = document.createElement("passWord");  
  36.         pelement.setTextContent(passWord);  
  37.           
  38.         element.appendChild(uelement);  
  39.         element.appendChild(pelement);  
  40.           
  41.         headers.add(new Header(new QName("qqw"), element));  
  42.     }  
  43.   
  44. }  

5：查看控制台

（1）服务端的发布（服务端日志）CXF系列（三）：拦截器

（2）客户端调用（客户端日志）

CXF系列（三）：拦截器


可以看到客户端在准备调服务端接口前，拦截器起了作用，把用户名和密码写进了document里面通过xml形式传递过去，服务端验证后把数据再次以xml形式返回过来

（3）服务端的日志

CXF系列（三）：拦截器


可以看到服务端先把传过来的用户名和密码解析，合理后把数据以xml形式传给客户端。同理如果用户名或密码错误，服务端和客户端会提示自定义的异常信息。至此CXF的拦截器完毕。

相关推荐