如何使用Java和Spring Boot创建短链接生成器

URL短链接生成器是一种根据冗长的URL,创建短链接的服务。通常,短链接的长度只有原始URL的三分之一、甚至四分之一。因此它们更容易被输入、呈现、以及推送。用户只需单击短链接,便可被自动重定向到原始的URL处。

目前,tiny．cc、bitly．com和cutt．ly都能够提供在线式的URL缩短服务。当然,您也可以为应用系统自行设计和开发出缩短URL的服务。下面,我和您讨论具体的实现过程。首先,让我们来探讨一下与之相关的功能性和非功能性的需求。

URL短链接生成器中最重要的是转换算法。不同的转换方式通常会产生不同的输出,而且它们各有优、缺点。假设我们需要一个最长为7个字符的短链接。那么我们可以采用MD5或SHA-2之类的哈希函数,对原始的URL进行散列处理。由于散列的结果会超过7个字符,因此我们只取前7个字符。不过,由于前7个字符可能已经被用于其他短链接,并由此会引发冲突,因此我们需要依次截取后面的7个字符,直至找到一个被使用过的短链接为止。

生成短链接的第二种方法是使用UUID。UUID被复制的概率近似为零,因此可以完全忽略冲突的可能。由于UUID是由36个字符组成,仍然可能遇到上述问题,因此我们应当截取前7个字符,然后检查该组合是否已被占用。

第三种方法是将数字从Base 10转换为Base 62。Base是可用于表示特定数字的字符数。Base 10是我们日常生活中使用的数字,即:[0-9],而Base 62则是:[0-9][az][AZ]。这意味着,以10为Base的四位数字,将与以62为Base、但具有两个字符的数字相同。因此在URL转换中,使用最大长度为7个字符的Base 62,将允许我们为短链接提供62^7个唯一值。

我使用如下算法,将一个Base为10的数字转换为Base为62:

据此,我们只需要将结果集中的数字映射到Base为62的字符 [0,1,2,．．．,a,b,c．．．,A,B,C,．．．]即可。

下面,我通过将1000从Base 10转换为Base 62的例子,来讨论其工作机制。

[16,8] 被映射到Base 62后为g8,即1000base10 = g8base62。

而从Base 62转换为Base 10的过程也很简单,即:

所以其对应的代码示例为:

我使用Spring Boot和MySQL来实现该服务。请参看我在Github上的具体代码。我用到了数据库的自动递增功能来实现Base 62的转换。当然,您也可以使用任何其他具有自动递增功能的数据库。

首先,请访问Spring initializr,并选择Spring Web与MySQL Driver。接着,请单击“生成(Generate)”按钮,并下载对应的zip文件。完成解压缩之后,我们就可以在自己的IDE中打开该项目了。

我通过创建文件夹:控制器、实体、服务、存储库、dto和配置,实现在逻辑上划分程序代码。

在“实体”文件夹中,我创建了一个具有id、longUrl、createdDate和expiresDate四个属性的Url．java类。

请注意,此处既没有短链接的属性,也不会去保存短链接。每次只要有GET请求的出现,我们都会将id属性从Base 10转换为Base 62,以便节省数据库中的空间。

用户在访问该短链接时,应根据longURL属性重定向到目标网站。createdDate则只是为了查看longURL何时被保存(并不重要)。而如果用户希望在一段时间后让短链接失效的话,可以对expiresDate进行设置。

接着,我在“服务”文件夹中,创建了一个BaseService．java文件。其中包含了从Base 10到Base 62相互转换的方法。

正如前面所提到的,若要使用Base 62转换,则需要有一个被称为allowedCharacters的Base 62的字母表。此外,为了方便按需更改被允许的字符,我们可根据字符的长度,计算出基本变量的值。其中,编码(encode)方法会将一个数字作为输入,返回一个短链接;而解码(decode)方法则会接受一个字符串(如:短链接)作为输入,并返回一个数字。

在存储库文件夹中,我创建了UrlRepository．java文件。它只是JpaRepository的一个扩展,并给出了诸如“findById”,“save”等方法。在此微信短链接在线生成器,我们无需进行任何添加。

然后,我在“控制器”文件夹中创建了一个URLController．java文件(请参见如下代码)。它提供一种用于创建短链接的POST方法,以及一种被用于重定向到原始URL的GET方法。

其中,POST方法会将UrlLongRequest作为请求体。它是一个具有longURL和expiresDate属性的类。而GET方法会将一个短的URL作为路径变量,以获取并重定向到原始的URL处。

在控制器的上层,urlService会作为依赖项被注入,以便后续进行解释。

UrlService．java既包含了大量逻辑,又为控制器提供了服务。ConvertToShortUrl仅供控制器的POST方法所使用。它只是在数据库中创建了一条新的记录,并获取一个id,以便将其转换为Base 62的短链接,并返回给控制器。

控制器使用GetOriginalUrl方法,首先将字符串转换为Base 10类型的id。然后,它通过该id从数据库中获取一条记录。当然,如果该记录不存在的话,则会抛出异常。最后,它会将原始的URL返回给控制器。

下面,我将和您讨论Swagger文档、应用的dockerization(容器化)、缓存以及MySQL的计划事件。

在开发过程中文档记录无疑能够使得API更易于理解和使用。在该项目中,我使用Swagger UI来记录API。Swagger UI允许任何人在没有任何实现逻辑的情况下,可视化API资源,并与之交互。它不但能够自动生成,而且带有可视化的文档,以便于后端的实现和客户端的使用。

我通过执行如下步骤,在项目中引入了Swagger UI。首先,我在pom．xml文件中添加了Maven依赖项:

添加了Maven依赖项后,我们便可以添加Swagger的相关配置了。我在“配置”文件夹中,创建了一个新的类--SwaggerConfig．java,请参考如下代码段。

Java

在该类的顶部,我添加了如下注释:

接下来,我添加了Docket bean。它提供的主要API配置,带有各种合理的默认值、以及便捷的配置方法。

此处的apiInfo()方法除了可以使用默认值,还能够接受ApiInfo对象,以便我们配置所有必要的API信息。为了使代码更加简洁,我们可以创建一个私有的方法—metadata(),来配置和返回ApiInfo对象,并将该方法作为apiInfo()方法的参数进行传递。同时,apis()方法也允许我们过滤那些被文档化的包。

在完成了Swagger UI的配置后,我们便可以开始文档化API了。在UrlController内部的每个端点上,我们可以使用@ApiOperation来添加描述性的注释。当然,您也可以按需使用其他类型的注释。

我们还可以文档化DTO,并使用@ApiModelProperty来添加各种允许的值和描述。

根据维基百科的定义,缓存是存储数据的软、硬件组件,可用来更快地处理后续对于相同数据的请求。而存储在缓存中的数据,往往是早期计算的结果、或是已存储在其他地方的数据副本。

目前,最常用的缓存类型是内存缓存(in-memory cache)。它能够将缓存的数据存储到RAM中。当被请求数据与缓存一致时,它是从RAM、而非从数据库被提取。据此,我们避免频繁调用后端的开销。

由于URL短链接生成器可以被认为是一种读取多于写入的请求应用,因此它是使用缓存的理想应用场景。若想在Spring Boot应用中启用缓存,我们只需要在UrlShortenerApiApplication类中添加@EnableCaching注释即可。

接着,在控制器中,我们需要在GET方法上设置@Cachable注解,以实现自动将方法调用的结果存入缓存中。在@Cachable的注解中,我设置了缓存名称的value参数和缓存键的key参数。鉴于缓存键的唯一性,我使用了“shortUrl”,并将Sync参数设置为true,以确保只有一个线程正在构建缓存值。

至此,当我们首次加载带有短链接的URL时,其结果将会被保存到缓存中。后续,任何端点若想调用相同短链接,都会从缓存、而非从数据库中检索结果。

Dockerization是将应用程序及其依赖项打包到Docker容器中的过程。一旦配置了Docker容器,我们便可以轻松地在任何支持Docker的服务器、或主机上运行应用程序。

因此微信短链接在线生成器,我们首先需要创建一个包含所有命令的Dockerfile文本文件,以便用户通过调用命令行的方式,挂载某个镜像。

Dockerfile

为了在项目中创建．jar文件,以便Dockerfile中的COPY命令能够正常工作,我使用Maven来创建可执行的．jar。如果您的pom．xml缺少Maven,请用如下方式进行添加:

XML

随后,我运行命令:mvn clean package,以构建出一个Docker镜像。接着,在Dockerfile文件夹中,我运行了命令:docker build -t url-shortener:latest。其中,-t可用于标记一个镜像,并实现版本控制。在此,即为最新的存储库URL-shortener。我们可以使用命令“docker images”来创建镜像。屏幕上的显示结果为:

最后,我还需要在docker容器中构建MySQL服务器镜像,以方便数据库容器与应用容器相隔离。为此,我在Docker容器中运行了如下命令:

您可以在Docker hub上查看到相关文档。

为了在容器内运行数据库,我通过配置,将现有的应用程序连接上该MySQL服务器。即:在application．properties中设置spring．datasource．url,以连接到shortener容器。

然后,我使用以下命令来运行已构建好的Docker 镜像容器:

至此,我们便可以在浏览器中访问:8080/swagger-ui．html了。通过将镜像发布到Docker Hub上,任何计算机和服务器都可以轻松地运行该应用。

当然,为了改善该Docker的使用体验,我们需要注意多阶段构建,以及docker-compose两个方面。

使用多阶段构建,您将可以在Dockerfile中使用多个FROM语句。每个FROM指令都可以使用不同的base,并且每个指令都能够开启构建的新阶段。您可以有选择性地将各个工件(artifacts)从一个阶段复制到另一个阶段,并在最终镜像中去掉不想要的内容。

多阶段构建有利于我们避免每次对代码进行更改后,都必须手动重建．jar文件。据此,我们可以定义一个构建阶段,来执行Maven包命令。而另一个阶段会将来自第一次构建的结果,直接复制到Docker容器的文件系统中。您可以通过链接--．com/AnteMarin/UrlShortener-API/blob/develop/Dockerfile,查看完整的Dockerfile。

Compose是一个用于定义和运行多容器Docker应用的工具。借助Compose,您可以使用YAML文件,来配置应用程序的服务,然后使用单个命令,从配置中创建并启动所有的服务。

使用docker-compose,我们能够将应用程序和数据库打包到一个配置文件中,以便立即运行所有的内容。据此,我们避免了每次去运行MySQL容器,将其链接到应用容器的繁琐。

由Docker-compose．yml文件的具体配置内容可知:首先,我们通过设置镜像mysql v8．0和MySQL服务器的凭据,来配置MySQL容器。接着,我们通过设置构建参数,来配置应用容器,毕竟我们需要的是镜像,而非使用MySQL进行拉取。此外,我们还需要通过设置,让应用容器依赖于MySQL容器。最终,我们可以使用命令“docker-compose up”,来运行整个项目。

说到短链接的到期设置,我们既可以让用户自定义,又可以保持默认值。为此,我们可以在数据库中设置一个计划事件。通过每x分钟运行一次该事件,到期时间只要小于当前时间,数据库就会自动删除某一行,就这么简单。这非常适用于保持数据库中的少量数据。不过,该方法有两个问题值得注意:

通过上述示例和讨论,我向您展示了如何使用Java和Spring Boot,来创建URL短链接生成器的API。这是一个十分常见的面试问题,您既可以据此创建自己的改进版本,又可以从上述GitHub处克隆项目的存储库,并创建自己的前端。

原文标题:URL Shortener Complete Tutorial,作者:Ante Marin

【编辑推荐】