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

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


​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测试。

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

相关推荐
星落梦生6 小时前
SpringAOP基础笔记(7)
java·开发语言
金銀銅鐵7 小时前
带您看懂字节码指令(四):一条指令里有什么
java·jvm
最强小杰7 小时前
某 OpenAI 兼容网关上的 `kimi-k3.1-pro`:Cline、Zed 接入与 SSE 排错示例
java·服务器·网络·ai
Flynn Liang8 小时前
流量治理不是限流那么简单:I/O 密集型 Java 服务的 6 层防线
java·微服务·高并发·限流·熔断·系统稳定性·resilience4j
学长毕设8 小时前
基于SpringBoot智慧养老服务平台设计与实现-附源码
java·spring boot·后端
曹牧8 小时前
Java:“刷新雪崩”
java·开发语言
秋天的怀念_David8 小时前
算法一千零一夜 · 第三十三夜 · 跳表
java·程序人生·算法
Forget the Dream10 小时前
Spring AI 2.0 系列(二):第一个 ChatClient——从注入到一次完整调用
java·人工智能·spring boot·ai·springai
黑十11 小时前
FDE 怎么快速搭一个可演示页面?最小前端方案
java·大数据·前端·数据库·人工智能
神明不懂浪漫12 小时前
【第八章】多线程(一)
java·开发语言·经验分享·笔记