Just add a few code comments , beautify the code style and update the README.md file

pom.xml

@@ -8,18 +8,22 @@
     <version>0.0.1-SNAPSHOT</version>
     <packaging>pom</packaging>
     <modules>
+        <!-- 核心业务类模块:提供基本的数据操作、工具处理等 -->
         <module>shiro-core</module>
+        <!-- 后台管理模块 -->
         <module>shiro-admin</module>
     </modules>
 
     <name>shiro</name>
-    <description>Demo project for Spring Boot</description>
+    <description>A simpele authority management system</description>
+    <url>https://github.com/YUbuntu0109/springboot-shiro</url>
 
+    <!-- lookup parent from repository -->
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>2.0.1.RELEASE</version>
-        <relativePath/> <!-- lookup parent from repository -->
+        <relativePath/>
     </parent>
 
     <properties>
@@ -38,11 +42,13 @@
     </properties>
 
     <dependencies>
+        <!-- Lombok -->
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
             <optional>true</optional>
         </dependency>
+        <!-- Test -->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
@@ -55,4 +61,5 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+
 </project>

shiro-admin/pom.xml

@@ -1,41 +1,40 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
 
-	<artifactId>shiro-admin</artifactId>
-	<version>0.0.1-SNAPSHOT</version>
-	<packaging>jar</packaging>
+    <artifactId>shiro-admin</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+    <packaging>jar</packaging>
 
-	<name>shiro-admin</name>
-	<description>Demo project for Spring Boot</description>
+    <name>shiro-admin</name>
+    <description>后台管理模块</description>
 
-	<parent>
-		<groupId>com.zyd.shiro</groupId>
-		<artifactId>shiro</artifactId>
-		<version>0.0.1-SNAPSHOT</version>
-	</parent>
+    <parent>
+        <groupId>com.zyd.shiro</groupId>
+        <artifactId>shiro</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
+    </parent>
 
-	<dependencies>
-		<dependency>
-			<groupId>com.zyd.shiro</groupId>
-			<artifactId>shiro-core</artifactId>
-			<version>0.0.1-SNAPSHOT</version>
-		</dependency>
-	</dependencies>
-
-	<build>
-		<plugins>
-			<plugin>
-				<groupId>org.springframework.boot</groupId>
-				<artifactId>spring-boot-maven-plugin</artifactId>
-				<configuration>
-					<mainClass>com.zyd.shiro.ShiroAdminApplication</mainClass>
-					<layout>JAR</layout>
-				</configuration>
-			</plugin>
-		</plugins>
-	</build>
+    <dependencies>
+        <dependency>
+            <groupId>com.zyd.shiro</groupId>
+            <artifactId>shiro-core</artifactId>
+            <version>0.0.1-SNAPSHOT</version>
+        </dependency>
+    </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.springframework.boot</groupId>
+                <artifactId>spring-boot-maven-plugin</artifactId>
+                <configuration>
+                    <mainClass>com.zyd.shiro.ShiroAdminApplication</mainClass>
+                    <layout>JAR</layout>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
 
 </project>

shiro-admin/src/main/java/com/zyd/shiro/controller/ErrorPagesController.java

@@ -39,18 +39,12 @@
 import java.util.Map;
 
 /**
- * 重写BasicErrorController,主要负责系统的异常页面的处理以及错误信息的显示
- * <p/>
- * 此处指需要记录
- *
- * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @version 1.0
- * @website https://www.zhyd.me
- * @date 2018/4/16 16:26
- * <p/>
- * 要注意，这个类里面的代码一定不能有异常或者潜在异常发生，否则可能会让程序陷入死循环。
- * <p/>
- * @since 1.0
+ * @project: springboot-shiro
+ * @description: 重写BasicErrorController, 主要负责系统的异常页面的处理以及错误信息的显示
+ * 注意: 这个类里面的代码一定不能有异常或者潜在异常发生,否则可能会让程序陷入死循环
+ * @date: 2019-08-15 7:42 PM
+ * @version: 1.0
+ * @website: https://yubuntu0109.github.io/
  */
 @Slf4j
 @Controller
@@ -64,16 +58,25 @@ public class ErrorPagesController implements ErrorController {
     private ServerProperties serverProperties;
 
     /**
-     * 初始化ExceptionController
-     *
-     * @param errorAttributes
+     * @description: 初始化ExceptionController
+     * @param: errorAttributes
+     * @date: 2019-08-15 8:10 PM
+     * @return:
      */
     @Autowired
     public ErrorPagesController(ErrorAttributes errorAttributes) {
         Assert.notNull(errorAttributes, "ErrorAttributes must not be null");
         this.errorAttributes = errorAttributes;
     }
 
+    /**
+     * @description: 404:指网页或文件未找到错误
+     * @param: request
+     * @param: response
+     * @param: webRequest
+     * @date: 2019-08-15 8:10 PM
+     * @return: org.springframework.web.servlet.ModelAndView
+     */
     @RequestMapping("/404")
     public ModelAndView errorHtml404(HttpServletRequest request, HttpServletResponse response, WebRequest webRequest) {
         response.setStatus(HttpStatus.NOT_FOUND.value());
@@ -82,31 +85,63 @@ public ModelAndView errorHtml404(HttpServletRequest request, HttpServletResponse
         return new ModelAndView("error/404", model);
     }
 
+    /**
+     * @description: 403:资源不可用错误
+     * @param: request
+     * @param: response
+     * @param: webRequest
+     * @date: 2019-08-15 8:11 PM
+     * @return: org.springframework.web.servlet.ModelAndView
+     */
     @RequestMapping("/403")
     public ModelAndView errorHtml403(HttpServletRequest request, HttpServletResponse response, WebRequest webRequest) {
         response.setStatus(HttpStatus.FORBIDDEN.value());
-        // 404拦截规则，如果是静态文件发生的404则不记录到DB
+        // 404拦截规则,如果是静态文件发生的404则不记录到DB
         Map<String, Object> model = getErrorAttributes(webRequest, isIncludeStackTrace(request, MediaType.TEXT_HTML));
         if (!String.valueOf(model.get("path")).contains(".")) {
             model.put("status", HttpStatus.FORBIDDEN.value());
         }
         return new ModelAndView("error/403", model);
     }
 
+    /**
+     * @description: 400:访问的页面域名不存在或者请求错误
+     * @param: request
+     * @param: response
+     * @param: webRequest
+     * @date: 2019-08-15 8:11 PM
+     * @return: org.springframework.web.servlet.ModelAndView
+     */
     @RequestMapping("/400")
     public ModelAndView errorHtml400(HttpServletRequest request, HttpServletResponse response, WebRequest webRequest) {
         response.setStatus(HttpStatus.BAD_REQUEST.value());
         Map<String, Object> model = getErrorAttributes(webRequest, isIncludeStackTrace(request, MediaType.TEXT_HTML));
         return new ModelAndView("error/400", model);
     }
 
+    /**
+     * @description: 401:未经授权错误
+     * @param: request
+     * @param: response
+     * @param: webRequest
+     * @date: 2019-08-15 8:12 PM
+     * @return: org.springframework.web.servlet.ModelAndView
+     */
     @RequestMapping("/401")
     public ModelAndView errorHtml401(HttpServletRequest request, HttpServletResponse response, WebRequest webRequest) {
         response.setStatus(HttpStatus.UNAUTHORIZED.value());
         Map<String, Object> model = getErrorAttributes(webRequest, isIncludeStackTrace(request, MediaType.TEXT_HTML));
         return new ModelAndView("error/401", model);
     }
 
+    /**
+     * @description: 500:服务器端发生异常
+     * @param: request
+     * @param: response
+     * @param: webRequest
+     * @date: 2019-08-15 8:12 PM
+     * @return: org.springframework.web.servlet.ModelAndView
+     */
     @RequestMapping("/500")
     public ModelAndView errorHtml500(HttpServletRequest request, HttpServletResponse response, WebRequest webRequest) {
         response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
@@ -121,8 +156,7 @@ public ModelAndView errorHtml500(HttpServletRequest request, HttpServletResponse
      * @param produces the media type produced (or {@code MediaType.ALL})
      * @return if the stacktrace attribute should be included
      */
-    protected boolean isIncludeStackTrace(HttpServletRequest request,
-                                          MediaType produces) {
+    protected boolean isIncludeStackTrace(HttpServletRequest request, MediaType produces) {
         ErrorProperties.IncludeStacktrace include = this.serverProperties.getError().getIncludeStacktrace();
         if (include == ErrorProperties.IncludeStacktrace.ALWAYS) {
             return true;
@@ -132,33 +166,32 @@ protected boolean isIncludeStackTrace(HttpServletRequest request,
 
 
     /**
-     * 获取错误的信息
-     *
-     * @param webRequest
-     * @param includeStackTrace
-     * @return
+     * @description: 获取错误信息
+     * @param: webRequest
+     * @param: includeStackTrace
+     * @date: 2019-08-15 8:13 PM
+     * @return: java.util.Map<java.lang.String, java.lang.Object>
      */
-    private Map<String, Object> getErrorAttributes(WebRequest webRequest,
-                                                   boolean includeStackTrace) {
+    private Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
         return this.errorAttributes.getErrorAttributes(webRequest, includeStackTrace);
     }
 
     /**
-     * 是否包含trace
-     *
-     * @param request
-     * @return
+     * @description: 判断是否包含trace
+     * @param: request
+     * @date: 2019-08-15 8:13 PM
+     * @return: boolean
      */
     private boolean getTraceParameter(HttpServletRequest request) {
         String parameter = request.getParameter("trace");
         return parameter != null && !"false".equalsIgnoreCase(parameter);
     }
 
     /**
-     * 获取错误编码
-     *
-     * @param request
-     * @return
+     * @description: (never used)获取错误编码
+     * @param: request
+     * @date: 2019-08-15 8:14 PM
+     * @return: org.springframework.http.HttpStatus
      */
     private HttpStatus getStatus(HttpServletRequest request) {
         Integer statusCode = (Integer) request
@@ -175,9 +208,10 @@ private HttpStatus getStatus(HttpServletRequest request) {
     }
 
     /**
-     * 实现错误路径,暂时无用
-     *
-     * @return
+     * @description: 实现错误路径, 暂时无用
+     * @param:
+     * @date: 2019-08-15 8:14 PM
+     * @return: java.lang.String
      */
     @Override
     public String getErrorPath() {

shiro-admin/src/main/java/com/zyd/shiro/controller/ExceptionHandleController.java

@@ -32,14 +32,11 @@
 import java.lang.reflect.UndeclaredThrowableException;
 
 /**
- * 统一异常处理类<br>
- * 捕获程序所有异常，针对不同异常，采取不同的处理方式
- *
- * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @version 1.0
- * @website https://www.zhyd.me
- * @date 2018/4/24 14:37
- * @since 1.0
+ * @project: springboot-shiro
+ * @description: 统一异常处理类:捕获程序所有异常,针对不同异常,采取不同的处理方式
+ * @date: 2019-08-15 7:38 PM
+ * @version: 1.0
+ * @website: https://yubuntu0109.github.io/
  */
 @Slf4j
 @ControllerAdvice
@@ -59,7 +56,7 @@ public ResponseVO handle(Throwable e) {
             log.error(responseStatus.getMessage());
             return ResultUtil.error(responseStatus.getCode(), responseStatus.getMessage());
         }
-        e.printStackTrace(); // 打印异常栈
+        e.printStackTrace(); //打印异常栈
         return ResultUtil.error(CommonConst.DEFAULT_ERROR_CODE, ResponseStatus.ERROR.getMessage());
     }