erik/urlencoder-java
erik/urlencoder-java
1
0
Fork 0
mirror of https://github.com/gbevin/urlencoder.git synced 2025-04-24 23:07:12 -07:00
Code Issues Projects Releases Packages Wiki Activity

README tweaks

Browse source
This commit is contained in:
Geert Bevin 2022-12-31 14:25:56 -05:00
parent 3e397a65d2
commit 10e793fc39
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -10,12 +10,16 @@ A simple library to encode/decode URL parameters.
This library was extracted from the [RIFE2 Web Application Framework](https://rife2.com).
A Kotlin version can also be found at [https://github.com/ethauvin/urlencoder](https://github.com/ethauvin/urlencoder).
For decades, we've been using [java.net.URLEncoder](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URLEncoder.html)
For decades, we've been using `[java.net.URLEncoder](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URLEncoder.html)
because of its improper naming. It is actually intended to encode HTML form
parameters, not URLs.
parameters, not URLs, causing the wrong escape sequences to be used.
Additionally, java.net.URLEncoder allocates memory even when no encoding is
necessary, significantly impacting performance. This library has a negligible
performance impact when the string that is passed in doesn't need to be encoded.
Android's [Uri.encode](https://developer.android.com/reference/android/net/Uri#encode(java.lang.String,%20java.lang.String))
also addresses this issue.
also addresses these issues.
## Examples (TL;DR)