Golang 大小写转换与首字母缩略词处理库 kace 使用指南

kace 是一个用于处理字符串大小写转换和首字母缩略词(acronyms)的 Go 语言库，它提供了多种命名格式的转换功能。

安装

go get github.com/codemodus/kace

基本功能

1. 大小写转换

kace 提供了以下几种常见的大小写转换方法：

package main

import (
	"fmt"
	"github.com/codemodus/kace"
)

func main() {
	str := "hello_world-example"

	// 转换为小驼峰 (camelCase)
	camel := kace.Camel(str)
	fmt.Println(camel) // "helloWorldExample"

	// 转换为大驼峰 (PascalCase)
	pascal := kace.Pascal(str)
	fmt.Println(pascal) // "HelloWorldExample"

	// 转换为蛇形 (snake_case)
	snake := kace.Snake(str)
	fmt.Println(snake) // "hello_world_example"

	// 转换为大蛇形 (SCREAMING_SNAKE_CASE)
	screamingSnake := kace.ScreamingSnake(str)
	fmt.Println(screamingSnake) // "HELLO_WORLD_EXAMPLE"

	// 转换为短横线 (kebab-case)
	kebab := kace.Kebab(str)
	fmt.Println(kebab) // "hello-world-example"

	// 转换为大短横线 (SCREAMING-KEBAB-CASE)
	screamingKebab := kace.ScreamingKebab(str)
	fmt.Println(screamingKebab) // "HELLO-WORLD-EXAMPLE"
}

2. 自定义首字母缩略词处理

kace 允许你自定义首字母缩略词的处理方式，这在处理特定领域的术语时非常有用。

package main

import (
	"fmt"
	"github.com/codemodus/kace"
)

func main() {
	// 创建自定义转换器，指定缩略词
	k := kace.New(map[string]string{
		"id":  "ID",
		"url": "URL",
		"api": "API",
	})

	str := "user_id,api_url,http_api"

	// 使用自定义转换器
	fmt.Println(k.Camel(str))  // "userID,apiURL,httpAPI"
	fmt.Println(k.Pascal(str)) // "UserID,APIURL,HTTPAPI"
	fmt.Println(k.Snake(str))  // "user_id,api_url,http_api"
}

高级用法

1. 自定义分隔符

kace 默认识别以下分隔符：空格、下划线(_)、短横线(-)和点(.)。你也可以自定义分隔符：

package main

import (
	"fmt"
	"github.com/codemodus/kace"
)

func main() {
	// 创建自定义转换器，添加斜杠(/)作为分隔符
	k := kace.NewWithSep(nil, []rune{'/'})

	str := "user/id/api/version"
	
	fmt.Println(k.Camel(str))  // "userIDAPIVersion"
	fmt.Println(k.Snake(str))  // "user_id_api_version"
}

2. 处理混合大小写字符串

kace 能够智能处理已经包含大小写的字符串：

package main

import (
	"fmt"
	"github.com/codemodus/kace"
)

func main() {
	str := "XMLHttpRequest"

	fmt.Println(kace.Snake(str))      // "xml_http_request"
	fmt.Println(kace.Kebab(str))      // "xml-http-request"
	fmt.Println(kace.Camel(str))      // "xmlHttpRequest"
	fmt.Println(kace.Pascal(str))     // "XMLHTTPRequest"
}

实际应用示例

数据库字段名与结构体字段名转换

package main

import (
	"fmt"
	"github.com/codemodus/kace"
)

type User struct {
	ID        int
	FirstName string
	LastName  string
	APIKey    string
}

func main() {
	dbFields := []string{"user_id", "first_name", "last_name", "api_key"}

	for _, field := range dbFields {
		// 将数据库字段名转换为结构体字段名
		structField := kace.Pascal(field)
		fmt.Printf("%s -> %s\n", field, structField)
	}
	// 输出:
	// user_id -> UserID
	// first_name -> FirstName
	// last_name -> LastName
	// api_key -> APIKey
}

处理特殊缩略词

package main

import (
	"fmt"
	"github.com/codemodus/kace"
)

func main() {
	// 自定义缩略词处理
	k := kace.New(map[string]string{
		"tcp":  "TCP",
		"ip":   "IP",
		"http": "HTTP",
		"json": "JSON",
	})

	terms := []string{"tcp_port", "ip_address", "http_request", "json_data"}

	for _, term := range terms {
		fmt.Printf("%s -> %s\n", term, k.Pascal(term))
	}
	// 输出:
	// tcp_port -> TCPPort
	// ip_address -> IPAddress
	// http_request -> HTTPRequest
	// json_data -> JSONData
}

性能考虑

kace 在设计时考虑了性能因素，所有转换函数都是无状态的，可以安全地在并发环境中使用。对于需要频繁转换的场景，建议创建并重用自定义的转换器实例。

kace 是一个轻量级但功能强大的库，特别适合需要处理多种命名格式转换的项目，如代码生成器、ORM工具、API客户端等场景。