mmall商场第二天

前言

昨天写的东西感觉有点啰嗦，这样写感觉重点不突出，效率比较低，决定以后调重点记录一下，最后写好一个模块再总结这个模块用到的技术点。下面是今天的内容：

  • 抽象出响应类
  • 登录逻辑

抽象出响应类

为什么要抽象出一个统一的响应类呢？不抽象出响应类的时候我一般都是需要返回什么我再去想该怎么写接口，返回的值是什么，这样做有很大的弊端:

  • 想到哪写到哪，没有形成一个通用的思考方向，这样写代码效率非常底下而且写出的代码可读性，可维护性太差。
  • 每个接口返回的值都不统一，不利于前端取数据。

总之感觉无论是自己写代码还是以后在公司写代码都应该这样做，这就是一种规范。捋清楚为啥要这样写，还是有点小震撼的，目前的水平真的太菜了。
下面是抽象出响应类的过程：
首先哪登录接口出来分析下

/user/login.do post(代码需要post方式请求),开放get，方便调试

request
username,password
response

fail
{
"status": 1,
"msg": "密码错误"
}

success
{
"status": 0,
"data": {
"id": 12,
"username": "aaa",
"email": "aaa@163.com",
"phone": null,
"role": 0,
"createTime": 1479048325000,
"updateTime": 1479048325000
}
}

这里只是拿出登录接口出来分析，其他接口都是一样的格式，即json格式。接口返回的值可以分为三部分内容：

  1. status： 返回状态，0表示成功，1表示成功
  2. msg： 返回信息，例如密码错误，登录失败等等随接口不同而返回的值不同
  3. user对象： 实际上这里不一定是user 对象，也可以是购物车对象，订单对象等等，所以在抽象的时候应该抽象成一个泛型，可以接受所有对象

根据接口抽取出这三部分内容，代码就好写了。先建一个带泛型的ServerResponse类，这个类有上三个成员变量，另外@JsonSerialize标签的作用是忽略掉值为null的key，比如，某个接口的fail里面不需要包含status这个字段，那么加了这个标签就可以不序列status这个字段。注意@JsonSerialize放到类上面是对所有字段都有效，如果只是放到某个方法上面则对该方法有效。

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL)//忽略属性为null序列化
public class ServerResponse<T> implements Serializable {
    private int status;
    private String msg;
    private T data;
}

然后是写ServerResponse类的各种构造函数，至于要写哪些构造函数的话其实我感觉是当需要的时候再去写，毕竟一开始没经验的也不知道哪种是我们需要的。

private ServerResponse(int status) {
        this.status = status;
    }
    private ServerResponse(int status, T data) {
        this.status = status;
        this.data = data;
    }
    private ServerResponse(int status, String msg) {
        this.status = status;
        this.msg = msg;
    }
    private ServerResponse(int status, String msg, T data) {
        this.status = status;
        this.msg = msg;
        this.data = data;
    }

写一个返回布尔值的方法，这个方法判断是成功或者失败。注意这里有个标签@JsonIgnore，这个标签的作用是这个方法的返回值不要转换成json。因为前端不需要这个数据，这个数据只是我们后端用来判断是成功还是失败用的。

//忽略此方法的json转换
    @JsonIgnore
    public boolean isSuccess() {
        return this.status == ResponseCode.SUCCESS.getCode();
    }

注意到上面的构造函数都是私有的，也就是说不能通过new来得到我们的响应类，所以还要开放一些方法来得到响应类以及三个私有字段的值。

public static <T> ServerResponse<T> createBySuccess() {
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode());
    }

    public static <T> ServerResponse<T> createBySuccess(T data) {
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), data);
    }

    public static <T> ServerResponse<T> createBySuccessMessage(String msg) {
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), msg);
    }

    public static <T> ServerResponse<T> createBySuccess(String msg, T data) {
        return new ServerResponse<T>(ResponseCode.SUCCESS.getCode(), msg, data);
    }

    public static <T> ServerResponse<T> createByError(String errorMessage) {
        return new ServerResponse<T>(ResponseCode.ERROR.getCode(), errorMessage);
    }

    public static <T> ServerResponse<T> createByError() {
        return new ServerResponse<T>(ResponseCode.ERROR.getCode(), ResponseCode.ERROR.getDesc());
    }

    public static <T> ServerResponse<T> createByError(int errorCode, String errorMessage) {
        return new ServerResponse<T>(errorCode, errorMessage);
    }

    public T getData() {
        return this.data;
    }

    public String getMsg() {
        return this.msg;
    }

    public int getStatus() {
        return this.status;
    }

上面用到了一个ResponseCode类，这是一个枚举类，作用是用来保存返回码和返回信息，即接口中的status和msg这两个字段，下面是ResponseCode类

package com.ch0918.common;

/**
 * @author huangdongjiang
 * @date 2018/8/12 15:50
 */
public enum ResponseCode {
    ERROR(1, "ERROR"),//用逗号隔开
    SUCCESS(0, "SUCCESS"),//用逗号隔开
    ILLEGAL_ARGUMENT(10, "ILLEGAL_ARGUMENT");//分号结束

    private int code;
    private String desc;

    ResponseCode(int code, String desc) {
        this.code = code;
        this.desc = desc;
    }
    public int getCode() {
        return this.code;
    }
    public String getDesc() {
        return this.desc;
    }
}
小结

这里代码不多，但是很有营养，这种抽象思想放到任何一个项目都是需要的，而且前端和后端交互数据应该也是通过这个类封装好返回给前端。另外里面的泛型用到这里恰到好处，趁机复习了一波泛型和枚举类的相关知识。

登录逻辑

登录逻辑之前写过，但是跟别人的写的比起来，感觉我的代码写得很乱。
controller层，注意这里在类上面用了@RequestMapping("/user/")，这样写是因为通过分析接口文档知道，用户模块前面都带有/user/，如果不在类上面加的，每个方法都要加这个。另外这里又抽出了一个常量类Const。

package com.ch0918.controller.portal;

import com.ch0918.common.Const;
import com.ch0918.common.ServerResponse;
import com.ch0918.pojo.User;
import com.ch0918.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * @author huangdongjiang
 * @date 2018/8/12 14:44
 */
@Controller
@RequestMapping("/user/")
public class UserController {
    @Autowired
    private IUserService iUserService;

    /**
     * 用户登录
     * @param username 用户名
     * @param password 密码
     * @param session session
     * @return ServerResponse<User>
     */
    @RequestMapping(value = "login.do", method = RequestMethod.POST)
    @ResponseBody //封装成jason格式返回
    public ServerResponse<User> login(String username, String password, HttpSession session) {
        //controller->service->dao
        ServerResponse<User> serverResponse = iUserService.login(username, password);
        if (serverResponse.isSuccess()) {
            session.setAttribute(Const.CURRENT_USER, serverResponse.getData());
        }
        return serverResponse;
    }
}

常量类Const代码

package com.ch0918.common;

/**
 * @author huangdongjiang
 * @date 2018/8/12 20:14
 */
public class Const {
    public static final String CURRENT_USER = "current_user";
}

Service层

package com.ch0918.service;

import com.ch0918.common.ServerResponse;
import com.ch0918.pojo.User;

/**
 * @author huangdongjiang
 * @date 2018/8/12 14:50
 */
public interface IUserService {
    /**
     * 登录
     * @param userName 用户名
     * @param password 密码
     * @return 响应对象
     */
    ServerResponse<User> login(String userName, String password);
}

package com.ch0918.service.impl;

import com.ch0918.common.ResponseCode;
import com.ch0918.common.ServerResponse;
import com.ch0918.dao.UserMapper;
import com.ch0918.pojo.User;
import com.ch0918.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @author huangdongjiang
 * @date 2018/8/12 14:51
 */
@Service
public class UserServiceImpl implements IUserService {
    @Autowired
    private UserMapper userMapper;

    @Override
    public ServerResponse<User> login(String username, String password) {
        int resultCount = userMapper.checkUsername(username);
        if (resultCount == 0) {
            return ServerResponse.createByError("用户名不存在。");
        }
        //todo MD5加密
        User user = userMapper.login(username, password);
        if (user == null) {
            return ServerResponse.createByError("密码错误。");
        }
        return ServerResponse.createBySuccess("登录成功", user);
    }
}

dao层

int checkUsername(String userName);

    User login(@Param("username") String username, @Param("password") String password);

user.xml中的sql语句

 <select id="checkUsername" parameterType="String" resultType="int">
    select count(1)
    from mmall_user
    where username = #{userName}
  </select>

  <select id="login" parameterMap="map" resultMap="BaseResultMap">
    select
      <include refid="Base_Column_List"/>
    from mmall_user
    where username = #{username}
    and password = #{password}
  </select>

总结

每个接口的响应可以抽象出一个统一的类，以后的接口就直接用这个类来作为响应。这样就不用想每个接口要返回什么东西了。这个响应类的精髓在于泛型的使用，就是要返回给前台的数据抽象成一个泛型，根据接口的不同而不同，例如可以是User对象，也可以是Cart对象等等。另外做响应对象时又抽出了一个常量类Const和枚举类ResponseCode。
有了抽取出来的响应类后写登录功能的代码就可以优雅地完成了。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,547评论 6赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,399评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,428评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,599评论 1赞 274
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,612评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,577评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,941评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,603评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,852评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,375评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,955评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2赞 342

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,585评论 18赞 139
  • 《晨读记》（187）: 秋草独寻人去后
    ——读《长沙过贾谊宅 》 在秋草中，独寻贾谊，独寻自己，独寻天地的玄机，独寻人生的真谛。却只见寒...
    大观学园阅读 681评论 1赞 1
  • 〔杂乱〕  随笔小说
    心情不算很好。 我最终还是没想到夏天结束的这么快，连同街角一直趴着的那条狗一同不见了。 但是这个并不是让我心烦的原...
    江槎阅读 324评论 0赞 2
  • 叫我如何不爱她
    她叫安倍 广东狂人路亚基地的爱犬 我们的好朋友 看家护院并非她的职责 天生丽质，貌美如花 然而 奇迹总是发生在身边...
    李瘦猪阅读 2,225评论 2赞 9
  • 打火匣留给寒冷之时
    阔别似大海的波澜不惊， 能包容多少沉静的心。 爱人的年华老去， 看见苹果香味的腐朽与畏缩， 泥土无限宽恕生物的落魄...
    衡己阅读 132评论 0赞 1