关于Spring boot2.6后版本Bean循环依赖问题的初探

原创已于 2022-08-25 14:21:34 修改 · 1.4k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring #开发语言 #spring boot #mvc

于 2022-08-25 11:46:56 首次发布

springboot 专栏收录该内容

1 篇文章

订阅专栏

本文探讨了Spring Boot 2.6及以上版本中遇到的Bean循环依赖问题。在Spring MVC中，简单和复杂的循环依赖不会报错，但在Spring Boot中，特定的设置循环依赖会导致错误。文章分析了错误现象、原因，并提出了解决办法，指出Spring Boot 2.6开始默认不允许循环引用，需要自定义配置来允许循环引用的存在。

Spring mvc中循环依赖测试：

简单循环依赖搭建

public class B {
    @Autowired//B依赖于A
    private A a;
}

public class A {
    @Autowired//A依赖于B
    private B b;
}

@Configuration
public class Config {
    @Bean
    public A a(){return new A();}
    @Bean
    public B b(){return new B();}
}

复杂循环依赖搭建

public class B {
    @Autowired//配置类B中注入服务层的实现类A
    private A a;
    @Bean//在向容器添加C的实现类的过程中.....
    public C userDetailsService(){
        return new C() {
            @Override
            public void loadUserByUsername() {//从数据库查询数据，并进行封装
                a.getAdminByUsername();//调用A的方法：查询用户信息
                a.getPermissionList();//调用A的方法：查询用户权限
                System.out.println();//将用户信息与权限进行封装操作，返回用户详情
            }
        };
    }
}

public class A {
    @Autowired//A依赖C
    private C c;

    public void login(){//登录方法中调用c的方法
        c.loadUserByUsername();//获取对用户信息与权限的封装
    }

    public void getAdminByUsername() {//获取用信息
    }

    public void getPermissionList() {//获取用户权限
    }
}

ps:此依赖循环为setting依赖，在mvc中不会报错。

Spring Boot中循环依赖问题

代码初勘

SecurityConfig依赖UmsAdminService
SecurityConfig向容器中注入了2个Bean（PasswordEncoder与UserDetailsService）

@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled=true)//启用授权注解
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Autowired//依赖UmsAdminService
    private UmsAdminService adminService;

    /**
     * 身份认证接口
     */
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.userDetailsService(userDetailsService())
                .passwordEncoder(passwordEncoder());
    }

    @Bean//定义的用于对密码进行编码及比对的接口，目前使用的是BCryptPasswordEncoder；
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }

    /**
     * 自定义用户认证逻辑
     */
    @Bean
    public UserDetailsService userDetailsService() {
        //获取登录用户信息
        return username -> {
            // 1.根据username查询数据库，判断用户名是否存在
            UmsAdmin admin =adminService .getAdminByUsername(username);
            if (admin != null) {
                List<UmsPermission> permissionList = adminService.getPermissionList(admin.getId());
                // 2.将数据库当中查出来的username和pwd封装到user对象当中返回 第三个参数表示权限
                return new AdminUserDetails(admin,permissionList);
            }
            throw new UsernameNotFoundException("用户名或密码错误");
        };
    }
}

UmsAdminServiceImpl依赖（UserDetailsService，PasswordEncoder）

@Service
public class UmsAdminServiceImpl implements UmsAdminService {

    @Autowired
    private UserDetailsService userDetailsService;

    @Autowired
    private PasswordEncoder passwordEncoder;

    @Override
    public String login(String username, String password) {
        String token = null;
        try {
            //将密码进行校验
            UserDetails userDetails = userDetailsService.loadUserByUsername(username);
            if (!passwordEncoder.matches(password, userDetails.getPassword())) {
                throw new BadCredentialsException("密码不正确");
            }
            //校验成功就将权限设置到SecurityContextHolder中（必须需要3个参数的构造器。）
            UsernamePasswordAuthenticationToken authentication = new UsernamePasswordAuthenticationToken(userDetails, null, userDetails.getAuthorities());
            SecurityContextHolder.getContext().setAuthentication(authentication);
            //生成token
            token = jwtTokenUtil.generateToken(userDetails);
        } catch (AuthenticationException e) {
            LOGGER.warn("登录异常:{}", e.getMessage());
        }
        return token;
    }
}

现象解释

会报2个错误：

所以UserDetailsService，PasswordEncoder都在SecurityConfig这个类里面被添加掉容器中。
所以要想注入UserDetailsService，PasswordEncoder，必须容器中要有SecurityConfig。
所以形成了循环依赖

ps：这是setting循环依赖，照理说会通过springmvc的三级缓存自动解决，但是在springboot中确没有解决，为什么了？

原因分析

springBoot需要自定义配置循环依赖解决。

SpringBoot 从 2.6 开始默认不允许出现 Bean 循环引用。而且这个是在Bean 定义上也就是类上就不允许出现循环引用。

解决办法

允许循环引用存在

spring:
  main:
    allow-circular-references:true

public static void main(String[] args) {
  new SpringApplicationBuilder(DemoApplication.class)
.allowCircularReferences(true)
.run(args);
}