文档章节

分享几个 SpringBoot 实用的小技巧

crossoverJie
 crossoverJie
发布于 10/15 08:24
字数 1542
阅读 6503
收藏 124

前言

最近分享的一些源码、框架设计的东西。我发现大家热情不是特别高,想想大多数应该还是正儿八经写代码的居多;这次就分享一点接地气的: SpringBoot 使用中的一些小技巧。

算不上多高大上的东西,但都还挺有用。

屏蔽外部依赖

第一个是屏蔽外部依赖,什么意思呢?

比如大家日常开发时候有没有这样的烦恼:

项目是基于 SpringCloud 或者是 dubbo 这样的分布式服务,你需要依赖许多基础服务。

比如说某个订单号的生成、获取用户信息等。

由于服务拆分,这些功能都是在其他应用中以接口的形式提供,单测还好我还可以利用 Mock 把它屏蔽掉。

但如果自己想把应用启动起来同时把自己相关的代码跑一遍呢?

通常有几种做法:

  • 本地把所有的服务都启动起来。
  • 把注册中心换为开发环境,依赖开发环境的服务。
  • 直接把代码推送到开发环境自测。

看起来三种都可以,以前我也是这么干的。但还是有几个小问题:

  • 本地启动有可能服务很多,全部起来电脑能不能撑住还两说,万一服务有问题就进行不下去了。
  • 依赖开发环境的前提是网络打通,还有一个问题就是开发环境代码很不稳定很大可能会影响你的测试。
  • 推送到开发环境应该是比较靠谱的方案,但如果想调试只有日志大法,没有本地 debug 的效率高效。

那如何解决问题呢?既可以在本地调试也不用启动其他服务。

其实也可以利用单测的做法,把其他外部依赖 Mock 掉就行了。

大致的流程分为以下几步:

  • SpringBoot 启动之后在 Spring 中找出你需要屏蔽的那个 APIbean(通常情况下这个接口都是交给 Spring 管理的)。
  • 手动从 bean 容器中删除该 bean
  • 重新创建一个该 API 的对象,只不过是通过 Mock 出来的。
  • 再手动注册进 bean 容器中。

以下面这段代码为例:

    @Override
    public BaseResponse<OrderNoResVO> getUserByHystrix(@RequestBody UserReqVO userReqVO) {

        OrderNoReqVO vo = new OrderNoReqVO();
        vo.setAppId(123L);
        vo.setReqNo(userReqVO.getReqNo());
        BaseResponse<OrderNoResVO> orderNo = orderServiceClient.getOrderNo(vo);
        return orderNo;
    }

这是一个 SpringCloud 应用。

它依赖于 orderServiceClient 获取一个订单号。

其中的 orderServiceClient 就是一个外部 API,也是被 Spring 所管理。

替换原有的 Bean

下一步就是替换原有的 Bean。

@Component
public class OrderMockServiceConfig implements CommandLineRunner {

    private final static Logger logger = LoggerFactory.getLogger(OrderMockServiceConfig.class);

    @Autowired
    private ApplicationContext applicationContext;

    @Value("${excute.env}")
    private String env;

    @Override
    public void run(String... strings) throws Exception {

        // 非本地环境不做处理
        if ("dev".equals(env) || "test".equals(env) || "pro".equals(env)) {
            return;
        }

        DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) applicationContext.getAutowireCapableBeanFactory();

        OrderServiceClient orderServiceClient = defaultListableBeanFactory.getBean(OrderServiceClient.class);
        logger.info("======orderServiceClient {}=====", orderServiceClient.getClass());

        defaultListableBeanFactory.removeBeanDefinition(OrderServiceClient.class.getCanonicalName());

        OrderServiceClient mockOrderApi = PowerMockito.mock(OrderServiceClient.class,
                invocationOnMock -> BaseResponse.createSuccess(DateUtil.getLongTime() + "", "mock orderNo success"));

        defaultListableBeanFactory.registerSingleton(OrderServiceClient.class.getCanonicalName(), mockOrderApi);

        logger.info("======mockOrderApi {}=====", mockOrderApi.getClass());
    }
}

其中实现了 CommandLineRunner 接口,可以在 Spring 容器初始化完成之后调用 run() 方法。

代码非常简单,简单来说首先判断下是什么环境,毕竟除开本地环境其余的都是需要真正调用远程服务的。

之后就是获取 bean 然后手动删除掉。

关键的一步:

OrderServiceClient mockOrderApi = PowerMockito.mock(OrderServiceClient.class,
                invocationOnMock -> BaseResponse.createSuccess(DateUtil.getLongTime() + "", "mock orderNo success"));

defaultListableBeanFactory.registerSingleton(OrderServiceClient.class.getCanonicalName(), mockOrderApi);

创建了一个新的 OrderServiceClient 对象并手动注册进了 Spring 容器中。

第一段代码使用的是 PowerMockito.mock 的 API,他可以创建一个代理对象,让所有调用 OrderServiceClient 的方法都会做默认的返回。

BaseResponse.createSuccess(DateUtil.getLongTime() + "", "mock orderNo success"))

测试一下,当我们没有替换时调用刚才那个接口并且本地也没有启动 OrderService

因为没有配置 fallback 所以会报错,表示找不到这个服务。

替换掉 bean 时:

再次请求没有报错,并且获得了我们默认的返回。

通过日志也会发现 OrderServiceClient 最后已经被 Mock 代理了,并不会去调用真正的方法。

配置加密

下一个则是配置加密,这应该算是一个基本功能。

比如我们配置文件中的一些账号和密码,都应该是密文保存的。

因此这次使用了一个开源组件来实现加密与解密,并且对 SpringBoot 非常友好只需要几段代码即可完成。

  • 首先根据加密密码将需要加密的配置加密为密文。
  • 替换原本明文保存的配置。
  • 再使用时进行解密。

使用该包也只需要引入一个依赖即可:

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>1.14</version>
</dependency>

同时写一个单测根据密码生成密文,密码也可保存在配置文件中:

jasypt.encryptor.password=123456

接着在单测中生成密文。

    @Autowired
    private StringEncryptor encryptor;

    @Test
    public void getPass() {
        String name = encryptor.encrypt("userName");
        String password = encryptor.encrypt("password");
        System.out.println(name + "----------------");
        System.out.println(password + "----------------");

    }

之后只需要使用密文就行。

由于我这里是对数据库用户名和密码加密,所以还得有一个解密的过程。

利用 Spring Bean 的一个增强接口即可实现:

@Component
public class DataSourceProcess implements BeanPostProcessor {


    @Autowired
    private StringEncryptor encryptor;

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {

        if (bean instanceof DataSourceProperties){
            DataSourceProperties dataSourceProperties = (DataSourceProperties) bean;
            dataSourceProperties.setUsername(encryptor.decrypt(dataSourceProperties.getUsername())) ;
            dataSourceProperties.setPassword(encryptor.decrypt(dataSourceProperties.getPassword()));
            return dataSourceProperties ;
        }

        return bean;
    }
}

这样就可以在真正使用时还原为明文。

同时也可以在启动命令中配置刚才的密码:

java -Djasypt.encryptor.password=password -jar target/jasypt-spring-boot-demo-0.0.1-SNAPSHOT.jar

总结

这样两个小技巧就讲完了,大家有 SpringBoot 的更多使用技巧欢迎留言讨论。

上文的一些实例代码可以在这里找到:

https://github.com/crossoverJie/springboot-cloud

欢迎关注公众号一起交流:

© 著作权归作者所有

共有 人打赏支持
crossoverJie
粉丝 534
博文 71
码字总数 132407
作品 0
江北
后端工程师
私信 提问
加载中

评论(7)

w
w11
1. 其实替换Bean有更简单的方法, 就是用BeanPostProcessor. 然后再结合spring.factories自动初始化就能把相关代码无入侵放在另外一个jar包, 通过maven的pom的profiles只在特定的active profile才引入这个jar. 这样可以做到生产环境完全无Mock相关的代码. 也无需改任何的代码.
2. 如果不用#Dubbo#, 使用#Spring Cloud#有方法四可以选择: #Spring Cloud Contract#再结合#WireMock#可以实现更加强大的服务测试和隔离. 功能更强大和方便, 也更适合各大团队协作, 推荐此法.
JacCoffee
JacCoffee

引用来自“catalogMan”的评论

更加清晰的做法是自己搞一个 dubbo 封装,包装一下 consumer bean 构建工具,在统一的 Configuration 里面显式生成自己要用的 bean,并且都指定为 ConditionOnMissingBean,在 Configuration 上加个 Profile 注解,只在 prod 下生效。

这样在本地启动 dev profile 的时候,只需要加一个 MockConfiguration 把 MockBean 都标记为 Primary 就行了,完全隔离了2个配置文件。我们摸索后发现这么搞项目结构可以做到分离清晰

引用来自“JacCoffee”的评论

兄弟,有简单的代码示例吗?看你上面的描述有点蒙。。。

引用来自“catalogMan”的评论

其实提供一个包装类 DubboSubscriber, 在 ApplicationAware 里面手动注入 Bean。这样我们只用提供2个配置类:

// 生产环境配置
@Profile("prod")
@Configuration
class ApiConfiguration {
@Autowire
private DubboSubscriber subscriber;

@Bean
@ConditionOnMissingBean
public SomeService someService() {
// 订阅生产服务
return subscriber.consume(SomeService.class).subscribe();
}
}

// 本地测试配置
@Profile(" dev")
@Configuration
class MockApiConfiguration {
@Autowire
private DubboSubscriber subscriber;

@Bean
@Primary
public SomeService someService() {
// 提供一个 Mock service
return new MockSomeService();
}
}

这样直接利用 spring 的配置类,做到了环境隔离,需要的只是包装一下 Dubbo 的 bean 注入类, spring-dubbo 直接将一个 Dubbo consumer 包装成了一个 Bean, 而我们则不引用 spring-dubbo,而是提供了一个简单的 Bean 封装工具,这个工具本质上和 spring-dubbo 大同小异,就我们项目来说,这样有2个好处:

1. 显式申明订阅类,按需消费
2. 全局管理 Bean 生命周期,在生成、注入 bean 的时候,可以往 Bean 里面塞一些业务监控工具
:smile: 看懂了,非常感谢,这个实现真的很不错
catalogMan
catalogMan

引用来自“catalogMan”的评论

更加清晰的做法是自己搞一个 dubbo 封装,包装一下 consumer bean 构建工具,在统一的 Configuration 里面显式生成自己要用的 bean,并且都指定为 ConditionOnMissingBean,在 Configuration 上加个 Profile 注解,只在 prod 下生效。

这样在本地启动 dev profile 的时候,只需要加一个 MockConfiguration 把 MockBean 都标记为 Primary 就行了,完全隔离了2个配置文件。我们摸索后发现这么搞项目结构可以做到分离清晰

引用来自“JacCoffee”的评论

兄弟,有简单的代码示例吗?看你上面的描述有点蒙。。。
其实提供一个包装类 DubboSubscriber, 在 ApplicationAware 里面手动注入 Bean。这样我们只用提供2个配置类:

// 生产环境配置
@Profile("prod")
@Configuration
class ApiConfiguration {
@Autowire
private DubboSubscriber subscriber;

@Bean
@ConditionOnMissingBean
public SomeService someService() {
// 订阅生产服务
return subscriber.consume(SomeService.class).subscribe();
}
}

// 本地测试配置
@Profile(" dev")
@Configuration
class MockApiConfiguration {
@Autowire
private DubboSubscriber subscriber;

@Bean
@Primary
public SomeService someService() {
// 提供一个 Mock service
return new MockSomeService();
}
}

这样直接利用 spring 的配置类,做到了环境隔离,需要的只是包装一下 Dubbo 的 bean 注入类, spring-dubbo 直接将一个 Dubbo consumer 包装成了一个 Bean, 而我们则不引用 spring-dubbo,而是提供了一个简单的 Bean 封装工具,这个工具本质上和 spring-dubbo 大同小异,就我们项目来说,这样有2个好处:

1. 显式申明订阅类,按需消费
2. 全局管理 Bean 生命周期,在生成、注入 bean 的时候,可以往 Bean 里面塞一些业务监控工具
JacCoffee
JacCoffee

引用来自“catalogMan”的评论

更加清晰的做法是自己搞一个 dubbo 封装,包装一下 consumer bean 构建工具,在统一的 Configuration 里面显式生成自己要用的 bean,并且都指定为 ConditionOnMissingBean,在 Configuration 上加个 Profile 注解,只在 prod 下生效。

这样在本地启动 dev profile 的时候,只需要加一个 MockConfiguration 把 MockBean 都标记为 Primary 就行了,完全隔离了2个配置文件。我们摸索后发现这么搞项目结构可以做到分离清晰
兄弟,有简单的代码示例吗?看你上面的描述有点蒙。。。
catalogMan
catalogMan
更加清晰的做法是自己搞一个 dubbo 封装,包装一下 consumer bean 构建工具,在统一的 Configuration 里面显式生成自己要用的 bean,并且都指定为 ConditionOnMissingBean,在 Configuration 上加个 Profile 注解,只在 prod 下生效。

这样在本地启动 dev profile 的时候,只需要加一个 MockConfiguration 把 MockBean 都标记为 Primary 就行了,完全隔离了2个配置文件。我们摸索后发现这么搞项目结构可以做到分离清晰
crossoverJie
crossoverJie

引用来自“lifes77”的评论

赞,去你的个人网站,发现一个小bug,下拉页面,然后点击箭头回不到顶部了
由于是在境外的,可能由于网络原因 JS 等静态资源没有加载完毕吧。
lifes77
lifes77
赞,去你的个人网站,发现一个小bug,下拉页面,然后点击箭头回不到顶部了
学习 Spring Boot 知识看这一篇就够了

从2016年因为工作原因开始研究 Spring Boot ,先后写了很多关于 Spring Boot 的文章,发表在技术社区、我的博客和我的公号内。粗略的统计了一下总共的文章加起来大概有六十多篇了,其中一部分...

ityouknow
05/28
0
0
补习系列-springboot项目基础搭建课

目录 前言 一、基础结构 二、添加代码 三、应用配置 四、日志配置 五、打包部署 小结 前言 springboot 最近火的不行,目前几乎已经是 spring 家族最耀眼的项目了。抛开微服务、技术社区这些推...

美码师
07/07
0
0
SpringBoot 学习二:操作数据库

本文将从以下几个方面介绍: 前言 配置数据源 SpringBoot 整合 Mybatis SpringBoot 整合 JdbcTemplate SpringBoot 整合 Redis 前言 在上篇文章 SpringBoot 学习一 中已经学习了 SpringBoot的...

tsmyk0715
09/26
0
0
Spring Boot 全家桶 - SpringBootBucket

Spring Boot 现在已经成为Java 开发领域的一颗璀璨明珠,它本身是包容万象的,可以跟各种技术集成。 本项目对目前Web开发中常用的各个技术,通过和SpringBoot的集成,并且对各种技术通过“一...

一刀
03/05
0
1
恒宇少年/spring-boot-chapter

简书整套文档以及源码解析 专题 专题名称 专题描述 001 Spring Boot 核心技术 讲解SpringBoot一些企业级层面的核心组件 002 Spring Cloud 核心技术 对Spring Cloud核心技术全面讲解 003 Quer...

恒宇少年
04/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

CentOS 安装PHP5和PHP7

安装PHP5 下载解压二进制包 [root@test-a src]# cd /usr/local/src/[root@test-a src]# wget http://cn2.php.net/distributions/php-5.6.32.tar.bz2[root@test-a src]# tar jxvf php-5.6......

野雪球
今天
4
0
windows上类似dnsmasq的软件Dual DHCP DNS Server

官网地址:http://dhcp-dns-server.sourceforge.net/官网定向的下载地址:https://sourceforge.net/projects/dhcp-dns-server/files/ 设置参考地址:http://blog.51cto.com/zhukeqiang/18264......

xueyuse0012
今天
3
0
LinkedHashMap源码解析

前言 HashMap中的元素时无序的,也就是说遍历HashMap的时候,顺序和放入的顺序是不一样的。 如果需要有序的Map,就可以采用LinkedHashMap. LinkedHashMap通过维护一个包含所有元素的双向链表,...

grace_233
今天
3
0
初识flask

文档 0.10.1版本 http://www.pythondoc.com/flask/index.html 1.0.2版本 https://dormousehole.readthedocs.io/en/latest/ 安装flask $ pip3 install flaskCollecting flask Downloading......

yimingkeji
昨天
5
0
Akka系统《sixteen》译

Actor是一个封装状态(state)和行为(behavior)的对象,它们只通过交换消息通信(放入收件人邮箱的邮件)。从某种意义上说,Actor是最严格的面向对象编程形式,但它更适合将他们视为人:在与Act...

woshixin
昨天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部