java版SpringCloud+SpringBoot+mybatis+uniapp微服务架构二次浅封装实践

分布式系统中存在很多拆分的服务&＃xff0c;在不断迭代升级的过程中&＃xff0c;会出现如下常见的棘手情况&＃xff1a;

某个技术组件版本升级&＃xff0c;依赖包升级导致部分语法或者API过期&＃xff0c;或者组件修复紧急的漏洞&＃xff0c;从而会导致分布式系统下各个服务被动的升级迭代&＃xff0c;很容易引发意外的问题&＃xff1b;不同的服务中对组件的依赖和版本各不相同&＃xff0c;从而导致不兼容问题的出现&＃xff0c;很难对版本做统一的管理和维护&＃xff0c;一旦出现问题很容易手忙脚乱&＃xff0c;引发蝴蝶效应&＃xff1b;

所以在复杂的系统中&＃xff0c;对于依赖的框架和组件进行统一管理和二次浅封装&＃xff0c;可以较大程度降低上述问题的处理成本与风险&＃xff0c;同时可以更好的管理和控制技术栈。

 需要框架源码的朋友可以看我个人简介联系我。推荐分布式架构源码

1、浅封装作用

为什么浅封装&＃xff0c;核心目的在于统一管理和协调组件的依赖与升级&＃xff0c;并对常用方法做一层包装&＃xff0c;实际上很多组件使用到的功能点并不多&＃xff0c;只是在业务中的使用点很多&＃xff0c;这样给组件本身的迭代升级带来了一定的难度&＃xff1a;

例如某个组件常用的API中存在巨大风险漏洞&＃xff0c;或者替换掉过期的用法&＃xff0c;需要对整个系统中涉及的地方做升级&＃xff0c;这种操作的成本是非常高的&＃xff1b;

如果是对这种常用的组件方法进行二次包装&＃xff0c;作为处理业务的工具方法&＃xff0c;那么解决上面的问题就相对轻松许多&＃xff0c;只要对封装的工具方法升级&＃xff0c;服务的依赖升级即可&＃xff0c;降低时间成本和风险。

通过浅封装的手段&＃xff0c;可以实现两个方面的解耦&＃xff1a;

业务与技术

技术栈中常用的方法进行二次浅封装&＃xff0c;这样可以较大程度的降低业务与技术的耦合&＃xff0c;如此可以独立的升级技术栈&＃xff0c;扩展功能而不影响业务服务的迭代。

框架与组件

不同的框架与组件都需要一定程度的自定义配置&＃xff0c;同时分模块管理&＃xff0c;在不同的服务中引入特定的依赖&＃xff0c;也可以在基础包中做统一依赖&＃xff0c;以此实现技术栈的快速组合搭配。

这里说的浅封装&＃xff0c;是指包装常规常用的语法&＃xff0c;组件本身就是技术层面的深度封装&＃xff0c;所以也不可能完全隔开技术栈原生用法。

2、统一版本控制

例如微服务架构下&＃xff0c;不同的研发组负责不同的业务模块&＃xff0c;然而受到开发人员的经验和能力影响&＃xff0c;很容易出现不同的服务组件选型不一致&＃xff0c;或者相同的组件依赖版本不同&＃xff0c;这样很难对系统架构做标准的统一管理。

对于二次封装的方式&＃xff0c;可以严格的控制技术栈的迭代扩展&＃xff0c;以及版本冲突的问题&＃xff0c;通过对二次封装层的统一升级&＃xff0c;可以快速实现业务服务的升级&＃xff0c;解决不同服务的依赖差异问题。

1、案例简介

Java分布式系统中&＃xff0c;微服务基础组件&＃xff08;Nacos、Feign、Gateway、Seata&＃xff09;等&＃xff0c;系统中间件&＃xff08;Quartz、Redis、Kafka、ElasticSearch&＃xff0c;Logstash&＃xff09;等&＃xff0c;对常用功能、配置、API等&＃xff0c;进行二次浅封装并统一集成管理&＃xff0c;以满足日常开发中基础环境搭建与临时工具的快速实现。

• butte-flyer 组件封装的应用案例&＃xff1b;
• butte-frame 常用技术组件二次封装&＃xff1b;

2、分层架构

整体划分五层&＃xff1a;网关层、应用层、业务层、中间件层、基础层&＃xff0c;组合成一套分布式系统。

服务总览

3、目录结构

在butte-frame中对各个技术栈进行二次封装管理&＃xff0c;在butte-flyer中进行依赖引用。

butte-frame
├── frame-base 基础代码块
├── frame-jdbc 数据库组件
├── frame-core 服务基础依赖
├── frame-gateway 路由网关
├── frame-nacos 注册与配置中心
├── frame-seata 分布式事务
├── frame-feign 服务间调用
├── frame-security 安全管理
├── frame-search 搜索引擎
├── frame-redis 缓存管理
├── frame-kafka 消息中间件
├── frame-quartz 定时任务
├── frame-swagger 接口文档
└── frame-sleuth 链路日志butte-flyer
├── flyer-gateway 网关服务&＃xff1a;路由控制
├── flyer-facade 门面服务&＃xff1a;功能协作接口
├── flyer-account 账户服务&＃xff1a;用户账户
├── flyer-quartz 任务服务&＃xff1a;定时任务
└── flyer-admin 管理服务&＃xff1a;后端管理


4、技术栈组件

系统常用的技术栈&＃xff1a;基础框架、微服务组件、缓存、安全管理、数据库、定时任务、工具依赖等。

1、Nacos

Nacos在整个组件体系中&＃xff0c;提供两个核心能力&＃xff0c;注册发现&＃xff1a;适配微服务注册与发现标准&＃xff0c;快速实现动态服务注册发现、元数据管理等&＃xff0c;提供微服务组件中最基础的能力&＃xff1b;配置中心&＃xff1a;统一管理各个服务配置&＃xff0c;集中在Nacos中存储管理&＃xff0c;隔离多环境的不同配置&＃xff0c;并且可以规避线上配置放开的风险&＃xff1b;

连接管理

spring:cloud:nacos:# 配置读取config:prefix: applicationserver-addr: 127.0.0.1:8848file-extension: ymlrefresh-enabled: true# 注册中心discovery:server-addr: 127.0.0.1:8848


配置管理

• bootstrap.yml &＃xff1a;服务中文件&＃xff0c;连接和读取Nacos中配置信息&＃xff1b;
• application.yml &＃xff1a;公共基础配置&＃xff0c;这里配置mybatis组件&＃xff1b;
• application-dev.yml &＃xff1a;中间件连接配置&＃xff0c;用作环境标识隔离&＃xff1b;
• application-def.yml &＃xff1a;各个服务的自定义配置&＃xff0c;参数加载&＃xff1b;

2、Gateway

Gateway网关核心能力&＃xff0c;提供统一的API路由管理&＃xff0c;作为微服务架构体系下请求唯一入口&＃xff0c;还可以在网关层处理所有的非业务功能&＃xff0c;例如&＃xff1a;安全控制&＃xff0c;流量监控限流&＃xff0c;等等。

路由控制&＃xff1a;各个服务的发现和路由&＃xff1b;

&＃64;Component
public class RouteFactory implements RouteDefinitionRepository {&＃64;Resourceprivate RouteService routeService ;/*** 加载全部路由* &＃64;since 2021-11-14 18:08*/&＃64;Overridepublic Flux getRouteDefinitions() {return Flux.fromIterable(routeService.getRouteDefinitions());}/*** 添加路由* &＃64;since 2021-11-14 18:08*/&＃64;Overridepublic Mono save(Mono routeMono) {return routeMono.flatMap(routeDefinition -> {routeService.saveRouter(routeDefinition);return Mono.empty();});}
}


全局过滤&＃xff1a;作为网关的基础能力&＃xff1b;

&＃64;Component
public class GatewayFilter implements GlobalFilter {private static final Logger logger &＃61; LoggerFactory.getLogger(GatewayFilter.class);&＃64;Overridepublic Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {ServerHttpRequest request &＃61; exchange.getRequest();String uri &＃61; request.getURI().getPath() ;String host &＃61; String.valueOf(request.getHeaders().getHost()) ;logger.info("request host : {} , uri : {}",host,uri);return chain.filter(exchange);}
}


3、Feign

Feign组件是声明式的WebService客户端&＃xff0c;使微服务之间的调用变得更简单&＃xff0c;Feign通过注解手段&＃xff0c;将请求进行模板化和接口化管理&＃xff0c;可以更加标准的管理各个服务间的通信交互。

响应解码&＃xff1a;定义Feign接口响应时解码逻辑&＃xff0c;校验和控制统一的接口风格&＃xff1b;

public class FeignDecode extends ResponseEntityDecoder {public FeignDecode(Decoder decoder) {super(decoder);}&＃64;Overridepublic Object decode(Response response, Type type) {if (!type.getTypeName().startsWith(Rep.class.getName())) {throw new RuntimeException("响应格式异常");}try {return super.decode(response, type);} catch (IOException e) {e.printStackTrace();throw new RuntimeException(e.getMessage());}}
}


4、Seata

Seata组件是开源的分布式事务解决方案&＃xff0c;致力于提供高性能和简单易用的分布式事务服务&＃xff0c;实现AT、TCC、SAGA、XA事务模式&＃xff0c;支持一站式的分布式解决方案。

事务配置&＃xff1a;基于nacos管理Seata组件的参数定义&＃xff1b;

服务注册&＃xff1a;在需要管理分布式事务的服务中连接和使用Seata服务&＃xff1b;

seata:enabled: trueapplication-id: ${spring.application.name}tx-service-group: butte-seata-groupconfig:type: nacosnacos:server-addr: ${spring.cloud.nacos.config.server-addr}group: DEFAULT_GROUPregistry:type: nacosnacos:server-addr: ${spring.cloud.nacos.config.server-addr}application: seata-servergroup: DEFAULT_GROUP

五、中间件集成

1、Kafka

Kafka是由Apache开源&＃xff0c;具有分布式、分区的、多副本的、多订阅者&＃xff0c;基于Zookeeper协调的分布式消息处理平台&＃xff0c;由Scala和Java语言编写。还常用于搜集用户在应用服务中产生的日志数据。

消息发送&＃xff1a;封装消息发送的基础能力&＃xff1b;

&＃64;Component
public class KafkaSendOperate {&＃64;Resourceprivate KafkaTemplate kafkaTemplate ;public void send (SendMsgVO entry) {kafkaTemplate.send(entry.getTopic(),entry.getKey(),entry.getMsgBody()) ;}
}


消息消费&＃xff1a;消费监听时有两种策略&＃xff1b;

• 消息生产方自己消费&＃xff0c;通过Feign接口去执行具体消费服务的逻辑&＃xff0c;这样有利于流程跟踪排查&＃xff1b;
• 消息消费方直接监听&＃xff0c;减少消息处理的流程节点&＃xff0c;当然也可以打造统一的MQ总线服务&＃xff08;文尾&＃xff09;&＃xff1b;

public class KafkaListen {private static final Logger logger &＃61; LoggerFactory.getLogger(KafkaListen.class);/*** Kafka消息监听* &＃64;since 2021-11-06 16:47*/&＃64;KafkaListener(topics &＃61; KafkaTopic.USER_TOPIC)public void listenUser (ConsumerRecord record, Acknowledgment acknowledgment) {try {String key &＃61; String.valueOf(record.key());String body &＃61; record.value();switch (key){ }} catch (Exception e){e.printStackTrace();} finally {acknowledgment.acknowledge();}}
}


2、Redis

Redis是一款开源组件&＃xff0c;基于内存的高性能的key-value数据结构存储系统&＃xff0c;它可以用作数据库、缓存和消息中间件&＃xff0c;支持多种类型的数据结构&＃xff0c;如字符串、集合等。在实际应用中&＃xff0c;通常用来做变动频率低的热点数据缓存和加锁机制。

KV数据缓存&＃xff1a;作为Redis最常用的功能&＃xff0c;即缓存一个指定有效期的键和值&＃xff0c;在使用时直接获取&＃xff1b;

&＃64;Component
public class RedisKvOperate {&＃64;Resourceprivate StringRedisTemplate stringRedisTemplate ;/*** 创建缓存&＃xff0c;必须带缓存时长* &＃64;param key 缓存Key* &＃64;param value 缓存Value* &＃64;param expire 单位秒* &＃64;return boolean* &＃64;since 2021-08-07 21:12*/public boolean set (String key, String value, long expire) {try {stringRedisTemplate.opsForValue().set(key,value,expire, TimeUnit.SECONDS);} catch (Exception e){e.printStackTrace();return Boolean.FALSE ;}return Boolean.TRUE ;}
}


Lock加锁机制&＃xff1a;基于spring-integration-redis中RedisLockRegistry&＃xff0c;实现分布式锁&＃xff1b;

&＃64;Component
public class RedisLockOperate {&＃64;Resourceprotected RedisLockRegistry redisLockRegistry;/*** 尝试一次加锁&＃xff0c;采用默认时间* &＃64;param lockKey 加锁Key* &＃64;return java.lang.Boolean* &＃64;since 2021-09-12 13:14*/&＃64;SneakyThrowspublic Boolean tryLock(T lockKey) {return redisLockRegistry.obtain(lockKey).tryLock(time, TimeUnit.MILLISECONDS);}/*** 释放锁* &＃64;param lockKey 解锁Key* &＃64;since 2021-09-12 13:32*/public void unlock(T lockKey) {redisLockRegistry.obtain(lockKey).unlock();}}


3、ElasticSearch

ElasticSearch是一个基于Lucene的搜索服务器&＃xff0c;它提供了一个分布式多用户能力的全文搜索引擎&＃xff0c;基于RESTful web接口&＃xff0c;Elasticsearch是用Java开发的&＃xff0c;是当前流行的企业级搜索引擎。

索引管理&＃xff1a;索引的创建和删除&＃xff0c;结构添加和查询&＃xff1b;

基于ElasticsearchRestTemplate的模板方法操作&＃xff1b;

&＃64;Component
public class TemplateOperate {&＃64;Resourceprivate ElasticsearchRestTemplate template ;/*** 创建索引和结构* &＃64;param clazz 基于注解类实体* &＃64;return java.lang.Boolean* &＃64;since 2021-08-15 19:25*/public Boolean createPut (Class clazz){boolean createIf &＃61; template.createIndex(clazz) ;if (createIf){return template.putMapping(clazz) ;}return Boolean.FALSE ;}
}


基于RestHighLevelClient原生API操作&＃xff1b;

&＃64;Component
public class IndexOperate {&＃64;Resourceprivate RestHighLevelClient client ;/*** 判断索引是否存在* &＃64;return boolean* &＃64;since 2021-08-07 18:57*/public boolean exists (IndexVO entry) {GetIndexRequest getReq &＃61; new GetIndexRequest (entry.getIndexName()) ;try {return client.indices().exists(getReq, entry.getOptions());} catch (Exception e) {e.printStackTrace();}return Boolean.FALSE ;}
}


数据管理&＃xff1a;数据新增、主键查询、修改、批量操作&＃xff0c;业务性质的搜索封装复杂度很高&＃xff1b;

数据的增删改方法&＃xff1b;

&＃64;Component
public class DataOperate {&＃64;Resourceprivate RestHighLevelClient client ;/*** 批量更新数据* &＃64;param entry 对象主体* &＃64;since 2021-08-07 18:16*/public void bulkUpdate (DataVO entry){if (CollUtil.isEmpty(entry.getDataList())){return ;}// 请求条件BulkRequest bulkUpdate &＃61; new BulkRequest(entry.getIndexName(),entry.getType()) ;bulkUpdate.setRefreshPolicy(entry.getRefresh()) ;entry.getDataList().forEach(dataMap -> {UpdateRequest updateReq &＃61; new UpdateRequest() ;updateReq.id(String.valueOf(dataMap.get("id"))) ;updateReq.doc(dataMap) ;bulkUpdate.add(updateReq) ;});try {// 执行请求client.bulk(bulkUpdate, entry.getOptions());} catch (IOException e) {e.printStackTrace();}}
}


索引主键查询&＃xff0c;分组查询方法&＃xff1b;

&＃64;Component
public class QueryOperate {&＃64;Resourceprivate RestHighLevelClient client ;/*** 指定字段分组查询* &＃64;since 2021-10-07 19:00*/public Map groupByField (QueryVO entry){Map groupMap &＃61; new HashMap<>() ;// 分组APIString groupName &＃61; entry.getGroupField()&＃43;"_group" ;SearchSourceBuilder sourceBuilder &＃61; new SearchSourceBuilder();sourceBuilder.size(0) ;TermsAggregationBuilder termAgg &＃61; AggregationBuilders.terms(groupName).field(entry.getGroupField()) ;sourceBuilder.aggregation(termAgg);// 查询APISearchRequest searchRequest &＃61; new SearchRequest(entry.getIndexName());searchRequest.source(sourceBuilder) ;try {// 执行APISearchResponse response &＃61; client.search(searchRequest, entry.getOptions());// 响应结果Terms groupTerm &＃61; response.getAggregations().get(groupName) ;if (CollUtil.isNotEmpty(groupTerm.getBuckets())){for (Terms.Bucket bucket:groupTerm.getBuckets()){groupMap.put(bucket.getKeyAsString(),bucket.getDocCount()) ;}}} catch (IOException e) {e.printStackTrace();}return groupMap ;}
}


4、Logstash

Logstash是一款开源的数据采集组件&＃xff0c;具有实时管道功能。Logstash能够动态的从多个来源采集数据&＃xff0c;进行标准化转换数据&＃xff0c;并将数据传输到所选择的存储容器。

• Sleuth&＃xff1a;管理服务链路&＃xff0c;提供核心TraceId和SpanId生成&＃xff1b;
• ElasticSearch&＃xff1a;基于ES引擎做日志聚合存储和查询&＃xff1b;
• Logstash&＃xff1a;提供日志采集服务&＃xff0c;和数据发送ES的能力&＃xff1b;

logback.xml&＃xff1a;服务连接Logstash地址&＃xff0c;并加载核心配置&＃xff1b;


${DES_URI:- }:${DES_PORT:- }UTC{"severity": "%level","service": "${APP_NAME:-}","trace": "%X{X-B3-TraceId:-}","span": "%X{X-B3-SpanId:-}","exportable": "%X{X-Span-Export:-}","pid": "${PID:-}","thread": "%thread","class": "%logger{40}","rest": "%message"}



5、Quartz

Quartz是一个完全由java编写的开源作业调度框架&＃xff0c;用来执行各个服务中的定时调度任务&＃xff0c;在微服务体系架构下&＃xff0c;通常开发一个独立的Quartz服务&＃xff0c;通过Feign接口去触发各个服务的任务执行。

配置参数&＃xff1a;定时任务基础信息&＃xff0c;数据库表&＃xff0c;线程池&＃xff1b;

spring:quartz:job-store-type: jdbcproperties:org:quartz:scheduler:instanceName: ButteSchedulerinstanceId: AUTOjobStore:class: org.quartz.impl.jdbcjobstore.JobStoreTXdriverDelegateClass: org.quartz.impl.jdbcjobstore.StdJDBCDelegatetablePrefix: qrtz_isClustered: trueclusterCheckinInterval: 15000useProperties: falsethreadPool:class: org.quartz.simpl.SimpleThreadPoolthreadPriority: 5threadCount: 10threadsInheritContextClassLoaderOfInitializingThread: true


6、Swagger

Swagger是常用的接口文档管理组件&＃xff0c;通过对API接口和对象的简单注释&＃xff0c;快速生成接口描述信息&＃xff0c;并且提供可视化界面可以快速对接口发送请求和调试&＃xff0c;该组件在前后端联调中&＃xff0c;极大的提高效率。

配置基本的包扫描能力即可&＃xff1b;

&＃64;Configuration
public class SwaggerConfig {&＃64;Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.butte")).paths(PathSelectors.any()).build();}
}


访问&＃xff1a;服务:端口/swagger-ui.html即可打开接口文档&＃xff1b;

1、MySQL

微服务架构下&＃xff0c;不同的服务对应不同的MySQL库&＃xff0c;基于业务模块做库的划分是当前常用的方式&＃xff0c;可以对各自业务下的服务做迭代升级&＃xff0c;同时可以避免单点故障导致雪崩效应。

2、HikariCP

HikariCP作为SpringBoot2版本推荐和默认采用的数据库连接池&＃xff0c;具有速度极快、轻量简单的特点。

spring:datasource:type: com.zaxxer.hikari.HikariDataSourcedriver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://127.0.0.1:3306/${data.name.mysql}?${spring.datasource.db-param}username: rootpassword: 123456db-param: useUnicode&＃61;true&characterEncoding&＃61;UTF8&zeroDateTimeBehavior&＃61;convertToNull&useSSL&＃61;falsehikari:minimumIdle: 5maximumPoolSize: 10idleTimeout: 300000maxLifetime: 500000connectionTimeout: 30000


连接池的配置根据业务的并发需求量&＃xff0c;做适当的调优即可。

3、Mybatis

Mybatis持久层的框架组件&＃xff0c;支持定制化SQL、存储过程以及高级映射&＃xff0c;MyBatis-Plus是一个MyBatis的增强工具&＃xff0c;在MyBatis的基础上只做增强不做改变&＃xff0c;可以简化开发、提高效率。

mybatis-plus:mapper-locations: classpath*:/mapper/**/*.xmlconfiguration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

七、源代码地址

应用仓库&＃xff1a;
https://gitee.com/cicadasmile/butte-flyer-parent组件封装&＃xff1a;
https://gitee.com/cicadasmile/butte-frame-parent