Skip to content

快速开始指南 🚀

开始之前 🎯

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

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

下载安装包 📦

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

选择适合你的安装包:

shell
# Windows 64位下载地址
https://software.wueasy.com/gateway-go/latest/gateway_go_win_64.zip
shell
# Linux系统(Intel/AMD处理器)
https://software.wueasy.com/gateway-go/latest/gateway_go_linux_amd64.tar.gz

# Linux系统(飞腾/鲲鹏等ARM处理器)
https://software.wueasy.com/gateway-go/latest/gateway_go_linux_arm64.tar.gz
shell
# Mac系统(M1/M2/M3芯片)
https://software.wueasy.com/gateway-go/latest/gateway_go_mac_arm64.tar.gz

# Mac系统(Intel处理器)
https://software.wueasy.com/gateway-go/latest/gateway_go_mac_amd64.tar.gz

架构选择说明

根据您的系统处理器类型选择对应的版本:

  • AMD64架构:适用于Intel或AMD处理器
  • ARM64架构:适用于飞腾、鲲鹏等ARM处理器

可以通过以下命令查看系统架构:

bash
# Linux系统
uname -m

# Docker环境
docker info | grep "Architecture"

环境配置 ⚙️

配置网关的核心功能:

yaml
# 服务器配置
server:
  port: 8080
  name: gateway  # 应用名称

# 日志配置
log:
  level: info
  sensitive:
    field-rules:
      - field-names:
          - password
        type: password
      - field-names:
          - name
        type: name
    max-length: 100

# Nacos配置
nacos:
  server-addr: ${NACOS_SERVER_ADDR:192.168.3.181:8848}  # 地址,多个逗号分隔
  username: ${NACOS_USERNAME:dev}
  password: ${NACOS_PASSWORD:dev}
  config:
    namespace: ${NACOS_NAMESPACE:dev}
    group: ${NACOS_GROUP:dev}
    enabled: true
  discovery:
    namespace: ${NACOS_NAMESPACE:dev}
    group: ${NACOS_GROUP:dev}
    enabled: true
    # metadata:  # 元数据
    #   version: gray-2  # 指定灰度版本号
    # ip: 192.168.3.54   # 指定本机ip
    # port: 9720         # 服务端口

# 网关配置
gateway:
  routes:
    - id: demo
      uri: http://localhost:8082
      # uri: lb://web-example123
      predicates:
        - Path=/demo/**
        - Method=GET,POST
      filters:
        - StripPrefix=1
  
  filter:
    # 会话管理配置
    session:
      enabled: true
      rules:
        - urls: 
            - /demo/**
          type: redis
          jwt-secret: a748d0d6-1b30-4489-9751-1115134dcb8a
          redis-auto-expire: true
          is-generate-temp-code: true
          is-crypto: true
          crypto-key: a748d0d6a748d0d6a748d0d6
          jwt-check-logout: true
          expire: 2h
          user-login-urls:
            - /demo/login
          user-logout-urls:
            - /demo/logout
          user-get-info-urls:
            - /demo/getInfo
          user-get-session-urls:
            - /demo/getSession
          security-visitor-urls:
            - /demo/login
            - /demo/logout
            - /demo/captcha
            - /demo/get
    
    # 验证码配置
    captcha: 
      enabled: true
      rules:
        - generate-urls: 
            - /demo/captcha
          type: random  # 类型:string 数字字母,number 数字,math 数学,random 随机
          verify-urls:
            - /demo/login2
          expire: 5m
          parameter-type: body
          code-field-name: code
          value-field-name: captcha
          test-enabled: true
          test-value: 1234
          image-width: 150   # 宽度
          image-height: 70   # 高度
          image-length: 5    # 长度
  
  # 跨域配置
  cors:
    enabled: true
    rules:
      - urls:
          - /**
        allow-origins: "*"  # 允许所有源,也可以配置具体的域名,多个用逗号分隔
        allow-methods: "GET,POST,PUT,DELETE,PATCH,OPTIONS"  # 允许的HTTP方法
        allow-headers: "Authorization,Content-Type,Accept,Origin,User-Agent,DNT,Cache-Control,X-Mx-ReqToken,Keep-Alive,X-Requested-With,If-Modified-Since"  # 允许的请求头
        allow-credentials: true  # 允许携带认证信息
        max-age: 3600  # 预检结果缓存时间(秒)
        expose-headers: "Authorization"  # 允许浏览器访问的响应头

# Redis配置
redis:
  addrs: 192.168.3.181:6379
  password: "123456"
  db: 0

启动运行 🎬

1. 启动前检查清单

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

2. 启动命令

shell
# 双击运行
gateway_win_64.exe
shell
# 添加执行权限
chmod +x gateway_linux_amd64 
# 启动服务
./gateway_linux_amd64
shell
# 添加执行权限
chmod +x gateway_mac_arm64 
# 启动服务
./gateway_mac_arm64

验证部署 ✅

1. 测试示例接口

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

常见问题 ❓

1. 服务无法启动?

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

2. 路由不通?

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

需要帮助?🆘

如果遇到问题:

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