在Java中获取注释元数据的方法

时间:2011-12-08 19:21:10

标签: java validation annotations metadata bean-validation

我正在研究GWT的JSR-303验证框架。有些人可能听说过它,即使它是一个小项目。 Here is gwt-validation.

在过去(v1.0)中,它为每个类使用了一个标记接口,每个类都有单独生成的元数据。这很糟糕,因为它不是JSR-303标准的一部分,我们转向了下一个想法。

在2.0版中,它使用Reflections在运行时扫描类路径。这很棒。缺点是它似乎无法在容器化环境或有特殊限制的环境中工作。

这可能是我的错,请看下面的代码:

    //this little snippet goes through the classpath urls and ommits jars that are on the forbidden list.
    //this is intended to remove jars from the classpath that we know are not ones that will contain patterns
    Set<URL> classPathUrls = ClasspathHelper.forJavaClassPath();
    Set<URL> useableUrls = new HashSet<URL>();
    for(URL url : classPathUrls) {
        boolean use = true;
        for(String jar : this.doNotScanJarsInThisList) {
            if(url.toString().contains(jar)) {
                use = false;
                break;
            }
        }
        if(use) {
            useableUrls.add(url);
        }
        use = false;
    }       

    ConfigurationBuilder builder = new ConfigurationBuilder()
                                    .setUrls(useableUrls)
                                    .setScanners(   new TypeAnnotationsScanner(), 
                                                    new FieldAnnotationsScanner(), 
                                                    new MethodAnnotationsScanner(), 
                                                    new SubTypesScanner()
                                    )
                                    .useParallelExecutor()
                                    ;

    this.reflections = new Reflections(builder);

我正在使用过滤器删除我知道的jar文件中没有我感兴趣的注释。正如我所提到的那样,这提供了巨大的速度提升(特别是在大型类路径上) )但我所基于的ClasspathHelper.forJavaClassPath()可能不是进入容器环境的最佳方式。 (例如Tomcat,JBoss)

是否有更好的方法或至少可以使用容器环境的方式,还是让我的用户过滤掉他们不想要的类?

我已经看了一些关于Hibernate Validation项目(JSR-303的参考实现)的方式,他们看起来至少在Java 6中使用(至少部分)Annotations Processing。这不能所有的故事,因为直到JDK6和Hibernate Validator与JDK5兼容才出现。 (见:hibernate documentation

所以,和往常一样,故事还有更多。

我已阅读这些帖子,供参考:

  • 关于Scannotation几乎被“反思”所取代。
  • 这是one,但是它使用文件,我不确定GAE(Google App Engine)或Tomcat等内容的影响。
  • 我已经谈过很多事情that goes over

这些线程只有很多帮助。

我也读过about the annotation processing framework,我必须遗漏一些东西。它似乎做了我想要的但是它似乎只在编译时工作,我知道这不是Hibernate Validator所做的。 (任何人都可以解释它是如何扫描的吗?它适用于GAE,这意味着它不能使用任何IO包。)

此外,这段代码会比我上面的代码更好吗?

Set<URL> classPathUrls = ClasspathHelper.forClassLoader(Thread.currentThread().getContextClassLoader());

可以正确地将类加载器放在Tomcat或JBoss容器中吗?它似乎扫描了一组较小的类,但仍然可以完成。

所以,无论如何,任何人都可以帮我指出正确的方向吗?或者我只是坚持我所拥有的东西?

1 个答案:

答案 0 :(得分:0)

你可以看一下Spring的注释支持。 Spring可以扫描文件中的注释(使用asm IIRC),可以在容器内外工作。

这可能并不容易,因为它经历了Spring的资源抽象,但重用(或提取)相关代码应该是可行的。