JavaSpringBoot编码规范

### Java Spring Boot 编码规范最佳实践

#### 代码结构与命名规则
项目应遵循清晰的分层设计原则，通常分为控制器（Controller）、服务（Service）、仓库（Repository）等层次。每一层负责不同的职责，保持高内聚低耦合。

- **包名**：采用全小写的反向域名表示法来定义基础包路径，例如 `com.example.projectname`[^3]。

- **类名**：首字母大写驼峰式命名，确保名称能够反映其功能或用途。对于接口推荐使用“I”前缀区分实现类，不过这不是强制性的标准做法[^2]。

- **方法名/变量名**：同样采取驼峰形式书写；常量全部大写字母并用下划线分割单词。

public class UserService {
    private static final String USER_ROLE_ADMIN = "ADMIN";
}

#### 控制器编写指导
RESTful风格API的设计应当直观易懂，URL应该简洁明了地表达资源位置关系。

- 使用@RestController注解声明Rest Controller组件，并通过@RequestMapping指定基本映射路径。

- GET请求用于获取数据，POST提交新实体，PUT更新现有条目，DELETE移除记录。这些HTTP动词的选择要严格对应CRUD操作语义。

@RestController
@RequestMapping("/api/users")
public class UserController {

    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id){
        //...
    }
    
    @PostMapping("")
    public ResponseEntity<Void> createUser(@RequestBody User user){
        //...
    }

}

#### Service 层建议
业务逻辑集中在Service Bean内部处理，这里不涉及任何视图渲染或者持久化细节。

- 方法签名尽可能返回具体类型而非泛型集合，便于后续调用者理解意图。

- 抛出自定义异常代替通用RuntimeException有助于错误定位和恢复策略制定。

@Service
public class UserServiceImpl implements UserService{
   
   @Override
   public List<UserDTO> getAllUsers(){
       try{
           // business logic here
       }catch(Exception e){
          throw new CustomException("Error occurred while fetching users",e);
       }
       
   }
}

#### Repository 接口定义
访问数据库的操作封装在此处完成，借助Spring Data JPA简化查询构建过程。

- 继承JpaRepository<T,ID>获得常用增删改查能力的同时还可以自定义复杂条件检索函数。

@Repository
public interface UserRepository extends JpaRepository<User,Long>{
     Optional<User> findByEmail(String email); 
}

#### 测试案例准备
单元测试覆盖核心算法验证，集成测试模拟真实环境交互流程检验整体协作效果。

- 利用@SpringBootTest启动完整的上下文容器支持端到端场景演练。

- MockMvc工具帮助隔离外部依赖项以便快速迭代开发周期内的回归检查工作。

@SpringBootTest
class ApplicationTests {

@Test
void contextLoads() {
}

@Autowired
private MockMvc mockMvc;

@Test
void shouldReturnDefaultMessage() throws Exception {
	mockMvc.perform(get("/"))
	.andExpect(status().isOk())
	.andExpect(content().string(containsString("Hello")));
}
}