From a10893c9efa1478cea92fb9549691df00d183243 Mon Sep 17 00:00:00 2001 From: xtuhcy Date: Thu, 3 Nov 2016 10:44:58 +0800 Subject: [PATCH] =?UTF-8?q?=E6=95=B4=E7=90=86javadoc=EF=BC=8C=E5=8E=BB?= =?UTF-8?q?=E9=99=A4=E9=94=99=E8=AF=AF=E5=92=8C=E8=AD=A6=E5=91=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../com/geccocrawler/gecco/GeccoEngine.java | 4 +- .../gecco/annotation/Downloader.java | 2 +- .../geccocrawler/gecco/annotation/Gecco.java | 2 +- .../geccocrawler/gecco/annotation/Html.java | 2 +- .../gecco/downloader/AbstractDownloader.java | 4 +- .../gecco/dynamic/DynamicBean.java | 15 ++-- .../gecco/dynamic/DynamicField.java | 14 ++-- .../gecco/dynamic/GeccoClassLoader.java | 2 +- .../gecco/dynamic/JavassistDynamicBean.java | 2 - .../gecco/listener/EventListener.java | 78 +++++++++---------- .../gecco/monitor/DownloadMonitor.java | 4 +- .../spider/render/html/JSVarFieldRender.java | 8 +- .../gecco/utils/DownloadImage.java | 2 +- .../gecco/utils/ReflectUtils.java | 6 +- .../geccocrawler/gecco/utils/UrlUtils.java | 4 +- 15 files changed, 72 insertions(+), 77 deletions(-) diff --git a/src/main/java/com/geccocrawler/gecco/GeccoEngine.java b/src/main/java/com/geccocrawler/gecco/GeccoEngine.java index 1fbb2b93..bc3f7abb 100644 --- a/src/main/java/com/geccocrawler/gecco/GeccoEngine.java +++ b/src/main/java/com/geccocrawler/gecco/GeccoEngine.java @@ -87,7 +87,7 @@ private GeccoEngine() { /** * 动态配置规则不能使用该方法构造GeccoEngine * - * @return + * @return GeccoEngine */ public static GeccoEngine create() { GeccoEngine geccoEngine = new GeccoEngine(); @@ -363,7 +363,7 @@ public void closeUnitlComplete() { /** * 启动引擎，并返回GeccoEngine对象 * - * @return + * @return GeccoEngine */ public GeccoEngine engineStart() { start(); diff --git a/src/main/java/com/geccocrawler/gecco/annotation/Downloader.java b/src/main/java/com/geccocrawler/gecco/annotation/Downloader.java index caa35719..f7a6d7ee 100644 --- a/src/main/java/com/geccocrawler/gecco/annotation/Downloader.java +++ b/src/main/java/com/geccocrawler/gecco/annotation/Downloader.java @@ -14,7 +14,7 @@ /** * 下载器名称 * - * @return + * @return 下载器名称 */ String value(); diff --git a/src/main/java/com/geccocrawler/gecco/annotation/Gecco.java b/src/main/java/com/geccocrawler/gecco/annotation/Gecco.java index bc77df15..0fe09198 100644 --- a/src/main/java/com/geccocrawler/gecco/annotation/Gecco.java +++ b/src/main/java/com/geccocrawler/gecco/annotation/Gecco.java @@ -29,7 +29,7 @@ /** * 下载超时时间 * - * @return + * @return 下载超时时间 */ int timeout() default 3000; diff --git a/src/main/java/com/geccocrawler/gecco/annotation/Html.java b/src/main/java/com/geccocrawler/gecco/annotation/Html.java index c696300b..c126a27e 100644 --- a/src/main/java/com/geccocrawler/gecco/annotation/Html.java +++ b/src/main/java/com/geccocrawler/gecco/annotation/Html.java @@ -25,7 +25,7 @@ * * * @author LiuJunGuang - * @return + * @return 是否取外部Html */ public boolean outer() default false; } diff --git a/src/main/java/com/geccocrawler/gecco/downloader/AbstractDownloader.java b/src/main/java/com/geccocrawler/gecco/downloader/AbstractDownloader.java index 7cf31005..23e7aae7 100644 --- a/src/main/java/com/geccocrawler/gecco/downloader/AbstractDownloader.java +++ b/src/main/java/com/geccocrawler/gecco/downloader/AbstractDownloader.java @@ -45,8 +45,8 @@ protected String getCharset(String requestCharset, String contentType) { /** * 将原始的inputStream转换为ByteArrayInputStream使raw可以重复使用 * - * @param in - * @return + * @param in 原始的inputStream + * @return 可以重复使用的ByteArrayInputStream */ protected ByteArrayInputStream toByteInputStream(InputStream in) { ByteArrayInputStream bis = null; diff --git a/src/main/java/com/geccocrawler/gecco/dynamic/DynamicBean.java b/src/main/java/com/geccocrawler/gecco/dynamic/DynamicBean.java index 4d52fe29..0d6107af 100644 --- a/src/main/java/com/geccocrawler/gecco/dynamic/DynamicBean.java +++ b/src/main/java/com/geccocrawler/gecco/dynamic/DynamicBean.java @@ -42,8 +42,8 @@ public interface DynamicBean { /** * 由于有歧义，已经被existField代替 * - * @param fieldName - * @return + * @param fieldName 字段名称 + * @return DynamicField */ @Deprecated public DynamicField field(String fieldName); @@ -53,7 +53,7 @@ public interface DynamicBean { * * @param fieldName 字段名称 * @param fieldType 字段类型 - * @return + * @return DynamicField */ public DynamicField field(String fieldName, CtClass fieldType); @@ -62,7 +62,8 @@ public interface DynamicBean { /** * 删除一个属性 * - * @param fieldName + * @param fieldName 字段名 + * @return DynamicBean */ public DynamicBean removeField(String fieldName); @@ -127,14 +128,14 @@ public interface DynamicBean { * 将加载的bean注册到爬虫引擎中。 * 主要应用在先定义Bean后期的爬虫引擎的情况。 * - * @return + * @return spiderBeanClass */ public Class register(); /** * 加载bean到classloader中 * - * @return + * @return spiderBeanClass */ public Class loadClass(); @@ -146,7 +147,7 @@ public interface DynamicBean { /** * Constant pool table. * - * @return + * @return ConstPool */ public ConstPool getConstPool(); } diff --git a/src/main/java/com/geccocrawler/gecco/dynamic/DynamicField.java b/src/main/java/com/geccocrawler/gecco/dynamic/DynamicField.java index dd92c2b8..6352094b 100644 --- a/src/main/java/com/geccocrawler/gecco/dynamic/DynamicField.java +++ b/src/main/java/com/geccocrawler/gecco/dynamic/DynamicField.java @@ -5,12 +5,12 @@ public interface DynamicField { -/** - * 动态生成属性注解 - * - * @return - */ -public DynamicField request(); + /** + * 动态生成属性注解 + * + * @return DynamicField + */ + public DynamicField request(); public DynamicField requestParameter(String param); @@ -18,6 +18,8 @@ public interface DynamicField { /** * replace by csspath + * @param cssPath cssPath + * @return DynamicField */ @Deprecated public DynamicField htmlField(String cssPath); diff --git a/src/main/java/com/geccocrawler/gecco/dynamic/GeccoClassLoader.java b/src/main/java/com/geccocrawler/gecco/dynamic/GeccoClassLoader.java index 46bccb46..063727cf 100644 --- a/src/main/java/com/geccocrawler/gecco/dynamic/GeccoClassLoader.java +++ b/src/main/java/com/geccocrawler/gecco/dynamic/GeccoClassLoader.java @@ -16,7 +16,7 @@ public class GeccoClassLoader extends ClassLoader { /** * 创建一个新的GeccoClassLoader - * @return + * @return GeccoClassLoader */ public static synchronized GeccoClassLoader create() { if(instance != null) { diff --git a/src/main/java/com/geccocrawler/gecco/dynamic/JavassistDynamicBean.java b/src/main/java/com/geccocrawler/gecco/dynamic/JavassistDynamicBean.java index e09d0c14..890ad173 100644 --- a/src/main/java/com/geccocrawler/gecco/dynamic/JavassistDynamicBean.java +++ b/src/main/java/com/geccocrawler/gecco/dynamic/JavassistDynamicBean.java @@ -64,8 +64,6 @@ public JavassistDynamicBean(String spiderBeanName) { * 名称 * @param beanType * 类型html/json - * @param create - * 是否新建类和属性。true表示创建写的类和属性已经setter/getter方法，false表示只动态生成注解 */ public JavassistDynamicBean(String spiderBeanName, String beanType) { try { diff --git a/src/main/java/com/geccocrawler/gecco/listener/EventListener.java b/src/main/java/com/geccocrawler/gecco/listener/EventListener.java index 50b8cfe1..37bab192 100644 --- a/src/main/java/com/geccocrawler/gecco/listener/EventListener.java +++ b/src/main/java/com/geccocrawler/gecco/listener/EventListener.java @@ -1,39 +1,39 @@ -package com.geccocrawler.gecco.listener; - -import com.geccocrawler.gecco.GeccoEngine; - -/** - * 爬虫引擎生命周期监听器 - * - * @author LiuJunGuang - */ -public interface EventListener { - - /** - * 开始启动时，回调 - * - * @param ge - */ - public void onStart(GeccoEngine ge); - - /** - * 暂停时，回调 - * - * @param ge - */ - public void onPause(GeccoEngine ge); - - /** - * 恢复抓取时，回调 - * - * @param ge - */ - public void onRestart(GeccoEngine ge); - - /** - * 引擎停止时，回调 - * - * @param ge - */ - public void onStop(GeccoEngine ge); -} +package com.geccocrawler.gecco.listener; + +import com.geccocrawler.gecco.GeccoEngine; + +/** + * 爬虫引擎生命周期监听器 + * + * @author LiuJunGuang + */ +public interface EventListener { + + /** + * 开始启动时，回调 + * + * @param ge GeccoEngine + */ + public void onStart(GeccoEngine ge); + + /** + * 暂停时，回调 + * + * @param ge GeccoEngine + */ + public void onPause(GeccoEngine ge); + + /** + * 恢复抓取时，回调 + * + * @param ge GeccoEngine + */ + public void onRestart(GeccoEngine ge); + + /** + * 引擎停止时，回调 + * + * @param ge GeccoEngine + */ + public void onStop(GeccoEngine ge); +} diff --git a/src/main/java/com/geccocrawler/gecco/monitor/DownloadMonitor.java b/src/main/java/com/geccocrawler/gecco/monitor/DownloadMonitor.java index c103d548..9b3f4df3 100644 --- a/src/main/java/com/geccocrawler/gecco/monitor/DownloadMonitor.java +++ b/src/main/java/com/geccocrawler/gecco/monitor/DownloadMonitor.java @@ -31,8 +31,8 @@ public static Map getStatistics() { /** * 双重检查机制锁 * - * @param host - * @return + * @param host host + * @return DownloadStatistics */ public static DownloadStatistics getStatistics(String host) { DownloadStatistics downloadStatistics = statistics.get(host); diff --git a/src/main/java/com/geccocrawler/gecco/spider/render/html/JSVarFieldRender.java b/src/main/java/com/geccocrawler/gecco/spider/render/html/JSVarFieldRender.java index a65481fa..e9e7ff02 100644 --- a/src/main/java/com/geccocrawler/gecco/spider/render/html/JSVarFieldRender.java +++ b/src/main/java/com/geccocrawler/gecco/spider/render/html/JSVarFieldRender.java @@ -27,13 +27,7 @@ import net.sf.cglib.beans.BeanMap; /** - *
  • java.lang.Boolean objects
    • - *
  • java.lang.String objects
    • - *
  • java.lang.Number objects
    • - *
  • org.mozilla.javascript.Scriptable objects
    • - *
  • null
    • - *
  • The value returned by Context.getUndefinedValue()
    • - *
  • NOT_FOUND
    • + * 解析页面中的javascript变量 * * @author huchengyi * diff --git a/src/main/java/com/geccocrawler/gecco/utils/DownloadImage.java b/src/main/java/com/geccocrawler/gecco/utils/DownloadImage.java index 3a0ce414..d4893166 100644 --- a/src/main/java/com/geccocrawler/gecco/utils/DownloadImage.java +++ b/src/main/java/com/geccocrawler/gecco/utils/DownloadImage.java @@ -29,7 +29,7 @@ public class DownloadImage { * * @param parentPath 指定目录 * @param imgUrl 图片地址 - * @return + * @return 下载文件地址 */ public static String download(String parentPath, String imgUrl) { if(Strings.isNullOrEmpty(imgUrl) || Strings.isNullOrEmpty(parentPath)) { diff --git a/src/main/java/com/geccocrawler/gecco/utils/ReflectUtils.java b/src/main/java/com/geccocrawler/gecco/utils/ReflectUtils.java index 8af9d11b..2877c178 100644 --- a/src/main/java/com/geccocrawler/gecco/utils/ReflectUtils.java +++ b/src/main/java/com/geccocrawler/gecco/utils/ReflectUtils.java @@ -22,7 +22,7 @@ public class ReflectUtils { /** * 获得类的所有基类和接口 * - * @param clazz + * @param clazz 类 * @return 所有基类的集合 */ public static Set> getAllSuperType(Class clazz) { @@ -50,8 +50,8 @@ public static boolean haveSuperType(Class childClazz, Class superClazz) { /** * 是否继承某个基类 * - * @param bean - * @param superClazz + * @param bean 需要判断的对象bean + * @param superClazz 基类 * @return 是否继承某个基类 */ public static boolean haveSuperType(Object bean, Class superClazz) { diff --git a/src/main/java/com/geccocrawler/gecco/utils/UrlUtils.java b/src/main/java/com/geccocrawler/gecco/utils/UrlUtils.java index e5471035..41734d17 100644 --- a/src/main/java/com/geccocrawler/gecco/utils/UrlUtils.java +++ b/src/main/java/com/geccocrawler/gecco/utils/UrlUtils.java @@ -8,8 +8,8 @@ public class UrlUtils { * 相对地址转绝对地址 * * @param absolutePath 当前绝对地址 - * @param relativeUrl 相对地址 - * @return + * @param relativePath 相对地址 + * @return 绝对地址 */ public static String relative2Absolute(String absolutePath, String relativePath) { if(relativePath == null) {