🎨 改进结构和代码格式，缓存常量配置 #32、删除无用引入

2019-04-28 16:54:22 +08:00
1 parent d85e7e721e
commit bd2984164f
@@ -0,0 +1,37 @@
+package com.pig4cloud.pigx.common.core.constant;
+
+/**
+ * @author lengleng
+ * @date 2019-04-28
+ * <p>
+ * 缓存的key 常量
+ */
+public interface CacheConstants {
+
+	/**
+	 * 用户信息缓存
+	 */
+	String USER_DETAILS = "user_details";
+
+
+	/**
+	 * oauth 客户端信息
+	 */
+	String CLIENT_DETAILS_KEY = "pigx_oauth:client:details";
+
+	/**
+	 * 菜单信息缓存
+	 */
+	String MENU_DETAILS = "menu_details";
+
+	/**
+	 * spring boot admin 事件key
+	 */
+	String EVENT_KEY = "event_key";
+
+	/**
+	 * 路由存放
+	 */
+	String ROUTE_KEY = "gateway_route_key";
+
+}
@@ -62,16 +62,6 @@ public interface CommonConstants {
 	 */
 	String BACK_END_PROJECT = "pigx";

-	/**
-	 * 路由存放
-	 */
-	String ROUTE_KEY = "gateway_route_key";
-
-	/**
-	 * spring boot admin 事件key
-	 */
-	String EVENT_KEY = "event_key";
-
 	/**
 	 * 验证码前缀
 	 */
@@ -82,10 +82,6 @@ public interface SecurityConstants {
 	 * 自定义登录URL
 	 */
 	String MOBILE_TOKEN_URL = "/mobile/token/*";
-	/**
-	 * oauth 客户端信息
-	 */
-	String CLIENT_DETAILS_KEY = "pigx_oauth:client:details";

 	/**
 	 * 微信获取OPENID
@@ -17,7 +17,7 @@

 package com.pig4cloud.pigx.common.gateway.support;

-import com.pig4cloud.pigx.common.core.constant.CommonConstants;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.gateway.vo.RouteDefinitionVo;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
@@ -53,7 +53,7 @@ public class RedisRouteDefinitionWriter implements RouteDefinitionRepository {
 			BeanUtils.copyProperties(r, vo);
 			log.info("保存路由信息{}", vo);
 			redisTemplate.setKeySerializer(new StringRedisSerializer());
-			redisTemplate.opsForHash().put(CommonConstants.ROUTE_KEY, r.getId(), vo);
+			redisTemplate.opsForHash().put(CacheConstants.ROUTE_KEY, r.getId(), vo);
 			return Mono.empty();
 		});
 	}
@@ -63,7 +63,7 @@ public class RedisRouteDefinitionWriter implements RouteDefinitionRepository {
 		routeId.subscribe(id -> {
 			log.info("删除路由信息{}", id);
 			redisTemplate.setKeySerializer(new StringRedisSerializer());
-			redisTemplate.opsForHash().delete(CommonConstants.ROUTE_KEY, id);
+			redisTemplate.opsForHash().delete(CacheConstants.ROUTE_KEY, id);
 		});
 		return Mono.empty();
 	}
@@ -78,7 +78,7 @@ public class RedisRouteDefinitionWriter implements RouteDefinitionRepository {
 	public Flux<RouteDefinition> getRouteDefinitions() {
 		redisTemplate.setKeySerializer(new StringRedisSerializer());
 		redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(RouteDefinitionVo.class));
-		List<RouteDefinitionVo> values = redisTemplate.opsForHash().values(CommonConstants.ROUTE_KEY);
+		List<RouteDefinitionVo> values = redisTemplate.opsForHash().values(CacheConstants.ROUTE_KEY);
 		List<RouteDefinition> definitionList = new ArrayList<>();
 		values.forEach(vo -> {
 			RouteDefinition routeDefinition = new RouteDefinition();
@@ -17,7 +17,7 @@

 package com.pig4cloud.pigx.common.security.service;

-import com.pig4cloud.pigx.common.core.constant.SecurityConstants;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import org.springframework.cache.annotation.Cacheable;
 import org.springframework.security.oauth2.common.exceptions.InvalidClientException;
 import org.springframework.security.oauth2.provider.ClientDetails;
@@ -45,7 +45,7 @@ public class PigxClientDetailsService extends JdbcClientDetailsService {
 	 * @throws InvalidClientException
 	 */
 	@Override
-	@Cacheable(value = SecurityConstants.CLIENT_DETAILS_KEY, key = "#clientId", unless = "#result == null")
+	@Cacheable(value = CacheConstants.CLIENT_DETAILS_KEY, key = "#clientId", unless = "#result == null")
 	public ClientDetails loadClientByClientId(String clientId) {
 		return super.loadClientByClientId(clientId);
 	}
@@ -22,6 +22,7 @@ import cn.hutool.core.util.StrUtil;
 import com.pig4cloud.pigx.admin.api.dto.UserInfo;
 import com.pig4cloud.pigx.admin.api.entity.SysUser;
 import com.pig4cloud.pigx.admin.api.feign.RemoteUserService;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.core.constant.CommonConstants;
 import com.pig4cloud.pigx.common.core.constant.SecurityConstants;
 import com.pig4cloud.pigx.common.core.util.R;
@@ -63,7 +64,7 @@ public class PigxUserDetailsServiceImpl implements PigxUserDetailsService {
 	@Override
 	@SneakyThrows
 	public UserDetails loadUserByUsername(String username) {
-		Cache cache = cacheManager.getCache("user_details");
+		Cache cache = cacheManager.getCache(CacheConstants.USER_DETAILS);
 		if (cache != null && cache.get(username) != null) {
 			return (PigxUser) cache.get(username).get();
 		}
@@ -20,7 +20,7 @@ package com.pig4cloud.pigx.admin.config;
 import cn.hutool.json.JSONArray;
 import cn.hutool.json.JSONUtil;
 import com.pig4cloud.pigx.admin.service.SysRouteConfService;
-import com.pig4cloud.pigx.common.core.constant.CommonConstants;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.gateway.support.DynamicRouteInitEvent;
 import com.pig4cloud.pigx.common.gateway.vo.RouteDefinitionVo;
 import lombok.AllArgsConstructor;
@@ -57,7 +57,7 @@ public class DynamicRouteInitRunner {
 	@Order
 	@EventListener({WebServerInitializedEvent.class, DynamicRouteInitEvent.class})
 	public void initRoute() {
-		Boolean result = pigxRedisTemplate.delete(CommonConstants.ROUTE_KEY);
+		Boolean result = pigxRedisTemplate.delete(CacheConstants.ROUTE_KEY);
 		log.info("初始化网关路由 {} ", result);

 		routeConfService.routes().forEach(route -> {
@@ -74,7 +74,7 @@ public class DynamicRouteInitRunner {

 			log.info("加载路由ID：{},{}", route.getRouteId(), vo);
 			pigxRedisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(RouteDefinitionVo.class));
-			pigxRedisTemplate.opsForHash().put(CommonConstants.ROUTE_KEY, route.getRouteId(), vo);
+			pigxRedisTemplate.opsForHash().put(CacheConstants.ROUTE_KEY, route.getRouteId(), vo);
 		});
 		log.debug("初始化网关路由结束 ");
 	}
@@ -31,7 +31,6 @@ import com.pig4cloud.pigx.common.core.constant.enums.LoginTypeEnum;
 import lombok.AllArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
-import org.springframework.web.client.RestTemplate;

 /**
 * @author lengleng
@@ -28,6 +28,7 @@ import com.pig4cloud.pigx.admin.api.vo.MenuVO;
 import com.pig4cloud.pigx.admin.mapper.SysMenuMapper;
 import com.pig4cloud.pigx.admin.mapper.SysRoleMenuMapper;
 import com.pig4cloud.pigx.admin.service.SysMenuService;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.core.constant.CommonConstants;
 import com.pig4cloud.pigx.common.core.util.R;
 import lombok.AllArgsConstructor;
@@ -52,14 +53,14 @@ public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> impl
 	private final SysRoleMenuMapper sysRoleMenuMapper;

 	@Override
-	@Cacheable(value = "menu_details", key = "#roleId  + '_menu'")
+	@Cacheable(value = CacheConstants.MENU_DETAILS, key = "#roleId  + '_menu'")
 	public List<MenuVO> findMenuByRoleId(Integer roleId) {
 		return baseMapper.listMenusByRoleId(roleId);
 	}

 	@Override
 	@Transactional(rollbackFor = Exception.class)
-	@CacheEvict(value = "menu_details", allEntries = true)
+	@CacheEvict(value = CacheConstants.MENU_DETAILS, allEntries = true)
 	public R removeMenuById(Integer id) {
 		// 查询父节点为当前节点的节点
 		List<SysMenu> menuList = this.list(Wrappers.<SysMenu>query()
@@ -79,7 +80,7 @@ public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> impl
 	}

 	@Override
-	@CacheEvict(value = "menu_details", allEntries = true)
+	@CacheEvict(value = CacheConstants.MENU_DETAILS, allEntries = true)
 	public Boolean updateMenuById(SysMenu sysMenu) {
 		return this.updateById(sysMenu);
 	}
@@ -23,7 +23,7 @@ import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
 import com.pig4cloud.pigx.admin.api.entity.SysOauthClientDetails;
 import com.pig4cloud.pigx.admin.mapper.SysOauthClientDetailsMapper;
 import com.pig4cloud.pigx.admin.service.SysOauthClientDetailsService;
-import com.pig4cloud.pigx.common.core.constant.SecurityConstants;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import org.springframework.cache.annotation.CacheEvict;
 import org.springframework.stereotype.Service;

@@ -45,7 +45,7 @@ public class SysOauthClientDetailsServiceImpl extends ServiceImpl<SysOauthClient
 	 * @return
 	 */
 	@Override
-	@CacheEvict(value = SecurityConstants.CLIENT_DETAILS_KEY, key = "#id")
+	@CacheEvict(value = CacheConstants.CLIENT_DETAILS_KEY, key = "#id")
 	public Boolean removeClientDetailsById(String id) {
 		return this.removeById(id);
 	}
@@ -57,7 +57,7 @@ public class SysOauthClientDetailsServiceImpl extends ServiceImpl<SysOauthClient
 	 * @return
 	 */
 	@Override
-	@CacheEvict(value = SecurityConstants.CLIENT_DETAILS_KEY, key = "#clientDetails.clientId")
+	@CacheEvict(value = CacheConstants.CLIENT_DETAILS_KEY, key = "#clientDetails.clientId")
 	public Boolean updateClientDetailsById(SysOauthClientDetails clientDetails) {
 		return this.updateById(clientDetails);
 	}
@@ -25,6 +25,7 @@ import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
 import com.pig4cloud.pigx.admin.api.entity.SysRoleMenu;
 import com.pig4cloud.pigx.admin.mapper.SysRoleMenuMapper;
 import com.pig4cloud.pigx.admin.service.SysRoleMenuService;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import lombok.AllArgsConstructor;
 import org.springframework.cache.CacheManager;
 import org.springframework.cache.annotation.CacheEvict;
@@ -56,25 +57,25 @@ public class SysRoleMenuServiceImpl extends ServiceImpl<SysRoleMenuMapper, SysRo
 	 */
 	@Override
 	@Transactional(rollbackFor = Exception.class)
-	@CacheEvict(value = "menu_details", key = "#roleId + '_menu'")
+	@CacheEvict(value = CacheConstants.CLIENT_DETAILS_KEY, key = "#roleId + '_menu'")
 	public Boolean saveRoleMenus(String role, Integer roleId, String menuIds) {
 		this.remove(Wrappers.<SysRoleMenu>query().lambda()
-			.eq(SysRoleMenu::getRoleId, roleId));
+				.eq(SysRoleMenu::getRoleId, roleId));

 		if (StrUtil.isBlank(menuIds)) {
 			return Boolean.TRUE;
 		}
 		List<SysRoleMenu> roleMenuList = Arrays
-			.stream(menuIds.split(","))
-			.map(menuId -> {
-				SysRoleMenu roleMenu = new SysRoleMenu();
-				roleMenu.setRoleId(roleId);
-				roleMenu.setMenuId(Integer.valueOf(menuId));
-				return roleMenu;
-			}).collect(Collectors.toList());
+				.stream(menuIds.split(","))
+				.map(menuId -> {
+					SysRoleMenu roleMenu = new SysRoleMenu();
+					roleMenu.setRoleId(roleId);
+					roleMenu.setMenuId(Integer.valueOf(menuId));
+					return roleMenu;
+				}).collect(Collectors.toList());

 		//清空userinfo
-		cacheManager.getCache("user_details").clear();
+		cacheManager.getCache(CacheConstants.USER_DETAILS).clear();
 		return this.saveBatch(roleMenuList);
 	}
 }
@@ -26,6 +26,7 @@ import com.pig4cloud.pigx.admin.api.entity.SysRoleMenu;
 import com.pig4cloud.pigx.admin.mapper.SysRoleMapper;
 import com.pig4cloud.pigx.admin.mapper.SysRoleMenuMapper;
 import com.pig4cloud.pigx.admin.service.SysRoleService;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import lombok.AllArgsConstructor;
 import org.springframework.cache.annotation.CacheEvict;
 import org.springframework.stereotype.Service;
@@ -64,7 +65,7 @@ public class SysRoleServiceImpl extends ServiceImpl<SysRoleMapper, SysRole> impl
 	 * @return
 	 */
 	@Override
-	@CacheEvict(value = "menu_details", allEntries = true)
+	@CacheEvict(value = CacheConstants.CLIENT_DETAILS_KEY, allEntries = true)
 	@Transactional(rollbackFor = Exception.class)
 	public Boolean removeRoleById(Integer id) {
 		sysRoleMenuMapper.delete(Wrappers
@@ -25,6 +25,7 @@ import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
 import com.pig4cloud.pigx.admin.api.entity.SysRouteConf;
 import com.pig4cloud.pigx.admin.mapper.SysRouteConfMapper;
 import com.pig4cloud.pigx.admin.service.SysRouteConfService;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.core.constant.CommonConstants;
 import com.pig4cloud.pigx.common.gateway.support.DynamicRouteInitEvent;
 import com.pig4cloud.pigx.common.gateway.vo.RouteDefinitionVo;
@@ -83,7 +84,7 @@ public class SysRouteConfServiceImpl extends ServiceImpl<SysRouteConfMapper, Sys
 	@Transactional(rollbackFor = Exception.class)
 	public Mono<Void> updateRoutes(JSONArray routes) {
 		// 清空Redis 缓存
-		Boolean result = pigxRedisTemplate.delete(CommonConstants.ROUTE_KEY);
+		Boolean result = pigxRedisTemplate.delete(CacheConstants.ROUTE_KEY);
 		log.info("清空网关路由 {} ", result);

 		// 遍历修改的routes，保存到Redis
@@ -131,7 +132,7 @@ public class SysRouteConfServiceImpl extends ServiceImpl<SysRouteConfMapper, Sys
 					vo.setOrder(Integer.parseInt(String.valueOf(order)));
 				}
 				pigxRedisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(RouteDefinitionVo.class));
-				pigxRedisTemplate.opsForHash().put(CommonConstants.ROUTE_KEY, vo.getId(), vo);
+				pigxRedisTemplate.opsForHash().put(CacheConstants.ROUTE_KEY, vo.getId(), vo);
 				routeDefinitionVoList.add(vo);
 			});

@@ -26,6 +26,7 @@ import com.pig4cloud.pigx.admin.handler.LoginHandler;
 import com.pig4cloud.pigx.admin.mapper.SysSocialDetailsMapper;
 import com.pig4cloud.pigx.admin.mapper.SysUserMapper;
 import com.pig4cloud.pigx.admin.service.SysSocialDetailsService;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.core.constant.enums.LoginTypeEnum;
 import com.pig4cloud.pigx.common.security.util.SecurityUtils;
 import lombok.AllArgsConstructor;
@@ -69,7 +70,7 @@ public class SysSocialDetailsServiceImpl extends ServiceImpl<SysSocialDetailsMap
 		}
 		sysUserMapper.updateById(sysUser);
 		//更新緩存
-		cacheManager.getCache("user_details").evict(sysUser.getUsername());
+		cacheManager.getCache(CacheConstants.USER_DETAILS).evict(sysUser.getUsername());
 		return Boolean.TRUE;
 	}

@@ -32,6 +32,7 @@ import com.pig4cloud.pigx.admin.api.vo.MenuVO;
 import com.pig4cloud.pigx.admin.api.vo.UserVO;
 import com.pig4cloud.pigx.admin.mapper.SysUserMapper;
 import com.pig4cloud.pigx.admin.service.*;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import com.pig4cloud.pigx.common.core.constant.CommonConstants;
 import com.pig4cloud.pigx.common.core.util.R;
 import com.pig4cloud.pigx.common.data.datascope.DataScope;
@@ -152,7 +153,7 @@ public class SysUserServiceImpl extends ServiceImpl<SysUserMapper, SysUser> impl
 	 * @return Boolean
 	 */
 	@Override
-	@CacheEvict(value = "user_details", key = "#sysUser.username")
+	@CacheEvict(value = CacheConstants.USER_DETAILS, key = "#sysUser.username")
 	public Boolean deleteUserById(SysUser sysUser) {
 		sysUserRoleService.deleteByUserId(sysUser.getUserId());
 		this.removeById(sysUser.getUserId());
@@ -160,7 +161,7 @@ public class SysUserServiceImpl extends ServiceImpl<SysUserMapper, SysUser> impl
 	}

 	@Override
-	@CacheEvict(value = "user_details", key = "#userDto.username")
+	@CacheEvict(value = CacheConstants.USER_DETAILS, key = "#userDto.username")
 	public R<Boolean> updateUserInfo(UserDTO userDto) {
 		UserVO userVO = baseMapper.getUserVoByUsername(userDto.getUsername());
 		SysUser sysUser = new SysUser();
@@ -180,7 +181,7 @@ public class SysUserServiceImpl extends ServiceImpl<SysUserMapper, SysUser> impl
 	}

 	@Override
-	@CacheEvict(value = "user_details", key = "#userDto.username")
+	@CacheEvict(value = CacheConstants.USER_DETAILS, key = "#userDto.username")
 	public Boolean updateUser(UserDTO userDto) {
 		SysUser sysUser = new SysUser();
 		BeanUtils.copyProperties(userDto, sysUser);
@@ -18,7 +18,7 @@
 package com.pig4cloud.pigx.monitor.support;

 import cn.hutool.core.util.StrUtil;
-import com.pig4cloud.pigx.common.core.constant.CommonConstants;
+import com.pig4cloud.pigx.common.core.constant.CacheConstants;
 import de.codecentric.boot.admin.server.domain.events.InstanceEvent;
 import de.codecentric.boot.admin.server.eventstore.InMemoryEventStore;
 import lombok.AllArgsConstructor;
@@ -51,7 +51,7 @@ public class RedisEventStore extends InMemoryEventStore {
 			log.info("保存实例事件的KEY：{},EVENT: {}", key, event.getType());
 			redisTemplate.setKeySerializer(new StringRedisSerializer());
 			redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(InstanceEvent.class));
-			redisTemplate.opsForHash().put(CommonConstants.EVENT_KEY, key, event);
+			redisTemplate.opsForHash().put(CacheConstants.EVENT_KEY, key, event);
 		});
 		return super.append(events);
 	}
@@ -18,7 +18,6 @@ package com.pig4cloud.pigx.mp.entity;

 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableLogic;
-import com.baomidou.mybatisplus.annotation.TableName;
 import com.baomidou.mybatisplus.extension.activerecord.Model;
 import lombok.Data;
 import lombok.EqualsAndHashCode;