用户中心基础数据接口

获取用户相关信息和企业相关信息，在创建用户和创建企业的时候都会有相关的 MQ 事件发布，如果需要同步数据可以在接收到消息后调用接口获取详细的数据

依赖

xml

 <dependency>
     <groupId>com.leaderrun</groupId>
     <artifactId>business-upm-api</artifactId>
 </dependency>

API

所有接口中的 default 默认方法都只是用来清空缓存使用

用户相关接口有@CacheEvict表示这个接口有缓存，不过你不需要处理这些缓存过期，组件会自动处理缓存问题。更多内容可以查看UserApiService源码

java

public interface UserApiService {

  /**
   * 获取用户信息
   *
   * @param userId 用户主键
   * @return 用户详细信息，包含企业名称和代码
   */
  @Cacheable(key = "#p0")
  @GetMapping("/{userId}")
  UserDTO get(@PathVariable("userId") Long userId);

  /**
   * 获取用户系统下的菜单
   *
   * @param userId 用户主键
   * @return 用户拥有的系统菜单权限
   */
  @GetMapping("/{userId}/menu")
  List<UserMenuDTO> menu(@PathVariable("userId") Long userId);

  /**
   * 获取用户角色集合
   *
   * @param userId 用户集合
   * @return 用户系统角色集合
   */
  @GetMapping("/{userId}/authority")
  List<UserAuthorityDTO> userAuthority(@PathVariable("userId") Long userId);

  /**
   * 获取用户拥有的有效部门数据
   *
   * @param userId 用户主键
   * @return 用户所在部门数据
   */
  @GetMapping("/{userId}/dept")
  List<DeptDTO> userDept(@PathVariable("userId") Long userId);

  /**
   * 获取部门下的用户主键集合
   *
   * @param deptId 部门主键
   * @return 部门用户主键集合
   */
  @GetMapping("/dept/{deptId}")
  Set<Long> deptUserIds(@PathVariable("deptId") Long deptId);

  /**
   * 获取用户所在部门，部门中所有的数据
   *
   * <h1>该方法有缓存，以下场景需要清空缓存</h1>
   *
   * <pre>
   *     1. 部门数据变更时候需要清空
   *     2. 企业下所有用户的部门变更后需要清空
   * </pre>
   *
   * @param userId 用户主键
   * @return 用户所在部门，部门中所有的数据
   */
  @GetMapping("/{userId}/dept/users")
  @Cacheable(key = "'dept:users:' + #p0")
  Set<Long> deptUserId(@PathVariable("userId") Long userId);

  @CacheEvict(key = "#p0")
  default void clearUserCache(Long userId) {}

  @CacheEvict(key = "'dept:users:' + #p0")
  default void clearUserDept(Long userId) {}
}

企业信息相关

java

public interface EnterpriseApiService {

  /**
   * 获取企业详情数据
   *
   * <h1>该接口有缓存</h1>
   *
   * @param entId 企业主键
   * @return 企业详情数据
   */
  @GetMapping("/{entId}")
  @Cacheable(key = "#p0")
  EnterpriseDTO get(@PathVariable("entId") Long entId);

  /**
   * 通过企业代码获取企业数据
   *
   * @param entCode 企业代码
   * @return 企业数据
   */
  @GetMapping("/getByCode/{entCode}")
  EnterpriseDTO getByCode(@PathVariable("entCode") String entCode);

  @CacheEvict(key = "#p0")
  default void clearEntCache(Long entId) {}
}

MQ 事件

需要注意的是不管是用户或企业新增、删除、修改都只有一个事件，你可以收到事件后调用相关接口来获取，没有获取到则表示删除。在用户中心的设计中，不提供删除用户和企业功能，只有启用、禁用来标识

如果你有使用到带缓存的接口一定必须要配置以下 MQ 事件，它会帮你管理你的缓存

在spring.profiles.group中添加bizupm代码。如下：

yaml

spring:
  profiles:
    group:
      dev: base,rpc,bizupm
      test: base,rpc,bizupm
      prod: base,rpc,bizupm

用户信息相关事件
如果你要想接收到用户创建、删除、修改的消息只需要实现UserApiMessageService接口并且实现类能被Spring托管。然后再配置文件中新增
yaml
```
spring:
  cloud:
    stream:
      function:
        definition: user;deptClearUserCache
```
你可以使用leaderrun.bizupm.user-enabled=false来禁用来自MQ的消息。禁用后不会管理你的接口缓存
企业信息相关事件
实现EnterpriseMessageService接口既可以收到企业修改、新增、删除的事件。配置文件新增：
yaml
```
spring:
  cloud:
    stream:
      function:
        definition: ent
```
你可以使用leaderrun.bizupm.ent-enabled=false禁用MQ消息。禁用后不会管理你的接口缓存

用户中心基础数据接口 ​

依赖 ​

API ​

MQ 事件 ​

用户中心基础数据接口

依赖

API

MQ 事件