https://github.com/insidezhou/southern-quiet

这是一个基于Spring Boot，为了提供一些基础设施抽象，减少重复劳动而存在的库。
https://github.com/insidezhou/southern-quiet

debounce event job notification spring-boot throttle

Last synced: 3 months ago
JSON representation

这是一个基于Spring Boot，为了提供一些基础设施抽象，减少重复劳动而存在的库。

• Host: GitHub
• URL: https://github.com/insidezhou/southern-quiet
• Owner: InsideZhou
• License: bsd-3-clause
• Created: 2019-02-21T02:42:21.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-11T07:22:28.000Z (over 1 year ago)
• Last Synced: 2024-10-01T06:22:39.747Z (4 months ago)
• Topics: debounce, event, job, notification, spring-boot, throttle
• Language: Java
• Homepage:
• Size: 1.24 MB
• Stars: 8
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### 必须知道的细节

1. 版本控制中忽略了application-default.properties文件，意味着本地调试时，可以往该文件中写入配置，覆盖一些值来适应本地开发环境。

1. 每个模块都有与之对应的*AutoConfiguration类，模块依赖的外部配置使用*AutoConfiguration.*Properties来管理。

1. 每个*AutoConfiguration类都有与之对应的spring.factories，以便在AutoConfigure时自动载入。

### 提供的特性

##### FileSystem 文件系统  

> 屏蔽底层细节，提供文件读写的支持，并且由于驱动的不同，可以做到不同机器上的应用共享同一个文件系统。

- filesystem-spring-boot-starter-*

- 考虑文件名的规范，在某些驱动上合法的文件名，在其他驱动上未必合法。需要跨驱动的应用，特别需要注意兼容性。查看FileSystemSupport.assertFileNameValid。

- 考虑文件并发读写的问题。由于某些驱动在读文件时并不会独占文件，所以需要充分考虑事务的级别。

##### Logging 日志

- logging-spring-boot-starter-*

- 由于Logger初始化时间的原因，基于FileSystem的FileAppender在FileSystem未能初始化时，默认不输出日志。

    

##### Auth 身份及权限验证

- 提供Auth注解来验证身份及权限，使用在spring容器管理的bean及其方法上。

- 通过实现AuthProvider接口来自定义验证逻辑。

- 权限匹配使用org.springframework.util.PathMatcher（默认AntPathMatcher）进行。

##### KeyValueStore 键值对存储（默认southern-quiet.framework.key-value.enable=false）

- 默认驱动基于FileSystem，会有KEY规范的问题需要考虑。

    

##### IdGenerator 发号器/Id生成器

- id-generator-spring-boot-starter-*

    

##### EventBroadcasting 事件广播 (At Most Once Message)

> 把基于Spring Event的自定义事件广播到当前ApplicationContext之外

> 为了支持跨语言事件，每个事件都有其唯一类型标识。

- event-spring-boot-starter-*

- me.insidezhou.southernquiet.event.ShouldBroadcast

- me.insidezhou.southernquiet.event.CustomApplicationEvent

    

##### NotificationPublishing 通知发布 (At Least Once Message)

- notification-spring-boot-starter-*

    

##### JobArranger 任务编排 (Exactly Once Message)

- job-spring-boot-starter-*

##### Debouncer 抖动去除器

> 对容器内某个bean的方法按指定时间去除抖动，抖动去除完成后肯定会得到执行。

- me.insidezhou.southernquiet.debounce.*

##### Throttle 节流器  

> 对容器内某个bean的方法按指定时间或次数节流，节流期间方法不会得到执行。

- throttle-spring-boot-starter-*

- me.insidezhou.southernquiet.throttle.Throttle

- me.insidezhou.southernquiet.throttle.ThrottleManager

### 如何使用

1. 在应用入口类上使用SpringBootApplication或者EnableAutoConfiguration注解。

### 需要注意的局限

1. 因为Logging的特殊性，Logger的初始化在ApplicationContext之前，所以Logger的相关配置需要注意遵守Spring Boot的

[约定](https://docs.spring.io/spring-boot/docs/2.0.6.RELEASE/reference/htmlsingle/#boot-features-custom-log-configuration)。

1. 启用spring-boot-devtools的时候，可能会因为同一个类被不同ClassLoader载入导致类型判断失败。

### 编码及设计风格

1. 在文件系统上的目录，如果是框架使用默认值创建的，应该统一用大写路径名，保持适当的特征有助于应用维护时大致区分某个目录来自何处。

1. 遇到bug，应该优先考虑设计一个或一组测试来捕获这个bug，以提高代码的质量及可维护性。