适合中小型社区网站使用的短链接服务系统,支持短链接生产、查询及302转向,并自带点击量统计、独立IP数统计、访问日志查询:
- 支持 Docker One Step Start 部署启动
- 支持短链接生产、查询、存储、302转向
- 支持访问日志查询、访问量统计、独立IP数统计
- 支持 HTTP API 方式新建短链接、禁用/启用短链接、查看短链接统计信息、新建管理员、修改管理员密码
- 支持访问日志导出,方便线下分析
Docker 一步启动所有服务,运行 docker/one_step_start.sh
,该命令将会:
- 拉取 baratsemet/ohurlshortener-admin 镜像(本地构建可查看
docker/admin.Dockerfile
) - 拉取 baratsemet/ohurlshortener-portal 镜像(本地构建镜像可查看
docker/portal.Dockerfile
) - 通过
docker/pull_build.yml
其他描述内容构建redis
和postgresql
镜像及服务,并对其运行状态做判断,等待缓存和数据库服务正常之后,再启动其他必要服务 (本地构建镜像请查阅local_build.yml
) - 构建名为
network_ohurlshortener
的虚拟网络供上述服务使用 - 开启本机
9091
、9092
端口分别应对ohUrlShortener-Portal
及ohUrlShortener-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/
默认帐号: 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 支持请参阅 ohUrlShortener HTTP API
所有短链接再系统启动时会以 Key(short_url) -> Value(original_url)
的形式存储在 Redis 中。
当短链接的查询请求进入应用时,为了能够更快、更准确的将用户请求转向到目标链接,与传统的方式从数据库中查询相比,直接从 Redis 中获取目标链接就会显得更有价值。
理论上来说,如果 Redis 所在的服务器的内存较大的话,存储10w个Key也是可以的。但是,硬件条件不允许的情况下,就需要控制 Redis 中的 Key 数量(主要是怕机器扛不住,Redis 本身的性能不会有问题)。这部分的功能扩展,考虑在将来的某个版本中实现并允许配置管理。
考虑到可扩展性,多封装了一层 service
,以便需要的时候在业务逻辑层进行自定义扩展,eg:将 key 查询改成数据库查询等。
所在文件 core/short_url.go
func GenerateShortLink(initialLink string) (string, error) {
if utils.EmptyString(initialLink) {
return "", fmt.Errorf("empty string")
}
urlHash, err := utils.Sha256Of(initialLink)
if err != nil {
return "", err
}
str := utils.Base58Encode(urlHash)
return str[:8], nil
}
所在文件 main.go
//清理 Redis 中的访问日志的时间间隔
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
}
所在文件 main.go
// Top25 榜单计算间隔
TOP25_CALC_INTERVAL = 5 * time.Minute
func startTicker2() error {
top25Ticker := time.NewTicker(TOP25_CALC_INTERVAL)
for range top25Ticker.C {
log.Println("[Top25Urls Ticker] Start.")
if err := storage.CallProcedureStatsTop25(); err != nil {
log.Printf("Error while trying to calculate Top25Urls %s", err)
}
log.Println("[Top25Urls Ticker] Finish.")
}
return nil
}
所在文件 main.go
// 仪表盘页面中其他几个统计数据计算间隔
STATS_SUM_CALC_INTERVAL = 5 * time.Minute
func startTicker4() error {
statsSumTicker := time.NewTicker(STATS_SUM_CALC_INTERVAL)
for range statsSumTicker.C {
log.Println("[StatsSum Ticker] Start.")
if err := storage.CallProcedureStatsSum(); err != nil {
log.Printf("Error while trying to calculate StatsSum %s", err)
}
log.Println("[StatsSum Ticker] Finish.")
}
return nil
}
所在文件 main.go
//全部访问日志分析统计的间隔
STATS_IP_SUM_CALC_INTERVAL = 30 * time.Minute
func startTicker3() error {
statsIpSumTicker := time.NewTicker(STATS_IP_SUM_CALC_INTERVAL)
for range statsIpSumTicker.C {
log.Println("[StatsIpSum Ticker] Start.")
if err := storage.CallProcedureStatsIPSum(); err != nil {
log.Printf("Error while trying to calculate StatsIpSum %s", err)
}
log.Println("[StatsIpSum Ticker] Finish.")
}
return nil
}
在 第一次提交 Pull Request 时 ,请您在 Pull Request 内容中明确写明「本人自愿接受并签署 《ohUrlShortener Contributor License Agreement》」,并在 Pull Request 信息中附带该协议链接信息。
由衷感谢以下开源软件、框架等(包括但不限于)
- ohUrlShortener 短链接系统 v1.7 发布,安全更新
- ohUrlShortener 短链接系统 v1.6 发布,统计功能增强
- ohUrlShortener 短链接系统 v1.5 发布,管理功能增强
- ohUrlShortener 短链接系统 v1.4 正式发布
- ohUrlShortener 短链接系统 v1.3 发布,支持导出访问日志
- ohUrlShortener 短链接系统 v1.2 正式发布
- ohUrlShortener 短链接服务系统 1.0 发布
- 软件信息收录 https://www.oschina.net/p/ohurlshortener
- Gitee https://gitee.com/barat/ohurlshortener
- Github https://github.com/barats/ohUrlShortener
- Gitlink https://www.gitlink.org.cn/baladiwei/ohurlshortener