Lombok 使用教程
首页 死磕 Java 优质系列 Java 技术总览 Java 面试宝典 关于我

Lombok 使用教程-@Helper | 让你可以在方法内部中写方法

转
 2024-01-10  阅读(0)
©版权
原文作者：猫巳 原文地址： https://moonce.blog.csdn.net/article/details/122214401

一、实验性功能说明

在lombok v1.16.6中，@Helper作为一个实验性功能被引入。

实验因为：

  • 具有通用函数类型的lambda提供了一种替代策略。
  • 也许有一种方法可以使辅助方法的模板更少，从而使这个功能变得过时。

当前状态：未知–我们对这一功能没有足够的经验，无法对其未来做出预测。

二、简介

这个注解让你把方法放在方法中。你可能不知道，但是你可以在方法中声明类，并且这个类中的方法可以访问任何在声明前定义和设置的（有效的）最终局部变量或参数。不幸的是，要真正调用任何方法，你必须先建立一个这个方法局部类的实例，但这就是@Helper的作用，它可以帮助你解决这个问题! 用@Helper来注解一个方法局部类，就好像该帮助类中的所有方法都是你可以直接调用的方法，就像java允许方法存在于方法内部一样。

通常情况下，你必须声明你的帮助器的实例，例如：HelperClass h = new HelperClass(); 在声明了你的助手类之后，直接调用你的助手类中的方法，用h.helperMethod(); 。有了@Helper，这两件事就不再需要了。你不需要浪费一行代码来声明一个助手的实例，也不需要在所有对助手方法的调用前加上nameOfHelperInstance。

三、示例比较

1. Lombok 写法

    
    import lombok.experimental.Helper;
    
    public class HelperExample {
      int someMethod(int arg1) {
        int localVar = 5;
    
        @Helper class Helpers {
          int helperMethod(int arg) {
            return arg + localVar;
          }
        }
    
        return helperMethod(10);
      }
    }

2. Java 标准写法

    
    public class HelperExample {
      int someMethod(int arg1) {
        int localVar = 5;
    
        class Helpers {
          int helperMethod(int arg) {
            return arg + localVar;
          }
        }
        Helpers $Helpers = new Helpers();
    
        return $Helpers.helperMethod(10);
      }
    }

四、支持的配置项

lombok.helper.flagUsage = [warning | error] (默认: not set)
Lombok将@Helper的任何使用标记为警告或错误（如果已配置）。

五、附属说明

@Helper要求辅助类有一个无args的构造函数。如果不是这样的话，将会产生一个编译器错误。

目前，你的辅助类的实例在引擎下被称为$Foo，其中Foo是你的辅助类的名字。我们将来可能会改变这一点；请不要依赖这个变量的存在。我们甚至可能在以后用一个兄弟姐妹的方法来代替它。

请不要指望 this在辅助方法的代码中会有任何意义。你可以通过使用语法NameOfMyClass.this来引用真正的“this”。

在代码中，任何存在于辅助类方法声明下面的、与辅助类中任何方法同名的未限定的方法调用都被认为是对辅助类的调用。如果参数最终不兼容，你会得到一个编译器错误。

除非你使用的是JDK8或更高版本（它引入了 "effectively final"的概念），否则如果你想在方法的局部类中引用局部变量和参数，你必须将它们声明为final变量。这是java的限制，不是lombok的@Helper特有的东西。

参考文献

【1】@Helper | With a little help from my friends… Helper methods for java.

Java 面试宝典是大明哥全力打造的 Java 精品面试题，它是一份靠谱、强大、详细、经典的 Java 后端面试宝典。它不仅仅只是一道道面试题，而是一套完整的 Java 知识体系，一套你 Java 知识点的扫盲贴。

它的内容包括：

  • 大厂真题：Java 面试宝典里面的题目都是最近几年的高频的大厂面试真题。
  • 原创内容：Java 面试宝典内容全部都是大明哥原创，内容全面且通俗易懂，回答部分可以直接作为面试回答内容。
  • 持续更新：一次购买，永久有效。大明哥会持续更新 3+ 年，累计更新 1000+，宝典会不断迭代更新，保证最新、最全面。
  • 覆盖全面：本宝典累计更新 1000+，从 Java 入门到 Java 架构的高频面试题，实现 360° 全覆盖。
  • 不止面试：内容包含面试题解析、内容详解、知识扩展，它不仅仅只是一份面试题，更是一套完整的 Java 知识体系。
  • 宝典详情：https://www.yuque.com/chenssy/sike-java/xvlo920axlp7sf4k
  • 宝典总览：https://www.yuque.com/chenssy/sike-java/yogsehzntzgp4ly1
  • 宝典进展：https://www.yuque.com/chenssy/sike-java/en9ned7loo47z5aw

目前 Java 面试宝典累计更新 400+ 道，总字数 42w+。大明哥还在持续更新中，下图是大明哥在 2024-12 月份的更新情况：

想了解详情的小伙伴，扫描下面二维码加大明哥微信【daming091】咨询

同时，大明哥也整理一套目前市面最常见的热点面试题。微信搜[大明哥聊 Java]或扫描下方二维码关注大明哥的原创公众号[大明哥聊 Java] ，回复【面试题】 即可免费领取。

阅读全文
文章标签： Lombok