This repository was archived by the owner on Jun 30, 2023. It is now read-only.
Turn ServiceException into an UncheckedException#208
Closed
eddiemay wants to merge 1 commit intocloudendpoints:masterfrom
eddiemay:patch-1
Closed
Turn ServiceException into an UncheckedException#208eddiemay wants to merge 1 commit intocloudendpoints:masterfrom eddiemay:patch-1
eddiemay wants to merge 1 commit intocloudendpoints:masterfrom
eddiemay:patch-1
Conversation
From Effective Java Item 71: Avoid unnecessary use of checked exceptions "overuse of checked exceptions in APIs can make them far less pleasant to use. If a method throws checked exceptions, the code that invokes it must handle them in one or more catch blocks, or declare that it throws them and let them propagate outward. Either way, it places a burden on the user of the API. The burden increased in Java 8, as methods throwing checked exceptions can’t be used directly in streams (Items 45–48)." In this API the outer Google Cloud Endpoints framework handles these ServiceExceptions, the developer is simply to detect other exceptions then wrap them in a ServiceException to throw up to the framework for proper error code response. If the code that throws the exception is a few levels deep the developer is forced to propagate throws ServiceException on all those methods. The developer is not supposed to handle these exceptions but allow the framework to handle them, thus they should not have to deal with that burden.
|
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed (or fixed any issues), please reply here with What to do if you already signed the CLAIndividual signers
Corporate signers
ℹ️ Googlers: Go here for more info. |
Author
|
@googlebot I signed it! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
From Effective Java Item 71: Avoid unnecessary use of checked exceptions
"overuse of checked exceptions in APIs can make them far less pleasant to use. If a method throws checked exceptions, the code that invokes it must handle them in one or more catch blocks, or declare that it throws them and let them propagate outward. Either way, it places a burden on the user of the API. The burden increased in Java 8, as methods throwing checked exceptions can’t be used directly in streams (Items 45–48)."
In this API the outer Google Cloud Endpoints framework handles these ServiceExceptions, the developer is simply to detect other exceptions then wrap them in a ServiceException to throw up to the framework for proper error code response. If the code that throws the exception is a few levels deep the developer is forced to propagate throws ServiceException on all those methods. The developer is not supposed to handle these exceptions but allow the framework to handle them, thus they should not have to deal with that burden.