{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/410", "result": {"data":{"issuesJson":{"id":"175d4983-cbfa-5d43-aff3-00fdb38ad14a","title":"barats/ohUrlShortener: 企业级短链接服务系统，支持短链接生产、查询及302转向，并自带点击量统计、独立 IP 数统计、访问日志","number":410,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposbarats/ohUrlShortener
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

ohUrlShortener

\n

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

\n
    \n
  1. 支持 Docker One Step Start 部署启动
    2. \n
  2. 支持短链接生产、查询、存储、302转向
    3. \n
  3. 支持访问日志查询、访问量统计、独立IP数统计
    4. \n
  4. 支持 HTTP API 方式新建短链接、禁用/启用短链接、查看短链接统计信息、管理员设置
    5. \n
  5. 支持访问日志导出，方便线下分析
    6. \n
\n

\"Screenshot\"

\n

\nhttps://www.ohurls.cn

\n\n\n \n\n\n \n\"Portal\n\"Admin\n

\n

快速使用

\n

Docker 一步启动所有服务，运行 docker/one_step_start.sh ，该命令将会：

\n
    \n
  1. 拉取 baratsemet/ohurlshortener-admin 镜像（本地构建可查看 docker/admin.Dockerfile）
    2. \n
  2. 拉取 baratsemet/ohurlshortener-portal 镜像（本地构建镜像可查看docker/portal.Dockerfile）
    3. \n
  3. 通过 docker/pull_build.yml 其他描述内容构建 redis 和 postgresql 镜像及服务，并对其运行状态做判断，等待缓存和数据库服务正常之后，再启动其他必要服务 (本地构建镜像请查阅 local_build.yml)
    4. \n
  4. 构建名为 network_ohurlshortener 的虚拟网络供上述服务使用
    5. \n
  5. 开启本机 9091、9092 端口分别应对 ohUrlShortener-Portal 及 ohUrlShortener-Admin 应用
    6. \n
\n

参数说明

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

配置文件

\n

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

\n
[app]\n\n# 短链接系统本地启动端口\nport = 9091\n\n# 短链接系统管理后台本地启动端口\nadmin_port = 9092\n\n# 例如：https://t.cn/ 是前缀(不要忘记最后一个/符号)\nurl_prefix = http://localhost:9091/\n\n# captcha 验证码默认会写入内存，也可以指定存储到 redis\n[captcha]\nstore = memory\n# store = redis\n\n# Redis 配置信息 \n[redis]\nhost = redis:6379\ndatabase = 0\nusername =\npassword =\npool_size = 50\n\n# Redis 集群配置\n[redis-cluster]\nhosts = localhost:6371,localhost:6372,localhost:6373,localhost:6374,localhost:6375,localhost:6376\nusername = \npassword = \npool_size = 50\n\n# Postgresql 数据库配置信息\n[postgres]\nhost = localhost\nport = 5432\nuser = postgres\npassword = xxx\ndatabase = oh_url_shortener\nmax_open_conn = 20\nmax_idle_conn = 5
\n

Admin 后台默认帐号

\n

默认帐号: ohUrlShortener
\n默认密码: -2aDzm=0(ln_9^1

\n

数据库中存储的是加密后的密码，在 structure.sql 中标有注释，如果需要自定义其他密码，可以修改这里

\n

加密规则 storage/users_storage.go 中

\n
func PasswordBase58Hash(password string) (string, error) {\n\tdata, err := utils.Sha256Of(password)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\treturn base58.Encode(data), nil\n}
\n

亦可参照 storage/users_storage_test.go 中的 TestNewUser() 方法

\n

HTTP API 支持

\n

管理端 HTTP API 支持请参阅 ohUrlShortener HTTP API

\n
api := router.Group(\"/api\", controller.APIAuthHandler())\napi.POST(\"/account\", controller.APINewAdmin)\napi.PUT(\"/account/:account/update\", controller.APIAdminUpdate)\napi.POST(\"/url\", controller.APIGenShortUrl)\napi.GET(\"/url/:url\", controller.APIUrlInfo)\napi.DELETE(\"/url/:url\", controller.APIDeleteUrl)\napi.PUT(\"/url/:url/change_state\", controller.APIUpdateUrl)
\n

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

\n

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

\n

1. 为什么要这么做？

\n

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

\n

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

\n

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

\n

3. 万一

\n

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

\n

短链接生产过程相关代码

\n

所在文件 core/short_url.go

\n
func GenerateShortLink(initialLink string) (string, error) {\n\tif utils.EmptyString(initialLink) {\n\t\treturn \"\", fmt.Errorf(\"empty string\")\n\t}\n\turlHash, err := utils.Sha256Of(initialLink)\n\tif err != nil {\n\t\treturn \"\", err\n\t}\n\tstr := utils.Base58Encode(urlHash)\n\treturn str[:8], nil\n}
\n

访问日志处理间隔：1分钟

\n

所在文件 main.go

\n
//清理 Redis 中的访问日志的时间间隔\nconst AccessLogCleanInterval = 1 * time.Minute\n\nfunc startTicker() error {\n\tticker := time.NewTicker(AccessLogCleanInterval)\n\tfor range ticker.C {\n\t\tlog.Println(\"[StoreAccessLog] Start.\")\n\t\tif err := service.StoreAccessLogs(); err != nil {\n\t\t\tlog.Printf(\"Error while trying to store access_log %s\", err)\n\t\t}\n\t\tlog.Println(\"[StoreAccessLog] Finish.\")\n\t}\n\treturn nil\n}
\n

当日 Top25 访问 URL 榜单处理间隔：5分钟

\n

所在文件 main.go

\n
// Top25 榜单计算间隔\nTop25CalcInterval = 5 * time.Minute\n\nfunc startTicker2() error {\n\ttop25Ticker := time.NewTicker(Top25CalcInterval)\n\tfor range top25Ticker.C {\n\t\tlog.Println(\"[Top25Urls Ticker] Start.\")\n\t\tif err := storage.CallProcedureStatsTop25(); err != nil {\n\t\t\tlog.Printf(\"Error while trying to calculate Top25Urls %s\", err)\n\t\t}\n\t\tlog.Println(\"[Top25Urls Ticker] Finish.\")\n\t}\n\treturn nil\n}
\n

仪表盘中几个相关统计处理间隔：5分钟

\n

所在文件 main.go

\n
// 仪表盘页面中其他几个统计数据计算间隔\nStatsSumCalcInterval = 5 * time.Minute\n\nfunc startTicker4() error {\n\tstatsSumTicker := time.NewTicker(StatsSumCalcInterval)\n\tfor range statsSumTicker.C {\n\t\tlog.Println(\"[StatsSum Ticker] Start.\")\n\t\tif err := storage.CallProcedureStatsSum(); err != nil {\n\t\t\tlog.Printf(\"Error while trying to calculate StatsSum %s\", err)\n\t\t}\n\t\tlog.Println(\"[StatsSum Ticker] Finish.\")\n\t}\n\treturn nil\n}
\n

全部访问日志统计处理间隔：30分钟

\n

所在文件 main.go

\n
//全部访问日志分析统计的间隔\nStatsIpSumCalcInterval = 30 * time.Minute\n\nfunc startTicker3() error {\n\tstatsIpSumTicker := time.NewTicker(StatsIpSumCalcInterval)\n\tfor range statsIpSumTicker.C {\n\t\tlog.Println(\"[StatsIpSum Ticker] Start.\")\n\t\tif err := storage.CallProcedureStatsIPSum(); err != nil {\n\t\t\tlog.Printf(\"Error while trying to calculate StatsIpSum %s\", err)\n\t\t}\n\t\tlog.Println(\"[StatsIpSum Ticker] Finish.\")\n\t}\n\treturn nil\n}
\n

License

\n

ohUrlShortener 以《木兰宽松许可证》 第2版 为开源协议发布

\n
Copyright (c) [2023] [巴拉迪维]\n[ohUrlShortener] is licensed under Mulan PSL v2.\nYou can use this software according to the terms and conditions of the Mulan PSL v2.\nYou may obtain a copy of Mulan PSL v2 at:\n         http://license.coscl.org.cn/MulanPSL2\nTHIS SOFTWARE IS PROVIDED ON AN \"AS IS\" BASIS, WITHOUT WARRANTIES OF ANY KIND,\nEITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,\nMERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.\nSee the Mulan PSL v2 for more details.\n
\n

Contributor License Agreement

\n

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

\n

Give Thanks To

\n

由衷感谢以下开源软件、框架等（包括但不限于）

\n
    \n
  1. gin-gonic/gin
    2. \n
  2. FomanticUI
    3. \n
  3. dchest/captcha
    4. \n
  4. Masterminds/sprig
    5. \n
  5. go-redis/redis
    6. \n
  6. jmoiron/sqlx
    7. \n
  7. go-ini/ini
    8. \n
\n

ohUrlShortener

\n
    \n
  1. ohUrlShortener 短链接系统 v2.0 发布，指定「打开方式」功能支持
    2. \n
  2. ohUrlShortener 短链接系统 v1.9 发布，Redis Cluster 集群支持
    3. \n
  3. ohUrlShortener 短链接系统 v1.8 发布，API 问题处理
    4. \n
  4. ohUrlShortener 短链接系统 v1.7 发布，安全更新
    5. \n
  5. ohUrlShortener 短链接系统 v1.6 发布，统计功能增强
    6. \n
  6. ohUrlShortener 短链接系统 v1.5 发布，管理功能增强
    7. \n
  7. ohUrlShortener 短链接系统 v1.4 正式发布
    8. \n
  8. ohUrlShortener 短链接系统 v1.3 发布，支持导出访问日志
    9. \n
  9. ohUrlShortener 短链接系统 v1.2 正式发布
    10. \n
  10. ohUrlShortener 短链接服务系统 1.0 发布
    11. \n
  11. 软件信息收录 https://www.oschina.net/p/ohurlshortener
    12. \n
  12. Gitee https://gitee.com/barat/ohurlshortener
    13. \n
  13. Github https://github.com/barats/ohUrlShortener
    14. \n
  14. Gitlink https://www.gitlink.org.cn/baladiwei/ohurlshortener
    15. \n
\n

Stargazers over time

\n

\"Stargazers

","updatedAt":"2025-05-21T16:14:06Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"ShortURL","color":"89cbc1"}},{"node":{"name":"barats","color":"befd3f"}}]},"comments":{"edges":[]}}},"pageContext":{"number":410,"previous":{"title":"keyval-dev/odigos: 分布式跟踪，无需更改代码。🚀 使用 OpenTelemetry 和 eBPF 即时监控任何应用程序","number":409},"next":{"title":"CloudWise-OpenSource/omp: 轻量级、聚合型、智能运维管理平台","number":411}}}, "staticQueryHashes": ["151096407","2861350382"]}