SpringBoot--@Configuration(proxyBeanMethods = false) 的作用

浅浅的花香味﹌ 2023-09-29 14:32 16阅读 0赞

原文网址：[SpringBoot--@Configuration(proxyBeanMethods = false) 的作用\_IT利刃出鞘的博客-CSDN博客][SpringBoot--_Configuration_proxyBeanMethods _ false_ _IT_-CSDN]

## 简介 ##

**说明**

本文介绍SpringBoot中@Configuration注解proxyBeanMethods的含义。

**SpringBoot源码的写法**

看过SpringBoot源码后发现，Spring的自动配置类都是这样写的：@Configuration(proxyBeanMethods = false)。

> **技术资料与交流** ==>分享**靠谱**资料：Java**真实**面试题汇总、简历模板、PDF书籍、PPT模板等；分享Java**实用技术**；帮助**优化简历**；。详见：[资料与交流][Link 1]

## proxyBeanMethods的取值 ##

proxyBeanMethods属性的默认值是true。

### true ###

**说明**

如果为true，则是Full模式。被@Bean标识的方法会做如下处理：

1.  都会被CGLIB进行代理
2.  会走bean的生命周期中的一些行为（比如：@PostConstruct、@Destroy等 Spring中提供的生命周期）
3.  无论调用几次，得到的都是同一个bean

**优点**

可以支持通过常规Java调用相同类的@Bean方法而保证是容器内的Bean，这有效规避了在“Lite模式”下操作时难以跟踪的细微错误。

**缺点**

1.  启动时会给该配置类生成一个CGLIB子类放进容器（代理），会增加启动时间。
    
    1.  Spring Boot有很多配置类，这个开销是不容忽视的。这也是Spring 5.2新增了proxyBeanMethods属性的原因
2.  因为被代理了，所以@Bean方法 不可以是private、不可以是final

### false ###

**说明**

如果为true，则是Lite模式。被@Bean标识的方法会做如下处理：

1.  不会被拦截进行CGLIB代理
2.  不会走bean的生命周期中的一些行为（比如：@PostConstruct、@Destroy等 Spring中提供的生命周期）
3.  如果同一个Configuration中调用@Bean标识的方法，就只是普通方法的执行而已，不会从容器中获取对象。
    
    1.  @Bean标识的返回值对象还是会放入到容器中的，从容器中获取bean还是可以是单例的，会走生命周期。

**优点**

1.  启动时不需要给配置类生成CGLIB子类，减少了启动时间
2.  可以将配置类当作一个普通类使用：也就是说@Bean方法 可以是private、可以是final

**缺点**

1.  不能声明@Bean之间的依赖（也就是说不能通过方法调用来依赖其它Bean）
    
    1.  解决方案：把依赖Bean放进方法入参里

## 如何选用true/false ##

如果配置类中的@Bean标识的方法之间不存在依赖调用的话，可以设置为false，可以避免拦截方法进行代理操作，提升性能。

## 实例 ##

### Bean ###

package com.knife.tmp;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public class MyUtil {
        private String name;
    
        public void welcome(String customer) {
            System.out.println("Welcome, " + customer);
        }
    }

### 配置类 ###

package com.knife.tmp;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    @Configuration(proxyBeanMethods = false)
    public class CommonConfig {
        @Bean
        public MyUtil myUtil1(){
            System.out.println("myUtil1方法");
            myUtil2();
            return new MyUtil("Tony");
        }
    
        @Bean
        public MyUtil myUtil2(){
            System.out.println("myUtil2方法");
            return new MyUtil("Peter");
        }
     
    }

### 其他类 ###

package com.knife.util;
    
    import org.springframework.beans.BeansException;
    import org.springframework.context.ApplicationContext;
    import org.springframework.context.ApplicationContextAware;
    import org.springframework.stereotype.Component;
    
    @Component
    public class ApplicationContextHolder implements ApplicationContextAware {
        private static ApplicationContext context;
    
        public void setApplicationContext(ApplicationContext context) throws BeansException {
            ApplicationContextHolder.context = context;
        }
    
        public static ApplicationContext getContext() {
            return context;
        }
    }

### 测试类 ###

package com.knife.controller;
    
    import com.knife.util.ApplicationContextHolder;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class HelloController {
        @GetMapping("/test")
        public String test() {
            Object myUtil2 = ApplicationContextHolder.getContext().getBean("myUtil2");
            return "test success";
        }
    }

### 测试 ###

#### **测试1：proxyBeanMethods = false** ####

启动结果：myUtil2方法执行了两次。

![e8806a01bcdd40958b6ddfa636e4cac0.png][]

打个断点：

![1b2eebede321456884a81e20d5daeb06.png][]

访问：[http://localhost:8080/test][http_localhost_8080_test]

结果：

![ac41583d43f042f69cc0b9582351db66.png][]

释放断点，再次访问：发现**多次获取的myUtil2这个bean都是同一个**

![fc03f0d832b04b4ba387d45fa8349026.png][]

#### **测试2：proxyBeanMethods = true** ####

修改配置类为：

package com.knife.tmp;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    @Configuration(proxyBeanMethods = true)
    public class CommonConfig {
        @Bean
        public MyUtil myUtil1(){
            System.out.println("myUtil1方法");
            myUtil2();
            return new MyUtil("Tony");
        }
    
        @Bean
        public MyUtil myUtil2(){
            System.out.println("myUtil2方法");
            return new MyUtil("Peter");
        }
     
    }

启动结果：myUtil2方法执行了1次。

![c9af7da6d3ee4e8e8117a33dc551f04c.png][]

打个断点：

![1b2eebede321456884a81e20d5daeb06.png][]

访问：[http://localhost:8080/test][http_localhost_8080_test]

结果：

![5d54e8bfcec4449eb25c590f274eb8cf.png][]

释放断点，再次访问：发现**多次获取的myUtil2这个bean都是同一个**

![ad8b28e1241e4ed29af1f9990f9543c0.png][]

#### **测试3：不指定proxyBeanMethods** ####

启动结果：myUtil2方法执行了1次。

![481303bb856c47ef895584a2f1e4e8c3.png][]

打个断点：

![1b2eebede321456884a81e20d5daeb06.png][]

访问：[http://localhost:8080/test][http_localhost_8080_test]

结果：

![b5873c9412704d0aa3d1edb5e9307ccd.png][]

释放断点，再次访问：发现**多次获取的myUtil2这个bean都是同一个**

![52e8fa65a5934e1480619859851a8a9d.png][]

[SpringBoot--_Configuration_proxyBeanMethods _ false_ _IT_-CSDN]: https://knife.blog.csdn.net/article/details/124778853
[Link 1]: https://app.yinxiang.com/fx/d2ac6ff4-94c5-4e5f-9d4f-f5dfc344ede6
[e8806a01bcdd40958b6ddfa636e4cac0.png]: https://img-blog.csdnimg.cn/e8806a01bcdd40958b6ddfa636e4cac0.png
[1b2eebede321456884a81e20d5daeb06.png]: https://img-blog.csdnimg.cn/1b2eebede321456884a81e20d5daeb06.png
[http_localhost_8080_test]: http://localhost:8080/test
[ac41583d43f042f69cc0b9582351db66.png]: https://img-blog.csdnimg.cn/ac41583d43f042f69cc0b9582351db66.png
[fc03f0d832b04b4ba387d45fa8349026.png]: https://img-blog.csdnimg.cn/fc03f0d832b04b4ba387d45fa8349026.png
[c9af7da6d3ee4e8e8117a33dc551f04c.png]: https://img-blog.csdnimg.cn/c9af7da6d3ee4e8e8117a33dc551f04c.png
[5d54e8bfcec4449eb25c590f274eb8cf.png]: https://img-blog.csdnimg.cn/5d54e8bfcec4449eb25c590f274eb8cf.png
[ad8b28e1241e4ed29af1f9990f9543c0.png]: https://img-blog.csdnimg.cn/ad8b28e1241e4ed29af1f9990f9543c0.png
[481303bb856c47ef895584a2f1e4e8c3.png]: https://img-blog.csdnimg.cn/481303bb856c47ef895584a2f1e4e8c3.png
[b5873c9412704d0aa3d1edb5e9307ccd.png]: https://img-blog.csdnimg.cn/b5873c9412704d0aa3d1edb5e9307ccd.png
[52e8fa65a5934e1480619859851a8a9d.png]: https://img-blog.csdnimg.cn/52e8fa65a5934e1480619859851a8a9d.png