Skip to content

快速开始指南 🚀

开始之前 🎯

想象你正在搭建一个智能门禁系统:

  • 🏢 网关就像大楼的智能门禁
  • 🔑 配置就像门禁的规则设置
  • 🌐 服务就像大楼里的不同部门
  • 📡 注册中心就像总控制室

下载安装包 📦

注意:仅支持64位操作系统

选择适合你的安装包:

shell
# Windows 64位下载地址
https://software.wueasy.com/gateway/latest/gateway_win_64.zip
shell
# Linux AMD64架构下载地址
https://software.wueasy.com/gateway/latest/gateway_linux_amd64.zip
shell
# Docker镜像拉取命令
docker pull registry.cn-hangzhou.aliyuncs.com/wueasy/gateway:latest

环境配置 ⚙️

1. 环境变量设置

就像设置门禁系统的基本参数:

环境变量说明默认值示例
GATEWAY_SPRING_APPLICATION_NAME应用名称gatewaygateway
GATEWAY_NACOS_SERVER_ADDRNacos地址-127.0.0.1:8848
GATEWAY_NACOS_USERNAMENacos用户名-nacos
GATEWAY_NACOS_PASSWORDNacos密码-123456
GATEWAY_NACOS_GROUPNacos分组-DEFAULT_GROUP
GATEWAY_NACOS_NAMESPACENacos命名空间-dev
GATEWAY_NACOS_DISCOVERY_IP注册IP自动获取192.168.1.100
GATEWAY_NACOS_DISCOVERY_PORT注册端口服务端口8080

2. Nacos配置

配置网关的核心功能,就像设置门禁系统的具体规则:

yaml
# 日志配置
logging: 
  file:
    name: ./logs/gateway.log    # 日志文件路径
    max-history: 60            # 日志保留天数
    max-size: 100MB           # 单个日志文件大小
  level: 
    root: INFO                # 日志级别

# 服务配置
server: 
  port: 8080                  # 服务端口

# 网关配置
spring:
  cloud:
    gateway:
      discovery: 
        locator: 
          enabled: false      # 是否启用服务发现
          lowerCaseServiceId: true
      routes: 
      # 路由配置示例
      - id: demo 
        uri: http://127.0.0.1:8081  # 目标服务地址
        predicates: 
        - Path=/demo/**            # 路径匹配
        filters:
        - StripPrefix=1           # 去除前缀

  # Redis配置
  data:
    redis:
      database: 0
      host: 127.0.0.1
      port: 6379
      password: 123456
      timeout: 30000
      lettuce:
        pool:
          max-active: 100    # 最大连接数
          max-wait: -1       # 最大等待时间
          max-idle: 10       # 最大空闲连接
          min-idle: 0        # 最小空闲连接

# 网关特性配置
wueasy:
  gateway:
    filter:
      session:
        enabled: true        # 启用会话管理
        items:              # 会话配置项
        - type: redis       # 会话存储类型
          redis-auto-expire: true  # 自动续期
          expire: PT1H      # 会话过期时间
          urls:             # 拦截地址
          - /demo/**        # 拦截demo开头的所有请求
          business-key: demo  # 业务标识
          user-login-urls: /demo/login    # 登录接口
          user-logout-urls: /demo/logout  # 登出接口
          user-get-info-urls: /demo/getInfo  # 用户信息接口
          security-visitor-urls:  # 游客可访问接口
          - /demo/captcha
          - /demo/login
          - /demo/logout
          security-login-urls:    # 需登录才能访问的接口
          - /demo/getInfo

启动运行 🎬

1. 启动前检查清单

  • ✓ 确保配置文件正确
  • ✓ 验证环境变量设置
  • ✓ 检查依赖服务(如Redis、Nacos)状态

2. 启动命令

shell
# 双击运行
gateway.exe
shell
# 添加执行权限
chmod +x gateway
# 启动服务
./gateway
shell
# 启动容器
docker run -d \
  -p 8080:8080 \
  -e GATEWAY_NACOS_SERVER_ADDR=127.0.0.1:8848 \
  registry.cn-hangzhou.aliyuncs.com/wueasy/gateway:latest

验证部署 ✅

1. 检查服务状态

bash
# 访问健康检查接口
curl http://localhost:8080/actuator/health

2. 测试示例接口

bash
# 测试demo接口
curl http://localhost:8080/demo/test

常见问题 ❓

1. 服务无法启动?

  • ✓ 检查端口是否被占用
  • ✓ 验证配置文件格式
  • ✓ 确认环境变量设置

2. 路由不通?

  • ✓ 检查目标服务是否可用
  • ✓ 验证路由配置是否正确
  • ✓ 确认网络连接状态

需要帮助?🆘

如果遇到问题:

  1. 查看启动日志
  2. 检查配置文件
  3. 联系技术支持