sviolet.slate.common.x.bean.mbrproc.MemberProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slate-common Show documentation
Comprehensive Java library for spring framework (Java8+)
There is a newer version: 22.1.0
/*
 * Copyright (C) 2015-2018 S.Violet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Project GitHub: https://github.com/shepherdviolet/slate
 * Email: [email protected]
 */

package sviolet.slate.common.x.bean.mbrproc;

import org.springframework.context.ApplicationContext;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * SpringBean成员处理器接口
 *
 * 
 * 说明:

 * 1.用于对SpringContext中所有的Bean成员(Field/Method)进行处理, 处理时机为Bean装配阶段(BeanPostProcessor)

 * 2.可以实现Bean成员的自定义注入/变换/代理替换等

 * 3.该注解允许多次声明, 声明不同的处理器处理不同的注解
 * 
 *
 * 用法 ===========================================================================================
 *
 * 定义一个注解:
 *
 *  *  @Target({ElementType.FIELD, ElementType.METHOD})
 *  @Retention(RetentionPolicy.RUNTIME)
 *  @Documented
 *  public @interface HttpClient {
 *      // ...
 *  }
 * 
 *
 * 编写一个处理器:
 *
 *  *  public class HttpClientMemberProcessor implements MemberProcessor {
 *
 *      public Class acceptAnnotationType() {
 *          //声明本处理器接收的注解类型. 注意: 不允许存在两个以上的处理器处理同一个注解!
 *          return HttpClient.class;
 *      }
 *
 *      public void visitField(Object bean, String beanName, Field field, HttpClient annotation, ApplicationContext applicationContext) {
 *          //处理每个Bean的Field (前提是Field上申明了指定的注解)
 *      }
 *
 *      public void visitMethod(Object bean, String beanName, Method method, HttpClient annotation, ApplicationContext applicationContext) {
 *          //处理每个Bean的Method (前提是方法上申明了指定的注解)
 *      }
 *
 *  }
 * 
 *
 * 启用:
 *
 *  *  @Configuration
 *  @EnableMemberProcessor(HttpClientMemberProcessor.class)
 *  public class MyConfiguration {
 *      // ...
 *  }
 * 
 *
 * @author S.Violet
 */
public interface MemberProcessor {

    /**
     * 声明本处理器接收的注解类型.
     * 注意: 不允许存在两个以上的处理器处理同一个注解!
     */
    Class acceptAnnotationType();

    /**
     * 处理每个Bean的Field (前提是Field上申明了指定的注解)
     * @param bean bean
     * @param beanName bean name
     * @param field field
     * @param annotation 注解
     * @param applicationContext context
     */
    void visitField(Object bean, String beanName, Field field, AnnotationType annotation, ApplicationContext applicationContext);

    /**
     * 处理每个Bean的Method (前提是方法上申明了指定的注解)
     * @param bean bean
     * @param beanName bean name
     * @param method method
     * @param annotation 注解
     * @param applicationContext context
     */
    void visitMethod(Object bean, String beanName, Method method, AnnotationType annotation, ApplicationContext applicationContext);

}