资深专家的代码和接口规范指南

"资深专家总结的代码规范.pptx" 这篇资源主要涵盖了Java编程中的代码规范，特别是针对SpringBoot框架的应用。以下是对这些规范的详细解释： 1. **命名规范**： - 类名应使用大写字母开头的驼峰式命名，如`ProductAddBean`，表示这是一个用于新增产品的属性类。 - 方法名、变量名和参数名应以小写字母开头，遵循驼峰式命名，如`getProductName`。 - 接口名和包名全部使用小写字母，包名尽量简洁，如`com.example.product`。 - 常量名应全大写，单词间用下划线分隔，如`MAX_PRODUCTS`。 - 避免使用下划线、美元符号开头的命名，禁止使用拼音和英文混杂的命名，且不推荐使用中文名称。 2. **接口开发代码规范**： - 明确区分HTTP请求方法，GET用于获取数据，不涉及数据库修改；POST用于提交数据，涉及数据库更新。 - GET请求的参数通过查询字符串（query parameters）传递，POST请求的参数通过请求体（request body）传递，使用`@RequestParam`标注必填项。 - POST请求的参数应使用验证模型类（model class）进行约束，并使用`@RequestBody`注解，配合`validation`进行参数校验。 - 接口文档工具，如Swagger，用于清晰地描述接口和参数，便于开发者理解和使用。 3. **类设计规范**： - Service类和Dao类的接口对外提供服务，实现类加后缀`Impl`，如`UserService`和`UserServiceImpl`。 - 属性类（Bean类）和模型类（Model类）的属性应使用包装数据类型，不设定默认值，以确保数据的准确性。 - 构造方法中不应包含业务逻辑，初始化逻辑应放在独立的`init`方法中。 4. **错误处理和日志规范**： - Controller类仅负责参数校验和接口响应，业务逻辑处理在Service层，异常通过`throws`语句抛出。 - AOP（面向切面编程）用于接口请求前后的监听，记录请求和响应信息，包括接口名、URL、请求方式、参数等。 - 在Service层，AOP用于捕获异常，记录异常信息，帮助调试和问题追踪。 - 日志输出使用`Logger`类，避免使用`println`，结合`logback.xml`配置实现日志存储和与Logstash的集成，以便于日志管理和分析。 5. **接口返回结构**： - 统一的接口返回格式有助于API的标准化，示例：`{"status":200,"result":{},"message":""}`，其中`status`是状态码，200表示成功；`result`是返回的数据对象；`message`是返回的消息描述。 遵循以上规范，可以提高代码可读性、可维护性和团队协作效率，减少bug的发生，并有助于构建健壮的、易于测试的Java应用。