name: coding-standards description: 适用于TypeScript、JavaScript、React和Node.js开发的通用编码标准、最佳实践和模式。
编码标准与最佳实践
适用于所有项目的通用编码标准。
代码质量原则
1. 可读性优先
- 代码被阅读的次数远多于被编写的次数
- 清晰的变量和函数命名
- 优先选择自文档化代码而非注释
- 一致的代码格式
2. KISS原则（保持简单）
- 选择最简单可行的解决方案
- 避免过度设计
- 不要过早优化
- 易于理解 > 巧妙代码
3. DRY原则（不要重复自己）
- 将通用逻辑提取为函数
- 创建可复用组件
- 跨模块共享工具函数
- 避免复制粘贴编程
4. YAGNI原则（你不需要它）
- 不要构建不需要的功能
- 避免推测性泛化
- 仅在需要时增加复杂性
- 从简单开始，需要时重构
TypeScript/JavaScript标准
变量命名
// ✅ 良好：描述性名称
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000
// ❌ 不良：不清晰的名称
const q = 'election'
const flag = true
const x = 1000
函数命名
// ✅ 良好：动词-名词模式
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }
// ❌ 不良：不清晰或仅使用名词
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }
不可变性模式（关键）
// ✅ 始终使用扩展运算符
const updatedUser = {
...user,
name: '新名称'
}
const updatedArray = [...items, newItem]
// ❌ 永远不要直接修改
user.name = '新名称' // 不良
items.push(newItem) // 不良
错误处理
// ✅ 良好：全面的错误处理
async function fetchData(url: string) {
try {
const response = await fetch(url)
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`)
}
return await response.json()
} catch (error) {
console.error('获取失败:', error)
throw new Error('获取数据失败')
}
}
// ❌ 不良：没有错误处理
async function fetchData(url) {
const response = await fetch(url)
return response.json()
}
Async/Await最佳实践
// ✅ 良好：尽可能并行执行
const [users, markets, stats] = await Promise.all([
fetchUsers(),
fetchMarkets(),
fetchStats()
])
// ❌ 不良：不必要的顺序执行
const users = await fetchUsers()
const markets = await fetchMarkets()
const stats = await fetchStats()
类型安全
// ✅ 良好：正确的类型
interface Market {
id: string
name: string
status: 'active' | 'resolved' | 'closed'
created_at: Date
}
function getMarket(id: string): Promise<Market> {
// 实现
}
// ❌ 不良：使用'any'
function getMarket(id: any): Promise<any> {
// 实现
}
React最佳实践
组件结构
// ✅ 良好：带类型的函数组件
interface ButtonProps {
children: React.ReactNode
onClick: () => void
disabled?: boolean
variant?: 'primary' | 'secondary'
}
export function Button({
children,
onClick,
disabled = false,
variant = 'primary'
}: ButtonProps) {
return (
<button
onClick={onClick}
disabled={disabled}
className={`btn btn-${variant}`}
>
{children}
</button>
)
}
// ❌ 不良：没有类型，结构不清晰
export function Button(props) {
return <button onClick={props.onClick}>{props.children}</button>
}
自定义Hooks
// ✅ 良好：可复用的自定义hook
export function useDebounce<T>(value: T, delay: number): T {
const [debouncedValue, setDebouncedValue] = useState<T>(value)
useEffect(() => {
const handler = setTimeout(() => {
setDebouncedValue(value)
}, delay)
return () => clearTimeout(handler)
}, [value, delay])
return debouncedValue
}
// 使用
const debouncedQuery = useDebounce(searchQuery, 500)
状态管理
// ✅ 良好：正确的状态更新
const [count, setCount] = useState(0)
// 基于前一个状态的功能性更新
setCount(prev => prev + 1)
// ❌ 不良：直接引用状态
setCount(count + 1) // 在异步场景中可能过时
条件渲染
// ✅ 良好：清晰的条件渲染
{isLoading && <Spinner />}
{error && <ErrorMessage error={error} />}
{data && <DataDisplay data={data} />}
// ❌ 不良：三元表达式地狱
{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}
API设计标准
REST API约定
GET /api/markets # 列出所有市场
GET /api/markets/:id # 获取特定市场
POST /api/markets # 创建新市场
PUT /api/markets/:id # 更新市场（完整）
PATCH /api/markets/:id # 更新市场（部分）
DELETE /api/markets/:id # 删除市场
# 用于筛选的查询参数
GET /api/markets?status=active&limit=10&offset=0
响应格式
// ✅ 良好：一致的响应结构
interface ApiResponse<T> {
success: boolean
data?: T
error?: string
meta?: {
total: number
page: number
limit: number
}
}
// 成功响应
return NextResponse.json({
success: true,
data: markets,
meta: { total: 100, page: 1, limit: 10 }
})
// 错误响应
return NextResponse.json({
success: false,
error: '无效请求'
}, { status: 400 })
输入验证
import { z } from 'zod'
// ✅ 良好：模式验证
const CreateMarketSchema = z.object({
name: z.string().min(1).max(200),
description: z.string().min(1).max(2000),
endDate: z.string().datetime(),
categories: z.array(z.string()).min(1)
})
export async function POST(request: Request) {
const body = await request.json()
try {
const validated = CreateMarketSchema.parse(body)
// 使用验证后的数据继续处理
} catch (error) {
if (error instanceof z.ZodError) {
return NextResponse.json({
success: false,
error: '验证失败',
details: error.errors
}, { status: 400 })
}
}
}
文件组织
项目结构
src/
├── app/ # Next.js应用路由
│ ├── api/ # API路由
│ ├── markets/ # 市场页面
│ └── (auth)/ # 认证页面（路由组）
├── components/ # React组件
│ ├── ui/ # 通用UI组件
│ ├── forms/ # 表单组件
│ └── layouts/ # 布局组件
├── hooks/ # 自定义React hooks
├── lib/ # 工具函数和配置
│ ├── api/ # API客户端
│ ├── utils/ # 辅助函数
│ └── constants/ # 常量
├── types/ # TypeScript类型
└── styles/ # 全局样式
文件命名
components/Button.tsx # 组件使用帕斯卡命名法
hooks/useAuth.ts # 使用'use'前缀的驼峰命名法
lib/formatDate.ts # 工具函数使用驼峰命名法
types/market.types.ts # 使用.types后缀的驼峰命名法
注释与文档
何时添加注释
// ✅ 良好：解释为什么，而不是做什么
// 使用指数退避避免在API中断时过度请求
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
// 为了处理大型数组的性能，特意使用突变
items.push(newItem)
// ❌ 不良：陈述显而易见的事实
// 计数器加1
count++
// 将名称设置为用户名称
name = user.name
公共API的JSDoc
/**
* 使用语义相似性搜索市场。
*
* @param query - 自然语言搜索查询
* @param limit - 最大结果数（默认：10）
* @returns 按相似度分数排序的市场数组
* @throws {Error} 如果OpenAI API失败或Redis不可用
*
* @example
* ```typescript
* const results = await searchMarkets('election', 5)
* console.log(results[0].name) // "Trump vs Biden"
* ```
*/
export async function searchMarkets(
query: string,
limit: number = 10
): Promise<Market[]> {
// 实现
}
性能最佳实践
记忆化
import { useMemo, useCallback } from 'react'
// ✅ 良好：记忆化昂贵的计算
const sortedMarkets = useMemo(() => {
return markets.sort((a, b) => b.volume - a.volume)
}, [markets])
// ✅ 良好：记忆化回调函数
const handleSearch = useCallback((query: string) => {
setSearchQuery(query)
}, [])
懒加载
import { lazy, Suspense } from 'react'
// ✅ 良好：懒加载重型组件
const HeavyChart = lazy(() => import('./HeavyChart'))
export function Dashboard() {
return (
<Suspense fallback={<Spinner />}>
<HeavyChart />
</Suspense>
)
}
数据库查询
// ✅ 良好：仅选择需要的列
const { data } = await supabase
.from('markets')
.select('id, name, status')
.limit(10)
// ❌ 不良：选择所有内容
const { data } = await supabase
.from('markets')
.select('*')
测试标准
测试结构（AAA模式）
test('正确计算相似度', () => {
// 准备
const vector1 = [1, 0, 0]
const vector2 = [0, 1, 0]
// 执行
const similarity = calculateCosineSimilarity(vector1, vector2)
// 断言
expect(similarity).toBe(0)
})
测试命名
// ✅ 良好：描述性测试名称
test('当没有市场匹配查询时返回空数组', () => { })
test('当OpenAI API密钥缺失时抛出错误', () => { })
test('当Redis不可用时回退到子字符串搜索', () => { })
// ❌ 不良：模糊的测试名称
test('工作', () => { })
test('测试搜索', () => { })
代码异味检测
注意这些反模式：
1. 过长函数
// ❌ 不良：函数超过50行
function processMarketData() {
// 100行代码
}
// ✅ 良好：拆分为更小的函数
function processMarketData() {
const validated = validateData()
const transformed = transformData(validated)
return saveData(transformed)
}
2. 深层嵌套
// ❌ 不良：5+层嵌套
if (user) {
if (user.isAdmin) {
if (market) {
if (market.isActive) {
if (hasPermission) {
// 执行操作
}
}
}
}
}
// ✅ 良好：提前返回
if (!user) return
if (!user.isAdmin) return
if (!market) return
if (!market.isActive) return
if (!hasPermission) return
// 执行操作
3. 魔法数字
// ❌ 不良：未解释的数字
if (retryCount > 3) { }
setTimeout(callback, 500)
// ✅ 良好：命名常量
const MAX_RETRIES = 3
const DEBOUNCE_DELAY_MS = 500
if (retryCount > MAX_RETRIES) { }
setTimeout(callback, DEBOUNCE_DELAY_MS)
记住：代码质量不可妥协。清晰、可维护的代码能够实现快速开发和自信重构。