Browse Source

添加备注

zhoutg 6 years ago
parent
commit
876c7d3888

+ 4 - 0
diagbotman-service/src/main/java/com/diagbot/facade/ServiceFilterFacade.java

@@ -15,6 +15,10 @@ import java.util.List;
 @Component
 public class ServiceFilterFacade extends ServiceFilterServiceImpl {
 
+    /**
+     * 获取需要appkey和secret的服务,未用
+     * @return 服务列表
+     */
     public RespDTO<List<ServiceFilter>> getServiceFilter() {
         return this.getAll();
     }

+ 1 - 3
diagbotman-service/src/main/java/com/diagbot/facade/ServiceInfoFacade.java

@@ -2,16 +2,14 @@ package com.diagbot.facade;
 
 import com.baomidou.mybatisplus.core.metadata.IPage;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
-import com.diagbot.entity.LantoneProduct;
 import com.diagbot.entity.ServiceInfo;
-import com.diagbot.entity.ServiceToken;
-import com.diagbot.entity.wrapper.ProductServiceWrapper;
 import com.diagbot.exception.CommonErrorCode;
 import com.diagbot.exception.CommonException;
 import com.diagbot.service.impl.ServiceInfoServiceImpl;
 import com.diagbot.util.UserUtils;
 import com.diagbot.vo.ServiceSaveVO;
 import org.springframework.stereotype.Component;
+
 import java.util.Date;
 import java.util.List;
 

+ 4 - 3
diagbotman-service/src/main/java/com/diagbot/facade/ServiceTokenFacade.java

@@ -33,10 +33,11 @@ public class ServiceTokenFacade extends ServiceTokenServiceImpl {
     @Autowired
     OpenedProductsFacade openedProductsFacade;
 
+
     /**
-     * @Description: 获取资源的url
-     * @Author: ztg
-     * @Date: 2018/9/18 16:54
+     * 获取资源的url
+     * @param serviceTokenVo 参数
+     * @return 是否有权限
      */
     public RespDTO<Boolean> hasPermission(ServiceTokenVo serviceTokenVo) {
         String appkey = serviceTokenVo.getAppkey();

+ 5 - 0
diagbotman-service/src/main/java/com/diagbot/service/impl/ServiceFilterServiceImpl.java

@@ -22,6 +22,11 @@ public class ServiceFilterServiceImpl extends ServiceImpl<ServiceFilterMapper, S
     @Autowired
     ServiceFilterMapper serviceFilterMapper;
 
+
+    /**
+     * 获取需要appkey和secret的服务信息
+     * @return
+     */
     @Override
     public RespDTO<List<ServiceFilter>> getAll() {
         List<ServiceFilter> list = serviceFilterMapper.getAll();

+ 1 - 1
diagbotman-service/src/main/java/com/diagbot/web/ServiceFilterController.java

@@ -27,7 +27,7 @@ public class ServiceFilterController {
 
 
     @PostMapping("/getAll")
-    @ApiOperation(value = "获取需要appkey和secret的服务信息",
+    @ApiOperation(value = "获取需要appkey和secret的服务信息[by:zhoutg]",
             notes = "接口未用,直接从配置项中读取服务")
     @ApiIgnore
     public RespDTO<List<ServiceFilter>> getServiceFilter() {

+ 49 - 27
user-service/src/main/java/com/diagbot/facade/UserFacade.java

@@ -68,11 +68,10 @@ public class UserFacade extends UserServiceImpl {
     @Autowired
     PermissionFacade permissionFacade;
 
-
     /**
-     * @Description: 注册
-     * @Author: ztg
-     * @Date: 2018/9/25 15:08
+     * 注册
+     * @param userSaveVO 参数
+     * @return 用户信息
      */
     public User createUser(UserSaveVO userSaveVO){
         User user = new User();
@@ -109,9 +108,9 @@ public class UserFacade extends UserServiceImpl {
 
 
     /**
-     * @Description: 用来测试分页
-     * @Author: ztg
-     * @Date: 2018/9/25 15:10
+     * @param page 分页参数
+     * @param userSaveVO 参数
+     * @return 用户列表
      */
     public RespDTO<IPage<User>> index(Page page, UserSaveVO userSaveVO){
         User user = new User();
@@ -121,7 +120,11 @@ public class UserFacade extends UserServiceImpl {
     }
 
 
-    //添加一条默认用户认证信息
+    /**
+     * 添加一条默认用户认证信息
+     * @param userSaveVO 参数
+     * @param user 参数
+     */
     public void doUserAuthentication(UserSaveVO userSaveVO, User user) {
         UserAuthentication ua = new UserAuthentication();
         ua.setGmtCreate(new Date());
@@ -129,7 +132,12 @@ public class UserFacade extends UserServiceImpl {
         userAuthenticationFacade.save(ua);
     }
 
-    //如果机构已存在,只要添加用户与机构的映射即可;如果机构不存在,先添加机构信息
+
+    /**
+     * 如果机构已存在,只要添加用户与机构的映射即可;如果机构不存在,先添加机构信息
+     * @param userSaveVO 参数
+     * @param user 参数
+     */
     public void doPermisson(UserSaveVO userSaveVO, User user) {
         UserRole  userRole = new UserRole();
         userRole.setUserId(user.getId());
@@ -138,7 +146,12 @@ public class UserFacade extends UserServiceImpl {
         userRoleFacade.save(userRole);
     }
 
-    //如果机构已存在,只要添加用户与机构的映射即可;如果机构不存在,先添加机构信息
+
+    /**
+     * 如果机构已存在,只要添加用户与机构的映射即可;如果机构不存在,先添加机构信息
+     * @param userSaveVO 参数
+     * @param user 参数
+     */
     public void doOrganization(UserSaveVO userSaveVO, User user) {
         Map<String, Object> paramMap = new HashMap<>();
         String name = userSaveVO.getOrganization();
@@ -175,10 +188,12 @@ public class UserFacade extends UserServiceImpl {
         return this.findByName(username);
     }
 
+
     /**
-     * @Description: 登录
-     * @Author: ztg
-     * @Date: 2018/9/25 15:08
+     * 登录
+     * @param username 用户名
+     * @param password 密码
+     * @return 登录相关信息
      */
     public RespDTO login(String username , String password){
         User user= this.findByName(username);
@@ -211,9 +226,8 @@ public class UserFacade extends UserServiceImpl {
 
 
     /**
-     * @Description: 递归获取菜单结构
-     * @Author: ztg
-     * @Date: 2018/9/14 13:56
+     * 递归获取菜单结构
+     * @param menuList 菜单参数
      */
     public void getMenuStruct(List<MenuWrapper> menuList) {
         for(MenuWrapper m : menuList) {
@@ -221,6 +235,12 @@ public class UserFacade extends UserServiceImpl {
         }
     }
 
+
+    /**
+     * 递归查询菜单信息
+     * @param m 参数
+     * @return 菜单信息
+     */
     public List<MenuWrapper> recursion(MenuWrapper m) {
         List<MenuWrapper> subMenu = menuFacade.getSubMenuById(m.getId());
         for (MenuWrapper sub : subMenu) {
@@ -231,9 +251,9 @@ public class UserFacade extends UserServiceImpl {
 
 
     /**
-     * @Description: 获取用户相关信息和机构信息
-     * @Author: ztg
-     * @Date: 2018/9/25 15:09
+     * 获取用户相关信息和机构信息
+     * @param userIds 用户ids
+     * @return 用户相关信息和机构信息
      */
     public Map<Long, UserOrgDTO> getUserAndOrg(List<Long> userIds) {
         Map<Long, UserOrgDTO> data = new HashMap();
@@ -250,9 +270,11 @@ public class UserFacade extends UserServiceImpl {
 
 
     /**
-     * @Description: 重置密码
-     * @Author: ztg
-     * @Date: 2018/9/25 15:08
+     * 重置密码
+     * @param username 用户名
+     * @param password 密码
+     * @param diffPassword 重置的密码
+     * @return 重置密码是否成功
      */
     public RespDTO resetPassword(String username, String password, String diffPassword) {
         if (StringUtil.isBlank(username)){
@@ -331,11 +353,11 @@ public class UserFacade extends UserServiceImpl {
 	}
 
 
-	/**
-	 * @Description: 远程调用,根据机构名称获取用户信息
-	 * @Author: ztg
-	 * @Date: 2018/9/25 15:10
-	 */
+    /**
+     * 远程调用,根据机构名称获取用户信息
+     * @param orgName 机构信息
+     * @return 用户ids
+     */
     public List<Long> getUserByOrgNameFac(String orgName) {
         List<Long> userIdList = new ArrayList<>();
         if(StringUtil.isEmpty(orgName)) {

+ 11 - 0
user-service/src/main/java/com/diagbot/service/impl/MenuServiceImpl.java

@@ -23,11 +23,22 @@ public class MenuServiceImpl extends ServiceImpl<MenuMapper, Menu> implements Me
     @Autowired
     MenuMapper menuMapper;
 
+    /**
+     * 根据用户id获取菜单信息
+     * @param userId 用户id
+     * @return 菜单信息
+     */
     @Override
     public List<MenuWrapper> getByRole(Long userId) {
         return menuMapper.getByRole(userId);
     }
 
+
+    /**
+     * 获取下级菜单
+     * @param id 菜单id
+     * @return 子菜单信息
+     */
     @Override
     public List<MenuWrapper> getSubMenuById(Long id) {
         return menuMapper.getSubMenuById(id);

+ 5 - 1
user-service/src/main/java/com/diagbot/service/impl/OrganizationServiceImpl.java

@@ -5,7 +5,6 @@ import com.diagbot.entity.Organization;
 import com.diagbot.mapper.OrganizationMapper;
 import com.diagbot.service.OrganizationService;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 import java.util.List;
@@ -20,6 +19,11 @@ import java.util.Map;
 @Slf4j
 public class OrganizationServiceImpl extends ServiceImpl<OrganizationMapper, Organization> implements OrganizationService {
 
+    /**
+     * 根据参数查询机构信息
+     * @param map 参数
+     * @return
+     */
     @Override
     public List<Organization> selectByMap(Map map) {
         return baseMapper.selectByMap(map);

+ 5 - 0
user-service/src/main/java/com/diagbot/service/impl/UserOrganizationServiceImpl.java

@@ -21,6 +21,11 @@ public class UserOrganizationServiceImpl extends ServiceImpl<UserOrganizationMap
     @Autowired
     UserOrganizationMapper userOrganizationMapper;
 
+    /**
+     * 根据参数获取机构信息
+     * @param map 参数
+     * @return 机构列表
+     */
     @Override
     public List<UserOrganization> selectByMap(Map map) {
         return userOrganizationMapper.selectByMap(map);

+ 12 - 0
user-service/src/main/java/com/diagbot/service/impl/UserServiceImpl.java

@@ -29,6 +29,11 @@ public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements Us
     @Autowired
     UserMapper userMapper;
 
+    /**
+     * 根据用户查找信息
+     * @param username 用户名
+     * @return 用户信息
+     */
     public User findByName(String username){
         return baseMapper.findByName(username);
     }
@@ -64,10 +69,17 @@ public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements Us
         return userMapper.getByIds(ids);
     }
 
+
+    /**
+     * 获取用户和机构信息
+     * @param userIds 用户ids
+     * @return 用户和机构信息
+     */
     @Override
     public List<UserOrgDTO> getUserOrgByIds(List<Long> userIds) {
         return userMapper.getUserOrgDTOByIds(userIds);
     }
+
     @Override
     public boolean auditUserInfoAll(Map<String,Object> auditMap) {
 	    // TODO Auto-generated method stub