pig 权限管理开源项目学习

pig 源码 https://github.com/pig-mesh/pig

文档在其中，前端在文档中，官方视频教学也在文档中有。

第一次搭建，建议直接去看单体视频，照着做即可，需 mysql，redis 基础。

项目结构

这是典型的 Spring Boot 微服务项目

• auth : authentication 身份验证
• common 公共的、通用的
• gateway 网关
• upms : user permission management system 用户权限管理系统
• visual : visualization 可视化
• pom : project object model , Maven的项目对象模型

Maven 多模块项目

聚合项目（Aggregator Project）指的是一个 父项目（Parent POM），它不包含实际代码，只是统一管理多个子模块（Submodule）

pig/pom.xml 聚合

明确聚合的子模块：

<modules><module>pig-register</module><module>pig-gateway</module><module>pig-auth</module><module>pig-upms</module><module>pig-common</module><module>pig-visual</module>
</modules>

<dependencyManagement> 统一管理依赖版本

pluginManagement 统一插件版本

profiles 支持不同构建环境
这里就对应 idea 右边 maven 里的 profiles

<!--  --><profiles><profile> <!-- 代表一个特定的构建配置集合 --><id>cloud</id> <!-- 唯一标识符 --><properties> <!-- 定义一组属性 --><!-- 环境标识，需要与配置文件的名称相对应 -->             <profiles.active>dev</profiles.active> <!-- 当前激活的环境为 dev --><!-- 设置 Nacos 注册中心的用户名和密码 --><nacos.username>nacos</nacos.username> <nacos.password>nacos</nacos.password></properties><activation><!-- 默认环境 --><activeByDefault>true</activeByDefault></activation></profile><profile><id>boot</id><modules> <!-- 激活时要包含的模块 --><module>pig-boot</module></modules></profile>

pig-boot 启动核心模块

SpringBootApplication 注解是 
@Configuration // ※ 使 spring boot 默认扫描其上级和同级的子包
@EnableAutoConfiguration
@ComponentScan 
的组合。

项目结构是一个 多模块 Maven 工程

pig/pom.xml中，已经把子模块都聚合进来了（见上文）：

而 @ComponentScan 默认就是从 com.pig.boot 扫描其“上级和同级的子包” （这里是 com.pig4cloud.pig ）

因此只要它们的包路径是 com.pig 开头，Spring Boot 默认就能扫描到！

总 profile

Spring Boot 会加载所有依赖模块中的 resources 目录下的配置文件，合并成一个配置环境，再根据 spring.profiles.active 去选择性加载 profile 文件。

无论模块是 pig-boot、pig-gateway 还是别的，只要这个模块是当前应用启动时依赖的模块，并且里面有resources/application.yml（或 .properties），Spring Boot 就会统一加载。

如果有多个模块都有 application.yml，Spring Boot 会合并它们的配置（后加载的覆盖前面的，或者由 @Order、@PropertySource 等控制顺序）。

pig-auth 实现认证和授权

使用了 Spring Security 和 OAuth2

pig-gateway API 网关

过滤器会对路径进行修改，从而转发到对应的微服务：

路由配置 resources/application.yml：

配置了服务器端口，而网关信息由 Nacos 读入

.yaml 文件，一种数据序列化格式
阅读提示：
下面的 server: port: 等价于 server.port

server:port: 9999  # 服务器端口号spring:application:name: @artifactId@ # 应用名称，会被替换为pig/pom.xml的同名标记cloud:nacos:username: @nacos.username@password: @nacos.password@discovery:server-addr: ${NACOS_HOST:pig-register}:${NACOS_PORT:8848} # 配置 Nacos 服务发现的服务器地址watch:enabled: true # 启用服务发现的监听watch-delay: 1000 # 监听的延迟时间msconfig: # 配置 Nacos 作为配置中心的服务器地址server-addr: ${spring.cloud.nacos.discovery.server-addr} # . 即 :config:import: ## Spring 应用从 Nacos 配置中心导入配置文件 ##- optional:nacos:[e-mail]@.yml- optional:nacos:${spring.application.name}[e-mail]@.yml

Nacos

Naming and Configuration Service

一个服务发现和配置管理的平台

• 集中管理微服务的配置信息，无需重启应用即可使配置生效
• 允许微服务在 Nacos 中进行注册，其他服务可以通过 Nacos 发现并获取到这些已注册服务的实例信息，从而实现服务间的调用。

启动 Nacos

阅读 pig-gateway 的配置文件：

spring:cloud:gateway:locator:enabled: trueroutes:# 认证中心- id: pig-authuri: lb://pig-authpredicates:- Path=/auth/**#UPMS 模块- id: pig-upms-bizuri: lb://pig-upms-bizpredicates:- Path=/admin/**filters:# 限流配置- name: RequestRateLimiterargs:key-resolver: '#{@remoteAddrKeyResolver}'redis-rate-limiter.replenishRate: 100redis-rate-limiter.burstCapacity: 200# 代码生成模块- id: pig-codegenuri: lb://pig-codegenpredicates:- Path=/gen/**# 代码生成模块- id: pig-quartzuri: lb://pig-quartzpredicates:- Path=/job/**# 固定路由转发配置 无修改- id: openapiuri: lb://pig-gatewaypredicates:- Path=/v3/api-docs/**filters:- RewritePath=/v3/api-docs/(?<path>.*), /$\{path}/$\{path}/v3/api-docs

Spring Cloud

Spring Cloud 是一整套用来构建和管理“分布式微服务系统”的工具集。
「微服务系统的全家桶」

• 传统单体项目：一个项目包含了所有功能，部署在一个服务里。

• 微服务架构：把系统拆成多个独立的小服务（例如用户服务、订单服务、商品服务），每个服务都可以独立部署、独立开发、独立扩展。

拆了之后服务间怎么交互？！：

问题	举例
服务之间怎么通信？	A 服务怎么访问 B 服务？
服务地址怎么发现？	B 服务的 IP 是谁？端口是多少？
服务挂了怎么办？	有没有熔断机制？
用户请求怎么统一入口？	所有请求能不能先经过一个地方统一鉴权、限流？
配置这么多服务，怎么管理？	能不能有一个配置中心？

Spring Cloud 核心模块：

模块	作用	类比
Spring Cloud Gateway	网关，统一请求入口、路由、限流	高速公路收费站
Nacos / Eureka	注册中心，服务自动注册发现	电话簿/联系人列表
OpenFeign	服务调用客户端（HTTP）	拨电话的工具
Hystrix / Sentinel	熔断限流，防止雪崩	跌倒保护垫
Config	配置中心，统一配置管理	云端配置文件
Bus	消息总线，配置变更通知	群发消息
Sleuth + Zipkin	链路追踪，查看请求全流程	快递跟踪系统

Spring Cloud Gateway

Spring Cloud Gateway 是 Spring 官方提供的一个微服务网关组件，用于：

• 统一入口：所有请求都先经过网关
• 路由转发：根据路径、请求头、参数等，把请求转发到对应的微服务
• 权限校验、限流、熔断降级等

通俗讲：就像超市收银台，你不同商品（服务）都通过一个地方集中收银（请求都先走网关）。

上述.yml配置中

spring:cloud:gateway:locator:enabled: true  # 动态注册服务（结合 nacos、eureka 等注册中心）routes:         # 静态配置路由列表- id: pig-authuri: lb://pig-authpredicates:- Path=/auth/**

routes 就是我们最关注的内容，每一个 - 项目就是一个微服务的路由规则。

• id 唯一标识
• uri 转发的目标服务。lb:// 表示走注册中心（如 Nacos）进行负载均衡
• predicates 匹配路径才会路由，比如 /auth/** 请求才转发
• locator.enabled=true 开启服务发现的自动路由，根据服务自动生成 lb://pig-auth 路由 （如果rotues里有，优先用静态配置的）
• filters 可选：对请求进行增强，如限流、鉴权、改写路径等

pig-upms 核心业务

• Controller ：对外提供接口
• Service ：封装具体业务逻辑
• Mapper ：与数据库交互

项目交互细节

验证码

Request URL:
http://localhost:8888/api/admin/code/image?randomStr=477ba151-80ab-43cf-b70b-a5077dd4f919
Request Method:
GET
Status Code:
200 OK

通过路径找到对应代码：

为什么前面有 /api/admin 呢，见上文 pig-gataway 网关介绍