用户模块Web层开发

到目前为止，我们完成了用户模块Service层功能的开发，是时候进入web层开发了。

全局响应对象Response

不管是请求成功还是失败的响应结果，都应该结构统一，因此，这里我们定义一个统一的Response类：

package com.xiaojuan.boot.common;

import ...

@Data
public class Response<T> {

    /** 响应状态：0-成功 1-失败 */
    private Integer status;

    private String errCode;

    private String msg;

    private T data;

    private static final Integer STATUS_SUCCESS = 0;
    private static final Integer STATUS_FAIL = 1;

    private Response(Integer status, String msg, String errCode, T data) {
        this.status = status;
        this.msg = msg;
        this.errCode = errCode;
        this.data = data;
    }
    private Response(Integer status, T data) {
        this(status, null, data);
    }

    private Response(Integer status) {
        this(status, null, null);
    }

    private Response(Integer status, String msg, T data) {
        this(status, msg, null, data);
    }

    private Response(Integer status, String msg) {
        this(status, msg, null, null);
    }

    public static <T> Response<T> ok() {
        return ok(null);
    }

    public static <T> Response<T> ok(T data) {
        return new Response<>(STATUS_SUCCESS, data);
    }

    public static <T> Response<T> fail(String msg, String errCode, T data) {
        return new Response<>(STATUS_FAIL, msg, errCode, data);
    }

    public static <T> Response<T> fail(String msg, String errCode) {
        return fail(msg, errCode, null);
    }

    public static <T> Response<T> fail(String msg) {
        return fail(msg, null, null);
    }
}

代码说明

这个类我们考虑了各种请求成功或失败要存储的信息，我们提供了各种潜在会使用的构造器，并用重载的形式来完成字段的初始化操作。要注意，这里的构造器都是私有的，我们不希望用户在外面new出来，而交给该类中相应的ok和fail方法来构造其实例。

API定义

以往我们在开发Web组件时，我们只管实现controller。这里小卷给大家一个更优雅的实现方式，我们为controller抽取出接口，俗称web层的api。我们来看下api怎么定义的：

package com.xiaojuan.boot.web.api;

import ...

@RequestMapping("user")
public interface UserAPI {

    @PostMapping("register")
    Response<Void> register(UserRegisterDTO userRegisterDTO);

    @PostMapping("login")
    Response<UserInfoDTO> login(@RequestParam String username, @RequestParam String password, HttpSession session);

    // 给管理员一个单独的登录入口
    @PostMapping("admin/login")
    Response<UserInfoDTO> adminLogin(@RequestParam String username, @RequestParam String password, HttpSession session);

    @PostMapping("signature")
    Response<Void> signature(@RequestParam String signature, HttpSession session);

    @PostMapping("logout")
    Response<Void> logout(HttpSession session);
}

说明

这里我们将REST API接口定义和Controller接口实现进行了分离。这样我们从接口签名中很容易就能看到这个接口是干嘛的，一目了然，这里我们注入了HttpSession来进行http会话的相关操作。除了这种注入外，我们还可以借助Filter和ThreadLocal来实现无倾入式的session操作，后续我们会改进目前这种方式。

UserController实现

接下来我们写UserController，实现UserAPI。现在我们的UserController就变得很干净了，因为我们不用再写跟请求映射相关的注解了，只需要关注web表示层的实现即可。看下整体的代码：

package com.xiaojuan.boot.web.controller;

import ...

@RequiredArgsConstructor
@RestController
public class UserController implements UserAPI {

    private final UserService userService;

    @Override
    public Response<Void> register(UserRegisterDTO userRegisterDTO) {
        // todo DTO字段的校验暂且先不实现
        userService.register(userRegisterDTO);
        return Response.ok();
    }

    @Override
    public Response<UserInfoDTO> login(String username, String password, HttpSession session) {
        // todo 参数字段的校验先不做
        UserInfoDTO userInfo = userService.login(username, password);
        session.setAttribute(SessionConst.LOGIN_USER, userInfo);
        return Response.ok(userInfo);
    }

    @Override
    public Response<UserInfoDTO> adminLogin(String username, String password, HttpSession session) {
        // todo 参数字段的校验先不做
        UserInfoDTO userInfo = userService.login(username, password);
        userService.checkAdminRole(userInfo.getRole(), "非管理员用户不能登录");
        session.setAttribute(SessionConst.LOGIN_USER, userInfo);
        return Response.ok(userInfo);
    }

    @Override
    public Response<Void> signature(String signature, HttpSession session) {
        // 先从Session里获取用户
        UserInfoDTO userInfo = (UserInfoDTO) session.getAttribute(SessionConst.LOGIN_USER);
        if (userInfo == null) {
            // todo 暂时写死，待重构...
            return Response.fail("需要登录才能访问", "401");
        }
        userService.updatePersonalSignature(userInfo.getId(), signature);
        return Response.ok();
    }

    @Override
    public Response<Void> logout(HttpSession session) {
        session.removeAttribute(SessionConst.LOGIN_USER);
        return Response.ok();
    }
}

代码说明

1. 这里UserService的注入我们没有采用字段注入的形式，而是采用推荐的构造器的形式，而构造器我们也没有自己写，而是用一个注解@RequiredArgsConstructor省事儿了。

2. 注意下原来的UserService的checkAdminRole(role)方法，原来我们把错误消息写死了，这里我们在调用时要按照现在的场景输出不一样的错误消息，因此我们做了改造，多加了一个msg参数：

   UserServiceImpl.java

   @Override
   public void checkAdminRole(byte role, String msg) throws BusinessException {
       if (StringUtils.isEmpty(msg)) {
           msg = MSG_ADMIN_ROLE_REQUIRED;
       }
       if (Role.ADMIN.getValue() != role) {
           throw new BusinessException(msg);
       }
   }
   

3. 这里涉及到操作session，session的key我们也维护起来了：

   package com.xiaojuan.boot.consts;
   
   public interface SessionConst {
       String LOGIN_USER = "loginUser";
   }
   

4. 在实现controller方法逻辑时，我们没有一步到位，一些待实现的地方我们在注释中用todo进行了标记，表示后期待完善的地方。这就是迭代式开发的好习惯，当我们回头来修改这些地方时，可以从todo列表中很容易定位到它们：

   

好了，我们用户模块的Controller层也基本实现完了，接下来就是测试我们实现的REST API了。下一节我们来讲讲怎么测，大家加油！