使用webservice自定义注解处理参数加解密问题

目录

• webservice自定义注解处理参数加解密
• 代码实现
• webservice注解汇总
• @WebService
• @WebMethod
• @Oneway
• @WebParam
• @WebResult
• @HandlerChain

webservice自定义注解处理参数加解密

前一段项目中用到了webservice，正好自己之前也了解过一点apache的cxf框架，所以就采用了cxf来实现webservice服务端，本身实现并没技术难点，但是项目为了保证安全性，采用了传输加密的过程，所以大部分请求参数需要加密，返回参数也需要加密，大致流程是：

• 请求参数对称加密+对称秘钥非对称加密
• 返回参数堆成加密+对称秘钥非对称加密

参数加密本身并不复杂，但是有些服务并不需要加密，有些则需要，加密工具类并不通用

string，datahandler等不能重用，虽然本质都是对字节数据加密，但是要写许多方法，还要方法参数，检查需要加解密处理的参数，然后寻找对应的类型处理方法调用.

逻辑很清晰，但是过程实现很恶心，最终这样实现了一版，但是并不合我的意.

如果能在拦截器中获取到参数列表，然后寻找对应的解码器解码，这样就比较简单了.但是难点是，如果标记参数，并指定被标记参数的解码器尼?

我想到了注解，注解就可以标记，参数，然后通过反射获取到注解，解析出内容.

本来想标记到参数上，但是一个个标记太麻烦，而且获取也不太方便，索性就放在方法上，用数组来接收.

问题解决.

代码实现

自定义注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * @author webservice请求参数自定义注解
 *
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestHanleAnnotation {
    Class[] handler() default {};
    int[] index() default {};
}

参数解码器接口

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
 * @author taoyuan
 *参数处理器
 * @param <T>
 */
public abstract class  ParamHandler<T> {
//解码器实例缓存
public static final Map<Class,ParamHandler> hanlers=new ConcurrentHashMap<>();
//处理方法
     abstract T handle(T t);
}

解码器实现，这里并没有真正解码，只是在参数后面加了123

public class StringHandler extends ParamHandler<String> {
    @Override
    public String handle(String t) {
        return t+"123";
    }
}

服务方法注解使用

//表示第一个参数需要StringHandler处理
    @RequestHanleAnnotation(index=0,handler=StringHandler.class)
    public String test(String test, String test2) throws Exception {
        System.out.println(test);
        System.out.println(test2);
        return "cesshi";
    }

拦截器实现

import java.io.File;
import java.lang.reflect.Method;
import java.util.Map;
import org.apache.commons.io.FileUtils;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.message.MessageContentsList;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;
import org.apache.log4j.Logger;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
/**
 * @author 都市桃源
 */
public class EcrInInterceptor extends AbstractPhaseInterceptor<SoapMessage>{
    private Logger log = Logger.getLogger(ContractLogicImpl.class);
      public EcrInInterceptor(){
            // 在调用方法之前调用拦截器
            super(Phase.PRE_INVOKE);
        }
    @Override
    public void handleMessage(SoapMessage msg) throws Fault {
    /*获取请求ip,拦截器中可以做下统一日志处理
    HttpServletRequest httprequest = (HttpServletRequest)msg.get(AbstractHTTPDestination.HTTP_REQUEST);
        *
        */
        //获取正在执行的方法
         Method method = MsgUtil.getSoapMethod(msg);
         //解析注解,并处理参数
         MessageContentsList contentsList = MessageContentsList.getContentsList(msg);
         MsgUtil.handle(method,contentsList);
    }
    @Override
    public void handleFault(SoapMessage message) {
    super.handleFault(message);
    }

注解解析工具类实现

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.message.Exchange;
import org.apache.cxf.message.MessageContentsList;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.invoker.MethodDispatcher;
import org.apache.cxf.service.model.BindingOperationInfo;
/**
 * @author ll
 * 获取方法名称
 *
 */
public class MsgUtil {
    /**根据消息获取调用方法
     * @param msg
     * @return
     */
    public static Method getSoapMethod(SoapMessage msg){
         Exchange exchange = msg.getExchange();
            BindingOperationInfo bop = exchange.get(BindingOperationInfo.class);
            MethodDispatcher md = (MethodDispatcher) exchange.get(Service.class)
                    .get(MethodDispatcher.class.getName());
            Method method = md.getMethod(bop);
            return method;
    }
    public static void handle(Method method, MessageContentsList contentsList) {
        if(method==null)return;
        RequestHanleAnnotation reqAnno= method.getAnnotation(RequestHanleAnnotation.class);
        int[] indexs = reqAnno.index();
        if(indexs==null||indexs.length==0)return;
        Class[] handlers = reqAnno.handler();
        try {
            //处理器实例
            ParamHandler handler=null;
        for(int i=0,len=indexs.length;i<len;i++){
                //获取需要处理的参数
                Object obj = contentsList.get(indexs[i]);
                //从缓存中获取处理器实例
                handler=ParamHandler.hanlers.get(handlers[i]);
                if(handler==null){
                    //创建处理器实例
                    handler=(ParamHandler) handlers[i].newInstance();
                    //缓存处理器实例
                    ParamHandler.hanlers.put(handlers[i], handler);
                }
                 contentsList.set(indexs[i], handler.handle(obj));
        }
        }catch (Exception e) {
            e.printStackTrace();
        }
    }
}

返回参数同样也可以注解实现，这里就不在赘述了，实现也比较简单.

**需要注意的是,拦截器拦截顺序不一样
拦截器统一继承
AbstractPhaseInterceptor类,
请求拦截 :super(Phase.PRE_INVOKE);
返回拦截: super(Phase.PRE_STREAM);**

webservice注解汇总

@WebService

• serviceName：对外发布的服务名，指定 Web Service 的服务名称：wsdl:service。缺省值为 Java 类的简单名称 + Service。（字符串）
• endpointInterface：服务接口全路径, 指定做SEI（Service EndPoint Interface）服务端点接口
• name：此属性的值包含XML Web Service的名称。在默认情况下，该值是实现XML Web Service的类的名称，wsdl:portType 的名称。缺省值为 Java 类或接口的非限定名称。（字符串
• portName：wsdl:portName。缺省值为 WebService.name+Port。
• targetNamespace：指定你想要的名称空间，默认是使用接口实现类的包名的反序
• wsdlLocation：指定用于定义 Web Service 的 WSDL 文档的 Web 地址。Web 地址可以是相对路径或绝对路径。（字符串）注意：实现类上可以不添加Webservice注解

@WebMethod

注释表示作为一项 Web Service 操作的方法，将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于 JavaBeans 端点的服务器端点实现类。

要点：

仅支持在使用 @WebService 注释来注释的类上使用 @WebMethod 注释

• operationName：指定与此方法相匹配的wsdl:operation 的名称。缺省值为 Java 方法的名称。（字符串）
• action：定义此操作的行为。对于 SOAP 绑定，此值将确定 SOAPAction 头的值。缺省值为 Java 方法的名称。（字符串）
• exclude：指定是否从 Web Service 中排除某一方法。缺省值为 false。（布尔值）

@Oneway

注释将一个方法表示为只有输入消息而没有输出消息的 Web Service 单向操作。

将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于 JavaBeans 端点的服务器端点实现类

@WebParam

注释用于定制从单个参数至 Web Service 消息部件和 XML 元素的映射。

将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于 JavaBeans 端点的服务器端点实现类。

• name：参数的名称。如果操作是远程过程调用（RPC）类型并且未指定partName 属性，那么这是用于表示参数的 wsdl:part 属性的名称。如果操作是文档类型或者参数映射至某个头，那么 -name 是用于表示该参数的 XML 元素的局部名称。如果操作是文档类型、参数类型为 BARE 并且方式为 OUT 或 INOUT，那么必须指定此属性。（字符串）
• partName：定义用于表示此参数的 wsdl:part属性的名称。仅当操作类型为 RPC 或者操作是文档类型并且参数类型为BARE 时才使用此参数。（字符串）
• targetNamespace：指定参数的 XML 元素的 XML 名称空间。当属性映射至 XML 元素时，仅应用于文档绑定。缺省值为 Web Service的targetNamespace。（字符串）
• mode：此值表示此方法的参数流的方向。有效值为 IN、INOUT 和 OUT。（字符串）
• header：指定参数是在消息头还是消息体中。缺省值为 false。（布尔值）

@WebResult

注释用于定制从返回值至 WSDL 部件或 XML 元素的映射。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于 JavaBeans 端点的服务器端点实现类。

• name：当返回值列示在 WSDL 文件中并且在连接上的消息中找到该返回值时，指定该返回值的名称。对于 RPC 绑定，这是用于表示返回值的 wsdl:part属性的名称。对于文档绑定，-name参数是用于表示返回值的 XML 元素的局部名。对于 RPC 和 DOCUMENT/WRAPPED 绑定，缺省值为 return。对于 DOCUMENT/BARE 绑定，缺省值为方法名 + Response。（字符串）
• targetNamespace：指定返回值的 XML 名称空间。仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。（字符串）
• header：指定头中是否附带结果。缺省值为false。（布尔值）
• partName：指定 RPC 或 DOCUMENT/BARE 操作的结果的部件名称。缺省值为@WebResult.name。（字符串）

@HandlerChain

注释用于使 Web Service 与外部定义的处理程序链相关联。只能通过对 SEI 或实现类使用 @HandlerChain 注释来配置服务器端的处理程序。但是可以使用多种方法来配置客户端的处理程序。可以通过对生成的服务类或者 SEI 使用 @HandlerChain 注释来配置客户端的处理程序。此外，可以按程序在服务上注册您自己的 HandlerResolver 接口实现，或者按程序在绑定对象上设置处理程序链。

• file：指定处理程序链文件所在的位置。文件位置可以是采用外部格式的绝对 java.net.URL，也可以是类文件中的相对路径。（字符串）
• name：指定配置文件中处理程序链的名称。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。