# light-frame-boot **Repository Path**: cdlvyh/light-frame-boot ## Basic Information - **Project Name**: light-frame-boot - **Description**: 基于Spring Boot的应用开发框架 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-03-05 - **Last Updated**: 2022-01-04 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ## light-frame-boot ![license](https://img.shields.io/badge/license-Apache--2.0-green.svg) light-frame-boot 是基于 Spring Boot 的应用开发框架，通过 Spring Boot Starter 机制做了相应扩展增强，提供了诸如健康检测（readiness/liveness check）、短信发送、日志跟踪、solr搜索、多数据源路由等能力，简化了繁琐配置，同时方便用户快速接入各种常用组件。 ## 一、功能简介 light-frame-boot 对 Spring Boot 框架做了扩展增强，提供了以下的能力： ### 1.1 健康检测 为了让应用更好地适应容器化环境以及帮助用户随时掌握线上应用的健康状况，比如监控进程是否意外停止、应用发布需要灰度更新等场景，对 spring boot 的探针技术做了扩展，采用简单http方式获取应用当前状态（readiness和liveness)、支持动态刷新应用状态数据以及支持自定义健康检查组件，无需繁琐配置，便于用户更好地监控和操作 spring boot 应用。 ### 1.2 短信发送 基于 Spring Boot Starter 插件机制的短信服务支持，通过引用不同的短信渠道管理类启用不同的短信通道支持，支持同步/异步方式发送。 目前仅支持类型：阿里云短信、京东云短信，如需其他渠道，可以根据模板代码进行扩展。 ### 1.3 日志跟踪 在Web应用多线程复杂环境中，大量用户请求访问日志混在一起，想精准定位查询某个用户的全量请求日志变得比较困难。采用 slf4j MDC 可以解决这个棘手问题，为方便用户快速接入，支持日志跟踪注解切面、异步任务调度切面以及自定义线程池任务跟踪等方式进行日志全路径跟踪，通过聚类用户全量日志，方便用户快速定位各种线上问题。 ### 1.4 solr搜索 为简化用户采用solrj操作数据，采用注解+反射机制封装搜索orm工具，并支持索引新增、批量导入、更新、删除、结果分页、排序、高亮等常规操作，接入简单快捷，类似于普通接口调用，大大提升了搜索数据开发效率。 ### 1.5 多数据源路由 为支持某些场景需要应用系统跨数据库访问，采用ImportBeanDefinitionRegistrar动态注册数据源，并通过aop+注解实现动态数据源的自由切换，用户只需要在业务方法加上注解即可轻松实现主从库读写分离、多种数据源混合模式读写等多数据源路由落地。 ## 二、快速开始 请查看项目文档中[快速开始](https://gitee.com/cdlvyh/light-frame-boot/blob/master/quickstart.md)来了解如何快速上手使用 light-frame-boot 。 ## 三、如何贡献 light-frame-boot 欢迎广大开发者创建Pull Request来贡献代码，代码通过审核后会被合并到master主分支。 light-frame-boot 编译环境要求为JDK8或以上版本，需要采用 [Apache Maven 3.5.0](https://archive.apache.org/dist/maven/maven-3/3.5.0/binaries/) 或者更高的版本进行编译。 ## 四、感谢 TODO。 ## 五、示例 light-frame-boot 的示例工程，详见 light-frame-boot-sample 。 ## 六、开源许可 light-frame-boot 基于Apache License 2.0协议，light-frame-boot 依赖了一些第三方组件，其开源协议参见[依赖组件版权说明](https://gitee.com/cdlvyh/light-frame-boot/blob/master/NOTICE.md)。