Cxf - 拦截器

最新推荐文章于 2024-05-07 02:08:35 发布
最新推荐文章于 2024-05-07 02:08:35 发布
阅读量1.7k 收藏
点赞数
分类专栏： WebServices 文章标签： cxf 拦截器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/guoxilen/article/details/24053655
版权
本文介绍了如何在Cxf中使用拦截器处理Web Services通信。内容包括 Soap消息的解析，服务端和客户端拦截器的添加。在服务端，通过In拦截器验证用户信息，而在客户端则使用Out拦截器将用户信息插入到Soap消息中。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

一、Soap消息

        Web Services通信的内容。如下

<!-- 根元素: Envelope  -->
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <!-- Header：不强制出现的元素，可用于携带一些wsdl定义之外的信息，如用户名信息等  -->
	<soap:Header>
		<userInfo>
			<userName>CxfName</userName>
			<userPass>CxfPass</userPass>
		</userInfo>
	</soap:Header>
	<!-- Body：Soap的消息体，在正确调用的情况下符合WSDL文档定义的格式，调用错误则为soap:Fault子元素  -->
	<soap:Body>
		<ns2:sayHello xmlns:ns2="http://ws.cxf.xilen.com/">
			<arg0>Admin</arg0>
		</ns2:sayHello>
	</soap:Body>
</soap:Envelope>

二、添加拦截器

    1、服务端

import java.util.List;

import javax.xml.ws.Endpoint;

import org.apache.cxf.interceptor.Interceptor;
import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.message.Message;

import com.xilen.cxf.ws.UserInfoWs;
import com.xilen.cxf.ws.impl.UserInfoWsImpl;

public class ServerMain {
	public static void main(String[] args) {

		UserInfoWs ui = new UserInfoWsImpl();

		// 得到javax.xml.ws.Endpoint.publish()发布方法的org.apache.cxf.jaxws.EndpointImpl类型返回值
		EndpointImpl ep = (EndpointImpl) Endpoint.publish("http://192.168.1.100/cxf", ui);

		// 通过这个返回值的getInInterceptors()和getOutInterceptors()方法得到现有的对应拦截器集合
		List<Interceptor<? extends Message>> interceptorIn = ep.getInInterceptors();
		List<Interceptor<? extends Message>> interceptorOut = ep.getOutInterceptors();

		// 通过这个集合的添加方法添加拦截器   LoggingInterceptor为Cxf自带拦截器
		interceptorIn.add(new LoggingInInterceptor());
		interceptorOut.add(new LoggingOutInterceptor());

	}
}
    2、客户端

        客户端此时使用了Cxf相关的对象，需要添加Cxf的Jar

public class ClientMain {
	
	public static void main(String[] args) {
	
		//在生成的Java类中继承javax.xml.ws.Service的类可作为工厂来使用
		UserInfoWsImpl factory = new UserInfoWsImpl();
		
		//通过工厂类实例来获取远程Web Service对象的代理
		UserInfoWs uiws = factory.getUserInfoWsImplPort();
		
		//以远程代理对象为参数调用ClientProxy的getClient()方法获取Client对象
		Client client = ClientProxy.getClient(uiws);
		
		//获取Client对象的输入输出拦截器集合并添加新的拦截器
		client.getInInterceptors().add(new LoggingInInterceptor());
		client.getOutInterceptors().add(new LoggingOutInterceptor());
		
		//调用代理对象的方法实现远程调用
		System.out.println(uiws.sayHello("Admin"));
		
	}
}


三、自定义拦截器

    1、说明

        以调用Web Services时需要验证用户为例说明。服务器端需要添加In拦截器验证是否有用户信息并符合要求，而客户端则需要添加Out拦截器把用户信息加入到Soap消息中。

    2、服务器端

        （1）定义服务器端拦截器

import java.util.List;

import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

/**
 * 自定义拦截器继承Interceptor接口，可通过继承AbstractPhaseInterceptor<Message>来实现(Message使用SoapMessage的实现)
 * 通过PhaseInterceptor拦截器可以指定这个拦截器在服务的哪个阶段起作用，具体阶段在实现类的构造器中传入
 */
public class ServerAuthInInterceptor extends AbstractPhaseInterceptor<SoapMessage>{
	
	/**
	 * AbstractPhaseInterceptor没有无参构造器，需要在子类中定义构造器并显示的调用其有参数的构造器
	 */
	public ServerAuthInInterceptor(){
		/*
		 * 显示调用父类的构造器。参数通过Phase类的常量指定，即这个拦截器起作用的阶段
		 * Phase.PRE_INVOKE: 调用之前起作用 
		 */
		super(Phase.PRE_INVOKE);
	}
	
	/**
	 * 重写AbstractPhaseInterceptor的handleMessage()方法 定义拦截业务的逻辑
	 * 参数message就是被拦截到的soap消息
	 * 对符合逻辑的请求Cxf不用多余的操作，只需要在不符合业务逻辑的请求Throw Fault
	 */
	public void handleMessage(SoapMessage message) throws Fault {
		/*
		 * soap body是固定的， 其他信息只能放在Header中
		 * 通过SoapMessage对象的getHeader()方法得到Header的集合
		 */
		List<Header> headers = message.getHeaders();
		
		if (headers.isEmpty()) {
			throw new Fault(new IllegalArgumentException("没有携带额外的信息!"));
		}
		
		// 假设要求第一个Header就携带用户信息
		Header header = headers.get(0);
		// 得到的是DOM的元素
		Element element = (Element) header.getObject();
		
		// DOM解析
		NodeList nodeUserName = element.getElementsByTagName("userName");
		NodeList nodeUserPass = element.getElementsByTagName("userPass");
		if(nodeUserName.getLength() != 1 || nodeUserPass.getLength() != 1){
			throw new Fault(new IllegalArgumentException("没有携带用户信息或者不符合要求!"));
		}
		
		// 得到具体的用户名和密码并验证
		String userName = nodeUserName.item(0).getTextContent();
		String userPass = nodeUserPass.item(0).getTextContent();
		if(!userName.equals("CxfName") || !userPass.equals("CxfPass")){
			throw new Fault(new IllegalArgumentException("用户名或者密码不正确!"));
		}
		
		// 如果验证一路通过，则请求自动继续往下
		
	}
}

        （2）添加服务器端拦截器

public class ServerMain {
	public static void main(String[] args) {

		UserInfoWs ui = new UserInfoWsImpl();

		// 得到javax.xml.ws.Endpoint.publish()发布方法的org.apache.cxf.jaxws.EndpointImpl类型返回值
		EndpointImpl ep = (EndpointImpl) Endpoint.publish("http://192.168.1.100/cxf", ui);

		// 通过这个返回值的getInInterceptors()和getOutInterceptors()方法得到现有的对应拦截器集合
		List<Interceptor<? extends Message>> interceptorIn = ep.getInInterceptors();
		List<Interceptor<? extends Message>> interceptorOut = ep.getOutInterceptors();

		// 通过这个集合的添加方法添加拦截器
		interceptorIn.add(new LoggingInInterceptor());
		interceptorOut.add(new LoggingOutInterceptor());
		
		//添加自定义拦截器
		interceptorIn.add(new ServerAuthInInterceptor());

	}
}

    3、客户端

        （1）定义客户端拦截器

import java.util.List;

import javax.xml.namespace.QName;

import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.headers.Header;
import org.apache.cxf.helpers.DOMUtils;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

public class ClientAuthOutInterceptor extends AbstractPhaseInterceptor<SoapMessage> {

	private String name;
	private String pwd;

	/**
	 * 除了调用父类构造方法之外，也把用户信息一并添加
	 */
	public ClientAuthOutInterceptor(String name, String pwd) {
		// 在消息发送之前调用 此时Soap消息已经生成
		super(Phase.PREPARE_SEND);  
		this.name = name;
		this.pwd = pwd;
	}

	@Override
	public void handleMessage(SoapMessage message) throws Fault {
		List<Header> headers = message.getHeaders();
		
		// DOM编程
		Document doc = DOMUtils.createDocument();
		Element element = doc.createElement("userInfo");
		
		// 封装用户信息
		Element nameEle = doc.createElement("userName");
		nameEle.setTextContent(name);
		Element passEle = doc.createElement("userPass");
		passEle.setTextContent(pwd);
		
		element.appendChild(nameEle);
		element.appendChild(passEle);
		
		// 把element元素封装成Header并添加到Headers中  QName即命名空间
		Header header = new Header(new QName("xilen"), element);
		headers.add(header);
		
	}
}
        （2）添加客户端拦截器 

import org.apache.cxf.endpoint.Client;
import org.apache.cxf.frontend.ClientProxy;
import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;

import com.xilen.cxf.ws.UserInfoWs;
import com.xilen.cxf.ws.impl.UserInfoWsImpl;
import com.xilen.inter.ClientAuthOutInterceptor;

public class ClientMain {
	
	public static void main(String[] args) {
	
		//在生成的Java类中继承javax.xml.ws.Service的类可作为工厂来使用
		UserInfoWsImpl factory = new UserInfoWsImpl();
		
		//通过工厂类实例来获取远程Web Service对象的代理
		UserInfoWs uiws = factory.getUserInfoWsImplPort();
		
		//以远程代理对象为参数调用ClientProxy的getClient()方法获取Client对象
		Client client = ClientProxy.getClient(uiws);
		
		//获取Client对象的输入输出拦截器集合并添加新的拦截器
		client.getInInterceptors().add(new LoggingInInterceptor());
		client.getOutInterceptors().add(new LoggingOutInterceptor());
		
		//自定义用户认证拦截器，存入用户名密码信息
		client.getOutInterceptors().add(new ClientAuthOutInterceptor("CxfName","CxfPass"));
		
		//调用代理对象的方法实现远程调用
		System.out.println(uiws.sayHello("Admin"));
		
	}
}
    4、调用结果
        （1）在用户信息输入正确的情况下，服务端顺利执行了相应的方法并返回 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:sayHelloResponse xmlns:ns2="http://ws.cxf.xilen.com/">
			<return>Admin, Hello!</return>
		</ns2:sayHelloResponse>
	</soap:Body>
</soap:Envelope>
        （2）在用户信息输入错误的情况下，服务器端只返回了错误调用的信息 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<soap:Fault>
			<faultcode>soap:Server</faultcode>
			<faultstring>用户名或者密码不正确!</faultstring>
		</soap:Fault>
	</soap:Body>
</soap:Envelope>


四、资源下载  
    客户端和服务端的工程源码已打包上传优快云，地址：http://download.youkuaiyun.com/detail/u013379717/7216357

 

 

CXF 拦截器 拦截请求和发送时的报文
04-10 1343
参考：https://blog.youkuaiyun.com/yczz/article/details/16809859#commentBox http://cxf.apache.org/docs/interceptors.html https://elim.iteye.com/blog/2248620#_Toc431737707 cxf 可以对请求和发送时的报文进行拦截，然后对其进行加工成我...
Apache CXF interceptor拦截器的使用
lichuangcsdn的博客
12-03 3634
现在一般很少会用到Webservice了，但有时候和第三方传统机构对接，他们用的可能是WebService。这里写下CXF 拦截器的使用。 拦截器分为服务端拦截器和客户端拦截器，又分为入拦截器（in）和出拦截器（out） 先讲述一个Webservice请求过程如下。 1、首先是客户端发起请求，在请求到达服务端之前，我们可以用客户端出拦截器（client  out  interceptor）进...
CXF拦截器（Interceptor）的使用
weixin_34072857的博客
06-16 462
CXF拦截器（Interceptor）的使用   CXF的拦截器是CXF功能最主要的扩展点。通过自定义的Interceptor，可以改变请求和响应的一些消息处理，其中最基本的原理还是一个动态代理。   Interceptor是CXF架构中一个很有特色的模式。你可以在不对核心模块进行修改的情况下，动态添加很多功能。这对于CXF这个以处理消息为中心的服务框架来说是非常有用的，CXF通过在Int...
CXF - 拦截器
weixin_33778544的博客
03-25 261
2019独角兽企业重金招聘Python工程师标准>>> ...
CXF 拦截器获取方法信息和参数信息
syj0301的专栏
08-24 5599
1. 配置beans.xml               2. 拦截器实现 package com.sf.module.test; import java.lang.reflect.Method; import java.util.List; import org.apache.cxf.binding.soap.Soap
CXF-拦截器-权限控制-登录校验
02-22
本文将深入探讨"CXF拦截器-权限控制-登录校验"这一主题。 首先，我们需要了解什么是拦截器。在CXF框架中，拦截器是实现业务逻辑和基础架构之间解耦的一种方式。它们可以插入到服务调用的生命周期中，在消息发送前或...
apache-cxf-2.2.4
11-06
7. **扩展性**：CXF的模块化设计使其易于扩展，用户可以根据需求添加自定义功能，如自定义消息处理器、拦截器等。 8. **工具集**：CXF提供了一系列的工具，如WSDL生成器、代码生成器等，帮助开发者更便捷地进行服务...
apache-cxf-2.1.4
05-06
6. **拦截器和管道**：CXF的拦截器机制允许在服务调用前后插入自定义逻辑，而管道则允许对消息进行复杂处理和转换。 7. **Spring框架集成**：CXF可以很好地与Spring框架结合，使得服务的配置和管理变得更加容易。 ...
apache-cxf-2.7.7.zip
10-12
5. **插件架构**：CXF的插件架构允许开发者轻松地扩展其功能，比如添加新的数据绑定框架或者自定义拦截器。 6. **强大的测试工具**：CXF提供了一套完整的测试工具，如CXF的WS-Testing框架，可以帮助开发者测试Web...
wsdl2java源码-cxf-samples:cxf-样本
06-05
4. **SOAP消息处理**：通过示例了解CXF如何处理SOAP请求和响应，包括消息编码、解码，以及如何添加自定义的行为和拦截器。 5. **RESTful服务**：学习JAX-RS的使用，创建RESTful API，包括资源定义、HTTP方法映射、...
【WebService】CXF拦截器的设置以及自定义CXF拦截器
盐焗味的小星球的博客
10-21 885
CXF的拦截器和以前学过的servlet的拦截器类似的，都是在开始或结束切入一段代码，执行一些逻辑之类的。我们可以在调用ws服务前设置拦截器，也可以在调用ws服务后设置拦截器，当然了，拦截器也可以添加多个，CXF中有自己内置的拦截器，先来写个简单CXF自带的拦截器实例熟悉一下在CXF中如何添加，然后再来自定义CXF拦截器。 CXF内置的拦截器设置 还是使用上一节的ws，在原来的基础上添加以下拦...
(三)cxf的拦截器使用
u010502101的博客
02-23 1462
在webservice的客户端和服务端的请求和响应的过程中，能动态的操作请求和响应的数据，能够拦截请求和响应的数据并进行响应的操作，设计了cxf的拦截器，注意JDK中支持webservice，但不支持拦截器，所以开发强大的webservice通信，推荐cxf框架。拦截器分类： 1. 按所处的位置分：服务器端拦截器，客户端拦截器 2. 按消息的方向分：入拦截器，出拦截器 3. 按定义者分：
CXF系列（三）：拦截器
二次开发需求博客
11-07 1284
 拦截器这个概念基本上都已经熟悉了，本文要讲的CXF拦截器就是在客户端调用前拦截，以及调用服务端方法前拦截。因为考虑两个应用互相掉接口的权限和安全性问题，服务端要验证是否合理才传递东西给客户端，所以客户端可以把一些服务端需要的东西配置xml传递过去。 常用的一些拦截器，需要配置，比如日志，客户端分输出的和输入的，服务端分输入的和输出的，另外把服务端pom文件的依赖copy到客户端去。除了已
SpringBoot + CXF快速实现SOAP WebService（支持Basic Auth）
weixin_30745553的博客
04-06 729
唠叨两句 讲真，SOAP跟现在流行的RESTful WebService比起来显得很难用。冗余的XML文本信息太多，可读性差，它的请求信息有时很难手动构造，不太好调试。不过说归说，对某些企业用户来说SOAP的使用率仍然是很高的。 需求背景 接手维护的一个项目，最近客户想开放项目中的功能给第三方调用，而且接入方指定必须是SOAP接口。这项目原来的代码我看着头疼，也不想再改了，...
基于CXF的webservice拦截器
u014543166的博客
11-02 1254
CXF webservice 拦截器 定制报文格式
2024年前端最新webservice（3）：CXF拦截器介绍及自定义拦截器实现，web开发工程师面试题
最新发布
2401_84433924的博客
05-07 865
CXF中也可以自定义拦截器，CXF中实现自定义拦截器需要继承AbstractPhaseInterceptor或者其子类如AbstractSoapInterceptor。一个简单的拦截器：/*** CXF 自定义拦截器*///必需提供一个带参数的构造函数//覆写拦截后的动作@Override= null) {= null) {添加到客户端拦截器链：ser.get();输出：nullnull。
Webservice实践（六）CXF拦截器简介
csolo的博客
02-03 1327
Cxf的拦截器包括入拦截器和出拦截器，所有的入拦截器或出拦截器构成了一个拦截器链，它们可以作用在Server端也可以作用在Client端。
@service报错_CXF使用及常见报错
weixin_31727937的博客
12-30 928
Apache CXF 是一个开源的 WebService 框架，CXF可以用来构建和开发 WebService，这些服务可以支持多种协议，比如：SOAP、POST/HTTP、HTTP ，CXF 大大简化了WebService并且可以天然地和 Spring 进行无缝集成。CXF是 Celtrix （ESB框架）和 XFire（webserivice） 合并而成，核心是org.apache.cxf....
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值