【记BUG】记一次使用lombook @RequiredArgsConstructor导致循环依赖的问题

什么是循环依赖问题

循环依赖问题是指两个或多个模块相互引用对方而形成的依赖关系，导致程序无法正确执行或运行时出现异常。在编程中，循环依赖通常是由于模块之间的引用顺序不当或设计上的问题导致的。

Spring中的的概念

在Spring中，循环依赖问题是指两个或多个Bean之间相互引用对方，导致Spring无法创建这些Bean或者创建后出现异常的情况。这种问题通常是由于Bean A需要Bean B的实例来进行初始化，而Bean B又需要依赖Bean A的实例来完成自己的初始化，这样就造成了循环依赖的问题。

Spring 的解决方式

为了解决Spring中的循环依赖问题，Spring采用了三级缓存和提前暴露单例对象等方法。具体来说，Spring会将正在创建的Bean放入第一级缓存中，已经创建出来但还未完成属性注入的Bean放入第二级缓存中，而完成全部依赖注入的Bean则放入第三级缓存中。同时，在第二级缓存中，Spring也会提前暴露某些单例对象，以解决循环依赖的问题。

Lombok @RequiredArgsConstructor注解可能导致的循环依赖问题

Lombok是一款流行的Java库，它提供了许多实用的注解，可以帮助我们简化Java代码的编写。其中之一是@RequiredArgsConstructor注解，它可以根据类中定义的final字段和非空字段自动生成构造函数。

然而，在使用@RequiredArgsConstructor注解时，有时会遇到循环依赖的问题。具体地说，如果我们的类之间存在循环依赖关系，那么就有可能导致Lombok生成的构造函数无法满足依赖注入的需求，从而抛出循环依赖异常。

例如，假设我们有两个类A和B。A类的构造函数中需要注入B类的实例，而B类的构造函数中又需要注入A类的实例。这时候，如果我们使用Lombok @RequiredArgsConstructor注解来自动生成构造函数，那么就会出现循环依赖问题。

import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class A {
    private final B b;
}

@RequiredArgsConstructor
public class B {
    private final A a;
}

解决Lombok @RequiredArgsConstructor导致的循环依赖问题

为了解决Lombok @RequiredArgsConstructor导致的循环依赖问题，我们可以采用以下几种方式之一：

1. 使用Setter方法注入
   使用Setter方法注入相对于构造函数注入更加灵活，因为它允许我们在应用程序运行时动态地注入依赖项。此外，Setter方法注入还可以避免循环依赖问题的出现。

例如，在上述的A和B类中，我们可以将它们的依赖项改为通过Setter方法注入。下面是具体的代码示例：

public class A {
    private B b;
    
	@Autowired
    public void setB(B b) {
        this.b = b;
    }
    
    // ...
}

public class B {
    private A a;
    
	@Autowired
    public void setA(A a) {
        this.a = a;
    }

    // ...
}

2. 使用@Lazy注解
   @Lazy注解可以延迟bean的初始化，直到它真正需要被使用时才会被创建。因此，在使用Lombok @RequiredArgsConstructor注解时，我们可以尝试在创建bean时添加@Lazy注解来解决循环依赖问题。

例如，在上述的A和B类中，我们可以将它们的@Bean注解标记为@Lazy。下面是具体的代码示例：

@Configuration
public class AppConfig {
    @Bean
    @Lazy
    public A a() {
        return new A();
    }

    @Bean
    @Lazy
    public B b() {
        return new B();
    }
}

3. 手动编写@Lazy构造函数
   最后，我们也可以考虑去除Lombok @RequiredArgsConstructor注解，并手动编写构造函数。这样虽然比较繁琐，但是可以确保不会出现循环依赖问题。

例如，在上述的A和B类中，我们可以手动编写构造函数来避免循环依赖问题。下面是具体的代码示例：

public class A {
    private final  B b;
	
	@Lazy
    public A(B b) {
        this.b = b;
    }
    
    // ...
}

public class B {
    private final  A a;
    
   	@Lazy
    public B(A a) {
        this.a = a;
    }

    // ...
}

另外，还有一种解决方案，就是在使用@RequiredArgsConstructor注解时，在构造函数上添加@Lazy注解来解决循环依赖问题。具体的方式可以参考之前的回答中的第五种解决方案。

无论采用哪种方式，都需要明确地指定bean之间的依赖关系，并避免出现循环依赖问题，以保证应用程序的可维护性和扩展性。

@RequiredArgsConstructor(onConstructor_ = {@Lazy})

无论采用哪种方式，都需要明确地指定bean之间的依赖关系，并避免出现循环依赖问题，以保证应用程序的可维护性和扩展性。以下是一些建议：

• 尽可能避免类之间的循环依赖关系，以减少应用程序出现“circular dependency”（循环依赖）的风险。
• 在使用Lombok
  @RequiredArgsConstructor注解时，可以采用Setter方法注入、@Lazy注解 或者手动编写构造函数等方式来解决循环依赖问题。需要注意的是，不同的解决方案适用于不同的场景，具体要根据应用程序的需求进行选择。
• 在使用@Autowired注解进行依赖注入时，建议尽量避免构造函数注入中存在循环依赖关系。如果必须要存在循环依赖关系，可以通过使用@ConstructorProperties注解或者默认参数名称来指定构造函数参数的注入顺序来避免异常的出现。
• 在编写代码的过程中，要注重代码的可读性和易维护性，尽可能使代码结构清晰，依赖关系简单明了。这样可以大大减少出现“circular
  dependency”（循环依赖）等问题的可能性，同时也有利于代码的扩展和维护。

总之，循环依赖问题是一个比较常见的Java开发中的问题，需要我们在编写代码时多加注意。通过采用合适的解决方案，可以避免这个问题的出现，从而提高应用程序的可靠性和可维护性。