摸鱼事务所——Bate冲刺代码规范

[摸鱼事务所]

这个作业属于哪个课程	202501福大-软件工程实践-w班
这个作业要求在哪里	团队作业——Bate冲刺
这个作业的目标	完成bata冲刺
其他参考文献	阿里巴巴Java开发手册终极版v1.3.0、华为内部代码规范、Google代码规范

目录

• 1. 代码规范
• 1.1 前端代码规范
• 1.1.1 项目结构
• 1.1.2 组件规范
• 1.1.3 状态管理
• 1.1.4 路由配置
• 1.1.5 代码风格
• 1.1.6 其他最佳实践
• 1.1.7 版本控制
• 1.2 后端代码规范
• 1.2.1 命名规范
• 1.2.2 代码格式
• 1.2.3 编码规范

1. 代码规范

1.1 前端代码规范

1.1.1 项目结构

src/
├── components/          # 公共组件
│   ├── common/         # 通用组件
│   └── business/       # 业务组件
├── views/              # 页面组件
├── router/             # 路由配置
├── store/              # 状态管理
├── utils/              # 工具函数
├── assets/             # 静态资源
├── styles/             # 全局样式
├── api/                # API接口
└── constants/          # 常量定义

1.1.2 组件规范

• 组件采用PascalCase命名，如UserLogin.vue
• 组件必须包含明确的props验证和文档注释
• 遵循单一职责原则，每个组件只负责一个特定功能

1.1.3 状态管理

• 使用Vuex/Pinia进行状态管理
• 状态变更必须通过mutation/action
• 模块化状态管理，按功能拆分store

1.1.4 路由配置

// 路由懒加载，提高首屏加载速度
const routes = [
  {
    path: '/login',
    name: 'Login',
    component: () => import('@/views/Login.vue')
  }
]

1.1.5 代码风格

• 使用ESLint + Prettier统一代码格式
• 缩进使用2个空格
• 字符串使用单引号
• 每行代码不超过100字符

1.1.6 其他最佳实践

• 使用TypeScript增强类型安全
• 组件样式使用Scoped CSS
• 合理使用异步组件和代码分割

1.1.7 版本控制

• 提交信息遵循Conventional Commits规范
• 功能分支命名：feature/功能描述
• 修复分支命名：fix/问题描述

1.2 后端代码规范

1.2.1 命名规范

• 类名使用PascalCase：UserService
• 方法名使用camelCase：getUserInfo
• 常量使用UPPER_SNAKE_CASE：MAX_LOGIN_ATTEMPTS
• 包名使用全小写：com.dormitory.service

1.2.2 代码格式

// 遵循阿里巴巴Java开发手册
public class UserServiceImpl implements UserService {
    private static final Logger LOGGER = LoggerFactory.getLogger(UserServiceImpl.class);
    
    @Override
    public UserDTO getUserById(Long userId) {
        // 方法体不超过50行
        if (userId == null) {
            throw new IllegalArgumentException("用户ID不能为空");
        }
        return userMapper.selectById(userId);
    }
}

1.2.3 编码规范

• 所有Controller必须添加@RestController和@RequestMapping
• Service层接口与实现分离
• 数据库操作必须使用MyBatis Plus
• 统一异常处理，使用全局异常处理器