Skip to content

goqueryvsxpath

BSD-3-Clause 3 2 13,635
58.1 thousand (month) Aug 29 2016 v1.9.2(a month ago)
656 2 14 MIT
Jun 08 2019 58.1 thousand (month) (2 months ago)

goquery brings a syntax and a set of features similar to jQuery to the Go language. goquery is a popular and easy-to-use library for Go that allows you to use a CSS selector-like syntax to select elements from an HTML document.

It is based on Go's net/html package and the CSS Selector library cascadia. Since the net/html parser returns nodes, and not a full-featured DOM tree, jQuery's stateful manipulation functions (like height(), css(), detach()) have been left off.

Also, because the net/html parser requires UTF-8 encoding, so does goquery: it is the caller's responsibility to ensure that the source document provides UTF-8 encoded HTML. See the wiki for various options to do this. Syntax-wise, it is as close as possible to jQuery, with the same function names when possible, and that warm and fuzzy chainable interface. jQuery being the ultra-popular library that it is, I felt that writing a similar HTML-manipulating library was better to follow its API than to start anew (in the same spirit as Go's fmt package), even though some of its methods are less than intuitive (looking at you, index()...).

goquery can download HTML by itself (using built-in http client) though it's not recommended for web scraping as it's likely to be blocked.

xpath is a library for Go that allows you to use XPath expressions to select elements from an HTML document. It is built on top of the html package in the Go standard library, and provides a way to select elements from an HTML document using XPath expressions, which are more powerful and expressive than CSS selectors.

Example Use


package main

import (
  "fmt"
  "github.com/PuerkitoBio/goquery"
)

func main() {
  // Use goquery.NewDocument to load an HTML document
  // This can load from URL
  doc, err := goquery.NewDocument("http://example.com")
  // or HTML string:
  doc, err := goquery.NewDocumentFromReader("some html")
  if err != nil {
    fmt.Println("Error:", err)
    return
  }

  // Use the Selection.Find method to select elements from the document
  doc.Find("a").Each(func(i int, s *goquery.Selection) {
    // Use the Selection.Text method to get the text of the element
    fmt.Println(s.Text())
    // Use the Selection.Attr method to get the value of an attribute
    fmt.Println(s.Attr("href"))
  })
}
package main

import (
  "fmt"
  "github.com/antchfx/xpath"
  "golang.org/x/net/html"
  "strings"
)

func main() {
  // Create an HTML string
  html := `<html>
        <body>
          <div id="content">
            <p>Hello, World!</p>
            <a href="http://example.com">Example</a>
          </div>
        </body>
      </html>`

  // Parse the HTML string into a node tree
  doc, err := html.Parse(strings.NewReader(html))
  if err != nil {
    fmt.Println("Error:", err)
    return
  }

  // Compile the XPath expression
  expr, err := xpath.Compile("//p")
  if err != nil {
    fmt.Println("Error:", err)
    return
  }

  // Use the Evaluate method to select elements from the document
  nodes, err := expr.Evaluate(xpath.NodeNavigator(doc))
  if err != nil {
    fmt.Println("Error:", err)
    return
  }
  if nodes.MoveNext() {
    fmt.Println(nodes.Current().Value())
    // > Hello, World!
  }
}

Alternatives / Similar


Was this page helpful?