适合中小型社区网站使用的短链接服务系统,支持短链接生产、查询及302转向,并自带点击量统计、独立IP数统计、访问日志

适合中小型社区网站使用的短链接服务系统,支持短链接生产、查询及302转向,并自带点击量统计、独立IP数统计、访问日志

Property
Aug 19, 2022 08:35 PM
地址
https://github.com/barats/ohUrlShortener
notion image

ohUrlShortener

适合中小型社区网站使用的短链接服务系统,支持短链接生产、查询及302转向,并自带点击量统计、独立IP数统计、访问日志查询:
  1. 支持 Docker One Step Start 部署、Makefile 编译打包
  1. 支持短链接生产、查询、存储、302转向
  1. 支持访问日志查询、访问量统计、独立IP数统计
  1. 支持 HTTP API 方式新建短链接、禁用/启用短链接、查看短链接统计信息、新建管理员、修改管理员密码
  1. 支持访问日志导出,方便线下分析
notion image
notion image
notion image
notion image
notion image
notion image
notion image
notion image
notion image

快速使用

Docker 一步启动所有服务,运行 docker/one_step_start.sh ,该命令将会:
  1. 拉取 baratsemet/ohurlshortener-admin 镜像(本地构建可查看 docker/admin.Dockerfile
  1. 拉取 baratsemet/ohurlshortener-portal 镜像(本地构建镜像可查看docker/portal.Dockerfile
  1. 通过 docker/pull_build.yml 其他描述内容构建 redispostgresql 镜像及服务,并对其运行状态做判断,等待缓存和数据库服务正常之后,再启动其他必要服务 (本地构建镜像请查阅 local_build.yml)
  1. 构建名为 network_ohurlshortener 的虚拟网络供上述服务使用
  1. 开启本机 90919092 端口分别应对 ohUrlShortener-PortalohUrlShortener-Admin 应用

参数说明

ohurlshortener [-c config_file] [-s admin|portal|<omit to start both>]

配置文件

根目录下 config.ini 中存放着关于 ohUrlShortener 短链接系统的一些必要配置,请在启动应用之前确保这些配置的正确性
[app]

# 应用是否以 debug 模式启动,主要作用会在go-gin 框架上体现(eg:日志输出等)
debug = false

# 短链接系统本地启动端口
port = 9091

# 短链接系统管理后台本地启动端口
admin_port = 9092

# 例如:https://t.cn/ 是前缀(不要忘记最后一个/符号)
url_prefix = http://localhost:9091/

[redis]
...

[postgres]
...

Admin 后台默认帐号

默认帐号: ohUrlShortener 默认密码: -2aDzm=0(ln_9^1
数据库中存储的是加密后的密码,在 structure.sql 中标有注释,如果需要自定义其他密码,可以修改这里
加密规则 storage/users_storage.go
func PasswordBase58Hash(password string) (string, error) {
 data, err := utils.Sha256Of(password)
 if err != nil {
 return "", err
 }
 return base58.Encode(data), nil
}
亦可参照 storage/users_storage_test.go 中的 TestNewUser() 方法

HTTP API 支持

/api 接口权限说明

所有 /api/* 接口需要通过 Bearer Token 方式验证权限,亦即:每个请求 Header 须携带
 Authorization: Bearer {sha256_of_password}
sha256_of_password 的加密规则,与 storage/users_storage.go 中的 PasswordBase58Hash() 保持同步

1. 新增短链接 POST /api/url

接受参数:
  1. dest_url 目标链接,必填
  1. memo 备注信息,选填
请求示例:
curl --request POST \
 --url http://localhost:9092/api/url \
 --header 'Authorization: Bearer EZ2zQjC3fqbkvtggy9p2YaJiLwx1kKPTJxvqVzowtx6t' \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data dest_url=http://localhost:9092/admin/dashboard \
 --data memo=dashboard
返回结果:
{
 "code": 200,
 "status": true,
 "message": "success",
 "result": {
 "short_url": "http://localhost:9091/BUUtpbGp"
 },
 "date": "2022-04-10T21:31:29.36559+08:00"
}

2. 禁用/启用 短链接 PUT /api/url/:url/change_state

接受参数:
  1. url path 参数,指定短链接,必填
  1. enable 禁用时,传入 false;启用时,传入 true
请求示例:
curl --request PUT \
 --url http://localhost:9092/api/url/33R5QUtD/change_state \
 --header 'Authorization: Bearer EZ2zQjC3fqbkvtggy9p2YaJiLwx1kKPTJxvqVzowtx6t' \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data enable=false
返回结果:
{
 "code": 200,
 "status": true,
 "message": "success",
 "result": true,
 "date": "2022-04-10T21:31:25.7744402+08:00"
}

3. 查询短链接统计数据 GET /api/url/:url

接受参数:
  1. url path 参数,指定短链接,必填
请求示例:
curl --request GET \
 --url http://localhost:9092/api/url/33R5QUtD \
 --header 'Authorization: Bearer EZ2zQjC3fqbkvtggy9p2YaJiLwx1kKPTJxvqVzowtx6t' \
 --header 'Content-Type: application/x-www-form-urlencoded'
返回结果:
{
 "code": 200,
 "status": true,
 "message": "success",
 "result": {
 "short_url": "33R5QUtD",
 "today_count": 3,
 "yesterday_count": 0,
 "last_7_days_count": 0,
 "monthly_count": 3,
 "total_count": 3,
 "d_today_count": 1,
 "d_yesterday_count": 0,
 "d_last_7_days_count": 0,
 "d_monthly_count": 1,
 "d_total_count": 1
 },
 "date": "2022-04-10T21:31:22.059596+08:00"
}

4. 新建管理员 POST /api/account

接受参数:
  1. account 管理员帐号,必填
  1. password 管理员密码,必填,最小长度8
请求示例:
curl --request POST \
 --url http://localhost:9092/api/account \
 --header 'Authorization: Bearer EZ2zQjC3fqbkvtggy9p2YaJiLwx1kKPTJxvqVzowtx6t' \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data account=hello1 \
 --data password=12345678
返回结果:
{
 "code": 200,
 "status": true,
 "message": "success",
 "result": null,
 "date": "2022-04-10T21:31:39.7353132+08:00"
}

5. 修改管理员密码 PUT /api/account/:account/update

接受参数:
  1. account path 参数,管理员帐号,必填
  1. password 管理员密码,必填,最小长度8
请求示例:
curl --request PUT \
 --url http://localhost:9092/api/account/hello/update \
 --header 'Authorization: Bearer EZ2zQjC3fqbkvtggy9p2YaJiLwx1kKPTJxvqVzowtx6t' \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data password=world123
返回结果:
{
 "code": 200,
 "status": true,
 "message": "success",
 "result": null,
 "date": "2022-04-10T21:31:32.5880538+08:00"
}

6. 删除短链接 DELETE /api/url/:url

接受参数:
  1. url path 参数,要删除的短链接地址
(此处省略示例)

短链接在应用启动时会存入 Redis 中

所有短链接再系统启动时会以 Key(short_url) -> Value(original_url) 的形式存储在 Redis 中。

1. 为什么要这么做?

当短链接的查询请求进入应用时,为了能够更快、更准确的将用户请求转向到目标链接,与传统的方式从数据库中查询相比,直接从 Redis 中获取目标链接就会显得更有价值。

2. 这种处理方式有什么缺点?

理论上来说,如果 Redis 所在的服务器的内存较大的话,存储10w个Key也是可以的。但是,硬件条件不允许的情况下,就需要控制 Redis 中的 Key 数量(主要是怕机器扛不住,Redis 本身的性能不会有问题)。这部分的功能扩展,考虑在将来的某个版本中实现并允许配置管理。

3. 万一

考虑到可扩展性,多封装了一层 service,以便需要的时候在业务逻辑层进行自定义扩展,eg:将 key 查询改成数据库查询等。

短链接生产过程相关代码

所在文件 core/short_url.go
func GenerateShortLink(initialLink string) (string, error) {
 if utils.EemptyString(initialLink) {
 return "", fmt.Errorf("empty string")
 }
 urlHash, err := utils.Sha256Of(initialLink)
 if err != nil {
 return "", err
 }
 number := new(big.Int).SetBytes(urlHash).Uint64()
 str := utils.Base58Encode([]byte(fmt.Sprintf("%d", number)))
 return str[:8], nil
}

定时器1分钟清理一次访问日志

所在文件 main.go
const ACCESS_LOG_CLEAN_INTERVAL = 1 * time.Minute

func startTicker() error {
 ticker := time.NewTicker(ACCESS_LOG_CLEAN_INTERVAL)
 for range ticker.C {
 log.Println("[StoreAccessLog] Start.")
 if err := service.StoreAccessLogs(); err != nil {
 log.Printf("Error while trying to store access_log %s", err)
 }
 log.Println("[StoreAccessLog] Finish.")
 }
 return nil
}

Contributor License Agreement

第一次提交 Pull Request 时 ,请您在 Pull Request 内容中明确写明「本人自愿接受并签署 《ohUrlShortener Contributor License Agreement》」,并在 Pull Request 信息中附带该协议链接信息。

Give Thanks To

由衷感谢以下开源软件、框架等(包括但不限于)
  1. gin-gonic/gin
  1. FomanticUI
  1. dchest/captcha
  1. Masterminds/sprig
  1. go-redis/redis
  1. jmoiron/sqlx
  1. go-ini/ini

ohUrlShortener

  1. ohUrlShortener 短链接系统 v1.5 发布,管理功能增强
  1. ohUrlShortener 短链接系统 v1.4 正式发布
  1. ohUrlShortener 短链接系统 v1.3 发布,支持导出访问日志
  1. ohUrlShortener 短链接系统 v1.2 正式发布
  1. ohUrlShortener 短链接服务系统 1.0 发布
  1. 软件信息收录 https://www.oschina.net/p/ohurlshortener
  1. Gitee https://gitee.com/barat/ohurlshortener
  1. Github https://github.com/barats/ohUrlShortener
  1. Gitlink https://www.gitlink.org.cn/baladiwei/ohurlshortener