ZutShop

Junior practical training project

• 在csdn暂存一下开发文档

本人大三做的实训项目，前后端分离。
后端：https://github.com/roydonGuo/ZutShop
前端使用Vue，前端项目地址：https://github.com/roydonGuo/ZutShop-Vue

0. 项目介绍

项目名称：智子商城。类似于购物车系统、订单系统。前后端分离。

分析项目：

当开发某一个项目时，分许该项目中需要处理哪些数据？

例如：用户，收货地址，商品类别，商品，收藏，购物车，订单。。。。

处理数据的先后顺序：先处理基础数据，在处理相关数据，

例如需要先处理商品数据，才可以处理订单数据

处理以上数据的先后顺序：用户>收获地址>商品类别>商品>收藏>购物车>订单

当确定了数据处理顺序之后应该分析每个数据对应的功能有哪些

例如用户数据：注册，登录，修改密码，修改资料，上传头像。。。。

确定开发功能的开发顺序，遵循增>查>删>改

用户数据功能的开发顺序：注册>登录>修改密码>修改资料>上传头像。。。。

确定每一个功能的开发步骤：创建数据表>创建实体类>持久层>业务层>控制器层>前端页面

1. 数据库创建

关于项项目的数据表问题：

1. 根据虚拟的前端页面和业务需求创建出各种数据表
2. 画出各种数据表之间的关系图
3. 每个表中的每个字段都应该有其作用否则将直接去掉

针对本项目，数据库设计如下：

sql文件在项目resources中。

2. 项目准备

本项目使用springboot框架进行后台开发，前端使用Vue开发，axios进行前后端交互。所以，涉及到的技术栈有：

• springboot
• springSecurity
• maven
• redis
• mybatis-plus
• Vue，axios

2.1 创建maven项目

父工程管理依赖：

1.8UTF-888

org.springframework.bootspring-boot-dependencies2.5.0pomimportcom.alibabafastjson1.2.33io.jsonwebtokenjjwt0.9.0com.baomidoumybatis-plus-boot-starter3.5.2io.springfoxspringfox-swagger22.9.2io.springfoxspringfox-swagger-ui2.9.2

子工程Zut-Framework

org.springframework.bootspring-boot-starter-weborg.projectlomboklomboktrueorg.springframework.bootspring-boot-starter-testorg.springframework.bootspring-boot-starter-data-redisorg.springframework.bootspring-boot-starter-security2.5.14com.alibabafastjsonio.jsonwebtokenjjwtcom.baomidoumybatis-plus-boot-startermysqlmysql-connector-javaorg.springframework.bootspring-boot-starter-aopio.springfoxspringfox-swagger2io.springfoxspringfox-swagger-ui

子工程Zut-Shopping依赖于子工程Zut-FrameWork

edu.zutZut-Framework1.0.0

2.2 Zut-Shopping

Zut-Shopping为业务控制层，需要一个启动类：

并添加mapper包扫描和开启swagger

@SpringBootApplication
@MapperScan("edu.zut.mapper")
@EnableSwagger2
public class ShopApplication {public static void main(String[] args) {SpringApplication.run(ShopApplication.class, args);}
}

配置文件：

配置服务端口号7777，数据库信息，配置redis和MP。

server:port: 7777
spring:datasource:url: jdbc:mysql://localhost:3306/zut-shop?characterEncoding=utf-8&serverTimezone=Asia/Shanghaiusername: rootpassword: qwer1234driver-class-name: com.mysql.cj.jdbc.Driver

2.3 Zut-Framework

Zut-Framework负责业务接口的实现。

新建User实体类：

IDEA有插件easycode快速生成MP代码，或者使用官方提供的代码生成器。

@SuppressWarnings("serial")
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user")
public class User {//用户id@TableIdprivate Integer uid;//用户名@ApiModelProperty(value = "用户名")private String username;//密码private String password;//性别,0-女,1-男private Integer gender;//电话private String phone;//邮箱private String email;//头像private String avatar;//是否删除,0-未删除,1-已删除private Integer isDelete;//创建执行人private Integer createdUser;//创建时间private Date createdTime;//修改执行人private Integer modifiedUser;//修改时间private Date modifiedTime;
}

UserMapper接口:

/*** Author: roydon - 2022/12/12**/
public interface UserMapper extends BaseMapper {}

Service层UserService：

public interface UserService extends IService {}

UserService的实现类UserServiceImpl

@Slf4j
@Service("userService")
public class UserServiceImpl extends ServiceImpl implements UserService {}

新建数据相应类ResponseResult，表示后端响应给前端的数据。

@JsonInclude(JsonInclude.Include.NON_NULL)
public class ResponseResult implements Serializable {private Integer code;private String msg;private T data;public ResponseResult() {this.code = AppHttpCodeEnum.SUCCESS.getCode();this.msg = AppHttpCodeEnum.SUCCESS.getMsg();}public ResponseResult(Integer code, T data) {this.code = code;this.data = data;}public ResponseResult(Integer code, String msg, T data) {this.code = code;this.msg = msg;this.data = data;}public ResponseResult(Integer code, String msg) {this.code = code;this.msg = msg;}public static ResponseResult errorResult(int code, String msg) {ResponseResult result = new ResponseResult();return result.error(code, msg);}public static ResponseResult okResult() {ResponseResult result = new ResponseResult();return result;}public static ResponseResult okResult(int code, String msg) {ResponseResult result = new ResponseResult();return result.ok(code, null, msg);}public static ResponseResult okResult(Object data) {ResponseResult result = setAppHttpCodeEnum(AppHttpCodeEnum.SUCCESS, AppHttpCodeEnum.SUCCESS.getMsg());if (data != null) {result.setData(data);}return result;}public static ResponseResult errorResult(AppHttpCodeEnum enums) {return setAppHttpCodeEnum(enums, enums.getMsg());}public static ResponseResult errorResult(AppHttpCodeEnum enums, String msg) {return setAppHttpCodeEnum(enums, msg);}public static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums) {return okResult(enums.getCode(), enums.getMsg());}private static ResponseResult setAppHttpCodeEnum(AppHttpCodeEnum enums, String msg) {return okResult(enums.getCode(), msg);}public ResponseResult error(Integer code, String msg) {this.code = code;this.msg = msg;return this;}public ResponseResult ok(Integer code, T data) {this.code = code;this.data = data;return this;}public ResponseResult ok(Integer code, T data, String msg) {this.code = code;this.data = data;this.msg = msg;return this;}public ResponseResult ok(T data) {this.data = data;return this;}public Integer getCode() {return code;}public void setCode(Integer code) {this.code = code;}public String getMsg() {return msg;}public void setMsg(String msg) {this.msg = msg;}public T getData() {return data;}public void setData(T data) {this.data = data;}
}

新建一个枚举类，封装响应码对应响应信息。

public enum AppHttpCodeEnum {// 成功SUCCESS(200, "操作成功"),// 登录NEED_LOGIN(401, "需要登录后操作"),NO_OPERATOR_AUTH(403, "无权限操作"),USER_IS_DELETED(404, "用户已被删除"),SYSTEM_ERROR(500, "出现错误"),USERNAME_EXIST(501, "用户名已存在"),PHONENUMBER_EXIST(502, "手机号已存在"),EMAIL_EXIST(503, "邮箱已存在"),REQUIRE_USERNAME(504, "必需填写用户名"),CONTENT_NOT_NULL(506, "评论内容不能为空"),FILE_TYPE_ERROR(507, "文件类型错误，请上传png文件"),USERNAME_NOT_NULL(508, "用户名不能为空"),NICKNAME_NOT_NULL(509, "昵称不能为空"),PASSWORD_NOT_NULL(510, "密码不能为空"),PASSWORD_NOT_MATCH(513, "原密码错误"),EMAIL_NOT_NULL(511, "邮箱不能为空"),NICKNAME_EXIST(512, "昵称已存在"),LOGIN_ERROR(505, "用户名或密码错误");int code;String msg;AppHttpCodeEnum(int code, String errorMessage) {this.code = code;this.msg = errorMessage;}public int getCode() {return code;}public String getMsg() {return msg;}
}

跟redis的key相关字符串的封装：

public class RedisConstants {public static final String LOGIN_USER_KEY="login:user:";
}

一些需要用到的常量的封装：

public class SystemConstants {/*** 正常状态*/public static final String NORMAL = "0";public static final String ADMAIN = "1";/*** 用户是否为删除状态*/public static final Integer IS_DELETED = 1;public static final Integer IS_ALIVE = 0;}

2.4 MP配置

配置MP分页器。这个功能也许用不到，针对数据多的时候分页查询会减小很多额外的性能消耗。

@Configuration
public class MybatisPlusConfig {@Beanpublic MybatisPlusInterceptor mybatisPlusInterceptor(){MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());return mybatisPlusInterceptor;}
}

分析数据表t_user可知，当我们在crud时，同时需要修改创建时间、修改时间、修改人、创建人等字段。

例如下面场景：修改用户密码后，实现类中还需要单独设置修改人、获取系统时间对修改时间字段进行设置。麻烦不说，写起来十分别扭不美观。所以，解决方法MP已经为我们想到了，只需要实现MetaObjectHandler接口即可。每当调用MP提供的相应方法，下面实现类对应的方法就会执行。

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {Integer userId = null;try {userId = SecurityUtils.getUserId();} catch (Exception e) {e.printStackTrace();userId = -1;//表示是自己创建}this.setFieldValByName("createdTime", new Date(), metaObject);this.setFieldValByName("createdUser",userId , metaObject);this.setFieldValByName("modifiedTime", new Date(), metaObject);this.setFieldValByName("modifiedUser", userId, metaObject);}@Overridepublic void updateFill(MetaObject metaObject) {this.setFieldValByName("modifiedTime", new Date(), metaObject);this.setFieldValByName("modifiedUser", SecurityUtils.getUserId(), metaObject);}
}

同时，User实体类要添加@TableField注解，添加规则

@SuppressWarnings("serial")
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("t_user")
public class User {//用户id@TableIdprivate Integer uid;//用户名@ApiModelProperty(value = "用户名")private String username;//密码private String password;//性别,0-女,1-男private Integer gender;//电话private String phone;//邮箱private String email;//头像private String avatar;//是否删除,0-未删除,1-已删除private Integer isDelete;//创建执行人@TableField(fill = FieldFill.INSERT)//插入时触发handlerprivate Integer createdUser;//创建时间@TableField(fill = FieldFill.INSERT)private Date createdTime;//修改执行人@TableField(fill = FieldFill.INSERT_UPDATE)//更新时触发handlerprivate Integer modifiedUser;//修改时间@TableField(fill = FieldFill.INSERT_UPDATE)private Date modifiedTime;
}

配置文件添加MP配置：

server:port: 7777spring:datasource:url: jdbc:mysql://localhost:3306/zut-shop?characterEncoding=utf-8&serverTimezone=Asia/Shanghaiusername: rootpassword: qwer1234driver-class-name: com.mysql.cj.jdbc.Driver
mybatis-plus:configuration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #sql打印global-config:db-config:logic-delete-field: delFlaglogic-delete-value: 1logic-not-delete-value: 0id-type: auto

注意：MP配置好后最好在测试类中测试能否拿到数据库数据。

2.5 Redis配置

需要用到ali的fastjson序列化器在redis存值的时候进行序列化，保证是转义后的中文字符。

FastJsonRedisSerializer

/*** Redis使用FastJson序列化*/
public class FastJsonRedisSerializer implements RedisSerializer {public static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;private Class clazz;static {ParserConfig.getGlobalInstance().setAutoTypeSupport(true);}public FastJsonRedisSerializer(Class clazz) {super();this.clazz = clazz;}@Overridepublic byte[] serialize(T t) throws SerializationException {if (t == null) {return new byte[0];}return JSON.toJSONString(t, SerializerFeature.WriteClassName).getBytes(DEFAULT_CHARSET);}@Overridepublic T deserialize(byte[] bytes) throws SerializationException {if (bytes == null || bytes.length <= 0) {return null;}String str = new String(bytes, DEFAULT_CHARSET);return JSON.parseObject(str, clazz);}protected JavaType getJavaType(Class clazz) {return TypeFactory.defaultInstance().constructType(clazz);}
}

RedisConfig

@Configuration
public class RedisConfig {@Bean@SuppressWarnings(value = {"unchecked", "rawtypes"})public RedisTemplate redisTemplate(RedisConnectionFactory connectionFactory) {RedisTemplate template = new RedisTemplate<>();template.setConnectionFactory(connectionFactory);FastJsonRedisSerializer serializer = new FastJsonRedisSerializer(Object.class);// 使用StringRedisSerializer来序列化和反序列化redis的key值template.setKeySerializer(new StringRedisSerializer());template.setValueSerializer(serializer);// Hash的key也采用StringRedisSerializer的序列化方式template.setHashKeySerializer(new StringRedisSerializer());template.setHashValueSerializer(serializer);template.afterPropertiesSet();return template;}
}

redis操作封装工具类，来自ruoyi：

@SuppressWarnings(value = {"unchecked", "rawtypes"})
@Component
public class RedisCache {@Resourcepublic RedisTemplate redisTemplate;/*** 缓存基本的对象，Integer、String、实体类等** @param key   缓存的键值* @param value 缓存的值*/public  void setCacheObject(final String key, final T value) {redisTemplate.opsForValue().set(key, value);}/*** 缓存基本的对象，Integer、String、实体类等** @param key      缓存的键值* @param value    缓存的值* @param timeout  时间* @param timeUnit 时间颗粒度*/public  void setCacheObject(final String key, final T value, final Integer timeout, final TimeUnit timeUnit) {redisTemplate.opsForValue().set(key, value, timeout, timeUnit);}/*** 设置有效时间** @param key     Redis键* @param timeout 超时时间* @return true=设置成功；false=设置失败*/public boolean expire(final String key, final long timeout) {return expire(key, timeout, TimeUnit.SECONDS);}/*** 设置有效时间** @param key     Redis键* @param timeout 超时时间* @param unit    时间单位* @return true=设置成功；false=设置失败*/public boolean expire(final String key, final long timeout, final TimeUnit unit) {return redisTemplate.expire(key, timeout, unit);}/*** 获得缓存的基本对象。** @param key 缓存键值* @return 缓存键值对应的数据*/public  T getCacheObject(final String key) {ValueOperations operation = redisTemplate.opsForValue();return operation.get(key);}/*** 删除单个对象** @param key*/public boolean deleteObject(final String key) {return redisTemplate.delete(key);}/*** 删除集合对象** @param collection 多个对象* @return*/public long deleteObject(final Collection collection) {return redisTemplate.delete(collection);}/*** 缓存List数据** @param key      缓存的键值* @param dataList 待缓存的List数据* @return 缓存的对象*/public  long setCacheList(final String key, final List dataList) {Long count = redisTemplate.opsForList().rightPushAll(key, dataList);return count == null ? 0 : count;}/*** 获得缓存的list对象** @param key 缓存的键值* @return 缓存键值对应的数据*/public  List getCacheList(final String key) {return redisTemplate.opsForList().range(key, 0, -1);}/*** 缓存Set** @param key     缓存键值* @param dataSet 缓存的数据* @return 缓存数据的对象*/public  BoundSetOperations setCacheSet(final String key, final Set dataSet) {BoundSetOperations setOperation = redisTemplate.boundSetOps(key);Iterator it = dataSet.iterator();while (it.hasNext()) {setOperation.add(it.next());}return setOperation;}/*** 获得缓存的set** @param key* @return*/public  Set getCacheSet(final String key) {return redisTemplate.opsForSet().members(key);}/*** 缓存Map** @param key* @param dataMap*/public  void setCacheMap(final String key, final Map dataMap) {if (dataMap != null) {redisTemplate.opsForHash().putAll(key, dataMap);}}/*** 获得缓存的Map** @param key* @return*/public  Map getCacheMap(final String key) {return redisTemplate.opsForHash().entries(key);}/*** 根据map的key对值进行自增操作** @param key* @param hKey* @param v*/public void incrementCacheMapValue(String key, String hKey, long v) {redisTemplate.boundHashOps(key).increment(hKey, v);}/*** 往Hash中存入数据** @param key   Redis键* @param hKey  Hash键* @param value 值*/public  void setCacheMapValue(final String key, final String hKey, final T value) {redisTemplate.opsForHash().put(key, hKey, value);}/*** 获取Hash中的数据** @param key  Redis键* @param hKey Hash键* @return Hash中的对象*/public  T getCacheMapValue(final String key, final String hKey) {HashOperations opsForHash = redisTemplate.opsForHash();return opsForHash.get(key, hKey);}/*** 删除Hash中的数据** @param key* @param hkey*/public void delCacheMapValue(final String key, final String hkey) {HashOperations hashOperations = redisTemplate.opsForHash();hashOperations.delete(key, hkey);}/*** 获取多个Hash中的数据** @param key   Redis键* @param hKeys Hash键集合* @return Hash对象集合*/public  List getMultiCacheMapValue(final String key, final Collection