Purell 使用与技术文档

1. 安装指南

Purell 是一个用 Go 语言编写的用于标准化 URL 的库。安装 Purell 非常简单，您可以使用以下命令：

go get github.com/PuerkitoBio/purell

这将自动下载并安装 Purell 到您的 Go 工作环境中。

2. 项目的使用说明

Purell 提供了几个方法来标准化 URL。以下是如何在您的代码中使用 Purell 的示例：

package main

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

func main() {
  normalized, err := purell.NormalizeURLString("hTTp://someWEBsite.com:80/Amazing%3f/url/",
    purell.FlagLowercaseScheme|purell.FlagLowercaseHost|purell.FlagUppercaseEscapes)
  if err != nil {
    panic(err)
  }
  fmt.Println(normalized)
}

在这个例子中，我们使用了 NormalizeURLString 函数来标准化一个字符串形式的 URL。我们还应用了一些标志来指定我们想要的标准化类型。

3. 项目API使用文档

Purell 提供以下 API 方法：

• NormalizeURLString(string, NormalizationFlags) (string, error): 接受一个 URL 字符串和一组标准化标志，返回标准化后的 URL 字符串和可能发生的错误。
• MustNormalizeURLString(string, NormalizationFlags) (string): 与 NormalizeURLString 类似，但如果发生错误，它会引发一个恐慌而不是返回错误。
• NormalizeURL(*url.URL, NormalizationFlags) (string): 接受一个 url.URL 对象和一组标准化标志，返回标准化后的 URL 字符串。

以下是可用的标准化标志：

const (
  FlagLowercaseScheme           NormalizationFlags = 1 << iota
  FlagLowercaseHost
  FlagUppercaseEscapes
  FlagDecodeUnnecessaryEscapes
  FlagEncodeNecessaryEscapes
  FlagRemoveDefaultPort
  FlagRemoveEmptyQuerySeparator
  // 更多标志...
)

这些标志可以组合使用，以控制标准化过程的不同方面。

4. 项目安装方式

项目的安装方式已在安装指南中说明，使用 go get 命令即可完成安装。确保您的 Go 环境已正确设置，并且您有权限访问 GitHub 仓库。

以上就是关于 Purell 的技术文档，它将帮助您更好地理解和使用这个库来标准化 URL。