代码规约

yami-shop-sys/src/main/java/com/yami/shop/sys/aspect/SysLogAspect.java

@@ -11,7 +11,7 @@
 package com.yami.shop.sys.aspect;
 
 import cn.hutool.core.date.SystemClock;
-import com.yami.shop.common.util.IPHelper;
+import com.yami.shop.common.util.IpHelper;
 import com.yami.shop.common.util.Json;
 import com.yami.shop.security.admin.util.SecurityUtils;
 import com.yami.shop.sys.model.SysLog;
@@ -62,7 +62,7 @@ public class SysLogAspect {
 		sysLogEntity.setParams(params);
 
 		//设置IP地址
-		sysLogEntity.setIp(IPHelper.getIpAddr());
+		sysLogEntity.setIp(IpHelper.getIpAddr());
 
 		//用户名
 		String username = SecurityUtils.getSysUser().getUsername();

yami-shop-sys/src/main/java/com/yami/shop/sys/constant/Constant.java

@@ -12,6 +12,7 @@ package com.yami.shop.sys.constant;
 
 /**
  * 常量
+ * @author lanhai
  */
 public class Constant {
 	/** 超级管理员ID */

yami-shop-sys/src/main/java/com/yami/shop/sys/constant/MenuType.java

@@ -2,6 +2,7 @@ package com.yami.shop.sys.constant;
 
 /**
  * 菜单类型
+ * @author lanhai
  */
 public enum MenuType {
     /**

yami-shop-sys/src/main/java/com/yami/shop/sys/dao/SysLogMapper.java

@@ -15,6 +15,7 @@ import com.yami.shop.sys.model.SysLog;
 
 /**
  * 系统日志
+ * @author lanhai
  */
 public interface SysLogMapper extends BaseMapper<SysLog> {
 

yami-shop-sys/src/main/java/com/yami/shop/sys/dao/SysMenuMapper.java

@@ -56,9 +56,14 @@ public interface SysMenuMapper extends BaseMapper<SysMenu>{
 	
 	/**
 	 * 根据一级菜单id 获取二级菜单
+	 * @param parentId 一级菜单id
 	 * @return 二级菜单列表
 	 */
 	List<SysMenu> listChildrenMenuByParentId(Long parentId);
 
+	/**
+	 * 获取菜单和按钮列表
+	 * @return
+	 */
 	List<SysMenu> listMenuAndBtn();
 }

yami-shop-sys/src/main/java/com/yami/shop/sys/dao/SysRoleMapper.java

@@ -17,12 +17,21 @@ import org.apache.ibatis.annotations.Param;
 import java.util.List;
 
 /**
+ * @author lanhai
  * 角色管理
  */
 public interface SysRoleMapper extends BaseMapper<SysRole>{
-
+	/**
+	 * 批量删除
+	 * @param roleIds
+	 */
 	void deleteBatch(@Param("roleIds") Long[] roleIds);
 
+	/**
+	 * 根据用户id获取角色id列表
+	 * @param userId
+	 * @return
+	 */
 	List<Long> listRoleIdByUserId(Long userId);
 
 }

yami-shop-sys/src/main/java/com/yami/shop/sys/dao/SysRoleMenuMapper.java

@@ -17,12 +17,15 @@ import org.apache.ibatis.annotations.Param;
 import java.util.List;
 
 /**
+ * @author lanhai
  * 角色与菜单对应关系
  */
 public interface SysRoleMenuMapper extends BaseMapper<SysRoleMenu> {
 	
 	/**
 	 * 根据角色ID数组，批量删除
+	 * @param roleIds
+	 * @return
 	 */
 	int deleteBatch(Long[] roleIds);
 

yami-shop-sys/src/main/java/com/yami/shop/sys/dao/SysUserMapper.java

@@ -17,6 +17,7 @@ import org.apache.ibatis.annotations.Param;
 import java.util.List;
 
 /**
+ * @author lanhai
  * 系统用户
  */
 public interface SysUserMapper extends BaseMapper<SysUser> {
@@ -24,12 +25,14 @@ public interface SysUserMapper extends BaseMapper<SysUser> {
 	/**
 	 * 查询用户的所有权限
 	 * @param userId  用户ID
+	 * @return
 	 */
 	List<String> queryAllPerms(@Param("userId") Long userId);
 	
 	/**
 	 * 根据用户id 批量删除用户
 	 * @param userIds
+	 * @param shopId
 	 */
 	void deleteBatch(@Param("userIds") Long[] userIds, @Param("shopId") Long shopId);
 	

yami-shop-sys/src/main/java/com/yami/shop/sys/dao/SysUserRoleMapper.java

@@ -18,11 +18,14 @@ import java.util.List;
 
 /**
  * 用户与角色对应关系
+ * @author lanhai
  */
 public interface SysUserRoleMapper  extends BaseMapper<SysUserRole> {
 	
 	/**
 	 * 根据角色ID数组，批量删除
+	 * @param roleIds
+	 * @return
 	 */
 	int deleteBatch(@Param("roleIds") Long[] roleIds);
 

yami-shop-sys/src/main/java/com/yami/shop/sys/dto/UpdatePasswordDto.java

@@ -15,7 +15,9 @@ import lombok.Data;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-
+/**
+ * @author lanhai
+ */
 @Data
 @Schema(description = "更新密码参数")
 public class UpdatePasswordDto {

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysConfig.java

@@ -18,6 +18,7 @@ import javax.validation.constraints.NotBlank;
 
 /**
  * 系统配置信息
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_config")

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysLog.java

@@ -12,7 +12,6 @@ package com.yami.shop.sys.model;
 
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
-import com.fasterxml.jackson.annotation.JsonFormat;
 import lombok.Data;
 
 import java.io.Serializable;
@@ -21,6 +20,7 @@ import java.util.Date;
 
 /**
  * 系统日志
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_log")

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysMenu.java

@@ -23,7 +23,7 @@ import java.util.List;
 
 /**
  * 菜单管理
- * 
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_menu")

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysRole.java

@@ -14,7 +14,6 @@ package com.yami.shop.sys.model;
 import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
-import com.fasterxml.jackson.annotation.JsonFormat;
 import lombok.Data;
 import org.springframework.format.annotation.DateTimeFormat;
 
@@ -25,6 +24,7 @@ import java.util.List;
 
 /**
  * 角色
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_role")

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysRoleMenu.java

@@ -19,7 +19,7 @@ import java.io.Serializable;
 
 /**
  * 角色与菜单对应关系
- * 
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_role_menu")

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysUser.java

@@ -28,6 +28,7 @@ import java.util.List;
 
 /**
  * 系统用户
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_user")

yami-shop-sys/src/main/java/com/yami/shop/sys/model/SysUserRole.java

@@ -19,6 +19,7 @@ import java.io.Serializable;
 
 /**
  * 用户与角色对应关系
+ * @author lanhai
  */
 @Data
 @TableName("tz_sys_user_role")

yami-shop-sys/src/main/java/com/yami/shop/sys/service/SysMenuService.java

@@ -11,11 +11,11 @@
 package com.yami.shop.sys.service;
 
 
-import java.util.List;
-
 import com.baomidou.mybatisplus.extension.service.IService;
 import com.yami.shop.sys.model.SysMenu;
 
+import java.util.List;
+
 
 /**
  * 菜单管理
@@ -62,5 +62,9 @@ public interface SysMenuService extends IService<SysMenu> {
 	 */
 	List<SysMenu> listChildrenMenuByParentId(Long parentId);
 
+	/**
+	 * 获取菜单和按钮列表
+	 * @return
+	 */
 	List<SysMenu> listMenuAndBtn();
 }

yami-shop-sys/src/main/java/com/yami/shop/sys/service/SysUserService.java

@@ -45,6 +45,7 @@ public interface SysUserService extends IService<SysUser> {
 	/**
 	 * 根据用户id 批量删除用户
 	 * @param userIds
+	 * @param shopId
 	 */
 	void deleteBatch(Long[] userIds,Long shopId);
 
@@ -65,6 +66,7 @@ public interface SysUserService extends IService<SysUser> {
 	/**
 	 * 查询用户的所有权限
 	 * @param userId  用户ID
+	 * @return
 	 */
 	List<String> queryAllPerms(Long userId);