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

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

相关推荐
笨蛋不要掉眼泪7 分钟前
Java虚拟机:常用参数
java·开发语言·python
亦暖筑序1 小时前
AgentScope-Java 入门:用 Middleware 审计 Agent 调用
java·ai编程·agentscope
你驴我1 小时前
WhatsApp 消息撤回与编辑的幂等性设计实践
java·服务器·前端·后端·python
青山木2 小时前
Hot 100 ---腐烂的橘子
java·数据结构·后端·算法·leetcode·广度优先
小龙报2 小时前
【优选算法】1. 水果成蓝 2.找到字符串中所有字母的异位词
java·c语言·数据结构·数据库·c++·redis·算法
自强的小白2 小时前
重点!起始时间和结束时间与创建时间和修改时间的区别(localdate与LocaldateTIME区别)以及增删改查什么时候设置目前时间(添加和更新员工时)
java
雪的季节2 小时前
Python 线程同步与异步编程 全解析
java·开发语言
吃饱了得干活3 小时前
缓存与数据库一致性:从理论到实战
java·后端·面试
520拼好饭被践踏3 小时前
JAVA+Agent学习day22
java·开发语言·后端·学习
笨蛋不要掉眼泪3 小时前
Java虚拟机:堆的参数配置
java·开发语言·jvm