# NewsServer

**Repository Path**: urasaki/news-server

## Basic Information

- **Project Name**: NewsServer
- **Description**: Spring Boot 新闻聚合服务端：按分类定时从 NewsData.io 同步新闻到 MySQL，提供 REST 分页查询与详情；支持手机号/邮箱注册登录、JWT 签发、退出即时失效、新闻增删改及腾讯云 COS 图片上传；Redis 实现 token 黑名单、分布式锁、限流计数；具备统一响应、全局异常处理、traceId 链路追踪，以及 Nginx + 应用层两层限流。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-10-14
- **Last Updated**: 2026-10-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文档索引（`docs/`，按类型分目录）

> 注意区分两个同义但不同用途的目录：**`deploy/`（项目根）= 部署脚本与模板**；**`docs/deployment/` = 部署文档**。本文只讲 `docs/` 下面的分类。

| 目录 | 类型 | 篇数 |
|---|---|---|
| `deployment/` | 部署 / 启动 / 发版（7 篇正文 + 索引 `deployment/README.md`） | 8 |
| `ops/` | 清理脱敏、提交规范 | 2 |
| `api/` | 接口设计与客户端接入 | 2 |
| `config/` | 配置项说明与速查 | 2 |
| `architecture/` | 架构解析、分包规范、请求链路（3 篇） | 5 |
| `database/` | 数据库连接排障 | 1 |
| `sql/` | 建表 / 迁移脚本（`upload.sh` 依赖 `docs/sql`，**勿移动**） | — |

## 常用入口

- 部署 / 启动 / 发版 → `deployment/README.md`（该目录的索引）
  - 新服务器：`deployment/首次部署.md`
  - 已有服务发版：`deployment/升级部署.md`
- 配置怎么填 → `config/配置与环境变量说明.md`
- 连不上数据库 → `database/远程MySQL连接排查与SSH隧道.md`
- 连线/链路怎么走（MVC 之前）→ `architecture/请求前置链路-精简版.md`（速查）、`architecture/请求前置链路详解-客户端到AOP.md`（详解）
- 从 TCP 到 JSON 的全链路入门 → `architecture/请求全链路详解-给Java新手.md`
- 线上出问题 → `deployment/升级部署.md` §8（故障表）/ `deployment/首次部署.md` §9

## 放新文件的规则

- 部署、启动、发版 → `deployment/`
- 排障、复盘、清理、规范 → `ops/`
- 接口设计 / 客户端接入 → `api/`
- 配置项与对照 → `config/`
- 架构、分层、分包 → `architecture/`
- 数据库连接与操作 → `database/`
- 建表 / 迁移 SQL → `sql/`（不要移动）

> 根目录不再放任何 `.md`。新增前先对号入座；七类都不属于的先确认，再建新目录。