Skip to content
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#208
eddiemay wants to merge 1 commit intocloudendpoints:masterfrom
eddiemay:patch-1

Conversation

@eddiemay
Copy link

@eddiemay eddiemay commented Sep 5, 2021

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.

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.
@google-cla
Copy link

google-cla bot commented Sep 5, 2021

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 @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@eddiemay eddiemay closed this Sep 5, 2021
@eddiemay eddiemay reopened this Sep 5, 2021
@eddiemay
Copy link
Author

eddiemay commented Sep 5, 2021

@googlebot I signed it!

@eddiemay eddiemay closed this by deleting the head repository Jan 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant