Lombok 使用教程-@Synchronized | 如何优雅的添加Synchronized锁

作者简介：大家好，我是smart哥，前中兴通讯、美团架构师，现某互联网公司CTO

联系qq：184480602，加我进群，大家一起学习，一起进步，一起对抗互联网寒冬

学习必须往深处挖，挖的越深，基础越扎实！

阶段1、深入多线程

阶段2、深入多线程设计模式

阶段3、深入juc源码解析

阶段4、深入jdk其余源码解析

阶段5、深入jvm源码解析

码哥源码部分

码哥讲源码-原理源码篇【2024年最新大厂关于线程池使用的场景题】

码哥讲源码【炸雷啦！炸雷啦！黄光头他终于跑路啦！】

码哥讲源码-【jvm课程前置知识及c/c++调试环境搭建】

​​​​​​码哥讲源码-原理源码篇【揭秘join方法的唤醒本质上决定于jvm的底层析构函数】

码哥源码-原理源码篇【Doug Lea为什么要将成员变量赋值给局部变量后再操作？】

码哥讲源码【你水不是你的错,但是你胡说八道就是你不对了！】

码哥讲源码【谁再说Spring不支持多线程事务，你给我抽他！】

终结B站没人能讲清楚红黑树的历史，不服等你来踢馆！

打脸系列【020-3小时讲解MESI协议和volatile之间的关系，那些将x86下的验证结果当作最终结果的水货们请闭嘴】

一、简介

@Synchronized是synchronized方法修饰语的一个更安全的变体。和synchronized一样，该注解只能用于静态和实例方法。它的操作与synchronized关键字类似，但它锁定的对象不同。关键字锁定了这个对象，但注解锁定了一个名为$lock的字段，它是私有的。

如果你愿意，你可以自己创建这些锁。如果你已经自己创建了$lock和$LOCK字段，当然就不会再生成它们。你也可以选择锁定另一个字段，通过指定它作为@Synchronized注释的参数。在这种用法的变体中，字段不会被自动创建，你必须自己明确地创建它们，否则会发出一个错误。

锁定此对象或您自己的类对象可能会产生不幸的副作用，因为您无法控制的其他代码也会锁定这些对象，这可能会导致竞争条件和其他与线程相关的严重错误。

二、示例比较

1. Lombok 写法

    import lombok.Synchronized;
    
    public class SynchronizedExample {
      private final Object readLock = new Object();
      
      @Synchronized
      public static void hello() {
        System.out.println("world");
      }
      
      @Synchronized
      public int answerToLife() {
        return 42;
      }
      
      @Synchronized("readLock")
      public void foo() {
        System.out.println("bar");
      }
    }

2. Java 标准写法

    public class SynchronizedExample {
      private static final Object $LOCK = new Object[0];
      private final Object $lock = new Object[0];
      private final Object readLock = new Object();
      
      public static void hello() {
        synchronized($LOCK) {
          System.out.println("world");
        }
      }
      
      public int answerToLife() {
        synchronized($lock) {
          return 42;
        }
      }
      
      public void foo() {
        synchronized(readLock) {
          System.out.println("bar");
        }
      }
    }

三、支持的配置项

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

四、附属说明

如果$lock或$LOCK是自动生成的，那么字段会用一个空的Object[]数组来初始化，而不是像大多数显示这种模式的代码段那样，只用一个new Object()。Lombok这样做是因为一个新的对象不是可序列化的，但0大小的数组是可序列化的。因此，使用@Synchronized将不会阻止你的对象被序列化。

在你的类中至少有一个@Synchronized方法意味着会有一个锁字段，但如果你后来删除了所有这样的方法，将不再有一个锁字段。这意味着你预先确定的serialVersionUID会发生变化。如果你打算通过java的序列化机制长期存储你的类，我们建议你总是给你的类添加一个serialVersionUID。如果你这样做了，从你的方法中移除所有的@Synchronized注解将不会破坏序列化。

为什么被锁定对象选择自己的名字时不会生成自动搜索结果：在字段名中打错字会导致一个非常难以发现的错误！

参考文献

【1】@Synchronized | synchronized done right: Don’t expose your locks.