htmlparser使用指南.doc

需要做一个垂直搜索引擎，比较了nekohtml和htmlparser 的功能，尽管nekohtml在容错性、性能等方面的口碑好像比htmlparser好（htmlunit也用的是nekohtml），但感觉 nekohtml的测试用例和文档都比htmlparser都少，而且htmlparser基本上能够满足垂直搜索引擎页面处理分析的需求，因此先研究一下htmlparser的使用，有空再研究nekohtml和mozilla html parser的使用。 html的功能还是官方说得最为清楚， 引用 HTML Parser is a Java library used to parse HTML in either a linear or nested fashion. Primarily used for transformation or extraction, it features filters, visitors, custom tags and easy to use JavaBeans. It is a fast, robust and well tested package. The two fundamental use-cases that are handled by the parser are extraction and transformation (the syntheses use-case, where HTML pages are created from scratch, is better handled by other tools closer to the source of data). While prior versions concentrated on data extraction from web pages, Version 1.4 of the HTMLParser has substantial improvements in the area of transforming web pages, with simplified tag creation and editing, and verbatim toHtml() method output. 研究的重点还是extraction的使用，有空再研究transformation的使用。 1、htmlparser对html页面处理的数据结构 color=blue 如图所示，HtmlParser采用了经典的Composite模式，通过RemarkNode、TextNode、TagNode、AbstractNode和Tag来描述HTML页面各元素。 * org.htmlparser.Node： Node接口定义了进行树形结构节点操作的各种典型操作方法，包括： 节点到html文本、text文本的方法：toPlainTextString、toHtml 典型树形结构遍历的方法：getParent、getChildren、getFirstChild、getLastChild、getPreviousSibling、getNextSibling、getText 获取节点对应的树形结构结构的顶级节点Page对象方法：getPage 获取节点起始位置的方法：getStartPosition、getEndPosition Visitor方法遍历节点时候方法：accept (NodeVisitor visitor) Filter方法：collectInto (NodeList list, NodeFilter filter) Object方法：toString、clone * org.htmlparser.nodes.AbstractNode： AbstractNode是形成HTML树形结构抽象基类，实现了Node接口。 在htmlparser中，Node分成三类： RemarkNode：代表Html中的注释 TagNode：标签节点。 TextNode：文本节点 这三类节点都继承AbstractNode。 * org.htmlparser.nodes.TagNode： TagNode包含了对HTML处理的核心的各个类，是所有TAG的基类，其中有分为包含其他TAG的复合节点ComositeTag和不包含其他TAG的叶子节点Tag。 复合节点CompositeTag： AppletTag,BodyTag,Bullet,BulletList,DefinitionList,DefinitionListBullet,Div,FormTag,FrameSetTag,HeadingTag, HeadTag,Html,LabelTag,LinkTag,ObjectTag,ParagraphTag,ScriptTag,SelectTag,Span,StyleTag,TableColumn, TableHeader,TableRow,TableTag,TextareaTag,TitleTag 叶子节点TAG： BaseHrefTag,DoctypeTag,FrameTag,ImageTag,InputTag,JspTag,MetaTag,ProcessingInstructionTag, 2、htmlparser对html页面处理的算法 主要是如下几种方式 Java代码 1. *采用Visitor方式访问Html 2. 3. try 4. Parserparser=newParser(); 5. parser.setURL(””); 6. parser.setEncoding(parser.getEncoding(); 7. NodeVisitorvisitor=newNodeVisitor() 8. publicvoidvisitTag(Tagtag) 9. logger.fatal(”testVisitorAll()Tagnameis:” 10. +tag.getTagName()+”nClassis:” 11. +tag.getClass(); 12. 13. 14. ; 15. 16. parser.visitAllNodesWith(visitor); 17. catch(ParserExceptione) 18. e.printStackTrace(); 19. 20. 21. *采用Filter方式访问html 22. 23. try 24. 25. NodeFilterfilter=newNodeClassFilter(LinkTag.class); 26. Parserparser=newParser(); 27. parser.setURL(””); 28. parser.setEncoding(parser.getEncoding(); 29. NodeListlist=parser.extractAllNodesThatMatch(filter); 30. for(inti=0;ilist.size();i+) 31. LinkTagnode=(LinkTag)list.elementAt(i); 32. logger.fatal(”testLinkTag()Linkis:”+node.extractLink(); 33. 34. catch(Exceptione) 35. e.printStackTrace(); 36. 37. 38. *采用org.htmlparser.beans方式 39. 40. 另外htmlparser还在org.htmlparser.beans中对一些常用的方法进行了封装，以简化操作，例如： 41. 42. Parserparser=newParser(); 43. 44. LinkBeanlinkBean=newLinkBean(); 45. linkBean.setURL(””); 46. URLurls=linkBean.getLinks(); 47. 48. for(inti=0;iurls.length;i+) 49. URLurl=urlsi; 50. logger.fatal(”testLinkBean()-urlis:”+url); 51. 52. 53. 54. 3、htmlparser关键包结构说明 55. 56. htmlparser其实核心代码并不多，好好研究一下其代码，弥补文档不足的问题。同时htmlparser的代码注释和单元测试用例还是很齐全的，也有助于了解htmlparser的用法。 57. 58. 59. 3.1、org.htmlparser 60. 61. 定义了htmlparser的一些基础类。其中最为重要的是Parser类。 62. 63. Parser是htmlparser的最核心的类，其构造函数提供了如下：Parser.createParser(Stringhtml,Stringcharset)、Parser()、Parser(Lexerlexer,ParserFeedbackfb)、Parser(URLConnectionconnection,ParserFeedbackfb)、Parser(Stringresource,ParserFeedbackfeedback)、Parser(Stringresource) 64. 65. 各构造函数的具体用法及含义可以查看其代码，很容易理解。 66. 67. Parser常用的几个方法： 68. 69. *elements获取元素 70. 71. Parserparser=newParser(””); 72. for(NodeIteratori=parser.elements();i.hasMoreElements();) 73. processMyNodes(i.nextNode(); 74. 75. *parse(NodeFilterfilter)：通过NodeFilter方式获取 76. *visitAllNodesWith(NodeVisitorvisitor)：通过Nodevisitor方式 77. *extractAllNodesThatMatch(NodeFilterfilter)：通过NodeFilter方式 78. 79. 3.2、org.htmlparser.beans 80. 81. 对Visitor和Filter的方法进行了封装，定义了针对一些常用html元素操作的bean，简化对常用元素的提取操作。 82. 83. 包括：FilterBean、HTMLLinkBean、HTMLTextBean、LinkBean、StringBean、BeanyBaby等。 84. 3.3、org.htmlparser.nodes 85. 86. 定义了基础的node，包括：AbstractNode、RemarkNode、TagNode、TextNode等。 87. 3.4、org.htmlparser.tags 88. 89. 定义了htmlparser的各种tag。 90. 3.5、org.htmlparser.filters 91. 92. 定义了htmlparser所提供的各种filter，主要通过extractAllNodesThatMatch(NodeFilterfilter)来对html页面指定类型的元素进行过滤，包括：AndFilter、CssSelectorNodeFilter、HasAttributeFilter、HasChildFilter、HasParentFilter、HasSiblingFilter、IsEqualFilter、LinkRegexFilter、LinkStringFilter、NodeClassFilter、NotFilter、OrFilter、RegexFilter、StringFilter、TagNameFilter、XorFilter 93. 3.6、org.htmlparser.visitors 94. 95. 定义了htmlparser所提供的各种visitor，主要通过visitAllNodesWith(NodeVisitorvisitor)来对html页面元素进行遍历，包括：HtmlPage、LinkFindingVisitor、NodeVisitor、ObjectFindingVisitor、StringFindingVisitor、TagFindingVisitor、TextExtractingVisitor、UrlModifyingVisitor 96. 97. 98. 3.7、org.htmlparser.parserapplications 99. 100. 定义了一些实用的工具，包括LinkExtractor、SiteCapturer、StringExtractor、WikiCapturer，这几个类也可以作为htmlparser使用样例。 101. 3.8、org.htmlparser.tests 102. 103. 对各种功能的单元测试用例，也可以作为htmlparser使用的样例。 104. 105. 106. 4、htmlparser的使用样例 107. 108. 109. 110. .URL; 111. 112. importjunit.framework.TestCase; 113. 114. importorg.apache.log4j.Logger; 115. importorg.htmlparser.Node; 116. importorg.htmlparser.NodeFilter; 117. importorg.htmlparser.Parser; 118. importorg.htmlparser.Tag; 119. importorg.htmlparser.beans.LinkBean; 120. importorg.htmlparser.filters.NodeClassFilter; 121. importorg.htmlparser.filters.OrFilter; 122. importorg.htmlparser.filters.TagNameFilter; 123. importorg.htmlparser.tags.HeadTag; 124. importorg.htmlparser.tags.ImageTag; 125. importorg.htmlparser.tags.InputTag; 126. importorg.htmlparser.tags.LinkTag; 127. importorg.htmlparser.tags.OptionTag; 128. importorg.htmlparser.tags.SelectTag; 129. importorg.htmlparser.tags.TableColumn; 130. importorg.htmlparser.tags.TableRow; 131. importorg.htmlparser.tags.TableTag; 132. importorg.htmlparser.tags.TitleTag; 133. importorg.htmlparser.util.NodeIterator; 134. importorg.htmlparser.util.NodeList; 135. importorg.htmlparser.util.ParserException; 136. importorg.htmlparser.visitors.HtmlPage; 137. importorg.htmlparser.visitors.NodeVisitor; 138. importorg.htmlparser.visitors.ObjectFindingVisitor; 139. 140. publicclassParserTestCaseextendsTestCase 141. 142. privatestaticfinalLoggerlogger=Logger.getLogger(ParserTestCase.class); 143. 144. publicParserTestCase(Stringname) 145. super(name); 146. 147. /* 148. *测试ObjectFindVisitor的用法 149. */150. publicvoidtestImageVisitor() 151. try 152. ImageTagimgLink; 153. ObjectFindingVisitorvisitor=newObjectFindingVisitor( 154. ImageTag.class); 155. Parserparser=newParser(); 156. parser.setURL(””); 157. parser.setEncoding(parser.getEncoding(); 158. parser.visitAllNodesWith(visitor); 159. Nodenodes=visitor.getTags(); 160. for(inti=0;inodes.length;i+) 161. imgLink=(ImageTag)nodesi; 162. logger.fatal(”testImageVisitor()ImageURL=“ 163. +imgLink.getImageURL(); 164. logger.fatal(”testImageVisitor()ImageLocation=“ 165. +imgLink.extractImageLocn(); 166. logger.fatal(”testImageVisitor()SRC=“ 167. +imgLink.getAttribute(”SRC”); 168. 169. 170. catch(Exceptione) 171. e.printStackTrace(); 172. 173. 174. /* 175. *测试TagNameFilter用法 176. */177. publicvoidtestNodeFilter() 178. try 179. NodeFilterfilter=newTagNameFilter(”IMG”); 180. Parserparser=newParser(); 181. parser.setURL(””); 182. parser.setEncoding(parser.getEncoding(); 183. NodeListlist=parser.extractAllNodesThatMatch(filter); 184. for(inti=0;ilist.size();i+) 185. logger.fatal(”testNodeFilter()”+list.elementAt(i).toHtml(); 186. 187. catch(Exceptione) 188. e.printStackTrace(); 189. 190. 191. 192. /* 193. *测试NodeClassFilter用法 194. */195. publicvoidtestLinkTag() 196. try 197. 198. NodeFilterfilter=newNodeClassFilter(LinkTag.class); 199. Parserparser=newParser(); 200. parser.setURL(””); 201. parser.setEncoding(parser.getEncoding(); 202. NodeListlist=parser.extractAllNodesThatMatch(filter); 203. for(inti=0;ilist.size();i+) 204. LinkTagnode=(LinkTag)list.elementAt(i); 205. logger.fatal(”testLinkTag()Linkis:”+node.extractLink(); 206. 207. catch(Exceptione) 208. e.printStackTrace(); 209. 210. 211. 212. /* 213. *测试用法 214. */215. publicvoidtestLinkCSS() 216. try 217. 218. Parserparser=newParser(); 219. parser 220. .setInputHTML(”LinkTest” 221. +“” 222. +“” 223. +“”+“”); 224. parser.setEncoding(parser.getEncoding(); 225. NodeListnodeList=null; 226. 227. for(NodeIteratore=parser.elements();e.hasMoreNodes();) 228. Nodenode=e.nextNode(); 229. logger 230. .fatal(”testLinkCSS()”+node.getText() 231. +node.getClass(); 232. 233. 234. catch(Exceptione) 235. e.printStackTrace(); 236. 237. 238. /* 239. *测试OrFilter的用法 240. */241. publicvoidtestOrFilter() 242. NodeFilterinputFilter=newNodeClassFilter(InputTag.class); 243. NodeFilterselectFilter=newNodeClassFilter(SelectTag.class); 244. ParsermyParser; 245. NodeListnodeList=null; 246. 247. try 248. Parserparser=newParser(); 249. parser 250. .setInputHTML(”OrFilterTest” 251. +“” 252. +“” 253. +“” 254. +“” 255. +“” 256. +“” 257. +“12” 258. +“” 259. +“”); 260. 261. parser.setEncoding(parser.getEncoding(); 262. OrFilterlastFilter=newOrFilter(); 263. lastFilter.setPredicates(newNodeFilterselectFilter, 264. inputFilter); 265. nodeList=parser.parse(lastFilter); 266. for(inti=0;i=nodeList.size();i+) 267. if(nodeList.elementAt(i)instanceofInputTag) 268. InputTagtag=(InputTag)nodeList.elementAt(i); 269. logger.fatal(”OrFiltertagnameis:”+tag.getTagName() 270. +”,tagvalueis:”+tag.getAttribute(”value”); 271. 272. if(nodeList.elementAt(i)instanceofSelectTag) 273. SelectTagtag=(SelectTag)nodeList.elementAt(i); 274. NodeListlist=tag.getChildren(); 275. 276. for(intj=0;jlist.size();j+) 277. OptionTagoption=(OptionTag)list.elementAt(j); 278. logger 279. .fatal(”OrFilterOption” 280. +option.getOptionText(); 281. 282. 283. 284. 285. 286. catch(ParserExceptione) 287. e.printStackTrace(); 288. 289. 290. /* 291. *测试对的解析 292. */293. publicvoidtestTable() 294. ParsermyParser; 295. NodeListnodeList=null; 296. myParser=Parser.createParser(”+“” 297. +“1-111-121-13” 298. +“1-211-221-23” 299. +“1-311-321-33” 300. +“” 301. +“2-112-122-13” 302. +“2-212-222-23” 303. +“2-312-322-33” 304. +“”,“GBK”); 305. NodeFiltertableFilter=newNodeClassFilter(TableTag.class); 306. OrFilterlastFilter=newOrFilter(); 307. lastFilter.setPredicates(newNodeFiltertableFilter); 308. try 309. nodeList=myParser.parse(lastFilter); 310. for(inti=0;i=nodeList.size();i+) 311. if(nodeList.elementAt(i)instanceofTableTag) 312. TableTagtag=(TableTag)nodeList.elementAt(i); 313. TableRowrows=tag.getRows(); 314. 315. for(intj=0;jrows.length;j+) 316. TableRowtr=(TableRow)rowsj; 317. TableColumntd=tr.getColumns(); 318. for(intk=0;ktd.length;k+) 319. logger.fatal(”+tdk.toPlainTextString(); 320. 321. 322. 323. 324. 325. 326. 327. catch(ParserExceptione) 328. e.printStackTrace(); 329. 330. 331. /* 332. *测试NodeVisitor的用法，遍历所有节点 333. */334.