cloudendpoints / endpoints-java

A Java framework for building RESTful APIs on Google App Engine
Apache License 2.0
32 stars 35 forks source link

Turn ServiceException into an UncheckedException #208

Closed eddiemay closed 1 year ago

eddiemay commented 3 years ago

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[bot] commented 3 years ago

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).

:memo: 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 commented 3 years ago

@googlebot I signed it!