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

121 lines
2.7 KiB
Go

package utils
import (
"regexp"
)
// L-B 修复:正则预编译到包级变量,避免 IsPhone/IsEmail/IsIPv4/IsIDCard 每次调用
// regexp.MatchString 重编译(高 QPS 下浪费 CPU)。零行为变化。
var (
phoneRE = regexp.MustCompile(`^1[3-9]\d{9}$`)
emailRE = regexp.MustCompile(`^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$`)
ipv4RE = regexp.MustCompile(`^(\d{1,3}\.){3}\d{1,3}$`)
idCardRE = regexp.MustCompile(`^\d{6}(19|20)\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01])\d{3}[\dXx]$`)
)
// IsPhone 检查是否为有效的中国大陆手机号
// 注意: 正则基于当前号段,新号段开放时需更新
func IsPhone(phone string) bool {
return phoneRE.MatchString(phone)
}
// IsEmail 检查是否为有效的邮箱地址
func IsEmail(email string) bool {
return emailRE.MatchString(email)
}
// IsIPv4 检查是否为有效的 IPv4 地址
func IsIPv4(ip string) bool {
if !ipv4RE.MatchString(ip) {
return false
}
// 验证每个段在 0-255 范围内
parts := splitByDot(ip)
for _, part := range parts {
n := ToInt(part)
if n < 0 || n > 255 {
return false
}
}
return true
}
// IsIDCard 检查是否为有效的中国身份证号(18位)
// 注意: 仅校验格式,不校验校验位
func IsIDCard(id string) bool {
return idCardRE.MatchString(id)
}
// IsChinese 检查字符串是否非空且全部为中文字符(CJK 基本区 U+4E00..U+9FFF)。空串返回 false。
func IsChinese(s string) bool {
for _, r := range s {
if r < 0x4E00 || r > 0x9FFF {
return false
}
}
return len(s) > 0
}
// HasChinese 检查字符串是否包含中文字符
func HasChinese(s string) bool {
for _, r := range s {
if r >= 0x4E00 && r <= 0x9FFF {
return true
}
}
return false
}
// IsNumeric 检查字符串是否全部为数字
func IsNumeric(s string) bool {
if len(s) == 0 {
return false
}
for _, r := range s {
if r < '0' || r > '9' {
return false
}
}
return true
}
// IsAlpha 检查字符串是否全部为字母
func IsAlpha(s string) bool {
if len(s) == 0 {
return false
}
for _, r := range s {
if (r < 'a' || r > 'z') && (r < 'A' || r > 'Z') {
return false
}
}
return true
}
// IsAlphanumeric 检查字符串是否全部为字母或数字
func IsAlphanumeric(s string) bool {
if len(s) == 0 {
return false
}
for _, r := range s {
if (r < 'a' || r > 'z') && (r < 'A' || r > 'Z') && (r < '0' || r > '9') {
return false
}
}
return true
}
// 内部函数
func splitByDot(s string) []string {
var result []string
start := 0
for i := 0; i < len(s); i++ {
if s[i] == '.' {
result = append(result, s[start:i])
start = i + 1
}
}
result = append(result, s[start:])
return result
}