利用Spring扫描机制,实现服务的注册(一)

git仓库地址:服务注册

前言

本文章是阐述通过注解和扫描完成对服务包里面的功能实现注册,不需要为每一个service类,提供不同的映射方法,尤其是供前台获取数据的接口。

  • 使用场景
    对项目进行封装,规范接口的调用,比如post方法的参数都使用json对象,对返回数据也进行规范,必须返回ResultVo,数据放在vo的data字段中。
    一般可以称为:对SpringMVC进行封装;对服务进行注册
  • 最终效果
    访问对应的服务,只需要找到对应的Controller类url,后面的路径使用service中方法拼接上Auto即可,最终会有整个封装好的demo。
  • 涉及的主要类
  1. AutoDispatch注解
    作用:贴在Controller类上面,根据参数serviceInterface指定该Controller对哪些service类提供的服务进行注册。
  2. LoadPackageClasses工具类
    作用:类似Spring的自动扫描机制进行对指定包中的类进行扫描,并根据传入的注解进行过滤未被该注解标注的类。(扫描指定包里所有被某注解标注的类,并放入同一个集合)
    在本demo中就是扫描controller包中所有标注了AutoDispatch的注解的Controller类
  3. MetaDataManager
    作用:利用LoadPackageClasses进行获取注册服务的Controller类集合,然后通过反射获取每个controller的AutoDispatch注解,获取注解的serviceInterface参数(class集合即controller需要注册的服务是哪个service中的服务),再通过service的class对象进行反射将每个service的所有public方法进行缓存起来。
    4.WelcomeController
    作用:提供一个供子类继承的方法,所有的注册服务的Controller都是这个类的子类,对于该唯一的方法我们还进行了扩展,就是服务的前置环境检查和服务执行后的处理。一般情况下,执行前检查和执行后的处理是没有提供的,只是为了拓展性,进行了添加该功能,相信大家看了方法后会动的

使用方法和一些细节

待更新

代码

  • WelcomeController
@Component
@Slf4j
public class WelcomeController {

    @Autowired
    MetaDataManager metaDataManager;

    protected Object autoDispatch(HttpServletRequest request, HttpServletResponse response, String methodName, Map<String, ?> model) {
        if(request.getMethod().equalsIgnoreCase("GET")) {
        //model = request.getParameterMap();
        }
        AutoDispatch annotation = getClass().getAnnotation(AutoDispatch.class);
        Class<?>[] services = annotation.serviceInterface();
        String preKey = null, postKey = null;
        String key = null;
        Class<?> service = null;
        Map<String, Method> methodCache = metaDataManager.getMethodCache();
        for (Class<?> cls : services) {
            if (metaDataManager.getMethodCache().containsKey(key = cls.getName()
                    .concat(methodName))) {
                preKey = key.replace(methodName, "pre" + methodName);
                postKey = key.replace(methodName, "post" + methodName);
                service = cls;
                break;
            }
        }
        if(key != null) {
            Object o = ServiceLocator.getBeanByName(CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_CAMEL, service.getSimpleName()));
            Object ret = null;

            //1. preCondition process
            ResultVo preCheck = null;
            Method pre = metaDataManager.getMethodCache().get(preKey);
            if (pre != null) {
                try {
                    int pCount = pre.getParameterTypes().length;
                    if(pCount == 1)
                        preCheck = (ResultVo) pre.invoke(o, model);
                    else
                        preCheck = (ResultVo) pre.invoke(o);
                }catch (Exception e) {

                    log.debug("preCondition check error:" + e.getCause().getMessage());
                }

                if (!ResultVo.isSuccess(preCheck))
                    throw new RuntimeException((String)preCheck.getMessage());
            }

            //2. business process
            Method m = metaDataManager.getMethodCache().get(key);
            try {
                int pCount = m.getParameterTypes().length;
                if(pCount == 1)
                    ret = m.invoke(o, model);
                else
                    ret = m.invoke(o);
            } catch (Exception e) {

                e.printStackTrace();

            } finally {
                //3. postCondition process
                Method post = metaDataManager.getMethodCache().get(postKey);
                if(post != null) {
                    try {
                        post.invoke(o, ret);
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                }
            }

            return ret;
        }
        else
            throw new UnsupportedOperationException();
    }
}
  • AutoDispatch注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
// 自动启用处理激活器
public @interface AutoDispatch {

    /** 默认开启 */
    boolean enable() default true;

    /** 需要注入的服务 */
    Class<?>[] serviceInterface();
}

*LoadPackageClasses,借鉴了Spring

public class LoadPackageClasses {

    protected final Log logger = LogFactory.getLog(getClass());

    public static final String RESOURCE_PATTERN = "/**/*.class";

    private ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();

    private List<String> packagesList = new LinkedList<String>();

    private List<TypeFilter> typeFilters = new LinkedList<TypeFilter>();

    private Set<Class<?>> classSet = new HashSet<Class<?>>();

    /**
     * 构造函数
     *
     * @param packagesToScan
     *            指定哪些包需要被扫描,支持多个包"package.a,package.b"并对每个包都会递归搜索
     * @param annotationFilter
     *            指定扫描包中含有特定注解标记的bean,支持多个注解
     */
    @SuppressWarnings("unchecked")
    public LoadPackageClasses(String[] packagesToScan,
                              Class<? extends Annotation>... annotationFilter) {
        if (packagesToScan != null) {
            for (String packagePath : packagesToScan) {
                this.packagesList.add(packagePath);
            }
        }
        if (annotationFilter != null) {
            for (Class<? extends Annotation> annotation : annotationFilter) {
                typeFilters.add(new AnnotationTypeFilter(annotation, false));
            }
        }
    }

    /**
     * 将符合条件的Bean以Class集合的形式返回
     *
     * @return
     * @throws IOException
     * @throws ClassNotFoundException
     */
    public Set<Class<?>> getClassSet() throws IOException,
            ClassNotFoundException {
        this.classSet.clear();
        if (!this.packagesList.isEmpty()) {
            for (String pkg : this.packagesList) {
                String pattern = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX
                        + ClassUtils.convertClassNameToResourcePath(pkg)
                        + RESOURCE_PATTERN;
                Resource[] resources = this.resourcePatternResolver
                        .getResources(pattern);
                MetadataReaderFactory readerFactory = new CachingMetadataReaderFactory(
                        this.resourcePatternResolver);
                for (Resource resource : resources) {
                    if (resource.isReadable()) {
                        MetadataReader reader = readerFactory
                                .getMetadataReader(resource);
                        String className = reader.getClassMetadata()
                                .getClassName();
                        if (matchesEntityTypeFilter(reader, readerFactory)) {
                            this.classSet.add(Class.forName(className));
                        }
                    }
                }
            }
        }
        // 输出日志
        if (logger.isInfoEnabled()) {
            for (Class<?> clazz : this.classSet) {
                logger.info(String.format("Found class:%s", clazz.getName()));
            }
        }
        return this.classSet;
    }

    /**
     * 检查当前扫描到的Bean含有任何一个指定的注解标记
     *
     * @param reader
     * @param readerFactory
     * @return
     * @throws IOException
     */
    private boolean matchesEntityTypeFilter(MetadataReader reader,
                                            MetadataReaderFactory readerFactory) throws IOException {
        if (!this.typeFilters.isEmpty()) {
            for (TypeFilter filter : this.typeFilters) {
                if (filter.match(reader, readerFactory)) {
                    return true;
                }
            }
        }
        return false;
    }

}
  • MetaDataManager
public class MetaDataManager {
    @Getter
    public Map<String, Method>     methodCache = Maps.newHashMap();
    @Getter
    public Map<String, Class<?>[]> cache       = Maps.newHashMap();

    public MetaDataManager() {}

    public MetaDataManager(String[] pkgs) {
        try {
            scan(pkgs);
        }catch(Exception e) {
            ;
        }
    }

    @SuppressWarnings("unchecked")
    public MetaDataManager scan(String[] pkgs) throws Exception {
        //MetaDataManager manager = new  MetaDataManager();
        if (pkgs == null || pkgs.length == 0)
            return null;
        LoadPackageClasses loader = new LoadPackageClasses(pkgs, AutoDispatch.class);
        Set<Class<?>> sets = loader.getClassSet();
        Set<Class<?>> serviceInterfaces = Sets.newHashSet();
        for (Class<?> cls : sets) {
            AutoDispatch autoDispatch = cls.getAnnotation(AutoDispatch.class);
            for (Class<?> service : autoDispatch.serviceInterface()) {
                if (!serviceInterfaces.contains(service))
                    serviceInterfaces.add(service);
            }
            cache.put(cls.getName(), autoDispatch.serviceInterface());
        }

        for (Class<?> cls : serviceInterfaces) {
            for (Method m : cls.getMethods())
                methodCache.put(cls.getName().concat(m.getName()), m);
        }

        methodCache = Collections.unmodifiableMap(methodCache);
        cache = Collections.unmodifiableMap(cache);
        return this;
    }

}

流程及注意点看下面的博客:利用Spring扫描机制,实现服务的注册(二)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,033评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,725评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,473评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,846评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,848评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,691评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,053评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,700评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,856评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,430评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,034评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2 343

推荐阅读更多精彩内容