Skip to content

Latest commit

 

History

History
70 lines (40 loc) · 2.99 KB

README.md

File metadata and controls

70 lines (40 loc) · 2.99 KB
Raw

必须知道的细节

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

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

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

提供的特性

FileSystem 文件系统

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

  • filesystem-spring-boot-starter-*
  • 考虑文件名的规范，在某些驱动上合法的文件名，在其他驱动上未必合法。需要跨驱动的应用，特别需要注意兼容性。查看FileSystemSupport.assertFileNameValid。
  • 考虑文件并发读写的问题。由于某些驱动在读文件时并不会独占文件，所以需要充分考虑事务的级别。
Session 会话
  • session-spring-boot-starter-*
Logging 日志
  • logging-spring-boot-starter-*
  • 由于Logger初始化时间的原因，基于FileSystem的FileAppender在FileSystem未能初始化时，默认不输出日志。
Auth 身份及权限验证
  • 提供Auth注解来验证身份及权限，使用在Controller及Action上。
  • 要打开这个特性，需要提供AuthService类型的Bean。
KeyValueStore 键值对存储（默认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-*
JobEngine 任务引擎 (Exactly Once Message)
  • job-spring-boot-starter-*

如何使用

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

需要注意的局限

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

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

编码及设计风格

  1. 在文件系统上的目录，如果是框架使用默认值创建的，应该统一用大写路径名，保持适当的特征有助于应用维护时大致区分某个目录来自何处。
  2. 遇到bug，应该优先考虑设计一个或一组测试来捕获这个bug，以提高代码的质量及可维护性。