Files
杭州明婳科技 ffcb1a77b9 docs: 注释/文档一致性审查修复(A/B/C 三档共 23 项)
对 60 个非测试源文件做文档/注释/代码一致性审查,修复 23 项。全部为注释/文档
改动 + 1 处死代码删除,无运行逻辑变更,无 breaking change。

A 档·实质错误(10 项,会误导下游):
- app.go: closeResources 三连契约注释统一修正--failAfterInit 走
  rollbackReplacedResources 不走 closeResources,closeResources 仅供 doShutdown 复用
- database/manager.go: RandomPicker 注释从过时的 rand.Intn/issue 54899 改为 crypto/rand
- model/base.go: datetime(0) 与“亚秒精度”矛盾,改为 datetime(6)
- cache/keybuilder.go: 三处示例下划线分隔符改为冒号(与默认分隔符 : 一致)
- repository/repository.go: Delete 接口注释从绝对“软删除”改为条件性;
  UpdateFields 示例移除把字段名当 WHERE 条件的误用写法
- middleware/csrf.go: CSRFToken 注释从“用于 API 模式”改为 Cookie/双重提交模式说明
- examples/full/main.go: POST /users 补上“需 Authorization”标注;删除 _ = app 死代码
- utils/random.go: RandInt/RandInt64 补 min==max 边界说明(对齐 RandIntSecure 写法)

B 档·导出符号注释缺失/不完整(6 项):
- ws/ws.go: 5 个 Type* 常量、4 个 Err* 变量补注释
- console/console.go: 5 个 Level 常量补注释
- jwt/jwt.go: 2 个 Blacklist 常量补注释
- router/router.go: 包级 GroupWithMiddlewareGroup 补注释
- middleware/ratelimit.go: NewRateLimiter 补 panic 条件与 Stop 生命周期说明

C 档·描述不完整(7 项):
- utils/strings.go Substr、convert.go CalcPageCount/CalcOffset、datetime.go
  StartOfMonth/EndOfMonth、file.go CopyFile、validator.go IsChinese、crypto.go HashFile
  补全边界/默认行为/返回值语义
- response/error.go: WithDetail 补 nil 接收者行为说明

验证:go build / go vet / go test -race 全绿。

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-12 18:47:12 +08:00

151 lines
3.2 KiB
Go

package utils
import (
"strings"
"unicode"
"unicode/utf8"
)
// IsBlank 检查字符串是否为空或仅包含空白字符
func IsBlank(s string) bool {
if s == "" {
return true
}
for _, r := range s {
if !unicode.IsSpace(r) {
return false
}
}
return true
}
// IsNotBlank 检查字符串是否非空且不全是空白字符
func IsNotBlank(s string) bool {
return !IsBlank(s)
}
// IsAnyBlank 检查多个字符串中是否有任意一个为空或空白
func IsAnyBlank(strs ...string) bool {
for _, s := range strs {
if IsBlank(s) {
return true
}
}
return false
}
// IsAllBlank 检查所有字符串是否都为空或空白
func IsAllBlank(strs ...string) bool {
for _, s := range strs {
if IsNotBlank(s) {
return false
}
}
return true
}
// DefaultIfBlank 如果字符串为空或空白,返回默认值
func DefaultIfBlank(s, def string) string {
if IsBlank(s) {
return def
}
return s
}
// IsEmpty 检查任意类型是否为空值。
//
// 实际支持(N4 文档修正):nil、空 string、空 []byte。
// 注意:通用 []T / map[K]V 走 default 分支恒返回 false(不为空)——若需对任意 slice/map
// 判空,请用 len() 显式判断。文档原称支持 slice/map 与实现不符,已修正。
func IsEmpty(v any) bool {
if v == nil {
return true
}
switch val := v.(type) {
case string:
return val == ""
case []byte:
return len(val) == 0
default:
return false
}
}
// Trim 去除字符串首尾的空白字符(包括空格、制表符、换行符)
func Trim(s string) string {
return trimFunc(s, unicode.IsSpace)
}
// trimFunc 内部修剪函数
func trimFunc(s string, f func(rune) bool) string {
s = trimLeftFunc(s, f)
return trimRightFunc(s, f)
}
func trimLeftFunc(s string, f func(rune) bool) string {
for i, r := range s {
if !f(r) {
return s[i:]
}
}
return ""
}
func trimRightFunc(s string, f func(rune) bool) string {
for i := len(s); i > 0; {
r, size := utf8.DecodeLastRuneInString(s[:i])
if !f(r) {
return s[:i]
}
i -= size
}
return ""
}
// Substr 截取子字符串(按 Unicode 字符计数)。
// start 支持负数(从末尾计算);start 越界或 length<=0 返回空串;length 超出末尾自动截断。
// 参数: start 起始位置(支持负数从末尾计算),length 截取长度
func Substr(s string, start, length int) string {
runes := []rune(s)
lenRunes := len(runes)
if lenRunes == 0 {
return ""
}
// 处理负数起始位置
if start < 0 {
start = lenRunes + start
}
if start < 0 {
start = 0
}
if start >= lenRunes {
return ""
}
end := start + length
if end > lenRunes {
end = lenRunes
}
if end <= start {
return ""
}
return string(runes[start:end])
}
// StrLen 获取字符串的 Unicode 字符数
func StrLen(s string) int {
return utf8.RuneCountInString(s)
}
// EqualsIgnoreCase 不区分大小写比较字符串。
//
// L-C 修复:改用 strings.EqualFold(标准库 Unicode 大小写折叠)。原实现仅做 ASCII
// 字节级折叠('A'-'Z' → +32),对非 ASCII 字符(如 "É" vs "é")误判为不等。
// EqualFold 同时更快(无逐字节循环开销)。
func EqualsIgnoreCase(a, b string) bool {
return strings.EqualFold(a, b)
}