使用bbConvert实现BBCode转HTML并支持自定义标签

bbConvert是一个轻量级的Go库，用于将BBCode转换为HTML，同时支持自定义标签扩展。下面我将介绍如何使用这个库以及如何扩展自定义标签。

基本安装

首先安装bbConvert库：

go get github.com/StalkR/bbconvert

基本用法

package main

import (
	"fmt"
	"github.com/StalkR/bbconvert"
)

func main() {
	// 创建转换器实例
	converter := bbconvert.NewConverter()

	// 示例BBCode文本
	bbcode := `[b]粗体[/b] [i]斜体[/i] [u]下划线[/u]
[url=https://example.com]链接[/url]
[img]https://example.com/image.jpg[/img]
[color=red]红色文字[/color]`

	// 转换为HTML
	html := converter.Convert(bbcode)
	fmt.Println(html)
}

输出结果：

<strong>粗体</strong> <em>斜体</em> <u>下划线</u>
<a href="https://example.com">链接</a>
<img src="https://example.com/image.jpg" alt=""/>
<span style="color:red">红色文字</span>

支持的标准标签

bbConvert默认支持以下BBCode标签：

• [b][/b] → <strong>
• [i][/i] → <em>
• [u][/u] → <u>
• [s][/s] → <del>
• [url][/url] → <a>
• [img][/img] → <img>
• [code][/code] → <pre><code>
• [quote][/quote] → <blockquote>
• [color=…][/color] → <span style="color:...">
• [size=…][/size] → <span style="font-size:...">

自定义标签扩展

bbConvert的强大之处在于可以轻松添加自定义标签处理器：

package main

import (
	"fmt"
	"github.com/StalkR/bbconvert"
)

func main() {
	converter := bbconvert.NewConverter()

	// 添加自定义标签处理器
	converter.AddTag("youtube", func(content, arg string) string {
		if arg == "" {
			return content // 如果没有参数，直接返回内容
		}
		// 返回YouTube嵌入代码
		return fmt.Sprintf(`<iframe width="560" height="315" src="https://www.youtube.com/embed/%s" frameborder="0" allowfullscreen></iframe>`, arg)
	})

	// 添加另一个自定义标签
	converter.AddTag("spoiler", func(content, arg string) string {
		title := "剧透警告"
		if arg != "" {
			title = arg
		}
		return fmt.Sprintf(`<div class="spoiler"><button onclick="this.nextElementSibling.style.display='block'">%s</button><div style="display:none">%s</div></div>`, 
			title, content)
	})

	// 使用自定义标签
	bbcode := `[youtube]dQw4w9WgXcQ[/youtube]
[spoiler=结局剧透]主角最后死了[/spoiler]`

	html := converter.Convert(bbcode)
	fmt.Println(html)
}

输出结果：

<iframe width="560" height="315" src="https://www.youtube.com/embed/dQw4w9WgXcQ" frameborder="0" allowfullscreen></iframe>
<div class="spoiler"><button onclick="this.nextElementSibling.style.display='block'">结局剧透</button><div style="display:none">主角最后死了</div></div>

高级用法：修改默认标签

你也可以覆盖默认的标签处理器：

// 修改默认的[b]标签处理器
converter.AddTag("b", func(content, arg string) string {
	return fmt.Sprintf(`<span style="font-weight:800">%s</span>`, content)
})

// 修改默认的[url]标签处理器，添加nofollow属性
converter.AddTag("url", func(content, arg string) string {
	if arg == "" {
		return fmt.Sprintf(`<a href="%s" rel="nofollow">%s</a>`, content, content)
	}
	return fmt.Sprintf(`<a href="%s" rel="nofollow">%s</a>`, arg, content)
})

安全性考虑

当处理用户输入的BBCode时，应该考虑HTML注入安全问题。bbConvert默认不会对内容进行HTML转义，因此建议：

import "html"

// 安全的标签处理器示例
converter.AddTag("safe", func(content, arg string) string {
	// 对内容进行HTML转义
	escapedContent := html.EscapeString(content)
	return fmt.Sprintf(`<div class="safe-content">%s</div>`, escapedContent)
})

完整示例

下面是一个完整的示例，包含自定义标签和安全性处理：

package main

import (
	"fmt"
	"html"
	"github.com/StalkR/bbconvert"
)

func main() {
	converter := bbconvert.NewConverter()

	// 添加自定义标签
	converter.AddTag("center", func(content, arg string) string {
		return fmt.Sprintf(`<div style="text-align:center">%s</div>`, content)
	})
	
	converter.AddTag("user", func(content, arg string) string {
		escaped := html.EscapeString(content)
		return fmt.Sprintf(`<a href="/user/%s" class="user-mention">@%s</a>`, escaped, escaped)
	})

	// 用户输入的BBCode
	userInput := `[center]居中内容[/center]
[user]<script>alert('xss')</script>[/user]`

	// 转换
	htmlOutput := converter.Convert(userInput)
	fmt.Println(htmlOutput)
}

输出结果：

<div style="text-align:center">居中内容</div>
<a href="/user/&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;" class="user-mention">@&lt;script&gt;alert(&#39;xss&#39;)&lt;/script&gt;</a>

bbConvert是一个灵活且易于扩展的BBCode转换库，通过自定义标签处理器，你可以轻松地扩展它来满足各种需求。