【Apache CXF】Interceptor與Phase

server端和client端均可以使用攔截器作一些記錄、轉換、驗證、錯誤處理什麼的。
好比處理傳輸的對象較大時使用GZIPIn/OutInterceptor。

interceptor以phase方式組織起來，類似功能的interceptor屬一個phase。
phase實現Comparator接口，以priority屬性進行排序，phaseManager將其依次添加至SortedSet。
當須要doInterceptor()時則按順序依次執行。

CXF提供的Interceptor有in和out的區別。
好比當服務被調用時攔截器鏈會被建立並調用，此時對於client端是out interceptor，而對於server端則是in interceptor。
反之，當server端做響應時，對於server端是out interceptor，而對於client端則是in interceptor。

打開看org.apache.cxf.interceptor.Interceptor<T extendsMessage>的類型層級關係發現數量好多。

CXF中的不少組件都繼承org.apache.cxf.interceptor.InterceptorProvider，以自由地添加/移除過濾器。

定義一個攔截器只須要繼承org.apache.cxf.phase.AbstractPhaseInterceptor或其子類。
若是須要使用到Message接口中的一些方法的話仍是直接繼承AbstractPhaseInterceptor比較好；
若是想獲取一些特定的信息，則須要繼承那些特定的攔截器。

原先我是想直接實現phaseInterceptor或者繼承AbstractPhaseInterceptor，但我以annotation方式爲服務設置interceptor時必須在constructor中指定phase，並且此時interceptor沒法定義一個無參constructor。
因而我繼承了SoapActionInInterceptor輸出點信息，繼承AbstractPhaseInterceptor的子類則是同一個phase:

package pac.king.webservice.interceptor;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.binding.soap.interceptor.SoapActionInInterceptor;
import org.apache.cxf.interceptor.Fault;
public class MyInterceptor extends SoapActionInInterceptor {
    @Override
    public void handleMessage(SoapMessage m) throws Fault {
        System.out.println(m.get(m.PROTOCOL_HEADERS));
        System.out.println(m.get(m.REQUEST_URL));
    }
}

有三種方式設置interceptor。

·調用方法
好比像這樣以編程方式啓動服務時順便添加interceptor:

JaxWsServerFactoryBean factory = new JaxWsServerFactoryBean();
factory.setServiceClass(MyCxfServiceImpl.class);
factory.setAddress("http://localhost:8080/runtrain/services/MyCxfService");
factory.create().getEndpoint().getInInterceptors().add(new MyInterceptor(Phase.USER_PROTOCOL));

·annotation
沒什麼特別的，interceptor註解支持兩種參數:

/**
 * Specifies a list of classes that are added to the inbound interceptor
 * chain. This annotation effects SEI classes and service implementation
 * classes.
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface InInterceptors {
                                                                                                                                                                                                                                         
    String[] interceptors() default { };
                                                                                                                                                                                                                                         
    Class<? extends Interceptor<? extends Message>>[] classes() default { };
}

因而我能夠直接寫到service類上面:

package pac.king.webservice;
import java.util.HashMap;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.cxf.interceptor.InInterceptors;
import pac.king.pojo.User;
import pac.king.webservice.interceptor.MyInterceptor;
import pac.king.webservice.utils.MyMapAdapter;
@InInterceptors(classes={MyInterceptor.class})
@WebService
public interface MyCxfService {
    @WebMethod
    @XmlJavaTypeAdapter(MyMapAdapter.class)
    public @WebResult HashMap<String,String> convertUserInfoToMap(@WebParam User user);
}

·XML configuration

<bean id="myInterceptor" class="pac.king.webservice.interceptor.MyInterceptor" />
<cxf:bus>
    <cxf:inInterceptors>
        <ref bean="myInterceptor"/>
    </cxf:inInterceptors>
</cxf:bus>

client端設置interceptor的方法幾乎相同。
這裏記錄一下編程方式設置Interceptor的方式，雖然代碼中的service是從spring context中拿的，可是配置interceptor則是經過在代碼中add:

package pac.king.webservice;
import java.util.Map;
import org.apache.cxf.frontend.ClientProxy;
import org.apache.cxf.phase.Phase;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import pac.king.pojo.User;
import pac.king.webservice.interceptor.MyInterceptor;
public class TestCase {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:applicationContext*.xml");
        MyCxfService client = (MyCxfService) context.getBean("MyCxfClient");
        ClientProxy.getClient(client).getInInterceptors().add(new MyInterceptor(Phase.INVOKE));
        Map<String,String> map = client.convertUserInfoToMap(new User("100001","King.","t;stmdtkg"));
        System.out.println(map.get("id"));
        System.out.println(map.get("name"));
        System.out.println(map.get("password"));
                                                   
    }
}