tinyurl

tinyurl

Tinyurlは、Java上のシンプルなURLショートナービルドです。プロジェクトはオープンソースです（Apacheライセンス、バージョン2.0）

現在の安定バージョンは1.0.7です

---

doc

構成ファイル

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

注：ファイルがclassPathにない場合は、 file:///etc/tinyurl/org.javastack.tinyurl.propertiesまたはhttps://config-server/tinyurl/org.javastack.tinyurl.propertiesなどのURL形式を使用して、file：///etc/tinyurl/org.tynyurl.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 ：ローカルファイルが保存される場所。
• whitelist.file ：ホワイトリストファイルが保存される場所。
• Check.Flags ：そのチェックはURLに対して行われます。
  • ホワイトリスト：ホワイトリストファイルに対してURLドメインをチェックします。
  • Surbl：Surbl Serviceに対してURLドメインを確認してください。見つかった場合、短縮剤は拒否されます。
  • 接続：HTTP接続（GET）でURLを確認します。
• check.cache.millis ：URLドメインチェックのキャッシュ時間（ホワイトリスト /サーブ）。
• Connection.Timeout.Millis ：Millisの接続タイムアウト。
• read.timeout.millis ：ミリでタイムアウトを読む。
• dump.key ：すべてのストレージをCSVでエクスポートするためのダンプキー。
• Storage.class ：永続性に使用されるクラス：
  • org.javastack.tinyurl.PersistentKVStore ：kvstore persistence（デフォルト、ポータブル）
  • org.javastack.tinyurl.jdbc.PersistentMySQL ：mysqlの持続性
    • Storage.url ：JDBC接続用のURL
    • Storage.username ：username
    • Storage.Password ：パスワード
    • Storage.xxx ：ストレージが付いた追加のパラメーターを参照してください。
• base.url ：tinyurlリダイレクターのベースURL（デフォルトではリクエストから発見してみてください） example: https://tiny.javastack.org/r/
• Qr.size.min ：qr（ピクセル、正方形）で許可される最小サイズ、デフォルト= 50
• Qr.size.max ：qr（ピクセル、正方形）で許可される最大サイズ、デフォルト= 1000
• Qr.size.default ：qr（ピクセル、正方形）のデフォルトサイズ、デフォルト= 300

その他の例

• Sampleconfディレクトリのその他の例

ランニング（Tomcat）

• CATALINA_OPTS="-Dorg.javastack.tinyurl.config=file://${CATALINA_BASE}/conf/org.javastack.tinyurl.properties" in tomcat/bin/setenv.sh（linux）
• webappsディレクトリ内のwarファイルをname：root.warをコピーします
• mysqlの持続性について：
  • mysql-connector-java-xxxx.jarをTomcat/lib/
  • MySQLユーザーを作成します： 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のデフォルトチェックは次のとおりです。ホワイトリスト、接続
• デフォルトチェックキャッシュ（ミリ）：60000
• デフォルトの接続タイムアウト（MILLIS）：10000
• デフォルトの読み取りタイムアウト（Millis）：30000
• URLからキーを生成するためのアルゴリズム：MD5
• KEY_SPACEは6文字です（base64は64^ks（6）= 68.719.476.736キーmax）
• ストレージ用のデフォルトのバックエンドは：kvstore（ポータブル）

---

goo.gl、bit.ly、cort.asにインスピレーションを受けたこのコードは、Java-Minimalisticバージョンです。