mirror of
https://github.com/gbevin/urlencoder.git
synced 2025-04-25 07:17:11 -07:00
130 lines
5.2 KiB
Markdown
130 lines
5.2 KiB
Markdown
[](https://opensource.org/licenses/Apache-2.0)
|
||
[](https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html)
|
||
[](https://s01.oss.sonatype.org/content/repositories/snapshots/com/uwyn/urlencoder/)
|
||
[](https://github.com/gbevin/urlencoder/releases/latest)
|
||
[](https://maven-badges.herokuapp.com/maven-central/com.uwyn/urlencoder)
|
||
[](https://github.com/gbevin/urlencoder/actions/workflows/bld.yml)
|
||
[](https://github.com/gbevin/urlencoder/actions/workflows/gradle.yml)
|
||
|
||
# URL Encoder for Java
|
||
|
||
A simple defensive library to encode/decode URL components.
|
||
|
||
This library was extracted from the [RIFE2 Web Application Framework](https://rife2.com).
|
||
A Kotlin Multiplatform version can also be found at [https://github.com/ethauvin/urlencoder](https://github.com/ethauvin/urlencoder).
|
||
|
||
The rules are determined by combining the unreserved character set from
|
||
[RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#page-13) with the
|
||
percent-encode set from
|
||
[application/x-www-form-urlencoded](https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set).
|
||
|
||
Both specs above support percent decoding of two hexadecimal digits to a
|
||
binary octet, however their unreserved set of characters differs and
|
||
`application/x-www-form-urlencoded` adds conversion of space to `+`,
|
||
that has the potential to be misunderstood.
|
||
|
||
This class encodes with rules that will be decoded correctly in either case.
|
||
|
||
Additionally, this library allocates no memory when encoding isn't needed and
|
||
does the work in a single pass without multiple loops. Both of these
|
||
optimizations have a significantly beneficial impact on performance of encoding
|
||
compared to other solutions like the standard `URLEncoder` in the JDK or
|
||
`UriUtils` in Spring.
|
||
|
||
## Examples (TL;DR)
|
||
|
||
```java
|
||
UrlEncoder.encode("a test &"); // -> "a%20test%20%26"
|
||
UrlEncoder.encode("%#okékÉȢ smile!😁"); // -> "%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81"
|
||
UrlEncoder.encode("?test=a test", "?="); // -> "?test=a%20test"
|
||
UrlEncoder.encode("foo bar", true); // -> "foo+bar" (encode space to +)
|
||
|
||
UrlEncoder.decode("a%20test%20%26"); // -> "a test &"
|
||
UrlEncoder.decode("%25%23ok%C3%A9k%C3%89%C8%A2%20smile%21%F0%9F%98%81"); // -> "%#okékÉȢ smile!😁"
|
||
UrlEncoder.decode("foo+bar", true); // -> "foo bar" (decode + to space)
|
||
```
|
||
|
||
## Gradle, Maven, etc.
|
||
To use with [Gradle](https://gradle.org/), include the following dependency in your build file:
|
||
|
||
```gradle
|
||
dependencies {
|
||
implementation("com.uwyn:urlencoder:1.2.0")
|
||
}
|
||
```
|
||
|
||
Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://maven-badges.herokuapp.com/maven-central/com.uwyn/urlencoder).
|
||
|
||
## Standalone usage
|
||
|
||
UrlEncoder can be used on the command line also, both for encoding and decoding.
|
||
|
||
You have two options:
|
||
* run it with Gradle
|
||
* build the jar and launch it with Java
|
||
|
||
The usage is as follows:
|
||
|
||
```
|
||
Encode and decode URL components defensively.
|
||
-e encode (default)
|
||
-d decode
|
||
```
|
||
|
||
### Running with Gradle
|
||
|
||
```shell
|
||
./gradlew run --args="-e 'a test &'" # -> a%20test%20%26
|
||
./gradlew run --args="%#okékÉȢ" # -> %25%23ok%C3%A9k%C3%89%C8%A2
|
||
|
||
./gradlew run --args="-d 'a%20test%20%26'" # -> a test &
|
||
```
|
||
|
||
### Running with Java
|
||
|
||
First build the jar file:
|
||
|
||
```shell
|
||
./gradlew clean jar
|
||
```
|
||
|
||
Then run it:
|
||
|
||
```shell
|
||
java -jar lib/build/libs/urlencoder-*.jar -e "a test &" # -> a%20test%20%26
|
||
java -jar lib/build/libs/urlencoder-*.jar "%#okékÉȢ" # -> %25%23ok%C3%A9k%C3%89%C8%A2
|
||
|
||
java -jar lib/build/libs/urlencoder-*.jar -d "a%20test%20%26" # -> a test &
|
||
```
|
||
|
||
## Why not simply use `java.net.URLEncoder`?
|
||
|
||
Apart for being quite inefficient and [deprecated](https://inside.java/2023/02/15/quality-heads-up/) as of JDK 20, some URL components encoded with `URLEncoder.encode` might not be able to be properly decoded.
|
||
|
||
For example, a simply search query such as:
|
||
|
||
```java
|
||
var u = URLEncoder.encode("foo +bar", StandardCharsets.UTF_8);
|
||
```
|
||
|
||
would be encoded as:
|
||
|
||
```
|
||
foo+%2Bbar
|
||
```
|
||
|
||
Trying to decode it with [Spring](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/util/UriUtils.html#decode(java.lang.String,java.lang.String)), for example:
|
||
|
||
```java
|
||
UriUtils.decode(u, StandardCharsets.UTF_8));
|
||
```
|
||
|
||
would return:
|
||
|
||
```
|
||
foo++bar
|
||
```
|
||
|
||
Unfortunately, decoding with [Uri.decode](https://developer.android.com/reference/android/net/Uri#decode(java.lang.String)) on Android, [decodeURI](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURI) in Javascript, etc. would yield the exact same result.
|
||
|
||
|