!149 优化代码格式

Merge pull request !149 from AprilWind/feat/dev-docs
This commit is contained in:
疯狂的狮子Li
2024-01-19 09:51:36 +00:00
committed by Gitee
35 changed files with 332 additions and 30 deletions

View File

@@ -87,4 +87,5 @@ public class SysOssConfig extends BaseEntity {
* 桶权限类型(0private 1public 2custom)
*/
private String accessPolicy;
}

View File

@@ -19,7 +19,6 @@ import jakarta.validation.constraints.Size;
* @author 孤舟烟雨
* @date 2021-08-13
*/
@Data
@EqualsAndHashCode(callSuper = true)
@AutoMapper(target = SysOssConfig.class, reverseConvertGenerate = false)
@@ -107,5 +106,4 @@ public class SysOssConfigBo extends BaseEntity {
@NotBlank(message = "桶权限类型不能为空", groups = {AddGroup.class, EditGroup.class})
private String accessPolicy;
}

View File

@@ -10,4 +10,5 @@ import org.dromara.resource.domain.vo.SysOssVo;
* @author Lion Li
*/
public interface SysOssMapper extends BaseMapperPlus<SysOss, SysOssVo> {
}

View File

@@ -37,7 +37,7 @@ public interface ISysOssConfigService {
* 根据新增业务对象插入对象存储配置
*
* @param bo 对象存储配置新增业务对象
* @return
* @return 结果
*/
Boolean insertByBo(SysOssConfigBo bo);
@@ -45,7 +45,7 @@ public interface ISysOssConfigService {
* 根据编辑业务对象修改对象存储配置
*
* @param bo 对象存储配置编辑业务对象
* @return
* @return 结果
*/
Boolean updateByBo(SysOssConfigBo bo);
@@ -54,7 +54,7 @@ public interface ISysOssConfigService {
*
* @param ids 主键集合
* @param isValid 是否校验,true-删除前校验,false-不校验
* @return
* @return 结果
*/
Boolean deleteWithValidByIds(Collection<Long> ids, Boolean isValid);

View File

@@ -1,13 +1,12 @@
package org.dromara.resource.service;
import jakarta.servlet.http.HttpServletResponse;
import org.dromara.common.mybatis.core.page.PageQuery;
import org.dromara.common.mybatis.core.page.TableDataInfo;
import org.dromara.resource.domain.bo.SysOssBo;
import org.dromara.resource.domain.vo.SysOssVo;
import org.springframework.web.multipart.MultipartFile;
import jakarta.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
@@ -20,21 +19,77 @@ import java.util.List;
*/
public interface ISysOssService {
/**
* 查询OSS对象存储列表
*
* @param sysOss OSS对象存储分页查询对象
* @param pageQuery 分页查询实体类
* @return 结果
*/
TableDataInfo<SysOssVo> queryPageList(SysOssBo sysOss, PageQuery pageQuery);
/**
* 根据一组 ossIds 获取对应的 SysOssVo 列表
*
* @param ossIds 一组文件在数据库中的唯一标识集合
* @return 包含 SysOssVo 对象的列表
*/
List<SysOssVo> listByIds(Collection<Long> ossIds);
/**
* 根据一组 ossIds 获取对应文件的 URL 列表
*
* @param ossIds 以逗号分隔的 ossId 字符串
* @return 以逗号分隔的文件 URL 字符串
*/
String selectUrlByIds(String ossIds);
/**
* 根据 ossId 从缓存或数据库中获取 SysOssVo 对象
*
* @param ossId 文件在数据库中的唯一标识
* @return SysOssVo 对象,包含文件信息
*/
SysOssVo getById(Long ossId);
/**
* 上传 MultipartFile 到对象存储服务,并保存文件信息到数据库
*
* @param file 要上传的 MultipartFile 对象
* @return 上传成功后的 SysOssVo 对象,包含文件信息
*/
SysOssVo upload(MultipartFile file);
/**
* 上传文件到对象存储服务,并保存文件信息到数据库
*
* @param file 要上传的文件对象
* @return 上传成功后的 SysOssVo 对象,包含文件信息
*/
SysOssVo upload(File file);
/**
* 新增OSS对象存储
*
* @param bo SysOssBo 对象,包含待插入的数据
* @return 插入操作是否成功的布尔值
*/
Boolean insertByBo(SysOssBo bo);
/**
* 文件下载方法,支持一次性下载完整文件
*
* @param ossId OSS对象ID
* @param response HttpServletResponse对象用于设置响应头和向客户端发送文件内容
*/
void download(Long ossId, HttpServletResponse response) throws IOException;
/**
* 删除OSS对象存储
*
* @param ids OSS对象ID串
* @param isValid 判断是否需要校验
* @return 结果
*/
Boolean deleteWithValidByIds(Collection<Long> ids, Boolean isValid);
}

View File

@@ -51,6 +51,13 @@ public class SysOssServiceImpl implements ISysOssService {
private final SysOssMapper baseMapper;
/**
* 查询OSS对象存储列表
*
* @param bo OSS对象存储分页查询对象
* @param pageQuery 分页查询实体类
* @return 结果
*/
@Override
public TableDataInfo<SysOssVo> queryPageList(SysOssBo bo, PageQuery pageQuery) {
LambdaQueryWrapper<SysOss> lqw = buildQueryWrapper(bo);
@@ -60,6 +67,12 @@ public class SysOssServiceImpl implements ISysOssService {
return TableDataInfo.build(result);
}
/**
* 根据一组 ossIds 获取对应的 SysOssVo 列表
*
* @param ossIds 一组文件在数据库中的唯一标识集合
* @return 包含 SysOssVo 对象的列表
*/
@Override
public List<SysOssVo> listByIds(Collection<Long> ossIds) {
List<SysOssVo> list = new ArrayList<>();
@@ -71,11 +84,18 @@ public class SysOssServiceImpl implements ISysOssService {
} catch (Exception ignored) {
// 如果oss异常无法连接则将数据直接返回
list.add(vo);
} }
}
}
}
return list;
}
/**
* 根据一组 ossIds 获取对应文件的 URL 列表
*
* @param ossIds 以逗号分隔的 ossId 字符串
* @return 以逗号分隔的文件 URL 字符串
*/
@Override
public String selectUrlByIds(String ossIds) {
List<String> list = new ArrayList<>();
@@ -108,12 +128,24 @@ public class SysOssServiceImpl implements ISysOssService {
return lqw;
}
/**
* 根据 ossId 从缓存或数据库中获取 SysOssVo 对象
*
* @param ossId 文件在数据库中的唯一标识
* @return SysOssVo 对象,包含文件信息
*/
@Cacheable(cacheNames = CacheNames.SYS_OSS, key = "#ossId")
@Override
public SysOssVo getById(Long ossId) {
return baseMapper.selectVoById(ossId);
}
/**
* 文件下载方法,支持一次性下载完整文件
*
* @param ossId OSS对象ID
* @param response HttpServletResponse对象用于设置响应头和向客户端发送文件内容
*/
@Override
public void download(Long ossId, HttpServletResponse response) throws IOException {
SysOssVo sysOss = SpringUtils.getAopProxy(this).getById(ossId);
@@ -123,7 +155,7 @@ public class SysOssServiceImpl implements ISysOssService {
FileUtils.setAttachmentResponseHeader(response, sysOss.getOriginalName());
response.setContentType(MediaType.APPLICATION_OCTET_STREAM_VALUE + "; charset=UTF-8");
OssClient storage = OssFactory.instance(sysOss.getService());
try(InputStream inputStream = storage.getObjectContent(sysOss.getUrl())) {
try (InputStream inputStream = storage.getObjectContent(sysOss.getUrl())) {
int available = inputStream.available();
IoUtil.copy(inputStream, response.getOutputStream(), available);
response.setContentLength(available);
@@ -132,6 +164,13 @@ public class SysOssServiceImpl implements ISysOssService {
}
}
/**
* 上传 MultipartFile 到对象存储服务,并保存文件信息到数据库
*
* @param file 要上传的 MultipartFile 对象
* @return 上传成功后的 SysOssVo 对象,包含文件信息
* @throws ServiceException 如果上传过程中发生异常,则抛出 ServiceException 异常
*/
@Override
public SysOssVo upload(MultipartFile file) {
String originalfileName = file.getOriginalFilename();
@@ -147,6 +186,12 @@ public class SysOssServiceImpl implements ISysOssService {
return buildResultEntity(originalfileName, suffix, storage.getConfigKey(), uploadResult);
}
/**
* 上传文件到对象存储服务,并保存文件信息到数据库
*
* @param file 要上传的文件对象
* @return 上传成功后的 SysOssVo 对象,包含文件信息
*/
@Override
public SysOssVo upload(File file) {
String originalfileName = file.getName();
@@ -169,6 +214,12 @@ public class SysOssServiceImpl implements ISysOssService {
return this.matchingUrl(sysOssVo);
}
/**
* 新增OSS对象存储
*
* @param bo SysOssBo 对象,包含待插入的数据
* @return 插入操作是否成功的布尔值
*/
@Override
public Boolean insertByBo(SysOssBo bo) {
SysOss oss = BeanUtil.toBean(bo, SysOss.class);
@@ -179,6 +230,13 @@ public class SysOssServiceImpl implements ISysOssService {
return flag;
}
/**
* 删除OSS对象存储
*
* @param ids OSS对象ID串
* @param isValid 判断是否需要校验
* @return 结果
*/
@Override
public Boolean deleteWithValidByIds(Collection<Long> ids, Boolean isValid) {
if (isValid) {
@@ -193,7 +251,7 @@ public class SysOssServiceImpl implements ISysOssService {
}
/**
* 匹配Url
* 桶类型为 private 的URL 修改为临时URL时长为120s
*
* @param oss OSS对象
* @return oss 匹配Url的OSS对象

View File

@@ -148,16 +148,50 @@ public class RemoteUserServiceImpl implements RemoteUserService {
return userService.registerUser(sysUserBo, remoteUserBo.getTenantId());
}
/**
* 通过用户ID查询用户账户
*
* @param userId 用户ID
* @return 用户账户
*/
@Override
public String selectUserNameById(Long userId) {
return userService.selectUserNameById(userId);
}
/**
* 通过用户ID查询用户昵称
*
* @param userId 用户ID
* @return 用户昵称
*/
@Override
public String selectNicknameById(Long userId) {
return userService.selectNicknameById(userId);
}
/**
* 通过用户ID查询用户手机号
*
* @param userId 用户id
* @return 用户手机号
*/
@Override
public String selectPhonenumberById(Long userId) {
return userService.selectPhonenumberById(userId);
}
/**
* 通过用户ID查询用户邮箱
*
* @param userId 用户id
* @return 用户邮箱
*/
@Override
public String selectEmailById(Long userId) {
return userService.selectEmailById(userId);
}
/**
* 构建登录用户
*/

View File

@@ -219,11 +219,27 @@ public interface ISysUserService {
*/
String selectNicknameById(Long userId);
/**
* 通过用户ID查询用户手机号
*
* @param userId 用户id
* @return 用户手机号
*/
String selectPhonenumberById(Long userId);
/**
* 通过用户ID查询用户邮箱
*
* @param userId 用户id
* @return 用户邮箱
*/
String selectEmailById(Long userId);
/**
* 通过部门id查询当前部门所有用户
*
* @param deptId
* @return
* @param deptId 部门id
* @return 结果
*/
List<SysUserVo> selectUserListByDept(Long deptId);

View File

@@ -94,7 +94,7 @@ public class SysClientServiceImpl implements ISysClientService {
SysClient add = MapstructUtils.convert(bo, SysClient.class);
validEntityBeforeSave(add);
add.setGrantType(String.join(",", bo.getGrantTypeList()));
// 生成clientid
// 生成clientId
String clientKey = bo.getClientKey();
String clientSecret = bo.getClientSecret();
add.setClientId(SecureUtil.md5(clientKey + clientSecret));

View File

@@ -523,8 +523,8 @@ public class SysUserServiceImpl implements ISysUserService {
/**
* 通过部门id查询当前部门所有用户
*
* @param deptId
* @return
* @param deptId 部门ID
* @return 用户信息集合信息
*/
@Override
public List<SysUserVo> selectUserListByDept(Long deptId) {
@@ -534,6 +534,12 @@ public class SysUserServiceImpl implements ISysUserService {
return baseMapper.selectVoList(lqw);
}
/**
* 通过用户ID查询用户账户
*
* @param userId 用户ID
* @return 用户账户
*/
@Cacheable(cacheNames = CacheNames.SYS_USER_NAME, key = "#userId")
@Override
public String selectUserNameById(Long userId) {
@@ -542,6 +548,12 @@ public class SysUserServiceImpl implements ISysUserService {
return ObjectUtil.isNull(sysUser) ? null : sysUser.getUserName();
}
/**
* 通过用户ID查询用户昵称
*
* @param userId 用户ID
* @return 用户昵称
*/
@Override
@Cacheable(cacheNames = CacheNames.SYS_NICKNAME, key = "#userId")
public String selectNicknameById(Long userId) {
@@ -550,4 +562,30 @@ public class SysUserServiceImpl implements ISysUserService {
return ObjectUtil.isNull(sysUser) ? null : sysUser.getNickName();
}
/**
* 通过用户ID查询用户手机号
*
* @param userId 用户id
* @return 用户手机号
*/
@Override
public String selectPhonenumberById(Long userId) {
SysUser sysUser = baseMapper.selectOne(new LambdaQueryWrapper<SysUser>()
.select(SysUser::getPhonenumber).eq(SysUser::getUserId, userId));
return ObjectUtil.isNull(sysUser) ? null : sysUser.getPhonenumber();
}
/**
* 通过用户ID查询用户邮箱
*
* @param userId 用户id
* @return 用户邮箱
*/
@Override
public String selectEmailById(Long userId) {
SysUser sysUser = baseMapper.selectOne(new LambdaQueryWrapper<SysUser>()
.select(SysUser::getEmail).eq(SysUser::getUserId, userId));
return ObjectUtil.isNull(sysUser) ? null : sysUser.getEmail();
}
}