Skip to content

Commit

Permalink
📖 add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
weihubeats committed Mar 8, 2024
1 parent 4bb9c21 commit 6847ae2
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# spring-boot-nebula

# 模块说明
- [spring-boot-nebula-common](spring-boot-nebula-common) 基础工具组件
- [spring-boot-nebula-aggregate](spring-boot-nebula-aggregate) ddd聚合根组件
- [spring-boot-nebula-dependencies](spring-boot-nebula-dependencies) 统一依赖
- [spring-boot-nebula-samples](spring-boot-nebula-samples) 使用示例
- [spring-boot-nebula-web](spring-boot-nebula-web) web封装组件(包括统一异常返回,简化返回,自定义异常报警)

> 每个模块可单独引用使用,不耦合
## 解决问题
1. 统一公司所有`spring boot`项目的依赖管理

不使用`common`可能存在的问题:
- a项目使用了 redission 3.14 b项目 使用3.61,然后导致相同代码可能运行结果不一致
- 统一使用`web-spring-boot-start`模块或者`boot-common-parent`可解决不同项目依赖版本不一致问题。
`boot-common-parent`管理公司的所有依赖,以后应用项目无需手动指定各种依赖版本只需引用依赖即可,统一在`boot-common-parent`管理即可
4. 提供开箱即用的`web-spring-boot-start`模块
4. 提供开箱即用的`web-spring-boot-start`模块,解决web开发需要手动封装工具类的痛点


## demo
Expand Down Expand Up @@ -57,3 +66,14 @@
- [NebulaPageQuery.java](spring-boot-nebula-web%2Fsrc%2Fmain%2Fjava%2Fcom%2Fnebula%2Fweb%2Fboot%2Fapi%2FNebulaPageQuery.java)

使用

#### 提供时间戳自动转`LocalDateTime`注解
@GetTimestamp

```java
@GetMapping("/test")
@NebulaResponseBody
public String test(@GetTimestamp LocalDateTime time) {
return time.toString();
}
```

0 comments on commit 6847ae2

Please sign in to comment.