codeTemplate/README.md

Poyee Microservice 脚手架模板说明

项目架构概述

这是一个基于 Maven 的多模块微服务架构脚手架模板，采用经典的分层设计模式，便于快速构建企业级微服务应用。

模块结构说明

核心业务模块

• micro-common: 通用工具模块，包含项目通用的工具类、常量、基础实体等
• micro-dao: 数据访问层模块，负责数据库交互操作
• micro-manager: 业务逻辑层模块，处理核心业务逻辑
• micro-service: 服务接口层模块，提供业务服务接口

Web入口模块

• web-controller: Web应用入口模块，包含Spring Boot启动类

模块依赖关系

graph TD
    web-controller --> micro-service
    micro-service --> micro-manager
    micro-manager --> micro-dao
    micro-manager --> micro-common
    micro-dao --> micro-common

各模块详细说明

micro-common 模块

• 提供项目通用的基础组件
• 被 micro-dao 和 micro-manager 模块依赖

micro-dao 模块

• 负责数据持久化操作
• 依赖 micro-common 模块获取基础实体类

micro-manager 模块

• 实现核心业务逻辑
• 依赖 micro-common 和 micro-dao 模块

micro-service 模块

• 提供服务接口实现
• 依赖 micro-manager 模块

web-controller 模块

• Spring Boot 应用启动入口
• 依赖 micro-service 模块，作为Web层接入点
• 包含启动类 PoyeeMicroApplication
• 配置文件为 application.yml，应用名称为 poyee-micro

使用方法

1. 克隆项目模板
2. 修改根 pom.xml 中的 groupId、artifactId 和 version
3. 根据业务需求在各模块中添加相应代码

4. 使用 Maven 构建项目：

   mvn clean install
   

5. 运行应用：

   mvn spring-boot:run -pl web-controller
   

扩展

• 新增公共组件
• 添加配置中心、服务注册发现等微服务组件
• 集成安全认证、监控等企业级功能

项目启动

应用启动类为 PoyeeMicroApplication，配置文件为 application.yml，应用名称为 poyee-micro。