lifuquan 2 years ago
parent
commit
676b7512b0
2 changed files with 48 additions and 0 deletions
  1. 14 0
      gogs使用指南.md
  2. 34 0
      项目要求java代码规范.md

+ 14 - 0
gogs使用指南.md

@@ -0,0 +1,14 @@
+# gogs使用指南
+
+gogs对人员的管理大概是一个两级结构
+
+组织 》》 团队
+组织 》》 仓库
+
+建议每个不同的项目创建不同的组织
+
+团队用于赋权,组织内通过不同的团队管理读取/写入/管理权限。
+
+如果不做权限管理,请把组织的人员全部加入组织对应的owner团队。
+
+因为gogs是docker部署的,请采用http方式连接,ssh无法连接。

+ 34 - 0
项目要求java代码规范.md

@@ -13,3 +13,37 @@
 4. 原则上要求有源码的改写项目将依赖版本同步到 hb_springboot_parent 依赖版本,如果遇到特殊情况可以特殊考虑。
 
 5. 对已完成且正常运行未扫描到漏洞的项目可以不考虑。
+
+
+## 关于实体类的要求
+
+实体类可能面临3种情况
+
+1. 需要持久化(存入数据库或其他形式) -- 与数据库表对应
+2. 参与前端或接口交互 -- 不与数据库表对应,但可能参与dao逻辑
+3. 不持久化也不参与前端或接口交互,仅存在于代码逻辑
+
+建议:
+
+存在需求1 --> pojo
+不存在需求1,存在需求2 --> vo
+仅存在需求3 --> entity
+
+尽量采用lombok
+
+## 代码目录结构
+
+代码目录结构 com.nokia 后面加一层代表project简单说明的目录
+
+```xml
+<groupId>com.nokia.sms</groupId>
+<artifactId>sgip_sms_server</artifactId>
+<version>1.0</version>
+
+<parent>
+    <groupId>com.nokia</groupId>
+    <artifactId>hb_springboot_parent</artifactId>
+    <version>1.0</version>
+    <relativePath />
+</parent>
+```