Java利用自定义注解调用指定的类的方法

朴灿烈づ我的快乐病毒、 2023-06-12 09:25 37阅读 0赞

最近公司的产品分多端开发，MP端和PC端，MP端经常要调用PC端接口，因为项目初始忙于交付，暂未使用dubbo和Cloud等服务治理框架，暂时考虑用client调用实现，但是考虑多个接口，调用不同Service需要繁琐的if判断，最终决定，使用自定义注解来简化开发。

实现的逻辑：

MP端（第三方端）调用PC端的统一入口的接口 GatewayController。 然后入口调用ServiceFactory工厂进行解析，标识，入参等，定义Service方法，接口+实现类，并定义自定义注解和枚举类，将自定义注解标注在Service的方法上面，ServiceFactory调用解析类，解析类扫描Service包，找到注解标识的方法，用传入的标识和注解类的标识比对，相同的证明是要调用的方法，执行即可。

待优化项：

1. 入参现在为String字符串(JSON格式需要转化)，很影响代码的阅读性和效率，可以使用反射，将对应的Dto与其映射，方便方法调用，阅读性也会大大加强。

2. 每次调用方法，进行全局包扫描很影响效率，并发情况下不是很友好，可以在项目启动初始化的时候，将所有的注解实现方法放入到Map中，标识作为key，当调用接口时，找对应的Service可以通过key在Map中寻找，不必要在每次扫描。

以上两点优化会在后续的博客中更新出来，包括自定义注解实现从Sping容器中拿取对应的类，方便Dto映射。

# 以下是本次逻辑实现的简约代码，大致实现，并未包括用户鉴权，仅供参考。 #

## 一、 定义枚举类(方便标识统一) ##

public enum GatewayEnum {
    
        MP01("MP01","小程序有参接口测试枚举"),
        MP02("MP02","小程序无参接口测试枚举"),
        ;
    
        String api;
        String msg;
    
        GatewayEnum(String api, String msg) {
            this.api = api;
            this.msg = msg;
        }
    
    
        public String getApi() {
            return this.api;
        }
    
        public String getMsg() {
            return this.msg;
        }
    }

## 二、定义自定义注解(扫描使用) ##

@Documented
    @Target({ElementType.TYPE,ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Service
    public @interface ApiMethodAnnotation {
    
        GatewayEnum apiCode();
    
    }

## 三、定义自定义的网关统一入口和工厂进行分发 ##

@RestController
    @RequestMapping("api")
    @Scope("prototype")
    public class GatewayController {
    
        private Logger logger = LoggerFactory.getLogger(getClass());
    
        @Autowired
        private ServiceFactory serviceFactory;
    
    
        /**
         * 所有调用接口的统一入口
         */
        @RequestMapping(value = "request", method = RequestMethod.GET)
        @ResponseBody
        public Object request() {
           // api  args  
           WebResponse res = serviceFactory.execute(api, args);
         
        }
    
    }

@Service
    public class ServiceFactory {
    
        @Autowired
        private GateWay gateWay;
    
        private static final Logger logger = LoggerFactory.getLogger(ServiceFactory.class);
    
        public WebResponse execute(String api, String args) {
            return gateWay.gateWay(api, args);
        }
    
    }

## 四、扫描注解，通过apiCode的唯一标识，判定实现注定的方法。 ##

public class GateWay {
     
        private static final Logger logger = LoggerFactory.getLogger(GateWay.class);
     
        public WebResponse gateWay(String api,String args) {
            WebResponse response = new WebResponse ();
            Reflections reflections = new Reflections("xxx.xxxx.service");//包名且不可忘记，不然扫描全部项目包，包括引用的jar
            //获取带Service注解的类
            Set<Class<?>> typesAnnotatedWith = reflections.getTypesAnnotatedWith(Service.class);
            for (Class clazz : typesAnnotatedWith
            ) {
                Method[] methods = clazz.getDeclaredMethods();
                for (Method method : methods
                ) {
                    //判断带自定义注解ApiMethodAnnontation的method
                    if (method.isAnnotationPresent(ApiMethodAnnontation.class)) {
               ApiMethodAnnontation annotation = method.getAnnotation(ApiMethodAnnontation.class);
                        //根据入参WayCode比较method注解上的WayCode,两者值相同才执行该method
                        if (null != annotation.apiCode().getApi &&  annotation.apiCode().getApi.equals(api)) {
                            logger.info("WayCode = " + annotation.apiCode().getApi);
                            try {
                                //执行method
                                response = (WebResponse) method.invoke(clazz.newInstance(), args);
                            } catch (Exception e) {
                                logger.info("--------------执行自定义注解方法异常--------------");
                                e.printStackTrace();
                            }
                        }
     
                    }
     
                }
            }
            return response;
        }
     
    }