Golang高效生成XML网站地图插件库go-sitemap-generator的使用

简介

go-sitemap-generator是Go语言中最简单的生成网站地图(Sitemap)的方式。从2.0.0版本开始，该库已作为Go模块提供。

基本使用示例

package main

import (
    "github.com/ikeikeikeike/go-sitemap-generator/v2/stm"
)

func main() {
    sm := stm.NewSitemap(1)

    // 在添加条目之前必须先调用Create方法
    sm.Create()

    sm.Add(stm.URL{{"loc", "home"}, {"changefreq", "always"}, {"mobile", true}})
    sm.Add(stm.URL{{"loc", "readme"}})
    sm.Add(stm.URL{{"loc", "aboutme"}, {"priority", 0.1}})

    sm.Finalize().PingSearchEngines()
}

安装

作为Go模块安装

go get github.com/ikeikeikeike/go-sitemap-generator/v2/stm

传统安装方式

go get gopkg.in/ikeikeikeike/go-sitemap-generator.v1/stm
go get gopkg.in/ikeikeikeike/go-sitemap-generator.v2/stm

主要特性

• 支持生成多种类型的网站地图：

  • 新闻网站地图
  • 视频网站地图
  • 图片网站地图
  • 地理位置网站地图
  • 移动网站地图
  • 替代链接

• 支持网站地图存储适配器：

  • 文件系统
  • S3存储

• 自定义网站地图工作方式

• 通知搜索引擎(Google, Bing)有新网站地图

• 完全控制网站地图内容和命名方案

详细使用指南

设置并发度

禁用并发(设置为1个CPU):

sm := stm.NewSitemap(1)

使用所有可用CPU:

sm := stm.NewSitemap(0)

禁用非必要输出

sm := stm.NewSitemap(1)
sm.SetVerbose(false)

通知搜索引擎

sm.Finalize().PingSearchEngines()

添加新的搜索引擎:

sm.Finalize().PingSearchEngines("http://newengine.com/ping?url=%s")

配置选项

// 设置网站主机名
sm.SetDefaultHost("http://www.example.com")

// 设置网站地图远程主机
sm.SetSitemapsHost("http://s3.amazonaws.com/sitemap-generator/")

// 设置本地写入路径
sm.SetPublicPath("tmp/")

// 设置网站地图路径
sm.SetSitemapsPath("sitemaps/")

// 设置S3适配器
sm.SetAdapter(&stm.S3Adapter{Region: "ap-northeast-1", Bucket: "your-bucket", ACL: "public-read"})

// 更改输出文件名
sm.SetFilename("new_filename")

高级功能示例

上传到S3

package main

import (
    "github.com/aws/aws-sdk-go/aws/credentials"
    "github.com/ikeikeikeike/go-sitemap-generator/stm"
)

func main() {
    sm := stm.NewSitemap(1)
    sm.SetDefaultHost("http://example.com")
    sm.SetSitemapsPath("sitemap-generator") // 默认: public
    sm.SetSitemapsHost("http://s3.amazonaws.com/sitemap-generator/")
    sm.SetAdapter(&stm.S3Adapter{
        Region: "ap-northeast-1",
        Bucket: "your-bucket",
        ACL:    "public-read",
        Creds:  credentials.NewEnvCredentials(),
    })

    sm.Create()

    sm.Add(stm.URL{{"loc", "home"}, {"changefreq", "always"}, {"mobile", true}})
    sm.Add(stm.URL{{"loc", "readme"}})
    sm.Add(stm.URL{{"loc", "aboutme"}, {"priority", 0.1}})

    sm.Finalize().PingSearchEngines()
}

新闻网站地图

sm.Add(stm.URL{
    {"loc", "/news"},
    {"news", stm.URL{
        {"publication", stm.URL{
            {"name",     "Example"},
            {"language", "en"},
        },
        },
        {"title",            "My Article"},
        {"keywords",         "my article, articles about myself"},
        {"stock_tickers",    "SAO:PETR3"},
        {"publication_date", "2011-08-22"},
        {"access",           "Subscription"},
        {"genres",           "PressRelease"},
    },},
})

视频网站地图

sm.Add(stm.URL{
    {"loc", "/videos"},
    {"video", stm.URL{
        {"thumbnail_loc", "http://www.example.com/video1_thumbnail.png"},
        {"title",         "Title"},
        {"description",   "Description"},
        {"content_loc",   "http://www.example.com/cool_video.mpg"},
        {"category",      "Category"},
        {"tag",           []string{"one", "two", "three"}},
        {"player_loc",    stm.Attrs{"https://example.com/p/flash/moogaloop/6.2.9/moogaloop.swf?clip_id=26", map[string]string{"allow_embed": "Yes", "autoplay": "autoplay=1"}}},
    },
    },
})

图片网站地图

sm.Add(stm.URL{
    {"loc", "/images"},
    {"image", []stm.URL{
        {{"loc", "http://www.example.com/image.png"}, {"title", "Image"}},
        {{"loc", "http://www.example.com/image1.png"}, {"title", "Image1"}},
    },},
})

地理位置网站地图

sm.Add(stm.URL{
    {"loc", "/geos"},
    {"geo", stm.URL{
        {"format", "kml"},
    },},
})

移动网站地图

sm.Add(stm.URL{{"loc", "mobiles"}, {"mobile", true}})

完整示例

package main

import (
    "github.com/ikeikeikeike/go-sitemap-generator/stm"
)

func main() {
    sm := stm.NewSitemap(0)
    sm.SetDefaultHost("http://yourhost.com")
    sm.SetSitemapsHost("http://s3.amazonaws.com/sitemaps/")
    sm.SetSitemapsPath("sitemaps/")
    sm.SetFilename("anothername")
    sm.SetCompress(true)
    sm.SetVerbose(true)
    sm.SetAdapter(&stm.S3Adapter{Region: "ap-northeast-1", Bucket: "your-bucket"})

    sm.Create()

    sm.Add(stm.URL{{"loc", "/home"}, {"changefreq", "daily"}})

    sm.Add(stm.URL{{"loc", "/abouts"}, {"mobile", true}})

    sm.Add(stm.URL{{"loc", "/news"},
    {"news", stm.URL{
        {"publication", stm.URL{
            {"name",     "Example"},
            {"language", "en"},
        },
        },
        {"title",            "My Article"},
        {"keywords",         "my article, articles about myself"},
        {"stock_tickers",    "SAO:PETR3"},
        {"publication_date", "2011-08-22"},
        {"access",           "Subscription"},
        {"genres",           "PressRelease"},
    },},
    })

    sm.Add(stm.URL{{"loc", "/images"},
    {"image", []stm.URL{
        {{"loc", "http://www.example.com/image.png"}, {"title", "Image"}},
        {{"loc", "http://www.example.com/image1.png"}, {"title", "Image1"}},
    },},
    })

    sm.Add(stm.URL{{"loc", "/videos"},
    {"video", stm.URL{
        {"thumbnail_loc", "http://www.example.com/video1_thumbnail.png"},
        {"title",         "Title"},
        {"description",   "Description"},
        {"content_loc",   "http://www.example.com/cool_video.mpg"},
        {"category",      "Category"},
        {"tag",           []string{"one", "two", "three"}},
        {"player_loc",    stm.Attrs{"https://example.com/p/flash/moogaloop/6.2.9/moogaloop.swf?clip_id=26", map[string]string{"allow_embed": "Yes", "autoplay": "autoplay=1"}}},
    },},
    })

    sm.Add(stm.URL{{"loc", "/geos"},
    {"geo", stm.URL{
        {"format", "kml"},
    },},
    })

    sm.Finalize().PingSearchEngines("http://newengine.com/ping?url=%s")
}

Web服务器示例

package main

import (
    "log"
    "net/http"

    "github.com/ikeikeikeike/go-sitemap-generator/stm"
)

func buildSitemap() *stm.Sitemap {
    sm := stm.NewSitemap(1)
    sm.SetDefaultHost("http://example.com")

    sm.Create()
    sm.Add(stm.URL{{"loc", "/"}, {"changefreq", "daily"}})

    // 注意: 不要调用sm.Finalize()，因为它会将底层数据结构从内存刷新到磁盘
    
    return sm
}

func main() {
    sm := buildSitemap()

    mux := http.NewServeMux()
    mux.HandleFunc("/sitemap.xml", func(w http.ResponseWriter, r *http.Request) {
        // Go的web服务器会自动设置正确的Content-Type头
        w.Write(sm.XMLContent())
        return
    })

    log.Fatal(http.ListenAndServe(":8080", mux))
}

测试

准备:

$ go get github.com/clbanning/mxj

运行测试:

$ go test -v -cover -race ./...