【lombok】@Cleanup - 自动资源管理，安全的调用close方法

版权声明：本文为博主原创文章，转载请注明出处。 https://blog.csdn.net/amoscn/article/details/86544468

 

@Cleanup
当在处理文件对象，或者数据库资源时，我们总是会忘记close，可能引发内存溢出。

如果手动去调用close方法，代码又会非常长，现在有了@Cleanup , 我们不再需要担心这些问题。

您可以使用@Cleanup确保在代码执行路径退出当前作用域之前自动清除给定资源。 您可以通过使用@Cleanup注释来注释任何局部变量声明来执行此操作，如下所示：
@Cleanup InputStream in = new FileInputStream（“some / file”）;
因此，在您所在范围的末尾，调用in.close（）。 保证通过try / finally构造运行此调用。 请看下面的示例，看看它是如何工作的。

如果要清理的对象类型没有close（）方法，而是其他一些无参数方法，则可以指定此方法的名称，如下所示：
@Cleanup（“dispose”）org.eclipse.swt.widgets.CoolBar bar = new CoolBar（parent，0）;
默认情况下，清除方法假定为close（）。 不能通过@Cleanup调用带有1个或多个参数的清理方法。

为了方便理解，我们假设该内存资源是一扇门。初始化的时候，这扇门默认是打开的，等于说允许你在房间里做一些事情（看书，打游戏，睡觉） - 方法调用。将内存资源回收当作把门关掉，也就是不再允许你再做上述动作。（也许有人说，我可以关门看书，打游戏，睡觉！！！只是示例而已，别杠！！！）

看代码！非常简单易懂！！

package com.amos.lombok;

import lombok.Cleanup;

/**
 * @author chenjun
 */
public class Door {

    /**
     * 门是否打开
     * true : 打开
     * false : 关闭
     */
    private boolean openStatus;

    public Door(boolean openStatus) {
        this.openStatus = openStatus;
    }

    public Door() {
        this.openStatus = true;
        System.out.println("初始化时，门的状态默认是-打开 ");
    }

    public void function() {
        System.out.println("调用该对象的某一个或者多个方法ing");
    }

    public void close() {
        System.out.println("关门之前，门的状态是-" + (this.openStatus ? "打开" : "关闭"));
        this.openStatus = false;
        System.out.println("关门之前，门的状态是-关闭");
    }

    public static void main(String[] args) {
        @Cleanup Door door = new Door();
        door.function();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
执行main方式，打印数据如下：

初始化时，门的状态默认是-打开
调用该对象的某一个或者多个方法ing
关门之前，门的状态是-打开
关门之前，门的状态是-关闭

可以看出，当在新建的door对象上加上@Cleanup注解后，它会在我们调用完function方法后，自动的帮我们调用close方法。希望你自己去试试看，看虽然能看懂，但是手动写一下加深印象

编译完后，改main方法生成的class文件如下:

public static void main(String[] args) {
        Door door = new Door();

        try {
            door.function();
        } finally {
            if (Collections.singletonList(door).get(0) != null) {
                door.close();
            }

        }

    }
--------------------- 
版权声明：本文为CSDN博主「吃菜不吃饭」的原创文章，遵循CC 4.0 by-sa版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/amoscn/article/details/86544468

 

 

 

https://www.jianshu.com/p/f0b1b602d0c9

 

@Cleanup

 eagle_king 关注

2019.01.13 15:10 字数 599 阅读 1193评论 0喜欢 0

@Cleanup

自动资源管理：没有麻烦和安全地调用您的close()方法。

Overview

您可以使用@Cleanup以确保在代码执行路径退出当前作用域之前自动清除给定资源。您可以通过使用@Cleanup注释任何局部变量声明来执行此操作：
@Cleanup InputStream in = new FileInputStream("some/file");
结果，在您作用域范围的末尾调用in.close()。保证通过try / finally构造运行此调用。请看下面的示例，看看它是如何工作的。

如果要清理的对象类型没有close()方法，但是有其他一些无参数方法，则可以指定此方法的名称，如下所示：
@Cleanup("dispose") org.eclipse.swt.widgets.CoolBar bar = new CoolBar(parent, 0);
默认情况下，清除方法被假定为close()。@Cleanup无法调用带有1个或多个参数的清理方法。

With Lombok

import lombok.Cleanup;
import java.io.*;

public class CleanupExample {
  public static void main(String[] args) throws IOException {
    @Cleanup InputStream in = new FileInputStream(args[0]);
    @Cleanup OutputStream out = new FileOutputStream(args[1]);
    byte[] b = new byte[10000];
    while (true) {
      int r = in.read(b);
      if (r == -1) break;
      out.write(b, 0, r);
    }
  }
}

Vanilla Java

import java.io.*;

public class CleanupExample {
  public static void main(String[] args) throws IOException {
    InputStream in = new FileInputStream(args[0]);
    try {
      OutputStream out = new FileOutputStream(args[1]);
      try {
        byte[] b = new byte[10000];
        while (true) {
          int r = in.read(b);
          if (r == -1) break;
          out.write(b, 0, r);
        }
      } finally {
        if (out != null) {
          out.close();
        }
      }
    } finally {
      if (in != null) {
        in.close();
      }
    }
  }
}

Supported configuration keys:

lombok.cleanup.flagUsage = [warning | error] (default: not set)
如果配置， Lombok会将任何@Cleanup用法标记为警告或错误。

Small print

在finally块中，只有在给定资源不是null的情况下才会调用cleanup方法。但是，如果您使用delombok在代码上，则插入lombok.Lombok.preventNullAnalysis(Object o)调用以防止警告，如果静态代码分析可以确定，则不需要进行 null-check。使用 lombok.jar 类路径进行编译会删除该方法调用，因此不存在运行时依赖性。

如果您的代码抛出异常，并且随后触发的清理方法调用也会抛出异常，则清理调用抛出的异常将隐藏原始异常。你不应该依赖这个“功能”。最好是，lombok想生成代码，这样，如果主体抛出了异常，那么关闭调用抛出的任何异常都会被静默吞噬（但如果主体以任何其他方式退出，则关闭调用的异常将不会是吞咽）。lombok的作者目前不知道实现这个方案的可行方法，但是如果java更新允许它，或者我们找到了一种方法，我们将修复它。

您仍然需要处理清理方法可以生成的任何异常！