thrift-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Can Celasun (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (THRIFT-4530) proposal: add nullability annotations to generated Java code
Date Fri, 23 Mar 2018 22:07:00 GMT

    [ https://issues.apache.org/jira/browse/THRIFT-4530?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16412173#comment-16412173
] 

Can Celasun commented on THRIFT-4530:
-------------------------------------

I think it's a good idea. Regarding which annotation to use, I think we should definitely
include a default {{@Nullable}} implementation, but it might also be worth adding a compiler
flag to use a different one.

For the patch, it's better if you send it as a PR on Github instead of posting it here, as
a PR will trigger a Travis build.

> proposal: add nullability annotations to generated Java code
> ------------------------------------------------------------
>
>                 Key: THRIFT-4530
>                 URL: https://issues.apache.org/jira/browse/THRIFT-4530
>             Project: Thrift
>          Issue Type: New Feature
>          Components: Java - Compiler
>            Reporter: Manu Sridharan
>            Priority: Major
>
> I'd like to propose (optionally) including {{@Nullable}} annotations in Thrift-generated
Java code.  I'm the main author of NullAway ([https://github.com/uber/NullAway)] and we'd
like to better support users who are using Thrift.  The change would involve changing the
Java code generator to include {{@Nullable}} annotations on every field, method return value,
and method parameter in the public API of generated code that may be null.  With these annotations,
NullAway users will get warnings when their client code is missing appropriate null checks. 
Also, IDEs like IntelliJ will give better warnings about missing null checks.  As part of
this change, I would also add support to NullAway for understanding {{isSetX()}} methods to
avoid excessive false positives.
> Regarding which {{@Nullable}} annotation to use, Thrift seems to try to minimize third-party
dependencies, but we could simply include a new Thrift {{@Nullable}} annotation, and it will
work fine with NullAway and most other tools.
> I have a WIP patch to generate these annotations, but I wanted to get feedback from the
maintainers before opening a PR.  We could of course make the annotation generation optional
and default it to being off, if desired.  Anyway, thoughts / feedback welcome.  Thanks!



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message