info-backend

Info-backend

ZJUT新生信息查询后端

如何编译

1. Clone 仓库到本地

   git clone https://github.com/zjutjh/info-backend
   

2. 更改工作目录

   cd info-backend
   

3. 编译

   go build
   

如何运行

1. 创建配置文件config.yaml

   配置文件自动查找目录：. /etc/info/

   或者使用-c --config 参数指定配置文件

   # example config file
   # server config >>>
   server-port: ":8080"
   proxy: true
   trusted-proxies:
     - "127.0.0.0/8"
     - "192.168.0.0/16"
     - "172.16.0.0/12"
     - "10.0.0.0/8"
   # database config >>>
   db-username: "root"
   db-password: "passwd"
   db-database: "info_test"
   # "db-hostname: 127.0.0.1" & "port: 3306" can be omitted
   # db-hostname: 127.0.0.1
   # db-port: 3306
   # excel keys >>>
   excel:
     name: "姓名"
     id: "证件号"
     campus: "校区"
     faculty: "学院"
     class: "班级"
     uid: "学号"
     house: "寝室楼"
     room: "寝室号"
     bed: "床号"
   

2. 从Excel载入数据到MySQL

   注：Excel数据表格式很可能不通用, 可以通过修改config.yaml中的excel配置来匹配表头(第一行)。 导入已写的尽量智能了一些，但是仍然不能保证适配每一年学校提供的数据，出了问题可能还是需要手动修改一下源码read_excel.go

   ./info-backend -l [excel文件路径]
   

   如果Excel文件有密码：

   ./info-backend -l [excel文件路径] -p [密码]
   

   如果已导入基本数据，然后再导入寝室数据(更新数据库)，可以后面再加个-u，这样就不会执行数据库插入操作，避免打印记录重复的错误。

3. 启动服务端

   ./info-backend
   

API定义

1. 获取基本信息

   POST /api/v1/info HTTP/1.1
   Content-Type: application/json; charset=utf-8
   Host: 127.0.0.1:8080
   Connection: close
   User-Agent: Paw/3.2.2 (Macintosh; OS X/11.4.0) GCDHTTPRequest
   Content-Length: 51
   
   {"stu_name":"\u7cbe\u5c0f\u5f18","stu_id":"210001"}
   

   HTTP/1.1 200 OK
   Server: Tengine
   Date: Sat, 07 Aug 2021 03:35:39 GMT
   Content-Type: application/json; charset=utf-8
   Content-Length: 132
   Connection: close
   Expires: Sat, 07 Aug 2021 15:35:39 GMT
   Cache-Control: max-age=43200
   Cache-Control: no-cache
   
   {"code":200,"data":{"uid":"20210101","name":"精小弘","faculty":"精弘学院","class":"番茄一班","campus":"莫干山校区"}}
   

2. 获取寝室信息

   POST /api/v1/dorm HTTP/1.1
   Content-Type: application/json; charset=utf-8
   Host: 127.0.0.1:8080
   Connection: close
   User-Agent: Paw/3.2.2 (Macintosh; OS X/11.4.0) GCDHTTPRequest
   Content-Length: 38
   
   {"stu_name":"jxh01","stu_id":"210001"}
   

   HTTP/1.1 200 OK
   Content-Type: application/json; charset=utf-8
   Date: Sun, 08 Aug 2021 04:09:15 GMT
   Content-Length: 222
   Connection: close
   
   {"code":200,"data":{"name":"jxh01","campus":"朝晖","house":"#7","room":"101","bed":1,"friends":[{"name":"jxh02","class":"CS02","bed":2},{"name":"jxh03","class":"CS03","bed":3},{"name":"jxh04","class":"CS04","bed":4}]}}
   

3. 异常情况 （例）

   POST /api/v1/info HTTP/1.1
   Content-Type: application/json; charset=utf-8
   Host: 127.0.0.1:8080
   Connection: close
   User-Agent: Paw/3.2.2 (Macintosh; OS X/11.4.0) GCDHTTPRequest
   Content-Length: 51
   
   {"stu_name":"nobody","stu_id":"none"}
   

   HTTP/1.1 200 OK
   Content-Type: application/json; charset=utf-8
   Date: Sat, 07 Aug 2021 03:53:36 GMT
   Content-Length: 35
   Connection: close
   
   {"code":404,"msg":"RecordNotFound"}
   

运行参数一览

Usage:
  info-backend [OPTIONS]

Application Options:
  -c, --config=  [PATH] Config file path
  -l, --load=    [PATH] Read & load data from excel
  -p, --passwd=  [PASS] Password of excel file
  -s, --sheet=   [Sheet] Read sheet
  -u, --update   Update database by dormitory info
  -v, --version  Show Info server version & quit

Help Options:
  -h, --help     Show this help message

项目结构

.
├── README.md
├── config.yaml
├── controller
│   └── get_stu_info.go //路由绑定的控制器
├── data
│   └── data.go //数据库全局变量
├── go.mod
├── go.sum
├── handler
│   ├── init_db.go //初始化数据库连接
│   ├── query_record.go //数据库记录查找
│   ├── read_excel.go //excel读取
│   └── request_check.go //请求合法性检查
├── main.go //路由和http服务定义
└── model
    ├── models.go //数据库模型
    ├── options.go 
    ├── request.go
    └── response.go

5 directories, 20 files

项目结构的设计大概存在许多不合理的地方。欢迎指正。