hz/cloud-platform/README.md

64 lines
2.4 KiB
Markdown
Raw Normal View History

# 分布式微服务架构--平台服务
## 项目介绍
## 平台架构
## 应用架构
## 工程结构
| 目录结构 | 描述说明 |
| ------------ | ------------ |
| shell | 脚本文件夹 |
|  ┣━ Dockerfile | Docker镜像打包的配置文件 |
|  ┣━ docker-build.sh | Docker镜像打包脚本 |
|  ┣━ docker-start.sh | Docker镜像启动脚本 |
|  ┗━ nk-ms.sh | 微服务在Linux操作系统下的管理脚本包含启动、停止、重启、更新、查看状态等操作。 |
| src/main/java | Java源代码目录 |
|  ┗━ net.northking.<产品>.<模块> | 工程源代码的主包名 |
|    ┣━ api | http api接口包 |
|    ┣━ config | 配置包 |
|    ┣━ constants | 常量包 |
|    ┣━ db | 数据库持久层包 |
|    ┣━ dto | 数据传输对象包 |
|    ┗━ XXXApplication | 微服务启动类 |
| src/main/resources | 配置文件目录 |
|  ┣━ db/mysql/ | 该目录下按`数据库`创建子文件夹存放数据库脚本 |
|  ┃  ┣━ data/ | 存放:`初始化数据`的SQL脚本 |
|  ┃  ┗━ schema/ | 存放:`创建表结构`的SQL脚本 |
|  ┣━ mybatis | Mybatis映射文件根目录 |
|  ┃  ┣━ base/ | 基础的Mybatis映射信息由代码生成器产生不要手动修改 |
|  ┃  ┣━ ext/ | 扩展的Mybatis映射信息手动维护。自定义的SQL及映射写在此文件下对应的xml文件内 |
|  ┃  ┗━ query/ | 扩展查询类的Mybatis映射信息手动维护。自定义的分页查询类SQL及映射写在此文件下 |
|  ┣━ application.yml | Spring Boot 主配置文件 |
|  ┗━ logback-rabbitmq.xml | 日志配置(写入消息队列) |
| src/test/java | 单元测试源代码目录 |
| src/test/resources | 单元测试配置文件目录 |
| pom.xml | 工程的Maven主配置文件编译和打包构建工程的完整jar包和安装部署包 |
| .gitignore | Git排除清单 |
| README.md | 项目工程说明 |
## 项目文档
## 项目环境
开发环境:
测试环境:
生产环境:
## 技术选型
## 环境搭建
Copyright (c) 2017 京北方信息技术股份有限公司 京ICP备13020631号