完善注释

2017-10-02 17:34:04 +08:00
parent 4708dd22ca
commit 6ebcf7030b
22 changed files with 168 additions and 71 deletions
@@ -3,9 +3,19 @@ package com.micro.fast.elasticsearch;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

+/**
+ * elasticsearch的springboot热插拔模块启动类
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
@SpringBootApplication
 public class BootStarterElasticsearchApplication {

+	/**
+	 * elasticsearch的springboot热插拔模块启动方法
+	 * @param args 控制台参数
+	 */
 	public static void main(String[] args) {
 		SpringApplication.run(BootStarterElasticsearchApplication.class, args);
 	}
@@ -16,28 +16,30 @@ import java.net.UnknownHostException;
 import java.util.ArrayList;

 /**
- * 定义elasticsearch客户端的bean
- * create by lishouyu 2017/09/23
- * email 18332763730@163.com
- *
- * last edit lishouyu 2017/09/24
- * email 18332763730@163.com
+ * elasticsearch客户端bean的配置类
+ * @author lishouyu 18332763730@163.com 2017/09/23
+ * @version 1.0
+ * @since 1.0
 */
@Configuration
-public class ElasticsearchConfig {
+public class ElasticsearchConfig  {

  /**
   * 记录es客户端生成日志
   */
  private static final Logger logger = LoggerFactory.getLogger(ElasticsearchParamConfig.class);

+  /**
+   * elasticsearch的客户端配置参数对象
+   * @see com.micro.fast.elasticsearch.config.param.ElasticsearchParamConfig
+   */
  @Autowired
  private ElasticsearchParamConfig elasticsearchParamConfig;

  /**
   * 定义es客户端的bean
-   * @return client
-   * @throws UnknownHostException
+   * @return client 客户端对象
+   * @throws UnknownHostException 未知主机异常
   */
  @Bean("esClient")
  public TransportClient transportClient() throws UnknownHostException {
@@ -1 +1,7 @@
+/**
+ * elasticsearch的springboot热插拔模块配置包
+ * @author lishouyu 18332763730@163.com 2017/09/23
+ * @version 1.0
+ * @since 1.0
+ */
 package com.micro.fast.elasticsearch.config;
@@ -9,25 +9,25 @@ import javax.validation.constraints.NotNull;
 import java.util.ArrayList;

 /**
- * elasticsearch客户端的配置类
- * create by lishouyu 2017/09/24
- * email 18332763730@163.com
- *
- * last edit lishouyu 2017/09/24
- * email 18332763730@163.com
+ * elasticsearch客户端配置参数类,用于接收从applcation.yml中加载的配置信息
+ * @author lishouyu 18332763730@163.com 2017/09/24
+ * @version 1.0
+ * @since 1.0
 */
@Configuration
@ConfigurationProperties(prefix = "elasticsearch")
@AutoConfigureBefore(value = com.micro.fast.elasticsearch.config.ElasticsearchConfig.class)
@Validated
 public class ElasticsearchParamConfig {
+
  /**
-   * elasticsearch集群的ip:port数组,至少要有一个
+   * elasticsearch集群的ip:port数组,至少要有一个.
   */
  @NotNull
  private ArrayList<String> hosts;
+
  /**
-   * elasticsearch客户端Settings类的配置参数 key:value数组的形式,至少要有一个
+   * elasticsearch客户端Settings类的配置参数 key:value数组的形式,至少要有一个.
   */
  @NotNull
  private ArrayList<String> settings;
@@ -1 +1,7 @@
+/**
+ * elasticsearch的springboot热插拔模块配置参数包
+ * @author lishouyu 18332763730@163.com 2017/09/24
+ * @version 1.0
+ * @since 1.0
+ */
 package com.micro.fast.elasticsearch.config.param;
@@ -0,0 +1,7 @@
+/**
+ * elasticsearch模块包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
+package com.micro.fast.elasticsearch;
@@ -3,9 +3,19 @@ package com.micro.fast.fastdfs;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

+/**
+ * fastdfs-client的springboot热插拔模块启动类
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
@SpringBootApplication
 public class BootStartFastdfsClientApplication {

+  /**
+   * fastdfs-client的springboot热插拔模块启动方法
+   * @param args 控制台参数
+   */
 	public static void main(String[] args) {
 		SpringApplication.run(BootStartFastdfsClientApplication.class, args);
 	}
@@ -0,0 +1,7 @@
+/**
+ * fastdfs-client的springboot热插拔模块配置包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
+package com.micro.fast.fastdfs.config;
@@ -0,0 +1,7 @@
+/**
+ * fastdfs-client的springboot热插拔模块配置参数包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
+package com.micro.fast.fastdfs.config.param;
@@ -0,0 +1,7 @@
+/**
+ * fast-client模块包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
+package com.micro.fast.fastdfs;
@@ -0,0 +1,7 @@
+/**
+ * fastdfs-client的工具包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
+package com.micro.fast.fastdfs.util;
@@ -14,26 +14,20 @@ import java.security.SecureRandom;

 /**
 * AES加解密工具类
- * create by lishouyu 2017/08/21
- * email 18332763730@163.com
- *
- * last edit lishouyu 2017/08/21
- * email 18332763730@163.com
+ * @author lishouyu 18332763730@163.com 2017/08/21
+ * @version 1.0
+ * @since 1.0
 */
 public class AESUtil {
-    //编码规则
-    private static final String encodeRules = "li";
+  /**
+   * 编码规则
+   */
+  private static final String encodeRules = "li";

    /**
-     * 加密
-     * 1.构造密钥生成器
-     * 2.根据ecnodeRules规则初始化密钥生成器
-     * 3.产生密钥
-     * 4.创建和初始化密码器
-     * 5.内容加密
-     * 6.返回字符串
-     * @param content
-     * @return
+     * 对字符串进行加密
+     * @param content 需要加密的字符串
+     * @return AES_encode 加密后的字符串
     */
    public static String AESEncode(String content){
        try{
@@ -83,14 +77,9 @@ public class AESUtil {
    }

    /**
-     * 1.构造密钥生成器
-     * 2.根据encodeRules初始化密钥生成器
-     * 3.产生密钥
-     * 4.创建和初始化密码器
-     * 5.根据密钥对内容解密
-     * 6.返回字符串
-     * @param content
-     * @return
+     * 对字符串进行解密
+     * @param content 需要解密的字符串
+     * @return AES_decode 解密后的字符串
     */
    public static String AESDecode(String content){
        try {
@@ -4,20 +4,16 @@ import java.io.File;

 /**
 * 文件操作工具类
- * create by lishouyu 2017/08/27
- * email 18332763730@163.com
- *
- * last edit lishouyu 2017/09/07
- * email 18332763730@163.com
- * 添加递归修改文件夹下所有特定文件的扩展名的方法
+ * @author lishouyu 18332763730@163.com 2017/08/27
+ * @version 1.0
+ * @since 1.0
 */
 public class FileUtils {
  /**
   * 修改文件夹下的所有符合条件的文件的扩展名，递归文件夹下所有文件
-   *
-   * @param dir              文件夹下的路径
-   * @param oldExtensionName 旧的文件扩展名 .jpg
-   * @param newExtensionName 新的文件扩展名 .png
+   * @param dir              文件夹的路径
+   * @param oldExtensionName 旧的文件扩展名 例如：.jpg
+   * @param newExtensionName 新的文件扩展名 例如：.png
   */
  public static void modifyFileExtensionNameInDir(File dir, String oldExtensionName, String newExtensionName) {
    //1.判断输入的文件是否是文件夹
@@ -42,9 +38,9 @@ public class FileUtils {

  /**
   * 修改单个文件的扩展名
-   * @param file
-   * @param oldExtensionName
-   * @param newExtensionName
+   * @param file　文件对象
+   * @param oldExtensionName　旧的文件扩展名 例如：.jpg
+   * @param newExtensionName　新的文件扩展名 例如：.png
   */
  public static void modifyFileExtensionName(File file, String oldExtensionName, String newExtensionName) {
    String fileName = file.getName();
@@ -5,12 +5,9 @@ import java.security.MessageDigest;

 /**
 * MD5加密类
- * create by lishouyu 2017/08/21
- * email 18332763730@163.com
- *
- * last edit lishouyu 2017/08/21
- * email 18332763730@163.com
- *
+ * @author lishouyu 18332763730@163.com 2017/08/21
+ * @version 1.0
+ * @since 1.0
 */
 public class MD5Util {
    /**
@@ -56,6 +53,5 @@ public class MD5Util {
            e.printStackTrace();
        }
        return MD5EncodeUtf8(bytes);
-
    }
 }
@@ -12,12 +12,10 @@ import java.io.IOException;
 import java.util.UUID;

 /**
- * 图片添加水印工具类
- * create by lishouyu 2017/09/05
- * email 18332763730@163.com
- *
- * last edit lishouyu 2017/09/07
- * email 18332763730@163.com
+ * 常用工具类包
+ * @author lishouyu 18332763730@163.com 2017/09/05
+ * @version 1.0
+ * @since 1.0
 */
 public class WatermarkerUtil {

@@ -55,7 +53,7 @@ public class WatermarkerUtil {
   * @param text 要添加的水印的文字内容
   * @param inputImage 输入的图片文件
   * @param filePath 生成图片的输出路径
-   * @return
+   * @return　file　加上水银之后的图片对象
   */
  public File markerWord(String text,File inputImage,String filePath){
    String imageName = inputImage.getName();
@@ -1,4 +1,7 @@
 /**
- * 常用工具类模块
+ * 常用工具类包
+ * @author lishouyu 18332763730@163.com 2017/08/21
+ * @version 1.0
+ * @since 1.0
 */
 package com.micro.fast.util;
@@ -4,10 +4,20 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.config.server.EnableConfigServer;

+/**
+ * 配置中心启动类
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
@SpringBootApplication
@EnableConfigServer //开启配置中心相关服务
 public class ConfigServerApplication {

+	/**
+	 * 配置中心方法　
+	 * @param args 控制台参数
+	 */
 	public static void main(String[] args) {
 		SpringApplication.run(ConfigServerApplication.class, args);
 	}
@@ -1 +1,7 @@
+/**
+ * 配置中心模块包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
 package com.micro.fast.config.server;
@@ -5,10 +5,19 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

+/**
+ * 注册中心启动类
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
@SpringBootApplication
@EnableEurekaServer //开启注册中心相关服务
 public class EurekaServerApplication {
-
+    /**
+     * 注册中心启动类
+     * @param args 控制台参数
+     */
    public static void main(String[] args) {
        SpringApplication.run(EurekaServerApplication.class, args);
    }
@@ -1 +1,7 @@
+/**
+ * 注册中心1模块包
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
 package com.micro.fast.eureka.server;
@@ -4,10 +4,19 @@ import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;

+/**
+ * 注册中心启动类
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
@SpringBootApplication
@EnableEurekaServer    //开启注册中心的相关服务
 public class EurekaServer2Application {
-
+  /**
+   * 注册中心启动类
+   * @param args 控制台参数
+   */
  public static void main(String[] args) {
    SpringApplication.run(EurekaServer2Application.class, args);
  }
@@ -1 +1,7 @@
+/**
+ * 注册中心启动类
+ * @author lishouyu 18332763730@163.com 2017/10/02
+ * @version 1.0
+ * @since 1.0
+ */
 package com.micro.fast.eureka.server2;