![]() * Strict mode for JSON parsing (#2323)
* Feat #6: Add strict flag to Gson and GsonBuilder
* Test #2: Add failing tests for capitalized keywords
* Feat #2: JsonReader does not read (partially) capitalized keywords if strict mode is used
* Feat #3: Added implementation and tests for JSONReader not accepting specific escape sequence representing in strict mode
* Test #3: Simplify test cases by removing unnecessary array
* Feat #3: Improve error by including the illegal character
* Feat #5: JsonReader does not allow unespaced control flow characters in strict mode
* Test #5: Test unespaced control flow characters in strict mode
* Feat #4: Disallow espaced newline character in strict mode
* Test #4: Add tests for (dis)allowing newline character depensding on strictness
* Test #5: Test case for unescaped control char in non-strict mode
* Test #2: Simplify test cases
* Feat #13: Change leniency API to Strictness enum in JsonReader, Gson, and GsonBuilder
* Feat #15: Change JsonWriter API to also use Strictness
* Test #15: Test Strictness in JsonWriter API
* Doc #15: Add and update documentation for Strictness in JsonWriter API
* refactor #12: Fixed typos and empty catch brackets in tests
* refactor #12: Resolved importing wildcards, made some lines adhere to Google java style
* #5 Add test case for unescaped control characters
* Feat #5: add new lines to make JsonReader able to detect unescaped control characters (U+0000 through U+001F) and throw exceptions.
* Feat #5: add new lines to make JsonReader able to detect unescaped control characters (U+0000 through U+001F) and throw exceptions.
* Test #11: Added two tests for testing implementation of control character handling in strict mode and moved the implementation to nextQuotedValue
* Test #11: Added two tests for testing implementation of control character handling in strict mode and moved the implementation to nextQuotedValue
---------
Co-authored-by: LMC117 <2295699210@qq.com>
Co-authored-by: Marten Voorberg <martenvoorberg@gmail.com>
* Doc #17: Add and change javadoc of public methods
* Doc #17: Update JavaDoc in JsonReader and Strictness
* Doc #17: Update JavaDoc in Gson and GsonBuilder
* Test #34: Add tests for setting strictness through GsonBuilder
* Fix: Add Fix broken test
* Fix: Invalid JavaDoc in Gson.java
* Doc #17: update outdated javadoc
* #37: Resolve more PR feedback
* Fix #37: Resolve various PR comments
* Fix #37: Resolve various PR comments
* Refactor #35: Refactor JsonReader#peekKeyword to reduce the amount of strictness checks (#39)
* Doc #40: Update JavaDoc based on PR feedback
* Doc #40: Update old RFC in GsonBuilder documentation
* Doc #40: Fix formatting error in JavaDoc
* Doc #40: Add tests for setting strictness and lenient to JsonReaderTest
* Test #43: Changed tests to make use of assertThrows
* test #43: Changed tests to make use of assertThrows as per feedback
* Test #43: Update JsonWriterTest#testStrictnessNull to use assertThrows
* Test #43: Update JsonWriterTest#testStrictnessNull to use assertThrows
* test #43: Resolve PR recommendations
* Test #43: Mini change to TC
* Test #43: Mini change to TC
---------
Co-authored-by: Marten Voorberg <martenvoorberg@gmail.com>
* doc #46: Resolved comments in main PR
* Feat #45: Change Gson.fromJson and Gson.toJson to be strict when the provided writer/reader is strict
* Fix #45: Small type
* Update gson/src/test/java/com/google/gson/stream/JsonReaderTest.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Fix #45: Resolve various comments by Marcono1234
* Update gson/src/main/java/com/google/gson/GsonBuilder.java
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Fix #45: Resolve various comments by Marcono1234
* Fix #45: Resolve various comments by eamonmcmanus
* Strictness mode follow-up
* Update Troubleshooting.md and Gson default lenient mode documentation
* Always use GSON strictness when set.
* Rename Strictness.DEFAULT to Strictness.LEGACY_STRICT
* Update JavaDoc with new strictness functionality
* Replace default with legacy strict for JsonReader javadoc
* Add JSONReader test cases for U2028 and U2029
* Refactor JSONReader#peekKeyWord() based on @eamonmcmanus's suggestion
* Deprecate setLenient in favor of setStrictness
---------
Co-authored-by: Carl Peterson <unknown>
Co-authored-by: Gustaf Johansson <gustajoh@kth.se>
Co-authored-by: gustajoh <58432871+gustajoh@users.noreply.github.com>
Co-authored-by: LMC117 <2295699210@qq.com>
Co-authored-by: Marcono1234 <Marcono1234@users.noreply.github.com>
* Strictness follow-up (#2408)
* Strictness mode follow-up
- Remove mentions of `null` Gson strictness; this is an implementation detail
- Fix incorrect / outdated documentation
- Reduce links to RFC; if there is already a link to it in a previous sentence
don't link to it again
- Extend and update tests
- Minor punctuation changes in documentation for consistency
* Deprecate `setLenient` methods
* `strictness2` fixes & improvements (#2456)
* Adjust ProGuard default rules and shrinking tests (#2420)
* Adjust ProGuard default rules and shrinking tests
* Adjust comment
* Add shrinking test for class without no-args constructor; improve docs
* Improve Unsafe mention in Troubleshooting Guide
* Improve comment for `-if class *`
* Bump com.google.guava:guava from 32.0.1-jre to 32.1.1-jre (#2444)
Bumps [com.google.guava:guava](https://github.com/google/guava) from 32.0.1-jre to 32.1.1-jre.
- [Release notes](https://github.com/google/guava/releases)
- [Commits](https://github.com/google/guava/commits)
---
updated-dependencies:
- dependency-name: com.google.guava:guava
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Bump com.google.guava:guava-testlib from 32.0.1-jre to 32.1.1-jre (#2443)
Bumps [com.google.guava:guava-testlib](https://github.com/google/guava) from 32.0.1-jre to 32.1.1-jre.
- [Release notes](https://github.com/google/guava/releases)
- [Commits](https://github.com/google/guava/commits)
---
updated-dependencies:
- dependency-name: com.google.guava:guava-testlib
dependency-type: direct:development
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Support non-generic type for `TypeToken.getParameterized` for legacy reasons (#2447)
This partially restores the behavior before
|
||
---|---|---|
.github | ||
.mvn | ||
examples/android-proguard-example | ||
extras | ||
gson | ||
lib | ||
metrics | ||
proto | ||
shrinker-test | ||
.gitignore | ||
CHANGELOG.md | ||
GsonDesignDocument.md | ||
LICENSE | ||
pom.xml | ||
README.md | ||
ReleaseProcess.md | ||
Troubleshooting.md | ||
UserGuide.md |
Gson
Gson is a Java library that can be used to convert Java Objects into their JSON representation. It can also be used to convert a JSON string to an equivalent Java object. Gson can work with arbitrary Java objects including pre-existing objects that you do not have source-code of.
There are a few open-source projects that can convert Java objects to JSON. However, most of them require that you place Java annotations in your classes; something that you can not do if you do not have access to the source-code. Most also do not fully support the use of Java Generics. Gson considers both of these as very important design goals.
ℹ️ Gson is currently in maintenance mode; existing bugs will be fixed, but large new features will likely not be added. If you want to add a new feature, please first search for existing GitHub issues, or create a new one to discuss the feature and get feedback.
Goals
- Provide simple
toJson()
andfromJson()
methods to convert Java objects to JSON and vice-versa - Allow pre-existing unmodifiable objects to be converted to and from JSON
- Extensive support of Java Generics
- Allow custom representations for objects
- Support arbitrarily complex objects (with deep inheritance hierarchies and extensive use of generic types)
Download
Gradle:
dependencies {
implementation 'com.google.code.gson:gson:2.10.1'
}
Maven:
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.10.1</version>
</dependency>
Gson jar downloads are available from Maven Central.
Requirements
Minimum Java version
- Gson 2.9.0 and newer: Java 7
- Gson 2.8.9 and older: Java 6
Despite supporting older Java versions, Gson also provides a JPMS module descriptor (module name com.google.gson
) for users of Java 9 or newer.
JPMS dependencies (Java 9+)
These are the optional Java Platform Module System (JPMS) JDK modules which Gson depends on. This only applies when running Java 9 or newer.
-
java.sql
(optional since Gson 2.8.9)
When this module is present, Gson provides default adapters for some SQL date and time classes. -
jdk.unsupported
, respectively classsun.misc.Unsafe
(optional)
When this module is present, Gson can use theUnsafe
class to create instances of classes without no-args constructor. However, care should be taken when relying on this.Unsafe
is not available in all environments and its usage has some pitfalls, seeGsonBuilder.disableJdkUnsafe()
.
Minimum Android API level
- Gson 2.11.0 and newer: API level 21
- Gson 2.10.1 and older: API level 19
Older Gson versions may also support lower API levels, however this has not been verified.
Documentation
- API Javadoc: Documentation for the current release
- User guide: This guide contains examples on how to use Gson in your code
- Troubleshooting guide: Describes how to solve common issues when using Gson
- Releases and change log: Latest releases and changes in these versions; for older releases see
CHANGELOG.md
- Design document: This document discusses issues we faced while designing Gson. It also includes a comparison of Gson with other Java libraries that can be used for Json conversion
Please use the 'gson' tag on StackOverflow or the google-gson Google group to discuss Gson or to post questions.
Related Content Created by Third Parties
- Gson Tutorial by
StudyTrails
- Gson Tutorial Series by
Future Studio
- Gson API Report
Building
Gson uses Maven to build the project:
mvn clean verify
JDK 11 or newer is required for building, JDK 17 is recommended.
Contributing
See the contributing guide.
Please perform a quick search to check if there are already existing issues or pull requests related to your contribution.
Keep in mind that Gson is in maintenance mode. If you want to add a new feature, please first search for existing GitHub issues, or create a new one to discuss the feature and get feedback.
License
Gson is released under the Apache 2.0 license.
Copyright 2008 Google Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Disclaimer
This is not an officially supported Google product.