tinyurl

Tinyurl

Tinyurl是Java上简单的URL Shortener构建。项目是开源（Apache许可证，版本2.0）

当前稳定版本为1.0.7

---

Doc

配置文件

 # SystemProperty / Default value
org.javastack.tinyurl.config=[classpath]/org.javastack.tinyurl.properties

注意：如果文件不在classpath中，请使用url格式，例如file:///etc/tinyurl/org.javastack.tinyurl.properties或https://config-server/tinyurl/org.javastack.tinyurl.properties

配置参数

 # Parameter / Default value
storage.dir=[webapp]/WEB-INF/storage/
whitelist.file=file://[storage.dir]/whitelist.conf
check.flags=WHITELIST,CONNECTION
check.cache.millis=60000
connection.timeout.millis=10000
read.timeout.millis=30000
dump.key=[random]
#
# Default KVStore Persistence
storage.class=org.javastack.tinyurl.PersistentKVStore
#
# Optional MySQL Persistence (default: not enabled)
#storage.class=org.javastack.tinyurl.jdbc.PersistentMySQL
#storage.url=jdbc:mysql://localhost:3306/tinyurl
#storage.username=tinyurl
#storage.password=secret
#
# QR Codes
#base.url=https://tiny.javastack.org/r/
#qr.size.min=50
#qr.size.max=1000
#qr.size.default=300

• storage.dir ：存储本地文件的位置。
• 白名单：file：存储白名单文件的位置。
• check.flags ：对URL进行检查。
  • 白名单：使用白名单文件检查URL域，如果找不到，缩写器将被拒绝。
  • SURBL：检查URL域针对SURBL服务，如果发现，将拒绝Shortener。
  • 连接：使用HTTP连接（GET）检查URL。
• check.cache.millis ：网址域检查的缓存时间（白名单 / surbl）。
• Connection.TimeOut.Millis ：Millis中的连接超时。
• Read.TimeOut.Millis ：在Millis中阅读超时。
• dump.key ：输出键，用于导出CSV中的所有存储。
• 存储。类：用于持久性的类：
  • org.javastack.tinyurl.PersistentKVStore ：kvstore持久性（默认，便携式）
  • org.javastack.tinyurl.jdbc.PersistentMySQL ：mysql持久性
    • Storage.URL ：JDBC连接的URL
    • storage.username ：用户名
    • storage.Password ：密码
    • Storage.xxx ：请参阅额外的参数，所有参数都带有存储。
• base.url ：tinyurl redirector的基本URL（默认情况下尝试从请求中发现） example: https://tiny.javastack.org/r/
• qr.size.min ：QR（像素，广场）中允许的最小尺寸，默认值= 50
• qr.size.max ：QR中允许的最大大小（像素，广场），默认值= 1000
• qr.size.default ：qr（pixels，square）中的默认大小，默认值= 300

更多例子

• SampleConf目录中的更多示例

跑步（tomcat）

• 设置CATALINA_OPTS="-Dorg.javastack.tinyurl.config=file://${CATALINA_BASE}/conf/org.javastack.tinyurl.properties"
• 在WebApps目录中复制WAR文件名称：root.war
• 对于MySQL的持久性：
  • 复制MySQL-Connector-Java-XXXX.Jar中的tomcat/lib/
  • GRANT ALL ON tinyurl.* TO 'tinyurl'@'%' IDENTIFIED BY 'secret';

*我们需要哪个版本的mysql-connector/J？版本

API使用

用于缩短的API非常简单：

缩短URL：

 # Method: POST
# Path: /tiny
# Content-Type: application/x-www-form-urlencoded
# Parameter: "url=${longURLencoded}"
# Example: curl -i -d "url=https%3A%2F%2Fgithub.com%2Fggrandes%2Ftinyurl%2F" ${BASE_URL}/tiny

返回这样的东西：

 HTTP/1.1 200 OK
Content-Type: application/json;charset=ISO-8859-1
Content-Length: 19
Cache-control: must-revalidate, max-age=0

{ "id": "iN8diz" }

检索短URL的QR图像：

 # Method: GET
# Path: /q/{id}
# Example: curl -i ${BASE_URL}/q/iN8diz

返回这样的东西：

 HTTP/1.1 200 OK
Cache-Control: public
Content-Type: image/png
Content-Length: 475

.PNG...binary-data...

检索原始/长URL：

 # Method: GET
# Path: /r/{id}
# Example: curl -i ${BASE_URL}/r/iN8diz

返回这样的东西：

 HTTP/1.1 302 Found
Location: https://github.com/ggrandes/tinyurl/
Content-Length: 0
Cache-control: must-revalidate, max-age=0

---

杂项

当前的硬编码值：

• 默认配置文件（在classPath中搜索）：org.javastack.tinyurl.properties
• URL的默认检查是：白名单，连接
• 默认检查缓存（MILLIS）：60000
• 默认连接超时（MILLIS）：10000
• 默认读取超时（毫里）：30000
• 来自URL的生成键的算法：MD5
• KEY_SPACE是：6个字符（base64为64^ks（6）= 68.719.476.736键max）
• 存储的默认后端为：kvstore（Portable）

---

灵感来自goo.gl，bit.ly和cort.s，此代码是Java-nimalistic版本。