# nm-data-micro-services **Repository Path**: yuan_dad/nm-data-micro-services ## Basic Information - **Project Name**: nm-data-micro-services - **Description**: SpringCloud Alibaba - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: develop - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2022-05-05 - **Last Updated**: 2022-08-20 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README ## 服务结构 ``` ├── nm-data-micro-services // 父项目 │ ├── nm-framework-core // 公共包 │ │ ├── nm-framework-common // 公共工具类 │ │ ├── nm-framework-model // 实体包 │ │ ├── nm-framework-utils // 工具包 │ ├── nm-service-core // 公共starter包 │ │ ├── nm-starter-common // 公共配置Bean │ │ ├── nm-starter-feign // feign-starter │ │ ├── nm-starter-file // 文件处理starter │ │ ├── nm-starter-grpc // grpc服务调用starter │ │ ├── nm-starter-lock // 全局锁配置starter │ │ ├── nm-starter-log // 全局日志starter │ │ ├── nm-starter-mybatis // mybatis配置starter │ │ ├── nm-starter-nebula // 图数据库nebula配置starter │ │ ├── nm-starter-plugin // 插件包,热加载外部依赖 │ │ ├── nm-starter-pool // 池配置starter │ │ ├── nm-starter-redis // redis配置starter │ │ ├── nm-starter-seata // 分布式事务配置starter │ │ ├── nm-starter-security // 全局安全配置starter │ │ ├── nm-starter-sentinel // 服务治理配置starter │ │ ├── nm-starter-standard // 全局规范配置starter │ │ ├── nm-starter-validator // 参数校验配置starter │ │ ├── nm-starter-web // 全局web配置starter │ │ ├── nm-starter-webhook // webhook配置starter │ ├── nm-service-gateway // 网关服务 │ ├── nm-service-platform // 系统平台服务 │ │ ├── nm-service-archives // 档案服务 │ │ ├── nm-service-dict // 数据库字典服务 │ │ ├── nm-service-elastic // elastic search检索服务 │ │ ├── nm-service-oss // 阿里云对象存储服务 │ │ ├── nm-service-system // 系统服务（用户、角色、菜单） │ │ ├── nm-service-userconfig // 用户采集配置服务 │ │ ├── nm-service-graph // 图相关服务 │ │ ├── nm-service-warning // 预警服务 │ ├── nm-service-social // 社交服务包 │ │ ├── nm-service-ethereum // 以太坊服务 │ │ ├── nm-service-facebook // facebook服务 │ │ ├── nm-service-reddit // reddit服务 │ │ ├── nm-service-signal // signal服务 │ │ ├── nm-service-telegram // telegram服务 │ │ ├── nm-service-twitters // twitter服务 │ │ ├── nm-service-weibo // 微博服务 │ │ ├── nm-service-whatsapp // whatsapp服务 │ │ ├──nm-service-youtube // youtube服务 │ ├── nm-service-uaa // 认证授权服务 │ └── xxxx // xxx │ └── pom.xml ``` ## 项目目录结构 ``` ├── src // 应用 │ ├── main // 主程序 │ │ ├── ai.people.netmon // 代码目录 │ │ │ │ ├── controller // 控制层 │ │ │ │ ├── service // 服务层 │ │ │ │ │ └── serviceImpl //业务逻辑层（处理业务） │ │ │ │ ├── mapper // 数据层 │ │ │ │ ├── entity // 实体 │ │ │ │ └── vo // 视图 │ │ │ ├── common // 通用异常及工具类 │ │ │ │ ├── enums // 通用枚举 │ │ │ │ ├── exception // 通用异常 │ │ │ │ ├── response // 返回体 │ │ │ │ └── utils // 工具类 │ │ │ └── MainApplication.java // 启动类 │ │ └── resource // 配置目录 │ │ ├── mapper // SQL-xml │ │ ├── META_INF │ │ ├── smart-doc.json // 接口文档配置 │ │ └── bootstrap.yml │ └── test // 测试 │ └── pom.xml ``` ## 分支说明 ``` ├── master // 主分支 ├── develop // 开发分支 ├── archives-develop-v2 // 档案库测试环境v2版本 ├── archives-prod-v2 // 档案库正式环境v2版本 ``` ## 分支说明 ``` ├── master // 主分支 ├── develop // 开发分支 ``` ## 基本开发规范 1.开发规范阅读飞书文档 与我共享-紫东信息-文档-紫东信息开发规范 ## 开发环境工具 1.开发所需环境和工具在飞书文档下载 与我共享-紫东信息-开发环境、工具 ### 数据规范 #### 请求参数 1. 用户Session相关使用 `RequestHolderUtil.loginUser()` 方法，内容参见 `AuthenticationUser`(可适当扩展) ``` java AuthenticationUser authenticationUser = RequestHolderUtil.getUserId(); ``` #### 返回参数 1.成功响应使用 `ResultUtil.success()` 方法 ``` java 有返回数据: return ResultUtil.success(Object); 无返回数据: return ResultUtil.success(); ``` 2.失败响应使用 `ResultUtil.error()` 方法，需定义错误码枚举 ``` java return ResultUtil.error(ExceptionEnum); ``` 3.异常响应使用 `ResultUtil.error(CustomizeRuntimeException)` 方法，需自定义异常子类 ``` java return ResultUtil.error(CustomizeRuntimeException); ``` ### DAO层规范 使用 **Bean** 或 **String** / **int** 等输入，不可使用 **Map** 输入。 ### 插件 1.推荐Easy javadoc自动生成注释 1.1 生成类注释 光标放类名上 Ctrl + \ 生成类注释 1.2 生成方法注释 光标放方法名上 Ctrl + \ 生成方法注释 1.3 生成属性注释 光标放属性名上 Ctrl + \ 生成属性注释 1.4 同时生成类、方法、属性注释 光标放类名上 Ctrl Shift + \ 选择要生成的类、方法、属性注释