Skip to content

Short-Url 短链接生成器是个人制作的一个集合了多种生成策略,加密安全配置,缓存配置等可选可自定义的短链接生成工具包

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

HK-hub/Short-URL

Repository files navigation

Short-Url 短链接生产器

背景

在当前万物互联的时代,各种网络中的Web 应用,自媒体的数据传播已经到达了前所未有的高速时代,这当中 url 超链接承当了绝大多数的Web 网络上的数据访问工作。

随着 url 的爆炸生产,也产生了很多的问题:

  • 复制容易出错,长链接URL较长,有时参数不止一个,复制容易遗漏或在粘贴时被编辑器截断;
  • 容易被屏蔽,绝大部分长链接暴露了资源来源及分配策略,在投放第三方时容易被屏蔽,比如被短信屏蔽,(淘宝宝贝长链接)被微信屏蔽......;
  • 如果企业存在大量的资源服务内容(参考B站视频),使用长链接不适合对每一个资源进行映射;
  • URL链接过长不利于网站的SEO优化以及用户体验:过长的URL 在搜索引擎进行收录的时候需要进行一系列的处理,浏览器也对URL长度有限制;
  • 严格规律的长url 里面可能回携带企业内部资源的敏感信息,可能回暴露企业内容: 例如文章,视频,图片等的资源的url 传输的时候如果不对名字进行特殊处理可能回暴露企业的类似的其他资源(但是此资源不希望用户可见);
  • ......

那么相比于我们的长链接,短链接到底有什么好处呢?除了有能够解决以上问题的能力外,还有以下的能力:

  • 短链接相比我们的长链接更加的安全:可以保护企业内部资源,保护落地域名等。
  • 短链接对于用户来说用户体验更好,短小,点击方便,操作简单。
  • 节约空间,如一些社交网站会对字数有要求。
  • 便于追踪,可做数据分析等用途。

所以我们有必要对一个长链接进行改造产生符合意愿的短链接,并且能够进行数据统计。其实这也是很多企业都一直在默默使用的功能:B站的全部视频都是经过短链接变换后的URL地址,淘宝分享商品的时候就是使用短链接,新浪的短链接,百度短的链接系统等等,可以说市场上对于短链接的需求相当大的。

那我们来看看市面上开源的短链接的解决方案:Github 里面排名考前的短链接系统的实现方法都很单一,要么就是随机算法,要么就是Redis 自增算法,提供的数据信息统计等功能更是没有.....

简介

Short-Url 短链接生成器是一个集合了多种生成策略,加密安全配置,缓存配置等可选可自定义的短链接生成工具包。除了核心这些核心功能外,未来还将支持短链接访问信息统计,用户喜好数据统计等。 Short-Url目前已经开源出来啦,开源地址如下:

https://github.com/HK-hub/Short-URL

功能

Short-Url 短链接生成工具包提供了多种短链接生成算法,包括:字符串池随机算法,短地址发号器算法,MD5加密截取算法,BASE64编码截取算法,URL压缩算法,分布式雪花算法等。 此外集成了线程安全配置,缓存配置,加密配置,其他配置等可选可自定义的配置,可以根据自己的需求进行配置。实现对于普通 URL 长链接到短链接的转换,缓存,加密,以及对于已经生成的短链接的解密解析,重定向等功能。

安装

目前 Short-Url 短链接生成工具包还处于开发,天使测试阶段,暂时不支持编译安装,只支持使用 maven 或者 gradle 安装。Short-Url 目前已经打包成为一个 Starter, 使用时候只需要导入依赖 Jar包即可,如下:

<dependency>
    <groupId>io.github.hk-hub</groupId>
    <artifactId>short-url</artifactId>
    <version>1.0.0</version>
</dependency>

快速开始

下面是一个简单的入门简单案例,在开始之前需要引入我们的Maven依赖坐标。之后我们可以采用建造者创造适合个人业务的生产器了;除此之外我们的Short-URL 还会提供Template模板直接进行快速生成:

public class ShortUrlTest {

	static String longUrl = "http://localhost:8080/cloud/45464uy6terju54grfea464uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders64uy6terju54grfea44hytejorders4hytejorders/user/15645juytkuy4648/dehtrehgvsfd114545glete";

	// 最小 API 方式: 完全使用默认配置
	@Test
	public void minApiBuildTest(){

		// 全部使用默认配置,只需要传入一个 长链接即可
		ShortUrlGenerator generator = new ShortUrlGeneratorBuilder(longUrl).build();

		// 生产短链接
		ShortUrl shortUrl = generator.generate();

		System.out.println(shortUrl);

	}

	// 较为完整的API
	@Test
	public void fullConfigApi(){

		// 通过建造者模式 获取生成器
		ShortUrlGenerator generator = new ShortUrlGeneratorBuilder(longUrl)
				.provider(new RandomStringProvider())
				.length(8)
				.syncStrategy(SyncStrategy.DISABLE)
				.expireStrategy(ExpirationStrategy.ONE_DAYS)
				.build();

		// 生产短链接
		ShortUrl shortUrl = generator.generate();

		System.out.println(shortUrl);
	}
}

更多的使用方式请参考官方网站里面的指南文档或者可以阅读 Short-Url的源码工程,根据里面的策略来进行配置。

使用

Short-Url 短链接生成器内置了多种短链接生成算法策略,可以根据自己的需求选择使用,如下:

  • 字符串池随机算法:StringPoolRandomStrategy
  • 发号器算法:SnowFlakeStrategy
  • MD5加密截取算法:Md5Strategy
  • BASE64编码截取算法:Base64Strategy
  • URL字符串压缩算法:UrlCompressStrategy
  • 分布式ID生成算法:DistributedIdStrategy

除此之外还聚合了多种缓存配置,加密配置,线程安全配置等可选可自定义的配置,可以根据自己的需求进行配置。

线程安全配置 缓存配置 其他配置
默认配置 永久有效 短链多级长度配置
乐观锁配置 多级过期时间 短链接加密配置
加锁配置 自定义过期时间 短链接解析配置
不缓存 短链接访问配置

除此之外,Short-Url短链接生成器也提供了几个已经配置好的短链接生成模板,可以直接使用来快速生成和控制。

短链生成算法.drawio

其他

欢迎各位喜欢的小伙伴,加入我们一起进行创作,设计和开发

反馈

任何有关于 Short-Url 工具包的相关疑问,出现的Bug, 错误等都可以联系邮箱:3161880795@qq.com 进行及时的交流与反馈。

关于

版本

Short-Url 目前还是处于第一个版本(天使版) ,还有很多的缺陷和漏洞需要进行修复弥补,也还有很多的功能需要进行扩展,所有静待等候哦。

待办:

  • 添加:base64 的压缩,二维码的压缩
  • 添加:302 重定向日志
  • 添加:短链接信息统计
  • 添加:用户偏好信息记录
  • 完善:压缩算法更新补充
  • 完善:发号器算法重构
  • 完善:雪花算法优化
  • 构建:Spring Boot Starter 构建
  • 构建:发布Maven 仓库依赖

更新日志

  1. 2022-4-20:发布了具备核心功能,基本功能的第一个版本。
  2. 2022-4-18:构建了最基本的短链接生成算法: 随机算法,雪花算法,发号器算法,压缩算法,加密算法。
  3. 2022-5-23:准备开始着手开发,短链接访问数据,用户画像数据等的搭建。
  4. 2022-6-30:基本完成了用户短链接生产逻辑和访问,以及访问数据监控页面的开发。

About

Short-Url 短链接生成器是个人制作的一个集合了多种生成策略,加密安全配置,缓存配置等可选可自定义的短链接生成工具包

Topics

Resources

License

MIT, MIT licenses found

Licenses found

MIT
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Packages