Spring Boot项目中的Controller、Service、Mapper和Entity层的作用与联系

目录

一、Controller层

1.2Controller层重要注解：

1.3@Controller

1.4@RequestMapping

（1）基础用法

（2）用 @RequestMapping 处理 HTTP 的各种方法

Service层

后端service层一般需要做以下几件事情：

如何通过service层调用dao：

Mapper层

1.1 @Repository

1.2 @Mapper

Entity层

关系与联系

---

一、Controller层

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 查询用户列表
     */
    @RequiresPermissions("user:list")
    @GetMapping("/list")
    public JSONObject listUser(HttpServletRequest request) {
        return userService.listUser(CommonUtil.request2Json(request));
    }

    @RequiresPermissions("user:add")
    @PostMapping("/addUser")
    public JSONObject addUser(@RequestBody JSONObject requestJson) {
        CommonUtil.hasAllRequired(requestJson, "username, password, nickname, roleIds");
        return userService.addUser(requestJson);
    }

    @RequiresPermissions("user:update")
    @PostMapping("/updateUser")
    public JSONObject updateUser(@RequestBody JSONObject requestJson) {
        CommonUtil.hasAllRequired(requestJson, " nickname, roleIds, deleteStatus, userId");
        return userService.updateUser(requestJson);
    }

    @RequiresPermissions(value = {"user:add", "user:update"}, logical = Logical.OR)
    @GetMapping("/getAllRoles")
    public JSONObject getAllRoles() {
        return userService.getAllRoles();
    }

  

Controller层是Spring Boot应用程序的入口点，通常处用于理请求的输入和输出，并负责验证输入数据的有效性。它将http请求参数传递给Service层，然后将Service层的处理结果封装成适当的响应返回给客户端。

1.2Controller层重要注解：

• @Controller
• @RequestMapping
• @ResponseBody
• @RestController
• @GetMapping
• @PostMapping

1.3@Controller

当Spring检测到@Controller注解时，将其自动注册为Controller对象

1.4@RequestMapping

（1）基础用法

@RequestMapping 注解用于将任意HTTP 请求映射到控制器方法上，可以在控制器类上和控制器类中的方法上使用。

 @RequiresPermissions("user:list")
    @GetMapping("/list")
    public JSONObject listUser(HttpServletRequest request) {
        return userService.listUser(CommonUtil.request2Json(request));
    }

如上述代码所示，到 /user：list的请求会由  listUser(HttpServletRequest request)方法来处理，

用于将任意HTTP 请求映射到控制器方法上。

（2）用 @RequestMapping 处理 HTTP 的各种方法

Spring MVC 的 @RequestMapping 注解能够处理 HTTP 请求的方法, 比如 GET, PUT, POST, DELETE 以及 PATCH。

@RestController
@RequestMapping("/home")
public class IndexController {
    @RequestMapping(method = RequestMethod.GET)
    String get() {
        return "Hello from get";
    }
    @RequestMapping(method = RequestMethod.DELETE)
    String delete() {
        return "Hello from delete";
    }
    @RequestMapping(method = RequestMethod.POST)
    String post() {
        return "Hello from post";
    }
    @RequestMapping(method = RequestMethod.PUT)
    String put() {
        return "Hello from put";
    }
    @RequestMapping(method = RequestMethod.PATCH)
    String patch() {
        return "Hello from patch";
    }
}

 @RequestMapping 注解中的 method 元素声明了 HTTP 请求的 HTTP 方法的类型。

Service层

@Service
public class UserService {
    @Autowired
    private UserDao userDao;

    /**
     * 用户列表
     */
    public JSONObject listUser(JSONObject jsonObject) {
        CommonUtil.fillPageParam(jsonObject);
        int count = userDao.countUser(jsonObject);
        List<JSONObject> list = userDao.listUser(jsonObject);
        return CommonUtil.successPage(jsonObject, list, count);
    }

Service层不应该直接与数据库交互，它接收Controller层传递过来的请求，并调用相应的Mapper层方法来操作数据库。

后端service层一般需要做以下几件事情：

（1）定义service层的接口和实现类，接口中声明业务方法，实现类中编写业务逻辑。
（2）注入dao层或mapper层的对象，调用它们的方法来操作数据库或执行sql语句。
（3）处理异常情况，例如捕获sql异常，抛出自定义异常等。
（4）添加事务管理注解，保证数据的一致性和完整性。

如何通过service层调用dao：

在bean属性中配置每一个service与dao，例如：

添加配置属性：

       <context:annotation-config/>
       <bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor"/>
       
       <bean id="loginService" class="com.springmvc.service.LoginService">
         <property name="loginDao" ref="loginDao"/>
       </bean>
       <bean id="loginDao" class="com.springmvc.dao.LoginDao" />

id="loginService" 与注解@Resource的name保持一致

service层：

@Service
public class LoginService {
	
	@Autowired
	private LoginDao loginDao = null;
	
	@Resource(name="loginDao")
	public void setLoginDao(LoginDao loginDao) {
		this.loginDao = loginDao;
	}
	
	public User getUserInfo() {
		return loginDao.getUserInfo();
	}
}

@Autowired可以标注在属性上、方法上和构造器上，按by type自动装配。

@Resource和@Autowired注解都是用来实现依赖注入的。@Resource默认按byName自动注入。

Mapper层

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.heeexy.example.dao.UserDao">

    <select id="countUser" resultType="Integer">
        SELECT count(0)
        FROM sys_user u
        WHERE u.delete_status = '1'
    </select>

    <resultMap id="userMap" type="com.heeexy.example.util.model.One2Many">
        <id column="userId" property="userId"/>
        <result column="username" property="username"/>
        <result column="nickname" property="nickname"/>
        <result column="createTime" property="createTime"/>
        <result column="updateTime" property="updateTime"/>
        <result column="deleteStatus" property="deleteStatus"/>
        <collection property="roles" ofType="com.alibaba.fastjson.JSONObject">
            <id column="roleId" property="roleId"/>
            <result column="roleName" property="roleName"/>
        </collection>
    </resultMap>

1.1 @Repository

它用来标注访问层的类（Dao层），它表示一个仓库，主要用于封装对于数据库的访问，配合 @MapperScan 注解一起使用。

1.2 @Mapper

package com.example.mapper;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM users WHERE id = #{id}")
    User getUserById(int id);
}

单独使用，通过xml里面的namespace里面的接口地址，生成了Bean后注入到Service层中。

Mapper层定义了各种数据库操作方法的接口，并由ORM框架自动实现。它将数据库操作细节封装起来，对上层提供简洁的接口，让开发人员能够更专注于业务逻辑的实现。

它还提供了一组方法用于对数据库进行增删改查等操作。例如：mybits......

<select id="listUser" resultMap="userMap">
        SELECT u.*,
               r.id        roleId,
               r.role_name roleName
        FROM (
                 SELECT id                                      userId,
                        username                                username,
                        nickname                                nickname,
                        delete_status                           deleteStatus,
                        DATE_FORMAT(create_time, '%Y.%m.%d %T') createTime,
                        DATE_FORMAT(update_time, '%Y.%m.%d %T') updateTime
                 FROM sys_user
                 WHERE delete_status = '1'
                 ORDER BY id
                 LIMIT #{offSet}, #{pageRow}
             ) u
                 LEFT JOIN sys_user_role ur on ur.user_id = u.userId
                 LEFT JOIN sys_role r ON r.id = ur.role_id
        ORDER BY u.userId, r.id
    </select>

Entity层

Entity层（也称为Model层）表示与数据库表对应的实体类。它的作用是映射数据库表结构，定义数据的结构和属性。它是与数据库交互的核心，将数据库表中的记录映射为Java对象。

package com.heeexy.example.util.model;

import com.alibaba.fastjson.JSONObject;

import java.util.List;
import java.util.Set;

/**
 * @author: heeexy
 * @description: MyBatis的一对多JSON返回对象
 * <p>
 * 处理嵌套查询结果时，MyBatis会根据bean定义的属性类型来初始化嵌套的成员变量，
 * 主要看其是不是Collection
 * 如果这里不定义，那么嵌套返回结果里就只能返回一对一的结果，而不是一对多的
 * <p>
 * 参见MyBatis  DefaultResultSetHandler.instantiateCollectionPropertyIfAppropriate()
 * @date: 2017/10/24 10:17
 */
public class One2Many extends JSONObject {
    private Set<String> roleList;
    private Set<String> menuList;
    private Set<String> permissionList;
    private Set<Integer> permissionIds;
    private List<JSONObject> picList;
    private List<JSONObject> menus;
    private List<JSONObject> users;
    private List<JSONObject> permissions;
    private List<JSONObject> roles;
}

关系与联系

这四个层次之间存在着紧密的联系，它们共同协作以实现应用程序的功能。通过分层框架，将不同职责分离，提高了代码 的可维护性和可测试性。

1.Controller层接收来自客户端的请求，将请求参数传递给Service层，并将Service层的处理结果封装成适当的响应返回给客户端。
2.Service层负责实现具体的业务功能，它接收Controller层传递过来的请求，并调用Mapper层的方法来操作数据库。
3.Mapper层负责与数据库交互，通过ORM框架来简化数据库操作。它将数据库操作细节封装起来，为Service层提供简洁的接口。
4.Entity层表示与数据库表对应的实体类，它映射数据库表的结构和属性，并负责与数据库进行数据的转换和映射。