SpringBoot-Shiro-Vue代码规范：项目结构与命名约定详解

SpringBoot-Shiro-Vue作为一款优秀的权限管理框架，其代码规范与项目结构设计体现了极高的专业水准。本文将为你详细解析这套完整的代码规范体系，帮助你更好地理解和应用这一框架。✨

📁 项目整体架构设计

SpringBoot-Shiro-Vue项目采用前后端分离架构，主要包含两个核心模块：

后端结构：back/ 目录下的Spring Boot应用 前端结构：vue/ 目录下的Vue.js单页应用

后端项目结构规范

后端采用经典的三层架构设计，遵循标准的Maven项目结构：

back/src/main/java/com/heeexy/example/
├── config/          # 配置类目录
├── controller/      # 控制器层
├── dao/             # 数据访问层  
├── service/         # 业务逻辑层
├── dto/             # 数据传输对象
└── util/            # 工具类目录

前端项目结构规范

前端采用Vue.js + ElementUI的技术栈，结构清晰：

vue/src/
├── components/      # 公共组件
├── router/         # 路由配置
├── store/          # 状态管理
├── views/          # 页面组件
└── utils/          # 工具函数

🔧 包命名规范详解

基础包名约定

项目采用反向域名命名法，确保唯一性和规范性：

com.heeexy.example

子包分类标准

• config包：存放所有配置类文件

  • annotation/ - 自定义注解定义
  • exception/ - 异常处理相关
  • filter/ - 过滤器和切面配置
  • system/ - 系统级配置

• controller包：REST API控制器，按功能模块划分

📝 代码注释规范要求

Java注释标准

项目中所有Java类都遵循统一的注释模板：

/**
 * @author: heeexy
 * @description: SpringBoot启动类
 * @date: 2017/10/24 11:55
 */

注释要素包含：

• @author：开发者标识
• @description：类功能描述
• @date：创建时间

前端注释规范

Vue组件采用JSDoc风格的注释，清晰说明组件用途和参数。

🎯 权限注解使用规范

权限控制注解

项目采用自定义权限注解替代传统Shiro注解：

@RequiresPermissions("article:add")

命名规则：

• 模块名:操作名
• 如：user:list、article:delete

🚀 最佳实践建议

1. 分层架构遵循

严格遵循Controller-Service-DAO三层架构，确保代码职责清晰：

• Controller层：LoginController.java
• Service层：LoginService.java
• DAO层：LoginDao.java

2. 异常处理统一

所有异常处理统一在exception/包中管理。

3. 工具类集中管理

所有通用工具方法统一在util/包中实现，避免代码重复。

💡 总结要点

SpringBoot-Shiro-Vue的代码规范体系体现了现代Java开发的优秀实践：

✅ 结构清晰 - 分层明确，职责单一 ✅ 命名规范 - 统一标准，易于理解
✅ 注释完整 - 文档齐全，维护方便 ✅ 权限精细 - 按钮级别控制，安全可靠

通过遵循这套代码规范，不仅能够提高代码质量，还能显著提升团队协作效率。建议在实际开发中严格遵循这些约定，确保项目的长期可维护性。👍