接口优化

common-springboot/pom.xml

@@ -106,6 +106,11 @@
             <artifactId>spring-session-data-redis</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>com.github.xiaoymin</groupId>
+            <artifactId>knife4j-spring-boot-starter</artifactId>
+            <version>3.0.2</version>
+        </dependency>
     </dependencies>
 
 

common-springboot/src/main/java/com/gihon/security/config/MybatisPlusConfig.java → common-springboot/src/main/java/com/gihon/common/MybatisPlusConfig.java

@@ -1,4 +1,4 @@
-package com.gihon.security.config;
+package com.gihon.common;
 
 import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
 import org.springframework.context.annotation.Bean;

common-springboot/src/main/java/com/gihon/security/config/MySecurityConfiguration.java → common-springboot/src/main/java/com/gihon/configSecurity/config/MySecurityConfiguration.java

@@ -1,9 +1,9 @@
-package com.gihon.security.config;
+package com.gihon.configSecurity.config;
 
-import com.gihon.security.encoder.MyPasswordEncoder;
-import com.gihon.security.handler.MyAccessDeniedHandler;
-import com.gihon.security.handler.MyFailureHandler;
-import com.gihon.security.handler.MySuccessHandler;
+import com.gihon.configSecurity.encoder.MyPasswordEncoder;
+import com.gihon.configSecurity.handler.MyAccessDeniedHandler;
+import com.gihon.configSecurity.handler.MyFailureHandler;
+import com.gihon.configSecurity.handler.MySuccessHandler;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -88,9 +88,11 @@ public class MySecurityConfiguration extends WebSecurityConfigurerAdapter {
          *      底层： access("hasIpAddress('IP地址')")
          */
         http.authorizeRequests() // 获取Security中专门配置权限管理的配置类型
-                .antMatchers("/", "/fail").permitAll() // 访问 '/' 地址的时候，不需要登录。
-                .antMatchers("/**/*.js").permitAll() // 只处理js文件
-                .regexMatchers(".+[.]css").permitAll() // 只处理css
+                  .antMatchers("/swagger**/**").permitAll()
+                  .antMatchers("/doc.html","/webjars/**","/img.icons/**","/swagger-resources/**","/**","/v2/api-docs").permitAll()
+//                .antMatchers("/", "/fail").permitAll() // 访问 '/' 地址的时候，不需要登录。
+//                .antMatchers("/**/*.js").permitAll() // 只处理js文件
+//                .regexMatchers(".+[.]css").permitAll() // 只处理css
 //                .antMatchers("/anonymous").anonymous() // 匿名访问
 //                .antMatchers("/denyAll").denyAll() // 不能访问
 //                .antMatchers("/hasAdminRole").hasRole("管理员") // 判断有没有"管理员"角色

common-springboot/src/main/java/com/gihon/security/controller/DispatcherController.java → common-springboot/src/main/java/com/gihon/configSecurity/controller/DispatcherController.java

@@ -1,4 +1,4 @@
-package com.gihon.security.controller;
+package com.gihon.configSecurity.controller;
 
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;

common-springboot/src/main/java/com/gihon/security/encoder/MyPasswordEncoder.java → common-springboot/src/main/java/com/gihon/configSecurity/encoder/MyPasswordEncoder.java

@@ -1,4 +1,4 @@
-package com.gihon.security.encoder;
+package com.gihon.configSecurity.encoder;
 
 import org.springframework.security.crypto.password.PasswordEncoder;
 

common-springboot/src/main/java/com/gihon/security/handler/MyAccessDeniedHandler.java → common-springboot/src/main/java/com/gihon/configSecurity/handler/MyAccessDeniedHandler.java

@@ -1,4 +1,4 @@
-package com.gihon.security.handler;
+package com.gihon.configSecurity.handler;
 
 import org.springframework.security.access.AccessDeniedException;
 import org.springframework.security.web.access.AccessDeniedHandler;

common-springboot/src/main/java/com/gihon/security/handler/MyFailureHandler.java → common-springboot/src/main/java/com/gihon/configSecurity/handler/MyFailureHandler.java

@@ -1,4 +1,4 @@
-package com.gihon.security.handler;
+package com.gihon.configSecurity.handler;
 
 import org.springframework.security.core.AuthenticationException;
 import org.springframework.security.web.authentication.AuthenticationFailureHandler;

common-springboot/src/main/java/com/gihon/security/handler/MySuccessHandler.java → common-springboot/src/main/java/com/gihon/configSecurity/handler/MySuccessHandler.java

@@ -1,4 +1,4 @@
-package com.gihon.security.handler;
+package com.gihon.configSecurity.handler;
 
 import org.springframework.security.core.Authentication;
 import org.springframework.security.web.authentication.AuthenticationSuccessHandler;

common-springboot/src/main/java/com/gihon/security/matchers/MyPermissionsMatcher.java → common-springboot/src/main/java/com/gihon/configSecurity/matchers/MyPermissionsMatcher.java

@@ -1,4 +1,4 @@
-package com.gihon.security.matchers;
+package com.gihon.configSecurity.matchers;
 
 import org.springframework.security.core.Authentication;
 

common-springboot/src/main/java/com/gihon/security/matchers/impl/MyPermissionsMatcherImpl.java → common-springboot/src/main/java/com/gihon/configSecurity/matchers/impl/MyPermissionsMatcherImpl.java

@@ -1,6 +1,6 @@
-package com.gihon.security.matchers.impl;
+package com.gihon.configSecurity.matchers.impl;
 
-import com.gihon.security.matchers.MyPermissionsMatcher;
+import com.gihon.configSecurity.matchers.MyPermissionsMatcher;
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;

common-springboot/src/main/java/com/gihon/security/service/impl/UserLoginServiceImpl.java → common-springboot/src/main/java/com/gihon/configSecurity/service/impl/UserLoginServiceImpl.java

@@ -1,7 +1,7 @@
-package com.gihon.security.service.impl;
+package com.gihon.configSecurity.service.impl;
 
-import com.gihon.user.mapper.UserMapper;
-import com.gihon.user.entity.User;
+import com.gihon.mapper.UserMapper;
+import com.gihon.entity.User;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;
 import org.springframework.security.core.userdetails.UserDetails;

common-springboot/src/main/java/com/gihon/permission/controller/PermissionController.java → common-springboot/src/main/java/com/gihon/controller/PermissionController.java

@@ -1,8 +1,8 @@
-package com.gihon.permission.controller;
+package com.gihon.controller;
 
 import com.gihon.common.web.response.Response;
-import com.gihon.permission.entity.Permission;
-import com.gihon.permission.service.permissionService;
+import com.gihon.entity.Permission;
+import com.gihon.service.permissionService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;

common-springboot/src/main/java/com/gihon/role/controller/RoleController.java → common-springboot/src/main/java/com/gihon/controller/RoleController.java

@@ -1,8 +1,8 @@
-package com.gihon.role.controller;
+package com.gihon.controller;
 import com.gihon.common.web.response.Response;
 import com.gihon.common.web.response.ResponseStatus;
-import com.gihon.role.entity.Role;
-import com.gihon.role.service.RoleService;
+import com.gihon.entity.Role;
+import com.gihon.service.RoleService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.transaction.annotation.Transactional;

common-springboot/src/main/java/com/gihon/user/controller/UserController.java → common-springboot/src/main/java/com/gihon/controller/UserController.java

@@ -1,13 +1,15 @@
-package com.gihon.user.controller;
+package com.gihon.controller;
 
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.gihon.common.web.response.PageBean;
 import com.gihon.common.web.response.PageResponse;
 import com.gihon.common.web.response.Response;
 import com.gihon.common.web.response.ResponseStatus;
-import com.gihon.security.encoder.MyPasswordEncoder;
-import com.gihon.user.entity.User;
-import com.gihon.user.service.UserService;
+import com.gihon.configSecurity.encoder.MyPasswordEncoder;
+import com.gihon.entity.User;
+import com.gihon.service.UserService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.transaction.annotation.Transactional;
 import org.springframework.web.bind.annotation.*;
@@ -20,6 +22,7 @@ import java.util.List;
  */
 @RestController
 @RequestMapping("/user")
+@Api(value = "用户接口", tags = "用户接口")
 public class UserController {
     @Autowired
     private UserService userService;
@@ -34,9 +37,10 @@ public class UserController {
      * @return com.gihon.common.http.Response
      */
     //@Secured(value = {"ROLE_管理员", "ROLE_超级管理员"})
+    @ApiOperation("分页查询用户列表")
     @GetMapping("/getUsersByPage")
     public PageResponse<PageBean<User>> getUsersByPage(
-            @RequestParam(required = false,defaultValue = "0") int page,
+            @RequestParam(required = false,defaultValue = "1") int page,
             @RequestParam(required = false, defaultValue = "10") int rows) {
         PageResponse byPage = userService.getByPage(page, rows);
         return byPage;
@@ -51,6 +55,7 @@ public class UserController {
      * @return com.gihon.common.http.Response
      *
      */
+    @ApiOperation("查询 用户信息by用户ID")
     @GetMapping("/userByID")
     public Response userFindOne(@RequestParam Long id){
         User userInfo = userService.getById(id);
@@ -64,7 +69,8 @@ public class UserController {
      * @param	id	 用户id
      * @return com.gihon.common.http.Response<java.util.List<java.lang.String>>
      */
-    @RequestMapping("/getPermissionsByUserId")
+    @ApiOperation("根据用户id 查找对应权限")
+    @GetMapping("/getPermissionsByUserId")
     public Response<List<String>> getPermissionsByUserId(Long id){
         List<String> permissions = userService.findPermissionsByUserId(id);
         return Response.ok(permissions);
@@ -83,6 +89,7 @@ public class UserController {
      */
 
     //@Secured(value = {"addUser"})
+    @ApiOperation("增加用户")
     @PostMapping("/addUser")
     public Response<User> addUser(@RequestBody User user) {
         Response<User> addUser = userService.addUser(user);
@@ -98,7 +105,8 @@ public class UserController {
      * @param	RoleIds
      * @return com.gihon.common.web.response.Response
      */
-    @RequestMapping("/addRole4User")
+    @ApiOperation("用户ById")
+    @PostMapping("/addRole4User")
     @ResponseBody
     public Response addRole4User(@RequestBody User user,@RequestParam("RoleIds") Long[] RoleIds){
         Response response = userService.addRole4User(user,RoleIds);
@@ -113,6 +121,7 @@ public class UserController {
      * @param	id
      * @return com.gihon.common.http.Response
      */
+    @ApiOperation("删除用户")
     @Transactional(rollbackFor = Exception.class)
     @GetMapping(value = "/deleteUser")
     public Response deleteUser(@RequestParam Long id) {
@@ -126,6 +135,7 @@ public class UserController {
     }
 
     //@PreAuthorize("hasAuthority('updateUser')")
+    @ApiOperation("修改密码")
     @Transactional(rollbackFor = Exception.class)
     @PostMapping(value = "/setUser")
     /**

common-springboot/src/main/java/com/gihon/permission/entity/Permission.java → common-springboot/src/main/java/com/gihon/entity/Permission.java

@@ -1,4 +1,4 @@
-package com.gihon.permission.entity;
+package com.gihon.entity;
 
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;

common-springboot/src/main/java/com/gihon/role/entity/Role.java → common-springboot/src/main/java/com/gihon/entity/Role.java

@@ -1,4 +1,4 @@
-package com.gihon.role.entity;
+package com.gihon.entity;
 
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableField;

common-springboot/src/main/java/com/gihon/user/entity/User.java → common-springboot/src/main/java/com/gihon/entity/User.java

@@ -1,8 +1,10 @@
-package com.gihon.user.entity;
+package com.gihon.entity;
 
 import com.baomidou.mybatisplus.annotation.IdType;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.*;
 
 import java.io.Serializable;
@@ -19,10 +21,14 @@ import java.io.Serializable;
 @Data
 @NoArgsConstructor
 @AllArgsConstructor(access = AccessLevel.PACKAGE)
+@ApiModel("用户实体")
 public class User implements Serializable {
     @TableId(value = "id", type = IdType.AUTO)
+    @ApiModelProperty("用户id")
     private Long id;
+    @ApiModelProperty("用户名称")
     private String username;
+    @ApiModelProperty("用户密码")
     private String password;
 
 

common-springboot/src/main/java/com/gihon/permission/mapper/PermissionMapper.java → common-springboot/src/main/java/com/gihon/mapper/PermissionMapper.java

@@ -1,7 +1,7 @@
-package com.gihon.permission.mapper;
+package com.gihon.mapper;
 
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
-import com.gihon.permission.entity.Permission;
+import com.gihon.entity.Permission;
 import org.apache.ibatis.annotations.Mapper;
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.Select;

common-springboot/src/main/java/com/gihon/role/mapper/RoleMapper.java → common-springboot/src/main/java/com/gihon/mapper/RoleMapper.java

@@ -1,7 +1,7 @@
-package com.gihon.role.mapper;
+package com.gihon.mapper;
 
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
-import com.gihon.role.entity.Role;
+import com.gihon.entity.Role;
 import org.apache.ibatis.annotations.Mapper;
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.Select;

common-springboot/src/main/java/com/gihon/user/mapper/UserMapper.java → common-springboot/src/main/java/com/gihon/mapper/UserMapper.java

@@ -1,7 +1,7 @@
-package com.gihon.user.mapper;
+package com.gihon.mapper;
 
 import com.baomidou.mybatisplus.core.mapper.BaseMapper;
-import com.gihon.user.entity.User;
+import com.gihon.entity.User;
 import org.apache.ibatis.annotations.Mapper;
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.Select;

common-springboot/src/main/java/com/gihon/role/service/RoleService.java → common-springboot/src/main/java/com/gihon/service/RoleService.java

@@ -1,8 +1,8 @@
-package com.gihon.role.service;
+package com.gihon.service;
 
 import com.baomidou.mybatisplus.extension.service.IService;
 import com.gihon.common.web.response.Response;
-import com.gihon.role.entity.Role;
+import com.gihon.entity.Role;
 
 import java.util.List;
 

common-springboot/src/main/java/com/gihon/user/service/UserService.java → common-springboot/src/main/java/com/gihon/service/UserService.java

@@ -1,9 +1,9 @@
-package com.gihon.user.service;
+package com.gihon.service;
 
 import com.baomidou.mybatisplus.extension.service.IService;
 import com.gihon.common.web.response.PageResponse;
 import com.gihon.common.web.response.Response;
-import com.gihon.user.entity.User;
+import com.gihon.entity.User;
 
 import java.util.List;
 

common-springboot/src/main/java/com/gihon/role/service/impl/RoleServiceImpl.java → common-springboot/src/main/java/com/gihon/service/impl/RoleServiceImpl.java

@@ -1,10 +1,10 @@
-package com.gihon.role.service.impl;
+package com.gihon.service.impl;
 
 import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
 import com.gihon.common.web.response.Response;
-import com.gihon.role.mapper.RoleMapper;
-import com.gihon.role.entity.Role;
-import com.gihon.role.service.RoleService;
+import com.gihon.mapper.RoleMapper;
+import com.gihon.entity.Role;
+import com.gihon.service.RoleService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 

common-springboot/src/main/java/com/gihon/user/service/impl/UserServiceImpl.java → common-springboot/src/main/java/com/gihon/service/impl/UserServiceImpl.java

@@ -1,4 +1,4 @@
-package com.gihon.user.service.impl;
+package com.gihon.service.impl;
 
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
@@ -7,11 +7,10 @@ import com.gihon.common.web.response.PageBean;
 import com.gihon.common.web.response.PageResponse;
 import com.gihon.common.web.response.Response;
 import com.gihon.common.web.response.ResponseStatus;
-import com.gihon.role.entity.Role;
-import com.gihon.security.encoder.MyPasswordEncoder;
-import com.gihon.user.mapper.UserMapper;
-import com.gihon.user.entity.User;
-import com.gihon.user.service.UserService;
+import com.gihon.configSecurity.encoder.MyPasswordEncoder;
+import com.gihon.mapper.UserMapper;
+import com.gihon.entity.User;
+import com.gihon.service.UserService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 

common-springboot/src/main/java/com/gihon/permission/service/impl/permissionServiceImpl.java → common-springboot/src/main/java/com/gihon/service/impl/permissionServiceImpl.java

@@ -1,12 +1,12 @@
-package com.gihon.permission.service.impl;
+package com.gihon.service.impl;
 
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
 import com.gihon.common.web.response.Response;
 import com.gihon.common.web.response.ResponseStatus;
-import com.gihon.permission.mapper.PermissionMapper;
-import com.gihon.permission.entity.Permission;
-import com.gihon.permission.service.permissionService;
+import com.gihon.mapper.PermissionMapper;
+import com.gihon.entity.Permission;
+import com.gihon.service.permissionService;
 import org.springframework.stereotype.Service;
 
 import java.util.List;

common-springboot/src/main/java/com/gihon/permission/service/permissionService.java → common-springboot/src/main/java/com/gihon/service/permissionService.java

@@ -1,8 +1,8 @@
-package com.gihon.permission.service;
+package com.gihon.service;
 
 import com.baomidou.mybatisplus.extension.service.IService;
 import com.gihon.common.web.response.Response;
-import com.gihon.permission.entity.Permission;
+import com.gihon.entity.Permission;
 
 import java.util.List;
 

common-springboot/src/main/resources/application.yml

@@ -64,4 +64,8 @@ mybatis-plus:
     #驼峰下划线转换
     map-underscore-to-camel-case: true
     cache-enabled: false
-    jdbc-type-for-null: 'null'   
+    jdbc-type-for-null: 'null'
+
+logging:
+  level:
+    com.gihon.mapper: debug

common-springboot/src/main/resources/mapper/RoleMapper.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
-<mapper namespace="com.gihon.role.mapper.RoleMapper">
+<mapper namespace="com.gihon.mapper.RoleMapper">
 
-    <select id="selectPermissionByRoleId" resultType="com.gihon.role.entity.Role">
+    <select id="selectPermissionByRoleId" resultType="com.gihon.entity.Role">
         select * from tb_permission where id in(select role_id from tb_role_perm where role_id =#{id})
     </select>
 </mapper>

common-springboot/src/main/resources/mapper/UserInfoMapper.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
-<mapper namespace="com.gihon.user.mapper.UserMapper">
+<mapper namespace="com.gihon.mapper.UserMapper">
 
-	<!--<select id="selectByUsername" resultType="com.gihon.user.entity.User">-->
+	<!--<select id="selectByUsername" resultType="User">-->
 	<!--	select id, username, password from tb_user where username = #{username}-->
 	<!--</select>-->
 	<insert id="insertRolestoUser">

common-springboot/src/main/resources/templates/fail.html

@@ -6,6 +6,6 @@
 </head>
 <body style="text-align: center">
     <h3><!--<span th:text="${SPRING_SECURITY_LAST_EXCEPTION.message}"></span>-->登录认证失败，请重新
-        <a href="/">登录</a></h3>
+        <a href="/security/login">登录</a></h3>
 </body>
 </html>