SpringBoot项目中,controller 、 entity、mapper和service包的介绍

在Spring Boot项目中,mapperservicecontrollerentity 是标准的代码分层目录,每个目录有明确的职责划分。以下是它们的详细说明和文件存储规范:


1. controller 目录

  • 作用 :存放 控制器类(接收HTTP请求并返回响应)。

  • 文件类型

    • 普通Java类(.java文件)
  • 关键注解

    • @RestController(REST API)
    • @Controller(传统MVC)
    • @RequestMapping@GetMapping
  • 示例

    复制代码
    复制代码
    // src/main/java/com/example/controller/UserController.java
    @RestController
    @RequestMapping("/api/users")
    public class UserController {
        @Autowired
        private UserService userService;
    
        @GetMapping
        public List<User> listUsers() {
            return userService.getAllUsers();
        }
    }

2. service 目录

  • 作用 :存放 业务逻辑层代码(处理复杂业务规则)。

  • 文件类型

    • 接口(UserService.java
    • 实现类(UserServiceImpl.java,放在impl子目录下)
  • 关键注解

    • @Service(标记实现类)
  • 示例

    复制代码
    复制代码
    // src/main/java/com/example/service/UserService.java
    public interface UserService {
        List<User> getAllUsers();
    }
    
    // src/main/java/com/example/service/impl/UserServiceImpl.java
    @Service
    public class UserServiceImpl implements UserService {
        @Autowired
        private UserMapper userMapper;
    
        @Override
        public List<User> getAllUsers() {
            return userMapper.selectAll();
        }
    }

3. mapper 目录

  • 作用 :存放 数据访问层接口(直接操作数据库的代码)。

  • 文件类型

    • 接口(.java文件)
    • 配套的XML映射文件(MyBatis)或使用JPA接口
  • 关键注解

    • @Mapper(MyBatis)
    • @Repository(可选,Spring会自动识别)
  • 示例

    复制代码
    复制代码
    // src/main/java/com/example/mapper/UserMapper.java
    @Mapper
    public interface UserMapper {
        List<User> selectAll();
        User selectById(Long id);
    }
    
    <!-- src/main/resources/mapper/UserMapper.xml -->
    <mapper namespace="com.example.mapper.UserMapper">
        <select id="selectAll" resultType="com.example.entity.User">
            SELECT * FROM t_user
        </select>
    </mapper>


4. entity 目录

  • 作用 :存放 数据实体类(与数据库表直接映射的Java对象)。

  • 文件类型

    • 普通Java类(.java文件)
    • 使用注解标记与数据库的映射关系(如JPA或MyBatis注解)
  • 关键注解

    • @Entity(JPA)
    • @Table(name = "表名")
    • @Id(主键)
  • 示例

    复制代码
    // src/main/java/com/example/entity/User.java
    @Entity
    @Table(name = "t_user")
    public class User {
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        private String username;
        // getter/setter省略
    }

分层架构流程图

复制代码
flowchart LR
    Client --> Controller --> Service --> Mapper --> Database
    Database --> Entity

各层职责总结

目录 职责 是否必须 典型依赖
entity 定义数据结构
mapper 数据库CRUD操作 entity
service 业务逻辑处理 推荐 mapper + 其他Service
controller 处理HTTP请求/响应 service

最佳实践建议

  1. 严格分层调用

    • Controller → Service → Mapper
    • 禁止跨层调用(如Controller直接调用Mapper)
  2. 命名规范

    • 实体类:User.java
    • Mapper接口:UserMapper.java
    • Service接口:UserService.java
    • Service实现类:UserServiceImpl.java
    • Controller:UserController.java
  3. 使用接口分离

    • Service和Mapper层建议使用接口+实现类的形式,便于扩展和Mock测试。

通过这种分层设计,代码可维护性和可测试性会显著提升。

相关推荐
Algorithm157620 分钟前
谈谈接口和抽象类有什么区别?
java·开发语言
细心的莽夫1 小时前
SpringCloud 微服务复习笔记
java·spring boot·笔记·后端·spring·spring cloud·微服务
264玫瑰资源库2 小时前
问道数码兽 怀旧剧情回合手游源码搭建教程(反查重优化版)
java·开发语言·前端·游戏
pwzs2 小时前
Java 中 String 转 Integer 的方法与底层原理详解
java·后端·基础
东阳马生架构2 小时前
Nacos简介—2.Nacos的原理简介
java
普if加的帕3 小时前
java Springboot使用扣子Coze实现实时音频对话智能客服
java·开发语言·人工智能·spring boot·实时音视频·智能客服
爱喝一杯白开水3 小时前
SpringMVC从入门到上手-全面讲解SpringMVC的使用.
java·spring·springmvc
王景程3 小时前
如何测试短信接口
java·服务器·前端
zhang23839061544 小时前
IDEA add gitlab account 提示
java·gitlab·intellij-idea·idea
牛马baby4 小时前
Java高频面试之并发编程-07
java·开发语言·面试