Spring Boot @Autowired -CheckStyle / PMD / Spotbugs规则在非接口使用情况下警告

Question

最近被 Spring 咬住了Spring Boot 应用程序中的 CGLib 与 JDK 动态代理问题（在 Mac 上运行时似乎使用 CGLib，而在 Linux 上运行时则使用 JDK 动态代理）。

我正在寻找一个 linter 工具配置/插件（PMD、Checkstyle、Spotbugs 等），它可以识别使用 @Autowired 注释字段/参数的位置，并且自动装配的类是使用类实例而不是接口定义的。

例如：

public interface MyService {
}


public class MyServiceImpl implements MyService {
}


@RestController
public class MyController {
  @Autowired
  private MyServiceImpl serviceImpl;   // this should raise a warning in a linter as
                                       // class is being used for injection type

  @Autowired
  private MyService service;           // this should not raise a warning, as interface
                                       // is used for type
}

Answer 1

我认为这是不可能与PMD，CheckStyle，Spotbugs等进行检查。但是有一个解决方案可以检查此问题。
Archunit 提供编写自定义规则，可以为此编写自定义规则。假设您使用Junit5或Junit4进行测试，则可以做类似的事情 -

@ArchTest                                         
public static final ArchRule archRule = noFields()
    .that()                                        
    .areAnnotatedWith(Autowired.class)             
    .should()                                      
    .haveNameEndingWith("Impl");                  

可以将其纳入您的测试中，您必须阅读ARCH单元的文档并在工作环境中设置，它非常容易集成。您可以为设定器或方法创建类似的规则 -

@ArchTest                                                         
public static final ArchRule archRule1 = noMethods()               
     .that()                                                       
     .areAnnotatedWith(Autowired.class)                       
     .should()                                                     
     .haveRawParameterTypes(MyServiceImpl.class, MyDaoImpl.class);

将其集成到代码库中时，可以为自己创建自定义规则。将Archunit用于春季项目通常是一个好主意，它们还具有可以在项目中使用的预配置模板。希望这会有所帮助。

Answer 2

除了上面的 @vyomydv的答案外，我还偶然发现了春季的这个问题：

本质上是用 @validated 和 @configurationproperties 和实现接口将是在运行时成为JDK代理实例的候选者，并且您不能自动自动化类实例，您必须自动作为接口。

因此，修改Yyomydv的规则如下：

public static final ArchRule AUTOWIRE_PROXY_RULE = noFields()
    .that()
    .areAnnotatedWith(Autowired.class)
    .should()
    .haveRawType(new DescribedPredicate<>("that does not autowire an interface") {
        @Override
        public boolean apply(final JavaClass input) {
            return !input.isInterface();
        }
    })
    .andShould().haveRawType(new DescribedPredicate<>("class is not a JDK proxy candidate") {
        @Override
        public boolean apply(final JavaClass input) {
            return !input.getAllRawInterfaces().isEmpty()
                && input.getPackageName().startsWith("com.mypackage")
                && input.isAnnotatedWith(Validated.class)
                && input.isAnnotatedWith(ConfigurationProperties.class);
        }
    });