docs 补充缺少的@Override和注释

This commit is contained in:
AprilWind
2024-07-02 10:26:10 +08:00
parent 5627f6ae0d
commit 2105c4a637
12 changed files with 163 additions and 22 deletions

View File

@@ -20,6 +20,7 @@ public class RemoteFileServiceMock implements RemoteFileService {
* @param file 文件信息
* @return 结果
*/
@Override
public RemoteFile upload(String name, String originalFilename, String contentType, byte[] file) {
log.warn("服务调用异常 -> 降级处理");
return null;
@@ -31,11 +32,18 @@ public class RemoteFileServiceMock implements RemoteFileService {
* @param ossIds ossId串逗号分隔
* @return url串逗号分隔
*/
@Override
public String selectUrlByIds(String ossIds) {
log.warn("服务调用异常 -> 降级处理");
return StringUtils.EMPTY;
}
/**
* 通过ossId查询列表
*
* @param ossIds ossId串逗号分隔
* @return 列表
*/
@Override
public List<RemoteFile> selectByIds(String ossIds) {
log.warn("服务调用异常 -> 降级处理");

View File

@@ -15,5 +15,10 @@ public interface RemoteMessageService {
*/
void publishMessage(Long sessionKey, String message);
/**
* 发布订阅的消息(群发)
*
* @param message 消息内容
*/
void publishAll(String message);
}

View File

@@ -20,6 +20,7 @@ public class RemoteMessageServiceStub implements RemoteMessageService {
* @param sessionKey session主键 一般为用户id
* @param message 消息文本
*/
@Override
public void publishMessage(Long sessionKey, String message) {
try {
remoteMessageService.publishMessage(sessionKey, message);
@@ -28,6 +29,12 @@ public class RemoteMessageServiceStub implements RemoteMessageService {
}
}
/**
* 发布订阅的消息(群发)
*
* @param message 消息内容
*/
@Override
public void publishAll(String message) {
try {
remoteMessageService.publishAll(message);

View File

@@ -81,6 +81,7 @@ public class RemoteFileServiceImpl implements RemoteFileService {
* @param ossIds ossId串逗号分隔
* @return 列表
*/
@Override
public List<RemoteFile> selectByIds(String ossIds){
List<SysOssVo> sysOssVos = sysOssService.listByIds(StringUtils.splitTo(ossIds, Convert::toLong));
return MapstructUtils.convert(sysOssVos, RemoteFile.class);

View File

@@ -26,6 +26,7 @@ public class RemoteMailServiceImpl implements RemoteMailService {
* @param subject 标题
* @param text 内容
*/
@Override
public void send(String to, String subject, String text) throws ServiceException {
MailUtils.sendText(to, subject, text);
}

View File

@@ -18,6 +18,12 @@ public class RemoteDeptServiceImpl implements RemoteDeptService {
private final ISysDeptService sysDeptService;
/**
* 通过部门ID查询部门名称
*
* @param deptIds 部门ID串逗号分隔
* @return 部门名称串逗号分隔
*/
@Override
public String selectDeptNameByIds(String deptIds) {
return sysDeptService.selectDeptNameByIds(deptIds);

View File

@@ -23,7 +23,12 @@ public class RemoteDictServiceImpl implements RemoteDictService {
private final ISysDictTypeService sysDictTypeService;
/**
* 根据字典类型查询字典数据
*
* @param dictType 字典类型
* @return 字典数据集合信息
*/
@Override
public List<RemoteDictDataVo> selectDictDataByType(String dictType) {
List<SysDictDataVo> list = sysDictTypeService.selectDictDataByType(dictType);

View File

@@ -26,6 +26,11 @@ public class RemoteLogServiceImpl implements RemoteLogService {
private final ISysOperLogService operLogService;
private final ISysLogininforService logininforService;
/**
* 保存系统日志
*
* @param remoteOperLogBo 日志实体
*/
@Async
@Override
public void saveLog(RemoteOperLogBo remoteOperLogBo) {
@@ -33,6 +38,11 @@ public class RemoteLogServiceImpl implements RemoteLogService {
operLogService.insertOperlog(sysOperLogBo);
}
/**
* 保存访问记录
*
* @param remoteLogininforBo 访问实体
*/
@Async
@Override
public void saveLogininfor(RemoteLogininforBo remoteLogininforBo) {

View File

@@ -26,7 +26,10 @@ public class RemoteSocialServiceImpl implements RemoteSocialService {
private final ISysSocialService sysSocialService;
/**
* 根据 authId 查询用户信息
* 根据 authId 查询用户授权信息
*
* @param authId 认证id
* @return 授权信息
*/
@Override
public List<RemoteSocialVo> selectByAuthId(String authId) {
@@ -34,6 +37,11 @@ public class RemoteSocialServiceImpl implements RemoteSocialService {
return MapstructUtils.convert(list, RemoteSocialVo.class);
}
/**
* 查询列表
*
* @param bo 社会化关系业务对象
*/
@Override
public List<RemoteSocialVo> queryList(RemoteSocialBo bo) {
SysSocialBo params = MapstructUtils.convert(bo, SysSocialBo.class);
@@ -43,6 +51,8 @@ public class RemoteSocialServiceImpl implements RemoteSocialService {
/**
* 保存社会化关系
*
* @param bo 社会化关系业务对象
*/
@Override
public void insertByBo(RemoteSocialBo bo) {
@@ -51,6 +61,8 @@ public class RemoteSocialServiceImpl implements RemoteSocialService {
/**
* 更新社会化关系
*
* @param bo 社会化关系业务对象
*/
@Override
public void updateByBo(RemoteSocialBo bo) {
@@ -59,6 +71,9 @@ public class RemoteSocialServiceImpl implements RemoteSocialService {
/**
* 删除社会化关系
*
* @param socialId 社会化关系ID
* @return 结果
*/
@Override
public Boolean deleteWithValidById(Long socialId) {

View File

@@ -46,6 +46,13 @@ public class RemoteUserServiceImpl implements RemoteUserService {
private final ISysDeptService deptService;
private final SysUserMapper userMapper;
/**
* 通过用户名查询用户信息
*
* @param username 用户名
* @param tenantId 租户id
* @return 结果
*/
@Override
public LoginUser getUserInfo(String username, String tenantId) throws UserException {
return TenantHelper.dynamic(tenantId, () -> {
@@ -62,6 +69,13 @@ public class RemoteUserServiceImpl implements RemoteUserService {
});
}
/**
* 通过用户id查询用户信息
*
* @param userId 用户id
* @param tenantId 租户id
* @return 结果
*/
@Override
public LoginUser getUserInfo(Long userId, String tenantId) throws UserException {
return TenantHelper.dynamic(tenantId, () -> {
@@ -78,6 +92,13 @@ public class RemoteUserServiceImpl implements RemoteUserService {
});
}
/**
* 通过手机号查询用户信息
*
* @param phonenumber 手机号
* @param tenantId 租户id
* @return 结果
*/
@Override
public LoginUser getUserInfoByPhonenumber(String phonenumber, String tenantId) throws UserException {
return TenantHelper.dynamic(tenantId, () -> {
@@ -94,6 +115,13 @@ public class RemoteUserServiceImpl implements RemoteUserService {
});
}
/**
* 通过邮箱查询用户信息
*
* @param email 邮箱
* @param tenantId 租户id
* @return 结果
*/
@Override
public LoginUser getUserInfoByEmail(String email, String tenantId) throws UserException {
return TenantHelper.dynamic(tenantId, () -> {
@@ -110,6 +138,12 @@ public class RemoteUserServiceImpl implements RemoteUserService {
});
}
/**
* 通过openid查询用户信息
*
* @param openid openid
* @return 结果
*/
@Override
public XcxLoginUser getUserInfoByOpenid(String openid) throws UserException {
// todo 自行实现 userService.selectUserByOpenid(openid);
@@ -131,6 +165,12 @@ public class RemoteUserServiceImpl implements RemoteUserService {
return loginUser;
}
/**
* 注册用户信息
*
* @param remoteUserBo 用户信息
* @return 结果
*/
@Override
public Boolean registerUserInfo(RemoteUserBo remoteUserBo) throws UserException, ServiceException {
SysUserBo sysUserBo = MapstructUtils.convert(remoteUserBo, SysUserBo.class);
@@ -246,12 +286,24 @@ public class RemoteUserServiceImpl implements RemoteUserService {
DataPermissionHelper.ignore(() -> userMapper.updateById(sysUser));
}
/**
* 通过用户ID查询用户列表
*
* @param userIds 用户ids
* @return 用户列表
*/
@Override
public List<RemoteUserVo> selectListByIds(List<Long> userIds) {
List<SysUserVo> sysUserVos = userService.selectUserByIds(userIds, null);
return MapstructUtils.convert(sysUserVos, RemoteUserVo.class);
}
/**
* 通过角色ID查询用户ID
*
* @param roleIds 角色ids
* @return 用户ids
*/
@Override
public List<Long> selectUserIdsByRoleIds(List<Long> roleIds) {
return userService.selectUserIdsByRoleIds(roleIds);

View File

@@ -12,45 +12,60 @@ import java.util.List;
*/
public interface ISysSocialService {
/**
* 查询社会化关系
* 根据ID查询社会化关系
*
* @param id 社会化关系的唯一标识符
* @return 返回与给定ID对应的SysSocialVo对象如果未找到则返回null
*/
SysSocialVo queryById(String id);
/**
* 查询社会化关系列表
*
* @param bo 用于过滤查询条件的SysSocialBo对象
* @return 返回符合条件的SysSocialVo对象列表
*/
List<SysSocialVo> queryList(SysSocialBo bo);
/**
* 查询社会化关系列表
* 根据用户ID查询社会化关系列表
*
* @param userId 用户的唯一标识符
* @return 返回与给定用户ID相关联的SysSocialVo对象列表
*/
List<SysSocialVo> queryListByUserId(Long userId);
/**
* 新增授权关系
*
* @param bo 包含新增授权关系信息的SysSocialBo对象
* @return 返回新增操作的结果成功返回true失败返回false
*/
Boolean insertByBo(SysSocialBo bo);
/**
* 更新社会化关系
*
* @param bo 包含更新信息的SysSocialBo对象
* @return 返回更新操作的结果成功返回true失败返回false
*/
Boolean updateByBo(SysSocialBo bo);
/**
* 删除社会化关系信息
*
* @param id 要删除的社会化关系的唯一标识符
* @return 返回删除操作的结果成功返回true失败返回false
*/
Boolean deleteWithValidById(Long id);
/**
* 根据 authId 查询 SysSocial 表和 SysUser 表,返回 SysSocialAuthResult 映射的对象
* 根据认证ID查询社会化关系和用户信息
*
* @param authId 认证ID
* @return SysSocial
* @return 返回包含SysSocial和用户信息的SysSocialVo对象列表
*/
List<SysSocialVo> selectByAuthId(String authId);
}

View File

@@ -26,9 +26,11 @@ public class SysSocialServiceImpl implements ISysSocialService {
private final SysSocialMapper baseMapper;
/**
* 查询社会化关系
* 根据ID查询社会化关系
*
* @param id 社会化关系的唯一标识符
* @return 返回与给定ID对应的SysSocialVo对象如果未找到则返回null
*/
@Override
public SysSocialVo queryById(String id) {
@@ -36,7 +38,10 @@ public class SysSocialServiceImpl implements ISysSocialService {
}
/**
* 授权列表
* 查询社会化关系列表
*
* @param bo 用于过滤查询条件的SysSocialBo对象
* @return 返回符合条件的SysSocialVo对象列表
*/
@Override
public List<SysSocialVo> queryList(SysSocialBo bo) {
@@ -47,14 +52,22 @@ public class SysSocialServiceImpl implements ISysSocialService {
return baseMapper.selectVoList(lqw);
}
/**
* 根据用户ID查询社会化关系列表
*
* @param userId 用户的唯一标识符
* @return 返回与给定用户ID相关联的SysSocialVo对象列表
*/
@Override
public List<SysSocialVo> queryListByUserId(Long userId) {
return baseMapper.selectVoList(new LambdaQueryWrapper<SysSocial>().eq(SysSocial::getUserId, userId));
}
/**
* 新增社会化关系
* 新增授权关系
*
* @param bo 包含新增授权关系信息的SysSocialBo对象
* @return 返回新增操作的结果成功返回true失败返回false
*/
@Override
public Boolean insertByBo(SysSocialBo bo) {
@@ -73,6 +86,9 @@ public class SysSocialServiceImpl implements ISysSocialService {
/**
* 更新社会化关系
*
* @param bo 包含更新信息的SysSocialBo对象
* @return 返回更新操作的结果成功返回true失败返回false
*/
@Override
public Boolean updateByBo(SysSocialBo bo) {
@@ -81,7 +97,6 @@ public class SysSocialServiceImpl implements ISysSocialService {
return baseMapper.updateById(update) > 0;
}
/**
* 保存前的数据校验
*/
@@ -89,21 +104,22 @@ public class SysSocialServiceImpl implements ISysSocialService {
//TODO 做一些数据校验,如唯一约束
}
/**
* 删除社会化关系
* 删除社会化关系信息
*
* @param id 要删除的社会化关系的唯一标识符
* @return 返回删除操作的结果成功返回true失败返回false
*/
@Override
public Boolean deleteWithValidById(Long id) {
return baseMapper.deleteById(id) > 0;
}
/**
* 根据 authId 查询用户信息
* 根据认证ID查询社会化关系和用户信息
*
* @param authId 认证id
* @return 授权信息
* @param authId 认证ID
* @return 返回包含SysSocial和用户信息的SysSocialVo对象列表
*/
@Override
public List<SysSocialVo> selectByAuthId(String authId) {