bonus
/
Bonus-Cloud
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

增加javaDoc注释

This commit is contained in:
weiweiw 2024-09-20 16:07:43 +08:00
parent c436674445
commit bb7a21a8c0
12 changed files with 120 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteConfigService.java
View File

@ -19,34 +19,36 @@ public interface RemoteConfigService {
* 根据条件获取参数配置列表
*
* @param config 参数的查询条件，如参数名称，参数键名，参数类型（系统内置 Y or N）,检索开始时间和结束时间
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 获取分页参数配置信息
*/
@PostMapping(value = "/config/list")
public TableDataInfo list(SysConfig config, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 根据参数编号获取详细信息
*
* @param configId 参数编号
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @param configId 参数编号(数据库表主键id 如1，2...)
* @return 获取参数信息
*/
@GetMapping(value = "/config/{configId}")
public AjaxResult getInfo(@PathVariable Long configId, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
public AjaxResult getInfo(@PathVariable("configId") Long configId, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 根据参数键名查询参数值
*
* @param configKey 参数键名
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 获取参数信息
*/
@GetMapping(value = "/config/configKey/{configKey}")
public AjaxResult getConfigKey(@PathVariable String configKey, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
public AjaxResult getConfigKey(@PathVariable("configKey") String configKey, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 新增参数配置
*
* @param config 参数属性
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 新增成功影响的行数或错误码和错误消息
*/
@PostMapping(value = "/config")
public AjaxResult add(@Validated @RequestBody SysConfig config, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -54,7 +56,8 @@ public interface RemoteConfigService {
/**
* 修改参数配置
* @param config 参数属性
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 修改成功影响的行数或错误码和错误消息
*/
@PutMapping
public AjaxResult edit(@Validated @RequestBody SysConfig config, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -62,8 +65,9 @@ public interface RemoteConfigService {
/**
* 删除参数配置
* @param configIds 参数编号
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或出错信息
*/
@DeleteMapping("/{configIds}")
public AjaxResult remove(@PathVariable Long[] configIds, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
public AjaxResult remove(@PathVariable("configIds") Long[] configIds, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
}

17
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteDeptService.java
View File

@ -15,10 +15,11 @@ import org.springframework.web.bind.annotation.*;
@FeignClient(contextId = "remoteDeptService", value = ServiceNameConstants.SYSTEM_SERVICE, fallbackFactory = RemoteDeptFallbackFactory.class)
public interface RemoteDeptService {
/**
* 根据部门id或上级部门id或部门名或状态（正常或停用）获取部门信息
* 根据部门id或上级部门id或部门名或状态（正常或停用）获取当前登录用户数据权限范围内的部门信息
*
* @param dept 部门的查询条件
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 满足条件的部门信息
*/
@GetMapping("/dept/list")
public AjaxResult list(SysDept dept, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -26,7 +27,8 @@ public interface RemoteDeptService {
/**
* 根据部门编号获取详细信息
* @param deptId 部门编号
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 部门信息
*/
@GetMapping("/dept/{deptId}")
public AjaxResult getInfo(@PathVariable Long deptId, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -34,7 +36,8 @@ public interface RemoteDeptService {
/**
* 新增部门
* @param dept 部门信息
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 新增成功影响的行数或错误码和错误消息
*/
@PostMapping("/dept")
public AjaxResult add(@Validated @RequestBody SysDept dept, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -42,13 +45,17 @@ public interface RemoteDeptService {
/**
* 修改部门
* @param dept 部门信息
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 修改成功影响的行数或错误码和错误消息
*/
@PutMapping("/dept")
public AjaxResult edit(@Validated @RequestBody SysDept dept, @RequestHeader(SecurityConstants.FROM_SOURCE)String source);
/**
* 删除部门
* @param deptId 部门编号
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或出错信息
*/
@DeleteMapping("/dept/{deptId}")
public AjaxResult remove(@PathVariable Long deptId, @RequestHeader(SecurityConstants.FROM_SOURCE)String source);

19
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteDictDataService.java
View File

@ -19,7 +19,8 @@ public interface RemoteDictDataService {
/**
* 根据字典标签或字典类型或状态查询字典数据列表
* @param dictData 字典数据的查询条件
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 满足结果的字典数据
*/
@GetMapping("/dict/data/list")
public TableDataInfo list(SysDictData dictData, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -27,15 +28,16 @@ public interface RemoteDictDataService {
/**
* 根据字典编码 查询字典数据详细
* @param dictCode 字典数据编码
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 字典数据
*/
@GetMapping(value = "/dict/data/{dictCode}")
public AjaxResult getInfo(@PathVariable Long dictCode, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 根据字典类型 查询正常状态的字典数据信息
* 根据字典类型查询正常状态的字典数据信息
* @param dictType 字典类型
* @return 结果
* @return 字典数据
*/
@GetMapping(value = "/dict/data/type/{dictType}")
public AjaxResult dictType(@PathVariable String dictType, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -43,7 +45,8 @@ public interface RemoteDictDataService {
/**
* 新增字典数据
* @param dict 新增字典数据
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 新增成功影响的行数或错误码和错误消息
*/
@PostMapping(value = "/dict/data")
public AjaxResult add(@Validated @RequestBody SysDictData dict, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -51,7 +54,8 @@ public interface RemoteDictDataService {
/**
* 修改字典数据
* @param dict 修改的字典数据
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 修改成功影响的行数或错误码和错误消息
*/
@PutMapping(value = "/dict/data")
public AjaxResult edit(@Validated @RequestBody SysDictData dict, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -59,7 +63,8 @@ public interface RemoteDictDataService {
/**
* 删除字典数据
* @param dictCodes 待删除的字典数据编码
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或出错信息
*/
@DeleteMapping("/dict/data/{dictCodes}")
public AjaxResult remove(@PathVariable Long[] dictCodes, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);

17
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteDictTypeService.java
View File

@ -20,7 +20,8 @@ public interface RemoteDictTypeService {
/**
* 根据字典标签或字典类型或状态查询字典数据列表
* @param dictType 字典类型的查询条件，如字典名称，字典类型或状态（启用或停用），创建时间范围
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 满足条件的字典类型列表分页信息
*/
@GetMapping("/dict/type/list")
public TableDataInfo list(SysDictType dictType, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -28,7 +29,8 @@ public interface RemoteDictTypeService {
/**
* 根据字典类型id 查询字典类型详细
* @param dictId 字典类型id
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 字典类型详细
*/
@GetMapping(value = "/dict/type/{dictId}")
public AjaxResult getInfo(@PathVariable Long dictId, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -36,7 +38,8 @@ public interface RemoteDictTypeService {
/**
* 新增字典类型
* @param dict 新增的字典类型
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 新增成功影响的行数或错误码和错误消息
*/
@PostMapping(value = "/dict/type")
public AjaxResult add(@Validated @RequestBody SysDictType dict, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -44,7 +47,8 @@ public interface RemoteDictTypeService {
/**
* 修改字典类型
* @param dict 修改的字典类型
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 修改成功影响的行数或错误码和错误消息
*/
@PutMapping(value = "/dict/type")
public AjaxResult edit(@Validated @RequestBody SysDictType dict, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -52,13 +56,16 @@ public interface RemoteDictTypeService {
/**
* 删除字典类型
* @param dictIds 字段类型id列表
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或出错信息
*/
@DeleteMapping("/dict/type/{dictIds}")
public AjaxResult remove(@PathVariable Long[] dictIds, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 获取所有字典类型
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或出错信息
*/
@GetMapping("/dict/type/optionselect")
public AjaxResult optionselect(@RequestHeader(SecurityConstants.FROM_SOURCE) String source);

10
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteFileService.java
View File

@ -1,5 +1,6 @@
package com.bonus.system.api;
import com.bonus.common.core.web.domain.AjaxResult;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMapping;
@ -20,10 +21,17 @@ public interface RemoteFileService
{
/**
* 上传文件
*
* @param file 文件信息
* @return 结果
*/
@PostMapping(value = "/upload", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public R<SysFile> upload(@RequestPart(value = "file") MultipartFile file);
/**
* 多文件上传
* @param files 多个文件流
* @return 文件信息
*/
@PostMapping(value = "/uploadFiles", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public AjaxResult uploadFile(@RequestPart(value = "files") MultipartFile[] files);
}

19
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteMenuService.java
View File

@ -18,7 +18,8 @@ public interface RemoteMenuService {
/**
* 根据菜单名或状态（显示或隐藏）或状态（正常或停用）获取菜单列表
* @param menu 菜单的查询条件，如菜单名或状态（显示或隐藏）或状态（正常或停用）
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 满足要求的菜单列表
*/
@GetMapping("/menu/list")
public AjaxResult list(SysMenu menu, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -26,7 +27,8 @@ public interface RemoteMenuService {
/**
* 根据菜单编号获取详细信息
* @param menuId 菜单id列表
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 菜单详情
*
*/
@GetMapping(value = "/menu/{menuId}")
@ -35,7 +37,8 @@ public interface RemoteMenuService {
/**
* 根据菜单的查询条件，如菜单名或状态（显示或隐藏）或状态（正常或停用），获取菜单下拉树列表
* @param menu 菜单的查询条件，如菜单名或状态（显示或隐藏）或状态（正常或停用）
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 菜单下拉树列表
*/
@GetMapping("/menu/treeselect")
public AjaxResult treeselect(SysMenu menu, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -43,6 +46,7 @@ public interface RemoteMenuService {
/**
* 加载对应角色菜单列表树
* @param roleId 角色id
* @param source 请求来源，使用SecurityConstants.INNER
* @return 结果
*/
@GetMapping(value = "/menu/roleMenuTreeselect/{roleId}")
@ -51,7 +55,8 @@ public interface RemoteMenuService {
/**
* 新增菜单
* @param menu 新增的菜单信息
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 新增成功影响的行数或错误码和错误消息
*/
@PostMapping("/menu")
public AjaxResult add(@Validated @RequestBody SysMenu menu, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
@ -59,14 +64,16 @@ public interface RemoteMenuService {
/**
* 修改菜单
* @param menu 修改的菜单信息
* @return 结果
* @param source 请求来源，使用SecurityConstants.INNER
* @return 修改成功影响的行数或错误码和错误消息
*/
@PutMapping("/menu")
public AjaxResult edit(@Validated @RequestBody SysMenu menu, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 查询当前登录用户的菜单树信息
* @return 路由信息
* @param source 请求来源，使用SecurityConstants.INNER
* @return 当前登录用户的菜单树信息
*/
@GetMapping("/menu/getRouters")
public AjaxResult getRouters(@RequestHeader(SecurityConstants.FROM_SOURCE) String source);

1
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteProfileService.java
View File

@ -19,6 +19,7 @@ public interface RemoteProfileService {
/**
* 获取当前登录用户个人信息
* @param source 内部请求标志，使用SecurityConstants.INNER
* @param source 内部请求标志，使用SecurityConstants.INNER
* @return 岗位列表
*/
@GetMapping("/user/profile")

16
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteRoleService.java
View File

@ -18,7 +18,7 @@ import org.springframework.web.bind.annotation.*;
@FeignClient(contextId = "remoteRoleService", value = ServiceNameConstants.SYSTEM_SERVICE, fallbackFactory = RemoteRoleFallbackFactory.class)
public interface RemoteRoleService {
/**
* 获取角色列表
* 获取当前登录用户数据权限范围内的角色列表
* @param role 角色信息
* @param source 请求来源，使用SecurityConstants.INNER
* @return 角色列表
@ -89,7 +89,7 @@ public interface RemoteRoleService {
public AjaxResult optionselect(@RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 查询已分配用户角色列表
* 查询登录用户数据权限内的已分配用户角色列表
* @param user 查询条件
* @param source 请求来源，使用SecurityConstants.INNER
* @return 角色列表
@ -98,7 +98,7 @@ public interface RemoteRoleService {
public TableDataInfo allocatedList(SysUser user, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 查询未分配用户角色列表
* 查询登录用户数据权限内的未分配用户角色列表
* @param user 查询条件
* @param source 请求来源，使用SecurityConstants.INNER
* @return 角色列表
@ -117,18 +117,26 @@ public interface RemoteRoleService {
/**
* 批量取消授权用户
* @param roleId 取消角色id
* @param userIds 取消的用户id列表
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或失败消息
*/
@PutMapping("/role/authUser/cancelAll")
public AjaxResult cancelAuthUserAll(@PathVariable("roleId")Long roleId, @PathVariable("userIds")Long[] userIds, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 批量选择用户授权
* @param roleId 授权角色id
* @param userIds 授权的用户id列表
* @param source 请求来源，使用SecurityConstants.INNER
* @return 成功或失败消息
*/
@PutMapping("/role/authUser/selectAll")
public AjaxResult selectAuthUserAll(@PathVariable("roleId")Long roleId, @PathVariable("userIds")Long[] userIds, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 获取对应角色获取部门树列表
* 获取对应角色的部门树列表
* @param roleId 角色id
* @param source 请求来源，使用SecurityConstants.INNER
* @return 部门树列表或错误消息

14
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/RemoteUserService.java
View File

@ -1,6 +1,7 @@
package com.bonus.system.api;
import com.bonus.common.core.web.domain.AjaxResult;
import com.bonus.common.core.web.page.TableDataInfo;
import com.bonus.system.api.domain.SysDept;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.validation.annotation.Validated;
@ -20,6 +21,17 @@ import com.bonus.system.api.model.LoginUser;
@FeignClient(contextId = "remoteUserService", value = ServiceNameConstants.SYSTEM_SERVICE, fallbackFactory = RemoteUserFallbackFactory.class)
public interface RemoteUserService
{
/**
* 根据条件如用户名，手机号码，状态（停用或正常）和创建时间获取当前登录用户数据权限范围内的用户信息
* @param user 角色信息
* @param source 请求来源，使用SecurityConstants.INNER
* @return 满足条件的用户信息分页信息
*/
@GetMapping("/user/list}")
public TableDataInfo list(SysUser user, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 通过用户名查询用户信息
*
@ -107,7 +119,7 @@ public interface RemoteUserService
public AjaxResult insertAuthRole(@PathVariable("userId")Long userId, @PathVariable("roleIds")Long[] roleIds, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
/**
* 获取部门权限下的部门树列表
* 获取当前登录用户数据权限范围内的部门权限下的部门树列表
* @param dept 部门信息
* @param source 请求来源
* @return 部门树列表或失败消息

8
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/factory/RemoteFileFallbackFactory.java
View File

@ -1,5 +1,6 @@
package com.bonus.system.api.factory;
import com.bonus.common.core.web.domain.AjaxResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.openfeign.FallbackFactory;
@ -28,7 +29,12 @@ public class RemoteFileFallbackFactory implements FallbackFactory<RemoteFileServ
@Override
public R<SysFile> upload(MultipartFile file)
{
return R.fail("上传文件失败:" + throwable.getMessage());
return R.fail("单上传文件失败:" + throwable.getMessage());
}
@Override
public AjaxResult uploadFile(MultipartFile[] files) {
return AjaxResult.error("多上传文件失败:" + throwable.getMessage());
}
};
}

11
bonus-api/bonus-api-system/src/main/java/com/bonus/system/api/factory/RemoteUserFallbackFactory.java
View File

@ -14,6 +14,7 @@ import com.bonus.system.api.RemoteUserService;
import com.bonus.system.api.domain.SysUser;
import com.bonus.system.api.model.LoginUser;
import java.util.ArrayList;
import java.util.List;
/**
@ -32,6 +33,11 @@ public class RemoteUserFallbackFactory implements FallbackFactory<RemoteUserServ
log.error("用户服务调用失败:{}", throwable.getMessage());
return new RemoteUserService()
{
@Override
public TableDataInfo list(SysUser user, String source) {
return getDataTableError(new ArrayList<SysUser>());
}
@Override
public R<LoginUser> getUserInfo(String username, String source)
{
@ -44,11 +50,6 @@ public class RemoteUserFallbackFactory implements FallbackFactory<RemoteUserServ
return R.fail("注册用户失败:" + throwable.getMessage());
}
// @Override
// public TableDataInfo list(SysUser user, String source) {
// return getDataTableError(new ArrayList<SysUser>());
// }
@Override
public AjaxResult getInfo(String source) {
return AjaxResult.error("获取当前登录用户权限内的角色和权限集合失败:" + throwable.getMessage());

12
bonus-modules/bonus-file/src/main/java/com/bonus/file/config/MinioConfig.java
View File

@ -1,5 +1,6 @@
package com.bonus.file.config;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@ -11,6 +12,7 @@ import io.minio.MinioClient;
* @author bonus
*/
@Configuration
@ConditionalOnProperty(name = "storage.type", havingValue = "minio")
@ConfigurationProperties(prefix = "minio")
public class MinioConfig
{
@ -74,9 +76,9 @@ public class MinioConfig
this.bucketName = bucketName;
}
@Bean
public MinioClient getMinioClient()
{
return MinioClient.builder().endpoint(url).credentials(accessKey, secretKey).build();
}
// @Bean
// public MinioClient getMinioClient()
// {
// return MinioClient.builder().endpoint(url).credentials(accessKey, secretKey).build();
// }
}