How gookit/validate works
Project Type and Purpose
• This is an open-source Go library (not a standalone app) for data validation and filtering.
• It provides generic routines to validate/map/sanitize data from maps, structs, HTTP requests, JSON, form values, etc.
• Key use-cases: struct-tag driven validation, map-based validation, request payload validation, custom rules/filters and i18n error messages.
File Structure Analysis
• Top-level files and dirs:
• go.mod / go.sum – Go module definitions
• cache.go, filtering.go, validate.go, validating.go, validation.go, data_source.go, rule.go, validators.go, util.go, value.go, messages.go
– core packages implementing filters, rules, validation engine, data sources, utilities and messaging
• locales/** – i18n packages (en, zh-CN, zh-TW, ruru)
• _examples/** – sample code (httpdemo, request usage, etc.)
• docs/** – extended documentation (diffs, built-in rules list)
• test files & testdata/ – unit tests and fixtures
• .github/**, CI/YAML – GitHub Actions, Dependabot, issue templates, changelog
• index.html – project homepage
• Patterns & modules:
• DataFace abstraction → MapData, StructData, FormData
• Validation core (Validation struct) → rule parsing, filter execution, error collection
• Registry pattern for built-in/custom validators and filters
• GlobalOption for global configuration
• i18n via locales packages
Insights from README
• Main features: validate Map, Struct, Request; add custom filters/validators; scene support; custom error messages; built-in 70+ validators; filtering/sanitization.
• Integration points: any Go web framework (e.g., Gin, Echo, Chi) by supplying a custom binding validator.
• Extension points: validate.AddValidator/AddFilter (global), v.AddValidator/v.AddFilter (per-instance).
a. Main Components
1. Data Sources (DataFace layer)
• MapData
• StructData
• FormData (URL values, JSON, multipart)
2. Filter Engine
• Built-in filters (gookit/filter)
• Custom filter registry
3. Validation Engine (Validation struct)
• Rule parser
• Rule registry (built-in & custom validators)
• GlobalOption configuration
• Scene management
4. Message & i18n
• Messages.go (default English)
• locales packages (zh-CN, zh-TW, ruru)
• Custom message/label tags and struct methods
5. Error Handling
• Errors collection (Errors type)
• JSON marshal behavior (StopOnError, multi-error)
6. Integration Layer
• HTTP request adapter (validate.FromRequest)
• Framework binding (Gin/Echo custom StructValidator)
7. Examples & Documentation
• _examples
• docs
b. Relationships and Data Flow
• Input data (map/struct/HTTP request) → DataFace
• DataFace.Create() → Validation instance
• Validation pipeline:
1. apply filters → sanitized data
2. apply rules → boolean checks
3. collect errors if any
• Upon success: v.SafeData() / v.BindSafeData() → user struct
• Error output → Errors struct → API response or returned error
• GlobalOption → influences filter/rule engine behavior
• Custom validators/filters registered at startup or per request
c. Architectural Patterns & Principles
• Layered design: DataFace → Validation → Error
• Registry pattern: plug-in validators & filters
• Strategy pattern: filter & validator functions passed around
• Dependency injection via interfaces (DataFace)
• Single responsibility: each package/file has clear role (data source, filter, validation, messaging)
• Extensibility: clear extension points for custom rules, filters, messages, locales
d. Technologies and Frameworks
• Go modules (go.mod)
• Standard library (net/http, time)
• Third-party: gookit/filter, any Go web framework (Gin, Echo, Chi)
• CI: GitHub Actions (Go test, codeql)
• i18n packages under locales/