xxjwxc/uber_go_guide_cn
Uber Go Guide Cn
This project is a translated Go language style guide and programming standard. It provides a collection of coding standards and best practices designed to ensure that Go code remains maintainable, readable, and efficient.
The guide focuses on idiomatic patterns for error handling, interface compliance, and memory optimization. It establishes standards for package naming and the use of functional options to maintain backward compatibility in constructors.
It covers a broad range of capabilities, including concurrency management for coordinating process lifecycles and preventing resource leaks. Further guidance is provided on memory optimization through pre-allocation strategies, the use of static analysis for automated linting, and the implementation of table-driven unit testing workflows.
Features
- Go Ecosystem Conventions - Provides comprehensive standards for Go ecosystem conventions, including coding styles and project layouts.
- Coding Standards - Provides a curated collection of language conventions and formatting rules to ensure code remains readable and maintainable.
- Slice Capacity Pre-allocation - Provides strategies for pre-allocating data collection capacity to minimize runtime overhead and garbage collection pressure.
- Go Concurrency Guides - Serves as a guide for managing parallel execution and synchronization specifically within the Go language.
- Collection Capacity Reservation - Recommends specifying initial capacity for collections to minimize runtime memory reallocations.
- Compile-Time Interface Verification - Provides patterns for verifying that a type implements an interface at compile time using zero-value assignments.
- Deferred Resource Management - Promotes the use of delayed execution patterns to ensure system locks and files are reliably released.
- Identifier Naming Conventions - Establishes standardized naming conventions for packages and variables to ensure codebase consistency.
- Memory Allocation Optimizations - Provides strategies for pre-allocating data structures to reduce garbage collection overhead.
- Go Memory Optimization - Offers specific strategies for optimizing Go runtime memory usage and reducing GC pressure.
- Go Quality Validators - Provides a framework for validating Go-specific formatting, linting, and performance standards.
- Code Style Guides - Establishes human-readable standards for naming, formatting, and layout to ensure consistent Go source code.
- Concurrency Managers - Provides guidelines for coordinating the lifecycles of concurrent operations and managing task cancellation.
- Task Lifecycle Coordination - Explains how to synchronize the start and stop times of concurrent tasks to ensure predictable shutdowns.
- Error Handling Patterns - Defines idiomatic architectural approaches for treating errors as explicit return values and wrapping them for context.
- Error Wrapping - Establishes standardized patterns for wrapping errors to provide context without causing duplicate log entries.
- Functional Options - Implements the pattern of using variadic functions in constructors to handle optional parameters while maintaining compatibility.
- Goroutine Leak Prevention - Provides best practices for managing goroutine lifecycles to prevent memory leaks.
- Resource Acquisition and Release - Implements deferred execution patterns to ensure reliable acquisition and release of system locks and files.
- Shared Resource Lifecycles - Defines synchronization mechanisms to coordinate the shutdown of shared concurrent resources.
- Code Quality and Analysis - Employs static analysis and formatting tools to maintain a consistent visual style and identify potential bugs.
- Table-Driven Tests - Organizes repetitive testing logic into structured data slices to increase test coverage and simplify maintenance.
- Static Code Linting - Recommends the use of automated static analysis tools to enforce style consistency and detect errors.
- Static Analysis Tools - Guides the use of automated linting and static analysis tools to enforce style consistency.
- Table-Driven Tests - Implements structured table-driven testing workflows to increase code coverage and simplify maintenance.
