From 6ebcf7030bdf48c2614d2710e7757a5df1e9a645 Mon Sep 17 00:00:00 2001 From: lsy <18332763730@163.com> Date: Mon, 2 Oct 2017 17:34:04 +0800 Subject: [PATCH] =?UTF-8?q?=E5=AE=8C=E5=96=84=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../BootStarterElasticsearchApplication.java | 10 +++++ .../config/ElasticsearchConfig.java | 20 +++++----- .../elasticsearch/config/package-info.java | 6 +++ .../param/ElasticsearchParamConfig.java | 16 ++++---- .../config/param/package-info.java | 6 +++ .../fast/elasticsearch/package-info.java | 7 ++++ .../BootStartFastdfsClientApplication.java | 10 +++++ .../fast/fastdfs/config/package-info.java | 7 ++++ .../fastdfs/config/param/package-info.java | 7 ++++ .../com/micro/fast/fastdfs/package-info.java | 7 ++++ .../micro/fast/fastdfs/util/package-info.java | 7 ++++ .../java/com/micro/fast/util/AESUtil.java | 37 +++++++------------ .../java/com/micro/fast/util/FileUtils.java | 22 +++++------ .../java/com/micro/fast/util/MD5Util.java | 10 ++--- .../com/micro/fast/util/WatermarkerUtil.java | 12 +++--- .../com/micro/fast/util/package-info.java | 5 ++- .../server/ConfigServerApplication.java | 10 +++++ .../fast/config/server/package-info.java | 6 +++ .../server/EurekaServerApplication.java | 11 +++++- .../fast/eureka/server/package-info.java | 6 +++ .../server2/EurekaServer2Application.java | 11 +++++- .../fast/eureka/server2/package-info.java | 6 +++ 22 files changed, 168 insertions(+), 71 deletions(-) create mode 100644 boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/package-info.java create mode 100644 boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/package-info.java create mode 100644 boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/param/package-info.java create mode 100644 boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/package-info.java create mode 100644 boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/util/package-info.java diff --git a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/BootStarterElasticsearchApplication.java b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/BootStarterElasticsearchApplication.java index 5058630..b2ee258 100644 --- a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/BootStarterElasticsearchApplication.java +++ b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/BootStarterElasticsearchApplication.java @@ -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); } diff --git a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/ElasticsearchConfig.java b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/ElasticsearchConfig.java index f41ba96..e9ba55c 100644 --- a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/ElasticsearchConfig.java +++ b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/ElasticsearchConfig.java @@ -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 { diff --git a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/package-info.java b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/package-info.java index 7e7327a..15c1679 100644 --- a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/package-info.java +++ b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/package-info.java @@ -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; \ No newline at end of file diff --git a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/ElasticsearchParamConfig.java b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/ElasticsearchParamConfig.java index f4a6990..bd62c9b 100644 --- a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/ElasticsearchParamConfig.java +++ b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/ElasticsearchParamConfig.java @@ -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 hosts; + /** - * elasticsearch客户端Settings类的配置参数 key:value数组的形式,至少要有一个 + * elasticsearch客户端Settings类的配置参数 key:value数组的形式,至少要有一个. */ @NotNull private ArrayList settings; diff --git a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/package-info.java b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/package-info.java index 5cf8fb7..45f6935 100644 --- a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/package-info.java +++ b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/config/param/package-info.java @@ -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; \ No newline at end of file diff --git a/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/package-info.java b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/package-info.java new file mode 100644 index 0000000..4c08427 --- /dev/null +++ b/boot-starter-elasticsearch/src/main/java/com/micro/fast/elasticsearch/package-info.java @@ -0,0 +1,7 @@ +/** + * elasticsearch模块包 + * @author lishouyu 18332763730@163.com 2017/10/02 + * @version 1.0 + * @since 1.0 + */ +package com.micro.fast.elasticsearch; \ No newline at end of file diff --git a/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/BootStartFastdfsClientApplication.java b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/BootStartFastdfsClientApplication.java index d9177a9..35b54d9 100644 --- a/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/BootStartFastdfsClientApplication.java +++ b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/BootStartFastdfsClientApplication.java @@ -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); } diff --git a/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/package-info.java b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/package-info.java new file mode 100644 index 0000000..13c49fd --- /dev/null +++ b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/package-info.java @@ -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; \ No newline at end of file diff --git a/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/param/package-info.java b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/param/package-info.java new file mode 100644 index 0000000..9f28240 --- /dev/null +++ b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/config/param/package-info.java @@ -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; \ No newline at end of file diff --git a/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/package-info.java b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/package-info.java new file mode 100644 index 0000000..43e2254 --- /dev/null +++ b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/package-info.java @@ -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; \ No newline at end of file diff --git a/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/util/package-info.java b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/util/package-info.java new file mode 100644 index 0000000..a06d3c3 --- /dev/null +++ b/boot-starter-fastdfs-client/src/main/java/com/micro/fast/fastdfs/util/package-info.java @@ -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; \ No newline at end of file diff --git a/boot-starter-util/src/main/java/com/micro/fast/util/AESUtil.java b/boot-starter-util/src/main/java/com/micro/fast/util/AESUtil.java index 523829a..0dbb40b 100644 --- a/boot-starter-util/src/main/java/com/micro/fast/util/AESUtil.java +++ b/boot-starter-util/src/main/java/com/micro/fast/util/AESUtil.java @@ -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 { diff --git a/boot-starter-util/src/main/java/com/micro/fast/util/FileUtils.java b/boot-starter-util/src/main/java/com/micro/fast/util/FileUtils.java index d4e9592..357578e 100644 --- a/boot-starter-util/src/main/java/com/micro/fast/util/FileUtils.java +++ b/boot-starter-util/src/main/java/com/micro/fast/util/FileUtils.java @@ -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(); diff --git a/boot-starter-util/src/main/java/com/micro/fast/util/MD5Util.java b/boot-starter-util/src/main/java/com/micro/fast/util/MD5Util.java index 6d1c52d..4303b15 100644 --- a/boot-starter-util/src/main/java/com/micro/fast/util/MD5Util.java +++ b/boot-starter-util/src/main/java/com/micro/fast/util/MD5Util.java @@ -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); - } } diff --git a/boot-starter-util/src/main/java/com/micro/fast/util/WatermarkerUtil.java b/boot-starter-util/src/main/java/com/micro/fast/util/WatermarkerUtil.java index c6c939a..6582ab0 100644 --- a/boot-starter-util/src/main/java/com/micro/fast/util/WatermarkerUtil.java +++ b/boot-starter-util/src/main/java/com/micro/fast/util/WatermarkerUtil.java @@ -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(); diff --git a/boot-starter-util/src/main/java/com/micro/fast/util/package-info.java b/boot-starter-util/src/main/java/com/micro/fast/util/package-info.java index 1f7d1f4..6d056f9 100644 --- a/boot-starter-util/src/main/java/com/micro/fast/util/package-info.java +++ b/boot-starter-util/src/main/java/com/micro/fast/util/package-info.java @@ -1,4 +1,7 @@ /** - * 常用工具类模块 + * 常用工具类包 + * @author lishouyu 18332763730@163.com 2017/08/21 + * @version 1.0 + * @since 1.0 */ package com.micro.fast.util; \ No newline at end of file diff --git a/config-server/src/main/java/com/micro/fast/config/server/ConfigServerApplication.java b/config-server/src/main/java/com/micro/fast/config/server/ConfigServerApplication.java index fd43955..ddfd625 100644 --- a/config-server/src/main/java/com/micro/fast/config/server/ConfigServerApplication.java +++ b/config-server/src/main/java/com/micro/fast/config/server/ConfigServerApplication.java @@ -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); } diff --git a/config-server/src/main/java/com/micro/fast/config/server/package-info.java b/config-server/src/main/java/com/micro/fast/config/server/package-info.java index 48b1910..dfd39e9 100644 --- a/config-server/src/main/java/com/micro/fast/config/server/package-info.java +++ b/config-server/src/main/java/com/micro/fast/config/server/package-info.java @@ -1 +1,7 @@ +/** + * 配置中心模块包 + * @author lishouyu 18332763730@163.com 2017/10/02 + * @version 1.0 + * @since 1.0 + */ package com.micro.fast.config.server; \ No newline at end of file diff --git a/eureka-server/src/main/java/com/micro/fast/eureka/server/EurekaServerApplication.java b/eureka-server/src/main/java/com/micro/fast/eureka/server/EurekaServerApplication.java index 3e9cc16..5414844 100644 --- a/eureka-server/src/main/java/com/micro/fast/eureka/server/EurekaServerApplication.java +++ b/eureka-server/src/main/java/com/micro/fast/eureka/server/EurekaServerApplication.java @@ -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); } diff --git a/eureka-server/src/main/java/com/micro/fast/eureka/server/package-info.java b/eureka-server/src/main/java/com/micro/fast/eureka/server/package-info.java index 0bdb093..88e01d5 100644 --- a/eureka-server/src/main/java/com/micro/fast/eureka/server/package-info.java +++ b/eureka-server/src/main/java/com/micro/fast/eureka/server/package-info.java @@ -1 +1,7 @@ +/** + * 注册中心1模块包 + * @author lishouyu 18332763730@163.com 2017/10/02 + * @version 1.0 + * @since 1.0 + */ package com.micro.fast.eureka.server; \ No newline at end of file diff --git a/eureka-server2/src/main/java/com/micro/fast/eureka/server2/EurekaServer2Application.java b/eureka-server2/src/main/java/com/micro/fast/eureka/server2/EurekaServer2Application.java index 370a552..54f71ba 100644 --- a/eureka-server2/src/main/java/com/micro/fast/eureka/server2/EurekaServer2Application.java +++ b/eureka-server2/src/main/java/com/micro/fast/eureka/server2/EurekaServer2Application.java @@ -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); } diff --git a/eureka-server2/src/main/java/com/micro/fast/eureka/server2/package-info.java b/eureka-server2/src/main/java/com/micro/fast/eureka/server2/package-info.java index 4945ede..5866ba8 100644 --- a/eureka-server2/src/main/java/com/micro/fast/eureka/server2/package-info.java +++ b/eureka-server2/src/main/java/com/micro/fast/eureka/server2/package-info.java @@ -1 +1,7 @@ +/** + * 注册中心启动类 + * @author lishouyu 18332763730@163.com 2017/10/02 + * @version 1.0 + * @since 1.0 + */ package com.micro.fast.eureka.server2; \ No newline at end of file