From 58ec992025ebeb5b9ac937bb94d9095d1be3c446 Mon Sep 17 00:00:00 2001 From: wangj19 Date: Mon, 21 Sep 2026 22:10:30 +0800 Subject: [PATCH 1/4] 111 --- ...\204Class\347\261\273\345\222\214Object\347\261\273.md" | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git "a/docs/Java/basic/Java\344\270\255\347\232\204Class\347\261\273\345\222\214Object\347\261\273.md" "b/docs/Java/basic/Java\344\270\255\347\232\204Class\347\261\273\345\222\214Object\347\261\273.md" index 7ff3baa..d8e987b 100644 --- "a/docs/Java/basic/Java\344\270\255\347\232\204Class\347\261\273\345\222\214Object\347\261\273.md" +++ "b/docs/Java/basic/Java\344\270\255\347\232\204Class\347\261\273\345\222\214Object\347\261\273.md" @@ -99,7 +99,7 @@ private Class(ClassLoader loader) { // annotationTypeOffset = objectFieldOffset(fields, "annotationType"); // annotationDataOffset = objectFieldOffset(fields, "annotationData"); // } - + } //æ��ä¾›å��å°„ä¿¡æ�¯ // reflection data that might get invalidated when JVM TI RedefineClasses() is called // private static class ReflectionData { @@ -159,11 +159,11 @@ private Class(ClassLoader loader) { // } // } } +} ```` > 我们都知é�“所有的java类都是继承了object这个类,在object这个类中有一个方法:getclass().这个方法是用æ�¥å�–得该类已ç»�被实例化了的对象的该类的引用,这个引用指å�‘的是Class类的对象。 -> -> 我们自己无法生æˆ�一个Class对象(构造函数为private),而 这个Class类的对象是在当å�„类被调入时,由 Java 虚拟机自动创建 Class 对象,或通过类装载器中的 defineClass 方法生æˆ�。 +> 我们自己无法生æˆ�一个Class对象(构造函数为private),而 这个Class类的对象是在当å�„类被调入时,由 Java 虚拟机自动创建 Class 对象,或通过类装载器中的 defineClass 方法生æˆ�。 //通过该方法å�¯ä»¥åЍæ€�地将字节ç �转为一个Class类对象 protected final Class defineClass(String name, byte[] b, int off, int len) @@ -171,7 +171,6 @@ private Class(ClassLoader loader) { { return defineClass(name, b, off, len, null); } -> ### 如何获得一个Class类对象 From c2ead2d21dfe486711ea2eb1226a7c09044015ef Mon Sep 17 00:00:00 2001 From: wangj19 Date: Wed, 23 Sep 2026 12:40:28 +0800 Subject: [PATCH 2/4] 2222 --- .../\345\244\232\347\272\277\347\250\213.md" | 561 +++++++++--------- 1 file changed, 276 insertions(+), 285 deletions(-) diff --git "a/docs/Java/basic/\345\244\232\347\272\277\347\250\213.md" "b/docs/Java/basic/\345\244\232\347\272\277\347\250\213.md" index 35e3ada..18d9e7f 100644 --- "a/docs/Java/basic/\345\244\232\347\272\277\347\250\213.md" +++ "b/docs/Java/basic/\345\244\232\347\272\277\347\250\213.md" @@ -32,30 +32,27 @@ 如果对本系列文章有什么建议,或者是有什么疑问的è¯�,也å�¯ä»¥å…³æ³¨å…¬ä¼—å�·ã€�Java技术江湖】è�”系作者,欢迎你å�‚与本系列å�šæ–‡çš„åˆ›ä½œå’Œä¿®è®¢ã€‚ - +--- ## Java中的线程 Java之父对线程的定义是: -> 线程是一个独立执行的调用åº�列,å�Œä¸€ä¸ªè¿›ç¨‹çš„线程在å�Œä¸€æ—¶åˆ»å…±äº«ä¸€äº›ç³»ç»Ÿèµ„æº�(比如文件å�¥æŸ„等)也能访问å�Œä¸€ä¸ªè¿›ç¨‹æ‰€åˆ›å»ºçš„对象资æº�(内存资æº�)。java.lang.Thread对象负责统计和控制这ç§�行为。 -> æ¯�个程åº�都至少拥有一个线程-å�³ä½œä¸ºJava虚拟机(JVM)å�¯åЍå�‚æ•°è¿�行在主类main方法的线程。在Java虚拟机åˆ�始化过程中也å�¯èƒ½å�¯åŠ¨å…¶ä»–çš„å�Žå�°çº¿ç¨‹ã€‚è¿™ç§�线程的数目和ç§�类因JVM的实现而异。然而所有用户级线程都是显å¼�被构造并在主线程或者是其他用户线程中被å�¯åŠ¨ã€‚ +线程是一个独立执行的调用åº�列,å�Œä¸€ä¸ªè¿›ç¨‹çš„线程在å�Œä¸€æ—¶åˆ»å…±äº«ä¸€äº›ç³»ç»Ÿèµ„æº�(比如文件å�¥æŸ„等)也能访问å�Œä¸€ä¸ªè¿›ç¨‹æ‰€åˆ›å»ºçš„对象资æº�(内存资æº�)。`java.lang.Thread` 对象负责统计和控制这ç§�行为。 - 本文主è¦�讲了java中多线程的使用方法ã€�线程å�Œæ­¥ã€�线程数æ�®ä¼ é€’ã€�线程状æ€�å�Šç›¸åº”的一些线程函数用法ã€�概述等。在这之å‰�,首先让我们æ�¥äº†è§£ä¸‹åœ¨æ“�作系统中进程和线程的区别: - -   进程:æ¯�个进程都有独立的代ç �和数æ�®ç©ºé—´ï¼ˆè¿›ç¨‹ä¸Šä¸‹æ–‡ï¼‰ï¼Œè¿›ç¨‹é—´çš„切æ�¢ä¼šæœ‰è¾ƒå¤§çš„开销,一个进程包å�«1--n个线程。(进程是资æº�分é…�的最å°�å�•ä½�) - -   线程:å�Œä¸€ç±»çº¿ç¨‹å…±äº«ä»£ç �和数æ�®ç©ºé—´ï¼Œæ¯�个线程有独立的è¿�行栈和程åº�计数器(PC),线程切æ�¢å¼€é”€å°�。(线程是cpu调度的最å°�å�•ä½�) - -   线程和进程一样分为五个阶段:创建ã€�就绪ã€�è¿�行ã€�阻塞ã€�终止。 - -   多进程是指æ“�作系统能å�Œæ—¶è¿�行多个任务(程åº�)。 - -   多线程是指在å�Œä¸€ç¨‹åº�中有多个顺åº�æµ�在执行。 - - 在java中è¦�想实现多线程,有两ç§�手段,一ç§�是继续Thread类,å�¦å¤–一ç§�是实现Runable接å�£.(其实准确æ�¥è®²ï¼Œåº”该有三ç§�,还有一ç§�是实现Callable接å�£ï¼Œå¹¶ä¸ŽFutureã€�线程池结å�ˆä½¿ç”¨ +æ¯�个程åº�都至少拥有一个线程,å�³ä½œä¸º Java 虚拟机(JVM)å�¯åЍå�‚æ•°è¿�行在主类 `main` 方法的线程。在 Java 虚拟机åˆ�始化过程中也å�¯èƒ½å�¯åŠ¨å…¶ä»–çš„å�Žå�°çº¿ç¨‹ã€‚è¿™ç§�线程的数目和ç§�类因 JVM 的实现而异。然而所有用户级线程都是显å¼�被构造并在主线程或者是其他用户线程中被å�¯åŠ¨ã€‚ + +本文主è¦�讲 Java 中多线程的使用方法ã€�线程å�Œæ­¥ã€�线程数æ�®ä¼ é€’ã€�线程状æ€�å�Šç›¸åº”的一些线程函数用法ã€�概述等。在这之å‰�,先看æ“�作系统里进程和线程的区别: + +- **进程:** æ¯�个进程都有独立的代ç �和数æ�®ç©ºé—´ï¼ˆè¿›ç¨‹ä¸Šä¸‹æ–‡ï¼‰ï¼Œè¿›ç¨‹é—´çš„切æ�¢å¼€é”€è¾ƒå¤§ï¼Œä¸€ä¸ªè¿›ç¨‹åŒ…å�« 1 到 n 个线程。进程是资æº�分é…�的最å°�å�•ä½�。 +- **线程:** å�Œä¸€è¿›ç¨‹é‡Œçš„线程共享代ç �和数æ�®ç©ºé—´ï¼Œæ¯�个线程有独立的è¿�行栈和程åº�计数器(PC),线程切æ�¢å¼€é”€å°�。线程是 CPU 调度的最å°�å�•ä½�。 +- 线程和进程一样分为五个阶段:创建ã€�就绪ã€�è¿�行ã€�阻塞ã€�终止。 +- 多进程:æ“�作系统能å�Œæ—¶è¿�行多个任务(程åº�)。 +- 多线程:å�Œä¸€ç¨‹åº�中有多个顺åº�æµ�在执行。 + +在 Java 里实现多线程,常è§�是继承 `Thread` 类,或实现 `Runnable` 接å�£ã€‚更准确说还有第三ç§�:实现 `Callable` 接å�£ï¼Œå¹¶ä¸Ž `Future`ã€�线程池结å�ˆä½¿ç”¨ã€‚ ## Java线程状æ€�机 @@ -68,317 +65,314 @@ Java 给多线程编程æ��供了内置的支æŒ�。 一æ�¡çº¿ç¨‹æŒ‡çš„æ˜¯è¿›ç¨‹ 多线程能满足程åº�员编写高效率的程åº�æ�¥è¾¾åˆ°å……分利用 CPU 的目的。 -* * * ### 一个线程的生命周期 线程是一个动æ€�执行的过程,它也有一个从产生到死亡的过程。 -下图显示了一个线程完整的生命周期。 - -![](https://www.runoob.com/wp-content/uploads/2014/01/java-thread.jpg) +å�„状æ€�如下: -* **新建状æ€�:** +- **新建:** `new Thread(...)` 之å�Žã€�调用 `start()` 之å‰�。 +- **就绪:** 调用了 `start()`,在就绪队列里等 JVM 调度。 +- **è¿�行:** 抢到 CPU,正在执行 `run()`。 +- **阻塞:** `sleep` / `wait` / 抢ä¸�到é”� / I/O。æ�¡ä»¶æ»¡è¶³å�Žå›žåˆ°å°±ç»ªã€‚ +- **死亡:** `run()` 结æ�Ÿæˆ–未æ�•获异常。ä¸�能å†� `start()`。 - 使用**new**关键字和**Thread**类或其å­�类建立一个线程对象å�Žï¼Œè¯¥çº¿ç¨‹å¯¹è±¡å°±å¤„于新建状æ€�。它ä¿�æŒ�这个状æ€�直到程åº�**start()**这个线程。 +**新建状æ€�:** 使用 `new` 关键字和 `Thread` 类或其å­�类建立一个线程对象å�Žï¼Œè¯¥çº¿ç¨‹å¯¹è±¡å°±å¤„于新建状æ€�。它ä¿�æŒ�这个状æ€�直到程åº� `start()` 这个线程。 -* **就绪状æ€�:** +**就绪状æ€�:** 当线程对象调用了 `start()` 方法之å�Žï¼Œè¯¥çº¿ç¨‹å°±è¿›å…¥å°±ç»ªçжæ€�。就绪状æ€�的线程处于就绪队列中,è¦�等待 JVM 里线程调度器的调度。 - 当线程对象调用了start()方法之å�Žï¼Œè¯¥çº¿ç¨‹å°±è¿›å…¥å°±ç»ªçжæ€�。就绪状æ€�的线程处于就绪队列中,è¦�等待JVM里线程调度器的调度。 +**è¿�行状æ€�:** 如果就绪状æ€�的线程获å�– CPU 资æº�,就å�¯ä»¥æ‰§è¡Œ `run()`,此时线程便处于è¿�行状æ€�。处于è¿�行状æ€�的线程最为å¤�æ�‚,它å�¯ä»¥å�˜ä¸ºé˜»å¡žçжæ€�ã€�就绪状æ€�和死亡状æ€�。 -* **è¿�行状æ€�:** +**阻塞状æ€�:** 如果一个线程执行了 `sleep`(ç�¡çœ ï¼‰ã€�`suspend`(挂起)等方法,失去所å� ç”¨èµ„æº�之å�Žï¼Œè¯¥çº¿ç¨‹å°±ä»Žè¿�行状æ€�进入阻塞状æ€�。在ç�¡çœ æ—¶é—´å·²åˆ°æˆ–获得设备资æº�å�Žå�¯ä»¥é‡�新进入就绪状æ€�。å�¯ä»¥åˆ†ä¸ºä¸‰ç§�: - 如果就绪状æ€�的线程获å�– CPU 资æº�,就å�¯ä»¥æ‰§è¡Œ**run()**,此时线程便处于è¿�行状æ€�。处于è¿�行状æ€�的线程最为å¤�æ�‚,它å�¯ä»¥å�˜ä¸ºé˜»å¡žçжæ€�ã€�就绪状æ€�和死亡状æ€�。 +- 等待阻塞:è¿�行状æ€�中的线程执行 `wait()` 方法,使线程进入到等待阻塞状æ€�。 +- å�Œæ­¥é˜»å¡žï¼šçº¿ç¨‹åœ¨èŽ·å�– `synchronized` å�Œæ­¥é”�失败(因为å�Œæ­¥é”�被其他线程å� ç”¨ï¼‰ã€‚ +- 其他阻塞:通过调用线程的 `sleep()` 或 `join()` å�‘出了 I/O 请求时,线程就会进入到阻塞状æ€�。当 `sleep()` 状æ€�超时,`join()` 等待线程终止或超时,或者 I/O 处ç�†å®Œæ¯•,线程é‡�新转入就绪状æ€�。 -* **阻塞状æ€�:** +**死亡状æ€�:** 一个è¿�行状æ€�的线程完æˆ�任务或者其他终止æ�¡ä»¶å�‘生时,该线程就切æ�¢åˆ°ç»ˆæ­¢çжæ€�。 - 如果一个线程执行了sleep(ç�¡çœ ï¼‰ã€�suspend(挂起)等方法,失去所å� ç”¨èµ„æº�之å�Žï¼Œè¯¥çº¿ç¨‹å°±ä»Žè¿�行状æ€�进入阻塞状æ€�。在ç�¡çœ æ—¶é—´å·²åˆ°æˆ–获得设备资æº�å�Žå�¯ä»¥é‡�新进入就绪状æ€�。å�¯ä»¥åˆ†ä¸ºä¸‰ç§�: - - * 等待阻塞:è¿�行状æ€�中的线程执行 wait() 方法,使线程进入到等待阻塞状æ€�。 +## Java多线程实战 - * å�Œæ­¥é˜»å¡žï¼šçº¿ç¨‹åœ¨èŽ·å�– synchronized å�Œæ­¥é”�失败(因为å�Œæ­¥é”�被其他线程å� ç”¨)。 +## 多线程的实现 - * 其他阻塞:通过调用线程的 sleep() 或 join() å�‘出了 I/O 请求时,线程就会进入到阻塞状æ€�。当sleep() 状æ€�超时,join() 等待线程终止或超时,或者 I/O 处ç�†å®Œæ¯•,线程é‡�新转入就绪状æ€�。 +```java +public class 多线程实例 { -* **死亡状æ€�:** + //继承thread + @Test + public void test1() { + class A extends Thread { + @Override + public void run() { + System.out.println("A run"); + } + } + A a = new A(); + a.start(); + } - 一个è¿�行状æ€�的线程完æˆ�任务或者其他终止æ�¡ä»¶å�‘生时,该线程就切æ�¢åˆ°ç»ˆæ­¢çжæ€�。 -## Java多线程实战 -## 多线程的实现 + //实现Runnable + @Test + public void test2() { + class B implements Runnable { - public class 多线程实例 { - - //继承thread - @Test - public void test1() { - class A extends Thread { - @Override - public void run() { - System.out.println("A run"); - } + @Override + public void run() { + System.out.println("B run"); } - A a = new A(); - a.start(); } - - //实现Runnable - @Test - public void test2() { - class B implements Runnable { - - @Override - public void run() { - System.out.println("B run"); + B b = new B(); + //Runable实现类需è¦�ç”±Thread类包装å�Žæ‰�能执行 + new Thread(b).start(); + } + + //有返回值的线程 + @Test + public void test3() { + Callable callable = new Callable() { + int sum = 0; + @Override + public Object call() throws Exception { + for (int i = 0; i <= 4; i++) { + sum += i; } + return sum; } - B b = new B(); - //Runable实现类需è¦�ç”±Thread类包装å�Žæ‰�能执行 - new Thread(b).start(); + }; + //这里è¦�用FutureTask,å�¦åˆ™ä¸�能加入Thread构造方法 + FutureTask futureTask = new FutureTask(callable); + new Thread(futureTask).start(); + try { + System.out.println(futureTask.get()); + } catch (InterruptedException e) { + e.printStackTrace(); + } catch (ExecutionException e) { + e.printStackTrace(); } - - //有返回值的线程 - @Test - public void test3() { - Callable callable = new Callable() { - int sum = 0; - @Override - public Object call() throws Exception { - for (int i = 0;i < 5;i ++) { - sum += i; - } - return sum; - } - }; - //这里è¦�用FutureTask,å�¦åˆ™ä¸�能加入Thread构造方法 - FutureTask futureTask = new FutureTask(callable); - new Thread(futureTask).start(); - try { - System.out.println(futureTask.get()); - } catch (InterruptedException e) { - e.printStackTrace(); - } catch (ExecutionException e) { - e.printStackTrace(); + } + + //线程池实现 + @Test + public void test4() { + ExecutorService executorService = Executors.newFixedThreadPool(5); + //execute直接执行线程 + executorService.execute(new Thread()); + executorService.execute(new Runnable() { + @Override + public void run() { + System.out.println("runnable"); + } + }); + //submitæ��交有返回结果的任务,è¿�行完å�Žè¿”回结果。 + Future future = executorService.submit(new Callable() { + @Override + public String call() throws Exception { + return "a"; } + }); + try { + System.out.println(future.get()); + } catch (InterruptedException e) { + e.printStackTrace(); + } catch (ExecutionException e) { + e.printStackTrace(); } - - //线程池实现 - @Test - public void test4() { - ExecutorService executorService = Executors.newFixedThreadPool(5); - //execute直接执行线程 - executorService.execute(new Thread()); - executorService.execute(new Runnable() { - @Override - public void run() { - System.out.println("runnable"); - } - }); - //submitæ��交有返回结果的任务,è¿�行完å�Žè¿”回结果。 - Future future = executorService.submit(new Callable() { + + ArrayList list = new ArrayList(); + //有返回值的线程组将返回值存进集å�ˆ + for (int i = 0; i <= 4; i++) { + int finalI = i; + Future future1 = executorService.submit(new Callable() { @Override public String call() throws Exception { - return "a"; + return "res" + finalI; } }); try { - System.out.println(future.get()); + list.add((String) future1.get()); } catch (InterruptedException e) { e.printStackTrace(); } catch (ExecutionException e) { e.printStackTrace(); } - - ArrayList list = new ArrayList<>(); - //有返回值的线程组将返回值存进集å�ˆ - for (int i = 0;i < 5;i ++ ) { - int finalI = i; - Future future1 = executorService.submit(new Callable() { - @Override - public String call() throws Exception { - return "res" + finalI; - } - }); - try { - list.add((String) future1.get()); - } catch (InterruptedException e) { - e.printStackTrace(); - } catch (ExecutionException e) { - e.printStackTrace(); - } - } - for (String s : list) { - System.out.println(s); - } + } + for (String s : list) { + System.out.println(s); } } +} +``` ## 线程状æ€�转æ�¢ - public class 线程的状æ€�转æ�¢ { - //一开始线程是init状æ€�,结æ�Ÿæ—¶æ˜¯terminated状æ€� - class t implements Runnable { - private String name; - public t(String name) { - this.name = name; - } - @Override - public void run() { - System.out.println(name + "run"); - } +```java +public class 线程的状æ€�转æ�¢ { +//一开始线程是init状æ€�,结æ�Ÿæ—¶æ˜¯terminated状æ€� +class t implements Runnable { + private String name; + public t(String name) { + this.name = name; } + @Override + public void run() { + System.out.println(name + "run"); + } +} - //测试join,父线程在å­�线程è¿�行时进入waiting状æ€� - @Test - public void test1() throws InterruptedException { - Thread dad = new Thread(new Runnable() { - Thread son = new Thread(new t("son")); - @Override - public void run() { - System.out.println("dad init"); - son.start(); - try { - //ä¿�è¯�å­�线程è¿�行完å†�è¿�行父线程 - son.join(); - System.out.println("dad run"); - } catch (InterruptedException e) { - e.printStackTrace(); - } +//测试join,父线程在å­�线程è¿�行时进入waiting状æ€� +@Test +public void test1() throws InterruptedException { + Thread dad = new Thread(new Runnable() { + Thread son = new Thread(new t("son")); + @Override + public void run() { + System.out.println("dad init"); + son.start(); + try { + //ä¿�è¯�å­�线程è¿�行完å†�è¿�行父线程 + son.join(); + System.out.println("dad run"); + } catch (InterruptedException e) { + e.printStackTrace(); } - }); - //调用start,线程进入runnable状æ€�,等待系统调度 - dad.start(); - //在父线程中对å­�线程实例使用join,ä¿�è¯�å­�线程在父线程之å‰�执行完 + } + }); + //调用start,线程进入runnable状æ€�,等待系统调度 + dad.start(); + //在父线程中对å­�线程实例使用join,ä¿�è¯�å­�线程在父线程之å‰�执行完 - } +} - //测试sleep - @Test - public void test2(){ - Thread t1 = new Thread(new Runnable() { - @Override - public void run() { - System.out.println("t1 run"); - try { - Thread.sleep(3000); - } catch (InterruptedException e) { - e.printStackTrace(); - } +//测试sleep +@Test +public void test2(){ + Thread t1 = new Thread(new Runnable() { + @Override + public void run() { + System.out.println("t1 run"); + try { + Thread.sleep(3000); + } catch (InterruptedException e) { + e.printStackTrace(); } - }); - - //主线程休眠。进入time waiting状æ€� - try { - Thread.sleep(3000); - } catch (InterruptedException e) { - e.printStackTrace(); } - t1.start(); + }); + //主线程休眠。进入time waiting状æ€� + try { + Thread.sleep(3000); + } catch (InterruptedException e) { + e.printStackTrace(); } - - //线程2进入blocked状æ€�。 - public static void main(String[] args) { - test4(); - Thread.yield();//进入runnable状æ€� - } - - //测试blocked状æ€� - public static void test4() { - class A { - //线程1获得实例é”�以å�Žçº¿ç¨‹2无法获得实例é”�,所以进入blocked状æ€� - synchronized void run() { - while (true) { - System.out.println("run"); - } + t1.start(); + +} + +//线程2进入blocked状æ€�。 +public static void main(String[] args) { + test4(); + Thread.yield();//进入runnable状æ€� +} + +//测试blocked状æ€� +public static void test4() { + class A { + //线程1获得实例é”�以å�Žçº¿ç¨‹2无法获得实例é”�,所以进入blocked状æ€� + synchronized void run() { + while (true) { + System.out.println("run"); } } - A a = new A(); - new Thread(new Runnable() { - @Override - public void run() { - System.out.println("t1 get lock"); - a.run(); - } - }).start(); - new Thread(new Runnable() { - @Override - public void run() { - System.out.println("t2 get lock"); - a.run(); - } - }).start(); - } - - //volatileä¿�è¯�线程å�¯è§�性 - volatile static int flag = 1; - //object作为é”�对象,用于线程使用waitå’Œnotify方法 - volatile static Object o = new Object(); - //测试waitå’Œnotify - //waitå�Žè¿›å…¥waiting状æ€�,被notify进入blocked(阻塞等待é”�释放)或者runnable状æ€�(获å�–到é”�) - public void test5() { - new Thread(new Runnable() { - @Override - public void run() { - //waitå’Œnotifyå�ªèƒ½åœ¨å�Œæ­¥ä»£ç �å�—内使用 - synchronized (o) { - while (true) { - if (flag == 0) { - try { - Thread.sleep(2000); - System.out.println("thread1 wait"); - //释放é”�,线程挂起进入object的等待队列,å�Žç»­ä»£ç �è¿�行 - o.wait(); - } catch (InterruptedException e) { - e.printStackTrace(); - } + A a = new A(); + new Thread(new Runnable() { + @Override + public void run() { + System.out.println("t1 get lock"); + a.run(); + } + }).start(); + new Thread(new Runnable() { + @Override + public void run() { + System.out.println("t2 get lock"); + a.run(); + } + }).start(); + +} + +//volatileä¿�è¯�线程å�¯è§�性 +volatile static int flag = 1; +//object作为é”�对象,用于线程使用waitå’Œnotify方法 +volatile static Object o = new Object(); +//测试waitå’Œnotify +//waitå�Žè¿›å…¥waiting状æ€�,被notify进入blocked(阻塞等待é”�释放)或者runnable状æ€�(获å�–到é”�) +public void test5() { + new Thread(new Runnable() { + @Override + public void run() { + //waitå’Œnotifyå�ªèƒ½åœ¨å�Œæ­¥ä»£ç �å�—内使用 + synchronized (o) { + while (true) { + if (flag == 0) { + try { + Thread.sleep(2000); + System.out.println("thread1 wait"); + //释放é”�,线程挂起进入object的等待队列,å�Žç»­ä»£ç �è¿�行 + o.wait(); + } catch (InterruptedException e) { + e.printStackTrace(); } - System.out.println("thread1 run"); - System.out.println("notify t2"); - flag = 0; - //通知等待队列的一个线程获å�–é”� - o.notify(); } + System.out.println("thread1 run"); + System.out.println("notify t2"); + flag = 0; + //通知等待队列的一个线程获å�–é”� + o.notify(); } } - }).start(); - //解释å�Œä¸Š - new Thread(new Runnable() { - @Override - public void run() { - while (true) { - synchronized (o) { - if (flag == 1) { - try { - Thread.sleep(2000); - System.out.println("thread2 wait"); - o.wait(); - } catch (InterruptedException e) { - e.printStackTrace(); - } + } + }).start(); + //解释å�Œä¸Š + new Thread(new Runnable() { + @Override + public void run() { + while (true) { + synchronized (o) { + if (flag == 1) { + try { + Thread.sleep(2000); + System.out.println("thread2 wait"); + o.wait(); + } catch (InterruptedException e) { + e.printStackTrace(); } - System.out.println("thread2 run"); - System.out.println("notify t1"); - flag = 1; - o.notify(); } + System.out.println("thread2 run"); + System.out.println("notify t1"); + flag = 1; + o.notify(); } } - }).start(); - } - - //输出结果是 - // thread1 run - // notify t2 - // thread1 wait - // thread2 run - // notify t1 - // thread2 wait - // thread1 run - // notify t2 - //ä¸�断循环 - - } + } + }).start(); +} + +//输出结果是 +// thread1 run +// notify t2 +// thread1 wait +// thread2 run +// notify t1 +// thread2 wait +// thread1 run +// notify t2 +//ä¸�断循环 + +} +``` ## Java Thread常用方法 ### Thread#yield(): @@ -410,24 +404,21 @@ A线程调用B线程的join()方法,将会使A等待B执行,直到B线程终 ## 构造方法和守护线程 - 构造方法 - Thread类中ä¸�å�Œçš„æž„造方法接å�—如下å�‚æ•°çš„ä¸�å�Œç»„å�ˆï¼š - - 一个Runnable对象,这ç§�情况下,Thread.start方法将会调用对应Runnable对象的run方法。如果没有æ��ä¾›Runnable对象,那么就会立å�³å¾—到一个Thread.run的默认实现。 - - 一个作为线程标识å��çš„String字符串,该标识在跟踪和调试过程中会é�žå¸¸æœ‰ç”¨ï¼Œé™¤æ­¤åˆ«æ— å®ƒç”¨ã€‚ - - 线程组(ThreadGroup),用æ�¥æ”¾ç½®æ–°åˆ›å»ºçš„线程,如果æ��供的ThreadGroupä¸�å…�许被访问,那么就会抛出一个SecurityException 。 - - - - Thread对象拥有一个守护(daemon)标识属性,这个属性无法在构造方法中被赋值,但是å�¯ä»¥åœ¨çº¿ç¨‹å�¯åЍ之å‰�设置该属性(通过setDaemon方法)。 - - 当程åº�中所有的é�žå®ˆæŠ¤çº¿ç¨‹éƒ½å·²ç»�终止,调用setDaemon方法å�¯èƒ½ä¼šå¯¼è‡´è™šæ‹Ÿæœºç²—暴的终止线程并退出。 - - isDaemon方法能够返回该属性的值。守护状æ€�的作用é�žå¸¸æœ‰é™�,å�³ä½¿æ˜¯å�Žå�°çº¿ç¨‹åœ¨ç¨‹åº�退出的时候也ç»�常需è¦�å�šä¸€äº›æ¸…ç�†å·¥ä½œã€‚ - - (daemonçš„å�‘音为â€�day-monâ€�,这是系统编程传统的é�—留,系统守护进程是一个æŒ�ç»­è¿�行的进程,比如打å�°æœºé˜Ÿåˆ—管ç�†ï¼Œå®ƒæ€»æ˜¯åœ¨ç³»ç»Ÿä¸­è¿�行。) +**构造方法** + +`Thread` 类中ä¸�å�Œçš„æž„造方法接å�—如下å�‚æ•°çš„ä¸�å�Œç»„å�ˆï¼š + +- 一个 `Runnable` 对象:这ç§�情况下,`Thread.start` 方法将会调用对应 `Runnable` 对象的 `run` 方法。如果没有æ��ä¾› `Runnable` 对象,那么就会立å�³å¾—到一个 `Thread.run` 的默认实现。 +- 一个作为线程标识å��çš„ `String` 字符串:该标识在跟踪和调试过程中会é�žå¸¸æœ‰ç”¨ï¼Œé™¤æ­¤åˆ«æ— å®ƒç”¨ã€‚ +- 线程组(`ThreadGroup`):用æ�¥æ”¾ç½®æ–°åˆ›å»ºçš„线程。如果æ��供的 `ThreadGroup` ä¸�å…�许被访问,那么就会抛出一个 `SecurityException`。 + +`Thread` 对象拥有一个守护(daemon)标识属性,这个属性无法在构造方法中被赋值,但是å�¯ä»¥åœ¨çº¿ç¨‹å�¯åЍ之å‰�设置该属性(通过 `setDaemon` 方法)。 + +当程åº�中所有的é�žå®ˆæŠ¤çº¿ç¨‹éƒ½å·²ç»�终止,调用 `setDaemon` 方法å�¯èƒ½ä¼šå¯¼è‡´è™šæ‹Ÿæœºç²—暴的终止线程并退出。 + +`isDaemon` 方法能够返回该属性的值。守护状æ€�的作用é�žå¸¸æœ‰é™�,å�³ä½¿æ˜¯å�Žå�°çº¿ç¨‹åœ¨ç¨‹åº�退出的时候也ç»�常需è¦�å�šä¸€äº›æ¸…ç�†å·¥ä½œã€‚ + +(daemon çš„å�‘音为 "day-mon",这是系统编程传统的é�—留。系统守护进程是一个æŒ�ç»­è¿�行的进程,比如打å�°æœºé˜Ÿåˆ—管ç�†ï¼Œå®ƒæ€»æ˜¯åœ¨ç³»ç»Ÿä¸­è¿�行。) ## å�¯åŠ¨çº¿ç¨‹çš„æ–¹å¼�å’ŒisAlive方法 From d6a3367360e220e0ae4811b5656a022aeca24873 Mon Sep 17 00:00:00 2001 From: wangj19 Date: Sat, 26 Sep 2026 18:18:47 +0800 Subject: [PATCH 3/4] =?UTF-8?q?=E4=BF=AE=E5=A4=8D=E4=B9=B1=E7=A0=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...65\344\270\216\344\275\234\347\224\250.md" | 172 +-- ...10\346\240\270\345\277\203\357\274\211.md" | 198 +-- ...23\347\232\204\350\256\277\351\227\256.md" | 438 +++--- ...75\347\232\204\346\224\257\346\214\201.md" | 260 ++-- ...57\345\242\203\345\217\230\351\207\217.md" | 196 +-- ...04\347\220\206\346\234\272\345\210\266.md" | 90 +- ...04\346\272\220\347\256\241\347\220\206.md" | 148 +- ...54\346\225\260\346\215\256\357\274\211.md" | 330 ++--- ...72\346\234\254\347\224\250\346\263\225.md" | 244 ++-- .../Spring/Spring\345\220\210\351\233\206.md" | 20 +- ...345\256\271\345\231\250\344\270\216IOC.md" | 98 +- ...70\350\247\201\346\263\250\350\247\243.md" | 306 ++-- .../Spring/Spring\346\246\202\350\277\260.md" | 162 +-- ...\270\252Spring\345\272\224\347\224\250.md" | 34 +- ...\260\203\345\272\246\344\270\216@Async.md" | 78 +- ...45\345\277\227\347\256\241\347\220\206.md" | 244 ++-- ...70\350\247\201\346\263\250\350\247\243.md" | 72 +- ...\210\260\345\244\226\351\203\250Tomcat.md" | 62 +- ...42\203\345\267\245\345\205\267Actuator.md" | 1268 ++++++++--------- ...232\204Starter\346\234\272\345\210\266.md" | 150 +- ...15\344\270\226\344\273\212\347\224\237.md" | 194 +-- ...72\346\234\254\344\275\277\347\224\250.md" | 72 +- ...07\344\273\266\347\256\241\347\220\206.md" | 698 ++++----- ...50\347\275\262\345\267\245\345\205\267.md" | 228 +-- ...52\345\212\250\347\224\237\346\210\220.md" | 478 +++---- ...45\220\253Spring+SpringMVC+SpringBoot).md" | 482 +++---- ...345\267\245\345\205\267SpringBootAdmin.md" | 150 +- ...ootApplication\346\263\250\350\247\243.md" | 144 +- ...50\345\206\214\346\265\201\347\250\213.md" | 264 ++-- ...05\351\205\215\350\277\207\347\250\213.md" | 260 ++-- ...5\207\206\345\244\207SpringApplication.md" | 196 +-- ...345\244\207IOC\345\256\271\345\231\250.md" | 208 +-- ...20\350\241\214\347\216\257\345\242\203.md" | 216 +-- ...14\346\210\220\345\220\257\345\212\250.md" | 46 +- ...01\347\250\213\346\200\273\347\273\223.md" | 36 +- ...345\212\250IOC\345\256\271\345\231\250.md" | 190 +-- ...50\350\243\205\351\205\215\347\261\273.md" | 242 ++-- ...05\351\205\215\351\241\272\345\272\217.md" | 332 ++--- ...41\344\273\266\346\263\250\350\247\243.md" | 404 +++--- .../SpringCloud/SpringCloudConfig.md" | 392 ++--- .../SpringCloud/SpringCloudConsul.md" | 106 +- .../SpringCloud/SpringCloudEureka.md" | 418 +++--- .../SpringCloud/SpringCloudGateway.md" | 342 ++--- .../SpringCloud/SpringCloudHystrix.md" | 478 +++---- .../SpringCloud/SpringCloudLoadBalancer.md" | 96 +- .../SpringCloud/SpringCloudOpenFeign.md" | 198 +-- .../SpringCloud/SpringCloudRibbon.md" | 328 ++--- .../SpringCloud/SpringCloudSleuth.md" | 68 +- .../SpringCloud/SpringCloudZuul.md" | 200 +-- .../SpringCloud\346\246\202\350\277\260.md" | 128 +- .../SpringCloudAlibabaNacos.md" | 464 +++--- .../SpringCloudAlibabaRocketMQ.md" | 154 +- .../SpringCloudAlibabaSeata.md" | 700 ++++----- .../SpringCloudAlibabaSentinel.md" | 252 ++-- .../SpringCloudAlibabaSkywalking.md" | 204 +-- ...ngCloudAlibaba\346\246\202\350\247\210.md" | 116 +- ...15\345\212\241\345\217\221\347\216\260.md" | 130 +- ...15\345\212\241\346\263\250\345\206\214.md" | 138 +- ...20\357\274\232\346\246\202\350\247\210.md" | 148 +- ...15\347\275\256\344\270\255\345\277\203.md" | 148 +- ...20\347\240\201\345\210\206\346\236\220.md" | 190 +-- ...20\347\240\201\345\210\206\346\236\220.md" | 318 ++--- ...20\347\240\201\345\210\206\346\236\220.md" | 320 ++--- ...20\347\240\201\345\210\206\346\236\220.md" | 114 +- ...20\347\240\201\345\210\206\346\236\220.md" | 468 +++--- ...20\347\240\201\345\210\206\346\236\220.md" | 156 +- ...20\347\240\201\345\210\206\346\236\220.md" | 416 +++--- ...20\347\240\201\345\210\206\346\236\220.md" | 138 +- ...20\347\240\201\345\210\206\346\236\220.md" | 230 +-- ...20\347\240\201\345\210\206\346\236\220.md" | 254 ++-- ...05\345\214\226\345\212\237\350\203\275.md" | 108 +- ...70\347\224\250\345\212\237\350\203\275.md" | 200 +-- ...70\345\244\204\347\220\206\345\231\250.md" | 94 +- ...04\346\213\246\346\210\252\345\231\250.md" | 22 +- ...76\350\247\243\346\236\220\345\231\250.md" | 86 +- ...\277\207\346\273\244\345\231\250Filter.md" | 80 +- ...53\351\200\237\345\205\245\351\227\250.md" | 392 ++--- ...07\344\273\266\344\270\212\344\274\240.md" | 50 +- ...70\350\247\201\346\263\250\350\247\243.md" | 102 +- ...13\345\214\226\346\265\201\347\250\213.md" | 192 +-- ...13\345\214\226\346\265\201\347\250\213.md" | 300 ++-- ...23\346\236\204\346\200\273\347\273\223.md" | 48 +- ...6@EnableWebMvc\346\263\250\350\247\243.md" | 260 ++-- ...\231\250\345\220\257\345\212\250Tomcat.md" | 114 +- ...271\213\350\216\267\345\217\226Handler.md" | 286 ++-- ...241\214Handler\346\226\271\346\263\225.md" | 246 ++-- ...20\357\274\210\344\270\213\357\274\211.md" | 258 ++-- ...7\274\232cglib\344\273\243\347\220\206.md" | 198 +-- ...357\274\232aop\346\200\273\347\273\223.md" | 16 +- ...50\346\200\201\344\273\243\347\220\206.md" | 320 ++--- ...13\345\212\241\347\273\204\344\273\266.md" | 324 ++--- ...\347\232\204\345\244\204\347\220\20601.md" | 224 +-- ...47\350\241\214\346\265\201\347\250\213.md" | 308 ++-- ...\347\232\204\345\244\204\347\220\20603.md" | 202 +-- ...\347\232\204\345\244\204\347\220\20604.md" | 160 +-- ...\347\232\204\345\244\204\347\220\20602.md" | 242 ++-- ...13\344\273\266\345\244\204\347\220\206.md" | 78 +- ...53\346\217\217\346\265\201\347\250\213.md" | 326 ++--- ...an\347\232\204\345\210\233\345\273\272.md" | 420 +++--- ...xt\347\232\204\345\210\233\345\273\272.md" | 48 +- ...47\350\241\214BeanFactoryPostProcessor.md" | 300 ++-- ...04\345\210\235\345\247\213\345\214\226.md" | 130 +- ...6\263\250\345\206\214BeanPostProcessor.md" | 66 +- ...01\347\250\213\346\200\273\347\273\223.md" | 14 +- ...20\347\232\204\345\244\204\347\220\206.md" | 74 +- ...06\345\244\207\345\267\245\344\275\234.md" | 102 +- ...\273\266\344\271\213ApplicationContext.md" | 338 ++--- ...204\344\273\266\344\271\213BeanFactory.md" | 32 +- ...66\344\271\213BeanFactoryPostProcessor.md" | 106 +- ...4\273\266\344\271\213BeanPostProcessor.md" | 144 +- ...@ComponentScan\346\263\250\350\247\243.md" | 350 ++--- ...220\206@Import\346\263\250\350\247\243.md" | 406 +++--- ...7\220\206@Bean\346\263\250\350\247\243.md" | 394 ++--- ...06@Conditional\346\263\250\350\247\243.md" | 150 +- ...47\350\241\214\351\241\272\345\272\217.md" | 244 ++-- ...13\344\273\266\346\234\272\345\210\266.md" | 426 +++--- ...06\350\256\272\345\237\272\347\237\263.md" | 866 +++++------ ...20\347\240\201\345\210\206\346\236\220.md" | 536 +++---- ...0\346\263\250\350\247\243EventListener.md" | 316 ++-- ...43\347\232\204\345\244\204\347\220\206.md" | 306 ++-- ...36\350\267\265\346\200\273\347\273\223.md" | 9 +- ...40\344\275\225\350\200\214\347\224\237.md" | 69 +- ...66\346\236\204\344\273\213\347\273\215.md" | 147 +- 123 files changed, 14178 insertions(+), 14273 deletions(-) diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringAOP\347\232\204\346\246\202\345\277\265\344\270\216\344\275\234\347\224\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringAOP\347\232\204\346\246\202\345\277\265\344\270\216\344\275\234\347\224\250.md" index 26e828a..38cae19 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringAOP\347\232\204\346\246\202\345\277\265\344\270\216\344\275\234\347\224\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringAOP\347\232\204\346\246\202\345\277\265\344\270\216\344\275\234\347\224\250.md" @@ -1,53 +1,53 @@ -# Spring ¿ò¼ÜµÄ AOP +# Spring 框架的 AOP -## Spring ¿ò¼ÜµÄ AOP +## Spring 框架的 AOP -Spring ¿ò¼ÜµÄÒ»¸ö¹Ø¼ü×é¼þÊÇ**ÃæÏòÇÐÃæµÄ±à³Ì**(AOP)¿ò¼Ü¡£ÃæÏòÇÐÃæµÄ±à³ÌÐèÒª°Ñ³ÌÐòÂß¼­·Ö½â³É²»Í¬µÄ²¿·Ö³ÆÎªËùνµÄ¹Ø×¢µã¡£¿çÒ»¸öÓ¦ÓóÌÐòµÄ¶à¸öµãµÄ¹¦Äܱ»³ÆÎª**ºáÇйØ×¢µã**£¬ÕâЩºáÇйØ×¢µãÔÚ¸ÅÄîÉ϶ÀÁ¢ÓÚÓ¦ÓóÌÐòµÄÒµÎñÂß¼­¡£ÔÚÈí¼þ¿ª·¢¹ý³ÌÖÐÓи÷ÖÖ¸÷ÑùµÄºÜºÃµÄÇÐÃæµÄÀý×Ó£¬ÈçÈÕÖ¾¼Ç¼¡¢É󼯡¢ÉùÃ÷ʽÊÂÎñ¡¢°²È«ÐԺͻº´æµÈ¡£ +Spring 框架的一个关键组件是**é�¢å�‘切é�¢çš„编程**(AOP)框架。é�¢å�‘切é�¢çš„编程需è¦�把程åº�逻辑分解æˆ�ä¸�å�Œçš„部分称为所谓的关注点。跨一个应用程åº�的多个点的功能被称为**横切关注点**,这些横切关注点在概念上独立于应用程åº�的业务逻辑。在软件开å�‘过程中有å�„ç§�å�„样的很好的切é�¢çš„例å­�,如日志记录ã€�审计ã€�声明å¼�事务ã€�安全性和缓存等。 -ÔÚ OOP ÖУ¬¹Ø¼üµ¥ÔªÄ£¿é¶ÈÊÇÀ࣬¶øÔÚ AOP Öе¥ÔªÄ£¿é¶ÈÊÇÇÐÃæ¡£ÒÀÀµ×¢Èë°ïÖúÄã¶ÔÓ¦ÓóÌÐò¶ÔÏóÏ໥½âñîºÏ£¬AOP ¿ÉÒÔ°ïÖúÄã´ÓËüÃÇËùÓ°ÏìµÄ¶ÔÏóÖжԺáÇйØ×¢µã½âñî¡£AOP ÏñÊDZà³ÌÓïÑԵĴ¥·¢ÎÈç Perl£¬.NET£¬Java »òÕ߯äËûÓïÑÔ¡£ +在 OOP 中,关键å�•元模å�—度是类,而在 AOP 中å�•元模å�—度是切é�¢ã€‚ä¾�赖注入帮助你对应用程åº�对象相互解耦å�ˆï¼ŒAOP å�¯ä»¥å¸®åŠ©ä½ ä»Žå®ƒä»¬æ‰€å½±å“�的对象中对横切关注点解耦。AOP åƒ�是编程语言的触å�‘物,如 Perl,.NET,Java 或者其他语言。 -Spring AOP Ä£¿éÌṩÀ¹½ØÆ÷À´À¹½ØÒ»¸öÓ¦ÓóÌÐò£¬ÀýÈ磬µ±Ö´ÐÐÒ»¸ö·½·¨Ê±£¬Äã¿ÉÒÔÔÚ·½·¨Ö´ÐÐ֮ǰ»òÖ®ºóÌí¼Ó¶îÍâµÄ¹¦ÄÜ¡£ +Spring AOP 模å�—æ��供拦截器æ�¥æ‹¦æˆªä¸€ä¸ªåº”用程åº�,例如,当执行一个方法时,你å�¯ä»¥åœ¨æ–¹æ³•执行之å‰�或之å�Žæ·»åŠ é¢�外的功能。 -## AOP ÊõÓï +## AOP 术语 -ÔÚÎÒÃÇ¿ªÊ¼Ê¹Óà AOP ¹¤×÷֮ǰ£¬ÈÃÎÒÃÇÊìϤһÏ AOP ¸ÅÄîºÍÊõÓï¡£ÕâЩÊõÓï²¢²»Ìض¨ÓÚ Spring£¬¶øÊÇÓë AOP Óйصġ£ +在我们开始使用 AOP 工作之å‰�,让我们熟悉一下 AOP 概念和术语。这些术语并ä¸�特定于 Spring,而是与 AOP 有关的。 -| Ïî | ÃèÊö | +| 项 | æ��è¿° | | --- | --- | -| Aspect | Ò»¸öÄ£¿é¾ßÓÐÒ»×éÌṩºáÇÐÐèÇóµÄ APIs¡£ÀýÈ磬һ¸öÈÕ־ģ¿éΪÁ˼ǼÈÕÖ¾½«±» AOP ·½Ãæµ÷Óá£Ó¦ÓóÌÐò¿ÉÒÔÓµÓÐÈÎÒâÊýÁ¿µÄ·½Ã棬ÕâÈ¡¾öÓÚÐèÇó¡£ | -| Join point | ÔÚÄãµÄÓ¦ÓóÌÐòÖÐËü´ú±íÒ»¸öµã£¬Äã¿ÉÒÔÔÚ²å¼þ AOP ·½Ãæ¡£ÄãÒ²ÄÜ˵£¬ËüÊÇÔÚʵ¼ÊµÄÓ¦ÓóÌÐòÖУ¬ÆäÖÐÒ»¸ö²Ù×÷½«Ê¹Óà Spring AOP ¿ò¼Ü¡£ | -| Advice | ÕâÊÇʵ¼ÊÐж¯Ö®Ç°»òÖ®ºóÖ´Ðеķ½·¨¡£ÕâÊÇÔÚ³ÌÐòÖ´ÐÐÆÚ¼äͨ¹ý Spring AOP ¿ò¼Üʵ¼Ê±»µ÷ÓõĴúÂë¡£ | -| Pointcut | ÕâÊÇÒ»×éÒ»¸ö»ò¶à¸öÁ¬½Óµã£¬Í¨ÖªÓ¦¸Ã±»Ö´ÐС£Äã¿ÉÒÔʹÓñí´ïʽ»òģʽָ¶¨ÇÐÈëµãÕýÈçÎÒÃǽ«ÔÚ AOP µÄÀý×ÓÖп´µ½µÄ¡£ | -| Introduction | ÒýÓÃÔÊÐíÄãÌí¼Óз½·¨»òÊôÐÔµ½ÏÖÓеÄÀàÖС£ | -| Target object | ±»Ò»¸ö»òÕß¶à¸ö·½ÃæËù֪ͨµÄ¶ÔÏó£¬Õâ¸ö¶ÔÏóÓÀÔ¶ÊÇÒ»¸ö±»´úÀí¶ÔÏó¡£Ò²³ÆÎª±»Í¨Öª¶ÔÏó¡£ | -| Weaving | Weaving °Ñ·½ÃæÁ¬½Óµ½ÆäËüµÄÓ¦ÓóÌÐòÀàÐÍ»òÕß¶ÔÏóÉÏ£¬²¢´´½¨Ò»¸ö±»Í¨ÖªµÄ¶ÔÏó¡£ÕâЩ¿ÉÒÔÔÚ±àÒëʱ£¬Àà¼ÓÔØÊ±ºÍÔËÐÐʱÍê³É¡£ | +| Aspect | 一个模å�—具有一组æ��供横切需求的 APIs。例如,一个日志模å�—为了记录日志将被 AOP æ–¹é�¢è°ƒç”¨ã€‚应用程åº�å�¯ä»¥æ‹¥æœ‰ä»»æ„�æ•°é‡�的方é�¢ï¼Œè¿™å�–决于需求。 | +| Join point | 在你的应用程åº�中它代表一个点,你å�¯ä»¥åœ¨æ�’ä»¶ AOP æ–¹é�¢ã€‚你也能说,它是在实际的应用程åº�中,其中一个æ“�作将使用 Spring AOP 框架。 | +| Advice | 这是实际行动之å‰�或之å�Žæ‰§è¡Œçš„æ–¹æ³•。这是在程åº�执行期间通过 Spring AOP 框架实际被调用的代ç �。 | +| Pointcut | 这是一组一个或多个连接点,通知应该被执行。你å�¯ä»¥ä½¿ç”¨è¡¨è¾¾å¼�或模å¼�指定切入点正如我们将在 AOP 的例å­�中看到的。 | +| Introduction | 引用å…�许你添加新方法或属性到现有的类中。 | +| Target object | 被一个或者多个方é�¢æ‰€é€šçŸ¥çš„对象,这个对象永远是一个被代ç�†å¯¹è±¡ã€‚也称为被通知对象。 | +| Weaving | Weaving 把方é�¢è¿žæŽ¥åˆ°å…¶å®ƒçš„应用程åº�类型或者对象上,并创建一个被通知的对象。这些å�¯ä»¥åœ¨ç¼–译时,类加载时和è¿�行时完æˆ�。 | -## ֪ͨµÄÀàÐÍ +## 通知的类型 -Spring ·½Ãæ¿ÉÒÔʹÓÃÏÂÃæÌáµ½µÄÎåÖÖ֪ͨ¹¤×÷£º +Spring æ–¹é�¢å�¯ä»¥ä½¿ç”¨ä¸‹é�¢æ��到的五ç§�通知工作: -| ֪ͨ | ÃèÊö | +| 通知 | æ��è¿° | | --- | --- | -| ǰÖÃ֪ͨ | ÔÚÒ»¸ö·½·¨Ö´ÐÐ֮ǰ£¬Ö´ÐÐ֪ͨ¡£ | -| ºóÖÃ֪ͨ | ÔÚÒ»¸ö·½·¨Ö´ÐÐÖ®ºó£¬²»¿¼ÂÇÆä½á¹û£¬Ö´ÐÐ֪ͨ¡£ | -| ·µ»Øºó֪ͨ | ÔÚÒ»¸ö·½·¨Ö´ÐÐÖ®ºó£¬Ö»ÓÐÔÚ·½·¨³É¹¦Íê³Éʱ£¬²ÅÄÜÖ´ÐÐ֪ͨ¡£ | -| Å׳öÒì³£ºó֪ͨ | ÔÚÒ»¸ö·½·¨Ö´ÐÐÖ®ºó£¬Ö»ÓÐÔÚ·½·¨Í˳öÅ׳öÒ쳣ʱ£¬²ÅÄÜÖ´ÐÐ֪ͨ¡£ | -| »·ÈÆÍ¨Öª | ÔÚ½¨Òé·½·¨µ÷ÓÃ֮ǰºÍÖ®ºó£¬Ö´ÐÐ֪ͨ¡£ | +| å‰�置通知 | 在一个方法执行之å‰�,执行通知。 | +| å�Žç½®é€šçŸ¥ | 在一个方法执行之å�Žï¼Œä¸�考虑其结果,执行通知。 | +| 返回å�Žé€šçŸ¥ | 在一个方法执行之å�Žï¼Œå�ªæœ‰åœ¨æ–¹æ³•æˆ�功完æˆ�时,æ‰�能执行通知。 | +| 抛出异常å�Žé€šçŸ¥ | 在一个方法执行之å�Žï¼Œå�ªæœ‰åœ¨æ–¹æ³•退出抛出异常时,æ‰�能执行通知。 | +| 环绕通知 | 在建议方法调用之å‰�和之å�Žï¼Œæ‰§è¡Œé€šçŸ¥ã€‚ | -## ʵÏÖ×Ô¶¨Òå·½Ãæ +## 实现自定义方é�¢ -Spring Ö§³Ö **@AspectJ annotation style** µÄ·½·¨ºÍ**»ùÓÚģʽ**µÄ·½·¨À´ÊµÏÖ×Ô¶¨Òå·½Ãæ¡£ÕâÁ½ÖÖ·½·¨ÒѾ­ÔÚÏÂÃæÁ½¸ö×Ó½Ú½øÐÐÁËÏêϸ½âÊÍ¡£ +Spring 支æŒ� **@AspectJ annotation style** 的方法和**基于模å¼�**的方法æ�¥å®žçŽ°è‡ªå®šä¹‰æ–¹é�¢ã€‚这两ç§�方法已ç»�在下é�¢ä¸¤ä¸ªå­�节进行了详细解释。 -| ·½·¨ | ÃèÊö | +| 方法 | æ��è¿° | | --- | --- | -| [XML Schema based](https://www.w3cschool.cn/wkspring/omps1mm6.html) | ·½ÃæÊÇʹÓ󣹿ÀàÒÔ¼°»ùÓÚÅäÖÃµÄ XML À´ÊµÏֵġ£ | -| [@AspectJ based](https://www.w3cschool.cn/wkspring/k4q21mm8.html) | @AspectJ ÒýÓÃÒ»ÖÖÉùÃ÷·½ÃæµÄ·ç¸ñ×÷Ϊ´øÓÐ Java 5 ×¢Ê͵ij£¹æ Java Àà×¢ÊÍ¡£ | +| [XML Schema based](https://www.w3cschool.cn/wkspring/omps1mm6.html) | æ–¹é�¢æ˜¯ä½¿ç”¨å¸¸è§„类以å�ŠåŸºäºŽé…�置的 XML æ�¥å®žçŽ°çš„ã€‚ | +| [@AspectJ based](https://www.w3cschool.cn/wkspring/k4q21mm8.html) | @AspectJ 引用一ç§�声明方é�¢çš„风格作为带有 Java 5 注释的常规 Java 类注释。 | -## Spring ÖлùÓÚ AOP µÄ XML¼Ü¹¹ +## Spring 中基于 AOP çš„ XMLæž¶æž„ -ΪÁËÔÚ±¾½ÚµÄÃèÊöÖÐʹÓà aop ÃüÃû¿Õ¼ä±êÇ©£¬ÄãÐèÒªµ¼Èë spring-aop ¼Ü¹¹£¬ÈçÏÂËùÊö£º +为了在本节的æ��述中使用 aop 命å��空间标签,你需è¦�导入 spring-aop 架构,如下所述: ``` @@ -65,7 +65,7 @@ Spring Ö§ ``` -Ä㻹ÐèÒªÔÚÄãµÄÓ¦ÓóÌÐòµÄ CLASSPATH ÖÐʹÓÃÒÔÏ AspectJ ¿âÎļþ¡£ÕâЩ¿âÎļþÔÚÒ»¸ö AspectJ ×°ÖÃµÄ ¡®lib¡¯ Ŀ¼ÖÐÊÇ¿ÉÓõ쬷ñÔòÄã¿ÉÒÔÔÚ Internet ÖÐÏÂÔØËüÃÇ¡£(×¢£ºaspectjweaver.jar ÒѰüº¬ÆäËû°ü) +你还需è¦�在你的应用程åº�çš„ CLASSPATH 中使用以下 AspectJ 库文件。这些库文件在一个 AspectJ 装置的 ‘lib’ 目录中是å�¯ç”¨çš„,å�¦åˆ™ä½ å�¯ä»¥åœ¨ Internet 中下载它们。(注:aspectjweaver.jar 已包å�«å…¶ä»–包) * aspectjrt.jar @@ -75,9 +75,9 @@ Spring Ö§ * aopalliance.jar -## ¡¡ÉùÃ÷Ò»¸ö aspect +##  声明一个 aspect -Ò»¸ö **aspect** ÊÇʹÓÃ ÔªËØÉùÃ÷µÄ£¬Ö§³ÖµÄ bean ÊÇʹÓà **ref** ÊôÐÔÒýÓõģ¬ÈçÏÂËùʾ£º +一个 **aspect** 是使用 元素声明的,支æŒ�çš„ bean 是使用 **ref** 属性引用的,如下所示: ``` @@ -90,11 +90,11 @@ Spring Ö§ ``` -ÕâÀ¡°aBean¡± ½«±»ÅäÖúÍÒÀÀµ×¢È룬¾ÍÏñÇ°ÃæµÄÕ½ÚÖÐÄã¿´µ½µÄÆäËûµÄ Spring bean Ò»Ñù¡£ +这里,“aBeanâ€� 将被é…�置和ä¾�赖注入,就åƒ�å‰�é�¢çš„章节中你看到的其他的 Spring bean 一样。 -## ÉùÃ÷Ò»¸öÇÐÈëµã +## 声明一个切入点 -Ò»¸ö**ÇÐÈëµã**ÓÐÖúÓÚÈ·¶¨Ê¹Óò»Í¬½¨ÒéÖ´ÐеĸÐÐËȤµÄÁ¬½Óµã£¨¼´·½·¨£©¡£ÔÚ´¦Àí»ùÓÚÅäÖÃµÄ XML ¼Ü¹¹Ê±£¬ÇÐÈëµã½«»á°´ÕÕÈçÏÂËùʾ¶¨Ò壺 +一个**切入点**有助于确定使用ä¸�å�Œå»ºè®®æ‰§è¡Œçš„æ„Ÿå…´è¶£çš„连接点(å�³æ–¹æ³•)。在处ç�†åŸºäºŽé…�置的 XML 架构时,切入点将会按照如下所示定义: ``` @@ -108,7 +108,7 @@ Spring Ö§ ``` -ÏÂÃæµÄʾÀý¶¨ÒåÁËÒ»¸öÃûΪ ¡°businessService¡± µÄÇÐÈëµã£¬¸ÃÇÐÈëµã½«Óë com.tutorialspoint °üÏ嵀 Student ÀàÖÐµÄ getName() ·½·¨ÏàÆ¥Å䣺 +下é�¢çš„示例定义了一个å��为 “businessServiceâ€� 的切入点,该切入点将与 com.tutorialspoint 包下的 Student 类中的 getName() 方法相匹é…�: ``` @@ -122,9 +122,9 @@ Spring Ö§ ``` -## ÉùÃ÷½¨Òé +## 声明建议 -Äã¿ÉÒÔÔÚÖÐʹÓÃÔªËØÉùÃ÷ÈÎÒâÎåÖÖÀàÐ͵Ä֪ͨ£¬ÈçÏ£º +ä½ å�¯ä»¥åœ¨ä¸­ä½¿ç”¨å…ƒç´ å£°æ˜Žä»»æ„�五ç§�类型的通知,如下: ``` @@ -150,22 +150,22 @@ Spring Ö§ ``` -Äã¿ÉÒÔ¶Ô²»Í¬µÄ½¨ÒéʹÓÃÏàͬµÄ **doRequiredTask** »òÕß²»Í¬µÄ·½·¨¡£ÕâЩ·½·¨½«»á×÷Ϊ aspect Ä£¿éµÄÒ»²¿·ÖÀ´¶¨Òå¡£ +ä½ å�¯ä»¥å¯¹ä¸�å�Œçš„建议使用相å�Œçš„ **doRequiredTask** 或者ä¸�å�Œçš„æ–¹æ³•。这些方法将会作为 aspect 模å�—的一部分æ�¥å®šä¹‰ã€‚ -## »ùÓÚ AOP µÄ XML ¼Ü¹¹µÄʾÀý +## 基于 AOP çš„ XML 架构的示例 -ΪÁËÀí½âÉÏÃæÌáµ½µÄ»ùÓÚ AOP µÄ XML ¼Ü¹¹µÄ¸ÅÄÈÃÎÒÃDZàдһ¸öʾÀý£¬¿ÉÒÔʵÏÖ¼¸¸ö½¨Ò顣ΪÁËÔÚÎÒÃǵÄʾÀýÖÐʹÓü¸¸ö½¨Ò飬ÈÃÎÒÃÇʹ Eclipse IDE ´¦ÓÚ¹¤×÷״̬£¬È»ºó°´ÕÕÈçϲ½Öè´´½¨Ò»¸ö Spring Ó¦ÓóÌÐò£º +为了ç�†è§£ä¸Šé�¢æ��到的基于 AOP çš„ XML 架构的概念,让我们编写一个示例,å�¯ä»¥å®žçŽ°å‡ ä¸ªå»ºè®®ã€‚ä¸ºäº†åœ¨æˆ‘ä»¬çš„ç¤ºä¾‹ä¸­ä½¿ç”¨å‡ ä¸ªå»ºè®®ï¼Œè®©æˆ‘ä»¬ä½¿ Eclipse IDE 处于工作状æ€�,然å�ŽæŒ‰ç…§å¦‚下步骤创建一个 Spring 应用程åº�: -| ²½Öè | ÃèÊö | +| 步骤 | æ��è¿° | | --- | --- | -| 1 | ´´½¨Ò»¸öÃûΪ _SpringExample_ µÄÏîÄ¿£¬²¢ÇÒÔÚËù´´½¨ÏîÄ¿µÄ **src** Îļþ¼ÐÏ´´½¨Ò»¸öÃûΪ _com.tutorialspoint_ µÄ°ü¡£ | -| 2 | ʹÓà _Add External JARs_ Ñ¡ÏîÌí¼ÓËùÐèµÄ Spring ¿âÎļþ£¬¾ÍÈçÔÚ _Spring Hello World Example_ Õ½ÚÖнâÊ͵ÄÄÇÑù¡£ | -| 3 | ÔÚÏîÄ¿ÖÐÌí¼Ó Spring AOP Ö¸¶¨µÄ¿âÎļþ **aspectjrt.jar£¬ aspectjweaver.jar** ºÍ **aspectj.jar**¡£ | -| 4 | ÔÚ _com.tutorialspoint_ °üÏ´´½¨ Java Àà **Logging**£¬ _Student_ ºÍ _MainApp_¡£ | -| 5 | ÔÚ **src** Îļþ¼ÐÏ´´½¨ Beans ÅäÖÃÎļþ _Beans.xml_¡£ | -| 6 | ×îºóÒ»²½ÊÇ´´½¨ËùÓÐ Java ÎļþºÍ Bean ÅäÖÃÎļþµÄÄÚÈÝ£¬²¢ÇÒ°´ÈçϽâÊ͵ÄÄÇÑùÔËÐÐÓ¦ÓóÌÐò¡£ | +| 1 | 创建一个å��为 _SpringExample_ 的项目,并且在所创建项目的 **src** 文件夹下创建一个å��为 _com.tutorialspoint_ 的包。 | +| 2 | 使用 _Add External JARs_ 选项添加所需的 Spring 库文件,就如在 _Spring Hello World Example_ 章节中解释的那样。 | +| 3 | 在项目中添加 Spring AOP 指定的库文件 **aspectjrt.jar, aspectjweaver.jar** å’Œ **aspectj.jar**。 | +| 4 | 在 _com.tutorialspoint_ 包下创建 Java ç±» **Logging**, _Student_ å’Œ _MainApp_。 | +| 5 | 在 **src** 文件夹下创建 Beans é…�置文件 _Beans.xml_。 | +| 6 | 最å�Žä¸€æ­¥æ˜¯åˆ›å»ºæ‰€æœ‰ Java 文件和 Bean é…�置文件的内容,并且按如下解释的那样è¿�行应用程åº�。 | -ÕâÀïÊÇ **Logging.java** ÎļþµÄÄÚÈÝ¡£Õâʵ¼ÊÉÏÊÇ aspect Ä£¿éµÄÒ»¸öʾÀý£¬Ëü¶¨ÒåÁËÔÚ¸÷¸öµãµ÷Óõķ½·¨¡£ +这里是 **Logging.java** 文件的内容。这实际上是 aspect 模å�—的一个示例,它定义了在å�„个点调用的方法。 ``` package com.tutorialspoint; @@ -201,7 +201,7 @@ public class Logging { } ``` -ÏÂÃæÊÇ **Student.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **Student.java** 文件的内容: ``` package com.tutorialspoint; @@ -229,7 +229,7 @@ public class Student { } ``` -ÏÂÃæÊÇ **MainApp.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **MainApp.java** 文件的内容: ``` package com.tutorialspoint; @@ -247,7 +247,7 @@ public class MainApp { } ``` -ÏÂÃæÊÇÅäÖÃÎļþ **Beans.xml**£º +下é�¢æ˜¯é…�置文件 **Beans.xml**: ``` @@ -282,7 +282,7 @@ public class MainApp { ``` -Ò»µ©ÄãÒѾ­Íê³ÉµÄ´´½¨ÁËÔ´ÎļþºÍ bean ÅäÖÃÎļþ£¬ÈÃÎÒÃÇÔËÐÐÒ»ÏÂÓ¦ÓóÌÐò¡£Èç¹ûÄãµÄÓ¦ÓóÌÐòÒ»Çж¼Õý³£µÄ»°£¬Õ⽫»áÊä³öÒÔÏÂÏûÏ¢£º +一旦你已ç»�完æˆ�的创建了æº�文件和 bean é…�置文件,让我们è¿�行一下应用程åº�。如果你的应用程åº�一切都正常的è¯�,这将会输出以下消æ�¯ï¼š ``` Going to setup student profile. @@ -301,7 +301,7 @@ There has been an exception: java.lang.IllegalArgumentException other exception content ``` -ÈÃÎÒÃÇÀ´½âÊÍÒ»ÏÂÉÏÃæ¶¨ÒåµÄÔÚ com.tutorialspoint ÖÐ Ñ¡ÔñËùÓз½·¨µÄ ¡£ÈÃÎÒÃǼÙÉèһϣ¬ÄãÏëÒªÔÚÒ»¸öÌØÊâµÄ·½·¨Ö®Ç°»òÕßÖ®ºóÖ´ÐÐÄãµÄ½¨Ò飬Äã¿ÉÒÔͨ¹ýÌæ»»Ê¹ÓÃÕæÊµÀàºÍ·½·¨Ãû³ÆµÄÇÐÈëµã¶¨ÒåÖеÄÐǺţ¨*£©À´¶¨ÒåÄãµÄÇÐÈëµãÀ´Ëõ¶ÌÄãµÄÖ´ÐС£ +让我们æ�¥è§£é‡Šä¸€ä¸‹ä¸Šé�¢å®šä¹‰çš„在 com.tutorialspoint 中 选择所有方法的 。让我们å�‡è®¾ä¸€ä¸‹ï¼Œä½ æƒ³è¦�在一个特殊的方法之å‰�或者之å�Žæ‰§è¡Œä½ çš„建议,你å�¯ä»¥é€šè¿‡æ›¿æ�¢ä½¿ç”¨çœŸå®žç±»å’Œæ–¹æ³•å��称的切入点定义中的星å�·ï¼ˆ*)æ�¥å®šä¹‰ä½ çš„切入点æ�¥ç¼©çŸ­ä½ çš„æ‰§è¡Œã€‚ ``` @@ -334,7 +334,7 @@ other exception content ``` -Èç¹ûÄãÏëÒªÖ´ÐÐͨ¹ýÕâЩ¸ü¸ÄÖ®ºóµÄʾÀýÓ¦ÓóÌÐò£¬Õ⽫»áÊä³öÒÔÏÂÏûÏ¢£º +如果你想è¦�执行通过这些更改之å�Žçš„示例应用程åº�,这将会输出以下消æ�¯ï¼š ``` Going to setup student profile. @@ -348,15 +348,15 @@ other exception content -## Spring ÖлùÓÚ AOP µÄ @AspectJ +## Spring 中基于 AOP çš„ @AspectJ -@AspectJ ×÷Ϊͨ¹ý Java 5 ×¢ÊÍ×¢ÊÍµÄÆÕͨµÄ Java À࣬ËüÖ¸µÄÊÇÉùÃ÷ aspects µÄÒ»ÖÖ·ç¸ñ¡£Í¨¹ýÔÚÄãµÄ»ùÓڼܹ¹µÄ XML ÅäÖÃÎļþÖаüº¬ÒÔÏÂÔªËØ£¬@AspectJ Ö§³ÖÊÇ¿ÉÓõġ£ +@AspectJ 作为通过 Java 5 注释注释的普通的 Java 类,它指的是声明 aspects 的一ç§�风格。通过在你的基于架构的 XML é…�置文件中包å�«ä»¥ä¸‹å…ƒç´ ï¼Œ@AspectJ 支æŒ�是å�¯ç”¨çš„。 ``` ``` -Ä㻹ÐèÒªÔÚÄãµÄÓ¦ÓóÌÐòµÄ CLASSPATH ÖÐʹÓÃÒÔÏ AspectJ ¿âÎļþ¡£ÕâЩ¿âÎļþÔÚÒ»¸ö AspectJ ×°ÖÃµÄ ¡®lib¡¯ Ŀ¼ÖÐÊÇ¿ÉÓõģ¬Èç¹ûûÓУ¬Äã¿ÉÒÔÔÚ Internet ÖÐÏÂÔØËüÃÇ¡£ +你还需è¦�在你的应用程åº�çš„ CLASSPATH 中使用以下 AspectJ 库文件。这些库文件在一个 AspectJ 装置的 ‘lib’ 目录中是å�¯ç”¨çš„,如果没有,你å�¯ä»¥åœ¨ Internet 中下载它们。 * aspectjrt.jar @@ -366,9 +366,9 @@ other exception content * aopalliance.jar -## ¡¡ÉùÃ÷Ò»¸ö aspect +##  声明一个 aspect -Aspects ÀàºÍÆäËûÈκÎÕý³£µÄ bean Ò»Ñù£¬³ýÁËËüÃǽ«»áÓà @AspectJ ×¢ÊÍÖ®Í⣬ËüºÍÆäËûÀàÒ»Ñù¿ÉÄÜÓз½·¨ºÍ×ֶΣ¬ÈçÏÂËùʾ£º +Aspects 类和其他任何正常的 bean 一样,除了它们将会用 @AspectJ 注释之外,它和其他类一样å�¯èƒ½æœ‰æ–¹æ³•和字段,如下所示: ``` package org.xyz; @@ -378,7 +378,7 @@ public class AspectModule { } ``` -ËüÃǽ«ÔÚ XML Öа´ÕÕÈçϽøÐÐÅäÖã¬¾ÍºÍÆäËûÈκΠbean Ò»Ñù£º +它们将在 XML 中按照如下进行é…�置,就和其他任何 bean 一样: ``` @@ -387,15 +387,15 @@ public class AspectModule { ``` -## ÉùÃ÷Ò»¸öÇÐÈëµã +## 声明一个切入点 -Ò»¸ö**ÇÐÈëµã**ÓÐÖúÓÚÈ·¶¨Ê¹Óò»Í¬½¨ÒéÖ´ÐеĸÐÐËȤµÄÁ¬½Óµã£¨¼´·½·¨£©¡£ÔÚ´¦Àí»ùÓÚÅäÖÃµÄ XML ¼Ü¹¹Ê±£¬ÇÐÈëµãµÄÉùÃ÷ÓÐÁ½¸ö²¿·Ö£º +一个**切入点**有助于确定使用ä¸�å�Œå»ºè®®æ‰§è¡Œçš„æ„Ÿå…´è¶£çš„连接点(å�³æ–¹æ³•)。在处ç�†åŸºäºŽé…�置的 XML 架构时,切入点的声明有两个部分: -* Ò»¸öÇÐÈëµã±í´ïʽ¾ö¶¨ÁËÎÒÃǸÐÐËȤµÄÄĸö·½·¨»áÕæÕý±»Ö´ÐС£ +* 一个切入点表达å¼�决定了我们感兴趣的哪个方法会真正被执行。 -* Ò»¸öÇÐÈëµã±êÇ©°üº¬Ò»¸öÃû³ÆºÍÈÎÒâÊýÁ¿µÄ²ÎÊý¡£·½·¨µÄÕæÕýÄÚÈÝÊDz»Ïà¸ÉµÄ£¬²¢ÇÒʵ¼ÊÉÏËüÓ¦¸ÃÊǿյġ£ +* 一个切入点标签包å�«ä¸€ä¸ªå��称和任æ„�æ•°é‡�çš„å�‚数。方法的真正内容是ä¸�相干的,并且实际上它应该是空的。 -ÏÂÃæµÄʾÀýÖж¨ÒåÁËÒ»¸öÃûΪ ¡®businessService¡¯ µÄÇÐÈëµã£¬¸ÃÇÐÈëµã½«Óë com.xyz.myapp.service °üϵÄÀàÖпÉÓõÄÿһ¸ö·½·¨ÏàÆ¥Å䣺 +下é�¢çš„示例中定义了一个å��为 ‘businessService’ 的切入点,该切入点将与 com.xyz.myapp.service 包下的类中å�¯ç”¨çš„æ¯�一个方法相匹é…�: ``` import org.aspectj.lang.annotation.Pointcut; @@ -403,7 +403,7 @@ import org.aspectj.lang.annotation.Pointcut; private void businessService() {} // signature ``` -ÏÂÃæµÄʾÀýÖж¨ÒåÁËÒ»¸öÃûΪ ¡®getname¡¯ µÄÇÐÈëµã£¬¸ÃÇÐÈëµã½«Óë com.tutorialspoint °üÏ嵀 Student ÀàÖÐµÄ getName() ·½·¨ÏàÆ¥Å䣺 +下é�¢çš„示例中定义了一个å��为 ‘getname’ 的切入点,该切入点将与 com.tutorialspoint 包下的 Student 类中的 getName() 方法相匹é…�: ``` import org.aspectj.lang.annotation.Pointcut; @@ -411,9 +411,9 @@ import org.aspectj.lang.annotation.Pointcut; private void getname() {} ``` -## ÉùÃ÷½¨Òé +## 声明建议 -Äã¿ÉÒÔʹÓà @{ADVICE-NAME} ×¢ÊÍÉùÃ÷Îå¸ö½¨ÒéÖеÄÈÎÒâÒ»¸ö£¬ÈçÏÂËùʾ¡£Õâ¼ÙÉèÄãÒѾ­¶¨ÒåÁËÒ»¸öÇÐÈëµã±êÇ©·½·¨ businessService()£º +ä½ å�¯ä»¥ä½¿ç”¨ @{ADVICE-NAME} 注释声明五个建议中的任æ„�一个,如下所示。这å�‡è®¾ä½ å·²ç»�定义了一个切入点标签方法 businessService(): ``` @Before("businessService()") @@ -440,7 +440,7 @@ public void doAroundTask(){ } ``` -Äã¿ÉÒÔΪÈÎÒâÒ»¸ö½¨Ò鶨ÒåÄãµÄÇÐÈëµãÄÚÁª¡£ÏÂÃæÊÇÔÚ½¨Òé֮ǰ¶¨ÒåÄÚÁªÇÐÈëµãµÄÒ»¸öʾÀý£º +ä½ å�¯ä»¥ä¸ºä»»æ„�一个建议定义你的切入点内è�”。下é�¢æ˜¯åœ¨å»ºè®®ä¹‹å‰�定义内è�”切入点的一个示例: ``` @Before("execution(* com.xyz.myapp.service.*.*(..))") @@ -449,20 +449,20 @@ public doBeforeTask(){ } ``` -## »ùÓÚ AOP µÄ @AspectJ ʾÀý +## 基于 AOP çš„ @AspectJ 示例 -ΪÁËÀí½âÉÏÃæÌáµ½µÄ¹ØÓÚ»ùÓÚ AOP µÄ @AspectJ µÄ¸ÅÄÈÃÎÒÃDZàдһ¸öʾÀý£¬¿ÉÒÔʵÏÖ¼¸¸ö½¨Ò顣ΪÁËÔÚÎÒÃǵÄʾÀýÖÐʹÓü¸¸ö½¨Ò飬ÈÃÎÒÃÇʹ Eclipse IDE ´¦ÓÚ¹¤×÷״̬£¬È»ºó°´ÕÕÈçϲ½Öè´´½¨Ò»¸ö Spring Ó¦ÓóÌÐò£º +为了ç�†è§£ä¸Šé�¢æ��到的关于基于 AOP çš„ @AspectJ 的概念,让我们编写一个示例,å�¯ä»¥å®žçŽ°å‡ ä¸ªå»ºè®®ã€‚ä¸ºäº†åœ¨æˆ‘ä»¬çš„ç¤ºä¾‹ä¸­ä½¿ç”¨å‡ ä¸ªå»ºè®®ï¼Œè®©æˆ‘ä»¬ä½¿ Eclipse IDE 处于工作状æ€�,然å�ŽæŒ‰ç…§å¦‚下步骤创建一个 Spring 应用程åº�: -| ²½Öè | ÃèÊö | +| 步骤 | æ��è¿° | | --- | --- | -| 1 | ´´½¨Ò»¸öÃûΪ _SpringExample_ µÄÏîÄ¿£¬²¢ÇÒÔÚËù´´½¨ÏîÄ¿µÄ **src** Îļþ¼ÐÏ´´½¨Ò»¸öÃûΪ _com.tutorialspoint_ µÄ°ü¡£ | -| 2 | ʹÓà _Add External JARs_ Ñ¡ÏîÌí¼ÓËùÐèµÄ Spring ¿âÎļþ£¬¾ÍÈçÔÚ _Spring Hello World Example_ Õ½ÚÖнâÊ͵ÄÄÇÑù¡£ | -| 3 | ÔÚÏîÄ¿ÖÐÌí¼Ó Spring AOP Ö¸¶¨µÄ¿âÎļþ **aspectjrt.jar£¬ aspectjweaver.jar** ºÍ **aspectj.jar**¡£ | -| 4 | ÔÚ _com.tutorialspoint_ °üÏ´´½¨ Java Àà **Logging**£¬ _Student_ ºÍ _MainApp_¡£ | -| 5 | ÔÚ **src** Îļþ¼ÐÏ´´½¨ Beans ÅäÖÃÎļþ _Beans.xml_¡£ | -| 6 | ×îºóÒ»²½ÊÇ´´½¨ËùÓÐ Java ÎļþºÍ Bean ÅäÖÃÎļþµÄÄÚÈÝ£¬²¢ÇÒ°´ÈçϽâÊ͵ÄÄÇÑùÔËÐÐÓ¦ÓóÌÐò¡£ | +| 1 | 创建一个å��为 _SpringExample_ 的项目,并且在所创建项目的 **src** 文件夹下创建一个å��为 _com.tutorialspoint_ 的包。 | +| 2 | 使用 _Add External JARs_ 选项添加所需的 Spring 库文件,就如在 _Spring Hello World Example_ 章节中解释的那样。 | +| 3 | 在项目中添加 Spring AOP 指定的库文件 **aspectjrt.jar, aspectjweaver.jar** å’Œ **aspectj.jar**。 | +| 4 | 在 _com.tutorialspoint_ 包下创建 Java ç±» **Logging**, _Student_ å’Œ _MainApp_。 | +| 5 | 在 **src** 文件夹下创建 Beans é…�置文件 _Beans.xml_。 | +| 6 | 最å�Žä¸€æ­¥æ˜¯åˆ›å»ºæ‰€æœ‰ Java 文件和 Bean é…�置文件的内容,并且按如下解释的那样è¿�行应用程åº�。 | -ÕâÀïÊÇ **Logging.java** ÎļþµÄÄÚÈÝ¡£Õâʵ¼ÊÉÏÊÇ aspect Ä£¿éµÄÒ»¸öʾÀý£¬Ëü¶¨ÒåÁËÔÚ¸÷¸öµãµ÷Óõķ½·¨¡£ +这里是 **Logging.java** 文件的内容。这实际上是 aspect 模å�—的一个示例,它定义了在å�„个点调用的方法。 ``` package com.tutorialspoint; @@ -516,7 +516,7 @@ public class Logging { } ``` -ÏÂÃæÊÇ **Student.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **Student.java** 文件的内容: ``` package com.tutorialspoint; @@ -544,7 +544,7 @@ public class Student { } ``` -ÏÂÃæÊÇ **MainApp.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **MainApp.java** 文件的内容: ``` package com.tutorialspoint; @@ -562,7 +562,7 @@ public class MainApp { } ``` -ÏÂÃæÊÇÅäÖÃÎļþ **Beans.xml**£º +下é�¢æ˜¯é…�置文件 **Beans.xml**: ``` @@ -589,7 +589,7 @@ public class MainApp { ``` -Ò»µ©ÄãÒѾ­Íê³ÉµÄ´´½¨ÁËÔ´ÎļþºÍ bean ÅäÖÃÎļþ£¬ÈÃÎÒÃÇÔËÐÐÒ»ÏÂÓ¦ÓóÌÐò¡£Èç¹ûÄãµÄÓ¦ÓóÌÐòÒ»Çж¼Õý³£µÄ»°£¬Õ⽫»áÊä³öÒÔÏÂÏûÏ¢£º +一旦你已ç»�完æˆ�的创建了æº�文件和 bean é…�置文件,让我们è¿�行一下应用程åº�。如果你的应用程åº�一切都正常的è¯�,这将会输出以下消æ�¯ï¼š ``` Going to setup student profile. @@ -612,7 +612,7 @@ other exception content -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringBean\347\232\204\345\256\232\344\271\211\344\270\216\347\256\241\347\220\206\357\274\210\346\240\270\345\277\203\357\274\211.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringBean\347\232\204\345\256\232\344\271\211\344\270\216\347\256\241\347\220\206\357\274\210\346\240\270\345\277\203\357\274\211.md" index c4de431..996d06a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringBean\347\232\204\345\256\232\344\271\211\344\270\216\347\256\241\347\220\206\357\274\210\346\240\270\345\277\203\357\274\211.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/SpringBean\347\232\204\345\256\232\344\271\211\344\270\216\347\256\241\347\220\206\357\274\210\346\240\270\345\277\203\357\274\211.md" @@ -1,179 +1,179 @@ -### ÒÀÀµ×¢Èë +### ä¾�赖注入 -Spring¿ò¼ÜµÄºËÐŦÄÜÓÐÁ½¸ö£º +Spring框架的核心功能有两个: -* SpringÈÝÆ÷×÷Ϊ³¬¼¶´ó¹¤³§£¬¸ºÔð´´½¨¡¢¹ÜÀíËùÓеÄJava¶ÔÏó£¬ÕâЩJava¶ÔÏó±»³ÆÎªBean¡£ -* SpringÈÝÆ÷¹ÜÀíÈÝÆ÷ÖÐBeanÖ®¼äµÄÒÀÀµ¹ØÏµ£¬SpringʹÓÃÒ»ÖÖ±»³ÆÎª"ÒÀÀµ×¢Èë"µÄ·½Ê½À´¹ÜÀíBeanÖ®¼äµÄÒÀÀµ¹ØÏµ¡£ +* Spring容器作为超级大工厂,负责创建ã€�管ç�†æ‰€æœ‰çš„Java对象,这些Java对象被称为Bean。 +* Spring容器管ç�†å®¹å™¨ä¸­Bean之间的ä¾�赖关系,Spring使用一ç§�被称为"ä¾�赖注入"的方å¼�æ�¥ç®¡ç�†Bean之间的ä¾�赖关系。 -ʹÓÃÒÀÀµ×¢È룬²»½ö¿ÉÒÔΪBean×¢ÈëÆÕͨµÄÊôÐÔÖµ£¬»¹¿ÉÒÔ×¢ÈëÆäËûBeanµÄÒýÓá£ÒÀÀµ×¢ÈëÊÇÒ»ÖÖÓÅÐãµÄ½âñʽ£¬Æä¿ÉÒÔÈÃBeanÒÔÅäÖÃÎļþ×éÖ¯ÔÚÒ»Æð£¬¶ø²»ÊÇÒÔÓ²±àÂëµÄ·½Ê½ñîºÏÔÚÒ»Æð¡£ +使用ä¾�赖注入,ä¸�ä»…å�¯ä»¥ä¸ºBean注入普通的属性值,还å�¯ä»¥æ³¨å…¥å…¶ä»–Bean的引用。ä¾�赖注入是一ç§�优秀的解耦方å¼�,其å�¯ä»¥è®©Bean以é…�置文件组织在一起,而ä¸�是以硬编ç �的方å¼�耦å�ˆåœ¨ä¸€èµ·ã€‚ -#### Àí½âÒÀÀµ×¢Èë +#### ç�†è§£ä¾�赖注入 -Rod JohnsonÊǵÚÒ»¸ö¸ß¶ÈÖØÊÓÒÔÅäÖÃÎļþÀ´¹ÜÀíJavaʵÀýµÄЭ×÷¹ØÏµµÄÈË£¬Ëû¸øÕâÖÖ·½Ê½ÆðÁËÒ»¸öÃû×Ö£º¿ØÖÆ·´×ª£¨Inverse of Control£¬IoC£©¡£ºóÀ´Martine FowlerΪÕâÖÖ·½Ê½ÆðÁËÁíÒ»¸öÃû³Æ£ºÒÀÀµ×¢È루Dependency Injection£©£¬Òò´Ë²»¹ÜÊÇÒÀÀµ×¢È룬»¹ÊÇ¿ØÖÆ·´×ª£¬Æäº¬ÒåÍêÈ«Ïàͬ¡£µ±Ä³¸öJava¶ÔÏ󣨵÷ÓÃÕߣ©ÐèÒªµ÷ÓÃÁíÒ»¸öJava¶ÔÏ󣨱»ÒÀÀµ¶ÔÏ󣩵ķ½·¨Ê±£¬ÔÚ´«Í³Ä£Ê½ÏÂͨ³£ÓÐÁ½ÖÖ×ö·¨£º +Rod Johnson是第一个高度é‡�视以é…�置文件æ�¥ç®¡ç�†Java实例的å��作关系的人,他给这ç§�æ–¹å¼�起了一个å��字:控制å��转(Inverse of Control,IoC)。å�Žæ�¥Martine Fowler为这ç§�æ–¹å¼�起了å�¦ä¸€ä¸ªå��称:ä¾�赖注入(Dependency Injection),因此ä¸�管是ä¾�赖注入,还是控制å��转,其å�«ä¹‰å®Œå…¨ç›¸å�Œã€‚当æŸ�个Java对象(调用者)需è¦�调用å�¦ä¸€ä¸ªJava对象(被ä¾�赖对象)的方法时,在传统模å¼�下通常有两ç§�å�šæ³•ï¼š -1. ԭʼ×ö·¨: µ÷ÓÃÕß**Ö÷¶¯**´´½¨±»ÒÀÀµ¶ÔÏó£¬È»ºóÔÙµ÷Óñ»ÒÀÀµ¶ÔÏóµÄ·½·¨¡£ -2. ¼òµ¥¹¤³§Ä£Ê½: µ÷ÓÃÕßÏÈÕÒµ½±»ÒÀÀµ¶ÔÏóµÄ¹¤³§£¬È»ºó**Ö÷¶¯**ͨ¹ý¹¤³§È¥»ñÈ¡±»ÒÀÀµ¶ÔÏó£¬×îºóÔÙµ÷Óñ»ÒÀÀµ¶ÔÏóµÄ·½·¨¡£ +1. 原始å�𿳕: 调用者**主动**创建被ä¾�赖对象,然å�Žå†�调用被ä¾�赖对象的方法。 +2. 简å�•工厂模å¼�: 调用者先找到被ä¾�赖对象的工厂,然å�Ž**主动**通过工厂去获å�–被ä¾�赖对象,最å�Žå†�调用被ä¾�赖对象的方法。 -×¢ÒâÉÏÃæµÄ**Ö÷¶¯**¶þ×Ö£¬Õâ±ØÈ»»áµ¼Öµ÷ÓÃÕßÓë±»ÒÀÀµ¶ÔÏóʵÏÖÀàµÄÓ²±àÂëñîºÏ£¬·Ç³£²»ÀûÓÚÏîÄ¿Éý¼¶µÄά»¤¡£Ê¹ÓÃSpring¿ò¼ÜÖ®ºó£¬µ÷ÓÃÕßÎÞÐè**Ö÷¶¯**»ñÈ¡±»ÒÀÀµ¶ÔÏ󣬵÷ÓÃÕßÖ»Òª**±»¶¯**½ÓÊÜSpringÈÝÆ÷Ϊµ÷ÓÃÕߵijÉÔ±±äÁ¿¸³Öµ¼´¿É£¬Óɴ˿ɼû£¬Ê¹ÓÃSpringºó£¬µ÷ÓÃÕß»ñÈ¡±»ÒÀÀµ¶ÔÏóµÄ·½Ê½ÓÉÔ­À´µÄÖ÷¶¯»ñÈ¡£¬±ä³ÉÁ˱»¶¯½ÓÊÜ¡ª¡ªËùÒÔRod Johnson³ÆÖ®Îª¿ØÖÆ·´×ª¡£ +注æ„�上é�¢çš„**主动**二字,这必然会导致调用者与被ä¾�赖对象实现类的硬编ç �耦å�ˆï¼Œé�žå¸¸ä¸�利于项目å�‡çº§çš„维护。使用Spring框架之å�Žï¼Œè°ƒç”¨è€…无需**主动**获å�–被ä¾�赖对象,调用者å�ªè¦�**被动**接å�—Spring容器为调用者的æˆ�员å�˜é‡�赋值å�³å�¯ï¼Œç”±æ­¤å�¯è§�,使用Springå�Žï¼Œè°ƒç”¨è€…获å�–被ä¾�赖对象的方å¼�由原æ�¥çš„主动获å�–,å�˜æˆ�了被动接å�———所以Rod Johnson称之为控制å��转。 -ÁíÍâ´ÓSpringÈÝÆ÷µÄ½Ç¶ÈÀ´¿´£¬SpringÈÝÆ÷¸ºÔ𽫱»ÒÀÀµ¶ÔÏó¸³Öµ¸øµ÷ÓÃÕߵijÉÔ±±äÁ¿¡ª¡ªÏ൱ÓÚΪµ÷ÓÃÕß×¢ÈëËüÒÀÀµµÄʵÀý£¬Òò´ËMartine Fowler³ÆÖ®ÎªÒÀÀµ×¢Èë¡£ +å�¦å¤–从Spring容器的角度æ�¥çœ‹ï¼ŒSpring容器负责将被ä¾�赖对象赋值给调用者的æˆ�员å�˜é‡�——相当于为调用者注入它ä¾�赖的实例,因此Martine Fowler称之为ä¾�赖注入。 -#### ÉèÖµ×¢Èë +#### 设值注入 -ÉèÖµ×¢ÈëÊÇÖ¸IoCÈÝÆ÷ͨ¹ý³ÉÔ±±äÁ¿µÄsetter·½·¨À´×¢Èë±»ÒÀÀµ¶ÔÏó¡£ÕâÖÖ×¢È뷽ʽ¼òµ¥¡¢Ö±¹Û£¬Òò¶øÔÚSpringµÄÒÀÀµ×¢ÈëÀï´óÁ¿Ê¹Óᣠ+设值注入是指IoC容器通过æˆ�员å�˜é‡�çš„setter方法æ�¥æ³¨å…¥è¢«ä¾�赖对象。这ç§�注入方å¼�简å�•ã€�直观,因而在Springçš„ä¾�赖注入里大é‡�使用。 -#### ¹¹Ôì×¢Èë +#### 构造注入 -ÀûÓù¹ÔìÆ÷À´ÉèÖÃÒÀÀµ¹ØÏµµÄ·½Ê½£¬±»³ÆÎª¹¹Ôì×¢È롣ͨË×À´Ëµ£¬¾ÍÊÇÇý¶¯SpringÔڵײãÒÔ·´É䷽ʽִÐдøÖ¸¶¨²ÎÊýµÄ¹¹ÔìÆ÷£¬µ±Ö´Ðдø²ÎÊýµÄ¹¹ÔìÆ÷ʱ£¬¾Í¿ÉÀûÓù¹ÔìÆ÷²ÎÊý¶Ô³ÉÔ±±äÁ¿Ö´Ðгõʼ»¯¡ª¡ªÕâ¾ÍÊǹ¹Ôì×¢ÈëµÄ±¾ÖÊ¡£ +利用构造器æ�¥è®¾ç½®ä¾�赖关系的方å¼�,被称为构造注入。通俗æ�¥è¯´ï¼Œå°±æ˜¯é©±åЍSpring在底层以å��å°„æ–¹å¼�执行带指定å�‚数的构造器,当执行带å�‚数的构造器时,就å�¯åˆ©ç”¨æž„造器å�‚数对æˆ�员å�˜é‡�执行åˆ�始化——这就是构造注入的本质。 -#### Á½ÖÖ×¢È뷽ʽµÄ¶Ô±È +#### 两ç§�注入方å¼�的对比 -ÉèÖµ×¢ÈëÓÐÈçÏÂÓŵ㣺 +设值注入有如下优点: -* Ó봫ͳµÄJavaBeanµÄд·¨¸üÏàËÆ£¬³ÌÐò¿ª·¢ÈËÔ±¸üÈÝÒ×Àí½â¡¢½ÓÊÜ¡£Í¨¹ýsetter·½·¨É趨ÒÀÀµ¹ØÏµÏԵøü¼ÓÖ±¹Û¡¢×ÔÈ»¡£ -* ¶ÔÓÚ¸´ÔÓµÄÒÀÀµ¹ØÏµ£¬Èç¹û²ÉÓù¹Ôì×¢È룬»áµ¼Ö¹¹ÔìÆ÷¹ýÓÚÓ·Ö×£¬ÄÑÒÔÔĶÁ¡£SpringÔÚ´´½¨BeanʵÀýʱ£¬ÐèҪͬʱʵÀý»¯ÆäÒÀÀµµÄÈ«²¿ÊµÀý£¬Òò¶øµ¼ÖÂÐÔÄÜϽµ¡£¶øÊ¹ÓÃÉèÖµ×¢È룬ÔòÄܱÜÃâÕâЩÎÊÌâ¡£ -* ÓÈÆäÔÚijЩ³ÉÔ±±äÁ¿¿ÉÑ¡µÄÇé¿öÏ£¬¶à²ÎÊýµÄ¹¹ÔìÆ÷¸ü¼Ó±¿ÖØ¡£ +* 与传统的JavaBean的写法更相似,程åº�å¼€å�‘人员更容易ç�†è§£ã€�接å�—。通过setter方法设定ä¾�赖关系显得更加直观ã€�自然。 +* 对于å¤�æ�‚çš„ä¾�赖关系,如果采用构造注入,会导致构造器过于臃肿,难以阅读。Spring在创建Bean实例时,需è¦�å�Œæ—¶å®žä¾‹åŒ–å…¶ä¾�赖的全部实例,因而导致性能下é™�。而使用设值注入,则能é�¿å…�这些问题。 +* 尤其在æŸ�些æˆ�员å�˜é‡�å�¯é€‰çš„æƒ…况下,多å�‚数的构造器更加笨é‡�。 -¹¹Ôì×¢ÈëÓÅÊÆÈçÏ£º +构造注入优势如下: -* ¹¹Ôì×¢Èë¿ÉÒÔÔÚ¹¹ÔìÆ÷Öоö¶¨ÒÀÀµ¹ØÏµµÄ×¢Èë˳Ðò£¬ÓÅÏÈÒÀÀµµÄÓÅÏÈ×¢Èë¡£ -* ¶ÔÓÚÒÀÀµ¹ØÏµÎÞÐè±ä»¯µÄBean£¬¹¹Ôì×¢Èë¸üÓÐÓô¦¡£ÒòΪûÓÐsetter·½·¨£¬ËùÓеÄÒÀÀµ¹ØÏµÈ«²¿ÔÚ¹¹ÔìÆ÷ÄÚÉ趨£¬ÎÞÐëµ£ÐĺóÐøµÄ´úÂë¶ÔÒÀÀµ¹ØÏµ²úÉúÆÆ»µ¡£ -* ÒÀÀµ¹ØÏµÖ»ÄÜÔÚ¹¹ÔìÆ÷ÖÐÉ趨£¬ÔòÖ»ÓÐ×é¼þµÄ´´½¨Õß²ÅÄܸıä×é¼þµÄÒÀÀµ¹ØÏµ£¬¶Ô×é¼þµÄµ÷ÓÃÕß¶øÑÔ£¬×é¼þÄÚ²¿µÄÒÀÀµ¹ØÏµÍêȫ͸Ã÷£¬¸ü·ûºÏ¸ßÄÚ¾ÛµÄÔ­Ôò¡£ +* 构造注入å�¯ä»¥åœ¨æž„造器中决定ä¾�赖关系的注入顺åº�,优先ä¾�赖的优先注入。 +* 对于ä¾�赖关系无需å�˜åŒ–çš„Bean,构造注入更有用处。因为没有setter方法,所有的ä¾�赖关系全部在构造器内设定,无须担心å�Žç»­çš„代ç �对ä¾�赖关系产生破å��。 +* ä¾�赖关系å�ªèƒ½åœ¨æž„造器中设定,则å�ªæœ‰ç»„件的创建者æ‰�能改å�˜ç»„ä»¶çš„ä¾�赖关系,对组件的调用者而言,组件内部的ä¾�赖关系完全é€�明,更符å�ˆé«˜å†…è�šçš„原则。 -**_×¢Ò⣺_** -½¨Òé²ÉÓÃÉèÖµ×¢ÈëΪÖ÷£¬¹¹Ôì×¢ÈëΪ¸¨µÄ×¢Èë²ßÂÔ¡£¶ÔÓÚÒÀÀµ¹ØÏµÎÞÐë±ä»¯µÄ×¢È룬¾¡Á¿²ÉÓù¹Ôì×¢È룻¶øÆäËûÒÀÀµ¹ØÏµµÄ×¢È룬Ôò¿¼ÂDzÉÓÃÉèÖµ×¢Èë¡£ +**_注æ„�:_** +建议采用设值注入为主,构造注入为辅的注入策略。对于ä¾�赖关系无须å�˜åŒ–的注入,尽é‡�采用构造注入;而其他ä¾�赖关系的注入,则考虑采用设值注入。 -### SpringÈÝÆ÷ÖеÄBean +### Spring容器中的Bean -¶ÔÓÚ¿ª·¢ÕßÀ´Ëµ£¬¿ª·¢ÕßʹÓÃSpring¿ò¼ÜÖ÷ÒªÊÇ×öÁ½¼þÊ£º¢Ù¿ª·¢Bean£»¢ÚÅäÖÃBean¡£¶ÔÓÚSpring¿ò¼ÜÀ´Ëµ£¬ËüÒª×öµÄ¾ÍÊǸù¾ÝÅäÖÃÎļþÀ´´´½¨BeanʵÀý£¬²¢µ÷ÓÃBeanʵÀýµÄ·½·¨Íê³É"ÒÀÀµ×¢Èë"¡ª¡ªÕâ¾ÍÊÇËùνIoCµÄ±¾ÖÊ¡£ +对于开å�‘者æ�¥è¯´ï¼Œå¼€å�‘者使用Spring框架主è¦�是å�šä¸¤ä»¶äº‹ï¼šâ‘ å¼€å�‘Bean;②é…�ç½®Bean。对于Spring框架æ�¥è¯´ï¼Œå®ƒè¦�å�šçš„就是根æ�®é…�置文件æ�¥åˆ›å»ºBean实例,并调用Bean实例的方法完æˆ�"ä¾�赖注入"——这就是所谓IoC的本质。 -#### ÈÝÆ÷ÖÐBeanµÄ×÷ÓÃÓò +#### 容器中Bean的作用域 -µ±Í¨¹ýSpringÈÝÆ÷´´½¨Ò»¸öBeanʵÀýʱ£¬²»½ö¿ÉÒÔÍê³ÉBeanʵÀýµÄʵÀý»¯£¬»¹¿ÉÒÔΪBeanÖ¸¶¨Ìض¨µÄ×÷ÓÃÓò¡£SpringÖ§³ÖÈçÏÂÎåÖÖ×÷ÓÃÓò£º +当通过Spring容器创建一个Bean实例时,ä¸�ä»…å�¯ä»¥å®Œæˆ�Bean实例的实例化,还å�¯ä»¥ä¸ºBean指定特定的作用域。Spring支æŒ�如下五ç§�作用域: -1. singleton: µ¥Àýģʽ£¬ÔÚÕû¸öSpring IoCÈÝÆ÷ÖУ¬singleton×÷ÓÃÓòµÄBean½«Ö»Éú³ÉÒ»¸öʵÀý¡£ -2. prototype: ÿ´Îͨ¹ýÈÝÆ÷µÄgetBean()·½·¨»ñÈ¡prototype×÷ÓÃÓòµÄBeanʱ£¬¶¼½«²úÉúÒ»¸öеÄBeanʵÀý¡£ -3. request: ¶ÔÓÚÒ»´ÎHTTPÇëÇó£¬request×÷ÓÃÓòµÄBean½«Ö»Éú³ÉÒ»¸öʵÀý£¬ÕâÒâζ×Å£¬ÔÚͬһ´ÎHTTPÇëÇóÄÚ£¬³ÌÐòÿ´ÎÇëÇó¸ÃBean£¬µÃµ½µÄ×ÜÊÇͬһ¸öʵÀý¡£Ö»ÓÐÔÚWebÓ¦ÓÃÖÐʹÓÃSpringʱ£¬¸Ã×÷ÓÃÓò²ÅÕæÕýÓÐЧ¡£ -4. session£º¸Ã×÷ÓÃÓò½« bean µÄ¶¨ÒåÏÞÖÆÎª HTTP »á»°¡£ Ö»ÔÚweb-aware Spring ApplicationContextµÄÉÏÏÂÎÄÖÐÓÐЧ¡£ -5. global session: ÿ¸öÈ«¾ÖµÄHTTP Session¶ÔÓ¦Ò»¸öBeanʵÀý¡£ÔÚµäÐ͵ÄÇé¿öÏ£¬½öÔÚʹÓÃportlet contextµÄʱºòÓÐЧ£¬Í¬ÑùÖ»ÔÚWebÓ¦ÓÃÖÐÓÐЧ¡£ +1. singleton: å�•例模å¼�,在整个Spring IoC容器中,singleton作用域的Beanå°†å�ªç”Ÿæˆ�一个实例。 +2. prototype: æ¯�次通过容器的getBean()方法获å�–prototype作用域的Bean时,都将产生一个新的Bean实例。 +3. request: 对于一次HTTP请求,request作用域的Beanå°†å�ªç”Ÿæˆ�一个实例,这æ„�味ç�€ï¼Œåœ¨å�Œä¸€æ¬¡HTTP请求内,程åº�æ¯�次请求该Bean,得到的总是å�Œä¸€ä¸ªå®žä¾‹ã€‚å�ªæœ‰åœ¨Web应用中使用Spring时,该作用域æ‰�真正有效。 +4. session:该作用域将 bean 的定义é™�制为 HTTP 会è¯�。 å�ªåœ¨web-aware Spring ApplicationContext的上下文中有效。 +5. global session: æ¯�个全局的HTTP Session对应一个Bean实例。在典型的情况下,仅在使用portlet context的时候有效,å�Œæ ·å�ªåœ¨Web应用中有效。 -Èç¹û²»Ö¸¶¨BeanµÄ×÷ÓÃÓò£¬SpringĬÈÏʹÓÃsingleton×÷ÓÃÓò¡£prototype×÷ÓÃÓòµÄBeanµÄ´´½¨¡¢Ïú»Ù´ú¼Û±È½Ï´ó¡£¶øsingleton×÷ÓÃÓòµÄBeanʵÀýÒ»µ©´´½¨³É¹û£¬¾Í¿ÉÒÔÖØ¸´Ê¹Óá£Òò´Ë£¬Ó¦¸Ã¾¡Á¿±ÜÃ⽫BeanÉèÖóÉprototype×÷ÓÃÓò¡£ +如果ä¸�指定Bean的作用域,Spring默认使用singleton作用域。prototype作用域的Bean的创建ã€�销æ¯�代价比较大。而singleton作用域的Bean实例一旦创建æˆ�果,就å�¯ä»¥é‡�å¤�使用。因此,应该尽é‡�é�¿å…�å°†Bean设置æˆ�prototype作用域。 -### ʹÓÃ×Ô¶¯×°Åä×¢ÈëºÏ×÷ÕßBean +### 使用自动装é…�注入å�ˆä½œè€…Bean -SpringÄÜ×Ô¶¯×°ÅäBeanÓëBeanÖ®¼äµÄÒÀÀµ¹ØÏµ£¬¼´ÎÞÐëʹÓÃrefÏÔʽָ¶¨ÒÀÀµBean£¬¶øÊÇÓÉSpringÈÝÆ÷¼ì²éXMLÅäÖÃÎļþÄÚÈÝ£¬¸ù¾ÝijÖÖ¹æÔò£¬Îªµ÷ÓÃÕßBean×¢Èë±»ÒÀÀµµÄBean¡£ -Spring×Ô¶¯×°Åä¿Éͨ¹ý``ÔªËØµÄ`default-autowire`ÊôÐÔÖ¸¶¨£¬¸ÃÊôÐÔ¶ÔÅäÖÃÎļþÖÐËùÓеÄBeanÆð×÷Óã»Ò²¿Éͨ¹ý¶Ô``ÔªËØµÄ`autowire`ÊôÐÔÖ¸¶¨£¬¸ÃÊôÐÔÖ»¶Ô¸ÃBeanÆð×÷Óᣠ+Spring能自动装é…�Bean与Bean之间的ä¾�赖关系,å�³æ— é¡»ä½¿ç”¨ref显å¼�指定ä¾�èµ–Bean,而是由Spring容器检查XMLé…�置文件内容,根æ�®æŸ�ç§�规则,为调用者Bean注入被ä¾�èµ–çš„Bean。 +Spring自动装é…�å�¯é€šè¿‡``元素的`default-autowire`属性指定,该属性对é…�置文件中所有的Bean起作用;也å�¯é€šè¿‡å¯¹``元素的`autowire`属性指定,该属性å�ªå¯¹è¯¥Bean起作用。 -`autowire`ºÍ`default-autowire`¿ÉÒÔ½ÓÊÜÈçÏÂÖµ£º +`autowire`å’Œ`default-autowire`å�¯ä»¥æŽ¥å�—如下值: -* `no`: ²»Ê¹ÓÃ×Ô¶¯×°Åä¡£BeanÒÀÀµ±ØÐëͨ¹ýrefÔªËØ¶¨Òå¡£ÕâÊÇĬÈÏÅäÖã¬ÔڽϴóµÄ²¿Êð»·¾³Öв»¹ÄÀø¸Ä±äÕâ¸öÅäÖã¬ÏÔʽÅäÖúÏ×÷ÕßÄܹ»µÃµ½¸üÇåÎúµÄÒÀÀµ¹ØÏµ¡£ -* `byName`: ¸ù¾Ýsetter·½·¨Ãû½øÐÐ×Ô¶¯×°Åä¡£SpringÈÝÆ÷²éÕÒÈÝÆ÷ÖÐÈ«²¿Bean£¬ÕÒ³öÆäidÓësetter·½·¨ÃûÈ¥µôsetǰ׺£¬²¢Ð¡Ð´Ê××ÖĸºóͬÃûµÄBeanÀ´Íê³É×¢Èë¡£Èç¹ûûÓÐÕÒµ½Æ¥ÅäµÄBeanʵÀý£¬ÔòSpring²»»á½øÐÐÈκÎ×¢Èë¡£ -* `byType`: ¸ù¾Ýsetter·½·¨µÄÐβÎÀàÐÍÀ´×Ô¶¯×°Åä¡£SpringÈÝÆ÷²éÕÒÈÝÆ÷ÖеÄÈ«²¿Bean£¬Èç¹ûÕýºÃÓÐÒ»¸öBeanÀàÐÍÓësetter·½·¨µÄÐβÎÀàÐÍÆ¥Å䣬¾Í×Ô¶¯×¢ÈëÕâ¸öBean£»Èç¹ûÕÒµ½¶à¸öÕâÑùµÄBean£¬¾ÍÅ׳öÒ»¸öÒì³££»Èç¹ûûÓÐÕÒµ½ÕâÑùµÄBean£¬Ôòʲô¶¼²»»á·¢Éú£¬setter·½·¨²»»á±»µ÷Óᣠ-* `constructor`: ÓëbyTypeÀàËÆ£¬Çø±ðÊÇÓÃÓÚ×Ô¶¯Æ¥Åä¹¹ÔìÆ÷µÄ²ÎÊý¡£Èç¹ûÈÝÆ÷²»ÄÜÇ¡ºÃÕÒµ½Ò»¸öÓë¹¹ÔìÆ÷²ÎÊýÀàÐÍÆ¥ÅäµÄBean£¬Ôò»áÅ׳öÒ»¸öÒì³£¡£ -* `autodetect`: SpringÈÝÆ÷¸ù¾ÝBeanÄÚ²¿½á¹¹£¬×ÔÐоö¶¨Ê¹ÓÃconstructor»òbyType²ßÂÔ¡£Èç¹ûÕÒµ½Ò»¸öĬÈϵĹ¹Ô캯Êý£¬ÄÇô¾Í»áÓ¦ÓÃbyType²ßÂÔ¡£ +* `no`: ä¸�使用自动装é…�。Beanä¾�赖必须通过ref元素定义。这是默认é…�置,在较大的部署环境中ä¸�鼓励改å�˜è¿™ä¸ªé…�置,显å¼�é…�ç½®å�ˆä½œè€…能够得到更清晰的ä¾�赖关系。 +* `byName`: æ ¹æ�®setter方法å��进行自动装é…�。Spring容器查找容器中全部Bean,找出其id与setter方法å��去掉setå‰�缀,并å°�写首字æ¯�å�Žå�Œå��çš„Beanæ�¥å®Œæˆ�注入。如果没有找到匹é…�çš„Bean实例,则Springä¸�会进行任何注入。 +* `byType`: æ ¹æ�®setter方法的形å�‚类型æ�¥è‡ªåŠ¨è£…é…�。Spring容器查找容器中的全部Bean,如果正好有一个Bean类型与setter方法的形å�‚类型匹é…�,就自动注入这个Bean;如果找到多个这样的Bean,就抛出一个异常;如果没有找到这样的Bean,则什么都ä¸�会å�‘生,setter方法ä¸�会被调用。 +* `constructor`: 与byType类似,区别是用于自动匹é…�构造器的å�‚数。如果容器ä¸�能æ�°å¥½æ‰¾åˆ°ä¸€ä¸ªä¸Žæž„造器å�‚数类型匹é…�çš„Bean,则会抛出一个异常。 +* `autodetect`: Spring容器根æ�®Bean内部结构,自行决定使用constructor或byType策略。如果找到一个默认的构造函数,那么就会应用byType策略。 -**µ±Ò»¸öBean¼ÈʹÓÃ×Ô¶¯×°ÅäÒÀÀµ£¬ÓÖʹÓÃrefÏÔʽָ¶¨ÒÀÀµÊ±£¬ÔòÏÔʽָ¶¨µÄÒÀÀµ¸²¸Ç×Ô¶¯×°ÅäÒÀÀµ£»¶ÔÓÚ´óÐ͵ÄÓ¦Ó㬲»¹ÄÀøÊ¹ÓÃ×Ô¶¯×°Åä¡£ËäȻʹÓÃ×Ô¶¯×°Åä¿É¼õÉÙÅäÖÃÎļþµÄ¹¤×÷Á¿£¬µ«´ó´ó½«ËÀÁËÒÀÀµ¹ØÏµµÄÇåÎúÐÔºÍ͸Ã÷ÐÔ¡£ÒÀÀµ¹ØÏµµÄ×°ÅäÒÀÀµÓÚÔ´ÎļþµÄÊôÐÔÃûºÍÊôÐÔÀàÐÍ£¬µ¼ÖÂBeanÓëBeanÖ®¼äµÄñîºÏ½µµÍµ½´úÂë²ã´Î£¬²»ÀûÓڸ߲ã´Î½âñî¡£** +**当一个Bean既使用自动装é…�ä¾�赖,å�ˆä½¿ç”¨ref显å¼�指定ä¾�赖时,则显å¼�指定的ä¾�赖覆盖自动装é…�ä¾�赖;对于大型的应用,ä¸�鼓励使用自动装é…�。虽然使用自动装é…�å�¯å‡�å°‘é…�置文件的工作é‡�,但大大将死了ä¾�赖关系的清晰性和é€�明性。ä¾�赖关系的装é…�ä¾�赖于æº�文件的属性å��和属性类型,导致Bean与Bean之间的耦å�ˆé™�低到代ç �层次,ä¸�利于高层次解耦。** - + -## ´´½¨BeanµÄ3ÖÖ·½Ê½ +## 创建Beançš„3ç§�æ–¹å¼� -### ʹÓù¹ÔìÆ÷´´½¨BeanʵÀý +### 使用构造器创建Bean实例 -ʹÓù¹ÔìÆ÷À´´´½¨BeanʵÀýÊÇ×î³£¼ûµÄÇé¿ö£¬Èç¹û²»²ÉÓù¹Ôì×¢È룬Springµ×²ã»áµ÷ÓÃBeanÀàµÄÎÞ²ÎÊý¹¹ÔìÆ÷À´´´½¨ÊµÀý£¬Òò´ËÒªÇó¸ÃBeanÀàÌṩÎÞ²ÎÊýµÄ¹¹ÔìÆ÷¡£ +使用构造器æ�¥åˆ›å»ºBean实例是最常è§�的情况,如果ä¸�采用构造注入,Spring底层会调用Bean类的无å�‚数构造器æ�¥åˆ›å»ºå®žä¾‹ï¼Œå› æ­¤è¦�求该Beanç±»æ��供无å�‚数的构造器。 -²ÉÓÃĬÈϵĹ¹ÔìÆ÷´´½¨BeanʵÀý£¬Spring¶ÔBeanʵÀýµÄËùÓÐÊôÐÔÖ´ÐÐĬÈϳõʼ»¯£¬¼´ËùÓеĻù±¾ÀàÐ͵ÄÖµ³õʼ»¯Îª0»òfalse£»ËùÓеÄÒýÓÃÀàÐ͵ÄÖµ³õʼ»¯Îªnull¡£ +采用默认的构造器创建Bean实例,Spring对Bean实例的所有属性执行默认åˆ�始化,å�³æ‰€æœ‰çš„基本类型的值åˆ�始化为0或false;所有的引用类型的值åˆ�始化为null。 -### ʹÓþ²Ì¬¹¤³§·½·¨´´½¨Bean +### 使用é�™æ€�工厂方法创建Bean -ʹÓþ²Ì¬¹¤³§·½·¨´´½¨BeanʵÀýʱ£¬classÊôÐÔÒ²±ØÐëÖ¸¶¨£¬µ«´ËʱclassÊôÐÔ²¢²»ÊÇÖ¸¶¨BeanʵÀýµÄʵÏÖÀ࣬¶øÊǾ²Ì¬¹¤³§À࣬Springͨ¹ý¸ÃÊôÐÔÖªµÀÓÉÄĸö¹¤³§ÀàÀ´´´½¨BeanʵÀý¡£ +使用é�™æ€�工厂方法创建Bean实例时,class属性也必须指定,但此时class属性并ä¸�是指定Bean实例的实现类,而是é�™æ€�工厂类,Spring通过该属性知é�“由哪个工厂类æ�¥åˆ›å»ºBean实例。 -³ý´ËÖ®Í⣬»¹ÐèҪʹÓÃfactory-methodÊôÐÔÀ´Ö¸¶¨¾²Ì¬¹¤³§·½·¨£¬Spring½«µ÷Óþ²Ì¬¹¤³§·½·¨·µ»ØÒ»¸öBeanʵÀý£¬Ò»µ©»ñµÃÁËÖ¸¶¨BeanʵÀý£¬SpringºóÃæµÄ´¦Àí²½ÖèÓë²ÉÓÃÆÕͨ·½·¨´´½¨BeanʵÀýÍêȫһÑù¡£Èç¹û¾²Ì¬¹¤³§·½·¨ÐèÒª²ÎÊý£¬ÔòʹÓÃ``ÔªËØÖ¸¶¨¾²Ì¬¹¤³§·½·¨µÄ²ÎÊý¡£ +除此之外,还需è¦�使用factory-method属性æ�¥æŒ‡å®šé�™æ€�工厂方法,Spring将调用é�™æ€�工厂方法返回一个Bean实例,一旦获得了指定Bean实例,Springå�Žé�¢çš„处ç�†æ­¥éª¤ä¸Žé‡‡ç”¨æ™®é€šæ–¹æ³•创建Bean实例完全一样。如果é�™æ€�工厂方法需è¦�å�‚数,则使用``元素指定é�™æ€�工厂方法的å�‚数。 -### µ÷ÓÃʵÀý¹¤³§·½·¨´´½¨Bean +### 调用实例工厂方法创建Bean -ʵÀý¹¤³§·½·¨Ó뾲̬¹¤³§·½·¨Ö»ÓÐÒ»¸ö²»Í¬£ºµ÷Óþ²Ì¬¹¤³§·½·¨Ö»ÐèʹÓù¤³§À༴¿É£¬¶øµ÷ÓÃʵÀý¹¤³§·½·¨ÔòÐèÒª¹¤³§ÊµÀý¡£Ê¹ÓÃʵÀý¹¤³§·½·¨Ê±£¬ÅäÖÃBeanʵÀýµÄ``ÔªËØÎÞÐëclassÊôÐÔ£¬ÅäÖÃʵÀý¹¤³§·½·¨Ê¹ÓÃ`factory-bean`Ö¸¶¨¹¤³§ÊµÀý¡£ -²ÉÓÃʵÀý¹¤³§·½·¨´´½¨BeanµÄ``ÔªËØÊ±ÐèÒªÖ¸¶¨ÈçÏÂÁ½¸öÊôÐÔ£º +实例工厂方法与é�™æ€�工厂方法å�ªæœ‰ä¸€ä¸ªä¸�å�Œï¼šè°ƒç”¨é�™æ€�工厂方法å�ªéœ€ä½¿ç”¨å·¥åŽ‚ç±»å�³å�¯ï¼Œè€Œè°ƒç”¨å®žä¾‹å·¥åŽ‚æ–¹æ³•åˆ™éœ€è¦�工厂实例。使用实例工厂方法时,é…�ç½®Bean实例的``元素无须class属性,é…�置实例工厂方法使用`factory-bean`指定工厂实例。 +采用实例工厂方法创建Beançš„``元素时需è¦�指定如下两个属性: -* factory-bean: ¸ÃÊôÐÔµÄֵΪ¹¤³§BeanµÄid¡£ -* factory-method: ¸ÃÊôÐÔÖ¸¶¨ÊµÀý¹¤³§µÄ¹¤³§·½·¨¡£ +* factory-bean: 该属性的值为工厂Beançš„id。 +* factory-method: 该属性指定实例工厂的工厂方法。 -Èôµ÷ÓÃʵÀý¹¤³§·½·¨Ê±ÐèÒª´«Èë²ÎÊý£¬ÔòʹÓÃ``ÔªËØÈ·¶¨²ÎÊýÖµ¡£ +若调用实例工厂方法时需è¦�ä¼ å…¥å�‚数,则使用``元素确定å�‚数值。 -## Эµ÷×÷ÓÃÓò²»Í¬²½µÄBean +## å��调作用域ä¸�å�Œæ­¥çš„Bean -µ±singleton×÷ÓÃÓòµÄBeanÒÀÀµÓÚprototype×÷ÓÃÓòµÄBeanʱ£¬»á²úÉú²»Í¬²½µÄÏÖÏó£¬Ô­ÒòÊÇÒòΪµ±SpringÈÝÆ÷³õʼ»¯Ê±£¬ÈÝÆ÷»áÔ¤³õʼ»¯ÈÝÆ÷ÖÐËùÓеÄ`singleton Bean`£¬ÓÉÓÚ`singleton Bean`ÒÀÀµÓÚ`prototype Bean`£¬Òò´ËSpringÔÚ³õʼ»¯`singleton Bean`֮ǰ£¬»áÏÈ´´½¨`prototypeBean`¡ª¡ªÈ»ºó²Å´´½¨`singleton Bean`£¬½ÓÏÂÀォ`prototype Bean`×¢Èë`singleton Bean`¡£ -½â¾ö²»Í¬²½µÄ·½·¨ÓÐÁ½ÖÖ£º +当singleton作用域的Beanä¾�赖于prototype作用域的Bean时,会产生ä¸�å�Œæ­¥çš„现象,原因是因为当Spring容器åˆ�始化时,容器会预åˆ�始化容器中所有的`singleton Bean`,由于`singleton Bean`ä¾�赖于`prototype Bean`,因此Spring在åˆ�始化`singleton Bean`之å‰�,会先创建`prototypeBean`——然å�Žæ‰�创建`singleton Bean`,接下里将`prototype Bean`注入`singleton Bean`。 +解决ä¸�å�Œæ­¥çš„æ–¹æ³•有两ç§�: -* ·ÅÆúÒÀÀµ×¢Èë: singleton×÷ÓÃÓòµÄBeanÿ´ÎÐèÒªprototype×÷ÓÃÓòµÄBeanʱ£¬Ö÷¶¯ÏòÈÝÆ÷ÇëÇóеÄBeanʵÀý£¬¼´¿É±£Ö¤Ã¿´Î×¢ÈëµÄ`prototype Bean`ʵÀý¶¼ÊÇ×îеÄʵÀý¡£ -* ÀûÓ÷½·¨×¢Èë: ·½·¨×¢Èëͨ³£Ê¹ÓÃlookup·½·¨×¢È룬ʹÓÃlookup·½·¨×¢Èë¿ÉÒÔÈÃSpringÈÝÆ÷ÖØÐ´ÈÝÆ÷ÖÐBeanµÄ³éÏó»ò¾ßÌå·½·¨£¬·µ»Ø²éÕÒÈÝÆ÷ÖÐÆäËûBeanµÄ½á¹û£¬±»²éÕÒµÄBeanͨ³£ÊÇÒ»¸ö`non-singleton Bean`¡£Springͨ¹ýʹÓÃJDK¶¯Ì¬´úÀí»òcglib¿âÐ޸Ŀͻ§¶ËµÄ¶þ½øÖÆÂ룬´Ó¶øÊµÏÖÉÏÊöÒªÇó¡£ +* 放弃ä¾�赖注入: singleton作用域的Beanæ¯�次需è¦�prototype作用域的Bean时,主动å�‘容器请求新的Bean实例,å�³å�¯ä¿�è¯�æ¯�次注入的`prototype Bean`实例都是最新的实例。 +* 利用方法注入: 方法注入通常使用lookup方法注入,使用lookup方法注入å�¯ä»¥è®©Spring容器é‡�写容器中Bean的抽象或具体方法,返回查找容器中其他Bean的结果,被查找的Bean通常是一个`non-singleton Bean`。Spring通过使用JDK动æ€�代ç�†æˆ–cglib库修改客户端的二进制ç �,从而实现上述è¦�求。 -½¨Òé²ÉÓõڶþÖÖ·½·¨£¬Ê¹Ó÷½·¨×¢È롣ΪÁËʹÓÃlookup·½·¨×¢È룬´óÖÂÐèÒªÈçÏÂÁ½²½£º +建议采用第二ç§�方法,使用方法注入。为了使用lookup方法注入,大致需è¦�如下两步: -1. ½«µ÷ÓÃÕßBeanµÄʵÏÖÀඨÒåΪ³éÏóÀ࣬²¢¶¨ÒåÒ»¸ö³éÏó·½·¨À´»ñÈ¡±»ÒÀÀµµÄBean¡£ -2. ÔÚ``ÔªËØÖÐÌí¼Ó``×ÓÔªËØÈÃSpringΪµ÷ÓÃÕßBeanµÄʵÏÖÀàʵÏÖÖ¸¶¨µÄ³éÏó·½·¨¡£ +1. 将调用者Bean的实现类定义为抽象类,并定义一个抽象方法æ�¥èŽ·å�–被ä¾�èµ–çš„Bean。 +2. 在``元素中添加``å­�元素让Spring为调用者Bean的实现类实现指定的抽象方法。 -**_×¢Ò⣺_** +**_注æ„�:_** -> Spring»á²ÉÓÃÔËÐÐʱ¶¯Ì¬ÔöÇ¿µÄ·½Ê½À´ÊµÏÖ``ÔªËØËùÖ¸¶¨µÄ³éÏó·½·¨£¬Èç¹ûÄ¿±ê³éÏóÀàʵÏÖ¹ý½Ó¿Ú£¬Spring»á²ÉÓÃJDK¶¯Ì¬´úÀíÀ´ÊµÏָóéÏóÀ࣬²¢ÎªÖ®ÊµÏÖ³éÏó·½·¨£»Èç¹ûÄ¿±ê³éÏóÀàûÓÐʵÏÖ¹ý½Ó¿Ú£¬Spring»á²ÉÓÃcglibʵÏָóéÏóÀ࣬²¢ÎªÖ®ÊµÏÖ³éÏó·½·¨¡£Spring4.0µÄspring-core-xxx.jar°üÖÐÒѾ­¼¯³ÉÁËcglibÀà¿â¡£ +> Spring会采用è¿�行时动æ€�增强的方å¼�æ�¥å®žçް``元素所指定的抽象方法,如果目标抽象类实现过接å�£ï¼ŒSpring会采用JDK动æ€�代ç�†æ�¥å®žçŽ°è¯¥æŠ½è±¡ç±»ï¼Œå¹¶ä¸ºä¹‹å®žçŽ°æŠ½è±¡æ–¹æ³•ï¼›å¦‚æžœç›®æ ‡æŠ½è±¡ç±»æ²¡æœ‰å®žçŽ°è¿‡æŽ¥å�£ï¼ŒSpring会采用cglib实现该抽象类,并为之实现抽象方法。Spring4.0çš„spring-core-xxx.jar包中已ç»�集æˆ�了cglib类库。 -## Á½ÖÖºó´¦ÀíÆ÷ +## 两ç§�å�Žå¤„ç�†å™¨ -SpringÌṩÁËÁ½ÖÖ³£Óõĺó´¦ÀíÆ÷£º +Springæ��供了两ç§�常用的å�Žå¤„ç�†å™¨ï¼š -* Beanºó´¦ÀíÆ÷: ÕâÖÖºó´¦ÀíÆ÷»á¶ÔÈÝÆ÷ÖÐBean½øÐкó´¦Àí£¬¶ÔBean½øÐжîÍâ¼ÓÇ¿¡£ -* ÈÝÆ÷ºó´¦ÀíÆ÷: ÕâÖÖºó´¦ÀíÆ÷»á¶ÔIoCÈÝÆ÷½øÐкó´¦Àí£¬ÓÃÓÚÔöÇ¿ÈÝÆ÷¹¦ÄÜ¡£ +* Beanå�Žå¤„ç�†å™¨: è¿™ç§�å�Žå¤„ç�†å™¨ä¼šå¯¹å®¹å™¨ä¸­Bean进行å�Žå¤„ç�†ï¼Œå¯¹Bean进行é¢�外加强。 +* 容器å�Žå¤„ç�†å™¨: è¿™ç§�å�Žå¤„ç�†å™¨ä¼šå¯¹IoC容器进行å�Žå¤„ç�†ï¼Œç”¨äºŽå¢žå¼ºå®¹å™¨åŠŸèƒ½ã€‚ -### Beanºó´¦ÀíÆ÷ +### Beanå�Žå¤„ç�†å™¨ -Beanºó´¦ÀíÆ÷ÊÇÒ»ÖÖÌØÊâµÄBean£¬ÕâÖÖÌØÊâµÄBean²¢²»¶ÔÍâÌṩ·þÎñ£¬ËüÉõÖÁ¿ÉÒÔÎÞÐëidÊôÐÔ£¬ËüÖ÷Òª¸ºÔð¶ÔÈÝÆ÷ÖÐµÄÆäËûBeanÖ´Ðкó´¦Àí£¬ÀýÈçΪÈÝÆ÷ÖеÄÄ¿±êBeanÉú³É´úÀíµÈ£¬ÕâÖÖBean³ÆÎªBeanºó´¦ÀíÆ÷¡£Beanºó´¦ÀíÆ÷»áÔÚBeanʵÀý´´½¨³É¹¦Ö®ºó£¬¶ÔBeanʵÀý½øÐнøÒ»²½µÄÔöÇ¿´¦Àí¡£Beanºó´¦ÀíÆ÷±ØÐëʵÏÖ`BeanPostProcessor`½Ó¿Ú£¬Í¬Ê±±ØÐëʵÏָýӿڵÄÁ½¸ö·½·¨¡£ +Beanå�Žå¤„ç�†å™¨æ˜¯ä¸€ç§�特殊的Bean,这ç§�特殊的Beanå¹¶ä¸�对外æ��ä¾›æœ�务,它甚至å�¯ä»¥æ— é¡»id属性,它主è¦�负责对容器中的其他Bean执行å�Žå¤„ç�†ï¼Œä¾‹å¦‚为容器中的目标Bean生æˆ�代ç�†ç­‰ï¼Œè¿™ç§�Bean称为Beanå�Žå¤„ç�†å™¨ã€‚Beanå�Žå¤„ç�†å™¨ä¼šåœ¨Bean实例创建æˆ�功之å�Žï¼Œå¯¹Bean实例进行进一步的增强处ç�†ã€‚Beanå�Žå¤„ç�†å™¨å¿…须实现`BeanPostProcessor`接å�£ï¼Œå�Œæ—¶å¿…须实现该接å�£çš„两个方法。 -1. `Object postProcessBeforeInitialization(Object bean, String name) throws BeansException`: ¸Ã·½·¨µÄµÚÒ»¸ö²ÎÊýÊÇϵͳ¼´½«½øÐкó´¦ÀíµÄBeanʵÀý£¬µÚ¶þ¸ö²ÎÊýÊǸÃBeanµÄÅäÖÃid -2. `Object postProcessAfterinitialization(Object bean, String name) throws BeansException`: ¸Ã·½·¨µÄµÚÒ»¸ö²ÎÊýÊÇϵͳ¼´½«½øÐкó´¦ÀíµÄBeanʵÀý£¬µÚ¶þ¸ö²ÎÊýÊǸÃBeanµÄÅäÖÃid +1. `Object postProcessBeforeInitialization(Object bean, String name) throws BeansException`: 该方法的第一个å�‚数是系统å�³å°†è¿›è¡Œå�Žå¤„ç�†çš„Bean实例,第二个å�‚数是该Beançš„é…�ç½®id +2. `Object postProcessAfterinitialization(Object bean, String name) throws BeansException`: 该方法的第一个å�‚数是系统å�³å°†è¿›è¡Œå�Žå¤„ç�†çš„Bean实例,第二个å�‚数是该Beançš„é…�ç½®id -ÈÝÆ÷ÖÐÒ»µ©×¢²áÁËBeanºó´¦ÀíÆ÷£¬Beanºó´¦ÀíÆ÷¾Í»á×Ô¶¯Æô¶¯£¬ÔÚÈÝÆ÷ÖÐÿ¸öBean´´½¨Ê±×Ô¶¯¹¤×÷£¬Beanºó´¦ÀíÆ÷Á½¸ö·½·¨µÄ»Øµ÷ʱ»úÈçÏÂͼ£º +容器中一旦注册了Beanå�Žå¤„ç�†å™¨ï¼ŒBeanå�Žå¤„ç�†å™¨å°±ä¼šè‡ªåЍå�¯åŠ¨ï¼Œåœ¨å®¹å™¨ä¸­æ¯�个Bean创建时自动工作,Beanå�Žå¤„ç�†å™¨ä¸¤ä¸ªæ–¹æ³•的回调时机如下图: ![bean-post-process](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e8970a58f831cd7613b680ef0541e7c7.jpg) -×¢ÒâÒ»µã£¬Èç¹ûʹÓÃ`BeanFactory`×÷ΪSpringÈÝÆ÷£¬Ôò±ØÐëÊÖ¶¯×¢²áBeanºó´¦ÀíÆ÷£¬³ÌÐò±ØÐë»ñÈ¡Beanºó´¦ÀíÆ÷ʵÀý£¬È»ºóÊÖ¶¯×¢²á¡£ +注æ„�一点,如果使用`BeanFactory`作为Spring容器,则必须手动注册Beanå�Žå¤„ç�†å™¨ï¼Œç¨‹åº�必须获å�–Beanå�Žå¤„ç�†å™¨å®žä¾‹ï¼Œç„¶å�Žæ‰‹åŠ¨æ³¨å†Œã€‚ BeanPostProcessor bp = (BeanPostProcessor)beanFactory.getBean("bp"); beanFactory.addBeanPostProcessor(bp); Person p = (Person)beanFactory.getBean("person"); -### ÈÝÆ÷ºó´¦ÀíÆ÷ +### 容器å�Žå¤„ç�†å™¨ -Beanºó´¦ÀíÆ÷¸ºÔð´¦ÀíÈÝÆ÷ÖеÄËùÓÐBeanʵÀý£¬¶øÈÝÆ÷ºó´¦ÀíÆ÷Ôò¸ºÔð´¦ÀíÈÝÆ÷±¾Éí¡£ÈÝÆ÷ºó´¦ÀíÆ÷±ØÐëʵÏÖ`BeanFactoryPostProcessor`½Ó¿Ú£¬²¢ÊµÏָýӿڵÄÒ»¸ö·½·¨`postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)`ʵÏָ÷½·¨µÄ·½·¨Ìå¾ÍÊǶÔSpringÈÝÆ÷½øÐеĴ¦Àí£¬ÕâÖÖ´¦Àí¿ÉÒÔ¶ÔSpringÈÝÆ÷½øÐÐ×Ô¶¨ÒåÀ©Õ¹£¬µ±È»Ò²¿ÉÒÔ¶ÔSpringÈÝÆ÷²»½øÐÐÈκδ¦Àí¡£ +Beanå�Žå¤„ç�†å™¨è´Ÿè´£å¤„ç�†å®¹å™¨ä¸­çš„æ‰€æœ‰Bean实例,而容器å�Žå¤„ç�†å™¨åˆ™è´Ÿè´£å¤„ç�†å®¹å™¨æœ¬èº«ã€‚容器å�Žå¤„ç�†å™¨å¿…须实现`BeanFactoryPostProcessor`接å�£ï¼Œå¹¶å®žçŽ°è¯¥æŽ¥å�£çš„一个方法`postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)`实现该方法的方法体就是对Spring容器进行的处ç�†ï¼Œè¿™ç§�处ç�†å�¯ä»¥å¯¹Spring容器进行自定义扩展,当然也å�¯ä»¥å¯¹Spring容器ä¸�进行任何处ç�†ã€‚ -ÀàËÆÓÚ`BeanPostProcessor`£¬`ApplicationContext`¿É×Ô¶¯¼ì²âµ½ÈÝÆ÷ÖеÄÈÝÆ÷ºó´¦ÀíÆ÷£¬²¢ÇÒ×Ô¶¯×¢²áÈÝÆ÷ºó´¦ÀíÆ÷¡£µ«ÈôʹÓÃ`BeanFactory`×÷ΪSpringÈÝÆ÷£¬Ôò±ØÐëÊÖ¶¯µ÷ÓøÃÈÝÆ÷ºó´¦ÀíÆ÷À´´¦Àí`BeanFactory`ÈÝÆ÷¡£ +类似于`BeanPostProcessor`,`ApplicationContext`å�¯è‡ªåŠ¨æ£€æµ‹åˆ°å®¹å™¨ä¸­çš„å®¹å™¨å�Žå¤„ç�†å™¨ï¼Œå¹¶ä¸”自动注册容器å�Žå¤„ç�†å™¨ã€‚但若使用`BeanFactory`作为Spring容器,则必须手动调用该容器å�Žå¤„ç�†å™¨æ�¥å¤„ç�†`BeanFactory`容器。 -## SpringµÄ"ÁãÅäÖÃ"Ö§³Ö +## Springçš„"é›¶é…�ç½®"支æŒ� -### ËÑË÷BeanÀà +### æ�œç´¢Beanç±» -SpringÌṩÈçϼ¸¸öAnnotationÀ´±ê×¢Spring Bean£º +Springæ��供如下几个Annotationæ�¥æ ‡æ³¨Spring Bean: -* `@Component`: ±ê×¢Ò»¸öÆÕͨµÄSpring BeanÀà -* `@Controller`: ±ê×¢Ò»¸ö¿ØÖÆÆ÷×é¼þÀà -* `@Service`: ±ê×¢Ò»¸öÒµÎñÂß¼­×é¼þÀà -* `@Repository`: ±ê×¢Ò»¸öDAO×é¼þÀà +* `@Component`: 标注一个普通的Spring Beanç±» +* `@Controller`: 标注一个控制器组件类 +* `@Service`: 标注一个业务逻辑组件类 +* `@Repository`: 标注一个DAO组件类 -ÔÚSpringÅäÖÃÎļþÖÐ×öÈçÏÂÅäÖã¬Ö¸¶¨×Ô¶¯É¨ÃèµÄ°ü£º +在Springé…�置文件中å�šå¦‚下é…�置,指定自动扫æ��的包: -### ʹÓÃ@ResourceÅäÖÃÒÀÀµ +### 使用@Resourceé…�ç½®ä¾�èµ– -`@Resource`λÓÚ`javax.annotation`°üÏ£¬ÊÇÀ´×ÔJavaEE¹æ·¶µÄÒ»¸ö`Annotation`£¬SpringÖ±½Ó½è¼øÁ˸Ã`Annotation`£¬Í¨¹ýʹÓøÃ`Annotation`ΪĿ±êBeanÖ¸¶¨Ð­×÷ÕßBean¡£Ê¹ÓÃ`@Resource`Óë``ÔªËØµÄrefÊôÐÔÓÐÏàͬµÄЧ¹û¡£ -`@Resource`²»½ö¿ÉÒÔÐÞÊÎsetter·½·¨£¬Ò²¿ÉÒÔÖ±½ÓÐÞÊÎʵÀý±äÁ¿£¬Èç¹ûʹÓÃ`@Resource`ÐÞÊÎʵÀý±äÁ¿½«»á¸ü¼Ó¼òµ¥£¬´ËʱSpring½«»áÖ±½ÓʹÓÃJavaEE¹æ·¶µÄField×¢È룬´ËʱÁ¬setter·½·¨¶¼¿ÉÒÔ²»Òª¡£ +`@Resource`ä½�于`javax.annotation`包下,是æ�¥è‡ªJavaEE规范的一个`Annotation`,Spring直接借鉴了该`Annotation`,通过使用该`Annotation`为目标Bean指定å��作者Bean。使用`@Resource`与``元素的ref属性有相å�Œçš„æ•ˆæžœã€‚ +`@Resource`ä¸�ä»…å�¯ä»¥ä¿®é¥°setter方法,也å�¯ä»¥ç›´æŽ¥ä¿®é¥°å®žä¾‹å�˜é‡�,如果使用`@Resource`修饰实例å�˜é‡�将会更加简å�•,此时Spring将会直接使用JavaEE规范的Field注入,此时连setter方法都å�¯ä»¥ä¸�è¦�。 -### ʹÓÃ@PostConstructºÍ@PreDestroy¶¨ÖÆÉúÃüÖÜÆÚÐÐΪ +### 使用@PostConstructå’Œ@PreDestroy定制生命周期行为 -`@PostConstruct`ºÍ`@PreDestroy`ͬÑùλÓÚjavax.annotation°üÏ£¬Ò²ÊÇÀ´×ÔJavaEE¹æ·¶µÄÁ½¸öAnnotation£¬SpringÖ±½Ó½è¼øÁËËüÃÇ£¬ÓÃÓÚ¶¨ÖÆSpringÈÝÆ÷ÖÐBeanµÄÉúÃüÖÜÆÚÐÐΪ¡£ËüÃǶ¼ÓÃÓÚÐÞÊη½·¨£¬ÎÞÐëÈκÎÊôÐÔ¡£ÆäÖÐǰÕßÐÞÊεķ½·¨Ê±BeanµÄ³õʼ»¯·½·¨£»¶øºóÕßÐÞÊεķ½·¨Ê±BeanÏú»Ù֮ǰµÄ·½·¨¡£ +`@PostConstruct`å’Œ`@PreDestroy`å�Œæ ·ä½�于javax.annotation包下,也是æ�¥è‡ªJavaEE规范的两个Annotation,Spring直接借鉴了它们,用于定制Spring容器中Bean的生命周期行为。它们都用于修饰方法,无须任何属性。其中å‰�者修饰的方法时Beançš„åˆ�始化方法;而å�Žè€…修饰的方法时Bean销æ¯�之å‰�的方法。 -### Spring4.0ÔöÇ¿µÄ×Ô¶¯×°ÅäºÍ¾«È·×°Åä +### Spring4.0增强的自动装é…�和精确装é…� -SpringÌṩÁË`@Autowired`×¢½âÀ´Ö¸¶¨×Ô¶¯×°Å䣬`@Autowired`¿ÉÒÔÐÞÊÎsetter·½·¨¡¢ÆÕͨ·½·¨¡¢ÊµÀý±äÁ¿ºÍ¹¹ÔìÆ÷µÈ¡£µ±Ê¹ÓÃ`@Autowired`±ê×¢setter·½·¨Ê±£¬Ä¬ÈϲÉÓÃbyType×Ô¶¯×°Åä²ßÂÔ¡£ÔÚÕâÖÖ²ßÂÔÏ£¬·ûºÏ×Ô¶¯×°ÅäÀàÐ͵ĺòÑ¡BeanʵÀý³£³£Óжà¸ö£¬Õâ¸öʱºò¾Í¿ÉÄÜÒýÆðÒì³££¬ÎªÁËʵÏÖ¾«È·µÄ×Ô¶¯×°Å䣬SpringÌṩÁË`@Qualifier`×¢½â£¬Í¨¹ýʹÓÃ`@Qualifier`£¬ÔÊÐí¸ù¾ÝBeanµÄidÀ´Ö´ÐÐ×Ô¶¯×°Åä¡£ +Springæ��供了`@Autowired`注解æ�¥æŒ‡å®šè‡ªåŠ¨è£…é…�,`@Autowired`å�¯ä»¥ä¿®é¥°setter方法ã€�普通方法ã€�实例å�˜é‡�和构造器等。当使用`@Autowired`标注setter方法时,默认采用byType自动装é…�策略。在这ç§�策略下,符å�ˆè‡ªåŠ¨è£…é…�类型的候选Bean实例常常有多个,这个时候就å�¯èƒ½å¼•起异常,为了实现精确的自动装é…�,Springæ��供了`@Qualifier`注解,通过使用`@Qualifier`,å…�许根æ�®Beançš„idæ�¥æ‰§è¡Œè‡ªåŠ¨è£…é…�。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\225\260\346\215\256\345\272\223\347\232\204\350\256\277\351\227\256.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\225\260\346\215\256\345\272\223\347\232\204\350\256\277\351\227\256.md" index 69bfc96..d4aa807 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\225\260\346\215\256\345\272\223\347\232\204\350\256\277\351\227\256.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\225\260\346\215\256\345\272\223\347\232\204\350\256\277\351\227\256.md" @@ -1,13 +1,13 @@ -## ÅäÖÃÊý¾ÝÔ´ +## é…�置数æ�®æº� -### Spring ÅäÖÃÊý¾ÝÔ´ +### Spring é…�置数æ�®æº� -Spring ÅäÖÃÊý¾ÝÔ´ÓжàÖÖ·½Ê½£¬ÏÂÃæÒ»Ò»Áо٣º +Spring é…�置数æ�®æº�有多ç§�æ–¹å¼�,下é�¢ä¸€ä¸€åˆ—举: -#### [#](https://dunwu.github.io/spring-tutorial/pages/1b774c/#%E4%BD%BF%E7%94%A8-jndi-%E6%95%B0%E6%8D%AE%E6%BA%90)ʹÓà JNDI Êý¾ÝÔ´ +#### [#](https://dunwu.github.io/spring-tutorial/pages/1b774c/#%E4%BD%BF%E7%94%A8-jndi-%E6%95%B0%E6%8D%AE%E6%BA%90)使用 JNDI æ•°æ�®æº� -Èç¹û Spring Ó¦Óò¿ÊðÔÚÖ§³Ö JNDI µÄ WEB ·þÎñÆ÷ÉÏ£¨Èç WebSphere¡¢JBoss¡¢Tomcat µÈ£©£¬¾Í¿ÉÒÔʹÓà JNDI »ñÈ¡Êý¾ÝÔ´¡£ +如果 Spring 应用部署在支æŒ� JNDI çš„ WEB æœ�务器上(如 WebSphereã€�JBossã€�Tomcat 等),就å�¯ä»¥ä½¿ç”¨ JNDI 获å�–æ•°æ�®æº�。 @@ -20,12 +20,12 @@ Spring http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-3.2.xsd"> - + - + @@ -33,9 +33,9 @@ http://www.springframework.org/schema/jee/spring-jee-3.2.xsd"> -#### [#](https://dunwu.github.io/spring-tutorial/pages/1b774c/#%E4%BD%BF%E7%94%A8%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5%E6%B1%A0)ʹÓÃÊý¾Ý¿âÁ¬½Ó³Ø +#### [#](https://dunwu.github.io/spring-tutorial/pages/1b774c/#%E4%BD%BF%E7%94%A8%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5%E6%B1%A0)使用数æ�®åº“连接池 -Spring ±¾Éí²¢Ã»ÓÐÌṩÊý¾Ý¿âÁ¬½Ó³ØµÄʵÏÖ£¬ÐèÒª×ÔÐÐÑ¡ÔñºÏÊʵÄÊý¾Ý¿âÁ¬½Ó³Ø¡£ÏÂÃæÊÇÒ»¸öʹÓà [Druid (opens new window)](https://github.com/alibaba/druid)×÷ΪÊý¾Ý¿âÁ¬½Ó³ØµÄʾÀý£º +Spring 本身并没有æ��供数æ�®åº“连接池的实现,需è¦�自行选择å�ˆé€‚的数æ�®åº“连接池。下é�¢æ˜¯ä¸€ä¸ªä½¿ç”¨ [Druid (opens new window)](https://github.com/alibaba/druid)作为数æ�®åº“连接池的示例: @@ -47,36 +47,36 @@ Spring - + - + - + - + - + - + - + - + @@ -85,7 +85,7 @@ Spring -#### [#](https://dunwu.github.io/spring-tutorial/pages/1b774c/#%E5%9F%BA%E4%BA%8E-jdbc-%E9%A9%B1%E5%8A%A8%E7%9A%84%E6%95%B0%E6%8D%AE%E6%BA%90)»ùÓÚ JDBC Çý¶¯µÄÊý¾ÝÔ´ +#### [#](https://dunwu.github.io/spring-tutorial/pages/1b774c/#%E5%9F%BA%E4%BA%8E-jdbc-%E9%A9%B1%E5%8A%A8%E7%9A%84%E6%95%B0%E6%8D%AE%E6%BA%90)基于 JDBC 驱动的数æ�®æº� @@ -99,29 +99,29 @@ Spring ``` -#### ʹÓÃJDBC +#### 使用JDBC -×îºó¸üÐÂ: 2022/11/16 20:10 / ÔĶÁ: 946668 +最å�Žæ›´æ–°: 2022/11/16 20:10 / 阅读: 946668 * * * -ÎÒÃÇÔÚÇ°Ãæ½éÉÜ[JDBC±à³Ì](https://www.liaoxuefeng.com/wiki/1252599548343744/1255943820274272)ʱÒѾ­½²¹ý£¬Java³ÌÐòʹÓÃJDBC½Ó¿Ú·ÃÎʹØÏµÊý¾Ý¿âµÄʱºò£¬ÐèÒªÒÔϼ¸²½£º +我们在å‰�é�¢ä»‹ç»�[JDBC编程](https://www.liaoxuefeng.com/wiki/1252599548343744/1255943820274272)æ—¶å·²ç»�讲过,Java程åº�使用JDBC接å�£è®¿é—®å…³ç³»æ•°æ�®åº“的时候,需è¦�以下几步: -* ´´½¨È«¾Ö`DataSource`ʵÀý£¬±íʾÊý¾Ý¿âÁ¬½Ó³Ø£» -* ÔÚÐèÒª¶ÁдÊý¾Ý¿âµÄ·½·¨ÄÚ²¿£¬°´Èçϲ½Öè·ÃÎÊÊý¾Ý¿â£º - * ´ÓÈ«¾Ö`DataSource`ʵÀý»ñÈ¡`Connection`ʵÀý£» - * ͨ¹ý`Connection`ʵÀý´´½¨`PreparedStatement`ʵÀý£» - * Ö´ÐÐSQLÓï¾ä£¬Èç¹ûÊDzéѯ£¬Ôòͨ¹ý`ResultSet`¶ÁÈ¡½á¹û¼¯£¬Èç¹ûÊÇÐ޸ģ¬Ôò»ñµÃ`int`½á¹û¡£ +* 创建全局`DataSource`实例,表示数æ�®åº“连接池; +* 在需è¦�读写数æ�®åº“的方法内部,按如下步骤访问数æ�®åº“: + * 从全局`DataSource`实例获å�–`Connection`实例; + * 通过`Connection`实例创建`PreparedStatement`实例; + * 执行SQL语å�¥ï¼Œå¦‚果是查询,则通过`ResultSet`读å�–结果集,如果是修改,则获得`int`结果。 -ÕýÈ·±àдJDBC´úÂëµÄ¹Ø¼üÊÇʹÓÃ`try ... finally`ÊÍ·Å×ÊÔ´£¬Éæ¼°µ½ÊÂÎñµÄ´úÂëÐèÒªÕýÈ·Ìá½»»ò»Ø¹öÊÂÎñ¡£ +正确编写JDBC代ç �的关键是使用`try ... finally`释放资æº�,涉å�Šåˆ°äº‹åŠ¡çš„ä»£ç �需è¦�正确æ��交或回滚事务。 -ÔÚSpringʹÓÃJDBC£¬Ê×ÏÈÎÒÃÇͨ¹ýIoCÈÝÆ÷´´½¨²¢¹ÜÀíÒ»¸ö`DataSource`ʵÀý£¬È»ºó£¬SpringÌṩÁËÒ»¸ö`JdbcTemplate`£¬¿ÉÒÔ·½±ãµØÈÃÎÒÃDzÙ×÷JDBC£¬Òò´Ë£¬Í¨³£Çé¿öÏ£¬ÎÒÃÇ»áʵÀý»¯Ò»¸ö`JdbcTemplate`¡£¹ËÃû˼Ò壬Õâ¸öÀàÖ÷ҪʹÓÃÁË[Templateģʽ](https://www.liaoxuefeng.com/wiki/1252599548343744/1281319636041762)¡£ +在Spring使用JDBC,首先我们通过IoC容器创建并管ç�†ä¸€ä¸ª`DataSource`实例,然å�Žï¼ŒSpringæ��供了一个`JdbcTemplate`,å�¯ä»¥æ–¹ä¾¿åœ°è®©æˆ‘们æ“�作JDBC,因此,通常情况下,我们会实例化一个`JdbcTemplate`。顾å��æ€�义,这个类主è¦�使用了[Template模å¼�](https://www.liaoxuefeng.com/wiki/1252599548343744/1281319636041762)。 -±àдʾÀý´úÂë»òÕß²âÊÔ´úÂëʱ£¬ÎÒÃÇÇ¿ÁÒÍÆ¼öʹÓÃ[HSQLDB](http://hsqldb.org/)Õâ¸öÊý¾Ý¿â£¬ËüÊÇÒ»¸öÓÃJava±àдµÄ¹ØÏµÊý¾Ý¿â£¬¿ÉÒÔÒÔÄÚ´æÄ£Ê½»òÕßÎļþģʽÔËÐУ¬±¾ÉíÖ»ÓÐÒ»¸öjar°ü£¬·Ç³£ÊʺÏÑÝʾ´úÂë»òÕß²âÊÔ´úÂë¡£ +编写示例代ç �或者测试代ç �时,我们强烈推è��使用[HSQLDB](http://hsqldb.org/)这个数æ�®åº“,它是一个用Java编写的关系数æ�®åº“,å�¯ä»¥ä»¥å†…存模å¼�或者文件模å¼�è¿�行,本身å�ªæœ‰ä¸€ä¸ªjar包,é�žå¸¸é€‚å�ˆæ¼”示代ç �或者测试代ç �。 -ÎÒÃÇÒÔʵ¼Ê¹¤³ÌΪÀý£¬ÏÈ´´½¨Maven¹¤³Ì`spring-data-jdbc`£¬È»ºóÒýÈëÒÔÏÂÒÀÀµ£º +我们以实际工程为例,先创建Maven工程`spring-data-jdbc`,然å�Žå¼•入以下ä¾�赖: * org.springframework:spring-context:6.0.0 * org.springframework:spring-jdbc:6.0.0 @@ -129,7 +129,7 @@ Spring * com.zaxxer:HikariCP:5.0.1 * org.hsqldb:hsqldb:2.7.1 -ÔÚ`AppConfig`ÖУ¬ÎÒÃÇÐèÒª´´½¨ÒÔϼ¸¸ö±ØÐëµÄBean£º +在`AppConfig`中,我们需è¦�创建以下几个必须的Bean: ``` @Configuration @@ -166,26 +166,26 @@ public class AppConfig { ``` -ÔÚÉÏÊöÅäÖÃÖУº +在上述é…�置中: -1. ͨ¹ý`@PropertySource("jdbc.properties")`¶ÁÈ¡Êý¾Ý¿âÅäÖÃÎļþ£» -2. ͨ¹ý`@Value("${jdbc.url}")`×¢ÈëÅäÖÃÎļþµÄÏà¹ØÅäÖã» -3. ´´½¨Ò»¸öDataSourceʵÀý£¬ËüµÄʵ¼ÊÀàÐÍÊÇ`HikariDataSource`£¬´´½¨Ê±ÐèÒªÓõ½×¢ÈëµÄÅäÖã» -4. ´´½¨Ò»¸öJdbcTemplateʵÀý£¬ËüÐèҪעÈë`DataSource`£¬ÕâÊÇͨ¹ý·½·¨²ÎÊýÍê³É×¢ÈëµÄ¡£ +1. 通过`@PropertySource("jdbc.properties")`读å�–æ•°æ�®åº“é…�置文件; +2. 通过`@Value("${jdbc.url}")`注入é…�置文件的相关é…�置; +3. 创建一个DataSource实例,它的实际类型是`HikariDataSource`,创建时需è¦�用到注入的é…�置; +4. 创建一个JdbcTemplate实例,它需è¦�注入`DataSource`,这是通过方法å�‚数完æˆ�注入的。 -×îºó£¬Õë¶ÔHSQLDBдһ¸öÅäÖÃÎļþ`jdbc.properties`£º +最å�Žï¼Œé’ˆå¯¹HSQLDB写一个é…�置文件`jdbc.properties`: ``` -# Êý¾Ý¿âÎļþÃûΪtestdb: +# æ•°æ�®åº“文件å��为testdb: jdbc.url=jdbc:hsqldb:file:testdb -# HsqldbĬÈϵÄÓû§ÃûÊÇsa£¬¿ÚÁîÊÇ¿Õ×Ö·û´®: +# Hsqldb默认的用户å��是sa,å�£ä»¤æ˜¯ç©ºå­—符串: jdbc.username=sa jdbc.password= ``` -¿ÉÒÔͨ¹ýHSQLDB×Ô´øµÄ¹¤¾ßÀ´³õʼ»¯Êý¾Ý¿â±í£¬ÕâÀïÎÒÃÇдһ¸öBean£¬ÔÚSpringÈÝÆ÷Æô¶¯Ê±×Ô¶¯´´½¨Ò»¸ö`users`±í£º +å�¯ä»¥é€šè¿‡HSQLDB自带的工具æ�¥åˆ�始化数æ�®åº“表,这里我们写一个Bean,在Spring容器å�¯åŠ¨æ—¶è‡ªåŠ¨åˆ›å»ºä¸€ä¸ª`users`表: ``` @Component @@ -206,7 +206,7 @@ public class DatabaseInitializer { ``` -ÏÖÔÚ£¬ËùÓÐ×¼±¸¹¤×÷¶¼ÒÑÍê±Ï¡£ÎÒÃÇÖ»ÐèÒªÔÚÐèÒª·ÃÎÊÊý¾Ý¿âµÄBeanÖУ¬×¢Èë`JdbcTemplate`¼´¿É£º +现在,所有准备工作都已完毕。我们å�ªéœ€è¦�在需è¦�访问数æ�®åº“çš„Bean中,注入`JdbcTemplate`å�³å�¯ï¼š ``` @Component @@ -218,20 +218,20 @@ public class UserService { ``` -### JdbcTemplateÓ÷¨ +### JdbcTemplate用法 -SpringÌṩµÄ`JdbcTemplate`²ÉÓÃTemplateģʽ£¬ÌṩÁËһϵÁÐÒԻص÷ÎªÌØµãµÄ¹¤¾ß·½·¨£¬Ä¿µÄÊDZÜÃâ·±ËöµÄ`try...catch`Óï¾ä¡£ +Springæ��供的`JdbcTemplate`采用Template模å¼�,æ��供了一系列以回调为特点的工具方法,目的是é�¿å…�ç¹�ç��çš„`try...catch`语å�¥ã€‚ -ÎÒÃÇÒÔ¾ßÌåµÄʾÀýÀ´ËµÃ÷JdbcTemplateµÄÓ÷¨¡£ +我们以具体的示例æ�¥è¯´æ˜ŽJdbcTemplate的用法。 -Ê×ÏÈÎÒÃÇ¿´`T execute(ConnectionCallback action)`·½·¨£¬ËüÌṩÁËJdbcµÄ`Connection`¹©ÎÒÃÇʹÓ㺠+首先我们看`T execute(ConnectionCallback action)`方法,它æ��供了Jdbcçš„`Connection`供我们使用: ``` public User getUserById(long id) { - // ×¢Òâ´«ÈëµÄÊÇConnectionCallback: + // 注æ„�传入的是ConnectionCallback: return jdbcTemplate.execute((Connection conn) -> { - // ¿ÉÒÔÖ±½ÓʹÓÃconnʵÀý£¬²»ÒªÊÍ·ÅËü£¬»Øµ÷½áÊøºóJdbcTemplate×Ô¶¯ÊÍ·Å: - // ÔÚÄÚ²¿ÊÖ¶¯´´½¨µÄPreparedStatement¡¢ResultSet±ØÐëÓÃtry(...)ÊÍ·Å: + // å�¯ä»¥ç›´æŽ¥ä½¿ç”¨conn实例,ä¸�è¦�释放它,回调结æ�Ÿå�ŽJdbcTemplate自动释放: + // 在内部手动创建的PreparedStatementã€�ResultSet必须用try(...)释放: try (var ps = conn.prepareStatement("SELECT * FROM users WHERE id = ?")) { ps.setObject(1, id); try (var rs = ps.executeQuery()) { @@ -250,15 +250,15 @@ public User getUserById(long id) { ``` -Ò²¾ÍÊÇ˵£¬ÉÏÊö»Øµ÷·½·¨ÔÊÐí»ñÈ¡Connection£¬È»ºó×öÈκλùÓÚConnectionµÄ²Ù×÷¡£ +也就是说,上述回调方法å…�许获å�–Connection,然å�Žå�šä»»ä½•基于Connectionçš„æ“�作。 -ÎÒÃÇÔÙ¿´`T execute(String sql, PreparedStatementCallback action)`µÄÓ÷¨£º +我们å†�看`T execute(String sql, PreparedStatementCallback action)`的用法: ``` public User getUserByName(String name) { - // ÐèÒª´«ÈëSQLÓï¾ä£¬ÒÔ¼°PreparedStatementCallback: + // 需è¦�ä¼ å…¥SQL语å�¥ï¼Œä»¥å�ŠPreparedStatementCallback: return jdbcTemplate.execute("SELECT * FROM users WHERE name = ?", (PreparedStatement ps) -> { - // PreparedStatementʵÀýÒѾ­ÓÉJdbcTemplate´´½¨£¬²¢Ôڻص÷ºó×Ô¶¯ÊÍ·Å: + // PreparedStatement实例已ç»�ç”±JdbcTemplate创建,并在回调å�Žè‡ªåŠ¨é‡Šæ”¾: ps.setObject(1, name); try (var rs = ps.executeQuery()) { if (rs.next()) { @@ -275,14 +275,14 @@ public User getUserByName(String name) { ``` -×îºó£¬ÎÒÃÇ¿´`T queryForObject(String sql, RowMapper rowMapper, Object... args)`·½·¨£º +最å�Žï¼Œæˆ‘们看`T queryForObject(String sql, RowMapper rowMapper, Object... args)`方法: ``` public User getUserByEmail(String email) { - // ´«ÈëSQL£¬²ÎÊýºÍRowMapperʵÀý: + // ä¼ å…¥SQL,å�‚æ•°å’ŒRowMapper实例: return jdbcTemplate.queryForObject("SELECT * FROM users WHERE email = ?", (ResultSet rs, int rowNum) -> { - // ½«ResultSetµÄµ±Ç°ÐÐÓ³ÉäΪһ¸öJavaBean: + // å°†ResultSet的当å‰�行映射为一个JavaBean: return new User( // new User object: rs.getLong("id"), // id rs.getString("email"), // email @@ -294,21 +294,21 @@ public User getUserByEmail(String email) { ``` -ÔÚ`queryForObject()`·½·¨ÖУ¬´«ÈëSQLÒÔ¼°SQL²ÎÊýºó£¬`JdbcTemplate`»á×Ô¶¯´´½¨`PreparedStatement`£¬×Ô¶¯Ö´Ðвéѯ²¢·µ»Ø`ResultSet`£¬ÎÒÃÇÌṩµÄ`RowMapper`ÐèÒª×öµÄÊÂÇé¾ÍÊǰÑ`ResultSet`µÄµ±Ç°ÐÐÓ³Éä³ÉÒ»¸öJavaBean²¢·µ»Ø¡£Õû¸ö¹ý³ÌÖУ¬Ê¹ÓÃ`Connection`¡¢`PreparedStatement`ºÍ`ResultSet`¶¼²»ÐèÒªÎÒÃÇÊÖ¶¯¹ÜÀí¡£ +在`queryForObject()`方法中,传入SQL以å�ŠSQLå�‚æ•°å�Žï¼Œ`JdbcTemplate`会自动创建`PreparedStatement`,自动执行查询并返回`ResultSet`,我们æ��供的`RowMapper`需è¦�å�šçš„事情就是把`ResultSet`的当å‰�行映射æˆ�一个JavaBean并返回。整个过程中,使用`Connection`ã€�`PreparedStatement`å’Œ`ResultSet`都ä¸�需è¦�我们手动管ç�†ã€‚ -`RowMapper`²»Ò»¶¨·µ»ØJavaBean£¬Êµ¼ÊÉÏËü¿ÉÒÔ·µ»ØÈκÎJava¶ÔÏó¡£ÀýÈ磬ʹÓÃ`SELECT COUNT(*)`²éѯʱ£¬¿ÉÒÔ·µ»Ø`Long`£º +`RowMapper`ä¸�一定返回JavaBean,实际上它å�¯ä»¥è¿”回任何Java对象。例如,使用`SELECT COUNT(*)`查询时,å�¯ä»¥è¿”回`Long`: ``` public long getUsers() { return jdbcTemplate.queryForObject("SELECT COUNT(*) FROM users", (ResultSet rs, int rowNum) -> { - // SELECT COUNT(*)²éѯֻÓÐÒ»ÁУ¬È¡µÚÒ»ÁÐÊý¾Ý: + // SELECT COUNT(*)查询å�ªæœ‰ä¸€åˆ—,å�–第一列数æ�®: return rs.getLong(1); }); } ``` -Èç¹ûÎÒÃÇÆÚÍû·µ»Ø¶àÐмǼ£¬¶ø²»ÊÇÒ»ÐУ¬¿ÉÒÔÓÃ`query()`·½·¨£º +如果我们期望返回多行记录,而ä¸�是一行,å�¯ä»¥ç”¨`query()`方法: ``` public List getUsers(int pageIndex) { @@ -321,13 +321,13 @@ public List getUsers(int pageIndex) { ``` -ÉÏÊö`query()`·½·¨´«ÈëµÄ²ÎÊýÈÔÈ»ÊÇSQL¡¢SQL²ÎÊýÒÔ¼°`RowMapper`ʵÀý¡£ÕâÀïÎÒÃÇÖ±½ÓʹÓÃSpringÌṩµÄ`BeanPropertyRowMapper`¡£Èç¹ûÊý¾Ý¿â±íµÄ½á¹¹Ç¡ºÃºÍJavaBeanµÄÊôÐÔÃû³ÆÒ»Ö£¬ÄÇô`BeanPropertyRowMapper`¾Í¿ÉÒÔÖ±½Ó°ÑÒ»ÐмǼ°´ÁÐÃûת»»ÎªJavaBean¡£ +上述`query()`方法传入的å�‚æ•°ä»�然是SQLã€�SQLå�‚数以å�Š`RowMapper`实例。这里我们直接使用Springæ��供的`BeanPropertyRowMapper`。如果数æ�®åº“表的结构æ�°å¥½å’ŒJavaBean的属性å��称一致,那么`BeanPropertyRowMapper`å°±å�¯ä»¥ç›´æŽ¥æŠŠä¸€è¡Œè®°å½•按列å��转æ�¢ä¸ºJavaBean。 -Èç¹ûÎÒÃÇÖ´ÐеIJ»ÊDzéѯ£¬¶øÊDzåÈë¡¢¸üкÍɾ³ý²Ù×÷£¬ÄÇôÐèҪʹÓÃ`update()`·½·¨£º +如果我们执行的ä¸�是查询,而是æ�’å…¥ã€�更新和删除æ“�作,那么需è¦�使用`update()`方法: ``` public void updateUser(User user) { - // ´«ÈëSQL£¬SQL²ÎÊý£¬·µ»Ø¸üеÄÐÐÊý: + // ä¼ å…¥SQL,SQLå�‚数,返回更新的行数: if (1 != jdbcTemplate.update("UPDATE users SET name = ? WHERE id = ?", user.getName(), user.getId())) { throw new RuntimeException("User not found by id"); } @@ -335,16 +335,16 @@ public void updateUser(User user) { ``` -Ö»ÓÐÒ»ÖÖ`INSERT`²Ù×÷±È½ÏÌØÊ⣬ÄǾÍÊÇÈç¹ûijһÁÐÊÇ×ÔÔöÁУ¨ÀýÈç×ÔÔöÖ÷¼ü£©£¬Í¨³££¬ÎÒÃÇÐèÒª»ñÈ¡²åÈëºóµÄ×ÔÔöÖµ¡£`JdbcTemplate`ÌṩÁËÒ»¸ö`KeyHolder`À´¼ò»¯ÕâÒ»²Ù×÷£º +å�ªæœ‰ä¸€ç§�`INSERT`æ“�作比较特殊,那就是如果æŸ�一列是自增列(例如自增主键),通常,我们需è¦�获å�–æ�’å…¥å�Žçš„自增值。`JdbcTemplate`æ��供了一个`KeyHolder`æ�¥ç®€åŒ–这一æ“�作: ``` public User register(String email, String password, String name) { - // ´´½¨Ò»¸öKeyHolder: + // 创建一个KeyHolder: KeyHolder holder = new GeneratedKeyHolder(); if (1 != jdbcTemplate.update( - // ²ÎÊý1:PreparedStatementCreator + // å�‚æ•°1:PreparedStatementCreator (conn) -> { - // ´´½¨PreparedStatementʱ£¬±ØÐëÖ¸¶¨RETURN_GENERATED_KEYS: + // 创建PreparedStatement时,必须指定RETURN_GENERATED_KEYS: var ps = conn.prepareStatement("INSERT INTO users(email, password, name) VALUES(?, ?, ?)", Statement.RETURN_GENERATED_KEYS); ps.setObject(1, email); @@ -352,42 +352,42 @@ public User register(String email, String password, String name) { ps.setObject(3, name); return ps; }, - // ²ÎÊý2:KeyHolder + // å�‚æ•°2:KeyHolder holder) ) { throw new RuntimeException("Insert failed."); } - // ´ÓKeyHolderÖлñÈ¡·µ»ØµÄ×ÔÔöÖµ: + // 从KeyHolder中获å�–返回的自增值: return new User(holder.getKey().longValue(), email, password, name); } ``` -`JdbcTemplate`»¹ÓÐÐí¶àÖØÔØ·½·¨£¬ÕâÀïÎÒÃDz»Ò»Ò»½éÉÜ¡£ÐèҪǿµ÷µÄÊÇ£¬`JdbcTemplate`Ö»ÊǶÔJDBC²Ù×÷µÄÒ»¸ö¼òµ¥·â×°£¬ËüµÄÄ¿µÄÊǾ¡Á¿¼õÉÙÊÖ¶¯±àд`try(resource) {...}`µÄ´úÂ룬¶ÔÓÚ²éѯ£¬Ö÷Ҫͨ¹ý`RowMapper`ʵÏÖÁËJDBC½á¹û¼¯µ½Java¶ÔÏóµÄת»»¡£ +`JdbcTemplate`还有许多é‡�载方法,这里我们ä¸�一一介ç»�。需è¦�强调的是,`JdbcTemplate`å�ªæ˜¯å¯¹JDBCæ“�作的一个简å�•å°�装,它的目的是尽é‡�å‡�少手动编写`try(resource) {...}`的代ç �,对于查询,主è¦�通过`RowMapper`实现了JDBC结果集到Java对象的转æ�¢ã€‚ -ÎÒÃÇ×ܽáÒ»ÏÂ`JdbcTemplate`µÄÓ÷¨£¬ÄǾÍÊÇ£º +我们总结一下`JdbcTemplate`的用法,那就是: -* Õë¶Ô¼òµ¥²éѯ£¬ÓÅÑ¡`query()`ºÍ`queryForObject()`£¬ÒòΪֻÐèÌṩSQLÓï¾ä¡¢²ÎÊýºÍ`RowMapper`£» -* Õë¶Ô¸üвÙ×÷£¬ÓÅÑ¡`update()`£¬ÒòΪֻÐèÌṩSQLÓï¾äºÍ²ÎÊý£» -* Èκθ´ÔӵIJÙ×÷£¬×îÖÕÒ²¿ÉÒÔͨ¹ý`execute(ConnectionCallback)`ʵÏÖ£¬ÒòΪÄõ½`Connection`¾Í¿ÉÒÔ×öÈκÎJDBC²Ù×÷¡£ +* 针对简å�•查询,优选`query()`å’Œ`queryForObject()`,因为å�ªéœ€æ��ä¾›SQL语å�¥ã€�å�‚æ•°å’Œ`RowMapper`ï¼› +* 针对更新æ“�作,优选`update()`,因为å�ªéœ€æ��ä¾›SQL语å�¥å’Œå�‚æ•°ï¼› +* 任何å¤�æ�‚çš„æ“�作,最终也å�¯ä»¥é€šè¿‡`execute(ConnectionCallback)`实现,因为拿到`Connection`å°±å�¯ä»¥å�šä»»ä½•JDBCæ“�作。 -ʵ¼ÊÉÏÎÒÃÇʹÓÃ×î¶àµÄÈÔÈ»ÊǸ÷ÖÖ²éѯ¡£Èç¹ûÔÚÉè¼Æ±í½á¹¹µÄʱºò£¬Äܹ»ºÍJavaBeanµÄÊôÐÔÒ»Ò»¶ÔÓ¦£¬ÄÇôֱ½ÓʹÓÃ`BeanPropertyRowMapper`¾ÍºÜ·½±ã¡£Èç¹û±í½á¹¹ºÍJavaBean²»Ò»ÖÂÔõô°ì£¿ÄǾÍÐèÒªÉÔ΢¸Äдһϲéѯ£¬Ê¹½á¹û¼¯µÄ½á¹¹ºÍJavaBean±£³ÖÒ»Ö¡£ +实际上我们使用最多的ä»�然是å�„ç§�查询。如果在设计表结构的时候,能够和JavaBean的属性一一对应,那么直接使用`BeanPropertyRowMapper`就很方便。如果表结构和JavaBeanä¸�一致怎么办?那就需è¦�ç¨�微改写一下查询,使结果集的结构和JavaBeanä¿�æŒ�一致。 -ÀýÈ磬±íµÄÁÐÃûÊÇ`office_address`£¬¶øJavaBeanÊôÐÔÊÇ`workAddress`£¬¾ÍÐèÒªÖ¸¶¨±ðÃû£¬¸Äд²éѯÈçÏ£º +例如,表的列å��是`office_address`,而JavaBean属性是`workAddress`,就需è¦�指定别å��,改写查询如下: ``` SELECT id, email, office_address AS workAddress, name FROM users WHERE email = ? ``` -ʹÓÃ`JdbcTemplate`µÄʱºò£¬ÎÒÃÇÓõÃ×î¶àµÄ·½·¨¾ÍÊÇ`List query(String, RowMapper, Object...)`¡£Õâ¸ö`RowMapper`µÄ×÷ÓþÍÊǰÑ`ResultSet`µÄÒ»ÐмǼӳÉäΪJava Bean¡£ +使用`JdbcTemplate`的时候,我们用得最多的方法就是`List query(String, RowMapper, Object...)`。这个`RowMapper`的作用就是把`ResultSet`的一行记录映射为Java Bean。 -ÕâÖְѹØÏµÊý¾Ý¿âµÄ±í¼Ç¼ӳÉäΪJava¶ÔÏóµÄ¹ý³Ì¾ÍÊÇORM£ºObject-Relational Mapping¡£ORM¼È¿ÉÒ԰ѼǼת»»³ÉJava¶ÔÏó£¬Ò²¿ÉÒÔ°ÑJava¶ÔÏóת»»ÎªÐмǼ¡£ +è¿™ç§�把关系数æ�®åº“的表记录映射为Java对象的过程就是ORM:Object-Relational Mapping。ORMæ—¢å�¯ä»¥æŠŠè®°å½•转æ�¢æˆ�Java对象,也å�¯ä»¥æŠŠJava对象转æ�¢ä¸ºè¡Œè®°å½•。 -ʹÓÃ`JdbcTemplate`ÅäºÏ`RowMapper`¿ÉÒÔ¿´×÷ÊÇ×îԭʼµÄORM¡£Èç¹ûҪʵÏÖ¸ü×Ô¶¯»¯µÄORM£¬¿ÉÒÔÑ¡Ôñ³ÉÊìµÄORM¿ò¼Ü£¬ÀýÈç[Hibernate](https://hibernate.org/)¡£ +使用`JdbcTemplate`é…�å�ˆ`RowMapper`å�¯ä»¥çœ‹ä½œæ˜¯æœ€åŽŸå§‹çš„ORM。如果è¦�实现更自动化的ORM,å�¯ä»¥é€‰æ‹©æˆ�熟的ORM框架,例如[Hibernate](https://hibernate.org/)。 -ÎÒÃÇÀ´¿´¿´ÈçºÎÔÚSpringÖм¯³ÉHibernate¡£ +我们æ�¥çœ‹çœ‹å¦‚何在Spring中集æˆ�Hibernate。 -Hibernate×÷ΪORM¿ò¼Ü£¬Ëü¿ÉÒÔÌæ´ú`JdbcTemplate`£¬µ«HibernateÈÔÈ»ÐèÒªJDBCÇý¶¯£¬ËùÒÔ£¬ÎÒÃÇÐèÒªÒýÈëJDBCÇý¶¯¡¢Á¬½Ó³Ø£¬ÒÔ¼°Hibernate±¾Éí¡£ÔÚMavenÖУ¬ÎÒÃǼÓÈëÒÔÏÂÒÀÀµÏ +Hibernate作为ORM框架,它å�¯ä»¥æ›¿ä»£`JdbcTemplate`,但Hibernateä»�然需è¦�JDBC驱动,所以,我们需è¦�引入JDBC驱动ã€�连接池,以å�ŠHibernate本身。在Maven中,我们加入以下ä¾�赖项: * org.springframework:spring-context:6.0.0 * org.springframework:spring-orm:6.0.0 @@ -397,7 +397,7 @@ Hibernate * com.zaxxer:HikariCP:5.0.1 * org.hsqldb:hsqldb:2.7.1 -ÔÚ`AppConfig`ÖУ¬ÎÒÃÇÈÔÈ»ÐèÒª´´½¨`DataSource`¡¢ÒýÈëJDBCÅäÖÃÎļþ£¬ÒÔ¼°ÆôÓÃÉùÃ÷ʽÊÂÎñ£º +在`AppConfig`中,我们ä»�然需è¦�创建`DataSource`ã€�引入JDBCé…�置文件,以å�Šå�¯ç”¨å£°æ˜Žå¼�事务: ``` @Configuration @@ -413,19 +413,19 @@ public class AppConfig { ``` -ΪÁËÆôÓÃHibernate£¬ÎÒÃÇÐèÒª´´½¨Ò»¸ö`LocalSessionFactoryBean`£º +为了å�¯ç”¨Hibernate,我们需è¦�创建一个`LocalSessionFactoryBean`: ``` public class AppConfig { @Bean LocalSessionFactoryBean createSessionFactory(@Autowired DataSource dataSource) { var props = new Properties(); - props.setProperty("hibernate.hbm2ddl.auto", "update"); // Éú²ú»·¾³²»ÒªÊ¹Óà + props.setProperty("hibernate.hbm2ddl.auto", "update"); // 生产环境ä¸�è¦�使用 props.setProperty("hibernate.dialect", "org.hibernate.dialect.HSQLDialect"); props.setProperty("hibernate.show_sql", "true"); var sessionFactoryBean = new LocalSessionFactoryBean(); sessionFactoryBean.setDataSource(dataSource); - // ɨÃèÖ¸¶¨µÄpackage»ñÈ¡ËùÓÐentity class: + // 扫æ��指定的package获å�–所有entity class: sessionFactoryBean.setPackagesToScan("com.itranswarp.learnjava.entity"); sessionFactoryBean.setHibernateProperties(props); return sessionFactoryBean; @@ -434,17 +434,17 @@ public class AppConfig { ``` -×¢ÒâÎÒÃÇÔÚ[¶¨ÖÆBean](https://www.liaoxuefeng.com/wiki/1252599548343744/1308043627200545)Öн²µ½¹ý`FactoryBean`£¬`LocalSessionFactoryBean`ÊÇÒ»¸ö`FactoryBean`£¬Ëü»áÔÙ×Ô¶¯´´½¨Ò»¸ö`SessionFactory`£¬ÔÚHibernateÖУ¬`Session`ÊÇ·â×°ÁËÒ»¸öJDBC `Connection`µÄʵÀý£¬¶ø`SessionFactory`ÊÇ·â×°ÁËJDBC `DataSource`µÄʵÀý£¬¼´`SessionFactory`³ÖÓÐÁ¬½Ó³Ø£¬Ã¿´ÎÐèÒª²Ù×÷Êý¾Ý¿âµÄʱºò£¬`SessionFactory`´´½¨Ò»¸öеÄ`Session`£¬Ï൱ÓÚ´ÓÁ¬½Ó³Ø»ñÈ¡µ½Ò»¸öеÄ`Connection`¡£`SessionFactory`¾ÍÊÇHibernateÌṩµÄ×îºËÐĵÄÒ»¸ö¶ÔÏ󣬵«`LocalSessionFactoryBean`ÊÇSpringÌṩµÄΪÁËÈÃÎÒÃÇ·½±ã´´½¨`SessionFactory`µÄÀà¡£ +注æ„�我们在[定制Bean](https://www.liaoxuefeng.com/wiki/1252599548343744/1308043627200545)中讲到过`FactoryBean`,`LocalSessionFactoryBean`是一个`FactoryBean`,它会å†�自动创建一个`SessionFactory`,在Hibernate中,`Session`是å°�装了一个JDBC `Connection`的实例,而`SessionFactory`是å°�装了JDBC `DataSource`的实例,å�³`SessionFactory`æŒ�有连接池,æ¯�次需è¦�æ“�作数æ�®åº“的时候,`SessionFactory`创建一个新的`Session`,相当于从连接池获å�–到一个新的`Connection`。`SessionFactory`就是Hibernateæ��供的最核心的一个对象,但`LocalSessionFactoryBean`是Springæ��供的为了让我们方便创建`SessionFactory`的类。 -×¢Òâµ½ÉÏÃæ´´½¨`LocalSessionFactoryBean`µÄ´úÂ룬Ê×ÏÈÓÃ`Properties`³ÖÓÐHibernate³õʼ»¯`SessionFactory`ʱÓõ½µÄËùÓÐÉèÖ㬳£ÓõÄÉèÖÃÇë²Î¿¼[HibernateÎĵµ](https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#configurations)£¬ÕâÀïÎÒÃÇÖ»¶¨ÒåÁË3¸öÉèÖ㺠+注æ„�到上é�¢åˆ›å»º`LocalSessionFactoryBean`的代ç �,首先用`Properties`æŒ�有Hibernateåˆ�始化`SessionFactory`时用到的所有设置,常用的设置请å�‚考[Hibernate文档](https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#configurations),这里我们å�ªå®šä¹‰äº†3个设置: -* `hibernate.hbm2ddl.auto=update`£º±íʾ×Ô¶¯´´½¨Êý¾Ý¿âµÄ±í½á¹¹£¬×¢Òâ²»ÒªÔÚÉú²ú»·¾³ÖÐÆôÓã» -* `hibernate.dialect=org.hibernate.dialect.HSQLDialect`£ºÖ¸Ê¾HibernateʹÓõÄÊý¾Ý¿âÊÇHSQLDB¡£HibernateʹÓÃÒ»ÖÖHQLµÄ²éѯÓï¾ä£¬ËüºÍSQLÀàËÆ£¬µ«ÕæÕýÔÚ¡°·­Ò롱³ÉSQLʱ£¬»á¸ù¾ÝÉ趨µÄÊý¾Ý¿â¡°·½ÑÔ¡±À´Éú³ÉÕë¶ÔÊý¾Ý¿âÓÅ»¯µÄSQL£» -* `hibernate.show_sql=true`£ºÈÃHibernate´òÓ¡Ö´ÐеÄSQL£¬Õâ¶ÔÓÚµ÷ÊԷdz£ÓÐÓã¬ÎÒÃÇ¿ÉÒÔ·½±ãµØ¿´µ½HibernateÉú³ÉµÄSQLÓï¾äÊÇ·ñ·ûºÏÎÒÃǵÄÔ¤ÆÚ¡£ +* `hibernate.hbm2ddl.auto=update`:表示自动创建数æ�®åº“的表结构,注æ„�ä¸�è¦�在生产环境中å�¯ç”¨ï¼› +* `hibernate.dialect=org.hibernate.dialect.HSQLDialect`:指示Hibernate使用的数æ�®åº“是HSQLDB。Hibernate使用一ç§�HQL的查询语å�¥ï¼Œå®ƒå’ŒSQL类似,但真正在“翻译â€�æˆ�SQL时,会根æ�®è®¾å®šçš„æ•°æ�®åº““方言â€�æ�¥ç”Ÿæˆ�针对数æ�®åº“优化的SQLï¼› +* `hibernate.show_sql=true`:让Hibernate打å�°æ‰§è¡Œçš„SQL,这对于调试é�žå¸¸æœ‰ç”¨ï¼Œæˆ‘们å�¯ä»¥æ–¹ä¾¿åœ°çœ‹åˆ°Hibernate生æˆ�çš„SQL语å�¥æ˜¯å�¦ç¬¦å�ˆæˆ‘们的预期。 -³ýÁËÉèÖÃ`DataSource`ºÍ`Properties`Ö®Í⣬עÒâµ½`setPackagesToScan()`ÎÒÃÇ´«ÈëÁËÒ»¸ö`package`Ãû³Æ£¬ËüָʾHibernateɨÃèÕâ¸ö°üÏÂÃæµÄËùÓÐJavaÀ࣬×Ô¶¯ÕÒ³öÄÜÓ³ÉäΪÊý¾Ý¿â±í¼Ç¼µÄJavaBean¡£ºóÃæÎÒÃÇ»á×ÐϸÌÖÂÛÈçºÎ±àд·ûºÏHibernateÒªÇóµÄJavaBean¡£ +除了设置`DataSource`å’Œ`Properties`之外,注æ„�到`setPackagesToScan()`我们传入了一个`package`å��称,它指示Hibernate扫æ��这个包下é�¢çš„æ‰€æœ‰Java类,自动找出能映射为数æ�®åº“表记录的JavaBean。å�Žé�¢æˆ‘们会仔细讨论如何编写符å�ˆHibernateè¦�求的JavaBean。 -½ô½Ó×Å£¬ÎÒÃÇ»¹ÐèÒª´´½¨`HibernateTransactionManager`£º +紧接ç�€ï¼Œæˆ‘们还需è¦�创建`HibernateTransactionManager`: ``` public class AppConfig { @@ -456,9 +456,9 @@ public class AppConfig { ``` -`HibernateTransactionManager`ÊÇÅäºÏHibernateʹÓÃÉùÃ÷ʽÊÂÎñËù±ØÐëµÄ¡£µ½´ËΪֹ£¬ËùÓеÄÅäÖö¼¶¨ÒåÍê±Ï£¬ÎÒÃÇÀ´¿´¿´ÈçºÎ½«Êý¾Ý¿â±í½á¹¹Ó³ÉäΪJava¶ÔÏó¡£ +`HibernateTransactionManager`是é…�å�ˆHibernate使用声明å¼�事务所必须的。到此为止,所有的é…�置都定义完毕,我们æ�¥çœ‹çœ‹å¦‚何将数æ�®åº“表结构映射为Java对象。 -¿¼²ìÈçϵÄÊý¾Ý¿â±í£º +考察如下的数æ�®åº“表: ``` CREATE TABLE user @@ -473,7 +473,7 @@ CREATE TABLE user ``` -ÆäÖУ¬`id`ÊÇ×ÔÔöÖ÷¼ü£¬`email`¡¢`password`¡¢`name`ÊÇ`VARCHAR`ÀàÐÍ£¬`email`´øÎ¨Ò»Ë÷ÒýÒÔÈ·±£Î¨Ò»ÐÔ£¬`createdAt`´æ´¢ÕûÐÍÀàÐ͵Äʱ¼ä´Á¡£ÓÃJavaBean±íʾÈçÏ£º +其中,`id`是自增主键,`email`ã€�`password`ã€�`name`是`VARCHAR`类型,`email`带唯一索引以确ä¿�唯一性,`createdAt`存储整型类型的时间戳。用JavaBean表示如下: ``` public class User { @@ -489,7 +489,7 @@ public class User { ``` -ÕâÖÖÓ³Éä¹ØÏµÊ®·ÖÒ×¶®£¬µ«ÎÒÃÇÐèÒªÌí¼ÓһЩע½âÀ´¸æËßHibernateÈçºÎ°Ñ`User`ÀàÓ³Éäµ½±í¼Ç¼£º +è¿™ç§�映射关系å��分易懂,但我们需è¦�添加一些注解æ�¥å‘Šè¯‰Hibernate如何把`User`类映射到表记录: ``` @Entity @@ -514,7 +514,7 @@ public class User { ``` -Èç¹ûÒ»¸öJavaBean±»ÓÃÓÚÓ³É䣬ÎÒÃǾͱê¼ÇÒ»¸ö`@Entity`¡£Ä¬ÈÏÇé¿öÏ£¬Ó³ÉäµÄ±íÃûÊÇ`user`£¬Èç¹ûʵ¼ÊµÄ±íÃû²»Í¬£¬ÀýÈçʵ¼Ê±íÃûÊÇ`users`£¬¿ÉÒÔ×·¼ÓÒ»¸ö`@Table(name="users")`±íʾ£º +如果一个JavaBean被用于映射,我们就标记一个`@Entity`。默认情况下,映射的表å��是`user`,如果实际的表å��ä¸�å�Œï¼Œä¾‹å¦‚实际表å��是`users`,å�¯ä»¥è¿½åŠ ä¸€ä¸ª`@Table(name="users")`表示: ``` @Entity @@ -525,17 +525,17 @@ public class User { ``` -ÿ¸öÊôÐÔµ½Êý¾Ý¿âÁеÄÓ³ÉäÓÃ`@Column()`±êʶ£¬`nullable`ָʾÁÐÊÇ·ñÔÊÐíΪ`NULL`£¬`updatable`ָʾ¸ÃÁÐÊÇ·ñÔÊÐí±»ÓÃÔÚ`UPDATE`Óï¾ä£¬`length`ָʾ`String`ÀàÐ͵ÄÁеij¤¶È£¨Èç¹ûûÓÐÖ¸¶¨£¬Ä¬ÈÏÊÇ`255`£©¡£ +æ¯�个属性到数æ�®åº“列的映射用`@Column()`标识,`nullable`指示列是å�¦å…�许为`NULL`,`updatable`指示该列是å�¦å…�许被用在`UPDATE`语å�¥ï¼Œ`length`指示`String`类型的列的长度(如果没有指定,默认是`255`)。 -¶ÔÓÚÖ÷¼ü£¬»¹ÐèÒªÓÃ`@Id`±êʶ£¬×ÔÔöÖ÷¼üÔÙ×·¼ÓÒ»¸ö`@GeneratedValue`£¬ÒÔ±ãHibernateÄܶÁÈ¡µ½×ÔÔöÖ÷¼üµÄÖµ¡£ +对于主键,还需è¦�用`@Id`标识,自增主键å†�追加一个`@GeneratedValue`,以便Hibernate能读å�–到自增主键的值。 -ϸÐĵÄͯЬ¿ÉÄÜ»¹×¢Òâµ½£¬Ö÷¼ü`id`¶¨ÒåµÄÀàÐͲ»ÊÇ`long`£¬¶øÊÇ`Long`¡£ÕâÊÇÒòΪHibernateÈç¹û¼ì²âµ½Ö÷¼üΪ`null`£¬¾Í²»»áÔÚ`INSERT`Óï¾äÖÐÖ¸¶¨Ö÷¼üµÄÖµ£¬¶øÊÇ·µ»ØÓÉÊý¾Ý¿âÉú³ÉµÄ×ÔÔöÖµ£¬·ñÔò£¬HibernateÈÏΪÎÒÃǵijÌÐòÖ¸¶¨ÁËÖ÷¼üµÄÖµ£¬»áÔÚ`INSERT`Óï¾äÖÐÖ±½ÓÁгö¡£`long`ÐÍ×Ö¶Î×ÜÊǾßÓÐĬÈÏÖµ`0`£¬Òò´Ë£¬Ã¿´Î²åÈëµÄÖ÷¼üÖµ×ÜÊÇ0£¬µ¼Ö³ýµÚÒ»´ÎÍâºóÐø²åÈë¶¼½«Ê§°Ü¡£ +细心的童鞋å�¯èƒ½è¿˜æ³¨æ„�到,主键`id`定义的类型ä¸�是`long`,而是`Long`。这是因为Hibernate如果检测到主键为`null`,就ä¸�会在`INSERT`语å�¥ä¸­æŒ‡å®šä¸»é”®çš„值,而是返回由数æ�®åº“生æˆ�的自增值,å�¦åˆ™ï¼ŒHibernate认为我们的程åº�指定了主键的值,会在`INSERT`语å�¥ä¸­ç›´æŽ¥åˆ—出。`long`型字段总是具有默认值`0`,因此,æ¯�次æ�’入的主键值总是0,导致除第一次外å�Žç»­æ�’入都将失败。 -`createdAt`ËäÈ»ÊÇÕûÐÍ£¬µ«ÎÒÃDz¢Ã»ÓÐʹÓÃ`long`£¬¶øÊÇ`Long`£¬ÕâÊÇÒòΪʹÓûù±¾ÀàÐͻᵼÖÂfindByExample²éѯ»áÌí¼ÓÒâÍâµÄÌõ¼þ£¬ÕâÀïÖ»ÐèÀμǣ¬×÷ΪӳÉäʹÓõÄJavaBean£¬ËùÓÐÊôÐÔ¶¼Ê¹Óðü×°ÀàÐͶø²»ÊÇ»ù±¾ÀàÐÍ¡£ +`createdAt`虽然是整型,但我们并没有使用`long`,而是`Long`,这是因为使用基本类型会导致findByExample查询会添加æ„�外的æ�¡ä»¶ï¼Œè¿™é‡Œå�ªéœ€ç‰¢è®°ï¼Œä½œä¸ºæ˜ å°„使用的JavaBean,所有属性都使用包装类型而ä¸�是基本类型。 -ʹÓÃHibernateʱ£¬²»ÒªÊ¹Óûù±¾ÀàÐ͵ÄÊôÐÔ£¬×ÜÊÇʹÓðü×°ÀàÐÍ£¬ÈçLong»òInteger¡£ +使用Hibernate时,ä¸�è¦�使用基本类型的属性,总是使用包装类型,如Long或Integer。 -ÀàËÆµÄ£¬ÎÒÃÇÔÙ¶¨ÒåÒ»¸ö`Book`Àࣺ +类似的,我们å†�定义一个`Book`类: ``` @Entity @@ -554,9 +554,9 @@ public class Book { ``` -Èç¹û×Ðϸ¹Û²ì`User`ºÍ`Book`£¬»á·¢ÏÖËüÃǶ¨ÒåµÄ`id`¡¢`createdAt`ÊôÐÔÊÇÒ»ÑùµÄ£¬ÕâÔÚÊý¾Ý¿â±í½á¹¹µÄÉè¼ÆÖкܳ£¼û£º¶ÔÓÚÿ¸ö±í£¬Í¨³£ÎÒÃÇ»áͳһʹÓÃÒ»ÖÖÖ÷¼üÉú³É»úÖÆ£¬²¢Ìí¼Ó`createdAt`±íʾ´´½¨Ê±¼ä£¬`updatedAt`±íʾÐÞ¸Äʱ¼äµÈͨÓÃ×ֶΡ£ +如果仔细观察`User`å’Œ`Book`,会å�‘现它们定义的`id`ã€�`createdAt`属性是一样的,这在数æ�®åº“表结构的设计中很常è§�:对于æ¯�个表,通常我们会统一使用一ç§�主键生æˆ�机制,并添加`createdAt`表示创建时间,`updatedAt`表示修改时间等通用字段。 -²»±ØÔÚ`User`ºÍ`Book`ÖÐÖØ¸´¶¨ÒåÕâЩͨÓÃ×ֶΣ¬ÎÒÃÇ¿ÉÒÔ°ÑËüÃÇÌáµ½Ò»¸ö³éÏóÀàÖУº +ä¸�必在`User`å’Œ`Book`中é‡�å¤�定义这些通用字段,我们å�¯ä»¥æŠŠå®ƒä»¬æ��到一个抽象类中: ``` @MappedSuperclass @@ -586,11 +586,11 @@ public abstract class AbstractEntity { ``` -¶ÔÓÚ`AbstractEntity`À´Ëµ£¬ÎÒÃÇÒª±ê×¢Ò»¸ö`@MappedSuperclass`±íʾËüÓÃÓڼ̳С£´ËÍ⣬עÒâµ½ÎÒÃǶ¨ÒåÁËÒ»¸ö`@Transient`·½·¨£¬Ëü·µ»ØÒ»¸ö¡°ÐéÄ⡱µÄÊôÐÔ¡£ÒòΪ`getCreatedDateTime()`ÊǼÆËãµÃ³öµÄÊôÐÔ£¬¶ø²»ÊÇ´ÓÊý¾Ý¿â±í¶Á³öµÄÖµ£¬Òò´Ë±ØÐëÒª±ê×¢`@Transient`£¬·ñÔòHibernate»á³¢ÊÔ´ÓÊý¾Ý¿â¶ÁÈ¡ÃûΪ`createdDateTime`Õâ¸ö²»´æÔÚµÄ×ֶδӶø³ö´í¡£ +对于`AbstractEntity`æ�¥è¯´ï¼Œæˆ‘们è¦�标注一个`@MappedSuperclass`表示它用于继承。此外,注æ„�到我们定义了一个`@Transient`方法,它返回一个“虚拟â€�的属性。因为`getCreatedDateTime()`是计算得出的属性,而ä¸�是从数æ�®åº“表读出的值,因此必须è¦�标注`@Transient`,å�¦åˆ™Hibernate会å°�试从数æ�®åº“读å�–å��为`createdDateTime`这个ä¸�存在的字段从而出错。 -ÔÙ×¢Òâµ½`@PrePersist`±êʶµÄ·½·¨£¬Ëü±íʾÔÚÎÒÃǽ«Ò»¸öJavaBean³Ö¾Ã»¯µ½Êý¾Ý¿â֮ǰ£¨¼´Ö´ÐÐINSERTÓï¾ä£©£¬Hibernate»áÏÈÖ´Ðи÷½·¨£¬ÕâÑùÎÒÃǾͿÉÒÔ×Ô¶¯ÉèÖúÃ`createdAt`ÊôÐÔ¡£ +å†�注æ„�到`@PrePersist`标识的方法,它表示在我们将一个JavaBeanæŒ�久化到数æ�®åº“之å‰�(å�³æ‰§è¡ŒINSERT语å�¥ï¼‰ï¼ŒHibernate会先执行该方法,这样我们就å�¯ä»¥è‡ªåŠ¨è®¾ç½®å¥½`createdAt`属性。 -ÓÐÁË`AbstractEntity`£¬ÎÒÃǾͿÉÒÔ´ó·ù¼ò»¯`User`ºÍ`Book`£º +有了`AbstractEntity`,我们就å�¯ä»¥å¤§å¹…简化`User`å’Œ`Book`: ``` @Entity @@ -608,13 +608,13 @@ public class User extends AbstractEntity { ``` -×¢Ò⵽ʹÓõÄËùÓÐ×¢½â¾ùÀ´×Ô`jakarta.persistence`£¬ËüÊÇJPA¹æ·¶µÄÒ»²¿·Ö¡£ÕâÀïÎÒÃÇÖ»½éÉÜʹÓÃ×¢½âµÄ·½Ê½ÅäÖÃHibernateÓ³Éä¹ØÏµ£¬²»ÔÙ½éÉÜ´«Í³µÄ±È½Ï·±ËöµÄXMLÅäÖá£Í¨¹ýSpring¼¯³ÉHibernateʱ£¬Ò²²»ÔÙÐèÒª`hibernate.cfg.xml`ÅäÖÃÎļþ£¬ÓÃÒ»¾ä»°×ܽ᣺ +注æ„�到使用的所有注解å�‡æ�¥è‡ª`jakarta.persistence`,它是JPA规范的一部分。这里我们å�ªä»‹ç»�使用注解的方å¼�é…�ç½®Hibernate映射关系,ä¸�å†�介ç»�传统的比较ç¹�ç��çš„XMLé…�置。通过Spring集æˆ�Hibernate时,也ä¸�å†�需è¦�`hibernate.cfg.xml`é…�置文件,用一å�¥è¯�总结: -ʹÓÃSpring¼¯³ÉHibernate£¬ÅäºÏJPA×¢½â£¬ÎÞÐèÈκζîÍâµÄXMLÅäÖᣠ+使用Spring集æˆ�Hibernate,é…�å�ˆJPA注解,无需任何é¢�外的XMLé…�置。 -ÀàËÆ`User`¡¢`Book`ÕâÑùµÄÓÃÓÚORMµÄJava Bean£¬ÎÒÃÇͨ³£³ÆÖ®ÎªEntity Bean¡£ +类似`User`ã€�`Book`这样的用于ORMçš„Java Bean,我们通常称之为Entity Bean。 -×îºó£¬ÎÒÃÇÀ´¿´¿´Èç¹û¶Ô`user`±í½øÐÐÔöɾ¸Ä²é¡£ÒòΪʹÓÃÁËHibernate£¬Òò´Ë£¬ÎÒÃÇÒª×öµÄ£¬Êµ¼ÊÉÏÊǶÔ`User`Õâ¸öJavaBean½øÐС°Ôöɾ¸Ä²é¡±¡£ÎÒÃDZàдһ¸ö`UserService`£¬×¢Èë`SessionFactory`£º +最å�Žï¼Œæˆ‘们æ�¥çœ‹çœ‹å¦‚果对`user`表进行增删改查。因为使用了Hibernate,因此,我们è¦�å�šçš„,实际上是对`User`这个JavaBean进行“增删改查â€�。我们编写一个`UserService`,注入`SessionFactory`: ``` @Component @@ -626,31 +626,31 @@ public class UserService { ``` -### Insert²Ù×÷ +### Insertæ“�作 -Òª³Ö¾Ã»¯Ò»¸ö`User`ʵÀý£¬ÎÒÃÇÖ»Ðèµ÷ÓÃ`persist()`·½·¨¡£ÒÔ`register()`·½·¨ÎªÀý£¬´úÂëÈçÏ£º +è¦�æŒ�久化一个`User`实例,我们å�ªéœ€è°ƒç”¨`persist()`方法。以`register()`方法为例,代ç �如下: ``` public User register(String email, String password, String name) { - // ´´½¨Ò»¸öUser¶ÔÏó: + // 创建一个User对象: User user = new User(); - // ÉèÖúø÷¸öÊôÐÔ: + // 设置好å�„个属性: user.setEmail(email); user.setPassword(password); user.setName(name); - // ²»ÒªÉèÖÃid£¬ÒòΪʹÓÃÁË×ÔÔöÖ÷¼ü - // ±£´æµ½Êý¾Ý¿â: + // ä¸�è¦�设置id,因为使用了自增主键 + // ä¿�存到数æ�®åº“: sessionFactory.getCurrentSession().persist(user); - // ÏÖÔÚÒѾ­×Ô¶¯»ñµÃÁËid: + // 现在已ç»�自动获得了id: System.out.println(user.getId()); return user; } ``` -### Delete²Ù×÷ +### Deleteæ“�作 -ɾ³ýÒ»¸ö`User`Ï൱ÓÚ´Ó±íÖÐɾ³ý¶ÔÓ¦µÄ¼Ç¼¡£×¢ÒâHibernate×ÜÊÇÓÃ`id`À´É¾³ý¼Ç¼£¬Òò´Ë£¬ÒªÕýÈ·ÉèÖÃ`User`µÄ`id`ÊôÐÔ²ÅÄÜÕý³£É¾³ý¼Ç¼£º +删除一个`User`相当于从表中删除对应的记录。注æ„�Hibernate总是用`id`æ�¥åˆ é™¤è®°å½•,因此,è¦�正确设置`User`çš„`id`属性æ‰�能正常删除记录: ``` public boolean deleteUser(Long id) { @@ -664,11 +664,11 @@ public boolean deleteUser(Long id) { ``` -ͨ¹ýÖ÷¼üɾ³ý¼Ç¼ʱ£¬Ò»¸ö³£¼ûµÄÓ÷¨ÊÇÏȸù¾ÝÖ÷¼ü¼ÓÔØ¸Ã¼Ç¼£¬ÔÙɾ³ý¡£×¢Òâµ½µ±¼Ç¼²»´æÔÚʱ£¬`load()`·µ»Ø`null`¡£ +通过主键删除记录时,一个常è§�的用法是先根æ�®ä¸»é”®åŠ è½½è¯¥è®°å½•ï¼Œå†�删除。注æ„�到当记录ä¸�存在时,`load()`返回`null`。 -### Update²Ù×÷ +### Updateæ“�作 -¸üмǼÏ൱ÓÚÏȸüÐÂ`User`µÄÖ¸¶¨ÊôÐÔ£¬È»ºóµ÷ÓÃ`merge()`·½·¨£º +更新记录相当于先更新`User`的指定属性,然å�Žè°ƒç”¨`merge()`方法: ``` public void updateUser(Long id, String name) { @@ -679,20 +679,20 @@ public void updateUser(Long id, String name) { ``` -Ç°ÃæÎÒÃÇÔÚ¶¨Òå`User`ʱ£¬¶ÔÓеÄÊôÐÔ±ê×¢ÁË`@Column(updatable=false)`¡£HibernateÔÚ¸üмǼʱ£¬ËüÖ»»á°Ñ`@Column(updatable=true)`µÄÊôÐÔ¼ÓÈëµ½`UPDATE`Óï¾äÖУ¬ÕâÑù¿ÉÒÔÌṩһ²ã¶îÍâµÄ°²È«ÐÔ£¬¼´Èç¹û²»Ð¡ÐÄÐÞ¸ÄÁË`User`µÄ`email`¡¢`createdAt`µÈÊôÐÔ£¬Ö´ÐÐ`update()`ʱ²¢²»»á¸üжÔÓ¦µÄÊý¾Ý¿âÁС£µ«Ò²±ØÐëÀμǣºÕâ¸ö¹¦ÄÜÊÇHibernateÌṩµÄ£¬Èç¹ûÈÆ¹ýHibernateÖ±½Óͨ¹ýJDBCÖ´ÐÐ`UPDATE`Óï¾äÈÔÈ»¿ÉÒÔ¸üÐÂÊý¾Ý¿âµÄÈÎÒâÁеÄÖµ¡£ +å‰�é�¢æˆ‘们在定义`User`时,对有的属性标注了`@Column(updatable=false)`。Hibernate在更新记录时,它å�ªä¼šæŠŠ`@Column(updatable=true)`的属性加入到`UPDATE`语å�¥ä¸­ï¼Œè¿™æ ·å�¯ä»¥æ��供一层é¢�外的安全性,å�³å¦‚æžœä¸�å°�心修改了`User`çš„`email`ã€�`createdAt`等属性,执行`update()`æ—¶å¹¶ä¸�会更新对应的数æ�®åº“列。但也必须牢记:这个功能是Hibernateæ��供的,如果绕过Hibernate直接通过JDBC执行`UPDATE`语å�¥ä»�ç„¶å�¯ä»¥æ›´æ–°æ•°æ�®åº“的任æ„�列的值。 -×îºó£¬ÎÒÃDZàдµÄ´ó²¿·Ö·½·¨¶¼ÊǸ÷ÖÖ¸÷ÑùµÄ²éѯ¡£¸ù¾Ý`id`²éѯÎÒÃÇ¿ÉÒÔÖ±½Óµ÷ÓÃ`load()`£¬Èç¹ûҪʹÓÃÌõ¼þ²éѯ£¬ÀýÈ磬¼ÙÉèÎÒÃÇÏëÖ´ÐÐÒÔϲéѯ£º +最å�Žï¼Œæˆ‘们编写的大部分方法都是å�„ç§�å�„样的查询。根æ�®`id`查询我们å�¯ä»¥ç›´æŽ¥è°ƒç”¨`load()`,如果è¦�使用æ�¡ä»¶æŸ¥è¯¢ï¼Œä¾‹å¦‚,å�‡è®¾æˆ‘们想执行以下查询: ``` SELECT * FROM user WHERE email = ? AND password = ? ``` -ÎÒÃÇÀ´¿´¿´¿ÉÒÔʹÓÃʲô²éѯ¡£ +我们æ�¥çœ‹çœ‹å�¯ä»¥ä½¿ç”¨ä»€ä¹ˆæŸ¥è¯¢ã€‚ -### ʹÓÃHQL²éѯ +### 使用HQL查询 -Ò»ÖÖ³£ÓõIJéѯÊÇÖ±½Ó±àдHibernateÄÚÖõÄHQL²éѯ£º +一ç§�常用的查询是直接编写Hibernate内置的HQL查询: ``` List list = sessionFactory.getCurrentSession() @@ -702,16 +702,16 @@ List list = sessionFactory.getCurrentSession() ``` -ºÍSQLÏà±È£¬HQLʹÓÃÀàÃûºÍÊôÐÔÃû£¬ÓÉHibernate×Ô¶¯×ª»»ÎªÊµ¼ÊµÄ±íÃûºÍÁÐÃû¡£ÏêϸµÄHQLÓï·¨¿ÉÒԲο¼[HibernateÎĵµ](https://docs.jboss.org/hibernate/orm/6.1/userguide/html_single/Hibernate_User_Guide.html#query-language)¡£ +å’ŒSQL相比,HQL使用类å��和属性å��,由Hibernate自动转æ�¢ä¸ºå®žé™…的表å��和列å��。详细的HQL语法å�¯ä»¥å�‚考[Hibernate文档](https://docs.jboss.org/hibernate/orm/6.1/userguide/html_single/Hibernate_User_Guide.html#query-language)。 -³ýÁË¿ÉÒÔÖ±½Ó´«ÈëHQL×Ö·û´®Í⣬Hibernate»¹¿ÉÒÔʹÓÃÒ»ÖÖ`NamedQuery`£¬Ëü¸ø²éѯÆð¸öÃû×Ö£¬È»ºó±£´æÔÚ×¢½âÖС£Ê¹ÓÃ`NamedQuery`ʱ£¬ÎÒÃÇÒªÏÈÔÚ`User`Àà±ê×¢£º +除了å�¯ä»¥ç›´æŽ¥ä¼ å…¥HQL字符串外,Hibernate还å�¯ä»¥ä½¿ç”¨ä¸€ç§�`NamedQuery`,它给查询起个å��字,然å�Žä¿�存在注解中。使用`NamedQuery`时,我们è¦�先在`User`类标注: ``` @NamedQueries( @NamedQuery( - // ²éѯÃû³Æ: + // 查询å��ç§°: name = "login", - // ²éѯÓï¾ä: + // 查询语å�¥: query = "SELECT u FROM User u WHERE u.email = :e AND u.password = :pwd" ) ) @@ -722,33 +722,33 @@ public class User extends AbstractEntity { ``` -×¢Òâµ½ÒýÈëµÄ`NamedQuery`ÊÇ`jakarta.persistence.NamedQuery`£¬ËüºÍÖ±½Ó´«ÈëHQLÓе㲻ͬµÄÊÇ£¬Õ¼Î»·ûʹÓÃ`:e`ºÍ`:pwd`¡£ +注æ„�到引入的`NamedQuery`是`jakarta.persistence.NamedQuery`,它和直接传入HQL有点ä¸�å�Œçš„æ˜¯ï¼Œå� ä½�符使用`:e`å’Œ`:pwd`。 -ʹÓÃ`NamedQuery`Ö»ÐèÒªÒýÈë²éѯÃûºÍ²ÎÊý£º +使用`NamedQuery`å�ªéœ€è¦�引入查询å��å’Œå�‚数: ``` public User login(String email, String password) { List list = sessionFactory.getCurrentSession() - .createNamedQuery("login", User.class) // ´´½¨NamedQuery - .setParameter("e", email) // °ó¶¨e²ÎÊý - .setParameter("pwd", password) // °ó¶¨pwd²ÎÊý + .createNamedQuery("login", User.class) // 创建NamedQuery + .setParameter("e", email) // 绑定eå�‚æ•° + .setParameter("pwd", password) // 绑定pwdå�‚æ•° .list(); return list.isEmpty() ? null : list.get(0); } ``` -Ö±½ÓдHQLºÍʹÓÃ`NamedQuery`¸÷ÓÐÓÅÁÓ¡£Ç°Õß¿ÉÒÔÔÚ´úÂëÖÐÖ±¹ÛµØ¿´µ½²éѯÓï¾ä£¬ºóÕß¿ÉÒÔÔÚ`User`Ààͳһ¹ÜÀíËùÓÐÏà¹Ø²éѯ¡£ +直接写HQL和使用`NamedQuery`å�„有优劣。å‰�者å�¯ä»¥åœ¨ä»£ç �中直观地看到查询语å�¥ï¼Œå�Žè€…å�¯ä»¥åœ¨`User`类统一管ç�†æ‰€æœ‰ç›¸å…³æŸ¥è¯¢ã€‚ -ÉÏÒ»½ÚÎÒÃǽ²ÁËÔÚSpringÖм¯³ÉHibernate¡£HibernateÊǵÚÒ»¸ö±»¹ã·ºÊ¹ÓõÄORM¿ò¼Ü£¬µ«ÊǺܶàС»ï°é»¹Ìý˵¹ýJPA£ºJava Persistence API£¬ÕâÓÖÊÇɶ£¿ +上一节我们讲了在Spring中集æˆ�Hibernate。Hibernate是第一个被广泛使用的ORM框架,但是很多å°�伙伴还å�¬è¯´è¿‡JPA:Java Persistence API,这å�ˆæ˜¯å•¥ï¼Ÿ -ÔÚÌÖÂÛJPA֮ǰ£¬ÎÒÃÇҪעÒâµ½JavaEEÔçÔÚ1999Äê¾Í·¢²¼ÁË£¬²¢ÇÒÓÐServlet¡¢JMSµÈÖî¶à±ê×¼¡£ºÍÆäËûƽ̨²»Í¬£¬JavaÊÀ½çÔçÆÚ·Ç³£ÈÈÖÔÓÚ±ê×¼ÏÈÐУ¬¸÷¼Ò¸ú½ø£º´ó¼ÒÏÈ×øÏÂÀ´°Ñ½Ó¿Ú¶¨ÁË£¬È»ºó£¬¸÷×ԻؼҸɻîȥʵÏÖ½Ó¿Ú£¬ÕâÑù£¬Óû§¾Í¿ÉÒÔÔÚ²»Í¬µÄ³§¼ÒÌṩµÄ²úÆ·½øÐÐÑ¡Ôñ£¬»¹¿ÉÒÔËæÒâÇл»£¬ÒòΪÓû§±àд´úÂëµÄʱºòÖ»ÐèÒªÒýÓýӿڣ¬²¢²»ÐèÒªÒýÓþßÌåµÄµ×²ãʵÏÖ£¨ÏëÏëJDBC£©¡£ +在讨论JPA之å‰�,我们è¦�注æ„�到JavaEE早在1999å¹´å°±å�‘布了,并且有Servletã€�JMS等诸多标准。和其他平å�°ä¸�å�Œï¼ŒJava世界早期é�žå¸¸çƒ­è¡·äºŽæ ‡å‡†å…ˆè¡Œï¼Œå�„家跟进:大家先å��下æ�¥æŠŠæŽ¥å�£å®šäº†ï¼Œç„¶å�Žï¼Œå�„自回家干活去实现接å�£ï¼Œè¿™æ ·ï¼Œç”¨æˆ·å°±å�¯ä»¥åœ¨ä¸�å�Œçš„厂家æ��供的产å“�进行选择,还å�¯ä»¥éš�æ„�切æ�¢ï¼Œå› ä¸ºç”¨æˆ·ç¼–写代ç �的时候å�ªéœ€è¦�引用接å�£ï¼Œå¹¶ä¸�需è¦�引用具体的底层实现(想想JDBC)。 -JPA¾ÍÊÇJavaEEµÄÒ»¸öORM±ê×¼£¬ËüµÄʵÏÖÆäʵºÍHibernateûɶ±¾ÖÊÇø±ð£¬µ«ÊÇÓû§Èç¹ûʹÓÃJPA£¬ÄÇôÒýÓõľÍÊÇ`jakarta.persistence`Õâ¸ö¡°±ê×¼¡±°ü£¬¶ø²»ÊÇ`org.hibernate`ÕâÑùµÄµÚÈý·½°ü¡£ÒòΪJPAÖ»Êǽӿڣ¬ËùÒÔ£¬»¹ÐèҪѡÔñÒ»¸öʵÏÖ²úÆ·£¬¸úJDBC½Ó¿ÚºÍMySQLÇý¶¯Ò»¸öµÀÀí¡£ +JPA就是JavaEE的一个ORM标准,它的实现其实和Hibernate没啥本质区别,但是用户如果使用JPA,那么引用的就是`jakarta.persistence`这个“标准â€�包,而ä¸�是`org.hibernate`这样的第三方包。因为JPAå�ªæ˜¯æŽ¥å�£ï¼Œæ‰€ä»¥ï¼Œè¿˜éœ€è¦�选择一个实现产å“�,跟JDBC接å�£å’ŒMySQL驱动一个é�“ç�†ã€‚ -ÎÒÃÇʹÓÃJPAʱҲÍêÈ«¿ÉÒÔÑ¡ÔñHibernate×÷Ϊµ×²ãʵÏÖ£¬µ«Ò²¿ÉÒÔÑ¡ÔñÆäËüµÄJPAÌṩ·½£¬±ÈÈç[EclipseLink](https://www.eclipse.org/eclipselink/)¡£SpringÄÚÖÃÁËJPAµÄ¼¯³É£¬²¢Ö§³ÖÑ¡ÔñHibernate»òEclipseLink×÷ΪʵÏÖ¡£ÕâÀïÎÒÃÇÈÔÈ»ÒÔÖ÷Á÷µÄHibernate×÷ΪJPAʵÏÖΪÀý×Ó£¬ÑÝʾJPAµÄ»ù±¾Ó÷¨¡£ +我们使用JPA时也完全å�¯ä»¥é€‰æ‹©Hibernate作为底层实现,但也å�¯ä»¥é€‰æ‹©å…¶å®ƒçš„JPAæ��供方,比如[EclipseLink](https://www.eclipse.org/eclipselink/)。Spring内置了JPA的集æˆ�,并支æŒ�选择Hibernate或EclipseLink作为实现。这里我们ä»�然以主æµ�çš„Hibernate作为JPA实现为例å­�,演示JPA的基本用法。 -ºÍʹÓÃHibernateÒ»Ñù£¬ÎÒÃÇÖ»ÐèÒªÒýÈëÈçÏÂÒÀÀµ£º +和使用Hibernate一样,我们å�ªéœ€è¦�引入如下ä¾�赖: * org.springframework:spring-context:6.0.0 * org.springframework:spring-orm:6.0.0 @@ -758,9 +758,9 @@ JPA * com.zaxxer:HikariCP:5.0.1 * org.hsqldb:hsqldb:2.7.1 -ʵ¼ÊÉÏÎÒÃÇÕâÀïÒýÈëµÄÒÀÀµºÍÉÏÒ»½Ú¼¯³ÉHibernateÒýÈëµÄÒÀÀµÍêȫһÑù£¬ÒòΪHibernate¼ÈÌṩÁËËü×Ô¼ºµÄ½Ó¿Ú£¬Ò²ÌṩÁËJPA½Ó¿Ú£¬ÎÒÃÇÓÃJPA½Ó¿Ú¾ÍÏ൱ÓÚͨ¹ýJPA²Ù×÷Hibernate¡£ +实际上我们这里引入的ä¾�赖和上一节集æˆ�Hibernate引入的ä¾�赖完全一样,因为Hibernateæ—¢æ��供了它自己的接å�£ï¼Œä¹Ÿæ��供了JPA接å�£ï¼Œæˆ‘们用JPA接å�£å°±ç›¸å½“于通过JPAæ“�作Hibernate。 -È»ºó£¬ÔÚ`AppConfig`ÖÐÆôÓÃÉùÃ÷ʽÊÂÎñ¹ÜÀí£¬´´½¨`DataSource`£º +ç„¶å�Žï¼Œåœ¨`AppConfig`中å�¯ç”¨å£°æ˜Žå¼�事务管ç�†ï¼Œåˆ›å»º`DataSource`: ``` @Configuration @@ -774,21 +774,21 @@ public class AppConfig { ``` -ʹÓÃHibernateʱ£¬ÎÒÃÇÐèÒª´´½¨Ò»¸ö`LocalSessionFactoryBean`£¬²¢ÈÃËüÔÙ×Ô¶¯´´½¨Ò»¸ö`SessionFactory`¡£Ê¹ÓÃJPAÒ²ÊÇÀàËÆµÄ£¬ÎÒÃÇÒ²´´½¨Ò»¸ö`LocalContainerEntityManagerFactoryBean`£¬²¢ÈÃËüÔÙ×Ô¶¯´´½¨Ò»¸ö`EntityManagerFactory`£º +使用Hibernate时,我们需è¦�创建一个`LocalSessionFactoryBean`,并让它å†�自动创建一个`SessionFactory`。使用JPA也是类似的,我们也创建一个`LocalContainerEntityManagerFactoryBean`,并让它å†�自动创建一个`EntityManagerFactory`: ``` @Bean public LocalContainerEntityManagerFactoryBean createEntityManagerFactory(@Autowired DataSource dataSource) { var emFactory = new LocalContainerEntityManagerFactoryBean(); - // ×¢ÈëDataSource: + // 注入DataSource: emFactory.setDataSource(dataSource); - // ɨÃèÖ¸¶¨µÄpackage»ñÈ¡ËùÓÐentity class: + // 扫æ��指定的package获å�–所有entity class: emFactory.setPackagesToScan(AbstractEntity.class.getPackageName()); - // ʹÓÃHibernate×÷ΪJPAʵÏÖ: + // 使用Hibernate作为JPA实现: emFactory.setJpaVendorAdapter(new HibernateJpaVendorAdapter()); - // ÆäËûÅäÖÃÏî: + // å…¶ä»–é…�置项: var props = new Properties(); - props.setProperty("hibernate.hbm2ddl.auto", "update"); // Éú²ú»·¾³²»ÒªÊ¹Óà + props.setProperty("hibernate.hbm2ddl.auto", "update"); // 生产环境ä¸�è¦�使用 props.setProperty("hibernate.dialect", "org.hibernate.dialect.HSQLDialect"); props.setProperty("hibernate.show_sql", "true"); emFactory.setJpaProperties(props); @@ -797,9 +797,9 @@ public LocalContainerEntityManagerFactoryBean createEntityManagerFactory(@Autowi ``` -¹Û²ìÉÏÊö´úÂ룬³ýÁËÐèҪעÈë`DataSource`ºÍÉ趨×Ô¶¯É¨ÃèµÄ`package`Í⣬»¹ÐèÒªÖ¸¶¨JPAµÄÌṩÉÌ£¬ÕâÀïʹÓÃSpringÌṩµÄÒ»¸ö`HibernateJpaVendorAdapter`£¬×îºó£¬Õë¶ÔHibernate×Ô¼ºÐèÒªµÄÅäÖã¬ÒÔ`Properties`µÄÐÎʽעÈë¡£ +观察上述代ç �,除了需è¦�注入`DataSource`和设定自动扫æ��çš„`package`外,还需è¦�指定JPAçš„æ��供商,这里使用Springæ��供的一个`HibernateJpaVendorAdapter`,最å�Žï¼Œé’ˆå¯¹Hibernate自己需è¦�çš„é…�置,以`Properties`的形å¼�注入。 -×îºó£¬ÎÒÃÇ»¹ÐèҪʵÀý»¯Ò»¸ö`JpaTransactionManager`£¬ÒÔʵÏÖÉùÃ÷ʽÊÂÎñ£º +最å�Žï¼Œæˆ‘们还需è¦�实例化一个`JpaTransactionManager`,以实现声明å¼�事务: ``` @Bean @@ -809,11 +809,11 @@ PlatformTransactionManager createTxManager(@Autowired EntityManagerFactory entit ``` -ÕâÑù£¬ÎÒÃǾÍÍê³ÉÁËJPAµÄÈ«²¿³õʼ»¯¹¤×÷¡£ÓÐЩͯЬ¿ÉÄÜ´ÓÍøÉÏËÑË÷µÃÖªJPAÐèÒª`persistence.xml`ÅäÖÃÎļþ£¬ÒÔ¼°¸´ÔÓµÄ`orm.xml`Îļþ¡£ÕâÀïÎÒÃǸºÔðµØ¸æËß´ó¼Ò£¬Ê¹ÓÃSpring+Hibernate×÷ΪJPAʵÏÖ£¬ÎÞÐèÈκÎÅäÖÃÎļþ¡£ +这样,我们就完æˆ�了JPA的全部åˆ�始化工作。有些童鞋å�¯èƒ½ä»Žç½‘上æ�œç´¢å¾—知JPA需è¦�`persistence.xml`é…�置文件,以å�Šå¤�æ�‚çš„`orm.xml`文件。这里我们负责地告诉大家,使用Spring+Hibernate作为JPA实现,无需任何é…�置文件。 -ËùÓÐEntity BeanµÄÅäÖúÍÉÏÒ»½ÚÍêÈ«Ïàͬ£¬È«²¿²ÉÓÃAnnotation±ê×¢¡£ÎÒÃÇÏÖÔÚÖ»Ðè¹ØÐľßÌåµÄÒµÎñÀàÈçºÎͨ¹ýJPA½Ó¿Ú²Ù×÷Êý¾Ý¿â¡£ +所有Entity Beançš„é…�置和上一节完全相å�Œï¼Œå…¨éƒ¨é‡‡ç”¨Annotation标注。我们现在å�ªéœ€å…³å¿ƒå…·ä½“的业务类如何通过JPA接å�£æ“�作数æ�®åº“。 -»¹ÊÇÒÔ`UserService`ΪÀý£¬³ýÁ˱ê×¢`@Component`ºÍ`@Transactional`Í⣬ÎÒÃÇÐèҪעÈëÒ»¸ö`EntityManager`£¬µ«ÊDz»ÒªÊ¹ÓÃ`Autowired`£¬¶øÊÇ`@PersistenceContext`£º +还是以`UserService`为例,除了标注`@Component`å’Œ`@Transactional`外,我们需è¦�注入一个`EntityManager`,但是ä¸�è¦�使用`Autowired`,而是`@PersistenceContext`: ``` @Component @@ -825,18 +825,18 @@ public class UserService { ``` -ÎÒÃǻعËÒ»ÏÂJDBC¡¢HibernateºÍJPAÌṩµÄ½Ó¿Ú£¬Êµ¼ÊÉÏ£¬ËüÃǵĹØÏµÈçÏ£º +我们回顾一下JDBCã€�Hibernateå’ŒJPAæ��供的接å�£ï¼Œå®žé™…上,它们的关系如下: | JDBC | Hibernate | JPA | | --- | --- | --- | | DataSource | SessionFactory | EntityManagerFactory | | Connection | Session | EntityManager | -`SessionFactory`ºÍ`EntityManagerFactory`Ï൱ÓÚ`DataSource`£¬`Session`ºÍ`EntityManager`Ï൱ÓÚ`Connection`¡£Ã¿´ÎÐèÒª·ÃÎÊÊý¾Ý¿âµÄʱºò£¬ÐèÒª»ñȡеÄ`Session`ºÍ`EntityManager`£¬ÓÃÍêºóÔٹرա£ +`SessionFactory`å’Œ`EntityManagerFactory`相当于`DataSource`,`Session`å’Œ`EntityManager`相当于`Connection`。æ¯�次需è¦�访问数æ�®åº“的时候,需è¦�获å�–æ–°çš„`Session`å’Œ`EntityManager`,用完å�Žå†�关闭。 -µ«ÊÇ£¬×¢Òâµ½`UserService`×¢ÈëµÄ²»ÊÇ`EntityManagerFactory`£¬¶øÊÇ`EntityManager`£¬²¢ÇÒ±ê×¢ÁË`@PersistenceContext`¡£ÄѵÀʹÓÃJPA¿ÉÒÔÔÊÐí¶àÏ̲߳Ù×÷ͬһ¸ö`EntityManager`£¿ +但是,注æ„�到`UserService`注入的ä¸�是`EntityManagerFactory`,而是`EntityManager`,并且标注了`@PersistenceContext`。难é�“使用JPAå�¯ä»¥å…�许多线程æ“�作å�Œä¸€ä¸ª`EntityManager`? -ʵ¼ÊÉÏÕâÀï×¢ÈëµÄ²¢²»ÊÇÕæÕýµÄ`EntityManager`£¬¶øÊÇÒ»¸ö`EntityManager`µÄ´úÀíÀ࣬Ï൱ÓÚ£º +实际上这里注入的并ä¸�是真正的`EntityManager`,而是一个`EntityManager`的代ç�†ç±»ï¼Œç›¸å½“于: ``` public class EntityManagerProxy implements EntityManager { @@ -845,11 +845,11 @@ public class EntityManagerProxy implements EntityManager { ``` -SpringÓöµ½±ê×¢ÁË`@PersistenceContext`µÄ`EntityManager`»á×Ô¶¯×¢Èë´úÀí£¬¸Ã´úÀí»áÔÚ±ØÒªµÄʱºò×Ô¶¯´ò¿ª`EntityManager`¡£»»¾ä»°Ëµ£¬¶àÏß³ÌÒýÓõÄ`EntityManager`ËäÈ»ÊÇͬһ¸ö´úÀíÀ࣬µ«¸Ã´úÀíÀàÄÚ²¿Õë¶Ô²»Í¬Ï̻߳ᴴ½¨²»Í¬µÄ`EntityManager`ʵÀý¡£ +Springé�‡åˆ°æ ‡æ³¨äº†`@PersistenceContext`çš„`EntityManager`会自动注入代ç�†ï¼Œè¯¥ä»£ç�†ä¼šåœ¨å¿…è¦�的时候自动打开`EntityManager`。æ�¢å�¥è¯�说,多线程引用的`EntityManager`虽然是å�Œä¸€ä¸ªä»£ç�†ç±»ï¼Œä½†è¯¥ä»£ç�†ç±»å†…部针对ä¸�å�Œçº¿ç¨‹ä¼šåˆ›å»ºä¸�å�Œçš„`EntityManager`实例。 -¼òµ¥×ܽáһϣ¬±ê×¢ÁË`@PersistenceContext`µÄ`EntityManager`¿ÉÒÔ±»¶àḬ̈߳²È«µØ¹²Ïí¡£ +简å�•总结一下,标注了`@PersistenceContext`çš„`EntityManager`å�¯ä»¥è¢«å¤šçº¿ç¨‹å®‰å…¨åœ°å…±äº«ã€‚ -Òò´Ë£¬ÔÚ`UserService`µÄÿ¸öÒµÎñ·½·¨Àֱ½ÓʹÓÃ`EntityManager`¾ÍºÜ·½±ã¡£ÒÔÖ÷¼ü²éѯΪÀý£º +因此,在`UserService`çš„æ¯�个业务方法里,直接使用`EntityManager`就很方便。以主键查询为例: ``` public User getUserById(long id) { @@ -862,11 +862,11 @@ public User getUserById(long id) { ``` -ÓëHQL²éѯÀàËÆ£¬JPAʹÓÃJPQL²éѯ£¬ËüµÄÓï·¨ºÍHQL»ù±¾²î²»¶à£º +与HQL查询类似,JPA使用JPQL查询,它的语法和HQL基本差ä¸�多: ``` public User fetchUserByEmail(String email) { - // JPQL²éѯ: + // JPQL查询: TypedQuery query = em.createQuery("SELECT u FROM User u WHERE u.email = :e", User.class); query.setParameter("e", email); List list = query.getResultList(); @@ -878,7 +878,7 @@ public User fetchUserByEmail(String email) { ``` -ͬÑùµÄ£¬JPAÒ²Ö§³Ö`NamedQuery`£¬¼´Ïȸø²éѯÆð¸öÃû×Ö£¬ÔÙ°´Ãû×Ö´´½¨²éѯ£º +å�Œæ ·çš„,JPA也支æŒ�`NamedQuery`,å�³å…ˆç»™æŸ¥è¯¢èµ·ä¸ªå��字,å†�按å��字创建查询: ``` public User login(String email, String password) { @@ -891,7 +891,7 @@ public User login(String email, String password) { ``` -`NamedQuery`ͨ¹ý×¢½â±ê×¢ÔÚ`User`ÀàÉÏ£¬ËüµÄ¶¨ÒåºÍÉÏÒ»½ÚµÄ`User`ÀàÒ»Ñù£º +`NamedQuery`通过注解标注在`User`类上,它的定义和上一节的`User`类一样: ``` @NamedQueries( @@ -907,23 +907,23 @@ public class User { ``` -¶ÔÊý¾Ý¿â½øÐÐÔöɾ¸ÄµÄ²Ù×÷£¬¿ÉÒÔ·Ö±ðʹÓÃ`persist()`¡¢`remove()`ºÍ`merge()`·½·¨£¬²ÎÊý¾ùΪEntity Bean±¾Éí£¬Ê¹Ó÷dz£¼òµ¥£¬ÕâÀï²»ÔÙ¶àÊö¡£ +对数æ�®åº“进行增删改的æ“�作,å�¯ä»¥åˆ†åˆ«ä½¿ç”¨`persist()`ã€�`remove()`å’Œ`merge()`方法,å�‚æ•°å�‡ä¸ºEntity Bean本身,使用é�žå¸¸ç®€å�•,这里ä¸�å†�多述。 -#### ¼¯³ÉMyBatis +#### 集æˆ�MyBatis -×îºó¸üÐÂ: 2022/11/16 21:07 / ÔĶÁ: 601258 +最å�Žæ›´æ–°: 2022/11/16 21:07 / 阅读: 601258 * * * -ʹÓÃHibernate»òJPA²Ù×÷Êý¾Ý¿âʱ£¬ÕâÀàORM¸ÉµÄÖ÷Òª¹¤×÷¾ÍÊǰÑResultSetµÄÿһÐбä³ÉJava Bean£¬»òÕß°ÑJava Bean×Ô¶¯×ª»»µ½INSERT»òUPDATEÓï¾äµÄ²ÎÊýÖУ¬´Ó¶øÊµÏÖORM¡£ +使用Hibernate或JPAæ“�作数æ�®åº“时,这类ORM干的主è¦�工作就是把ResultSetçš„æ¯�一行å�˜æˆ�Java Bean,或者把Java Bean自动转æ�¢åˆ°INSERT或UPDATE语å�¥çš„å�‚数中,从而实现ORM。 -¶øORM¿ò¼ÜÖ®ËùÒÔÖªµÀÈçºÎ°ÑÐÐÊý¾ÝÓ³Éäµ½Java Bean£¬ÊÇÒòΪÎÒÃÇÔÚJava BeanµÄÊôÐÔÉϸøÁË×ã¹»µÄ×¢½â×÷ΪԪÊý¾Ý£¬ORM¿ò¼Ü»ñÈ¡Java BeanµÄ×¢½âºó£¬¾ÍÖªµÀÈçºÎ½øÐÐË«ÏòÓ³Éä¡£ +而ORM框架之所以知é�“如何把行数æ�®æ˜ å°„到Java Bean,是因为我们在Java Bean的属性上给了足够的注解作为元数æ�®ï¼ŒORM框架获å�–Java Bean的注解å�Žï¼Œå°±çŸ¥é�“如何进行å�Œå�‘映射。 -ÄÇô£¬ORM¿ò¼ÜÊÇÈçºÎ¸ú×ÙJava BeanµÄÐ޸ģ¬ÒÔ±ãÔÚ`update()`²Ù×÷ÖиüбØÒªµÄÊôÐÔ£¿ +那么,ORM框架是如何跟踪Java Bean的修改,以便在`update()`æ“�作中更新必è¦�的属性? -´ð°¸ÊÇʹÓÃ[Proxyģʽ](https://www.liaoxuefeng.com/wiki/1252599548343744/1281319432618017)£¬´ÓORM¿ò¼Ü¶ÁÈ¡µÄUserʵÀýʵ¼ÊÉϲ¢²»ÊÇUserÀ࣬¶øÊÇ´úÀíÀ࣬´úÀíÀà¼Ì³Ð×ÔUserÀ࣬µ«Õë¶Ôÿ¸ösetter·½·¨×öÁ˸²Ð´£º +答案是使用[Proxy模å¼�](https://www.liaoxuefeng.com/wiki/1252599548343744/1281319432618017),从ORM框架读å�–çš„User实例实际上并ä¸�是User类,而是代ç�†ç±»ï¼Œä»£ç�†ç±»ç»§æ‰¿è‡ªUser类,但针对æ¯�个setter方法å�šäº†è¦†å†™ï¼š ``` public class UserProxy extends User { @@ -937,9 +937,9 @@ public class UserProxy extends User { ``` -ÕâÑù£¬´úÀíÀà¿ÉÒÔ¸ú×Ùµ½Ã¿¸öÊôÐԵı仯¡£ +这样,代ç�†ç±»å�¯ä»¥è·Ÿè¸ªåˆ°æ¯�个属性的å�˜åŒ–。 -Õë¶ÔÒ»¶Ô¶à»ò¶à¶ÔÒ»¹ØÏµÊ±£¬´úÀíÀà¿ÉÒÔÖ±½Óͨ¹ýgetter·½·¨²éѯÊý¾Ý¿â£º +针对一对多或多对一关系时,代ç�†ç±»å�¯ä»¥ç›´æŽ¥é€šè¿‡getter方法查询数æ�®åº“: ``` public class UserProxy extends User { @@ -952,7 +952,7 @@ public class UserProxy extends User { } /** - * »ñÈ¡User¶ÔÏó¹ØÁªµÄAddress¶ÔÏó: + * 获å�–User对象关è�”çš„Address对象: */ public Address getAddress() { Query q = _session.createQuery("from Address where userId = :userId"); @@ -964,11 +964,11 @@ public class UserProxy extends User { ``` -ΪÁËʵÏÖÕâÑùµÄ²éѯ£¬UserProxy±ØÐë±£´æHibernateµÄµ±Ç°Session¡£µ«ÊÇ£¬µ±ÊÂÎñÌá½»ºó£¬Session×Ô¶¯¹Ø±Õ£¬´ËʱÔÙ»ñÈ¡`getAddress()`½«ÎÞ·¨·ÃÎÊÊý¾Ý¿â£¬»òÕß»ñÈ¡µÄ²»ÊÇÊÂÎñÒ»ÖµÄÊý¾Ý¡£Òò´Ë£¬ORM¿ò¼Ü×ÜÊÇÒýÈëÁËAttached/Detached״̬£¬±íʾµ±Ç°´ËJava Beanµ½µ×ÊÇÔÚSessionµÄ·¶Î§ÄÚ£¬»¹ÊÇÍÑÀëÁËSession±ä³ÉÁËÒ»¸ö¡°ÓÎÀ롱¶ÔÏ󡣺ܶà³õѧÕßÎÞ·¨ÕýÈ·Àí½â״̬±ä»¯ºÍÊÂÎñ±ß½ç£¬¾Í»áÔì³É´óÁ¿µÄ`PersistentObjectException`Òì³£¡£ÕâÖÖÒþʽ״̬ʹµÃÆÕͨJava BeanµÄÉúÃüÖÜÆÚ±äµÃ¸´ÔÓ¡£ +为了实现这样的查询,UserProxyå¿…é¡»ä¿�å­˜Hibernate的当å‰�Session。但是,当事务æ��交å�Žï¼ŒSession自动关闭,此时å†�获å�–`getAddress()`将无法访问数æ�®åº“,或者获å�–çš„ä¸�是事务一致的数æ�®ã€‚因此,ORM框架总是引入了Attached/Detached状æ€�,表示当å‰�æ­¤Java Bean到底是在Session的范围内,还是脱离了Sessionå�˜æˆ�了一个“游离â€�对象。很多åˆ�学者无法正确ç�†è§£çжæ€�å�˜åŒ–和事务边界,就会造æˆ�大é‡�çš„`PersistentObjectException`异常。这ç§�éš�å¼�状æ€�使得普通Java Bean的生命周期å�˜å¾—å¤�æ�‚。 -´ËÍ⣬HibernateºÍJPAΪÁËʵÏÖ¼æÈݶàÖÖÊý¾Ý¿â£¬ËüʹÓÃHQL»òJPQL²éѯ£¬¾­¹ýÒ»µÀת»»£¬±ä³ÉÌØ¶¨Êý¾Ý¿âµÄSQL£¬ÀíÂÛÉÏÕâÑù¿ÉÒÔ×öµ½ÎÞ·ìÇл»Êý¾Ý¿â£¬µ«ÕâÒ»²ã×Ô¶¯×ª»»³ýÁËÉÙÐíµÄÐÔÄÜ¿ªÏúÍ⣬¸øSQL¼¶±ðµÄÓÅ»¯´øÀ´ÁËÂé·³¡£ +此外,Hibernateå’ŒJPA为了实现兼容多ç§�æ•°æ�®åº“,它使用HQL或JPQL查询,ç»�过一é�“转æ�¢ï¼Œå�˜æˆ�特定数æ�®åº“çš„SQL,ç�†è®ºä¸Šè¿™æ ·å�¯ä»¥å�šåˆ°æ— ç¼�切æ�¢æ•°æ�®åº“,但这一层自动转æ�¢é™¤äº†å°‘许的性能开销外,给SQL级别的优化带æ�¥äº†éº»çƒ¦ã€‚ -×îºó£¬ORM¿ò¼Üͨ³£ÌṩÁË»º´æ£¬²¢ÇÒ»¹·ÖΪһ¼¶»º´æºÍ¶þ¼¶»º´æ¡£Ò»¼¶»º´æÊÇÖ¸ÔÚÒ»¸öSession·¶Î§ÄڵĻº´æ£¬³£¼ûµÄÇé¾°ÊǸù¾ÝÖ÷¼ü²éѯʱ£¬Á½´Î²éѯ¿ÉÒÔ·µ»ØÍ¬Ò»ÊµÀý£º +最å�Žï¼ŒORM框架通常æ��供了缓存,并且还分为一级缓存和二级缓存。一级缓存是指在一个Session范围内的缓存,常è§�的情景是根æ�®ä¸»é”®æŸ¥è¯¢æ—¶ï¼Œä¸¤æ¬¡æŸ¥è¯¢å�¯ä»¥è¿”回å�Œä¸€å®žä¾‹ï¼š ``` User user1 = session.load(User.class, 123); @@ -976,46 +976,46 @@ User user2 = session.load(User.class, 123); ``` -¶þ¼¶»º´æÊÇÖ¸¿çSessionµÄ»º´æ£¬Ò»°ãĬÈϹرգ¬ÐèÒªÊÖ¶¯ÅäÖ᣶þ¼¶»º´æ¼«´óµÄÔö¼ÓÁËÊý¾ÝµÄ²»Ò»ÖÂÐÔ£¬Ô­ÒòÔÚÓÚSQL·Ç³£Áé»î£¬³£³£»áµ¼ÖÂÒâÍâµÄ¸üС£ÀýÈ磺 +二级缓存是指跨Session的缓存,一般默认关闭,需è¦�手动é…�置。二级缓存æž�大的增加了数æ�®çš„ä¸�一致性,原因在于SQLé�žå¸¸ç�µæ´»ï¼Œå¸¸å¸¸ä¼šå¯¼è‡´æ„�外的更新。例如: ``` -// Ïß³Ì1¶ÁÈ¡: +// 线程1读å�–: User user1 = session1.load(User.class, 123); ... -// Ò»¶Îʱ¼äºó£¬Ïß³Ì2¶ÁÈ¡: +// 一段时间å�Žï¼Œçº¿ç¨‹2读å�–: User user2 = session2.load(User.class, 123); ``` -µ±¶þ¼¶»º´æÉúЧµÄʱºò£¬Á½¸öÏ̶߳ÁÈ¡µÄUserʵÀýÊÇÒ»ÑùµÄ£¬µ«ÊÇ£¬Êý¾Ý¿â¶ÔÓ¦µÄÐмǼÍêÈ«¿ÉÄܱ»Ð޸ģ¬ÀýÈ磺 +当二级缓存生效的时候,两个线程读å�–çš„User实例是一样的,但是,数æ�®åº“对应的行记录完全å�¯èƒ½è¢«ä¿®æ”¹ï¼Œä¾‹å¦‚: ``` --- ¸øÀÏÓû§Ôö¼Ó100»ý·Ö: +-- ç»™è€�用户增加100积分: UPDATE users SET bonus = bonus + 100 WHERE createdAt <= ? ``` -ORMÎÞ·¨ÅжÏ`id=123`µÄÓû§ÊÇ·ñÊܸÃ`UPDATE`Óï¾äÓ°Ïì¡£¿¼Âǵ½Êý¾Ý¿âͨ³£»áÖ§³Ö¶à¸öÓ¦ÓóÌÐò£¬´ËUPDATEÓï¾ä¿ÉÄÜÓÉÆäËû½ø³ÌÖ´ÐУ¬ORM¿ò¼Ü¾Í¸ü²»ÖªµÀÁË¡£ +ORM无法判断`id=123`的用户是å�¦å�—该`UPDATE`语å�¥å½±å“�。考虑到数æ�®åº“通常会支æŒ�多个应用程åº�,此UPDATE语å�¥å�¯èƒ½ç”±å…¶ä»–进程执行,ORM框架就更ä¸�知é�“了。 -ÎÒÃǰÑÕâÖÖORM¿ò¼Ü³ÆÖ®ÎªÈ«×Ô¶¯ORM¿ò¼Ü¡£ +我们把这ç§�ORM框架称之为全自动ORM框架。 -¶Ô±ÈSpringÌṩµÄJdbcTemplate£¬ËüºÍORM¿ò¼ÜÏà±È£¬Ö÷ÒªÓм¸µã²î±ð£º +对比Springæ��供的JdbcTemplate,它和ORM框架相比,主è¦�有几点差别: -1. ²éѯºóÐèÒªÊÖ¶¯ÌṩMapperʵÀýÒÔ±ã°ÑResultSetµÄÿһÐбäΪJava¶ÔÏó£» -2. Ôöɾ¸Ä²Ù×÷ËùÐèµÄ²ÎÊýÁÐ±í£¬ÐèÒªÊÖ¶¯´«È룬¼´°ÑUserʵÀý±äΪ[user.id, user.name, user.email]ÕâÑùµÄÁÐ±í£¬±È½ÏÂé·³¡£ +1. 查询å�Žéœ€è¦�手动æ��ä¾›Mapper实例以便把ResultSetçš„æ¯�一行å�˜ä¸ºJava对象; +2. 增删改æ“�作所需的å�‚数列表,需è¦�手动传入,å�³æŠŠUser实例å�˜ä¸º[user.id, user.name, user.email]这样的列表,比较麻烦。 -µ«ÊÇJdbcTemplateµÄÓÅÊÆÔÚÓÚËüµÄÈ·¶¨ÐÔ£º¼´Ã¿´Î¶ÁÈ¡²Ù×÷Ò»¶¨ÊÇÊý¾Ý¿â²Ù×÷¶ø²»ÊÇ»º´æ£¬ËùÖ´ÐеÄSQLÊÇÍêȫȷ¶¨µÄ£¬È±µã¾ÍÊÇ´úÂë±È½Ï·±Ëö£¬¹¹Ôì`INSERT INTO users VALUES (?,?,?)`¸üÊǸ´ÔÓ¡£ +但是JdbcTemplate的优势在于它的确定性:å�³æ¯�次读å�–æ“�作一定是数æ�®åº“æ“�作而ä¸�是缓存,所执行的SQL是完全确定的,缺点就是代ç �比较ç¹�ç��,构造`INSERT INTO users VALUES (?,?,?)`更是å¤�æ�‚。 -ËùÒÔ£¬½éÓÚÈ«×Ô¶¯ORMÈçHibernateºÍÊÖдȫ²¿ÈçJdbcTemplateÖ®¼ä£¬»¹ÓÐÒ»ÖÖ°ë×Ô¶¯µÄORM£¬ËüÖ»¸ºÔð°ÑResultSet×Ô¶¯Ó³Éäµ½Java Bean£¬»òÕß×Ô¶¯Ìî³äJava Bean²ÎÊý£¬µ«ÈÔÐè×Ô¼ºÐ´³öSQL¡£[MyBatis](https://mybatis.org/)¾ÍÊÇÕâÑùÒ»ÖÖ°ë×Ô¶¯»¯ORM¿ò¼Ü¡£ +所以,介于全自动ORM如Hibernate和手写全部如JdbcTemplate之间,还有一ç§�å�Šè‡ªåŠ¨çš„ORM,它å�ªè´Ÿè´£æŠŠResultSet自动映射到Java Bean,或者自动填充Java Beanå�‚数,但ä»�需自己写出SQL。[MyBatis](https://mybatis.org/)就是这样一ç§�å�Šè‡ªåŠ¨åŒ–ORM框架。 -ÎÒÃÇÀ´¿´¿´ÈçºÎÔÚSpringÖм¯³ÉMyBatis¡£ +我们æ�¥çœ‹çœ‹å¦‚何在Spring中集æˆ�MyBatis。 -Ê×ÏÈ£¬ÎÒÃÇÒªÒýÈëMyBatis±¾Éí£¬Æä´Î£¬ÓÉÓÚSpring²¢Ã»ÓÐÏñHibernateÄÇÑùÄÚÖöÔMyBatisµÄ¼¯³É£¬ËùÒÔ£¬ÎÒÃÇÐèÒªÔÙÒýÈëMyBatis¹Ù·½×Ô¼º¿ª·¢µÄÒ»¸öÓëSpring¼¯³ÉµÄ¿â£º +首先,我们è¦�引入MyBatis本身,其次,由于Spring并没有åƒ�Hibernate那样内置对MyBatis的集æˆ�,所以,我们需è¦�å†�引入MyBatis官方自己开å�‘的一个与Spring集æˆ�的库: * org.mybatis:mybatis:3.5.11 * org.mybatis:mybatis-spring:3.0.0 -ºÍÇ°ÃæÒ»Ñù£¬ÏÈ´´½¨`DataSource`ÊDZز»¿ÉÉٵģº +å’Œå‰�é�¢ä¸€æ ·ï¼Œå…ˆåˆ›å»º`DataSource`是必ä¸�å�¯å°‘的: ``` @Configuration @@ -1029,14 +1029,14 @@ public class AppConfig { ``` -ÔٻعËÒ»ÏÂHibernateºÍJPAµÄ`SessionFactory`Óë`EntityManagerFactory`£¬MyBatisÓëÖ®¶ÔÓ¦µÄÊÇ`SqlSessionFactory`ºÍ`SqlSession`£º +å†�回顾一下Hibernateå’ŒJPAçš„`SessionFactory`与`EntityManagerFactory`,MyBatis与之对应的是`SqlSessionFactory`å’Œ`SqlSession`: | JDBC | Hibernate | JPA | MyBatis | | --- | --- | --- | --- | | DataSource | SessionFactory | EntityManagerFactory | SqlSessionFactory | | Connection | Session | EntityManager | SqlSession | -¿É¼û£¬ORMµÄÉè¼ÆÌ×·¶¼ÊÇÀàËÆµÄ¡£Ê¹ÓÃMyBatisµÄºËÐľÍÊÇ´´½¨`SqlSessionFactory`£¬ÕâÀïÎÒÃÇÐèÒª´´½¨µÄÊÇ`SqlSessionFactoryBean`£º +å�¯è§�,ORM的设计套路都是类似的。使用MyBatis的核心就是创建`SqlSessionFactory`,这里我们需è¦�创建的是`SqlSessionFactoryBean`: ``` @Bean @@ -1048,7 +1048,7 @@ SqlSessionFactoryBean createSqlSessionFactoryBean(@Autowired DataSource dataSour ``` -ÒòΪMyBatis¿ÉÒÔÖ±½ÓʹÓÃSpring¹ÜÀíµÄÉùÃ÷ʽÊÂÎñ£¬Òò´Ë£¬´´½¨ÊÂÎñ¹ÜÀíÆ÷ºÍʹÓÃJDBCÊÇÒ»ÑùµÄ£º +因为MyBatiså�¯ä»¥ç›´æŽ¥ä½¿ç”¨Spring管ç�†çš„声明å¼�事务,因此,创建事务管ç�†å™¨å’Œä½¿ç”¨JDBC是一样的: ``` @Bean @@ -1058,7 +1058,7 @@ PlatformTransactionManager createTxManager(@Autowired DataSource dataSource) { ``` -ºÍHibernate²»Í¬µÄÊÇ£¬MyBatisʹÓÃMapperÀ´ÊµÏÖÓ³É䣬¶øÇÒMapper±ØÐëÊǽӿڡ£ÎÒÃÇÒÔ`User`ÀàΪÀý£¬ÔÚ`User`ÀàºÍ`users`±íÖ®¼äÓ³ÉäµÄ`UserMapper`±àдÈçÏ£º +å’ŒHibernateä¸�å�Œçš„æ˜¯ï¼ŒMyBatis使用Mapperæ�¥å®žçŽ°æ˜ å°„ï¼Œè€Œä¸”Mapper必须是接å�£ã€‚我们以`User`类为例,在`User`类和`users`表之间映射的`UserMapper`编写如下: ``` public interface UserMapper { @@ -1068,9 +1068,9 @@ public interface UserMapper { ``` -×¢Ò⣺ÕâÀïµÄMapper²»ÊÇ`JdbcTemplate`µÄ`RowMapper`µÄ¸ÅÄËüÊǶ¨Òå·ÃÎÊ`users`±íµÄ½Ó¿Ú·½·¨¡£±ÈÈçÎÒÃǶ¨ÒåÁËÒ»¸ö`User getById(long)`µÄÖ÷¼ü²éѯ·½·¨£¬²»½öÒª¶¨Òå½Ó¿Ú·½·¨±¾Éí£¬»¹ÒªÃ÷ȷд³ö²éѯµÄSQL£¬ÕâÀïÓÃ×¢½â`@Select`±ê¼Ç¡£SQLÓï¾äµÄÈκβÎÊý£¬¶¼Óë·½·¨²ÎÊý°´Ãû³Æ¶ÔÓ¦¡£ÀýÈ磬·½·¨²ÎÊýidµÄÃû×Öͨ¹ý×¢½â`@Param()`±ê¼ÇΪ`id`£¬ÔòSQLÓï¾äÀォÀ´Ìæ»»µÄռλ·û¾ÍÊÇ`#{id}`¡£ +注æ„�:这里的Mapperä¸�是`JdbcTemplate`çš„`RowMapper`的概念,它是定义访问`users`表的接å�£æ–¹æ³•。比如我们定义了一个`User getById(long)`的主键查询方法,ä¸�ä»…è¦�定义接å�£æ–¹æ³•本身,还è¦�明确写出查询的SQL,这里用注解`@Select`标记。SQL语å�¥çš„任何å�‚数,都与方法å�‚数按å��称对应。例如,方法å�‚æ•°idçš„å��字通过注解`@Param()`标记为`id`,则SQL语å�¥é‡Œå°†æ�¥æ›¿æ�¢çš„å� ä½�符就是`#{id}`。 -Èç¹ûÓжà¸ö²ÎÊý£¬ÄÇôÿ¸ö²ÎÊýÃüÃûºóÖ±½ÓÔÚSQLÖÐд³ö¶ÔÓ¦µÄռλ·û¼´¿É£º +如果有多个å�‚数,那么æ¯�个å�‚数命å��å�Žç›´æŽ¥åœ¨SQL中写出对应的å� ä½�符å�³å�¯ï¼š ``` @Select("SELECT * FROM users LIMIT #{offset}, #{maxResults}") @@ -1078,15 +1078,15 @@ List getAll(@Param("offset") int offset, @Param("maxResults") int maxResul ``` -×¢Ò⣺MyBatisÖ´Ðвéѯºó£¬½«¸ù¾Ý·½·¨µÄ·µ»ØÀàÐÍ×Ô¶¯°ÑResultSetµÄÿһÐÐת»»ÎªUserʵÀý£¬×ª»»¹æÔòµ±È»Êǰ´ÁÐÃûºÍÊôÐÔÃû¶ÔÓ¦¡£Èç¹ûÁÐÃûºÍÊôÐÔÃû²»Í¬£¬×î¼òµ¥µÄ·½Ê½ÊDZàдSELECTÓï¾äµÄ±ðÃû£º +注æ„�:MyBatis执行查询å�Žï¼Œå°†æ ¹æ�®æ–¹æ³•的返回类型自动把ResultSetçš„æ¯�一行转æ�¢ä¸ºUser实例,转æ�¢è§„则当然是按列å��和属性å��对应。如果列å��和属性å��ä¸�å�Œï¼Œæœ€ç®€å�•的方å¼�是编写SELECT语å�¥çš„别å��: ``` --- ÁÐÃûÊÇcreated_time£¬ÊôÐÔÃûÊÇcreatedAt: +-- 列å��是created_time,属性å��是createdAt: SELECT id, name, email, created_time AS createdAt FROM users ``` -Ö´ÐÐINSERTÓï¾ä¾ÍÉÔ΢Âé·³µã£¬ÒòΪÎÒÃÇÏ£Íû´«ÈëUserʵÀý£¬Òò´Ë£¬¶¨ÒåµÄ·½·¨½Ó¿ÚÓë`@Insert`×¢½âÈçÏ£º +执行INSERT语å�¥å°±ç¨�微麻烦点,因为我们希望传入User实例,因此,定义的方法接å�£ä¸Ž`@Insert`注解如下: ``` @Insert("INSERT INTO users (email, password, name, createdAt) VALUES (#{user.email}, #{user.password}, #{user.name}, #{user.createdAt})") @@ -1094,9 +1094,9 @@ void insert(@Param("user") User user); ``` -ÉÏÊö·½·¨´«ÈëµÄ²ÎÊýÃû³ÆÊÇ`user`£¬²ÎÊýÀàÐÍÊÇUserÀ࣬ÔÚSQLÖÐÒýÓõÄʱºò£¬ÒÔ`#{obj.property}`µÄ·½Ê½Ð´Õ¼Î»·û¡£ºÍHibernateÕâÑùµÄÈ«×Ô¶¯»¯ORMÏà±È£¬MyBatis±ØÐëд³öÍêÕûµÄINSERTÓï¾ä¡£ +上述方法传入的å�‚æ•°å��称是`user`,å�‚数类型是User类,在SQL中引用的时候,以`#{obj.property}`的方å¼�写å� ä½�符。和Hibernate这样的全自动化ORM相比,MyBatis必须写出完整的INSERT语å�¥ã€‚ -Èç¹û`users`±íµÄ`id`ÊÇ×ÔÔöÖ÷¼ü£¬ÄÇô£¬ÎÒÃÇÔÚSQLÖв»´«Èë`id`£¬µ«Ï£Íû»ñÈ¡²åÈëºóµÄÖ÷¼ü£¬ÐèÒªÔÙ¼ÓÒ»¸ö`@Options`×¢½â£º +如果`users`表的`id`是自增主键,那么,我们在SQL中ä¸�ä¼ å…¥`id`,但希望获å�–æ�’å…¥å�Žçš„主键,需è¦�å†�加一个`@Options`注解: ``` @Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id") @@ -1105,9 +1105,9 @@ void insert(@Param("user") User user); ``` -`keyProperty`ºÍ`keyColumn`·Ö±ðÖ¸³öJavaBeanµÄÊôÐÔºÍÊý¾Ý¿âµÄÖ÷¼üÁÐÃû¡£ +`keyProperty`å’Œ`keyColumn`分别指出JavaBean的属性和数æ�®åº“的主键列å��。 -Ö´ÐÐ`UPDATE`ºÍ`DELETE`Óï¾äÏà¶Ô±È½Ï¼òµ¥£¬ÎÒÃǶ¨Òå·½·¨ÈçÏ£º +执行`UPDATE`å’Œ`DELETE`语å�¥ç›¸å¯¹æ¯”较简å�•,我们定义方法如下: ``` @Update("UPDATE users SET name = #{user.name}, createdAt = #{user.createdAt} WHERE id = #{user.id}") @@ -1118,29 +1118,29 @@ void deleteById(@Param("id") long id); ``` -ÓÐÁË`UserMapper`½Ó¿Ú£¬»¹ÐèÒª¶ÔÓ¦µÄʵÏÖÀà²ÅÄÜÕæÕýÖ´ÐÐÕâЩÊý¾Ý¿â²Ù×÷µÄ·½·¨¡£ËäÈ»¿ÉÒÔ×Ô¼ºÐ´ÊµÏÖÀ࣬µ«ÎÒÃdzýÁ˱àд`UserMapper`½Ó¿ÚÍ⣬»¹ÓÐ`BookMapper`¡¢`BonusMapper`¡­¡­Ò»¸öÒ»¸öд̫Âé·³£¬Òò´Ë£¬MyBatisÌṩÁËÒ»¸ö`MapperFactoryBean`À´×Ô¶¯´´½¨ËùÓÐMapperµÄʵÏÖÀà¡£¿ÉÒÔÓÃÒ»¸ö¼òµ¥µÄ×¢½âÀ´ÆôÓÃËü£º +有了`UserMapper`接å�£ï¼Œè¿˜éœ€è¦�对应的实现类æ‰�能真正执行这些数æ�®åº“æ“�作的方法。虽然å�¯ä»¥è‡ªå·±å†™å®žçŽ°ç±»ï¼Œä½†æˆ‘ä»¬é™¤äº†ç¼–å†™`UserMapper`接å�£å¤–,还有`BookMapper`ã€�`BonusMapper`……一个一个写太麻烦,因此,MyBatisæ��供了一个`MapperFactoryBean`æ�¥è‡ªåŠ¨åˆ›å»ºæ‰€æœ‰Mapper的实现类。å�¯ä»¥ç”¨ä¸€ä¸ªç®€å�•的注解æ�¥å�¯ç”¨å®ƒï¼š ``` @MapperScan("com.itranswarp.learnjava.mapper") -...ÆäËû×¢½â... +...其他注解... public class AppConfig { ... } ``` -ÓÐÁË`@MapperScan`£¬¾Í¿ÉÒÔÈÃMyBatis×Ô¶¯É¨ÃèÖ¸¶¨°üµÄËùÓÐMapper²¢´´½¨ÊµÏÖÀà¡£ÔÚÕæÕýµÄÒµÎñÂß¼­ÖУ¬ÎÒÃÇ¿ÉÒÔÖ±½Ó×¢È룺 +有了`@MapperScan`,就å�¯ä»¥è®©MyBatis自动扫æ��指定包的所有Mapper并创建实现类。在真正的业务逻辑中,我们å�¯ä»¥ç›´æŽ¥æ³¨å…¥ï¼š ``` @Component @Transactional public class UserService { - // ×¢ÈëUserMapper: + // 注入UserMapper: @Autowired UserMapper userMapper; public User getUserById(long id) { - // µ÷ÓÃMapper·½·¨: + // 调用Mapper方法: User user = userMapper.getById(id); if (user == null) { throw new RuntimeException("User not found by id."); @@ -1151,11 +1151,11 @@ public class UserService { ``` -¿É¼û£¬ÒµÎñÂß¼­Ö÷Òª¾ÍÊÇͨ¹ý`XxxMapper`¶¨ÒåµÄÊý¾Ý¿â·½·¨À´·ÃÎÊÊý¾Ý¿â¡£ +å�¯è§�,业务逻辑主è¦�就是通过`XxxMapper`定义的数æ�®åº“方法æ�¥è®¿é—®æ•°æ�®åº“。 -### XMLÅäÖà +### XMLé…�ç½® -ÉÏÊöÔÚSpringÖм¯³ÉMyBatisµÄ·½Ê½£¬ÎÒÃÇÖ»ÐèÒªÓõ½×¢½â£¬²¢Ã»ÓÐÈκÎXMLÅäÖÃÎļþ¡£MyBatisÒ²ÔÊÐíʹÓÃXMLÅäÖÃÓ³Éä¹ØÏµºÍSQLÓï¾ä£¬ÀýÈ磬¸üÐÂ`User`ʱ¸ù¾ÝÊôÐÔÖµ¹¹Ô춯̬SQL£º +上述在Spring中集æˆ�MyBatis的方å¼�,我们å�ªéœ€è¦�用到注解,并没有任何XMLé…�置文件。MyBatis也å…�许使用XMLé…�置映射关系和SQL语å�¥ï¼Œä¾‹å¦‚,更新`User`æ—¶æ ¹æ�®å±žæ€§å€¼æž„造动æ€�SQL: ``` @@ -1170,11 +1170,11 @@ public class UserService { ``` -±àдXMLÅäÖõÄÓŵãÊÇ¿ÉÒÔ×é×°³ö¶¯Ì¬SQL£¬²¢ÇÒ°ÑËùÓÐSQL²Ù×÷¼¯ÖÐÔÚÒ»Æð¡£È±µãÊÇÅäÖÃÆðÀ´Ì«·±Ëö£¬µ÷Ó÷½·¨Ê±Èç¹ûÏë²é¿´SQL»¹ÐèÒª¶¨Î»µ½XMLÅäÖÃÖС£ÕâÀïÎÒÃDz»½éÉÜXMLµÄÅäÖ÷½Ê½£¬ÐèÒªÁ˽âµÄͯЬÇë×ÔÐÐÔĶÁ[¹Ù·½Îĵµ](https://mybatis.org/mybatis-3/zh/configuration.html)¡£ +编写XMLé…�置的优点是å�¯ä»¥ç»„装出动æ€�SQL,并且把所有SQLæ“�作集中在一起。缺点是é…�置起æ�¥å¤ªç¹�ç��,调用方法时如果想查看SQL还需è¦�定ä½�到XMLé…�置中。这里我们ä¸�介ç»�XMLçš„é…�置方å¼�,需è¦�了解的童鞋请自行阅读[官方文档](https://mybatis.org/mybatis-3/zh/configuration.html)。 -ʹÓÃMyBatis×î´óµÄÎÊÌâÊÇËùÓÐSQL¶¼ÐèҪȫ²¿ÊÖд£¬ÓŵãÊÇÖ´ÐеÄSQL¾ÍÊÇÎÒÃÇ×Ô¼ºÐ´µÄSQL£¬¶ÔSQL½øÐÐÓÅ»¯·Ç³£¼òµ¥£¬Ò²¿ÉÒÔ±àдÈÎÒ⸴ÔÓµÄSQL£¬»òÕßʹÓÃÊý¾Ý¿âµÄÌØ¶¨Óï·¨£¬µ«Çл»Êý¾Ý¿â¿ÉÄܾͲ»Ì«ÈÝÒס£ºÃÏûÏ¢ÊǴ󲿷ÖÏîÄ¿²¢Ã»ÓÐÇл»Êý¾Ý¿âµÄÐèÇó£¬ÍêÈ«¿ÉÒÔÕë¶Ôij¸öÊý¾Ý¿â±àд¾¡¿ÉÄÜÓÅ»¯µÄSQL¡£ +使用MyBatis最大的问题是所有SQL都需è¦�全部手写,优点是执行的SQL就是我们自己写的SQL,对SQL进行优化é�žå¸¸ç®€å�•,也å�¯ä»¥ç¼–写任æ„�å¤�æ�‚çš„SQL,或者使用数æ�®åº“的特定语法,但切æ�¢æ•°æ�®åº“å�¯èƒ½å°±ä¸�太容易。好消æ�¯æ˜¯å¤§éƒ¨åˆ†é¡¹ç›®å¹¶æ²¡æœ‰åˆ‡æ�¢æ•°æ�®åº“的需求,完全å�¯ä»¥é’ˆå¯¹æŸ�个数æ�®åº“编写尽å�¯èƒ½ä¼˜åŒ–çš„SQL。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\240\241\351\252\214\345\212\237\350\203\275\347\232\204\346\224\257\346\214\201.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\240\241\351\252\214\345\212\237\350\203\275\347\232\204\346\224\257\346\214\201.md" index de8dba7..db0808d 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\240\241\351\252\214\345\212\237\350\203\275\347\232\204\346\224\257\346\214\201.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\345\257\271\344\272\216\346\240\241\351\252\214\345\212\237\350\203\275\347\232\204\346\224\257\346\214\201.md" @@ -1,12 +1,12 @@ -# Spring УÑé +# Spring 校验 -Java API ¹æ·¶(`JSR303`)¶¨ÒåÁË`Bean`УÑéµÄ±ê×¼`validation-api`£¬µ«Ã»ÓÐÌṩʵÏÖ¡£`hibernate validation`ÊǶÔÕâ¸ö¹æ·¶µÄʵÏÖ£¬²¢Ôö¼ÓÁËУÑé×¢½âÈç`@Email`¡¢`@Length`µÈ¡£`Spring Validation`ÊǶÔ`hibernate validation`µÄ¶þ´Î·â×°£¬ÓÃÓÚÖ§³Ö`spring mvc`²ÎÊý×Ô¶¯Ð£Ñé¡£ +Java API 规范(`JSR303`)定义了`Bean`校验的标准`validation-api`,但没有æ��供实现。`hibernate validation`是对这个规范的实现,并增加了校验注解如`@Email`ã€�`@Length`等。`Spring Validation`是对`hibernate validation`的二次å°�装,用于支æŒ�`spring mvc`å�‚数自动校验。 -## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8)¿ìËÙÈëÃÅ +## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8)快速入门 -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%BC%95%E5%85%A5%E4%BE%9D%E8%B5%96)ÒýÈëÒÀÀµ +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%BC%95%E5%85%A5%E4%BE%9D%E8%B5%96)引入ä¾�èµ– -Èç¹û spring-boot °æ±¾Ð¡ÓÚ 2.3.x£¬spring-boot-starter-web »á×Ô¶¯´«Èë hibernate-validator ÒÀÀµ¡£Èç¹û spring-boot °æ±¾´óÓÚ 2.3.x£¬ÔòÐèÒªÊÖ¶¯ÒýÈëÒÀÀµ£º +如果 spring-boot 版本å°�于 2.3.x,spring-boot-starter-web 会自动传入 hibernate-validator ä¾�赖。如果 spring-boot 版本大于 2.3.x,则需è¦�手动引入ä¾�赖: @@ -21,16 +21,16 @@ Java API -¶ÔÓÚ web ·þÎñÀ´Ëµ£¬Îª·ÀÖ¹·Ç·¨²ÎÊý¶ÔÒµÎñÔì³ÉÓ°Ï죬ÔÚ Controller ²ãÒ»¶¨Òª×ö²ÎÊýУÑéµÄ£¡´ó²¿·ÖÇé¿öÏ£¬ÇëÇó²ÎÊý·ÖΪÈçÏÂÁ½ÖÖÐÎʽ£º +对于 web æœ�务æ�¥è¯´ï¼Œä¸ºé˜²æ­¢é�žæ³•å�‚数对业务造æˆ�å½±å“�,在 Controller 层一定è¦�å�šå�‚数校验的ï¼�大部分情况下,请求å�‚数分为如下两ç§�å½¢å¼�: -* POST¡¢PUT ÇëÇó£¬Ê¹Óà requestBody ´«µÝ²ÎÊý£» -* GET ÇëÇó£¬Ê¹Óà requestParam/PathVariable ´«µÝ²ÎÊý¡£ +* POSTã€�PUT 请求,使用 requestBody 传递å�‚æ•°ï¼› +* GET 请求,使用 requestParam/PathVariable 传递å�‚数。 -ʵ¼ÊÉÏ£¬²»¹ÜÊÇ requestBody ²ÎÊýУÑ黹ÊÇ·½·¨¼¶±ðµÄУÑ飬×îÖÕ¶¼Êǵ÷Óà Hibernate Validator Ö´ÐÐУÑ飬Spring Validation Ö»ÊÇ×öÁËÒ»²ã·â×°¡£ +实际上,ä¸�管是 requestBody å�‚数校验还是方法级别的校验,最终都是调用 Hibernate Validator 执行校验,Spring Validation å�ªæ˜¯å�šäº†ä¸€å±‚å°�装。 -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E6%A0%A1%E9%AA%8C%E7%A4%BA%E4%BE%8B)УÑéʾÀý +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E6%A0%A1%E9%AA%8C%E7%A4%BA%E4%BE%8B)校验示例 -£¨1£©ÔÚʵÌåÉϱê¼ÇУÑé×¢½â +(1)在实体上标记校验注解 @@ -57,7 +57,7 @@ public class User implements Serializable { -£¨2£©ÔÚ·½·¨²ÎÊýÉÏÉùÃ÷УÑé×¢½â +(2)在方法å�‚数上声明校验注解 @@ -69,16 +69,16 @@ public class User implements Serializable { public class ValidatorController { /** - * {@link RequestBody} ²ÎÊýУÑé + * {@link RequestBody} å�‚数校验 */ @PostMapping(value = "save") public DataResult save(@Valid @RequestBody User entity) { - log.info("±£´æÒ»Ìõ¼Ç¼£º{}", JSONUtil.toJsonStr(entity)); + log.info("ä¿�存一æ�¡è®°å½•:{}", JSONUtil.toJsonStr(entity)); return DataResult.ok(true); } /** - * {@link RequestParam} ²ÎÊýУÑé + * {@link RequestParam} å�‚数校验 */ @GetMapping(value = "queryByName") public DataResult queryByName( @@ -92,11 +92,11 @@ public class ValidatorController { } /** - * {@link PathVariable} ²ÎÊýУÑé + * {@link PathVariable} å�‚数校验 */ @GetMapping(value = "detail/{id}") public DataResult detail(@PathVariable("id") @Min(1L) Long id) { - User user = new User(id, "ÀîËÄ", 18); + User user = new User(id, "æ�Žå››", 18); return DataResult.ok(user); } @@ -106,11 +106,11 @@ public class ValidatorController { -£¨3£©Èç¹ûÇëÇó²ÎÊý²»Âú×ãУÑ鹿Ôò£¬Ôò»áÅ׳ö `ConstraintViolationException` »ò `MethodArgumentNotValidException` Òì³£¡£ +(3)如果请求å�‚æ•°ä¸�满足校验规则,则会抛出 `ConstraintViolationException` 或 `MethodArgumentNotValidException` 异常。 -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E7%BB%9F%E4%B8%80%E5%BC%82%E5%B8%B8%E5%A4%84%E7%90%86)ͳһÒì³£´¦Àí +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E7%BB%9F%E4%B8%80%E5%BC%82%E5%B8%B8%E5%A4%84%E7%90%86)统一异常处ç�† -ÔÚʵ¼ÊÏîÄ¿¿ª·¢ÖУ¬Í¨³£»áÓÃͳһÒì³£´¦ÀíÀ´·µ»ØÒ»¸ö¸üÓѺõÄÌáʾ¡£ +在实际项目开å�‘中,通常会用统一异常处ç�†æ�¥è¿”回一个更å�‹å¥½çš„æ��示。 @@ -120,18 +120,18 @@ public class ValidatorController { public class GlobalExceptionHandler { /** - * ´¦ÀíËùÓв»¿ÉÖªµÄÒì³£ + * 处ç�†æ‰€æœ‰ä¸�å�¯çŸ¥çš„异常 */ @ResponseBody @ResponseStatus(HttpStatus.OK) @ExceptionHandler(Throwable.class) public Result handleException(Throwable e) { - log.error("δ֪Òì³£", e); + log.error("未知异常", e); return new Result(ResultStatus.HTTP_SERVER_ERROR.getCode(), e.getMessage()); } /** - * ͳһ´¦ÀíÇëÇó²ÎÊýУÑéÒì³£(ÆÕͨ´«²Î) + * 统一处ç�†è¯·æ±‚å�‚数校验异常(普通传å�‚) * * @param e ConstraintViolationException * @return {@link DataResult} @@ -151,7 +151,7 @@ public class GlobalExceptionHandler { } /** - * ´¦Àí²ÎÊýУÑéÒì³£ + * 处ç�†å�‚数校验异常 * * @param e MethodArgumentNotValidException * @return {@link DataResult} @@ -174,13 +174,13 @@ public class GlobalExceptionHandler { -## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E8%BF%9B%E9%98%B6%E4%BD%BF%E7%94%A8)½ø½×ʹÓà +## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E8%BF%9B%E9%98%B6%E4%BD%BF%E7%94%A8)进阶使用 -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%88%86%E7%BB%84%E6%A0%A1%E9%AA%8C)·Ö×éУÑé +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%88%86%E7%BB%84%E6%A0%A1%E9%AA%8C)分组校验 -ÔÚʵ¼ÊÏîÄ¿ÖУ¬¿ÉÄܶà¸ö·½·¨ÐèҪʹÓÃͬһ¸ö DTO ÀàÀ´½ÓÊÕ²ÎÊý£¬¶ø²»Í¬·½·¨µÄУÑ鹿ÔòºÜ¿ÉÄÜÊDz»Ò»ÑùµÄ¡£Õâ¸öʱºò£¬¼òµ¥µØÔÚ DTO ÀàµÄ×Ö¶ÎÉϼÓÔ¼Êø×¢½âÎÞ·¨½â¾öÕâ¸öÎÊÌâ¡£Òò´Ë£¬spring-validation Ö§³ÖÁË·Ö×éУÑéµÄ¹¦ÄÜ£¬×¨ÃÅÓÃÀ´½â¾öÕâÀàÎÊÌâ¡£ +在实际项目中,å�¯èƒ½å¤šä¸ªæ–¹æ³•需è¦�使用å�Œä¸€ä¸ª DTO ç±»æ�¥æŽ¥æ”¶å�‚数,而ä¸�å�Œæ–¹æ³•的校验规则很å�¯èƒ½æ˜¯ä¸�一样的。这个时候,简å�•地在 DTO 类的字段上加约æ�Ÿæ³¨è§£æ— æ³•解决这个问题。因此,spring-validation 支æŒ�了分组校验的功能,专门用æ�¥è§£å†³è¿™ç±»é—®é¢˜ã€‚ -£¨1£©¶¨Òå·Ö×é +(1)定义分组 @@ -197,7 +197,7 @@ public @interface EditCheck { } -£¨2£©ÔÚʵÌåÉϱê¼ÇУÑé×¢½â +(2)在实体上标记校验注解 @@ -212,7 +212,7 @@ public class User2 { @Size(min = 2, max = 10, groups = { AddCheck.class, EditCheck.class }) private String name; - @IsMobile(message = "²»ÊÇÓÐЧÊÖ»úºÅ", groups = { AddCheck.class, EditCheck.class }) + @IsMobile(message = "ä¸�是有效手机å�·", groups = { AddCheck.class, EditCheck.class }) private String mobile; } @@ -221,7 +221,7 @@ public class User2 { -£¨3£©ÔÚ·½·¨Éϸù¾Ý²»Í¬³¡¾°½øÐÐУÑé·Ö×é +(3)在方法上根æ�®ä¸�å�Œåœºæ™¯è¿›è¡Œæ ¡éªŒåˆ†ç»„ @@ -233,20 +233,20 @@ public class User2 { public class ValidatorController2 { /** - * {@link RequestBody} ²ÎÊýУÑé + * {@link RequestBody} å�‚数校验 */ @PostMapping(value = "add") public DataResult add(@Validated(AddCheck.class) @RequestBody User2 entity) { - log.info("Ìí¼ÓÒ»Ìõ¼Ç¼£º{}", JSONUtil.toJsonStr(entity)); + log.info("添加一æ�¡è®°å½•:{}", JSONUtil.toJsonStr(entity)); return DataResult.ok(true); } /** - * {@link RequestBody} ²ÎÊýУÑé + * {@link RequestBody} å�‚数校验 */ @PostMapping(value = "edit") public DataResult edit(@Validated(EditCheck.class) @RequestBody User2 entity) { - log.info("±à¼­Ò»Ìõ¼Ç¼£º{}", JSONUtil.toJsonStr(entity)); + log.info("编辑一æ�¡è®°å½•:{}", JSONUtil.toJsonStr(entity)); return DataResult.ok(true); } @@ -256,9 +256,9 @@ public class ValidatorController2 { -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%B5%8C%E5%A5%97%E6%A0%A1%E9%AA%8C)ǶÌ×УÑé +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%B5%8C%E5%A5%97%E6%A0%A1%E9%AA%8C)嵌套校验 -Ç°ÃæµÄʾÀýÖУ¬DTO ÀàÀïÃæµÄ×ֶζ¼ÊÇ»ù±¾Êý¾ÝÀàÐÍºÍ String ÀàÐÍ¡£µ«ÊÇʵ¼Ê³¡¾°ÖУ¬ÓпÉÄÜij¸ö×Ö¶ÎÒ²ÊÇÒ»¸ö¶ÔÏó£¬ÕâÖÖÇé¿öÏÈ£¬¿ÉÒÔʹÓÃǶÌ×УÑé¡£ post ±ÈÈ磬ÉÏÃæ±£´æ User ÐÅÏ¢µÄʱºòͬʱ»¹´øÓÐ Job ÐÅÏ¢¡£ÐèҪעÒâµÄÊÇ£¬´Ëʱ DTO ÀàµÄ¶ÔÓ¦×ֶαØÐë±ê¼Ç@Valid ×¢½â¡£ +å‰�é�¢çš„示例中,DTO 类里é�¢çš„字段都是基本数æ�®ç±»åž‹å’Œ String 类型。但是实际场景中,有å�¯èƒ½æŸ�个字段也是一个对象,这ç§�情况先,å�¯ä»¥ä½¿ç”¨åµŒå¥—校验。 post 比如,上é�¢ä¿�å­˜ User ä¿¡æ�¯çš„æ—¶å€™å�Œæ—¶è¿˜å¸¦æœ‰ Job ä¿¡æ�¯ã€‚需è¦�注æ„�的是,此时 DTO 类的对应字段必须标记@Valid 注解。 @@ -301,28 +301,28 @@ public class UserDTO { } /** - * ±£´æµÄʱºòУÑé·Ö×é + * ä¿�存的时候校验分组 */ public interface Save { } /** - * ¸üеÄʱºòУÑé·Ö×é + * 更新的时候校验分组 */ public interface Update { } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ǶÌ×УÑé¿ÉÒÔ½áºÏ·Ö×éУÑéÒ»ÆðʹÓ᣻¹ÓоÍÊÇǶÌ×¼¯ºÏУÑé»á¶Ô¼¯ºÏÀïÃæµÄÿһÏî¶¼½øÐÐУÑ飬ÀýÈç`List`×ֶλá¶ÔÕâ¸ö list ÀïÃæµÄÿһ¸ö Job ¶ÔÏó¶¼½øÐÐУÑé +嵌套校验å�¯ä»¥ç»“å�ˆåˆ†ç»„校验一起使用。还有就是嵌套集å�ˆæ ¡éªŒä¼šå¯¹é›†å�ˆé‡Œé�¢çš„æ¯�一项都进行校验,例如`List`字段会对这个 list 里é�¢çš„æ¯�一个 Job 对象都进行校验 -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%A0%A1%E9%AA%8C%E6%B3%A8%E8%A7%A3)×Ô¶¨ÒåУÑé×¢½â +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%A0%A1%E9%AA%8C%E6%B3%A8%E8%A7%A3)自定义校验注解 -£¨1£©×Ô¶¨ÒåУÑé×¢½â `@IsMobile` +(1)自定义校验注解 `@IsMobile` @@ -344,7 +344,7 @@ public @interface IsMobile { -£¨2£©ÊµÏÖ `ConstraintValidator` ½Ó¿Ú£¬±àд `@IsMobile` УÑé×¢½âµÄ½âÎöÆ÷ +(2)实现 `ConstraintValidator` 接å�£ï¼Œç¼–写 `@IsMobile` 校验注解的解æž�器 @@ -376,18 +376,18 @@ public class MobileValidator implements ConstraintValidator { -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%A0%A1%E9%AA%8C)×Ô¶¨ÒåУÑé +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%A0%A1%E9%AA%8C)自定义校验 -¿ÉÒÔͨ¹ýʵÏÖ `org.springframework.validation.Validator` ½Ó¿ÚÀ´×Ô¶¨ÒåУÑé¡£ +å�¯ä»¥é€šè¿‡å®žçް `org.springframework.validation.Validator` 接å�£æ�¥è‡ªå®šä¹‰æ ¡éªŒã€‚ -ÓÐÒÔÏÂÒªµã +有以下è¦�点 -* ʵÏÖ `supports` ·½·¨ -* ʵÏÖ `validate` ·½·¨ - * ͨ¹ý `Errors` ¶ÔÏóÊÕ¼¯´íÎó - * `ObjectError`£º¶ÔÏó£¨Bean£©´íÎó£º - * `FieldError`£º¶ÔÏó£¨Bean£©ÊôÐÔ£¨Property£©´íÎó - * ͨ¹ý `ObjectError` ºÍ `FieldError` ¹ØÁª `MessageSource` ʵÏÖ»ñÈ¡×îÖյĴíÎóÎݸ +* 实现 `supports` 方法 +* 实现 `validate` 方法 + * 通过 `Errors` 对象收集错误 + * `ObjectError`:对象(Bean)错误: + * `FieldError`:对象(Bean)属性(Property)错误 + * 通过 `ObjectError` å’Œ `FieldError` å…³è�” `MessageSource` 实现获å�–最终的错误文案 @@ -418,7 +418,7 @@ public class CustomValidator implements Validator { } /** - * ±¾Ð£ÑéÆ÷Ö»Õë¶Ô Person ¶ÔÏó½øÐÐУÑé + * 本校验器å�ªé’ˆå¯¹ Person 对象进行校验 */ @Override public boolean supports(Class clazz) { @@ -448,11 +448,11 @@ public class CustomValidator implements Validator { } private List getFields(Class clazz) { - // ÉùÃ÷FieldÊý×é + // 声明Field数组 List fields = new ArrayList<>(); - // Èç¹ûclassÀàÐͲ»Îª¿Õ + // 如果class类型ä¸�为空 while (clazz != null) { - // Ìí¼ÓÊôÐÔµ½ÊôÐÔÊý×é + // 添加属性到属性数组 Collections.addAll(fields, clazz.getDeclaredFields()); clazz = clazz.getSuperclass(); } @@ -465,9 +465,9 @@ public class CustomValidator implements Validator { -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%BF%AB%E9%80%9F%E5%A4%B1%E8%B4%A5-fail-fast)¿ìËÙʧ°Ü(Fail Fast) +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%BF%AB%E9%80%9F%E5%A4%B1%E8%B4%A5-fail-fast)快速失败(Fail Fast) -Spring Validation ĬÈÏ»áУÑéÍêËùÓÐ×ֶΣ¬È»ºó²ÅÅ׳öÒì³£¡£¿ÉÒÔͨ¹ýһЩ¼òµ¥µÄÅäÖ㬿ªÆô Fali Fast ģʽ£¬Ò»µ©Ð£Ñéʧ°Ü¾ÍÁ¢¼´·µ»Ø¡£ +Spring Validation 默认会校验完所有字段,然å�Žæ‰�抛出异常。å�¯ä»¥é€šè¿‡ä¸€äº›ç®€å�•çš„é…�置,开å�¯ Fali Fast 模å¼�,一旦校验失败就立å�³è¿”回。 @@ -476,7 +476,7 @@ Spring Validation Ĭ public Validator validator() { ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) .configure() - // ¿ìËÙʧ°Üģʽ + // 快速失败模å¼� .failFast(true) .buildValidatorFactory(); return validatorFactory.getValidator(); @@ -486,51 +486,51 @@ public Validator validator() { -## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#spring-%E6%A0%A1%E9%AA%8C%E5%8E%9F%E7%90%86)Spring УÑéÔ­Àí +## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#spring-%E6%A0%A1%E9%AA%8C%E5%8E%9F%E7%90%86)Spring 校验原ç�† -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#spring-%E6%A0%A1%E9%AA%8C%E4%BD%BF%E7%94%A8%E5%9C%BA%E6%99%AF)Spring УÑéʹÓó¡¾° +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#spring-%E6%A0%A1%E9%AA%8C%E4%BD%BF%E7%94%A8%E5%9C%BA%E6%99%AF)Spring 校验使用场景 -* Spring ³£¹æÐ£Ñ飨Validator£© -* Spring Êý¾Ý°ó¶¨£¨DataBinder£© -* Spring Web ²ÎÊý°ó¶¨£¨WebDataBinder£© -* Spring WebMVC/WebFlux ´¦Àí·½·¨²ÎÊýУÑé +* Spring 常规校验(Validator) +* Spring æ•°æ�®ç»‘定(DataBinder) +* Spring Web å�‚数绑定(WebDataBinder) +* Spring WebMVC/WebFlux 处ç�†æ–¹æ³•å�‚数校验 -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#validator-%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1)Validator ½Ó¿ÚÉè¼Æ +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#validator-%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1)Validator 接å�£è®¾è®¡ -* ½Ó¿ÚÖ°Ôð - * Spring ÄÚ²¿Ð£ÑéÆ÷½Ó¿Ú£¬Í¨¹ý±à³ÌµÄ·½Ê½Ð£ÑéÄ¿±ê¶ÔÏó -* ºËÐÄ·½·¨ - * `supports(Class)`£ºÐ£ÑéÄ¿±êÀàÄÜ·ñУÑé - * `validate(Object,Errors)`£ºÐ£ÑéÄ¿±ê¶ÔÏ󣬲¢½«Ð£Ñéʧ°ÜµÄÄÚÈÝÊä³öÖÁ Errors ¶ÔÏó -* ÅäÌ××é¼þ - * ´íÎóÊÕ¼¯Æ÷£º`org.springframework.validation.Errors` - * Validator ¹¤¾ßÀࣺ`org.springframework.validation.ValidationUtils` +* 接å�£è�Œè´£ + * Spring 内部校验器接å�£ï¼Œé€šè¿‡ç¼–程的方å¼�校验目标对象 +* 核心方法 + * `supports(Class)`:校验目标类能å�¦æ ¡éªŒ + * `validate(Object,Errors)`:校验目标对象,并将校验失败的内容输出至 Errors 对象 +* é…�套组件 + * 错误收集器:`org.springframework.validation.Errors` + * Validator 工具类:`org.springframework.validation.ValidationUtils` -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#errors-%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1)Errors ½Ó¿ÚÉè¼Æ +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#errors-%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1)Errors 接å�£è®¾è®¡ -* ½Ó¿ÚÖ°Ôð - * Êý¾Ý°ó¶¨ºÍУÑé´íÎóÊÕ¼¯½Ó¿Ú£¬Óë Java Bean ºÍÆäÊôÐÔÓÐÇ¿¹ØÁªÐÔ -* ºËÐÄ·½·¨ - * `reject` ·½·¨£¨ÖØÔØ£©£ºÊÕ¼¯´íÎóÎݸ - * `rejectValue` ·½·¨£¨ÖØÔØ£©£ºÊÕ¼¯¶ÔÏó×Ö¶ÎÖеĴíÎóÎݸ -* ÅäÌ××é¼þ - * Java Bean ´íÎóÃèÊö£º`org.springframework.validation.ObjectError` - * Java Bean ÊôÐÔ´íÎóÃèÊö£º`org.springframework.validation.FieldError` +* 接å�£è�Œè´£ + * æ•°æ�®ç»‘定和校验错误收集接å�£ï¼Œä¸Ž Java Bean 和其属性有强关è�”性 +* 核心方法 + * `reject` 方法(é‡�载):收集错误文案 + * `rejectValue` 方法(é‡�载):收集对象字段中的错误文案 +* é…�套组件 + * Java Bean 错误æ��述:`org.springframework.validation.ObjectError` + * Java Bean 属性错误æ��述:`org.springframework.validation.FieldError` -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#errors-%E6%96%87%E6%A1%88%E6%9D%A5%E6%BA%90)Errors ÎݸÀ´Ô´ +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#errors-%E6%96%87%E6%A1%88%E6%9D%A5%E6%BA%90)Errors 文案æ�¥æº� -Errors ÎݸÉú³É²½Öè +Errors 文案生æˆ�步骤 -* Ñ¡Ôñ Errors ʵÏÖ£¨È磺`org.springframework.validation.BeanPropertyBindingResult`£© -* µ÷Óà reject »ò rejectValue ·½·¨ -* »ñÈ¡ Errors ¶ÔÏóÖÐ ObjectError »ò FieldError -* ½« ObjectError »ò FieldError ÖÐµÄ code ºÍ args£¬¹ØÁª MessageSource ʵÏÖ£¨È磺`ResourceBundleMessageSource`£© +* 选择 Errors 实现(如:`org.springframework.validation.BeanPropertyBindingResult`) +* 调用 reject 或 rejectValue 方法 +* 获å�– Errors 对象中 ObjectError 或 FieldError +* å°† ObjectError 或 FieldError 中的 code å’Œ args,关è�” MessageSource 实现(如:`ResourceBundleMessageSource`) -### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#spring-web-%E6%A0%A1%E9%AA%8C%E5%8E%9F%E7%90%86)spring web УÑéÔ­Àí +### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#spring-web-%E6%A0%A1%E9%AA%8C%E5%8E%9F%E7%90%86)spring web 校验原ç�† -#### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#requestbody-%E5%8F%82%E6%95%B0%E6%A0%A1%E9%AA%8C%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86)RequestBody ²ÎÊýУÑéʵÏÖÔ­Àí +#### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#requestbody-%E5%8F%82%E6%95%B0%E6%A0%A1%E9%AA%8C%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86)RequestBody å�‚数校验实现原ç�† -ÔÚ spring-mvc ÖУ¬`RequestResponseBodyMethodProcessor` ÊÇÓÃÓÚ½âÎö `@RequestBody` ±ê×¢µÄ²ÎÊýÒÔ¼°´¦Àí`@ResponseBody` ±ê×¢·½·¨µÄ·µ»ØÖµµÄ¡£ÆäÖУ¬Ö´ÐвÎÊýУÑéµÄÂß¼­¿Ï¶¨¾ÍÔÚ½âÎö²ÎÊýµÄ·½·¨ `resolveArgument()` ÖУº +在 spring-mvc 中,`RequestResponseBodyMethodProcessor` 是用于解æž� `@RequestBody` 标注的å�‚数以å�Šå¤„ç�†`@ResponseBody` 标注方法的返回值的。其中,执行å�‚数校验的逻辑肯定就在解æž�å�‚数的方法 `resolveArgument()` 中: @@ -546,10 +546,10 @@ public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewC if (binderFactory != null) { WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name); if (arg != null) { - // ³¢ÊÔ½øÐвÎÊýУÑé + // å°�试进行å�‚数校验 validateIfApplicable(binder, parameter); if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) { - // Èç¹û´æÔÚУÑé´íÎó£¬ÔòÅ׳ö MethodArgumentNotValidException + // 如果存在校验错误,则抛出 MethodArgumentNotValidException throw new MethodArgumentNotValidException(parameter, binder.getBindingResult()); } } @@ -565,23 +565,23 @@ public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewC -¿ÉÒÔ¿´µ½£¬resolveArgument()µ÷ÓÃÁË validateIfApplicable()½øÐвÎÊýУÑé¡£ +å�¯ä»¥çœ‹åˆ°ï¼ŒresolveArgument()调用了 validateIfApplicable()进行å�‚数校验。 ``` protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) { - // »ñÈ¡²ÎÊý×¢½â£¬Èç @RequestBody¡¢@Valid¡¢@Validated + // 获å�–å�‚数注解,如 @RequestBodyã€�@Validã€�@Validated Annotation[] annotations = parameter.getParameterAnnotations(); for (Annotation ann : annotations) { - // Ïȳ¢ÊÔ»ñÈ¡ @Validated ×¢½â + // å…ˆå°�试获å�– @Validated 注解 Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class); - // Èç¹û±ê×¢ÁË @Validated£¬Ö±½Ó¿ªÊ¼Ð£Ñé¡£ - // Èç¹ûûÓУ¬ÄÇôÅжϲÎÊýǰÊÇ·ñÓÐ Valid ¿ªÍ·µÄ×¢½â¡£ + // 如果标注了 @Validated,直接开始校验。 + // 如果没有,那么判断å�‚æ•°å‰�是å�¦æœ‰ Valid 开头的注解。 if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) { Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann)); Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints}); - // Ö´ÐÐУÑé + // 执行校验 binder.validate(validationHints); break; } @@ -592,9 +592,9 @@ protected void validateIfApplicable(WebDataBinder binder, MethodParameter parame -ÒÔÉÏ´úÂ룬¾Í½âÊÍÁË Spring ΪʲôÄÜͬʱ֧³Ö `@Validated`¡¢`@Valid` Á½¸ö×¢½â¡£ +以上代ç �,就解释了 Spring 为什么能å�Œæ—¶æ”¯æŒ� `@Validated`ã€�`@Valid` 两个注解。 -½ÓÏÂÀ´£¬¿´Ò»Ï WebDataBinder.validate() µÄʵÏÖ£º +接下æ�¥ï¼Œçœ‹ä¸€ä¸‹ WebDataBinder.validate() 的实现: @@ -603,7 +603,7 @@ protected void validateIfApplicable(WebDataBinder binder, MethodParameter parame public void validate(Object target, Errors errors, Object... validationHints) { if (this.targetValidator != null) { processConstraintViolations( - // ´Ë´¦µ÷Óà Hibernate Validator Ö´ÐÐÕæÕýµÄУÑé + // 此处调用 Hibernate Validator 执行真正的校验 this.targetValidator.validate(target, asValidationGroups(validationHints)), errors); } } @@ -612,11 +612,11 @@ public void validate(Object target, Errors errors, Object... validationHints) { -ͨ¹ýÉÏÃæ´úÂ룬¿ÉÒÔ¿´³ö Spring УÑéʵ¼ÊÉÏÊÇ»ùÓÚ Hibernate Validator µÄ·â×°¡£ +通过上é�¢ä»£ç �,å�¯ä»¥çœ‹å‡º Spring 校验实际上是基于 Hibernate Validator çš„å°�装。 -#### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E6%96%B9%E6%B3%95%E7%BA%A7%E5%88%AB%E7%9A%84%E5%8F%82%E6%95%B0%E6%A0%A1%E9%AA%8C%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86)·½·¨¼¶±ðµÄ²ÎÊýУÑéʵÏÖÔ­Àí +#### [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E6%96%B9%E6%B3%95%E7%BA%A7%E5%88%AB%E7%9A%84%E5%8F%82%E6%95%B0%E6%A0%A1%E9%AA%8C%E5%AE%9E%E7%8E%B0%E5%8E%9F%E7%90%86)方法级别的å�‚数校验实现原ç�† -Spring Ö§³Ö¸ù¾Ý·½·¨È¥½øÐÐÀ¹½Ø¡¢Ð£Ñ飬ԭÀí¾ÍÔÚÓÚÓ¦ÓÃÁË AOP ¼¼Êõ¡£¾ßÌåÀ´Ëµ£¬ÊÇͨ¹ý `MethodValidationPostProcessor` ¶¯Ì¬×¢²á AOP ÇÐÃæ£¬È»ºóʹÓà `MethodValidationInterceptor` ¶ÔÇе㷽·¨Ö¯ÈëÔöÇ¿¡£ +Spring 支æŒ�æ ¹æ�®æ–¹æ³•去进行拦截ã€�校验,原ç�†å°±åœ¨äºŽåº”用了 AOP 技术。具体æ�¥è¯´ï¼Œæ˜¯é€šè¿‡ `MethodValidationPostProcessor` 动æ€�注册 AOP 切é�¢ï¼Œç„¶å�Žä½¿ç”¨ `MethodValidationInterceptor` 对切点方法织入增强。 @@ -624,13 +624,13 @@ Spring Ö§ public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean { @Override public void afterPropertiesSet() { - // ΪËùÓÐ @Validated ±ê×¢µÄ Bean ´´½¨ÇÐÃæ + // 为所有 @Validated 标注的 Bean 创建切é�¢ Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true); - // ´´½¨ Advisor ½øÐÐÔöÇ¿ + // 创建 Advisor 进行增强 this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator)); } - // ´´½¨ Advice£¬±¾ÖʾÍÊÇÒ»¸ö·½·¨À¹½ØÆ÷ + // 创建 Advice,本质就是一个方法拦截器 protected Advice createMethodValidationAdvice(@Nullable Validator validator) { return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor()); } @@ -640,7 +640,7 @@ public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvis -½Ó×Å¿´Ò»Ï `MethodValidationInterceptor`£º +接ç�€çœ‹ä¸€ä¸‹ `MethodValidationInterceptor`: @@ -648,32 +648,32 @@ public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvis public class MethodValidationInterceptor implements MethodInterceptor { @Override public Object invoke(MethodInvocation invocation) throws Throwable { - // ÎÞÐèÔöÇ¿µÄ·½·¨£¬Ö±½ÓÌø¹ý + // 无需增强的方法,直接跳过 if (isFactoryBeanMetadataMethod(invocation.getMethod())) { return invocation.proceed(); } - // »ñÈ¡·Ö×éÐÅÏ¢ + // 获å�–分组信æ�¯ Class[] groups = determineValidationGroups(invocation); ExecutableValidator execVal = this.validator.forExecutables(); Method methodToValidate = invocation.getMethod(); Set> result; try { - // ·½·¨Èë²ÎУÑ飬×îÖÕ»¹ÊÇίÍиø Hibernate Validator À´Ð£Ñé + // 方法入å�‚校验,最终还是委托给 Hibernate Validator æ�¥æ ¡éªŒ result = execVal.validateParameters( invocation.getThis(), methodToValidate, invocation.getArguments(), groups); } catch (IllegalArgumentException ex) { ... } - // ÓÐÒì³£Ö±½ÓÅ׳ö + // 有异常直接抛出 if (!result.isEmpty()) { throw new ConstraintViolationException(result); } - // ÕæÕýµÄ·½·¨µ÷Óà + // 真正的方法调用 Object returnValue = invocation.proceed(); - // ¶Ô·µ»ØÖµ×öУÑ飬×îÖÕ»¹ÊÇίÍиøHibernate ValidatorÀ´Ð£Ñé + // 对返回值å�šæ ¡éªŒï¼Œæœ€ç»ˆè¿˜æ˜¯å§”æ‰˜ç»™Hibernate Validatoræ�¥æ ¡éªŒ result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups); - // ÓÐÒì³£Ö±½ÓÅ׳ö + // 有异常直接抛出 if (!result.isEmpty()) { throw new ConstraintViolationException(result); } @@ -685,26 +685,26 @@ public class MethodValidationInterceptor implements MethodInterceptor { -ʵ¼ÊÉÏ£¬²»¹ÜÊÇ requestBody ²ÎÊýУÑ黹ÊÇ·½·¨¼¶±ðµÄУÑ飬×îÖÕ¶¼Êǵ÷Óà Hibernate Validator Ö´ÐÐУÑ飬Spring Validation Ö»ÊÇ×öÁËÒ»²ã·â×°¡£ +实际上,ä¸�管是 requestBody å�‚数校验还是方法级别的校验,最终都是调用 Hibernate Validator 执行校验,Spring Validation å�ªæ˜¯å�šäº†ä¸€å±‚å°�装。 -## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E9%97%AE%E9%A2%98)ÎÊÌâ +## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E9%97%AE%E9%A2%98)问题 -**Spring ÓÐÄÄЩУÑéºËÐÄ×é¼þ**£¿ +**Spring 有哪些校验核心组件**? -* ¼ìÑéÆ÷£º`org.springframework.validation.Validator` -* ´íÎóÊÕ¼¯Æ÷£º`org.springframework.validation.Errors` -* Java Bean ´íÎóÃèÊö£º`org.springframework.validation.ObjectError` -* Java Bean ÊôÐÔ´íÎóÃèÊö£º`org.springframework.validation.FieldError` -* Bean Validation ÊÊÅ䣺`org.springframework.validation.beanvalidation.LocalValidatorFactoryBean` +* 检验器:`org.springframework.validation.Validator` +* 错误收集器:`org.springframework.validation.Errors` +* Java Bean 错误æ��述:`org.springframework.validation.ObjectError` +* Java Bean 属性错误æ��述:`org.springframework.validation.FieldError` +* Bean Validation 适é…�:`org.springframework.validation.beanvalidation.LocalValidatorFactoryBean` -## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99)²Î¿¼×ÊÁÏ +## [#](https://dunwu.github.io/spring-tutorial/pages/fe6aad/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99)å�‚考资料 -* [Spring ¹Ù·½ÎĵµÖ® Core Technologies(opens new window)](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) -* [¡¶Ð¡Âí¸ç½² Spring ºËÐıà³Ì˼Ïë¡·(opens new window)](https://time.geekbang.org/course/intro/265) +* [Spring 官方文档之 Core Technologies(opens new window)](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) +* [《å°�马哥讲 Spring 核心编程æ€�想》(opens new window)](https://time.geekbang.org/course/intro/265) * https://juejin.cn/post/6856541106626363399 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204Environment\347\216\257\345\242\203\345\217\230\351\207\217.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204Environment\347\216\257\345\242\203\345\217\230\351\207\217.md" index 99987fa..46b8568 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204Environment\347\216\257\345\242\203\345\217\230\351\207\217.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204Environment\347\216\257\345\242\203\345\217\230\351\207\217.md" @@ -2,13 +2,13 @@ -Èç½ñ£¬ÖÂÁ¦ÓÚ°ïÖú¿ª·¢ÕßÓøüÉٵĴúÂë¡¢¸ü¿ìµØÐ´³öÉú²ú¼¶ÏµÍ³µÄ Spring Boot ÒÑÈ»³ÉΪ Java Ó¦Óÿª·¢µÄÊÂʵ±ê×¼¡£ÔÚ Spring Boot ÌṩµÄÖÚ¶àÌØÐÔÖУ¬**×Ô¶¯ÅäÖÃ**ÎÞÒÉÊǶÔÌáÉý¿ª·¢ÌåÑé×îÏÔÖøµÄÒ»¸öÌØÐÔ£¬Spring Boot »ùÓÚÕâÒ»ÌØÐÔΪ¿ª·¢ÈËÔ±×Ô¶¯ÉùÃ÷ÁËÈô¸É¿ªÏä¼´Óᢾ߱¸Ä³Ò»¹¦ÄÜµÄ Bean¡£´ó¶àÊýÇé¿öÏ£¬×Ô¶¯ÅäÖÃµÄ Bean ¸ÕºÃÄÜÂú×ã´ó¼ÒµÄÐèÇ󣬵«ÔÚijЩÇé¿öÏ£¬²»µÃ²»ÍêÕûµØ¸²¸ÇËüÃÇ£¬Õâ¸öʱºòÖ»ÐèÒªÖØÐÂÉùÃ÷Ïà¹ØÀàÐ굀 Bean ¼´¿É£¬ÒòΪ¾ø´ó¶àÊý×Ô¶¯ÅäÖÃµÄ Bean ¶¼»áÓÉ`@ConditionalOnMissingBean`×¢½âÐÞÊΡ£ÐÒÔ˵ÄÊÇ£¬Èç¹ûÖ»ÊÇÏë΢µ÷һЩϸ½Ú£¬±ÈÈç¸Ä¸Ä¶Ë¿ÚºÅ (server.port) ºÍÊý¾ÝÔ´ URL (spring.datasource.url) £¬ÄÇѹ¸ùû±ØÒªÖØÐÂÉùÃ÷`ServerProperties`ºÍ`DataSourceProperties`ÕâÁ© Bean À´¸²¸Ç×Ô¶¯ÅäÖÃµÄ Bean¡£ Spring Boot Ϊ×Ô¶¯ÅäÖÃµÄ Bean ÌṩÁË1000¶à¸öÓÃÓÚ΢µ÷µÄÊôÐÔ£¬µ±ÐèÒªµ÷ÕûÉèÖÃʱ£¬Ö»ÐèÒªÔÚ»·¾³±äÁ¿¡¢ÃüÁîÐвÎÊý»òÅäÖÃÎļþ (application.properties/application.yml) ÖнøÐÐÖ¸¶¨¼´¿É£¬Õâ¾ÍÊÇ Spring Boot µÄ`Externalized Configuration` (ÅäÖÃÍ⻯) ÌØÐÔ¡£ +如今,致力于帮助开å�‘者用更少的代ç �ã€�更快地写出生产级系统的 Spring Boot 已然æˆ�为 Java 应用开å�‘的事实标准。在 Spring Boot æ��供的众多特性中,**自动é…�ç½®**无疑是对æ��å�‡å¼€å�‘体验最显著的一个特性,Spring Boot 基于这一特性为开å�‘人员自动声明了若干开箱å�³ç”¨ã€�具备æŸ�一功能的 Bean。大多数情况下,自动é…�置的 Bean 刚好能满足大家的需求,但在æŸ�些情况下,ä¸�å¾—ä¸�完整地覆盖它们,这个时候å�ªéœ€è¦�é‡�新声明相关类型的 Bean å�³å�¯ï¼Œå› ä¸ºç»�大多数自动é…�置的 Bean 都会由`@ConditionalOnMissingBean`注解修饰。幸è¿�的是,如果å�ªæ˜¯æƒ³å¾®è°ƒä¸€äº›ç»†èŠ‚ï¼Œæ¯”å¦‚æ”¹æ”¹ç«¯å�£å�· (server.port) 和数æ�®æº� URL (spring.datasource.url) ,那压根没必è¦�é‡�新声明`ServerProperties`å’Œ`DataSourceProperties`这俩 Bean æ�¥è¦†ç›–自动é…�置的 Bean。 Spring Boot 为自动é…�置的 Bean æ��供了1000多个用于微调的属性,当需è¦�调整设置时,å�ªéœ€è¦�在环境å�˜é‡�ã€�命令行å�‚数或é…�置文件 (application.properties/application.yml) 中进行指定å�³å�¯ï¼Œè¿™å°±æ˜¯ Spring Boot çš„`Externalized Configuration` (é…�置外化) 特性。 -µ±È»£¬ÍⲿÅäÖÃÔ´²¢²»¾ÖÏÞÓÚ»·¾³±äÁ¿¡¢ÃüÁîÐвÎÊýºÍÅäÖÃÎļþÕâÈýÖÖ£¬¸ÐÐËȤµÄ¶ÁÕß¿ÉÒÔ×ÔÐÐÔĶÁ Spring Boot ¹Ù·½Îĵµ¡£ÔÚ Spring ÖУ¬`BeanFactory`°çÑÝ×Å Bean ÈÝÆ÷µÄ½ÇÉ«£¬¶ø`Environment`ͬÑù¶¨Î»ÎªÒ»¸öÈÝÆ÷£¬¼´ÍⲿÅäÖÃÔ´ÖеÄÊôÐÔ¶¼»á±»Ìí¼Óµ½ _Environment_ ÖС£**ÔÚ΢·þÎñ´óÐÐÆäµÀµÄ½ñÌ죬ÍⲿÅäÖÃÔ´ÓÖÑÜÉú³öÁË_Disconf_¡¢_Apollo_ ºÍ _Nacos_ µÈ·Ö²¼Ê½ÅäÖÃÖÐÐÄ£¬µ«ÔÚ Spring µÄµØÅÌ£¬»¹ÊÇÒªÈëÏçËæË×£¬´ÓÅäÖÃÖÐÐÄÖжÁÈ¡µ½µÄÊôÐÔÒÀÈ»»á±»×·¼Óµ½ _Environment_ ÖÐ**¡£ +当然,外部é…�ç½®æº�å¹¶ä¸�å±€é™�于环境å�˜é‡�ã€�命令行å�‚æ•°å’Œé…�置文件这三ç§�,感兴趣的读者å�¯ä»¥è‡ªè¡Œé˜…读 Spring Boot 官方文档。在 Spring 中,`BeanFactory`扮演ç�€ Bean 容器的角色,而`Environment`å�Œæ ·å®šä½�为一个容器,å�³å¤–部é…�ç½®æº�中的属性都会被添加到 _Environment_ 中。**在微æœ�务大行其é�“的今天,外部é…�ç½®æº�å�ˆè¡�生出了_Disconf_ã€�_Apollo_ å’Œ _Nacos_ 等分布å¼�é…�置中心,但在 Spring 的地盘,还是è¦�入乡éš�俗,从é…�置中心中读å�–到的属性ä¾�然会被追加到 _Environment_ 中**。 -±ÊÕßÖ®ËùÒÔдÕâÆªÎÄÕ£¬ÊÇÊÜ`jasypt`×é¼þµÄÆô·¢¡£µÚÒ»´Î½Ó´¥ËüÊÇÔÚ2018Ä꣬µ±Ê±¾ÍºÜºÃÆæÕâÍæÒâ¶ù¾¿¾¹ÊÇÈçºÎʵÏÖ¶ÔÃô¸ÐÊôÐÔ¼Ó½âÃܵģ»ÏÖÔÚÀ´¿´£¬ÒªÏëʵÏÖÕâôһ¸ö¶«¶«£¬²»½öÐèÒªÊìϤ Bean µÄÉúÃüÖÜÆÚ¡¢IoC ÈÝÆ÷ÍØÕ¹µã (IoC Container Extension Points) ºÍ Spring Boot µÄÆô¶¯Á÷³ÌµÈ֪ʶ£¬»¹ÐèÒªÕÆÎÕ _Environment_¡£ +笔者之所以写这篇文章,是å�—`jasypt`组件的å�¯å�‘。第一次接触它是在2018年,当时就很好奇这玩æ„�儿究竟是如何实现对æ•�感属性加解密的;现在æ�¥çœ‹ï¼Œè¦�想实现这么一个东东,ä¸�仅需è¦�熟悉 Bean 的生命周期ã€�IoC 容器拓展点 (IoC Container Extension Points) å’Œ Spring Boot çš„å�¯åЍæµ�程等知识,还需è¦�掌æ�¡ _Environment_。 -> jasypt ÉÏÊÖÊ®·Ö¼òµ¥¡£Ê×ÏÈͨ¹ý`jasypt-maven-plugin`ÕâÒ» maven ²å¼þΪÃô¸ÐÊôÐÔÖµÉú³ÉÃÜÎÄ£¬È»ºóÓÃ`ENC(ÃÜÎÄ)`Ìæ»»Ãô¸ÐÊôÐÔÖµ¼´¿É¡£ÈçÏ£º +> jasypt 上手å��分简å�•。首先通过`jasypt-maven-plugin`这一 maven æ�’件为æ•�感属性值生æˆ�密文,然å�Žç”¨`ENC(密文)`替æ�¢æ•�感属性值å�³å�¯ã€‚如下: > > ``` > jasypt.encryptor.password=crimson_typhoon @@ -17,12 +17,12 @@ > spring.datasource.hikari.driver-class-name=com.mysql.cj.jdbc.Driver > spring.datasource.hikari.username=root > spring.datasource.hikari.password=ENC(qS8+DEIlHxvhPHgn1VaW3oHkn2twrmwNOHewWLIfquAXiCDBrKwvIhDoqalKyhIF) -> ¸´ÖÆ´úÂë +> å¤�制代ç � > ``` -## 1 ÈÏʶ Environmnent +## 1 认识 Environmnent -ÔÚʵ¼Ê¹¤×÷ÖУ¬ÎÒÃÇÓë _Environment_ ´ò½»µÀµÄ»ú»á²¢²»¶à£»Èç¹ûÒµÎñ Bean ȷʵÐèÒª»ñÈ¡ÍⲿÅäÖÃÔ´ÖеÄijһÊôÐÔÖµ£¬¿ÉÒÔÊÖ¶¯½« _Environment_ ×¢Èëµ½¸ÃÒµÎñ Bean ÖУ¬Ò²¿ÉÒÔÖ±½ÓʵÏÖ`EnvironmentAware`½Ó¿Ú£¬µÃµ½ _Environment_ ÀàÐ굀 Bean ʵÀýÖ®ºó¿ÉÒÔͨ¹ý`getProperty()`»ñÈ¡¾ßÌåÊôÐÔÖµ¡£_Environment_ ½Ó¿ÚÄÚÈÝÈçÏÂËùʾ£º +在实际工作中,我们与 _Environment_ 打交é�“的机会并ä¸�多;如果业务 Bean 确实需è¦�获å�–外部é…�ç½®æº�中的æŸ�一属性值,å�¯ä»¥æ‰‹åЍ将 _Environment_ 注入到该业务 Bean 中,也å�¯ä»¥ç›´æŽ¥å®žçް`EnvironmentAware`接å�£ï¼Œå¾—到 _Environment_ 类型的 Bean 实例之å�Žå�¯ä»¥é€šè¿‡`getProperty()`获å�–具体属性值。_Environment_ 接å�£å†…容如下所示: ``` public interface Environment extends PropertyResolver { @@ -39,10 +39,10 @@ public interface PropertyResolver { T getProperty(String key, Class targetType, T defaultValue); String resolvePlaceholders(String text); } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -**´ó¼Ò²»ÒªÊÜ _Environment_ ÖÐ _getProperty()_ ·½·¨µÄÎóµ¼£¬ÍⲿÅäÖÃÔ´ÖеÄÊôÐÔ²¢²»ÊÇÒÔµ¥¸öÊôÐÔΪά¶È±»Ìí¼Óµ½ _Environment_ Öе쬶øÊÇÒÔ`PropertySource`Ϊά¶È**¡£_PropertySource_ ÊǶÔÊôÐÔÔ´Ãû³ÆºÍ¸ÃÊôÐÔÔ´ÖÐÒ»×éÊôÐԵijéÏó£¬`MapPropertySource`ÊÇÒ»ÖÖ×î¼òµ¥µÄʵÏÖ£¬Ëüͨ¹ý _Map_ À´³ÐÔØÏà¹ØµÄÊôÐÔ¡£_PropertySource_ ÄÚÈÝÈçÏ£º +**大家ä¸�è¦�å�— _Environment_ 中 _getProperty()_ 方法的误导,外部é…�ç½®æº�中的属性并ä¸�是以å�•个属性为维度被添加到 _Environment_ 中的,而是以`PropertySource`为维度**。_PropertySource_ 是对属性æº�å��称和该属性æº�中一组属性的抽象,`MapPropertySource`是一ç§�最简å�•的实现,它通过 _Map_ æ�¥æ‰¿è½½ç›¸å…³çš„属性。_PropertySource_ 内容如下: ``` public abstract class PropertySource { @@ -58,30 +58,30 @@ public abstract class PropertySource { public T getSource() { return this.source; } public abstract Object getProperty(String name); } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -´ÓÉÏÊö _PropertySource_ ÄÚÈÝÀ´¿´£¬_PropertySource_ ×ÔÉíÊǾ߱¸¸ù¾ÝÊôÐÔÃû»ñÈ¡ÊôÐÔÖµÕâÒ»ÄÜÁ¦µÄ¡£ +从上述 _PropertySource_ 内容æ�¥çœ‹ï¼Œ_PropertySource_ 自身是具备根æ�®å±žæ€§å��获å�–属性值这一能力的。 -#### ****getProperty()ÄÚ²¿Ö´ÐÐÂß¼­**** +#### ****getProperty()内部执行逻辑**** ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/QQ%E6%88%AA%E5%9B%BE20230416193319.jpg) -Ò»°ã£¬_Environment_ ʵÏÖÀàÖлá³ÖÓÐÒ»¸ö`PropertyResolver`ÀàÐ͵ijÉÔ±±äÁ¿£¬½ø¶ø½»ÓÉ _PropertyResolver_ ¸ºÔðÖ´ÐÐ _getProperty()_ Âß¼­¡£_PropertyResolver_ ʵÏÖÀàÖÐÓÖ»á³ÖÓÐÁ½¸ö³ÉÔ±±äÁ¿£¬·Ö±ðÊÇ£º`ConversionService`Óë`PropertySources`£»Ê×ÏÈ£¬_PropertyResolver_ ±éÀú `PropertySources` ÖÐµÄ _PropertySource_£¬»ñȡԭÉúÊôÐÔÖµ£»È»ºóίÅÉ _ConversionService_ ¶ÔÔ­ÉúÊôÐÔÖµ½øÐÐÊý¾ÝÀàÐÍת»» (Èç¹ûÓбØÒªµÄ»°)¡£**ËäÈ» PropertySource ×ÔÉíÊǾ߱¸¸ù¾ÝÊôÐÔÃû»ñÈ¡ÊôÐÔÖµÕâÒ»ÄÜÁ¦µÄ£¬µ«²»¾ß±¸Õ¼Î»·û½âÎöÓëÀàÐÍת»»ÄÜÁ¦£¬ÓÚÊÇÔÚÖмäÒýÈë¾ß±¸ÕâÁ½ÖÖÄÜÁ¦µÄ PropertyResolver£¬ ÕâÒ²Ó¡Ö¤ÁËÒ»¸ö¶Î×Ó£ºÔÚ¼ÆËã»ú¿ÆÑ§ÖУ¬Ã»ÓÐʲôÎÊÌâÊÇÔÚÖмä¼ÓÒ»²ã½â¾ö²»Á˵ģ¬Èç¹ûÓУ¬ÄǾÍÔÙ¼ÓÒ»²ã**¡£ +一般,_Environment_ 实现类中会æŒ�有一个`PropertyResolver`类型的æˆ�员å�˜é‡�,进而交由 _PropertyResolver_ 负责执行 _getProperty()_ 逻辑。_PropertyResolver_ 实现类中å�ˆä¼šæŒ�有两个æˆ�员å�˜é‡�,分别是:`ConversionService`与`PropertySources`;首先,_PropertyResolver_ é��历 `PropertySources` 中的 _PropertySource_,获å�–原生属性值;然å�Žå§”æ´¾ _ConversionService_ 对原生属性值进行数æ�®ç±»åž‹è½¬æ�¢ (如果有必è¦�çš„è¯�)。**虽然 PropertySource 自身是具备根æ�®å±žæ€§å��获å�–属性值这一能力的,但ä¸�具备å� ä½�符解æž�与类型转æ�¢èƒ½åŠ›ï¼ŒäºŽæ˜¯åœ¨ä¸­é—´å¼•å…¥å…·å¤‡è¿™ä¸¤ç§�能力的 PropertyResolver, 这也å�°è¯�了一个段å­�:在计算机科学中,没有什么问题是在中间加一层解决ä¸�了的,如果有,那就å†�加一层**。 -#### ****PropertySourceÄÚ²¿¸üÐÂÂß¼­**** +#### ****PropertySource内部更新逻辑**** ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/QQ%E6%88%AA%E5%9B%BE20230416193319.jpg) -_Environment_ ʵÏÖÀàÖгýÁ˳ÖÓÐ`PropertyResolver`ÀàÐ͵ijÉÔ±±äÁ¿Í⣬»¹ÓÐÒ»¸ö`MutablePropertySources`ÀàÐ͵ijÉÔ±±äÁ¿£¬µ«²¢²»Ìṩֱ½Ó²Ù×÷¸Ã _MutablePropertySources_ µÄ·½·¨£¬ÎÒÃÇÖ»ÄÜͨ¹ý`getPropertySources()`·½·¨»ñÈ¡ _MutablePropertySources_ ʵÀý£¬È»ºó½èÖú _MutablePropertySources_ ÖеÄ`addFirst()`¡¢`addLast()`ºÍ`replace()`µÈ·½·¨È¥¸üР_PropertySource_¡£_MutablePropertySources_ ÊÇ _PropertySources_ Ψһһ¸öʵÏÖÀ࣬ÈçÏÂͼËùʾ£º +_Environment_ 实现类中除了æŒ�有`PropertyResolver`类型的æˆ�员å�˜é‡�外,还有一个`MutablePropertySources`类型的æˆ�员å�˜é‡�,但并ä¸�æ��供直接æ“�作该 _MutablePropertySources_ 的方法,我们å�ªèƒ½é€šè¿‡`getPropertySources()`方法获å�– _MutablePropertySources_ 实例,然å�Žå€ŸåŠ© _MutablePropertySources_ 中的`addFirst()`ã€�`addLast()`å’Œ`replace()`等方法去更新 _PropertySource_。_MutablePropertySources_ 是 _PropertySources_ 唯一一个实现类,如下图所示: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416193420.png) -×ܵÄÀ´Ëµ£¬_Environment_ ÊÇ¶Ô _PropertySource_ ºÍ _Profile_ µÄ¶¥¼¶³éÏó£¬ÏÂÃæ½éÉÜ _Profile_ µÄ¸ÅÄî¡£µ±Ó¦ÓóÌÐòÐèÒª²¿Êðµ½²»Í¬µÄÔËÐл·¾³Ê±£¬Ò»Ð©ÊôÐÔÏîͨ³£»áÓÐËù²»Í¬£¬±ÈÈ磬Êý¾ÝÔ´ URL ÔÚ¿ª·¢»·¾³ºÍ²âÊÔ»·¾³¾Í»á²»Ò»Ñù¡£Spring ´Ó3.1°æ±¾¿ªÊ¼Ö§³Ö»ùÓÚ _Profile_ µÄÌõ¼þ»¯ÅäÖᣠ+总的æ�¥è¯´ï¼Œ_Environment_ 是对 _PropertySource_ å’Œ _Profile_ 的顶级抽象,下é�¢ä»‹ç»� _Profile_ 的概念。当应用程åº�需è¦�部署到ä¸�å�Œçš„è¿�行环境时,一些属性项通常会有所ä¸�å�Œï¼Œæ¯”如,数æ�®æº� URL 在开å�‘环境和测试环境就会ä¸�一样。Spring 从3.1版本开始支æŒ�基于 _Profile_ çš„æ�¡ä»¶åŒ–é…�置。 **Profile in Spring 3.1** -ÔÚ Spring ·¢²¼3.1°æ±¾Ê±£¬Spring Boot »¹Î´ÎÊÊÀ£¬¿ÉÒÔ˵´ËʱµÄ _Profile_ ÌØÐÔ»¹ÊÇÓÐЩ**覴Ã**µÄ£¬µ«è¦²»ÑÚ褡£Ö÷ÒªÌåÏÖÔÚ£ºÕë¶ÔͬһÀàÐ굀 Bean£¬±ØÐëÉùÃ÷¶à´Î¡£Ò»ÆðÀ´¸ÐÊÜÏÂÕâÖÖС覴㺠+在 Spring å�‘布3.1版本时,Spring Boot 还未问世,å�¯ä»¥è¯´æ­¤æ—¶çš„ _Profile_ 特性还是有些**ç‘•ç–µ**的,但瑕ä¸�掩瑜。主è¦�体现在:针对å�Œä¸€ç±»åž‹çš„ Bean,必须声明多次。一起æ�¥æ„Ÿå�—下这ç§�å°�瑕疵: ``` @Configuration(proxyBeanMethods = false) @@ -108,12 +108,12 @@ public class DataSourceConfig { .build(); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` **Profile in Spring Boot** -Spring Boot ·¢²¼ºó£¬`@Profile`×¢½â¿ÉÒÔÈÓµ½¾ÅÏöÔÆÍâÁË¡£¹Ù·½¿ª·¢´óÀп϶¨Ò²Òâʶµ½ _Profile in Spring 3.1_ ÖÐÕâÖÖ覴ã¬ÓÚÊÇÔÚ Spring Boot µÄµÚÒ»°æ±¾ _(1.0.0.RELEASE)_ ÖÐ¾ÍÆÈ²»¼°´ýµØÖ§³ÖΪ _application.properties_ ºÍ _application.yml_ ÀïµÄÊôÐÔÏîÅäÖà _Profile_ ÁË¡£»»¸ö¿Ú棬һÆðÀ´¸ÐÊÜÏÂÕâÖÖÓÅÑÅ£º +Spring Boot å�‘布å�Žï¼Œ`@Profile`注解å�¯ä»¥æ‰”到ä¹�霄云外了。官方开å�‘大佬肯定也æ„�识到 _Profile in Spring 3.1_ 中这ç§�瑕疵,于是在 Spring Boot 的第一版本 _(1.0.0.RELEASE)_ 中就迫ä¸�å�Šå¾…地支æŒ�为 _application.properties_ å’Œ _application.yml_ 里的属性项é…�ç½® _Profile_ 了。æ�¢ä¸ªå�£å‘³ï¼Œä¸€èµ·æ�¥æ„Ÿå�—下这ç§�优雅: ``` @Configuration(proxyBeanMethods = false) @@ -128,30 +128,30 @@ public class DataSourceConfig { .build(); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -_application-dev.properties_ ÄÚÈÝÈçÏ£º +_application-dev.properties_ 内容如下: ``` spring.datasource.url=jdbc:mysql://DEV_HOST:PORT/db_sql_boy?characterEncoding=UTF-8 spring.datasource.hikari.driver-class-name=com.mysql.jdbc.Driver spring.datasource.hikari.password=dev spring.datasource.hikari.username=dev -¸´ÖÆ´úÂë +å¤�制代ç � ``` -_application-test.properties_ ÄÚÈÝÈçÏ£º +_application-test.properties_ 内容如下: ``` spring.datasource.url=jdbc:mysql://TEST_HOST:PORT/db_sql_boy?characterEncoding=UTF-8 spring.datasource.hikari.driver-class-name=com.mysql.jdbc.Driver spring.datasource.hikari.password=test spring.datasource.hikari.username=test -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÔÚÔ­Éú Spring 3.1 ºÍ Spring Boot ÖУ¬¾ùÊÇͨ¹ý`spring.profiles.active`À´Îª _Environment_ Ö¸¶¨¼¤»îµÄ _Profile_£¬·ñÔò_Environment_ ÖÐĬÈϼ¤»îµÄ _Profile_ Ãû³ÆÎª`default`¡£Ð´µ½ÕâÀ±ÊÕßÄÔº£ÖÐÉÁÏÖÒ»¸öÎÊÌ⣺һ°ã£¬`@Profile` ×¢½âÖ÷ÒªÓë _@Configuration_ ×¢½â»ò _@Bean_ ×¢½â´îÅäʹÓã¬Èç¹û _spring.profiles.active_ µÄֵΪ _dev_ ʱ£¬ÄÇôÄÇЩÓÉ _@Configuration_ »ò _@Bean_ ×¢½â±ê¼Ç (µ«Ã»ÓÐ`@Profile`×¢½âµÄÉíÓ°¹þ) µÄ Bean »¹»á±»½âÎöΪÈô¸É`BeanDefinition`ʵÀýÂ𣿴ð°¸ÊÇ»áµÄ¡£`ConfigurationClassPostProcessor`¸ºÔ𽫠_@Configuration_ ÅäÖÃÀà½âÎöΪ _BeanDefinition_£¬Ôڴ˹ý³ÌÖлáÖ´ÐÐ`ConditionEvaluator`µÄ`shouldSkip()`·½·¨£¬Ö÷ÒªÄÚÈÝÈçÏ£º +在原生 Spring 3.1 å’Œ Spring Boot 中,å�‡æ˜¯é€šè¿‡`spring.profiles.active`æ�¥ä¸º _Environment_ 指定激活的 _Profile_,å�¦åˆ™_Environment_ 中默认激活的 _Profile_ å��称为`default`。写到这里,笔者脑海中闪现一个问题:一般,`@Profile` 注解主è¦�与 _@Configuration_ 注解或 _@Bean_ 注解æ�­é…�使用,如果 _spring.profiles.active_ 的值为 _dev_ 时,那么那些由 _@Configuration_ 或 _@Bean_ 注解标记 (但没有`@Profile`注解的身影哈) çš„ Bean 还会被解æž�为若干`BeanDefinition`实例å�—?答案是会的。`ConfigurationClassPostProcessor`负责将 _@Configuration_ é…�置类解æž�为 _BeanDefinition_,在此过程中会执行`ConditionEvaluator`çš„`shouldSkip()`方法,主è¦�内容如下: ``` public class ConditionEvaluator { @@ -191,20 +191,20 @@ public class ConditionEvaluator { return false; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -`shouldSkip()`·½·¨µÚÒ»ÐÐ _if_ Óï¾ä¾ÍÊǴ𰸣¬`@Profile`×¢½âÓÉ`@Conditional(ProfileCondition.class)`ÐÞÊΣ¬ÄÇÈç¹ûÒ»¸öÅäÖÃÀàÍ·ÉÏûÓÐ`Condition`µÄÉíÓ°£¬Ö±½Ó·µ»Ø`false`ÁË£¬ÄǾÍÊDz»Ìø¹ý¸ÃÅäÖÃÀàµÄÒâ˼ඣ¡ +`shouldSkip()`方法第一行 _if_ 语å�¥å°±æ˜¯ç­”案,`@Profile`注解由`@Conditional(ProfileCondition.class)`修饰,那如果一个é…�置类头上没有`Condition`的身影,直接返回`false`了,那就是ä¸�跳过该é…�置类的æ„�æ€�å–½ï¼� -_Environment_ ÖеÄÕâЩ _PropertySource_ ¾¿¾¹ÓÐɶÓ𡣿µ±È»ÊÇΪÁËÌî³ä _Bean_ à¶£¬·Ï»°²»¶à˵£¬ÉÏͼ¡£ +_Environment_ 中的这些 _PropertySource_ 究竟有啥用啊?当然是为了填充 _Bean_ 喽,废è¯�ä¸�多说,上图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416193443.png) -> ±ÊÕßÒÔǰ¶¼ÊÇÓà visio ºÍ processOn »­Í¼£¬µÚÒ»´ÎÌåÑé draw.io£¬Ã»Ïëµ½Èç´ËÓÅÐ㣬ǿÁÒ°²ÀûÒ»²¨£¡ +> 笔者以å‰�都是用 visio å’Œ processOn 画图,第一次体验 draw.io,没想到如此优秀,强烈安利一波ï¼� -## 2 Environmnent ³õʼ»¯Á÷³Ì +## 2 Environmnent åˆ�始化æµ�程 -±¾½ÚÖ÷Òª½éÉÜ Spring Boot ÔÚÆô¶¯¹ý³ÌÖÐÏò _Environmnt_ Öо¿¾¹×¢²áÁËÄÄЩ _PropertySource_¡£Æô¶¯Èë¿ÚλÓÚ`SpringApplication`ÖеÄ`run(String... args)`·½·¨£¬ÈçÏ£º +本节主è¦�介ç»� Spring Boot 在å�¯åŠ¨è¿‡ç¨‹ä¸­å�‘ _Environmnt_ 中究竟注册了哪些 _PropertySource_。å�¯åЍ入å�£ä½�于`SpringApplication`中的`run(String... args)`方法,如下: ``` public class SpringApplication { @@ -246,21 +246,21 @@ public class SpringApplication { return context; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -¿ÉÒÔÃ÷ÏÔ¿´³ö£¬_Environmnt_ µÄ³õʼ»¯ÊÇÔÚ`refreshContext(context)`֮ǰÍê³ÉµÄ£¬ÕâÊǺÁÎÞÒÉÎʵġ£_run()_ ·½·¨ºÜ¸´ÔÓ£¬µ«Óë±¾ÎÄÖ÷ÌâÆõºÏµÄÂß¼­Ö»ÓÐ**Ò»**´¦£º +å�¯ä»¥æ˜Žæ˜¾çœ‹å‡ºï¼Œ_Environmnt_ çš„åˆ�始化是在`refreshContext(context)`之å‰�完æˆ�的,这是毫无疑问的。_run()_ 方法很å¤�æ�‚,但与本文主题契å�ˆçš„逻辑å�ªæœ‰**一**处: ``` prepareEnvironment(listeners, bootstrapContext, applicationArguments); -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÏÂÃæ·Ö±ð·ÖÎöÕâÁ½´¦ºËÐÄÂß¼­¡£ +下é�¢åˆ†åˆ«åˆ†æž�这两处核心逻辑。 ### 2.1 prepareEnvironment() -ÏÔÈ»£¬ºËÐÄÄÚÈݶ¼ÔÚ`prepareEnvironment()`·½·¨ÄÚ£¬ÏÂÃæ·ÖС½ÚÖðÒ»·ÖÎö¡£ +显然,核心内容都在`prepareEnvironment()`方法内,下é�¢åˆ†å°�节é€�一分æž�。 ``` public class SpringApplication { @@ -281,16 +281,16 @@ public class SpringApplication { return environment; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` #### 2.1.1 getOrCreateEnvironment() -`getOrCreateEnvironment()`Ö÷Òª¸ºÔð¹¹½¨ _Environment_ ʵÀý¡£Èç¹ûµ±Ç°Ó¦ÓÃÊÇ»ùÓÚ`ͬ²½×èÈûI/O`Ä£Ð͵ģ¬Ôò _Environment_ Ñ¡ÓÃ`ApplicationServletEnvironment`£»Ïà·´µØ£¬Èç¹ûµ±Ç°Ó¦ÓÃÊÇ»ùÓÚ`Òì²½·Ç×èÈûI/O`Ä£Ð͵ģ¬Ôò _Environment_ Ñ¡ÓÃ`ApplicationReactiveWebEnvironment`¡£ÎÒÃǹ¤×÷Öлù±¾¶¼ÊÇ»ùÓÚ Spring MVC ¿ª·¢Ó¦Óã¬Spring MVC ÊÇÒ»¿î¹¹½¨ÓÚ`Servlet API`Ö®ÉÏ¡¢»ùÓÚͬ²½×èÈû I/O Ä£Ð͵ÄÖ÷Á÷ Java Web ¿ª·¢¿ò¼Ü£¬ÕâÖÖ I/O Ä£ÐÍÒâζ×ÅÒ»¸ö HTTP ÇëÇó¶ÔÓ¦Ò»¸öỊ̈߳¬¼´Ã¿Ò»¸ö HTTP ÇëÇó¶¼ÊÇÔÚ¸÷×ÔÏß³ÌÉÏÏÂÎÄÖÐÍê³É´¦ÀíµÄ¡£_ApplicationServletEnvironment_ ¼Ì³Ð¹ØÏµÈçÏÂͼËùʾ£º +`getOrCreateEnvironment()`主è¦�负责构建 _Environment_ 实例。如果当å‰�应用是基于`å�Œæ­¥é˜»å¡žI/O`模型的,则 _Environment_ 选用`ApplicationServletEnvironment`;相å��地,如果当å‰�应用是基于`异步é�žé˜»å¡žI/O`模型的,则 _Environment_ 选用`ApplicationReactiveWebEnvironment`。我们工作中基本都是基于 Spring MVC å¼€å�‘应用,Spring MVC 是一款构建于`Servlet API`之上ã€�基于å�Œæ­¥é˜»å¡ž I/O 模型的主æµ� Java Web å¼€å�‘框架,这ç§� I/O 模型æ„�味ç�€ä¸€ä¸ª HTTP 请求对应一个线程,å�³æ¯�一个 HTTP 请求都是在å�„自线程上下文中完æˆ�处ç�†çš„。_ApplicationServletEnvironment_ 继承关系如下图所示: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416193515.png) -´ÓÉÏͼ¿ÉÒÔ¿´³ö _ApplicationServletEnvironment_ ¼Ò×åÏ൱ÅÓ´ó£¬ÔÚÖ´ÐÐ _ApplicationServletEnvironment_ ¹¹Ôì·½·¨µÄʱºò±ØÈ»»á´¥·¢¸÷¼¶¸¸À๹Ôì·½·¨ÖеÄÂß¼­£¬**ÒÀ´ÎΪ**£º +从上图å�¯ä»¥çœ‹å‡º _ApplicationServletEnvironment_ å®¶æ—�相当庞大,在执行 _ApplicationServletEnvironment_ 构造方法的时候必然会触å�‘å�„级父类构造方法中的逻辑,**ä¾�次为**: ``` public abstract class AbstractEnvironment implements ConfigurableEnvironment { @@ -307,7 +307,7 @@ public abstract class AbstractEnvironment implements ConfigurableEnvironment { customizePropertySources(propertySources); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` ``` @@ -319,7 +319,7 @@ public class StandardServletEnvironment extends StandardEnvironment implements C super.customizePropertySources(propertySources); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` ``` @@ -332,14 +332,14 @@ public class StandardEnvironment extends AbstractEnvironment { new SystemEnvironmentPropertySource("systemEnvironment", (Map) System.getenv())); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -Ëæ×Å _ApplicationServletEnvironment_ ¹¹Ôì·½·¨µÄÖ´ÐУ¬´ËʱÔÚ _Environment_ Àï _MutablePropertySources_ ÀàÐ͵ijÉÔ±±äÁ¿`propertySources`ÖÐÒѾ­ÓÐÁË**ËÄ**¸ö _PropertySource_ ÁË£¬Ãû³ÆÒÀ´ÎÊÇ£º`servletConfigInitParams`¡¢`servletContextInitParams`¡¢`systemProperties`ºÍ`systemEnvironment`¡£´ËÍ⣬ҲҪ¼Çס _ApplicationServletEnvironment_ ÖеÄÁ½¸öÖØÒª³ÉÔ±±äÁ¿£¬¼´`MutablePropertySources`ºÍ`ConfigurationPropertySourcesPropertyResolver`¡£ +éš�ç�€ _ApplicationServletEnvironment_ 构造方法的执行,此时在 _Environment_ 里 _MutablePropertySources_ 类型的æˆ�员å�˜é‡�`propertySources`中已ç»�有了**å››**个 _PropertySource_ 了,å��ç§°ä¾�次是:`servletConfigInitParams`ã€�`servletContextInitParams`ã€�`systemProperties`å’Œ`systemEnvironment`。此外,也è¦�è®°ä½� _ApplicationServletEnvironment_ 中的两个é‡�è¦�æˆ�员å�˜é‡�,å�³`MutablePropertySources`å’Œ`ConfigurationPropertySourcesPropertyResolver`。 #### 2.1.2 configureEnvironment() -`configureEnvironment()`·½·¨ÖеÄÂß¼­Ò²ºÜ¼òµ¥¹þ¡£Ê×ÏÈ£¬Îª _Environment_ ÖÐµÄ _PropertySourcesPropertyResolver_ É趨 _ConversionService_£»È»ºó£¬Ïò _Environment_ ÖÐµÄ _MutablePropertySources_ ×·¼ÓÒ»¸öÃû³ÆÎª`commandLineArgs`µÄ _PropertySource_ ʵÀý£¬×¢ÒâʹÓõÄÊÇ`addFirst()`·½·¨Å¶£¬ÕâÒâζ×ÅÕâ¸öÃû³ÆÎª`commandLineArgs`µÄ _PropertySource_ ÓÅÏȼ¶ÊÇ×î¸ßµÄ¡£Ö÷ÒªÂß¼­ÈçÏ£º +`configureEnvironment()`方法中的逻辑也很简å�•哈。首先,为 _Environment_ 中的 _PropertySourcesPropertyResolver_ 设定 _ConversionService_;然å�Žï¼Œå�‘ _Environment_ 中的 _MutablePropertySources_ 追加一个å��称为`commandLineArgs`çš„ _PropertySource_ 实例,注æ„�使用的是`addFirst()`方法哦,这æ„�味ç�€è¿™ä¸ªå��称为`commandLineArgs`çš„ _PropertySource_ 优先级是最高的。主è¦�逻辑如下: ``` public class SpringApplication { @@ -353,26 +353,26 @@ public class SpringApplication { } } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -¼ÌÐø`SimpleCommandLinePropertySource`£º +ç»§ç»­`SimpleCommandLinePropertySource`: ``` public class SimpleCommandLinePropertySource extends CommandLinePropertySource { public SimpleCommandLinePropertySource(String... args) { - // Æä¸¸À๹Ôì·½·¨Îª£ºsuper("commandLineArgs", source) + // 其父类构造方法为:super("commandLineArgs", source) super(new SimpleCommandLineArgsParser().parse(args)); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÃüÁîÐвÎÊý»¹ÊDZȽϳ£Óõ쬱ÈÈçÎÒÃÇÔÚÆô¶¯ Spring Boot Ó¦ÓÃʱ»áÕâÑùÉùÃ÷ÃüÁîÐвÎÊý£º`java -jar app.jar --server.port=8088`¡£ +命令行å�‚数还是比较常用的,比如我们在å�¯åЍ Spring Boot 应用时会这样声明命令行å�‚数:`java -jar app.jar --server.port=8088`。 #### 2.1.3 ConfigurationPropertySources.attach() -`attach()`·½·¨Ö÷Òª¾ÍÊÇÔÚ _Environment_ ÖÐ _MutablePropertySources_ µÄÍ·²¿Î»ÖòåÈë¼ÓÒ»¸öÃû³ÆÎª`configurationProperties`µÄ _PropertySource_ ʵÀý¡£Ö÷ÒªÂß¼­ÈçÏ£º +`attach()`方法主è¦�就是在 _Environment_ 中 _MutablePropertySources_ 的头部ä½�ç½®æ�’入加一个å��称为`configurationProperties`çš„ _PropertySource_ 实例。主è¦�逻辑如下: ``` public final class ConfigurationPropertySources { @@ -392,10 +392,10 @@ public final class ConfigurationPropertySources { return (sources != null) ? sources.get("configurationProperties") : null; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -±ÊÕß¶¢×ÅÕâÍæÒâ¶ù¿´Á˺þã¬Ñ¹¸ùû¿´³öÕâ¸öÃû³ÆÎª`configurationProperties`µÄ _PropertySource_ ¾¿¾¹ÓÐɶÓá£×îºó£¬»¹ÊÇÔÚ¹Ù·½ÎĵµÖйØÓÚ`Relaxed Binding` (¿íËɰó¶¨) µÄÃèÊöÖв³öÁËЩ¶ËÄß¡£»¹ÊÇͨ¹ý´úÂëÀ´½â¶Á±È½ÏÖ±½Ó¡£Ê×ÏÈ£¬ÔÚ _application.properties_ ÖÐ×·¼ÓÒ»¸öÅäÖÃÏ`a.b.my-first-key=hello spring environment`£»È»ºó£¬Í¨¹ý _Environment_ È¡³öÕâ¸öÅäÖÃÏîµÄÖµ£¬ÈçÏ£º +笔者盯ç�€è¿™çŽ©æ„�儿看了好久,压根没看出这个å��称为`configurationProperties`çš„ _PropertySource_ 究竟有啥用。最å�Žï¼Œè¿˜æ˜¯åœ¨å®˜æ–¹æ–‡æ¡£ä¸­å…³äºŽ`Relaxed Binding` (宽æ�¾ç»‘定) çš„æ��述中猜出了些端倪。还是通过代ç �æ�¥è§£è¯»æ¯”较直接。首先,在 _application.properties_ 中追加一个é…�置项:`a.b.my-first-key=hello spring environment`;然å�Žï¼Œé€šè¿‡ _Environment_ å�–出这个é…�置项的值,如下: ``` @SpringBootApplication @@ -407,14 +407,14 @@ public class DemoApplication { System.out.println(environment.getProperty("a.b.my-first-key")); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -Æô¶¯Ó¦Óú󣬿ØÖÆÌ¨´òÓ¡³öÁË _hello spring environment_ ×ÖÑù£¬ÕâÓëÔ¤ÆÚÊÇÏà·ûµÄ¡£¿Éµ±ÎÒÃÇͨ¹ý`environment.getProperty("a.b.myfirstkey")`»òÕß`environment.getProperty("a.b.my-firstkey")`ÒÀÈ»Äܹ»»ñÈ¡µ½ÅäÖÃÏîµÄÄÚÈÝ¡£`a.b.myfirstkey`ºÍ`a.b.my-firstkey`²¢²»ÊÇÅäÖÃÎļþÖеÄÊôÐÔÃû³Æ£¬Ö»ÊÇÏàËÆ¶øÒÑ£¬ÕâµÄÈ·ºÜ**¿íËÉ**°¡£¬¹þ¹þ¡£¸ÐÐËȤµÄ¶ÁÕß¿ÉÒÔ×ÔÐÐ DEBUG ¿´¿´ÆäÖеÄÔ­Àí¡£ +å�¯åŠ¨åº”ç”¨å�Žï¼ŒæŽ§åˆ¶å�°æ‰“å�°å‡ºäº† _hello spring environment_ 字样,这与预期是相符的。å�¯å½“我们通过`environment.getProperty("a.b.myfirstkey")`或者`environment.getProperty("a.b.my-firstkey")`ä¾�然能够获å�–到é…�置项的内容。`a.b.myfirstkey`å’Œ`a.b.my-firstkey`å¹¶ä¸�是é…�置文件中的属性å��称,å�ªæ˜¯ç›¸ä¼¼è€Œå·²ï¼Œè¿™çš„确很**宽æ�¾**啊,哈哈。感兴趣的读者å�¯ä»¥è‡ªè¡Œ DEBUG 看看其中的原ç�†ã€‚ #### 2.1.4 listeners.environmentPrepared() -Çúڰ壬¸÷λ´óÀУ¬Õâ¸öÒª¿¼µÄ £¡`environmentPrepared()`·½·¨»á¹ã²¥Ò»¸ö`ApplicationEnvironmentPreparedEvent`ʼþ£¬½Ó×ÅÓÉ`EnvironmentPostProcessorApplicationListener`ÏìÓ¦¸Ãʼþ£¬ÕâÓ¦¸ÃÊǵäÐ͵Ä**¹Û²ìÕßģʽ**¡£Ö÷ÒªÄÚÈÝÈçÏ£º +敲黑æ�¿ï¼Œå�„ä½�大佬,这个è¦�考的 ï¼�`environmentPrepared()`方法会广播一个`ApplicationEnvironmentPreparedEvent`事件,接ç�€ç”±`EnvironmentPostProcessorApplicationListener`å“�应该事件,这应该是典型的**观察者模å¼�**。主è¦�内容如下: ``` public class SpringApplicationRunListeners { @@ -460,10 +460,10 @@ public class SimpleApplicationEventMulticaster extends AbstractApplicationEventM } } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÏÂÃæÀ´¿´Ò»ÏÂ`EnvironmentPostProcessorApplicationListener`µÄÂ®É½ÕæÃæÄ¿£º +下é�¢æ�¥çœ‹ä¸€ä¸‹`EnvironmentPostProcessorApplicationListener`çš„åº�山真é�¢ç›®ï¼š ``` public class EnvironmentPostProcessorApplicationListener implements SmartApplicationListener, Ordered { @@ -487,19 +487,19 @@ public class EnvironmentPostProcessorApplicationListener implements SmartApplica } } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -`EnvironmentPostProcessor`ÊÇ Spring Boot Ϊ _Environment_ Á¿Éí´òÔìµÄÀ©Õ¹µã¡£ÕâÀïÒýÓùٷ½ÎĵµÖбȽϾ«Á¶µÄÒ»¾ä»°£º_Allows for customization of the application's Environment prior to the application context being refreshed_¡£_EnvironmentPostProcessor_ ÊÇÒ»¸öº¯ÊýÐÔ½Ó¿Ú£¬ÄÚÈÝÈçÏ£º +`EnvironmentPostProcessor`是 Spring Boot 为 _Environment_ é‡�身打造的扩展点。这里引用官方文档中比较精炼的一å�¥è¯�:_Allows for customization of the application's Environment prior to the application context being refreshed_。_EnvironmentPostProcessor_ 是一个函数性接å�£ï¼Œå†…容如下: ``` public interface EnvironmentPostProcessor { void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application); } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÔÚÉÏÊö _EnvironmentPostProcessorApplicationListener_ ʼþ´¦ÀíÂß¼­ÖУ¬`getEnvironmentPostProcessors`¸ºÔð¼ÓÔØ³öËùÓÐµÄ _EnvironmentPostProcessor_ ¡£¿´Ò»ÏÂÄÚ²¿¼ÓÔØÂß¼­£º +在上述 _EnvironmentPostProcessorApplicationListener_ 事件处ç�†é€»è¾‘中,`getEnvironmentPostProcessors`负责加载出所有的 _EnvironmentPostProcessor_ 。看一下内部加载逻辑: ``` public interface EnvironmentPostProcessorsFactory { @@ -510,10 +510,10 @@ public interface EnvironmentPostProcessorsFactory { ); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -¼ÌÐø½øÈë`SpringFactoriesLoader`һ̽¾¿¾¹£º +继续进入`SpringFactoriesLoader`一探究竟: ``` public final class SpringFactoriesLoader { @@ -560,18 +560,18 @@ public final class SpringFactoriesLoader { return result; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` > **Spring SPI** > -> > _SpringFactoriesLoader_ ÕâÒ»Ì×Âß¼­¾ÍÊÇ Spring ÖеÄ`SPI`»úÖÆ£»Ö±°×µã˵£¬¾ÍÊÇ´Ó`classpath`ϵÄ`META-INF/spring.factories` ÎļþÖмÓÔØ _EnvironmentPostProcessor_ £¬Èç¹û´ó¼ÒÓÐÐèÇó¾Í½«×Ô¼ºÊµÏÖµÄ _EnvironmentPostProcessor_ ·Åµ½¸ÃÎļþÖоÍÐÐÁË¡£ÆäʵÓë`JDK`ÖеÄ`SPI`»úÖÆºÜÀàËÆ¹þ¡£ +> > _SpringFactoriesLoader_ 这一套逻辑就是 Spring 中的`SPI`机制;直白点说,就是从`classpath`下的`META-INF/spring.factories` 文件中加载 _EnvironmentPostProcessor_ ,如果大家有需求就将自己实现的 _EnvironmentPostProcessor_ 放到该文件中就行了。其实与`JDK`中的`SPI`机制很类似哈。 -ÔÚµ±Ç°°æ±¾£¬Spring Boot ÄÚÖÃÁË7¸ö _EnvironmentPostProcessor_ ʵÏÖÀà¡£½ÓÏÂÀ´Ìô¼¸¸ö±È½ÏµäÐ͵ķÖÎöÏ¡£ +在当å‰�版本,Spring Boot 内置了7个 _EnvironmentPostProcessor_ 实现类。接下æ�¥æŒ‘几个比较典型的分æž�下。 **RandomValuePropertySourceEnvironmentPostProcessor** -`RandomValuePropertySourceEnvironmentPostProcessor`Ïò _Environment_ ÖÐ×·¼ÓÁËÒ»¸öÃû³ÆÎª`random`µÄ _PropertySource_£¬¼´`RandomValuePropertySource`¡£ÄÚÈÝÈçÏ£º +`RandomValuePropertySourceEnvironmentPostProcessor`å�‘ _Environment_ 中追加了一个å��称为`random`çš„ _PropertySource_,å�³`RandomValuePropertySource`。内容如下: ``` public class RandomValuePropertySourceEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered { @@ -592,14 +592,14 @@ public class RandomValuePropertySourceEnvironmentPostProcessor implements Enviro RandomValuePropertySource.addToEnvironment(environment, this.logger); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÄÇôÕâ¸ö _RandomValuePropertySource_ ÓÐɶ×÷ÓÃÄØ£¿Ö÷Òª¾ÍÊÇÓÃÓÚÉú³ÉËæ»úÊý£¬±ÈÈ磺`environment.getProperty("random.int(5,10)")`¿ÉÒÔ»ñȡһ¸öËæ»úÊý¡£ÒÔ`random.int`ΪÊôÐÔÃû¿ÉÒÔ»ñȡһ¸ö _int_ ÀàÐ͵ÄËæ»úÊý£»ÒÔ`random.long`ΪÊôÐÔÃû¿ÉÒÔ»ñȡһ¸ö _long_ ÀàÐ͵ÄËæ»úÊý£»ÒÔ`random.int(5,10)`ΪÊôÐÔÃû¿ÉÒÔ»ñȡһ¸ö _[5, 10}_ Çø¼äÄÚ _int_ ÀàÐ͵ÄËæ»úÊý£¬¸ü¶àÍæ·¨´ó¼Ò×ÔÐÐ̽Ë÷¡£ +那么这个 _RandomValuePropertySource_ 有啥作用呢?主è¦�就是用于生æˆ�éš�机数,比如:`environment.getProperty("random.int(5,10)")`å�¯ä»¥èŽ·å�–一个éš�机数。以`random.int`为属性å��å�¯ä»¥èŽ·å�–一个 _int_ 类型的éš�机数;以`random.long`为属性å��å�¯ä»¥èŽ·å�–一个 _long_ 类型的éš�机数;以`random.int(5,10)`为属性å��å�¯ä»¥èŽ·å�–一个 _[5, 10}_ 区间内 _int_ 类型的éš�机数,更多玩法大家自行探索。 _SystemEnvironmentPropertySourceEnvironmentPostProcessor_ -µ±Ç°£¬_Environment_ ÖÐÒѾ­´æÔÚÒ»¸öÃû³ÆÎª`systemEnvironment`µÄ _PropertySource_£¬¼´`SystemEnvironmentPropertySource`¡£`SystemEnvironmentPropertySourceEnvironmentPostProcessor`ÓÃÓÚ½«¸Ã _SystemEnvironmentPropertySource_ Ìæ»»Îª`OriginAwareSystemEnvironmentPropertySource`£¬Õ¦Óе㡰ÍÑ¿ã×Ó·ÅÆ¨£¬¶à´ËÒ»¾Ù¡±µÄ¸Ð¾õÄØ£¬¹þ¹þ¡£ +当å‰�,_Environment_ 中已ç»�存在一个å��称为`systemEnvironment`çš„ _PropertySource_,å�³`SystemEnvironmentPropertySource`。`SystemEnvironmentPropertySourceEnvironmentPostProcessor`用于将该 _SystemEnvironmentPropertySource_ 替æ�¢ä¸º`OriginAwareSystemEnvironmentPropertySource`,咋有点“脱裤å­�放å±�,多此一举â€�的感觉呢,哈哈。 ``` public class SystemEnvironmentPropertySourceEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered { @@ -626,31 +626,31 @@ public class SystemEnvironmentPropertySourceEnvironmentPostProcessor implements environment.getPropertySources().replace(sourceName, source); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` **SpringApplicationJsonEnvironmentPostProcessor** -ÎÒÃÇÔÚͨ¹ý`java -jar -Dspring.application.json={"name":"duxiaotou"} app.jar`Æô¶¯ Spring Boot Ó¦ÓõÄʱºò£¬¸ÃÊôÐԻᱻ×Ô¶¯Ìí¼Óµ½ JVM ϵͳÊôÐÔÖÐ (Æäʵ _-Dkey=value_ ÕâÖÖÐÎʽµÄÊôÐÔ¾ùÊÇÈç´Ë)£¬ÆäµÈЧÓÚ`System.setProperty(key, value)`£»¶øµ±´æÔÚ`SPRING_APPLICATION_JSON`Õâһϵͳ±äÁ¿Ê±£¬×ÔȻҲ»áÔÚ`System.getenv()`ÖгöÏÖ¡£Ç°ÃæÔø¾­Ìáµ½¹ý`System.getProperties()`´ú±íµÄÊÇ`systemProperties`ÕâÒ» _PropertySource_£¬¶ø`System.getenv()`Ôò´ú±íµÄÊÇ`systemEnvironment`ÕâÒ» _PropertySource_¡£`SpringApplicationJsonEnvironmentPostProcessor`¾ÍÊÇÓÃÓÚ´ÓÕâÁ½¸ö _PropertySource_ ÖгéÈ¡³ö _spring.application.json_ »ò _SPRING_APPLICATION_JSON_ µÄ _JSON_ ´®£¬½ø¶øµ¥¶ÀÏò _Environment_ ÖÐ×·¼ÓÒ»¸öÃû³ÆÎª`spring.application.json`µÄ _PropertySource_£¬¼´`JsonPropertySource`¡£ +我们在通过`java -jar -Dspring.application.json={"name":"duxiaotou"} app.jar`å�¯åЍ Spring Boot 应用的时候,该属性会被自动添加到 JVM 系统属性中 (其实 _-Dkey=value_ è¿™ç§�å½¢å¼�的属性å�‡æ˜¯å¦‚æ­¤),其等效于`System.setProperty(key, value)`;而当存在`SPRING_APPLICATION_JSON`这一系统å�˜é‡�时,自然也会在`System.getenv()`中出现。å‰�é�¢æ›¾ç»�æ��到过`System.getProperties()`代表的是`systemProperties`这一 _PropertySource_,而`System.getenv()`则代表的是`systemEnvironment`这一 _PropertySource_。`SpringApplicationJsonEnvironmentPostProcessor`就是用于从这两个 _PropertySource_ 中抽å�–出 _spring.application.json_ 或 _SPRING_APPLICATION_JSON_ çš„ _JSON_ 串,进而å�•独å�‘ _Environment_ 中追加一个å��称为`spring.application.json`çš„ _PropertySource_,å�³`JsonPropertySource`。 **ConfigDataEnvironmentPostProcessor** -`ConfigDataEnvironmentPostProcessor`¸ºÔð½«`optional:classpath:/`¡¢`optional:classpath:/config/`¡¢`optional:file:./`¡¢`optional:file:./config/`ºÍ`optional:file:./config/*/`ÕâЩĿ¼Ï嵀 _application.properties_ ÅäÖÃÎļþ¼ÓÔØ³öÀ´£»Èç¹û»¹Ö¸¶¨ÁË _spring.profiles.active_µÄ»°£¬Í¬Ê±Ò²»á½«ÕâЩĿ¼Ï嵀 _application-{profile}.properties_ ÅäÖÃÎļþ¼ÓÔØ³öÀ´¡£×îÖÕ£¬_ConfigDataEnvironmentPostProcessor_ ½«»áÏò _Environment_ ÖÐ×·¼ÓÁ½¸ö`OriginTrackedMapPropertySource`£¬ÕâÁ© _PropertySource_ λÓÚ _Environment_ µÄβ²¿£»ÆäÖÐ _application-{profile}.properties_ Ëù´ú±íµÄ _OriginTrackedMapPropertySource_ ÊÇÅÅÔÚ _application.properties_ Ëù´ú±íµÄ _OriginTrackedMapPropertySource_ Ç°ÃæµÄ£¬ÕâÒ»µãÍ¦ÖØÒª¡£ +`ConfigDataEnvironmentPostProcessor`负责将`optional:classpath:/`ã€�`optional:classpath:/config/`ã€�`optional:file:./`ã€�`optional:file:./config/`å’Œ`optional:file:./config/*/`这些目录下的 _application.properties_ é…�置文件加载出æ�¥ï¼›å¦‚果还指定了 _spring.profiles.active_çš„è¯�,å�Œæ—¶ä¹Ÿä¼šå°†è¿™äº›ç›®å½•下的 _application-{profile}.properties_ é…�置文件加载出æ�¥ã€‚最终,_ConfigDataEnvironmentPostProcessor_ 将会å�‘ _Environment_ 中追加两个`OriginTrackedMapPropertySource`,这俩 _PropertySource_ ä½�于 _Environment_ 的尾部;其中 _application-{profile}.properties_ 所代表的 _OriginTrackedMapPropertySource_ 是排在 _application.properties_ 所代表的 _OriginTrackedMapPropertySource_ å‰�é�¢çš„,这一点挺é‡�è¦�。 -## 3 jasypt ºËÐÄÔ­Àí½â¶Á +## 3 jasypt 核心原ç�†è§£è¯» -> `jasypt`»ù´¡×é¼þ¿âÓë`jasypt-spring-boot-starter`ÊDz»Í¬×÷ÕßдµÄ£¬ºóÕßÖ»ÊÇΪ jasypt ×é¼þ¿ª·¢ÁË Spring Boot µÄÆð²½ÒÀÀµ×é¼þ¶øÒÑ¡£±¾ÎÄËù·ÖÎöµÄÆäʵ¾ÍÊÇÕâ¸öÆð²½ÒÀÀµ×é¼þ¡£ +> `jasypt`基础组件库与`jasypt-spring-boot-starter`是ä¸�å�Œä½œè€…写的,å�Žè€…å�ªæ˜¯ä¸º jasypt 组件开å�‘了 Spring Boot 的起步ä¾�赖组件而已。本文所分æž�的其实就是这个起步ä¾�赖组件。 -_application.properties_ ÅäÖÃÎļþÖйØÓÚÊý¾ÝÔ´µÄÃÜÂëÊÇÒ»¸ö¼ÓÃܺóµÄÃÜÎÄ£¬ÈçÏ£º +_application.properties_ é…�置文件中关于数æ�®æº�的密ç �是一个加密å�Žçš„密文,如下: ``` spring.datasource.hikari.password=ENC(4+t9a5QG8NkNdWVS6UjIX3dj18UtYRMqU6eb3wUKjivOiDHFLZC/RTK7HuWWkUtV) -¸´ÖÆ´úÂë +å¤�制代ç � ``` -µ±`HikariDataSource`Íê³ÉÊôÐÔÌî³ä²Ù×÷ºó£¬¸Ã Bean ÖÐ _password_ ×ֶεÄÖµÕ¦¾Í±äΪ½âÃܺóµÄ _qwe@1234_ ÕâÒ»Ã÷ÎÄÁËÄØ£¿ÏÔÈ»£¬Spring Boot Ϊ _Environment_ ÌṩµÄ`EnvironmentPostProcessor`ÕâÒ»ÍØÕ¹µã¿ÉÒÔʵÏÖ͵Ìì»»ÈÕ£¡µ«×÷ÕßûÓÐÓÃËü£¬¶øÊÇʹÓÃÁË Spring ÖеÄÒ»¸ö _IoC ÍØÕ¹µã_£¬¼´`BeanFactoryPostProcessor`£¬ÕâÒ²ÊÇÍêÈ«¿ÉÒԵģ¬ÒòΪµ±Ö´Ðе½ _BeanFactoryPostProcessor_ ÖеÄ`postProcessBeanFactory()`Âß¼­Ê±£¬Ö»ÊÇÍê³ÉÁËËùÓÐ`BeanDefinition`µÄ¼ÓÔØ£¬µ«»¹Ã»ÓÐʵÀý»¯ _BeanDefinition_ ¸÷×ÔËù¶ÔÓ¦µÄ Bean¡£ +当`HikariDataSource`完æˆ�属性填充æ“�作å�Žï¼Œè¯¥ Bean 中 _password_ 字段的值咋就å�˜ä¸ºè§£å¯†å�Žçš„ _qwe@1234_ 这一明文了呢?显然,Spring Boot 为 _Environment_ æ��供的`EnvironmentPostProcessor`这一拓展点å�¯ä»¥å®žçްå�·å¤©æ�¢æ—¥ï¼�但作者没有用它,而是使用了 Spring 中的一个 _IoC 拓展点_,å�³`BeanFactoryPostProcessor`,这也是完全å�¯ä»¥çš„,因为当执行到 _BeanFactoryPostProcessor_ 中的`postProcessBeanFactory()`逻辑时,å�ªæ˜¯å®Œæˆ�了所有`BeanDefinition`的加载,但还没有实例化 _BeanDefinition_ å�„自所对应的 Bean。 -ÏÂÃæ¿´Ò»ÏÂ`EnableEncryptablePropertiesBeanFactoryPostProcessor`ÖеÄÄÚÈÝ£º +下é�¢çœ‹ä¸€ä¸‹`EnableEncryptablePropertiesBeanFactoryPostProcessor`中的内容: ``` public class EnableEncryptablePropertiesBeanFactoryPostProcessor implements BeanFactoryPostProcessor, Ordered { @@ -674,12 +674,12 @@ public class EnableEncryptablePropertiesBeanFactoryPostProcessor implements Bean return Ordered.LOWEST_PRECEDENCE - 100; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÉÏÊöÔ´Âë±íÃ÷¸Ã _BeanFactoryPostProcessor_ ½èÖú`EncryptablePropertySourceConverter`¶Ô _MutablePropertySources_ ×öÁËÒ»²ãת»»£¬ÄÇôת»»³ÉɶÁËÄØ£¿ +上述æº�ç �表明该 _BeanFactoryPostProcessor_ 借助`EncryptablePropertySourceConverter`对 _MutablePropertySources_ å�šäº†ä¸€å±‚转æ�¢ï¼Œé‚£ä¹ˆè½¬æ�¢æˆ�啥了呢? -½Ó×Å£¬¸ú½ø _EncryptablePropertySourceConverter_£¬ºËÐÄÄÚÈÝÈçÏ£º +接ç�€ï¼Œè·Ÿè¿› _EncryptablePropertySourceConverter_,核心内容如下: ``` public class EncryptablePropertySourceConverter { @@ -715,12 +715,12 @@ public class EncryptablePropertySourceConverter { return encryptablePropertySource; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÏÔÈ»£¬Ëü½«Ïà¹ØÔ­Éú _PropertySource_ ת»»ÎªÁËÒ»¸ö`EncryptablePropertySourceWrapper`£¬ÄÇÕâ¸ö¿Ï¶¨¿ÉÒÔʵÏÖÃÜÎĽâÃÜ£¬±ØÐëµÄ£¡ +显然,它将相关原生 _PropertySource_ 转æ�¢ä¸ºäº†ä¸€ä¸ª`EncryptablePropertySourceWrapper`,那这个肯定å�¯ä»¥å®žçŽ°å¯†æ–‡è§£å¯†ï¼Œå¿…é¡»çš„ï¼� -¼ÌÐø£¬¸ú½ø`EncryptablePropertySourceWrapper`£¬ÄÚÈÝÈçÏ£º +继续,跟进`EncryptablePropertySourceWrapper`,内容如下: ``` public class EncryptablePropertySourceWrapper extends PropertySource implements EncryptablePropertySource { @@ -741,12 +741,12 @@ public class EncryptablePropertySourceWrapper extends PropertySource imple return encryptableDelegate; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ʧÍû£¡Ã»¿´³öɶ½âÃÜÂß¼­£¬µ«´ÓÆä _getProperty_ ·½·¨À´¿´£¬½«¾ßÌå½âÎöÂß¼­Î¯ÅɸøÁË`CachingDelegateEncryptablePropertySource`¡£ +失望ï¼�没看出啥解密逻辑,但从其 _getProperty_ 方法æ�¥çœ‹ï¼Œå°†å…·ä½“è§£æž�逻辑委派给了`CachingDelegateEncryptablePropertySource`。 -û°ì·¨£¬Ö»Äܵ½ _CachingDelegateEncryptablePropertySource_ ÖÐһ̽¾¿¾¹ÁË£º +没办法,å�ªèƒ½åˆ° _CachingDelegateEncryptablePropertySource_ 中一探究竟了: ``` public class CachingDelegateEncryptablePropertySource extends PropertySource implements EncryptablePropertySource { @@ -784,10 +784,10 @@ public class CachingDelegateEncryptablePropertySource extends PropertySource< } } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÖÕÓÚ£¬¸ú½øµ½`EncryptablePropertySource`Öп´µ½Á˽âÃܵÄ×îÖÕÂß¼­¡£ÆäÖУ¬`EncryptablePropertyDetector`¸ºÔð̽²âÏà¹ØÊôÐÔÊÇ·ñÐèÒª¶ÔÆä½âÃÜ£¬Ö÷Ҫͨ¹ýÅжϸÃÊôÐÔÖµÊÇ·ñÓÉ`ENC()`°ü¹ü¡£ +终于,跟进到`EncryptablePropertySource`中看到了解密的最终逻辑。其中,`EncryptablePropertyDetector`负责探测相关属性是å�¦éœ€è¦�对其解密,主è¦�通过判断该属性值是å�¦ç”±`ENC()`包裹。 ``` public interface EncryptablePropertySource extends OriginLookup { @@ -825,21 +825,21 @@ public class DefaultPropertyResolver implements EncryptablePropertyResolver { .orElse(value); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## 4 ×ܽá +## 4 总结 -×ܽáÐÔµÄÎÄ×־Ͳ»ÔÙ˵ÁË£¬±ÊÕßÏÖÔÚÎÄ˼Ȫӿ£¬·ñÔòÓÖÄÜË®300×Ö¡£×îºó£¬Ï£Íû´ó¼Ò¼ÇסÔÚµ±Ç° Spring Boot °æ±¾ÖУ¬ÓÉ`ApplicationServletEnvironment`°çÑÝ _Environment_£¬Æä×îÖÕ½«Î¯ÅÉ`ConfigurationPropertySourcesPropertyResolver`È¥»ñÈ¡ÊôÐÔÖµ¡£ +总结性的文字就ä¸�å†�说了,笔者现在文æ€�泉涌,å�¦åˆ™å�ˆèƒ½æ°´300字。最å�Žï¼Œå¸Œæœ›å¤§å®¶è®°ä½�在当å‰� Spring Boot 版本中,由`ApplicationServletEnvironment`扮演 _Environment_,其最终将委派`ConfigurationPropertySourcesPropertyResolver`去获å�–属性值。 -×÷Õߣº³ÌÐòÔ³¶ÅСͷ -Á´½Ó£ºhttps://juejin.cn/post/7098299623759937543 -À´Ô´£ºÏ¡ÍÁ¾ò½ð -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +作者:程åº�猿æ�œå°�头 +链接:https://juejin.cn/post/7098299623759937543 +æ�¥æº�:稀土掘金 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\344\272\213\344\273\266\345\244\204\347\220\206\346\234\272\345\210\266.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\344\272\213\344\273\266\345\244\204\347\220\206\346\234\272\345\210\266.md" index 98c55c3..e452f80 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\344\272\213\344\273\266\345\244\204\347\220\206\346\234\272\345\210\266.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\344\272\213\344\273\266\345\244\204\347\220\206\346\234\272\345\210\266.md" @@ -2,11 +2,11 @@ -# Spring ÖеÄʼþ´¦Àí +# Spring 中的事件处ç�† -2022-05-16 15:29 ¸üР+2022-05-16 15:29 æ›´æ–° @@ -16,39 +16,39 @@ -## Spring ÖеÄʼþ´¦Àí +## Spring 中的事件处ç�† -ÄãÒѾ­¿´µ½ÁËÔÚËùÓÐÕ½ÚÖÐ Spring µÄºËÐÄÊÇ **ApplicationContext**£¬Ëü¸ºÔð¹ÜÀí beans µÄÍêÕûÉúÃüÖÜÆÚ¡£µ±¼ÓÔØ beans ʱ£¬ApplicationContext ·¢²¼Ä³Ð©ÀàÐ͵Äʼþ¡£ÀýÈ磬µ±ÉÏÏÂÎÄÆô¶¯Ê±£¬ContextStartedEvent ·¢²¼£¬µ±ÉÏÏÂÎÄֹͣʱ£¬ContextStoppedEvent ·¢²¼¡£ +ä½ å·²ç»�看到了在所有章节中 Spring 的核心是 **ApplicationContext**,它负责管ç�† beans 的完整生命周期。当加载 beans 时,ApplicationContext å�‘布æŸ�些类型的事件。例如,当上下文å�¯åŠ¨æ—¶ï¼ŒContextStartedEvent å�‘布,当上下文å�œæ­¢æ—¶ï¼ŒContextStoppedEvent å�‘布。 -ͨ¹ý ApplicationEvent ÀàºÍ ApplicationListener ½Ó¿ÚÀ´ÌṩÔÚ ApplicationContext Öд¦Àíʼþ¡£Èç¹ûÒ»¸ö bean ʵÏÖ ApplicationListener£¬ÄÇôÿ´Î ApplicationEvent ±»·¢²¼µ½ ApplicationContext ÉÏ£¬ÄǸö bean »á±»Í¨Öª¡£ +通过 ApplicationEvent 类和 ApplicationListener 接å�£æ�¥æ��供在 ApplicationContext 中处ç�†äº‹ä»¶ã€‚如果一个 bean 实现 ApplicationListener,那么æ¯�次 ApplicationEvent 被å�‘布到 ApplicationContext 上,那个 bean 会被通知。 -Spring ÌṩÁËÒÔϵıê׼ʼþ£º +Spring æ��供了以下的标准事件: -| ÐòºÅ | Spring ÄÚÖÃʼþ & ÃèÊö | +| åº�å�· | Spring 内置事件 & æ��è¿° | | --- | --- | -| 1 | **ContextRefreshedEvent**ApplicationContext ±»³õʼ»¯»òË¢ÐÂʱ£¬¸Ãʼþ±»·¢²¼¡£ÕâÒ²¿ÉÒÔÔÚ ConfigurableApplicationContext ½Ó¿ÚÖÐʹÓà refresh() ·½·¨À´·¢Éú¡£ | -| 2 | **ContextStartedEvent**µ±Ê¹Óà ConfigurableApplicationContext ½Ó¿ÚÖÐµÄ start() ·½·¨Æô¶¯ ApplicationContext ʱ£¬¸Ãʼþ±»·¢²¼¡£Äã¿ÉÒÔµ÷²éÄãµÄÊý¾Ý¿â£¬»òÕßÄã¿ÉÒÔÔÚ½ÓÊܵ½Õâ¸öʼþºóÖØÆôÈκÎÍ£Ö¹µÄÓ¦ÓóÌÐò¡£ | -| 3 | **ContextStoppedEvent**µ±Ê¹Óà ConfigurableApplicationContext ½Ó¿ÚÖÐµÄ stop() ·½·¨Í£Ö¹ ApplicationContext ʱ£¬·¢²¼Õâ¸öʼþ¡£Äã¿ÉÒÔÔÚ½ÓÊܵ½Õâ¸öʼþºó×ö±ØÒªµÄÇåÀíµÄ¹¤×÷¡£ | -| 4 | **ContextClosedEvent**µ±Ê¹Óà ConfigurableApplicationContext ½Ó¿ÚÖÐµÄ close() ·½·¨¹Ø±Õ ApplicationContext ʱ£¬¸Ãʼþ±»·¢²¼¡£Ò»¸öÒѹرյÄÉÏÏÂÎĵ½´ïÉúÃüÖÜÆÚÄ©¶Ë£»Ëü²»Äܱ»Ë¢Ð»òÖØÆô¡£ | -| 5 | **RequestHandledEvent**ÕâÊÇÒ»¸ö web-specific ʼþ£¬¸æËßËùÓÐ bean HTTP ÇëÇóÒѾ­±»·þÎñ¡£ | +| 1 | **ContextRefreshedEvent**ApplicationContext 被åˆ�始化或刷新时,该事件被å�‘布。这也å�¯ä»¥åœ¨ ConfigurableApplicationContext 接å�£ä¸­ä½¿ç”¨ refresh() 方法æ�¥å�‘生。 | +| 2 | **ContextStartedEvent**当使用 ConfigurableApplicationContext 接å�£ä¸­çš„ start() 方法å�¯åЍ ApplicationContext 时,该事件被å�‘布。你å�¯ä»¥è°ƒæŸ¥ä½ çš„æ•°æ�®åº“,或者你å�¯ä»¥åœ¨æŽ¥å�—到这个事件å�Žé‡�å�¯ä»»ä½•å�œæ­¢çš„应用程åº�。 | +| 3 | **ContextStoppedEvent**当使用 ConfigurableApplicationContext 接å�£ä¸­çš„ stop() 方法å�œæ­¢ ApplicationContext 时,å�‘布这个事件。你å�¯ä»¥åœ¨æŽ¥å�—到这个事件å�Žå�šå¿…è¦�的清ç�†çš„工作。 | +| 4 | **ContextClosedEvent**当使用 ConfigurableApplicationContext 接å�£ä¸­çš„ close() 方法关闭 ApplicationContext 时,该事件被å�‘布。一个已关闭的上下文到达生命周期末端;它ä¸�能被刷新或é‡�å�¯ã€‚ | +| 5 | **RequestHandledEvent**这是一个 web-specific 事件,告诉所有 bean HTTP 请求已ç»�被æœ�务。 | -ÓÉÓÚ Spring µÄʼþ´¦ÀíÊǵ¥Ï̵߳ģ¬ËùÒÔÈç¹ûÒ»¸öʼþ±»·¢²¼£¬Ö±ÖÁ²¢ÇÒ³ý·ÇËùÓеĽÓÊÕÕߵõ½µÄ¸ÃÏûÏ¢£¬¸Ã½ø³Ì±»×èÈû²¢ÇÒÁ÷³Ì½«²»»á¼ÌÐø¡£Òò´Ë£¬Èç¹ûʼþ´¦Àí±»Ê¹Óã¬ÔÚÉè¼ÆÓ¦ÓóÌÐòʱӦעÒâ¡£ +由于 Spring 的事件处ç�†æ˜¯å�•线程的,所以如果一个事件被å�‘布,直至并且除é�žæ‰€æœ‰çš„æŽ¥æ”¶è€…得到的该消æ�¯ï¼Œè¯¥è¿›ç¨‹è¢«é˜»å¡žå¹¶ä¸”æµ�程将ä¸�会继续。因此,如果事件处ç�†è¢«ä½¿ç”¨ï¼Œåœ¨è®¾è®¡åº”用程åº�时应注æ„�。 -## ¼àÌýÉÏÏÂÎÄʼþ +## 监å�¬ä¸Šä¸‹æ–‡äº‹ä»¶ -ΪÁ˼àÌýÉÏÏÂÎÄʼþ£¬Ò»¸ö bean Ó¦¸ÃʵÏÖÖ»ÓÐÒ»¸ö·½·¨ **onApplicationEvent()** µÄ ApplicationListener ½Ó¿Ú¡£Òò´Ë£¬ÎÒÃÇдһ¸öÀý×ÓÀ´¿´¿´Ê¼þÊÇÈçºÎ´«²¥µÄ£¬ÒÔ¼°ÈçºÎ¿ÉÒÔÓôúÂëÀ´Ö´ÐлùÓÚijЩʼþËùÐèµÄÈÎÎñ¡£ +为了监å�¬ä¸Šä¸‹æ–‡äº‹ä»¶ï¼Œä¸€ä¸ª bean 应该实现å�ªæœ‰ä¸€ä¸ªæ–¹æ³• **onApplicationEvent()** çš„ ApplicationListener 接å�£ã€‚因此,我们写一个例å­�æ�¥çœ‹çœ‹äº‹ä»¶æ˜¯å¦‚何传播的,以å�Šå¦‚何å�¯ä»¥ç”¨ä»£ç �æ�¥æ‰§è¡ŒåŸºäºŽæŸ�些事件所需的任务。 -ÈÃÎÒÃÇÔÚÇ¡µ±µÄλÖÃʹÓà Eclipse IDE£¬È»ºó°´ÕÕÏÂÃæµÄ²½ÖèÀ´´´½¨Ò»¸ö Spring Ó¦ÓóÌÐò£º +让我们在æ�°å½“çš„ä½�置使用 Eclipse IDE,然å�ŽæŒ‰ç…§ä¸‹é�¢çš„æ­¥éª¤æ�¥åˆ›å»ºä¸€ä¸ª Spring 应用程åº�: -| ²½Öè | ÃèÊö | +| 步骤 | æ��è¿° | | --- | --- | -| 1 | ´´½¨Ò»¸öÃû³ÆÎª SpringExample µÄÏîÄ¿£¬²¢ÇÒÔÚ´´½¨ÏîÄ¿µÄ **src** Îļþ¼ÐÖд´½¨Ò»¸ö°ü com.tutorialspoint¡£ | -| 2 | ʹÓà Add External JARs Ñ¡ÏÌí¼ÓËùÐèµÄ Spring ¿â£¬½âÊͼû Spring Hello World Example Õ½ڡ£ | -| 3 | ÔÚ com.tutorialspoint °üÖд´½¨ Java Àà HelloWorld¡¢CStartEventHandler¡¢CStopEventHandler ºÍ MainApp¡£ | -| 4 | ÔÚ **src** Îļþ¼ÐÖд´½¨ Bean µÄÅäÖÃÎļþ Beans.xml¡£ | -| 5 | ×îºóÒ»²½ÊÇ´´½¨µÄËùÓÐ Java ÎļþºÍ Bean ÅäÖÃÎļþµÄÄÚÈÝ£¬²¢ÔËÐÐÓ¦ÓóÌÐò£¬½âÊÍÈçÏÂËùʾ¡£ | +| 1 | 创建一个å��称为 SpringExample 的项目,并且在创建项目的 **src** 文件夹中创建一个包 com.tutorialspoint。 | +| 2 | 使用 Add External JARs 选项,添加所需的 Spring 库,解释è§� Spring Hello World Example 章节。 | +| 3 | 在 com.tutorialspoint 包中创建 Java ç±» HelloWorldã€�CStartEventHandlerã€�CStopEventHandler å’Œ MainApp。 | +| 4 | 在 **src** 文件夹中创建 Bean çš„é…�置文件 Beans.xml。 | +| 5 | 最å�Žä¸€æ­¥æ˜¯åˆ›å»ºçš„æ‰€æœ‰ Java 文件和 Bean é…�置文件的内容,并è¿�行应用程åº�,解释如下所示。 | -ÕâÀïÊÇ **HelloWorld.java** ÎļþµÄÄÚÈÝ£º +这里是 **HelloWorld.java** 文件的内容: ``` package com.tutorialspoint; @@ -63,7 +63,7 @@ public class HelloWorld { } ``` -ÏÂÃæÊÇ **CStartEventHandler.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **CStartEventHandler.java** 文件的内容: ``` package com.tutorialspoint; @@ -77,7 +77,7 @@ public class CStartEventHandler } ``` -ÏÂÃæÊÇ **CStopEventHandler.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **CStopEventHandler.java** 文件的内容: ``` package com.tutorialspoint; @@ -91,7 +91,7 @@ public class CStopEventHandler } ``` -ÏÂÃæÊÇ **MainApp.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **MainApp.java** 文件的内容: ``` package com.tutorialspoint; @@ -117,7 +117,7 @@ public class MainApp { } ``` -ÏÂÃæÊÇÅäÖÃÎļþ **Beans.xml** Îļþ£º +下é�¢æ˜¯é…�置文件 **Beans.xml** 文件: ``` @@ -140,7 +140,7 @@ public class MainApp { ``` -Ò»µ©ÄãÍê³ÉÁË´´½¨Ô´ºÍ bean µÄÅäÖÃÎļþ£¬ÎÒÃǾͿÉÒÔÔËÐиÃÓ¦ÓóÌÐò¡£Èç¹ûÄãµÄÓ¦ÓóÌÐòÒ»Çж¼Õý³££¬½«Êä³öÒÔÏÂÏûÏ¢£º +一旦你完æˆ�了创建æº�å’Œ bean çš„é…�置文件,我们就å�¯ä»¥è¿�行该应用程åº�。如果你的应用程åº�一切都正常,将输出以下消æ�¯ï¼š ``` ContextStartedEvent Received @@ -154,21 +154,21 @@ ContextStoppedEvent Received -## Spring ÖеÄ×Ô¶¨Òåʼþ +## Spring 中的自定义事件 -±àдºÍ·¢²¼×Ô¼ºµÄ×Ô¶¨ÒåʼþÓÐÐí¶à²½Öè¡£°´ÕÕÔÚÕâÒ»Õ¸ø³öµÄ˵Ã÷À´±àд£¬·¢²¼ºÍ´¦Àí×Ô¶¨Òå Spring ʼþ¡£ +编写和å�‘布自己的自定义事件有许多步骤。按照在这一章给出的说明æ�¥ç¼–写,å�‘布和处ç�†è‡ªå®šä¹‰ Spring 事件。 -| ²½Öè | ÃèÊö | +| 步骤 | æ��è¿° | | --- | --- | -| 1 | ´´½¨Ò»¸öÃû³ÆÎª SpringExample µÄÏîÄ¿£¬²¢ÇÒÔÚ´´½¨ÏîÄ¿µÄ **src** Îļþ¼ÐÖд´½¨Ò»¸ö°ü com.tutorialspoint¡£ | -| 2 | ʹÓà Add External JARs Ñ¡ÏÌí¼ÓËùÐèµÄ Spring ¿â£¬½âÊͼû Spring Hello World Example Õ½ڡ£ | -| 3 | ͨ¹ýÀ©Õ¹ **ApplicationEvent**,´´½¨Ò»¸öʼþÀà CustomEvent¡£Õâ¸öÀà±ØÐ붨ÒåÒ»¸öĬÈϵĹ¹Ô캯Êý£¬ËüÓ¦¸Ã´Ó ApplicationEvent ÀàÖм̳еĹ¹Ô캯Êý¡£ | -| 4 | Ò»µ©¶¨ÒåʼþÀ࣬Äã¿ÉÒÔ´ÓÈκÎÀàÖз¢²¼Ëü£¬¼Ù¶¨ EventClassPublisher ʵÏÖÁË ApplicationEventPublisherAware¡£Ä㻹ÐèÒªÔÚ XML ÅäÖÃÎļþÖÐÉùÃ÷Õâ¸öÀà×÷Ϊһ¸ö bean£¬Ö®ËùÒÔÈÝÆ÷¿ÉÒÔʶ±ð bean ×÷Ϊʼþ·¢²¼Õߣ¬ÊÇÒòΪËüʵÏÖÁË ApplicationEventPublisherAware ½Ó¿Ú¡£ | -| 5 | ·¢²¼µÄʼþ¿ÉÒÔÔÚÒ»¸öÀàÖб»´¦Àí£¬¼Ù¶¨ EventClassHandler ʵÏÖÁË ApplicationListener ½Ó¿Ú£¬¶øÇÒʵÏÖÁË×Ô¶¨ÒåʼþµÄ onApplicationEvent ·½·¨¡£ | -| 6 | ÔÚ **src** Îļþ¼ÐÖд´½¨ bean µÄÅäÖÃÎļþ Beans.xml ºÍ MainApp À࣬Ëü¿ÉÒÔ×÷Ϊһ¸ö Spring Ó¦ÓóÌÐòÀ´ÔËÐС£ | -| 7 | ×îºóÒ»²½ÊÇ´´½¨µÄËùÓÐ Java ÎļþºÍ Bean ÅäÖÃÎļþµÄÄÚÈÝ£¬²¢ÔËÐÐÓ¦ÓóÌÐò£¬½âÊÍÈçÏÂËùʾ¡£ | +| 1 | 创建一个å��称为 SpringExample 的项目,并且在创建项目的 **src** 文件夹中创建一个包 com.tutorialspoint。 | +| 2 | 使用 Add External JARs 选项,添加所需的 Spring 库,解释è§� Spring Hello World Example 章节。 | +| 3 | 通过扩展 **ApplicationEvent**,创建一个事件类 CustomEvent。这个类必须定义一个默认的构造函数,它应该从 ApplicationEvent 类中继承的构造函数。 | +| 4 | 一旦定义事件类,你å�¯ä»¥ä»Žä»»ä½•类中å�‘布它,å�‡å®š EventClassPublisher 实现了 ApplicationEventPublisherAware。你还需è¦�在 XML é…�置文件中声明这个类作为一个 bean,之所以容器å�¯ä»¥è¯†åˆ« bean 作为事件å�‘布者,是因为它实现了 ApplicationEventPublisherAware 接å�£ã€‚ | +| 5 | å�‘布的事件å�¯ä»¥åœ¨ä¸€ä¸ªç±»ä¸­è¢«å¤„ç�†ï¼Œå�‡å®š EventClassHandler 实现了 ApplicationListener 接å�£ï¼Œè€Œä¸”实现了自定义事件的 onApplicationEvent 方法。 | +| 6 | 在 **src** 文件夹中创建 bean çš„é…�置文件 Beans.xml å’Œ MainApp 类,它å�¯ä»¥ä½œä¸ºä¸€ä¸ª Spring 应用程åº�æ�¥è¿�行。 | +| 7 | 最å�Žä¸€æ­¥æ˜¯åˆ›å»ºçš„æ‰€æœ‰ Java 文件和 Bean é…�置文件的内容,并è¿�行应用程åº�,解释如下所示。 | -Õâ¸öÊÇ **CustomEvent.java** ÎļþµÄÄÚÈÝ£º +这个是 **CustomEvent.java** 文件的内容: ``` package com.tutorialspoint; @@ -184,7 +184,7 @@ public class CustomEvent extends ApplicationEvent{ ``` -ÏÂÃæÊÇ **CustomEventPublisher.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **CustomEventPublisher.java** 文件的内容: ``` package com.tutorialspoint; @@ -204,7 +204,7 @@ public class CustomEventPublisher } ``` -ÏÂÃæÊÇ **CustomEventHandler.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **CustomEventHandler.java** 文件的内容: ``` package com.tutorialspoint; @@ -217,7 +217,7 @@ public class CustomEventHandler } ``` -ÏÂÃæÊÇ **MainApp.java** ÎļþµÄÄÚÈÝ£º +下é�¢æ˜¯ **MainApp.java** 文件的内容: ``` package com.tutorialspoint; @@ -235,7 +235,7 @@ public class MainApp { } ``` -ÏÂÃæÊÇÅäÖÃÎļþ **Beans.xml**£º +下é�¢æ˜¯é…�置文件 **Beans.xml**: ``` @@ -254,14 +254,14 @@ public class MainApp { ``` -Ò»µ©ÄãÍê³ÉÁË´´½¨Ô´ºÍ bean µÄÅäÖÃÎļþºó£¬ÎÒÃǾͿÉÒÔÔËÐиÃÓ¦ÓóÌÐò¡£Èç¹ûÄãµÄÓ¦ÓóÌÐòÒ»Çж¼Õý³££¬½«Êä³öÒÔÏÂÐÅÏ¢£º +一旦你完æˆ�了创建æº�å’Œ bean çš„é…�置文件å�Žï¼Œæˆ‘们就å�¯ä»¥è¿�行该应用程åº�。如果你的应用程åº�一切都正常,将输出以下信æ�¯ï¼š ``` My Custom Event My Custom Event ``` -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\350\265\204\346\272\220\347\256\241\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\350\265\204\346\272\220\347\256\241\347\220\206.md" index 09874af..ec68c5c 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\350\265\204\346\272\220\347\256\241\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\350\265\204\346\272\220\347\256\241\347\220\206.md" @@ -1,6 +1,6 @@ -## Resource ½Ó¿Ú +## Resource 接å�£ -Ïà¶Ô±ê×¼ URL ·ÃÎÊ»úÖÆ£¬Spring µÄ `org.springframework.core.io.Resource` ½Ó¿Ú³éÏóÁ˶Եײã×ÊÔ´µÄ·ÃÎʽӿڣ¬ÌṩÁËÒ»Ì׸üºÃµÄ·ÃÎÊ·½Ê½¡£ +相对标准 URL 访问机制,Spring çš„ `org.springframework.core.io.Resource` 接å�£æŠ½è±¡äº†å¯¹åº•层资æº�的访问接å�£ï¼Œæ��供了一套更好的访问方å¼�。 @@ -38,46 +38,46 @@ public interface Resource extends InputStreamSource { -ÕýÈç `Resource` ½Ó¿ÚµÄ¶¨ÒåËùʾ£¬ËüÀ©Õ¹ÁË `InputStreamSource` ½Ó¿Ú¡£`Resource` ×îºËÐĵķ½·¨ÈçÏ£º +正如 `Resource` 接å�£çš„定义所示,它扩展了 `InputStreamSource` 接å�£ã€‚`Resource` 最核心的方法如下: -* `getInputStream()` - ¶¨Î»²¢ÇÒ´ò¿ªµ±Ç°×ÊÔ´£¬·µ»Øµ±Ç°×ÊÔ´µÄ `InputStream`¡£Ã¿´Îµ÷Óö¼»á·µ»ØÒ»¸öÐ嵀 `InputStream`¡£µ÷ÓÃÕßÐèÒª¸ºÔð¹Ø±ÕÁ÷¡£ -* `exists()` - Åжϵ±Ç°×ÊÔ´ÊÇ·ñÕæµÄ´æÔÚ¡£ -* `isOpen()` - Åжϵ±Ç°×ÊÔ´ÊÇ·ñÊÇÒ»¸öÒÑ´ò¿ªµÄ `InputStream`¡£Èç¹ûΪ true£¬Ôò `InputStream` ²»Äܱ»¶à´Î¶ÁÈ¡£¬±ØÐëÖ»¶Áȡһ´ÎÈ»ºó¹Ø±ÕÒÔ±ÜÃâ×ÊԴй©¡£¶ÔËùÓг£ÓÃ×ÊԴʵÏÖ·µ»Ø false£¬`InputStreamResource` ³ýÍâ¡£ -* `getDescription()` - ·µ»Øµ±Ç°×ÊÔ´µÄÃèÊö£¬µ±´¦Àí×ÊÔ´³ö´íʱ£¬×ÊÔ´µÄÃèÊö»áÓÃÓÚ´íÎóÐÅÏ¢µÄÊä³ö¡£Ò»°ãÀ´Ëµ£¬×ÊÔ´µÄÃèÊöÊÇÒ»¸öÍêÈ«ÏÞ¶¨µÄÎļþÃû³Æ£¬»òÕßÊǵ±Ç°×ÊÔ´µÄÕæÊµ URL¡£ +* `getInputStream()` - 定ä½�并且打开当å‰�资æº�,返回当å‰�资æº�çš„ `InputStream`。æ¯�次调用都会返回一个新的 `InputStream`。调用者需è¦�负责关闭æµ�。 +* `exists()` - 判断当å‰�资æº�是å�¦çœŸçš„存在。 +* `isOpen()` - 判断当å‰�资æº�是å�¦æ˜¯ä¸€ä¸ªå·²æ‰“开的 `InputStream`。如果为 true,则 `InputStream` ä¸�能被多次读å�–,必须å�ªè¯»å�–一次然å�Žå…³é—­ä»¥é�¿å…�资æº�泄æ¼�。对所有常用资æº�实现返回 false,`InputStreamResource` 除外。 +* `getDescription()` - 返回当å‰�资æº�çš„æ��述,当处ç�†èµ„æº�出错时,资æº�çš„æ��述会用于错误信æ�¯çš„输出。一般æ�¥è¯´ï¼Œèµ„æº�çš„æ��述是一个完全é™�定的文件å��称,或者是当å‰�资æº�的真实 URL。 -³£¼û Spring ×ÊÔ´½Ó¿Ú£º +常è§� Spring 资æº�接å�£ï¼š -| ÀàÐÍ | ½Ó¿Ú | +| 类型 | 接å�£ | | --- | --- | -| ÊäÈëÁ÷ | `org.springframework.core.io.InputStreamSource` | -| Ö»¶Á×ÊÔ´ | `org.springframework.core.io.Resource` | -| ¿Éд×ÊÔ´ | `org.springframework.core.io.WritableResource` | -| ±àÂë×ÊÔ´ | `org.springframework.core.io.support.EncodedResource` | -| ÉÏÏÂÎÄ×ÊÔ´ | `org.springframework.core.io.ContextResource` | +| 输入æµ� | `org.springframework.core.io.InputStreamSource` | +| å�ªè¯»èµ„æº� | `org.springframework.core.io.Resource` | +| å�¯å†™èµ„æº� | `org.springframework.core.io.WritableResource` | +| ç¼–ç �资æº� | `org.springframework.core.io.support.EncodedResource` | +| 上下文资æº� | `org.springframework.core.io.ContextResource` | ![](https://raw.githubusercontent.com/dunwu/images/dev/snap/20221223155859.png) -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E5%86%85%E7%BD%AE%E7%9A%84-resource-%E5%AE%9E%E7%8E%B0)ÄÚÖÃµÄ Resource ʵÏÖ +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E5%86%85%E7%BD%AE%E7%9A%84-resource-%E5%AE%9E%E7%8E%B0)内置的 Resource 实现 -Spring °üÀ¨¼¸¸öÄÚÖÃµÄ Resource ʵÏÖ£º +Spring 包括几个内置的 Resource 实现: -| ×ÊÔ´À´Ô´ | ǰ׺ | ˵Ã÷ | +| 资æº�æ�¥æº� | å‰�ç¼€ | 说明 | | --- | --- | --- | -| [`UrlResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-urlresource) | `file:`¡¢`https:`¡¢`ftp:` µÈ | `UrlResource` ·â×°ÁËÒ»¸ö `java.net.URL` ¶ÔÏó£¬**ÓÃÓÚ·ÃÎÊ¿Éͨ¹ý URL ·ÃÎʵÄÈκζÔÏó**£¬ÀýÈçÎļþ¡¢HTTPS Ä¿±ê¡¢FTP Ä¿±êµÈ¡£ËùÓÐ URL ¶¼¿ÉÒÔͨ¹ý±ê×¼»¯µÄ×Ö·û´®ÐÎʽ±íʾ£¬Òò´Ë¿ÉÒÔʹÓÃÊʵ±µÄ±ê×¼»¯Ç°×ºÀ´Ö¸Ê¾Ò»ÖÖ URL ÀàÐÍÓëÁíÒ»ÖÖ URL ÀàÐ͵ÄÇø±ð¡£ Õâ°üÀ¨£º`file`£ºÓÃÓÚ·ÃÎÊÎļþϵͳ·¾¶£»`https`£ºÓÃÓÚͨ¹ý HTTPS ЭÒé·ÃÎÊ×ÊÔ´£»`ftp`£ºÓÃÓÚͨ¹ý FTP ·ÃÎÊ×ÊÔ´µÈµÈ¡£ | -| [`ClassPathResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-classpathresource) | `classpath:` | `ClassPathResource` **´ÓÀà·¾¶ÉϼÓÔØ×ÊÔ´**¡£ËüʹÓÃÏß³ÌÉÏÏÂÎļÓÔØÆ÷¡¢¸ø¶¨µÄÀà¼ÓÔØÆ÷»òÖ¸¶¨µÄ class ÀàÐÍÖеÄÈÎÒâÒ»¸öÀ´¼ÓÔØ×ÊÔ´¡£ | -| [`FileSystemResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-filesystemresource) | `file:` | `FileSystemResource` **ÊÇ `java.io.File` µÄ×ÊԴʵÏÖ**¡£Ëü»¹Ö§³Ö `java.nio.file.Path` £¬Ó¦Óà Spring µÄ±ê×¼¶Ô×Ö·û´®Â·¾¶½øÐÐת»»¡£`FileSystemResource` Ö§³Ö½âÎöΪÎļþºÍ URL¡£ | -| [`PathResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-pathresource) | ÎÞ | `PathResource` ÊÇ `java.nio.file.Path` µÄ×ÊԴʵÏÖ¡£ | -| [`ServletContextResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-servletcontextresource) | ÎÞ | `ServletContextResource` **ÊÇ `ServletContext` µÄ×ÊԴʵÏÖ**¡£Ëü±íʾÏàÓ¦ Web Ó¦ÓóÌÐò¸ùĿ¼ÖеÄÏà¶Ô·¾¶¡£ | -| [`InputStreamResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-inputstreamresource) | ÎÞ | `InputStreamResource` **ÊÇÖ¸¶¨ `InputStream` µÄ×ÊԴʵÏÖ**¡£×¢Ò⣺Èç¹û¸Ã `InputStream` Òѱ»´ò¿ª£¬Ôò²»¿ÉÒÔ¶à´Î¶ÁÈ¡¸ÃÁ÷¡£ | -| [`ByteArrayResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-bytearrayresource) | ÎÞ | `ByteArrayResource` ÊÇÖ¸¶¨µÄ¶þ½øÖÆÊý×éµÄ×ÊԴʵÏÖ¡£Ëü»áΪ¸ø¶¨µÄ×Ö½ÚÊý×é´´½¨Ò»¸ö `ByteArrayInputStream`¡£ | +| [`UrlResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-urlresource) | `file:`ã€�`https:`ã€�`ftp:` ç­‰ | `UrlResource` å°�装了一个 `java.net.URL` 对象,**用于访问å�¯é€šè¿‡ URL 访问的任何对象**,例如文件ã€�HTTPS 目标ã€�FTP 目标等。所有 URL 都å�¯ä»¥é€šè¿‡æ ‡å‡†åŒ–的字符串形å¼�表示,因此å�¯ä»¥ä½¿ç”¨é€‚当的标准化å‰�ç¼€æ�¥æŒ‡ç¤ºä¸€ç§� URL 类型与å�¦ä¸€ç§� URL 类型的区别。 这包括:`file`:用于访问文件系统路径;`https`:用于通过 HTTPS å��议访问资æº�ï¼›`ftp`:用于通过 FTP 访问资æº�等等。 | +| [`ClassPathResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-classpathresource) | `classpath:` | `ClassPathResource` **从类路径上加载资æº�**。它使用线程上下文加载器ã€�给定的类加载器或指定的 class 类型中的任æ„�一个æ�¥åŠ è½½èµ„æº�。 | +| [`FileSystemResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-filesystemresource) | `file:` | `FileSystemResource` **是 `java.io.File` 的资æº�实现**。它还支æŒ� `java.nio.file.Path` ,应用 Spring 的标准对字符串路径进行转æ�¢ã€‚`FileSystemResource` 支æŒ�è§£æž�为文件和 URL。 | +| [`PathResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-pathresource) | æ—  | `PathResource` 是 `java.nio.file.Path` 的资æº�实现。 | +| [`ServletContextResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-servletcontextresource) | æ—  | `ServletContextResource` **是 `ServletContext` 的资æº�实现**。它表示相应 Web 应用程åº�根目录中的相对路径。 | +| [`InputStreamResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-inputstreamresource) | æ—  | `InputStreamResource` **是指定 `InputStream` 的资æº�实现**。注æ„�:如果该 `InputStream` 已被打开,则ä¸�å�¯ä»¥å¤šæ¬¡è¯»å�–该æµ�。 | +| [`ByteArrayResource`(opens new window)](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#resources-implementations-bytearrayresource) | æ—  | `ByteArrayResource` 是指定的二进制数组的资æº�实现。它会为给定的字节数组创建一个 `ByteArrayInputStream`。 | -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#resourceloader-%E6%8E%A5%E5%8F%A3)ResourceLoader ½Ó¿Ú +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#resourceloader-%E6%8E%A5%E5%8F%A3)ResourceLoader 接å�£ -`ResourceLoader` ½Ó¿ÚÓÃÓÚ¼ÓÔØ `Resource` ¶ÔÏ󡣯䶍ÒåÈçÏ£º +`ResourceLoader` 接å�£ç”¨äºŽåŠ è½½ `Resource` 对象。其定义如下: @@ -93,22 +93,22 @@ public interface ResourceLoader { -Spring ÖÐÖ÷ÒªµÄ ResourceLoader ʵÏÖ£º +Spring 中主è¦�çš„ ResourceLoader 实现: ![](https://raw.githubusercontent.com/dunwu/images/dev/snap/20221223164745.png) -Spring ÖУ¬ËùÓÐµÄ `ApplicationContext` ¶¼ÊµÏÖÁË `ResourceLoader` ½Ó¿Ú¡£Òò´Ë£¬ËùÓÐ `ApplicationContext` ¶¼¿ÉÒÔͨ¹ý `getResource()` ·½·¨»ñÈ¡ `Resource` ʵÀý¡£ +Spring 中,所有的 `ApplicationContext` 都实现了 `ResourceLoader` 接å�£ã€‚因此,所有 `ApplicationContext` 都å�¯ä»¥é€šè¿‡ `getResource()` 方法获å�– `Resource` 实例。 -¡¾Ê¾Àý¡¿ +ã€�示例】 ``` -// Èç¹ûûÓÐÖ¸¶¨×ÊԴǰ׺£¬Spring »á³¢ÊÔ·µ»ØºÏÊʵÄ×ÊÔ´ +// 如果没有指定资æº�å‰�缀,Spring 会å°�试返回å�ˆé€‚的资æº� Resource template = ctx.getResource("some/resource/path/myTemplate.txt"); -// Èç¹ûÖ¸¶¨ classpath: ǰ׺£¬Spring »áÇ¿ÖÆÊ¹Óà ClassPathResource +// 如果指定 classpath: å‰�缀,Spring 会强制使用 ClassPathResource Resource template = ctx.getResource("classpath:some/resource/path/myTemplate.txt"); -// Èç¹ûÖ¸¶¨ file:¡¢http µÈ URL ǰ׺£¬Spring »áÇ¿ÖÆÊ¹Óà UrlResource +// 如果指定 file:ã€�http ç­‰ URL å‰�缀,Spring 会强制使用 UrlResource Resource template = ctx.getResource("file:///some/resource/path/myTemplate.txt"); Resource template = ctx.getResource("http://myhost.com/resource/path/myTemplate.txt"); @@ -116,20 +116,20 @@ Resource template = ctx.getResource("http://myhost.com/resource/path/myTemplate. -ϱíÁоÙÁË Spring ¸ù¾Ý¸÷ÖÖλÖ÷¾¶¼ÓÔØ×ÊÔ´µÄ²ßÂÔ£º +下表列举了 Spring æ ¹æ�®å�„ç§�ä½�置路径加载资æº�的策略: -| ǰ׺ | ÑùÀý | ˵Ã÷ | +| å‰�ç¼€ | 样例 | 说明 | | --- | --- | --- | -| `classpath:` | `classpath:com/myapp/config.xml` | ´ÓÀà·¾¶¼ÓÔØ | -| `file:` | `file:///data/config.xml` | ÒÔ URL ÐÎʽ´ÓÎļþϵͳ¼ÓÔØ | -| `http:` | `http://myserver/logo.png` | ÒÔ URL ÐÎʽ¼ÓÔØ | -| ÎÞ | `/data/config.xml` | ÓɵײãµÄ ApplicationContext ʵÏÖ¾ö¶¨ | +| `classpath:` | `classpath:com/myapp/config.xml` | 从类路径加载 | +| `file:` | `file:///data/config.xml` | 以 URL å½¢å¼�从文件系统加载 | +| `http:` | `http://myserver/logo.png` | 以 URL å½¢å¼�加载 | +| æ—  | `/data/config.xml` | 由底层的 ApplicationContext 实现决定 | -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#resourcepatternresolver-%E6%8E%A5%E5%8F%A3)ResourcePatternResolver ½Ó¿Ú +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#resourcepatternresolver-%E6%8E%A5%E5%8F%A3)ResourcePatternResolver 接å�£ -`ResourcePatternResolver` ½Ó¿ÚÊÇ `ResourceLoader` ½Ó¿ÚµÄÀ©Õ¹£¬ËüµÄ×÷ÓÃÊǶ¨Òå²ßÂÔ£¬¸ù¾ÝλÖÃģʽ½âÎö `Resource` ¶ÔÏó¡£ +`ResourcePatternResolver` 接å�£æ˜¯ `ResourceLoader` 接å�£çš„æ‰©å±•,它的作用是定义策略,根æ�®ä½�置模å¼�è§£æž� `Resource` 对象。 @@ -145,13 +145,13 @@ public interface ResourcePatternResolver extends ResourceLoader { -`PathMatchingResourcePatternResolver` ÊÇÒ»¸ö¶ÀÁ¢µÄʵÏÖ£¬¿ÉÒÔÔÚ `ApplicationContext` Ö®ÍâʹÓã¬Ò²¿ÉÒÔ±» `ResourceArrayPropertyEditor` ÓÃÓÚÌî³ä `Resource[]` bean ÊôÐÔ¡£`PathMatchingResourcePatternResolver` Äܹ»½«Ö¸¶¨µÄ×ÊԴλÖ÷¾¶½âÎöΪһ¸ö»ò¶à¸öÆ¥ÅäµÄ `Resource` ¶ÔÏó¡£ +`PathMatchingResourcePatternResolver` 是一个独立的实现,å�¯ä»¥åœ¨ `ApplicationContext` 之外使用,也å�¯ä»¥è¢« `ResourceArrayPropertyEditor` 用于填充 `Resource[]` bean 属性。`PathMatchingResourcePatternResolver` 能够将指定的资æº�ä½�置路径解æž�为一个或多个匹é…�çš„ `Resource` 对象。 -> ×¢Ò⣺Èκαê×¼ `ApplicationContext` ÖеÄĬÈÏ `ResourceLoader` ʵ¼ÊÉÏÊÇ `PathMatchingResourcePatternResolver` µÄÒ»¸öʵÀý£¬ËüʵÏÖÁË `ResourcePatternResolver` ½Ó¿Ú¡£ +> 注æ„�:任何标准 `ApplicationContext` 中的默认 `ResourceLoader` 实际上是 `PathMatchingResourcePatternResolver` 的一个实例,它实现了 `ResourcePatternResolver` 接å�£ã€‚ -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#resourceloaderaware-%E6%8E%A5%E5%8F%A3)ResourceLoaderAware ½Ó¿Ú +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#resourceloaderaware-%E6%8E%A5%E5%8F%A3)ResourceLoaderAware 接å�£ -`ResourceLoaderAware` ½Ó¿ÚÊÇÒ»¸öÌØÊâµÄ»Øµ÷½Ó¿Ú£¬ÓÃÀ´±ê¼ÇÌṩ `ResourceLoader` ÒýÓõĶÔÏó¡£`ResourceLoaderAware` ½Ó¿Ú¶¨ÒåÈçÏ£º +`ResourceLoaderAware` 接å�£æ˜¯ä¸€ä¸ªç‰¹æ®Šçš„回调接å�£ï¼Œç”¨æ�¥æ ‡è®°æ��ä¾› `ResourceLoader` 引用的对象。`ResourceLoaderAware` 接å�£å®šä¹‰å¦‚下: @@ -164,19 +164,19 @@ public interface ResourceLoaderAware { -µ±Ò»¸öÀàʵÏÖ `ResourceLoaderAware` ²¢²¿Êðµ½Ó¦ÓóÌÐòÉÏÏÂÎÄÖУ¨×÷Ϊ Spring ¹ÜÀíµÄ bean£©Ê±£¬Ëü»á±»Ó¦ÓóÌÐòÉÏÏÂÎÄʶ±ðΪ `ResourceLoaderAware`£¬È»ºó£¬Ó¦ÓóÌÐòÉÏÏÂÎÄ»áµ÷Óà `setResourceLoader(ResourceLoader)`£¬½«×ÔÉí×÷Ϊ²ÎÊýÌṩ£¨Çë¼Çס£¬Spring ÖеÄËùÓÐÓ¦ÓóÌÐòÉÏÏÂÎĶ¼ÊµÏÖ `ResourceLoader` ½Ó¿Ú£©¡£ +当一个类实现 `ResourceLoaderAware` 并部署到应用程åº�上下文中(作为 Spring 管ç�†çš„ bean)时,它会被应用程åº�上下文识别为 `ResourceLoaderAware`,然å�Žï¼Œåº”用程åº�上下文会调用 `setResourceLoader(ResourceLoader)`,将自身作为å�‚æ•°æ��供(请记ä½�,Spring 中的所有应用程åº�上下文都实现 `ResourceLoader` 接å�£ï¼‰ã€‚ -ÓÉÓÚ `ApplicationContext` ÊÇÒ»¸ö `ResourceLoader`£¬¸Ã bean »¹¿ÉÒÔʵÏÖ `ApplicationContextAware` ½Ó¿Ú²¢Ö±½ÓʹÓÃÌṩµÄÓ¦ÓóÌÐòÉÏÏÂÎÄÀ´¼ÓÔØ×ÊÔ´¡£ µ«ÊÇ£¬Ò»°ãÀ´Ëµ£¬Èç¹ûÄúÖ»ÐèÒªÕâЩ£¬×îºÃʹÓÃרÃÅµÄ `ResourceLoader` ½Ó¿Ú¡£ ¸Ã´úÂ뽫½öñîºÏµ½×ÊÔ´¼ÓÔØ½Ó¿Ú£¨¿ÉÒÔ±»ÊÓΪʵÓóÌÐò½Ó¿Ú£©£¬¶ø²»ñîºÏµ½Õû¸ö Spring `ApplicationContext` ½Ó¿Ú¡£ +由于 `ApplicationContext` 是一个 `ResourceLoader`,该 bean 还å�¯ä»¥å®žçް `ApplicationContextAware` 接å�£å¹¶ç›´æŽ¥ä½¿ç”¨æ��供的应用程åº�上下文æ�¥åŠ è½½èµ„æº�。 但是,一般æ�¥è¯´ï¼Œå¦‚果您å�ªéœ€è¦�这些,最好使用专门的 `ResourceLoader` 接å�£ã€‚ 该代ç �将仅耦å�ˆåˆ°èµ„æº�加载接å�£ï¼ˆå�¯ä»¥è¢«è§†ä¸ºå®žç”¨ç¨‹åº�接å�£ï¼‰ï¼Œè€Œä¸�耦å�ˆåˆ°æ•´ä¸ª Spring `ApplicationContext` 接å�£ã€‚ -ÔÚÓ¦ÓóÌÐòÖУ¬»¹¿ÉÒÔʹÓà `ResourceLoader` µÄ×Ô¶¯×°Åä×÷ΪʵÏÖ `ResourceLoaderAware` ½Ó¿ÚµÄÌæ´ú·½·¨¡£´«Í³µÄ¹¹Ô캯ÊýºÍ `byType` ×Ô¶¯×°ÅäģʽÄܹ»·Ö±ðΪ¹¹Ô캯Êý²ÎÊý»ò setter ·½·¨²ÎÊýÌṩ `ResourceLoader`¡£ ΪÁË»ñµÃ¸ü´óµÄÁé»îÐÔ£¨°üÀ¨×Ô¶¯×°Åä×ֶκͶà²ÎÊý·½·¨µÄÄÜÁ¦£©£¬Ç뿼ÂÇʹÓûùÓÚ×¢½âµÄ×Ô¶¯×°Å书ÄÜ¡£ ÔÚÕâÖÖÇé¿öÏ£¬`ResourceLoader` »á×Ô¶¯Á¬½Óµ½ÐèÒª `ResourceLoader` ÀàÐ͵Ä×ֶΡ¢¹¹Ô캯Êý²ÎÊý»ò·½·¨²ÎÊýÖУ¬Ö»ÒªÏà¹Ø×ֶΡ¢¹¹Ô캯Êý»ò·½·¨´øÓÐ `@Autowired` ×¢½â¼´¿É¡£ +在应用程åº�中,还å�¯ä»¥ä½¿ç”¨ `ResourceLoader` 的自动装é…�作为实现 `ResourceLoaderAware` 接å�£çš„æ›¿ä»£æ–¹æ³•。传统的构造函数和 `byType` 自动装é…�模å¼�能够分别为构造函数å�‚数或 setter 方法å�‚æ•°æ��ä¾› `ResourceLoader`。 为了获得更大的ç�µæ´»æ€§ï¼ˆåŒ…括自动装é…�字段和多å�‚数方法的能力),请考虑使用基于注解的自动装é…�功能。 在这ç§�情况下,`ResourceLoader` 会自动连接到需è¦� `ResourceLoader` 类型的字段ã€�构造函数å�‚数或方法å�‚数中,å�ªè¦�相关字段ã€�构造函数或方法带有 `@Autowired` 注解å�³å�¯ã€‚ -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E8%B5%84%E6%BA%90%E4%BE%9D%E8%B5%96)×ÊÔ´ÒÀÀµ +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E8%B5%84%E6%BA%90%E4%BE%9D%E8%B5%96)资æº�ä¾�èµ– -Èç¹û bean ±¾ÉíҪͨ¹ýijÖÖ¶¯Ì¬¹ý³ÌÀ´È·¶¨ºÍÌṩ×ÊԴ·¾¶£¬ÄÇô bean ¿ÉÒÔʹÓà `ResourceLoader` »ò `ResourcePatternResolver` ½Ó¿ÚÀ´¼ÓÔØ×ÊÔ´¡£ ÀýÈ磬¿¼ÂǼÓÔØÄ³ÖÖÄ£°å£¬ÆäÖÐËùÐèµÄÌØ¶¨×ÊÔ´È¡¾öÓÚÓû§µÄ½ÇÉ«¡£ Èç¹û×ÊÔ´ÊǾ²Ì¬µÄ£¬ÍêÈ«Ïû³ý `ResourceLoader` ½Ó¿Ú£¨»ò `ResourcePatternResolver` ½Ó¿Ú£©µÄʹÓã¬Èà bean ¹«¿ªËüÐèÒªµÄ `Resource` ÊôÐÔ£¬²¢ÆÚÍû½«ËüÃÇ×¢ÈëÆäÖÐÊÇÓÐÒâÒåµÄ¡£ +如果 bean 本身è¦�通过æŸ�ç§�动æ€�过程æ�¥ç¡®å®šå’Œæ��供资æº�路径,那么 bean å�¯ä»¥ä½¿ç”¨ `ResourceLoader` 或 `ResourcePatternResolver` 接å�£æ�¥åŠ è½½èµ„æº�。 例如,考虑加载æŸ�ç§�模æ�¿ï¼Œå…¶ä¸­æ‰€éœ€çš„特定资æº�å�–决于用户的角色。 如果资æº�是é�™æ€�的,完全消除 `ResourceLoader` 接å�£ï¼ˆæˆ– `ResourcePatternResolver` 接å�£ï¼‰çš„使用,让 bean 公开它需è¦�çš„ `Resource` 属性,并期望将它们注入其中是有æ„�义的。 -ʹעÈëÕâЩÊôÐÔ±äµÃ¼òµ¥µÄÔ­ÒòÊÇËùÓÐÓ¦ÓóÌÐòÉÏÏÂÎͼע²á²¢Ê¹ÓÃÒ»¸öÌØÊâµÄ JavaBeans `PropertyEditor`£¬Ëü¿ÉÒÔ½« `String` ·¾¶×ª»»Îª `Resource` ¶ÔÏó¡£ ÀýÈ磬ÏÂÃæµÄ MyBean ÀàÓÐÒ»¸ö `Resource` ÀàÐ͵ÄÄ£°åÊôÐÔ¡£ +使注入这些属性å�˜å¾—简å�•的原因是所有应用程åº�上下文都注册并使用一个特殊的 JavaBeans `PropertyEditor`,它å�¯ä»¥å°† `String` 路径转æ�¢ä¸º `Resource` 对象。 例如,下é�¢çš„ MyBean 类有一个 `Resource` 类型的模æ�¿å±žæ€§ã€‚ -¡¾Ê¾Àý¡¿ +ã€�示例】 @@ -189,9 +189,9 @@ public interface ResourceLoaderAware { -Çë×¢Ò⣬ÅäÖÃÖÐÒýÓõÄÄ£°å×ÊԴ·¾¶Ã»ÓÐǰ׺£¬ÒòΪӦÓóÌÐòÉÏÏÂÎı¾Éí½«ÓÃ×÷ `ResourceLoader`£¬×ÊÔ´±¾Éí½«¸ù¾ÝÐèҪͨ¹ý `ClassPathResource`£¬`FileSystemResource` »ò ServletContextResource ¼ÓÔØ£¬¾ßÌåÈ¡¾öÓÚÉÏÏÂÎĵÄÈ·ÇÐÀàÐÍ¡£ +请注æ„�,é…�置中引用的模æ�¿èµ„æº�路径没有å‰�缀,因为应用程åº�上下文本身将用作 `ResourceLoader`,资æº�本身将根æ�®éœ€è¦�通过 `ClassPathResource`,`FileSystemResource` 或 ServletContextResource 加载,具体å�–决于上下文的确切类型。 -Èç¹ûÐèÒªÇ¿ÖÆÊ¹ÓÃÌØ¶¨µÄ×ÊÔ´ÀàÐÍ£¬Ôò¿ÉÒÔʹÓÃǰ׺¡£ ÒÔÏÂÁ½¸öʾÀýÏÔʾÈçºÎÇ¿ÖÆÊ¹Óà `ClassPathResource` ºÍ `UrlResource`£¨ºóÕßÓÃÓÚ·ÃÎÊÎļþϵͳÎļþ£©¡£ +如果需è¦�强制使用特定的资æº�类型,则å�¯ä»¥ä½¿ç”¨å‰�缀。 以下两个示例显示如何强制使用 `ClassPathResource` å’Œ `UrlResource`(å�Žè€…用于访问文件系统文件)。 @@ -203,7 +203,7 @@ public interface ResourceLoaderAware { -¿ÉÒÔͨ¹ý `@Value` ×¢½â¼ÓÔØ×ÊÔ´Îļþ `myTemplate.txt`£¬Ê¾ÀýÈçÏ£º +å�¯ä»¥é€šè¿‡ `@Value` 注解加载资æº�文件 `myTemplate.txt`,示例如下: @@ -224,9 +224,9 @@ public class MyBean { -Spring µÄ `PropertyEditor` »á¸ù¾Ý×ÊÔ´ÎļþµÄ·¾¶×Ö·û´®£¬¼ÓÔØ `Resource` ¶ÔÏ󣬲¢½«Æä×¢Èëµ½ MyBean µÄ¹¹Ôì·½·¨¡£ +Spring çš„ `PropertyEditor` 会根æ�®èµ„æº�文件的路径字符串,加载 `Resource` 对象,并将其注入到 MyBean 的构造方法。 -Èç¹ûÏëÒª¼ÓÔØ¶à¸ö×ÊÔ´Îļþ£¬¿ÉÒÔʹÓà `classpath*:` ǰ׺£¬ÀýÈ磺`classpath*:/config/templates/*.txt`¡£ +如果想è¦�加载多个资æº�文件,å�¯ä»¥ä½¿ç”¨ `classpath*:` å‰�缀,例如:`classpath*:/config/templates/*.txt`。 @@ -247,13 +247,13 @@ public class MyBean { -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E5%BA%94%E7%94%A8%E4%B8%8A%E4%B8%8B%E6%96%87%E5%92%8C%E8%B5%84%E6%BA%90%E8%B7%AF%E5%BE%84)Ó¦ÓÃÉÏÏÂÎĺÍ×ÊԴ·¾¶ +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E5%BA%94%E7%94%A8%E4%B8%8A%E4%B8%8B%E6%96%87%E5%92%8C%E8%B5%84%E6%BA%90%E8%B7%AF%E5%BE%84)应用上下文和资æº�路径 -### [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E6%9E%84%E9%80%A0%E5%BA%94%E7%94%A8%E4%B8%8A%E4%B8%8B%E6%96%87)¹¹ÔìÓ¦ÓÃÉÏÏÂÎÄ +### [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E6%9E%84%E9%80%A0%E5%BA%94%E7%94%A8%E4%B8%8A%E4%B8%8B%E6%96%87)构造应用上下文 -Ó¦ÓÃÉÏÏÂÎĹ¹Ô캯Êý£¨Õë¶ÔÌØ¶¨µÄÓ¦ÓÃÉÏÏÂÎÄÀàÐÍ£©Í¨³£½«×Ö·û´®»ò×Ö·û´®Êý×é×÷Ϊ×ÊÔ´µÄλÖ÷¾¶£¬ÀýÈç¹¹³ÉÉÏÏÂÎ͍ÒåµÄ XML Îļþ¡£ +应用上下文构造函数(针对特定的应用上下文类型)通常将字符串或字符串数组作为资æº�çš„ä½�置路径,例如构æˆ�上下文定义的 XML 文件。 -¡¾Ê¾Àý¡¿ +ã€�示例】 @@ -268,11 +268,11 @@ ApplicationContext ctx = new ClassPathXmlApplicationContext( -### [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E4%BD%BF%E7%94%A8%E9%80%9A%E9%85%8D%E7%AC%A6%E6%9E%84%E9%80%A0%E5%BA%94%E7%94%A8%E4%B8%8A%E4%B8%8B%E6%96%87)ʹÓÃͨÅä·û¹¹ÔìÓ¦ÓÃÉÏÏÂÎÄ +### [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E4%BD%BF%E7%94%A8%E9%80%9A%E9%85%8D%E7%AC%A6%E6%9E%84%E9%80%A0%E5%BA%94%E7%94%A8%E4%B8%8A%E4%B8%8B%E6%96%87)使用通é…�符构造应用上下文 -ApplicationContext ¹¹ÔìÆ÷µÄÖеÄ×ÊԴ·¾¶¿ÉÒÔÊǵ¥Ò»µÄ·¾¶£¨¼´Ò»¶ÔÒ»µØÓ³É䵽Ŀ±ê×ÊÔ´£©£»Ò²¿ÉÒÔÊÇͨÅä·ûÐÎʽ¡ª¡ª¿É°üº¬ classpath*£ºÒ²¿ÉÒÔÊÇǰ׺»ò ant ·ç¸ñµÄÕýÔò±í´ïʽ£¨Ê¹Óà spring µÄ PathMatcher À´Æ¥Å䣩¡£ +ApplicationContext 构造器的中的资æº�路径å�¯ä»¥æ˜¯å�•一的路径(å�³ä¸€å¯¹ä¸€åœ°æ˜ å°„到目标资æº�);也å�¯ä»¥æ˜¯é€šé…�符形å¼�——å�¯åŒ…å�« classpath*:也å�¯ä»¥æ˜¯å‰�缀或 ant 风格的正则表达å¼�(使用 spring çš„ PathMatcher æ�¥åŒ¹é…�)。 -ʾÀý£º +示例: @@ -283,24 +283,24 @@ ApplicationContext ctx = new ClassPathXmlApplicationContext("classpath*:conf/app -ʹÓà `classpath*` ±íʾÀà·¾¶ÏÂËùÓÐÆ¥ÅäÎļþÃû³ÆµÄ×ÊÔ´¶¼»á±»»ñÈ¡(±¾ÖÊÉϾÍÊǵ÷ÓÃÁË ClassLoader.getResources(¡­) ·½·¨£©£¬½Ó׎«»ñÈ¡µ½µÄ×ÊÔ´×é×°³É×îÖÕµÄÓ¦ÓÃÉÏÏÂÎÄ¡£ +使用 `classpath*` 表示类路径下所有匹é…�文件å��称的资æº�都会被获å�–(本质上就是调用了 ClassLoader.getResources(…) 方法),接ç�€å°†èŽ·å�–到的资æº�组装æˆ�最终的应用上下文。 -ÔÚλÖ÷¾¶µÄÆäÓಿ·Ö£¬`classpath*:` ǰ׺¿ÉÒÔÓë PathMatcher ½áºÏʹÓã¬È磺`classpath*:META-INF/*-beans.xml`¡£ +在ä½�置路径的其余部分,`classpath*:` å‰�ç¼€å�¯ä»¥ä¸Ž PathMatcher 结å�ˆä½¿ç”¨ï¼Œå¦‚:`classpath*:META-INF/*-beans.xml`。 -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E9%97%AE%E9%A2%98)ÎÊÌâ +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E9%97%AE%E9%A2%98)问题 -Spring ÅäÖÃ×ÊÔ´ÖÐÓÐÄÄЩ³£¼ûÀàÐÍ£¿ +Spring é…�置资æº�中有哪些常è§�类型? -* XML ×ÊÔ´ -* Properties ×ÊÔ´ -* YAML ×ÊÔ´ +* XML 资æº� +* Properties 资æº� +* YAML 资æº� -## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99)²Î¿¼×ÊÁÏ +## [#](https://dunwu.github.io/spring-tutorial/pages/a1549f/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99)å�‚考资料 -* [Spring ¹Ù·½ÎĵµÖ® Core Technologies(opens new window)](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) -* [¡¶Ð¡Âí¸ç½² Spring ºËÐıà³Ì˼Ïë¡·](https://time.geekbang.org/course/intro/265) +* [Spring 官方文档之 Core Technologies(opens new window)](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) +* [《å°�马哥讲 Spring 核心编程æ€�想》](https://time.geekbang.org/course/intro/265) -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\351\205\215\347\275\256\345\205\203\346\225\260\346\215\256\357\274\210\347\256\241\347\220\206\351\205\215\347\275\256\347\232\204\345\237\272\346\234\254\346\225\260\346\215\256\357\274\211.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\351\205\215\347\275\256\345\205\203\346\225\260\346\215\256\357\274\210\347\256\241\347\220\206\351\205\215\347\275\256\347\232\204\345\237\272\346\234\254\346\225\260\346\215\256\357\274\211.md" index 4515cad..53fec9e 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\351\205\215\347\275\256\345\205\203\346\225\260\346\215\256\357\274\210\347\256\241\347\220\206\351\205\215\347\275\256\347\232\204\345\237\272\346\234\254\346\225\260\346\215\256\357\274\211.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\270\255\347\232\204\351\205\215\347\275\256\345\205\203\346\225\260\346\215\256\357\274\210\347\256\241\347\220\206\351\205\215\347\275\256\347\232\204\345\237\272\346\234\254\346\225\260\346\215\256\357\274\211.md" @@ -1,185 +1,185 @@ -# Spring ÅäÖÃÔªÊý¾Ý +# Spring é…�置元数æ�® -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)Spring ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)Spring é…�置元信æ�¯ -* Spring Bean ÅäÖÃÔªÐÅÏ¢ - BeanDefinition -* Spring Bean ÊôÐÔÔªÐÅÏ¢ - PropertyValues -* Spring ÈÝÆ÷ÅäÖÃÔªÐÅÏ¢ -* Spring Íⲿ»¯ÅäÖÃÔªÐÅÏ¢ - PropertySource -* Spring Profile ÔªÐÅÏ¢ - @Profile +* Spring Bean é…�置元信æ�¯ - BeanDefinition +* Spring Bean 属性元信æ�¯ - PropertyValues +* Spring 容器é…�置元信æ�¯ +* Spring 外部化é…�置元信æ�¯ - PropertySource +* Spring Profile 元信æ�¯ - @Profile -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)Spring Bean ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)Spring Bean é…�置元信æ�¯ -Bean ÅäÖÃÔªÐÅÏ¢ - BeanDefinition +Bean é…�置元信æ�¯ - BeanDefinition -* GenericBeanDefinition£ºÍ¨ÓÃÐÍ BeanDefinition -* RootBeanDefinition£ºÎÞ Parent µÄ BeanDefinition »òÕߺϲ¢ºó BeanDefinition -* AnnotatedBeanDefinition£º×¢½â±ê×¢µÄ BeanDefinition +* GenericBeanDefinition:通用型 BeanDefinition +* RootBeanDefinition:无 Parent çš„ BeanDefinition 或者å�ˆå¹¶å�Ž BeanDefinition +* AnnotatedBeanDefinition:注解标注的 BeanDefinition -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-bean-%E5%B1%9E%E6%80%A7%E5%85%83%E4%BF%A1%E6%81%AF)Spring Bean ÊôÐÔÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-bean-%E5%B1%9E%E6%80%A7%E5%85%83%E4%BF%A1%E6%81%AF)Spring Bean 属性元信æ�¯ -* Bean ÊôÐÔÔªÐÅÏ¢ - PropertyValues - * ¿ÉÐÞ¸ÄʵÏÖ - MutablePropertyValues - * ÔªËØ³ÉÔ± - PropertyValue -* Bean ÊôÐÔÉÏÏÂÎÄ´æ´¢ - AttributeAccessor -* Bean ÔªÐÅÏ¢ÔªËØ - BeanMetadataElement +* Bean 属性元信æ�¯ - PropertyValues + * å�¯ä¿®æ”¹å®žçް - MutablePropertyValues + * 元素æˆ�员 - PropertyValue +* Bean 属性上下文存储 - AttributeAccessor +* Bean 元信æ�¯å…ƒç´  - BeanMetadataElement -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-%E5%AE%B9%E5%99%A8%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)Spring ÈÝÆ÷ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-%E5%AE%B9%E5%99%A8%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)Spring 容器é…�置元信æ�¯ -Spring XML ÅäÖÃÔªÐÅÏ¢ - beans ÔªËØÏà¹Ø +Spring XML é…�置元信æ�¯ - beans 元素相关 -| beans ÔªËØÊôÐÔ | ĬÈÏÖµ | ʹÓó¡¾° | +| beans 元素属性 | 默认值 | 使用场景 | | --- | --- | --- | -| profile | null£¨Áô¿Õ£© | Spring Profiles ÅäÖÃÖµ | -| default-lazy-init | default | µ± outter beans ¡°default-lazy-init¡± ÊôÐÔ´æÔÚʱ£¬¼Ì³Ð¸ÃÖµ£¬·ñÔòΪ¡°false¡± | -| default-merge | default | µ± outter beans ¡°default-merge¡± ÊôÐÔ´æÔÚʱ£¬¼Ì³Ð¸ÃÖµ£¬·ñÔòΪ¡°false¡± | -| default-autowire | default | µ± outter beans ¡°default-autowire¡± ÊôÐÔ´æÔÚʱ£¬¼Ì³Ð¸ÃÖµ£¬·ñÔòΪ¡°no¡± | -| default-autowire-candidates | null£¨Áô¿Õ£© | ĬÈÏ Spring Beans Ãû³Æ pattern | -| default-init-method | null£¨Áô¿Õ£© | ĬÈÏ Spring Beans ×Ô¶¨Òå³õʼ»¯·½·¨ | -| default-destroy-method | null£¨Áô¿Õ£© | ĬÈÏ Spring Beans ×Ô¶¨ÒåÏú»Ù·½·¨ | +| profile | null(留空) | Spring Profiles é…�置值 | +| default-lazy-init | default | 当 outter beans “default-lazy-initâ€� 属性存在时,继承该值,å�¦åˆ™ä¸ºâ€œfalseâ€� | +| default-merge | default | 当 outter beans “default-mergeâ€� 属性存在时,继承该值,å�¦åˆ™ä¸ºâ€œfalseâ€� | +| default-autowire | default | 当 outter beans “default-autowireâ€� 属性存在时,继承该值,å�¦åˆ™ä¸ºâ€œnoâ€� | +| default-autowire-candidates | null(留空) | 默认 Spring Beans å��ç§° pattern | +| default-init-method | null(留空) | 默认 Spring Beans 自定义åˆ�始化方法 | +| default-destroy-method | null(留空) | 默认 Spring Beans 自定义销æ¯�方法 | -Spring XML ÅäÖÃÔªÐÅÏ¢ - Ó¦ÓÃÉÏÏÂÎÄÏà¹Ø +Spring XML é…�置元信æ�¯ - 应用上下文相关 -| XML ÔªËØ | ʹÓó¡¾° | +| XML 元素 | 使用场景 | | --- | --- | -| `` | ¼¤»î Spring ×¢½âÇý¶¯ | -| `` | Spring @Component ÒÔ¼°×Ô¶¨Òå×¢½âɨÃè | -| `` | ¼¤»î Spring LoadTimeWeaver | -| `` | ±©Â¶ Spring Beans ×÷Ϊ JMX Beans | -| `` | ½«µ±Ç°Æ½Ì¨×÷Ϊ MBeanServer | -| `` | ¼ÓÔØÍⲿ»¯ÅäÖÃ×ÊÔ´×÷Ϊ Spring ÊôÐÔÅä | -| `` | ÀûÓÃÍⲿ»¯ÅäÖÃ×ÊÔ´¸²¸Ç Spring Êô | +| `` | 激活 Spring 注解驱动 | +| `` | Spring @Component 以å�Šè‡ªå®šä¹‰æ³¨è§£æ‰«æ�� | +| `` | 激活 Spring LoadTimeWeaver | +| `` | 暴露 Spring Beans 作为 JMX Beans | +| `` | 将当å‰�å¹³å�°ä½œä¸º MBeanServer | +| `` | 加载外部化é…�置资æº�作为 Spring 属性é…� | +| `` | 利用外部化é…�置资æº�覆盖 Spring 属 | -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-xml-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD-spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)»ùÓÚ XML Îļþ×°ÔØ Spring Bean ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-xml-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD-spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)基于 XML 文件装载 Spring Bean é…�置元信æ�¯ -µ×²ãʵÏÖ - XmlBeanDefinitionReader +底层实现 - XmlBeanDefinitionReader -| XML ÔªËØ | ʹÓó¡¾° | +| XML 元素 | 使用场景 | | --- | --- | -| `` | µ¥ XML ×ÊԴϵĶà¸ö Spring Beans ÅäÖà | -| `` | µ¥¸ö Spring Bean ¶¨Ò壨BeanDefinition£©ÅäÖà | -| `` | Ϊ Spring Bean ¶¨Ò壨BeanDefinition£©Ó³Éä±ðÃû | -| `` | ¼ÓÔØÍⲿ Spring XML ÅäÖÃ×ÊÔ´ | +| `` | å�• XML 资æº�下的多个 Spring Beans é…�ç½® | +| `` | å�•个 Spring Bean 定义(BeanDefinition)é…�ç½® | +| `` | 为 Spring Bean 定义(BeanDefinition)映射别å�� | +| `` | 加载外部 Spring XML é…�置资æº� | -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-properties-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD-spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)»ùÓÚ Properties Îļþ×°ÔØ Spring Bean ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-properties-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD-spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)基于 Properties 文件装载 Spring Bean é…�置元信æ�¯ -µ×²ãʵÏÖ - PropertiesBeanDefinitionReader +底层实现 - PropertiesBeanDefinitionReader -| Properties ÊôÐÔÃû | ʹÓó¡¾° | +| Properties 属性å�� | 使用场景 | | --- | --- | -| `class` | Bean ÀàÈ«³ÆÏÞ¶¨Ãû | -| `abstract` | ÊÇ·ñΪ³éÏóµÄ BeanDefinition | -| `parent` | Ö¸¶¨ parent BeanDefinition Ãû³Æ | -| `lazy-init` | ÊÇ·ñΪÑÓ³Ù³õʼ»¯ | -| `ref` | ÒýÓÃÆäËû Bean µÄÃû³Æ | -| `scope` | ÉèÖà Bean µÄ scope ÊôÐÔ | -| ${n} | n ±íʾµÚ n+1 ¸ö¹¹ÔìÆ÷²ÎÊý | +| `class` | Bean 类全称é™�定å�� | +| `abstract` | 是å�¦ä¸ºæŠ½è±¡çš„ BeanDefinition | +| `parent` | 指定 parent BeanDefinition å��ç§° | +| `lazy-init` | 是å�¦ä¸ºå»¶è¿Ÿåˆ�始化 | +| `ref` | 引用其他 Bean çš„å��ç§° | +| `scope` | 设置 Bean çš„ scope 属性 | +| ${n} | n 表示第 n+1 个构造器å�‚æ•° | -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-java-%E6%B3%A8%E8%A7%A3%E8%A3%85%E8%BD%BD-spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)»ùÓÚ Java ×¢½â×°ÔØ Spring Bean ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-java-%E6%B3%A8%E8%A7%A3%E8%A3%85%E8%BD%BD-spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)基于 Java 注解装载 Spring Bean é…�置元信æ�¯ -Spring ģʽע½â +Spring 模å¼�注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| `@Repository` | Êý¾Ý²Ö´¢Ä£Ê½×¢½â | 2.0 | -| `@Component` | ͨÓÃ×é¼þģʽע½â | 2.5 | -| `@Service` | ·þÎñģʽע½â | 2.5 | -| `@Controller` | Web ¿ØÖÆÆ÷ģʽע½â | 2.5 | -| `@Configuration` | ÅäÖÃÀàģʽע½â | 3.0 | +| `@Repository` | æ•°æ�®ä»“储模å¼�注解 | 2.0 | +| `@Component` | 通用组件模å¼�注解 | 2.5 | +| `@Service` | æœ�务模å¼�注解 | 2.5 | +| `@Controller` | Web 控制器模å¼�注解 | 2.5 | +| `@Configuration` | é…�置类模å¼�注解 | 3.0 | -Spring Bean ¶¨Òå×¢½â +Spring Bean 定义注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| `@Bean` | Ìæ»» XML ÔªËØ `` | 3.0 | -| `@DependsOn` | Ìæ´ú XML ÊôÐÔ `` | 3.0 | -| `@Lazy` | Ìæ´ú XML ÊôÐÔ `` | 3.0 | -| `@Primary` | Ìæ»» XML ÔªËØ `` | 3.0 | -| `@Role` | Ìæ»» XML ÔªËØ `` | 3.1 | -| `@Lookup` | Ìæ´ú XML ÊôÐÔ `` | 4.1 | +| `@Bean` | 替æ�¢ XML 元素 `` | 3.0 | +| `@DependsOn` | 替代 XML 属性 `` | 3.0 | +| `@Lazy` | 替代 XML 属性 `` | 3.0 | +| `@Primary` | 替æ�¢ XML 元素 `` | 3.0 | +| `@Role` | 替æ�¢ XML 元素 `` | 3.1 | +| `@Lookup` | 替代 XML 属性 `` | 4.1 | -Spring Bean ÒÀÀµ×¢Èë×¢½â +Spring Bean ä¾�赖注入注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| `@Autowired` | Bean ÒÀÀµ×¢È룬֧³Ö¶àÖÖÒÀÀµ²éÕÒ·½Ê½ | 2.5 | -| `@Qualifier` | ϸÁ£¶ÈµÄ @Autowired ÒÀÀµ²éÕÒ | 2.5 | +| `@Autowired` | Bean ä¾�赖注入,支æŒ�多ç§�ä¾�赖查找方å¼� | 2.5 | +| `@Qualifier` | 细粒度的 @Autowired ä¾�赖查找 | 2.5 | -| Java ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Java 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| @Resource | ÀàËÆÓÚ @Autowired | 2.5 | -| @Inject | ÀàËÆÓÚ @Autowired | 2.5 | +| @Resource | 类似于 @Autowired | 2.5 | +| @Inject | 类似于 @Autowired | 2.5 | -Spring Bean Ìõ¼þ×°Åä×¢½â +Spring Bean æ�¡ä»¶è£…é…�注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| @Profile | ÅäÖû¯Ìõ¼þ×°Åä | 3.1 | -| @Conditional | ±à³ÌÌõ¼þ×°Åä | 4.0 | +| @Profile | é…�置化æ�¡ä»¶è£…é…� | 3.1 | +| @Conditional | 编程æ�¡ä»¶è£…é…� | 4.0 | -Spring Bean ÉúÃüÖÜÆÚ»Øµ÷×¢½â +Spring Bean 生命周期回调注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| @PostConstruct | Ìæ»» XML ÔªËØ »ò InitializingBean | 2.5 | -| @PreDestroy | Ìæ»» XML ÔªËØ »ò DisposableBean | 2.5 | +| @PostConstruct | 替æ�¢ XML 元素 或 InitializingBean | 2.5 | +| @PreDestroy | 替æ�¢ XML 元素 或 DisposableBean | 2.5 | -Spring BeanDefinition ½âÎöÓë×¢²á +Spring BeanDefinition è§£æž�与注册 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| XML ×ÊÔ´ | XmlBeanDefinitionReader | 1.0 | -| Properties ×ÊÔ´ | PropertiesBeanDefinitionReader | 1.0 | -| Java ×¢½â | AnnotatedBeanDefinitionReader | 3.0 | +| XML 资æº� | XmlBeanDefinitionReader | 1.0 | +| Properties 资æº� | PropertiesBeanDefinitionReader | 1.0 | +| Java 注解 | AnnotatedBeanDefinitionReader | 3.0 | -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF%E5%BA%95%E5%B1%82%E5%AE%9E%E7%8E%B0)Spring Bean ÅäÖÃÔªÐÅÏ¢µ×²ãʵÏÖ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-bean-%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF%E5%BA%95%E5%B1%82%E5%AE%9E%E7%8E%B0)Spring Bean é…�置元信æ�¯åº•层实现 -### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-xml-%E8%B5%84%E6%BA%90-beandefinition-%E8%A7%A3%E6%9E%90%E4%B8%8E%E6%B3%A8%E5%86%8C)Spring XML ×ÊÔ´ BeanDefinition ½âÎöÓë×¢²á +### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-xml-%E8%B5%84%E6%BA%90-beandefinition-%E8%A7%A3%E6%9E%90%E4%B8%8E%E6%B3%A8%E5%86%8C)Spring XML 资æº� BeanDefinition è§£æž�与注册 -ºËÐÄ API - XmlBeanDefinitionReader +核心 API - XmlBeanDefinitionReader -* ×ÊÔ´ - Resource -* µ×²ã - BeanDefinitionDocumentReader - * XML ½âÎö - Java DOM Level 3 API - * BeanDefinition ½âÎö - BeanDefinitionParserDelegate - * BeanDefinition ×¢²á - BeanDefinitionRegistry +* 资æº� - Resource +* 底层 - BeanDefinitionDocumentReader + * XML è§£æž� - Java DOM Level 3 API + * BeanDefinition è§£æž� - BeanDefinitionParserDelegate + * BeanDefinition 注册 - BeanDefinitionRegistry -### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-properties-%E8%B5%84%E6%BA%90-beandefinition-%E8%A7%A3%E6%9E%90%E4%B8%8E%E6%B3%A8%E5%86%8C)Spring Properties ×ÊÔ´ BeanDefinition ½âÎöÓë×¢²á +### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-properties-%E8%B5%84%E6%BA%90-beandefinition-%E8%A7%A3%E6%9E%90%E4%B8%8E%E6%B3%A8%E5%86%8C)Spring Properties 资æº� BeanDefinition è§£æž�与注册 -ºËÐÄ API - PropertiesBeanDefinitionReader +核心 API - PropertiesBeanDefinitionReader -* ×ÊÔ´ - * ×Ö½ÚÁ÷ - Resource - * ×Ö·ûÁ÷ - EncodedResouce -* µ×²ã - * ´æ´¢ - java.util.Properties - * BeanDefinition ½âÎö - API ÄÚ²¿ÊµÏÖ - * BeanDefinition ×¢²á - BeanDefinitionRegistry +* 资æº� + * 字节æµ� - Resource + * 字符æµ� - EncodedResouce +* 底层 + * 存储 - java.util.Properties + * BeanDefinition è§£æž� - API 内部实现 + * BeanDefinition 注册 - BeanDefinitionRegistry -### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-java-%E6%B3%A8%E5%86%8C-beandefinition-%E8%A7%A3%E6%9E%90%E4%B8%8E%E6%B3%A8%E5%86%8C)Spring Java ×¢²á BeanDefinition ½âÎöÓë×¢²á +### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#spring-java-%E6%B3%A8%E5%86%8C-beandefinition-%E8%A7%A3%E6%9E%90%E4%B8%8E%E6%B3%A8%E5%86%8C)Spring Java 注册 BeanDefinition è§£æž�与注册 -ºËÐÄ API - AnnotatedBeanDefinitionReader +核心 API - AnnotatedBeanDefinitionReader -* ×ÊÔ´ - * Àà¶ÔÏó - java.lang.Class -* µ×²ã - * Ìõ¼þÆÀ¹À - ConditionEvaluator - * Bean ·¶Î§½âÎö - ScopeMetadataResolver - * BeanDefinition ½âÎö - ÄÚ²¿ API ʵÏÖ - * BeanDefinition ´¦Àí - AnnotationConfigUtils.processCommonDefinitionAnnotations - * BeanDefinition ×¢²á - BeanDefinitionRegistry +* 资æº� + * 类对象 - java.lang.Class +* 底层 + * æ�¡ä»¶è¯„ä¼° - ConditionEvaluator + * Bean 范围解æž� - ScopeMetadataResolver + * BeanDefinition è§£æž� - 内部 API 实现 + * BeanDefinition 处ç�† - AnnotationConfigUtils.processCommonDefinitionAnnotations + * BeanDefinition 注册 - BeanDefinitionRegistry -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-xml-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD-spring-ioc-%E5%AE%B9%E5%99%A8%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)»ùÓÚ XML Îļþ×°ÔØ Spring IoC ÈÝÆ÷ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-xml-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD-spring-ioc-%E5%AE%B9%E5%99%A8%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)基于 XML 文件装载 Spring IoC 容器é…�置元信æ�¯ -Spring IoC ÈÝÆ÷Ïà¹Ø XML ÅäÖà +Spring IoC 容器相关 XML é…�ç½® -| ÃüÃû¿Õ¼ä | ËùÊôÄ£¿é | Schema ×ÊÔ´ URL | +| 命å��空间 | 所属模å�— | Schema 资æº� URL | | --- | --- | --- | | beans | spring-beans | https://www.springframework.org/schema/beans/spring-beans.xsd | | context | spring-context | https://www.springframework.org/schema/context/spring-context.xsd | @@ -188,35 +188,35 @@ Spring IoC | util | spring-beans | beans https://www.springframework.org/schema/util/spring-util.xsd | | tool | spring-beans | https://www.springframework.org/schema/tool/spring-tool.xsd | -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-java-%E6%B3%A8%E8%A7%A3%E8%A3%85%E8%BD%BD-spring-ioc-%E5%AE%B9%E5%99%A8%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)»ùÓÚ Java ×¢½â×°ÔØ Spring IoC ÈÝÆ÷ÅäÖÃÔªÐÅÏ¢ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-java-%E6%B3%A8%E8%A7%A3%E8%A3%85%E8%BD%BD-spring-ioc-%E5%AE%B9%E5%99%A8%E9%85%8D%E7%BD%AE%E5%85%83%E4%BF%A1%E6%81%AF)基于 Java 注解装载 Spring IoC 容器é…�置元信æ�¯ -Spring IoC ÈÝÆ÷×°Åä×¢½â +Spring IoC 容器装é…�注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| @ImportResource | Ìæ»» XML ÔªËØ `` | 3.0 | -| @Import | µ¼Èë Configuration Class | 3.0 | -| @ComponentScan | ɨÃèÖ¸¶¨ package ϱê×¢ Spring ģʽע½âµÄÀà | 3.1 | +| @ImportResource | 替æ�¢ XML 元素 `` | 3.0 | +| @Import | 导入 Configuration Class | 3.0 | +| @ComponentScan | 扫æ��指定 package 下标注 Spring 模å¼�注解的类 | 3.1 | -Spring IoC ÅäÊôÊôÐÔ×¢½â +Spring IoC é…�属属性注解 -| Spring ×¢½â | ³¡¾°ËµÃ÷ | Æðʼ°æ±¾ | +| Spring 注解 | 场景说明 | 起始版本 | | --- | --- | --- | -| @PropertySource | ÅäÖÃÊôÐÔ³éÏó PropertySource ×¢½â | 3.1 | -| @PropertySources | @PropertySource ¼¯ºÏ×¢½â | 4.0 | +| @PropertySource | é…�置属性抽象 PropertySource 注解 | 3.1 | +| @PropertySources | @PropertySource 集å�ˆæ³¨è§£ | 4.0 | -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-extensible-xml-authoring-%E6%89%A9%E5%B1%95-springxml-%E5%85%83%E7%B4%A0)»ùÓÚ Extensible XML authoring À©Õ¹ SpringXML ÔªËØ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-extensible-xml-authoring-%E6%89%A9%E5%B1%95-springxml-%E5%85%83%E7%B4%A0)基于 Extensible XML authoring 扩展 SpringXML 元素 -Spring XML À©Õ¹ +Spring XML 扩展 -* ±àд XML Schema Îļþ£º¶¨Òå XML ½á¹¹ -* ×Ô¶¨Òå NamespaceHandler ʵÏÖ£ºÃüÃû¿Õ¼ä°ó¶¨ -* ×Ô¶¨Òå BeanDefinitionParser ʵÏÖ£ºXML ÔªËØÓë BeanDefinition ½âÎö -* ×¢²á XML À©Õ¹£ºÃüÃû¿Õ¼äÓë XML Schema Ó³Éä +* 编写 XML Schema 文件:定义 XML 结构 +* 自定义 NamespaceHandler 实现:命å��空间绑定 +* 自定义 BeanDefinitionParser 实现:XML 元素与 BeanDefinition è§£æž� +* 注册 XML 扩展:命å��空间与 XML Schema 映射 -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#extensible-xml-authoring-%E6%89%A9%E5%B1%95%E5%8E%9F%E7%90%86)Extensible XML authoring À©Õ¹Ô­Àí +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#extensible-xml-authoring-%E6%89%A9%E5%B1%95%E5%8E%9F%E7%90%86)Extensible XML authoring 扩展原ç�† -### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E8%A7%A6%E5%8F%91%E6%97%B6%E6%9C%BA)´¥·¢Ê±»ú +### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E8%A7%A6%E5%8F%91%E6%97%B6%E6%9C%BA)触å�‘时机 * AbstractApplicationContext#obtainFreshBeanFactory * AbstractRefreshableApplicationContext#refreshBeanFactory @@ -226,40 +226,40 @@ Spring XML * ... * BeanDefinitionParserDelegate#parseCustomElement -### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E6%A0%B8%E5%BF%83%E6%B5%81%E7%A8%8B)ºËÐÄÁ÷³Ì +### [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E6%A0%B8%E5%BF%83%E6%B5%81%E7%A8%8B)核心æµ�程 BeanDefinitionParserDelegate#parseCustomElement(org.w3c.dom.Element, BeanDefinition) -* »ñÈ¡ namespace -* ͨ¹ý namespace ½âÎö NamespaceHandler -* ¹¹Ôì ParserContext -* ½âÎöÔªËØ£¬»ñÈ¡ BeanDefinintion +* 获å�– namespace +* 通过 namespace è§£æž� NamespaceHandler +* 构造 ParserContext +* è§£æž�元素,获å�– BeanDefinintion -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-properties-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD%E5%A4%96%E9%83%A8%E5%8C%96%E9%85%8D%E7%BD%AE)»ùÓÚ Properties Îļþ×°ÔØÍⲿ»¯ÅäÖà +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-properties-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD%E5%A4%96%E9%83%A8%E5%8C%96%E9%85%8D%E7%BD%AE)基于 Properties 文件装载外部化é…�ç½® -×¢½âÇý¶¯ +注解驱动 * @org.springframework.context.annotation.PropertySource * @org.springframework.context.annotation.PropertySources -API ±à³Ì +API 编程 * org.springframework.core.env.PropertySource * org.springframework.core.env.PropertySources -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-yaml-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD%E5%A4%96%E9%83%A8%E5%8C%96%E9%85%8D%E7%BD%AE)»ùÓÚ YAML Îļþ×°ÔØÍⲿ»¯ÅäÖà +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%9F%BA%E4%BA%8E-yaml-%E6%96%87%E4%BB%B6%E8%A3%85%E8%BD%BD%E5%A4%96%E9%83%A8%E5%8C%96%E9%85%8D%E7%BD%AE)基于 YAML 文件装载外部化é…�ç½® -API ±à³Ì +API 编程 * org.springframework.beans.factory.config.YamlProcessor * org.springframework.beans.factory.config.YamlMapFactoryBean * org.springframework.beans.factory.config.YamlPropertiesFactoryBean -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E9%97%AE%E9%A2%98)ÎÊÌâ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E9%97%AE%E9%A2%98)问题 -**Spring ƒÈ½¨ XML Schema ³£¼ûÓÐÄÄЩ**£¿ +**Spring 內建 XML Schema 常è§�有哪些**? -| ÃüÃû¿Õ¼ä | ËùÊôÄ£¿é | Schema ×ÊÔ´ URL | +| 命å��空间 | 所属模å�— | Schema 资æº� URL | | --- | --- | --- | | beans | spring-beans | https://www.springframework.org/schema/beans/spring-beans.xsd | | context | spring-context | https://www.springframework.org/schema/context/spring-context.xsd | @@ -268,28 +268,28 @@ API | util | spring-beans | beans https://www.springframework.org/schema/util/spring-util.xsd | | tool | spring-beans | https://www.springframework.org/schema/tool/spring-tool.xsd | -**Spring ÅäÖÃÔªÐÅÏ¢¾ßÌåÓÐÄÄЩ**£¿ +**Spring é…�置元信æ�¯å…·ä½“有哪些**? -* Bean ÅäÖÃÔªÐÅÏ¢£ºÍ¨¹ýý½é£¨Èç XML¡¢Proeprties µÈ£©£¬½âÎö BeanDefinition -* IoC ÈÝÆ÷ÅäÖÃÔªÐÅÏ¢£ºÍ¨¹ýý½é£¨Èç XML¡¢Proeprties µÈ£©£¬¿ØÖÆ IoC ÈÝÆ÷ÐÐΪ£¬±ÈÈç×¢½âÇý¶¯¡¢AOP µÈ -* Íⲿ»¯ÅäÖãºÍ¨¹ý×ÊÔ´³éÏó£¨Èç Proeprties¡¢YAML µÈ£©£¬¿ØÖÆ PropertySource -* Spring Profile£ºÍ¨¹ýÍⲿ»¯ÅäÖã¬ÌṩÌõ¼þ·ÖÖ§Á÷³Ì +* Bean é…�置元信æ�¯ï¼šé€šè¿‡åª’介(如 XMLã€�Proeprties 等),解æž� BeanDefinition +* IoC 容器é…�置元信æ�¯ï¼šé€šè¿‡åª’介(如 XMLã€�Proeprties 等),控制 IoC 容器行为,比如注解驱动ã€�AOP ç­‰ +* 外部化é…�置:通过资æº�抽象(如 Proeprtiesã€�YAML 等),控制 PropertySource +* Spring Profile:通过外部化é…�置,æ��ä¾›æ�¡ä»¶åˆ†æ”¯æµ�程 -**Extensible XML authoring µÄȱµã**£¿ +**Extensible XML authoring 的缺点**? -* ¸ß¸´ÔÓ¶È£º¿ª·¢ÈËÔ±ÐèÒªÊìϤ XML Schema£¬spring.handlers£¬spring.schemas ÒÔ¼° Spring API -* ǶÌ×ÔªËØÖ§³Ö½ÏÈõ£ºÍ¨³£ÐèҪʹÓ÷½·¨µÝ¹é»òÕ߯äǶÌ×½âÎöµÄ·½Ê½´¦ÀíǶÌ×£¨×Ó£©ÔªËØ -* XML ´¦ÀíÐÔÄܽϲSpring XML »ùÓÚ DOM Level 3 API ʵÏÖ£¬¸Ã API ±ãÓÚÀí½â£¬È»¶øÐÔÄܽϲî -* XML ¿ò¼ÜÒÆÖ²ÐԲºÜÄÑÊÊÅä¸ßÐÔÄܺͱãÀûÐ﵀ XML ¿ò¼Ü£¬Èç JAXB +* 高å¤�æ�‚度:开å�‘人员需è¦�熟悉 XML Schema,spring.handlers,spring.schemas 以å�Š Spring API +* 嵌套元素支æŒ�较弱:通常需è¦�使用方法递归或者其嵌套解æž�的方å¼�处ç�†åµŒå¥—(å­�)元素 +* XML 处ç�†æ€§èƒ½è¾ƒå·®ï¼šSpring XML 基于 DOM Level 3 API 实现,该 API 便于ç�†è§£ï¼Œç„¶è€Œæ€§èƒ½è¾ƒå·® +* XML 框架移æ¤�性差:很难适é…�高性能和便利性的 XML 框架,如 JAXB -## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99)²Î¿¼×ÊÁÏ +## [#](https://dunwu.github.io/spring-tutorial/pages/55f315/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99)å�‚考资料 -* [Spring ¹Ù·½ÎĵµÖ® Core Technologies(opens new window)](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) -* [¡¶Ð¡Âí¸ç½² Spring ºËÐıà³Ì˼Ïë¡·(opens new window)](https://time.geekbang.org/course/intro/265) +* [Spring 官方文档之 Core Technologies(opens new window)](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans) +* [《å°�马哥讲 Spring 核心编程æ€�想》(opens new window)](https://time.geekbang.org/course/intro/265) -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\272\213\345\212\241\345\237\272\346\234\254\347\224\250\346\263\225.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\272\213\345\212\241\345\237\272\346\234\254\347\224\250\346\263\225.md" index c247c82..1875e6a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\272\213\345\212\241\345\237\272\346\234\254\347\224\250\346\263\225.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\344\272\213\345\212\241\345\237\272\346\234\254\347\224\250\346\263\225.md" @@ -1,93 +1,93 @@ -# SpringÊÂÎñºËÐÄ½Ó¿Ú +# Spring事务核心接å�£ -[Spring](http://www.voidme.com/spring) µÄÊÂÎñ¹ÜÀíÊÇ»ùÓÚ AOP ʵÏֵ쬶ø AOP ÊÇÒÔ·½·¨Îªµ¥Î»µÄ¡£Spring µÄÊÂÎñÊôÐÔ·Ö±ðΪ´«²¥ÐÐΪ¡¢¸ôÀë¼¶±ð¡¢Ö»¶ÁºÍ³¬Ê±ÊôÐÔ£¬ÕâЩÊôÐÔÌṩÁËÊÂÎñÓ¦Óõķ½·¨ºÍÃèÊö²ßÂÔ¡£ +[Spring](http://www.voidme.com/spring) 的事务管ç�†æ˜¯åŸºäºŽ AOP 实现的,而 AOP 是以方法为å�•ä½�的。Spring 的事务属性分别为传播行为ã€�隔离级别ã€�å�ªè¯»å’Œè¶…时属性,这些属性æ��供了事务应用的方法和æ��述策略。 -ÔÚ [Java](http://www.voidme.com/java) EE ¿ª·¢¾­³£²ÉÓõķֲãģʽÖУ¬Spring µÄÊÂÎñ´¦ÀíλÓÚÒµÎñÂß¼­²ã£¬ËüÌṩÁËÕë¶ÔÊÂÎñµÄ½â¾ö·½°¸¡£ +在 [Java](http://www.voidme.com/java) EE å¼€å�‘ç»�常采用的分层模å¼�中,Spring 的事务处ç�†ä½�于业务逻辑层,它æ��供了针对事务的解决方案。 -ÔÚ Spring ½âѹ°üµÄ libs Ŀ¼ÖУ¬°üº¬Ò»¸öÃû³ÆÎª spring-tx-3.2.13.RELEASE.jar µÄÎļþ£¬¸ÃÎļþÊÇ Spring ÌṩµÄÓÃÓÚÊÂÎñ¹ÜÀíµÄ JAR °ü£¬ÆäÖаüÀ¨ÊÂÎñ¹ÜÀíµÄÈý¸öºËÐĽӿڣºPlatformTransactionManager¡¢TransactionDefinition ºÍ TransactionStatus¡£ +在 Spring 解压包的 libs 目录中,包å�«ä¸€ä¸ªå��称为 spring-tx-3.2.13.RELEASE.jar 的文件,该文件是 Spring æ��供的用于事务管ç�†çš„ JAR 包,其中包括事务管ç�†çš„三个核心接å�£ï¼šPlatformTransactionManagerã€�TransactionDefinition å’Œ TransactionStatus。 -½«¸Ã JAR °üµÄºó׺Ãû jar ¸Ä³É zip µÄÐÎʽºó£¬½âѹѹËõ°ü£¬½øÈë½âѹÎļþ¼ÐÖÐµÄ \org\springframework\transaction Ŀ¼ºó£¬¸ÃĿ¼ÖеÄÎļþÈçͼ 1 Ëùʾ¡£ +将该 JAR 包的å�Žç¼€å�� jar 改æˆ� zip 的形å¼�å�Žï¼Œè§£åŽ‹åŽ‹ç¼©åŒ…ï¼Œè¿›å…¥è§£åŽ‹æ–‡ä»¶å¤¹ä¸­çš„ \org\springframework\transaction 目录å�Žï¼Œè¯¥ç›®å½•中的文件如图 1 所示。 -![ÊÂÎñ¹ÜÀíºËÐĽӿÚ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/760_a12_405.png) -ͼ 1 ÊÂÎñ¹ÜÀíºËÐÄ½Ó¿Ú +![事务管ç�†æ ¸å¿ƒæŽ¥å�£](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/760_a12_405.png) +图 1 事务管ç�†æ ¸å¿ƒæŽ¥å�£ -ÔÚͼ 1 ÖУ¬·½¿òËù±ê×¢µÄÈý¸öÎļþ¾ÍÊDZ¾½Ú½«Òª½²½âµÄºËÐĽӿڡ£ÕâÈý¸öºËÐĽӿڵÄ×÷Óü°ÆäÌṩµÄ·½·¨ÈçÏ¡£ +在图 1 中,方框所标注的三个文件就是本节将è¦�讲解的核心接å�£ã€‚这三个核心接å�£çš„作用å�Šå…¶æ��供的方法如下。 #### 1\. PlatformTransactionManager -PlatformTransactionManager ½Ó¿ÚÊÇ Spring ÌṩµÄƽ̨ÊÂÎñ¹ÜÀíÆ÷£¬ÓÃÓÚ¹ÜÀíÊÂÎñ¡£¸Ã½Ó¿ÚÖÐÌṩÁËÈý¸öÊÂÎñ²Ù×÷·½·¨£¬¾ßÌåÈçÏ¡£ +PlatformTransactionManager 接å�£æ˜¯ Spring æ��供的平å�°äº‹åŠ¡ç®¡ç�†å™¨ï¼Œç”¨äºŽç®¡ç�†äº‹åŠ¡ã€‚è¯¥æŽ¥å�£ä¸­æ��供了三个事务æ“�作方法,具体如下。 -* TransactionStatus getTransaction£¨TransactionDefinition definition£©£ºÓÃÓÚ»ñÈ¡ÊÂÎñ״̬ÐÅÏ¢¡£ -* void commit£¨TransactionStatus status£©£ºÓÃÓÚÌá½»ÊÂÎñ¡£ -* void rollback£¨TransactionStatus status£©£ºÓÃÓڻعöÊÂÎñ¡£ +* TransactionStatus getTransaction(TransactionDefinition definition):用于获å�–事务状æ€�ä¿¡æ�¯ã€‚ +* void commit(TransactionStatus status):用于æ��交事务。 +* void rollback(TransactionStatus status):用于回滚事务。 -ÔÚÏîÄ¿ÖУ¬Spring ½« xml ÖÐÅäÖõÄÊÂÎñÏêϸÐÅÏ¢·â×°µ½¶ÔÏó TransactionDefinition ÖУ¬È»ºóͨ¹ýÊÂÎñ¹ÜÀíÆ÷µÄ getTransaction() ·½·¨»ñµÃÊÂÎñµÄ״̬£¨TransactionStatus£©£¬²¢¶ÔÊÂÎñ½øÐÐÏÂÒ»²½µÄ²Ù×÷¡£ +在项目中,Spring å°† xml 中é…�置的事务详细信æ�¯å°�装到对象 TransactionDefinition 中,然å�Žé€šè¿‡äº‹åŠ¡ç®¡ç�†å™¨çš„ getTransaction() 方法获得事务的状æ€�(TransactionStatus),并对事务进行下一步的æ“�作。 #### 2\. TransactionDefinition -TransactionDefinition ½Ó¿ÚÊÇÊÂÎñ¶¨Ò壨ÃèÊö£©µÄ¶ÔÏó£¬ËüÌṩÁËÊÂÎñÏà¹ØÐÅÏ¢»ñÈ¡µÄ·½·¨£¬ÆäÖаüÀ¨Îå¸ö²Ù×÷£¬¾ßÌåÈçÏ¡£ +TransactionDefinition 接å�£æ˜¯äº‹åŠ¡å®šä¹‰ï¼ˆæ��述)的对象,它æ��供了事务相关信æ�¯èŽ·å�–的方法,其中包括五个æ“�作,具体如下。 -* String getName()£º»ñÈ¡ÊÂÎñ¶ÔÏóÃû³Æ¡£ -* int getIsolationLevel()£º»ñÈ¡ÊÂÎñµÄ¸ôÀë¼¶±ð¡£ -* int getPropagationBehavior()£º»ñÈ¡ÊÂÎñµÄ´«²¥ÐÐΪ¡£ -* int getTimeout()£º»ñÈ¡ÊÂÎñµÄ³¬Ê±Ê±¼ä¡£ -* boolean isReadOnly()£º»ñÈ¡ÊÂÎñÊÇ·ñÖ»¶Á¡£ +* String getName():获å�–事务对象å��称。 +* int getIsolationLevel():获å�–事务的隔离级别。 +* int getPropagationBehavior():获å�–事务的传播行为。 +* int getTimeout():获å�–事务的超时时间。 +* boolean isReadOnly():获å�–事务是å�¦å�ªè¯»ã€‚ -ÔÚÉÏÊöÎå¸ö·½·¨µÄÃèÊöÖУ¬ÊÂÎñµÄ´«²¥ÐÐΪÊÇÖ¸ÔÚͬһ¸ö·½·¨ÖУ¬²»Í¬²Ù×÷ǰºóËùʹÓõÄÊÂÎñ¡£´«²¥ÐÐΪµÄÖÖÀàÈç±í 1 Ëùʾ¡£ +在上述五个方法的æ��述中,事务的传播行为是指在å�Œä¸€ä¸ªæ–¹æ³•中,ä¸�å�Œæ“�作å‰�å�Žæ‰€ä½¿ç”¨çš„事务。传播行为的ç§�类如表 1 所示。 -| ÊôÐÔÃû³Æ | Öµ | Ãè Êö | +| 属性å��ç§° | 值 | æ�� è¿° | | --- | --- | --- | -| PROPAGATION_REQUIRED | required | Ö§³Öµ±Ç°ÊÂÎñ¡£Èç¹û A ·½·¨ÒѾ­ÔÚÊÂÎñÖУ¬Ôò B ÊÂÎñ½«Ö±½ÓʹÓ᣷ñÔò½«´´½¨ÐÂÊÂÎñ | -| PROPAGATION_SUPPORTS | supports | Ö§³Öµ±Ç°ÊÂÎñ¡£Èç¹û A ·½·¨ÒѾ­ÔÚÊÂÎñÖУ¬Ôò B ÊÂÎñ½«Ö±½ÓʹÓ᣷ñÔò½«ÒÔ·ÇÊÂÎñ״ִ̬ÐÐ | -| PROPAGATION_MANDATORY | mandatory | Ö§³Öµ±Ç°ÊÂÎñ¡£Èç¹û A ·½·¨Ã»ÓÐÊÂÎñ£¬ÔòÅ׳öÒì³£ | -| PROPAGATION_REQUIRES_NEW | requires_new | ½«´´½¨ÐµÄÊÂÎñ£¬Èç¹û A ·½·¨ÒѾ­ÔÚÊÂÎñÖУ¬Ôò½« A ÊÂÎñ¹ÒÆð | -| PROPAGATION_NOT_SUPPORTED | not_supported | ²»Ö§³Öµ±Ç°ÊÂÎñ£¬×ÜÊÇÒÔ·ÇÊÂÎñ״ִ̬ÐС£Èç¹û A ·½·¨ÒѾ­ÔÚÊÂÎñÖУ¬Ôò½«Æä¹ÒÆð | -| PROPAGATION_NEVER | never | ²»Ö§³Öµ±Ç°ÊÂÎñ£¬Èç¹û A ·½·¨ÔÚÊÂÎñÖУ¬ÔòÅ׳öÒì³£ | -| PROPAGATION.NESTED | nested | ǶÌ×ÊÂÎñ£¬µ×²ã½«Ê¹Óà Savepoint ÐγÉǶÌ×ÊÂÎñ | +| PROPAGATION_REQUIRED | required | 支æŒ�当å‰�事务。如果 A 方法已ç»�在事务中,则 B 事务将直接使用。å�¦åˆ™å°†åˆ›å»ºæ–°äº‹åŠ¡ | +| PROPAGATION_SUPPORTS | supports | 支æŒ�当å‰�事务。如果 A 方法已ç»�在事务中,则 B 事务将直接使用。å�¦åˆ™å°†ä»¥é�žäº‹åŠ¡çŠ¶æ€�执行 | +| PROPAGATION_MANDATORY | mandatory | 支æŒ�当å‰�事务。如果 A 方法没有事务,则抛出异常 | +| PROPAGATION_REQUIRES_NEW | requires_new | 将创建新的事务,如果 A 方法已ç»�在事务中,则将 A 事务挂起 | +| PROPAGATION_NOT_SUPPORTED | not_supported | ä¸�支æŒ�当å‰�事务,总是以é�žäº‹åŠ¡çŠ¶æ€�执行。如果 A 方法已ç»�在事务中,则将其挂起 | +| PROPAGATION_NEVER | never | ä¸�支æŒ�当å‰�事务,如果 A 方法在事务中,则抛出异常 | +| PROPAGATION.NESTED | nested | 嵌套事务,底层将使用 Savepoint å½¢æˆ�嵌套事务 | -ÔÚÊÂÎñ¹ÜÀí¹ý³ÌÖУ¬´«²¥ÐÐΪ¿ÉÒÔ¿ØÖÆÊÇ·ñÐèÒª´´½¨ÊÂÎñÒÔ¼°ÈçºÎ´´½¨ÊÂÎñ¡£ +在事务管ç�†è¿‡ç¨‹ä¸­ï¼Œä¼ æ’­è¡Œä¸ºå�¯ä»¥æŽ§åˆ¶æ˜¯å�¦éœ€è¦�创建事务以å�Šå¦‚何创建事务。 -ͨ³£Çé¿öÏ£¬Êý¾ÝµÄ²éѯ²»»á¸Ä±äÔ­Êý¾Ý£¬ËùÒÔ²»ÐèÒª½øÐÐÊÂÎñ¹ÜÀí£¬¶ø¶ÔÓÚÊý¾ÝµÄÔö¼Ó¡¢Ð޸ĺÍɾ³ýµÈ²Ù×÷£¬±ØÐë½øÐÐÊÂÎñ¹ÜÀí¡£Èç¹ûûÓÐÖ¸¶¨ÊÂÎñµÄ´«²¥ÐÐΪ£¬Ôò Spring3 ĬÈϵĴ«²¥ÐÐΪÊÇ required¡£ +通常情况下,数æ�®çš„æŸ¥è¯¢ä¸�会改å�˜åŽŸæ•°æ�®ï¼Œæ‰€ä»¥ä¸�需è¦�进行事务管ç�†ï¼Œè€Œå¯¹äºŽæ•°æ�®çš„增加ã€�修改和删除等æ“�作,必须进行事务管ç�†ã€‚如果没有指定事务的传播行为,则 Spring3 默认的传播行为是 required。 #### 3\. TransactionStatus -TransactionStatus ½Ó¿ÚÊÇÊÂÎñµÄ״̬£¬ËüÃèÊöÁËijһʱ¼äµãÉÏÊÂÎñµÄ״̬ÐÅÏ¢¡£ÆäÖаüº¬Áù¸ö²Ù×÷£¬¾ßÌåÈç±í 2 Ëùʾ¡£ +TransactionStatus 接å�£æ˜¯äº‹åŠ¡çš„çŠ¶æ€�,它æ��述了æŸ�一时间点上事务的状æ€�ä¿¡æ�¯ã€‚其中包å�«å…­ä¸ªæ“�作,具体如表 2 所示。 -±í 2 ÊÂÎñµÄ²Ù×÷ -| Ãû³Æ | ˵Ã÷ | +表 2 事务的æ“�作 +| å��ç§° | 说明 | | --- | --- | -| void flush() | Ë¢ÐÂÊÂÎñ | -| boolean hasSavepoint() | »ñÈ¡ÊÇ·ñ´æÔÚ±£´æµã | -| boolean isCompleted() | »ñÈ¡ÊÂÎñÊÇ·ñÍê³É | -| boolean isNewTransaction() | »ñÈ¡ÊÇ·ñÊÇÐÂÊÂÎñ | -| boolean isRollbackOnly() | »ñÈ¡ÊÇ·ñ»Ø¹ö | -| void setRollbackOnly() | ÉèÖÃÊÂÎñ»Ø¹ö | +| void flush() | 刷新事务 | +| boolean hasSavepoint() | 获å�–是å�¦å­˜åœ¨ä¿�存点 | +| boolean isCompleted() | 获å�–事务是å�¦å®Œæˆ� | +| boolean isNewTransaction() | 获å�–是å�¦æ˜¯æ–°äº‹åŠ¡ | +| boolean isRollbackOnly() | 获å�–是å�¦å›žæ»š | +| void setRollbackOnly() | 设置事务回滚 | -# SpringÉùÃ÷ʽÊÂÎñ¹ÜÀí£¨»ùÓÚXML·½Ê½ÊµÏÖ£© +# Spring声明å¼�事务管ç�†ï¼ˆåŸºäºŽXMLæ–¹å¼�实现) -[Spring](http://www.voidme.com/spring) µÄÊÂÎñ¹ÜÀíÓÐÁ½ÖÖ·½Ê½£ºÒ»ÖÖÊÇ´«Í³µÄ±à³ÌʽÊÂÎñ¹ÜÀí£¬¼´Í¨¹ý±àд´úÂëʵÏÖµÄÊÂÎñ¹ÜÀí£»ÁíÒ»ÖÖÊÇ»ùÓÚ AOP ¼¼ÊõʵÏÖµÄÉùÃ÷ʽÊÂÎñ¹ÜÀí¡£ÓÉÓÚÔÚʵ¼Ê¿ª·¢ÖУ¬±à³ÌʽÊÂÎñ¹ÜÀíºÜÉÙʹÓã¬ËùÒÔÎÒÃÇÖ»¶Ô Spring µÄÉùÃ÷ʽÊÂÎñ¹ÜÀí½øÐÐÏêϸ½²½â¡£ +[Spring](http://www.voidme.com/spring) 的事务管ç�†æœ‰ä¸¤ç§�æ–¹å¼�:一ç§�是传统的编程å¼�事务管ç�†ï¼Œå�³é€šè¿‡ç¼–写代ç �实现的事务管ç�†ï¼›å�¦ä¸€ç§�是基于 AOP 技术实现的声明å¼�事务管ç�†ã€‚由于在实际开å�‘中,编程å¼�事务管ç�†å¾ˆå°‘使用,所以我们å�ªå¯¹ Spring 的声明å¼�事务管ç�†è¿›è¡Œè¯¦ç»†è®²è§£ã€‚ -Spring ÉùÃ÷ʽÊÂÎñ¹ÜÀíÔڵײã²ÉÓÃÁË AOP ¼¼Êõ£¬Æä×î´óµÄÓŵãÔÚÓÚÎÞÐëͨ¹ý±à³ÌµÄ·½Ê½¹ÜÀíÊÂÎñ£¬Ö»ÐèÒªÔÚÅäÖÃÎļþÖнøÐÐÏà¹ØµÄ¹æÔòÉùÃ÷£¬¾Í¿ÉÒÔ½«ÊÂÎñ¹æÔòÓ¦Óõ½ÒµÎñÂß¼­ÖС£ +Spring 声明å¼�事务管ç�†åœ¨åº•层采用了 AOP 技术,其最大的优点在于无须通过编程的方å¼�管ç�†äº‹åŠ¡ï¼Œå�ªéœ€è¦�在é…�置文件中进行相关的规则声明,就å�¯ä»¥å°†äº‹åŠ¡è§„åˆ™åº”ç”¨åˆ°ä¸šåŠ¡é€»è¾‘ä¸­ã€‚ -Spring ʵÏÖÉùÃ÷ʽÊÂÎñ¹ÜÀíÖ÷ÒªÓÐÁ½ÖÖ·½Ê½£º +Spring 实现声明å¼�事务管ç�†ä¸»è¦�有两ç§�æ–¹å¼�: -* »ùÓÚ XML ·½Ê½µÄÉùÃ÷ʽÊÂÎñ¹ÜÀí¡£ -* ͨ¹ý Annotation ×¢½â·½Ê½µÄÊÂÎñ¹ÜÀí¡£ +* 基于 XML æ–¹å¼�的声明å¼�事务管ç�†ã€‚ +* 通过 Annotation 注解方å¼�的事务管ç�†ã€‚ -±¾½Úͨ¹ýÒøÐÐתÕ˵ݸÀý½²½âÈçºÎʹÓà XML µÄ·½Ê½ÊµÏÖ Spring µÄÉùÃ÷ʽÊÂÎñ´¦Àí¡£ +本节通过银行转账的案例讲解如何使用 XML 的方å¼�实现 Spring 的声明å¼�事务处ç�†ã€‚ -#### 1\. ´´½¨ÏîÄ¿ +#### 1\. 创建项目 -ÔÚ MyEclipse Öд´½¨Ò»¸öÃûΪ springDemo03 µÄ Web ÏîÄ¿£¬½« Spring Ö§³ÖºÍÒÀÀµµÄ JAR °ü¸´ÖƵ½ Web ÏîÄ¿µÄ lib Ŀ¼ÖУ¬²¢Ìí¼Óµ½Àà·¾¶Ï¡£ËùÌí¼ÓµÄ JAR °üÈçͼ 1 Ëùʾ¡£ +在 MyEclipse 中创建一个å��为 springDemo03 çš„ Web 项目,将 Spring 支æŒ�å’Œä¾�èµ–çš„ JAR 包å¤�制到 Web 项目的 lib 目录中,并添加到类路径下。所添加的 JAR 包如图 1 所示。 -![ÐèÒªµ¼ÈëµÄJAR°ü](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/761_732_fcf.png) -ͼ 1 ÐèÒªµ¼ÈëµÄJAR°ü +![需è¦�导入的JAR包](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/761_732_fcf.png) +图 1 需è¦�导入的JAR包 -´Óͼ 1 ÖпÉÒÔ¿´³ö£¬ÕâÀïÔö¼Óµ¼ÈëÁË spring-tx-3.2.13.RELEASE.jar£¨ÊÂÎñ¹ÜÀí£©£¬ÒÔ¼° [MySQL](http://www.voidme.com/mysql) Çý¶¯¡¢JDBC ºÍ C3P0 µÄ JAR °ü¡£ +从图 1 中å�¯ä»¥çœ‹å‡ºï¼Œè¿™é‡Œå¢žåŠ å¯¼å…¥äº† spring-tx-3.2.13.RELEASE.jar(事务管ç�†ï¼‰ï¼Œä»¥å�Š [MySQL](http://www.voidme.com/mysql) 驱动ã€�JDBC å’Œ C3P0 çš„ JAR 包。 -#### 2\. ´´½¨Êý¾Ý¿â¡¢±íÒÔ¼°²åÈëÊý¾Ý +#### 2\. 创建数æ�®åº“ã€�表以å�Šæ�’入数æ�® -ÔÚ MySQL Öд´½¨Ò»¸öÃûΪ spring µÄÊý¾Ý¿â£¬È»ºóÔÚ¸ÃÊý¾Ý¿âÖд´½¨Ò»¸ö account ±í£¬²¢Ïò±íÖвåÈëÁ½ÌõÊý¾Ý£¬Æä SQL Ö´ÐÐÓï¾äÈçÏÂËùʾ£º +在 MySQL 中创建一个å��为 spring 的数æ�®åº“,然å�Žåœ¨è¯¥æ•°æ�®åº“中创建一个 account 表,并å�‘表中æ�’入两æ�¡æ•°æ�®ï¼Œå…¶ SQL 执行语å�¥å¦‚下所示: CREATE DATABASE spring; USE spring; @@ -99,37 +99,37 @@ money INT DEFAULT NULL INSERT INTO account VALUES (1,'zhangsan',1000); INSERT INTO account VALUES (2,'lisi',1000); -Ö´ÐкóµÄ account ±íÖеÄÊý¾ÝÈçͼ 2 Ëùʾ¡£ +执行å�Žçš„ account 表中的数æ�®å¦‚图 2 所示。 -![Ö´Ðнá¹û](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/762_276_8a5.PNG) -ͼ 2 Ö´Ðнá¹û +![执行结果](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/762_276_8a5.PNG) +图 2 执行结果 -#### 3\. ´´½¨ c3p0-db.properties +#### 3\. 创建 c3p0-db.properties -ÔÚÏîÄ¿µÄ src Ï´´½¨Ò»¸öÃûΪ c3p0-db.properties µÄÅäÖÃÎļþ£¬ÕâÀïʹÓà C3P0 Êý¾ÝÔ´£¬ÐèÒªÔÚ¸ÃÎļþÖÐÌí¼ÓÈçÏÂÅäÖ㺠+在项目的 src 下创建一个å��为 c3p0-db.properties çš„é…�置文件,这里使用 C3P0 æ•°æ�®æº�,需è¦�在该文件中添加如下é…�置: ```` jdbc.driverClass = com.mysql.jdbc.Driver jdbc.jdbcUrl = jdbc:mysql://localhost:3306/spring jdbc.user = root jdbc.password = root ```` -#### 4\. ʵÏÖ DAO +#### 4\. 实现 DAO -#### 1£©´´½¨ AccountDao ½Ó¿Ú +#### 1)创建 AccountDao 接å�£ -ÔÚÏîÄ¿µÄ src Ŀ¼Ï´´½¨Ò»¸öÃûΪ com.mengma.dao µÄ°ü£¬ÔڸðüÏ´´½¨Ò»¸ö½Ó¿Ú AccountDao£¬²¢ÔÚ½Ó¿ÚÖд´½¨»ã¿îºÍÊÕ¿îµÄ·½·¨£¬ÈçÏÂËùʾ¡£ +在项目的 src 目录下创建一个å��为 com.mengma.dao 的包,在该包下创建一个接å�£ AccountDao,并在接å�£ä¸­åˆ›å»ºæ±‡æ¬¾å’Œæ”¶æ¬¾çš„æ–¹æ³•,如下所示。 ```` package com.mengma.dao; public interface AccountDao { - // »ã¿î + // 汇款 public void out(String outUser, int money); - // ÊÕ¿î + // 收款 public void in(String inUser, int money);} ```` -ÉÏÊö´úÂëÖУ¬¶¨ÒåÁË out() ºÍ in() Á½¸ö·½·¨£¬·Ö±ðÓÃÓÚ±íʾ»ã¿îºÍÊÕ¿î¡£ +上述代ç �中,定义了 out() å’Œ in() 两个方法,分别用于表示汇款和收款。 -#### 2£©´´½¨DAO²ã½Ó¿ÚʵÏÖÀà +#### 2)创建DAO层接å�£å®žçŽ°ç±» -ÔÚÏîÄ¿µÄ src Ŀ¼Ï´´½¨Ò»¸öÃûΪ com.mengma.dao.impl µÄ°ü£¬ÔڸðüÏ´´½¨ÊµÏÖÀà AccountDaoImpl£¬ÈçÏÂËùʾ¡£ +在项目的 src 目录下创建一个å��为 com.mengma.dao.impl 的包,在该包下创建实现类 AccountDaoImpl,如下所示。 ```` package com.mengma.dao.impl; @@ -139,26 +139,26 @@ import com.mengma.dao.AccountDao; public class AccountDaoImpl implements AccountDao { private JdbcTemplate jdbcTemplate; public void setJdbcTemplate(JdbcTemplate jdbcTemplate) { this.jdbcTemplate = jdbcTemplate; } -// »ã¿îµÄʵÏÖ·½·¨ +// 汇款的实现方法 public void out(String outUser, int money) { this.jdbcTemplate.update("update account set money =money-?" + "where username =?", money, outUser); } -// ÊÕ¿îµÄʵÏÖ·½·¨ +// 收款的实现方法 public void in(String inUser, int money) { this.jdbcTemplate.update("update account set money =money+?" + "where username =?", money, inUser); }} ```` -ÉÏÊö´úÂëÖУ¬Ê¹Óà JdbcTemplate ÀàµÄ update() ·½·¨ÊµÏÖÁ˸üвÙ×÷¡£ +上述代ç �中,使用 JdbcTemplate 类的 update() 方法实现了更新æ“�作。 -#### 5\. ʵÏÖ Service +#### 5\. 实现 Service -#### 1£©´´½¨ Service ²ã½Ó¿Ú +#### 1)创建 Service 层接å�£ -ÔÚÏîÄ¿µÄ src Ŀ¼Ï´´½¨Ò»¸öÃûΪ com.mengma.service µÄ°ü£¬ÔڸðüÏ´´½¨½Ó¿Ú AccountService£¬ÈçÏÂËùʾ¡£ +在项目的 src 目录下创建一个å��为 com.mengma.service 的包,在该包下创建接å�£ AccountService,如下所示。 ```` package com.mengma.service; public interface AccountService { - // תÕË + // 转账 public void transfer(String outUser, String inUser, int money);} ```` -#### 2£©´´½¨ Service ²ã½Ó¿ÚʵÏÖÀà +#### 2)创建 Service 层接å�£å®žçŽ°ç±» -ÔÚÏîÄ¿µÄ src Ŀ¼Ï´´½¨Ò»¸öÃûΪ com.mengma.service.impl µÄ°ü£¬ÔڸðüÏ´´½¨ÊµÏÖÀà AccountServiceImpl£¬ÈçÏÂËùʾ¡£ +在项目的 src 目录下创建一个å��为 com.mengma.service.impl 的包,在该包下创建实现类 AccountServiceImpl,如下所示。 ```` package com.mengma.service.impl; @@ -168,24 +168,24 @@ public class AccountServiceImpl { private AccountDao accountDao; public void setAccountDao(AccountDao accountDao) { this.accountDao = accountDao; } public void transfer(String outUser, String inUser, int money) { this.accountDao.out(outUser, money); this.accountDao.in(inUser, money); }} ```` -ÉÏÊö´úÂëÖпÉÒÔ¿´³ö£¬¸ÃÀàʵÏÖÁË AccountService ½Ó¿Ú£¬²¢¶ÔתÕ˵ķ½·¨½øÐÐÁËʵÏÖ£¬¸ù¾Ý²ÎÊýµÄ²»Í¬µ÷Óà DAO ²ãÏàÓ¦µÄ·½·¨¡£ +上述代ç �中å�¯ä»¥çœ‹å‡ºï¼Œè¯¥ç±»å®žçŽ°äº† AccountService 接å�£ï¼Œå¹¶å¯¹è½¬è´¦çš„æ–¹æ³•进行了实现,根æ�®å�‚æ•°çš„ä¸�å�Œè°ƒç”¨ DAO 层相应的方法。 -#### 6\. ´´½¨ Spring ÅäÖÃÎļþ +#### 6\. 创建 Spring é…�置文件 -ÔÚÏîÄ¿µÄ src Ŀ¼Ï´´½¨ Spirng ÅäÖÃÎļþ applicationContext.xml£¬±à¼­ºóÈçÏÂËùʾ¡£ +在项目的 src 目录下创建 Spirng é…�置文件 applicationContext.xml,编辑å�Žå¦‚下所示。 ```` - - ```` -ÉÏÊö´úÂëÖУ¬Ê×ÏÈÔÚ ±ê¼ÇµÄµÚ 6¡¢13 ºÍ 14 ÐдúÂë·Ö±ðÌí¼ÓÁË AOP ËùÐèµÄÃüÃû¿Õ¼äÉùÃ÷¡£µÚ 42¡«50 ÐдúÂëʹÓà ±ê¼ÇÅäÖÃÊÂÎñ֪ͨÄÚÈÝ¡£ + http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"> + + ```` +上述代ç �中,首先在 标记的第 6ã€�13 å’Œ 14 行代ç �分别添加了 AOP 所需的命å��空间声明。第 42~50 行代ç �使用 标记é…�置事务通知内容。 -µÚ 52¡«58 ÐдúÂëʹÓà ±ê¼Ç¶¨ÒåÇÐÃæ£¬ÆäÖÐµÚ 54 ÐдúÂëÓ¦ÓÃÁË AspectJ ±í´ïʽ£¬´ú±í com.mengma.service °üÏÂËùÓÐÀàµÄËùÓз½·¨¶¼Ó¦ÓÃÊÂÎñ¹æÔò£¬µÚ 57 ÐдúÂëʹÓà ±ê¼Ç½«ÇÐÈëµãÓëÊÂÎñ֪ͨÕûºÏ£¬»ùÓÚ AOP µÄÉùÃ÷ʽÊÂÎñÅäÖÃÍê³É¡£ +第 52~58 行代ç �使用 标记定义切é�¢ï¼Œå…¶ä¸­ç¬¬ 54 行代ç �应用了 AspectJ 表达å¼�,代表 com.mengma.service 包下所有类的所有方法都应用事务规则,第 57 行代ç �使用 标记将切入点与事务通知整å�ˆï¼ŒåŸºäºŽ AOP 的声明å¼�事务é…�置完æˆ�。 -#### 7\. ´´½¨²âÊÔÀà +#### 7\. 创建测试类 -ÔÚÏîÄ¿µÄ src Ŀ¼Ï´´½¨ com.mengma.test µÄ°ü£¬ÔڸðüÏ´´½¨²âÊÔÀà AccountTest£¬ÈçÏÂËùʾ¡£ +在项目的 src 目录下创建 com.mengma.test 的包,在该包下创建测试类 AccountTest,如下所示。 ```` package com.mengma.test; import org.junit.Test; @@ -193,71 +193,71 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; import com.mengma.service.AccountService; public class AccountTest { -@Test public void test() { // »ñµÃSpringÈÝÆ÷£¬²¢²Ù×÷ +@Test public void test() { // 获得Spring容器,并æ“�作 String xmlPath = "applicationContext.xml"; ApplicationContext applicationContext = new ClassPathXmlApplicationContext( xmlPath); AccountService accountService = (AccountService) applicationContext .getBean("accountService"); accountService.transfer("zhangsan", "lisi", 100); }} ```` -ÉÏÊö´úÂëÖÐÄ£ÄâÁËÒøÐÐתÕËÒµÎñ£¬´Ó zhangsan µÄÕË»§Ïò lisi µÄÕË»§ÖÐתÈë 100 Ôª¡£Ê¹Óà JUnit ²âÊÔÔËÐÐ test() ·½·¨£¬ÔËÐгɹ¦ºó£¬²éѯ account ±í£¬Èçͼ 3 Ëùʾ¡£ +上述代ç �中模拟了银行转账业务,从 zhangsan 的账户å�‘ lisi 的账户中转入 100 元。使用 JUnit 测试è¿�行 test() 方法,è¿�行æˆ�功å�Žï¼ŒæŸ¥è¯¢ account 表,如图 3 所示。 -´Óͼ 3 µÄ²éѯ½á¹ûÖпÉÒÔ¿´³ö£¬zhangsan ³É¹¦Ïò lisi תÕË 100 Ôª¡£ +从图 3 的查询结果中å�¯ä»¥çœ‹å‡ºï¼Œzhangsan æˆ�功å�‘ lisi 转账 100 元。 -![²éѯ½á¹û](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/763_9ae_de5.PNG) -ͼ 3 ²éѯ½á¹û +![查询结果](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/763_9ae_de5.PNG) +图 3 查询结果 -ÏÂÃæÍ¨¹ýÐ޸ݸÀýÄ£ÄâתÕËʧ°ÜµÄÇé¿ö£¬ÔÚµÄ transfer() ·½·¨ÖÐÌí¼ÓÒ»ÐдúÂë¡°int i=1/0£»¡±Ä£Äâϵͳ¶ÏµçµÄÇé¿ö£¬¾ßÌå´úÂëÈçÏÂËùʾ£º +下é�¢é€šè¿‡ä¿®æ”¹æ¡ˆä¾‹æ¨¡æ‹Ÿè½¬è´¦å¤±è´¥çš„æƒ…况,在的 transfer() 方法中添加一行代ç �“int i=1/0ï¼›â€�模拟系统断电的情况,具体代ç �如下所示: ```` - public void transfer(String outUser, String inUser, int money) { this.accountDao.out(outUser, money); //Ä£Äâ¶Ïµç + public void transfer(String outUser, String inUser, int money) { this.accountDao.out(outUser, money); //模拟断电 int i = 1/0; this.accountDao.in(inUser, money); } ```` -ÖØÐ²âÊÔÔËÐÐ test() ·½·¨£¬JUnit ¿ØÖÆÌ¨Êä³öµÄÐÅÏ¢Èçͼ 4 Ëùʾ¡£ +é‡�新测试è¿�行 test() 方法,JUnit 控制å�°è¾“出的信æ�¯å¦‚图 4 所示。 -![¿ØÖÆÌ¨Êä³ö½á¹û](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/764_7a3_f52.png) -ͼ 4 ¿ØÖÆÌ¨Êä³ö½á¹û +![控制å�°è¾“出结果](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/764_7a3_f52.png) +图 4 控制å�°è¾“出结果 -´Óͼ 4 ÖпÉÒÔ¿´³ö£¬ÔÚÖ´ÐвâÊÔ·½·¨Ê±£¬³öÏÖÁ˳ýÒÔ 0 µÄÒì³£ÐÅÏ¢¡£´ËʱÔٴβéѯ account ±í£¬Æä²éѯ½á¹ûÈçͼ 5 Ëùʾ¡£ +从图 4 中å�¯ä»¥çœ‹å‡ºï¼Œåœ¨æ‰§è¡Œæµ‹è¯•方法时,出现了除以 0 的异常信æ�¯ã€‚此时å†�次查询 account 表,其查询结果如图 5 所示。 -´Óͼ 5 µÄ²éѯ½á¹ûÖпÉÒÔ¿´³ö£¬±íÖеÄÊý¾Ý²¢Ã»Óз¢Éú±ä»¯¡£ÓÉÓÚ³ÌÐòÔÚÖ´Ðйý³ÌÖÐÅ׳öÁËÒì³££¬ÊÂÎñ²»ÄÜÕý³£±»Ìá½»£¬ËùÒÔתÕËʧ°Ü¡£ÓÉ´Ë¿ÉÖª£¬Spring µÄÊÂÎñ¹ÜÀíÉúЧÁË¡£ +从图 5 的查询结果中å�¯ä»¥çœ‹å‡ºï¼Œè¡¨ä¸­çš„æ•°æ�®å¹¶æ²¡æœ‰å�‘生å�˜åŒ–。由于程åº�在执行过程中抛出了异常,事务ä¸�能正常被æ��交,所以转账失败。由此å�¯çŸ¥ï¼ŒSpring 的事务管ç�†ç”Ÿæ•ˆäº†ã€‚ -![²éѯ½á¹û](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/763_9ae_de5.PNG) -ͼ 5 ²éѯ½á¹û +![查询结果](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/763_9ae_de5.PNG) +图 5 查询结果 -# SpringÉùÃ÷ʽÊÂÎñ¹ÜÀí£¨»ùÓÚAnnotation×¢½â·½Ê½ÊµÏÖ£© +# Spring声明å¼�事务管ç�†ï¼ˆåŸºäºŽAnnotation注解方å¼�实现) -ÔÚ [Spring](http://www.voidme.com/spring) ÖУ¬³ýÁËʹÓûùÓÚ XML µÄ·½Ê½¿ÉÒÔʵÏÖÉùÃ÷ʽÊÂÎñ¹ÜÀíÒÔÍ⣬»¹¿ÉÒÔͨ¹ý Annotation ×¢½âµÄ·½Ê½ÊµÏÖÉùÃ÷ʽÊÂÎñ¹ÜÀí¡£ +在 [Spring](http://www.voidme.com/spring) 中,除了使用基于 XML 的方å¼�å�¯ä»¥å®žçŽ°å£°æ˜Žå¼�事务管ç�†ä»¥å¤–,还å�¯ä»¥é€šè¿‡ Annotation 注解的方å¼�实现声明å¼�事务管ç�†ã€‚ -ʹÓà Annotation µÄ·½Ê½·Ç³£¼òµ¥£¬Ö»ÐèÒªÔÚÏîÄ¿ÖÐ×öÁ½¼þÊ£¬¾ßÌåÈçÏ¡£ +使用 Annotation 的方å¼�é�žå¸¸ç®€å�•,å�ªéœ€è¦�在项目中å�šä¸¤ä»¶äº‹ï¼Œå…·ä½“如下。 -#### 1£©ÔÚ Spring ÈÝÆ÷ÖÐ×¢²áÇý¶¯£¬´úÂëÈçÏÂËùʾ£º +#### 1)在 Spring 容器中注册驱动,代ç �如下所示: ```` ```` -#### 2£©ÔÚÐèҪʹÓÃÊÂÎñµÄÒµÎñÀà»òÕß·½·¨ÖÐÌí¼Ó×¢½â @Transactional£¬²¢ÅäÖà @Transactional µÄ²ÎÊý¡£¹ØÓÚ @Transactional µÄ²ÎÊýÈçͼ 1 Ëùʾ¡£ +#### 2)在需è¦�使用事务的业务类或者方法中添加注解 @Transactional,并é…�ç½® @Transactional çš„å�‚数。关于 @Transactional çš„å�‚数如图 1 所示。 -![@Transactional²ÎÊýÁбí](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/765_7af_ff7.png) -ͼ 1 @Transactional²ÎÊýÁбí +![@Transactionalå�‚数列表](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/765_7af_ff7.png) +图 1 @Transactionalå�‚数列表 -ÏÂÃæÍ¨¹ýÐ޸ġ¶ [Spring»ùÓÚXMLʵÏÖÊÂÎñ¹ÜÀí](http://www.voidme.com/spring/spring-transaction-management-by-xml)¡·½Ì³ÌÖÐÒøÐÐתÕ˵ݸÀý½²½âÈçºÎʹÓà Annotation ×¢½âµÄ·½Ê½ÊµÏÖ Spring ÉùÃ÷ʽÊÂÎñ¹ÜÀí¡£ +下é�¢é€šè¿‡ä¿®æ”¹ã€Š [Spring基于XML实现事务管ç�†](http://www.voidme.com/spring/spring-transaction-management-by-xml)》教程中银行转账的案例讲解如何使用 Annotation 注解的方å¼�实现 Spring 声明å¼�事务管ç�†ã€‚ -#### 1\. ×¢²áÇý¶¯ +#### 1\. 注册驱动 -ÐÞ¸Ä Spring ÅäÖÃÎļþ applicationContext.xml£¬Ð޸ĺóÈçÏÂËùʾ¡£ +修改 Spring é…�置文件 applicationContext.xml,修改å�Žå¦‚下所示。 ```` - - ```` +http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"> + + ```` ```` -ÉÏÊö´úÂëÖпÉÒÔ¿´³ö£¬ÓëÔ­À´µÄÅäÖÃÎļþÏà±È£¬ÕâÀïÖ»ÐÞ¸ÄÁËÊÂÎñ¹ÜÀíÆ÷²¿·Ö£¬ÐÂÌí¼Ó²¢×¢²áÁËÊÂÎñ¹ÜÀíÆ÷µÄÇý¶¯¡£ +上述代ç �中å�¯ä»¥çœ‹å‡ºï¼Œä¸ŽåŽŸæ�¥çš„é…�置文件相比,这里å�ªä¿®æ”¹äº†äº‹åŠ¡ç®¡ç�†å™¨éƒ¨åˆ†ï¼Œæ–°æ·»åŠ å¹¶æ³¨å†Œäº†äº‹åŠ¡ç®¡ç�†å™¨çš„驱动。 -ÐèҪעÒâµÄÊÇ£¬ÔÚѧϰ AOP ×¢½â·½Ê½¿ª·¢Ê±£¬ÐèÒªÔÚÅäÖÃÎļþÖпªÆô×¢½â´¦ÀíÆ÷£¬Ö¸¶¨É¨ÃèÄÄЩ°üϵÄ×¢½â£¬ÕâÀïûÓпªÆô×¢½â´¦ÀíÆ÷ÊÇÒòΪÔÚµÚ 33¡«35 ÐÐÊÖ¶¯ÅäÖÃÁË AccountServiceImpl£¬¶ø @Transactional ×¢½â¾ÍÅäÖÃÔÚ¸ÃÀàÖУ¬ËùÒÔ»áÖ±½ÓÉúЧ¡£ +需è¦�注æ„�的是,在学习 AOP 注解方å¼�å¼€å�‘时,需è¦�在é…�置文件中开å�¯æ³¨è§£å¤„ç�†å™¨ï¼ŒæŒ‡å®šæ‰«æ��哪些包下的注解,这里没有开å�¯æ³¨è§£å¤„ç�†å™¨æ˜¯å› ä¸ºåœ¨ç¬¬ 33~35 行手动é…�置了 AccountServiceImpl,而 @Transactional 注解就é…�置在该类中,所以会直接生效。 -#### 2\. Ìí¼Ó @Transactional ×¢½â +#### 2\. 添加 @Transactional 注解 -ÐÞ¸Ä AccountServiceImpl£¬ÔÚÎļþÖÐÌí¼Ó @Transactional ×¢½â¼°²ÎÊý£¬Ìí¼ÓºóÈçÏÂËùʾ¡£ +修改 AccountServiceImpl,在文件中添加 @Transactional 注解å�Šå�‚数,添加å�Žå¦‚下所示。 ```` package com.mengma.service.impl; @@ -271,19 +271,19 @@ import com.mengma.dao.AccountDao; public class AccountServiceImpl { private AccountDao accountDao; public void setAccountDao(AccountDao accountDao) { this.accountDao = accountDao; } - public void transfer(String outUser, String inUser, int money) { this.accountDao.out(outUser, money); // Ä£Äâ¶Ïµç + public void transfer(String outUser, String inUser, int money) { this.accountDao.out(outUser, money); // 模拟断电 int i = 1 / 0; this.accountDao.in(inUser, money); }} ```` -ÐèҪעÒâµÄÊÇ£¬ÔÚʹÓà @Transactional ×¢½âʱ£¬²ÎÊýÖ®¼äÓá°£¬¡±½øÐзָô¡£ +需è¦�注æ„�的是,在使用 @Transactional 注解时,å�‚数之间用“,â€�进行分隔。 -ʹÓà JUnit ²âÊÔÔÙ´ÎÔËÐÐ test() ·½·¨Ê±£¬¿ØÖÆÌ¨Í¬Ñù»áÊä³öÈçͼ 2 ËùʾµÄÒì³£ÐÅÏ¢£¬Õâ˵Ã÷ʹÓûùÓÚ Annotation ×¢½âµÄ·½Ê½Í¬ÑùʵÏÖÁË Spring µÄÉùÃ÷ʽÊÂÎñ¹ÜÀí¡£Èç¹û×¢Ê͵ôÄ£Äâ¶ÏµçµÄ´úÂë½øÐвâÊÔ£¬ÔòתÕ˲Ù×÷¿ÉÒÔÕý³£Íê³É¡£ +使用 JUnit 测试å†�次è¿�行 test() 方法时,控制å�°å�Œæ ·ä¼šè¾“出如图 2 所示的异常信æ�¯ï¼Œè¿™è¯´æ˜Žä½¿ç”¨åŸºäºŽ Annotation 注解的方å¼�å�Œæ ·å®žçŽ°äº† Spring 的声明å¼�事务管ç�†ã€‚如果注释掉模拟断电的代ç �进行测试,则转账æ“�作å�¯ä»¥æ­£å¸¸å®Œæˆ�。 -![ÔËÐнá¹û](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/764_7a3_f52.png) -ͼ 2 ÔËÐнá¹û +![è¿�行结果](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/764_7a3_f52.png) +图 2 è¿�行结果 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\220\210\351\233\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\220\210\351\233\206.md" index 931264e..8371999 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\220\210\351\233\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\220\210\351\233\206.md" @@ -1,22 +1,22 @@ # Spring -# SpringÔ´Âë·ÖÎö +# Springæº�ç �分æž� # SpringMVC -# SpringMVC Ô´Âë·ÖÎö +# SpringMVC æº�ç �分æž� # SpringBoot -## springbootµÄǰÊÀ½ñÉú -## springbootµÄ»ù±¾Ê¹Óà -## springbootµÄ³£¼û×¢½â -## springbootµÄºËÐÄ×é¼þ -## springbootµÄ»ù±¾Ô­Àí -## springbootÔ´Âë½âÎö +## springbootçš„å‰�世今生 +## springboot的基本使用 +## springboot的常è§�注解 +## springboot的核心组件 +## springboot的基本原ç�† +## springbootæº�ç �è§£æž� -# SpringBoot Ô´Âë·ÖÎö +# SpringBoot æº�ç �分æž� # SpringCloud -# SpringCloud Ô´Âë·ÖÎö +# SpringCloud æº�ç �分æž� diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\256\271\345\231\250\344\270\216IOC.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\256\271\345\231\250\344\270\216IOC.md" index 35623db..20f8ff0 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\256\271\345\231\250\344\270\216IOC.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\256\271\345\231\250\344\270\216IOC.md" @@ -1,32 +1,32 @@ -IoC ÊÇ Inversion of Control µÄ¼òд£¬ÒëΪ¡°¿ØÖÆ·´×ª¡±£¬Ëü²»ÊÇÒ»Ãż¼Êõ£¬¶øÊÇÒ»ÖÖÉè¼ÆË¼Ï룬ÊÇÒ»¸öÖØÒªµÄÃæÏò¶ÔÏó±à³Ì·¨Ôò£¬Äܹ»Ö¸µ¼ÎÒÃÇÈçºÎÉè¼Æ³öËÉñîºÏ¡¢¸üÓÅÁ¼µÄ³ÌÐò¡£ +IoC 是 Inversion of Control 的简写,译为“控制å��转â€�,它ä¸�是一门技术,而是一ç§�设计æ€�想,是一个é‡�è¦�çš„é�¢å�‘对象编程法则,能够指导我们如何设计出æ�¾è€¦å�ˆã€�更优良的程åº�。 -Spring ͨ¹ý IoC ÈÝÆ÷À´¹ÜÀíËùÓÐ Java ¶ÔÏóµÄʵÀý»¯ºÍ³õʼ»¯£¬¿ØÖƶÔÏóÓë¶ÔÏóÖ®¼äµÄÒÀÀµ¹ØÏµ¡£ÎÒÃǽ«ÓÉ IoC ÈÝÆ÷¹ÜÀíµÄ Java ¶ÔÏó³ÆÎª Spring Bean£¬ËüÓëʹÓùؼü×Ö new ´´½¨µÄ Java ¶ÔÏóûÓÐÈκÎÇø±ð¡£ +Spring 通过 IoC 容器æ�¥ç®¡ç�†æ‰€æœ‰ Java 对象的实例化和åˆ�始化,控制对象与对象之间的ä¾�赖关系。我们将由 IoC 容器管ç�†çš„ Java 对象称为 Spring Bean,它与使用关键字 new 创建的 Java 对象没有任何区别。 -IoC ÈÝÆ÷ÊÇ Spring ¿ò¼ÜÖÐ×îÖØÒªµÄºËÐÄ×é¼þÖ®Ò»£¬Ëü¹á´©ÁË Spring ´Óµ®Éúµ½³É³¤µÄÕû¸ö¹ý³Ì¡£ +IoC 容器是 Spring 框架中最é‡�è¦�的核心组件之一,它贯穿了 Spring 从诞生到æˆ�长的整个过程。 -## ¿ØÖÆ·´×ª£¨IoC£© +## 控制å��转(IoC) -ÔÚ´«Í³µÄ Java Ó¦ÓÃÖУ¬Ò»¸öÀàÏëÒªµ÷ÓÃÁíÒ»¸öÀàÖеÄÊôÐÔ»ò·½·¨£¬Í¨³£»áÏÈÔÚÆä´úÂëÖÐͨ¹ý new Object() µÄ·½Ê½½«ºóÕߵĶÔÏó´´½¨³öÀ´£¬È»ºó²ÅÄÜʵÏÖÊôÐÔ»ò·½·¨µÄµ÷Óá£ÎªÁË·½±ãÀí½âºÍÃèÊö£¬ÎÒÃÇ¿ÉÒÔ½«Ç°Õß³ÆÎª¡°µ÷ÓÃÕß¡±£¬½«ºóÕß³ÆÎª¡°±»µ÷ÓÃÕß¡±¡£Ò²¾ÍÊÇ˵£¬µ÷ÓÃÕßÕÆÎÕ×ű»µ÷ÓÃÕß¶ÔÏó´´½¨µÄ¿ØÖÆÈ¨¡£ +在传统的 Java 应用中,一个类想è¦�调用å�¦ä¸€ä¸ªç±»ä¸­çš„属性或方法,通常会先在其代ç �中通过 new Object() 的方å¼�å°†å�Žè€…的对象创建出æ�¥ï¼Œç„¶å�Žæ‰�能实现属性或方法的调用。为了方便ç�†è§£å’Œæ��述,我们å�¯ä»¥å°†å‰�者称为“调用者â€�,将å�Žè€…称为“被调用者â€�。也就是说,调用者掌æ�¡ç�€è¢«è°ƒç”¨è€…对象创建的控制æ�ƒã€‚ -µ«ÔÚ Spring Ó¦ÓÃÖУ¬Java ¶ÔÏó´´½¨µÄ¿ØÖÆÈ¨ÊÇÕÆÎÕÔÚ IoC ÈÝÆ÷ÊÖÀïµÄ£¬Æä´óÖ²½ÖèÈçÏ¡£ +但在 Spring 应用中,Java 对象创建的控制æ�ƒæ˜¯æŽŒæ�¡åœ¨ IoC 容器手里的,其大致步骤如下。 -¿ª·¢ÈËԱͨ¹ý XML ÅäÖÃÎļþ¡¢×¢½â¡¢Java ÅäÖÃÀàµÈ·½Ê½£¬¶Ô Java ¶ÔÏó½øÐж¨Ò壬ÀýÈçÔÚ XML ÅäÖÃÎļþÖÐʹÓà ±êÇ©¡¢ÔÚ Java ÀàÉÏʹÓà @Component ×¢½âµÈ¡£ -Spring Æô¶¯Ê±£¬IoC ÈÝÆ÷»á×Ô¶¯¸ù¾Ý¶ÔÏó¶¨Ò壬½«ÕâЩ¶ÔÏó´´½¨²¢¹ÜÀíÆðÀ´¡£ÕâЩ±» IoC ÈÝÆ÷´´½¨²¢¹ÜÀíµÄ¶ÔÏó±»³ÆÎª Spring Bean¡£ -µ±ÎÒÃÇÏëҪʹÓÃij¸ö Bean ʱ£¬¿ÉÒÔÖ±½Ó´Ó IoC ÈÝÆ÷ÖлñÈ¡£¨ÀýÈçͨ¹ý ApplicationContext µÄ getBean() ·½·¨£©£¬¶ø²»ÐèÒªÊÖ¶¯Í¨¹ý´úÂ루ÀýÈç new Obejct() µÄ·½Ê½£©´´½¨¡£ +å¼€å�‘人员通过 XML é…�置文件ã€�注解ã€�Java é…�置类等方å¼�,对 Java 对象进行定义,例如在 XML é…�置文件中使用 标签ã€�在 Java 类上使用 @Component 注解等。 +Spring å�¯åŠ¨æ—¶ï¼ŒIoC 容器会自动根æ�®å¯¹è±¡å®šä¹‰ï¼Œå°†è¿™äº›å¯¹è±¡åˆ›å»ºå¹¶ç®¡ç�†èµ·æ�¥ã€‚这些被 IoC 容器创建并管ç�†çš„对象被称为 Spring Bean。 +当我们想è¦�使用æŸ�个 Bean 时,å�¯ä»¥ç›´æŽ¥ä»Ž IoC 容器中获å�–(例如通过 ApplicationContext çš„ getBean() 方法),而ä¸�需è¦�手动通过代ç �(例如 new Obejct() 的方å¼�)创建。 -IoC ´øÀ´µÄ×î´ó¸Ä±ä²»ÊÇ´úÂë²ãÃæµÄ£¬¶øÊÇ´Ó˼Ïë²ãÃæÉÏ·¢ÉúÁË¡°Ö÷´Ó»»Î»¡±µÄ¸Ä±ä¡£Ô­±¾µ÷ÓÃÕßÊÇÖ÷¶¯µÄÒ»·½£¬ËüÏëҪʹÓÃʲô×ÊÔ´¾Í»áÖ÷¶¯³ö»÷£¬×Ô¼º´´½¨£»µ«ÔÚ Spring Ó¦ÓÃÖУ¬IoC ÈÝÆ÷ÕÆÎÕ×ÅÖ÷¶¯È¨£¬µ÷ÓÃÕßÔò±ä³ÉÁ˱»¶¯µÄÒ»·½£¬±»¶¯µÄµÈ´ý IoC ÈÝÆ÷´´½¨ËüËùÐèÒªµÄ¶ÔÏó£¨Bean£©¡£ +IoC 带æ�¥çš„æœ€å¤§æ”¹å�˜ä¸�是代ç �层é�¢çš„,而是从æ€�想层é�¢ä¸Šå�‘生了“主从æ�¢ä½�â€�的改å�˜ã€‚原本调用者是主动的一方,它想è¦�使用什么资æº�就会主动出击,自己创建;但在 Spring 应用中,IoC 容器掌æ�¡ç�€ä¸»åЍæ�ƒï¼Œè°ƒç”¨è€…则å�˜æˆ�了被动的一方,被动的等待 IoC 容器创建它所需è¦�的对象(Bean)。 -Õâ¸ö¹ý³ÌÔÚÖ°Ôð²ãÃæ·¢ÉúÁË¿ØÖÆÈ¨µÄ·´×ª£¬°ÑÔ­±¾µ÷ÓÃÕßͨ¹ý´úÂëʵÏֵĶÔÏóµÄ´´½¨£¬·´×ª¸ø IoC ÈÝÆ÷À´°ïæʵÏÖ£¬Òò´ËÎÒÃǽ«Õâ¸ö¹ý³Ì³ÆÎª Spring µÄ¡°¿ØÖÆ·´×ª¡±¡£ +这个过程在è�Œè´£å±‚é�¢å�‘生了控制æ�ƒçš„å��转,把原本调用者通过代ç �实现的对象的创建,å��转给 IoC 容器æ�¥å¸®å¿™å®žçŽ°ï¼Œå› æ­¤æˆ‘ä»¬å°†è¿™ä¸ªè¿‡ç¨‹ç§°ä¸º Spring 的“控制å��转â€�。 -## ÒÀÀµ×¢È루DI£© +## ä¾�赖注入(DI) -ÔÚÁ˽âÁË IoC Ö®ºó£¬ÎÒÃÇ»¹ÐèÒªÁ˽âÁíÍâÒ»¸ö·Ç³£ÖØÒªµÄ¸ÅÄÒÀÀµ×¢Èë¡£ +在了解了 IoC 之å�Žï¼Œæˆ‘们还需è¦�了解å�¦å¤–一个é�žå¸¸é‡�è¦�的概念:ä¾�赖注入。 -ÒÀÀµ×¢È루Denpendency Injection£¬¼òдΪ DI£©ÊÇ Martin Fowler ÔÚ 2004 ÄêÔÚ¶Ô¡°¿ØÖÆ·´×ª¡±½øÐнâÊÍʱÌá³öµÄ¡£Martin Fowler ÈÏΪ¡°¿ØÖÆ·´×ª¡±Ò»´ÊºÜ»Þɬ£¬ÎÞ·¨ÈÃÈ˺ÜÖ±½ÓµÄÀí½â¡°µ½µ×ÊÇÄÄÀﷴתÁË¡±£¬Òò´ËËû½¨ÒéʹÓá°ÒÀÀµ×¢È롱À´´úÌæ¡°¿ØÖÆ·´×ª¡±¡£ +ä¾�赖注入(Denpendency Injection,简写为 DI)是 Martin Fowler 在 2004 年在对“控制å��转â€�进行解释时æ��出的。Martin Fowler 认为“控制å��转â€�一è¯�很晦涩,无法让人很直接的ç�†è§£â€œåˆ°åº•是哪里å��转了â€�,因此他建议使用“ä¾�赖注入â€�æ�¥ä»£æ›¿â€œæŽ§åˆ¶å��转â€�。 -ÔÚÃæÏò¶ÔÏóÖУ¬¶ÔÏóºÍ¶ÔÏóÖ®¼äÊÇ´æÔÚÒ»ÖÖ½Ð×ö¡°ÒÀÀµ¡±µÄ¹ØÏµ¡£¼òµ¥À´Ëµ£¬ÒÀÀµ¹ØÏµ¾ÍÊÇÔÚÒ»¸ö¶ÔÏóÖÐÐèÒªÓõ½ÁíÍâÒ»¸ö¶ÔÏ󣬼´¶ÔÏóÖдæÔÚÒ»¸öÊôÐÔ£¬¸ÃÊôÐÔÊÇÁíÍâÒ»¸öÀàµÄ¶ÔÏó¡£ +在é�¢å�‘对象中,对象和对象之间是存在一ç§�å�«å�šâ€œä¾�èµ–â€�的关系。简å�•æ�¥è¯´ï¼Œä¾�赖关系就是在一个对象中需è¦�用到å�¦å¤–一个对象,å�³å¯¹è±¡ä¸­å­˜åœ¨ä¸€ä¸ªå±žæ€§ï¼Œè¯¥å±žæ€§æ˜¯å�¦å¤–一个类的对象。 -ÀýÈ磬ÓÐÒ»¸öÃûΪ B µÄ Java À࣬ËüµÄ´úÂëÈçÏ¡£ +例如,有一个å��为 B çš„ Java 类,它的代ç �如下。 @@ -45,42 +45,42 @@ A a; -´Ó´úÂë¿ÉÒÔ¿´³ö£¬B ÖдæÔÚÒ»¸ö A ÀàÐ͵ĶÔÏóÊôÐÔ a£¬´ËʱÎÒÃǾͿÉÒÔ˵ B µÄ¶ÔÏóÒÀÀµÓÚ¶ÔÏó a¡£¶øÒÀÀµ×¢Èë¾ÍÊǾÍÊÇ»ùÓÚÕâÖÖ¡°ÒÀÀµ¹ØÏµ¡±¶ø²úÉúµÄ¡£ +从代ç �å�¯ä»¥çœ‹å‡ºï¼ŒB 中存在一个 A 类型的对象属性 a,此时我们就å�¯ä»¥è¯´ B 的对象ä¾�赖于对象 a。而ä¾�赖注入就是就是基于这ç§�“ä¾�赖关系â€�而产生的。 -ÎÒÃÇÖªµÀ£¬¿ØÖÆ·´×ªºËÐÄ˼Ïë¾ÍÊÇÓÉ Spring ¸ºÔð¶ÔÏóµÄ´´½¨¡£ÔÚ¶ÔÏó´´½¨¹ý³ÌÖУ¬Spring »á×Ô¶¯¸ù¾ÝÒÀÀµ¹ØÏµ£¬½«ËüÒÀÀµµÄ¶ÔÏó×¢Èëµ½µ±Ç°¶ÔÏóÖУ¬Õâ¾ÍÊÇËùνµÄ¡°ÒÀÀµ×¢È롱¡£ +我们知é�“,控制å��转核心æ€�想就是由 Spring 负责对象的创建。在对象创建过程中,Spring 会自动根æ�®ä¾�赖关系,将它ä¾�赖的对象注入到当å‰�对象中,这就是所谓的“ä¾�赖注入â€�。 -ÒÀÀµ×¢Èë±¾ÖÊÉÏÊÇ [Spring Bean ÊôÐÔ×¢Èë](http://c.biancheng.net/spring/attr-injection.html)µÄÒ»ÖÖ£¬Ö»²»¹ýÕâ¸öÊôÐÔÊÇÒ»¸ö¶ÔÏóÊôÐÔ¶øÒÑ¡£ +ä¾�赖注入本质上是 [Spring Bean 属性注入](http://c.biancheng.net/spring/attr-injection.html)的一ç§�,å�ªä¸�过这个属性是一个对象属性而已。 -## IoC µÄ¹¤×÷Ô­Àí +## IoC 的工作原ç�† -ÔÚ Java Èí¼þ¿ª·¢¹ý³ÌÖУ¬ÏµÍ³Öеĸ÷¸ö¶ÔÏóÖ®¼ä¡¢¸÷¸öÄ£¿éÖ®¼ä¡¢Èí¼þϵͳºÍÓ²¼þϵͳ֮¼ä£¬»ò¶à»òÉÙ¶¼´æÔÚÒ»¶¨µÄñîºÏ¹ØÏµ¡£ +在 Java 软件开å�‘过程中,系统中的å�„个对象之间ã€�å�„个模å�—之间ã€�软件系统和硬件系统之间,或多或少都存在一定的耦å�ˆå…³ç³»ã€‚ -ÈôÒ»¸öϵͳµÄñîºÏ¶È¹ý¸ß£¬ÄÇô¾Í»áÔì³ÉÄÑÒÔά»¤µÄÎÊÌ⣬µ«ÍêȫûÓÐñîºÏµÄ´úÂ뼸ºõÎÞ·¨Íê³ÉÈκι¤×÷£¬ÕâÊÇÓÉÓÚ¼¸ºõËùÓеŦÄܶ¼ÐèÒª´úÂëÖ®¼äÏ໥Э×÷¡¢Ï໥ÒÀÀµ²ÅÄÜÍê³É¡£Òò´ËÎÒÃÇÔÚ³ÌÐòÉè¼ÆÊ±£¬Ëù±ü³ÐµÄ˼ÏëÒ»°ã¶¼ÊÇÔÚ²»Ó°Ïìϵͳ¹¦ÄܵÄǰÌáÏ£¬×î´óÏ޶ȵĽµµÍñîºÏ¶È¡£ +若一个系统的耦å�ˆåº¦è¿‡é«˜ï¼Œé‚£ä¹ˆå°±ä¼šé€ æˆ�难以维护的问题,但完全没有耦å�ˆçš„代ç �几乎无法完æˆ�任何工作,这是由于几乎所有的功能都需è¦�代ç �之间相互å��作ã€�相互ä¾�èµ–æ‰�能完æˆ�。因此我们在程åº�设计时,所秉承的æ€�想一般都是在ä¸�å½±å“�系统功能的å‰�æ��下,最大é™�度的é™�低耦å�ˆåº¦ã€‚ -IoC µ×²ãͨ¹ý¹¤³§Ä£Ê½¡¢Java µÄ·´Éä»úÖÆ¡¢XML ½âÎöµÈ¼¼Êõ£¬½«´úÂëµÄñîºÏ¶È½µµÍµ½×îµÍÏÞ¶È£¬ÆäÖ÷Òª²½ÖèÈçÏ¡£ +IoC 底层通过工厂模å¼�ã€�Java çš„å��射机制ã€�XML è§£æž�等技术,将代ç �的耦å�ˆåº¦é™�低到最低é™�度,其主è¦�步骤如下。 -ÔÚÅäÖÃÎļþ£¨ÀýÈç Bean.xml£©ÖУ¬¶Ô¸÷¸ö¶ÔÏóÒÔ¼°ËüÃÇÖ®¼äµÄÒÀÀµ¹ØÏµ½øÐÐÅäÖã» -ÎÒÃÇ¿ÉÒÔ°Ñ IoC ÈÝÆ÷µ±×öÒ»¸ö¹¤³§£¬Õâ¸ö¹¤³§µÄ²úÆ·¾ÍÊÇ Spring Bean£» -ÈÝÆ÷Æô¶¯Ê±»á¼ÓÔØ²¢½âÎöÕâЩÅäÖÃÎļþ£¬µÃµ½¶ÔÏóµÄ»ù±¾ÐÅÏ¢ÒÔ¼°ËüÃÇÖ®¼äµÄÒÀÀµ¹ØÏµ£» -IoC ÀûÓà Java µÄ·´Éä»úÖÆ£¬¸ù¾ÝÀàÃûÉú³ÉÏàÓ¦µÄ¶ÔÏ󣨼´ Spring Bean£©£¬²¢¸ù¾ÝÒÀÀµ¹ØÏµ½«Õâ¸ö¶ÔÏó×¢Èëµ½ÒÀÀµËüµÄ¶ÔÏóÖС£ +在é…�置文件(例如 Bean.xml)中,对å�„个对象以å�Šå®ƒä»¬ä¹‹é—´çš„ä¾�赖关系进行é…�置; +我们å�¯ä»¥æŠŠ IoC 容器当å�šä¸€ä¸ªå·¥åŽ‚ï¼Œè¿™ä¸ªå·¥åŽ‚çš„äº§å“�就是 Spring Beanï¼› +容器å�¯åŠ¨æ—¶ä¼šåŠ è½½å¹¶è§£æž�这些é…�置文件,得到对象的基本信æ�¯ä»¥å�Šå®ƒä»¬ä¹‹é—´çš„ä¾�赖关系; +IoC 利用 Java çš„å��射机制,根æ�®ç±»å��生æˆ�相应的对象(å�³ Spring Bean),并根æ�®ä¾�赖关系将这个对象注入到ä¾�赖它的对象中。 -ÓÉÓÚ¶ÔÏóµÄ»ù±¾ÐÅÏ¢¡¢¶ÔÏóÖ®¼äµÄÒÀÀµ¹ØÏµ¶¼ÊÇÔÚÅäÖÃÎļþÖж¨ÒåµÄ£¬²¢Ã»ÓÐÔÚ´úÂëÖнôÃÜñîºÏ£¬Òò´Ë¼´Ê¹¶ÔÏó·¢Éú¸Ä±ä£¬ÎÒÃÇÒ²Ö»ÐèÒªÔÚÅäÖÃÎļþÖнøÐÐÐ޸ļ´¿É£¬¶øÎÞÐë¶Ô Java ´úÂë½øÐÐÐ޸ģ¬Õâ¾ÍÊÇ Spring IoC ʵÏÖ½âñîµÄÔ­Àí¡£ +由于对象的基本信æ�¯ã€�对象之间的ä¾�赖关系都是在é…�置文件中定义的,并没有在代ç �中紧密耦å�ˆï¼Œå› æ­¤å�³ä½¿å¯¹è±¡å�‘生改å�˜ï¼Œæˆ‘们也å�ªéœ€è¦�在é…�置文件中进行修改å�³å�¯ï¼Œè€Œæ— é¡»å¯¹ Java 代ç �进行修改,这就是 Spring IoC 实现解耦的原ç�†ã€‚ -## IoC ÈÝÆ÷µÄÁ½ÖÖʵÏÖ +## IoC 容器的两ç§�实现 -IoC ˼Ïë»ùÓÚ IoC ÈÝÆ÷ʵÏֵģ¬IoC ÈÝÆ÷µ×²ãÆäʵ¾ÍÊÇÒ»¸ö Bean ¹¤³§¡£Spring ¿ò¼ÜΪÎÒÃÇÌṩÁËÁ½ÖÖ²»Í¬ÀàÐÍ IoC ÈÝÆ÷£¬ËüÃÇ·Ö±ðÊÇ BeanFactory ºÍ ApplicationContext¡£ +IoC æ€�想基于 IoC 容器实现的,IoC 容器底层其实就是一个 Bean 工厂。Spring 框架为我们æ��供了两ç§�ä¸�å�Œç±»åž‹ IoC 容器,它们分别是 BeanFactory å’Œ ApplicationContext。 ### BeanFactory -BeanFactory ÊÇ IoC ÈÝÆ÷µÄ»ù±¾ÊµÏÖ£¬Ò²ÊÇ Spring ÌṩµÄ×î¼òµ¥µÄ IoC ÈÝÆ÷£¬ËüÌṩÁË IoC ÈÝÆ÷×î»ù±¾µÄ¹¦ÄÜ£¬ÓÉ org.springframework.beans.factory.BeanFactory ½Ó¿Ú¶¨Òå¡£ +BeanFactory 是 IoC 容器的基本实现,也是 Spring æ��供的最简å�•çš„ IoC 容器,它æ��供了 IoC 容器最基本的功能,由 org.springframework.beans.factory.BeanFactory 接å�£å®šä¹‰ã€‚ -BeanFactory ²ÉÓÃÀÁ¼ÓÔØ£¨lazy-load£©»úÖÆ£¬ÈÝÆ÷ÔÚ¼ÓÔØÅäÖÃÎļþʱ²¢²»»áÁ¢¿Ì´´½¨ Java ¶ÔÏó£¬Ö»ÓгÌÐòÖлñÈ¡£¨Ê¹Óã©Õâ¸ö¶Ô¶ÔÏóʱ²Å»á´´½¨¡£ +BeanFactory 采用懒加载(lazy-load)机制,容器在加载é…�置文件时并ä¸�会立刻创建 Java 对象,å�ªæœ‰ç¨‹åº�中获å�–(使用)这个对对象时æ‰�会创建。 -#### ʾÀý 1 +#### 示例 1 -ÏÂÃæÎÒÃÇͨ¹ýÒ»¸öʵÀýÑÝʾ£¬À´ÑÝʾÏ BeanFactory µÄʹÓᣠ+下é�¢æˆ‘们通过一个实例演示,æ�¥æ¼”示下 BeanFactory 的使用。 -1\. ÔÚ HelloSpring ÏîÄ¿ÖУ¬½« MainApp µÄ´úÂëÐÞ¸ÄΪʹÓà BeanFactory »ñÈ¡ HelloWorld µÄ¶ÔÏ󣬾ßÌå´úÂëÈçÏ¡£ +1\. 在 HelloSpring 项目中,将 MainApp 的代ç �修改为使用 BeanFactory 获å�– HelloWorld 的对象,具体代ç �如下。 @@ -100,30 +100,30 @@ obj.getMessage(); -2. ÔËÐÐ MainApp.java£¬¿ØÖÆÌ¨Êä³öÈçÏ¡£ +2. è¿�行 MainApp.java,控制å�°è¾“出如下。 message : Hello World! -> ×¢Ò⣺BeanFactory ÊÇ Spring ÄÚ²¿Ê¹Óýӿڣ¬Í¨³£Çé¿öϲ»Ìṩ¸ø¿ª·¢ÈËԱʹÓᣠ+> 注æ„�:BeanFactory 是 Spring 内部使用接å�£ï¼Œé€šå¸¸æƒ…况下ä¸�æ��供给开å�‘人员使用。 ### ApplicationContext -ApplicationContext ÊÇ BeanFactory ½Ó¿ÚµÄ×Ó½Ó¿Ú£¬ÊÇ¶Ô BeanFactory µÄÀ©Õ¹¡£ApplicationContext ÔÚ BeanFactory µÄ»ù´¡ÉÏÔö¼ÓÁËÐí¶àÆóÒµ¼¶µÄ¹¦ÄÜ£¬ÀýÈç AOP£¨ÃæÏòÇÐÃæ±à³Ì£©¡¢¹ú¼Ê»¯¡¢ÊÂÎñÖ§³ÖµÈ¡£ +ApplicationContext 是 BeanFactory 接å�£çš„å­�接å�£ï¼Œæ˜¯å¯¹ BeanFactory 的扩展。ApplicationContext 在 BeanFactory 的基础上增加了许多ä¼�业级的功能,例如 AOP(é�¢å�‘切é�¢ç¼–程)ã€�国际化ã€�事务支æŒ�等。 -ApplicationContext ½Ó¿ÚÓÐÁ½¸ö³£ÓõÄʵÏÖÀ࣬¾ßÌåÈçÏÂ±í¡£ +ApplicationContext 接å�£æœ‰ä¸¤ä¸ªå¸¸ç”¨çš„实现类,具体如下表。 -| ʵÏÖÀà | ÃèÊö | ʾÀý´úÂë | +| 实现类 | æ��è¿° | 示例代ç � | | --- | --- | --- | -| ClassPathXmlApplicationContext | ¼ÓÔØÀà·¾¶ ClassPath ÏÂÖ¸¶¨µÄ XML ÅäÖÃÎļþ£¬²¢Íê³É ApplicationContext µÄʵÀý»¯¹¤×÷ | ApplicationContext applicationContext = new ClassPathXmlApplicationContext(String configLocation); | -| FileSystemXmlApplicationContext | ¼ÓÔØÖ¸¶¨µÄÎļþϵͳ·¾¶ÖÐÖ¸¶¨µÄ XML ÅäÖÃÎļþ£¬²¢Íê³É ApplicationContext µÄʵÀý»¯¹¤×÷ | ApplicationContext applicationContext = new FileSystemXmlApplicationContext(String configLocation); | +| ClassPathXmlApplicationContext | 加载类路径 ClassPath 下指定的 XML é…�置文件,并完æˆ� ApplicationContext 的实例化工作 | ApplicationContext applicationContext = new ClassPathXmlApplicationContext(String configLocation); | +| FileSystemXmlApplicationContext | 加载指定的文件系统路径中指定的 XML é…�置文件,并完æˆ� ApplicationContext 的实例化工作 | ApplicationContext applicationContext = new FileSystemXmlApplicationContext(String configLocation); | -> ÔÚÉϱíµÄʾÀý´úÂëÖУ¬²ÎÊý configLocation ÓÃÓÚÖ¸¶¨ Spring ÅäÖÃÎļþµÄÃû³ÆºÍλÖã¬Èç Beans.xml¡£ +> 在上表的示例代ç �中,å�‚æ•° configLocation 用于指定 Spring é…�置文件的å��ç§°å’Œä½�置,如 Beans.xml。 -#### ʾÀý 2 +#### 示例 2 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý£¬À´ÑÝʾ ApplicationContext µÄʹÓᣠ+下é�¢æˆ‘们就通过一个实例,æ�¥æ¼”示 ApplicationContext 的使用。 -1. ÐÞ¸Ä HelloSpring ÏîÄ¿ MainApp ÀàÖÐ main() ·½·¨µÄ´úÂ룬¾ßÌå´úÂëÈçÏ¡£ +1. 修改 HelloSpring 项目 MainApp 类中 main() 方法的代ç �,具体代ç �如下。 @@ -132,7 +132,7 @@ ApplicationContext ```` public static void main(String[] args) { -//ʹÓà FileSystemXmlApplicationContext ¼ÓÔØÖ¸¶¨Â·¾¶ÏµÄÅäÖÃÎļþ Bean.xml +//使用 FileSystemXmlApplicationContext 加载指定路径下的é…�置文件 Bean.xml BeanFactory context = new FileSystemXmlApplicationContext("D:\\eclipe workspace\\spring workspace\\HelloSpring\\src\\Beans.xml"); HelloWorld obj = context.getBean("helloWorld", HelloWorld.class); obj.getMessage(); @@ -144,11 +144,11 @@ obj.getMessage(); -2. ÔËÐÐ MainApp.java£¬¿ØÖÆÌ¨Êä³öÈçÏ¡£ +2. è¿�行 MainApp.java,控制å�°è¾“出如下。 message : Hello World! -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.w3cschool.cn/wkspring https://www.runoob.com/w3cnote/basic-knowledge-summary-of-spring.html http://codepub.cn/2015/06/21/Basic-knowledge-summary-of-Spring diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\270\270\350\247\201\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\270\270\350\247\201\346\263\250\350\247\243.md" index c5b2238..b016c40 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\270\270\350\247\201\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\345\270\270\350\247\201\346\263\250\350\247\243.md" @@ -1,25 +1,25 @@ -# Spring×¢½â -## 1 ¸ÅÊö +# Spring注解 +## 1 概述 -ÎÒÃǶ¼ÖªµÀSpring×îºËÐĵÄÌØÐÔ¾ÍÊÇIOC+AOP£¬IOCµÄÔ­Àí¾ÍÊÇʵÏÖÁËÒ»¸öSpringÈÝÆ÷£¬ÓÃÀ´¹ÜÀíËùÓÐSpring BeanʵÀý -DI£¬Ò²¾ÍÊÇÒÀÀµ×¢È룬ÊÇÎÒÃÇ×÷Ϊ¿ª·¢ÕßÐèÒª¹ØÐĵĺËÐÄ»°Ì⣬ÈçºÎ×¢ÈëÒÀÀµ£¬×¢ÈëÄĸöÒÀÀµ£¬ÊÇÎÒÃÇÐèÒªÃ÷È·ÖªµÀµÄ¡£ -ÔÚÒÔǰ£¬ÎÒÃÇϰ¹ßÓÚÓÃxmlÅäÖÃÎļþÀ´ÉùÃ÷Ò»¸öbean£¬µ«ÏÖÔÚ£¬ÎÒÃǸü¶àµØÊ¹ÓÃ×¢½âºÍ´úÂëÀ´Íê³ÉDIµÄ¹ý³Ì +我们都知é�“Spring最核心的特性就是IOC+AOP,IOC的原ç�†å°±æ˜¯å®žçŽ°äº†ä¸€ä¸ªSpring容器,用æ�¥ç®¡ç�†æ‰€æœ‰Spring Bean实例 +DI,也就是ä¾�赖注入,是我们作为开å�‘者需è¦�关心的核心è¯�题,如何注入ä¾�赖,注入哪个ä¾�赖,是我们需è¦�明确知é�“的。 +在以å‰�,我们习惯于用xmlé…�置文件æ�¥å£°æ˜Žä¸€ä¸ªbean,但现在,我们更多地使用注解和代ç �æ�¥å®Œæˆ�DI的过程 -ÎÒÃÇ¿ÉÒÔʹÓà org.springframework.beans.factory.annotation ºÍ org.springframework.context.annotation °üÖеÄ×¢ÊÍÀ´ÆôÓà Spring DI ÒýÇæµÄ¹¦ÄÜ¡£ +我们å�¯ä»¥ä½¿ç”¨ org.springframework.beans.factory.annotation å’Œ org.springframework.context.annotation 包中的注释æ�¥å�¯ç”¨ Spring DI 引擎的功能。 -ÎÒÃÇͨ³£½«ÕâЩ³ÆÎª¡°Spring ºËÐÄ×¢ÊÍ¡±£¬ÎÒÃǽ«ÔÚ±¾½Ì³ÌÖÐ¶ÔÆä½øÐлعˡ£ +我们通常将这些称为“Spring 核心注释â€�,我们将在本教程中对其进行回顾。 -## 2 DIÏà¹Ø×¢½â +## 2 DI相关注解 ### 2.1 @Autowired -ÎÒÃÇ¿ÉÒÔʹÓà @Autowired À´±ê¼Ç Spring ½«Òª½âÎöºÍ×¢ÈëµÄÒÀÀµÏî¡£ -ÎÒÃÇ¿ÉÒÔ½«´Ë×¢ÊÍÓë¹¹Ô캯Êý¡¢setter »ò×Ö¶Î×¢ÈëÒ»ÆðʹÓᣠ+我们å�¯ä»¥ä½¿ç”¨ @Autowired æ�¥æ ‡è®° Spring å°†è¦�è§£æž�和注入的ä¾�赖项。 +我们å�¯ä»¥å°†æ­¤æ³¨é‡Šä¸Žæž„造函数ã€�setter 或字段注入一起使用。 Constructor injection: -**¹¹ÔìÆ÷×¢Èë** +**构造器注入** ```` class Car { @@ -32,7 +32,7 @@ class Car { } ```` -**Setter×¢Èë** +**Setter注入** ```` class Car { Engine engine; @@ -43,7 +43,7 @@ class Car { } } ```` -**±äÁ¿×¢Èë** +**å�˜é‡�注入** ```` class Car { @Autowired @@ -51,17 +51,17 @@ class Car { } ```` -@Autowired ÓÐÒ»¸öÃûΪ required µÄ²¼¶û²ÎÊý£¬Ä¬ÈÏֵΪ true¡£ +@Autowired 有一个å��为 required 的布尔å�‚数,默认值为 true。 -µ±ËüÕÒ²»µ½ºÏÊ浀 bean À´Á¬½Óʱ£¬Ëü»áµ÷Õû Spring µÄÐÐΪ¡£ µ±Îª true ʱ£¬½«Å׳öÒì³££¬·ñÔò²»Á¬½ÓÈκÎÄÚÈÝ¡£ +当它找ä¸�到å�ˆé€‚çš„ bean æ�¥è¿žæŽ¥æ—¶ï¼Œå®ƒä¼šè°ƒæ•´ Spring 的行为。 当为 true 时,将抛出异常,å�¦åˆ™ä¸�连接任何内容。 -Çë×¢Ò⣬Èç¹ûÎÒÃÇʹÓù¹Ô캯Êý×¢È룬ÔòËùÓй¹Ô캯Êý²ÎÊý¶¼ÊÇÇ¿ÖÆÐԵġ£ +请注æ„�,如果我们使用构造函数注入,则所有构造函数å�‚数都是强制性的。 -´Ó 4.3 °æ±¾¿ªÊ¼£¬ÎÒÃDz»ÐèÒªÏÔʽµØÊ¹Óà @Autowired ×¢½â¹¹Ô캯Êý£¬³ý·ÇÎÒÃÇÉùÃ÷ÖÁÉÙÁ½¸ö¹¹Ô캯Êý¡£ +从 4.3 版本开始,我们ä¸�需è¦�显å¼�地使用 @Autowired 注解构造函数,除é�žæˆ‘们声明至少两个构造函数。 ### 2.2 @Bean -@Bean ±ê¼ÇʵÀý»¯ Spring bean µÄ¹¤³§·½·¨£º +@Bean 标记实例化 Spring bean 的工厂方法: ``` @Bean @@ -70,9 +70,9 @@ Engine engine() { } ```` -µ±ÐèÒª·µ»ØÀàÐ͵ÄÐÂʵÀýʱ£¬Spring »áµ÷ÓÃÕâЩ·½·¨¡£ +当需è¦�返回类型的新实例时,Spring 会调用这些方法。 -Éú³ÉµÄ bean Ó빤³§·½·¨Í¬Ãû¡£ Èç¹ûÎÒÃÇÏëÒÔ²»Í¬µÄ·½Ê½ÃüÃû£¬ÎÒÃÇ¿ÉÒÔʹÓôË×¢Ê͵ÄÃû³Æ»òÖµ²ÎÊý£¨²ÎÊýÖµÊDzÎÊýÃû³ÆµÄ±ðÃû£©£º +生æˆ�çš„ bean 与工厂方法å�Œå��。 如果我们想以ä¸�å�Œçš„æ–¹å¼�命å��,我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨é‡Šçš„å��称或值å�‚数(å�‚数值是å�‚æ•°å��称的别å��): ```` @Bean("engine") @@ -80,17 +80,17 @@ Engine getEngine() { return new Engine(); } ```` -ÕâÊÇÒ»Öַdz£³£¼ûµÄbeanÉùÃ÷·½Ê½£¬ÒòΪºÜ¶àµÄbean²¢²»ÊÇÎÒÃÇÒ»¿ªÊ¼¾ÍÔÚ´úÂëÀﶨÒåºÃµÄ£¬Ëü¿ÉÄÜÐèÒª»ùÓÚÔËÐÐʱ»·¾³À´½øÐа´Ðè¹¹½¨¡£ +这是一ç§�é�žå¸¸å¸¸è§�çš„bean声明方å¼�,因为很多的beanå¹¶ä¸�是我们一开始就在代ç �里定义好的,它å�¯èƒ½éœ€è¦�基于è¿�行时环境æ�¥è¿›è¡ŒæŒ‰éœ€æž„建。 -ÎÒÃÇ¿ÉÒÔ×ÔÓɵØÉùÃ÷ºÍ¶¨ÒåBean£¬²¢ÇÒÒ²¿ÉÒÔ¸³ÓèËü×Ô¶¨ÒåµÄbeanÃû³Æ¡£ +我们å�¯ä»¥è‡ªç”±åœ°å£°æ˜Žå’Œå®šä¹‰Bean,并且也å�¯ä»¥èµ‹äºˆå®ƒè‡ªå®šä¹‰çš„beanå��称。 -×¢Ò⣬ËùÓÐÓÃ@Bean ×¢Ê͵ķ½·¨¶¼±ØÐëÔÚ@Configuration ÀàÖС£ +注æ„�,所有用@Bean 注释的方法都必须在@Configuration 类中。 ### 2.3 @Qualifier -ÎÒÃÇʹÓÃ@Qualifier ºÍ@Autowired À´ÌṩÎÒÃÇÏëÒªÔÚ²»Ã÷È·Çé¿öÏÂʹÓõÄbean id »òbean Ãû³Æ¡£ +我们使用@Qualifier å’Œ@Autowired æ�¥æ��供我们想è¦�在ä¸�明确情况下使用的bean id 或bean å��称。 -ÀýÈ磬ÒÔÏÂÁ½¸ö bean ʵÏÖÏàͬµÄ½Ó¿Ú£º +例如,以下两个 bean 实现相å�Œçš„æŽ¥å�£ï¼š ```` class Bike implements Vehicle {} @@ -98,9 +98,9 @@ class Car implements Vehicle {} ```` -Èç¹û Spring ÐèҪעÈëÒ»¸ö Vehicle bean£¬Ëü»áÒÔ¶à¸öÆ¥Å䶨Òå½áÊø¡£ ÔÚÕâÖÖÇé¿öÏ£¬ÎÒÃÇ¿ÉÒÔʹÓà @Qualifier ×¢ÊÍÏÔʽÌṩ bean µÄÃû³Æ¡£ +如果 Spring 需è¦�注入一个 Vehicle bean,它会以多个匹é…�定义结æ�Ÿã€‚ 在这ç§�情况下,我们å�¯ä»¥ä½¿ç”¨ @Qualifier 注释显å¼�æ��ä¾› bean çš„å��称。 -**¹¹ÔìÆ÷×¢Èë** +**构造器注入** ```` @Autowired Biker(@Qualifier("bike") Vehicle vehicle) { @@ -108,7 +108,7 @@ this.vehicle = vehicle; } ```` -**Setter×¢Èë** +**Setter注入** ```` @Autowired @@ -116,7 +116,7 @@ void setVehicle(@Qualifier("bike") Vehicle vehicle) { this.vehicle = vehicle; } ```` -»òÕß: +或者: ```` @Autowired @@ -124,18 +124,18 @@ this.vehicle = vehicle; void setVehicle(Vehicle vehicle) { this.vehicle = vehicle; ```` -**±äÁ¿×¢Èë** +**å�˜é‡�注入** ```` @Autowired @Qualifier("bike") Vehicle vehicle; ```` -Õâ¸ö×¢½âÎÒÃÇ¿ÉÄÜÆ½³£ÓõIJ»¶à£¬µ«Êǵ±Ò»¸ö½Ó¿ÚÓжà¸öʵÏÖÀàʱ£¬Ëü¾Í»á¾­³£ÅÉÉÏÓ󡣡 +这个注解我们å�¯èƒ½å¹³å¸¸ç”¨çš„ä¸�多,但是当一个接å�£æœ‰å¤šä¸ªå®žçŽ°ç±»æ—¶ï¼Œå®ƒå°±ä¼šç»�常派上用场ï¼� ### 2.4 @Required -@Required ÔÚ setter ·½·¨Éϱê¼ÇÎÒÃÇÏëҪͨ¹ý XML Ìî³äµÄÒÀÀµÏ +@Required 在 setter 方法上标记我们想è¦�通过 XML å¡«å……çš„ä¾�赖项: ```` @Required void setColor(String color) { @@ -148,22 +148,22 @@ xml ```` -·ñÔò£¬½«Å׳ö BeanInitializationException¡£ -·Ç³£ÉÙ¼ûµÄÓ÷¨£¬ÖªµÀһϾÍÐÐÁË +å�¦åˆ™ï¼Œå°†æŠ›å‡º BeanInitializationException。 +é�žå¸¸å°‘è§�的用法,知é�“一下就行了 ### 2.5 @Value -ÎÒÃÇ¿ÉÒÔʹÓà @Value ½«ÊôÐÔÖµ×¢Èë bean¡£ ËüÓë¹¹Ô캯Êý¡¢setter ºÍ×Ö¶Î×¢Èë¼æÈÝ¡£ +我们å�¯ä»¥ä½¿ç”¨ @Value 将属性值注入 bean。 它与构造函数ã€�setter 和字段注入兼容。 -ÕâÒ²ÊǷdz£³£ÓõÄÒ»¸ö×¢½â£¬ÒòΪÎÒÃǺܶàʱºò¶¼ÐèÒª´Óapplication.properties»òÕ߯äËûÅäÖÃÎļþÖÐÀ´¶ÁÈ¡ÅäÖÃÊôÐÔÖµ¡£ +这也是é�žå¸¸å¸¸ç”¨çš„一个注解,因为我们很多时候都需è¦�从application.properties或者其他é…�置文件中æ�¥è¯»å�–é…�置属性值。 -**¹¹ÔìÆ÷×¢Èë** +**构造器注入** ```` Engine(@Value("8") int cylinderCount) { this.cylinderCount = cylinderCount; } ```` -**setter×¢Èë** +**setter注入** ```` @Autowired @@ -172,7 +172,7 @@ this.cylinderCount = cylinderCount; } ```` -»òÕß: +或者: ```` @Value("8") @@ -181,33 +181,33 @@ this.cylinderCount = cylinderCount; } ```` -**±äÁ¿×¢Èë** +**å�˜é‡�注入** ```` @Value("8") int cylinderCount; ```` -µ±È»£¬×¢È뾲ֵ̬ÊÇûÓÐÓõġ£ Òò´Ë£¬ÎÒÃÇ¿ÉÒÔÔÚ @Value ÖÐʹÓÃռλ·û×Ö·û´®À´Á¬½ÓÔÚÍⲿԴÖж¨ÒåµÄÖµ£¬ÀýÈçÔÚ .properties »ò .yaml ÎļþÖС£ +当然,注入é�™æ€�值是没有用的。 因此,我们å�¯ä»¥åœ¨ @Value 中使用å� ä½�符字符串æ�¥è¿žæŽ¥åœ¨å¤–部æº�中定义的值,例如在 .properties 或 .yaml 文件中。 ```` engine.fuelType=petrol ```` -ÎÒÃÇ¿ÉÒÔͨ¹ýÒÔÏ·½Ê½×¢Èë engine.fuelType µÄÖµ£º +我们å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�注入 engine.fuelType 的值: ```` @Value("${engine.fuelType}") String fuelType; ```` -ÎÒÃÇÉõÖÁ¿ÉÒÔʹÓà SpEL À´Ê¹ÓÃ@Value¡£ ¸ü¶à¸ß¼¶Ê¾Àý¿ÉÒÔÔÚÎÒÃǹØÓÚ@Value µÄÎÄÕÂÖÐÕÒµ½¡£ +我们甚至å�¯ä»¥ä½¿ç”¨ SpEL æ�¥ä½¿ç”¨@Value。 更多高级示例å�¯ä»¥åœ¨æˆ‘们关于@Value 的文章中找到。 ### 2.6 @DependsOn -ÎÒÃÇ¿ÉÒÔʹÓôË×¢½âÈà Spring ÔÚ×¢½âµÄ bean ֮ǰ³õʼ»¯ÆäËû bean¡£ ͨ³££¬´ËÐÐΪÊÇ×Ô¶¯µÄ£¬»ùÓÚ bean Ö®¼äµÄÏÔʽÒÀÀµ¹ØÏµ¡£ +我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨è§£è®© Spring 在注解的 bean 之å‰�åˆ�始化其他 bean。 通常,此行为是自动的,基于 bean 之间的显å¼�ä¾�赖关系。 -ÎÒÃÇÖ»ÓÐÔÚÒÀÀµÊÇÒþʽµÄʱºò²ÅÐèÒªÕâ¸ö×¢½â£¬±ÈÈçJDBCÇý¶¯¼ÓÔØ»òÕß¾²Ì¬±äÁ¿³õʼ»¯¡£ +我们å�ªæœ‰åœ¨ä¾�赖是éš�å¼�的时候æ‰�需è¦�这个注解,比如JDBC驱动加载或者é�™æ€�å�˜é‡�åˆ�始化。 -ÎÒÃÇ¿ÉÒÔÔÚÖ¸¶¨ÒÀÀµ bean Ãû³ÆµÄÒÀÀµÀàÉÏʹÓà @DependsOn¡£ ×¢Ê͵ÄÖµ²ÎÊýÐèÒªÒ»¸ö°üº¬ÒÀÀµ bean Ãû³ÆµÄÊý×飺 +我们å�¯ä»¥åœ¨æŒ‡å®šä¾�èµ– bean å��ç§°çš„ä¾�赖类上使用 @DependsOn。 注释的值å�‚数需è¦�一个包å�«ä¾�èµ– bean å��称的数组: ```` @DependsOn("engine") @@ -222,18 +222,18 @@ return new Engine(); } ```` ### 2.7 @Lazy -µ±ÎÒÃÇÏëÀÁ¶èµØ³õʼ»¯ÎÒÃÇµÄ bean ʱ£¬ÎÒÃÇʹÓà @Lazy¡£ ĬÈÏÇé¿öÏ£¬Spring ÔÚÓ¦ÓóÌÐòÉÏÏÂÎĵįô¶¯/Òýµ¼Ê±¼±Çеش´½¨ËùÓе¥Àý bean¡£ +当我们想懒惰地åˆ�始化我们的 bean 时,我们使用 @Lazy。 默认情况下,Spring 在应用程åº�上下文的å�¯åЍ/引导时急切地创建所有å�•例 bean。 -µ«ÊÇ£¬ÓÐЩÇé¿öÏÂÎÒÃÇÐèÒªÔÚÇëÇóʱ´´½¨ bean£¬¶ø²»ÊÇÔÚÓ¦ÓóÌÐòÆô¶¯Ê±´´½¨¡£ +但是,有些情况下我们需è¦�在请求时创建 bean,而ä¸�是在应用程åº�å�¯åŠ¨æ—¶åˆ›å»ºã€‚ -Õâ¸ö×¢½âµÄÐÐΪ»á¸ù¾ÝÎÒÃÇ·ÅÖÃËüµÄÈ·ÇÐλÖöøÓÐËù²»Í¬¡£ ÎÒÃÇ¿ÉÒÔ°ÑËü·ÅÔÚ£º +这个注解的行为会根æ�®æˆ‘们放置它的确切ä½�置而有所ä¸�å�Œã€‚ 我们å�¯ä»¥æŠŠå®ƒæ”¾åœ¨ï¼š -Ò»¸ö @Bean ×¢Ê굀 bean ¹¤³§·½·¨£¬ÒÔÑÓ³Ù·½·¨µ÷Óã¨Òò´Ë´´½¨ bean£© -@Configuration ÀàºÍËùÓаüº¬µÄ@Bean ·½·¨¶¼»áÊܵ½Ó°Ïì +一个 @Bean 注释的 bean 工厂方法,以延迟方法调用(因此创建 bean) +@Configuration 类和所有包å�«çš„@Bean 方法都会å�—到影å“� -Ò»¸ö @Component À࣬Ëü²»ÊÇ @Configuration À࣬Õâ¸ö bean ½«±»ÑÓ³Ù³õʼ»¯ +一个 @Component 类,它ä¸�是 @Configuration 类,这个 bean 将被延迟åˆ�始化 -@Autowired ¹¹Ô캯Êý¡¢setter »ò×ֶΣ¬ÓÃÓÚÑÓ³Ù¼ÓÔØÒÀÀµÏî±¾Éí£¨Í¨¹ý´úÀí£© +@Autowired 构造函数ã€�setter 或字段,用于延迟加载ä¾�赖项本身(通过代ç�†ï¼‰ ```` @Configuration @@ -247,31 +247,31 @@ class VehicleFactoryConfig { } } ```` -ÕâͬÑù²»ÊÇÒ»¸ö³£ÓõÄ×¢½â¡£ +è¿™å�Œæ ·ä¸�是一个常用的注解。 -µ±ÎÒÃÇά»¤Ò»¸öÓдóÁ¿beanµÄÏîĿʱ£¬»á·¢ÏÖÓкܶàbean¿ÉÄܶ¼Êǰ´ÐèʹÓõ쬲»Ò»¶¨ÐèÒªÔÚÈÝÆ÷³õʼ»¯Ê±¾Í½øÐгõʼ»¯£¬Õâ¿ÉÒÔ°ïÎÒÃǽÚÊ¡ºÜ¶àʱ¼äºÍÐÔÄÜ¡£ +当我们维护一个有大é‡�bean的项目时,会å�‘现有很多beanå�¯èƒ½éƒ½æ˜¯æŒ‰éœ€ä½¿ç”¨çš„,ä¸�一定需è¦�在容器åˆ�始化时就进行åˆ�始化,这å�¯ä»¥å¸®æˆ‘们节çœ�很多时间和性能。 ### 2.8 @Lookup -ͬÑùÊÇÒ»¸ö±È½ÏÉÙÓõ½µÄ×¢½â +å�Œæ ·æ˜¯ä¸€ä¸ªæ¯”较少用到的注解 -@Lookup »á¸æËß Spring ÔÚÎÒÃǵ÷ÓÃËüʱ·µ»Ø·½·¨·µ»ØÀàÐ͵ÄʵÀý¡£ +@Lookup 会告诉 Spring 在我们调用它时返回方法返回类型的实例。 -±¾ÖÊÉÏ£¬Spring ½«¸²¸ÇÎÒÃÇ´ø×¢Ê͵ķ½·¨²¢Ê¹ÓÃÎÒÃÇ·½·¨µÄ·µ»ØÀàÐͺͲÎÊý×÷Ϊ BeanFactory#getBean µÄ²ÎÊý¡£ +本质上,Spring 将覆盖我们带注释的方法并使用我们方法的返回类型和å�‚数作为 BeanFactory#getBean çš„å�‚数。 -@Lookup ÊÊÓÃÓÚ£º +@Lookup 适用于: -½«Ô­ÐÍ bean ×¢ÈëÎÒÃÇ×Ô¼ºµÄbean£¨ÀàËÆÓÚ Provider£© +将原型 bean 注入我们自己的bean(类似于 Provider) -Èç¹ûÎÒÃÇÅöÇɾö¶¨ÓµÓÐÒ»¸öÔ­ÐÍ Spring bean£¬ÄÇôÎÒÃǼ¸ºõ»áÁ¢¼´ÃæÁÙÕâÑùµÄÎÊÌ⣺ +如果我们碰巧决定拥有一个原型 Spring bean,那么我们几乎会立å�³é�¢ä¸´è¿™æ ·çš„问题: -ÎÒÃǵĵ¥Àý Spring bean ½«ÈçºÎ·ÃÎÊÕâЩԭÐÍ Spring bean£¿ +我们的å�•例 Spring bean 将如何访问这些原型 Spring bean? -ÏÖÔÚ£¬Provider ¿Ï¶¨ÊÇÒ»ÖÖ·½Ê½£¬¾¡¹Ü @Lookup ÔÚijЩ·½Ãæ¸ü¼ÓͨÓᣠ+现在,Provider 肯定是一ç§�æ–¹å¼�,尽管 @Lookup 在æŸ�些方é�¢æ›´åŠ é€šç”¨ã€‚ -ҪעÒâµÄÊÇ£¬springĬÈÏʹÓõĵ¥Àýbean£¬ËùÒÔÈç¹ûÎÒÃÇҪעÈëÔ­ÐÍbean£¬ÎÒÃDzÅÐèÒª×öÕâÑùµÄ¶îÍ⹤×÷ +è¦�注æ„�的是,spring默认使用的å�•例bean,所以如果我们è¦�注入原型bean,我们æ‰�需è¦�å�šè¿™æ ·çš„é¢�外工作 -Ê×ÏÈ£¬ÈÃÎÒÃÇ´´½¨Ò»¸öÔ­ÐÍ bean£¬ÉÔºóÎÒÃǽ«Æä×¢Èëµ½µ¥Àý bean ÖУº +首先,让我们创建一个原型 bean,ç¨�å�Žæˆ‘们将其注入到å�•例 bean 中: ```` @Component @Scope("prototype") @@ -279,7 +279,7 @@ public class SchoolNotification { // ... prototype-scoped state } ```` -ʹÓÃ@Lookup£¬ÎÒÃÇ¿ÉÒÔͨ¹ýµ¥Àý bean »ñÈ¡ SchoolNotification µÄʵÀý£º +使用@Lookup,我们å�¯ä»¥é€šè¿‡å�•例 bean 获å�– SchoolNotification 的实例: ```` @Component @@ -307,19 +307,19 @@ StudentServices second = this.context.getBean(StudentServices.class); assertNotEquals(first.getNotification(), second.getNotification()); } ```` -Çë×¢Ò⣬ÔÚ StudentServices ÖУ¬ÎÒÃǽ« getNotification ·½·¨±£ÁôΪ´æ¸ù¡£ +请注æ„�,在 StudentServices 中,我们将 getNotification 方法ä¿�留为存根。 -ÕâÊÇÒòΪ Spring ͨ¹ýµ÷Óà beanFactory.getBean(StudentNotification.class) ¸²¸ÇÁ˸÷½·¨£¬Òò´ËÎÒÃÇ¿ÉÒÔ½«ÆäÁô¿Õ¡£ +这是因为 Spring 通过调用 beanFactory.getBean(StudentNotification.class) 覆盖了该方法,因此我们å�¯ä»¥å°†å…¶ç•™ç©ºã€‚ ### 2.9 @Primary -ÓÐʱÎÒÃÇÐèÒª¶¨Òå¶à¸öÏàͬÀàÐ͵Äbean¡£ ÔÚÕâЩÇé¿öÏ£¬×¢È뽫²»³É¹¦£¬ÒòΪ Spring ²»ÖªµÀÎÒÃÇÐèÒªÄĸö bean¡£ +有时我们需è¦�定义多个相å�Œç±»åž‹çš„bean。 在这些情况下,注入将ä¸�æˆ�功,因为 Spring ä¸�知é�“我们需è¦�哪个 bean。 -ÎÒÃÇÒѾ­¿´µ½ÁË´¦ÀíÕâÖÖÇé¿öµÄÑ¡ÏÓÃ@Qualifier ±ê¼ÇËùÓнÓÏߵ㲢ָ¶¨ËùÐè bean µÄÃû³Æ¡£ +我们已ç»�看到了处ç�†è¿™ç§�情况的选项:用@Qualifier 标记所有接线点并指定所需 bean çš„å��称。 -È»¶ø£¬´ó¶àÊýʱºòÎÒÃÇÐèÒªÒ»¸öÌØ¶¨µÄ bean£¬ºÜÉÙÐèÒªÆäËû bean¡£ +然而,大多数时候我们需è¦�一个特定的 bean,很少需è¦�å…¶ä»– bean。 -ÎÒÃÇ¿ÉÒÔʹÓÃ@Primary À´¼ò»¯ÕâÖÖÇé¿ö£ºÈç¹ûÎÒÃÇÓÃ@Primary ±ê¼Ç×î³£ÓõÄbean£¬Ëü½«ÔÚunqualifiedµÄ×¢ÈëµãÉϱ»Ñ¡Ôñ£º +我们å�¯ä»¥ä½¿ç”¨@Primary æ�¥ç®€åŒ–è¿™ç§�情况:如果我们用@Primary 标记最常用的bean,它将在unqualified的注入点上被选择: ```` @Component @@ -342,15 +342,15 @@ class Biker { Vehicle vehicle; } ```` -ÔÚÇ°ÃæµÄʾÀýÖУ¬Æû³µÊÇÖ÷Òª³µÁ¾¡£ Òò´Ë£¬ÔÚ Driver ÀàÖУ¬Spring ×¢ÈëÁËÒ»¸ö Car bean¡£ µ±È»£¬ÔÚ Biker bean ÖУ¬×Ö¶Î vehicle µÄÖµ½«ÊÇÒ»¸ö Bike ¶ÔÏó£¬ÒòΪËüÊÇqualifiedµÄ¡£ +在å‰�é�¢çš„示例中,汽车是主è¦�车辆。 因此,在 Driver 类中,Spring 注入了一个 Car bean。 当然,在 Biker bean 中,字段 vehicle 的值将是一个 Bike 对象,因为它是qualified的。 ### 2.10 @Scope -¶ÔÓÚͨ³£µÄÓ¦ÓÃÀ´Ëµ£¬ÎÒÃÇbeanµÄscopeĬÈ϶¼Êǵ¥ÀýµÄ£¬µ«Êµ¼ÊÉÏspring bean¿ÉÒÔÖ§³Ö¶àÖÖ¶àÑùµÄ×÷Ó÷¶Î§£¬ËüÃÇÓÐ×Ų»Í¬µÄÉúÃüÖÜÆÚ¡£ +对于通常的应用æ�¥è¯´ï¼Œæˆ‘们beançš„scope默认都是å�•例的,但实际上spring beanå�¯ä»¥æ”¯æŒ�多ç§�多样的作用范围,它们有ç�€ä¸�å�Œçš„生命周期。 -ÎÒÃÇʹÓÃ@Scope À´¶¨Òå@Component Àà»ò@Bean ¶¨ÒåµÄ·¶Î§¡£ Ëü¿ÉÒÔÊǵ¥Àý¡¢Ô­ÐÍ¡¢ÇëÇ󡢻Ự¡¢globalSession »òһЩ×Ô¶¨Ò巶Χ¡£ +我们使用@Scope æ�¥å®šä¹‰@Component 类或@Bean 定义的范围。 它å�¯ä»¥æ˜¯å�•例ã€�原型ã€�请求ã€�会è¯�ã€�globalSession 或一些自定义范围。 -¶ÔÓ¦µÄö¾ÙֵΪ +对应的枚举值为 ```` singleton prototype @@ -360,28 +360,28 @@ application websocket ```` -Àý×Ó +例å­� ```` @Component @Scope("prototype") class Engine {} ```` -ÎÒÃÇ¿ÉÒÔÏëÏóһЩ³¡¾°£¬±ÈÈçrequest¡¢session¡¢websocketÕâÀà×÷ÓÃÓòµÄbean£¬Í¨³£Ó¦¸ÃÊǺÍÍøÂçÇëÇóÏà¹ØµÄ£¬±ÈÈçÓô洢Óû§ÐÅÏ¢¡¢sessionÖ®ÀàµÄbean¡£ +我们å�¯ä»¥æƒ³è±¡ä¸€äº›åœºæ™¯ï¼Œæ¯”如requestã€�sessionã€�websocket这类作用域的bean,通常应该是和网络请求相关的,比如用存储用户信æ�¯ã€�session之类的bean。 -¾ßÌåÔõôʹÓ㬾ÍÒª¸ù¾ÝÄãµÄ¾ßÌ峡¾°À´Ñ¡ÔñÁË£¬Õâ»áÊÇÒ»¸öºÜ´óµÄ»°Ì⣬ÕâÀï¾ÍÏȲ»Õ¹¿ªÁË£¬ÒÔºó¿ÉÒÔÔÚµ¥¶ÀµÄÎÄÕÂÀï¼ÌÐø½éÉÜ¡£ +具体怎么使用,就è¦�æ ¹æ�®ä½ çš„具体场景æ�¥é€‰æ‹©äº†ï¼Œè¿™ä¼šæ˜¯ä¸€ä¸ªå¾ˆå¤§çš„è¯�题,这里就先ä¸�展开了,以å�Žå�¯ä»¥åœ¨å�•独的文章里继续介ç»�。 -## 3 ÉÏÏÂÎÄÅäÖÃ×¢½â -ÎÒÃÇ¿ÉÒÔʹÓñ¾½ÚÖÐÃèÊöµÄ×¢ÊÍÀ´ÅäÖÃÓ¦ÓóÌÐòÉÏÏÂÎÄ¡£ +## 3 上下文é…�置注解 +我们å�¯ä»¥ä½¿ç”¨æœ¬èЂ䏭æ��述的注释æ�¥é…�置应用程åº�上下文。 ### 3.1 @Profile -Èç¹ûÎÒÃÇÏ£Íû Spring ½öÔÚÌØ¶¨ÅäÖÃÎļþ´¦Óڻ״̬ʱʹÓÃ@Component Àà»ò@Bean ·½·¨£¬ÎÒÃÇ¿ÉÒÔʹÓÃ@Profile ¶ÔÆä½øÐбê¼Ç¡£ +如果我们希望 Spring 仅在特定é…�置文件处于活动状æ€�时使用@Component 类或@Bean 方法,我们å�¯ä»¥ä½¿ç”¨@Profile 对其进行标记。 -ÎÒÃÇ¿ÉÒÔʹÓÃ×¢Ê͵ÄÖµ²ÎÊýÅäÖÃÅäÖÃÎļþµÄÃû³Æ£º +我们å�¯ä»¥ä½¿ç”¨æ³¨é‡Šçš„值å�‚æ•°é…�ç½®é…�置文件的å��称: -ÎÒÃÇͨ³£Õâ¸ö×¢½âÀ´ÅäÖò»Í¬»·¾³µÄÅäÖᣠ-±ÈÈçÏÂÃæÕâ¸öÀý×Ó +我们通常这个注解æ�¥é…�ç½®ä¸�å�ŒçŽ¯å¢ƒçš„é…�置。 +比如下é�¢è¿™ä¸ªä¾‹å­� ```` public interface DatasourceConfig { @@ -389,7 +389,7 @@ public void setup(); } ```` -ÏÂÃæÊÇ¿ª·¢»·¾³µÄÅäÖ㺠+下é�¢æ˜¯å¼€å�‘环境的é…�置: ```` @Component @@ -401,7 +401,7 @@ System.out.println("Setting up datasource for DEV environment. "); } } ```` -ÏÂÃæÊÇÉú²ú»·¾³µÄÅäÖ㺠+下é�¢æ˜¯ç”Ÿäº§çŽ¯å¢ƒçš„é…�置: ```` @Component @@ -413,7 +413,7 @@ System.out.println("Setting up datasource for PRODUCTION environment. "); } } ```` -µ±È»ÎÒÃÇÒ²¿ÉÒÔʹÓÃxml»òÕ߯äËûÀàÐ͵ÄÅäÖÃÎļþÀ´ÃèÊöÕâ¸öÅäÖÃbean +当然我们也å�¯ä»¥ä½¿ç”¨xml或者其他类型的é…�置文件æ�¥æ��述这个é…�ç½®bean xml ```` @@ -424,11 +424,11 @@ xml ```` ### 3.2 @Import -ÎÒÃÇ¿ÉÒÔʹÓÃÌØ¶¨µÄ @Configuration À࣬¶øÎÞÐèʹÓôË×¢½â½øÐÐ×é¼þɨÃè¡£ ÎÒÃÇ¿ÉÒÔΪÕâЩÀàÌṩ@Import µÄÖµ²ÎÊý +我们å�¯ä»¥ä½¿ç”¨ç‰¹å®šçš„ @Configuration 类,而无需使用此注解进行组件扫æ��。 我们å�¯ä»¥ä¸ºè¿™äº›ç±»æ��ä¾›@Import 的值å�‚æ•° -Õý³£À´Ëµ£¬Èç¹ûÒªÓõ½@Configuration×¢½âµÄbean£¬ÄÇôspringÓ¦ÓñØÐëҪɨÃèµ½¸ÃĿ¼£¬Èç¹ûÇ¡ºÃûÓжԸ÷¾¶½øÐÐɨÃ裬»òÕßÎÒÃÇÖ»ÊÇÏëʹÓ÷¾¶Ïµĵ¥¸öÅäÖÃÀ࣬ÄÇôÎÒÃǾͿÉÒÔʹÓÃ@ImportÀ´µ¼ÈëÕâ¸öÅäÖÃÀàÁË¡£ +正常æ�¥è¯´ï¼Œå¦‚æžœè¦�用到@Configuration注解的bean,那么spring应用必须è¦�扫æ��到该目录,如果æ�°å¥½æ²¡æœ‰å¯¹è¯¥è·¯å¾„进行扫æ��,或者我们å�ªæ˜¯æƒ³ä½¿ç”¨è·¯å¾„下的å�•个é…�置类,那么我们就å�¯ä»¥ä½¿ç”¨@Importæ�¥å¯¼å…¥è¿™ä¸ªé…�置类了。 -Õâ¸ö×¢½â»¹ÊǷdz£³£Óõģ¬¿´Ò»ÏÂÏÂÃæÕâ¸öÀý×Ó +这个注解还是é�žå¸¸å¸¸ç”¨çš„,看一下下é�¢è¿™ä¸ªä¾‹å­� ```` @Import(VehiclePartSupplier.class) @@ -441,32 +441,32 @@ class VehiclePartSupplier{ ### 3.3 @ImportResource -±ÈÈç˵£ºÏÖÔÚÓÐÒ»¸ö bean.xml µÄÅäÖÃÎļþ£¬ÐèÒª½«¸Ã beans.xml Öж¨ÒåµÄ bean¶ÔÏó ¶¼µ¼Èëµ½ Spring Boot »·¾³µÄÈÝÆ÷ÖУ¬¸ÃÈçºÎ²Ù×÷ÄØ£¿ +比如说:现在有一个 bean.xml çš„é…�置文件,需è¦�将该 beans.xml 中定义的 bean对象 都导入到 Spring Boot 环境的容器中,该如何æ“�作呢? -1.Spring ·½Ê½µÄÅäÖÃÎļþ bean.xml ´Ë´¦Ëæ±ã¾Ù¸öʾÀý£¬±ÈÈç˵ xml ÖÐÅäÖÃÁËÒ»¸ö helloService£¬ÈçÏÂËùʾ +1.Spring æ–¹å¼�çš„é…�置文件 bean.xml 此处éš�便举个示例,比如说 xml 中é…�置了一个 helloService,如下所示 ```` - + ```` -2.ʹÓÃ@ImportResource×¢½â£¬ÒýÈë xml ÅäÖà +2.使用@ImportResource注解,引入 xml é…�ç½® ```` /** - * Spring BootÀïÃæÃ»ÓÐSpringµÄÅäÖÃÎļþ£¬ÎÒÃÇ×Ô¼º±àдµÄÅäÖÃÎļþ£¬Ò²²»ÄÜ×Ô¶¯Ê¶±ð£» - * Èç¹ûÏëÈÃSpringµÄÅäÖÃÎļþÉúЧ£¬¼ÓÔØµ½Spring ÈÝÆ÷ÖÐÀ´£» - * ʹÓÃ@ImportResource×¢½â£¬½«Æä±ê×¢ÔÚÒ»¸öÅäÖÃÀàÉÏ(´Ë´¦ÅäÖÃÔÚÆô¶¯Àà) + * Spring Boot里é�¢æ²¡æœ‰Springçš„é…�置文件,我们自己编写的é…�置文件,也ä¸�能自动识别; + * 如果想让Springçš„é…�置文件生效,加载到Spring 容器中æ�¥ï¼› + * 使用@ImportResource注解,将其标注在一个é…�置类上(此处é…�置在å�¯åŠ¨ç±») */ @SpringBootApplication @ImportResource(locations = {"classpath:beans.xml"}) public class BootApplication { public static void main(String[] args) { - // SpringÓ¦ÓÃÆô¶¯ÆðÀ´ + // Spring应用å�¯åŠ¨èµ·æ�¥ SpringApplication.run(BootApplication.class,args); } @@ -474,19 +474,19 @@ public class BootApplication { ```` ### 3.4 @PropertySource -ͨ¹ýÕâ¸ö×¢½â£¬ÎÒÃÇ¿ÉÒÔΪӦÓóÌÐòÉèÖö¨ÒåÊôÐÔÎļþ£º +通过这个注解,我们å�¯ä»¥ä¸ºåº”用程åº�设置定义属性文件: -@PropertySource ×¢½âÌṩÁËÒ»ÖÖ·½±ãµÄÉùÃ÷ÐÔ»úÖÆ£¬ÓÃÓÚ½« PropertySource Ìí¼Óµ½ Spring µÄ Environment ÖУ¬Óë @Configuration ÀàÒ»ÆðʹÓᣠ+@PropertySource 注解æ��供了一ç§�方便的声明性机制,用于将 PropertySource 添加到 Spring çš„ Environment 中,与 @Configuration 类一起使用。 -Äã¿ÉÒÔʹÓà @Value È¥ÒýÓö¨ÒåµÄÊôÐÔ£¬ÀýÈ磺@Value("testbean.name")£»Ò²¿ÉÒÔÖ¸¶¨Ä¬ÈÏÖµ£¬È磺@Value("testbean.name:defaultValue")¡£ +ä½ å�¯ä»¥ä½¿ç”¨ @Value 去引用定义的属性,例如:@Value("testbean.name");也å�¯ä»¥æŒ‡å®šé»˜è®¤å€¼ï¼Œå¦‚:@Value("testbean.name:defaultValue")。 -Ó÷¨Ê¾Àý +用法示例 -¸ø¶¨Ò»¸öÅäÖÃÎļþapp.properties +给定一个é…�置文件app.properties ```` testbean.name=myTestBean ```` -ÒÔÏ @Configuration ÀàʹÓà @PropertySource ½« app.properties ÉèÖøø Environment µÄ PropertySources ¼¯ºÏ¡£ +以下 @Configuration 类使用 @PropertySource å°† app.properties 设置给 Environment çš„ PropertySources 集å�ˆã€‚ ```` @Configuration @PropertySource("classpath:/com/myco/app.properties") @@ -504,10 +504,10 @@ public class AppConfig { } ```` -×¢Ò⣺ʹÓà @Autowired ½« Environment ¶ÔÏó×¢Èëµ½ÅäÖÃÀàÖУ¬È»ºóÔÚ testBean() ·½·¨ÖÐʹÓᣠ-ÒÔÉÏÅäÖÃÖУ¬µ÷Óà testBean.getName() ·½·¨½«·µ»Ø¡°myTestBean¡±×Ö·û´®¡£ +注æ„�:使用 @Autowired å°† Environment 对象注入到é…�置类中,然å�Žåœ¨ testBean() 方法中使用。 +以上é…�置中,调用 testBean.getName() 方法将返回“myTestBeanâ€�字符串。 -@PropertySource ÀûÓÃÁË Java 8 µÄÖØ¸´×¢½âÌØÐÔ£¬ÕâÒâζ×ÅÎÒÃÇ¿ÉÒÔÓÃËü¶à´Î±ê¼ÇÒ»¸öÀࣺ +@PropertySource 利用了 Java 8 çš„é‡�å¤�注解特性,这æ„�味ç�€æˆ‘们å�¯ä»¥ç”¨å®ƒå¤šæ¬¡æ ‡è®°ä¸€ä¸ªç±»ï¼š ```` @Configuration @@ -517,7 +517,7 @@ class VehicleFactoryConfig {} ```` ### 3.5 @PropertySources -Ó÷¨Í¬ÉÏ£¬Ö»²»¹ý£¬ÕâÒ»´ÎÎÒÃÇ¿ÉÒÔʹÓÃÕâ¸ö×¢½âÖ¸¶¨¶à¸ö@PropertySource ÅäÖ㺠+用法å�Œä¸Šï¼Œå�ªä¸�过,这一次我们å�¯ä»¥ä½¿ç”¨è¿™ä¸ªæ³¨è§£æŒ‡å®šå¤šä¸ª@PropertySource é…�置: ```` @Configuration @PropertySources({ @@ -526,40 +526,40 @@ class VehicleFactoryConfig {} }) class VehicleFactoryConfig {} ```` -Çë×¢Ò⣬×Ô Java 8 ÒÔÀ´£¬ÎÒÃÇ¿ÉÒÔͨ¹ýÉÏÊöÖØ¸´×¢Ê͹¦ÄÜʵÏÖÏàͬµÄ¹¦ÄÜ¡£ +请注æ„�,自 Java 8 以æ�¥ï¼Œæˆ‘们å�¯ä»¥é€šè¿‡ä¸Šè¿°é‡�å¤�注释功能实现相å�Œçš„功能。 -## 4.½áÂÛ +## 4.结论 -ÔÚ±¾ÎÄÖУ¬ÎÒÃÇ¿´µ½ÁË×î³£¼ûµÄ Spring ºËÐÄ×¢Ê͵ĸÅÊö¡£ ÎÒÃÇ¿´µ½ÁËÈçºÎÅäÖà bean Á¬½ÓºÍÓ¦ÓÃÉÏÏÂÎÄ£¬ÒÔ¼°ÈçºÎΪ×é¼þɨÃè±ê¼ÇÀà¡£ +在本文中,我们看到了最常è§�çš„ Spring 核心注释的概述。 我们看到了如何é…�ç½® bean 连接和应用上下文,以å�Šå¦‚何为组件扫æ��标记类。 -springÌåϵÖеij£¼û×¢½â»¹Óкܶ࣬һƪÎÄÕ²»¿ÉÄÜÈ«²¿¸²¸Ç£¬ÈçÓÐÒÅ©£¬»¶Ó­²¹³ä¡£ +spring体系中的常è§�注解还有很多,一篇文章ä¸�å�¯èƒ½å…¨éƒ¨è¦†ç›–,如有é�—æ¼�,欢迎补充。 -# Spring Bean×¢½â +# Spring Bean注解 -## 1 ¸ÅÊö -ÔÚ±¾½Ì³ÌÖУ¬ÎÒÃǽ«ÌÖÂÛÓÃÓÚ¶¨Ò岻ͬÀàÐÍ bean µÄ×î³£¼ûµÄ Spring bean ×¢ÊÍ¡£ +## 1 概述 +在本教程中,我们将讨论用于定义ä¸�å�Œç±»åž‹ bean 的最常è§�çš„ Spring bean 注释。 -Óм¸ÖÖ·½·¨¿ÉÒÔÔÚ Spring ÈÝÆ÷ÖÐÅäÖà bean¡£ Ê×ÏÈ£¬ÎÒÃÇ¿ÉÒÔʹÓà XML ÅäÖÃÉùÃ÷ËüÃÇ¡£ ÎÒÃÇ»¹¿ÉÒÔÔÚÅäÖÃÀàÖÐʹÓÃ@Bean ×¢½âÀ´ÉùÃ÷ bean¡£ +有几ç§�方法å�¯ä»¥åœ¨ Spring 容器中é…�ç½® bean。 首先,我们å�¯ä»¥ä½¿ç”¨ XML é…�置声明它们。 我们还å�¯ä»¥åœ¨é…�置类中使用@Bean 注解æ�¥å£°æ˜Ž bean。 -×îºó£¬ÎÒÃÇ¿ÉÒÔʹÓà org.springframework.stereotype °üÖеÄ×¢ÊÍÖ®Ò»À´±ê¼Ç¸ÃÀ࣬²¢½«ÆäÓಿ·ÖÁô¸ø×é¼þɨÃè¡£ +最å�Žï¼Œæˆ‘们å�¯ä»¥ä½¿ç”¨ org.springframework.stereotype 包中的注释之一æ�¥æ ‡è®°è¯¥ç±»ï¼Œå¹¶å°†å…¶ä½™éƒ¨åˆ†ç•™ç»™ç»„件扫æ��。 ## 2 @ComponentScan -ÕâÊÇÎÒÃǾ­³£»áʹÓõÄÒ»¸ö×¢½â£¬ÔÚÎÒÃǵÄÓ¦ÓÃÖУ¬ÓÐʱºò²»Ò»¶¨»áɨÃèËùÓеİü£¬ÌرðÊǵ±ÎÒÃÇҪɨÃèÍⲿjar°üÖеÄbeanʱ£¬Ëü·Ç³£ÓÐÓᣠ+这是我们ç»�常会使用的一个注解,在我们的应用中,有时候ä¸�一定会扫æ��所有的包,特别是当我们è¦�扫æ��外部jar包中的bean时,它é�žå¸¸æœ‰ç”¨ã€‚ -Ëü¿ÉÒÔ¼ÓÔÚSpringBootApplicationÉÏ£¬Ò²¿ÉÒÔ¼ÓÔÚ@configuration×¢½âÉϵÄÅäÖÃÀàÉÏ +它å�¯ä»¥åŠ åœ¨SpringBootApplication上,也å�¯ä»¥åŠ åœ¨@configuration注解上的é…�置类上 -Èç¹ûÆôÓÃÁË×é¼þɨÃ裬Spring ¿ÉÒÔ×Ô¶¯É¨Ãè°üÖÐµÄ bean¡£ +如果å�¯ç”¨äº†ç»„件扫æ��,Spring å�¯ä»¥è‡ªåŠ¨æ‰«æ��包中的 bean。 -@ComponentScan ÅäÖÃʹÓÃ×¢½âÅäÖÃɨÃèÄÄЩ°üµÄÀà¡£ +@ComponentScan é…�置使用注解é…�置扫æ��哪些包的类。 -ÎÒÃÇ¿ÉÒÔÖ±½ÓʹÓà basePackages »ò value ²ÎÊýÖ®Ò»Ö¸¶¨»ù±¾°üÃû³Æ£¨value ÊÇ basePackages µÄ±ðÃû£© +我们å�¯ä»¥ç›´æŽ¥ä½¿ç”¨ basePackages 或 value å�‚数之一指定基本包å��称(value 是 basePackages 的别å��) ```` @Configuration @ComponentScan(basePackages = "com.baeldung.annotations") class VehicleFactoryConfig {} ```` -´ËÍ⣬ÎÒÃÇ¿ÉÒÔʹÓà basePackageClasses ²ÎÊýÖ¸Ïò»ù´¡°üÖеÄÀࣺ +此外,我们å�¯ä»¥ä½¿ç”¨ basePackageClasses å�‚数指å�‘基础包中的类: ```` @Configuration @@ -567,11 +567,11 @@ class VehicleFactoryConfig {} class VehicleFactoryConfig {} ```` -ÕâÁ½¸ö²ÎÊý¶¼ÊÇÊý×飬Òò´ËÎÒÃÇ¿ÉÒÔΪÿ¸ö²ÎÊýÌṩ¶à¸ö°ü¡£ +这两个å�‚数都是数组,因此我们å�¯ä»¥ä¸ºæ¯�个å�‚æ•°æ��供多个包。 -Èç¹ûδָ¶¨²ÎÊý£¬ÔòɨÃè·¢ÉúÔÚ´æÔÚ @ComponentScan ×¢ÊÍÀàµÄͬһ°üÖС£ +如果未指定å�‚数,则扫æ��å�‘生在存在 @ComponentScan 注释类的å�Œä¸€åŒ…中。 -@ComponentScan ÀûÓÃÁË Java 8 µÄÖØ¸´×¢½âÌØÐÔ£¬ÕâÒâζ×ÅÎÒÃÇ¿ÉÒÔÓÃËü¶à´Î±ê¼ÇÒ»¸öÀࣺ +@ComponentScan 利用了 Java 8 çš„é‡�å¤�注解特性,这æ„�味ç�€æˆ‘们å�¯ä»¥ç”¨å®ƒå¤šæ¬¡æ ‡è®°ä¸€ä¸ªç±»ï¼š ```` @Configuration @@ -580,7 +580,7 @@ class VehicleFactoryConfig {} class VehicleFactoryConfig {} ```` -»òÕߣ¬ÎÒÃÇ¿ÉÒÔʹÓà @ComponentScans Ö¸¶¨¶à¸ö @ComponentScan ÅäÖ㺠+或者,我们å�¯ä»¥ä½¿ç”¨ @ComponentScans 指定多个 @ComponentScan é…�置: ```` @Configuration @@ -593,7 +593,7 @@ class VehicleFactoryConfig {} class VehicleFactoryConfig { } ```` -ʹÓà XML ÅäÖÃʱ£¬ÅäÖÃ×é¼þɨÃèͬÑù¼òµ¥£º +使用 XML é…�置时,é…�置组件扫æ��å�Œæ ·ç®€å�•: ```` @@ -601,7 +601,7 @@ class VehicleFactoryConfig { ### 3 @Component -@Component ÊÇÀ༶±ðµÄ×¢½â¡£ ÔÚ×é¼þɨÃèÆÚ¼ä£¬Spring Framework »á×Ô¶¯¼ì²âʹÓÃ@Component ×¢½âµÄÀࣺ +@Component 是类级别的注解。 在组件扫æ��期间,Spring Framework 会自动检测使用@Component 注解的类: ```` @Component class CarUtility { @@ -609,13 +609,13 @@ class CarUtility { } ```` -ĬÈÏÇé¿öÏ£¬´ËÀàµÄ bean ʵÀýÓëÀàÃûͬÃû£¬Ê××ÖĸСд¡£ ´ËÍ⣬ÎÒÃÇ¿ÉÒÔʹÓôË×¢Ê͵ĿÉѡֵ²ÎÊýÖ¸¶¨²»Í¬µÄÃû³Æ¡£ +默认情况下,此类的 bean 实例与类å��å�Œå��,首字æ¯�å°�写。 此外,我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨é‡Šçš„å�¯é€‰å€¼å�‚数指定ä¸�å�Œçš„å��称。 -ÓÉÓÚ@Repository¡¢@Service¡¢@Configuration ºÍ@Controller ¶¼ÊÇ´øÓÐ@Component µÄ×¢½â£¬ËüÃǹ²ÏíÏàͬµÄbean ÃüÃûÐÐΪ¡£ +由于@Repositoryã€�@Serviceã€�@Configuration å’Œ@Controller 都是带有@Component 的注解,它们共享相å�Œçš„bean 命å��行为。 -Spring »¹»áÔÚ×é¼þɨÃè¹ý³ÌÖÐ×Ô¶¯¼ì²âËüÃÇ¡£ +Spring 还会在组件扫æ��过程中自动检测它们。 -ͨ³£À´Ëµ£¬ÎÒÃÇ»áÔÚmvcÓ¦ÓÃÖÐÎÒÃÇ»áÓõ½ÉÏÊö¼¸ÖÖ×¢½â£¬¶øÎÒÃÇÔÚ·ÇwebÓ¦ÓÃÖиü¶àµØ¿ÉÒÔʹÓÃ@componentÀ´×¢½âbean +通常æ�¥è¯´ï¼Œæˆ‘们会在mvc应用中我们会用到上述几ç§�注解,而我们在é�žweb应用中更多地å�¯ä»¥ä½¿ç”¨@componentæ�¥æ³¨è§£bean ### 4 @Repository @@ -626,25 +626,25 @@ class VehicleRepository { // ... } ```` -ʹÓôË×¢Ê͵ÄÒ»¸öÓŵãÊÇËüÆôÓÃÁË×Ô¶¯³Ö¾ÃÐÔÒ쳣ת»»¡£ µ±Ê¹Óó־ÃÐÔ¿ò¼Ü£¨Èç Hibernate£©Ê±£¬ÔÚʹÓà @Repository ×¢Ê͵ÄÀàÖÐÅ׳öµÄ±¾»úÒì³£½«×Ô¶¯×ª»»Îª Spring µÄ DataAccessExeption µÄ×ÓÀà¡£ +使用此注释的一个优点是它å�¯ç”¨äº†è‡ªåЍæŒ�久性异常转æ�¢ã€‚ 当使用æŒ�久性框架(如 Hibernate)时,在使用 @Repository 注释的类中抛出的本机异常将自动转æ�¢ä¸º Spring çš„ DataAccessExeption çš„å­�类。 -ÒªÆôÓÃÒ쳣ת»»£¬ÎÒÃÇÐèÒªÉùÃ÷ÎÒÃÇ×Ô¼ºµÄ PersistenceExceptionTranslationPostProcessor bean£º +è¦�å�¯ç”¨å¼‚常转æ�¢ï¼Œæˆ‘们需è¦�声明我们自己的 PersistenceExceptionTranslationPostProcessor bean: ```` @Bean public PersistenceExceptionTranslationPostProcessor exceptionTranslation() { return new PersistenceExceptionTranslationPostProcessor(); } ```` -Çë×¢Ò⣬ÔÚ´ó¶àÊýÇé¿öÏ£¬Spring »á×Ô¶¯Ö´ÐÐÉÏÊö²½Öè¡£ +请注æ„�,在大多数情况下,Spring 会自动执行上述步骤。 -»òÕßͨ¹ý XML ÅäÖ㺠+或者通过 XML é…�置: ```` ```` ### 5 @Service -Ó¦ÓóÌÐòµÄÒµÎñÂß¼­Í¨³£×¤ÁôÔÚ·þÎñ²ãÖУ¬Òò´ËÎÒÃǽ«Ê¹ÓÃ@Service ×¢ÊÍÀ´Ö¸Ê¾Ò»¸öÀàÊôÓڸò㣺 +应用程åº�的业务逻辑通常驻留在æœ�务层中,因此我们将使用@Service 注释æ�¥æŒ‡ç¤ºä¸€ä¸ªç±»å±žäºŽè¯¥å±‚: ```` @Service @@ -653,9 +653,9 @@ public class VehicleService { } ```` ### 6 @Controller -@Controller ÊÇÒ»¸öÀ༶±ðµÄ×¢½â£¬Ëü¸æËß Spring Framework Õâ¸öÀà×÷Ϊ Spring MVC ÖеĿØÖÆÆ÷£º +@Controller 是一个类级别的注解,它告诉 Spring Framework 这个类作为 Spring MVC 中的控制器: -spring»á¶Ô@Controller ×¢½âµÄbean×öºÜ¶àÊÂÇ飬¾ßÌåÄÚÈÝÎÒÃÇ»áÔÚSpringMVCÏà¹ØµÄÄÚÈÝÀ´½²Êö +spring会对@Controller 注解的beanå�šå¾ˆå¤šäº‹æƒ…,具体内容我们会在SpringMVC相关的内容æ�¥è®²è¿° ```` @Controller @@ -666,7 +666,7 @@ public class VehicleController { ```` ## 7 @Configuration -ÅäÖÃÀà¿ÉÒÔ°üº¬ÓÃ@Bean ×¢Ê굀 bean ¶¨Òå·½·¨£º +é…�置类å�¯ä»¥åŒ…å�«ç”¨@Bean 注释的 bean 定义方法: ```` @Configuration class VehicleFactoryConfig { @@ -678,10 +678,10 @@ class VehicleFactoryConfig { } ```` -## 8 AOP×¢½â -µ±ÎÒÃÇʹÓà Spring ¹¹ÔìÐÍ×¢ÊÍʱ£¬ºÜÈÝÒ×´´½¨Ò»¸öÇÐÈëµã£¬¸ÃÇÐÈëµãÒÔËùÓоßÓÐÌØ¶¨¹¹ÔìÐ͵ÄÀàΪĿ±ê¡£ +## 8 AOP注解 +当我们使用 Spring 构造型注释时,很容易创建一个切入点,该切入点以所有具有特定构造型的类为目标。 -ÀýÈ磬¼ÙÉèÎÒÃÇÏë²âÁ¿ DAO ²ã·½·¨µÄÖ´ÐÐʱ¼ä¡£ ÎÒÃǽ«´´½¨ÒÔÏ·½Ã棨ʹÓà AspectJ ×¢ÊÍ£©£¬ÀûÓà @Repository ¹¹ÔìÐÍ£º +例如,å�‡è®¾æˆ‘们想测é‡� DAO 层方法的执行时间。 我们将创建以下方é�¢ï¼ˆä½¿ç”¨ AspectJ 注释),利用 @Repository 构造型: ``` @Aspect @@ -705,20 +705,20 @@ public void repositoryClassMethods() {}; } ```` -ÔÚ´ËʾÀýÖУ¬ÎÒÃÇ´´½¨ÁËÒ»¸öÇÐÈëµã£¬¸ÃÇÐÈëµãÆ¥ÅäʹÓÃ@Repository ×¢Ê͵ÄÀàÖеÄËùÓз½·¨¡£ È»ºóÎÒÃÇʹÓÃ@Around ֪ͨÀ´¶¨Î»ÄǸöÇÐÈëµã£¬²¢È·¶¨À¹½Ø·½·¨µ÷ÓõÄÖ´ÐÐʱ¼ä¡£ +在此示例中,我们创建了一个切入点,该切入点匹é…�使用@Repository 注释的类中的所有方法。 ç„¶å�Žæˆ‘们使用@Around 通知æ�¥å®šä½�那个切入点,并确定拦截方法调用的执行时间。 -´ËÍ⣬ʹÓÃÕâÖÖ·½·¨£¬ÎÒÃÇ¿ÉÒÔΪÿ¸öÓ¦ÓóÌÐò²ãÌí¼ÓÈÕÖ¾¼Ç¼¡¢ÐÔÄܹÜÀí¡¢Éó¼ÆºÍÆäËûÐÐΪ¡£ +此外,使用这ç§�方法,我们å�¯ä»¥ä¸ºæ¯�个应用程åº�层添加日志记录ã€�性能管ç�†ã€�审计和其他行为。 -µ±È»ÁË£¬aspectJµÄÏà¹Ø×¢½â»¹ºÜ¶à£¬¿ÉÒÔÓÃÀ´ÉùÃ÷ÇÐÃæ£¬Î´À´ÎÒÃÇÒ²»áµ¥¶ÀдÎĽéÉÜ¡£ +当然了,aspectJ的相关注解还很多,å�¯ä»¥ç”¨æ�¥å£°æ˜Žåˆ‡é�¢ï¼Œæœªæ�¥æˆ‘们也会å�•独写文介ç»�。 -## 9 ½áÂÛ +## 9 结论 -ÔÚ±¾ÎÄÖУ¬ÎÒÃǼì²éÁË Spring ¹¹ÔìÐÍ×¢ÊͲ¢ÌÖÂÛÁËËüÃǸ÷×Ô´ú±íµÄÓïÒåÀàÐÍ¡£ +在本文中,我们检查了 Spring 构造型注释并讨论了它们å�„自代表的语义类型。 -ÎÒÃÇ»¹Ñ§Ï°ÁËÈçºÎʹÓÃ×é¼þɨÃèÀ´¸æËßÈÝÆ÷ÔÚÄÄÀï¿ÉÒÔÕÒµ½´ø×¢Ê͵ÄÀà¡£ +我们还学习了如何使用组件扫æ��æ�¥å‘Šè¯‰å®¹å™¨åœ¨å“ªé‡Œå�¯ä»¥æ‰¾åˆ°å¸¦æ³¨é‡Šçš„类。 -×îºó£¬ÎÒÃÇÁ˽âÁËÕâЩעÊÍÈçºÎµ¼Ö¸ɾ»¡¢·Ö²ãµÄÉè¼ÆÒÔ¼°Ó¦ÓóÌÐò¹Ø×¢µãÖ®¼äµÄ·ÖÀë¡£ ËüÃÇ»¹Ê¹ÅäÖøüС£¬ÒòΪÎÒÃDz»ÔÙÐèÒªÊÖ¶¯ÏÔʽ¶¨Òå bean¡£ +最å�Žï¼Œæˆ‘们了解了这些注释如何导致干净ã€�分层的设计以å�Šåº”用程åº�关注点之间的分离。 它们还使é…�置更å°�,因为我们ä¸�å†�需è¦�手动显å¼�定义 bean。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.baeldung.com/spring-annotations diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\346\246\202\350\277\260.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\346\246\202\350\277\260.md" index e9a041f..df7049a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\346\246\202\350\277\260.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/Spring\346\246\202\350\277\260.md" @@ -1,96 +1,96 @@ -Spring ÊÇ Java EE ±à³ÌÁìÓòµÄÒ»¿îÇáÁ¿¼¶µÄ¿ªÔ´¿ò¼Ü£¬Óɱ»³ÆÎª¡°Spring Ö®¸¸¡±µÄ Rod Johnson ÓÚ 2002 ÄêÌá³ö²¢´´Á¢£¬ËüµÄÄ¿±ê¾ÍÊÇÒª¼ò»¯ Java ÆóÒµ¼¶Ó¦ÓóÌÐòµÄ¿ª·¢ÄѶȺÍÖÜÆÚ¡£ +Spring 是 Java EE 编程领域的一款轻é‡�级的开æº�框架,由被称为“Spring 之父â€�çš„ Rod Johnson 于 2002 å¹´æ��出并创立,它的目标就是è¦�简化 Java ä¼�业级应用程åº�的开å�‘难度和周期。 -Spring ×Ôµ®ÉúÒÔÀ´±¸ÊÜÇàíù£¬Ò»Ö±±»¹ã´ó¿ª·¢ÈËÔ±×÷Ϊ Java ÆóÒµ¼¶Ó¦ÓóÌÐò¿ª·¢µÄÊ×Ñ¡¡£Ê±ÖÁ½ñÈÕ£¬Spring ٲȻ³ÉΪÁË Java EE ´úÃû´Ê£¬³ÉΪÁ˹¹½¨ Java EE Ó¦ÓõÄÊÂʵ±ê×¼¡£ +Spring 自诞生以æ�¥å¤‡å�—é�’ç��,一直被广大开å�‘人员作为 Java ä¼�业级应用程åº�å¼€å�‘的首选。时至今日,Spring 俨然æˆ�为了 Java EE 代å��è¯�,æˆ�为了构建 Java EE 应用的事实标准。 -## Spring µÄµ®ÉúÓë·¢Õ¹ +## Spring 的诞生与å�‘展 -ÔçÆÚµÄ J2EE£¨Java EE ƽ̨£©ÍƳçÒÔ EJB ΪºËÐĵĿª·¢·½Ê½£¬µ«ÕâÖÖ¿ª·¢·½Ê½ÔÚʵ¼ÊµÄ¿ª·¢¹ý³ÌÖдæÔÚÖÖÖÖ±×¶Ë£¬ÀýÈçʹÓø´ÔÓ¡¢´úÂëÓ·Öס¢´úÂëÇÖÈëÐÔÇ¿¡¢¿ª·¢ÖÜÆÚ³¤¡¢ÒÆÖ²ÄѶȴóµÈ¡£ +早期的 J2EE(Java EE å¹³å�°ï¼‰æŽ¨å´‡ä»¥ EJB 为核心的开å�‘æ–¹å¼�,但这ç§�å¼€å�‘æ–¹å¼�在实际的开å�‘过程中存在ç§�ç§�弊端,例如使用å¤�æ�‚ã€�代ç �臃肿ã€�代ç �侵入性强ã€�å¼€å�‘周期长ã€�ç§»æ¤�难度大等。 -Rod Johnson ÔÚÆä 2004 Äê±àÖøµÄ³©ÏúÊé¡¶Expert One-on-One J2EE Development without EJB¡·ÖУ¬Õë¶Ô EJB ¸÷ÖÖÓ·Ö׵Ľṹ½øÐÐÁËÖðÒ»µÄ·ÖÎöºÍ·ñ¶¨£¬²¢·Ö±ðÒÔ¸ü¼Ó¼ò½àµÄ·½Ê½½øÐÐÁËÌæ»»¡£ +Rod Johnson 在其 2004 年编著的畅销书《Expert One-on-One J2EE Development without EJB》中,针对 EJB å�„ç§�臃肿的结构进行了é€�一的分æž�å’Œå�¦å®šï¼Œå¹¶åˆ†åˆ«ä»¥æ›´åŠ ç®€æ´�的方å¼�进行了替æ�¢ã€‚ -ÔÚÕâ±¾ÊéÖУ¬Rod Johnson ͨ¹ýÒ»¸ö°üº¬ 3 ÍòÐдúÂëµÄ¸½¼þ£¬Õ¹Ê¾ÁËÈçºÎÔÚ²»Ê¹Óà EJB µÄÇé¿öϹ¹½¨Ò»¸ö¸ßÖÊÁ¿¡¢¿ÉÀ©Õ¹µÄ Java Ó¦ÓóÌÐò¡£ÔÚÕâ¸ö¸½¼þÖУ¬Rod Johnson ±àдÁËÉÏÍòÐлù´¡½á¹¹´úÂ룬ÆäÖаüº¬ÁËÐí¶à¿ÉÖØÓÃµÄ Java ½Ó¿ÚºÍÀ࣬ÀýÈç ApplicationContext¡¢BeanFactory µÈ¡£ÕâЩÀàµÄ¸ù°ü±»ÃüÃûΪ com.interface21£¬º¬ÒåΪ£ºÕâÊÇÌṩ¸ø 21 ÊÀ¼ÍµÄÒ»¸ö²Î¿¼¡£ +在这本书中,Rod Johnson 通过一个包å�« 3 万行代ç �的附件,展示了如何在ä¸�使用 EJB 的情况下构建一个高质é‡�ã€�å�¯æ‰©å±•çš„ Java 应用程åº�。在这个附件中,Rod Johnson 编写了上万行基础结构代ç �,其中包å�«äº†è®¸å¤šå�¯é‡�用的 Java 接å�£å’Œç±»ï¼Œä¾‹å¦‚ ApplicationContextã€�BeanFactory 等。这些类的根包被命å��为 com.interface21,å�«ä¹‰ä¸ºï¼šè¿™æ˜¯æ��供给 21 世纪的一个å�‚考。 -Õâ±¾ÊéÓ°ÏìÉõÔ¶£¬ºóÀ´ Rod Johnson ½« com.interface21 µÄ´úÂ뿪Դ£¬²¢°ÑÕâ¸öпò¼Ü²¢ÃüÃûΪ¡°Spring¡±£¬º¬ÒåΪ£ºSpring ÏñÒ»ÂÆ´º·çÒ»Ñù£¬É¨Æ½´«Í³ J2EE µÄº®¶¬¡£ +这本书影å“�甚远,å�Žæ�¥ Rod Johnson å°† com.interface21 的代ç �å¼€æº�,并把这个新框架并命å��为“Springâ€�,å�«ä¹‰ä¸ºï¼šSpring åƒ�一缕春风一样,扫平传统 J2EE 的寒冬。 -2003 Äê 2 Ô£¬Spring 0.9 °æ±¾·¢²¼£¬Ëü²ÉÓÃÁË Apache 2.0 ¿ªÔ´Ð­Ò飻2004 Äê 4 Ô£¬Spring 1.0 °æ±¾Õýʽ·¢²¼¡£µ½Ä¿Ç°ÎªÖ¹£¬Spring ÒѾ­²½Èëµ½ÁËµÚ 5 ¸ö´ó°æ±¾£¬Ò²¾ÍÊÇÎÒÃdz£ËµµÄ Spring 5¡£ +2003 å¹´ 2 月,Spring 0.9 版本å�‘布,它采用了 Apache 2.0 å¼€æº�å��议;2004 å¹´ 4 月,Spring 1.0 版本正å¼�å�‘布。到目å‰�为止,Spring å·²ç»�步入到了第 5 个大版本,也就是我们常说的 Spring 5。 -## Spring µÄÏÁÒåºÍ¹ãÒå +## Spring 的狭义和广义 -ÔÚ²»Í¬µÄÓï¾³ÖУ¬Spring Ëù´ú±íµÄº¬ÒåÊDz»Í¬µÄ¡£ÏÂÃæÎÒÃǾͷֱð´Ó¡°¹ãÒ塱ºÍ¡°ÏÁÒ塱Á½¸ö½Ç¶È£¬¶Ô Spring ½øÐнéÉÜ¡£ +在ä¸�å�Œçš„语境中,Spring 所代表的å�«ä¹‰æ˜¯ä¸�å�Œçš„。下é�¢æˆ‘们就分别从“广义â€�和“狭义â€�两个角度,对 Spring 进行介ç»�。 -### ¹ãÒåµÄ Spring£ºSpring ¼¼ÊõÕ» +### 广义的 Spring:Spring 技术栈 -¹ãÒåÉ쵀 Spring ·ºÖ¸ÒÔ Spring Framework ΪºËÐÄµÄ Spring ¼¼ÊõÕ»¡£ +广义上的 Spring 泛指以 Spring Framework 为核心的 Spring 技术栈。 -¾­¹ýÊ®¶àÄêµÄ·¢Õ¹£¬Spring ÒѾ­²»ÔÙÊÇÒ»¸öµ¥´¿µÄÓ¦Óÿò¼Ü£¬¶øÊÇÖð½¥·¢Õ¹³ÉΪһ¸öÓɶà¸ö²»Í¬×ÓÏîÄ¿£¨Ä£¿é£©×é³ÉµÄ³ÉÊì¼¼Êõ£¬ÀýÈç Spring Framework¡¢Spring MVC¡¢SpringBoot¡¢Spring Cloud¡¢Spring Data¡¢Spring Security µÈ£¬ÆäÖÐ Spring Framework ÊÇÆäËû×ÓÏîÄ¿µÄ»ù´¡¡£ +ç»�过å��多年的å�‘展,Spring å·²ç»�ä¸�å†�是一个å�•纯的应用框架,而是é€�æ¸�å�‘展æˆ�为一个由多个ä¸�å�Œå­�项目(模å�—)组æˆ�çš„æˆ�熟技术,例如 Spring Frameworkã€�Spring MVCã€�SpringBootã€�Spring Cloudã€�Spring Dataã€�Spring Security 等,其中 Spring Framework 是其他å­�项目的基础。 -ÕâЩ×ÓÏîÄ¿º­¸ÇÁË´ÓÆóÒµ¼¶Ó¦Óÿª·¢µ½ÔƼÆËãµÈ¸÷·½ÃæµÄÄÚÈÝ£¬Äܹ»°ïÖú¿ª·¢ÈËÔ±½â¾öÈí¼þ·¢Õ¹¹ý³ÌÖв»¶Ï²úÉúµÄ¸÷ÖÖʵ¼ÊÎÊÌ⣬¸ø¿ª·¢ÈËÔ±´øÀ´Á˸üºÃµÄ¿ª·¢ÌåÑé¡£ +这些å­�项目涵盖了从ä¼�业级应用开å�‘到云计算等å�„æ–¹é�¢çš„内容,能够帮助开å�‘人员解决软件å�‘展过程中ä¸�断产生的å�„ç§�实际问题,给开å�‘人员带æ�¥äº†æ›´å¥½çš„å¼€å�‘体验。 -| ÏîÄ¿Ãû³Æ | ÃèÊö | +| 项目å��ç§° | æ��è¿° | | --- | --- | -| Spring Data | Spring ÌṩµÄÊý¾Ý·ÃÎÊÄ£¿é£¬¶Ô JDBC ºÍ ORM ÌṩÁ˺ܺõÄÖ§³Ö¡£Í¨¹ýËü£¬¿ª·¢ÈËÔ±¿ÉÒÔʹÓÃÒ»ÖÖÏà¶ÔͳһµÄ·½Ê½£¬À´·ÃÎÊλÓÚ²»Í¬ÀàÐÍÊý¾Ý¿âÖеÄÊý¾Ý¡£ | -| Spring Batch | Ò»¿îרÃÅÕë¶ÔÆóÒµ¼¶ÏµÍ³ÖеÄÈÕ³£Åú´¦ÀíÈÎÎñµÄÇáÁ¿¼¶¿ò¼Ü£¬Äܹ»°ïÖú¿ª·¢ÈËÔ±·½±ãµÄ¿ª·¢³ö½¡×³¡¢¸ßЧµÄÅú´¦ÀíÓ¦ÓóÌÐò¡£ | -| Spring Security | ǰÉíΪ Acegi£¬ÊÇ Spring ÖнϳÉÊìµÄ×ÓÄ£¿éÖ®Ò»¡£ËüÊÇÒ»¿î¿ÉÒÔ¶¨ÖÆ»¯µÄÉí·ÝÑéÖ¤ºÍ·ÃÎÊ¿ØÖÆ¿ò¼Ü¡£ | -| Spring Mobile | ÊÇ¶Ô Spring MVC µÄÀ©Õ¹£¬ÓÃÀ´¼ò»¯Òƶ¯¶Ë Web Ó¦ÓõĿª·¢¡£ | -| Spring Boot | ÊÇ Spring ÍŶÓÌṩµÄȫпò¼Ü£¬ËüΪ Spring ÒÔ¼°µÚÈý·½¿âһЩ¿ªÏä¼´ÓõÄÅäÖ㬿ÉÒÔ¼ò»¯ Spring Ó¦ÓõĴ¼°¿ª·¢¹ý³Ì¡£ | -| Spring Cloud | Ò»¿î»ùÓÚ Spring Boot ʵÏÖµÄ΢·þÎñ¿ò¼Ü¡£Ëü²¢²»ÊÇijһÃż¼Êõ£¬¶øÊÇһϵÁÐ΢·þÎñ½â¾ö·½°¸»ò¿ò¼ÜµÄÓÐÐò¼¯ºÏ¡£Ëü½«ÊÐÃæÉϳÉÊìµÄ¡¢¾­¹ýÑéÖ¤µÄ΢·þÎñ¿ò¼ÜÕûºÏÆðÀ´£¬²¢Í¨¹ý Spring Boot µÄ˼Ïë½øÐÐÔÙ·â×°£¬ÆÁ±Îµ÷ÆäÖи´ÔÓµÄÅäÖúÍʵÏÖÔ­Àí£¬×îÖÕΪ¿ª·¢ÈËÔ±ÌṩÁËÒ»Ì×¼òµ¥Ò×¶®¡¢Òײ¿ÊðºÍÒ×ά»¤µÄ·Ö²¼Ê½ÏµÍ³¿ª·¢¹¤¾ß°ü¡£ | +| Spring Data | Spring æ��供的数æ�®è®¿é—®æ¨¡å�—,对 JDBC å’Œ ORM æ��供了很好的支æŒ�。通过它,开å�‘人员å�¯ä»¥ä½¿ç”¨ä¸€ç§�相对统一的方å¼�,æ�¥è®¿é—®ä½�于ä¸�å�Œç±»åž‹æ•°æ�®åº“中的数æ�®ã€‚ | +| Spring Batch | 一款专门针对ä¼�业级系统中的日常批处ç�†ä»»åŠ¡çš„è½»é‡�级框架,能够帮助开å�‘人员方便的开å�‘出å�¥å£®ã€�高效的批处ç�†åº”用程åº�。 | +| Spring Security | å‰�身为 Acegi,是 Spring 中较æˆ�熟的å­�模å�—之一。它是一款å�¯ä»¥å®šåˆ¶åŒ–的身份验è¯�和访问控制框架。 | +| Spring Mobile | 是对 Spring MVC 的扩展,用æ�¥ç®€åŒ–移动端 Web 应用的开å�‘。 | +| Spring Boot | 是 Spring 团队æ��供的全新框架,它为 Spring 以å�Šç¬¬ä¸‰æ–¹åº“一些开箱å�³ç”¨çš„é…�置,å�¯ä»¥ç®€åŒ– Spring 应用的æ�­å»ºå�Šå¼€å�‘过程。 | +| Spring Cloud | 一款基于 Spring Boot 实现的微æœ�务框架。它并ä¸�是æŸ�一门技术,而是一系列微æœ�务解决方案或框架的有åº�集å�ˆã€‚它将市é�¢ä¸Šæˆ�熟的ã€�ç»�过验è¯�的微æœ�务框架整å�ˆèµ·æ�¥ï¼Œå¹¶é€šè¿‡ Spring Boot çš„æ€�想进行å†�å°�装,å±�蔽调其中å¤�æ�‚çš„é…�置和实现原ç�†ï¼Œæœ€ç»ˆä¸ºå¼€å�‘人员æ��供了一套简å�•易懂ã€�易部署和易维护的分布å¼�系统开å�‘工具包。 | -### ÏÁÒåµÄ Spring£ºSpring Framework +### 狭义的 Spring:Spring Framework -ÏÁÒåµÄ Spring ÌØÖ¸ Spring Framework£¬Í¨³£ÎÒÃǽ«Ëü³ÆÎª Spring ¿ò¼Ü¡£ +狭义的 Spring 特指 Spring Framework,通常我们将它称为 Spring 框架。 -Spring ¿ò¼ÜÊÇÒ»¸ö·Ö²ãµÄ¡¢ÃæÏòÇÐÃæµÄ Java Ó¦ÓóÌÐòµÄһվʽÇáÁ¿¼¶½â¾ö·½°¸£¬ËüÊÇ Spring ¼¼ÊõÕ»µÄºËÐĺͻù´¡£¬ÊÇΪÁ˽â¾öÆóÒµ¼¶Ó¦Óÿª·¢µÄ¸´ÔÓÐÔ¶ø´´½¨µÄ¡£ +Spring 框架是一个分层的ã€�é�¢å�‘切é�¢çš„ Java 应用程åº�的一站å¼�è½»é‡�级解决方案,它是 Spring 技术栈的核心和基础,是为了解决ä¼�业级应用开å�‘çš„å¤�æ�‚性而创建的。 -Spring ÓÐÁ½¸öºËÐIJ¿·Ö£º IoC ºÍ AOP¡£ +Spring 有两个核心部分: IoC å’Œ AOP。 -| ºËÐÄ | ÃèÊö | +| 核心 | æ��è¿° | | --- | --- | -| IOC | Inverse of Control µÄ¼òд£¬ÒëΪ¡°¿ØÖÆ·´×ª¡±£¬Ö¸°Ñ´´½¨¶ÔÏó¹ý³Ì½»¸ø Spring ½øÐйÜÀí¡£ | -| AOP | Aspect Oriented Programming µÄ¼òд£¬ÒëΪ¡°ÃæÏòÇÐÃæ±à³Ì¡±¡£AOP ÓÃÀ´·â×°¶à¸öÀàµÄ¹«¹²ÐÐΪ£¬½«ÄÇЩÓëÒµÎñÎ޹أ¬È´ÎªÒµÎñÄ£¿éËù¹²Í¬µ÷ÓõÄÂß¼­·â×°ÆðÀ´£¬¼õÉÙϵͳµÄÖØ¸´´úÂ룬½µµÍÄ£¿é¼äµÄñîºÏ¶È¡£ÁíÍ⣬AOP »¹½â¾öһЩϵͳ²ãÃæÉϵÄÎÊÌ⣬±ÈÈçÈÕÖ¾¡¢ÊÂÎñ¡¢È¨Ï޵ȡ£ | +| IOC | Inverse of Control 的简写,译为“控制å��转â€�,指把创建对象过程交给 Spring 进行管ç�†ã€‚ | +| AOP | Aspect Oriented Programming 的简写,译为“é�¢å�‘切é�¢ç¼–程â€�。AOP 用æ�¥å°�装多个类的公共行为,将那些与业务无关,å�´ä¸ºä¸šåŠ¡æ¨¡å�—所共å�Œè°ƒç”¨çš„逻辑å°�装起æ�¥ï¼Œå‡�少系统的é‡�å¤�代ç �,é™�低模å�—间的耦å�ˆåº¦ã€‚å�¦å¤–,AOP 还解决一些系统层é�¢ä¸Šçš„问题,比如日志ã€�事务ã€�æ�ƒé™�等。 | -Spring ÊÇÒ»ÖÖ»ùÓÚ Bean µÄ±à³Ì¼¼Êõ£¬ËüÉî¿ÌµØ¸Ä±ä×Å Java ¿ª·¢ÊÀ½ç¡£Spring ʹÓüòµ¥¡¢»ù±¾µÄ Java Bean À´Íê³ÉÒÔǰֻÓÐ EJB ²ÅÄÜÍê³ÉµÄ¹¤×÷£¬Ê¹µÃºÜ¶à¸´ÔӵĴúÂë±äµÃÓÅÑźͼò½à£¬±ÜÃâÁË EJB Ó·Öס¢µÍЧµÄ¿ª·¢Ä£Ê½£¬¼«´óµÄ·½±ãÏîÄ¿µÄºóÆÚά»¤¡¢Éý¼¶ºÍÀ©Õ¹¡£ +Spring 是一ç§�基于 Bean 的编程技术,它深刻地改å�˜ç�€ Java å¼€å�‘世界。Spring 使用简å�•ã€�基本的 Java Bean æ�¥å®Œæˆ�以å‰�å�ªæœ‰ EJB æ‰�能完æˆ�的工作,使得很多å¤�æ�‚的代ç �å�˜å¾—优雅和简æ´�,é�¿å…�了 EJB 臃肿ã€�低效的开å�‘模å¼�,æž�大的方便项目的å�ŽæœŸç»´æŠ¤ã€�å�‡çº§å’Œæ‰©å±•。 -ÔÚʵ¼Ê¿ª·¢ÖУ¬·þÎñÆ÷¶ËÓ¦ÓóÌÐòͨ³£²ÉÓÃÈý²ãÌåϵ¼Ü¹¹£¬·Ö±ðΪ±íÏֲ㣨web£©¡¢ÒµÎñÂß¼­²ã£¨service£©¡¢³Ö¾Ã²ã£¨dao£©¡£ +在实际开å�‘中,æœ�务器端应用程åº�通常采用三层体系架构,分别为表现层(web)ã€�业务逻辑层(service)ã€�æŒ�久层(dao)。 -Spring ÖÂÁ¦ÓÚ Java EE Ó¦Óø÷²ãµÄ½â¾ö·½°¸£¬¶Ôÿһ²ã¶¼ÌṩÁ˼¼ÊõÖ§³Ö¡£ +Spring 致力于 Java EE 应用å�„层的解决方案,对æ¯�一层都æ��供了技术支æŒ�。 -* ÔÚ±íÏÖ²ãÌṩÁË¶Ô Spring MVC¡¢Struts2 µÈ¿ò¼ÜµÄÕûºÏ£» -* ÔÚÒµÎñÂß¼­²ãÌṩÁ˹ÜÀíÊÂÎñºÍ¼Ç¼ÈÕÖ¾µÄ¹¦ÄÜ£» -* Ôڳ־ò㻹¿ÉÒÔÕûºÏ MyBatis¡¢Hibernate ºÍ JdbcTemplate µÈ¼¼Êõ£¬¶ÔÊý¾Ý¿â½øÐзÃÎÊ¡£ +* 在表现层æ��供了对 Spring MVCã€�Struts2 等框架的整å�ˆï¼› +* 在业务逻辑层æ��供了管ç�†äº‹åŠ¡å’Œè®°å½•æ—¥å¿—çš„åŠŸèƒ½ï¼› +* 在æŒ�久层还å�¯ä»¥æ•´å�ˆ MyBatisã€�Hibernate å’Œ JdbcTemplate 等技术,对数æ�®åº“进行访问。 -Õâ³ä·ÖµØÌåÏÖÁË Spring ÊÇÒ»¸öÈ«ÃæµÄ½â¾ö·½°¸£¬¶ÔÓÚÄÇЩÒѾ­ÓнϺýâ¾ö·½°¸µÄÁìÓò£¬Spring ¾ø²»×öÖØ¸´µÄÊÂÇé¡£ +这充分地体现了 Spring 是一个全é�¢çš„解决方案,对于那些已ç»�有较好解决方案的领域,Spring ç»�ä¸�å�šé‡�å¤�的事情。 -´ÓÉè¼ÆÉÏ¿´£¬Spring ¿ò¼Ü¸øÓèÁË Java ³ÌÐòÔ±¸ü¸ßµÄ×ÔÓɶȣ¬¶ÔÒµ½çµÄ³£¼ûÎÊÌâÒ²ÌṩÁËÁ¼ºÃµÄ½â¾ö·½°¸£¬Òò´ËÔÚ¿ªÔ´ÉçÇøÊܵ½Á˹㷺µÄ»¶Ó­£¬²¢ÇÒ±»´ó²¿·Ö¹«Ë¾×÷Ϊ Java ÏîÄ¿¿ª·¢µÄÊ×Ñ¡¿ò¼Ü¡£ +从设计上看,Spring 框架给予了 Java 程åº�员更高的自由度,对业界的常è§�问题也æ��供了良好的解决方案,因此在开æº�社区å�—到了广泛的欢迎,并且被大部分公å�¸ä½œä¸º Java 项目开å�‘的首选框架。 -## Spring Framework µÄÌØµã +## Spring Framework 的特点 -Spring ¿ò¼Ü¾ßÓÐÒÔϼ¸¸öÌØµã¡£ +Spring 框架具有以下几个特点。 -### **·½±ã½âñ¼ò»¯¿ª·¢** +### **方便解耦,简化开å�‘** -Spring ¾ÍÊÇÒ»¸ö´ó¹¤³§£¬¿ÉÒÔ½«ËùÓжÔÏóµÄ´´½¨ºÍÒÀÀµ¹ØÏµµÄά»¤½»¸ø Spring ¹ÜÀí¡£ +Spring 就是一个大工厂,å�¯ä»¥å°†æ‰€æœ‰å¯¹è±¡çš„创建和ä¾�赖关系的维护交给 Spring 管ç�†ã€‚ -### **·½±ã¼¯³É¸÷ÖÖÓÅÐã¿ò¼Ü** +### **方便集æˆ�å�„ç§�优秀框架** -Spring ²»Åųâ¸÷ÖÖÓÅÐãµÄ¿ªÔ´¿ò¼Ü£¬ÆäÄÚ²¿ÌṩÁ˶Ը÷ÖÖÓÅÐã¿ò¼Ü£¨Èç Struts2¡¢Hibernate¡¢MyBatis µÈ£©µÄÖ±½ÓÖ§³Ö¡£ +Spring ä¸�排斥å�„ç§�优秀的开æº�框架,其内部æ��供了对å�„ç§�优秀框架(如 Struts2ã€�Hibernateã€�MyBatis 等)的直接支æŒ�。 -### **½µµÍ Java EE API µÄʹÓÃÄѶÈ** +### **é™�低 Java EE API 的使用难度** -Spring ¶Ô Java EE ¿ª·¢Öзdz£ÄÑÓõÄһЩ API£¨JDBC¡¢JavaMail¡¢Ô¶³Ìµ÷Óõȣ©¶¼ÌṩÁË·â×°£¬Ê¹ÕâЩ API Ó¦ÓõÄÄѶȴó´ó½µµÍ¡£ +Spring 对 Java EE å¼€å�‘中é�žå¸¸éš¾ç”¨çš„一些 API(JDBCã€�JavaMailã€�远程调用等)都æ��供了å°�装,使这些 API 应用的难度大大é™�低。 -### **·½±ã³ÌÐòµÄ²âÊÔ** +### **方便程åº�的测试** -Spring Ö§³Ö JUnit4£¬¿ÉÒÔͨ¹ý×¢½â·½±ãµØ²âÊÔ Spring ³ÌÐò¡£ +Spring 支æŒ� JUnit4,å�¯ä»¥é€šè¿‡æ³¨è§£æ–¹ä¾¿åœ°æµ‹è¯• Spring 程åº�。 -### **AOP ±à³ÌµÄÖ§³Ö** +### **AOP 编程的支æŒ�** -Spring Ìá¹©ÃæÏòÇÐÃæ±à³Ì£¬¿ÉÒÔ·½±ãµØÊµÏÖ¶Ô³ÌÐò½øÐÐȨÏÞÀ¹½ØºÍÔËÐÐ¼à¿ØµÈ¹¦ÄÜ¡£ +Spring æ��ä¾›é�¢å�‘切é�¢ç¼–程,å�¯ä»¥æ–¹ä¾¿åœ°å®žçŽ°å¯¹ç¨‹åº�进行æ�ƒé™�拦截和è¿�行监控等功能。 -### **ÉùÃ÷ʽÊÂÎñµÄÖ§³Ö** +### **声明å¼�事务的支æŒ�** -Ö»ÐèҪͨ¹ýÅäÖþͿÉÒÔÍê³É¶ÔÊÂÎñµÄ¹ÜÀí£¬¶øÎÞÐëÊÖ¶¯±à³Ì¡£ +å�ªéœ€è¦�通过é…�置就å�¯ä»¥å®Œæˆ�对事务的管ç�†ï¼Œè€Œæ— é¡»æ‰‹åŠ¨ç¼–ç¨‹ã€‚ -Spring ¿ò¼Ü»ù±¾º­¸ÇÁËÆóÒµ¼¶Ó¦Óÿª·¢µÄ¸÷¸ö·½Ã棬Ëü°üº¬ÁË 20 ¶à¸ö²»Í¬µÄÄ£¿é¡£ +Spring 框架基本涵盖了ä¼�业级应用开å�‘çš„å�„个方é�¢ï¼Œå®ƒåŒ…å�«äº† 20 多个ä¸�å�Œçš„æ¨¡å�—。 spring-aop spring-context-indexer spring-instrument spring-orm spring-web spring-aspects spring-context-support spring-jcl spring-oxm spring-webflux @@ -98,48 +98,48 @@ spring-beans spring-core spring-jdbc spring-r2dbc spring- spring-context spring-expression spring-jms spring-test spring-websocket spring-messaging spring-tx -![SpringÌåϵ½á¹¹Í¼](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/163550G63-0.png) -ͼ1£ºSpring¼Ü¹¹Í¼ +![Spring体系结构图](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/163550G63-0.png) +图1:Spring架构图 -ÉÏͼÖаüº¬ÁË Spring ¿ò¼ÜµÄËùÓÐÄ£¿é£¬ÕâЩģ¿é¿ÉÒÔÂú×ãÒ»ÇÐÆóÒµ¼¶Ó¦Óÿª·¢µÄÐèÇó£¬ÔÚ¿ª·¢¹ý³ÌÖпÉÒÔ¸ù¾ÝÐèÇóÓÐÑ¡ÔñÐÔµØÊ¹ÓÃËùÐèÒªµÄÄ£¿é¡£ÏÂÃæ·Ö±ð¶ÔÕâЩģ¿éµÄ×÷ÓýøÐмòµ¥½éÉÜ¡£ +上图中包å�«äº† Spring 框架的所有模å�—,这些模å�—å�¯ä»¥æ»¡è¶³ä¸€åˆ‡ä¼�业级应用开å�‘的需求,在开å�‘过程中å�¯ä»¥æ ¹æ�®éœ€æ±‚有选择性地使用所需è¦�的模å�—。下é�¢åˆ†åˆ«å¯¹è¿™äº›æ¨¡å�—的作用进行简å�•介ç»�。 -## 1\. Data Access/Integration£¨Êý¾Ý·ÃÎÊ£¯¼¯³É£© +## 1\. Data Access/Integration(数æ�®è®¿é—®ï¼�集æˆ�) -Êý¾Ý·ÃÎÊ£¯¼¯³É²ã°üÀ¨ JDBC¡¢ORM¡¢OXM¡¢JMS ºÍ Transactions Ä£¿é£¬¾ßÌå½éÉÜÈçÏ¡£ +æ•°æ�®è®¿é—®ï¼�集æˆ�层包括 JDBCã€�ORMã€�OXMã€�JMS å’Œ Transactions 模å�—,具体介ç»�如下。 -* JDBC Ä£¿é£ºÌṩÁËÒ»¸ö JBDC µÄÑùÀýÄ£°å£¬Ê¹ÓÃÕâЩģ°åÄÜÏû³ý´«Í³Èß³¤µÄ JDBC ±àÂ뻹ÓбØÐëµÄÊÂÎñ¿ØÖÆ£¬¶øÇÒÄÜÏíÊܵ½ Spring ¹ÜÀíÊÂÎñµÄºÃ´¦¡£ -* ORM Ä£¿é£ºÌṩÓëÁ÷Ðеġ°¶ÔÏó-¹ØÏµ¡±Ó³Éä¿ò¼ÜÎ޷켯³ÉµÄ API£¬°üÀ¨ JPA¡¢JDO¡¢Hibernate ºÍ MyBatis µÈ¡£¶øÇÒ»¹¿ÉÒÔʹÓà Spring ÊÂÎñ¹ÜÀí£¬ÎÞÐè¶îÍâ¿ØÖÆÊÂÎñ¡£ -* OXM Ä£¿é£ºÌṩÁËÒ»¸öÖ§³Ö Object /XML Ó³ÉäµÄ³éÏó²ãʵÏÖ£¬Èç JAXB¡¢Castor¡¢XMLBeans¡¢JiBX ºÍ XStream¡£½« Java ¶ÔÏóÓ³Éä³É XML Êý¾Ý£¬»òÕß½«XML Êý¾ÝÓ³Éä³É Java ¶ÔÏó¡£ -* JMS Ä£¿é£ºÖ¸ Java ÏûÏ¢·þÎñ£¬ÌṩһÌ× ¡°ÏûÏ¢Éú²úÕß¡¢ÏûÏ¢Ïû·ÑÕß¡±Ä£°åÓÃÓÚ¸ü¼Ó¼òµ¥µÄʹÓà JMS£¬JMS ÓÃÓÚÓÃÓÚÔÚÁ½¸öÓ¦ÓóÌÐòÖ®¼ä£¬»ò·Ö²¼Ê½ÏµÍ³Öз¢ËÍÏûÏ¢£¬½øÐÐÒ첽ͨÐÅ¡£ -* Transactions ÊÂÎñÄ£¿é£ºÖ§³Ö±à³ÌºÍÉùÃ÷ʽÊÂÎñ¹ÜÀí¡£ +* JDBC 模å�—:æ��供了一个 JBDC 的样例模æ�¿ï¼Œä½¿ç”¨è¿™äº›æ¨¡æ�¿èƒ½æ¶ˆé™¤ä¼ ç»Ÿå†—é•¿çš„ JDBC ç¼–ç �还有必须的事务控制,而且能享å�—到 Spring 管ç�†äº‹åŠ¡çš„å¥½å¤„ã€‚ +* ORM 模å�—:æ��供与æµ�行的“对象-关系â€�映射框架无ç¼�集æˆ�çš„ API,包括 JPAã€�JDOã€�Hibernate å’Œ MyBatis 等。而且还å�¯ä»¥ä½¿ç”¨ Spring 事务管ç�†ï¼Œæ— éœ€é¢�外控制事务。 +* OXM 模å�—:æ��供了一个支æŒ� Object /XML 映射的抽象层实现,如 JAXBã€�Castorã€�XMLBeansã€�JiBX å’Œ XStream。将 Java 对象映射æˆ� XML æ•°æ�®ï¼Œæˆ–者将XML æ•°æ�®æ˜ å°„æˆ� Java 对象。 +* JMS 模å�—:指 Java 消æ�¯æœ�务,æ��供一套 “消æ�¯ç”Ÿäº§è€…ã€�消æ�¯æ¶ˆè´¹è€…â€�模æ�¿ç”¨äºŽæ›´åŠ ç®€å�•的使用 JMS,JMS 用于用于在两个应用程åº�之间,或分布å¼�系统中å�‘é€�消æ�¯ï¼Œè¿›è¡Œå¼‚步通信。 +* Transactions 事务模å�—:支æŒ�编程和声明å¼�事务管ç�†ã€‚ -## 2\. Web Ä£¿é +## 2\. Web 模å�— -Spring µÄ Web ²ã°üÀ¨ Web¡¢Servlet¡¢WebSocket ºÍ Portlet ×é¼þ£¬¾ßÌå½éÉÜÈçÏ¡£ +Spring çš„ Web 层包括 Webã€�Servletã€�WebSocket å’Œ Portlet 组件,具体介ç»�如下。 -* Web Ä£¿é£ºÌṩÁË»ù±¾µÄ Web ¿ª·¢¼¯³ÉÌØÐÔ£¬ÀýÈç¶àÎļþÉÏ´«¹¦ÄÜ¡¢Ê¹ÓÃµÄ Servlet ¼àÌýÆ÷µÄ IOC ÈÝÆ÷³õʼ»¯ÒÔ¼° Web Ó¦ÓÃÉÏÏÂÎÄ¡£ -* Servlet Ä£¿é£ºÌṩÁËÒ»¸ö Spring MVC Web ¿ò¼ÜʵÏÖ¡£Spring MVC ¿ò¼ÜÌṩÁË»ùÓÚ×¢½âµÄÇëÇó×ÊÔ´×¢Èë¡¢¸ü¼òµ¥µÄÊý¾Ý°ó¶¨¡¢Êý¾ÝÑéÖ¤µÈ¼°Ò»Ì׷dz£Ò×ÓÃµÄ JSP ±êÇ©£¬ÍêÈ«ÎÞ·ìÓë Spring ÆäËû¼¼ÊõЭ×÷¡£ -* WebSocket Ä£¿é£ºÌṩÁ˼òµ¥µÄ½Ó¿Ú£¬Óû§Ö»ÒªÊµÏÖÏìÓ¦µÄ½Ó¿Ú¾Í¿ÉÒÔ¿ìËٵĴ WebSocket Server£¬´Ó¶øÊµÏÖË«ÏòͨѶ¡£ -* Portlet Ä£¿é£ºÌṩÁËÔÚ Portlet »·¾³ÖÐʹÓà MVC ʵÏÖ£¬ÀàËÆ Web-Servlet Ä£¿éµÄ¹¦ÄÜ¡£ +* Web 模å�—:æ��供了基本的 Web å¼€å�‘集æˆ�特性,例如多文件上传功能ã€�使用的 Servlet 监å�¬å™¨çš„ IOC 容器åˆ�始化以å�Š Web 应用上下文。 +* Servlet 模å�—:æ��供了一个 Spring MVC Web 框架实现。Spring MVC 框架æ��供了基于注解的请求资æº�注入ã€�更简å�•的数æ�®ç»‘定ã€�æ•°æ�®éªŒè¯�ç­‰å�Šä¸€å¥—é�žå¸¸æ˜“用的 JSP 标签,完全无ç¼�与 Spring 其他技术å��作。 +* WebSocket 模å�—:æ��供了简å�•的接å�£ï¼Œç”¨æˆ·å�ªè¦�实现å“�应的接å�£å°±å�¯ä»¥å¿«é€Ÿçš„æ�­å»º WebSocket Server,从而实现å�Œå�‘通讯。 +* Portlet 模å�—:æ��供了在 Portlet 环境中使用 MVC 实现,类似 Web-Servlet 模å�—的功能。 -## 3\. Core Container£¨Spring µÄºËÐÄÈÝÆ÷£© +## 3\. Core Container(Spring 的核心容器) -Spring µÄºËÐÄÈÝÆ÷ÊÇÆäËûÄ£¿é½¨Á¢µÄ»ù´¡£¬ÓÉ Beans Ä£¿é¡¢Core ºËÐÄÄ£¿é¡¢Context ÉÏÏÂÎÄÄ£¿éºÍ SpEL ±í´ïʽÓïÑÔÄ£¿é×é³É£¬Ã»ÓÐÕâЩºËÐÄÈÝÆ÷£¬Ò²²»¿ÉÄÜÓÐ AOP¡¢Web µÈÉϲãµÄ¹¦ÄÜ¡£¾ßÌå½éÉÜÈçÏ¡£ +Spring 的核心容器是其他模å�—建立的基础,由 Beans 模å�—ã€�Core 核心模å�—ã€�Context 上下文模å�—å’Œ SpEL 表达å¼�语言模å�—组æˆ�,没有这些核心容器,也ä¸�å�¯èƒ½æœ‰ AOPã€�Web 等上层的功能。具体介ç»�如下。 -* Beans Ä£¿é£ºÌṩÁË¿ò¼ÜµÄ»ù´¡²¿·Ö£¬°üÀ¨¿ØÖÆ·´×ªºÍÒÀÀµ×¢Èë¡£ -* Core ºËÐÄÄ£¿é£º·â×°ÁË Spring ¿ò¼ÜµÄµ×²ã²¿·Ö£¬°üÀ¨×ÊÔ´·ÃÎÊ¡¢ÀàÐÍת»»¼°Ò»Ð©³£Óù¤¾ßÀà¡£ -* Context ÉÏÏÂÎÄÄ£¿é£º½¨Á¢ÔÚ Core ºÍ Beans Ä£¿éµÄ»ù´¡Ö®ÉÏ£¬¼¯³É Beans Ä£¿é¹¦Äܲ¢Ìí¼Ó×ÊÔ´°ó¶¨¡¢Êý¾ÝÑéÖ¤¡¢¹ú¼Ê»¯¡¢Java EE Ö§³Ö¡¢ÈÝÆ÷ÉúÃüÖÜÆÚ¡¢Ê¼þ´«²¥µÈ¡£ApplicationContext ½Ó¿ÚÊÇÉÏÏÂÎÄÄ£¿éµÄ½¹µã¡£ -* SpEL Ä£¿é£ºÌṩÁËÇ¿´óµÄ±í´ïʽÓïÑÔÖ§³Ö£¬Ö§³Ö·ÃÎʺÍÐÞ¸ÄÊôÐÔÖµ£¬·½·¨µ÷Óã¬Ö§³Ö·ÃÎʼ°ÐÞ¸ÄÊý×é¡¢ÈÝÆ÷ºÍË÷ÒýÆ÷£¬ÃüÃû±äÁ¿£¬Ö§³ÖËãÊýºÍÂß¼­ÔËË㣬֧³Ö´Ó Spring ÈÝÆ÷»ñÈ¡ Bean£¬ËüÒ²Ö§³ÖÁбíͶӰ¡¢Ñ¡ÔñºÍÒ»°ãµÄÁбí¾ÛºÏµÈ¡£ +* Beans 模å�—:æ��供了框架的基础部分,包括控制å��转和ä¾�赖注入。 +* Core 核心模å�—:å°�装了 Spring 框架的底层部分,包括资æº�访问ã€�类型转æ�¢å�Šä¸€äº›å¸¸ç”¨å·¥å…·ç±»ã€‚ +* Context 上下文模å�—:建立在 Core å’Œ Beans 模å�—的基础之上,集æˆ� Beans 模å�—功能并添加资æº�绑定ã€�æ•°æ�®éªŒè¯�ã€�国际化ã€�Java EE 支æŒ�ã€�容器生命周期ã€�事件传播等。ApplicationContext 接å�£æ˜¯ä¸Šä¸‹æ–‡æ¨¡å�—的焦点。 +* SpEL 模å�—:æ��供了强大的表达å¼�语言支æŒ�,支æŒ�访问和修改属性值,方法调用,支æŒ�访问å�Šä¿®æ”¹æ•°ç»„ã€�容器和索引器,命å��å�˜é‡�,支æŒ�算数和逻辑è¿�算,支æŒ�从 Spring 容器获å�– Bean,它也支æŒ�列表投影ã€�选择和一般的列表è�šå�ˆç­‰ã€‚ -## 4\. AOP¡¢Aspects¡¢Instrumentation ºÍ Messaging +## 4\. AOPã€�Aspectsã€�Instrumentation å’Œ Messaging -ÔÚ Core Container Ö®ÉÏÊÇ AOP¡¢Aspects µÈÄ£¿é£¬¾ßÌå½éÉÜÈçÏ£º +在 Core Container 之上是 AOPã€�Aspects 等模å�—,具体介ç»�如下: -* AOP Ä£¿é£ºÌṩÁËÃæÏòÇÐÃæ±à³ÌʵÏÖ£¬Ìṩ±ÈÈçÈÕÖ¾¼Ç¼¡¢È¨ÏÞ¿ØÖÆ¡¢ÐÔÄÜͳ¼ÆµÈͨÓù¦ÄܺÍÒµÎñÂß¼­·ÖÀëµÄ¼¼Êõ£¬²¢ÇÒÄܶ¯Ì¬µÄ°ÑÕâЩ¹¦ÄÜÌí¼Óµ½ÐèÒªµÄ´úÂëÖУ¬ÕâÑù¸÷˾ÆäÖ°£¬½µµÍÒµÎñÂß¼­ºÍͨÓù¦ÄܵÄñîºÏ¡£ -* Aspects Ä£¿é£ºÌṩÓë AspectJ µÄ¼¯³É£¬ÊÇÒ»¸ö¹¦ÄÜÇ¿´óÇÒ³ÉÊìµÄÃæÏòÇÐÃæ±à³Ì£¨AOP£©¿ò¼Ü¡£ -* Instrumentation Ä£¿é£ºÌṩÁËÀ๤¾ßµÄÖ§³ÖºÍÀà¼ÓÔØÆ÷µÄʵÏÖ£¬¿ÉÒÔÔÚÌØ¶¨µÄÓ¦Ó÷þÎñÆ÷ÖÐʹÓᣠ-* messaging Ä£¿é£ºSpring 4.0 ÒÔºóÐÂÔöÁËÏûÏ¢£¨Spring-messaging£©Ä£¿é£¬¸ÃÄ£¿éÌṩÁ˶ÔÏûÏ¢´«µÝÌåϵ½á¹¹ºÍЭÒéµÄÖ§³Ö¡£ +* AOP 模å�—:æ��供了é�¢å�‘切é�¢ç¼–程实现,æ��供比如日志记录ã€�æ�ƒé™�控制ã€�性能统计等通用功能和业务逻辑分离的技术,并且能动æ€�的把这些功能添加到需è¦�的代ç �中,这样å�„å�¸å…¶è�Œï¼Œé™�低业务逻辑和通用功能的耦å�ˆã€‚ +* Aspects 模å�—:æ��供与 AspectJ 的集æˆ�,是一个功能强大且æˆ�熟的é�¢å�‘切é�¢ç¼–程(AOP)框架。 +* Instrumentation 模å�—:æ��供了类工具的支æŒ�和类加载器的实现,å�¯ä»¥åœ¨ç‰¹å®šçš„应用æœ�务器中使用。 +* messaging 模å�—:Spring 4.0 以å�Žæ–°å¢žäº†æ¶ˆæ�¯ï¼ˆSpring-messaging)模å�—,该模å�—æ��供了对消æ�¯ä¼ é€’体系结构和å��议的支æŒ�。 -## 5\. Test Ä£¿é +## 5\. Test 模å�— -Test Ä£¿é£ºSpring Ö§³Ö Junit ºÍ TestNG ²âÊÔ¿ò¼Ü£¬¶øÇÒ»¹¶îÍâÌṩÁËһЩ»ùÓÚ Spring µÄ²âÊÔ¹¦ÄÜ£¬±ÈÈçÔÚ²âÊÔ Web ¿ò¼Üʱ£¬Ä£Äâ Http ÇëÇóµÄ¹¦ÄÜ¡£ \ No newline at end of file +Test 模å�—:Spring 支æŒ� Junit å’Œ TestNG 测试框架,而且还é¢�外æ��供了一些基于 Spring 的测试功能,比如在测试 Web 框架时,模拟 Http 请求的功能。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/\347\254\254\344\270\200\344\270\252Spring\345\272\224\347\224\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/\347\254\254\344\270\200\344\270\252Spring\345\272\224\347\224\250.md" index b40a369..65b036b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/\347\254\254\344\270\200\344\270\252Spring\345\272\224\347\224\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring/\347\254\254\344\270\200\344\270\252Spring\345\272\224\347\224\250.md" @@ -1,5 +1,5 @@ -## Ìí¼ÓÒÀÀµ -ÕâÀïÎÒÃÇ¿ÉÒÔÏ顄 Spring »ù´¡ Jar °üÒÔ¼° Commons-loggin µ¼Èëµ½ÏîÄ¿ÖУ¬ÈôºóÐø¹¦ÄÜÔö¼Ó£¬Ôò¸ù¾ÝÐèÒªÔÙµ¼Èë Spring µÄÆäËû Jar¡£ +## 添加ä¾�èµ– +这里我们å�¯ä»¥å…ˆæŠŠ Spring 基础 Jar 包以å�Š Commons-loggin 导入到项目中,若å�Žç»­åŠŸèƒ½å¢žåŠ ï¼Œåˆ™æ ¹æ�®éœ€è¦�å†�导入 Spring 的其他 Jar。 ```` org.springframework.core-5.3.13.jar @@ -8,12 +8,12 @@ spring-context-5.3.13.jar spring-expression-5.3.13.jar commons.logging-1.2.jar ```` -µ±È»ÕâÀïÎÒÃÇÍÆ¼öʹÓÃmaven¹ÜÀíÒÀÀµ +当然这里我们推è��使用maven管ç�†ä¾�èµ– -## ´´½¨ Java Àà - ÔÚ HelloSpring Öд´½¨ net.biancheng.c °ü£¬È»ºóÔÚÕâ¸ö°üÏ´´½¨ HelloWorld.java ºÍ MainApp.java Àà¡£ +## 创建 Java ç±» + 在 HelloSpring 中创建 net.biancheng.c 包,然å�Žåœ¨è¿™ä¸ªåŒ…下创建 HelloWorld.java å’Œ MainApp.java 类。 -HelloWorld.java ÀàµÄ´úÂëÈçÏ +HelloWorld.java 类的代ç �如下 ```` package net.biancheng.c; public class HelloWorld { @@ -26,7 +26,7 @@ public class HelloWorld { } } ```` -MainApp.java ÀàµÄ´úÂëÈçÏ +MainApp.java 类的代ç �如下 ```` package net.biancheng.c; import org.springframework.context.ApplicationContext; @@ -40,14 +40,14 @@ import org.springframework.context.support.ClassPathXmlApplicationContext; } } ```` -¹ØÓÚÒÔÉÏ´úÂ룬ÐèҪעÒâÒÔÏÂÁ½µã£º +关于以上代ç �,需è¦�注æ„�以下两点: -´´½¨ ApplicationContext ¶ÔÏóʱʹÓÃÁË ClassPathXmlApplicationContext À࣬Õâ¸öÀàÓÃÓÚ¼ÓÔØ Spring ÅäÖÃÎļþ¡¢´´½¨ºÍ³õʼ»¯ËùÓжÔÏó£¨Bean£©¡£ -ApplicationContext.getBean() ·½·¨ÓÃÀ´»ñÈ¡ Bean£¬¸Ã·½·¨·µ»ØÖµÀàÐÍΪ Object£¬Í¨¹ýÇ¿ÖÆÀàÐÍת»»Îª HelloWorld µÄʵÀý¶ÔÏ󣬵÷ÓÃÆäÖÐµÄ getMessage() ·½·¨¡£ +创建 ApplicationContext 对象时使用了 ClassPathXmlApplicationContext 类,这个类用于加载 Spring é…�置文件ã€�创建和åˆ�始化所有对象(Bean)。 +ApplicationContext.getBean() 方法用æ�¥èŽ·å�– Bean,该方法返回值类型为 Object,通过强制类型转æ�¢ä¸º HelloWorld 的实例对象,调用其中的 getMessage() 方法。 -## ´´½¨ÅäÖÃÎļþ +## 创建é…�置文件 -ÔÚ src Ŀ¼Ï£¬´´½¨Ò»¸ö Spring ÅäÖÃÎļþ Beans.xml£¬ÄÚÈÝÈçÏ¡£ +在 src 目录下,创建一个 Spring é…�置文件 Beans.xml,内容如下。 ```` ```` -ÎÒÃÇÒ²¿ÉÒÔ½«¸ÃÅäÖÃÎļþÃüÃûΪÆäËüÓÐЧµÄÃû³Æ£¬µ«ÐèҪעÒâµÄÊÇ£¬¸ÃÎļþÃû±ØÐëÓë MainApp.java ÖжÁÈ¡µÄÅäÖÃÎļþÃû³ÆÒ»Ö¡£ +我们也å�¯ä»¥å°†è¯¥é…�置文件命å��为其它有效的å��称,但需è¦�注æ„�的是,该文件å��必须与 MainApp.java 中读å�–çš„é…�置文件å��称一致。 -Beans.xml ÓÃÓÚ¸ø²»Í¬µÄ Bean ·ÖÅäΨһµÄ ID£¬²¢¸øÏàÓ¦µÄ Bean ÊôÐÔ¸³Öµ¡£ÀýÈ磬ÔÚÒÔÉÏ´úÂëÖУ¬ÎÒÃÇ¿ÉÒÔÔÚ²»Ó°ÏìÆäËüÀàµÄÇé¿öÏ£¬¸ø message ±äÁ¿¸³Öµ¡£ -## ÔËÐгÌÐò +Beans.xml 用于给ä¸�å�Œçš„ Bean 分é…�唯一的 ID,并给相应的 Bean 属性赋值。例如,在以上代ç �中,我们å�¯ä»¥åœ¨ä¸�å½±å“�其它类的情况下,给 message å�˜é‡�赋值。 +## è¿�行程åº� - ÔËÐÐ MainApp.java£¬Eclipse IDE ¿ØÖÆÌ¨ÖÐÏÔʾÐÅÏ¢ÈçÏ¡£ + è¿�行 MainApp.java,Eclipse IDE 控制å�°ä¸­æ˜¾ç¤ºä¿¡æ�¯å¦‚下。 message : Hello World! -ÖÁ´Ë£¬ÎÒÃǾͳɹ¦´´½¨Á˵ÚÒ»¸ö Spring Ó¦ÓóÌÐò¡£ \ No newline at end of file +至此,我们就æˆ�功创建了第一个 Spring 应用程åº�。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\344\273\273\345\212\241\350\260\203\345\272\246\344\270\216@Async.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\344\273\273\345\212\241\350\260\203\345\272\246\344\270\216@Async.md" index c3bce06..375c1f9 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\344\273\273\345\212\241\350\260\203\345\272\246\344\270\216@Async.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\344\273\273\345\212\241\350\260\203\345\272\246\344\270\216@Async.md" @@ -2,9 +2,9 @@
-# Spring Bootµ÷¶È +# Spring Boot调度 -ÒÔÏÂÄÚÈݽöÊÇÕ¾³¤»òÍøÓѸöÈËѧϰ±Ê¼Ç¡¢×ܽáºÍÑо¿Êղء£²»±£Ö¤ÕýÈ·ÐÔ£¬ÒòʹÓöø´øÀ´µÄ·çÏÕÓë±¾Õ¾Î޹أ¡ +以下内容仅是站长或网å�‹ä¸ªäººå­¦ä¹ ç¬”è®°ã€�总结和研究收è—�。ä¸�ä¿�è¯�正确性,因使用而带æ�¥çš„风险与本站无关ï¼�
@@ -14,15 +14,15 @@ -µ÷¶ÈÊÇÖ´ÐÐÌØ¶¨Ê±¼ä¶ÎµÄÈÎÎñµÄ¹ý³Ì¡£Spring BootΪÔÚSpringÓ¦ÓóÌÐòÉϱàдµ÷¶È³ÌÐòÌṩÁ˺ܺõÄÖ§³Ö¡£ +调度是执行特定时间段的任务的过程。Spring Boot为在Spring应用程åº�上编写调度程åº�æ��供了很好的支æŒ�。 -## Java Cron±í´ïʽ +## Java Cron表达å¼� -Java Cron±í´ïʽÓÃÓÚÅäÖÃCronTriggerµÄʵÀý£¬ËüÊÇ`org.quartz.Trigger`µÄ×ÓÀà¡£ ÓйØJava cron±í´ïʽµÄ¸ü¶àÐÅÏ¢£¬Çë²ÎÔÄ´ËÁ´½Ó - +Java Cron表达å¼�用于é…�ç½®CronTrigger的实例,它是`org.quartz.Trigger`çš„å­�类。 有关Java cron表达å¼�的更多信æ�¯ï¼Œè¯·å�‚阅此链接 - * [https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.html](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.html) -`[@EnableScheduling](https://github.com/EnableScheduling "@EnableScheduling")`×¢½âÓÃÓÚΪӦÓóÌÐòÆôÓõ÷¶È³ÌÐò¡£½«´ËÅú×¢Ìí¼Óµ½Ö÷Spring BootÓ¦ÓóÌÐòÀàÎļþÖС£ +`[@EnableScheduling](https://github.com/EnableScheduling "@EnableScheduling")`注解用于为应用程åº�å�¯ç”¨è°ƒåº¦ç¨‹åº�。将此批注添加到主Spring Boot应用程åº�类文件中。 ``` @SpringBootApplication @@ -36,7 +36,7 @@ public class DemoApplication { ``` -`[@Scheduled](https://github.com/Scheduled "@Scheduled")`×¢½âÓÃÓÚÔÚÌØ¶¨Ê±¼ä¶ÎÄÚ´¥·¢µ÷¶È³ÌÐò¡£ +`[@Scheduled](https://github.com/Scheduled "@Scheduled")`注解用于在特定时间段内触å�‘调度程åº�。 ``` @Scheduled(cron = "0 * 9 * * ?") @@ -45,7 +45,7 @@ public void cronJobSch() throws Exception { ``` -ÒÔÏÂÊÇÒ»¸öʾÀý´úÂ룬ÑÝʾÈçºÎÔÚÿÌìÉÏÎç9:00¿ªÊ¼µ½Ã¿ÌìÉÏÎç9:59½áÊøÖ´ÐÐÈÎÎñ¡£ +以下是一个示例代ç �,演示如何在æ¯�天上å�ˆ9:00开始到æ¯�天上å�ˆ9:59结æ�Ÿæ‰§è¡Œä»»åŠ¡ã€‚ ``` package com.yiibai.demo.scheduler; @@ -68,13 +68,13 @@ public class Scheduler { ``` -ÒÔÏÂÆÁÄ»½ØÍ¼ÏÔʾÁËÓ¦ÓóÌÐòÈçºÎÔÚ`09:03:23`Æô¶¯£¬²¢ÇÒ´ÓÄÇʱÆðÿ¸ôÒ»·ÖÖÓÖ´ÐÐÒ»´Îcron×÷Òµµ÷¶È³ÌÐòÈÎÎñ¡£ +以下å±�幕截图显示了应用程åº�如何在`09:03:23`å�¯åŠ¨ï¼Œå¹¶ä¸”ä»Žé‚£æ—¶èµ·æ¯�隔一分钟执行一次cron作业调度程åº�任务。 ![](/uploads/images/2018/10/05/103218_77311.jpg) -## ¹Ì¶¨ËÙÂÊ +## 固定速率 -¹Ì¶¨ËÙÂʵ÷¶È³ÌÐòÓÃÓÚÔÚÌØ¶¨Ê±¼äÖ´ÐÐÈÎÎñ¡£Ëü²»µÈ´ýǰһ¸öÈÎÎñµÄÍê³É¡£ ÖµÊÇÒÔºÁÃëΪµ¥Î»¡£ ʾÀý´úÂëÏÔʾÔÚ´Ë´¦ - +固定速率调度程åº�用于在特定时间执行任务。它ä¸�等待å‰�一个任务的完æˆ�。 值是以毫秒为å�•ä½�。 示例代ç �显示在此处 - ``` @Scheduled(fixedRate = 1000) @@ -83,7 +83,7 @@ public void fixedRateSch() { ``` -´Ë´¦ÏÔʾÁËÓ¦ÓóÌÐòÆô¶¯Ê±Ã¿ÃëÖ´ÐÐÈÎÎñµÄʾÀý´úÂë - +此处显示了应用程åº�å�¯åŠ¨æ—¶æ¯�秒执行任务的示例代ç � - ``` package com.yiibai.demo.scheduler; @@ -107,13 +107,13 @@ public class Scheduler { ``` -Çë×¢ÒâÒÔÏÂÆÁÄ»½ØÍ¼£¬ÆäÖÐÏÔʾÁËÔÚ`09:12:00`Æô¶¯µÄÓ¦ÓóÌÐò£¬Ö®ºóÿ¸ôÒ»¸ö¹Ì¶¨ËÙÂʵ÷¶È³ÌÐòÖ´ÐÐÈÎÎñ¡£ +请注æ„�以下å±�幕截图,其中显示了在`09:12:00`å�¯åŠ¨çš„åº”ç”¨ç¨‹åº�,之å�Žæ¯�隔一个固定速率调度程åº�执行任务。 ![](/uploads/images/2018/10/05/103355_72877.jpg) -## ¹Ì¶¨ÑÓ³Ù +## 固定延迟 -¹Ì¶¨ÑÓ³Ùµ÷¶È³ÌÐòÓÃÓÚÔÚÌØ¶¨Ê±¼äÖ´ÐÐÈÎÎñ¡£ ËüÓ¦¸ÃµÈ´ýÉÏÒ»¸öÈÎÎñÍê³É¡£ ÖµÓ¦ÒÔºÁÃëΪµ¥Î»¡£ ´Ë´¦ÏÔʾʾÀý´úÂë - +固定延迟调度程åº�用于在特定时间执行任务。 它应该等待上一个任务完æˆ�。 值应以毫秒为å�•ä½�。 此处显示示例代ç � - ``` @Scheduled(fixedDelay = 1000, initialDelay = 1000) @@ -122,9 +122,9 @@ public void fixedDelaySch() { ``` -ÕâÀ`initialDelay`ÊÇÔÚ³õʼÑÓ³ÙÖµÖ®ºóµÚÒ»´ÎÖ´ÐÐÈÎÎñµÄʱ¼ä¡£ +这里,`initialDelay`是在åˆ�始延迟值之å�Žç¬¬ä¸€æ¬¡æ‰§è¡Œä»»åŠ¡çš„æ—¶é—´ã€‚ -´ÓÓ¦ÓóÌÐòÆô¶¯Íê³É`3`ÃëºóÿÃëÖ´ÐÐÒ»´ÎÈÎÎñµÄʾÀýÈçÏÂËùʾ - +从应用程åº�å�¯åŠ¨å®Œæˆ�`3`ç§’å�Žæ¯�秒执行一次任务的示例如下所示 - ``` package com.yiibai.demo.scheduler; @@ -147,53 +147,53 @@ public class Scheduler { ``` -Ö´ÐÐÉÏÃæ´úÂëºó£¬Ëü»áÏÔʾÔÚ`09:18:39`¿ªÊ¼µÄÓ¦ÓóÌÐò£¬Ã¿`3`Ãëºó£¬¹Ì¶¨Ñӳټƻ®³ÌÐòÈÎÎñ(ÿÃëÖ´ÐÐÒ»´Î)¡£ +执行上é�¢ä»£ç �å�Žï¼Œå®ƒä¼šæ˜¾ç¤ºåœ¨`09:18:39`开始的应用程åº�,æ¯�`3`ç§’å�Žï¼Œå›ºå®šå»¶è¿Ÿè®¡åˆ’程åº�任务(æ¯�秒执行一次)。 -//¸ü¶àÇëÔĶÁ£ºhttps://www.yiibai.com/spring-boot/spring_boot_scheduling.html +//更多请阅读:https://www.yiibai.com/spring-boot/spring_boot_scheduling.html -@EnableAsync ×¢½â -ҪʹÓà @Async£¬Ê×ÏÈÐèҪʹÓà @EnableAsync ×¢½â¿ªÆô Spring Boot ÖеÄÒì²½ÌØÐÔ¡£ +@EnableAsync 注解 +è¦�使用 @Async,首先需è¦�使用 @EnableAsync 注解开å�¯ Spring Boot 中的异步特性。 @Configuration @EnableAsync public class AppConfig { } -¸üÏêϸµÄÅäÖÃ˵Ã÷£¬¿ÉÒԲο¼£ºAsyncConfigurer(opens new window) +更详细的é…�置说明,å�¯ä»¥å�‚考:AsyncConfigurer(opens new window) -#@Async ×¢½â -#Ö§³ÖµÄÓ÷¨ -£¨1£©ÎÞÈë²ÎÎÞ·µ»ØÖµ·½·¨ +#@Async 注解 +#支æŒ�的用法 +(1)无入å�‚无返回值方法 -Äú¿ÉÒÔÓà @Async ×¢½âÐÞÊη½·¨£¬Õâ±íÃ÷Õâ¸ö·½·¨ÊÇÒì²½·½Ê½µ÷Ó᣻»¾ä»°Ëµ£¬³ÌÐòÔÚµ÷Óô˷½·¨Ê±»áÁ¢¼´·µ»Ø£¬¶ø·½·¨µÄʵ¼ÊÖ´Ðз¢ÉúÔÚÒÑÌá½»¸ø Spring TaskExecutor µÄÈÎÎñÖС£ÔÚ×î¼òµ¥µÄÇé¿öÏ£¬Äú¿ÉÒÔ½«×¢½âÓ¦ÓÃÓÚ·µ»Ø void µÄ·½·¨£¬ÈçÒÔÏÂʾÀýËùʾ£º +您å�¯ä»¥ç”¨ @Async 注解修饰方法,这表明这个方法是异步方å¼�调用。æ�¢å�¥è¯�说,程åº�在调用此方法时会立å�³è¿”回,而方法的实际执行å�‘生在已æ��交给 Spring TaskExecutor 的任务中。在最简å�•的情况下,您å�¯ä»¥å°†æ³¨è§£åº”用于返回 void 的方法,如以下示例所示: @Async void doSomething() { // this will be executed asynchronously } -£¨2£©ÓÐÈë²ÎÎÞ·µ»ØÖµ·½·¨ +(2)有入å�‚无返回值方法 -ÓëʹÓà @Scheduled ×¢ÊÍ×¢Ê͵ķ½·¨²»Í¬£¬ÕâЩ·½·¨¿ÉÒÔÖ¸¶¨²ÎÊý£¬ÒòΪËüÃÇÔÚÔËÐÐʱÓɵ÷ÓÃÕßÒÔ¡°Õý³£¡±·½Ê½µ÷Ó㬶ø²»ÊÇÓÉÈÝÆ÷¹ÜÀíµÄµ÷¶ÈÈÎÎñµ÷Óá£ÀýÈ磬ÒÔÏ´úÂëÊÇ @Async ×¢½âµÄºÏ·¨Ó¦Ó㺠+与使用 @Scheduled 注释注释的方法ä¸�å�Œï¼Œè¿™äº›æ–¹æ³•å�¯ä»¥æŒ‡å®šå�‚数,因为它们在è¿�行时由调用者以“正常â€�æ–¹å¼�调用,而ä¸�是由容器管ç�†çš„调度任务调用。例如,以下代ç �是 @Async 注解的å�ˆæ³•应用: @Async void doSomething(String s) { // this will be executed asynchronously } -£¨3£©ÓÐÈë²ÎÓзµ»ØÖµ·½·¨ +(3)有入å�‚有返回值方法 -ÉõÖÁ¿ÉÒÔÒì²½µ÷Ó÷µ»ØÖµµÄ·½·¨¡£µ«ÊÇ£¬ÕâЩ·½·¨ÐèÒª¾ßÓÐ Future ÀàÐ͵ķµ»ØÖµ¡£ÕâÈÔÈ»ÌṩÁËÒì²½Ö´Ðеĺô¦£¬ÒÔ±ãµ÷ÓÃÕß¿ÉÒÔÔÚµ÷Óà Future É쵀 get() ֮ǰִÐÐÆäËûÈÎÎñ¡£ÒÔÏÂʾÀýÏÔʾÈçºÎÔÚ·µ»ØÖµµÄ·½·¨ÉÏʹÓÃ@Async£º +甚至å�¯ä»¥å¼‚步调用返回值的方法。但是,这些方法需è¦�具有 Future 类型的返回值。这ä»�ç„¶æ��供了异步执行的好处,以便调用者å�¯ä»¥åœ¨è°ƒç”¨ Future 上的 get() 之å‰�执行其他任务。以下示例显示如何在返回值的方法上使用@Async: @Async Future returnSomething(int i) { // this will be executed asynchronously } -#²»Ö§³ÖµÄÓ÷¨ -@Async ²»ÄÜÓëÉúÃüÖÜÆÚ»Øµ÷Ò»ÆðʹÓã¬ÀýÈç @PostConstruct¡£ +#ä¸�支æŒ�的用法 +@Async ä¸�能与生命周期回调一起使用,例如 @PostConstruct。 -ÒªÒì²½³õʼ»¯ Spring bean£¬±ØÐëʹÓõ¥¶ÀµÄ³õʼ»¯ Spring bean£¬È»ºóÔÚÄ¿±êÉϵ÷Óà @Async ´ø×¢Ê͵ķ½·¨£¬ÈçÒÔÏÂʾÀýËùʾ£º +è¦�异步åˆ�始化 Spring bean,必须使用å�•独的åˆ�始化 Spring bean,然å�Žåœ¨ç›®æ ‡ä¸Šè°ƒç”¨ @Async 带注释的方法,如以下示例所示: public class SampleBeanImpl implements SampleBean { @@ -218,17 +218,17 @@ public class SampleBeanInitializer { } } -#Ã÷È·Ö¸¶¨Ö´ÐÐÆ÷ -ĬÈÏÇé¿öÏ£¬ÔÚ·½·¨ÉÏÖ¸¶¨ @Async ʱ£¬Ê¹ÓõÄÖ´ÐÐÆ÷ÊÇÔÚÆôÓÃÒì²½Ö§³ÖʱÅäÖõÄÖ´ÐÐÆ÷£¬¼´Èç¹ûʹÓà XML »ò AsyncConfigurer ʵÏÖ£¨Èç¹ûÓУ©£¬ÔòΪ annotation-driven ÔªËØ¡£µ«ÊÇ£¬Èç¹ûÐèҪָʾÔÚÖ´Ðиø¶¨·½·¨Ê±Ó¦Ê¹ÓÃĬÈÏÖµÒÔÍâµÄÖ´ÐÐÆ÷£¬Ôò¿ÉÒÔʹÓà @Async ×¢½âµÄ value ÊôÐÔ¡£ÒÔÏÂʾÀýÏÔʾÁËÈçºÎÖ´Ðд˲Ù×÷£º +#明确指定执行器 +默认情况下,在方法上指定 @Async 时,使用的执行器是在å�¯ç”¨å¼‚步支æŒ�æ—¶é…�置的执行器,å�³å¦‚果使用 XML 或 AsyncConfigurer 实现(如果有),则为 annotation-driven 元素。但是,如果需è¦�指示在执行给定方法时应使用默认值以外的执行器,则å�¯ä»¥ä½¿ç”¨ @Async 注解的 value 属性。以下示例显示了如何执行此æ“�作: @Async("otherExecutor") void doSomething(String s) { // this will be executed asynchronously by "otherExecutor" } -ÔÚÕâÖÖÇé¿öÏ£¬¡°otherExecutor¡±¿ÉÒÔÊÇ Spring ÈÝÆ÷ÖÐÈκΠExecutor bean µÄÃû³Æ£¬Ò²¿ÉÒÔÊÇÓëÈκΠExecutor ¹ØÁªµÄÏÞ¶¨·ûµÄÃû³Æ£¨ÀýÈ磬ʹÓÃ ÔªËØ»ò Spring µÄ @Qualifier ×¢ÊÍÖ¸¶¨£© £©¡£ +在这ç§�情况下,“otherExecutorâ€�å�¯ä»¥æ˜¯ Spring 容器中任何 Executor bean çš„å��称,也å�¯ä»¥æ˜¯ä¸Žä»»ä½• Executor å…³è�”çš„é™�定符的å��称(例如,使用 元素或 Spring çš„ @Qualifier 注释指定) )。 -#¹ÜÀí @Async µÄÒì³£ -µ± @Async ·½·¨µÄ·µ»ØÖµÀàÐÍΪ Future ÐÍʱ£¬ºÜÈÝÒ×¹ÜÀíÔÚ·½·¨Ö´ÐÐÆÚ¼äÅ׳öµÄÒì³££¬ÒòΪÔÚµ÷Óà get ½á¹ûʱ»áÅ׳ö´ËÒì³£¡£µ«ÊÇ£¬¶ÔÓÚ·µ»ØÖµÀàÐÍΪ void Ð͵ķ½·¨£¬Òì³£²»»á±»²¶»ñÇÒÎÞ·¨´«Êä¡£Äú¿ÉÒÔÌṩ AsyncUncaughtExceptionHandler À´´¦Àí´ËÀàÒì³£¡£ÒÔÏÂʾÀýÏÔʾÁËÈçºÎÖ´Ðд˲Ù×÷£º +#管ç�† @Async 的异常 +当 @Async 方法的返回值类型为 Future 型时,很容易管ç�†åœ¨æ–¹æ³•执行期间抛出的异常,因为在调用 get 结果时会抛出此异常。但是,对于返回值类型为 void 型的方法,异常ä¸�会被æ�•获且无法传输。您å�¯ä»¥æ��ä¾› AsyncUncaughtExceptionHandler æ�¥å¤„ç�†æ­¤ç±»å¼‚常。以下示例显示了如何执行此æ“�作: public class MyAsyncUncaughtExceptionHandler implements AsyncUncaughtExceptionHandler { @@ -237,4 +237,4 @@ public class MyAsyncUncaughtExceptionHandler implements AsyncUncaughtExceptionHa // handle exception } } -ĬÈÏÇé¿öÏ£¬½ö¼Ç¼Òì³£¡£Äú¿ÉÒÔʹÓà AsyncConfigurer »ò XML ÔªËØ¶¨Òå×Ô¶¨Òå AsyncUncaughtExceptionHandler¡£ \ No newline at end of file +默认情况下,仅记录异常。您å�¯ä»¥ä½¿ç”¨ AsyncConfigurer 或 XML 元素定义自定义 AsyncUncaughtExceptionHandler。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\346\227\245\345\277\227\347\256\241\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\346\227\245\345\277\227\347\256\241\347\220\206.md" index 009576d..8b8a7ad 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\346\227\245\345\277\227\347\256\241\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\344\270\255\347\232\204\346\227\245\345\277\227\347\256\241\347\220\206.md" @@ -1,40 +1,40 @@ -## 4\. ÈÕÖ¾ +## 4\. 日志 -Spring BootÔÚËùÓÐÄÚ²¿ÈÕÖ¾ÖÐʹÓà [Commons Logging](https://commons.apache.org/logging) £¬µ«¶Ôµ×²ãÈÕÖ¾µÄʵÏÖ±£³Ö¿ª·Å¡£ Ϊ [Java Util Logging](https://docs.oracle.com/javase/17/docs/api/java/util/logging/package-summary.html) ¡¢ [Log4j2](https://logging.apache.org/log4j/2.x/) ¡¢ [Logback](https://logback.qos.ch/) ÌṩÁËĬÈÏÅäÖᣠÔÚÿһÖÖÇé¿öÏ£¬¼Ç¼Æ÷£¨logger£©¶¼±»Ô¤ÉèΪʹÓÿØÖÆÌ¨Êä³ö£¬Ò²¿ÉÒÔÑ¡ÔñÊä³öµ½Îļþ¡£ +Spring Boot在所有内部日志中使用 [Commons Logging](https://commons.apache.org/logging) ,但对底层日志的实现ä¿�æŒ�开放。 为 [Java Util Logging](https://docs.oracle.com/javase/17/docs/api/java/util/logging/package-summary.html) ã€� [Log4j2](https://logging.apache.org/log4j/2.x/) ã€� [Logback](https://logback.qos.ch/) æ��供了默认é…�置。 在æ¯�一ç§�情况下,记录器(logger)都被预设为使用控制å�°è¾“出,也å�¯ä»¥é€‰æ‹©è¾“出到文件。 -ĬÈÏÇé¿öÏ£¬Èç¹ûÄãʹÓà ¡°Starter¡±£¬ÔòĬÈÏʹÓÃLogback¡£ Êʵ±µÄLogback·ÓÉÒ²°üÀ¨ÔÚÄÚ£¬ÒÔÈ·±£Ê¹ÓÃJava Util Logging¡¢Commons Logging¡¢Log4J»òSLF4JµÄÒÀÀµ¿â¶¼ÄÜÕýÈ·¹¤×÷¡£ +默认情况下,如果你使用 “Starterâ€�,则默认使用Logback。 适当的Logback路由也包括在内,以确ä¿�使用Java Util Loggingã€�Commons Loggingã€�Log4J或SLF4Jçš„ä¾�赖库都能正确工作。 -| | ÓкܶàÊÊÓÃÓÚJavaµÄÈÕÖ¾¿ò¼Ü¡£ Èç¹ûÉÏÃæµÄÁÐ±í¿´ÆðÀ´ºÜ»ìÂÒ£¬Çë²»Òªµ£ÐÄ¡£ Ò»°ãÀ´Ëµ£¬Äã²»ÐèÒª¸Ä±äÄãµÄÈÕÖ¾ÒÀÀµ£¬Spring BootµÄĬÈÏÖµ¾ÍºÜºÃÓᣠ| +| | 有很多适用于Java的日志框架。 如果上é�¢çš„列表看起æ�¥å¾ˆæ··ä¹±ï¼Œè¯·ä¸�è¦�担心。 一般æ�¥è¯´ï¼Œä½ ä¸�需è¦�改å�˜ä½ çš„æ—¥å¿—ä¾�赖,Spring Boot的默认值就很好用。 | | --- | --- | -| | µ±Äã°ÑÄãµÄÓ¦ÓóÌÐò²¿Êðµ½Ò»¸öservletÈÝÆ÷»òÓ¦Ó÷þÎñÆ÷ʱ£¬ÓÃJava Util Logging APIÖ´ÐеÄÈÕÖ¾²»»á±»´«Ë͵½ÄãµÄÓ¦ÓóÌÐòµÄÈÕÖ¾ÖС£ Õâ¿ÉÒÔ·ÀÖ¹ÓÉÈÝÆ÷»òÆäËûÒѾ­²¿Êðµ½ËüµÄÓ¦ÓóÌÐòÖ´ÐеÄÈÕÖ¾³öÏÖÔÚÄãµÄÓ¦ÓóÌÐòµÄÈÕÖ¾ÖС£ | +| | 当你把你的应用程åº�部署到一个servlet容器或应用æœ�务器时,用Java Util Logging API执行的日志ä¸�会被传é€�到你的应用程åº�的日志中。 è¿™å�¯ä»¥é˜²æ­¢ç”±å®¹å™¨æˆ–å…¶ä»–å·²ç»�部署到它的应用程åº�执行的日志出现在你的应用程åº�的日志中。 | | --- | --- | -### [](https://springdoc.cn/spring-boot/features.html#features.logging.log-format)4.1\. ÈÕÖ¾¸ñʽ +### [](https://springdoc.cn/spring-boot/features.html#features.logging.log-format)4.1\. 日志格å¼� -Spring BootµÄĬÈϵÄÈÕÖ¾Êä³ö¸ñʽÀàËÆÓÚÏÂÃæµÄÀý×Ó¡£ +Spring Boot的默认的日志输出格å¼�类似于下é�¢çš„例å­�。 @@ -58,31 +58,31 @@ Spring Boot -Êä³öµÄÏîÄ¿ÈçÏ¡£ +输出的项目如下。 -* DateºÍʱTime£º¾«È·µ½ºÁÃ룬Ò×ÓÚÅÅÐò¡£ +* Date和时Time:精确到毫秒,易于排åº�。 -* ÈÕÖ¾¼¶±ð: `ERROR`, `WARN`, `INFO`, `DEBUG`, »ò `TRACE`. +* 日志级别: `ERROR`, `WARN`, `INFO`, `DEBUG`, 或 `TRACE`. -* ½ø³ÌID¡£ +* 进程ID。 -* Ò»¸ö `---` ·Ö¸ô·û£¬ÒÔÇø·Öʵ¼ÊÈÕÖ¾ÐÅÏ¢µÄ¿ªÊ¼¡£ +* 一个 `---` 分隔符,以区分实际日志信æ�¯çš„开始。 -* Ïß³ÌÃû³Æ£º°üº¬ÔÚ·½À¨ºÅÖУ¨¶ÔÓÚ¿ØÖÆÌ¨Êä³ö¿ÉÄܻᱻ½Ø¶Ï£©¡£ +* 线程å��称:包å�«åœ¨æ–¹æ‹¬å�·ä¸­ï¼ˆå¯¹äºŽæŽ§åˆ¶å�°è¾“出å�¯èƒ½ä¼šè¢«æˆªæ–­ï¼‰ã€‚ -* ¼Ç¼Æ÷Ãû³Æ£ºÕâͨ³£ÊÇÔ´ÀàµÄÃû³Æ£¨Í¨³£ÊÇËõд£©¡£ +* 记录器å��称:这通常是æº�类的å��称(通常是缩写)。 -* ÈÕÖ¾ÏûÏ¢¡£ +* 日志消æ�¯ã€‚ -| | LogbackûÓÐ `FATAL` ¼¶±ð¡£ Ëü±»Ó³Éäµ½ `ERROR`¡£ | +| | Logback没有 `FATAL` 级别。 它被映射到 `ERROR`。 | | --- | --- | @@ -91,11 +91,11 @@ Spring Boot -### [](https://springdoc.cn/spring-boot/features.html#features.logging.console-output)4.2\. ¿ØÖÆÌ¨Êä³ö +### [](https://springdoc.cn/spring-boot/features.html#features.logging.console-output)4.2\. 控制å�°è¾“出 -ĬÈÏÇé¿öÏ£¬ÈÕÖ¾»áÊä³ö `ERROR`¡¢`WARN` ºÍ `INFO` ¼¶±ðµÄÏûÏ¢µ½¿ØÖÆÌ¨¡£ ÄãÒ²¿ÉÒÔͨ¹ýÓà `--debug` ±êÖ¾Æô¶¯ÄãµÄÓ¦ÓóÌÐò£¬À´ÆôÓà `debug` ģʽ¡£ +默认情况下,日志会输出 `ERROR`ã€�`WARN` å’Œ `INFO` 级别的消æ�¯åˆ°æŽ§åˆ¶å�°ã€‚ 你也å�¯ä»¥é€šè¿‡ç”¨ `--debug` 标志å�¯åŠ¨ä½ çš„åº”ç”¨ç¨‹åº�,æ�¥å�¯ç”¨ `debug` 模å¼�。 @@ -113,36 +113,36 @@ $ java -jar myapp.jar --debug -| | ÄãÒ²¿ÉÒÔÔÚÄãµÄ `application.properties` ÖÐÖ¸¶¨ `debug=true`¡£ | +| | 你也å�¯ä»¥åœ¨ä½ çš„ `application.properties` 中指定 `debug=true`。 | | --- | --- | -µ±debugģʽ±»ÆôÓÃʱ£¬Ò»Ð©ºËÐļǼÆ÷£¨Ç¶ÈëʽÈÝÆ÷¡¢HibernateºÍSpring Boot£©±»ÅäÖÃΪÊä³ö¸ü¶àÐÅÏ¢¡£ ÆôÓÃdebugģʽ²¢²»Òâζ׎«ÄãµÄÓ¦ÓóÌÐòÅäÖÃΪÒÔ `DEBUG` ¼¶±ð¼Ç¼ËùÓÐÐÅÏ¢¡£ +当debug模å¼�被å�¯ç”¨æ—¶ï¼Œä¸€äº›æ ¸å¿ƒè®°å½•器(嵌入å¼�容器ã€�Hibernateå’ŒSpring Boot)被é…�置为输出更多信æ�¯ã€‚ å�¯ç”¨debug模å¼�å¹¶ä¸�æ„�味ç�€å°†ä½ çš„应用程åº�é…�置为以 `DEBUG` 级别记录所有信æ�¯ã€‚ -ÁíÍ⣬Äã¿ÉÒÔͨ¹ýÔÚÆô¶¯Ó¦ÓóÌÐòʱʹÓà `--trace` ±êÖ¾£¨»òÔÚ `application.properties` ÖÐʹÓà `trace=true` £©À´ÆôÓà ¡°trace¡± ģʽ¡£ ÕâÑù×ö¿ÉÒÔ¶ÔһЩºËÐļǼÆ÷£¨Ç¶ÈëʽÈÝÆ÷¡¢Hibernate schemaÉú³ÉºÍÕû¸öSpring×éºÏ£©½øÐиú×ټǼ¡£ +å�¦å¤–,你å�¯ä»¥é€šè¿‡åœ¨å�¯åŠ¨åº”ç”¨ç¨‹åº�时使用 `--trace` 标志(或在 `application.properties` 中使用 `trace=true` )æ�¥å�¯ç”¨ “traceâ€� 模å¼�。 这样å�šå�¯ä»¥å¯¹ä¸€äº›æ ¸å¿ƒè®°å½•器(嵌入å¼�容器ã€�Hibernate schema生æˆ�和整个Spring组å�ˆï¼‰è¿›è¡Œè·Ÿè¸ªè®°å½•。 -#### [](https://springdoc.cn/spring-boot/features.html#features.logging.console-output.color-coded)4.2.1\. ²ÊÉ«±àÂëµÄÊä³ö +#### [](https://springdoc.cn/spring-boot/features.html#features.logging.console-output.color-coded)4.2.1\. 彩色编ç �的输出 -Èç¹ûÄãµÄÖÕ¶ËÖ§³ÖANSI£¬¾Í»áʹÓòÊÉ«Êä³öÀ´°ïÖúÔĶÁ¡£ Äã¿ÉÒÔ½« `spring.output.ansi.enabled` ÉèÖÃΪ [Ö§³ÖµÄÖµ](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/ansi/AnsiOutput.Enabled.html)£¬ÒÔ¸²¸Ç×Ô¶¯¼ì²â¡£ +如果你的终端支æŒ�ANSI,就会使用彩色输出æ�¥å¸®åŠ©é˜…è¯»ã€‚ ä½ å�¯ä»¥å°† `spring.output.ansi.enabled` 设置为 [支æŒ�的值](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/ansi/AnsiOutput.Enabled.html),以覆盖自动检测。 -ÑÕÉ«±àÂëÊÇͨ¹ýʹÓà `%clr` ת»»¹Ø¼ü×ÖÀ´ÅäÖõġ£ ÔÚÆä×î¼òµ¥µÄÐÎʽÖУ¬×ª»»Æ÷¸ù¾ÝÈÕÖ¾¼¶±ð¶ÔÊä³ö½øÐÐ×ÅÉ«£¬ÈçÏÂÃæµÄÀý×ÓÖÐËùʾ¡£ +颜色编ç �是通过使用 `%clr` 转æ�¢å…³é”®å­—æ�¥é…�置的。 在其最简å�•的形å¼�中,转æ�¢å™¨æ ¹æ�®æ—¥å¿—级别对输出进行ç�€è‰²ï¼Œå¦‚下é�¢çš„例å­�中所示。 @@ -160,23 +160,23 @@ $ java -jar myapp.jar --debug -ϱíÃèÊöÁËÈÕÖ¾¼¶±ðÓëÑÕÉ«µÄÓ³Éä¹ØÏµ¡£ +下表æ��述了日志级别与颜色的映射关系。 -| ÈÕÖ¾¼¶±ð | ÑÕÉ« | +| 日志级别 | 颜色 | | --- | --- | -| `FATAL` | ºì | -| `ERROR` | ºì | -| `WARN` | »Æ | -| `INFO` | ÂÌ | -| `DEBUG` | ÂÌ | -| `TRACE` | ÂÌ | +| `FATAL` | 红 | +| `ERROR` | 红 | +| `WARN` | 黄 | +| `INFO` | 绿 | +| `DEBUG` | 绿 | +| `TRACE` | 绿 | -ÁíÍ⣬ÄãÒ²¿ÉÒÔͨ¹ýΪת»»Ìṩһ¸öÑ¡ÏîÀ´Ö¸¶¨Ó¦¸ÃʹÓõÄÑÕÉ«»òÑùʽ¡£ ÀýÈ磬ҪʹÎı¾Îª»ÆÉ«£¬ÇëʹÓÃÒÔÏÂÉèÖᣠ+å�¦å¤–,你也å�¯ä»¥é€šè¿‡ä¸ºè½¬æ�¢æ��供一个选项æ�¥æŒ‡å®šåº”该使用的颜色或样å¼�。 例如,è¦�使文本为黄色,请使用以下设置。 @@ -194,7 +194,7 @@ $ java -jar myapp.jar --debug -Ö§³ÖÒÔÏÂÑÕÉ«ºÍÑùʽ¡£ +支æŒ�以下颜色和样å¼�。 @@ -222,36 +222,36 @@ $ java -jar myapp.jar --debug -### [](https://springdoc.cn/spring-boot/features.html#features.logging.file-output)4.3\. Êä³öµ½Îļþ +### [](https://springdoc.cn/spring-boot/features.html#features.logging.file-output)4.3\. 输出到文件 -ĬÈÏÇé¿öÏ£¬Spring BootÖ»Ïò¿ØÖÆÌ¨¼Ç¼ÈÕÖ¾£¬²»Ð´ÈÕÖ¾Îļþ¡£ Èç¹ûÄãÏëÔÚ¿ØÖÆÌ¨Êä³öÖ®ÍâдÈÕÖ¾Îļþ£¬ÄãÐèÒªÉèÖà `logging.file.name` »ò `logging.file.path` ÊôÐÔ£¨ÀýÈ磬ÔÚÄãµÄ `application.properties` ÖУ©¡£ +默认情况下,Spring Bootå�ªå�‘控制å�°è®°å½•日志,ä¸�写日志文件。 如果你想在控制å�°è¾“出之外写日志文件,你需è¦�设置 `logging.file.name` 或 `logging.file.path` 属性(例如,在你的 `application.properties` 中)。 -ϱíÏÔʾÁË `logging.*` ÊôÐÔÈçºÎ±»Ò»ÆðʹÓᣠ+下表显示了 `logging.*` 属性如何被一起使用。 Table 5\. Logging properties | `logging.file.name` | `logging.file.path` | Example | Description | | --- | --- | --- | --- | -| _(none)_ | _(none)_ | | Ö»ÔÚ¿ØÖÆÌ¨½øÐмǼ¡£ | -| Ö¸¶¨Îļþ | _(none)_ | `my.log` | дÈëÖ¸¶¨µÄÈÕÖ¾Îļþ¡£ Ãû³Æ¿ÉÒÔÊÇÒ»¸öÈ·ÇеÄλÖã¬Ò²¿ÉÒÔÊÇÓ뵱ǰĿ¼µÄÏà¶ÔλÖᣠ| -| _(none)_ | Ö¸¶¨Ä¿Â¼ | `/var/log` | ½« `spring.log` дµ½Ö¸¶¨Ä¿Â¼¡£ Ãû³Æ¿ÉÒÔÊÇÒ»¸öÈ·ÇеÄλÖã¬Ò²¿ÉÒÔÊÇÓ뵱ǰĿ¼µÄÏà¶ÔλÖᣠ| +| _(none)_ | _(none)_ | | å�ªåœ¨æŽ§åˆ¶å�°è¿›è¡Œè®°å½•。 | +| 指定文件 | _(none)_ | `my.log` | 写入指定的日志文件。 å��ç§°å�¯ä»¥æ˜¯ä¸€ä¸ªç¡®åˆ‡çš„ä½�置,也å�¯ä»¥æ˜¯ä¸Žå½“å‰�目录的相对ä½�置。 | +| _(none)_ | 指定目录 | `/var/log` | å°† `spring.log` 写到指定目录。 å��ç§°å�¯ä»¥æ˜¯ä¸€ä¸ªç¡®åˆ‡çš„ä½�置,也å�¯ä»¥æ˜¯ä¸Žå½“å‰�目录的相对ä½�置。 | -ÈÕÖ¾ÎļþÔÚ´ïµ½10MBʱ¾Í»áÂÖ»»£¬Óë¿ØÖÆÌ¨Êä³öÒ»Ñù£¬Ä¬ÈÏÇé¿öÏ»á¼Ç¼ `ERROR` ¡¢`WARN` ¼¶ºÍ `INFO` ¼¶±ðµÄÐÅÏ¢¡£ +日志文件在达到10MB时就会轮æ�¢ï¼Œä¸ŽæŽ§åˆ¶å�°è¾“出一样,默认情况下会记录 `ERROR` ã€�`WARN` 级和 `INFO` 级别的信æ�¯ã€‚ -| | ÈÕÖ¾ÊôÐÔ¶ÀÁ¢ÓÚʵ¼ÊµÄÈÕÖ¾»ù´¡ÉèÊ©¡£ Òò´Ë£¬Ìض¨µÄÅäÖÃÊôÐÔ£¨ÈçLogbackµÄ `logback.configurationFile` £©²»ÓÉspring Boot¹ÜÀí¡£ | +| | 日志属性独立于实际的日志基础设施。 因此,特定的é…�置属性(如Logbackçš„ `logback.configurationFile` )ä¸�ç”±spring Boot管ç�†ã€‚ | | --- | --- | @@ -260,44 +260,44 @@ $ java -jar myapp.jar --debug -### [](https://springdoc.cn/spring-boot/features.html#features.logging.file-rotation)4.4\. ÎļþÂÖ»»£¨¹ö¶¯ÈÕÖ¾£© +### [](https://springdoc.cn/spring-boot/features.html#features.logging.file-rotation)4.4\. 文件轮æ�¢ï¼ˆæ»šåŠ¨æ—¥å¿—ï¼‰ -Èç¹ûÄãʹÓÃLogback£¬¿ÉÒÔʹÓÃÄãµÄ `application.properties` »ò `application.yaml` ÎļþÀ´Î¢µ÷ÈÕÖ¾ÂÖ»»ÉèÖᣠ¶ÔÓÚËùÓÐÆäËûµÄÈÕ־ϵͳ£¬Ä㽫ÐèÒª×Ô¼ºÖ±½ÓÅäÖÃÂÖ»»ÉèÖã¨ÀýÈ磬Èç¹ûÄãʹÓÃLog4J2£¬ÄÇôÄã¿ÉÒÔÌí¼ÓÒ»¸ö `log4j2.xml` »ò `log4j2-spring.xml` Îļþ£©¡£ +如果你使用Logback,å�¯ä»¥ä½¿ç”¨ä½ çš„ `application.properties` 或 `application.yaml` 文件æ�¥å¾®è°ƒæ—¥å¿—è½®æ�¢è®¾ç½®ã€‚ 对于所有其他的日志系统,你将需è¦�自己直接é…�置轮æ�¢è®¾ç½®ï¼ˆä¾‹å¦‚,如果你使用Log4J2,那么你å�¯ä»¥æ·»åŠ ä¸€ä¸ª `log4j2.xml` 或 `log4j2-spring.xml` 文件)。 -Ö§³ÖÒÔÏÂÂÖ»»²ßÂÔÊôÐÔ¡£ +支æŒ�以下轮æ�¢ç­–略属性。 -| ÊôÐÔ | ˵Ã÷ | +| 属性 | 说明 | | --- | --- | -| `logging.logback.rollingpolicy.file-name-pattern` | ÓÃÓÚ´´½¨ÈÕÖ¾¹éµµµÄÎļþÃûģʽ¡£ | -| `logging.logback.rollingpolicy.clean-history-on-start` | Ó¦ÓóÌÐòÆô¶¯Ê±£¬ÊÇ·ñÐÐÈÕÖ¾¹éµµÇåÀí¡£ | -| `logging.logback.rollingpolicy.max-file-size` | ÈÕÖ¾Îļþ¹éµµÇ°µÄ×î´ó³ß´ç£¨Îļþ×î´óÌå»ý£¬´ïµ½Õâ¸öÌå»ý¾Í»á¹éµµ£©¡£ | -| `logging.logback.rollingpolicy.total-size-cap` | ÈÕÖ¾µµ°¸ÔÚ±»É¾³ýǰµÄ×î´ó³ß´ç£¨¹éµµÎļþ×î´óÕ¼ÓôóС£¬³¬¹ýÕâ¸ö´óСºó»á±»É¾³ý£©¡£ | -| `logging.logback.rollingpolicy.max-history` | Òª±£ÁôµÄ¹éµµÈÕÖ¾ÎļþµÄ×î´óÊýÁ¿£¨Ä¬ÈÏΪ7£©¡£ | +| `logging.logback.rollingpolicy.file-name-pattern` | 用于创建日志归档的文件å��模å¼�。 | +| `logging.logback.rollingpolicy.clean-history-on-start` | 应用程åº�å�¯åŠ¨æ—¶ï¼Œæ˜¯å�¦è¡Œæ—¥å¿—归档清ç�†ã€‚ | +| `logging.logback.rollingpolicy.max-file-size` | 日志文件归档å‰�的最大尺寸(文件最大体积,达到这个体积就会归档)。 | +| `logging.logback.rollingpolicy.total-size-cap` | 日志档案在被删除å‰�的最大尺寸(归档文件最大å� ç”¨å¤§å°�,超过这个大å°�å�Žä¼šè¢«åˆ é™¤ï¼‰ã€‚ | +| `logging.logback.rollingpolicy.max-history` | è¦�ä¿�留的归档日志文件的最大数é‡�(默认为7)。 | -### [](https://springdoc.cn/spring-boot/features.html#features.logging.log-levels)4.5\. ÈÕÖ¾¼¶±ð +### [](https://springdoc.cn/spring-boot/features.html#features.logging.log-levels)4.5\. 日志级别 -ËùÓÐÖ§³ÖµÄÈÕ־ϵͳ¶¼¿ÉÒÔͨ¹ýʹÓà `logging.level.=` ÔÚSpringµÄ `Environment`£¨ÀýÈ磬ÔÚ `application.properties`£©ÖÐÉèÖÃÈÕÖ¾¼¶±ð£¬ÆäÖÐ `level` ÊÇ `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, »ò `OFF` Ö®Ò»¡£ `root` ¼Ç¼Æ÷£¨logger£©µÄ¼¶±ð¿ÉÒÔͨ¹ý `logging.level.root` À´ÅäÖᣠ+所有支æŒ�的日志系统都å�¯ä»¥é€šè¿‡ä½¿ç”¨ `logging.level.=` 在Springçš„ `Environment`(例如,在 `application.properties`)中设置日志级别,其中 `level` 是 `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, 或 `OFF` 之一。 `root` 记录器(logger)的级别å�¯ä»¥é€šè¿‡ `logging.level.root` æ�¥é…�置。 -ÏÂÃæµÄÀý×ÓÏÔʾÁË `application.properties` ÖÐDZÔÚµÄÈÕÖ¾ÉèÖᣠ+下é�¢çš„例å­�显示了 `application.properties` 中潜在的日志设置。 @@ -325,13 +325,13 @@ logging.level.org.hibernate=error -Ò²¿ÉÒÔʹÓû·¾³±äÁ¿À´ÉèÖÃÈÕÖ¾¼¶±ð¡£ ÀýÈ磬`LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG` ½«ÉèÖà `org.springframework.web` Ϊ `DEBUG` ¡£ +也å�¯ä»¥ä½¿ç”¨çŽ¯å¢ƒå�˜é‡�æ�¥è®¾ç½®æ—¥å¿—级别。 例如,`LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG` 将设置 `org.springframework.web` 为 `DEBUG` 。 -| | ÉÏÊö·½·¨Ö»ÊÊÓÃÓÚ°ü¼¶ÈÕÖ¾¡£ ÓÉÓÚ¿íËɰó¶¨×ÜÊǽ«»·¾³±äÁ¿×ª»»ÎªÐ¡Ð´×Öĸ£¬ËùÒÔ²»¿ÉÄÜÓÃÕâÖÖ·½Ê½Îªµ¥¸öÀàÅäÖÃÈÕÖ¾¡£ Èç¹ûÄãÐèҪΪһ¸öÀàÅäÖÃÈÕÖ¾£¬Äã¿ÉÒÔʹÓÃ[`SPRING_APPLICATION_JSON`](https://springdoc.cn/spring-boot/features.html#features.external-config.application-json)±äÁ¿¡£ | +| | 上述方法å�ªé€‚用于包级日志。 由于宽æ�¾ç»‘定总是将环境å�˜é‡�转æ�¢ä¸ºå°�写字æ¯�,所以ä¸�å�¯èƒ½ç”¨è¿™ç§�æ–¹å¼�为å�•个类é…�置日志。 如果你需è¦�为一个类é…�置日志,你å�¯ä»¥ä½¿ç”¨[`SPRING_APPLICATION_JSON`](https://springdoc.cn/spring-boot/features.html#features.external-config.application-json)å�˜é‡�。 | | --- | --- | @@ -340,17 +340,17 @@ logging.level.org.hibernate=error -### [](https://springdoc.cn/spring-boot/features.html#features.logging.log-groups)4.6\. ÈÕÖ¾×飨Log Groups£© +### [](https://springdoc.cn/spring-boot/features.html#features.logging.log-groups)4.6\. 日志组(Log Groups) -Äܹ»½«Ïà¹ØµÄÈÕÖ¾¼Ç¼Æ÷·Ö×飬ÒÔ±ãͬʱ¶ÔËüÃǽøÐÐÅäÖã¬Õâͨ³£ºÜÓÐÓᣠÀýÈ磬Äã¿ÉÄܾ­³£¸Ä±ä _ËùÓÐ_ ÓëTomcatÏà¹ØµÄ¼Ç¼Æ÷µÄ¼Ç¼¼¶±ð£¬µ«Äã²»ÈÝÒ×¼Çס×î¸ß¼¶±ðµÄ°ü¡£ +能够将相关的日志记录器分组,以便å�Œæ—¶å¯¹å®ƒä»¬è¿›è¡Œé…�置,这通常很有用。 例如,你å�¯èƒ½ç»�常改å�˜ _所有_ 与Tomcat相关的记录器的记录级别,但你ä¸�容易记ä½�最高级别的包。 -ΪÁ˰ïÖú½â¾öÕâ¸öÎÊÌ⣬Spring BootÔÊÐíÄãÔÚSpring `Environment` Öж¨ÒåÈÕÖ¾×é¡£ ÀýÈ磬Äã¿ÉÒÔͨ¹ýÔÚ `application.properties` ÖмÓÈë ¡°tomcat¡± group À´¶¨ÒåËü¡£ +为了帮助解决这个问题,Spring Bootå…�许你在Spring `Environment` 中定义日志组。 例如,你å�¯ä»¥é€šè¿‡åœ¨ `application.properties` 中加入 “tomcatâ€� group æ�¥å®šä¹‰å®ƒã€‚ @@ -377,7 +377,7 @@ logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat -Ò»µ©¶¨ÒåºÃºó£¬¾Í¿ÉÒÔÓÃÒ»ÐдúÂëÀ´¸Ä±ä×éÖÐËùÓÐloggerµÄ¼¶±ð¡£ +一旦定义好å�Žï¼Œå°±å�¯ä»¥ç”¨ä¸€è¡Œä»£ç �æ�¥æ”¹å�˜ç»„中所有logger的级别。 @@ -404,12 +404,12 @@ logging.level.tomcat=trace -Spring Boot°üÀ¨ÒÔÏÂÔ¤¶¨ÒåµÄÈÕÖ¾×飬¿ÉÒÔ¿ªÏä¼´Óᣠ+Spring Boot包括以下预定义的日志组,å�¯ä»¥å¼€ç®±å�³ç”¨ã€‚ -| ×éÃû | ×éÖеÄlogger | +| 组å�� | 组中的logger | | --- | --- | | web | `org.springframework.core.codec`, `org.springframework.http`, `org.springframework.web`, `org.springframework.boot.actuate.endpoint.web`, `org.springframework.boot.web.servlet.ServletContextInitializerBeans` | | sql | `org.springframework.jdbc.core`, `org.hibernate.SQL`, `org.jooq.tools.LoggerListener` | @@ -418,11 +418,11 @@ Spring Boot -### [](https://springdoc.cn/spring-boot/features.html#features.logging.shutdown-hook)4.7\. ʹÓÃÈÕÖ¾ Shutdown Hook +### [](https://springdoc.cn/spring-boot/features.html#features.logging.shutdown-hook)4.7\. 使用日志 Shutdown Hook -ΪÁËÔÚÄãµÄÓ¦ÓóÌÐòÖÕֹʱÊÍ·ÅÈÕÖ¾×ÊÔ´£¬ÎÒÃÇÌṩÁËÒ»¸öShutdown Hook£¬Ëü½«ÔÚJVMÍ˳öʱ´¥·¢ÈÕ־ϵͳÇåÀí¡£ ³ý·ÇÄãµÄÓ¦ÓóÌÐòÊÇÒÔwarÎļþµÄÐÎʽ²¿ÊðµÄ£¬·ñÔòÕâ¸öShutdown Hook»á×Ô¶¯×¢²á¡£ Èç¹ûÄãµÄÓ¦ÓóÌÐòÓи´ÔÓµÄÉÏÏÂÎIJã´Î½á¹¹£¬Shutdown Hook¿ÉÄÜÎÞ·¨Âú×ãÄãµÄÐèÇó¡£ Èç¹û²»ÄÜ£¬Çë½ûÓùػú¹³×Ó£¬²¢Ñо¿µ×²ãÈÕ־ϵͳֱ½ÓÌṩµÄÑ¡Ïî¡£ ÀýÈ磬LogbackÌṩÁË [context selectors](https://logback.qos.ch/manual/loggingSeparation.html)£¬ÔÊÐíÿ¸ö¼Ç¼Æ÷ÔÚËü×Ô¼ºµÄÉÏÏÂÎÄÖб»´´½¨¡£ Äã¿ÉÒÔʹÓà `logging.register-shutdown-hook` ÊôÐÔÀ´½ûÓÃShutdown Hook¡£ ½«ÆäÉèÖÃΪ `false` ½«½ûÓÃ×¢²á¡£ Äã¿ÉÒÔÔÚÄãµÄ `application.properties` »ò `application.yaml` ÎļþÖÐÉèÖøÃÊôÐÔ¡£ +为了在你的应用程åº�终止时释放日志资æº�,我们æ��供了一个Shutdown Hook,它将在JVM退出时触å�‘日志系统清ç�†ã€‚ 除é�žä½ çš„应用程åº�是以war文件的形å¼�部署的,å�¦åˆ™è¿™ä¸ªShutdown Hook会自动注册。 如果你的应用程åº�有å¤�æ�‚的上下文层次结构,Shutdown Hookå�¯èƒ½æ— æ³•满足你的需求。 如果ä¸�能,请ç¦�用关机钩å­�,并研究底层日志系统直接æ��供的选项。 例如,Logbackæ��供了 [context selectors](https://logback.qos.ch/manual/loggingSeparation.html),å…�许æ¯�个记录器在它自己的上下文中被创建。 ä½ å�¯ä»¥ä½¿ç”¨ `logging.register-shutdown-hook` 属性æ�¥ç¦�用Shutdown Hook。 将其设置为 `false` å°†ç¦�用注册。 ä½ å�¯ä»¥åœ¨ä½ çš„ `application.properties` 或 `application.yaml` 文件中设置该属性。 @@ -451,92 +451,92 @@ logging.register-shutdown-hook=false -### [](https://springdoc.cn/spring-boot/features.html#features.logging.custom-log-configuration)4.8\. ×Ô¶¨ÒåÈÕÖ¾ÅäÖà +### [](https://springdoc.cn/spring-boot/features.html#features.logging.custom-log-configuration)4.8\. 自定义日志é…�ç½® -¸÷ÖÖÈÕ־ϵͳ¿ÉÒÔͨ¹ýÔÚclasspathÉϰüº¬Êʵ±µÄ¿âÀ´¼¤»î£¬²¢ÇÒ¿ÉÒÔͨ¹ýÔÚclasspathµÄ¸ùĿ¼Ï»òÔÚ Spring `Environment` ÊôÐÔÖ¸¶¨µÄλÖÃÌṩһ¸öºÏÊʵÄÅäÖÃÎļþÀ´½øÒ»²½¶¨ÖÆ£º `logging.config`¡£ +å�„ç§�日志系统å�¯ä»¥é€šè¿‡åœ¨classpath上包å�«é€‚当的库æ�¥æ¿€æ´»ï¼Œå¹¶ä¸”å�¯ä»¥é€šè¿‡åœ¨classpath的根目录下或在 Spring `Environment` 属性指定的ä½�ç½®æ��供一个å�ˆé€‚çš„é…�置文件æ�¥è¿›ä¸€æ­¥å®šåˆ¶ï¼š `logging.config`。 -Äú¿ÉÒÔͨ¹ýʹÓà `org.springframework.boot.logging.LoggingSystem` ϵͳÊôÐÔ£¬Ç¿ÖÆSpring BootʹÓÃÌØ¶¨µÄÈÕ־ϵͳ¡£ ¸ÃÖµÓ¦¸ÃÊÇ `LoggingSystem` ʵÏÖµÄÈ«ÀàÃû¡£ ÄãÒ²¿ÉÒÔͨ¹ýʹÓà `none` µÄÖµÀ´ÍêÈ«½ûÓÃSpring BootµÄÈÕÖ¾ÅäÖᣠ+您å�¯ä»¥é€šè¿‡ä½¿ç”¨ `org.springframework.boot.logging.LoggingSystem` 系统属性,强制Spring Boot使用特定的日志系统。 该值应该是 `LoggingSystem` 实现的全类å��。 你也å�¯ä»¥é€šè¿‡ä½¿ç”¨ `none` 的值æ�¥å®Œå…¨ç¦�用Spring Boot的日志é…�置。 -| | SÓÉÓÚÈÕÖ¾ÊÇÔÚ´´½¨ `ApplicationContext` ֮ǰ³õʼ»¯µÄ£¬ËùÒÔ²»¿ÉÄÜ´ÓSpring `@Configuration` ÎļþÖÐµÄ `@PropertySources` ¿ØÖÆÈÕÖ¾¡£ ¸Ä±äÈÕ־ϵͳ»òÍêȫͣÓÃËüµÄΨһ·½·¨ÊÇͨ¹ýSystem properties¡£ | +| | S由于日志是在创建 `ApplicationContext` 之å‰�åˆ�始化的,所以ä¸�å�¯èƒ½ä»ŽSpring `@Configuration` 文件中的 `@PropertySources` 控制日志。 改å�˜æ—¥å¿—系统或完全å�œç”¨å®ƒçš„唯一方法是通过System properties。 | | --- | --- | -¸ù¾ÝÄãµÄÈÕ־ϵͳ£¬»á¼ÓÔØÒÔÏÂÎļþ¡£ +æ ¹æ�®ä½ çš„æ—¥å¿—系统,会加载以下文件。 -| ÈÕ־ϵͳ | ÅäÖÃÎļþ | +| 日志系统 | é…�置文件 | | --- | --- | -| Logback | `logback-spring.xml`, `logback-spring.groovy`, `logback.xml` »òÕß `logback.groovy` | -| Log4j2 | `log4j2-spring.xml` »òÕß `log4j2.xml` | +| Logback | `logback-spring.xml`, `logback-spring.groovy`, `logback.xml` 或者 `logback.groovy` | +| Log4j2 | `log4j2-spring.xml` 或者 `log4j2.xml` | | JDK (Java Util Logging) | `logging.properties` | -| | ÔÚ¿ÉÄܵÄÇé¿öÏ£¬ÎÒÃǽ¨ÒéÄãʹÓà `-spring` ±äÌåÀ´½øÐÐÈÕÖ¾ÅäÖã¨ÀýÈ磬 `logback-spring.xml` ¶ø²»ÊÇ `logback.xml` £©¡£ Èç¹ûÄãʹÓñê×¼ÅäÖÃλÖã¬Spring²»ÄÜÍêÈ«¿ØÖÆÈÕÖ¾³õʼ»¯¡£ | +| | 在å�¯èƒ½çš„æƒ…况下,我们建议你使用 `-spring` å�˜ä½“æ�¥è¿›è¡Œæ—¥å¿—é…�置(例如, `logback-spring.xml` 而ä¸�是 `logback.xml` )。 如果你使用标准é…�ç½®ä½�置,Springä¸�能完全控制日志åˆ�始化。 | | --- | --- | -| | µ±´Ó "¿ÉÖ´ÐеÄjar "ÖÐÔËÐÐʱ£¬Java Util LoggingÓÐһЩÒÑÖªµÄÀà¼ÓÔØÎÊÌ⣬»áµ¼ÖÂÎÊÌâ¡£ Èç¹û¿ÉÄܵϰ£¬ÎÒÃǽ¨ÒéÄãÔÚ´Ó "¿ÉÖ´ÐеÄjar" ÖÐÔËÐÐʱ±ÜÃâʹÓÃËü¡£ | +| | 当从 "å�¯æ‰§è¡Œçš„jar "中è¿�行时,Java Util Logging有一些已知的类加载问题,会导致问题。 如果å�¯èƒ½çš„è¯�,我们建议你在从 "å�¯æ‰§è¡Œçš„jar" 中è¿�行时é�¿å…�使用它。 | | --- | --- | -ΪÁ˰ïÖú¶¨ÖÆ£¬ÆäËûһЩÊôÐÔ´ÓSpringµÄ `Environment` ×ªÒÆµ½System properties£¬ÈçϱíËùʾ¡£ +为了帮助定制,其他一些属性从Springçš„ `Environment` 转移到System properties,如下表所示。 -| Spring Environment | System Property | ±¸×¢ | +| Spring Environment | System Property | 备注 | | --- | --- | --- | -| `logging.exception-conversion-word` | `LOG_EXCEPTION_CONVERSION_WORD` | ¼Ç¼Ò쳣ʱʹÓõÄת»»´Ê¡£ | -| `logging.file.name` | `LOG_FILE` | Èç¹û¶¨ÒåÁË£¬Ëü½«ÓÃÓÚĬÈϵÄÈÕÖ¾ÅäÖÃÖС£ | -| `logging.file.path` | `LOG_PATH` | Èç¹û¶¨ÒåÁË£¬Ëü½«ÓÃÓÚĬÈϵÄÈÕÖ¾ÅäÖÃÖС£ | -| `logging.pattern.console` | `CONSOLE_LOG_PATTERN` | ÔÚ¿ØÖÆÌ¨£¨stdout£©Ê¹ÓõÄÈÕÖ¾Êä³öģʽ¡£ | -| `logging.pattern.dateformat` | `LOG_DATEFORMAT_PATTERN` | date ¸ñʽ»¯. | -| `logging.charset.console` | `CONSOLE_LOG_CHARSET` | ¿ØÖÆÌ¨Êä³öÈÕÖ¾µÄ×Ö·û±àÂë¡£ | -| `logging.threshold.console` | `CONSOLE_LOG_THRESHOLD` | ÓÃÓÚ¿ØÖÆÌ¨ÈÕÖ¾¼Ç¼µÄÈÕÖ¾¼¶±ð¡£ | -| `logging.pattern.file` | `FILE_LOG_PATTERN` | ÒªÔÚÎļþÖÐʹÓõÄÈÕ־ģʽ£¨Èç¹û `LOG_FILE` ±»ÆôÓã©¡£ | -| `logging.charset.file` | `FILE_LOG_CHARSET` | ÎļþÈÕÖ¾µÄ×Ö·û±àÂ루Èç¹û `LOG_FILE` ±»ÆôÓã©¡£ | -| `logging.threshold.file` | `FILE_LOG_THRESHOLD` | ÓÃÓÚÎļþÈÕÖ¾¼Ç¼µÄÈÕÖ¾¼¶±ð¡£ | -| `logging.pattern.level` | `LOG_LEVEL_PATTERN` | äÖȾÈÕÖ¾¼¶±ðʱʹÓõĸñʽ£¨Ä¬ÈÏΪ `%5p` £©¡£ | -| `PID` | `PID` | µ±Ç°µÄ½ø³ÌID | +| `logging.exception-conversion-word` | `LOG_EXCEPTION_CONVERSION_WORD` | 记录异常时使用的转æ�¢è¯�。 | +| `logging.file.name` | `LOG_FILE` | 如果定义了,它将用于默认的日志é…�置中。 | +| `logging.file.path` | `LOG_PATH` | 如果定义了,它将用于默认的日志é…�置中。 | +| `logging.pattern.console` | `CONSOLE_LOG_PATTERN` | 在控制å�°ï¼ˆstdout)使用的日志输出模å¼�。 | +| `logging.pattern.dateformat` | `LOG_DATEFORMAT_PATTERN` | date æ ¼å¼�化. | +| `logging.charset.console` | `CONSOLE_LOG_CHARSET` | 控制å�°è¾“出日志的字符编ç �。 | +| `logging.threshold.console` | `CONSOLE_LOG_THRESHOLD` | 用于控制å�°æ—¥å¿—记录的日志级别。 | +| `logging.pattern.file` | `FILE_LOG_PATTERN` | è¦�在文件中使用的日志模å¼�(如果 `LOG_FILE` 被å�¯ç”¨ï¼‰ã€‚ | +| `logging.charset.file` | `FILE_LOG_CHARSET` | 文件日志的字符编ç �(如果 `LOG_FILE` 被å�¯ç”¨ï¼‰ã€‚ | +| `logging.threshold.file` | `FILE_LOG_THRESHOLD` | 用于文件日志记录的日志级别。 | +| `logging.pattern.level` | `LOG_LEVEL_PATTERN` | 渲染日志级别时使用的格å¼�(默认为 `%5p` )。 | +| `PID` | `PID` | 当å‰�的进程ID | -Èç¹ûÄãʹÓÃLogback£¬ÒÔÏÂÊôÐÔÒ²»á±»×ªÒÆ¡£ +如果你使用Logback,以下属性也会被转移。 -| Spring Environment | System Property | ±¸×¢ | +| Spring Environment | System Property | 备注 | | --- | --- | --- | -| `logging.logback.rollingpolicy.file-name-pattern` | `LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN` | ¹ö¶¯ÈÕÖ¾ÎļþÃûµÄģʽ£¨Ä¬ÈÏΪ `${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz` £©¡£ | -| `logging.logback.rollingpolicy.clean-history-on-start` | `LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START` | ÊÇ·ñÔÚÆô¶¯Ê±ÇåÀí¹éµµÈÕÖ¾Îļþ¡£ | -| `logging.logback.rollingpolicy.max-file-size` | `LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE` | ×î´óÈÕÖ¾Îļþ´óС¡£ | -| `logging.logback.rollingpolicy.total-size-cap` | `LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP` | Òª±£ÁôµÄÈÕÖ¾±¸·ÝµÄ×Ü´óС¡£ | -| `logging.logback.rollingpolicy.max-history` | `LOGBACK_ROLLINGPOLICY_MAX_HISTORY` | Òª±£ÁôµÄ×î´ó¹éµµÈÕÖ¾ÎļþÊýÁ¿¡£ | +| `logging.logback.rollingpolicy.file-name-pattern` | `LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN` | 滚动日志文件å��的模å¼�(默认为 `${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz` )。 | +| `logging.logback.rollingpolicy.clean-history-on-start` | `LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START` | 是å�¦åœ¨å�¯åŠ¨æ—¶æ¸…ç�†å½’档日志文件。 | +| `logging.logback.rollingpolicy.max-file-size` | `LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE` | 最大日志文件大å°�。 | +| `logging.logback.rollingpolicy.total-size-cap` | `LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP` | è¦�ä¿�留的日志备份的总大å°�。 | +| `logging.logback.rollingpolicy.max-history` | `LOGBACK_ROLLINGPOLICY_MAX_HISTORY` | è¦�ä¿�留的最大归档日志文件数é‡�。 | -ËùÓÐÖ§³ÖµÄÈÕ־ϵͳÔÚ½âÎöÆäÅäÖÃÎļþʱ¶¼¿ÉÒÔ´Ó System properties ÖлñÈ¡ÊôÐÔ¡£ Àý×Ó¼û `spring-boot.jar` ÖеÄĬÈÏÅäÖᣠ+所有支æŒ�的日志系统在解æž�å…¶é…�置文件时都å�¯ä»¥ä»Ž System properties 中获å�–属性。 例å­�è§� `spring-boot.jar` 中的默认é…�置。 @@ -552,14 +552,14 @@ logging.register-shutdown-hook=false -| | Èç¹ûÄãÏëÔÚÈÕÖ¾ÊôÐÔÖÐʹÓÃռλ·û£¬ÄãÓ¦¸ÃʹÓÃ[Spring BootµÄÓï·¨](https://springdoc.cn/spring-boot/features.html#features.external-config.files.property-placeholders)¶ø²»Êǵײã¿ò¼ÜµÄÓï·¨¡£ ÖµµÃ×¢ÒâµÄÊÇ£¬Èç¹ûÄãʹÓÃLogback£¬ÄãÓ¦¸ÃʹÓà `:` ×÷ΪÊôÐÔÃûºÍÆäĬÈÏÖµÖ®¼äµÄ·Ö¸ô·û£¬¶ø²»ÊÇʹÓà `:-` ¡£ | +| | 如果你想在日志属性中使用å� ä½�符,你应该使用[Spring Boot的语法](https://springdoc.cn/spring-boot/features.html#features.external-config.files.property-placeholders)而ä¸�是底层框架的语法。 值得注æ„�的是,如果你使用Logback,你应该使用 `:` 作为属性å��和其默认值之间的分隔符,而ä¸�是使用 `:-` 。 | | --- | --- | -| | Äã¿ÉÒÔͨ¹ýÖ»¸²¸Ç `LOG_LEVEL_PATTERN` £¨»òʹÓÃLogbackµÄ `logging.pattern.level` £©À´ÏòÈÕÖ¾ÐÐÌí¼ÓMDCºÍÆäËûÁÙʱÄÚÈÝ¡£ ÀýÈ磬Èç¹ûÄãʹÓà `logging.pattern.level=user:%X{user} %5p` £¬ÄÇôĬÈϵÄÈÕÖ¾¸ñʽ°üº¬Ò»¸ö "user" µÄMDCÌõÄ¿£¬Èç¹ûËü´æÔڵϰ£¬ÈçÏÂÀýËùʾ¡£ 2019-08-30 12:30:04.031 user:someone INFO 22174 --- [ nio-8080-exec-0] demo.ControllerHandling authenticated request | +| | ä½ å�¯ä»¥é€šè¿‡å�ªè¦†ç›– `LOG_LEVEL_PATTERN` (或使用Logbackçš„ `logging.pattern.level` )æ�¥å�‘日志行添加MDC和其他临时内容。 例如,如果你使用 `logging.pattern.level=user:%X{user} %5p` ,那么默认的日志格å¼�包å�«ä¸€ä¸ª "user" çš„MDCæ�¡ç›®ï¼Œå¦‚果它存在的è¯�,如下例所示。 2019-08-30 12:30:04.031 user:someone INFO 22174 --- [ nio-8080-exec-0] demo.ControllerHandling authenticated request | | --- | --- | @@ -568,24 +568,24 @@ logging.register-shutdown-hook=false -### [](https://springdoc.cn/spring-boot/features.html#features.logging.logback-extensions)4.9\. Logback À©Õ¹ +### [](https://springdoc.cn/spring-boot/features.html#features.logging.logback-extensions)4.9\. Logback 扩展 -Spring Boot°üÀ¨Ò»Ð©¶ÔLogbackµÄÀ©Õ¹£¬¿ÉÒÔ°ïÖú½øÐи߼¶ÅäÖᣠÄã¿ÉÒÔÔÚÄãµÄ `logback-spring.xml` ÅäÖÃÎļþÖÐʹÓÃÕâЩÀ©Õ¹¡£ +Spring Boot包括一些对Logback的扩展,å�¯ä»¥å¸®åŠ©è¿›è¡Œé«˜çº§é…�置。 ä½ å�¯ä»¥åœ¨ä½ çš„ `logback-spring.xml` é…�置文件中使用这些扩展。 -| | ÒòΪ±ê×¼µÄ `logback.xml` ÅäÖÃÎļþ±»¹ýÔç¼ÓÔØ£¬Äã²»ÄÜÔÚÆäÖÐʹÓÃÀ©Õ¹¡£ ÄãÐèҪʹÓà `logback-spring.xml` »òÕß¶¨ÒåÒ»¸ö `logging.config` ÊôÐÔ¡£ | +| | 因为标准的 `logback.xml` é…�置文件被过早加载,你ä¸�能在其中使用扩展。 你需è¦�使用 `logback-spring.xml` 或者定义一个 `logging.config` 属性。 | | --- | --- | -| | À©Õ¹³ÌÐò²»ÄÜÓë [LogbackµÄÅäÖÃɨÃè](https://logback.qos.ch/manual/configuration.html#autoScan) Ò»ÆðʹÓᣠÈç¹ûÄãÊÔͼÕâÑù×ö£¬¶ÔÅäÖÃÎļþ½øÐÐÐ޸ĻᵼÖÂÀàËÆÓÚÒÔϵĴíÎ󱻼ǼÏÂÀ´¡£ | +| | 扩展程åº�ä¸�能与 [Logbackçš„é…�置扫æ��](https://logback.qos.ch/manual/configuration.html#autoScan) 一起使用。 如果你试图这样å�šï¼Œå¯¹é…�置文件进行修改会导致类似于以下的错误被记录下æ�¥ã€‚ | | --- | --- | @@ -603,11 +603,11 @@ ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action f -#### [](https://springdoc.cn/spring-boot/features.html#features.logging.logback-extensions.profile-specific)4.9.1\. ÌØ¶¨µÄÅäÖÃÎļþ +#### [](https://springdoc.cn/spring-boot/features.html#features.logging.logback-extensions.profile-specific)4.9.1\. 特定的é…�置文件 -`` ±êÇ©ÈÃÄã¿ÉÒÔ¸ù¾Ý»î¶¯µÄSpringÅäÖÃÎļþÑ¡ÔñÐԵذüÀ¨»òÅųýÅäÖõIJ¿·Ö£¬ Ö§³ÖÔÚ `` ÔªËØµÄÈκεط½¶¨ÒåËü¡£ ʹÓà `name` ÊôÐÔÀ´Ö¸¶¨½ÓÊÜÅäÖõÄÅäÖÃÎļþ¡£ `` ±êÇ©¿ÉÒÔ°üº¬Ò»¸öÅäÖÃÎļþÃû³Æ£¨ÀýÈç `staging` £©»òÒ»¸öÅäÖÃÎļþ±í´ïʽ¡£ ÅäÖÃÎļþ±í´ïʽÔÊÐí±í´ï¸ü¸´ÔÓµÄÅäÖÃÎļþÂß¼­£¬ÀýÈç `production & (eu-central | eu-west)` ¡£ ²é¿´ [Spring ¿ò¼Ü²Î¿¼Ö¸ÄÏ](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/core.html#beans-definition-profiles-java) ÒÔÁ˽â¸ü¶àϸ½Ú¡£ ÏÂÃæµÄÁбíÏÔʾÁËÈý¸öÑù±¾ÅäÖÃÎļþ¡£ +`` 标签让你å�¯ä»¥æ ¹æ�®æ´»åŠ¨çš„Springé…�置文件选择性地包括或排除é…�置的部分, 支æŒ�在 `` 元素的任何地方定义它。 使用 `name` 属性æ�¥æŒ‡å®šæŽ¥å�—é…�置的é…�置文件。 `` 标签å�¯ä»¥åŒ…å�«ä¸€ä¸ªé…�置文件å��称(例如 `staging` )或一个é…�置文件表达å¼�。 é…�置文件表达å¼�å…�许表达更å¤�æ�‚çš„é…�置文件逻辑,例如 `production & (eu-central | eu-west)` 。 查看 [Spring 框架å�‚考指å�—](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/core.html#beans-definition-profiles-java) 以了解更多细节。 下é�¢çš„列表显示了三个样本é…�置文件。 @@ -637,11 +637,11 @@ ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action f -#### [](https://springdoc.cn/spring-boot/features.html#features.logging.logback-extensions.environment-properties)4.9.2\. £¨»·¾³ÊôÐÔ£©Environment Properties +#### [](https://springdoc.cn/spring-boot/features.html#features.logging.logback-extensions.environment-properties)4.9.2\. (环境属性)Environment Properties -`` ±êÇ©¿ÉÒÔ·ÃÎÊ Spring `Environment` ÖеÄÊôÐÔ£¬ÒÔ±ãÔÚLogbackÖÐʹÓᣠÈç¹ûÄãÏëÔÚLogbackÅäÖÃÖзÃÎÊ `application.properties` ÎļþÖеÄÖµ£¬ÕâÑù×ö»áºÜÓÐÓᣠ¸Ã±êÇ©µÄ¹¤×÷·½Ê½ÓëLogbackµÄ±ê×¼ `` ±êÇ©ÀàËÆ¡£ È»¶ø£¬Äã²»ÊÇÖ±½ÓÖ¸¶¨Ò»¸ö `value` £¬¶øÊÇÖ¸¶¨ÊôÐ﵀ `source` £¨À´×Ô `Environment` £©¡£ Èç¹ûÄãÐèÒªÔÚ `local` ·¶Î§ÒÔÍâµÄµØ·½´æ´¢¸ÃÊôÐÔ£¬Äã¿ÉÒÔʹÓà `scope` ÊôÐÔ¡£ Èç¹ûÄãÐèÒªÒ»¸öºó±¸Öµ£¨Ä¬ÈÏÖµ£©£¨ÍòÒ»¸ÃÊôÐÔûÓÐÔÚ `Environment` ÖÐÉèÖã©£¬Äã¿ÉÒÔʹÓà `defaultValue` ÊôÐÔ¡£ ÏÂÃæµÄÀý×ÓÏÔʾÁËÈçºÎ¹«¿ªÊôÐÔÒÔ±ãÔÚLogbackÖÐʹÓᣠ+`` 标签å�¯ä»¥è®¿é—® Spring `Environment` 中的属性,以便在Logback中使用。 如果你想在Logbacké…�置中访问 `application.properties` 文件中的值,这样å�šä¼šå¾ˆæœ‰ç”¨ã€‚ 该标签的工作方å¼�与Logback的标准 `` 标签类似。 然而,你ä¸�是直接指定一个 `value` ,而是指定属性的 `source` (æ�¥è‡ª `Environment` )。 如果你需è¦�在 `local` 范围以外的地方存储该属性,你å�¯ä»¥ä½¿ç”¨ `scope` 属性。 如果你需è¦�一个å�Žå¤‡å€¼ï¼ˆé»˜è®¤å€¼ï¼‰ï¼ˆä¸‡ä¸€è¯¥å±žæ€§æ²¡æœ‰åœ¨ `Environment` 中设置),你å�¯ä»¥ä½¿ç”¨ `defaultValue` 属性。 下é�¢çš„例å­�显示了如何公开属性以便在Logback中使用。 @@ -664,7 +664,7 @@ ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action f -| | `source` ±ØÐëÒÔkebab·ç¸ñÖ¸¶¨£¨Èç `my.property-name` £©¡£ È»¶ø£¬ÊôÐÔ¿ÉÒÔͨ¹ýʹÓÿíËɵĹæÔòÌí¼Óµ½ `Environment` ÖС£ | +| | `source` 必须以kebab风格指定(如 `my.property-name` )。 然而,属性å�¯ä»¥é€šè¿‡ä½¿ç”¨å®½æ�¾çš„规则添加到 `Environment` 中。 | | --- | --- | @@ -675,35 +675,35 @@ ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action f -### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions)4.10\. Log4j2 À©Õ¹ +### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions)4.10\. Log4j2 扩展 -Spring Boot°üÀ¨Ò»Ð©¶ÔLog4j2µÄÀ©Õ¹£¬¿ÉÒÔ°ïÖú½øÐи߼¶ÅäÖá£Äã¿ÉÒÔÔÚÈκΠ`log4j2-spring.xml` ÅäÖÃÎļþÖÐʹÓÃÕâЩÀ©Õ¹¡£ +Spring Boot包括一些对Log4j2的扩展,å�¯ä»¥å¸®åŠ©è¿›è¡Œé«˜çº§é…�置。你å�¯ä»¥åœ¨ä»»ä½• `log4j2-spring.xml` é…�置文件中使用这些扩展。 -| | ÒòΪ±ê×¼µÄ `log4j2.xml` ÅäÖÃÎļþ±»¹ýÔç¼ÓÔØ£¬Äã²»ÄÜÔÚÆäÖÐʹÓÃÀ©Õ¹¡£ÄãÐèҪʹÓà `log4j2-spring.xml` »òÕß¶¨ÒåÒ»¸ö ``logging.config`` ÊôÐÔ¡£ | +| | 因为标准的 `log4j2.xml` é…�置文件被过早加载,你ä¸�能在其中使用扩展。你需è¦�使用 `log4j2-spring.xml` 或者定义一个 ``logging.config`` 属性。 | | --- | --- | -| | ÕâЩÀ©Õ¹È¡´úÁËLog4JÌṩµÄ [Spring BootÖ§³Ö](https://logging.apache.org/log4j/2.x/log4j-spring-boot/index.html)¡£ ÄãÓ¦¸ÃÈ·±£ÔÚÄãµÄ¹¹½¨Öв»°üÀ¨ `org.apache.logging.log4j:log4j-spring-boot` Ä£¿é¡£ | +| | 这些扩展å�–代了Log4Jæ��供的 [Spring Boot支æŒ�](https://logging.apache.org/log4j/2.x/log4j-spring-boot/index.html)。 你应该确ä¿�在你的构建中ä¸�包括 `org.apache.logging.log4j:log4j-spring-boot` 模å�—。 | | --- | --- | -#### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions.profile-specific)4.10.1\. ÌØ¶¨ÅäÖÃÎļþÅäÖà +#### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions.profile-specific)4.10.1\. 特定é…�置文件é…�ç½® -`` ±êÇ©ÈÃÄã¿ÉÒÔ¸ù¾Ý»î¶¯µÄSpringÅäÖÃÎļþÑ¡ÔñÐԵذüÀ¨»òÅųýÅäÖõIJ¿·Ö¡£ÅäÖÃÎļþ²¿·Ö±»Ö§³ÖÔÚ `` ÔªËØµÄÈκεط½¡£Ê¹Óà `name` ÊôÐÔÀ´Ö¸¶¨ÄĸöÅäÖÃÎļþ½ÓÊÜÅäÖᣠ`` ±êÇ©¿ÉÒÔ°üº¬Ò»¸öÅäÖÃÎļþÃû³Æ£¨ÀýÈç `staging`£©»òÒ»¸öÅäÖÃÎļþ±í´ïʽ¡£ ÅäÖÃÎļþ±í´ïʽÔÊÐí±í´ï¸ü¸´ÔÓµÄÅäÖÃÎļþÂß¼­£¬ÀýÈç `production & (eu-central | eu-west)`¡£²é¿´ [Spring¿ò¼Ü²Î¿¼Ö¸ÄÏ](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/core.html#beans-definition-profiles-java) ÒÔÁ˽â¸ü¶àϸ½Ú¡£ ÏÂÃæµÄÁбíÏÔʾÁËÈý¸öÑù±¾ÅäÖÃÎļþ¡£ +`` 标签让你å�¯ä»¥æ ¹æ�®æ´»åŠ¨çš„Springé…�置文件选择性地包括或排除é…�置的部分。é…�置文件部分被支æŒ�在 `` 元素的任何地方。使用 `name` 属性æ�¥æŒ‡å®šå“ªä¸ªé…�置文件接å�—é…�置。 `` 标签å�¯ä»¥åŒ…å�«ä¸€ä¸ªé…�置文件å��称(例如 `staging`)或一个é…�置文件表达å¼�。 é…�置文件表达å¼�å…�许表达更å¤�æ�‚çš„é…�置文件逻辑,例如 `production & (eu-central | eu-west)`。查看 [Spring框架å�‚考指å�—](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/core.html#beans-definition-profiles-java) 以了解更多细节。 下é�¢çš„列表显示了三个样本é…�置文件。 @@ -733,17 +733,17 @@ Spring Boot -#### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions.environment-properties-lookup)4.10.2\. »·¾³£¨Environment£©ÊôÐÔ²éÕÒ +#### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions.environment-properties-lookup)4.10.2\. 环境(Environment)属性查找 -Èç¹ûÄãÏëÔÚLog4j2ÅäÖÃÖÐÒýÓÃSpring `Environment` ÖеÄÊôÐÔ£¬Äã¿ÉÒÔʹÓà `spring:` ǰ׺ [²éÕÒ](https://logging.apache.org/log4j/2.x/manual/lookups.html)¡£Èç¹ûÄãÏëÔÚLog4j2ÅäÖÃÖзÃÎÊ `application.properties` ÎļþÖеÄÖµ£¬ÕâÑù×ö»áºÜÓÐÓᣠ+如果你想在Log4j2é…�置中引用Spring `Environment` 中的属性,你å�¯ä»¥ä½¿ç”¨ `spring:` å‰�ç¼€ [查找](https://logging.apache.org/log4j/2.x/manual/lookups.html)。如果你想在Log4j2é…�置中访问 `application.properties` 文件中的值,这样å�šä¼šå¾ˆæœ‰ç”¨ã€‚ -ÏÂÃæµÄÀý×ÓÏÔʾÁËÈçºÎÉèÖÃÒ»¸öÃûΪ `applicationName` µÄLog4j2ÊôÐÔ£¬Ëü´ÓSpring `Environment` ÖжÁÈ¡ `spring.application.name`¡£ +下é�¢çš„例å­�显示了如何设置一个å��为 `applicationName` çš„Log4j2属性,它从Spring `Environment` 中读å�– `spring.application.name`。 @@ -763,7 +763,7 @@ Spring Boot -| | ²éѯkeyÓ¦ÒÔkebabf·ç¸ñÖ¸¶¨£¨Èç `my.property-name`£©¡£ | +| | 查询key应以kebabf风格指定(如 `my.property-name`)。 | | --- | --- | @@ -772,30 +772,30 @@ Spring Boot -#### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions.environment-property-source)4.10.3\. Log4j2 ϵͳÊôÐÔ£¨System Properties£© +#### [](https://springdoc.cn/spring-boot/features.html#features.logging.log4j2-extensions.environment-property-source)4.10.3\. Log4j2 系统属性(System Properties) -Log4j2Ö§³ÖһЩ [System Properties](https://logging.apache.org/log4j/2.x/manual/configuration.html#SystemProperties)£¬¿ÉÒÔÓÃÀ´ÅäÖø÷ÖÖÏîÄ¿¡£ÀýÈ磬`log4j2.skipJansi` ϵͳÊôÐÔ¿ÉÒÔÓÃÀ´ÅäÖà `ConsoleAppender` ÊÇ·ñ»áÔÚWindowsÉϳ¢ÊÔʹÓà [Jansi](https://github.com/fusesource/jansi) Êä³öÁ÷¡£ +Log4j2支æŒ�一些 [System Properties](https://logging.apache.org/log4j/2.x/manual/configuration.html#SystemProperties),å�¯ä»¥ç”¨æ�¥é…�ç½®å�„ç§�项目。例如,`log4j2.skipJansi` 系统属性å�¯ä»¥ç”¨æ�¥é…�ç½® `ConsoleAppender` 是å�¦ä¼šåœ¨Windows上å°�试使用 [Jansi](https://github.com/fusesource/jansi) 输出æµ�。 -Log4j2 ³õʼ»¯ºó¼ÓÔØµÄËùÓÐϵͳÊôÐÔ¶¼¿ÉÒÔ´ÓSpring `Environment` ÖлñµÃ¡£ÀýÈ磬Äã¿ÉÒÔÔÚ `application.properties` ÎļþÖÐÌí¼Ó `log4j2.skipJansi=false`£¬Èà `ConsoleAppender` ÔÚWindowsÉÏʹÓÃJansi¡£ +Log4j2 åˆ�始化å�ŽåŠ è½½çš„æ‰€æœ‰ç³»ç»Ÿå±žæ€§éƒ½å�¯ä»¥ä»ŽSpring `Environment` 中获得。例如,你å�¯ä»¥åœ¨ `application.properties` 文件中添加 `log4j2.skipJansi=false`,让 `ConsoleAppender` 在Windows上使用Jansi。 -| | Ö»Óе±ÏµÍ³ÊôÐÔ£¨system properties£©ºÍ²Ù×÷ϵͳ»·¾³±äÁ¿²»°üº¬ÕýÔÚ¼ÓÔØµÄֵʱ£¬²Å»á¿¼ÂÇSpring `Environment`¡£ | +| | å�ªæœ‰å½“系统属性(system properties)和æ“�作系统环境å�˜é‡�ä¸�包å�«æ­£åœ¨åŠ è½½çš„å€¼æ—¶ï¼Œæ‰�会考虑Spring `Environment`。 | | --- | --- | -| | ÔÚÔçÆÚLog4j2³õʼ»¯ÆÚ¼ä¼ÓÔØµÄϵͳÊôÐÔ²»ÄÜÒýÓÃSpring `Environment`¡£ÀýÈ磬Log4j2ÓÃÓÚÔÊÐíÑ¡ÔñĬÈÏLog4j2ʵÏÖµÄÊôÐÔÊÇÔÚ Spring Environment ¿ÉÓÃ֮ǰʹÓõġ£ | +| | 在早期Log4j2åˆ�始化期间加载的系统属性ä¸�能引用Spring `Environment`。例如,Log4j2用于å…�许选择默认Log4j2实现的属性是在 Spring Environment å�¯ç”¨ä¹‹å‰�使用的。 | | --- | --- | diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\270\270\350\247\201\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\270\270\350\247\201\346\263\250\350\247\243.md" index c699974..13497d2 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\270\270\350\247\201\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\270\270\350\247\201\346\263\250\350\247\243.md" @@ -1,13 +1,13 @@ -## 1 ¸ÅÊö -Spring Boot ͨ¹ýÆä×Ô¶¯ÅäÖù¦ÄÜʹÅäÖà Spring ±äµÃ¸ü¼ÓÈÝÒס£ +## 1 概述 +Spring Boot 通过其自动é…�置功能使é…�ç½® Spring å�˜å¾—更加容易。 -ÔÚ±¾¿ìËٽ̳ÌÖУ¬ÎÒÃǽ«Ì½Ë÷ org.springframework.boot.autoconfigure ºÍ org.springframework.boot.autoconfigure.condition °üÖеÄ×¢½â¡£ +在本快速教程中,我们将探索 org.springframework.boot.autoconfigure å’Œ org.springframework.boot.autoconfigure.condition 包中的注解。 ## 2 @SpringBootApplication -ÎÒÃÇʹÓÃÕâ¸ö×¢½âÀ´±ê¼Ç Spring Boot Ó¦ÓóÌÐòµÄÖ÷Àࣺ +我们使用这个注解æ�¥æ ‡è®° Spring Boot 应用程åº�的主类: @SpringBootApplication -ÎÒÃÇʹÓÃÕâ¸ö×¢½âÀ´±ê¼Ç Spring Boot Ó¦ÓóÌÐòµÄÖ÷Àࣺ +我们使用这个注解æ�¥æ ‡è®° Spring Boot 应用程åº�的主类: ```` @SpringBootApplication class VehicleFactoryApplication { @@ -17,13 +17,13 @@ class VehicleFactoryApplication { } } ```` -@SpringBootApplication ·â×°ÁË@Configuration¡¢@EnableAutoConfiguration ºÍ@ComponentScan ×¢½â¼°ÆäĬÈÏÊôÐÔ¡£ +@SpringBootApplication å°�装了@Configurationã€�@EnableAutoConfiguration å’Œ@ComponentScan 注解å�Šå…¶é»˜è®¤å±žæ€§ã€‚ ## 3 @EnableAutoConfiguration -@EnableAutoConfiguration£¬¹ËÃû˼Ò壬ÆôÓÃ×Ô¶¯ÅäÖᣠÕâÒâζ×Å Spring Boot ÔÚÆäÀà·¾¶ÖвéÕÒ×Ô¶¯ÅäÖà bean ²¢×Ô¶¯Ó¦ÓÃËüÃÇ¡£ +@EnableAutoConfiguration,顾å��æ€�义,å�¯ç”¨è‡ªåЍé…�置。 è¿™æ„�味ç�€ Spring Boot 在其类路径中查找自动é…�ç½® bean 并自动应用它们。 -Çë×¢Ò⣬ÎÒÃDZØÐ뽫´Ë×¢ÊÍÓë@Configuration Ò»ÆðʹÓ㺠+请注æ„�,我们必须将此注释与@Configuration 一起使用: ```` @Configuration @@ -31,17 +31,17 @@ class VehicleFactoryApplication { class VehicleFactoryConfig {} ```` -## 4 @ConfigurationÒÔ¼°Ïà¹ØÀà +## 4 @Configuration以å�Šç›¸å…³ç±» -@ConfigurationµÄ×÷Ó㺱ê×¢ÔÚÀàÉÏ£¬ÅäÖÃspringÈÝÆ÷(Ó¦ÓÃÉÏÏÂÎÄ)¡£ +@Configuration的作用:标注在类上,é…�ç½®spring容器(应用上下文)。 -ÒÔÍùÎÒÃÇÔÚspringÖÐÅäÖÃbean»áʹÓõ½xmlÅäÖÃÎļþ£¬¶¨ÒåÒ»¸ö¸öbean£¬ÔÚspringbootÖУ¬ÎªÁË×öµ½ÁãÅäÖã¬spring¿ò¼ÜÌṩÁË@ConfigurationÕâÒ»×¢½â +以往我们在spring中é…�ç½®bean会使用到xmlé…�置文件,定义一个个bean,在springboot中,为了å�šåˆ°é›¶é…�置,spring框架æ��供了@Configuration这一注解 -Ï൱ÓڰѸÃÀà×÷ΪspringµÄxmlÅäÖÃÎļþÖÐµÄ +相当于把该类作为springçš„xmlé…�置文件中的 -@Configuration×¢½âµÄÀàÖУ¬Ê¹ÓÃ@Bean×¢½â±ê×¢µÄ·½·¨£¬·µ»ØµÄÀàÐͶ¼»áÖ±½Ó×¢²áΪbean¡£ +@Configuration注解的类中,使用@Bean注解标注的方法,返回的类型都会直接注册为bean。 -@Configure×¢½âµÄ¶¨ÒåÈçÏ£º +@Configure注解的定义如下: ```` @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @@ -51,20 +51,20 @@ public @interface Configuration { String value() default ""; } ```` -´Ó¶¨ÒåÀ´¿´£¬µ×²ãÊǺ¬ÓÐ@Component £¬ËùÒÔ@Configuration ¾ßÓÐºÍ @Component µÄ×÷Óá£Òò´Ëcontext:component-scan/»òÕß@ComponentScan¶¼ÄÜ´¦Àí@Configuration×¢½âµÄÀà¡£ +从定义æ�¥çœ‹ï¼Œåº•层是å�«æœ‰@Component ,所以@Configuration 具有和 @Component 的作用。因此context:component-scan/或者@ComponentScan都能处ç�†@Configuration注解的类。 -ͨ³££¬µ±ÎÒÃDZàд×Ô¶¨Òå×Ô¶¯ÅäÖÃʱ£¬ÎÒÃÇÏ£Íû Spring ÓÐÌõ¼þµØÊ¹ÓÃËüÃÇ¡£ ÎÒÃÇ¿ÉÒÔͨ¹ý±¾½ÚÖеÄ×¢ÊÍÀ´ÊµÏÖÕâÒ»µã¡£ +通常,当我们编写自定义自动é…�置时,我们希望 Spring 有æ�¡ä»¶åœ°ä½¿ç”¨å®ƒä»¬ã€‚ 我们å�¯ä»¥é€šè¿‡æœ¬èŠ‚ä¸­çš„æ³¨é‡Šæ�¥å®žçŽ°è¿™ä¸€ç‚¹ã€‚ -ÎÒÃÇ¿ÉÒÔ½«´Ë²¿·ÖÖеÄ×¢ÊÍ·ÅÔÚ@Configuration Àà»ò@Bean ·½·¨ÉÏ¡£ +我们å�¯ä»¥å°†æ­¤éƒ¨åˆ†ä¸­çš„æ³¨é‡Šæ”¾åœ¨@Configuration 类或@Bean 方法上。 -ÔÚ½ÓÏÂÀ´µÄ²¿·ÖÖУ¬ÎÒÃǽ«Ö»½éÉÜÿ¸öÌõ¼þ±³ºóµÄ»ù±¾¸ÅÄî¡£ ÓûÁ˽â¸ü¶àÐÅÏ¢£¬Çë·ÃÎÊÕâÆªÎÄÕ¡£ +在接下æ�¥çš„部分中,我们将å�ªä»‹ç»�æ¯�个æ�¡ä»¶èƒŒå�Žçš„基本概念。 欲了解更多信æ�¯ï¼Œè¯·è®¿é—®è¿™ç¯‡æ–‡ç« ã€‚ ### 4.1 @ConditionalOnClass and @ConditionalOnMissingClass -ºÜÃ÷ÏÔÕâÊÇÒ»¸ö´øÓÐÌõ¼þÅжϵÄÅäÖÃ×¢½â£¬ÒªÖªµÀ£¬ºÜ¶àʱºòÎÒÃǰ´Ðè¼ÓÔØbeanµÄ£¬ÉõÖÁÊǸù¾ÝÍⲿjar°üÊÇ·ñ´æÔÚÀ´½øÐмÓÔØºÍÅжϵġ£ +很明显这是一个带有æ�¡ä»¶åˆ¤æ–­çš„é…�置注解,è¦�知é�“,很多时候我们按需加载bean的,甚至是根æ�®å¤–部jar包是å�¦å­˜åœ¨æ�¥è¿›è¡ŒåŠ è½½å’Œåˆ¤æ–­çš„ã€‚ -ÕâÖÖʱºò£¬¾ÍÒª¸ù¾ÝÍⲿÀàÊÇ·ñ´æÔÚÀ´¾ö¶¨ÊÇ·ñÊÇ·ñ¼ÓÔØ¸Ãbean +è¿™ç§�时候,就è¦�æ ¹æ�®å¤–部类是å�¦å­˜åœ¨æ�¥å†³å®šæ˜¯å�¦æ˜¯å�¦åŠ è½½è¯¥bean -ʹÓÃÕâЩÌõ¼þ£¬Èç¹û×¢ÊͲÎÊýÖеÄÀà´æÔÚ/²»´æÔÚ£¬Spring ½«½öʹÓñê¼ÇµÄ×Ô¶¯ÅäÖà bean£º +使用这些æ�¡ä»¶ï¼Œå¦‚果注释å�‚数中的类存在/ä¸�存在,Spring 将仅使用标记的自动é…�ç½® bean: ```` @Configuration @@ -76,9 +76,9 @@ class MySQLAutoconfiguration { ### 4.2 @ConditionalOnBean and @ConditionalOnMissingBean -µ±ÎÒÃÇÏëÒª¸ù¾ÝÌØ¶¨ bean µÄ´æÔÚ»ò²»´æÔÚÀ´¶¨ÒåÌõ¼þʱ£¬ÎÒÃÇ¿ÉÒÔʹÓÃÕâЩעÊÍ£º +当我们想è¦�æ ¹æ�®ç‰¹å®š bean 的存在或ä¸�存在æ�¥å®šä¹‰æ�¡ä»¶æ—¶ï¼Œæˆ‘们å�¯ä»¥ä½¿ç”¨è¿™äº›æ³¨é‡Šï¼š -ºÍÉÏÃæÒ»¸ö×¢½âÉÔÓÐЩ²»Í¬£¬ÒòΪÎÒÃǵÄÅжÏÌõ¼þ±ä³ÉÁËbean +和上é�¢ä¸€ä¸ªæ³¨è§£ç¨�有些ä¸�å�Œï¼Œå› ä¸ºæˆ‘们的判断æ�¡ä»¶å�˜æˆ�了bean ```` @Bean @@ -88,9 +88,9 @@ LocalContainerEntityManagerFactoryBean entityManagerFactory() { } ```` ### 4.3 @ConditionalOnProperty -ͨ¹ýÕâ¸ö×¢½â£¬ÎÒÃÇ¿ÉÒÔ¶ÔÊôÐÔµÄÖµÉèÖÃÌõ¼þ +通过这个注解,我们å�¯ä»¥å¯¹å±žæ€§çš„值设置æ�¡ä»¶ -ҪעÒ⣬ÕâÀïµÄÊôÐÔÖµÀ´Ô´ÓÚapplication.propertiesÎļþÖеÄÅäÖà +è¦�注æ„�,这里的属性值æ�¥æº�于application.properties文件中的é…�ç½® ```` @Bean @@ -105,8 +105,8 @@ DataSource dataSource() { ### 4.4 @ConditionalOnResource -ÎÒÃÇ¿ÉÒÔÈà Spring ½öÔÚ´æÔÚÌØ¶¨×ÊԴʱʹÓö¨Ò壺 -¹ËÃû˼Ò壬ҪÇóclasspath´æÔÚÕâ¸ö×ÊÔ´Îļþʱ²Å½øÐмÓÔØ£¬ÕâÒ²ÊǺܳ£ÓõÄÒ»¸ö×¢½â¡£ +我们å�¯ä»¥è®© Spring 仅在存在特定资æº�时使用定义: +顾å��æ€�义,è¦�求classpath存在这个资æº�文件时æ‰�进行加载,这也是很常用的一个注解。 ```` @@ -117,9 +117,9 @@ Properties ditionalProperties() { ```` ### 4.5 @ConditionalOnWebApplication and @ConditionalOnNotWebApplication -Õâ¸ö×¢½âͨ³£ÓÃÓÚºÍwebÓÐÇ¿¹ØÁª£¬»òÕßÍêÈ«ÎÞ¹ØÁªµÄÅäÖÃÉÏ +这个注解通常用于和web有强关è�”,或者完全无关è�”çš„é…�置上 -ʹÓÃÕâЩעÊÍ£¬ÎÒÃÇ¿ÉÒÔ¸ù¾Ýµ±Ç°Ó¦ÓóÌÐòÊÇ·ñÊÇ Web Ó¦ÓóÌÐòÀ´´´½¨Ìõ¼þ£º +使用这些注释,我们å�¯ä»¥æ ¹æ�®å½“å‰�应用程åº�是å�¦æ˜¯ Web 应用程åº�æ�¥åˆ›å»ºæ�¡ä»¶ï¼š ```` @ConditionalOnWebApplication @@ -129,9 +129,9 @@ HealthCheckController healthCheckController() { ```` ### 4.6 @ConditionalExpression -springbootÕæµÄΪÎÒÃÇÏëµ½ÁËËùÓÐÇé¿ö£¬Èç¹ûÉÏÃæµÄ×¢½â»¹²»ÄÜÂú×ãÄãµÄÒªÇó£¬ÄÇô¸É´à¾ÍÈÃÄã×Ô¼ºÐ´£¬ÕâÏÂÓ¦¸ÃûÓÐÎÊÌâ°É£¿ +springboot真的为我们想到了所有情况,如果上é�¢çš„æ³¨è§£è¿˜ä¸�能满足你的è¦�求,那么干脆就让你自己写,这下应该没有问题å�§ï¼Ÿ -ÎÒÃÇ¿ÉÒÔÔÚ¸ü¸´ÔÓµÄÇé¿öÏÂʹÓÃÕâ¸ö×¢½â¡£ µ± SpEL ±í´ïʽ±»ÆÀ¹ÀÎªÕæÊ±£¬Spring ½«Ê¹Óñê¼ÇµÄ¶¨Ò壺 +我们å�¯ä»¥åœ¨æ›´å¤�æ�‚的情况下使用这个注解。 当 SpEL 表达å¼�被评估为真时,Spring 将使用标记的定义: ```` @Bean @@ -142,10 +142,10 @@ DataSource dataSource() { ```` ### 4.7 @Conditional -ʲô£¬»¹ÓÐÎÊÌ⣿ -ÄÇspringbootÒ²²»ÔÙÌṩʲô±í´ïʽ¸øÄãÁË£¬Ö±½ÓÈÃÓû§Ð´Ò»¸öÅжÏÌõ¼þ£¬¸æËßÎÒtrue»òÕßfalse¾ÍÐÐÁË +什么,还有问题? +é‚£springboot也ä¸�å†�æ��供什么表达å¼�给你了,直接让用户写一个判断æ�¡ä»¶ï¼Œå‘Šè¯‰æˆ‘true或者false就行了 -¶ÔÓÚ¸ü¸´ÔÓµÄÌõ¼þ£¬ÎÒÃÇ¿ÉÒÔ´´½¨Ò»¸öÆÀ¹À×Ô¶¨ÒåÌõ¼þµÄÀà¡£ ÎÒÃǸæËß Spring ½«Õâ¸ö×Ô¶¨ÒåÌõ¼þÓë @Conditional Ò»ÆðʹÓ㺠+对于更å¤�æ�‚çš„æ�¡ä»¶ï¼Œæˆ‘们å�¯ä»¥åˆ›å»ºä¸€ä¸ªè¯„估自定义æ�¡ä»¶çš„类。 我们告诉 Spring 将这个自定义æ�¡ä»¶ä¸Ž @Conditional 一起使用: ```` @Conditional(HibernateCondition.class) @@ -154,5 +154,5 @@ Properties ditionalProperties() { } ```` -## 5 ×ܽá -ÔÚ±¾ÎÄÖУ¬ÎÒÃǸÅÊöÁËÈçºÎ΢µ÷×Ô¶¯ÅäÖùý³Ì²¢Îª×Ô¶¨Òå×Ô¶¯ÅäÖà bean ÌṩÌõ¼þ¡£ \ No newline at end of file +## 5 总结 +在本文中,我们概述了如何微调自动é…�置过程并为自定义自动é…�ç½® bean æ��ä¾›æ�¡ä»¶ã€‚ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\272\224\347\224\250\344\271\237\345\217\257\344\273\245\351\203\250\347\275\262\345\210\260\345\244\226\351\203\250Tomcat.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\272\224\347\224\250\344\271\237\345\217\257\344\273\245\351\203\250\347\275\262\345\210\260\345\244\226\351\203\250Tomcat.md" index e22fa00..acf97c6 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\272\224\347\224\250\344\271\237\345\217\257\344\273\245\351\203\250\347\275\262\345\210\260\345\244\226\351\203\250Tomcat.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\345\272\224\347\224\250\344\271\237\345\217\257\344\273\245\351\203\250\347\275\262\345\210\260\345\244\226\351\203\250Tomcat.md" @@ -2,9 +2,9 @@
-# Spring Boot Tomcat²¿Êð +# Spring Boot Tomcat部署 -ÒÔÏÂÄÚÈݽöÊÇÕ¾³¤»òÍøÓѸöÈËѧϰ±Ê¼Ç¡¢×ܽáºÍÑо¿Êղء£²»±£Ö¤ÕýÈ·ÐÔ£¬ÒòʹÓöø´øÀ´µÄ·çÏÕÓë±¾Õ¾Î޹أ¡ +以下内容仅是站长或网å�‹ä¸ªäººå­¦ä¹ ç¬”è®°ã€�总结和研究收è—�。ä¸�ä¿�è¯�正确性,因使用而带æ�¥çš„风险与本站无关ï¼�
@@ -14,13 +14,13 @@ -ͨ¹ýʹÓÃSpring BootÓ¦ÓóÌÐò£¬¿ÉÒÔ´´½¨Ò»¸öwarÎļþÒÔ²¿Êðµ½Web·þÎñÆ÷ÖС£ÔÚ±¾ÕÂÖУ¬½«Ñ§Ï°ÈçºÎ´´½¨WARÎļþ²¢ÔÚTomcat Web·þÎñÆ÷Öв¿ÊðSpring BootÓ¦ÓóÌÐò¡£ +通过使用Spring Boot应用程åº�,å�¯ä»¥åˆ›å»ºä¸€ä¸ªwar文件以部署到Webæœ�务器中。在本章中,将学习如何创建WAR文件并在Tomcat Webæœ�务器中部署Spring Boot应用程åº�。 -## Spring Boot Servlet³õʼ»¯³ÌÐò +## Spring Boot Servletåˆ�始化程åº� -´«Í³µÄ²¿Êð·½Ê½ÊÇʹSpring BootÓ¦ÓóÌÐò`[@SpringBootApplication](https://github.com/SpringBootApplication "@SpringBootApplication")`ÀàÀ©Õ¹`SpringBootServletInitializer`Àà¡£ `SpringBootServletInitializer`ÀàÎļþÔÊÐíÔÚʹÓÃServletÈÝÆ÷Æô¶¯Ê±ÅäÖÃÓ¦ÓóÌÐò¡£ +传统的部署方å¼�是使Spring Boot应用程åº�`[@SpringBootApplication](https://github.com/SpringBootApplication "@SpringBootApplication")`类扩展`SpringBootServletInitializer`类。 `SpringBootServletInitializer`类文件å…�许在使用Servlet容器å�¯åŠ¨æ—¶é…�置应用程åº�。 -ÏÂÃæ¸ø³öÁËÓÃÓÚJARÎļþ²¿ÊðµÄSpring BootÓ¦ÓóÌÐòÀàÎļþµÄ´úÂë - +下é�¢ç»™å‡ºäº†ç”¨äºŽJAR文件部署的Spring Boot应用程åº�类文件的代ç � - ``` package com.yiibai.demo; @@ -37,7 +37,7 @@ public class DemoApplication { ``` -ÐèÒªÀ©Õ¹Àà`SpringBootServletInitializer`ÒÔÖ§³ÖWARÎļþ²¿Êð¡£ Spring BootÓ¦ÓóÌÐòÀàÎļþµÄ´úÂëÈçÏ - +需è¦�扩展类`SpringBootServletInitializer`以支æŒ�WAR文件部署。 Spring Boot应用程åº�类文件的代ç �如下 - ``` package com.yiibai.demo; @@ -60,35 +60,35 @@ public class DemoApplication extends SpringBootServletInitializer { ``` -## ÉèÖÃMainÀà +## 设置Mainç±» -ÔÚSpring BootÖУ¬ÐèÒªÔÚ¹¹½¨ÎļþÖÐÖ¸¶¨Æô¶¯µÄÖ÷Àà¡£ -¶ÔÓÚMaven£¬ÔÚ`pom.xml`ÊôÐÔÖÐÌí¼Ó`start`À࣬ÈçÏÂËùʾ - +在Spring Boot中,需è¦�在构建文件中指定å�¯åŠ¨çš„ä¸»ç±»ã€‚ +对于Maven,在`pom.xml`属性中添加`start`类,如下所示 - ``` com.yiibai.demo.DemoApplication ``` -¶ÔÓÚGradle£¬ÔÚ`build.gradle`ÖÐÌí¼ÓÖ÷ÀàÃû£¬ÈçÏÂËùʾ - +对于Gradle,在`build.gradle`中添加主类å��,如下所示 - ``` mainClassName="com.yiibai.demo.DemoApplication" ``` -## ½«´ò°üJAR¸üÐÂΪWAR +## 将打包JAR更新为WAR -ʹÓÃÒÔÏ´úÂ뽫°ü×°JAR¸üÐÂΪWAR¡£ +使用以下代ç �将包装JAR更新为WAR。 -¶ÔÓÚMaven£¬ÔÚ_pom.xml_ Öн«°ü×°Ìí¼ÓΪWAR£¬ÈçÏÂËùʾ - +对于Maven,在_pom.xml_ 中将包装添加为WAR,如下所示 - ``` war ``` -¶ÔÓÚGradle£¬ÔÚ_build.gradle_ ÖÐÌí¼ÓÓ¦ÓóÌÐò²å¼þºÍwar²å¼þ£¬ÈçÏÂËùʾ - +对于Gradle,在_build.gradle_ 中添加应用程åº�æ�’ä»¶å’Œwaræ�’件,如下所示 - ``` apply plugin: 'war' @@ -96,9 +96,9 @@ apply plugin: 'application' ``` -¶ÔÓÚGradlNow£¬±àдһ¸ö¼òµ¥µÄRest¶ËµãÀ´·µ»Ø×Ö·û´®:`"Hello World from Tomcat"`¡£ Òª±àдRest¶Ëµã£¬ÐèÒª½«Spring Boot Web starterÒÀÀµÏîÌí¼Óµ½¹¹½¨ÎļþÖС£ +对于GradlNow,编写一个简å�•çš„Rest端点æ�¥è¿”回字符串:`"Hello World from Tomcat"`。 è¦�编写Rest端点,需è¦�å°†Spring Boot Web starterä¾�赖项添加到构建文件中。 -¶ÔÓÚMaven£¬Ê¹ÓÃÈçÏÂËùʾµÄ´úÂëÔÚ_pom.xml_ ÖÐÌí¼ÓSpring BootÆô¶¯³ÌÐòÒÀÀµÏî - +对于Maven,使用如下所示的代ç �在_pom.xml_ 中添加Spring Bootå�¯åŠ¨ç¨‹åº�ä¾�赖项 - ``` @@ -108,7 +108,7 @@ apply plugin: 'application' ``` -¶ÔÓÚGradle£¬Ê¹ÓÃÈçÏÂËùʾµÄ´úÂëÔÚ_build.gradle_ ÖÐÌí¼ÓSpring Boot starterÒÀÀµÏî - +对于Gradle,使用如下所示的代ç �在_build.gradle_ 中添加Spring Boot starterä¾�赖项 - ``` dependencies { @@ -117,7 +117,7 @@ dependencies { ``` -ÏÖÔÚ£¬Ê¹ÓÃÈçÏÂËùʾµÄ´úÂëÔÚSpring Boot ApplicationÀàÎļþÖбàдһ¸ö¼òµ¥µÄRest¶Ëµã - +现在,使用如下所示的代ç �在Spring Boot Application类文件中编写一个简å�•çš„Rest端点 - ``` package com.yiibai.demo; @@ -148,31 +148,31 @@ public class DemoApplication extends SpringBootServletInitializer { ``` -## ´ò°üÓ¦ÓóÌÐò +## 打包应用程åº� -ÏÖÔÚ£¬Ê¹ÓÃMavenºÍGradleÃüÁî´´½¨Ò»¸öWARÎļþÒÔ²¿Êðµ½Tomcat·þÎñÆ÷ÖУ¬ÒÔ´ò°üÓ¦ÓóÌÐò£¬ÈçÏÂËùʾ¡£ +现在,使用Mavenå’ŒGradle命令创建一个WAR文件以部署到Tomcatæœ�务器中,以打包应用程åº�,如下所示。 -¶ÔÓÚMaven£¬Ê¹ÓÃÃüÁî`mvn package`´ò°üÓ¦ÓóÌÐò¡£ È»ºó´´½¨WARÎļþ£¬¿ÉÒÔÔÚÄ¿±êĿ¼ÖÐÕÒµ½Ëü£¬ÈçÏÂÃæ¸ø³öµÄÆÁÄ»½ØÍ¼Ëùʾ - +对于Maven,使用命令`mvn package`打包应用程åº�。 ç„¶å�Žåˆ›å»ºWAR文件,å�¯ä»¥åœ¨ç›®æ ‡ç›®å½•中找到它,如下é�¢ç»™å‡ºçš„å±�幕截图所示 - ![](/uploads/images/2018/09/27/084613_17931.jpg) -¶ÔÓÚGradle£¬Ê¹ÓÃÃüÁî`gradle clean build`´ò°üÓ¦ÓóÌÐò¡£ È»ºó£¬½«´´½¨WARÎļþ£¬¿ÉÒÔÔÚ`build/libs`Ŀ¼ÏÂÕÒµ½Ëü¡£¹Û²ì´Ë´¦¸ø³öµÄÆÁÄ»½ØÍ¼ÒÔ±ã¸üºÃµØÀí½â - +对于Gradle,使用命令`gradle clean build`打包应用程åº�。 ç„¶å�Žï¼Œå°†åˆ›å»ºWAR文件,å�¯ä»¥åœ¨`build/libs`目录下找到它。观察此处给出的å±�幕截图以便更好地ç�†è§£ - ![](/uploads/images/2018/09/27/084717_10144.jpg) -## ²¿Êðµ½Tomcat +## 部署到Tomcat -ÏÖÔÚ£¬ÔËÐÐTomcat·þÎñÆ÷£¬²¢ÔÚwebappsĿ¼Ï²¿ÊðWARÎļþ¡£¹Û²ì´Ë´¦ÏÔʾµÄÆÁÄ»½ØÍ¼ÒÔ±ã¸üºÃµØÀí½â - +现在,è¿�行Tomcatæœ�务器,并在webapps目录下部署WAR文件。观察此处显示的å±�幕截图以便更好地ç�†è§£ - ![](/uploads/images/2018/09/27/084759_50620.jpg) -³É¹¦²¿Êðºó£¬µã»÷ÍøÒ³ä¯ÀÀÆ÷ÖеÄURL => `http://localhost:8080/demo-0.0.1-SNAPSHOT/`£¬¹Û²ìÊä³ö½á¹ûÈçÏÂͼËùʾ - +æˆ�功部署å�Žï¼Œç‚¹å‡»ç½‘页æµ�览器中的URL => `http://localhost:8080/demo-0.0.1-SNAPSHOT/`,观察输出结果如下图所示 - ![](/uploads/images/2018/09/27/084848_70593.jpg) -ÍêÕû´úÂëÈçÏ£º +完整代ç �如下: -Îļþ£º_pom.xml_ - +文件:_pom.xml_ - ``` @@ -228,7 +228,7 @@ xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 http://maven.apache.org/ ``` -Îļþ£º_build.gradle_ +文件:_build.gradle_ ``` buildscript { @@ -264,7 +264,7 @@ dependencies { ``` -Spring BootÓ¦ÓóÌÐòÀàÎļþµÄ´úÂëÈçÏ - +Spring Boot应用程åº�类文件的代ç �如下 - ``` package com.yiibai.demo; @@ -298,5 +298,5 @@ public class DemoApplication extends SpringBootServletInitializer { -//¸ü¶àÇëÔĶÁ£ºhttps://www.yiibai.com/spring-boot/spring_boot_tomcat_deployment.html +//更多请阅读:https://www.yiibai.com/spring-boot/spring_boot_tomcat_deployment.html diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\224\237\344\272\247\347\216\257\345\242\203\345\267\245\345\205\267Actuator.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\224\237\344\272\247\347\216\257\345\242\203\345\267\245\345\205\267Actuator.md" index e0eeb3e..eef646a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\224\237\344\272\247\347\216\257\345\242\203\345\267\245\345\205\267Actuator.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\224\237\344\272\247\347\216\257\345\242\203\345\267\245\345\205\267Actuator.md" @@ -1,22 +1,22 @@ -# Éú²ú¾ÍÐ÷¹¦ÄÜ +# 生产就绪功能 [Back to index](https://springdoc.cn/spring-boot/index.html) -* [1\. ÆôÓÃÉú²ú¾ÍÐ÷µÄ¹¦ÄÜ](https://springdoc.cn/spring-boot/actuator.html#actuator.enabling) -* [2\. ¶Ëµã£¨Endpoint£©](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints) -* [3\. ͨ¹ýHTTP½øÐÐ¼à¿ØºÍ¹ÜÀí](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring) -* [4\. ͨ¹ýJMX½øÐÐ¼à¿ØºÍ¹ÜÀí](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx) -* [5\. ¿É¹Û²âÐÔ£¨Observability£©](https://springdoc.cn/spring-boot/actuator.html#actuator.observability) -* [6\. ÈÕÖ¾¼Ç¼Æ÷£¨Logger£©](https://springdoc.cn/spring-boot/actuator.html#actuator.loggers) -* [7\. Ö¸±ê£¨Metrics£©](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics) -* [8\. ×·×Ù£¨Tracing£©](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing) -* [9\. Éó¼Æ](https://springdoc.cn/spring-boot/actuator.html#actuator.auditing) -* [10\. ¼Ç¼ HTTP Exchange](https://springdoc.cn/spring-boot/actuator.html#actuator.http-exchanges) -* [11\. ½ø³Ì¼à¿Ø](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring) -* [12\. Cloud Foundry µÄÖ§³Ö](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry) -* [13\. ½ÓÏÂÀ´¶Áʲô](https://springdoc.cn/spring-boot/actuator.html#actuator.whats-next) +* [1\. å�¯ç”¨ç”Ÿäº§å°±ç»ªçš„功能](https://springdoc.cn/spring-boot/actuator.html#actuator.enabling) +* [2\. 端点(Endpoint)](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints) +* [3\. 通过HTTP进行监控和管ç�†](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring) +* [4\. 通过JMX进行监控和管ç�†](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx) +* [5\. å�¯è§‚测性(Observability)](https://springdoc.cn/spring-boot/actuator.html#actuator.observability) +* [6\. 日志记录器(Logger)](https://springdoc.cn/spring-boot/actuator.html#actuator.loggers) +* [7\. 指标(Metrics)](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics) +* [8\. 追踪(Tracing)](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing) +* [9\. 审计](https://springdoc.cn/spring-boot/actuator.html#actuator.auditing) +* [10\. 记录 HTTP Exchange](https://springdoc.cn/spring-boot/actuator.html#actuator.http-exchanges) +* [11\. 进程监控](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring) +* [12\. Cloud Foundry 的支æŒ�](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry) +* [13\. 接下æ�¥è¯»ä»€ä¹ˆ](https://springdoc.cn/spring-boot/actuator.html#actuator.whats-next) @@ -30,14 +30,14 @@ -| | ±¾Õ¾([springdoc.cn](https://springdoc.cn/))ÖеÄÄÚÈÝÀ´Ô´ÓÚ [spring.io](https://spring.io/) £¬Ô­Ê¼°æÈ¨¹éÊôÓÚ [spring.io](https://spring.io/)¡£ÓÉ [springboot.io - Spring BootÖÐÎÄÉçÇø](https://springboot.io/) ½øÐз­Ò룬ÕûÀí¡£¿É¹©¸öÈËѧϰ¡¢Ñо¿£¬Î´¾­Ðí¿É£¬²»µÃ½øÐÐÈκÎ×ªÔØ¡¢ÉÌÓûòÓëÖ®Ïà¹ØµÄÐÐΪ¡£ É̱êÉùÃ÷£ºSpring ÊÇ Pivotal Software, Inc. ÔÚÃÀ¹úÒÔ¼°ÆäËû¹ú¼ÒµÄÉ̱ꡣ | +| | 本站([springdoc.cn](https://springdoc.cn/))中的内容æ�¥æº�于 [spring.io](https://spring.io/) ,原始版æ�ƒå½’属于 [spring.io](https://spring.io/)。由 [springboot.io - Spring Boot中文社区](https://springboot.io/) 进行翻译,整ç�†ã€‚å�¯ä¾›ä¸ªäººå­¦ä¹ ã€�研究,未ç»�许å�¯ï¼Œä¸�得进行任何转载ã€�商用或与之相关的行为。 商标声明:Spring 是 Pivotal Software, Inc. 在美国以å�Šå…¶ä»–国家的商标。 | | --- | --- | -Spring Boot°üÀ¨Ò»Ð©¶îÍâµÄ¹¦ÄÜ£¬ÒÔ°ïÖúÄãÔÚ½«Ó¦ÓóÌÐò·¢²¼µ½Éú²úʱ¼à¿ØºÍ¹ÜÀíÄãµÄÓ¦ÓóÌÐò¡£ Äã¿ÉÒÔÑ¡Ôñͨ¹ýʹÓÃHTTP¶Ëµã»òʹÓÃJMXÀ´¹ÜÀíºÍ¼à¿ØÄãµÄÓ¦ÓóÌÐò¡£ É󼯡¢½¡¿µºÍÖ¸±êÊÕ¼¯Ò²¿ÉÒÔ×Ô¶¯Ó¦ÓÃÓÚÄãµÄÓ¦ÓóÌÐò¡£ +Spring Boot包括一些é¢�外的功能,以帮助你在将应用程åº�å�‘布到生产时监控和管ç�†ä½ çš„应用程åº�。 ä½ å�¯ä»¥é€‰æ‹©é€šè¿‡ä½¿ç”¨HTTP端点或使用JMXæ�¥ç®¡ç�†å’Œç›‘控你的应用程åº�。 审计ã€�å�¥åº·å’ŒæŒ‡æ ‡æ”¶é›†ä¹Ÿå�¯ä»¥è‡ªåŠ¨åº”ç”¨äºŽä½ çš„åº”ç”¨ç¨‹åº�。 @@ -47,13 +47,13 @@ Spring Boot -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.enabling)1\. ÆôÓÃÉú²ú¾ÍÐ÷µÄ¹¦ÄÜ +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.enabling)1\. å�¯ç”¨ç”Ÿäº§å°±ç»ªçš„功能 -[`spring-boot-actuator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator) Ä£¿éÌṩÁËËùÓÐSpring BootµÄÉú²ú¾ÍÐ÷¹¦ÄÜ¡£ ÆôÓÃÕâЩ¹¦ÄܵÄÍÆ¼ö·½·¨ÊÇÌí¼Ó¶Ô `spring-boot-starter-actuator` ¡°Starter¡± µÄÒÀÀµ¡£ +[`spring-boot-actuator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator) 模å�—æ��供了所有Spring Boot的生产就绪功能。 å�¯ç”¨è¿™äº›åŠŸèƒ½çš„æŽ¨è��方法是添加对 `spring-boot-starter-actuator` “Starterâ€� çš„ä¾�赖。 @@ -61,11 +61,11 @@ Spring Boot -ActuatorµÄ¶¨Òå +Actuator的定义 -actuator£¨Ö´ÐÐÆ÷£© ÊÇÒ»¸öÖÆÔìÊõÓָµÄÊÇÓÃÓÚÒÆ¶¯»ò¿ØÖÆÄ³ÎïµÄ»úеװÖá£actuator ¿ÉÒÔ´ÓÒ»¸öСµÄ±ä»¯ÖвúÉú´óÁ¿µÄÔ˶¯¡£ +actuator(执行器) 是一个制造术语,指的是用于移动或控制æŸ�物的机械装置。actuator å�¯ä»¥ä»Žä¸€ä¸ªå°�çš„å�˜åŒ–中产生大é‡�çš„è¿�动。 @@ -75,7 +75,7 @@ actuator -ÒªÔÚ»ùÓÚMavenµÄÏîÄ¿ÖÐÌí¼Óactuator£¬ÇëÌí¼ÓÒÔÏ ¡°Starter¡± ÒÀÀµ¡£ +è¦�在基于Maven的项目中添加actuator,请添加以下 “Starterâ€� ä¾�赖。 @@ -98,7 +98,7 @@ actuator -¶ÔÓÚGradle£¬Ê¹ÓÃÒÔÏÂÉùÃ÷¡£ +对于Gradle,使用以下声明。 @@ -122,80 +122,80 @@ dependencies { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints)2\. ¶Ëµã£¨Endpoint£© +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints)2\. 端点(Endpoint) -Actuator ¶Ëµã£¨endpoint£©ÈÃÄã¿ÉÒÔ¼à¿Ø²¢ÓëÄãµÄÓ¦ÓóÌÐò»¥¶¯¡£ Spring Boot°üÀ¨Ò»Ð©ÄÚÖõĶ˵㣬²¢ÔÊÐíÄãÌí¼Ó×Ô¼ºµÄ¶Ëµã¡£ ÀýÈ磬`health` ¶ËµãÌṩ»ù±¾µÄÓ¦ÓóÌÐò½¡¿µÐÅÏ¢¡£ +Actuator 端点(endpoint)让你å�¯ä»¥ç›‘控并与你的应用程åº�互动。 Spring Boot包括一些内置的端点,并å…�许你添加自己的端点。 例如,`health` 端点æ��供基本的应用程åº�å�¥åº·ä¿¡æ�¯ã€‚ -Äã¿ÉÒÔ[ÆôÓûò½ûÓÃ](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.enabling)ÿ¸öµ¥¶ÀµÄ¶Ëµã£¬²¢[ͨ¹ýHTTP»òJMX¹«¿ªËüÃÇ£¨Ê¹ËüÃÇ¿ÉÒÔÔ¶³Ì·ÃÎÊ£©](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)¡£µ±Ò»¸ö¶Ëµã±»ÆôÓúͱ©Â¶Ê±£¬Ëü±»ÈÏΪÊÇ¿ÉÓõġ£ÄÚÖõĶ˵ãÖ»ÓÐÔÚËüÃÇ¿ÉÓÃʱ²Å»á±»×Ô¶¯ÅäÖᣴó¶àÊýÓ¦ÓóÌÐòÑ¡Ôñͨ¹ýHTTP±©Â¶£¬ÆäÖж˵ãµÄIDºÍ `/actuator` µÄǰ׺±»Ó³Éäµ½Ò»¸öURL¡£ÀýÈ磬ĬÈÏÇé¿öÏ£¬`health` ¶Ëµã±»Ó³Éäµ½ `/actuator/health`¡£ +ä½ å�¯ä»¥[å�¯ç”¨æˆ–ç¦�用](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.enabling)æ¯�个å�•独的端点,并[通过HTTP或JMX公开它们(使它们å�¯ä»¥è¿œç¨‹è®¿é—®ï¼‰](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)。当一个端点被å�¯ç”¨å’Œæš´éœ²æ—¶ï¼Œå®ƒè¢«è®¤ä¸ºæ˜¯å�¯ç”¨çš„。内置的端点å�ªæœ‰åœ¨å®ƒä»¬å�¯ç”¨æ—¶æ‰�会被自动é…�置。大多数应用程åº�选择通过HTTP暴露,其中端点的IDå’Œ `/actuator` çš„å‰�缀被映射到一个URL。例如,默认情况下,`health` 端点被映射到 `/actuator/health`。 -| | ÒªÁ˽â¸ü¶à¹ØÓÚactuatorµÄ¶ËµãÒÔ¼°ËüÃǵÄÇëÇóºÍÏìÓ¦¸ñʽ£¬Çë¿´µ¥¶ÀµÄAPIÎĵµ£¨ [HTML](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/htmlsingle) »ò [PDF](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/pdf/spring-boot-actuator-web-api.pdf)£©¡£ | +| | è¦�了解更多关于actuator的端点以å�Šå®ƒä»¬çš„请求和å“�应格å¼�,请看å�•独的API文档( [HTML](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/htmlsingle) 或 [PDF](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/pdf/spring-boot-actuator-web-api.pdf))。 | | --- | --- | -ÒÔÏÂÊǼ¼ÊõÎ޹صÄÖÕ¶Ë¡£ +以下是技术无关的终端。 -| ID | ˵Ã÷ | +| ID | 说明 | | --- | --- | -| `auditevents` | ¹«¿ªµ±Ç°Ó¦ÓóÌÐòµÄÉó¼ÆÊ¼þÐÅÏ¢¡£ ÐèÒªÒ»¸ö `AuditEventRepository` bean¡£ | -| `beans` | ÏÔʾÄãµÄÓ¦ÓóÌÐòÖÐËùÓÐSpring BeanµÄÍêÕûÁÐ±í¡£ | -| `caches` | ÏÔʾ¿ÉÓõĻº´æ¡£ | -| `conditions` | ÏÔʾ¶ÔÅäÖúÍ×Ô¶¯ÅäÖÃÀà½øÐÐÆÀ¹ÀµÄÌõ¼þ£¬ÒÔ¼°ËüÃÇ·ûºÏ»ò²»·ûºÏµÄÔ­Òò¡£ | -| `configprops` | ÏÔʾËùÓÐ `@ConfigurationProperties` µÄÕûÀíÁÐ±í¡£ | -| `env` | ±©Â¶SpringµÄ `ConfigurableEnvironment` ÖеÄÊôÐÔ¡£ | -| `flyway` | ÏÔʾÈκÎÒѾ­Ó¦ÓõÄFlywayÊý¾Ý¿âÇ¨ÒÆ¡£ ÐèÒªÒ»¸ö»ò¶à¸ö `Flyway` bean¡£ | -| `health` | ÏÔʾӦÓóÌÐòµÄ½¡¿µÐÅÏ¢¡£ | -| `httpexchanges` | ÏÔʾ HTTP exchange ÐÅÏ¢£¨Ä¬ÈÏÇé¿öÏ£¬×îºó 100 ¸ö HTTP request/response exchange£©¡£ ÐèÒªÒ»¸ö `HttpExchangeRepository` bean¡£ | -| `info` | ÏÔʾÈÎÒâµÄÓ¦ÓóÌÐòÐÅÏ¢¡£ | -| `integrationgraph` | ÏÔʾSpring¼¯³Éͼ¡£ ÐèÒªÒÀÀµ `spring-integration-core`¡£ | -| `loggers` | ÏÔʾºÍÐÞ¸ÄÓ¦ÓóÌÐòÖÐloggerµÄÅäÖᣠ| -| `liquibase` | ÏÔʾÈκÎÒѾ­Ó¦ÓõÄLiquibaseÊý¾Ý¿âÇ¨ÒÆ¡£ ÐèÒªÒ»¸ö»ò¶à¸ö `Liquibase` Bean¡£ | -| `metrics` | ÏÔʾµ±Ç°Ó¦ÓóÌÐòµÄ ¡°metrics¡± ÐÅÏ¢¡£ | -| `mappings` | ÏÔʾËùÓÐ `@RequestMapping` ·¾¶µÄÕûÀíÁÐ±í¡£ | -| `quartz` | ÏÔʾÓйØQuartz Scheduler JobµÄÐÅÏ¢¡£ | -| `scheduledtasks` | ÏÔʾÄãµÄÓ¦ÓóÌÐòÖеļƻ®ÈÎÎñ¡£ | -| `sessions` | ÔÊÐí´ÓSpring SessionÖ§³ÖµÄ»á»°´æ´¢ÖмìË÷ºÍɾ³ýÓû§»á»°¡£ ÐèÒªÒ»¸öʹÓÃSpring SessionµÄ»ùÓÚServletµÄWebÓ¦ÓóÌÐò¡£ | -| `shutdown` | ÈÃÓ¦ÓóÌÐòÓÅÑŵعرա£Ö»ÔÚʹÓÃjar´ò°üʱÓÐЧ¡£Ä¬ÈÏÇé¿öÏÂÊǽûÓõġ£ | -| `startup` | ÏÔʾÓÉ `ApplicationStartup` ÊÕ¼¯µÄ[Æô¶¯²½ÖèÊý¾Ý](https://springdoc.cn/spring-boot/features.html#features.spring-application.startup-tracking)¡£ÒªÇó `SpringApplication` ±»ÅäÖÃΪ `BufferingApplicationStartup`¡£ | +| `auditevents` | 公开当å‰�应用程åº�的审计事件信æ�¯ã€‚ 需è¦�一个 `AuditEventRepository` bean。 | +| `beans` | 显示你的应用程åº�中所有Spring Bean的完整列表。 | +| `caches` | 显示å�¯ç”¨çš„缓存。 | +| `conditions` | 显示对é…�置和自动é…�置类进行评估的æ�¡ä»¶ï¼Œä»¥å�Šå®ƒä»¬ç¬¦å�ˆæˆ–ä¸�符å�ˆçš„原因。 | +| `configprops` | 显示所有 `@ConfigurationProperties` 的整ç�†åˆ—表。 | +| `env` | 暴露Springçš„ `ConfigurableEnvironment` 中的属性。 | +| `flyway` | 显示任何已ç»�应用的Flywayæ•°æ�®åº“è¿�移。 需è¦�一个或多个 `Flyway` bean。 | +| `health` | 显示应用程åº�çš„å�¥åº·ä¿¡æ�¯ã€‚ | +| `httpexchanges` | 显示 HTTP exchange ä¿¡æ�¯ï¼ˆé»˜è®¤æƒ…况下,最å�Ž 100 个 HTTP request/response exchange)。 需è¦�一个 `HttpExchangeRepository` bean。 | +| `info` | 显示任æ„�的应用程åº�ä¿¡æ�¯ã€‚ | +| `integrationgraph` | 显示Spring集æˆ�图。 需è¦�ä¾�èµ– `spring-integration-core`。 | +| `loggers` | 显示和修改应用程åº�中loggerçš„é…�置。 | +| `liquibase` | 显示任何已ç»�应用的Liquibaseæ•°æ�®åº“è¿�移。 需è¦�一个或多个 `Liquibase` Bean。 | +| `metrics` | 显示当å‰�应用程åº�çš„ “metricsâ€� ä¿¡æ�¯ã€‚ | +| `mappings` | 显示所有 `@RequestMapping` 路径的整ç�†åˆ—表。 | +| `quartz` | 显示有关Quartz Scheduler Job的信æ�¯ã€‚ | +| `scheduledtasks` | 显示你的应用程åº�中的计划任务。 | +| `sessions` | å…�许从Spring Session支æŒ�的会è¯�存储中检索和删除用户会è¯�。 需è¦�一个使用Spring Session的基于Servletçš„Web应用程åº�。 | +| `shutdown` | 让应用程åº�优雅地关闭。å�ªåœ¨ä½¿ç”¨jar打包时有效。默认情况下是ç¦�用的。 | +| `startup` | 显示由 `ApplicationStartup` 收集的[å�¯åŠ¨æ­¥éª¤æ•°æ�®](https://springdoc.cn/spring-boot/features.html#features.spring-application.startup-tracking)。è¦�求 `SpringApplication` 被é…�置为 `BufferingApplicationStartup`。 | | `threaddump` | Performs a thread dump. | -Èç¹ûÄãµÄÓ¦ÓóÌÐòÊÇÒ»¸öWebÓ¦ÓóÌÐò£¨Spring MVC¡¢Spring WebFlux»òJersey£©£¬Äã¿ÉÒÔʹÓÃÒÔ϶îÍâµÄ¶Ëµã¡£ +如果你的应用程åº�是一个Web应用程åº�(Spring MVCã€�Spring WebFlux或Jersey),你å�¯ä»¥ä½¿ç”¨ä»¥ä¸‹é¢�外的端点。 -| ID | ˵Ã÷ | +| ID | 说明 | | --- | --- | -| `heapdump` | ·µ»ØÒ»¸ö¶ÑdumpÎļþ¡£ ÔÚHotSpot JVMÉÏ£¬·µ»ØÒ»¸ö `HPROF` ¸ñʽµÄÎļþ¡£ ÔÚOpenJ9 JVMÉÏ£¬·µ»ØÒ»¸ö `PHD` ¸ñʽµÄÎļþ¡£ | -| `logfile` | ·µ»ØÈÕÖ¾ÎļþµÄÄÚÈÝ£¨Èç¹û `logging.file.name` »ò `logging.file.path` ÊôÐÔÒѱ»ÉèÖã©¡£ Ö§³ÖʹÓÃHTTP `Range` Í·À´¼ìË÷ÈÕÖ¾ÎļþµÄ²¿·ÖÄÚÈÝ¡£ | -| `prometheus` | ÒԿɱ» Prometheus ·þÎñÆ÷ץȡµÄ¸ñʽչʾ¶ÈÁ¿£¨metric£©¡£ ÒÀÀµÓÚ `micrometer-registry-prometheus`¡£ | +| `heapdump` | 返回一个堆dump文件。 在HotSpot JVM上,返回一个 `HPROF` æ ¼å¼�的文件。 在OpenJ9 JVM上,返回一个 `PHD` æ ¼å¼�的文件。 | +| `logfile` | 返回日志文件的内容(如果 `logging.file.name` 或 `logging.file.path` 属性已被设置)。 支æŒ�使用HTTP `Range` 头æ�¥æ£€ç´¢æ—¥å¿—文件的部分内容。 | +| `prometheus` | 以å�¯è¢« Prometheus æœ�务器抓å�–的格å¼�展示度é‡�(metric)。 ä¾�赖于 `micrometer-registry-prometheus`。 | -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.enabling)2.1\. ÆôÓö˵ã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.enabling)2.1\. å�¯ç”¨ç«¯ç‚¹ -ĬÈÏÇé¿öÏ£¬³ý `shutdown` ÍâµÄËùÓж˵㶼±»ÆôÓᣠҪÅäÖÃÒ»¸ö¶ËµãµÄÆôÓã¬ÇëʹÓÃÆä `management.endpoint..enabled` ÊôÐÔ¡£ ÏÂÃæµÄÀý×ÓÆôÓÃÁË `shutdown` ¶Ëµã¡£ +默认情况下,除 `shutdown` 外的所有端点都被å�¯ç”¨ã€‚ è¦�é…�置一个端点的å�¯ç”¨ï¼Œè¯·ä½¿ç”¨å…¶ `management.endpoint..enabled` 属性。 下é�¢çš„例å­�å�¯ç”¨äº† `shutdown` 端点。 @@ -222,7 +222,7 @@ management.endpoint.shutdown.enabled=true -Èç¹ûÄãÏ£Íû¶ËµãÆôÓÃÊÇ¡°Ñ¡ÔñÆôÓá±¶ø²»ÊÇ¡°Ñ¡Ôñ½ûÓá±£¬Ç뽫 `management.endpoints.enabled-by-default` ÊôÐÔÉèÖÃΪ `false`£¬²¢Ê¹Óõ¥¸ö¶ËµãµÄ `enabled` ÊôÐÔÀ´Ñ¡ÔñÖØÐÂÆôÓᣠÏÂÃæµÄÀý×ÓÆôÓÃÁË `info` ¶Ëµã£¬²¢½ûÓÃÁËËùÓÐÆäËû¶Ëµã¡£ +如果你希望端点å�¯ç”¨æ˜¯â€œé€‰æ‹©å�¯ç”¨â€�而ä¸�是“选择ç¦�用â€�,请将 `management.endpoints.enabled-by-default` 属性设置为 `false`,并使用å�•个端点的 `enabled` 属性æ�¥é€‰æ‹©é‡�æ–°å�¯ç”¨ã€‚ 下é�¢çš„例å­�å�¯ç”¨äº† `info` 端点,并ç¦�用了所有其他端点。 @@ -250,7 +250,7 @@ management.endpoint.info.enabled=true -| | ±»½ûÓõĶ˵ã»á´ÓÓ¦ÓóÌÐòÉÏÏÂÎÄÖÐÍêȫɾ³ý¡£Èç¹ûÄãÏëÖ»¸Ä±ä±©Â¶¶ËµãµÄ¼¼Êõ£¬ÇëʹÓà [`include` ºÍ `exclude` ÊôÐÔ](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)À´´úÌæ¡£ | +| | 被ç¦�用的端点会从应用程åº�上下文中完全删除。如果你想å�ªæ”¹å�˜æš´éœ²ç«¯ç‚¹çš„æŠ€æœ¯ï¼Œè¯·ä½¿ç”¨ [`include` å’Œ `exclude` 属性](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)æ�¥ä»£æ›¿ã€‚ | | --- | --- | @@ -259,22 +259,22 @@ management.endpoint.info.enabled=true -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)2.2\. ±©Â¶¶Ëµã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)2.2\. 暴露端点 -ĬÈÏÇé¿öÏ£¬Ö»ÓÐhealth¶ËµãÊÇͨ¹ýHTTPºÍJMX±©Â¶µÄ¡£ ÓÉÓڶ˵ã¿ÉÄܰüº¬Ãô¸ÐÐÅÏ¢£¬ÄãÓ¦¸Ã×Ðϸ¿¼ÂǺÎʱ±©Â¶ËüÃÇ¡£ +默认情况下,å�ªæœ‰health端点是通过HTTPå’ŒJMX暴露的。 由于端点å�¯èƒ½åŒ…å�«æ•�感信æ�¯ï¼Œä½ åº”该仔细考虑何时暴露它们。 -Òª¸Ä±äÄÄЩ¶Ëµã±»±©Â¶£¬ÇëʹÓÃÒÔÏÂÌØ¶¨¼¼ÊõµÄ `include` ºÍ `exclude` ÊôÐÔ¡£ +è¦�改å�˜å“ªäº›ç«¯ç‚¹è¢«æš´éœ²ï¼Œè¯·ä½¿ç”¨ä»¥ä¸‹ç‰¹å®šæŠ€æœ¯çš„ `include` å’Œ `exclude` 属性。 -| ÊôÐÔ | ĬÈÏ | +| 属性 | 默认 | | --- | --- | | `management.endpoints.jmx.exposure.exclude` | | | `management.endpoints.jmx.exposure.include` | `health` | @@ -283,13 +283,13 @@ management.endpoint.info.enabled=true -`include` ÊôÐÔÁгöÁ˱»±©Â¶µÄ¶ËµãµÄID¡£ `exclude` ÊôÐÔÁгöÁ˲»Ó¦¸Ã±»¹«¿ªµÄ¶ËµãµÄID¡£ `exclude` ÊôÐÔÓÅÏÈÓÚ `include` ÊôÐÔ¡£ Äã¿ÉÒÔÓÃÒ»¸ö¶ËµãIDÁбíÀ´ÅäÖà `include` ºÍ `exclude` ÊôÐÔ¡£ +`include` 属性列出了被暴露的端点的ID。 `exclude` 属性列出了ä¸�应该被公开的端点的ID。 `exclude` 属性优先于 `include` 属性。 ä½ å�¯ä»¥ç”¨ä¸€ä¸ªç«¯ç‚¹ID列表æ�¥é…�ç½® `include` å’Œ `exclude` 属性。 -ÀýÈ磬Ҫͨ¹ýJMXÖ»¹«¿ª `health` ºÍ `info` ¶Ëµã£¬ÇëʹÓÃÒÔÏÂÊôÐÔ¡£ +例如,è¦�通过JMXå�ªå…¬å¼€ `health` å’Œ `info` 端点,请使用以下属性。 @@ -316,7 +316,7 @@ management.endpoints.jmx.exposure.include=health,info -`*` ¿ÉÒÔÓÃÀ´Ñ¡ÔñËùÓж˵㡣 ÀýÈ磬Ҫͨ¹ýHTTP¹«¿ªËùÓеĶ«Î÷£¬³ýÁË `env` ºÍ `beans` ¶Ëµã£¬Ê¹ÓÃÒÔÏÂÊôÐÔ¡£ +`*` å�¯ä»¥ç”¨æ�¥é€‰æ‹©æ‰€æœ‰ç«¯ç‚¹ã€‚ 例如,è¦�通过HTTP公开所有的东西,除了 `env` å’Œ `beans` 端点,使用以下属性。 @@ -344,21 +344,21 @@ management.endpoints.web.exposure.exclude=env,beans -| | `*` ÔÚYAMLÖоßÓÐÌØÊ⺬Ò壬ËùÒÔÈç¹ûÄãÏë°üÀ¨£¨»òÅųý£©ËùÓеĶ˵㣬һ¶¨Òª¼ÓÒýºÅ¡£ | +| | `*` 在YAML中具有特殊å�«ä¹‰ï¼Œæ‰€ä»¥å¦‚果你想包括(或排除)所有的端点,一定è¦�加引å�·ã€‚ | | --- | --- | -| | Èç¹ûÄãµÄÓ¦ÓóÌÐòÊǹ«¿ª±©Â¶µÄ£¬ÎÒÃÇÇ¿ÁÒ½¨ÒéÄãÒ²[±£»¤ÄãµÄ¶Ëµã](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.security)¡£ | +| | 如果你的应用程åº�是公开暴露的,我们强烈建议你也[ä¿�护你的端点](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.security)。 | | --- | --- | -| | Èç¹ûÄãÏëÔڶ˵㱩¶ʱʵʩ×Ô¼ºµÄ²ßÂÔ£¬Äã¿ÉÒÔ×¢²áÒ»¸ö `EndpointFilter` bean¡£ | +| | 如果你想在端点暴露时实施自己的策略,你å�¯ä»¥æ³¨å†Œä¸€ä¸ª `EndpointFilter` bean。 | | --- | --- | @@ -367,36 +367,36 @@ management.endpoints.web.exposure.exclude=env,beans -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.security)2.3\. °²È«£¨Security£© +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.security)2.3\. 安全(Security) -ΪÁ˰²È«Æð¼û£¬Ä¬ÈÏÇé¿öÏÂÖ»ÓÐ `/health` ¶Ëµãͨ¹ýHTTP¹«¿ª¡£ Äã¿ÉÒÔʹÓà `management.endpoints.web.exposure.include` ÊôÐÔÀ´ÅäÖñ»±©Â¶µÄ¶Ëµã¡£ +为了安全起è§�,默认情况下å�ªæœ‰ `/health` 端点通过HTTP公开。 ä½ å�¯ä»¥ä½¿ç”¨ `management.endpoints.web.exposure.include` 属性æ�¥é…�置被暴露的端点。 -| | ÔÚÉèÖà `management.endpoints.web.exposure.include` ֮ǰ£¬ÇëÈ·±£±©Â¶µÄÖ´ÐÐÆ÷²»°üº¬Ãô¸ÐÐÅÏ¢£¬½«ÆäÖÃÓÚ·À»ðǽ֮ºó£¬»òÓÉSpring SecurityÖ®ÀàµÄ¶«Î÷À´±£Ö¤°²È«¡£ | +| | 在设置 `management.endpoints.web.exposure.include` 之å‰�,请确ä¿�暴露的执行器ä¸�包å�«æ•�感信æ�¯ï¼Œå°†å…¶ç½®äºŽé˜²ç�«å¢™ä¹‹å�Žï¼Œæˆ–ç”±Spring Security之类的东西æ�¥ä¿�è¯�安全。 | | --- | --- | -Èç¹ûSpring SecurityÔÚclasspathÉÏ£¬²¢ÇÒûÓÐÆäËû `SecurityFilterChain` bean£¬ÄÇô³ýÁË `/health` Ö®ÍâµÄËùÓÐÖ´ÐÐÆ÷£¨actuator£©¶¼ÓÉSpring Boot×Ô¶¯ÅäÖÃÀ´±£Ö¤°²È«¡£ Èç¹ûÄ㶨ÒåÁËÒ»¸ö×Ô¶¨ÒåµÄ `SecurityFilterChain` bean£¬Spring Boot×Ô¶¯ÅäÖþͻáÍËËõ£¬ÈÃÄãÍêÈ«¿ØÖÆÖ´ÐÐÆ÷µÄ·ÃÎʹæÔò¡£ +如果Spring Security在classpath上,并且没有其他 `SecurityFilterChain` bean,那么除了 `/health` 之外的所有执行器(actuator)都由Spring Boot自动é…�ç½®æ�¥ä¿�è¯�安全。 如果你定义了一个自定义的 `SecurityFilterChain` bean,Spring Boot自动é…�置就会退缩,让你完全控制执行器的访问规则。 -Èç¹ûÄãÏëΪHTTP¶ËµãÅäÖÃ×Ô¶¨Ò尲ȫ£¨ÀýÈ磬ֻÔÊÐí¾ßÓÐijÖÖ½ÇÉ«µÄÓû§·ÃÎÊ£©£¬Spring BootÌṩÁËһЩ·½±ãµÄ `RequestMatcher` ¶ÔÏó£¬Äã¿ÉÒÔÓëSpring Security½áºÏʹÓᣠ+如果你想为HTTP端点é…�置自定义安全(例如,å�ªå…�许具有æŸ�ç§�角色的用户访问),Spring Bootæ��供了一些方便的 `RequestMatcher` 对象,你å�¯ä»¥ä¸ŽSpring Security结å�ˆä½¿ç”¨ã€‚ -Ò»¸öµäÐ͵ÄSpring SecurityÅäÖÿÉÄÜ¿´ÆðÀ´ÏñÏÂÃæµÄÀý×Ó¡£ +一个典型的Spring Securityé…�ç½®å�¯èƒ½çœ‹èµ·æ�¥åƒ�下é�¢çš„例å­�。 @@ -434,13 +434,13 @@ public class MySecurityConfiguration { -Ç°ÃæµÄÀý×ÓʹÓà `EndpointRequest.toAnyEndpoint()` À´Æ¥ÅäÒ»¸öÇëÇóµ½Èκζ˵㣬ȻºóÈ·±£ËùÓеĶ˵㶼ÓÐ `ENDPOINT_ADMIN` µÄ½ÇÉ«¡£ `EndpointRequest` ÉÏ»¹ÓÐÆäËû¼¸¸öÆ¥ÅäÆ÷·½·¨¡£ ÏêÇé¼ûAPIÎĵµ£¨ [HTML](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/htmlsingle) »ò [PDF](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/pdf/spring-boot-actuator-web-api.pdf)£©¡£ +å‰�é�¢çš„例å­�使用 `EndpointRequest.toAnyEndpoint()` æ�¥åŒ¹é…�一个请求到任何端点,然å�Žç¡®ä¿�所有的端点都有 `ENDPOINT_ADMIN` 的角色。 `EndpointRequest` 上还有其他几个匹é…�器方法。 详情è§�API文档( [HTML](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/htmlsingle) 或 [PDF](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/pdf/spring-boot-actuator-web-api.pdf))。 -Èç¹ûÄãÔÚ·À»ðǽºóÃæ²¿ÊðÓ¦ÓóÌÐò£¬Äã¿ÉÄÜÏ£ÍûÄãµÄËùÓÐÖ´ÐÐÆ÷¶Ëµã¶¼Äܱ»·ÃÎÊ£¬¶ø²»ÐèÒªÈÏÖ¤¡£ Äã¿ÉÒÔͨ¹ý¸Ä±ä `management.endpoints.web.exposure.include` ÊôÐÔÀ´×öµ½ÕâÒ»µã£¬ÈçÏÂËùʾ¡£ +如果你在防ç�«å¢™å�Žé�¢éƒ¨ç½²åº”用程åº�,你å�¯èƒ½å¸Œæœ›ä½ çš„æ‰€æœ‰æ‰§è¡Œå™¨ç«¯ç‚¹éƒ½èƒ½è¢«è®¿é—®ï¼Œè€Œä¸�需è¦�认è¯�。 ä½ å�¯ä»¥é€šè¿‡æ”¹å�˜ `management.endpoints.web.exposure.include` 属性æ�¥å�šåˆ°è¿™ä¸€ç‚¹ï¼Œå¦‚下所示。 @@ -467,7 +467,7 @@ management.endpoints.web.exposure.include=* -´ËÍ⣬Èç¹û´æÔÚSpring Security£¬ÄãÐèÒªÌí¼Ó×Ô¶¨Ò尲ȫÅäÖã¬ÔÊÐíδ¾­ÈÏÖ¤µÄ·ÃÎʶ˵㣬ÈçÏÂÀýËùʾ¡£ +此外,如果存在Spring Security,你需è¦�添加自定义安全é…�置,å…�许未ç»�认è¯�的访问端点,如下例所示。 @@ -504,31 +504,31 @@ public class MySecurityConfiguration { -| | ÔÚÇ°ÃæµÄÁ½¸öÀý×ÓÖУ¬ÅäÖÃÖ»ÊÊÓÃÓÚactuator¶Ëµã¡£ ÓÉÓÚSpring BootµÄ°²È«ÅäÖÃÔÚÓÐÈκΠ`SecurityFilterChain` beanµÄÇé¿ö϶¼»áÍêÈ«Í˳ö£¬ËùÒÔÄãÐèÒªÅäÖÃÒ»¸ö¶îÍâµÄ `SecurityFilterChain` bean£¬Æä¹æÔòÊÊÓÃÓÚÓ¦ÓóÌÐòµÄÆäËû²¿·Ö¡£ | +| | 在å‰�é�¢çš„两个例å­�中,é…�ç½®å�ªé€‚用于actuator端点。 由于Spring Boot的安全é…�置在有任何 `SecurityFilterChain` bean的情况下都会完全退出,所以你需è¦�é…�置一个é¢�外的 `SecurityFilterChain` bean,其规则适用于应用程åº�的其他部分。 | | --- | --- | -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.security.csrf)2.3.1\. ¿çÍøÕ¾ÇëÇóαÔì±£»¤£¨CSRF£© +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.security.csrf)2.3.1\. 跨网站请求伪造ä¿�护(CSRF) -ÓÉÓÚSpring BootÒÀÀµSpring SecurityµÄĬÈÏÖµ£¬CSRF±£»¤ÔÚĬÈÏÇé¿öϱ»´ò¿ª¡£ ÕâÒâζ×ÅÔÚʹÓÃĬÈϰ²È«ÅäÖÃʱ£¬ÐèÒª `POST`£¨shutdownºÍloggers¶Ëµã£©¡¢`PUT` »ò `DELETE` µÄactuator¶Ëµã»á³öÏÖ403£¨½ûÖ¹£©µÄ´íÎó¡£ +由于Spring Bootä¾�èµ–Spring Security的默认值,CSRFä¿�护在默认情况下被打开。 è¿™æ„�味ç�€åœ¨ä½¿ç”¨é»˜è®¤å®‰å…¨é…�置时,需è¦� `POST`(shutdownå’Œloggers端点)ã€�`PUT` 或 `DELETE` çš„actuator端点会出现403(ç¦�止)的错误。 -| | ÎÒÃǽ¨ÒéÖ»ÓÐÔÚÄã´´½¨µÄ·þÎñ±»·Çä¯ÀÀÆ÷¿Í»§¶ËʹÓÃʱ²ÅÍêÈ«½ûÓÃCSRF±£»¤¡£ | +| | 我们建议å�ªæœ‰åœ¨ä½ åˆ›å»ºçš„æœ�务被é�žæµ�览器客户端使用时æ‰�完全ç¦�用CSRFä¿�护。 | | --- | --- | -Äã¿ÉÒÔÔÚ [Spring°²È«²Î¿¼Ö¸ÄÏ](https://docs.spring.io/spring-security/reference/6.1.0-M1/features/exploits/csrf.html) ÖÐÕÒµ½¹ØÓÚCSRF±£»¤µÄÆäËûÐÅÏ¢¡£ +ä½ å�¯ä»¥åœ¨ [Spring安全å�‚考指å�—](https://docs.spring.io/spring-security/reference/6.1.0-M1/features/exploits/csrf.html) 中找到关于CSRFä¿�护的其他信æ�¯ã€‚ @@ -538,11 +538,11 @@ public class MySecurityConfiguration { -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.caching)2.4\. ÅäÖö˵ã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.caching)2.4\. é…�置端点 -¶Ëµã»á×Ô¶¯»º´æ²»ÐèÒªÈκβÎÊýµÄ¶ÁÈ¡²Ù×÷µÄÏìÓ¦¡£ ÒªÅäÖö˵㻺´æÏìÓ¦µÄʱ¼ä£¬ÇëʹÓÃÆä `cache.time-to-live` ÊôÐÔ¡£ ÏÂÃæµÄÀý×Ó½« `beans` ¶ËµãµÄ»º´æÉú´æÊ±¼äÉèÖÃΪ10Ãë¡£ +端点会自动缓存ä¸�需è¦�任何å�‚数的读å�–æ“�作的å“�应。 è¦�é…�置端点缓存å“�应的时间,请使用其 `cache.time-to-live` 属性。 下é�¢çš„例å­�å°† `beans` 端点的缓存生存时间设置为10秒。 @@ -569,7 +569,7 @@ management.endpoint.beans.cache.time-to-live=10s -| | `management.endpoint.` ǰ׺ΨһµØ±êʶÁËÕýÔÚÅäÖõĶ˵㡣 | +| | `management.endpoint.` å‰�缀唯一地标识了正在é…�置的端点。 | | --- | --- | @@ -578,17 +578,17 @@ management.endpoint.beans.cache.time-to-live=10s -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.hypermedia)2.5\. ÓÃÓÚ Actuator Web ¶ËµãµÄ³¬Ã½Ì壨Hypermedia£© +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.hypermedia)2.5\. 用于 Actuator Web 端点的超媒体(Hypermedia) -Ò»¸ö ¡°discovery page¡± ±»Ìí¼Óµ½ËùÓж˵ãµÄÁ´½ÓÖС£ ĬÈÏÇé¿öÏ£¬¡°discovery page¡± ÔÚ `/actuator` ÉÏÊÇ¿ÉÓõġ£ +一个 “discovery pageâ€� 被添加到所有端点的链接中。 默认情况下,“discovery pageâ€� 在 `/actuator` 上是å�¯ç”¨çš„。 -Òª½ûÓà ¡°discovery page¡±£¬ÇëÔÚÄãµÄÓ¦ÓóÌÐòÊôÐÔÖÐÌí¼ÓÒÔÏÂÊôÐÔ¡£ +è¦�ç¦�用 “discovery pageâ€�,请在你的应用程åº�属性中添加以下属性。 @@ -615,7 +615,7 @@ management.endpoints.web.discovery.enabled=false -µ±ÅäÖÃÁËÒ»¸ö×Ô¶¨ÒåµÄ¹ÜÀíÉÏÏÂÎÄ·¾¶Ê±£¬¡°discovery page¡± »á×Ô¶¯´Ó `/actuator` ÒÆµ½¹ÜÀíÉÏÏÂÎĵĸù²¿¡£ ÀýÈ磬Èç¹û¹ÜÀíÉÏÏÂÎÄ·¾¶ÊÇ `/management`£¬discovery page¿ÉÒÔ´Ó `/management` »ñµÃ¡£ µ±¹ÜÀíÉÏÏÂÎÄ·¾¶±»ÉèÖÃΪ `/` ʱ£¬·¢ÏÖÒ³±»½ûÓã¬ÒÔ·ÀÖ¹ÓëÆäËûmapping·¢Éú³åÍ»µÄ¿ÉÄÜÐÔ¡£ +当é…�置了一个自定义的管ç�†ä¸Šä¸‹æ–‡è·¯å¾„时,“discovery pageâ€� 会自动从 `/actuator` 移到管ç�†ä¸Šä¸‹æ–‡çš„æ ¹éƒ¨ã€‚ 例如,如果管ç�†ä¸Šä¸‹æ–‡è·¯å¾„是 `/management`,discovery pageå�¯ä»¥ä»Ž `/management` 获得。 当管ç�†ä¸Šä¸‹æ–‡è·¯å¾„被设置为 `/` 时,å�‘现页被ç¦�用,以防止与其他mappingå�‘生冲çª�çš„å�¯èƒ½æ€§ã€‚ @@ -623,17 +623,17 @@ management.endpoints.web.discovery.enabled=false -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.cors)2.6\. CORSµÄÖ§³Ö +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.cors)2.6\. CORS的支æŒ� -[¿çÔ´×ÊÔ´¹²Ïí](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)£¨CORS£©ÊÇ [W3CµÄÒ»¸ö¹æ·¶](https://www.w3.org/TR/cors/)£¬¿ÉÒÔÈÃÄãÒÔÁé»îµÄ·½Ê½Ö¸¶¨ÄÄÖÖ¿çÓòÇëÇó±»ÊÚȨ¡£Èç¹ûÄãʹÓÃSpring MVC»òSpring WebFlux£¬Äã¿ÉÒÔÅäÖÃActuatorµÄWeb¶ËµãÀ´Ö§³ÖÕâÖÖÇé¿ö¡£ +[è·¨æº�资æº�共享](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)(CORS)是 [W3C的一个规范](https://www.w3.org/TR/cors/),å�¯ä»¥è®©ä½ ä»¥ç�µæ´»çš„æ–¹å¼�指定哪ç§�跨域请求被授æ�ƒã€‚如果你使用Spring MVC或Spring WebFlux,你å�¯ä»¥é…�ç½®Actuatorçš„Web端点æ�¥æ”¯æŒ�è¿™ç§�情况。 -CORSÖ§³ÖÔÚĬÈÏÇé¿öÏÂÊǽûÓõģ¬Ö»ÓÐÔÚÄãÉèÖÃÁË `management.endpoints.web.cors.allowed-origins` ÊôÐÔºó²Å»áÆôÓᣠÏÂÃæµÄÅäÖÃÔÊÐí´Ó `example.com` ÓòÃûÖе÷Óà `GET` ºÍ `POST`¡£ +CORS支æŒ�在默认情况下是ç¦�用的,å�ªæœ‰åœ¨ä½ è®¾ç½®äº† `management.endpoints.web.cors.allowed-origins` 属性å�Žæ‰�会å�¯ç”¨ã€‚ 下é�¢çš„é…�ç½®å…�许从 `example.com` 域å��中调用 `GET` å’Œ `POST`。 @@ -661,7 +661,7 @@ management.endpoints.web.cors.allowed-methods=GET,POST -| | ²Î¼û [`CorsEndpointProperties`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/CorsEndpointProperties.java) ÒÔ»ñµÃÍêÕûµÄÑ¡ÏîÁÐ±í¡£ | +| | å�‚è§� [`CorsEndpointProperties`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/CorsEndpointProperties.java) 以获得完整的选项列表。 | | --- | --- | @@ -670,17 +670,17 @@ management.endpoints.web.cors.allowed-methods=GET,POST -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom)2.7\. ʵÏÖ×Ô¶¨Òå¶Ëµã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom)2.7\. 实现自定义端点 -Èç¹ûÄãÌí¼ÓÁËÒ»¸ö´øÓÐ `@Endpoint` ×¢½âµÄ `@Bean`£¬ÈκδøÓÐ `@ReadOperation`¡¢`@WriteOperation` »ò `@DeleteOperation` ×¢Ê͵ķ½·¨¶¼»á×Ô¶¯Í¨¹ýJMX¹«¿ª£¬ÔÚWebÓ¦ÓóÌÐòÖÐÒ²»áͨ¹ýHTTP¹«¿ª¡£ ͨ¹ýʹÓÃJersey¡¢Spring MVC»òSpring WebFlux£¬¶Ëµã¿ÉÒÔͨ¹ýHTTP±©Â¶¡£ Èç¹ûJerseyºÍSpring MVC¶¼¿ÉÓã¬ÔòʹÓÃSpring MVC¡£ +如果你添加了一个带有 `@Endpoint` 注解的 `@Bean`,任何带有 `@ReadOperation`ã€�`@WriteOperation` 或 `@DeleteOperation` 注释的方法都会自动通过JMX公开,在Web应用程åº�中也会通过HTTP公开。 通过使用Jerseyã€�Spring MVC或Spring WebFlux,端点å�¯ä»¥é€šè¿‡HTTP暴露。 如果Jerseyå’ŒSpring MVC都å�¯ç”¨ï¼Œåˆ™ä½¿ç”¨Spring MVC。 -ÏÂÃæµÄÀý×Ó±©Â¶ÁËÒ»¸ö¶Á²Ù×÷£¬Ëü·µ»ØÒ»¸ö×Ô¶¨Òå¶ÔÏó¡£ +下é�¢çš„例å­�暴露了一个读æ“�作,它返回一个自定义对象。 @@ -710,35 +710,35 @@ public CustomData getData() { -ÄãÒ²¿ÉÒÔͨ¹ýʹÓà `@JmxEndpoint` »ò `@WebEndpoint` À´±àÐ´ÌØ¶¨¼¼ÊõµÄ¶Ëµã¡£ ÕâЩ¶Ëµã±»ÏÞÖÆÔÚËüÃǸ÷×Եļ¼ÊõÉÏ¡£ ÀýÈ磬`@WebEndpoint` ֻͨ¹ýHTTP±©Â¶£¬¶ø²»ÊÇͨ¹ýJMX¡£ +你也å�¯ä»¥é€šè¿‡ä½¿ç”¨ `@JmxEndpoint` 或 `@WebEndpoint` æ�¥ç¼–写特定技术的端点。 这些端点被é™�制在它们å�„自的技术上。 例如,`@WebEndpoint` å�ªé€šè¿‡HTTP暴露,而ä¸�是通过JMX。 -Äã¿ÉÒÔͨ¹ýʹÓà `@EndpointWebExtension` ºÍ `@EndpointJmxExtension` À´±àÐ´ÌØ¶¨µÄ¼¼ÊõÀ©Õ¹¡£ ÕâЩע½âÈÃÄãÌá¹©ÌØ¶¨¼¼ÊõµÄ²Ù×÷£¬ÒÔÔöÇ¿ÏÖÓеĶ˵㡣 +ä½ å�¯ä»¥é€šè¿‡ä½¿ç”¨ `@EndpointWebExtension` å’Œ `@EndpointJmxExtension` æ�¥ç¼–写特定的技术扩展。 这些注解让你æ��供特定技术的æ“�作,以增强现有的端点。 -×îºó£¬Èç¹ûÄãÐèÒª·ÃÎÊWeb¿ò¼ÜµÄÌØ¶¨¹¦ÄÜ£¬Äã¿ÉÒÔʵÏÖservlet»òSpringµÄ `@Controller` ºÍ `@RestController` ¶Ëµã£¬´ú¼ÛÊÇËüÃDz»ÄÜͨ¹ýJMX»òʹÓò»Í¬µÄWeb¿ò¼Üʱ¿ÉÓᣠ+最å�Žï¼Œå¦‚果你需è¦�访问Web框架的特定功能,你å�¯ä»¥å®žçްservlet或Springçš„ `@Controller` å’Œ `@RestController` 端点,代价是它们ä¸�能通过JMX或使用ä¸�å�Œçš„Web框架时å�¯ç”¨ã€‚ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.input)2.7.1\. ½ÓÊÕÊäÈë +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.input)2.7.1\. 接收输入 -¶ËµãÉϵIJÙ×÷ͨ¹ýÆä²ÎÊý½ÓÊÕÊäÈë¡£ µ±Í¨¹ýweb¹«¿ªÊ±£¬ÕâЩ²ÎÊýµÄÖµÀ´×ÔURLµÄ²éѯ²ÎÊýºÍJSONÇëÇóÌå¡£ µ±Í¨¹ýJMX¹«¿ªÊ±£¬²ÎÊý±»Ó³Éäµ½MBean²Ù×÷µÄ²ÎÊýÖС£ ĬÈÏÇé¿öÏ£¬²ÎÊýÊDZØÐèµÄ¡£ ËüÃÇ¿ÉÒÔͨ¹ýʹÓà `@javax.annotation.Nullable` »ò `@org.springframework.lang.Nullable` ½øÐÐ×¢½â¶ø³ÉΪ¿ÉÑ¡Ïî¡£ +端点上的æ“�作通过其å�‚数接收输入。 当通过web公开时,这些å�‚数的值æ�¥è‡ªURL的查询å�‚æ•°å’ŒJSON请求体。 当通过JMX公开时,å�‚数被映射到MBeanæ“�作的å�‚数中。 默认情况下,å�‚数是必需的。 它们å�¯ä»¥é€šè¿‡ä½¿ç”¨ `@javax.annotation.Nullable` 或 `@org.springframework.lang.Nullable` 进行注解而æˆ�为å�¯é€‰é¡¹ã€‚ -Äã¿ÉÒÔ½«JSONÇëÇóÌåÖеÄÿ¸ö¸ùÊôÐÔÓ³Éäµ½¶ËµãµÄÒ»¸ö²ÎÊý¡£ ¿¼ÂÇÒ»ÏÂÏÂÃæµÄJSONÇëÇóÌå¡£ +ä½ å�¯ä»¥å°†JSON请求体中的æ¯�个根属性映射到端点的一个å�‚数。 考虑一下下é�¢çš„JSON请求体。 @@ -759,7 +759,7 @@ public CustomData getData() { -Äã¿ÉÒÔÓÃËüÀ´µ÷ÓÃÒ»¸öд²Ù×÷£¬¸Ã²Ù×÷ÐèÒª `String name` ºÍ `int counter` ²ÎÊý£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +ä½ å�¯ä»¥ç”¨å®ƒæ�¥è°ƒç”¨ä¸€ä¸ªå†™æ“�作,该æ“�作需è¦� `String name` å’Œ `int counter` å�‚数,如下é�¢çš„例å­�所示。 @@ -789,25 +789,25 @@ public void updateData(String name, int counter) { -| | ÒòΪ¶ËµãÊǼ¼Êõ²»¿ÉÖªµÄ£¬ÔÚ·½·¨Ç©ÃûÖÐÖ»ÄÜÖ¸¶¨¼òµ¥µÄÀàÐÍ¡£ ÌØ±ðÊÇ£¬²»Ö§³ÖÓà `CustomData` ÀàÐÍÉùÃ÷Ò»¸ö¶¨ÒåÁË `name` ºÍ `counter` ÊôÐԵĵ¥Ò»²ÎÊý¡£ | +| | 因为端点是技术ä¸�å�¯çŸ¥çš„,在方法签å��中å�ªèƒ½æŒ‡å®šç®€å�•的类型。 特别是,ä¸�支æŒ�用 `CustomData` 类型声明一个定义了 `name` å’Œ `counter` 属性的å�•一å�‚数。 | | --- | --- | -| | ΪÁËÈÃÊäÈëÓ³Éäµ½²Ù×÷·½·¨µÄ²ÎÊý£¬ÊµÏֶ˵ãµÄJava´úÂëÓ¦¸ÃÓà `-parameters` ±àÒ룬¶øÊµÏֶ˵ãµÄKotlin´úÂëÓ¦¸ÃÓà `-java-parameters` ±àÒë¡£ Èç¹ûÄãʹÓÃSpring BootµÄGradle²å¼þ»òʹÓÃMavenºÍ `spring-boot-starter-parent`£¬Õ⽫×Ô¶¯·¢Éú¡£ | +| | 为了让输入映射到æ“�作方法的å�‚数,实现端点的Java代ç �应该用 `-parameters` 编译,而实现端点的Kotlin代ç �应该用 `-java-parameters` 编译。 如果你使用Spring Bootçš„Gradleæ�’件或使用Mavenå’Œ `spring-boot-starter-parent`,这将自动å�‘生。 | | --- | --- | -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.input.conversion)ÊäÈëÀàÐÍת»» +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.input.conversion)输入类型转æ�¢ -Èç¹ûÓбØÒª£¬´«µÝ¸ø¶Ëµã²Ù×÷·½·¨µÄ²ÎÊý»á×Ô¶¯×ª»»ÎªËùÐèÀàÐÍ¡£ ÔÚµ÷ÓòÙ×÷·½·¨Ö®Ç°£¬Í¨¹ýJMX»òHTTPÊÕµ½µÄÊäÈ뱻ת»»ÎªËùÐèµÄÀàÐÍ£¬·½·¨ÊÇʹÓà `ApplicationConversionService` µÄʵÀýÒÔ¼°ÈκΠ`Converter` »ò `GenericConverter` Bean£¬²¢ÒÔ `@EndpointConverter` ÏÞ¶¨¡£ +如果有必è¦�,传递给端点æ“�作方法的å�‚数会自动转æ�¢ä¸ºæ‰€éœ€ç±»åž‹ã€‚ 在调用æ“�作方法之å‰�,通过JMX或HTTP收到的输入被转æ�¢ä¸ºæ‰€éœ€çš„类型,方法是使用 `ApplicationConversionService` 的实例以å�Šä»»ä½• `Converter` 或 `GenericConverter` Bean,并以 `@EndpointConverter` é™�定。 @@ -817,21 +817,21 @@ public void updateData(String name, int counter) { -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web)2.7.2\. ×Ô¶¨ÒåWEB¶Ëµã +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web)2.7.2\. 自定义WEB端点 -¶Ô `@Endpoint`¡¢`@WebEndpoint` »ò `@EndpointWebExtension` ²Ù×÷»á×Ô¶¯Ê¹ÓÃJersey¡¢Spring MVC»òSpring WebFluxͨ¹ýHTTP¹«¿ª¡£ Èç¹ûJerseyºÍSpring MVC¶¼¿ÉÓã¬ÔòʹÓÃSpring MVC¡£ +对 `@Endpoint`ã€�`@WebEndpoint` 或 `@EndpointWebExtension` æ“�作会自动使用Jerseyã€�Spring MVC或Spring WebFlux通过HTTP公开。 如果Jerseyå’ŒSpring MVC都å�¯ç”¨ï¼Œåˆ™ä½¿ç”¨Spring MVC。 -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.request-predicates)WEB¶ËµãÇëÇóν´Ê£¨Predicates£© +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.request-predicates)WEB端点请求谓è¯�(Predicates) -Ò»¸öÇëÇóν´Ê»áΪweb±©Â¶µÄ¶ËµãÉϵÄÿ¸ö²Ù×÷£¨operation£©×Ô¶¯Éú³É¡£ +一个请求谓è¯�会为web暴露的端点上的æ¯�个æ“�作(operation)自动生æˆ�。 @@ -843,13 +843,13 @@ public void updateData(String name, int counter) { -pathν´ÊÓɶ˵ãµÄIDºÍÍøÂ籩¶µÄ¶ËµãµÄ»ù±¾Â·¾¶¾ö¶¨¡£ ĬÈϵĻù±¾Â·¾¶ÊÇ `/actuator`¡£ ÀýÈ磬һ¸öIDΪ `sessions` µÄ¶ËµãÔÚν´ÊÖÐʹÓà `/actuator/sessions` ×÷ΪÆä·¾¶¡£ +pathè°“è¯�由端点的ID和网络暴露的端点的基本路径决定。 默认的基本路径是 `/actuator`。 例如,一个ID为 `sessions` 的端点在谓è¯�中使用 `/actuator/sessions` 作为其路径。 -Äã¿ÉÒÔͨ¹ýÓà `@Selector` ×¢½â²Ù×÷·½·¨µÄÒ»¸ö»ò¶à¸ö²ÎÊýÀ´½øÒ»²½¶¨ÖÆÂ·¾¶¡£ ÕâÑùµÄ²ÎÊý»á×÷Ϊһ¸ö·¾¶±äÁ¿Ìí¼Óµ½Â·¾¶Î½´ÊÖС£ ÔÚµ÷Óö˵ã²Ù×÷ʱ£¬¸Ã±äÁ¿µÄÖµ»á±»´«Èë²Ù×÷·½·¨¡£ Èç¹ûÄãÏë²¶»ñËùÓÐÊ£ÓàµÄ·¾¶ÔªËØ£¬Äã¿ÉÒÔÔÚ×îºóÒ»¸ö²ÎÊýÉÏÌí¼Ó `@Selector(Match=ALL_REMAINING)`£¬²¢Ê¹Æä³ÉΪһ¸öÓë `String[]` ת»»¼æÈݵÄÀàÐÍ¡£ +ä½ å�¯ä»¥é€šè¿‡ç”¨ `@Selector` 注解æ“�作方法的一个或多个å�‚æ•°æ�¥è¿›ä¸€æ­¥å®šåˆ¶è·¯å¾„。 这样的å�‚数会作为一个路径å�˜é‡�添加到路径谓è¯�中。 在调用端点æ“�作时,该å�˜é‡�的值会被传入æ“�作方法。 如果你想æ�•获所有剩余的路径元素,你å�¯ä»¥åœ¨æœ€å�Žä¸€ä¸ªå�‚数上添加 `@Selector(Match=ALL_REMAINING)`,并使其æˆ�为一个与 `String[]` 转æ�¢å…¼å®¹çš„类型。 @@ -857,11 +857,11 @@ pathν -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.method-predicates)HTTP method£¨·½·¨£© +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.method-predicates)HTTP method(方法) -HTTP methodν´ÊÊÇÓɲÙ×÷ÀàÐ;ö¶¨µÄ£¬ÈçϱíËùʾ¡£ +HTTP methodè°“è¯�是由æ“�作类型决定的,如下表所示。 @@ -880,7 +880,7 @@ HTTP methodν -¶ÔÓÚʹÓÃrequest bodyµÄ `@WriteOperation`£¨HTTP `POST`£©£¬Î½´ÊµÄ `consumes` ×Ó¾äÊÇ `application/vnd.spring-boot.actuator.v2+json, application/json`¡£ ¶ÔÓÚËùÓÐÆäËû²Ù×÷£¬`consumes` ×Ó¾äÊǿյġ£ +对于使用request bodyçš„ `@WriteOperation`(HTTP `POST`),谓è¯�çš„ `consumes` å­�å�¥æ˜¯ `application/vnd.spring-boot.actuator.v2+json, application/json`。 对于所有其他æ“�作,`consumes` å­�å�¥æ˜¯ç©ºçš„。 @@ -892,13 +892,13 @@ HTTP methodν -ν´ÊµÄ `produces` ×Ó¾ä¿ÉÒÔÓÉ `@DeleteOperation`¡¢`@ReadOperation` ºÍ `@WriteOperation` ×¢Ê굀 `produces` ÊôÐÔ¾ö¶¨¡£ ¸ÃÊôÐÔÊÇ¿ÉÑ¡µÄ¡£ Èç¹û²»Ê¹ÓÃËü£¬`produces` ×Ó¾ä»á×Ô¶¯È·¶¨¡£ +è°“è¯�çš„ `produces` å­�å�¥å�¯ä»¥ç”± `@DeleteOperation`ã€�`@ReadOperation` å’Œ `@WriteOperation` 注释的 `produces` 属性决定。 该属性是å�¯é€‰çš„。 如果ä¸�使用它,`produces` å­�å�¥ä¼šè‡ªåŠ¨ç¡®å®šã€‚ -Èç¹û²Ù×÷·½·¨·µ»Ø `void` »ò `Void`£¬Ôò `produces` ×Ó¾äΪ¿Õ¡£ Èç¹û²Ù×÷·½·¨·µ»Ø `org.springframework.core.io.Resource`£¬`produces` ×Ó¾äÊÇ `application/octet-stream`¡£ ¶ÔÓÚËùÓÐÆäËû²Ù×÷£¬`produces` ×Ó¾äÊÇ `application/vnd.spring-boot.actuator.v2+json, application/json`¡£ +如果æ“�作方法返回 `void` 或 `Void`,则 `produces` å­�å�¥ä¸ºç©ºã€‚ 如果æ“�作方法返回 `org.springframework.core.io.Resource`,`produces` å­�å�¥æ˜¯ `application/octet-stream`。 对于所有其他æ“�作,`produces` å­�å�¥æ˜¯ `application/vnd.spring-boot.actuator.v2+json, application/json`。 @@ -906,29 +906,29 @@ HTTP methodν -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.response-status)WEB¶ËµãÏìӦ״̬ +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.response-status)WEB端点å“�应状æ€� -¶Ëµã²Ù×÷µÄĬÈÏÏìӦ״̬ȡ¾öÓÚ²Ù×÷ÀàÐÍ£¨¶Á¡¢Ð´»òɾ³ý£©ºÍ²Ù×÷·µ»ØµÄÄÚÈÝ£¨Èç¹ûÓеϰ£©¡£ +端点æ“�作的默认å“�应状æ€�å�–决于æ“�作类型(读ã€�写或删除)和æ“�作返回的内容(如果有的è¯�)。 -Èç¹û `@ReadOperation` ·µ»ØÒ»¸öÖµ£¬ÏìӦ״̬½«ÊÇ200(Ok)¡£ Èç¹ûËüûÓзµ»ØÒ»¸öÖµ£¬ÏìӦ״̬½«ÊÇ404(Not Found)¡£ +如果 `@ReadOperation` 返回一个值,å“�应状æ€�将是200(Ok)。 如果它没有返回一个值,å“�应状æ€�将是404(Not Found)。 -Èç¹û `@WriteOperation` »ò `@DeleteOperation` ·µ»ØÒ»¸öÖµ£¬ÏìӦ״̬½«ÊÇ200£¨OK£©¡£ Èç¹ûËüûÓзµ»ØÒ»¸öÖµ£¬ÏìӦ״̬½«ÊÇ204£¨No Content£©¡£ +如果 `@WriteOperation` 或 `@DeleteOperation` 返回一个值,å“�应状æ€�将是200(OK)。 如果它没有返回一个值,å“�应状æ€�将是204(No Content)。 -Èç¹ûÒ»¸ö²Ù×÷ÔÚµ÷ÓÃʱûÓÐËùÐèµÄ²ÎÊý£¬»òÕß²ÎÊý²»Äܱ»×ª»»ÎªËùÐèµÄÀàÐÍ£¬²Ù×÷·½·¨¾Í²»»á±»µ÷Óã¬ÏìӦ״̬½«ÊÇ400£¨Bad Request£©¡£ +如果一个æ“�作在调用时没有所需的å�‚数,或者å�‚æ•°ä¸�能被转æ�¢ä¸ºæ‰€éœ€çš„类型,æ“�作方法就ä¸�会被调用,å“�应状æ€�将是400(Bad Request)。 @@ -936,17 +936,17 @@ HTTP methodν -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.range-requests)WEB¶Ëµã Range ÇëÇó +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.range-requests)WEB端点 Range 请求 -Äã¿ÉÒÔʹÓÃHTTP rangeÇëÇóÀ´ÇëÇóÒ»¸öHTTP×ÊÔ´µÄÒ»²¿·Ö¡£ µ±Ê¹ÓÃSpring MVC»òSpring Web Fluxʱ£¬·µ»Ø `org.springframework.core.io.Resource` µÄ²Ù×÷×Ô¶¯Ö§³Ö·¶Î§ÇëÇó¡£ +ä½ å�¯ä»¥ä½¿ç”¨HTTP range请求æ�¥è¯·æ±‚一个HTTP资æº�的一部分。 当使用Spring MVC或Spring Web Flux时,返回 `org.springframework.core.io.Resource` çš„æ“�作自动支æŒ�范围请求。 -| | ʹÓÃJerseyʱ²»Ö§³Ö Range ÇëÇó¡£ | +| | 使用Jerseyæ—¶ä¸�支æŒ� Range 请求。 | | --- | --- | @@ -955,11 +955,11 @@ HTTP methodν -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.security)Web¶ËµãµÄ°²È« +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.web.security)Web端点的安全 -ÔÚweb¶Ëµã»òwebÌØ¶¨¶ËµãÀ©Õ¹ÉϵIJÙ×÷¿ÉÒÔ½ÓÊÕµ±Ç°µÄ `java.security.Principal` »ò `org.springframework.boot.actuate.endpoint.SecurityContext` ×÷Ϊ·½·¨²ÎÊý¡£ ǰÕßͨ³£Óë `@Nullable` Ò»ÆðʹÓã¬ÎªÒÑÈÏÖ¤ºÍδÈÏÖ¤µÄÓû§Ìṩ²»Í¬µÄÐÐΪ¡£ ºóÕßͨ³£ÓÃÓÚͨ¹ýʹÓÃÆä `isUserInRole(String)` ·½·¨À´Ö´ÐÐÊÚȨ¼ì²é¡£ +在web端点或web特定端点扩展上的æ“�作å�¯ä»¥æŽ¥æ”¶å½“å‰�çš„ `java.security.Principal` 或 `org.springframework.boot.actuate.endpoint.SecurityContext` 作为方法å�‚数。 å‰�者通常与 `@Nullable` 一起使用,为已认è¯�和未认è¯�的用户æ��ä¾›ä¸�å�Œçš„行为。 å�Žè€…通常用于通过使用其 `isUserInRole(String)` 方法æ�¥æ‰§è¡ŒæŽˆæ�ƒæ£€æŸ¥ã€‚ @@ -969,11 +969,11 @@ HTTP methodν -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.servlet)2.7.3\. Servlet ¶Ëµã +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.servlet)2.7.3\. Servlet 端点 -Ò»¸öServlet¿ÉÒÔ×÷Ϊһ¸ö¶Ëµã±©Â¶³öÀ´£¬·½·¨ÊÇʵÏÖÒ»¸öÓà `@ServletEndpoint` ×¢½âµÄÀ࣬ͬʱʵÏÖ `Supplier`¡£ Servlet¶ËµãÌṩÁËÓëservletÈÝÆ÷µÄ¸üÉî²ã´ÎµÄÕûºÏ£¬µ«È´ÎþÉüÁË¿ÉÒÆÖ²ÐÔ¡£ ËüÃǵÄÄ¿µÄÊÇÓÃÀ´½«ÏÖÓеÄServlet×÷Ϊһ¸ö¶ËµãÀ´¹«¿ª¡£ ¶ÔÓÚеĶ˵㣬Ӧ¾¡¿ÉÄÜÑ¡Ôñ `@Endpoint` ºÍ `@WebEndpoint` ×¢½â¡£ +一个Servletå�¯ä»¥ä½œä¸ºä¸€ä¸ªç«¯ç‚¹æš´éœ²å‡ºæ�¥ï¼Œæ–¹æ³•是实现一个用 `@ServletEndpoint` 注解的类,å�Œæ—¶å®žçް `Supplier`。 Servlet端点æ��供了与servlet容器的更深层次的整å�ˆï¼Œä½†å�´ç‰ºç‰²äº†å�¯ç§»æ¤�性。 它们的目的是用æ�¥å°†çŽ°æœ‰çš„Servlet作为一个端点æ�¥å…¬å¼€ã€‚ 对于新的端点,应尽å�¯èƒ½é€‰æ‹© `@Endpoint` å’Œ `@WebEndpoint` 注解。 @@ -981,11 +981,11 @@ HTTP methodν -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.controller)2.7.4\. Controller ¶Ëµã +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.implementing-custom.controller)2.7.4\. Controller 端点 -Äã¿ÉÒÔʹÓà `@ControllerEndpoint` ºÍ `@RestControllerEndpoint` À´ÊµÏÖÒ»¸ö½öÓÉSpring MVC»òSpring WebFlux¹«¿ªµÄ¶Ëµã¡£ ·½·¨Í¨¹ýʹÓÃSpring MVCºÍSpring WebFluxµÄ±ê×¼×¢½â½øÐÐÓ³É䣬Èç `@RequestMapping` ºÍ `@GetMapping`£¬¶ËµãµÄID±»ÓÃ×÷·¾¶µÄǰ׺¡£ ¿ØÖÆÆ÷¶ËµãÌṩÁËÓëSpringµÄWeb¿ò¼Ü¸üÉîÈëµÄ¼¯³É£¬µ«È´ÎþÉüÁË¿ÉÒÆÖ²ÐÔ¡£ Ó¦¾¡¿ÉÄÜÑ¡Ôñ `@Endpoint` ºÍ `@WebEndpoint` ×¢½â¡£ +ä½ å�¯ä»¥ä½¿ç”¨ `@ControllerEndpoint` å’Œ `@RestControllerEndpoint` æ�¥å®žçŽ°ä¸€ä¸ªä»…ç”±Spring MVC或Spring WebFlux公开的端点。 方法通过使用Spring MVCå’ŒSpring WebFlux的标准注解进行映射,如 `@RequestMapping` å’Œ `@GetMapping`,端点的ID被用作路径的å‰�缀。 控制器端点æ��供了与Springçš„Web框架更深入的集æˆ�,但å�´ç‰ºç‰²äº†å�¯ç§»æ¤�性。 应尽å�¯èƒ½é€‰æ‹© `@Endpoint` å’Œ `@WebEndpoint` 注解。 @@ -995,116 +995,116 @@ HTTP methodν -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health)2.8\. ½¡¿µÐÅÏ¢ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health)2.8\. å�¥åº·ä¿¡æ�¯ -Äã¿ÉÒÔʹÓý¡¿µÐÅÏ¢À´¼ì²éÄãÔËÐеÄÓ¦ÓóÌÐòµÄ״̬¡£ Ëü¾­³£±»¼à¿ØÈí¼þÓÃÀ´ÔÚÉú²úϵͳ·¢Éú¹ÊÕÏʱÌáÐѱðÈË¡£ `health` ¶Ëµã±©Â¶µÄÐÅϢȡ¾öÓÚ `management.endpoint.health.show-details` ºÍ `management.endpoint.health.show-components` ÊôÐÔ£¬ËüÃÇ¿ÉÒÔÅäÖÃΪÒÔÏÂÖµÖ®Ò»¡£ +ä½ å�¯ä»¥ä½¿ç”¨å�¥åº·ä¿¡æ�¯æ�¥æ£€æŸ¥ä½ è¿�行的应用程åº�的状æ€�。 它ç»�常被监控软件用æ�¥åœ¨ç”Ÿäº§ç³»ç»Ÿå�‘生故障时æ��醒别人。 `health` 端点暴露的信æ�¯å�–决于 `management.endpoint.health.show-details` å’Œ `management.endpoint.health.show-components` 属性,它们å�¯ä»¥é…�置为以下值之一。 -| Öµ | ˵Ã÷ | +| 值 | 说明 | | --- | --- | -| `never` | ϸ½Ú´Ó²»ÏÔʾ¡£ | -| `when-authorized` | ϸ½ÚÖ»ÏÔʾ¸øÊÚȨÓû§¡£ ÊÚȨµÄ½ÇÉ«¿ÉÒÔͨ¹ýʹÓà `management.endpoint.health.roles` ½øÐÐÅäÖᣠ| -| `always` | ÏêÇéÏÔʾ¸øËùÓÐÓû§¡£ | +| `never` | 细节从ä¸�显示。 | +| `when-authorized` | 细节å�ªæ˜¾ç¤ºç»™æŽˆæ�ƒç”¨æˆ·ã€‚ 授æ�ƒçš„角色å�¯ä»¥é€šè¿‡ä½¿ç”¨ `management.endpoint.health.roles` 进行é…�置。 | +| `always` | 详情显示给所有用户。 | -ĬÈÏÖµÊÇ `never`¡£ µ±Óû§´¦Óڶ˵ãµÄÒ»¸ö»ò¶à¸ö½ÇÉ«ÖÐʱ£¬ËûÃDZ»ÈÏΪÊDZ»ÊÚȨµÄ¡£ Èç¹û¶ËµãûÓÐÅäÖýÇÉ«£¨Ä¬ÈÏÖµ£©£¬ËùÓÐÈÏÖ¤µÄÓû§¶¼±»ÈÏΪÊÇÊÚȨµÄ¡£ Äã¿ÉÒÔͨ¹ýʹÓà `management.endpoint.health.roles` ÊôÐÔÀ´ÅäÖýÇÉ«¡£ +默认值是 `never`。 当用户处于端点的一个或多个角色中时,他们被认为是被授æ�ƒçš„。 如果端点没有é…�置角色(默认值),所有认è¯�的用户都被认为是授æ�ƒçš„。 ä½ å�¯ä»¥é€šè¿‡ä½¿ç”¨ `management.endpoint.health.roles` 属性æ�¥é…�置角色。 -| | Èç¹ûÄãÒѾ­±£»¤ÁËÄãµÄÓ¦ÓóÌÐò²¢Ï£ÍûʹÓà `always`£¬ÄãµÄ°²È«ÅäÖã¨security configuration£©±ØÐëÔÊÐíÈÏÖ¤ºÍ·ÇÈÏÖ¤Óû§·ÃÎÊhealth¶Ëµã¡£ | +| | 如果你已ç»�ä¿�护了你的应用程åº�并希望使用 `always`,你的安全é…�置(security configuration)必须å…�许认è¯�å’Œé�žè®¤è¯�用户访问health端点。 | | --- | --- | -½¡¿µÐÅÏ¢ÊÇ´Ó [`HealthContributorRegistry`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthContributorRegistry.java) µÄÄÚÈÝÖÐÊÕ¼¯µÄ£¨Ä¬ÈÏÇé¿öÏ£¬ËùÓÐ [`HealthContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthContributor.java) ʵÀý¶¼¶¨ÒåÔÚÄãµÄ `ApplicationContext` ÖУ©¡£ Spring Boot°üÀ¨Ò»Ð©×Ô¶¯ÅäÖÃµÄ `HealthContributor`£¬ÄãÒ²¿ÉÒÔ±àд×Ô¼ºµÄ¡£ +å�¥åº·ä¿¡æ�¯æ˜¯ä»Ž [`HealthContributorRegistry`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthContributorRegistry.java) 的内容中收集的(默认情况下,所有 [`HealthContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthContributor.java) 实例都定义在你的 `ApplicationContext` 中)。 Spring Boot包括一些自动é…�置的 `HealthContributor`,你也å�¯ä»¥ç¼–写自己的。 -Ò»¸ö `HealthContributor` ¿ÉÒÔÊÇÒ»¸ö `HealthIndicator` »òÒ»¸ö `CompositeHealthContributor`¡£ Ò»¸ö `HealthIndicator` Ìṩʵ¼ÊµÄ½¡¿µÐÅÏ¢£¬°üÀ¨ `Status`¡£ Ò»¸ö `CompositeHealthContributor` ÌṩÆäËû `HealthContributors` µÄ×éºÏ¡£ ×ÛºÏÆðÀ´£¬contributorÐγÉÒ»¸öÊ÷×´½á¹¹À´±íʾÕû¸öϵͳµÄ½¡¿µ×´¿ö¡£ +一个 `HealthContributor` å�¯ä»¥æ˜¯ä¸€ä¸ª `HealthIndicator` 或一个 `CompositeHealthContributor`。 一个 `HealthIndicator` æ��供实际的å�¥åº·ä¿¡æ�¯ï¼ŒåŒ…括 `Status`。 一个 `CompositeHealthContributor` æ��供其他 `HealthContributors` 的组å�ˆã€‚ 综å�ˆèµ·æ�¥ï¼Œcontributorå½¢æˆ�一个树状结构æ�¥è¡¨ç¤ºæ•´ä¸ªç³»ç»Ÿçš„å�¥åº·çŠ¶å†µã€‚ -ĬÈÏÇé¿öÏ£¬×îÖÕµÄϵͳ½¡¿µ×´¿öÊÇÓÉÒ»¸ö `StatusAggregator` µÃ³öµÄ£¬Ëü¸ù¾ÝÒ»¸öÓÐÐòµÄ״̬Áбí¶Ôÿ¸ö `HealthIndicator` µÄ״̬½øÐÐÅÅÐò¡£ ÅÅÐòÁбíÖеĵÚÒ»¸ö״̬±»ÓÃ×÷ÕûÌ彡¿µ×´Ì¬¡£ Èç¹ûûÓÐ `HealthIndicator` ·µ»ØµÄ״̬ÊÇ `StatusAggregator` ËùÖªµÀµÄ£¬¾Í»áʹÓà `UNKNOWN` ״̬¡£ +默认情况下,最终的系统å�¥åº·çŠ¶å†µæ˜¯ç”±ä¸€ä¸ª `StatusAggregator` 得出的,它根æ�®ä¸€ä¸ªæœ‰åº�的状æ€�列表对æ¯�个 `HealthIndicator` 的状æ€�进行排åº�。 排åº�列表中的第一个状æ€�被用作整体å�¥åº·çжæ€�。 如果没有 `HealthIndicator` 返回的状æ€�是 `StatusAggregator` 所知é�“的,就会使用 `UNKNOWN` 状æ€�。 -| | Äã¿ÉÒÔʹÓà `HealthContributorRegistry` À´ÔÚÔËÐÐʱע²áºÍÈ¡Ïû×¢²á½¡¿µÖ¸±ê¡£ | +| | ä½ å�¯ä»¥ä½¿ç”¨ `HealthContributorRegistry` æ�¥åœ¨è¿�行时注册和å�–消注册å�¥åº·æŒ‡æ ‡ã€‚ | | --- | --- | -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.auto-configured-health-indicators)2.8.1\. ×Ô¶¯ÅäÖõÄHealthIndicators +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.auto-configured-health-indicators)2.8.1\. 自动é…�置的HealthIndicators -ÔÚÊʵ±µÄʱºò£¬Spring Boot»á×Ô¶¯ÅäÖÃϱíÖÐÁгöµÄ `HealthIndicators`¡£ ÄãÒ²¿ÉÒÔͨ¹ýÅäÖà `management.health.key.enabled` À´ÆôÓûòÍ£ÓÃËùѡָ±ê¡£ ºÍϱíÖÐÁгöµÄ `key`¡£ +在适当的时候,Spring Boot会自动é…�置下表中列出的 `HealthIndicators`。 你也å�¯ä»¥é€šè¿‡é…�ç½® `management.health.key.enabled` æ�¥å�¯ç”¨æˆ–å�œç”¨æ‰€é€‰æŒ‡æ ‡ã€‚ 和下表中列出的 `key`。 -| Key | Name | ˵Ã÷ | +| Key | Name | 说明 | | --- | --- | --- | -| `cassandra` | [`CassandraDriverHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cassandra/CassandraDriverHealthIndicator.java) | ¼ì²éCassandraÊý¾Ý¿âÊÇ·ñÒѾ­Æô¶¯¡£ | -| `couchbase` | [`CouchbaseHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/couchbase/CouchbaseHealthIndicator.java) | ¼ì²éCouchbase¼¯ÈºÊÇ·ñÒѾ­Æô¶¯¡£ | -| `db` | [`DataSourceHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/jdbc/DataSourceHealthIndicator.java) | ¼ì²éÊÇ·ñ¿ÉÒÔ»ñµÃÓë`DataSource`µÄÁ¬½Ó¡£ | -| `diskspace` | [`DiskSpaceHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/DiskSpaceHealthIndicator.java) | ¼ì²é´ÅÅ̿ռäÊÇ·ñ²»×ã¡£ | -| `elasticsearch` | [`ElasticsearchRestHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/elasticsearch/ElasticsearchRestHealthIndicator.java) | ¼ì²éElasticsearch¼¯ÈºÊÇ·ñÒѾ­Æô¶¯¡£ | -| `hazelcast` | [`HazelcastHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/hazelcast/HazelcastHealthIndicator.java) | ¼ì²éHazelcast·þÎñÆ÷ÊÇ·ñÒѾ­Æô¶¯¡£ | -| `influxdb` | [`InfluxDbHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/influx/InfluxDbHealthIndicator.java) | ¼ì²éInfluxDB·þÎñÆ÷ÊÇ·ñÒѾ­Æô¶¯¡£ | -| `jms` | [`JmsHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/jms/JmsHealthIndicator.java) | ¼ì²éÒ»¸öJMS´úÀíÊÇ·ñÒѾ­Æô¶¯¡£ | -| `ldap` | [`LdapHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/ldap/LdapHealthIndicator.java) | ¼ì²éÒ»¸öLDAP·þÎñÆ÷ÊÇ·ñÕý³£¡£ | -| `mail` | [`MailHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/mail/MailHealthIndicator.java) | ¼ì²éÒ»¸öÓʼþ·þÎñÆ÷ÊÇ·ñÕý³£¡£ | -| `mongo` | [`MongoHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/mongo/MongoHealthIndicator.java) | ¼ì²éMongoÊý¾Ý¿âÊÇ·ñÒѾ­Æô¶¯¡£ | -| `neo4j` | [`Neo4jHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/neo4j/Neo4jHealthIndicator.java) | ¼ì²éNeo4jÊý¾Ý¿âÊÇ·ñÒѾ­Æô¶¯¡£ | -| `ping` | [`PingHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/PingHealthIndicator.java) | ×ÜÊÇÏìÓ¦ `UP` ¡£ | -| `rabbit` | [`RabbitHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/amqp/RabbitHealthIndicator.java) | ¼ì²éÒ»¸öRabbit·þÎñÆ÷ÊÇ·ñÒѾ­Æô¶¯¡£ | -| `redis` | [`RedisHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/redis/RedisHealthIndicator.java) | ¼ì²éRedis·þÎñÆ÷ÊÇ·ñÒѾ­Æô¶¯¡£ | - - - -| | Äã¿ÉÒÔͨ¹ýÉèÖà `management.health.defaults.enabled` ÊôÐÔÀ´½ûÓÃËüÃÇ¡£ | +| `cassandra` | [`CassandraDriverHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cassandra/CassandraDriverHealthIndicator.java) | 检查Cassandraæ•°æ�®åº“是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `couchbase` | [`CouchbaseHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/couchbase/CouchbaseHealthIndicator.java) | 检查Couchbase集群是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `db` | [`DataSourceHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/jdbc/DataSourceHealthIndicator.java) | 检查是å�¦å�¯ä»¥èŽ·å¾—ä¸Ž`DataSource`的连接。 | +| `diskspace` | [`DiskSpaceHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/DiskSpaceHealthIndicator.java) | 检查ç£�盘空间是å�¦ä¸�足。 | +| `elasticsearch` | [`ElasticsearchRestHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/elasticsearch/ElasticsearchRestHealthIndicator.java) | 检查Elasticsearch集群是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `hazelcast` | [`HazelcastHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/hazelcast/HazelcastHealthIndicator.java) | 检查Hazelcastæœ�务器是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `influxdb` | [`InfluxDbHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/influx/InfluxDbHealthIndicator.java) | 检查InfluxDBæœ�务器是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `jms` | [`JmsHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/jms/JmsHealthIndicator.java) | 检查一个JMS代ç�†æ˜¯å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `ldap` | [`LdapHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/ldap/LdapHealthIndicator.java) | 检查一个LDAPæœ�务器是å�¦æ­£å¸¸ã€‚ | +| `mail` | [`MailHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/mail/MailHealthIndicator.java) | 检查一个邮件æœ�务器是å�¦æ­£å¸¸ã€‚ | +| `mongo` | [`MongoHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/mongo/MongoHealthIndicator.java) | 检查Mongoæ•°æ�®åº“是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `neo4j` | [`Neo4jHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/neo4j/Neo4jHealthIndicator.java) | 检查Neo4jæ•°æ�®åº“是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `ping` | [`PingHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/PingHealthIndicator.java) | 总是å“�应 `UP` 。 | +| `rabbit` | [`RabbitHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/amqp/RabbitHealthIndicator.java) | 检查一个Rabbitæœ�务器是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `redis` | [`RedisHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/redis/RedisHealthIndicator.java) | 检查Redisæœ�务器是å�¦å·²ç»�å�¯åŠ¨ã€‚ | + + + +| | ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.health.defaults.enabled` 属性æ�¥ç¦�用它们。 | | --- | --- | -¶îÍâµÄ `HealthIndicators` ÊÇ¿ÉÓõ쬵«ÔÚĬÈÏÇé¿öϲ»ÆôÓᣠ+é¢�外的 `HealthIndicators` 是å�¯ç”¨çš„,但在默认情况下ä¸�å�¯ç”¨ã€‚ -| Key | Name | ˵Ã÷ | +| Key | Name | 说明 | | --- | --- | --- | -| `livenessstate` | [`LivenessStateHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/availability/LivenessStateHealthIndicator.java) | ÏÔʾ ¡°Liveness¡± Ó¦ÓóÌÐòµÄ¿ÉÓÃÐÔ״̬¡£ | -| `readinessstate` | [`ReadinessStateHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/availability/ReadinessStateHealthIndicator.java) | ±©Â¶ ¡°Readiness¡± Ó¦ÓóÌÐòµÄ¿ÉÓÃÐÔ״̬¡£ | +| `livenessstate` | [`LivenessStateHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/availability/LivenessStateHealthIndicator.java) | 显示 “Livenessâ€� 应用程åº�çš„å�¯ç”¨æ€§çжæ€�。 | +| `readinessstate` | [`ReadinessStateHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/availability/ReadinessStateHealthIndicator.java) | 暴露 “Readinessâ€� 应用程åº�çš„å�¯ç”¨æ€§çжæ€�。 | -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.writing-custom-health-indicators)2.8.2\. ±àд×Ô¶¨ÒåHealthIndicators +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.writing-custom-health-indicators)2.8.2\. 编写自定义HealthIndicators -ΪÁËÌṩ×Ô¶¨ÒåµÄ½¡¿µÐÅÏ¢£¬Äã¿ÉÒÔ×¢²áʵÏÖ [`HealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthIndicator.java) ½Ó¿ÚµÄSpring Bean¡£ ÄãÐèÒªÌṩһ¸ö `health()` ·½·¨µÄʵÏÖ£¬²¢·µ»ØÒ»¸ö `Health` ÏìÓ¦¡£ `Health` ÏìÓ¦Ó¦¸Ã°üÀ¨Ò»¸östatus£¬²¢¿ÉÒÔÑ¡Ôñ°üÀ¨ÒªÏÔʾµÄÆäËûϸ½Ú¡£ ÏÂÃæµÄ´úÂëÏÔʾÁËÒ»¸ö `HealthIndicator` µÄʵÏÖÑù±¾¡£ +为了æ��供自定义的å�¥åº·ä¿¡æ�¯ï¼Œä½ å�¯ä»¥æ³¨å†Œå®žçް [`HealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthIndicator.java) 接å�£çš„Spring Bean。 你需è¦�æ��供一个 `health()` 方法的实现,并返回一个 `Health` å“�应。 `Health` å“�应应该包括一个status,并å�¯ä»¥é€‰æ‹©åŒ…括è¦�显示的其他细节。 下é�¢çš„代ç �显示了一个 `HealthIndicator` 的实现样本。 @@ -1148,27 +1148,27 @@ public class MyHealthIndicator implements HealthIndicator { -| | Ò»¸ö¸ø¶¨µÄ `HealthIndicator` µÄ±êʶ·û£¨ID£©ÊÇûÓÐ `HealthIndicator` ºó׺µÄBeanµÄÃû×Ö£¬Èç¹ûËü´æÔڵϰ¡£ ÔÚÇ°ÃæµÄÀý×ÓÖУ¬½¡¿µÐÅÏ¢¿ÉÒÔÔÚÒ»¸öÃûΪ `my` µÄÌõÄ¿ÖÐÕÒµ½¡£ | +| | 一个给定的 `HealthIndicator` 的标识符(ID)是没有 `HealthIndicator` å�Žç¼€çš„Beançš„å��字,如果它存在的è¯�。 在å‰�é�¢çš„例å­�中,å�¥åº·ä¿¡æ�¯å�¯ä»¥åœ¨ä¸€ä¸ªå��为 `my` çš„æ�¡ç›®ä¸­æ‰¾åˆ°ã€‚ | | --- | --- | -| | ½¡¿µÖ¸±êͨ³£ÊÇͨ¹ýHTTPµ÷Óõģ¬ÐèÒªÔÚÈκÎÁ¬½Ó³¬Ê±Ö®Ç°×ö³öÏìÓ¦¡£ Èç¹ûÈκν¡¿µÖ¸±êµÄÏìӦʱ¼ä³¬¹ý10Ã룬Spring Boot½«¼Ç¼һÌõ¾¯¸æÐÅÏ¢¡£ Èç¹ûÄãÏëÅäÖÃÕâ¸öãÐÖµ£¬Äã¿ÉÒÔʹÓà `management.endpoint.health.logging.slow-indicator-threshold` ÊôÐÔ¡£ | +| | å�¥åº·æŒ‡æ ‡é€šå¸¸æ˜¯é€šè¿‡HTTP调用的,需è¦�在任何连接超时之å‰�å�šå‡ºå“�应。 如果任何å�¥åº·æŒ‡æ ‡çš„å“�应时间超过10秒,Spring Boot将记录一æ�¡è­¦å‘Šä¿¡æ�¯ã€‚ 如果你想é…�置这个阈值,你å�¯ä»¥ä½¿ç”¨ `management.endpoint.health.logging.slow-indicator-threshold` 属性。 | | --- | --- | -³ýÁËSpring BootÔ¤¶¨ÒåµÄ [`Status`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java) ÀàÐÍÍ⣬`Health` ¿ÉÒÔ·µ»Ø´ú±íÐÂϵͳ״̬µÄ×Ô¶¨Òå `Status`¡£ ÔÚÕâÖÖÇé¿öÏ£¬Ä㻹ÐèÒªÌṩ `StatusAggregator` ½Ó¿ÚµÄ×Ô¶¨ÒåʵÏÖ£¬»òÕßÄã±ØÐëͨ¹ýʹÓà `management.endpoint.health.status.order` ÅäÖÃÊôÐÔÀ´ÅäÖÃĬÈÏʵÏÖ¡£ +除了Spring Boot预定义的 [`Status`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/Status.java) 类型外,`Health` å�¯ä»¥è¿”回代表新系统状æ€�的自定义 `Status`。 在这ç§�情况下,你还需è¦�æ��ä¾› `StatusAggregator` 接å�£çš„自定义实现,或者你必须通过使用 `management.endpoint.health.status.order` é…�置属性æ�¥é…�置默认实现。 -ÀýÈ磬¼ÙÉèÔÚÄãµÄÒ»¸ö `HealthIndicator` ʵÏÖÖÐʹÓÃÁËÒ»¸ö´úÂëΪ `FATAL` µÄР`Status`¡£ ΪÁËÅäÖÃÑÏÖØÐÔ˳Ðò£¬ÔÚÄãµÄÓ¦ÓóÌÐòÊôÐÔÖÐÌí¼ÓÒÔÏÂÊôÐÔ¡£ +例如,å�‡è®¾åœ¨ä½ çš„一个 `HealthIndicator` 实现中使用了一个代ç �为 `FATAL` 的新 `Status`。 为了é…�置严é‡�性顺åº�,在你的应用程åº�属性中添加以下属性。 @@ -1195,7 +1195,7 @@ management.endpoint.health.status.order=fatal,down,out-of-service,unknown,up -ÏìÓ¦ÖеÄHTTP״̬´úÂë·´Ó³ÁËÕûÌ彡¿µ×´Ì¬¡£ ĬÈÏÇé¿öÏ£¬`OUT_OF_SERVICE` ºÍ `DOWN` Ó³Éäµ½503¡£ ÈκÎδӳÉäµÄ½¡¿µ×´Ì¬£¬°üÀ¨ `UP`£¬¶¼Ó³ÉäΪ200¡£ Èç¹ûÄãͨ¹ýHTTP·ÃÎʽ¡¿µ¶Ëµã£¬Äã¿ÉÄÜ»¹Ïë×¢²á×Ô¶¨Òå״̬ӳÉä¡£ ÅäÖÃ×Ô¶¨ÒåÓ³Éä»á½ûÓà `DOWN` ºÍ `OUT_OF_SERVICE` µÄĬÈÏÓ³Éä¡£ Èç¹ûÄãÏë±£ÁôĬÈÏÓ³É䣬Äã±ØÐëÃ÷È·µØÅäÖÃËüÃÇ£¬ÒÔ¼°ÈκÎ×Ô¶¨ÒåÓ³Éä¡£ ÀýÈ磬ÏÂÃæµÄÊôÐÔ½« `FATAL` Ó³ÉäΪ503£¨·þÎñ²»¿ÉÓã©£¬²¢±£ÁôÁË `DOWN` ºÍ `OUT_OF_SERVICE` µÄĬÈÏÓ³Éä¡£ +å“�应中的HTTP状æ€�代ç �å��映了整体å�¥åº·çжæ€�。 默认情况下,`OUT_OF_SERVICE` å’Œ `DOWN` 映射到503。 任何未映射的å�¥åº·çжæ€�,包括 `UP`,都映射为200。 如果你通过HTTP访问å�¥åº·ç«¯ç‚¹ï¼Œä½ å�¯èƒ½è¿˜æƒ³æ³¨å†Œè‡ªå®šä¹‰çжæ€�映射。 é…�置自定义映射会ç¦�用 `DOWN` å’Œ `OUT_OF_SERVICE` 的默认映射。 如果你想ä¿�留默认映射,你必须明确地é…�置它们,以å�Šä»»ä½•自定义映射。 例如,下é�¢çš„属性将 `FATAL` 映射为503(æœ�务ä¸�å�¯ç”¨ï¼‰ï¼Œå¹¶ä¿�留了 `DOWN` å’Œ `OUT_OF_SERVICE` 的默认映射。 @@ -1224,14 +1224,14 @@ management.endpoint.health.status.http-mapping.out-of-service=503 -| | Èç¹ûÄãÐèÒª¸ü¶àµÄ¿ØÖÆ£¬Äã¿ÉÒÔ¶¨ÒåÄã×Ô¼ºµÄ `HttpCodeStatusMapper` bean¡£ | +| | 如果你需è¦�更多的控制,你å�¯ä»¥å®šä¹‰ä½ è‡ªå·±çš„ `HttpCodeStatusMapper` bean。 | | --- | --- | -ϱíÏÔʾÁËÄÚÖÃ״̬µÄĬÈÏ״̬ӳÉä¡£ +下表显示了内置状æ€�的默认状æ€�映射。 @@ -1240,37 +1240,37 @@ management.endpoint.health.status.http-mapping.out-of-service=503 | --- | --- | | `DOWN` | `SERVICE_UNAVAILABLE` (`503`) | | `OUT_OF_SERVICE` | `SERVICE_UNAVAILABLE` (`503`) | -| `UP` | ĬÈÏÇé¿öÏÂûÓÐÓ³É䣬ËùÒÔHTTP״̬Ϊ `200`¡£ | -| `UNKNOWN` | ĬÈÏÇé¿öÏÂûÓÐÓ³É䣬ËùÒÔHTTP״̬Ϊ `200`¡£ | +| `UP` | 默认情况下没有映射,所以HTTP状æ€�为 `200`。 | +| `UNKNOWN` | 默认情况下没有映射,所以HTTP状æ€�为 `200`。 | -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.reactive-health-indicators)2.8.3\. ÏìӦʽ½¡¿µÖ¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.reactive-health-indicators)2.8.3\. å“�应å¼�å�¥åº·æŒ‡æ ‡ -¶ÔÓÚÏìӦʽӦÓóÌÐò£¬ÀýÈçÄÇЩʹÓÃSpring WebFluxµÄÓ¦ÓóÌÐò£¬`ReactiveHealthContributor` ÌṩÁËÒ»¸ö·Ç×èÈûµÄÆõÔ¼À´»ñȡӦÓóÌÐòµÄ½¡¿µ×´¿ö¡£ Ó봫ͳµÄ `HealthContributor` ÀàËÆ£¬½¡¿µÐÅÏ¢´Ó [`ReactiveHealthContributorRegistry`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthContributorRegistry.java) µÄÄÚÈÝÖÐÊÕ¼¯£¨Ä¬ÈÏÇé¿öÏ£¬ËùÓÐ [`HealthContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthContributor.java) ºÍ [`ReactiveHealthContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthContributor.java) µÄʵÀý¶¨ÒåÔÚÄãµÄ `ApplicationContext` À¡£ +对于å“�应å¼�应用程åº�,例如那些使用Spring WebFlux的应用程åº�,`ReactiveHealthContributor` æ��供了一个é�žé˜»å¡žçš„契约æ�¥èŽ·å�–应用程åº�çš„å�¥åº·çŠ¶å†µã€‚ 与传统的 `HealthContributor` 类似,å�¥åº·ä¿¡æ�¯ä»Ž [`ReactiveHealthContributorRegistry`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthContributorRegistry.java) 的内容中收集(默认情况下,所有 [`HealthContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/HealthContributor.java) å’Œ [`ReactiveHealthContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthContributor.java) 的实例定义在你的 `ApplicationContext` 里)。 -²»¶ÔÏìӦʽAPI½øÐмì²éµÄ³£¹æ `HealthContributors` ÔÚµ¯ÐÔµ÷¶ÈÆ÷ÉÏÖ´ÐС£ +ä¸�对å“�应å¼�API进行检查的常规 `HealthContributors` 在弹性调度器上执行。 -| | ÔÚÒ»¸öÏìӦʽӦÓóÌÐòÖУ¬ÄãÓ¦¸ÃʹÓà `ReactiveHealthContributorRegistry` À´ÔÚÔËÐÐʱע²áºÍÈ¡Ïû×¢²á½¡¿µÖ¸±ê¡£ Èç¹ûÄãÐèҪע²áÒ»¸öÆÕͨµÄ `HealthContributor`£¬ÄãÓ¦¸ÃÓà `ReactiveHealthContributor#adapt` À´°ü×°Ëü¡£ | +| | 在一个å“�应å¼�应用程åº�中,你应该使用 `ReactiveHealthContributorRegistry` æ�¥åœ¨è¿�行时注册和å�–消注册å�¥åº·æŒ‡æ ‡ã€‚ 如果你需è¦�注册一个普通的 `HealthContributor`,你应该用 `ReactiveHealthContributor#adapt` æ�¥åŒ…装它。 | | --- | --- | -ΪÁË´ÓÏìӦʽAPIÖÐÌṩ×Ô¶¨ÒåµÄ½¡¿µÐÅÏ¢£¬Äã¿ÉÒÔ×¢²áʵÏÖ [`ReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java) ½Ó¿ÚµÄSpring Bean¡£ ÏÂÃæµÄ´úÂëÏÔʾÁËÒ»¸ö `ReactiveHealthIndicator` µÄʾÀýʵÏÖ¡£ +为了从å“�应å¼�API中æ��供自定义的å�¥åº·ä¿¡æ�¯ï¼Œä½ å�¯ä»¥æ³¨å†Œå®žçް [`ReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/ReactiveHealthIndicator.java) 接å�£çš„Spring Bean。 下é�¢çš„代ç �显示了一个 `ReactiveHealthIndicator` 的示例实现。 @@ -1311,7 +1311,7 @@ public class MyReactiveHealthIndicator implements ReactiveHealthIndicator { -| | ΪÁË×Ô¶¯´¦Àí´íÎ󣬿ÉÒÔ¿¼ÂÇ´Ó `AbstractReactiveHealthIndicator` ÖÐÀ©Õ¹¡£ | +| | 为了自动处ç�†é”™è¯¯ï¼Œå�¯ä»¥è€ƒè™‘从 `AbstractReactiveHealthIndicator` 中扩展。 | | --- | --- | @@ -1320,27 +1320,27 @@ public class MyReactiveHealthIndicator implements ReactiveHealthIndicator { -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.auto-configured-reactive-health-indicators)2.8.4\. ×Ô¶¯ÅäÖÃµÄ ReactiveHealthIndicators +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.auto-configured-reactive-health-indicators)2.8.4\. 自动é…�置的 ReactiveHealthIndicators -ÔÚÊʵ±µÄʱºò£¬Spring Boot»á×Ô¶¯ÅäÖÃÒÔÏ嵀 `ReactiveHealthIndicators`¡£ +在适当的时候,Spring Boot会自动é…�置以下的 `ReactiveHealthIndicators`。 -| Key | Name | ˵Ã÷ | +| Key | Name | 说明 | | --- | --- | --- | -| `cassandra` | [`CassandraDriverReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cassandra/CassandraDriverReactiveHealthIndicator.java) | ¼ì²éCassandraÊý¾Ý¿âÊÇ·ñÒѾ­Æô¶¯¡£ | -| `couchbase` | [`CouchbaseReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/couchbase/CouchbaseReactiveHealthIndicator.java) | ¼ì²éCouchbase¼¯ÈºÊÇ·ñÒѾ­Æô¶¯¡£ | -| `elasticsearch` | [`ElasticsearchReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/elasticsearch/ElasticsearchReactiveHealthIndicator.java) | ¼ì²éElasticsearch¼¯ÈºÊÇ·ñÒѾ­Æô¶¯¡£ | -| `mongo` | [`MongoReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/mongo/MongoReactiveHealthIndicator.java) | ¼ì²éMongoÊý¾Ý¿âÊÇ·ñÒѾ­Æô¶¯¡£ | -| `neo4j` | [`Neo4jReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/neo4j/Neo4jReactiveHealthIndicator.java) | ¼ì²éNeo4jÊý¾Ý¿âÊÇ·ñÒѾ­Æô¶¯¡£ | -| `redis` | [`RedisReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/redis/RedisReactiveHealthIndicator.java) | ¼ì²éRedis·þÎñÆ÷ÊÇ·ñÒѾ­Æô¶¯¡£ | +| `cassandra` | [`CassandraDriverReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cassandra/CassandraDriverReactiveHealthIndicator.java) | 检查Cassandraæ•°æ�®åº“是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `couchbase` | [`CouchbaseReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/couchbase/CouchbaseReactiveHealthIndicator.java) | 检查Couchbase集群是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `elasticsearch` | [`ElasticsearchReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/elasticsearch/ElasticsearchReactiveHealthIndicator.java) | 检查Elasticsearch集群是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `mongo` | [`MongoReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/mongo/MongoReactiveHealthIndicator.java) | 检查Mongoæ•°æ�®åº“是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `neo4j` | [`Neo4jReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/neo4j/Neo4jReactiveHealthIndicator.java) | 检查Neo4jæ•°æ�®åº“是å�¦å·²ç»�å�¯åŠ¨ã€‚ | +| `redis` | [`RedisReactiveHealthIndicator`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/data/redis/RedisReactiveHealthIndicator.java) | 检查Redisæœ�务器是å�¦å·²ç»�å�¯åŠ¨ã€‚ | -| | Èç¹ûÓбØÒª£¬ÏìӦʽָ±ê»áÈ¡´ú³£¹æÖ¸±ê¡£ ÁíÍ⣬ÈκÎûÓб»Ã÷È·´¦ÀíµÄ `HealthIndicator` ¶¼»á±»×Ô¶¯°ü×°ÆðÀ´¡£ | +| | 如果有必è¦�,å“�应å¼�指标会å�–代常规指标。 å�¦å¤–,任何没有被明确处ç�†çš„ `HealthIndicator` 都会被自动包装起æ�¥ã€‚ | | --- | --- | @@ -1349,17 +1349,17 @@ public class MyReactiveHealthIndicator implements ReactiveHealthIndicator { -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.groups)2.8.5\. Health·Ö×飨Health Groups£© +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.groups)2.8.5\. Health分组(Health Groups) -ÓÐʱ£¬½«½¡¿µÖ¸±ê×éÖ¯³É¿ÉÒÔÓÃÓÚ²»Í¬Ä¿µÄµÄ×éÊǺÜÓÐÓõġ£ +有时,将å�¥åº·æŒ‡æ ‡ç»„织æˆ�å�¯ä»¥ç”¨äºŽä¸�å�Œç›®çš„的组是很有用的。 -Òª´´½¨Ò»¸ö½¡¿µÖ¸±ê×飬Äã¿ÉÒÔʹÓà `management.endpoint.health.group.` ÊôÐÔ£¬²¢Ö¸¶¨Ò»¸ö½¡¿µÖ¸±êIDÁбíÀ´ `include` »ò `exclude`¡£ ÀýÈ磬Ҫ´´½¨Ò»¸öÖ»°üÀ¨Êý¾Ý¿âÖ¸±êµÄ×飬Äã¿ÉÒÔ¶¨ÒåÈçÏ¡£ +è¦�创建一个å�¥åº·æŒ‡æ ‡ç»„,你å�¯ä»¥ä½¿ç”¨ `management.endpoint.health.group.` 属性,并指定一个å�¥åº·æŒ‡æ ‡ID列表æ�¥ `include` 或 `exclude`。 例如,è¦�创建一个å�ªåŒ…括数æ�®åº“指标的组,你å�¯ä»¥å®šä¹‰å¦‚下。 @@ -1386,13 +1386,13 @@ management.endpoint.health.group.custom.include=db -È»ºóÄã¿ÉÒÔͨ¹ýµã»÷ `[localhost:8080/actuator/health/custom](http://localhost:8080/actuator/health/custom)` À´¼ì²é½á¹û¡£ +ç„¶å�Žä½ å�¯ä»¥é€šè¿‡ç‚¹å‡» `[localhost:8080/actuator/health/custom](http://localhost:8080/actuator/health/custom)` æ�¥æ£€æŸ¥ç»“果。 -ͬÑù£¬Òª´´½¨Ò»¸ö×飬½«Êý¾Ý¿âÖ¸±êÅųýÔÚ¸Ã×éÖ®Í⣬²¢°üÀ¨ËùÓÐÆäËûÖ¸±ê£¬Äã¿ÉÒÔ¶¨ÒåÈçÏ¡£ +å�Œæ ·ï¼Œè¦�创建一个组,将数æ�®åº“指标排除在该组之外,并包括所有其他指标,你å�¯ä»¥å®šä¹‰å¦‚下。 @@ -1419,7 +1419,7 @@ management.endpoint.health.group.custom.exclude=db -ĬÈÏÇé¿öÏ£¬×é¼Ì³ÐÁËÓëϵͳ½¡¿µÏàͬµÄ `StatusAggregator` ºÍ `HttpCodeStatusMapper` ÉèÖᣠȻ¶ø£¬ÄãÒ²¿ÉÒÔÔÚÿ¸ö×éµÄ»ù´¡É϶¨ÒåÕâЩ¡£ Èç¹ûÐèÒª£¬ÄãÒ²¿ÉÒÔ¸²¸Ç `show-details` ºÍ `roles` ÊôÐÔ¡£ +默认情况下,组继承了与系统å�¥åº·ç›¸å�Œçš„ `StatusAggregator` å’Œ `HttpCodeStatusMapper` 设置。 然而,你也å�¯ä»¥åœ¨æ¯�个组的基础上定义这些。 如果需è¦�,你也å�¯ä»¥è¦†ç›– `show-details` å’Œ `roles` 属性。 @@ -1450,14 +1450,14 @@ management.endpoint.health.group.custom.status.http-mapping.out-of-service=500 -| | Èç¹ûÄãÐèҪע²á×Ô¶¨ÒåµÄ `StatusAggregator` »ò `HttpCodeStatusMapper` BeanÒÔÓÃÓÚ×飬Äã¿ÉÒÔʹÓà `@Qualifier("groupname")`¡£ | +| | 如果你需è¦�注册自定义的 `StatusAggregator` 或 `HttpCodeStatusMapper` Bean以用于组,你å�¯ä»¥ä½¿ç”¨ `@Qualifier("groupname")`。 | | --- | --- | -Ò»¸ö½¡¿µ×éÒ²¿ÉÒÔ°üÀ¨/ÅųýÒ»¸ö `CompositeHealthContributor`¡£ ÄúÒ²¿ÉÒÔÖ»°üÀ¨/ÅųýÒ»¸ö `CompositeHealthContributor` µÄij¸ö×é¼þ¡£ Õâ¿ÉÒÔʹÓÃ×é¼þµÄÍêÈ«Ãû³ÆÀ´Íê³É£¬ÈçÏÂËùʾ¡£ +一个å�¥åº·ç»„也å�¯ä»¥åŒ…括/排除一个 `CompositeHealthContributor`。 您也å�¯ä»¥å�ªåŒ…括/排除一个 `CompositeHealthContributor` çš„æŸ�个组件。 è¿™å�¯ä»¥ä½¿ç”¨ç»„件的完全å��ç§°æ�¥å®Œæˆ�,如下所示。 @@ -1476,13 +1476,13 @@ management.endpoint.health.group.custom.exclude="test/primary/b" -ÔÚÉÏÃæµÄÀý×ÓÖУ¬`custom` ×齫°üÀ¨Ãû³ÆÎª `primary` µÄ `HealthContributor`£¬ËüÊǸ´ºÏ `test` µÄÒ»¸ö×é³É²¿·Ö¡£ ÔÚÕâÀ`primary` ±¾Éí¾ÍÊÇÒ»¸ö¸´ºÏÌ壬Ãû×ÖΪ `b` µÄ `HealthContributor` ½«±»ÅųýÔÚ `custom` ×éÖ®Íâ¡£ +在上é�¢çš„例å­�中,`custom` 组将包括å��称为 `primary` çš„ `HealthContributor`,它是å¤�å�ˆ `test` 的一个组æˆ�部分。 在这里,`primary` 本身就是一个å¤�å�ˆä½“,å��字为 `b` çš„ `HealthContributor` 将被排除在 `custom` 组之外。 -½¡¿µ×é¿ÉÒÔÔÚÖ÷¶Ë¿Ú»ò¹ÜÀí¶Ë¿ÚµÄ¶îÍâ·¾¶ÉÏÌṩ¡£ ÕâÔÚKubernetesµÈÔÆ»·¾³ÖкÜÓÐÓã¬ÔÚÕâЩ»·¾³ÖУ¬³öÓÚ°²È«¿¼ÂÇ£¬ÎªÖ´ÐÐÆ÷¶ËµãʹÓÃÒ»¸öµ¥¶ÀµÄ¹ÜÀí¶Ë¿ÚÊǺܳ£¼ûµÄ¡£ ÓÐÒ»¸öµ¥¶ÀµÄ¶Ë¿Ú¿ÉÄܵ¼Ö²»¿É¿¿µÄ½¡¿µ¼ì²é£¬ÒòΪ¼´Ê¹½¡¿µ¼ì²é³É¹¦£¬Ö÷Ó¦ÓóÌÐòÒ²¿ÉÄÜÎÞ·¨Õý³£¹¤×÷¡£ ½¡¿µ×é¿ÉÒÔÓÃÒ»¸ö¶îÍâµÄ·¾¶½øÐÐÅäÖã¬ÈçÏÂËùʾ¡£ +å�¥åº·ç»„å�¯ä»¥åœ¨ä¸»ç«¯å�£æˆ–管ç�†ç«¯å�£çš„é¢�外路径上æ��供。 这在Kubernetes等云环境中很有用,在这些环境中,出于安全考虑,为执行器端点使用一个å�•独的管ç�†ç«¯å�£æ˜¯å¾ˆå¸¸è§�的。 有一个å�•独的端å�£å�¯èƒ½å¯¼è‡´ä¸�å�¯é� çš„å�¥åº·æ£€æŸ¥ï¼Œå› ä¸ºå�³ä½¿å�¥åº·æ£€æŸ¥æˆ�功,主应用程åº�也å�¯èƒ½æ— æ³•正常工作。 å�¥åº·ç»„å�¯ä»¥ç”¨ä¸€ä¸ªé¢�外的路径进行é…�置,如下所示。 @@ -1500,7 +1500,7 @@ management.endpoint.health.group.live.additional-path="server:/healthz" -Õ⽫ʹ `live` ½¡¿µ×éÔÚÖ÷·þÎñÆ÷¶Ë¿Ú `/healthz` ÉÏ¿ÉÓᣠǰ׺ÊÇÇ¿ÖÆÐԵ쬱ØÐëÊÇ `server:`£¨´ú±íÖ÷·þÎñÆ÷¶Ë¿Ú£©»ò `management:`£¨´ú±í¹ÜÀí¶Ë¿Ú£¬Èç¹ûÒÑÅäÖã©¡£ ·¾¶±ØÐëÊÇÒ»¸öµ¥Ò»µÄ·¾¶¶Î¡£ +这将使 `live` å�¥åº·ç»„在主æœ�务器端å�£ `/healthz` 上å�¯ç”¨ã€‚ å‰�缀是强制性的,必须是 `server:`(代表主æœ�务器端å�£ï¼‰æˆ– `management:`(代表管ç�†ç«¯å�£ï¼Œå¦‚果已é…�置)。 路径必须是一个å�•一的路径段。 @@ -1508,11 +1508,11 @@ management.endpoint.health.group.live.additional-path="server:/healthz" -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.datasource)2.8.6\. Êý¾ÝÔ´½¡¿µ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.datasource)2.8.6\. æ•°æ�®æº�å�¥åº· -`DataSource` ½¡¿µÖ¸±êÏÔʾ±ê×¼Êý¾ÝÔ´ºÍ·ÓÉÊý¾ÝÔ´BeanµÄ½¡¿µ×´¿ö¡£ ·ÓÉÊý¾ÝÔ´µÄ½¡¿µ×´¿ö°üÀ¨Æäÿ¸öÄ¿±êÊý¾ÝÔ´µÄ½¡¿µ×´¿ö¡£ ÔÚ½¡¿µ¶ËµãµÄÏìÓ¦ÖУ¬Â·ÓÉÊý¾ÝÔ´µÄÿ¸öÄ¿±ê¶¼ÊÇͨ¹ýʹÓÃÆä·ÓɼüÀ´ÃüÃûµÄ¡£ Èç¹ûÄ㲻ϣÍûÔÚÖ¸±êµÄÊä³öÖаüÀ¨Â·ÓÉÊý¾ÝÔ´£¬Ç뽫 `management.health.db.ignore-routing-data-sources` ÉèÖÃΪ `true`¡£ +`DataSource` å�¥åº·æŒ‡æ ‡æ˜¾ç¤ºæ ‡å‡†æ•°æ�®æº�和路由数æ�®æº�Beançš„å�¥åº·çŠ¶å†µã€‚ 路由数æ�®æº�çš„å�¥åº·çŠ¶å†µåŒ…æ‹¬å…¶æ¯�个目标数æ�®æº�çš„å�¥åº·çŠ¶å†µã€‚ 在å�¥åº·ç«¯ç‚¹çš„å“�应中,路由数æ�®æº�çš„æ¯�个目标都是通过使用其路由键æ�¥å‘½å��的。 如果你ä¸�希望在指标的输出中包括路由数æ�®æº�,请将 `management.health.db.ignore-routing-data-sources` 设置为 `true`。 @@ -1522,23 +1522,23 @@ management.endpoint.health.group.live.additional-path="server:/healthz" -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes)2.9\. Kubernetes ̽Õë +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes)2.9\. Kubernetes 探针 -²¿ÊðÔÚKubernetesÉϵÄÓ¦ÓóÌÐò¿ÉÒÔͨ¹ý [ÈÝÆ÷̽Õë](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) ÌṩÓÐ¹ØÆäÄÚ²¿×´Ì¬µÄÐÅÏ¢¡£¸ù¾Ý [ÄãµÄKubernetesÅäÖÃ](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)£¬kubelet»áµ÷ÓÃÕâЩ̽Õë²¢¶Ô½á¹û×ö³ö·´Ó¦¡£ +部署在Kubernetes上的应用程åº�å�¯ä»¥é€šè¿‡ [容器探针](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes) æ��供有关其内部状æ€�的信æ�¯ã€‚æ ¹æ�® [ä½ çš„Kubernetesé…�ç½®](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/),kubelet会调用这些探针并对结果å�šå‡ºå��应。 -ĬÈÏÇé¿öÏ£¬Spring Boot»á¹ÜÀíÄãµÄ[Ó¦ÓÿÉÓÃÐÔ״̬](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-availability)¡£ Èç¹û²¿ÊðÔÚKubernetes»·¾³ÖУ¬actuator´Ó `ApplicationAvailability` ½Ó¿ÚÖÐÊÕ¼¯ ¡°Liveness¡± ºÍ ¡°Readiness¡± ÐÅÏ¢£¬²¢ÔÚרÓÃ[½¡¿µÖ¸±ê](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.auto-configured-health-indicators)ÖÐʹÓÃÕâЩÐÅÏ¢¡£`LivenessStateHealthIndicator` ºÍ `ReadinessStateHealthIndicator`¡£ ÕâЩָ±êÏÔʾÔÚÈ«¾Ö½¡¿µ¶Ëµã£¨`"/actuator/health"`£©¡£ ËüÃÇÒ²¿ÉÒÔͨ¹ýʹÓÃ[½¡¿µ×é](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.groups)×÷Ϊµ¥¶ÀµÄHTTP̽Õ룺`"/actuator/health/liveness"` ºÍ `"/actuator/health/readiness"`¡£ +默认情况下,Spring Boot会管ç�†ä½ çš„[应用å�¯ç”¨æ€§çжæ€�](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-availability)。 如果部署在Kubernetes环境中,actuator从 `ApplicationAvailability` 接å�£ä¸­æ”¶é›† “Livenessâ€� å’Œ “Readinessâ€� ä¿¡æ�¯ï¼Œå¹¶åœ¨ä¸“用[å�¥åº·æŒ‡æ ‡](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.auto-configured-health-indicators)中使用这些信æ�¯ã€‚`LivenessStateHealthIndicator` å’Œ `ReadinessStateHealthIndicator`。 这些指标显示在全局å�¥åº·ç«¯ç‚¹ï¼ˆ`"/actuator/health"`)。 它们也å�¯ä»¥é€šè¿‡ä½¿ç”¨[å�¥åº·ç»„](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.groups)作为å�•独的HTTP探针:`"/actuator/health/liveness"` å’Œ `"/actuator/health/readiness"`。 -È»ºó£¬Äã¿ÉÒÔÓÃÒÔ϶˵ãÐÅÏ¢ÅäÖÃÄãµÄKubernetes»ù´¡ÉèÊ©¡£ +ç„¶å�Žï¼Œä½ å�¯ä»¥ç”¨ä»¥ä¸‹ç«¯ç‚¹ä¿¡æ�¯é…�置你的Kubernetes基础设施。 @@ -1568,27 +1568,27 @@ readinessProbe: -| | `` Ó¦¸Ã±»ÉèÖÃΪִÐÐÆ÷¶Ëµã¿ÉÓõĶ˿ڡ£ Ëü¿ÉÒÔÊÇÖ÷Web·þÎñÆ÷µÄ¶Ë¿Ú£¬Ò²¿ÉÒÔÊÇÒ»¸öµ¥¶ÀµÄ¹ÜÀí¶Ë¿Ú£¬Èç¹û `"management.server.port"` ÊôÐÔÒѾ­±»ÉèÖᣠ| +| | `` 应该被设置为执行器端点å�¯ç”¨çš„端å�£ã€‚ 它å�¯ä»¥æ˜¯ä¸»Webæœ�务器的端å�£ï¼Œä¹Ÿå�¯ä»¥æ˜¯ä¸€ä¸ªå�•独的管ç�†ç«¯å�£ï¼Œå¦‚æžœ `"management.server.port"` 属性已ç»�被设置。 | | --- | --- | -Ö»Óе±Ó¦ÓóÌÐò[ÔÚKubernetes»·¾³ÖÐÔËÐÐʱ](https://springdoc.cn/spring-boot/deployment.html#deployment.cloud.kubernetes)£¬ÕâЩ½¡¿µ×é²Å»á×Ô¶¯ÆôÓᣠÄã¿ÉÒÔͨ¹ýʹÓà `management.endpoint.health.probes.enabled` ÅäÖÃÊôÐÔÔÚÈκλ·¾³ÖÐÆôÓÃËüÃÇ¡£ +å�ªæœ‰å½“应用程åº�[在Kubernetes环境中è¿�行时](https://springdoc.cn/spring-boot/deployment.html#deployment.cloud.kubernetes),这些å�¥åº·ç»„æ‰�会自动å�¯ç”¨ã€‚ ä½ å�¯ä»¥é€šè¿‡ä½¿ç”¨ `management.endpoint.health.probes.enabled` é…�置属性在任何环境中å�¯ç”¨å®ƒä»¬ã€‚ -| | Èç¹ûÒ»¸öÓ¦ÓóÌÐòµÄÆô¶¯Ê±¼ä³¬¹ýÁËÅäÖõÄÓÐЧÆÚ£¬Kubernetes »áÌáµ½ `"startupProbe"` ×÷Ϊһ¸ö¿ÉÄܵĽâ¾ö·½°¸¡£Ò»°ãÀ´Ëµ£¬ÕâÀï²»Ò»¶¨ÐèÒª `"startupProbe"`£¬ÒòΪ `"readinessProbe"` »áÔÚËùÓÐÆô¶¯ÈÎÎñÍê³É֮ǰʧЧ¡£ÕâÒâζ×ÅÄãµÄÓ¦ÓóÌÐòÔÚ×¼±¸ºÃ֮ǰ²»»áÊÕµ½Á÷Á¿¡£È»¶ø£¬Èç¹ûÄãµÄÓ¦ÓóÌÐòÐèÒªºÜ³¤Ê±¼ä²ÅÄÜÆô¶¯£¬¿ÉÒÔ¿¼ÂÇʹÓà `"startupProbe"` À´È·±£Kubernetes²»»áÔÚÄãµÄÓ¦ÓóÌÐòÆô¶¯¹ý³ÌÖÐɱËÀËü¡£Çë²ÎÔÄÃèÊö[̽ÕëÔÚÓ¦ÓóÌÐòÉúÃüÖÜÆÚÖеÄÐÐΪ](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes.lifecycle)µÄ²¿·Ö¡£ | +| | 如果一个应用程åº�çš„å�¯åŠ¨æ—¶é—´è¶…è¿‡äº†é…�置的有效期,Kubernetes 会æ��到 `"startupProbe"` 作为一个å�¯èƒ½çš„解决方案。一般æ�¥è¯´ï¼Œè¿™é‡Œä¸�一定需è¦� `"startupProbe"`,因为 `"readinessProbe"` 会在所有å�¯åŠ¨ä»»åŠ¡å®Œæˆ�之å‰�失效。这æ„�味ç�€ä½ çš„应用程åº�在准备好之å‰�ä¸�会收到æµ�é‡�。然而,如果你的应用程åº�需è¦�很长时间æ‰�能å�¯åŠ¨ï¼Œå�¯ä»¥è€ƒè™‘使用 `"startupProbe"` æ�¥ç¡®ä¿�Kubernetesä¸�会在你的应用程åº�å�¯åŠ¨è¿‡ç¨‹ä¸­æ�€æ­»å®ƒã€‚请å�‚阅æ��è¿°[探针在应用程åº�生命周期中的行为](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes.lifecycle)的部分。 | | --- | --- | -Èç¹ûÄãµÄActuator¶Ëµã±»²¿ÊðÔÚÒ»¸öµ¥¶ÀµÄ¹ÜÀíÉÏÏÂÎÄÖУ¬ÄÇôÕâЩ¶Ëµã¾Í²»»áÏñÖ÷³ÌÐòÄÇÑùʹÓÃÏàͬµÄÍøÂç»ù´¡ÉèÊ©£¨¶Ë¿Ú¡¢Á¬½Ó³Ø¡¢¿ò¼Ü×é¼þ£©¡£ ÔÚÕâÖÖÇé¿öÏ£¬¼´Ê¹Ö÷³ÌÐò²»ÄÜÕý³£¹¤×÷£¨ÀýÈ磬Ëü²»ÄܽÓÊÜеÄÁ¬½Ó£©£¬Ì½²â¼ì²éÒ²¿ÉÄܳɹ¦¡£ ÓÉÓÚÕâ¸öÔ­Òò£¬ÔÚÖ÷·þÎñÆ÷¶Ë¿ÚÉÏÉèÖà `liveness` ºÍ `readiness` ½¡¿µ×éÊǸöºÃÖ÷Òâ¡£ Õâ¿ÉÒÔͨ¹ýÉèÖÃÒÔÏÂÊôÐÔÀ´ÊµÏÖ¡£ +如果你的Actuator端点被部署在一个å�•独的管ç�†ä¸Šä¸‹æ–‡ä¸­ï¼Œé‚£ä¹ˆè¿™äº›ç«¯ç‚¹å°±ä¸�会åƒ�主程åº�那样使用相å�Œçš„网络基础设施(端å�£ã€�连接池ã€�框架组件)。 在这ç§�情况下,å�³ä½¿ä¸»ç¨‹åº�ä¸�能正常工作(例如,它ä¸�能接å�—新的连接),探测检查也å�¯èƒ½æˆ�功。 由于这个原因,在主æœ�务器端å�£ä¸Šè®¾ç½® `liveness` å’Œ `readiness` å�¥åº·ç»„是个好主æ„�。 è¿™å�¯ä»¥é€šè¿‡è®¾ç½®ä»¥ä¸‹å±žæ€§æ�¥å®žçŽ°ã€‚ @@ -1606,17 +1606,17 @@ management.endpoint.health.probes.add-additional-paths=true -Õ⽫ʹ `liveness` ÔÚ `/livez` ¿ÉÓã¬`readiness` ÔÚ `readyz` µÄÖ÷·þÎñÆ÷¶Ë¿Ú¿ÉÓᣠ+这将使 `liveness` 在 `/livez` å�¯ç”¨ï¼Œ`readiness` 在 `readyz` 的主æœ�务器端å�£å�¯ç”¨ã€‚ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes.external-state)2.9.1\. ÓÃKubernetes̽Õë¼ì²éÍⲿ״̬ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes.external-state)2.9.1\. 用Kubernetes探针检查外部状æ€� -Ö´ÐÐÆ÷½« ¡°liveness¡± ºÍ ¡°readiness¡± ̽ÕëÅäÖÃΪ½¡¿µ×é¡£ÕâÒâζ×ÅËùÓеÄ[½¡¿µ×éµÄ¹¦ÄÜ](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.groups)¶ÔËüÃǶ¼ÊÇ¿ÉÓõġ£ÀýÈ磬Äã¿ÉÒÔÅäÖöîÍâµÄ½¡¿µÖ¸±ê¡£ +执行器将 “livenessâ€� å’Œ “readinessâ€� 探针é…�置为å�¥åº·ç»„。这æ„�味ç�€æ‰€æœ‰çš„[å�¥åº·ç»„的功能](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.health.groups)对它们都是å�¯ç”¨çš„。例如,你å�¯ä»¥é…�ç½®é¢�外的å�¥åº·æŒ‡æ ‡ã€‚ @@ -1643,32 +1643,32 @@ management.endpoint.health.group.readiness.include=readinessState,customCheck -ĬÈÏÇé¿öÏ£¬Spring Boot²»»áÏòÕâЩ×éÌí¼ÓÆäËû½¡¿µÖ¸±ê¡£ +默认情况下,Spring Bootä¸�会å�‘这些组添加其他å�¥åº·æŒ‡æ ‡ã€‚ -¡°liveness¡± ̽Õë²»Ó¦¸ÃÒÀÀµÓÚÍⲿϵͳµÄ½¡¿µ¼ì²é¡£Èç¹û[Ó¦ÓóÌÐòµÄÓÐЧÐÔ״̬](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-availability.liveness)±»ÆÆ»µ£¬Kubernetes»á³¢ÊÔͨ¹ýÖØÐÂÆô¶¯Ó¦ÓóÌÐòʵÀýÀ´½â¾öÕâ¸öÎÊÌâ¡£ÕâÒâζ×Å£¬Èç¹ûÒ»¸öÍⲿϵͳ£¨ÈçÊý¾Ý¿â¡¢Web API»òÍⲿ»º´æ£©³öÏÖ¹ÊÕÏ£¬Kubernetes¿ÉÄÜ»áÖØÐÂÆô¶¯ËùÓÐÓ¦ÓóÌÐòʵÀý£¬²¢²úÉú¼¶Áª¹ÊÕÏ¡£ +“livenessâ€� 探针ä¸�应该ä¾�赖于外部系统的å�¥åº·æ£€æŸ¥ã€‚如果[应用程åº�的有效性状æ€�](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-availability.liveness)被破å��,Kubernetes会å°�试通过é‡�æ–°å�¯åŠ¨åº”ç”¨ç¨‹åº�实例æ�¥è§£å†³è¿™ä¸ªé—®é¢˜ã€‚è¿™æ„�味ç�€ï¼Œå¦‚果一个外部系统(如数æ�®åº“ã€�Web API或外部缓存)出现故障,Kuberneteså�¯èƒ½ä¼šé‡�æ–°å�¯åŠ¨æ‰€æœ‰åº”ç”¨ç¨‹åº�实例,并产生级è�”故障。 -ÖÁÓÚ ¡°readiness¡± ̽²â£¬¼ì²éÍⲿϵͳµÄÑ¡Ôñ±ØÐëÓÉÓ¦ÓóÌÐò¿ª·¢ÈËÔ±½÷É÷×÷³ö¡£³öÓÚÕâ¸öÔ­Òò£¬Spring BootÔÚ×¼±¸×´Ì¬Ì½²âÖв»°üÀ¨ÈκζîÍâµÄ½¡¿µ¼ì²é¡£Èç¹û[Ó¦ÓóÌÐòʵÀýµÄreadiness stateÊÇunready](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-availability.readiness)£¬Kubernetes¾Í²»»á½«Á÷Á¿Â·Óɵ½¸ÃʵÀý¡£Ò»Ð©Íⲿϵͳ¿ÉÄܲ»±»Ó¦ÓÃʵÀýËù¹²Ïí£¬ÔÚÕâÖÖÇé¿öÏ£¬ËüÃÇ¿ÉÒÔ±»°üÀ¨ÔÚ×¼±¸×´Ì¬Ì½²âÖС£ÆäËûÍⲿϵͳ¿ÉÄܲ»ÊÇÓ¦ÓóÌÐòµÄ¹Ø¼ü£¨Ó¦ÓóÌÐò¿ÉÄÜÓжÏ·Æ÷ºÍ»ØÍË£©£¬ÔÚÕâÖÖÇé¿öÏ£¬ËüÃǾø¶Ô²»Ó¦¸Ã±»°üÀ¨ÔÚÄÚ¡£²»ÐÒµÄÊÇ£¬Ò»¸ö±»ËùÓÐÓ¦ÓÃʵÀý¹²ÏíµÄÍⲿϵͳºÜ³£¼û£¬Äã±ØÐë×ö³öÅжϡ£°ÑËü°üÀ¨ÔÚ×¼±¸¾ÍÐ÷̽ÕëÖУ¬²¢ÆÚÍûµ±Íⲿ·þÎñ·¢Éú¹ÊÕÏʱ£¬Ó¦ÓóÌÐò»á±»Í£Ö¹·þÎñ£¬»òÕß²»°üÀ¨Ëü£¬²¢´¦Àí¶ÑÕ»Öиü¸ß²ã´ÎµÄ¹ÊÕÏ£¬Ò²Ðíͨ¹ýÔÚµ÷ÓÃÕßÖÐʹÓöÏ·Æ÷¡£ +至于 “readinessâ€� 探测,检查外部系统的选择必须由应用程åº�å¼€å�‘人员谨慎作出。出于这个原因,Spring Boot在准备状æ€�探测中ä¸�包括任何é¢�外的å�¥åº·æ£€æŸ¥ã€‚如果[应用程åº�实例的readiness state是unready](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-availability.readiness),Kuberneteså°±ä¸�会将æµ�é‡�路由到该实例。一些外部系统å�¯èƒ½ä¸�被应用实例所共享,在这ç§�情况下,它们å�¯ä»¥è¢«åŒ…括在准备状æ€�探测中。其他外部系统å�¯èƒ½ä¸�是应用程åº�的关键(应用程åº�å�¯èƒ½æœ‰æ–­è·¯å™¨å’Œå›žé€€ï¼‰ï¼Œåœ¨è¿™ç§�情况下,它们ç»�对ä¸�应该被包括在内。ä¸�幸的是,一个被所有应用实例共享的外部系统很常è§�,你必须å�šå‡ºåˆ¤æ–­ã€‚把它包括在准备就绪探针中,并期望当外部æœ�务å�‘生故障时,应用程åº�会被å�œæ­¢æœ�务,或者ä¸�包括它,并处ç�†å †æ ˆä¸­æ›´é«˜å±‚次的故障,也许通过在调用者中使用断路器。 -| | Èç¹ûÒ»¸öÓ¦ÓóÌÐòµÄËùÓÐʵÀý¶¼Ã»ÓÐ×¼±¸ºÃ£¬`type=ClusterIP` »ò `NodePort` µÄKubernetes·þÎñ²»½ÓÊÜÈκδ«ÈëÁ¬½Ó¡£Ã»ÓÐHTTP´íÎóÏìÓ¦£¨503µÈ£©£¬ÒòΪûÓÐÁ¬½Ó¡£`type=LoadBalancer` µÄ·þÎñ¿ÉÄܽÓÊÜÒ²¿ÉÄܲ»½ÓÊÜÁ¬½Ó£¬ÕâÈ¡¾öÓÚÌṩÕß¡£Ò»¸öÓÐÃ÷È· [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) µÄ·þÎñÒ²»áÒÔÒ»ÖÖÈ¡¾öÓÚʵÏֵķ½Ê½½øÐÐÏìÓ¦¡ª?Èë¿Ú·þÎñ±¾Éí±ØÐë¾ö¶¨ÈçºÎ´¦ÀíÀ´×ÔÏÂÓ뵀 ¡°connection refused¡±¡£ÔÚ¸ºÔؾùºâÆ÷ºÍÈë¿ÚµÄÇé¿öÏ£¬HTTP 503ÊǺÜÓпÉÄܵġ£ | +| | 如果一个应用程åº�的所有实例都没有准备好,`type=ClusterIP` 或 `NodePort` çš„Kubernetesæœ�务ä¸�接å�—任何传入连接。没有HTTP错误å“�应(503等),因为没有连接。`type=LoadBalancer` çš„æœ�务å�¯èƒ½æŽ¥å�—也å�¯èƒ½ä¸�接å�—连接,这å�–决于æ��供者。一个有明确 [ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) çš„æœ�务也会以一ç§�å�–决于实现的方å¼�进行å“�应—?å…¥å�£æœ�务本身必须决定如何处ç�†æ�¥è‡ªä¸‹æ¸¸çš„ “connection refusedâ€�。在负载å�‡è¡¡å™¨å’Œå…¥å�£çš„æƒ…况下,HTTP 503是很有å�¯èƒ½çš„。 | | --- | --- | -ÁíÍ⣬Èç¹ûÒ»¸öÓ¦ÓóÌÐòʹÓà Kubernetes [autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)£¬Ëü¿ÉÄÜ»á¶ÔÓ¦ÓóÌÐò±»´Ó¸ºÔØÆ½ºâÆ÷ÖÐÈ¡³ö×ö³ö²»Í¬µÄ·´Ó¦£¬ÕâÈ¡¾öÓÚÆäautoscalerµÄÅäÖᣠ+å�¦å¤–,如果一个应用程åº�使用 Kubernetes [autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/),它å�¯èƒ½ä¼šå¯¹åº”用程åº�被从负载平衡器中å�–出å�šå‡ºä¸�å�Œçš„å��应,这å�–决于其autoscalerçš„é…�置。 @@ -1676,55 +1676,55 @@ management.endpoint.health.group.readiness.include=readinessState,customCheck -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes.lifecycle)2.9.2\. Ó¦ÓóÌÐòÉúÃüÖÜÆÚºÍ̽Õë״̬ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.kubernetes-probes.lifecycle)2.9.2\. 应用程åº�生命周期和探针状æ€� -Kubernetes ProbesÖ§³ÖµÄÒ»¸öÖØÒª·½ÃæÊÇËüÓëÓ¦ÓóÌÐòÉúÃüÖÜÆÚµÄÒ»ÖÂÐÔ¡£ `AvailabilityState`£¨¼´Ó¦ÓóÌÐòµÄÄÚ´æÄÚ²¿×´Ì¬£©ºÍʵ¼ÊµÄ̽Õ루±©Â¶¸Ã״̬£©Ö®¼ä´æÔÚ×ÅÏÔÖøµÄÇø±ð¡£ ºÍʵ¼ÊµÄ̽Õ루±©Â¶Á˸Ã״̬£©Ö®¼äÓкܴóµÄÇø±ð¡£ ¸ù¾ÝÓ¦ÓóÌÐòÉúÃüÖÜÆÚµÄ²»Í¬½×¶Î£¬Ì½Õë¿ÉÄÜÎÞ·¨Ê¹Óᣠ+Kubernetes Probes支æŒ�的一个é‡�è¦�æ–¹é�¢æ˜¯å®ƒä¸Žåº”用程åº�生命周期的一致性。 `AvailabilityState`(å�³åº”用程åº�的内存内部状æ€�)和实际的探针(暴露该状æ€�)之间存在ç�€æ˜¾è‘—的区别。 和实际的探针(暴露了该状æ€�)之间有很大的区别。 æ ¹æ�®åº”用程åº�生命周期的ä¸�å�Œé˜¶æ®µï¼ŒæŽ¢é’ˆå�¯èƒ½æ— æ³•使用。 -Spring BootÔÚ[Æô¶¯ºÍ¹Ø±ÕÆÚ¼ä·¢²¼application event](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-events-and-listeners)£¬Ì½Õë¿ÉÒÔ¼àÌýÕâЩʼþ²¢±©Â¶³ö `AvailabilityState` ÐÅÏ¢¡£ +Spring Boot在[å�¯åŠ¨å’Œå…³é—­æœŸé—´å�‘布application event](https://springdoc.cn/spring-boot/features.html#features.spring-application.application-events-and-listeners),探针å�¯ä»¥ç›‘å�¬è¿™äº›äº‹ä»¶å¹¶æš´éœ²å‡º `AvailabilityState` ä¿¡æ�¯ã€‚ -ϱíÏÔʾÁ˲»Í¬½×¶ÎµÄ `AvailabilityState` ºÍHTTP connectorµÄ״̬¡£ +下表显示了ä¸�å�Œé˜¶æ®µçš„ `AvailabilityState` å’ŒHTTP connector的状æ€�。 -µ±Ò»¸öSpring BootÓ¦ÓóÌÐòÆô¶¯Ê±¡£ +当一个Spring Boot应用程åº�å�¯åŠ¨æ—¶ã€‚ -| Æô¶¯½×¶Î | LivenessState | ReadinessState | HTTP server | ±¸×¢ | +| å�¯åŠ¨é˜¶æ®µ | LivenessState | ReadinessState | HTTP server | 备注 | | --- | --- | --- | --- | --- | -| Starting | `BROKEN` | `REFUSING_TRAFFIC` | δÆô¶¯ | Kubernetes¼ì²é "liveness" ̽Õ룬Èç¹ûʱ¼ä¹ý³¤£¬¾ÍÖØÐÂÆô¶¯Ó¦ÓóÌÐò¡£ | -| Started | `CORRECT` | `REFUSING_TRAFFIC` | ¾Ü¾øÇëÇó | Ó¦ÓóÌÐòÉÏÏÂÎı»Ë¢Ð¡£Ó¦ÓóÌÐòÖ´ÐÐÆô¶¯ÈÎÎñ£¬»¹Ã»ÓÐÊÕµ½Á÷Á¿¡£ | -| Ready | `CORRECT` | `ACCEPTING_TRAFFIC` | ½ÓÊÜÇëÇó | Æô¶¯ÈÎÎñÒѾ­Íê³É¡£¸ÃÓ¦ÓóÌÐòÕýÔÚ½ÓÊÕÁ÷Á¿¡£ | +| Starting | `BROKEN` | `REFUSING_TRAFFIC` | 未å�¯åЍ | Kubernetes检查 "liveness" 探针,如果时间过长,就é‡�æ–°å�¯åŠ¨åº”ç”¨ç¨‹åº�。 | +| Started | `CORRECT` | `REFUSING_TRAFFIC` | æ‹’ç»�请求 | 应用程åº�上下文被刷新。应用程åº�执行å�¯åŠ¨ä»»åŠ¡ï¼Œè¿˜æ²¡æœ‰æ”¶åˆ°æµ�é‡�。 | +| Ready | `CORRECT` | `ACCEPTING_TRAFFIC` | 接å�—请求 | å�¯åŠ¨ä»»åŠ¡å·²ç»�完æˆ�。该应用程åº�正在接收æµ�é‡�。 | -µ±Ò»¸öSpring BootÓ¦ÓóÌÐò¹Ø±Õʱ¡£ +当一个Spring Boot应用程åº�关闭时。 -| Í£»ú½×¶Î | Liveness State | Readiness State | HTTP server | ±¸×¢ | +| å�œæœºé˜¶æ®µ | Liveness State | Readiness State | HTTP server | 备注 | | --- | --- | --- | --- | --- | -| Running | `CORRECT` | `ACCEPTING_TRAFFIC` | ½ÓÊÜÇëÇó | ÒÑÒªÇ󹨱ա£ | -| Graceful shutdown | `CORRECT` | `REFUSING_TRAFFIC` | еÄÇëÇ󱻾ܾø | Èç¹ûÆôÓ㬠[ÓÅÑŹػú»á´¦Àí¡°´¦ÀíÖС±µÄÇëÇó](https://springdoc.cn/spring-boot/web.html#web.graceful-shutdown)¡£ | -| Shutdown complete | N/A | N/A | ·þÎñÆ÷±»¹Ø±Õ | Ó¦ÓóÌÐòÉÏÏÂÎı»¹Ø±Õ£¬Ó¦ÓóÌÐò±»¹Ø±Õ¡£ | +| Running | `CORRECT` | `ACCEPTING_TRAFFIC` | 接å�—请求 | å·²è¦�求关闭。 | +| Graceful shutdown | `CORRECT` | `REFUSING_TRAFFIC` | 新的请求被拒ç»� | 如果å�¯ç”¨ï¼Œ [优雅关机会处ç�†â€œå¤„ç�†ä¸­â€�的请求](https://springdoc.cn/spring-boot/web.html#web.graceful-shutdown)。 | +| Shutdown complete | N/A | N/A | æœ�务器被关闭 | 应用程åº�上下文被关闭,应用程åº�被关闭。 | -| | ¹ØÓÚKubernetes²¿ÊðµÄ¸ü¶àÐÅÏ¢£¬Çë²Î¼û[KubernetesÈÝÆ÷ÉúÃüÖÜÆÚ](https://springdoc.cn/spring-boot/deployment.html#deployment.cloud.kubernetes.container-lifecycle)²¿·Ö¡£ | +| | 关于Kubernetes部署的更多信æ�¯ï¼Œè¯·å�‚è§�[Kubernetes容器生命周期](https://springdoc.cn/spring-boot/deployment.html#deployment.cloud.kubernetes.container-lifecycle)部分。 | | --- | --- | @@ -1735,48 +1735,48 @@ Spring Boot -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info)2.10\. Ó¦ÓÃÐÅÏ¢ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info)2.10\. 应用信æ�¯ -Ó¦ÓóÌÐòÐÅÏ¢¹«¿ªÁË´ÓÄãµÄ `ApplicationContext` Öж¨ÒåµÄËùÓÐ [`InfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/InfoContributor.java) BeanÊÕ¼¯µÄ¸÷ÖÖÐÅÏ¢¡£ Spring Boot°üÀ¨Ò»Ð©×Ô¶¯ÅäÖÃµÄ `InfoContributor` Bean£¬ÄãÒ²¿ÉÒÔ±àд×Ô¼ºµÄ¡£ +应用程åº�ä¿¡æ�¯å…¬å¼€äº†ä»Žä½ çš„ `ApplicationContext` 中定义的所有 [`InfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/InfoContributor.java) Bean收集的å�„ç§�ä¿¡æ�¯ã€‚ Spring Boot包括一些自动é…�置的 `InfoContributor` Bean,你也å�¯ä»¥ç¼–写自己的。 -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.auto-configured-info-contributors)2.10.1\. ×Ô¶¯ÅäÖÃµÄ InfoContributor +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.auto-configured-info-contributors)2.10.1\. 自动é…�置的 InfoContributor -ÔÚÊʵ±µÄʱºò£¬Spring»á×Ô¶¯ÅäÖÃÒÔÏ `InfoContributor` Bean¡£ +在适当的时候,Spring会自动é…�置以下 `InfoContributor` Bean。 -| ID | Name | ˵Ã÷ | ǰÌáÌõ¼þ | +| ID | Name | 说明 | å‰�æ��æ�¡ä»¶ | | --- | --- | --- | --- | -| `build` | [`BuildInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/BuildInfoContributor.java) | ±©Â¶Á˹¹½¨ÐÅÏ¢¡£ | Ò»¸ö `META-INF/build-info.properties` ×ÊÔ´¡£ | -| `env` | [`EnvironmentInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/EnvironmentInfoContributor.java) | ±©Â¶ `Environment` ÖÐÃû³ÆÒÔ `info.` ¿ªÍ·µÄÈκÎÊôÐÔ¡£ | None. | -| `git` | [`GitInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/GitInfoContributor.java) | ±©Â¶ÁËgitÐÅÏ¢¡£ | Ò»¸ö `git.properties` ×ÊÔ´¡£ | -| `java` | [`JavaInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/JavaInfoContributor.java) | ±©Â¶JavaÔËÐÐʱ£¨Runtime£©ÐÅÏ¢¡£ | None. | -| `os` | [`OsInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/OsInfoContributor.java) | ±©Â¶²Ù×÷ϵͳÐÅÏ¢¡£ | None. | +| `build` | [`BuildInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/BuildInfoContributor.java) | 暴露了构建信æ�¯ã€‚ | 一个 `META-INF/build-info.properties` 资æº�。 | +| `env` | [`EnvironmentInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/EnvironmentInfoContributor.java) | 暴露 `Environment` 中å��称以 `info.` 开头的任何属性。 | None. | +| `git` | [`GitInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/GitInfoContributor.java) | 暴露了gitä¿¡æ�¯ã€‚ | 一个 `git.properties` 资æº�。 | +| `java` | [`JavaInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/JavaInfoContributor.java) | 暴露Javaè¿�行时(Runtime)信æ�¯ã€‚ | None. | +| `os` | [`OsInfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/OsInfoContributor.java) | 暴露æ“�作系统信æ�¯ã€‚ | None. | -¸öÈ˹±Ï×Õߣ¨contributor£©ÊÇ·ñ±»ÆôÓÃÊÇÓÉÆä `management.info..enabled` ÊôÐÔ¿ØÖÆ¡£ ²»Í¬µÄcontributor¶ÔÕâ¸öÊôÐÔÓв»Í¬µÄĬÈÏÖµ£¬ÕâÈ¡¾öÓÚËûÃǵÄÏȾöÌõ¼þºÍËûÃÇËù±©Â¶µÄÐÅÏ¢µÄÐÔÖÊ¡£ +个人贡献者(contributor)是å�¦è¢«å�¯ç”¨æ˜¯ç”±å…¶ `management.info..enabled` 属性控制。 ä¸�å�Œçš„contributor对这个属性有ä¸�å�Œçš„默认值,这å�–决于他们的先决æ�¡ä»¶å’Œä»–们所暴露的信æ�¯çš„æ€§è´¨ã€‚ -ÓÉÓÚûÓÐÏȾöÌõ¼þ±íÃ÷ËüÃÇÓ¦¸Ã±»ÆôÓã¬`env`¡¢`java` ºÍ `os` contributor ĬÈÏÊǽûÓõġ£ ¿ÉÒÔͨ¹ýÉèÖà `management.info..enabled` ÊôÐÔΪ `true` À´ÆôÓÃËüÃÇ¡£ +由于没有先决æ�¡ä»¶è¡¨æ˜Žå®ƒä»¬åº”该被å�¯ç”¨ï¼Œ`env`ã€�`java` å’Œ `os` contributor 默认是ç¦�用的。 å�¯ä»¥é€šè¿‡è®¾ç½® `management.info..enabled` 属性为 `true` æ�¥å�¯ç”¨å®ƒä»¬ã€‚ -`build` ºÍ `git` ÐÅÏ¢contributorĬÈÏÊÇÆôÓõġ£ ¿ÉÒÔͨ¹ý½«Æä `management.info..enabled` ÊôÐÔÉèÖÃΪ `false` À´½ûÓᣠÁíÍ⣬Ҫ½ûÓÃÿһ¸öĬÈÏÆôÓõÄcontributor£¬Ç뽫 `management.info.defaults.enabled` ÊôÐÔÉèΪ `false`¡£ +`build` å’Œ `git` ä¿¡æ�¯contributor默认是å�¯ç”¨çš„。 å�¯ä»¥é€šè¿‡å°†å…¶ `management.info..enabled` 属性设置为 `false` æ�¥ç¦�用。 å�¦å¤–,è¦�ç¦�用æ¯�一个默认å�¯ç”¨çš„contributor,请将 `management.info.defaults.enabled` 属性设为 `false`。 @@ -1784,11 +1784,11 @@ Spring Boot -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.custom-application-information)2.10.2\. ×Ô¶¨ÒåÓ¦ÓÃÐÅÏ¢£¨Application Information£© +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.custom-application-information)2.10.2\. 自定义应用信æ�¯ï¼ˆApplication Information) -µ± `env` contributor ±»ÆôÓÃʱ£¬Äã¿ÉÒÔͨ¹ýÉèÖà `info.*` SpringÊôÐÔÀ´¶¨ÖÆ `info` ¶ËµãËù±©Â¶µÄÊý¾Ý¡£ `info` keyϵÄËùÓÐ `Environment` ÊôÐÔ¶¼»á×Ô¶¯±©Â¶¡£ ÀýÈ磬Äã¿ÉÒÔÔÚÄãµÄ `application.properties` ÎļþÖÐÌí¼ÓÒÔÏÂÉèÖᣠ+当 `env` contributor 被å�¯ç”¨æ—¶ï¼Œä½ å�¯ä»¥é€šè¿‡è®¾ç½® `info.*` Spring属性æ�¥å®šåˆ¶ `info` 端点所暴露的数æ�®ã€‚ `info` key下的所有 `Environment` 属性都会自动暴露。 例如,你å�¯ä»¥åœ¨ä½ çš„ `application.properties` 文件中添加以下设置。 @@ -1817,7 +1817,7 @@ info.app.java.target=17 -| | ÓëÆäÓ²±àÂëÕâЩֵ£¬Ä㻹¿ÉÒÔ [ÔÚ¹¹½¨Ê±À©Õ¹ÐÅÏ¢ÊôÐÔ](https://springdoc.cn/spring-boot/howto.html#howto.properties-and-configuration.expand-properties)¡£¼ÙÉèÄãʹÓÃMaven£¬Äã¿ÉÒÔ½«Ç°ÃæµÄÀý×Ó¸ÄдÈçÏ¡£PropertiesYaml```info.app.encoding=@project.build.sourceEncoding@info.app.java.source=@java.version@info.app.java.target=@java.version@``` | +| | 与其硬编ç �这些值,你还å�¯ä»¥ [在构建时扩展信æ�¯å±žæ€§](https://springdoc.cn/spring-boot/howto.html#howto.properties-and-configuration.expand-properties)。å�‡è®¾ä½ ä½¿ç”¨Maven,你å�¯ä»¥å°†å‰�é�¢çš„例å­�改写如下。PropertiesYaml```info.app.encoding=@project.build.sourceEncoding@info.app.java.source=@java.version@info.app.java.target=@java.version@``` | | --- | --- | @@ -1826,24 +1826,24 @@ info.app.java.target=17 -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.git-commit-information)2.10.3\. Git Commit ÐÅÏ¢ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.git-commit-information)2.10.3\. Git Commit ä¿¡æ�¯ -`info` ¶ËµãµÄÁíÒ»¸öÓÐÓõŦÄÜÊÇËüÄܹ»·¢²¼¹ØÓÚÄãµÄ `git` Ô´´úÂë¿âÔÚÏîÄ¿½¨Á¢Ê±µÄ״̬µÄÐÅÏ¢¡£ Èç¹ûÓÐÒ»¸ö `GitProperties` bean£¬Äã¿ÉÒÔʹÓà `info` ¶ËµãÀ´¹«²¼ÕâЩÊôÐÔ¡£ +`info` 端点的å�¦ä¸€ä¸ªæœ‰ç”¨çš„功能是它能够å�‘布关于你的 `git` æº�代ç �库在项目建立时的状æ€�的信æ�¯ã€‚ 如果有一个 `GitProperties` bean,你å�¯ä»¥ä½¿ç”¨ `info` 端点æ�¥å…¬å¸ƒè¿™äº›å±žæ€§ã€‚ -| | Èç¹ûclasspathµÄ¸ù²¿ÓÐ `git.properties` Îļþ£¬`GitProperties` Bean¾Í»á±»×Ô¶¯ÅäÖ᣸ü¶àϸ½Ú¼û "[ÈçºÎÉú³ÉgitÐÅÏ¢](https://springdoc.cn/spring-boot/howto.html#howto.build.generate-git-info)"¡£ | +| | 如果classpath的根部有 `git.properties` 文件,`GitProperties` Bean就会被自动é…�置。更多细节è§� "[如何生æˆ�gitä¿¡æ�¯](https://springdoc.cn/spring-boot/howto.html#howto.build.generate-git-info)"。 | | --- | --- | -ĬÈÏÇé¿öÏ£¬¶Ëµã»á±©Â¶ `git.branch`¡¢`git.commit.id` ºÍ `git.commit.time` ÊôÐÔ£¨Èç¹û´æÔÚ£©¡£ Èç¹ûÄã²»ÏëÈÃÕâЩÊôÐÔ³öÏÖÔڶ˵ãÏìÓ¦ÖУ¬ÐèÒª´Ó `git.properties` ÎļþÖÐÅųýËüÃÇ¡£ Èç¹ûÄãÏëÏÔʾÍêÕûµÄgitÐÅÏ¢£¨¼´ `git.properties` µÄÈ«²¿ÄÚÈÝ£©£¬Ê¹Óà `management.info.git.mode` ÊôÐÔ£¬ÈçÏÂËùʾ¡£ +默认情况下,端点会暴露 `git.branch`ã€�`git.commit.id` å’Œ `git.commit.time` 属性(如果存在)。 如果你ä¸�想让这些属性出现在端点å“�应中,需è¦�从 `git.properties` 文件中排除它们。 如果你想显示完整的gitä¿¡æ�¯ï¼ˆå�³ `git.properties` 的全部内容),使用 `management.info.git.mode` 属性,如下所示。 @@ -1870,7 +1870,7 @@ management.info.git.mode=full -Òª´Ó `info` ¶ËµãÍêÈ«½ûÓÃgitÌá½»ÐÅÏ¢£¬Çë `management.info.git.enabled` ÊôÐÔÉèΪ `false`£¬ÈçÏÂËùʾ¡£ +è¦�从 `info` 端点完全ç¦�用gitæ��交信æ�¯ï¼Œè¯· `management.info.git.enabled` 属性设为 `false`,如下所示。 @@ -1899,17 +1899,17 @@ management.info.git.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.build-information)2.10.4\. ¹¹½¨ÐÅÏ¢ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.build-information)2.10.4\. 构建信æ�¯ -Èç¹û `BuildProperties` BeanÊÇ¿ÉÓõģ¬`info` ¶ËµãÒ²¿ÉÒÔ·¢²¼¹ØÓÚÄãµÄ¹¹½¨ÐÅÏ¢¡£Èç¹ûclasspathÖÐµÄ `META-INF/build-info.properties` Îļþ¿ÉÓ㬾ͻᷢÉúÕâÖÖÇé¿ö¡£ +如果 `BuildProperties` Bean是å�¯ç”¨çš„,`info` 端点也å�¯ä»¥å�‘布关于你的构建信æ�¯ã€‚如果classpath中的 `META-INF/build-info.properties` 文件å�¯ç”¨ï¼Œå°±ä¼šå�‘生这ç§�情况。 -| | MavenºÍGradle²å¼þ¶¼¿ÉÒÔÉú³É¸ÃÎļþ¡£Ïê¼û "[ÈçºÎÉú³É¹¹½¨ÐÅÏ¢](https://springdoc.cn/spring-boot/howto.html#howto.build.generate-info)"¡£ | +| | Mavenå’ŒGradleæ�’件都å�¯ä»¥ç”Ÿæˆ�该文件。详è§� "[如何生æˆ�构建信æ�¯](https://springdoc.cn/spring-boot/howto.html#howto.build.generate-info)"。 | | --- | --- | @@ -1918,11 +1918,11 @@ management.info.git.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.java-information)2.10.5\. JavaÐÅÏ¢ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.java-information)2.10.5\. Javaä¿¡æ�¯ -`info` ¶Ëµã·¢²¼Á˹ØÓÚÄãµÄJavaÔËÐл·¾³µÄÐÅÏ¢£¬¸ü¶àϸ½Ú¼û [`JavaInfo`](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/info/JavaInfo.html)¡£ +`info` 端点å�‘布了关于你的Javaè¿�行环境的信æ�¯ï¼Œæ›´å¤šç»†èŠ‚è§� [`JavaInfo`](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/info/JavaInfo.html)。 @@ -1930,11 +1930,11 @@ management.info.git.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.os-information)2.10.6\. ²Ù×÷ϵͳ£¨OS£©ÐÅÏ¢ +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.os-information)2.10.6\. æ“�作系统(OS)信æ�¯ -`info` ¶Ëµã·¢²¼¹ØÓÚÄãµÄ²Ù×÷ϵͳµÄÐÅÏ¢£¬¸ü¶àϸ½Ú¼û [`OsInfo`](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/info/OsInfo.html)`¡£ +`info` 端点å�‘布关于你的æ“�作系统的信æ�¯ï¼Œæ›´å¤šç»†èŠ‚è§� [`OsInfo`](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/info/OsInfo.html)`。 @@ -1942,17 +1942,17 @@ management.info.git.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.writing-custom-info-contributors)2.10.7\. ±àд×Ô¶¨Òå InfoContributor +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.info.writing-custom-info-contributors)2.10.7\. 编写自定义 InfoContributor -ΪÁËÌṩ×Ô¶¨ÒåµÄÓ¦ÓóÌÐòÐÅÏ¢£¬Äã¿ÉÒÔ×¢²áʵÏÖ [`InfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/InfoContributor.java) ½Ó¿ÚµÄSpring Bean¡£ +为了æ��供自定义的应用程åº�ä¿¡æ�¯ï¼Œä½ å�¯ä»¥æ³¨å†Œå®žçް [`InfoContributor`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/info/InfoContributor.java) 接å�£çš„Spring Bean。 -ÏÂÃæµÄÀý×Ó¹±Ï×ÁËÒ»¸öÖ»ÓÐÒ»¸öÖµµÄ `example` ÌõÄ¿¡£ +下é�¢çš„例å­�贡献了一个å�ªæœ‰ä¸€ä¸ªå€¼çš„ `example` æ�¡ç›®ã€‚ @@ -1987,7 +1987,7 @@ public class MyInfoContributor implements InfoContributor { -Èç¹ûÄãÇëÇó `info` ¶Ëµã£¬ÄãÓ¦¸Ã¿´µ½Ò»¸ö°üº¬ÒÔ϶îÍâÌõÄ¿µÄÏìÓ¦¡£ +如果你请求 `info` 端点,你应该看到一个包å�«ä»¥ä¸‹é¢�外æ�¡ç›®çš„å“�应。 @@ -2017,37 +2017,37 @@ public class MyInfoContributor implements InfoContributor { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring)3\. ͨ¹ýHTTP½øÐÐ¼à¿ØºÍ¹ÜÀí +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring)3\. 通过HTTP进行监控和管ç�† -Èç¹ûÄãÕýÔÚ¿ª·¢Ò»¸öWebÓ¦ÓóÌÐò£¬Spring Boot Actuator»á×Ô¶¯ÅäÖÃËùÓÐÆôÓõĶ˵㣬ʹÆäͨ¹ýHTTP¹«¿ª¡£ ĬÈϵĹßÀýÊÇʹÓö˵ãµÄ `id` ºÍ `/actuator` µÄǰ׺×÷ΪURL·¾¶¡£ ÀýÈ磬`health` ÒÔ `/actuator/health` µÄÐÎʽ¹«¿ª¡£ +如果你正在开å�‘一个Web应用程åº�,Spring Boot Actuator会自动é…�置所有å�¯ç”¨çš„端点,使其通过HTTP公开。 默认的惯例是使用端点的 `id` å’Œ `/actuator` çš„å‰�缀作为URL路径。 例如,`health` 以 `/actuator/health` 的形å¼�公开。 -| | Actuator Ö§³Ö Spring MVC¡¢Spring WebFluxºÍJersey¡£ Èç¹ûJerseyºÍSpring MVC¶¼¿ÉÓã¬Ôò»áʹÓÃSpring MVC¡£ | +| | Actuator 支æŒ� Spring MVCã€�Spring WebFluxå’ŒJersey。 如果Jerseyå’ŒSpring MVC都å�¯ç”¨ï¼Œåˆ™ä¼šä½¿ç”¨Spring MVC。 | | --- | --- | -| | ΪÁË»ñµÃAPIÎĵµ£¨ [HTML](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/htmlsingle) »ò [PDF](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/pdf/spring-boot-actuator-web-api.pdf) £©ÖмÇÔØµÄÕýÈ·µÄJSONÏìÓ¦£¬JacksonÊÇÒ»¸ö±ØÒªµÄÒÀÀµ¡£ | +| | 为了获得API文档( [HTML](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/htmlsingle) 或 [PDF](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/actuator-api/pdf/spring-boot-actuator-web-api.pdf) )中记载的正确的JSONå“�应,Jackson是一个必è¦�çš„ä¾�赖。 | | --- | --- | -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-context-path)3.1\. ¶¨ÖƹÜÀí¶Ëµã·¾¶ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-context-path)3.1\. 定制管ç�†ç«¯ç‚¹è·¯å¾„ -ÓÐʱ£¬Îª¹ÜÀí¶Ëµã¶¨ÖÆÇ°×ºÊǺÜÓÐÓõġ£ ÀýÈ磬ÄãµÄÓ¦ÓóÌÐò¿ÉÄÜÒѾ­½« `/actuator` ÓÃÓÚÆäËûÄ¿µÄ¡£ Äã¿ÉÒÔʹÓà `management.endpoints.web.base-path` ÊôÐÔÀ´¸Ä±ä¹ÜÀí¶ËµãµÄǰ׺£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +有时,为管ç�†ç«¯ç‚¹å®šåˆ¶å‰�缀是很有用的。 例如,你的应用程åº�å�¯èƒ½å·²ç»�å°† `/actuator` 用于其他目的。 ä½ å�¯ä»¥ä½¿ç”¨ `management.endpoints.web.base-path` 属性æ�¥æ”¹å�˜ç®¡ç�†ç«¯ç‚¹çš„å‰�缀,如下é�¢çš„例å­�所示。 @@ -2074,26 +2074,26 @@ management.endpoints.web.base-path=/manage -Ç°ÃæµÄ `application.properties` Àý×Ó½«¶Ëµã´Ó `/actuator/{id}` ¸ÄΪ `/manage/{id}` £¨ÀýÈ磬`/manage/info`£©¡£ +å‰�é�¢çš„ `application.properties` 例å­�将端点从 `/actuator/{id}` 改为 `/manage/{id}` (例如,`/manage/info`)。 -| | ³ý·Ç¹ÜÀí¶Ë¿Ú±»ÅäÖÃΪ[ʹÓò»Í¬µÄHTTP¶Ë¿Ú](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-port)À´±©Â¶¶Ëµã£¬·ñÔò `management.endpoints.web.base-path` ÊÇÏà¶ÔÓÚ `server.servlet.context-path` £¨ÓÃÓÚServlet WebÓ¦Óã©»ò `spring.webflux.base-path` £¨ÓÃÓÚreactive WebÓ¦Óã©¡£Èç¹ûÅäÖÃÁË `management.server.port`£¬ `management.endpoints.web.base-path` ÊÇÏà¶ÔÓÚ `management.server.base-path` µÄ¡£ | +| | 除é�žç®¡ç�†ç«¯å�£è¢«é…�置为[使用ä¸�å�Œçš„HTTP端å�£](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-port)æ�¥æš´éœ²ç«¯ç‚¹ï¼Œå�¦åˆ™ `management.endpoints.web.base-path` 是相对于 `server.servlet.context-path` (用于Servlet Web应用)或 `spring.webflux.base-path` (用于reactive Web应用)。如果é…�置了 `management.server.port`, `management.endpoints.web.base-path` 是相对于 `management.server.base-path` 的。 | | --- | --- | -Èç¹ûÄãÏë°Ñ¶ËµãÓ³Éäµ½²»Í¬µÄ·¾¶£¬Äã¿ÉÒÔʹÓà `management.endpoints.web.path-mapping` ÊôÐÔ¡£ +如果你想把端点映射到ä¸�å�Œçš„路径,你å�¯ä»¥ä½¿ç”¨ `management.endpoints.web.path-mapping` 属性。 -ÏÂÃæµÄÀý×Ó½« `/actuator/health` ÖØÐÂÓ³ÉäΪ `/healthcheck`¡£ +下é�¢çš„例å­�å°† `/actuator/health` é‡�新映射为 `/healthcheck`。 @@ -2123,17 +2123,17 @@ management.endpoints.web.path-mapping.health=healthcheck -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-port)3.2\. ¶¨ÖƹÜÀí·þÎñÆ÷¶Ë¿Ú +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-port)3.2\. 定制管ç�†æœ�务器端å�£ -¶ÔÓÚ»ùÓÚÔÆµÄ²¿ÊðÀ´Ëµ£¬Í¨¹ýʹÓÃĬÈϵÄHTTP¶Ë¿ÚÀ´±©Â¶¹ÜÀí¶ËµãÊÇÒ»¸öÃ÷ÖǵÄÑ¡Ôñ¡£ È»¶ø£¬Èç¹ûÄãµÄÓ¦ÓóÌÐòÔÚÄã×Ô¼ºµÄÊý¾ÝÖÐÐÄÄÚÔËÐУ¬Äã¿ÉÄܸüϲ»¶Ê¹Óò»Í¬µÄHTTP¶Ë¿ÚÀ´±©Â¶¶Ëµã¡£ +对于基于云的部署æ�¥è¯´ï¼Œé€šè¿‡ä½¿ç”¨é»˜è®¤çš„HTTP端å�£æ�¥æš´éœ²ç®¡ç�†ç«¯ç‚¹æ˜¯ä¸€ä¸ªæ˜Žæ™ºçš„选择。 然而,如果你的应用程åº�在你自己的数æ�®ä¸­å¿ƒå†…è¿�行,你å�¯èƒ½æ›´å–œæ¬¢ä½¿ç”¨ä¸�å�Œçš„HTTP端å�£æ�¥æš´éœ²ç«¯ç‚¹ã€‚ -Äã¿ÉÒÔÉèÖà `management.server.port` ÊôÐÔÀ´¸Ä±äHTTP¶Ë¿Ú£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +ä½ å�¯ä»¥è®¾ç½® `management.server.port` 属性æ�¥æ”¹å�˜HTTP端å�£ï¼Œå¦‚下é�¢çš„例å­�所示。 @@ -2160,7 +2160,7 @@ management.server.port=8081 -| | ÔÚ Cloud Foundry ÉÏ£¬Ä¬ÈÏÇé¿öÏ£¬Ó¦ÓóÌÐò½öÔÚ¶Ë¿Ú 8080 ÉϽÓÊÕ HTTP ºÍ TCP ·ÓɵÄÇëÇó¡£ Èç¹ûÄúÏëÔÚ Cloud Foundry ÉÏʹÓÃ×Ô¶¨Òå¹ÜÀí¶Ë¿Ú£¬ÄúÐèÒªÃ÷È·ÉèÖÃÓ¦ÓóÌÐòµÄ·ÓÉÒÔ½«Á÷Á¿×ª·¢µ½×Ô¶¨Òå¶Ë¿Ú¡£ | +| | 在 Cloud Foundry 上,默认情况下,应用程åº�仅在端å�£ 8080 上接收 HTTP å’Œ TCP 路由的请求。 如果您想在 Cloud Foundry 上使用自定义管ç�†ç«¯å�£ï¼Œæ‚¨éœ€è¦�明确设置应用程åº�的路由以将æµ�é‡�转å�‘到自定义端å�£ã€‚ | | --- | --- | @@ -2169,11 +2169,11 @@ management.server.port=8081 -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.management-specific-ssl)3.3\. ÅäÖÃÕë¶ÔManagement£¨¹ÜÀí£©²ãµÄSSL +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.management-specific-ssl)3.3\. é…�置针对Management(管ç�†ï¼‰å±‚çš„SSL -µ±ÅäÖÃΪʹÓÃ×Ô¶¨Òå¶Ë¿Úʱ£¬ÄãÒ²¿ÉÒÔͨ¹ýʹÓø÷ÖÖ `management.server.ssl.*` ÊôÐÔÀ´ÅäÖùÜÀí·þÎñÆ÷µÄSSL¡£ ÀýÈ磬ÕâÑù×ö¿ÉÒÔÈùÜÀí·þÎñÆ÷ͨ¹ýHTTPÌṩ·þÎñ£¬¶øÖ÷Ó¦ÓóÌÐòʹÓÃHTTPS£¬ÈçÒÔÏÂÊôÐÔÉèÖÃËùʾ¡£ +当é…�置为使用自定义端å�£æ—¶ï¼Œä½ ä¹Ÿå�¯ä»¥é€šè¿‡ä½¿ç”¨å�„ç§� `management.server.ssl.*` 属性æ�¥é…�置管ç�†æœ�务器的SSL。 例如,这样å�šå�¯ä»¥è®©ç®¡ç�†æœ�务器通过HTTPæ��ä¾›æœ�务,而主应用程åº�使用HTTPS,如以下属性设置所示。 @@ -2205,7 +2205,7 @@ management.server.ssl.enabled=false -»òÕߣ¬Ö÷·þÎñÆ÷ºÍ¹ÜÀí·þÎñÆ÷¶¼¿ÉÒÔʹÓÃSSL£¬µ«Ê¹Óò»Í¬µÄÃÜÔ¿´æ´¢£¬ÈçÏÂËùʾ¡£ +或者,主æœ�务器和管ç�†æœ�务器都å�¯ä»¥ä½¿ç”¨SSL,但使用ä¸�å�Œçš„密钥存储,如下所示。 @@ -2241,24 +2241,24 @@ management.server.ssl.key-password=secret -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-address)3.4\. ¶¨ÖÆManagement£¨¹ÜÀí£©·þÎñÆ÷µØÖ· +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.customizing-management-server-address)3.4\. 定制Management(管ç�†ï¼‰æœ�务器地å�€ -Äã¿ÉÒÔͨ¹ýÉèÖà `management.server.address` ÐÔÀ´¶¨ÖƹÜÀí¶ËµãµÄ¿ÉÓõØÖ·¡£ Èç¹ûÄãÏëÖ»ÔÚÄÚ²¿»òÃæÏòÔËάµÄÍøÂçÉϼàÌý£¬»òÕßÖ»¼àÌýÀ´×Ô `localhost` µÄÁ¬½Ó£¬ÕâÑù×ö»áºÜÓÐÓᣠ+ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.server.address` 性æ�¥å®šåˆ¶ç®¡ç�†ç«¯ç‚¹çš„å�¯ç”¨åœ°å�€ã€‚ 如果你想å�ªåœ¨å†…部或é�¢å�‘è¿�维的网络上监å�¬ï¼Œæˆ–者å�ªç›‘å�¬æ�¥è‡ª `localhost` 的连接,这样å�šä¼šå¾ˆæœ‰ç”¨ã€‚ -| | Ö»Óе±¶Ë¿ÚÓëÖ÷·þÎñÆ÷¶Ë¿Ú²»Í¬Ê±£¬Äã²ÅÄÜÔÚ²»Í¬µÄµØÖ·ÉϽøÐмàÌý¡£ | +| | å�ªæœ‰å½“端å�£ä¸Žä¸»æœ�务器端å�£ä¸�å�Œæ—¶ï¼Œä½ æ‰�能在ä¸�å�Œçš„地å�€ä¸Šè¿›è¡Œç›‘å�¬ã€‚ | | --- | --- | -ÏÂÃæµÄÀý×Ó `application.properties` ²»ÔÊÐíÔ¶³Ì¹ÜÀíÁ¬½Ó¡£ +下é�¢çš„例å­� `application.properties` ä¸�å…�许远程管ç�†è¿žæŽ¥ã€‚ @@ -2288,11 +2288,11 @@ management.server.address=127.0.0.1 -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.disabling-http-endpoints)3.5\. ½ûÓÃHTTP¶Ëµã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.monitoring.disabling-http-endpoints)3.5\. ç¦�用HTTP端点 -Èç¹ûÄã²»Ïëͨ¹ýHTTP±©Â¶¶Ëµã£¬Äã¿ÉÒ԰ѹÜÀí¶Ë¿ÚÉèÖÃΪ `-1`£¬ÈçÏÂÀýËùʾ¡£ +如果你ä¸�想通过HTTP暴露端点,你å�¯ä»¥æŠŠç®¡ç�†ç«¯å�£è®¾ç½®ä¸º `-1`,如下例所示。 @@ -2319,7 +2319,7 @@ management.server.port=-1 -ÄãÒ²¿ÉÒÔͨ¹ýʹÓà `management.endpoints.web.exposure.exclude` ÊôÐÔÀ´ÊµÏÖ£¬ÈçÏÂÀýËùʾ¡£ +你也å�¯ä»¥é€šè¿‡ä½¿ç”¨ `management.endpoints.web.exposure.exclude` 属性æ�¥å®žçŽ°ï¼Œå¦‚ä¸‹ä¾‹æ‰€ç¤ºã€‚ @@ -2352,53 +2352,53 @@ management.endpoints.web.exposure.exclude=* -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx)4\. ͨ¹ýJMX½øÐÐ¼à¿ØºÍ¹ÜÀí +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx)4\. 通过JMX进行监控和管ç�† -Java¹ÜÀíÀ©Õ¹£¨JMX£©ÌṩÁËÒ»¸ö±ê×¼µÄ»úÖÆÀ´¼à¿ØºÍ¹ÜÀíÓ¦ÓóÌÐò¡£ ĬÈÏÇé¿öÏ£¬¸Ã¹¦ÄÜδ±»ÆôÓᣠÄã¿ÉÒÔͨ¹ýÉèÖà `spring.jmx.enabled` ÅäÖÃÊôÐÔΪ `true` À´´ò¿ªËü¡£ Spring Boot½«×îºÏÊ浀 `MBeanServer` ×÷ΪIDΪ `mbeanServer` µÄBean¹«¿ª¡£ ÄãµÄÈκδøÓÐSpring JMX×¢½âµÄBean£¨`@ManagedResource`¡¢`@ManagedAttribute` »ò `@ManagedOperation`£©¶¼»á±©Â¶¸øËü¡£ +Java管ç�†æ‰©å±•(JMX)æ��供了一个标准的机制æ�¥ç›‘控和管ç�†åº”用程åº�。 默认情况下,该功能未被å�¯ç”¨ã€‚ ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `spring.jmx.enabled` é…�置属性为 `true` æ�¥æ‰“开它。 Spring Boot将最å�ˆé€‚çš„ `MBeanServer` 作为ID为 `mbeanServer` çš„Bean公开。 你的任何带有Spring JMX注解的Bean(`@ManagedResource`ã€�`@ManagedAttribute` 或 `@ManagedOperation`)都会暴露给它。 -Èç¹ûÄãµÄƽ̨ÌṩÁËÒ»¸ö±ê×¼µÄ `MBeanServer` £¬Spring Boot»áʹÓÃËü£¬²¢ÔÚ±ØÒªÊ±Ä¬ÈÏΪVM `MBeanServer`¡£ Èç¹ûËùÓÐÕâЩ¶¼Ê§°ÜÁË£¬¾Í»á´´½¨Ò»¸öÐ嵀 `MBeanServer`¡£ +如果你的平å�°æ��供了一个标准的 `MBeanServer` ,Spring Boot会使用它,并在必è¦�时默认为VM `MBeanServer`。 如果所有这些都失败了,就会创建一个新的 `MBeanServer`。 -¸ü¶àϸ½Ú¼û [`JmxAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java) Àà¡£ +更多细节è§� [`JmxAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/main/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java) 类。 -ĬÈÏÇé¿öÏ£¬Spring BootÒ²½«¹ÜÀí¶Ëµã×÷ΪJMX MBeansÔÚ `org.springframework.boot` ÓòϹ«¿ª¡£ ÒªÍêÈ«¿ØÖÆJMXÓòÖеĶ˵ã×¢²á£¬¿ÉÒÔ¿¼ÂÇ×¢²áÄã×Ô¼ºµÄ `EndpointObjectNameFactory` ʵÏÖ¡£ +默认情况下,Spring Boot也将管ç�†ç«¯ç‚¹ä½œä¸ºJMX MBeans在 `org.springframework.boot` 域下公开。 è¦�完全控制JMX域中的端点注册,å�¯ä»¥è€ƒè™‘注册你自己的 `EndpointObjectNameFactory` 实现。 -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx.custom-mbean-names)4.1\. ×Ô¶¨ÒåMBeanÃû³Æ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx.custom-mbean-names)4.1\. 自定义MBeanå��ç§° -MBeanµÄÃû×Öͨ³£Óɶ˵ãµÄ `id` Éú³É¡£ ÀýÈ磬 `health` ¶Ëµã±»±©Â¶Îª `org.springframework.boot:type=Endpoint,name=Health`¡£ +MBeançš„å��字通常由端点的 `id` 生æˆ�。 例如, `health` 端点被暴露为 `org.springframework.boot:type=Endpoint,name=Health`。 -Èç¹ûÄãµÄÓ¦ÓóÌÐò°üº¬Ò»¸öÒÔÉϵÄSpring `ApplicationContext`£¬Äã¿ÉÄܻᷢÏÖÃû×Ö·¢Éú³åÍ»¡£ ΪÁ˽â¾öÕâ¸öÎÊÌ⣬Äã¿ÉÒÔ½« `spring.jmx.unique-names` ÊôÐÔÉèÖÃΪ `true`£¬ÕâÑùMBeanµÄÃû×Ö¾Í×ÜÊÇΨһµÄ¡£ +如果你的应用程åº�包å�«ä¸€ä¸ªä»¥ä¸Šçš„Spring `ApplicationContext`,你å�¯èƒ½ä¼šå�‘现å��å­—å�‘生冲çª�。 为了解决这个问题,你å�¯ä»¥å°† `spring.jmx.unique-names` 属性设置为 `true`,这样MBeançš„å��字就总是唯一的。 -Ä㻹¿ÉÒÔ×Ô¶¨Ò屩¶¶ËµãµÄJMXÓò¡£ ÏÂÃæµÄÉèÖÃÏÔʾÁËÔÚ `application.properties` ÖÐÕâÑù×öµÄÒ»¸öÀý×Ó¡£ +你还å�¯ä»¥è‡ªå®šä¹‰æš´éœ²ç«¯ç‚¹çš„JMX域。 下é�¢çš„设置显示了在 `application.properties` 中这样å�šçš„一个例å­�。 @@ -2428,11 +2428,11 @@ management.endpoints.jmx.domain=com.example.myapp -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx.disable-jmx-endpoints)4.2\. ½ûÓÃJMX¶Ëµã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.jmx.disable-jmx-endpoints)4.2\. ç¦�用JMX端点 -Èç¹ûÄã²»Ïëͨ¹ýJMX±©Â¶¶Ëµã£¬Äã¿ÉÒÔ°Ñ `management.endpoints.jmx.exposure.exclude` ÊôÐÔÉèÖÃΪ `*`£¬ÈçÏÂÀýËùʾ¡£ +如果你ä¸�想通过JMX暴露端点,你å�¯ä»¥æŠŠ `management.endpoints.jmx.exposure.exclude` 属性设置为 `*`,如下例所示。 @@ -2465,19 +2465,19 @@ management.endpoints.jmx.exposure.exclude=* -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.observability)5\. ¿É¹Û²âÐÔ£¨Observability£© +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.observability)5\. å�¯è§‚测性(Observability) -¿É¹Û²ìÐÔÊÇÖ¸´ÓÍⲿ¹Û²ìÒ»¸öÔËÐÐÖеÄϵͳµÄÄÚ²¿×´Ì¬µÄÄÜÁ¦¡£ËüÓÉÈý¸öÖ§Öù×é³É£ºÈÕÖ¾¡¢¶ÈÁ¿ºÍ¸ú×Ù¡£ +å�¯è§‚察性是指从外部观察一个è¿�行中的系统的内部状æ€�的能力。它由三个支柱组æˆ�:日志ã€�度é‡�和跟踪。 -¶ÔÓÚ¶ÈÁ¿ºÍ¸ú×Ù£¬Spring BootʹÓà [Micrometer Observation](https://micrometer.io/docs/observation)¡£Òª´´½¨Äã×Ô¼ºµÄ¹Û²ì£¨Õ⽫µ¼Ö¶ÈÁ¿ºÍ¸ú×Ù£©£¬Äã¿ÉÒÔ×¢ÈëÒ»¸ö `ObservationRegistry`¡£ +对于度é‡�和跟踪,Spring Boot使用 [Micrometer Observation](https://micrometer.io/docs/observation)。è¦�创建你自己的观察(这将导致度é‡�和跟踪),你å�¯ä»¥æ³¨å…¥ä¸€ä¸ª `ObservationRegistry`。 @@ -2514,33 +2514,33 @@ public class MyCustomObservation { -| | µÍ¿¨¶ÈµÄ±êÇ©½«±»Ìí¼Óµ½Ö¸±êºÍ×·×ÙÖУ¬¶ø¸ß¿¨¶ÈµÄ±êÇ©½«Ö»±»Ìí¼Óµ½×·×ÙÖС£ | +| | 低å�¡åº¦çš„æ ‡ç­¾å°†è¢«æ·»åŠ åˆ°æŒ‡æ ‡å’Œè¿½è¸ªä¸­ï¼Œè€Œé«˜å�¡åº¦çš„æ ‡ç­¾å°†å�ªè¢«æ·»åŠ åˆ°è¿½è¸ªä¸­ã€‚ | | --- | --- | -`ObservationPredicate`¡¢`GlobalObservationConvention` ºÍ `ObservationHandler` ÀàÐ굀 Bean ½«±»×Ô¶¯×¢²áµ½ `ObservationRegistry` ÉÏ¡£Äã¿ÉÒÔÁíÍâ×¢²áÈÎÒâÊýÁ¿µÄ `ObservationRegistryCustomizer` BeanÀ´½øÒ»²½ÅäÖÃ×¢²á±í¡£ +`ObservationPredicate`ã€�`GlobalObservationConvention` å’Œ `ObservationHandler` 类型的 Bean 将被自动注册到 `ObservationRegistry` 上。你å�¯ä»¥å�¦å¤–注册任æ„�æ•°é‡�çš„ `ObservationRegistryCustomizer` Beanæ�¥è¿›ä¸€æ­¥é…�置注册表。 -¸ü¶àϸ½ÚÇë¼û [Micrometer Observation Îĵµ](https://micrometer.io/docs/observation)¡£ +更多细节请è§� [Micrometer Observation 文档](https://micrometer.io/docs/observation)。 -| | JDBCºÍR2DBCµÄ¿É¹Û²ìÐÔ£¨Observability£©¿ÉÒÔʹÓõ¥¶ÀµÄÏîÄ¿½øÐÐÅäÖ᣶ÔÓÚ JDBC£¬ [Datasource Micrometer ÏîÄ¿](https://github.com/jdbc-observations/datasource-micrometer) ÌṩÁËÒ»¸ö Spring Boot Starter£¬ÔÚµ÷ÓÃJDBC²Ù×÷ʱ×Ô¶¯´´½¨¹Û²ì¡£ÔÚ [²Î¿¼Îĵµ](https://jdbc-observations.github.io/datasource-micrometer/docs/current/docs/html/)ÖÐÔĶÁ¸ü¶à¹ØÓÚËüµÄÐÅÏ¢¡£¶ÔÓÚR2DBC£¬ [R2DBC¹Û²ìµÄSpring Boot×Ô¶¯ÅäÖÃ](https://github.com/spring-projects-experimental/r2dbc-micrometer-spring-boot) ¿ÉÒÔΪR2DBC²éѯµ÷Óô´½¨¹Û²ì¡£ | +| | JDBCå’ŒR2DBCçš„å�¯è§‚察性(Observability)å�¯ä»¥ä½¿ç”¨å�•独的项目进行é…�置。对于 JDBC, [Datasource Micrometer 项目](https://github.com/jdbc-observations/datasource-micrometer) æ��供了一个 Spring Boot Starter,在调用JDBCæ“�作时自动创建观察。在 [å�‚考文档](https://jdbc-observations.github.io/datasource-micrometer/docs/current/docs/html/)中阅读更多关于它的信æ�¯ã€‚对于R2DBC, [R2DBC观察的Spring Boot自动é…�ç½®](https://github.com/spring-projects-experimental/r2dbc-micrometer-spring-boot) å�¯ä»¥ä¸ºR2DBC查询调用创建观察。 | | --- | --- | -½ÓÏÂÀ´µÄÕ½ڽ«Ìṩ¹ØÓÚÈÕÖ¾¡¢Ö¸±êºÍ×·×ٵĸü¶àϸ½Ú¡£ +接下æ�¥çš„章节将æ��供关于日志ã€�指标和追踪的更多细节。 @@ -2550,13 +2550,13 @@ public class MyCustomObservation { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.loggers)6\. ÈÕÖ¾¼Ç¼Æ÷£¨Logger£© +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.loggers)6\. 日志记录器(Logger) -Spring Boot Actuator°üÀ¨ÔÚÔËÐÐʱ²é¿´ºÍÅäÖÃÓ¦ÓóÌÐòµÄÈÕÖ¾¼¶±ðµÄ¹¦ÄÜ¡£ Äã¿ÉÒԲ鿴Õû¸öÁбí»òµ¥¸öÈÕÖ¾¼Ç¼Æ÷µÄÅäÖã¬ËüÓÉÃ÷È·ÅäÖõÄÈÕÖ¾¼¶±ðÒÔ¼°ÈÕÖ¾¿ò¼Ü¸³ÓèËüµÄÓÐЧÈÕÖ¾¼¶±ð×é³É¡£ ÕâЩ¼¶±ð¿ÉÒÔÊÇÒÔÏÂÖ®Ò»¡£ +Spring Boot Actuator包括在è¿�行时查看和é…�置应用程åº�的日志级别的功能。 ä½ å�¯ä»¥æŸ¥çœ‹æ•´ä¸ªåˆ—表或å�•个日志记录器的é…�置,它由明确é…�置的日志级别以å�Šæ—¥å¿—框架赋予它的有效日志级别组æˆ�。 这些级别å�¯ä»¥æ˜¯ä»¥ä¸‹ä¹‹ä¸€ã€‚ @@ -2582,17 +2582,17 @@ Spring Boot Actuator -`null` ±íʾûÓÐÃ÷È·µÄÅäÖᣠ+`null` 表示没有明确的é…�置。 -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.loggers.configure)6.1\. ÅäÖÃÒ»¸ö Logger +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.loggers.configure)6.1\. é…�置一个 Logger -ÒªÅäÖÃÒ»¸ö¸ø¶¨µÄ¼Ç¼Æ÷£¬`POST` Ò»¸ö²¿·ÖʵÌåµ½×ÊÔ´µÄURI£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +è¦�é…�置一个给定的记录器,`POST` 一个部分实体到资æº�çš„URI,如下é�¢çš„例å­�所示。 @@ -2612,7 +2612,7 @@ Spring Boot Actuator -| | Òª ¡°reset¡± £¨ÖØÖ㩼ǼÆ÷µÄÌØ¶¨¼¶±ð£¨²¢Ê¹ÓÃĬÈÏÅäÖã©£¬Äã¿ÉÒÔ´«µÝÒ»¸ö `null` µÄÖµ×÷Ϊ `configuredLevel`¡£ | +| | è¦� “resetâ€� (é‡�置)记录器的特定级别(并使用默认é…�置),你å�¯ä»¥ä¼ é€’一个 `null` 的值作为 `configuredLevel`。 | | --- | --- | @@ -2625,13 +2625,13 @@ Spring Boot Actuator -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics)7\. Ö¸±ê£¨Metrics£© +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics)7\. 指标(Metrics) -Spring Boot ActuatorΪ [Micrometer](https://micrometer.io/) ÌṩÁËÒÀÀµ¹ÜÀíºÍ×Ô¶¯ÅäÖã¬MicrometerÊÇÒ»¸öÖ§³Ö [ÖÚ¶à¼à¿ØÏµÍ³](https://micrometer.io/docs) µÄÓ¦ÓóÌÐòÖ¸±ê½Ó¿Ú£¬°üÀ¨¡£ +Spring Boot Actuator为 [Micrometer](https://micrometer.io/) æ��供了ä¾�赖管ç�†å’Œè‡ªåЍé…�置,Micrometer是一个支æŒ� [众多监控系统](https://micrometer.io/docs) 的应用程åº�指标接å�£ï¼ŒåŒ…括。 @@ -2679,24 +2679,24 @@ Spring Boot ActuatorΪ [Micrometer](https://micrometer.io/) -| | ÒªÁ˽â¸ü¶à¹ØÓÚMicrometerµÄ¹¦ÄÜ£¬Çë²Î¼ûÆä [²Î¿¼Îĵµ](https://micrometer.io/docs)£¬ÌرðÊÇ [¸ÅÄ·Ö](https://micrometer.io/docs/concepts)¡£ | +| | è¦�了解更多关于Micrometer的功能,请å�‚è§�å…¶ [å�‚考文档](https://micrometer.io/docs),特别是 [概念部分](https://micrometer.io/docs/concepts)。 | | --- | --- | -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.getting-started)7.1\. ÈëÃÅ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.getting-started)7.1\. 入门 -Spring Boot»á×Ô¶¯ÅäÖÃÒ»¸ö¸´ºÏµÄ `MeterRegistry`£¬²¢ÎªËüÔÚclasspathÉÏ·¢ÏÖµÄÿ¸öÖ§³ÖµÄʵÏÖÌí¼ÓÒ»¸ö×¢²á±í¡£ ÔÚÄãµÄÔËÐÐʱclasspathÖÐÓÐ¶Ô `micrometer-registry-{system}` µÄÒÀÀµ¾Í×ãÒÔÈÃSpring BootÅäÖÃ×¢²á±íÁË¡£ +Spring Boot会自动é…�置一个å¤�å�ˆçš„ `MeterRegistry`,并为它在classpath上å�‘现的æ¯�个支æŒ�的实现添加一个注册表。 在你的è¿�行时classpath中有对 `micrometer-registry-{system}` çš„ä¾�赖就足以让Spring Booté…�置注册表了。 -´ó¶àÊý×¢²á±íÓй²Í¬µÄÌØµã¡£ ÀýÈ磬¼´Ê¹ Micrometer ×¢²á±íµÄʵÏÖÔÚclasspathÉÏ£¬ÄãÒ²¿ÉÒÔ½ûÓÃÒ»¸öÌØ¶¨µÄ×¢²á±í¡£ ÏÂÃæµÄÀý×Ó½ûÓÃÁËDatadog¡£ +大多数注册表有共å�Œçš„特点。 例如,å�³ä½¿ Micrometer 注册表的实现在classpath上,你也å�¯ä»¥ç¦�用一个特定的注册表。 下é�¢çš„例å­�ç¦�用了Datadog。 @@ -2723,7 +2723,7 @@ management.datadog.metrics.export.enabled=false -ÄãÒ²¿ÉÒÔ½ûÓÃËùÓеÄ×¢²á±í£¬³ý·Ç×¢²á±íÌØ¶¨ÊôÐÔÁíÓÐ˵Ã÷£¬ÈçÏÂÀýËùʾ¡£ +你也å�¯ä»¥ç¦�用所有的注册表,除é�žæ³¨å†Œè¡¨ç‰¹å®šå±žæ€§å�¦æœ‰è¯´æ˜Žï¼Œå¦‚下例所示。 @@ -2750,7 +2750,7 @@ management.defaults.metrics.export.enabled=false -Spring Boot»¹½«ÈκÎ×Ô¶¯ÅäÖõÄ×¢²á±íÌí¼Óµ½ `Metrics` ÀàÉϵÄÈ«¾Ö¾²Ì¬¸´ºÏ×¢²á±í£¬³ý·ÇÄãÃ÷È·¸æËßËü²»ÒªÕâÑù×ö¡£ +Spring Boot还将任何自动é…�置的注册表添加到 `Metrics` 类上的全局é�™æ€�å¤�å�ˆæ³¨å†Œè¡¨ï¼Œé™¤é�žä½ æ˜Žç¡®å‘Šè¯‰å®ƒä¸�è¦�这样å�šã€‚ @@ -2777,7 +2777,7 @@ management.metrics.use-global-registry=false -Äã¿ÉÒÔ×¢²áÈÎÒâÊýÁ¿µÄ `MeterRegistryCustomizer` BeanÀ´½øÒ»²½ÅäÖÃ×¢²á±í£¬±ÈÈçÔÚÈÎºÎ±í±»×¢²á֮ǰӦÓÃÆÕͨ±êÇ©¡£ +ä½ å�¯ä»¥æ³¨å†Œä»»æ„�æ•°é‡�çš„ `MeterRegistryCustomizer` Beanæ�¥è¿›ä¸€æ­¥é…�置注册表,比如在任何表被注册之å‰�应用普通标签。 @@ -2812,7 +2812,7 @@ public class MyMeterRegistryConfiguration { -Äã¿ÉÒÔͨ¹ý¸ü¾ßÌåµÄ·ºÐͽ«¶¨ÖÆÓ¦ÓÃÓÚÌØ¶¨µÄ×¢²á±íʵÏÖ¡£ +ä½ å�¯ä»¥é€šè¿‡æ›´å…·ä½“的泛型将定制应用于特定的注册表实现。 @@ -2851,7 +2851,7 @@ public class MyMeterRegistryConfiguration { -Spring Boot»¹ [ÅäÖÃÁËÄÚÖà instrumentation](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported)£¬Äã¿ÉÒÔͨ¹ýÅäÖûòרÓÃ×¢½â±ê¼ÇÀ´¿ØÖÆ¡£ +Spring Boot还 [é…�置了内置 instrumentation](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported),你å�¯ä»¥é€šè¿‡é…�置或专用注解标记æ�¥æŽ§åˆ¶ã€‚ @@ -2859,11 +2859,11 @@ Spring Boot -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export)7.2\. Ö§³ÖµÄ¼à¿ØÏµÍ³ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export)7.2\. 支æŒ�的监控系统 -±¾½Ú¼òÒª½éÉÜÿ¸öÖ§³ÖµÄ¼à¿ØÏµÍ³¡£ +本节简è¦�介ç»�æ¯�个支æŒ�的监控系统。 @@ -2873,7 +2873,7 @@ Spring Boot -ĬÈÏÇé¿öÏ£¬AppOptics×¢²áÖÐÐĻᶨÆÚ½«Ö¸±êÍÆË͵½ `[api.appoptics.com/v1/measurements](https://api.appoptics.com/v1/measurements)`¡£Òª½«Ö¸±êµ¼³öµ½ SaaS [AppOptics](https://micrometer.io/docs/registry/appOptics)£¬±ØÐëÌṩÄãµÄAPIÁîÅÆ¡£ +默认情况下,AppOptics注册中心会定期将指标推é€�到 `[api.appoptics.com/v1/measurements](https://api.appoptics.com/v1/measurements)`。è¦�将指标导出到 SaaS [AppOptics](https://micrometer.io/docs/registry/appOptics),必须æ��供你的API令牌。 @@ -2906,7 +2906,7 @@ management.appoptics.metrics.export.api-token=YOUR_TOKEN -ĬÈÏÇé¿öÏ£¬Ö¸±ê»á±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [Atlas](https://micrometer.io/docs/registry/atlas)¡£Äã¿ÉÒÔÌṩ [Atlas server](https://github.com/Netflix/atlas) µÄλÖᣠ+默认情况下,指标会被导出到è¿�行在你本地机器上的 [Atlas](https://micrometer.io/docs/registry/atlas)。你å�¯ä»¥æ��ä¾› [Atlas server](https://github.com/Netflix/atlas) çš„ä½�置。 @@ -2939,7 +2939,7 @@ management.atlas.metrics.export.uri=https://atlas.example.com:7101/api/v1/publis -Ò»¸öDatadog×¢²áÖÐÐĻᶨÆÚ½«Ö¸±êÍÆË͵½ [datadoghq](https://www.datadoghq.com/)¡£ Òªµ¼³öÖ¸±êµ½ [Datadog](https://micrometer.io/docs/registry/datadog)£¬Äã±ØÐëÌṩÄãµÄAPIÃÜÔ¿¡£ +一个Datadog注册中心会定期将指标推é€�到 [datadoghq](https://www.datadoghq.com/)。 è¦�导出指标到 [Datadog](https://micrometer.io/docs/registry/datadog),你必须æ��供你的API密钥。 @@ -2966,7 +2966,7 @@ management.datadog.metrics.export.api-key=YOUR_KEY -Èç¹ûÄãÁíÍâÌṩһ¸öÓ¦ÓÃÃÜÔ¿£¨¿ÉÑ¡£©£¬ÄÇôԪÊý¾Ý£¬ÈçÒDZíÃèÊö¡¢ÀàÐͺͻù±¾µ¥Î»Ò²½«±»µ¼³ö¡£ +如果你å�¦å¤–æ��供一个应用密钥(å�¯é€‰ï¼‰ï¼Œé‚£ä¹ˆå…ƒæ•°æ�®ï¼Œå¦‚仪表æ��è¿°ã€�类型和基本å�•ä½�也将被导出。 @@ -2994,7 +2994,7 @@ management.datadog.metrics.export.application-key=YOUR_APPLICATION_KEY -ĬÈÏÇé¿öÏ£¬Ö¸±ê±»·¢Ë͵½DatadogÃÀ¹ú [site](https://docs.datadoghq.com/getting_started/site) £¨`[api.datadoghq.com](https://api.datadoghq.com/)`£©¡£ Èç¹ûÄãµÄDatadogÏîÄ¿ÍйÜÔÚÆäËûÍøÕ¾ÉÏ£¬»òÕßÄãÐèҪͨ¹ý´úÀí·¢ËÍÖ¸±ê£¬ÇëÏàÓ¦ÅäÖÃURI¡£ +默认情况下,指标被å�‘é€�到Datadog美国 [site](https://docs.datadoghq.com/getting_started/site) (`[api.datadoghq.com](https://api.datadoghq.com/)`)。 如果你的Datadog项目托管在其他网站上,或者你需è¦�通过代ç�†å�‘é€�指标,请相应é…�ç½®URI。 @@ -3021,7 +3021,7 @@ management.datadog.metrics.export.uri=https://api.datadoghq.eu -Ä㻹¿ÉÒԸıäÏòDatadog·¢ËÍÖ¸±êµÄʱ¼ä¼ä¸ô¡£ +你还å�¯ä»¥æ”¹å�˜å�‘Datadogå�‘é€�指标的时间间隔。 @@ -3054,7 +3054,7 @@ management.datadog.metrics.export.step=30s -DynatraceÌṩÁËÁ½¸öÖ¸±êÉãÈ¡API£¬¶¼ÊÇΪ [Micrometer](https://micrometer.io/docs/registry/dynatrace) ʵÏֵġ£Äã¿ÉÒÔÔÚ [ÕâÀï](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer) ÕÒµ½Dynatrace¹ØÓÚMicrometerÖ¸±êÉãÈëµÄÎĵµ¡£`v1` ÃüÃû¿Õ¼äÖеÄÅäÖÃÊôÐÔÖ»ÊÊÓÃÓÚµ¼³öµ½ [Timeseries v1 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v1/) ʱ¡£`v2` ÃüÃû¿Õ¼äÖеÄÅäÖÃÊôÐÔÖ»ÊÊÓÃÓÚµ¼³öµ½ [Metrics v2 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/) ʱ¡£Çë×¢Ò⣬¸Ã¼¯³Éÿ´ÎÖ»Äܵ¼³öµ½APIµÄ `v1` »ò `v2` °æ±¾£¬`v2` °æ±¾ÊÇÊ×Ñ¡¡£Èç¹û `device-id`£¨v1°æÐèÒª£¬µ«ÔÚv2°æÖв»Ê¹Óã©ÔÚ `v1` °æÃüÃû¿Õ¼äÖб»ÉèÖã¬ÄÇômetric½«±»µ¼³öµ½ `v1` °æ¶Ëµã¡£·ñÔò£¬¾Í¼Ù¶¨ÊÇ `v2` °æ±¾¡£ +Dynatraceæ��供了两个指标摄å�–API,都是为 [Micrometer](https://micrometer.io/docs/registry/dynatrace) 实现的。你å�¯ä»¥åœ¨ [这里](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer) 找到Dynatrace关于Micrometer指标摄入的文档。`v1` 命å��空间中的é…�置属性å�ªé€‚用于导出到 [Timeseries v1 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v1/) 时。`v2` 命å��空间中的é…�置属性å�ªé€‚用于导出到 [Metrics v2 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/) 时。请注æ„�,该集æˆ�æ¯�次å�ªèƒ½å¯¼å‡ºåˆ°APIçš„ `v1` 或 `v2` 版本,`v2` 版本是首选。如果 `device-id`(v1版需è¦�,但在v2版中ä¸�使用)在 `v1` 版命å��空间中被设置,那么metric将被导出到 `v1` 版端点。å�¦åˆ™ï¼Œå°±å�‡å®šæ˜¯ `v2` 版本。 @@ -3064,35 +3064,35 @@ Dynatrace -Äã¿ÉÒÔͨ¹ýÁ½ÖÖ·½Ê½Ê¹ÓÃv2 API¡£ +ä½ å�¯ä»¥é€šè¿‡ä¸¤ç§�æ–¹å¼�使用v2 API。 -###### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export.dynatrace.v2-api.auto-config)×Ô¶¯ÅäÖà +###### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export.dynatrace.v2-api.auto-config)自动é…�ç½® -Dynatrace×Ô¶¯ÅäÖÃÊÊÓÃÓÚÓÉOneAgent»òDynatrace Operator for Kubernetes¼à¿ØµÄÖ÷»ú¡£ +Dynatrace自动é…�置适用于由OneAgent或Dynatrace Operator for Kubernetes监控的主机。 -**±¾µØOneAgent£º**Èç¹ûÖ÷»úÉÏÔËÐÐOneAgent£¬Ö¸±ê»á×Ô¶¯Êä³öµ½ [local OneAgent ingest endpoint](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/local-api/) ¡£ ÉãÈ¡¶Ëµã½«Ö¸±êת·¢µ½Dynatraceºó¶Ë¡£ +**本地OneAgent:**如果主机上è¿�行OneAgent,指标会自动输出到 [local OneAgent ingest endpoint](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/local-api/) 。 æ‘„å�–端点将指标转å�‘到Dynatraceå�Žç«¯ã€‚ -**Dynatrace Kubernetes Operator£º**ÔÚ°²×°ÁËDynatrace OperatorµÄKubernetesÖÐÔËÐÐʱ£¬×¢²á±í½«×Ô¶¯´Ó²Ù×÷Ô±ÄÇÀï»ñÈ¡ÄãµÄ¶ËµãURIºÍAPIÁîÅÆ¡£ +**Dynatrace Kubernetes Operator:**在安装了Dynatrace Operatorçš„Kubernetes中è¿�行时,注册表将自动从æ“�作员那里获å�–你的端点URIå’ŒAPI令牌。 -ÕâÊÇĬÈÏÐÐΪ£¬³ýÁËÒÀÀµ `io.micrometer:micrometer-registry-dynatrace` Ö®Í⣬²»ÐèÒªÌØ±ðµÄÉèÖᣠ+这是默认行为,除了ä¾�èµ– `io.micrometer:micrometer-registry-dynatrace` 之外,ä¸�需è¦�特别的设置。 @@ -3100,17 +3100,17 @@ Dynatrace -###### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export.dynatrace.v2-api.manual-config)ÊÖ¶¯ÅäÖà +###### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export.dynatrace.v2-api.manual-config)手动é…�ç½® -Èç¹ûûÓÐ×Ô¶¯ÅäÖã¬ÔòÐèÒª [Metrics v2 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/) µÄ¶ËµãºÍÒ»¸ö API ÁîÅÆ¡£APIÁîÅÆ±ØÐëÓÐ ¡°Ingest metrics¡± £¨`metrics.ingest`£©µÄȨÏÞÉèÖá£ÎÒÃǽ¨Ò齫ÁîÅÆµÄ·¶Î§ÏÞÖÆÔÚÕâÒ»¸öȨÏÞÉÏ¡£Äã±ØÐëÈ·±£¶ËµãURI°üº¬Â·¾¶£¨ÀýÈ磬`/api/v2/metrics/ingest`£©¡£ +如果没有自动é…�置,则需è¦� [Metrics v2 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v2/post-ingest-metrics/) 的端点和一个 API 令牌。API令牌必须有 “Ingest metricsâ€� (`metrics.ingest`)的æ�ƒé™�设置。我们建议将令牌的范围é™�制在这一个æ�ƒé™�上。你必须确ä¿�端点URI包å�«è·¯å¾„(例如,`/api/v2/metrics/ingest`)。 -Metrics API v2ÉãÈ¡¶ËµãµÄURL¸ù¾ÝÄãµÄ²¿ÊðÑ¡Ïî¶ø²»Í¬¡£ +Metrics API v2æ‘„å�–端点的URLæ ¹æ�®ä½ çš„部署选项而ä¸�å�Œã€‚ @@ -3124,7 +3124,7 @@ Metrics API v2 -ÏÂÃæµÄÀý×ÓÊÇÓà `example` environment id ÅäÖöÈÁ¿Öµµ¼³ö¡£ +下é�¢çš„例å­�是用 `example` environment id é…�置度é‡�值导出。 @@ -3152,25 +3152,25 @@ management.dynatrace.metrics.export.api-token=YOUR_TOKEN -ÔÚʹÓÃDynatrace v2 APIʱ£¬¿ÉÒÔʹÓÃÒÔÏ¿ÉÑ¡¹¦ÄÜ£¨¸ü¶àϸ½Ú¿ÉÔÚ [DynatraceÎĵµ](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer#dt-configuration-properties) ÖÐÕÒµ½£©¡£ +在使用Dynatrace v2 API时,å�¯ä»¥ä½¿ç”¨ä»¥ä¸‹å�¯é€‰åŠŸèƒ½ï¼ˆæ›´å¤šç»†èŠ‚å�¯åœ¨ [Dynatrace文档](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer#dt-configuration-properties) 中找到)。 -* Metric key µÄǰ׺¡£ÉèÖÃÒ»¸öǰ׺£¬¸Ãǰ׺½«±»Ìí¼Óµ½ËùÓе¼³öµÄmetric keyÖС£ +* Metric key çš„å‰�缀。设置一个å‰�缀,该å‰�缀将被添加到所有导出的metric key中。 -* ÓÃDynatraceÔªÊý¾ÝÀ´³äʵ¡£Èç¹ûOneAgent»òDynatrace²Ù×÷Ô±ÕýÔÚÔËÐУ¬ÓöîÍâµÄÔªÊý¾Ý£¨ÀýÈ磬¹ØÓÚÖ÷»ú¡¢½ø³Ì»òPod£©À´·á¸»Ö¸±ê¡£ +* 用Dynatrace元数æ�®æ�¥å……实。如果OneAgent或Dynatraceæ“�作员正在è¿�行,用é¢�外的元数æ�®ï¼ˆä¾‹å¦‚,关于主机ã€�进程或Pod)æ�¥ä¸°å¯ŒæŒ‡æ ‡ã€‚ -* ĬÈÏά¶È¡£Ö¸¶¨Ìí¼Óµ½ËùÓе¼³ö¶ÈÁ¿µÄ¼üÖµ¶Ô¡£ Èç¹ûÓÃMicrometerÖ¸¶¨Á˾ßÓÐÏàͬ¼üµÄ±êÇ©£¬ËüÃǽ«¸²¸ÇĬÈÏdimension¡£ +* 默认维度。指定添加到所有导出度é‡�的键值对。 如果用Micrometer指定了具有相å�Œé”®çš„æ ‡ç­¾ï¼Œå®ƒä»¬å°†è¦†ç›–默认dimension。 -* ʹÓÃDynatrace Summary instrument¡£ÔÚijЩÇé¿öÏ£¬Micrometer Dynatrace×¢²á±í´´½¨µÄÖ¸±ê±»¾Ü¾ø¡£ ÔÚMicrometer 1.9.xÖУ¬Í¨¹ýÒýÈëDynatraceÌØ¶¨µÄÕªÒª¹¤¾ßÀ´½â¾öÕâ¸öÎÊÌâ¡£ °ÑÕâ¸ö¿ª¹ØÉèÖÃΪ `false` »áÆÈʹMicrometer»Øµ½1.9.x֮ǰµÄĬÈÏÐÐΪ¡£ Ö»ÓÐÔÚ´ÓMicrometer 1.8.xÇ¨ÒÆµ½1.9.xʱÓöµ½ÎÊÌâʱ²Å¿ÉÒÔʹÓᣠ+* 使用Dynatrace Summary instrument。在æŸ�些情况下,Micrometer Dynatrace注册表创建的指标被拒ç»�。 在Micrometer 1.9.x中,通过引入Dynatrace特定的摘è¦�工具æ�¥è§£å†³è¿™ä¸ªé—®é¢˜ã€‚ 把这个开关设置为 `false` 会迫使Micrometer回到1.9.x之å‰�的默认行为。 å�ªæœ‰åœ¨ä»ŽMicrometer 1.8.xè¿�移到1.9.xæ—¶é�‡åˆ°é—®é¢˜æ—¶æ‰�å�¯ä»¥ä½¿ç”¨ã€‚ -¿ÉÒÔ²»Ö¸¶¨URIºÍAPIÁîÅÆ£¬ÈçÒÔÏÂÀý×ÓËùʾ¡£ ÔÚÕâÖÖÇé¿öÏ£¬»áʹÓÃ×Ô¶¯ÅäÖõĶ˵㡣 +å�¯ä»¥ä¸�指定URIå’ŒAPI令牌,如以下例å­�所示。 在这ç§�情况下,会使用自动é…�置的端点。 @@ -3209,7 +3209,7 @@ management.dynatrace.metrics.export.v2.use-dynatrace-summary-instruments=true -Dynatrace v1 APIÖ¸±ê×¢²á±íͨ¹ýʹÓà [Timeseries v1 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v1/) ¶¨ÆÚ½«Ö¸±êÍÆË͵½ÅäÖõÄURI¡£ ΪÁËÏòºó¼æÈÝÏÖÓеÄÉèÖ㬵± `device-id` ±»ÉèÖÃʱ£¨v1ÐèÒª£¬µ«ÔÚv2Öв»Ê¹Óã©£¬Ö¸±ê±»µ¼³öµ½Timeseries v1¶Ëµã¡£ ÒªÏò [Dynatrace](https://micrometer.io/docs/registry/dynatrace) µ¼³öÖ¸±ê£¬±ØÐëÌṩÄãµÄAPIÁîÅÆ¡¢É豸IDºÍURI¡£ +Dynatrace v1 API指标注册表通过使用 [Timeseries v1 API](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/metric-v1/) 定期将指标推é€�到é…�置的URI。 为了å�‘å�Žå…¼å®¹çŽ°æœ‰çš„è®¾ç½®ï¼Œå½“ `device-id` 被设置时(v1需è¦�,但在v2中ä¸�使用),指标被导出到Timeseries v1端点。 è¦�å�‘ [Dynatrace](https://micrometer.io/docs/registry/dynatrace) 导出指标,必须æ��供你的API令牌ã€�设备IDå’ŒURI。 @@ -3238,7 +3238,7 @@ management.dynatrace.metrics.export.v1.device-id=YOUR_DEVICE_ID -¶ÔÓÚv1°æAPI£¬Äã±ØÐëÖ¸¶¨»ù±¾»·¾³URI£¬¶ø²»Ö¸¶¨Â·¾¶£¬ÒòΪv1°æµÄ¶Ëµã·¾¶»á×Ô¶¯Ìí¼Ó¡£ +对于v1版API,你必须指定基本环境URI,而ä¸�指定路径,因为v1版的端点路径会自动添加。 @@ -3246,11 +3246,11 @@ management.dynatrace.metrics.export.v1.device-id=YOUR_DEVICE_ID -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export.dynatrace.version-independent-settings)Óë°æ±¾Î޹صÄÉèÖà +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.export.dynatrace.version-independent-settings)与版本无关的设置 -³ýÁËAPI¶ËµãºÍÁîÅÆÍ⣬Ä㻹¿ÉÒԸıäÏòDynatrace·¢ËÍÖ¸±êµÄ¼ä¸ôʱ¼ä¡£ ĬÈϵĵ¼³öʱ¼ä¼ä¸ôÊÇ `60s`¡£ ÏÂÃæµÄÀý×Ó½«µ¼³öʱ¼ä¼ä¸ôÉèÖÃΪ30Ãë¡£ +除了API端点和令牌外,你还å�¯ä»¥æ”¹å�˜å�‘Dynatraceå�‘é€�指标的间隔时间。 默认的导出时间间隔是 `60s`。 下é�¢çš„例å­�将导出时间间隔设置为30秒。 @@ -3277,7 +3277,7 @@ management.dynatrace.metrics.export.step=30s -Äã¿ÉÒÔÔÚ [MicrometerÎĵµ](https://micrometer.io/docs/registry/dynatrace) ºÍ [DynatraceÎĵµ](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer) ÖÐÕÒµ½¹ØÓÚÈçºÎΪMicrometerÉèÖÃDynatrace exporter£¨µ¼³öÆ÷£©µÄ¸ü¶àÐÅÏ¢¡£ +ä½ å�¯ä»¥åœ¨ [Micrometer文档](https://micrometer.io/docs/registry/dynatrace) å’Œ [Dynatrace文档](https://www.dynatrace.com/support/help/how-to-use-dynatrace/metrics/metric-ingestion/ingestion-methods/micrometer) 中找到关于如何为Micrometer设置Dynatrace exporter(导出器)的更多信æ�¯ã€‚ @@ -3291,7 +3291,7 @@ management.dynatrace.metrics.export.step=30s -ĬÈÏÇé¿öÏ£¬Ö¸±ê±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [Elastic](https://micrometer.io/docs/registry/elastic) ¡£ Äã¿ÉÒÔͨ¹ýʹÓÃÒÔÏÂÊôÐÔÌṩҪʹÓõÄElastic·þÎñÆ÷µÄλÖᣠ+默认情况下,指标被导出到è¿�行在你本地机器上的 [Elastic](https://micrometer.io/docs/registry/elastic) 。 ä½ å�¯ä»¥é€šè¿‡ä½¿ç”¨ä»¥ä¸‹å±žæ€§æ��ä¾›è¦�使用的Elasticæœ�务器的ä½�置。 @@ -3324,7 +3324,7 @@ management.elastic.metrics.export.host=https://elastic.example.com:8086 -ĬÈÏÇé¿öÏ£¬Ö¸±ê±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [Ganglia](https://micrometer.io/docs/registry/ganglia) ¡£Äã¿ÉÒÔÌṩ [Ganglia server](http://ganglia.sourceforge.net/) µÄÖ÷»úºÍ¶Ë¿Ú£¬ÈçÏÂÀýËùʾ¡£ +默认情况下,指标被导出到è¿�行在你本地机器上的 [Ganglia](https://micrometer.io/docs/registry/ganglia) 。你å�¯ä»¥æ��ä¾› [Ganglia server](http://ganglia.sourceforge.net/) 的主机和端å�£ï¼Œå¦‚下例所示。 @@ -3358,7 +3358,7 @@ management.ganglia.metrics.export.port=9649 -ĬÈÏÇé¿öÏ£¬Ö¸±ê»á±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [Graphite](https://micrometer.io/docs/registry/graphite) ¡£Äã¿ÉÒÔÌṩ [Graphite server](https://graphiteapp.org/) µÄÖ÷»úºÍ¶Ë¿Ú£¬ÈçÏÂÀýËùʾ¡£ +默认情况下,指标会被导出到è¿�行在你本地机器上的 [Graphite](https://micrometer.io/docs/registry/graphite) 。你å�¯ä»¥æ��ä¾› [Graphite server](https://graphiteapp.org/) 的主机和端å�£ï¼Œå¦‚下例所示。 @@ -3386,13 +3386,13 @@ management.graphite.metrics.export.port=9004 -MicrometerÌṩÁËÒ»¸öĬÈ쵀 `HierarchicalNameMapper`£¬¹ÜÀídimensional meter IDÈçºÎhttps://micrometer.io/docs/registry/graphite#_hierarchical_name_mapping[Ó³Éäµ½ flat hierarchical name]¡£ +Micrometeræ��供了一个默认的 `HierarchicalNameMapper`,管ç�†dimensional meter ID如何https://micrometer.io/docs/registry/graphite#_hierarchical_name_mapping[映射到 flat hierarchical name]。 -| | Òª¿ØÖÆÕâÖÖÐÐΪ£¬Ç붨ÒåÄãµÄ `GraphiteMeterRegistry` ²¢ÌṩÄã×Ô¼ºµÄ `HierarchicalNameMapper`¡£ ³ý·ÇÄã×Ô¼º¶¨Ò壬·ñÔò»áÌṩһ¸ö×Ô¶¯ÅäÖÃµÄ `GraphiteConfig` ºÍ `Clock` Bean¡£JavaKotlin```@Configuration(proxyBeanMethods = false)public class MyGraphiteConfiguration { @Bean public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig config, Clock clock) { return new GraphiteMeterRegistry(config, clock, this::toHierarchicalName); } private String toHierarchicalName(Meter.Id id, NamingConvention convention) { return ... }}``` | +| | è¦�控制这ç§�行为,请定义你的 `GraphiteMeterRegistry` å¹¶æ��供你自己的 `HierarchicalNameMapper`。 除é�žä½ è‡ªå·±å®šä¹‰ï¼Œå�¦åˆ™ä¼šæ��供一个自动é…�置的 `GraphiteConfig` å’Œ `Clock` Bean。JavaKotlin```@Configuration(proxyBeanMethods = false)public class MyGraphiteConfiguration { @Bean public GraphiteMeterRegistry graphiteMeterRegistry(GraphiteConfig config, Clock clock) { return new GraphiteMeterRegistry(config, clock, this::toHierarchicalName); } private String toHierarchicalName(Meter.Id id, NamingConvention convention) { return ... }}``` | | --- | --- | @@ -3405,7 +3405,7 @@ Micrometer -ĬÈÏÇé¿öÏ£¬Humio×¢²áÖÐÐĻᶨÆÚ½«Ö¸±êÍÆË͵½ [cloud.humio.com](https://cloud.humio.com/) ¡£ Òª½«Ö¸±êµ¼³öµ½SaaS [Humio](https://micrometer.io/docs/registry/humio)£¬Äã±ØÐëÌṩÄãµÄAPIÁîÅÆ¡£ +默认情况下,Humio注册中心会定期将指标推é€�到 [cloud.humio.com](https://cloud.humio.com/) 。 è¦�将指标导出到SaaS [Humio](https://micrometer.io/docs/registry/humio),你必须æ��供你的API令牌。 @@ -3432,7 +3432,7 @@ management.humio.metrics.export.api-token=YOUR_TOKEN -Ä㻹Ӧ¸ÃÅäÖÃÒ»¸ö»ò¶à¸ö±êÇ©£¬ÒÔÈ·¶¨ÍÆËÍÖ¸±êµÄÊý¾ÝÔ´¡£ +你还应该é…�置一个或多个标签,以确定推é€�指标的数æ�®æº�。 @@ -3466,7 +3466,7 @@ management.humio.metrics.export.tags.bravo=b -ĬÈÏÇé¿öÏ£¬Ö¸±ê»á±»µ¼³öµ½ÔËÐÐÔÚ±¾µØ»úÆ÷É쵀 [Influx](https://micrometer.io/docs/registry/influx) v1ʵÀý£¬²¢²ÉÓÃĬÈÏÅäÖá£Òªµ¼³öÖ¸±êµ½InfluxDB v2£¬ÇëÅäÖà `org`¡¢`bucket` ºÍÓÃÓÚдÈëÖ¸±êµÄauthentication `token`¡£Äã¿ÉÒÔͨ¹ýÒÔÏ·½Ê½ÌṩҪʹÓÃµÄ [Influx server](https://www.influxdata.com/) µÄλÖᣠ+默认情况下,指标会被导出到è¿�行在本地机器上的 [Influx](https://micrometer.io/docs/registry/influx) v1实例,并采用默认é…�置。è¦�导出指标到InfluxDB v2,请é…�ç½® `org`ã€�`bucket` 和用于写入指标的authentication `token`。你å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�æ��ä¾›è¦�使用的 [Influx server](https://www.influxdata.com/) çš„ä½�置。 @@ -3499,7 +3499,7 @@ management.influx.metrics.export.uri=https://influx.example.com:8086 -MicrometerÌṩÁË¶Ô [JMX](https://micrometer.io/docs/registry/jmx) µÄ·Ö²ãÓ³É䣬Ö÷ÒªÊÇ×÷ΪһÖÖÁ®¼ÛºÍ¿ÉÒÆÖ²µÄ·½Ê½À´²é¿´±¾µØµÄ¶ÈÁ¿¡£ ĬÈÏÇé¿öÏ£¬Ö¸±ê±»µ¼³öµ½ `metrics` JMXÓò¡£ Äã¿ÉÒÔͨ¹ýÒÔÏ·½Ê½ÌṩҪʹÓõÄÓò¡£ +Micrometeræ��供了对 [JMX](https://micrometer.io/docs/registry/jmx) 的分层映射,主è¦�是作为一ç§�廉价和å�¯ç§»æ¤�的方å¼�æ�¥æŸ¥çœ‹æœ¬åœ°çš„度é‡�。 默认情况下,指标被导出到 `metrics` JMX域。 ä½ å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�æ��ä¾›è¦�使用的域。 @@ -3526,13 +3526,13 @@ management.jmx.metrics.export.domain=com.example.app.metrics -MicrometerÌṩÁËÒ»¸öĬÈ쵀 `HierarchicalNameMapper`£¬¹ÜÀídimensional meter ID ÈçºÎ [Ó³Éäµ½ flat hierarchical name](https://micrometer.io/docs/registry/jmx#_hierarchical_name_mapping)¡£ +Micrometeræ��供了一个默认的 `HierarchicalNameMapper`,管ç�†dimensional meter ID 如何 [映射到 flat hierarchical name](https://micrometer.io/docs/registry/jmx#_hierarchical_name_mapping)。 -| | Òª¿ØÖÆÕâÖÖÐÐΪ£¬Ç붨ÒåÄãµÄ `JmxMeterRegistry` ²¢ÌṩÄã×Ô¼ºµÄ `HierarchicalNameMapper`¡£ ³ý·ÇÄã×Ô¼º¶¨Ò壬·ñÔò»áÌṩһ¸ö×Ô¶¯ÅäÖÃµÄ `JmxConfig` ºÍ `Clock` Bean¡£JavaKotlin```@Configuration(proxyBeanMethods = false)public class MyJmxConfiguration { @Bean public JmxMeterRegistry jmxMeterRegistry(JmxConfig config, Clock clock) { return new JmxMeterRegistry(config, clock, this::toHierarchicalName); } private String toHierarchicalName(Meter.Id id, NamingConvention convention) { return ... }}``` | +| | è¦�控制这ç§�行为,请定义你的 `JmxMeterRegistry` å¹¶æ��供你自己的 `HierarchicalNameMapper`。 除é�žä½ è‡ªå·±å®šä¹‰ï¼Œå�¦åˆ™ä¼šæ��供一个自动é…�置的 `JmxConfig` å’Œ `Clock` Bean。JavaKotlin```@Configuration(proxyBeanMethods = false)public class MyJmxConfiguration { @Bean public JmxMeterRegistry jmxMeterRegistry(JmxConfig config, Clock clock) { return new JmxMeterRegistry(config, clock, this::toHierarchicalName); } private String toHierarchicalName(Meter.Id id, NamingConvention convention) { return ... }}``` | | --- | --- | @@ -3545,7 +3545,7 @@ Micrometer -ĬÈÏÇé¿öÏ£¬Ö¸±ê±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [KairosDB](https://micrometer.io/docs/registry/kairos) ¡£Äã¿ÉÒÔͨ¹ýÒÔÏ·½Ê½ÌṩҪʹÓÃµÄ [KairosDB server](https://kairosdb.github.io/) µÄλÖᣠ+默认情况下,指标被导出到è¿�行在你本地机器上的 [KairosDB](https://micrometer.io/docs/registry/kairos) 。你å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�æ��ä¾›è¦�使用的 [KairosDB server](https://kairosdb.github.io/) çš„ä½�置。 @@ -3578,7 +3578,7 @@ management.kairos.metrics.export.uri=https://kairosdb.example.com:8080/api/v1/da -New Relic×¢²áÖÐÐĻᶨÆÚ½«Ö¸±êÍÆË͵½ [New Relic](https://micrometer.io/docs/registry/new-relic)¡£Òªµ¼³öÖ¸±êµ½ [New Relic](https://newrelic.com/)£¬Äã±ØÐëÌṩÄãµÄAPIÃÜÔ¿ºÍÕË»§ID¡£ +New Relic注册中心会定期将指标推é€�到 [New Relic](https://micrometer.io/docs/registry/new-relic)。è¦�导出指标到 [New Relic](https://newrelic.com/),你必须æ��供你的API密钥和账户ID。 @@ -3606,7 +3606,7 @@ management.newrelic.metrics.export.account-id=YOUR_ACCOUNT_ID -Ä㻹¿ÉÒԸıäÏòNew Relic·¢ËÍÖ¸±êµÄʱ¼ä¼ä¸ô¡£ +你还å�¯ä»¥æ”¹å�˜å�‘New Relicå�‘é€�指标的时间间隔。 @@ -3633,7 +3633,7 @@ management.newrelic.metrics.export.step=30s -ĬÈÏÇé¿öÏ£¬Ö¸±êÊÇͨ¹ýRESTµ÷Ó÷¢²¼µÄ£¬µ«Èç¹ûÄãÔÚclasspathÉÏÓÐJava Agent API£¬ÄãÒ²¿ÉÒÔʹÓÃËü¡£ +默认情况下,指标是通过REST调用å�‘布的,但如果你在classpath上有Java Agent API,你也å�¯ä»¥ä½¿ç”¨å®ƒã€‚ @@ -3660,7 +3660,7 @@ management.newrelic.metrics.export.client-provider-type=insights-agent -×îºó£¬Äã¿ÉÒÔͨ¹ý¶¨ÒåÄã×Ô¼ºµÄ `NewRelicClientProvider` ¶¹À´ÍêÈ«¿ØÖÆ¡£ +最å�Žï¼Œä½ å�¯ä»¥é€šè¿‡å®šä¹‰ä½ è‡ªå·±çš„ `NewRelicClientProvider` 豆æ�¥å®Œå…¨æŽ§åˆ¶ã€‚ @@ -3672,7 +3672,7 @@ management.newrelic.metrics.export.client-provider-type=insights-agent -ĬÈÏÇé¿öÏ£¬Ö¸±ê±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [OpenTelemetry](https://micrometer.io/docs/registry/otlp) ¡£Äã¿ÉÒÔͨ¹ýÒÔÏ·½Ê½ÌṩҪʹÓÃµÄ [OpenTelemtry metric endpoint](https://opentelemetry.io/) µÄλÖᣠ+默认情况下,指标被导出到è¿�行在你本地机器上的 [OpenTelemetry](https://micrometer.io/docs/registry/otlp) 。你å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�æ��ä¾›è¦�使用的 [OpenTelemtry metric endpoint](https://opentelemetry.io/) çš„ä½�置。 @@ -3705,20 +3705,20 @@ management.otlp.metrics.export.url=https://otlp.example.com:4318/v1/metrics -[Prometheus](https://micrometer.io/docs/registry/prometheus) Ï£Íûscrape»òÂÖѯµ¥¸öÓ¦ÓóÌÐòʵÀýµÄÖ¸±ê¡£Spring BootÔÚ `/actuator/prometheus` ÌṩÁËÒ»¸öactuator¶Ëµã£¬ÒÔ±ãÒÔÊʵ±µÄ¸ñʽ³ÊÏÖ [Prometheus scrape](https://prometheus.io/)¡£ +[Prometheus](https://micrometer.io/docs/registry/prometheus) 希望scrape或轮询å�•个应用程åº�实例的指标。Spring Boot在 `/actuator/prometheus` æ��供了一个actuator端点,以便以适当的格å¼�呈现 [Prometheus scrape](https://prometheus.io/)。 -| | ĬÈÏÇé¿öÏ£¬¸Ã¶ËµãÊDz»¿ÉÓõ쬱ØÐë±»±©Â¶¡£¸ü¶àϸ½ÚÇë²Î¼û[±©Â¶¶Ëµã](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)¡£ | +| | 默认情况下,该端点是ä¸�å�¯ç”¨çš„,必须被暴露。更多细节请å�‚è§�[暴露端点](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)。 | | --- | --- | -ÏÂÃæµÄÀý×Ó `scrape_config` Ìí¼Óµ½ `prometheus.yml`¡£ +下é�¢çš„例å­� `scrape_config` 添加到 `prometheus.yml`。 @@ -3740,13 +3740,13 @@ scrape_configs: -Ò²Ö§³Ö [Prometheus Exemplars](https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage)¡£ÒªÆôÓÃÕâ¸ö¹¦ÄÜ£¬Ó¦¸ÃÓÐÒ»¸ö `SpanContextSupplier` Bean¡£Èç¹ûÄãʹÓà [Micrometer Tracing](https://micrometer.io/docs/tracing)£¬Õ⽫ΪÄã×Ô¶¯ÅäÖ㬵«Èç¹ûÄãÏ룬Äã×ÜÊÇ¿ÉÒÔ´´½¨×Ô¼ºµÄ¡£Çë²é¿´ [Prometheus Îĵµ](https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage) £¬ÒòΪÕâ¸ö¹¦ÄÜÐèÒªÔÚPrometheusÕâ±ßÃ÷È·ÆôÓ㬶øÇÒÖ»Ö§³ÖʹÓà [OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#exemplars) ¸ñʽ¡£ +也支æŒ� [Prometheus Exemplars](https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage)。è¦�å�¯ç”¨è¿™ä¸ªåŠŸèƒ½ï¼Œåº”è¯¥æœ‰ä¸€ä¸ª `SpanContextSupplier` Bean。如果你使用 [Micrometer Tracing](https://micrometer.io/docs/tracing),这将为你自动é…�置,但如果你想,你总是å�¯ä»¥åˆ›å»ºè‡ªå·±çš„。请查看 [Prometheus 文档](https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage) ,因为这个功能需è¦�在Prometheus这边明确å�¯ç”¨ï¼Œè€Œä¸”å�ªæ”¯æŒ�使用 [OpenMetrics](https://github.com/OpenObservability/OpenMetrics/blob/v1.0.0/specification/OpenMetrics.md#exemplars) æ ¼å¼�。 -¶ÔÓÚ¶ÌÔݵĻòÅú´¦ÀíµÄ×÷Òµ£¬¿ÉÄÜ´æÔÚµÄʱ¼ä²»¹»³¤£¬ÎÞ·¨±»¹ÎÈ¡£¬Äã¿ÉÒÔʹÓà [Prometheus Pushgateway](https://github.com/prometheus/pushgateway) Ö§³Ö£¬½«Ö¸±ê±©Â¶¸øPrometheus¡£ÒªÆôÓÃPrometheus PushgatewayÖ§³Ö£¬ÇëÔÚÄãµÄÏîÄ¿ÖÐÌí¼ÓÒÔÏÂÒÀÀµ¡£ +对于短暂的或批处ç�†çš„作业,å�¯èƒ½å­˜åœ¨çš„æ—¶é—´ä¸�够长,无法被刮å�–,你å�¯ä»¥ä½¿ç”¨ [Prometheus Pushgateway](https://github.com/prometheus/pushgateway) 支æŒ�,将指标暴露给Prometheus。è¦�å�¯ç”¨Prometheus Pushgateway支æŒ�,请在你的项目中添加以下ä¾�赖。 @@ -3767,13 +3767,13 @@ scrape_configs: -µ±Prometheus PushgatewayµÄÒÀÀµ³öÏÖÔÚclasspathÉÏ£¬²¢ÇÒ `management.prometheus.metrics.export.pushgateway.enabled` ÊôÐÔ±»ÉèÖÃΪ `true` ʱ£¬Ò»¸ö `PrometheusPushGatewayManager` bean¾Í±»×Ô¶¯ÅäÖÃÁË¡£ Ëü¸ºÔð¹ÜÀíÏòPrometheus PushgatewayÍÆËÍÖ¸±êµÄ¹¤×÷¡£ +当Prometheus Pushgatewayçš„ä¾�赖出现在classpath上,并且 `management.prometheus.metrics.export.pushgateway.enabled` 属性被设置为 `true` 时,一个 `PrometheusPushGatewayManager` bean就被自动é…�置了。 它负责管ç�†å�‘Prometheus Pushgateway推é€�指标的工作。 -Äã¿ÉÒÔͨ¹ýʹÓà `management.prometheus.metrics.export.pushgateway` ϵÄÊôÐÔÀ´µ÷Õû `PrometheusPushGatewayManager`¡£ ¶ÔÓڸ߼¶ÅäÖã¬ÄãÒ²¿ÉÒÔÌṩÄã×Ô¼ºµÄ `PrometheusPushGatewayManager` bean¡£ +ä½ å�¯ä»¥é€šè¿‡ä½¿ç”¨ `management.prometheus.metrics.export.pushgateway` 下的属性æ�¥è°ƒæ•´ `PrometheusPushGatewayManager`。 对于高级é…�置,你也å�¯ä»¥æ��供你自己的 `PrometheusPushGatewayManager` bean。 @@ -3785,7 +3785,7 @@ scrape_configs: -SignalFx×¢²áÖÐÐĻᶨÆÚ½«Ö¸±êÍÆË͵½ [SignalFx](https://micrometer.io/docs/registry/signalFx)¡£Òªµ¼³öÖ¸±êµ½ [SignalFx](https://www.signalfx.com/)£¬Äã±ØÐëÌṩÄãµÄaccess token¡£ +SignalFx注册中心会定期将指标推é€�到 [SignalFx](https://micrometer.io/docs/registry/signalFx)。è¦�导出指标到 [SignalFx](https://www.signalfx.com/),你必须æ��供你的access token。 @@ -3812,7 +3812,7 @@ management.signalfx.metrics.export.access-token=YOUR_ACCESS_TOKEN -ÄãÒ²¿ÉÒԸıäÏòSignalFx·¢ËÍÖ¸±êµÄʱ¼ä¼ä¸ô¡£ +你也å�¯ä»¥æ”¹å�˜å�‘SignalFxå�‘é€�指标的时间间隔。 @@ -3845,13 +3845,13 @@ management.signalfx.metrics.export.step=30s -MicrometerÌṩÁËÒ»¸ö¼òµ¥µÄ¡¢ÄÚ´æÖеĺó¶Ë£¬Èç¹ûûÓÐÅäÖÃÆäËû×¢²á±í£¬¸Ãºó¶Ë»á×Ô¶¯×÷Ϊ±¸Óá£Õâ¿ÉÒÔÈÃÄã¿´µ½ÔÚ [metrics endpoint](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.endpoint) ÖÐÊÕ¼¯ÁËÄÄЩ¶ÈÁ¿¡£ +Micrometeræ��供了一个简å�•çš„ã€�内存中的å�Žç«¯ï¼Œå¦‚果没有é…�置其他注册表,该å�Žç«¯ä¼šè‡ªåŠ¨ä½œä¸ºå¤‡ç”¨ã€‚è¿™å�¯ä»¥è®©ä½ çœ‹åˆ°åœ¨ [metrics endpoint](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.endpoint) 中收集了哪些度é‡�。 -Ò»µ©ÄãʹÓÃÈÎºÎÆäËû¿ÉÓõĺó¶Ë£¬ÄÚ´æÖеĺó¶Ë¾Í»á×Ô¶¯¹Ø±Õ¡£ÄãÒ²¿ÉÒÔÃ÷È·µØ½ûÓÃËü¡£ +一旦你使用任何其他å�¯ç”¨çš„å�Žç«¯ï¼Œå†…存中的å�Žç«¯å°±ä¼šè‡ªåŠ¨å…³é—­ã€‚ä½ ä¹Ÿå�¯ä»¥æ˜Žç¡®åœ°ç¦�用它。 @@ -3884,7 +3884,7 @@ management.simple.metrics.export.enabled=false -Stackdriver×¢²áÖÐÐĻᶨÆÚÏò [Stackdriver](https://cloud.google.com/stackdriver/) ÍÆËÍÖ¸±ê¡£Òªµ¼³öÖ¸±êµ½SaaS [Stackdriver](https://micrometer.io/docs/registry/stackdriver)£¬Äã±ØÐëÌṩÄãµÄGoogle Cloud project ID¡£ +Stackdriver注册中心会定期å�‘ [Stackdriver](https://cloud.google.com/stackdriver/) 推é€�指标。è¦�导出指标到SaaS [Stackdriver](https://micrometer.io/docs/registry/stackdriver),你必须æ��供你的Google Cloud project ID。 @@ -3911,7 +3911,7 @@ management.stackdriver.metrics.export.project-id=my-project -Ä㻹¿ÉÒԸıäÏòStackdriver·¢ËÍÖ¸±êµÄʱ¼ä¼ä¸ô¡£ +你还å�¯ä»¥æ”¹å�˜å�‘Stackdriverå�‘é€�指标的时间间隔。 @@ -3944,7 +3944,7 @@ management.stackdriver.metrics.export.step=30s -StatsD×¢²á±í¼±Çеؽ«Ö¸±êͨ¹ýUDPÍÆË͸øStatsD agent¡£Ä¬ÈÏÇé¿öÏ£¬Ö¸±ê±»µ¼³öµ½ÔËÐÐÔÚÄã±¾µØ»úÆ÷É쵀 [StatsD](https://micrometer.io/docs/registry/statsD) agent¡£Äã¿ÉÒÔͨ¹ýÒÔÏ·½Ê½ÌṩStatsD´úÀíµÄÖ÷»ú¡¢¶Ë¿ÚºÍЭÒ飬ÒÔ±ãʹÓᣠ+StatsD注册表急切地将指标通过UDP推é€�ç»™StatsD agent。默认情况下,指标被导出到è¿�行在你本地机器上的 [StatsD](https://micrometer.io/docs/registry/statsD) agent。你å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�æ��ä¾›StatsD代ç�†çš„主机ã€�端å�£å’Œå��议,以便使用。 @@ -3973,7 +3973,7 @@ management.statsd.metrics.export.protocol=udp -Ä㻹¿ÉÒԸıäҪʹÓõÄStatsDÏß·ЭÒ飨ĬÈÏΪDatadog£©¡£ +你还å�¯ä»¥æ”¹å�˜è¦�使用的StatsD线路å��议(默认为Datadog)。 @@ -4006,7 +4006,7 @@ management.statsd.metrics.export.flavor=etsy -Wavefront×¢²á±í¶¨ÆÚ½«Ö¸±êÍÆË͵½ [Wavefront](https://micrometer.io/docs/registry/wavefront)¡£Èç¹ûÄãÖ±½Ó½«Ö¸±êµ¼³öµ½ [Wavefront](https://www.wavefront.com/)£¬Äã±ØÐëÌṩÄãµÄAPI token¡£ +Wavefront注册表定期将指标推é€�到 [Wavefront](https://micrometer.io/docs/registry/wavefront)。如果你直接将指标导出到 [Wavefront](https://www.wavefront.com/),你必须æ��供你的API token。 @@ -4033,7 +4033,7 @@ management.wavefront.api-token=YOUR_API_TOKEN -ÁíÍ⣬Äú¿ÉÒÔÔÚÄúµÄ»·¾³ÖÐʹÓÃWavefront sidecar»òÄÚ²¿´úÀíÀ´×ª·¢Ö¸±êÊý¾Ýµ½Wavefront APIÖ÷»ú¡£ +å�¦å¤–,您å�¯ä»¥åœ¨æ‚¨çš„环境中使用Wavefront sidecar或内部代ç�†æ�¥è½¬å�‘指标数æ�®åˆ°Wavefront API主机。 @@ -4060,13 +4060,13 @@ management.wavefront.uri=proxy://localhost:2878 -Èç¹ûÄú½«Ö¸±ê·¢²¼µ½Wavefront´úÀí£¨Èç [WavefrontÎĵµ](https://docs.wavefront.com/proxies_installing.html) ÖÐËùÊö£©£¬Ö÷»ú±ØÐëÊÇ `proxy://HOST:PORT` ¸ñʽ¡£ +如果您将指标å�‘布到Wavefront代ç�†ï¼ˆå¦‚ [Wavefront文档](https://docs.wavefront.com/proxies_installing.html) 中所述),主机必须是 `proxy://HOST:PORT` æ ¼å¼�。 -ÄãÒ²¿ÉÒԸıäÏòWavefront·¢ËÍÖ¸±êµÄʱ¼ä¼ä¸ô¡£ +你也å�¯ä»¥æ”¹å�˜å�‘Wavefrontå�‘é€�指标的时间间隔。 @@ -4097,43 +4097,43 @@ management.wavefront.metrics.export.step=30s -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported)7.3\. Ö§³ÖµÄÖ¸±ê £¨Metric£©ºÍ¶ÈÁ¿£¨Meter£© +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported)7.3\. 支æŒ�的指标 (Metric)和度é‡�(Meter) -Spring BootΪ¸÷ÖÖ¸÷ÑùµÄ¼¼ÊõÌṩÁË×Ô¶¯¼ÆÁ¿Æ÷×¢²á¡£ ÔÚ´ó¶àÊýÇé¿öÏ£¬Ä¬ÈÏÖµÌṩÁ˺ÏÀíµÄÖ¸±ê£¬¿ÉÒÔ·¢²¼µ½ÈκÎÖ§³ÖµÄ¼à¿ØÏµÍ³ÖС£ +Spring Boot为å�„ç§�å�„样的技术æ��供了自动计é‡�器注册。 在大多数情况下,默认值æ��供了å�ˆç�†çš„æŒ‡æ ‡ï¼Œå�¯ä»¥å�‘布到任何支æŒ�的监控系统中。 -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jvm)7.3.1\. JVMÖ¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jvm)7.3.1\. JVM指标 -×Ô¶¯ÅäÖÃͨ¹ýʹÓúËÐÄ Micrometer ÀàÆôÓÃJVM¶ÈÁ¿¡£ JVMÖ¸±êÔÚ `jvm.` meter name Ï·¢²¼¡£ +自动é…�置通过使用核心 Micrometer ç±»å�¯ç”¨JVM度é‡�。 JVM指标在 `jvm.` meter name 下å�‘布。 -ÌṩÒÔÏÂJVMÖ¸±ê¡£ +æ��供以下JVM指标。 -* ¸÷ÖÖÄÚ´æºÍ»º³å³ØÏ¸½Ú +* å�„ç§�内存和缓冲池细节 -* ÓëÀ¬»øÊÕ¼¯ÓйصÄͳ¼ÆÊý¾Ý +* 与垃圾收集有关的统计数æ�® -* Ïß³ÌÀûÓÃÂÊ +* 线程利用率 -* ¼ÓÔØºÍÐ¶ÔØµÄÀàµÄÊýÁ¿ +* 加载和å�¸è½½çš„类的数é‡� -* JVMµÄ°æ±¾ÐÅÏ¢ +* JVM的版本信æ�¯ -* JIT ±àÒëʱ¼ä +* JIT 编译时间 @@ -4141,29 +4141,29 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.system)7.3.2\. ϵͳָ±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.system)7.3.2\. 系统指标 -×Ô¶¯ÅäÖÃͨ¹ýʹÓúËÐÄMicrometerÀàÀ´ÊµÏÖϵͳ¶ÈÁ¿¡£ ϵͳָ±êÔÚ `system.`¡¢`process.` ºÍ `disk.` meter ÃûÏ·¢²¼¡£ +自动é…�置通过使用核心Micrometerç±»æ�¥å®žçŽ°ç³»ç»Ÿåº¦é‡�。 系统指标在 `system.`ã€�`process.` å’Œ `disk.` meter å��下å�‘布。 -ÌṩÒÔÏÂϵͳָ±ê¡£ +æ��供以下系统指标。 -* CPUÖ¸±ê +* CPU指标 -* ÎļþÃèÊö·ûÖ¸±ê +* 文件æ��述符指标 -* Õý³£ÔËÐÐʱ¼äÖ¸±ê£¨°üÀ¨Ó¦ÓóÌÐòÒѾ­ÔËÐеÄʱ¼äºÍ¾ø¶ÔÆô¶¯Ê±¼äµÄ¹Ì¶¨²âÁ¿£©¡£ +* 正常è¿�行时间指标(包括应用程åº�å·²ç»�è¿�行的时间和ç»�对å�¯åŠ¨æ—¶é—´çš„å›ºå®šæµ‹é‡�)。 -* ¿ÉÓõĴÅÅ̿ռä +* å�¯ç”¨çš„ç£�盘空间 @@ -4171,25 +4171,25 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.application-startup)7.3.3\. Ó¦ÓóÌÐòÆô¶¯Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.application-startup)7.3.3\. 应用程åº�å�¯åŠ¨æŒ‡æ ‡ -×Ô¶¯ÅäÖñ©Â¶ÁËÓ¦ÓóÌÐòµÄÆô¶¯Ê±¼äÖ¸±ê¡£ +自动é…�置暴露了应用程åº�çš„å�¯åŠ¨æ—¶é—´æŒ‡æ ‡ã€‚ -* `application.started.time`: Æô¶¯Ó¦ÓóÌÐòµÄʱ¼ä¡£ +* `application.started.time`: å�¯åŠ¨åº”ç”¨ç¨‹åº�的时间。 -* `application.ready.time`£ºÓ¦ÓóÌÐò×¼±¸ºÃΪÇëÇóÌṩ·þÎñËùÐèµÄʱ¼ä¡£ +* `application.ready.time`:应用程åº�准备好为请求æ��ä¾›æœ�务所需的时间。 -Ö¸±êÊÇÓÉÓ¦ÓÃÀàµÄÍêÈ«Ãû³ÆÀ´±ê¼ÇµÄ¡£ +指标是由应用类的完全å��ç§°æ�¥æ ‡è®°çš„。 @@ -4197,11 +4197,11 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.logger)7.3.4\. ÈÕÖ¾¼Ç¼Æ÷Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.logger)7.3.4\. 日志记录器指标 -×Ô¶¯ÅäÖÃÆôÓÃÁËLogbackºÍLog4J2µÄʼþ¶ÈÁ¿¡£ ϸ½ÚÔÚ `log4j2.events.` »ò `logback.events.` meterÃûϹ«²¼¡£ +自动é…�ç½®å�¯ç”¨äº†Logbackå’ŒLog4J2的事件度é‡�。 细节在 `log4j2.events.` 或 `logback.events.` meterå��下公布。 @@ -4209,11 +4209,11 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.tasks)7.3.5\. ÈÎÎñÖ´Ðк͵÷¶ÈÖ¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.tasks)7.3.5\. 任务执行和调度指标 -×Ô¶¯ÅäÖÃʹËùÓпÉÓÃµÄ `ThreadPoolTaskExecutor` ºÍ `ThreadPoolTaskScheduler` Bean¶¼Äܱ»²âÁ¿£¬Ö»Òªµ×²ãµÄ `ThreadPoolExecutor` ¿ÉÓᣠָ±êÓÉexecutorµÄÃû³ÆÀ´±ê¼Ç£¬executorµÄÃû³ÆÀ´×ÔÓÚBeanµÄÃû³Æ¡£ +自动é…�置使所有å�¯ç”¨çš„ `ThreadPoolTaskExecutor` å’Œ `ThreadPoolTaskScheduler` Bean都能被测é‡�,å�ªè¦�底层的 `ThreadPoolExecutor` å�¯ç”¨ã€‚ 指标由executorçš„å��ç§°æ�¥æ ‡è®°ï¼Œexecutorçš„å��ç§°æ�¥è‡ªäºŽBeançš„å��称。 @@ -4221,36 +4221,36 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-mvc)7.3.6\. Spring MVC Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-mvc)7.3.6\. Spring MVC 指标 -×Ô¶¯ÅäÖÃÄܹ»¶Ô Spring MVC ControllerºÍ±à³Ìʽhandler´¦ÀíµÄËùÓÐÇëÇó½øÐжÈÁ¿¡£ ĬÈÏÇé¿öÏ£¬Ö¸±êÊÇÒÔ `http.server.requests` ΪÃû³ÆÉú³ÉµÄ¡£ Äã¿ÉÒÔͨ¹ýÉèÖà `management.observations.http.server.requests.name` ÊôÐÔÀ´¶¨ÖƸÃÃû³Æ¡£ +自动é…�置能够对 Spring MVC Controller和编程å¼�handler处ç�†çš„æ‰€æœ‰è¯·æ±‚进行度é‡�。 默认情况下,指标是以 `http.server.requests` 为å��称生æˆ�的。 ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.observations.http.server.requests.name` 属性æ�¥å®šåˆ¶è¯¥å��称。 -¹ØÓÚ²úÉúµÄ¹Û²ì½á¹û£¨observation£©µÄ¸ü¶àÐÅÏ¢£¬Çë²Î¼û [Spring Framework ²Î¿¼Îĵµ](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/integration.html#integration.observability.http-server.servlet)¡£ +关于产生的观察结果(observation)的更多信æ�¯ï¼Œè¯·å�‚è§� [Spring Framework å�‚考文档](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/integration.html#integration.observability.http-server.servlet)。 -ÒªÌí¼Óµ½Ä¬ÈϱêÇ©ÖУ¬ÇëÌṩһ¸ö¼Ì³ÐÁË `org.springframework.http.server.observation` °üÖÐµÄ `DefaultServerRequestObservationConvention` µÄ `@Bean`¡£ÒªÌ滻ĬÈϱêÇ©£¬ÇëÌṩһ¸öʵÏÖ `ServerRequestObservationConvention` µÄ `@Bean`¡£ +è¦�添加到默认标签中,请æ��供一个继承了 `org.springframework.http.server.observation` 包中的 `DefaultServerRequestObservationConvention` çš„ `@Bean`。è¦�替æ�¢é»˜è®¤æ ‡ç­¾ï¼Œè¯·æ��供一个实现 `ServerRequestObservationConvention` çš„ `@Bean`。 -| | ÔÚijЩÇé¿öÏ£¬Web¿ØÖÆÆ÷Öд¦ÀíµÄÒì³£²»»á±»¼Ç¼ΪÇëÇó¶ÈÁ¿±êÇ©¡£Ó¦ÓóÌÐò¿ÉÒÔÑ¡Ôñ¼ÓÈ벢ͨ¹ý½«[handled exception ÉèÖÃΪ request attribute](https://springdoc.cn/spring-boot/web.html#web.servlet.spring-mvc.error-handling)À´¼Ç¼Òì³£¡£ | +| | 在æŸ�些情况下,Web控制器中处ç�†çš„异常ä¸�会被记录为请求度é‡�标签。应用程åº�å�¯ä»¥é€‰æ‹©åŠ å…¥å¹¶é€šè¿‡å°†[handled exception 设置为 request attribute](https://springdoc.cn/spring-boot/web.html#web.servlet.spring-mvc.error-handling)æ�¥è®°å½•异常。 | | --- | --- | -ĬÈÏÇé¿öÏ£¬ËùÓÐÇëÇó¶¼±»´¦Àí¡£ Òª×Ô¶¨Òå¹ýÂËÆ÷£¬ÇëÌṩһ¸öʵÏÖ `FilterRegistrationBean` µÄ `@Bean`¡£ +默认情况下,所有请求都被处ç�†ã€‚ è¦�自定义过滤器,请æ��供一个实现 `FilterRegistrationBean` çš„ `@Bean`。 @@ -4258,29 +4258,29 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-webflux)7.3.7\. Spring WebFlux Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-webflux)7.3.7\. Spring WebFlux 指标 -×Ô¶¯ÅäÖÃÄܹ»¶ÔSpring WebFlux controllerºÍ±à³ÌʽhandlerµÄËùÓÐÇëÇó½øÐжÈÁ¿¡£ ĬÈÏÇé¿öÏ£¬Ö¸±êÊÇÒÔ `http.server.requests` ΪÃûÉú³ÉµÄ¡£ Äã¿ÉÒÔͨ¹ýÉèÖà `management.observations.http.server.requests.name` ÊôÐÔÀ´¶¨ÖƸÃÃû³Æ¡£ +自动é…�置能够对Spring WebFlux controller和编程å¼�handler的所有请求进行度é‡�。 默认情况下,指标是以 `http.server.requests` 为å��生æˆ�的。 ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.observations.http.server.requests.name` 属性æ�¥å®šåˆ¶è¯¥å��称。 -¹ØÓÚ²úÉúµÄ¹Û²ì½á¹û£¨observation£©µÄ¸ü¶àÐÅÏ¢£¬Çë²Î¼û [Spring Framework ²Î¿¼Îĵµ](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/integration.html#integration.observability.http-server.reactive)¡£ +关于产生的观察结果(observation)的更多信æ�¯ï¼Œè¯·å�‚è§� [Spring Framework å�‚考文档](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/integration.html#integration.observability.http-server.reactive)。 -ÒªÌí¼Óµ½Ä¬ÈϱêÇ©ÖУ¬ÇëÌṩ¼Ì³ÐÁË `org.springframework.http.server.reactive.observation` °üÖÐµÄ `DefaultServerRequestObservationConvention` µÄ `@Bean`¡£ÒªÌ滻ĬÈϱêÇ©£¬ÇëÌṩһ¸öʵÏÖ `ServerRequestObservationConvention` µÄ `@Bean`¡£ +è¦�添加到默认标签中,请æ��供继承了 `org.springframework.http.server.reactive.observation` 包中的 `DefaultServerRequestObservationConvention` çš„ `@Bean`。è¦�替æ�¢é»˜è®¤æ ‡ç­¾ï¼Œè¯·æ��供一个实现 `ServerRequestObservationConvention` çš„ `@Bean`。 -| | ÔÚijЩÇé¿öÏ£¬¿ØÖÆÆ÷ºÍ´¦Àíº¯ÊýÖд¦ÀíµÄÒì³£²»»á±»¼Ç¼ΪÇëÇó¶ÈÁ¿±êÇ©¡£Ó¦ÓóÌÐò¿ÉÒÔÑ¡Ôñ¼ÓÈ벢ͨ¹ý[½«handled exceptionÉèÖÃΪrequest attribute](https://springdoc.cn/spring-boot/web.html#web.reactive.webflux.error-handling)À´¼Ç¼Òì³£¡£ | +| | 在æŸ�些情况下,控制器和处ç�†å‡½æ•°ä¸­å¤„ç�†çš„异常ä¸�会被记录为请求度é‡�标签。应用程åº�å�¯ä»¥é€‰æ‹©åŠ å…¥å¹¶é€šè¿‡[å°†handled exception设置为request attribute](https://springdoc.cn/spring-boot/web.html#web.reactive.webflux.error-handling)æ�¥è®°å½•异常。 | | --- | --- | @@ -4289,32 +4289,32 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jersey)7.3.8\. Jersey Server Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jersey)7.3.8\. Jersey Server 指标 -×Ô¶¯ÅäÖÃʹJersey JAX-RSʵÏÖËù´¦ÀíµÄËùÓÐÇëÇó¶¼Äܱ»²âÁ¿¡£ ĬÈÏÇé¿öÏ£¬Ö¸±êÊÇÒÔ `http.server.requests` ΪÃû³ÆÉú³ÉµÄ¡£ Äã¿ÉÒÔͨ¹ýÉèÖà `management.observations.http.server.requests.name` ÊôÐÔÀ´¶¨ÖÆÃû³Æ¡£ +自动é…�置使Jersey JAX-RS实现所处ç�†çš„æ‰€æœ‰è¯·æ±‚都能被测é‡�。 默认情况下,指标是以 `http.server.requests` 为å��称生æˆ�的。 ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.observations.http.server.requests.name` 属性æ�¥å®šåˆ¶å��称。 -ĬÈÏÇé¿öÏ£¬Jersey·þÎñÆ÷Ö¸±ê±»±ê¼ÇΪÒÔÏÂÐÅÏ¢¡£ +默认情况下,Jerseyæœ�务器指标被标记为以下信æ�¯ã€‚ -| Tag | ˵Ã÷ | +| Tag | 说明 | | --- | --- | -| `exception` | ´¦ÀíÇëÇóʱÅ׳öµÄÈκÎÒì³£µÄ¼òµ¥ÀàÃû¡£ | -| `method` | ÇëÇóµÄ·½·¨£¨ÀýÈ磬`GET` »ò `POST`£©¡£ | -| `outcome` | ÇëÇóµÄ½á¹û£¬»ùÓÚÏìÓ¦µÄ״̬´úÂë¡£ 1xxÊÇ `INFORMATIONAL`£¬2xxÊÇ `SUCCESS`£¬3xxÊÇ `REDIRECTION`£¬4xxÊÇ `CLIENT_ERROR`£¬5xxÊÇ `SERVER_ERROR`¡£ | -| `status` | ÏìÓ¦µÄHTTP״̬´úÂ루ÀýÈ磬`200` »ò `500`£©¡£ | -| `uri` | Èç¹û¿ÉÄܵϰ£¬ÔÚ½øÐбäÁ¿Ì滻֮ǰ£¬ÇëÇóµÄURIÄ£°å£¨ÀýÈ磺`/api/person/{id}`£©¡£ | +| `exception` | 处ç�†è¯·æ±‚时抛出的任何异常的简å�•ç±»å��。 | +| `method` | 请求的方法(例如,`GET` 或 `POST`)。 | +| `outcome` | 请求的结果,基于å“�应的状æ€�代ç �。 1xx是 `INFORMATIONAL`,2xx是 `SUCCESS`,3xx是 `REDIRECTION`,4xx是 `CLIENT_ERROR`,5xx是 `SERVER_ERROR`。 | +| `status` | å“�应的HTTP状æ€�代ç �(例如,`200` 或 `500`)。 | +| `uri` | 如果å�¯èƒ½çš„è¯�,在进行å�˜é‡�替æ�¢ä¹‹å‰�,请求的URI模æ�¿ï¼ˆä¾‹å¦‚:`/api/person/{id}`)。 | -Òª¶¨ÖƱêÇ©£¬ÇëÌṩһ¸öʵÏÖ `JerseyTagsProvider` µÄ `@Bean`¡£ +è¦�定制标签,请æ��供一个实现 `JerseyTagsProvider` çš„ `@Bean`。 @@ -4322,49 +4322,49 @@ Spring BootΪ -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.http-clients)7.3.9\. HTTP Client Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.http-clients)7.3.9\. HTTP Client 指标 -Spring Boot Actuator¸ºÔð¹ÜÀí `RestTemplate` ºÍ `WebClient` µÄ¹¤¾ß¡£Îª´Ë£¬Äã±ØÐë×¢Èë×Ô¶¯ÅäÖõĹ¹½¨Æ÷²¢Ê¹ÓÃËüÀ´´´½¨ÊµÀý¡£ +Spring Boot Actuator负责管ç�† `RestTemplate` å’Œ `WebClient` 的工具。为此,你必须注入自动é…�置的构建器并使用它æ�¥åˆ›å»ºå®žä¾‹ã€‚ -* `RestTemplateBuilder` ÓÃÓÚ `RestTemplate` +* `RestTemplateBuilder` 用于 `RestTemplate` -* `WebClient.Builder` ÓÃÓÚ `WebClient` +* `WebClient.Builder` 用于 `WebClient` -ÄãÒ²¿ÉÒÔÊÖ¶¯Ó¦ÓøºÔðÕâ¸ö¹¤¾ßµÄcustomizer£¬¼´ `ObservationRestTemplateCustomizer` ºÍ `ObservationWebClientCustomizer`¡£ +你也å�¯ä»¥æ‰‹åŠ¨åº”ç”¨è´Ÿè´£è¿™ä¸ªå·¥å…·çš„customizer,å�³ `ObservationRestTemplateCustomizer` å’Œ `ObservationWebClientCustomizer`。 -ĬÈÏÇé¿öÏ£¬Ö¸±êÊÇÒÔ `http.client.requests` Õâ¸öÃû×ÖÉú³ÉµÄ¡£ +默认情况下,指标是以 `http.client.requests` 这个å��字生æˆ�的。 -Äã¿ÉÒÔͨ¹ýÉèÖà `management.observations.http.client.requests.name` ÊôÐÔÀ´¶¨ÖÆÕâ¸öÃû×Ö¡£ +ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.observations.http.client.requests.name` 属性æ�¥å®šåˆ¶è¿™ä¸ªå��字。 -¹ØÓÚ²úÉúµÄ¹Û²ì½á¹û£¨observation£©µÄ¸ü¶àÐÅÏ¢£¬Çë²Î¼û [Spring Framework ²Î¿¼Îĵµ](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/integration.html#integration.observability.http-client)¡£ +关于产生的观察结果(observation)的更多信æ�¯ï¼Œè¯·å�‚è§� [Spring Framework å�‚考文档](https://docs.spring.io/spring-framework/docs/6.0.5/reference/html/integration.html#integration.observability.http-client)。 -ÒªÔÚʹÓà `RestTemplate` ʱ¶¨ÖƱêÇ©£¬ÇëÌṩһ¸öʵÏÖÁË `org.springframework.http.client.observation` °üÖÐ `ClientRequestObservationConvention` µÄ `@Bean`¡£ÒªÔÚʹÓà `WebClient` ʱ×Ô¶¨Òå±êÇ©£¬ÇëÌṩһ¸öʵÏÖÁË `org.springframework.web.reactive.function.client` °üÖÐ `ClientRequestObservationConvention` µÄ `@Bean`¡£ +è¦�在使用 `RestTemplate` 时定制标签,请æ��供一个实现了 `org.springframework.http.client.observation` 包中 `ClientRequestObservationConvention` çš„ `@Bean`。è¦�在使用 `WebClient` 时自定义标签,请æ��供一个实现了 `org.springframework.web.reactive.function.client` 包中 `ClientRequestObservationConvention` çš„ `@Bean`。 @@ -4372,17 +4372,17 @@ Spring Boot Actuator -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.tomcat)7.3.10\. Tomcat Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.tomcat)7.3.10\. Tomcat 指标 -×Ô¶¯ÅäÖýöÔÚ `MBeanRegistry` ±»ÆôÓÃʱ²Å»áÆôÓÃTomcatµÄÒÇÆ÷¡£ ĬÈÏÇé¿öÏ£¬`MBeanRegistry` ÊǽûÓõ쬵«Äã¿ÉÒÔͨ¹ýÉèÖà `server.tomcat.mbeanregistry.enabled` Ϊ `true` À´ÆôÓÃËü¡£ +自动é…�置仅在 `MBeanRegistry` 被å�¯ç”¨æ—¶æ‰�会å�¯ç”¨Tomcat的仪器。 默认情况下,`MBeanRegistry` 是ç¦�用的,但你å�¯ä»¥é€šè¿‡è®¾ç½® `server.tomcat.mbeanregistry.enabled` 为 `true` æ�¥å�¯ç”¨å®ƒã€‚ -TomcatµÄÖ¸±êÔÚ `tomcat.` meter ÃûÏ·¢²¼¡£ +Tomcat的指标在 `tomcat.` meter å��下å�‘布。 @@ -4390,29 +4390,29 @@ Tomcat -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.cache)7.3.11\. Cache Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.cache)7.3.11\. Cache 指标 -×Ô¶¯ÅäÖÿÉÒÔÔÚÆô¶¯Ê±¶ÔËùÓпÉÓÃµÄ `Cache` ʵÀý½øÐмì²â£¬ÆäÖ¸±êÒÔ `cache` Ϊǰ׺¡£ +自动é…�ç½®å�¯ä»¥åœ¨å�¯åŠ¨æ—¶å¯¹æ‰€æœ‰å�¯ç”¨çš„ `Cache` 实例进行检测,其指标以 `cache` 为å‰�缀。 -»º´æÒDZíÊDZê×¼»¯µÄ»ù±¾Ö¸±ê¼¯¡£ +缓存仪表是标准化的基本指标集。 -Ò²¿ÉÒÔʹÓöîÍâµÄ¡¢Õë¶Ô»º´æµÄÖ¸±ê¡£ +也å�¯ä»¥ä½¿ç”¨é¢�外的ã€�针对缓存的指标。 -Ö§³ÖÒÔÏ»º´æ¿â¡£ +支æŒ�以下缓存库。 @@ -4424,7 +4424,7 @@ Tomcat * Hazelcast -* ÈκμæÈݵÄJCache£¨JSR-107£©ÊµÏÖ +* 任何兼容的JCache(JSR-107)实现 * Redis @@ -4432,13 +4432,13 @@ Tomcat -Ö¸±êÓÉ»º´æµÄÃû³ÆºÍ `CacheManager` µÄÃû³ÆÀ´±ê¼Ç£¬`CacheManager` µÄÃû³ÆÊÇÓÉBeanÃû³ÆÅÉÉúµÄ¡£ +指标由缓存的å��ç§°å’Œ `CacheManager` çš„å��ç§°æ�¥æ ‡è®°ï¼Œ`CacheManager` çš„å��称是由Beanå��称派生的。 -| | Ö»ÓÐÔÚÆô¶¯Ê±ÅäÖõĻº´æ±»°ó¶¨µ½×¢²á±í¡£ ¶ÔÓÚûÓÐÔÚ»º´æÅäÖÃÖж¨ÒåµÄ»º´æ£¬ÀýÈçÔÚÆô¶¯½×¶ÎºóÁÙʱ´´½¨µÄ»º´æ»òÒÔ±à³Ì·½Ê½´´½¨µÄ»º´æ£¬ÐèÒªÃ÷È·×¢²á¡£ Ò»¸ö `CacheMetricsRegistrar` Bean¿ÉÒÔʹÕâ¸ö¹ý³Ì¸üÈÝÒס£ | +| | å�ªæœ‰åœ¨å�¯åŠ¨æ—¶é…�置的缓存被绑定到注册表。 对于没有在缓存é…�置中定义的缓存,例如在å�¯åŠ¨é˜¶æ®µå�Žä¸´æ—¶åˆ›å»ºçš„缓存或以编程方å¼�创建的缓存,需è¦�明确注册。 一个 `CacheMetricsRegistrar` Beanå�¯ä»¥ä½¿è¿™ä¸ªè¿‡ç¨‹æ›´å®¹æ˜“。 | | --- | --- | @@ -4447,11 +4447,11 @@ Tomcat -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-graphql)7.3.12\. Spring GraphQL Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-graphql)7.3.12\. Spring GraphQL 指标 -²Î¼û [Spring GraphQL ²Î¿¼Îĵµ](https://docs.spring.io/spring-graphql/docs/1.1.2/reference/html/)¡£ +å�‚è§� [Spring GraphQL å�‚考文档](https://docs.spring.io/spring-graphql/docs/1.1.2/reference/html/)。 @@ -4459,30 +4459,30 @@ Tomcat -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jdbc)7.3.13\. DataSource Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jdbc)7.3.13\. DataSource 指标 -×Ô¶¯ÅäÖÃʹËùÓпÉÓÃµÄ `DataSource` ¶ÔÏóµÄÒÇÆ÷»¯£¬Ö¸±êǰ׺Ϊ `jdbc.connections`¡£ Êý¾ÝÔ´¼ì²âµÄ½á¹ûÊDZíʾ³ØÖе±Ç°»î¶¯µÄ¡¢¿ÕÏеġ¢×î´óÔÊÐíµÄºÍ×îСÔÊÐíµÄÁ¬½ÓÊýµÄÒÇ±í¡£ +自动é…�置使所有å�¯ç”¨çš„ `DataSource` 对象的仪器化,指标å‰�缀为 `jdbc.connections`。 æ•°æ�®æº�检测的结果是表示池中当å‰�活动的ã€�空闲的ã€�最大å…�许的和最å°�å…�许的连接数的仪表。 -ºâÁ¿±ê×¼Ò²ÓÉ»ùÓÚbeanÃû³Æ¼ÆËãµÄ `DataSource` µÄÃû³ÆÀ´±ê¼Ç¡£ +è¡¡é‡�标准也由基于beanå��称计算的 `DataSource` çš„å��ç§°æ�¥æ ‡è®°ã€‚ -| | ĬÈÏÇé¿öÏ£¬Spring BootΪËùÓÐÖ§³ÖµÄÊý¾ÝÔ´ÌṩԪÊý¾Ý¡£ Èç¹ûÄãϲ»¶µÄÊý¾ÝÔ´²»±»Ö§³Ö£¬Äã¿ÉÒÔÌí¼Ó¶îÍâµÄ `DataSourcePoolMetadataProvider` Bean¡£ Çë²ÎÔÄ `DataSourcePoolMetadataProvidersConfiguration` ÒÔÁ˽âʵÀý¡£ | +| | 默认情况下,Spring Boot为所有支æŒ�的数æ�®æº�æ��供元数æ�®ã€‚ 如果你喜欢的数æ�®æº�ä¸�被支æŒ�,你å�¯ä»¥æ·»åŠ é¢�外的 `DataSourcePoolMetadataProvider` Bean。 请å�‚阅 `DataSourcePoolMetadataProvidersConfiguration` 以了解实例。 | | --- | --- | -´ËÍ⣬HikariÌØ¶¨µÄÖ¸±êÒÔ `hikaricp` ǰ׺±©Â¶¡£ ÿ¸öÖ¸±ê¶¼±»poolµÄÃû×ÖËù±ê¼Ç£¨Äã¿ÉÒÔÓà `spring.datasource.name` À´¿ØÖÆ£©¡£ +此外,Hikari特定的指标以 `hikaricp` å‰�缀暴露。 æ¯�个指标都被poolçš„å��字所标记(你å�¯ä»¥ç”¨ `spring.datasource.name` æ�¥æŽ§åˆ¶ï¼‰ã€‚ @@ -4490,23 +4490,23 @@ Tomcat -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.hibernate)7.3.14\. Hibernate Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.hibernate)7.3.14\. Hibernate 指标 -Èç¹û `org.hibernate.orm:hibernate-micrometer` ÔÚclasspathÉÏ£¬ËùÓÐÆôÓÃÁËͳ¼Æ¹¦ÄܵÄHibernate `EntityManagerFactory` ʵÀý¶¼»á±»Ò»¸öÃûΪ `hibernate` µÄÖ¸±êËù¼ì²â¡£ +如果 `org.hibernate.orm:hibernate-micrometer` 在classpath上,所有å�¯ç”¨äº†ç»Ÿè®¡åŠŸèƒ½çš„Hibernate `EntityManagerFactory` 实例都会被一个å��为 `hibernate` 的指标所检测。 -ºâÁ¿±ê×¼Ò²ÓÉ `EntityManagerFactory` µÄÃû³ÆÀ´±ê¼Ç£¬¸ÃÃû³ÆÊÇÓÉBeanÃû³ÆÅÉÉúµÄ¡£ +è¡¡é‡�标准也由 `EntityManagerFactory` çš„å��ç§°æ�¥æ ‡è®°ï¼Œè¯¥å��称是由Beanå��称派生的。 -ÒªÆôÓÃͳ¼Æ£¬±ê×¼JPAÊôÐÔ `hibernate.generate_statistics` ±ØÐëÉèÖÃΪ `true`¡£ Äã¿ÉÒÔÔÚ×Ô¶¯ÅäÖÃµÄ `EntityManagerFactory` ÉÏÆôÓᣠ+è¦�å�¯ç”¨ç»Ÿè®¡ï¼Œæ ‡å‡†JPA属性 `hibernate.generate_statistics` 必须设置为 `true`。 ä½ å�¯ä»¥åœ¨è‡ªåЍé…�置的 `EntityManagerFactory` 上å�¯ç”¨ã€‚ @@ -4535,44 +4535,44 @@ spring.jpa.properties[hibernate.generate_statistics]=true -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-data-repository)7.3.15\. Spring Data Repository Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-data-repository)7.3.15\. Spring Data Repository 指标 -×Ô¶¯ÅäÖÃÄܹ»¶ÔËùÓÐSpring Data `Repository` ·½·¨µÄµ÷ÓýøÐжÈÁ¿¡£ ĬÈÏÇé¿öÏ£¬Ö¸±êÒÔ `spring.data.repository.invocations` ΪÃûÉú³É¡£ Äã¿ÉÒÔͨ¹ýÉèÖà `management.metrics.data.repository.metric-name` ÊôÐÔÀ´×Ô¶¨ÒåÃû³Æ¡£ +自动é…�置能够对所有Spring Data `Repository` 方法的调用进行度é‡�。 默认情况下,指标以 `spring.data.repository.invocations` 为å��生æˆ�。 ä½ å�¯ä»¥é€šè¿‡è®¾ç½® `management.metrics.data.repository.metric-name` 属性æ�¥è‡ªå®šä¹‰å��称。 -`io.micrometer.core.annotation` °üÖÐµÄ `@Timed` ×¢½âÖ§³Ö `Repository` ½Ó¿ÚºÍ·½·¨¡£Èç¹ûÄã²»Ïë¼Ç¼ËùÓÐ `Repository` µ÷ÓõĶÈÁ¿£¨metric£©£¬Äã¿ÉÒÔ½« `management.metrics.data.repository.autotime.enabled` ÉèÖÃΪ `false`£¬¶ø×¨ÃÅʹÓà `@Timed` ×¢½â¡£ +`io.micrometer.core.annotation` 包中的 `@Timed` 注解支æŒ� `Repository` 接å�£å’Œæ–¹æ³•。如果你ä¸�想记录所有 `Repository` 调用的度é‡�(metric),你å�¯ä»¥å°† `management.metrics.data.repository.autotime.enabled` 设置为 `false`,而专门使用 `@Timed` 注解。 -| | Ò»¸ö´øÓÐ `longTask = true` µÄ `@Timed` ×¢½â¿ÉÒÔΪ¸Ã·½·¨ÆôÓÃÒ»¸ö³¤ÈÎÎñ¼ÆÊ±Æ÷¡£³¤ÈÎÎñ¶¨Ê±Æ÷ÐèÒªÒ»¸öµ¥¶ÀµÄ metric name£¬²¢ÇÒ¿ÉÒÔÓë¶ÌÈÎÎñ¶¨Ê±Æ÷£¨task timer£©µþ¼Ó¡£ | +| | 一个带有 `longTask = true` çš„ `@Timed` 注解å�¯ä»¥ä¸ºè¯¥æ–¹æ³•å�¯ç”¨ä¸€ä¸ªé•¿ä»»åŠ¡è®¡æ—¶å™¨ã€‚é•¿ä»»åŠ¡å®šæ—¶å™¨éœ€è¦�一个å�•独的 metric name,并且å�¯ä»¥ä¸ŽçŸ­ä»»åŠ¡å®šæ—¶å™¨ï¼ˆtask timer)å� åŠ ã€‚ | | --- | --- | -ĬÈÏÇé¿öÏ£¬repositoryµ÷ÓÃÏà¹ØµÄ¶ÈÁ¿±ê×¼±»±ê¼ÇΪÒÔÏÂÐÅÏ¢¡£ +默认情况下,repository调用相关的度é‡�标准被标记为以下信æ�¯ã€‚ -| Tag | ˵Ã÷ | +| Tag | 说明 | | --- | --- | -| `repository` | Ô´ `Repository` µÄ¼òµ¥ÀàÃû¡£ | -| `method` | ±»µ÷ÓÃµÄ `Repository` ·½·¨µÄÃû³Æ¡£ | -| `state` | ½á¹û״̬£¨`SUCCESS`, `ERROR`, `CANCELED`, `RUNNING`£©¡£ | -| `exception` | µ÷ÓÃÖÐÅ׳öµÄÈκÎÒì³£µÄ¼òµ¥ÀàÃû¡£ | +| `repository` | æº� `Repository` 的简å�•ç±»å��。 | +| `method` | 被调用的 `Repository` 方法的å��称。 | +| `state` | 结果状æ€�(`SUCCESS`, `ERROR`, `CANCELED`, `RUNNING`)。 | +| `exception` | 调用中抛出的任何异常的简å�•ç±»å��。 | -ÒªÌæ»»Ä¬ÈϱêÇ©£¬ÐèÒªÌṩһ¸öʵÏÖÁË `RepositoryTagsProvider` µÄ `@Bean`¡£ +è¦�替æ�¢é»˜è®¤æ ‡ç­¾ï¼Œéœ€è¦�æ��供一个实现了 `RepositoryTagsProvider` çš„ `@Bean`。 @@ -4580,11 +4580,11 @@ spring.jpa.properties[hibernate.generate_statistics]=true -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.rabbitmq)7.3.16\. RabbitMQ Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.rabbitmq)7.3.16\. RabbitMQ 指标 -×Ô¶¯ÅäÖÃʹËùÓпÉÓÃµÄ RabbitMQ Á¬½Ó¹¤³§µÄÒÇÆ÷»¯£¬ÆäÖ¸±êÃûΪ `rabbitmq`¡£ +自动é…�置使所有å�¯ç”¨çš„ RabbitMQ 连接工厂的仪器化,其指标å��为 `rabbitmq`。 @@ -4592,11 +4592,11 @@ spring.jpa.properties[hibernate.generate_statistics]=true -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-integration)7.3.17\. Spring Integration Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.spring-integration)7.3.17\. Spring Integration 指标 -Ö»ÒªÓÐ `MeterRegistry` bean£¬Spring Integration¾Í»á×Ô¶¯Ìṩ [Micrometer support](https://docs.spring.io/spring-integration/docs/6.1.0-M1/reference/html/system-management.html#micrometer-integration)¡£ ¶ÈÁ¿±ê×¼ÔÚ `spring.integration.` meter Ãû³ÆÏ·¢²¼¡£ +å�ªè¦�有 `MeterRegistry` bean,Spring Integration就会自动æ��ä¾› [Micrometer support](https://docs.spring.io/spring-integration/docs/6.1.0-M1/reference/html/system-management.html#micrometer-integration)。 度é‡�标准在 `spring.integration.` meter å��称下å�‘布。 @@ -4604,11 +4604,11 @@ spring.jpa.properties[hibernate.generate_statistics]=true -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.kafka)7.3.18\. Kafka Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.kafka)7.3.18\. Kafka 指标 -×Ô¶¯ÅäÖÃΪ×Ô¶¯ÅäÖõÄÏû·ÑÕß¹¤³§ºÍÉú²úÕß¹¤³§·Ö±ð×¢²áÁËÒ»¸ö `MicrometerConsumerListener` ºÍ `MicrometerProducerListener`¡£ Ëü»¹Îª `StreamsBuilderFactoryBean` ×¢²áÁËÒ»¸ö `KafkaStreamsMicrometerListener`¡£ ¸ü¶àϸ½Ú£¬Çë²ÎÔÄSpring KafkaÎĵµÖÐµÄ [Micrometer Native Metrics](https://docs.spring.io/spring-kafka/docs/3.0.3/reference/html/#micrometer-native) ²¿·Ö¡£ +自动é…�置为自动é…�置的消费者工厂和生产者工厂分别注册了一个 `MicrometerConsumerListener` å’Œ `MicrometerProducerListener`。 它还为 `StreamsBuilderFactoryBean` 注册了一个 `KafkaStreamsMicrometerListener`。 更多细节,请å�‚阅Spring Kafka文档中的 [Micrometer Native Metrics](https://docs.spring.io/spring-kafka/docs/3.0.3/reference/html/#micrometer-native) 部分。 @@ -4616,41 +4616,41 @@ spring.jpa.properties[hibernate.generate_statistics]=true -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.mongodb)7.3.19\. MongoDB Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.mongodb)7.3.19\. MongoDB 指标 -±¾½Ú¼òÒª½éÉÜMongoDBµÄ¿ÉÓöÈÁ¿¡£ +本节简è¦�介ç»�MongoDBçš„å�¯ç”¨åº¦é‡�。 -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.mongodb.command)MongoDBÃüÁîÖ¸±ê +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.mongodb.command)MongoDB命令指标 -×Ô¶¯ÅäÖý« `MongoMetricsCommandListener` Óë×Ô¶¯ÅäÖÃµÄ `MongoClient` ×¢²á¡£ +自动é…�置将 `MongoMetricsCommandListener` 与自动é…�置的 `MongoClient` 注册。 -Ò»¸öÃûΪ `mongodb.driver.commands` µÄtimerÖ¸±ê±»´´½¨£¬ÓÃÓÚÏòµ×²ãMongoDB driver·¢³öµÄÿÌõÃüÁî¡£ ĬÈÏÇé¿öÏ£¬Ã¿¸öÖ¸±ê¶¼±»±ê¼ÇΪÒÔÏÂÐÅÏ¢¡£ +一个å��为 `mongodb.driver.commands` çš„timer指标被创建,用于å�‘底层MongoDB driverå�‘出的æ¯�æ�¡å‘½ä»¤ã€‚ 默认情况下,æ¯�个指标都被标记为以下信æ�¯ã€‚ -| Tag | ˵Ã÷ | +| Tag | 说明 | | --- | --- | -| `command` | ·¢³öµÄÃüÁîµÄÃû³Æ¡£ | -| `cluster.id` | ·¢Ë͸ÃÃüÁîµÄ¼¯ÈºµÄ±êʶ·û¡£ | -| `server.address` | ·¢ËÍÃüÁîµÄ·þÎñÆ÷µÄµØÖ·¡£ | -| `status` | ÃüÁîµÄ½á¹û£¨`SUCCESS` »ò `FAILED£©¡£ | +| `command` | å�‘出的命令的å��称。 | +| `cluster.id` | å�‘é€�该命令的集群的标识符。 | +| `server.address` | å�‘é€�命令的æœ�务器的地å�€ã€‚ | +| `status` | 命令的结果(`SUCCESS` 或 `FAILED)。 | -ΪÁËÌæ»»Ä¬ÈϵĶÈÁ¿ºâ±êÇ©£¬¶¨ÒåÒ»¸ö `MongoCommandTagsProvider` bean£¬ÈçÏÂÀýËùʾ¡£ +为了替æ�¢é»˜è®¤çš„度é‡�衡标签,定义一个 `MongoCommandTagsProvider` bean,如下例所示。 @@ -4685,7 +4685,7 @@ public class MyCommandTagsProviderConfiguration { -Òª½ûÓÃ×Ô¶¯ÅäÖõÄÃüÁî¶ÈÁ¿£¬ÇëÉèÖÃÒÔÏÂÊôÐÔ¡£ +è¦�ç¦�用自动é…�置的命令度é‡�,请设置以下属性。 @@ -4714,45 +4714,45 @@ management.metrics.mongo.command.enabled=false -##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.mongodb.connection-pool)MongoDB Á¬½Ó³ØÖ¸±ê +##### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.mongodb.connection-pool)MongoDB 连接池指标 -×Ô¶¯ÅäÖý« `MongoMetricsConnectionPoolListener` Óë×Ô¶¯ÅäÖÃµÄ `MongoClient` ×¢²á¡£ +自动é…�置将 `MongoMetricsConnectionPoolListener` 与自动é…�置的 `MongoClient` 注册。 -ÒÔÏÂÊÇΪÁ¬½Ó³Ø´´½¨µÄ²âÁ¿Ö¸±ê¡£ +以下是为连接池创建的测é‡�指标。 -* `mongodb.driver.pool.size` ±¨¸æÁ¬½Ó³ØµÄµ±Ç°´óС£¬°üÀ¨¿ÕÏкÍÕýÔÚʹÓõijÉÔ±¡£ +* `mongodb.driver.pool.size` 报告连接池的当å‰�大å°�,包括空闲和正在使用的æˆ�员。 -* `mongodb.driver.pool.checkedout` ±¨¸æµ±Ç°Ê¹ÓÃÖеÄÁ¬½ÓÊý¡£ +* `mongodb.driver.pool.checkedout` 报告当å‰�使用中的连接数。 -* `mongodb.driver.pool.waitqueuesize` ±¨¸æ³ØÖÐÁ¬½ÓµÄµÈ´ý¶ÓÁеĵ±Ç°´óС¡£ +* `mongodb.driver.pool.waitqueuesize` 报告池中连接的等待队列的当å‰�大å°�。 -ĬÈÏÇé¿öÏ£¬Ã¿¸öÖ¸±ê¶¼±»±ê¼ÇΪÒÔÏÂÐÅÏ¢¡£ +默认情况下,æ¯�个指标都被标记为以下信æ�¯ã€‚ -| Tag | ˵Ã÷ | +| Tag | 说明 | | --- | --- | -| `cluster.id` | Á¬½Ó³ØËù¶ÔÓ¦µÄ¼¯ÈºµÄ±êʶ·û¡£ | -| `server.address` | Á¬½Ó³ØËù¶ÔÓ¦µÄ·þÎñÆ÷µÄµØÖ·¡£ | +| `cluster.id` | 连接池所对应的集群的标识符。 | +| `server.address` | 连接池所对应的æœ�务器的地å�€ã€‚ | -Ҫȡ´úĬÈϵĶÈÁ¿ºâ±êÇ©£¬Ç붨ÒåÒ»¸ö `MongoConnectionPoolTagsProvider` bean¡£ +è¦�å�–代默认的度é‡�衡标签,请定义一个 `MongoConnectionPoolTagsProvider` bean。 @@ -4787,7 +4787,7 @@ public class MyConnectionPoolTagsProviderConfiguration { -Òª½ûÓÃ×Ô¶¯ÅäÖõÄÁ¬½Ó³Ø¶ÈÁ¿£¬ÇëÉèÖÃÒÔÏÂÊôÐÔ¡£ +è¦�ç¦�用自动é…�置的连接池度é‡�,请设置以下属性。 @@ -4818,11 +4818,11 @@ management.metrics.mongo.connectionpool.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jetty)7.3.20\. Jetty Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.jetty)7.3.20\. Jetty 指标 -×Ô¶¯ÅäÖÃͨ¹ýʹÓÃMicrometerµÄ `JettyServerThreadPoolMetrics` ΪJettyµÄ `ThreadPool` °ó¶¨Ö¸±ê¡£ JettyµÄ `Connector` ʵÀýµÄÖ¸±êͨ¹ýʹÓÃMicrometerµÄ `JettyConnectionMetrics` À´°ó¶¨£¬µ± `server.ssl.enabled` ±»ÉèÖÃΪ `true` ʱ£¬MicrometerµÄ `JettySslHandshakeMetrics`¡£ +自动é…�置通过使用Micrometerçš„ `JettyServerThreadPoolMetrics` 为Jettyçš„ `ThreadPool` 绑定指标。 Jettyçš„ `Connector` 实例的指标通过使用Micrometerçš„ `JettyConnectionMetrics` æ�¥ç»‘定,当 `server.ssl.enabled` 被设置为 `true` 时,Micrometerçš„ `JettySslHandshakeMetrics`。 @@ -4830,11 +4830,11 @@ management.metrics.mongo.connectionpool.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.timed-annotation)7.3.21\. @Timed ×¢½âµÄÖ§³Ö +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.timed-annotation)7.3.21\. @Timed 注解的支æŒ� -ÒªÔÚSpring Boot²»Ö±½ÓÖ§³ÖµÄµØ·½Ê¹Óà `@Timed`£¬Çë²Î¿¼ [Micrometer Îĵµ](https://micrometer.io/docs/concepts#_the_timed_annotation)¡£ +è¦�在Spring Bootä¸�直接支æŒ�的地方使用 `@Timed`,请å�‚考 [Micrometer 文档](https://micrometer.io/docs/concepts#_the_timed_annotation)。 @@ -4842,11 +4842,11 @@ management.metrics.mongo.connectionpool.enabled=false -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.redis)7.3.22\. Redis Ö¸±ê +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.supported.redis)7.3.22\. Redis 指标 -×Ô¶¯ÅäÖÃΪ×Ô¶¯ÅäÖÃµÄ `LettuceConnectionFactory` ×¢²áÁËÒ»¸ö `MicrometerCommandLatencyRecorder`¡£ ¸ü¶àϸ½Ú£¬Çë²ÎÔÄLettuceÎĵµµÄ [Micrometer Metrics²¿·Ö](https://lettuce.io/core/6.2.3.RELEASE/reference/index.html#command.latency.metrics.micrometer)¡£ +自动é…�置为自动é…�置的 `LettuceConnectionFactory` 注册了一个 `MicrometerCommandLatencyRecorder`。 更多细节,请å�‚阅Lettuce文档的 [Micrometer Metrics部分](https://lettuce.io/core/6.2.3.RELEASE/reference/index.html#command.latency.metrics.micrometer)。 @@ -4856,11 +4856,11 @@ management.metrics.mongo.connectionpool.enabled=false -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.registering-custom)7.4\. ×¢²á×Ô¶¨ÒåÖ¸±ê +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.registering-custom)7.4\. 注册自定义指标 -Ҫע²á×Ô¶¨Òå¶ÈÁ¿£¬Ç뽫 `MeterRegistry` ×¢ÈëÄãµÄ×é¼þÖС£ +è¦�注册自定义度é‡�,请将 `MeterRegistry` 注入你的组件中。 @@ -4897,7 +4897,7 @@ public class MyBean { -Èç¹ûÄãµÄ¶ÈÁ¿±ê×¼ÒÀÀµÓÚÆäËûBean£¬ÎÒÃǽ¨ÒéÄãʹÓà `MeterBinder` À´×¢²áËüÃÇ¡£ +如果你的度é‡�标准ä¾�赖于其他Bean,我们建议你使用 `MeterBinder` æ�¥æ³¨å†Œå®ƒä»¬ã€‚ @@ -4931,13 +4931,13 @@ public class MyMeterBinderConfiguration { -ʹÓà `MeterBinder` ¿ÉÒÔÈ·±£½¨Á¢ÕýÈ·µÄÒÀÀµ¹ØÏµ£¬²¢ÇÒÔÚ¼ìË÷¶ÈÁ¿ÖµµÄʱºò£¬BeanÊÇ¿ÉÓõġ£ Èç¹ûÄã·¢ÏÖÄãÔÚ×é¼þ»òÓ¦ÓóÌÐòÖÐÖØ¸´²âÁ¿Ò»Ì×Ö¸±ê£¬ÄÇô `MeterBinder` µÄʵÏÖÒ²»áºÜÓÐÓᣠ+使用 `MeterBinder` å�¯ä»¥ç¡®ä¿�建立正确的ä¾�赖关系,并且在检索度é‡�值的时候,Bean是å�¯ç”¨çš„。 如果你å�‘现你在组件或应用程åº�中é‡�å¤�测é‡�一套指标,那么 `MeterBinder` 的实现也会很有用。 -| | ĬÈÏÇé¿öÏ£¬ËùÓÐ `MeterBinder` BeanµÄÖ¸±ê¶¼»á×Ô¶¯°ó¶¨µ½Spring¹ÜÀíµÄ `MeterRegistry`¡£ | +| | 默认情况下,所有 `MeterBinder` Bean的指标都会自动绑定到Spring管ç�†çš„ `MeterRegistry`。 | | --- | --- | @@ -4946,17 +4946,17 @@ public class MyMeterBinderConfiguration { -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.customizing)7.5\. ¶¨ÖƸö±ðÖ¸±ê +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.customizing)7.5\. 定制个别指标 -Èç¹ûÄãÐèÒª¶ÔÌØ¶¨µÄ `Meter` ʵÀý½øÐÐ×Ô¶¨Ò壬Äã¿ÉÒÔʹÓà `io.micrometer.core.instrument.config.MeterFilter` ½Ó¿Ú¡£ +如果你需è¦�对特定的 `Meter` 实例进行自定义,你å�¯ä»¥ä½¿ç”¨ `io.micrometer.core.instrument.config.MeterFilter` 接å�£ã€‚ -ÀýÈ磬Èç¹ûÄãÏë°ÑËùÓÐÒÔ `com.example` ¿ªÍ·µÄÒDZíIDµÄ `mytag.region` ±êÇ©ÖØÃüÃûΪ `mytag.area`£¬Äã¿ÉÒÔ×öÒÔϹ¤×÷¡£ +例如,如果你想把所有以 `com.example` 开头的仪表IDçš„ `mytag.region` 标签é‡�命å��为 `mytag.area`,你å�¯ä»¥å�šä»¥ä¸‹å·¥ä½œã€‚ @@ -4991,18 +4991,18 @@ public class MyMetricsFilterConfiguration { -| | ĬÈÏÇé¿öÏ£¬ËùÓÐµÄ `MeterFilter` Bean¶¼×Ô¶¯°ó¶¨µ½Spring¹ÜÀíµÄ `MeterRegistry`¡£ ÇëÈ·±£Ê¹ÓÃSpring¹ÜÀíµÄ `MeterRegistry` À´×¢²áÄãµÄÖ¸±ê£¬¶ø²»ÊÇʹÓà `Metrics` µÄÈκξ²Ì¬·½·¨¡£ ÕâЩ·½·¨Ê¹ÓõÄÊDz»±»Spring¹ÜÀíµÄÈ«¾Ö×¢²á±í¡£ | +| | 默认情况下,所有的 `MeterFilter` Bean都自动绑定到Spring管ç�†çš„ `MeterRegistry`。 请确ä¿�使用Spring管ç�†çš„ `MeterRegistry` æ�¥æ³¨å†Œä½ çš„æŒ‡æ ‡ï¼Œè€Œä¸�是使用 `Metrics` 的任何é�™æ€�方法。 这些方法使用的是ä¸�被Spring管ç�†çš„全局注册表。 | | --- | --- | -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.customizing.common-tags)7.5.1\. ³£¼û±êÇ©£¨Tag£© +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.customizing.common-tags)7.5.1\. 常è§�标签(Tag) -ͨÓñêǩһ°ãÓÃÓÚ¶ÔÔËÐл·¾³½øÐÐά¶ÈÏÂ×꣬ÈçÖ÷»ú¡¢ÊµÀý¡¢ÇøÓò¡¢¶ÑÕ»µÈ¡£ ¹²ÓñêÇ©ÊÊÓÃÓÚËùÓÐÒÇ±í£¬¿ÉÒÔ½øÐÐÅäÖã¬ÈçÏÂÀýËùʾ¡£ +通用标签一般用于对è¿�行环境进行维度下钻,如主机ã€�实例ã€�区域ã€�堆栈等。 共用标签适用于所有仪表,å�¯ä»¥è¿›è¡Œé…�置,如下例所示。 @@ -5030,13 +5030,13 @@ management.metrics.tags.stack=prod -Ç°ÃæµÄÀý×ÓΪËùÓÐֵΪ `us-east-1` ºÍ `prod` µÄÒDZíÌí¼ÓÁË `region` ºÍ `stack` ±êÇ©¡£ +å‰�é�¢çš„例å­�为所有值为 `us-east-1` å’Œ `prod` 的仪表添加了 `region` å’Œ `stack` 标签。 -| | Èç¹ûÄãʹÓÃGraphite£¬ÆÕͨ±êÇ©µÄ˳ÐòÊǺÜÖØÒªµÄ¡£ ÓÉÓÚʹÓÃÕâÖÖ·½·¨²»Äܱ£Ö¤³£¼û±êÇ©µÄ˳Ðò£¬½¨ÒéGraphiteÓû§¶¨ÒåÒ»¸ö×Ô¶¨ÒåµÄ `MeterFilter` À´´úÌæ¡£ | +| | 如果你使用Graphite,普通标签的顺åº�是很é‡�è¦�的。 由于使用这ç§�方法ä¸�能ä¿�è¯�常è§�标签的顺åº�,建议Graphite用户定义一个自定义的 `MeterFilter` æ�¥ä»£æ›¿ã€‚ | | --- | --- | @@ -5049,7 +5049,7 @@ management.metrics.tags.stack=prod -³ýÁË `MeterFilter` Bean£¬Ä㻹¿ÉÒÔʹÓÃÊôÐÔÔÚÿ¸ö±íµÄ»ù´¡ÉÏÓ¦ÓÃÒ»×éÓÐÏÞµÄ×Ô¶¨Ò幦ÄÜ¡£ ʹÓÃSpring BootµÄ `PropertiesMeterFilter`£¬Ã¿¸ö±íµÄ¶¨ÖƱ»Ó¦ÓÃÓÚÒÔ¸ø¶¨Ãû³Æ¿ªÍ·µÄÈκαíµÄID¡£ ÏÂÃæµÄÀý×Ó¹ýÂ˵ôÈκÎIDÒÔ `example.remote` ¿ªÍ·µÄÒÇ±í¡£ +除了 `MeterFilter` Bean,你还å�¯ä»¥ä½¿ç”¨å±žæ€§åœ¨æ¯�个表的基础上应用一组有é™�的自定义功能。 使用Spring Bootçš„ `PropertiesMeterFilter`,æ¯�个表的定制被应用于以给定å��称开头的任何表的ID。 下é�¢çš„例å­�过滤掉任何ID以 `example.remote` 开头的仪表。 @@ -5076,23 +5076,23 @@ management.metrics.enable.example.remote=false -ÏÂÃæµÄÊôÐÔÔÊÐíper-meterµÄ¶¨ÖÆ¡£ +下é�¢çš„属性å…�许per-meter的定制。 Table 1\. Per-meter customizations -| Property | ˵Ã÷ | +| Property | 说明 | | --- | --- | -| `management.metrics.enable` | ÊÇ·ñ½ÓÊܾßÓÐÌØ¶¨IDµÄMeter¡£ ²»½ÓÊܵÄMeter½«´Ó `MeterRegistry` ÖйýÂ˵ô¡£ | -| `management.metrics.distribution.percentiles-histogram` | ÊÇ·ñ·¢²¼ÊʺϼÆËã¿É¾Û¼¯£¨¿çά¶È£©µÄ°Ù·ÖλÊý½üËÆÖµµÄÖ±·½Í¼¡£ | -| `management.metrics.distribution.minimum-expected-value`, `management.metrics.distribution.maximum-expected-value` | ͨ¹ýÇ¯ÖÆÔ¤ÆÚÖµµÄ·¶Î§£¬·¢²¼¸üÉÙµÄÖ±·½Í¼Í°¡£ | -| `management.metrics.distribution.percentiles` | ·¢²¼ÔÚÄãµÄÓ¦ÓóÌÐòÖмÆËãµÄ°Ù·Öλֵ | -| `management.metrics.distribution.expiry`, `management.metrics.distribution.buffer-length` | ͨ¹ýÔÚ»·Ðλº³åÇøÖлýÀÛ×î½üµÄÑù±¾£¬¸øËüÃǸü´óµÄÈ¨ÖØ£¬»·Ðλº³åÇøÔÚ¿ÉÅäÖõĹýÆÚºóÐýת£¬»º³åÇø³¤¶ÈΪ ¿ÉÅäÖõĻº³åÇø³¤¶È¡£ | -| `management.metrics.distribution.slo` | ·¢²¼Ò»¸öÀÛ»ýÖ±·½Í¼£¬ÆäÖеÄͰÓÉÄãµÄ·þÎñˮƽĿ±ê¶¨Òå¡£ | +| `management.metrics.enable` | 是å�¦æŽ¥å�—具有特定IDçš„Meter。 ä¸�接å�—çš„Meter将从 `MeterRegistry` 中过滤掉。 | +| `management.metrics.distribution.percentiles-histogram` | 是å�¦å�‘布适å�ˆè®¡ç®—å�¯è�šé›†ï¼ˆè·¨ç»´åº¦ï¼‰çš„百分ä½�数近似值的直方图。 | +| `management.metrics.distribution.minimum-expected-value`, `management.metrics.distribution.maximum-expected-value` | 通过钳制预期值的范围,å�‘布更少的直方图桶。 | +| `management.metrics.distribution.percentiles` | å�‘布在你的应用程åº�中计算的百分ä½�值 | +| `management.metrics.distribution.expiry`, `management.metrics.distribution.buffer-length` | 通过在环形缓冲区中积累最近的样本,给它们更大的æ�ƒé‡�,环形缓冲区在å�¯é…�置的过期å�Žæ—‹è½¬ï¼Œç¼“冲区长度为 å�¯é…�置的缓冲区长度。 | +| `management.metrics.distribution.slo` | å�‘布一个累积直方图,其中的桶由你的æœ�务水平目标定义。 | -¹ØÓÚ `percentiles-histogram` £¨°Ù·ÖÊý-Ö±·½Í¼£©¡¢`percentiles`£¨°Ù·ÖÊý£©ºÍ `slo` ±³ºóµÄ¸ÅÄîµÄ¸ü¶àϸ½Ú£¬Çë²Î¼ûMicrometerÎĵµÖÐµÄ [¡°Histograms and percentiles¡± £¨Ö±·½Í¼ºÍ°Ù·ÖÊý£©²¿·Ö](https://micrometer.io/docs/concepts#_histograms_and_percentiles)¡£ +关于 `percentiles-histogram` (百分数-直方图)ã€�`percentiles`(百分数)和 `slo` 背å�Žçš„æ¦‚念的更多细节,请å�‚è§�Micrometer文档中的 [“Histograms and percentilesâ€� (直方图和百分数)部分](https://micrometer.io/docs/concepts#_histograms_and_percentiles)。 @@ -5102,36 +5102,36 @@ management.metrics.enable.example.remote=false -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.endpoint)7.6\. Ö¸±ê¶Ëµã +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.endpoint)7.6\. 指标端点 -Spring BootÌṩÁËÒ»¸ö `metrics` ¶Ëµã£¬Äã¿ÉÒÔÕï¶ÏÐÔµØÊ¹ÓÃËüÀ´¼ì²éÓ¦ÓóÌÐòÊÕ¼¯µÄÖ¸±ê¡£¸Ã¶ËµãĬÈÏÇé¿öÏÂÊDz»¿ÉÓõ쬱ØÐ빫¿ª¡£¸ü¶àϸ½ÚÇë²Î¼û [±©Â¶¶Ëµã](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)¡£ +Spring Bootæ��供了一个 `metrics` 端点,你å�¯ä»¥è¯Šæ–­æ€§åœ°ä½¿ç”¨å®ƒæ�¥æ£€æŸ¥åº”用程åº�收集的指标。该端点默认情况下是ä¸�å�¯ç”¨çš„,必须公开。更多细节请å�‚è§� [暴露端点](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints.exposing)。 -µ¼º½µ½ `/actuator/metrics` »áÏÔʾһ¸ö¿ÉÓõÄÒDZíÃû³ÆÁÐ±í¡£ Äã¿ÉÒÔͨ¹ýÌṩÃû³Æ×÷ΪѡÔñÆ÷À´ÉîÈë²é¿´Ä³¸öÌØ¶¨ÒDZíµÄÐÅÏ¢£¬ÀýÈ磬`/actuator/metrics/jvm.memory.max`¡£ +导航到 `/actuator/metrics` 会显示一个å�¯ç”¨çš„仪表å��称列表。 ä½ å�¯ä»¥é€šè¿‡æ��ä¾›å��称作为选择器æ�¥æ·±å…¥æŸ¥çœ‹æŸ�个特定仪表的信æ�¯ï¼Œä¾‹å¦‚,`/actuator/metrics/jvm.memory.max`。 -| | ÄãÔÚÕâÀïʹÓõÄÃû×ÖÓ¦¸ÃÓë´úÂëÖÐʹÓõÄÃû×ÖÒ»Ö£¬¶ø²»ÊÇÔÚËü±»ÔËÍùµÄ¼à¿ØÏµÍ³Öо­¹ýÃüÃû¹ßÀý¹æ·¶»¯ºóµÄÃû×Ö¡£ »»¾ä»°Ëµ£¬Èç¹û `jvm.memory.max` ÔÚPrometheusÖÐÏÔʾΪ `jvm_memory_max`£¬ÒòΪËüµÄÉßÐÎÃüÃû¹ßÀý£¬ÄãÈÔȻӦ¸ÃʹÓà `jvm.memory.max` ×÷ΪѡÔñÆ÷£¬ÔÚ `metrics` ¶ËµãÖмì²éÒÇ±í¡£ | +| | 你在这里使用的å��字应该与代ç �中使用的å��字一致,而ä¸�是在它被è¿�往的监控系统中ç»�过命å��惯例规范化å�Žçš„å��字。 æ�¢å�¥è¯�说,如果 `jvm.memory.max` 在Prometheus中显示为 `jvm_memory_max`,因为它的蛇形命å��惯例,你ä»�然应该使用 `jvm.memory.max` 作为选择器,在 `metrics` 端点中检查仪表。 | | --- | --- | -ÄãÒ²¿ÉÒÔÔÚURLµÄĩβÌí¼ÓÈÎÒâÊýÁ¿µÄ `tag=KEY:VALUE` ²éѯ²ÎÊý£¬ÒÔ¶ÔÒÇ±í½øÐÐά¶ÈÏÂ×ê?¡ª?ÀýÈ磬`/actuator/metrics/jvm.memory.max?tag=area:nonheap`¡£ +你也å�¯ä»¥åœ¨URL的末尾添加任æ„�æ•°é‡�çš„ `tag=KEY:VALUE` 查询å�‚数,以对仪表进行维度下钻?—?例如,`/actuator/metrics/jvm.memory.max?tag=area:nonheap`。 -| | ±¨¸æµÄ²âÁ¿ÖµÊÇËùÓÐÓëÒDZíÃû³ÆÏàÆ¥ÅäµÄÒDZíºÍÈκÎÒÑÓ¦ÓõıêÇ©µÄͳ¼ÆÁ¿µÄ _×ܺÍ_¡£ ÔÚÇ°ÃæµÄÀý×ÓÖУ¬·µ»ØµÄ `Value` ͳ¼ÆÊÇ¶ÑµÄ ¡°Code Cache¡±¡¢¡°Compressed Class Space¡± ºÍ ¡°Metaspace¡± ÇøÓòµÄ×î´óÄÚ´æ¡°×ã¼£¡±Ö®ºÍ¡£ Èç¹ûÄãÏëÖ»¿´µ½ ¡°Metaspace¡± µÄ×î´ó³ß´ç£¬Äã¿ÉÒÔÌí¼ÓÒ»¸ö¶îÍâµÄ `tag=id:Metaspace` --¼´ `/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace`¡£ | +| | 报告的测é‡�值是所有与仪表å��称相匹é…�的仪表和任何已应用的标签的统计é‡�çš„ _总和_。 在å‰�é�¢çš„例å­�中,返回的 `Value` 统计是堆的 “Code Cacheâ€�ã€�“Compressed Class Spaceâ€� å’Œ “Metaspaceâ€� 区域的最大内存“足迹â€�之和。 如果你想å�ªçœ‹åˆ° “Metaspaceâ€� 的最大尺寸,你å�¯ä»¥æ·»åŠ ä¸€ä¸ªé¢�外的 `tag=id:Metaspace` --å�³ `/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace`。 | | --- | --- | @@ -5140,11 +5140,11 @@ Spring Boot -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.micrometer-observation)7.7\. ÕûºÏ Micrometer Observation +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.metrics.micrometer-observation)7.7\. æ•´å�ˆ Micrometer Observation -Ò»¸ö `DefaultMeterObservationHandler` ±»×Ô¶¯×¢²áÔÚ `ObservationRegistry` ÉÏ£¬ËüΪÿ¸öÍê³ÉµÄ¹Û²ì£¨completed observation£©´´½¨¶ÈÁ¿£¨metric£©¡£ +一个 `DefaultMeterObservationHandler` 被自动注册在 `ObservationRegistry` 上,它为æ¯�个完æˆ�的观察(completed observation)创建度é‡�(metric)。 @@ -5156,38 +5156,38 @@ Spring Boot -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing)8\. ×·×Ù£¨Tracing£© +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing)8\. 追踪(Tracing) -Spring Boot Actuator Ϊ Micrometer Tracing ÌṩÁËÒÀÀµÐÔ¹ÜÀíºÍ×Ô¶¯ÅäÖ㬠[Micrometer Tracing](https://micrometer.io/docs/tracing) ÊÇÁ÷ÐеÄ×·×ÙÆ÷£¨tracer£©¿âµÄÒ»¸ö½Ó¿Ú£¨facade£©¡£ +Spring Boot Actuator 为 Micrometer Tracing æ��供了ä¾�赖性管ç�†å’Œè‡ªåЍé…�置, [Micrometer Tracing](https://micrometer.io/docs/tracing) 是æµ�行的追踪器(tracer)库的一个接å�£ï¼ˆfacade)。 -| | ÒªÁ˽â¸ü¶à¹ØÓÚ Micrometer Tracing ¹¦ÄܵÄÐÅÏ¢£¬Çë²ÎÔÄÆä [²Î¿¼Îĵµ](https://micrometer.io/docs/tracing)¡£ | +| | è¦�了解更多关于 Micrometer Tracing 功能的信æ�¯ï¼Œè¯·å�‚阅其 [å�‚考文档](https://micrometer.io/docs/tracing)。 | | --- | --- | -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracers)8.1\. Ö§³ÖµÄ×·×ÙÆ÷ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracers)8.1\. 支æŒ�的追踪器 -Spring BootΪÒÔÏÂ×·×ÙÆ÷ÌṩÁË×Ô¶¯ÅäÖᣠ+Spring Boot为以下追踪器æ��供了自动é…�置。 -* ʹÓà [Zipkin](https://zipkin.io/) »ò [Wavefront](https://docs.wavefront.com/) µÄ [OpenTelemetry](https://opentelemetry.io/) +* 使用 [Zipkin](https://zipkin.io/) 或 [Wavefront](https://docs.wavefront.com/) çš„ [OpenTelemetry](https://opentelemetry.io/) -* ʹÓà [Zipkin](https://zipkin.io/) »ò [Wavefront](https://docs.wavefront.com/) µÄ [OpenZipkin Brave](https://github.com/openzipkin/brave) +* 使用 [Zipkin](https://zipkin.io/) 或 [Wavefront](https://docs.wavefront.com/) çš„ [OpenZipkin Brave](https://github.com/openzipkin/brave) @@ -5195,17 +5195,17 @@ Spring BootΪ -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.getting-started)8.2\. ÈëÃÅ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.getting-started)8.2\. 入门 -ÎÒÃÇÐèÒªÒ»¸ö¿ÉÒÔÓÃÀ´¿ªÊ¼×·×ÙµÄʾÀýÓ¦ÓóÌÐò¡£¾ÍÎÒÃǵÄÄ¿µÄ¶øÑÔ£¬¡°[getting-started.html](https://springdoc.cn/spring-boot/getting-started.html#getting-started.first-application)¡± ²¿·ÖËùÉæ¼°µÄ¼òµ¥µÄ ¡°Hello World!¡± web³ÌÐò¾Í×ã¹»ÁË¡£ÎÒÃǽ«Ê¹Óà `OpenTelemetry` ×·×ÙÆ÷ºÍ `Zipkin` ×÷Ϊ׷×Ùºó¶Ë¡£ +我们需è¦�一个å�¯ä»¥ç”¨æ�¥å¼€å§‹è¿½è¸ªçš„示例应用程åº�。就我们的目的而言,“[getting-started.html](https://springdoc.cn/spring-boot/getting-started.html#getting-started.first-application)â€� 部分所涉å�Šçš„简å�•çš„ “Hello World!â€� web程åº�就足够了。我们将使用 `OpenTelemetry` 追踪器和 `Zipkin` 作为追踪å�Žç«¯ã€‚ -»Ø¹Ëһϣ¬ÎÒÃǵÄÖ÷ÒªÓ¦ÓôúÂë¿´ÆðÀ´ÊÇÕâÑùµÄ¡£ +回顾一下,我们的主è¦�应用代ç �看起æ�¥æ˜¯è¿™æ ·çš„。 @@ -5240,14 +5240,14 @@ public class MyApplication { -| | ÔÚ `home()` ·½·¨ÖУ¬ÓÐÒ»¸ö¸½¼ÓµÄloggerÓï¾ä£¬ÕâÔÚºóÃæ»áºÜÖØÒª¡£ | +| | 在 `home()` 方法中,有一个附加的logger语å�¥ï¼Œè¿™åœ¨å�Žé�¢ä¼šå¾ˆé‡�è¦�。 | | --- | --- | -ÏÖÔÚ£¬ÎÒÃDZØÐëÌí¼ÓÒÔÏÂÒÀÀµÏî¡£ +现在,我们必须添加以下ä¾�赖项。 @@ -5255,15 +5255,15 @@ public class MyApplication { * `org.springframework.boot:spring-boot-starter-actuator` -* `io.micrometer:micrometer-tracing-bridge-otel` - ÕâÊÇÁ¬½Ó Micrometer Observation API ºÍ OpenTelemetry µÄ±ØÒªÌõ¼þ¡£ +* `io.micrometer:micrometer-tracing-bridge-otel` - 这是连接 Micrometer Observation API å’Œ OpenTelemetry 的必è¦�æ�¡ä»¶ã€‚ -* `io.opentelemetry:opentelemetry-exporter-zipkin` - ÕâÊÇÏòZipkin±¨¸æ [traces](https://micrometer.io/docs/tracing#_glossary) ËùÐèÒªµÄ¡£ +* `io.opentelemetry:opentelemetry-exporter-zipkin` - 这是å�‘Zipkin报告 [traces](https://micrometer.io/docs/tracing#_glossary) 所需è¦�的。 -Ìí¼ÓÈçÏ嵀 application properties: +添加如下的 application properties: @@ -5290,25 +5290,25 @@ management.tracing.sampling.probability=1.0 -ĬÈÏÇé¿öÏ£¬Spring BootÖ»¶Ô10%µÄÇëÇó½øÐвÉÑù£¬ÒÔ·ÀÖ¹×·×Ùºó¶Ë²»¿°Öظº¡£´ËÊôÐÔ½«ÆäÇл»Îª100%£¬ÕâÑùÿ¸öÇëÇ󶼻ᱻ·¢Ë͵½¸ú×Ùºó¶Ë¡£ +默认情况下,Spring Bootå�ªå¯¹10%的请求进行采样,以防止追踪å�Žç«¯ä¸�å ªé‡�负。此属性将其切æ�¢ä¸º100%,这样æ¯�个请求都会被å�‘é€�到跟踪å�Žç«¯ã€‚ -ΪÁËÊÕ¼¯ºÍ¿ÉÊÓ»¯¸ú×Ù£¬ÎÒÃÇÐèÒªÒ»¸öÔËÐиú×ٵĺó¶Ë¡£ÎÒÃÇÔÚÕâÀïʹÓÃZipkin×÷ΪÎÒÃǵĸú×Ùºó¶Ë¡£ [Zipkin¿ìËÙÈëÃÅÖ¸ÄÏ](https://zipkin.io/pages/quickstart) ÌṩÁËÈçºÎÔÚ±¾µØÆô¶¯ZipkinµÄ˵Ã÷¡£ +为了收集和å�¯è§†åŒ–跟踪,我们需è¦�一个è¿�行跟踪的å�Žç«¯ã€‚我们在这里使用Zipkin作为我们的跟踪å�Žç«¯ã€‚ [Zipkin快速入门指å�—](https://zipkin.io/pages/quickstart) æ��供了如何在本地å�¯åЍZipkin的说明。 -ZipkinÔËÐкó£¬Äã¿ÉÒÔÆô¶¯ÄãµÄÓ¦ÓóÌÐò¡£ +Zipkinè¿�行å�Žï¼Œä½ å�¯ä»¥å�¯åŠ¨ä½ çš„åº”ç”¨ç¨‹åº�。 -Èç¹ûÄã´ò¿ªwebä¯ÀÀÆ÷·ÃÎÊ `[localhost:8080](http://localhost:8080/)`£¬ÄãÓ¦¸Ã¿´µ½ÒÔÏÂÊä³ö¡£ +如果你打开webæµ�览器访问 `[localhost:8080](http://localhost:8080/)`,你应该看到以下输出。 @@ -5324,19 +5324,19 @@ Zipkin -ÔÚÄ»ºó£¬ÒѾ­ÎªHTTPÇëÇó´´½¨ÁËÒ»¸ö observation£¬Ëü·´¹ýÀ´±»ÇŽӵ½ `OpenTelemetry`£¬ºóÕßÏòZipkin±¨¸æÒ»¸öеĸú×Ù£¨trace£©¡£ +在幕å�Žï¼Œå·²ç»�为HTTP请求创建了一个 observation,它å��过æ�¥è¢«æ¡¥æŽ¥åˆ° `OpenTelemetry`,å�Žè€…å�‘Zipkin报告一个新的跟踪(trace)。 -ÏÖÔÚ£¬ÔÚ `[localhost:9411](http://localhost:9411/)` ´ò¿ªZipkinÓû§½çÃæ£¬µã»÷ "Run Query" °´Å¥£¬ÁгöËùÓÐÊÕ¼¯µ½µÄ¸ú×ÙÐÅÏ¢¡£ÄãÓ¦¸Ã¿´µ½Ò»¸ö×·×Ù¡£µã»÷ "Show" °´Å¥£¬²é¿´¸Ã×·×ÙµÄϸ½Ú¡£ +现在,在 `[localhost:9411](http://localhost:9411/)` 打开Zipkin用户界é�¢ï¼Œç‚¹å‡» "Run Query" 按钮,列出所有收集到的跟踪信æ�¯ã€‚你应该看到一个追踪。点击 "Show" 按钮,查看该追踪的细节。 -| | Äã¿ÉÒÔͨ¹ý½« `logging.pattern.level` ÊôÐÔÉèÖÃΪ `%5p [${spring.application.name:},%X{traceId:-},%X{spanId:-}]`£¬ÔÚÈÕÖ¾Öаüº¬µ±Ç°µÄ¸ú×Ù£¨trace£©ºÍ span id¡£ | +| | ä½ å�¯ä»¥é€šè¿‡å°† `logging.pattern.level` 属性设置为 `%5p [${spring.application.name:},%X{traceId:-},%X{spanId:-}]`,在日志中包å�«å½“å‰�的跟踪(trace)和 span id。 | | --- | --- | @@ -5345,29 +5345,29 @@ Zipkin -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations)8.3\. ¸ú×ÙÆ÷£¨Tracer£©µÄʵÏÖ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations)8.3\. 跟踪器(Tracer)的实现 -ÓÉÓÚMicrometer TracerÖ§³Ö¶àÖÖʾ×ÙÆ÷µÄʵÏÖ£¬Òò´ËSpring Boot¿ÉÄÜÓжàÖÖÒÀÀµ×éºÏ¡£ +由于Micrometer Tracer支æŒ�多ç§�示踪器的实现,因此Spring Bootå�¯èƒ½æœ‰å¤šç§�ä¾�赖组å�ˆã€‚ -ËùÓÐ×·×ÙÆ÷µÄʵÏÖ¶¼ÐèÒª `org.springframework.boot:spring-boot-starter-actuator` ÒÀÀµ¡£ +所有追踪器的实现都需è¦� `org.springframework.boot:spring-boot-starter-actuator` ä¾�赖。 -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.otel-zipkin)8.3.1\. ʹÓà Zipkin µÄ OpenTelemetry +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.otel-zipkin)8.3.1\. 使用 Zipkin çš„ OpenTelemetry -* `io.micrometer:micrometer-tracing-bridge-otel` - ÕâÊÇÁ¬½Ó Micrometer Observation API ºÍ OpenTelemetry µÄ±ØÒªÌõ¼þ¡£ +* `io.micrometer:micrometer-tracing-bridge-otel` - 这是连接 Micrometer Observation API å’Œ OpenTelemetry 的必è¦�æ�¡ä»¶ã€‚ -* `io.opentelemetry:opentelemetry-exporter-zipkin` - ÕâÊÇÏòZipkin±¨¸ætraceËùÐèÒªµÄ¡£ +* `io.opentelemetry:opentelemetry-exporter-zipkin` - 这是å�‘Zipkin报告trace所需è¦�的。 @@ -5375,13 +5375,13 @@ Zipkin -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.otel-wavefront)8.3.2\. ʹÓà Wavefront µÄ OpenTelemetry +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.otel-wavefront)8.3.2\. 使用 Wavefront çš„ OpenTelemetry -* `io.micrometer:micrometer-tracing-bridge-otel` - ÕâÊÇÁ¬½Ó Micrometer Observation API ºÍ OpenTelemetry µÄ±ØÒªÌõ¼þ¡£ +* `io.micrometer:micrometer-tracing-bridge-otel` - 这是连接 Micrometer Observation API å’Œ OpenTelemetry 的必è¦�æ�¡ä»¶ã€‚ -* `io.micrometer:micrometer-tracing-reporter-wavefront` - ÕâÊÇÏòWavefront±¨¸ætraceËùÐèÒªµÄ¡£ +* `io.micrometer:micrometer-tracing-reporter-wavefront` - 这是å�‘Wavefront报告trace所需è¦�的。 @@ -5389,19 +5389,19 @@ Zipkin -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.brave-zipkin)8.3.3\. ʹÓà Zipkin µÄ OpenZipkin Brave +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.brave-zipkin)8.3.3\. 使用 Zipkin çš„ OpenZipkin Brave -* `io.micrometer:micrometer-tracing-bridge-brave` - ÕâÊÇÁ¬½Ó Micrometer Observation API ºÍ Brave µÄ±ØÒªÌõ¼þ¡£ +* `io.micrometer:micrometer-tracing-bridge-brave` - 这是连接 Micrometer Observation API å’Œ Brave 的必è¦�æ�¡ä»¶ã€‚ -* `io.zipkin.reporter2:zipkin-reporter-brave` - ÕâÊÇÏòZipkin±¨¸æ trace ËùÐèÒªµÄ¡£ +* `io.zipkin.reporter2:zipkin-reporter-brave` - 这是å�‘Zipkin报告 trace 所需è¦�的。 -| | Èç¹ûÄãµÄÏîĿûÓÐʹÓÃSpring MVC»òSpring WebFlux£¬Ò²ÐèҪʹÓà `io.zipkin.reporter2:zipkin-sender-urlconnection` ÒÀÀµÏî¡£ | +| | 如果你的项目没有使用Spring MVC或Spring WebFlux,也需è¦�使用 `io.zipkin.reporter2:zipkin-sender-urlconnection` ä¾�赖项。 | | --- | --- | @@ -5410,13 +5410,13 @@ Zipkin -#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.brave-wavefront)8.3.4\. ʹÓÃWavefrontµÄOpenZipkin Brave +#### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.tracer-implementations.brave-wavefront)8.3.4\. 使用Wavefrontçš„OpenZipkin Brave -* `io.micrometer:micrometer-tracing-bridge-brave` - ÕâÊÇÁ¬½Ó²âMicrometer Observation APIºÍBraveµÄ±ØÒªÌõ¼þ¡£ +* `io.micrometer:micrometer-tracing-bridge-brave` - 这是连接测Micrometer Observation APIå’ŒBrave的必è¦�æ�¡ä»¶ã€‚ -* `io.micrometer:micrometer-tracing-reporter-wavefront` - ÕâÊÇÏòWavefront±¨¸ætraceËùÐèÒªµÄ¡£ +* `io.micrometer:micrometer-tracing-reporter-wavefront` - 这是å�‘Wavefront报告trace所需è¦�的。 @@ -5426,11 +5426,11 @@ Zipkin -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.creating-spans)8.4\. ´´½¨×Ô¶¨Òå¿ç¶È£¨span£© +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.micrometer-tracing.creating-spans)8.4\. 创建自定义跨度(span) -Äã¿ÉÒÔͨ¹ýÆô¶¯Ò»¸ö observation À´´´½¨Äã×Ô¼ºµÄspan¡£Îª´Ë£¬½« `ObservationRegistry` ×¢Èëµ½ÄãµÄ×é¼þÖС£ +ä½ å�¯ä»¥é€šè¿‡å�¯åŠ¨ä¸€ä¸ª observation æ�¥åˆ›å»ºä½ è‡ªå·±çš„span。为此,将 `ObservationRegistry` 注入到你的组件中。 @@ -5466,13 +5466,13 @@ class CustomObservation { -Õ⽫´´½¨Ò»¸öÃûΪ "some-operation" µÄ observation£¬±êǩΪ£¬±êǩΪ "some-tag=some-value"¡£ +这将创建一个å��为 "some-operation" çš„ observation,标签为,标签为 "some-tag=some-value"。 -| | Èç¹ûÄãÏëÔÚ²»´´½¨metricµÄÇé¿öÏ´´½¨Ò»¸öspan£¬ÄãÐèҪʹÓà Micrometer µÄ [µÍ¼¶Tracer API](https://micrometer.io/docs/tracing#_using_micrometer_tracing_directly)¡£ | +| | 如果你想在ä¸�创建metric的情况下创建一个span,你需è¦�使用 Micrometer çš„ [低级Tracer API](https://micrometer.io/docs/tracing#_using_micrometer_tracing_directly)。 | | --- | --- | @@ -5485,35 +5485,35 @@ class CustomObservation { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.auditing)9\. Éó¼Æ +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.auditing)9\. 审计 -Ò»µ©Spring Security·¢»Ó×÷Óã¬Spring Boot Actuator¾ÍÓÐÒ»¸öÁé»îµÄÉó¼Æ¿ò¼Ü£¬¿ÉÒÔ·¢²¼Ê¼þ£¨Ä¬ÈÏΪ ¡°authentication success¡±, ¡°failure¡± ºÍ ¡°access denied¡± µÄÒì³££©¡£ ÕâÒ»¹¦ÄܶÔÓÚ±¨¸æºÍʵʩ»ùÓÚÈÏ֤ʧ°ÜµÄËø¶¨²ßÂԷdz£ÓÐÓᣠ+一旦Spring Securityå�‘挥作用,Spring Boot Actuator就有一个ç�µæ´»çš„审计框架,å�¯ä»¥å�‘布事件(默认为 “authentication successâ€�, “failureâ€� å’Œ “access deniedâ€� 的异常)。 这一功能对于报告和实施基于认è¯�失败的é”�定策略é�žå¸¸æœ‰ç”¨ã€‚ -Äã¿ÉÒÔͨ¹ýÔÚÓ¦ÓóÌÐòµÄÅäÖÃÖÐÌṩһ¸ö `AuditEventRepository` ÀàÐ͵ÄbeanÀ´ÆôÓÃÉ󼯡£ ΪÁË·½±ã£¬Spring BootÌṩÁËÒ»¸ö `InMemoryAuditEventRepository`¡£ `InMemoryAuditEventRepository` µÄ¹¦ÄÜÓÐÏÞ£¬ÎÒÃǽ¨ÒéÖ»ÔÚ¿ª·¢»·¾³ÖÐʹÓÃËü¡£ ¶ÔÓÚÉú²ú»·¾³£¬Ç뿼ÂÇ´´½¨Äã×Ô¼ºµÄÌæ´ú `AuditEventRepository` ʵÏÖ¡£ +ä½ å�¯ä»¥é€šè¿‡åœ¨åº”用程åº�çš„é…�置中æ��供一个 `AuditEventRepository` 类型的beanæ�¥å�¯ç”¨å®¡è®¡ã€‚ 为了方便,Spring Bootæ��供了一个 `InMemoryAuditEventRepository`。 `InMemoryAuditEventRepository` 的功能有é™�,我们建议å�ªåœ¨å¼€å�‘环境中使用它。 对于生产环境,请考虑创建你自己的替代 `AuditEventRepository` 实现。 -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.auditing.custom)9.1\. ¶¨ÖÆÉó¼Æ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.auditing.custom)9.1\. 定制审计 -ΪÁ˶¨ÖÆ·¢²¼µÄ°²È«Ê¼þ£¬Äã¿ÉÒÔÌṩÄã×Ô¼ºµÄ `AbstractAuthenticationAuditListener` ºÍ `AbstractAuthorizationAuditListener` µÄʵÏÖ¡£ +为了定制å�‘布的安全事件,你å�¯ä»¥æ��供你自己的 `AbstractAuthenticationAuditListener` å’Œ `AbstractAuthorizationAuditListener` 的实现。 -ÄãÒ²¿ÉÒÔΪÄã×Ô¼ºµÄÒµÎñʼþʹÓÃÉ󼯷þÎñ¡£ Òª×öµ½ÕâÒ»µã£¬ÒªÃ´½« `AuditEventRepository` bean×¢ÈëÄã×Ô¼ºµÄ×é¼þ²¢Ö±½ÓʹÓÃËü£¬ÒªÃ´ÓÃSpringµÄ `ApplicationEventPublisher` ·¢²¼ `AuditApplicationEvent`£¨Í¨¹ýʵÏÖ `ApplicationEventPublisherAware`£©¡£ +你也å�¯ä»¥ä¸ºä½ è‡ªå·±çš„业务事件使用审计æœ�务。 è¦�å�šåˆ°è¿™ä¸€ç‚¹ï¼Œè¦�么将 `AuditEventRepository` bean注入你自己的组件并直接使用它,è¦�么用Springçš„ `ApplicationEventPublisher` å�‘布 `AuditApplicationEvent`(通过实现 `ApplicationEventPublisherAware`)。 @@ -5525,35 +5525,35 @@ class CustomObservation { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.http-exchanges)10\. ¼Ç¼ HTTP Exchange +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.http-exchanges)10\. 记录 HTTP Exchange -Äã¿ÉÒÔͨ¹ýÔÚÓ¦ÓóÌÐòµÄÅäÖÃÖÐÌṩһ¸ö `HttpExchangeRepository` ÀàÐ굀 bean À´ÆôÓà HTTP exchange µÄ¼Ç¼¡£ÎªÁË·½±ãÆð¼û£¬Spring Boot ÌṩÁË `InMemoryHttpExchangeRepository`£¬Ä¬ÈÏÇé¿öÏ£¬Ëü´æ´¢ÁË×îºó100¸ö request/response exchange¡£Óë×·×Ù½â¾ö·½°¸£¨tracing solutions£©Ïà±È£¬`InMemoryHttpExchangeRepository` ÊÇÓÐÏ޵ģ¬ÎÒÃǽ¨ÒéÖ»ÔÚ¿ª·¢»·¾³ÖÐʹÓÃËü¡£¶ÔÓÚÉú²ú»·¾³£¬ÎÒÃǽ¨ÒéʹÓÃÒ»¸öÉú²ú¾ÍÐ÷µÄ¸ú×Ù»ò¹Û²ì½â¾ö·½°¸£¬Èç `Zipkin` »ò `OpenTelemetry`¡£ÁíÍ⣬ÄãÒ²¿ÉÒÔ´´½¨Äã×Ô¼ºµÄ `HttpExchangeRepository`¡£ +ä½ å�¯ä»¥é€šè¿‡åœ¨åº”用程åº�çš„é…�置中æ��供一个 `HttpExchangeRepository` 类型的 bean æ�¥å�¯ç”¨ HTTP exchange 的记录。为了方便起è§�,Spring Boot æ��供了 `InMemoryHttpExchangeRepository`,默认情况下,它存储了最å�Ž100个 request/response exchange。与追踪解决方案(tracing solutions)相比,`InMemoryHttpExchangeRepository` 是有é™�的,我们建议å�ªåœ¨å¼€å�‘环境中使用它。对于生产环境,我们建议使用一个生产就绪的跟踪或观察解决方案,如 `Zipkin` 或 `OpenTelemetry`。å�¦å¤–,你也å�¯ä»¥åˆ›å»ºä½ è‡ªå·±çš„ `HttpExchangeRepository`。 -Äã¿ÉÒÔʹÓà `httpexchanges` ¶ËµãÀ´»ñÈ¡´æ´¢ÔÚ `HttpExchangeRepository` ÖÐµÄ request/response exchange µÄÐÅÏ¢¡£ +ä½ å�¯ä»¥ä½¿ç”¨ `httpexchanges` 端点æ�¥èŽ·å�–存储在 `HttpExchangeRepository` 中的 request/response exchange 的信æ�¯ã€‚ -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.http-exchanges.custom)10.1\. ×Ô¶¨Òå HTTP Exchange ¼Ç¼ +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.http-exchanges.custom)10.1\. 自定义 HTTP Exchange 记录 -Òª×Ô¶¨Òå°üÀ¨ÔÚÿ¸ö¼Ç¼µÄ exchange ÏîÄ¿£¬ÇëʹÓà `management.httpexchanges.recording.include` ÅäÖÃÊôÐÔ¡£ +è¦�自定义包括在æ¯�个记录的 exchange 项目,请使用 `management.httpexchanges.recording.include` é…�置属性。 -ÒªÍêÈ«½ûÖ¹ÖØÐ±àÂ룬Ç뽫 `management.httpexchanges.recording.enabled` ÉèÖÃΪ `false`¡£ +è¦�完全ç¦�æ­¢é‡�æ–°ç¼–ç �,请将 `management.httpexchanges.recording.enabled` 设置为 `false`。 @@ -5565,45 +5565,45 @@ class CustomObservation { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring)11\. ½ø³Ì¼à¿Ø +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring)11\. 进程监控 -ÔÚ `spring-boot` Ä£¿éÖУ¬Äã¿ÉÒÔÕÒµ½Á½¸ö´´½¨ÎļþµÄÀ࣬ÕâЩÎļþÔÚ½ø³Ì¼à¿ØÖÐͨ³£ºÜÓÐÓᣠ+在 `spring-boot` 模å�—中,你å�¯ä»¥æ‰¾åˆ°ä¸¤ä¸ªåˆ›å»ºæ–‡ä»¶çš„类,这些文件在进程监控中通常很有用。 -* `ApplicationPidFileWriter` ´´½¨Ò»¸ö°üº¬Ó¦ÓóÌÐòPIDµÄÎļþ£¨Ä¬ÈÏÇé¿öÏ£¬ÔÚÓ¦ÓóÌÐòĿ¼Ï£¬ÎļþÃûΪ `application.pid`£©¡£ +* `ApplicationPidFileWriter` 创建一个包å�«åº”用程åº�PID的文件(默认情况下,在应用程åº�目录下,文件å��为 `application.pid`)。 -* `WebServerPortFileWriter` ´´½¨Ò»¸ö£¨»ò¶à¸ö£©Îļþ£¬°üº¬ÔËÐÐÖеÄWeb·þÎñÆ÷µÄ¶Ë¿Ú£¨Ä¬ÈÏÇé¿öÏ£¬ÔÚÓ¦ÓóÌÐòĿ¼Ï£¬ÎļþÃûΪ `application.port`£©¡£ +* `WebServerPortFileWriter` 创建一个(或多个)文件,包å�«è¿�行中的Webæœ�务器的端å�£ï¼ˆé»˜è®¤æƒ…况下,在应用程åº�目录下,文件å��为 `application.port`)。 -ĬÈÏÇé¿öÏ£¬ÕâЩдÊÖûÓб»¼¤»î£¬µ«Äã¿ÉÒÔÆôÓÃËüÃÇ¡£ +默认情况下,这些写手没有被激活,但你å�¯ä»¥å�¯ç”¨å®ƒä»¬ã€‚ -* [ͨ¹ýÀ©Õ¹ÅäÖÃ](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.configuration) +* [通过扩展é…�ç½®](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.configuration) -* [ÒÔ±à³Ì·½Ê½ÊµÏÖ½ø³Ì¼à¿Ø](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.programmatically) +* [以编程方å¼�实现进程监控](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.programmatically) -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.configuration)11.1\. À©Õ¹ÅäÖà +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.configuration)11.1\. 扩展é…�ç½® -ÔÚ `META-INF/spring.factories` ÎļþÖУ¬Äã¿ÉÒÔ¼¤»îдÈëPIDÎļþµÄlistener£¨Ò»¸ö»òÕß¶à¸ö£©¡£ +在 `META-INF/spring.factories` 文件中,你å�¯ä»¥æ¿€æ´»å†™å…¥PID文件的listener(一个或者多个)。 @@ -5623,11 +5623,11 @@ org.springframework.boot.web.context.WebServerPortFileWriter -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.programmatically)11.2\. ÒÔ±à³Ì·½Ê½ÊµÏÖ½ø³Ì¼à¿Ø +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.process-monitoring.programmatically)11.2\. 以编程方å¼�实现进程监控 -ÄãÒ²¿ÉÒÔͨ¹ýµ÷Óà `SpringApplication.addListeners(¡­?)` ·½·¨²¢´«µÝÊʵ±µÄ `Writer` ¶ÔÏóÀ´¼¤»îÒ»¸ö¼àÌýÆ÷¡£ Õâ¸ö·½·¨»¹¿ÉÒÔÈÃÄãÔÚ `Writer` ¹¹Ô캯ÊýÖÐ×Ô¶¨ÒåÎļþÃûºÍ·¾¶¡£ +你也å�¯ä»¥é€šè¿‡è°ƒç”¨ `SpringApplication.addListeners(…?)` 方法并传递适当的 `Writer` 对象æ�¥æ¿€æ´»ä¸€ä¸ªç›‘å�¬å™¨ã€‚ 这个方法还å�¯ä»¥è®©ä½ åœ¨ `Writer` 构造函数中自定义文件å��和路径。 @@ -5639,36 +5639,36 @@ org.springframework.boot.web.context.WebServerPortFileWriter -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry)12\. Cloud Foundry µÄÖ§³Ö +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry)12\. Cloud Foundry 的支æŒ� -Spring Boot µÄactuatorÄ£¿é°üÀ¨¶îÍâµÄÖ§³Ö£¬µ±Äú²¿Êðµ½¼æÈÝµÄ Cloud Foundry ʵÀýʱ£¬¸ÃÖ§³Ö½«±»¼¤»î¡£ `/cloudfoundryapplication` ·¾¶ÎªËùÓÐ `@Endpoint` BeanÌṩÁËÁíÒ»Ìõ°²È«Â·Ïß¡£ +Spring Boot çš„actuator模å�—包括é¢�外的支æŒ�,当您部署到兼容的 Cloud Foundry 实例时,该支æŒ�将被激活。 `/cloudfoundryapplication` 路径为所有 `@Endpoint` Beanæ��供了å�¦ä¸€æ�¡å®‰å…¨è·¯çº¿ã€‚ -À©Õ¹Ö§³Öʹ Cloud Foundry ¹ÜÀí UI£¨ÀýÈçÄú¿ÉÒÔÓÃÀ´²é¿´ÒѲ¿ÊðµÄÓ¦ÓóÌÐòµÄ Web Ó¦ÓóÌÐò£©µÃµ½ Spring Boot Ö´ÐÐÆ÷ÐÅÏ¢µÄÔöÇ¿¡£ ÀýÈ磬ӦÓóÌÐò×´Ì¬Ò³Ãæ¿ÉÒÔ°üÀ¨ÍêÕûµÄ½¡¿µÐÅÏ¢£¬¶ø²»ÊǵäÐ굀 ¡°running¡± »ò ¡°stopped¡± ״̬¡£ +扩展支æŒ�使 Cloud Foundry 管ç�† UI(例如您å�¯ä»¥ç”¨æ�¥æŸ¥çœ‹å·²éƒ¨ç½²çš„应用程åº�çš„ Web 应用程åº�)得到 Spring Boot 执行器信æ�¯çš„增强。 例如,应用程åº�状æ€�页é�¢å�¯ä»¥åŒ…括完整的å�¥åº·ä¿¡æ�¯ï¼Œè€Œä¸�是典型的 “runningâ€� 或 “stoppedâ€� 状æ€�。 -| | ÆÕͨÓû§ÎÞ·¨Ö±½Ó·ÃÎÊ `/cloudfoundryapplication` ·¾¶¡£ ҪʹÓøö˵㣬Äú±ØÐëÔÚÇëÇóÖд«µÝÒ»¸öÓÐЧµÄ UAA ÁîÅÆ¡£ | +| | 普通用户无法直接访问 `/cloudfoundryapplication` 路径。 è¦�使用该端点,您必须在请求中传递一个有效的 UAA 令牌。 | | --- | --- | -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry.disable)12.1\. ½ûÓÃÀ©Õ¹µÄ Cloud Foundry Actuator Ö§³Ö +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry.disable)12.1\. ç¦�用扩展的 Cloud Foundry Actuator 支æŒ� -Èç¹ûÄúÏëÍêÈ«½ûÓà `/cloudfoundryapplication` ¶Ëµã£¬Äú¿ÉÒÔÔÚÄúµÄ `application.properties` ÎļþÖÐÌí¼ÓÒÔÏÂÉèÖᣠ+如果您想完全ç¦�用 `/cloudfoundryapplication` 端点,您å�¯ä»¥åœ¨æ‚¨çš„ `application.properties` 文件中添加以下设置。 @@ -5697,11 +5697,11 @@ management.cloudfoundry.enabled=false -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry.ssl)12.2\. Cloud Foundry×ÔÇ©ÃûÖ¤Êé +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry.ssl)12.2\. Cloud Foundry自签å��è¯�书 -ĬÈÏÇé¿öÏ£¬`/cloudfoundryapplication` ¶ËµãµÄ°²È«ÑéÖ¤»á¶Ô¸÷ÖÖ Cloud Foundry ·þÎñ½øÐÐ SSL µ÷ÓᣠÈç¹ûÄúµÄ Cloud Foundry UAA »ò Cloud Controller ·þÎñʹÓÃ×ÔÇ©ÃûÖ¤Ê飬ÄúÐèÒªÉèÖÃÒÔÏÂÊôÐÔ¡£ +默认情况下,`/cloudfoundryapplication` 端点的安全验è¯�会对å�„ç§� Cloud Foundry æœ�务进行 SSL 调用。 如果您的 Cloud Foundry UAA 或 Cloud Controller æœ�务使用自签å��è¯�书,您需è¦�设置以下属性。 @@ -5730,17 +5730,17 @@ management.cloudfoundry.skip-ssl-validation=true -### [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry.custom-context-path)12.3\. ×Ô¶¨Òå Context Path +### [](https://springdoc.cn/spring-boot/actuator.html#actuator.cloud-foundry.custom-context-path)12.3\. 自定义 Context Path -Èç¹û·þÎñÆ÷µÄ context-path ±»ÅäÖÃΪ `/` ÒÔÍâµÄÈκÎÄÚÈÝ£¬Ôò Cloud Foundry ¶ËµãÔÚÓ¦ÓóÌÐòµÄ¸ù²¿²»¿ÉÓᣠÀýÈ磬Èç¹û `server.servlet.context-path=/app`£¬Ôò Cloud Foundry ¶ËµãÔÚ `/app/cloudfoundryapplication/*` ´¦¿ÉÓᣠ+如果æœ�务器的 context-path 被é…�置为 `/` 以外的任何内容,则 Cloud Foundry 端点在应用程åº�的根部ä¸�å�¯ç”¨ã€‚ 例如,如果 `server.servlet.context-path=/app`,则 Cloud Foundry 端点在 `/app/cloudfoundryapplication/*` 处å�¯ç”¨ã€‚ -Èç¹ûÄúÏ£Íû Cloud Foundry ¶ËµãʼÖÕÔÚ `/cloudfoundryapplication/*` ´¦¿ÉÓã¬ÎÞÂÛ·þÎñÆ÷µÄÉÏÏÂÎÄ·¾¶ÈçºÎ£¬ÄúÐèÒªÔÚÄúµÄÓ¦ÓóÌÐòÖÐÃ÷È·ÅäÖᣠ¸ÃÅäÖÃÒòʹÓÃµÄ Web ·þÎñÆ÷²»Í¬¶ø²»Í¬¡£ ¶ÔÓÚ Tomcat£¬Äú¿ÉÒÔÌí¼ÓÒÔÏÂÅäÖᣠ+如果您希望 Cloud Foundry 端点始终在 `/cloudfoundryapplication/*` 处å�¯ç”¨ï¼Œæ— è®ºæœ�务器的上下文路径如何,您需è¦�在您的应用程åº�中明确é…�置。 该é…�置因使用的 Web æœ�务器ä¸�å�Œè€Œä¸�å�Œã€‚ 对于 Tomcat,您å�¯ä»¥æ·»åР以䏋é…�置。 @@ -5810,19 +5810,19 @@ public class MyCloudFoundryConfiguration { -## [](https://springdoc.cn/spring-boot/actuator.html#actuator.whats-next)13\. ½ÓÏÂÀ´¶Áʲô +## [](https://springdoc.cn/spring-boot/actuator.html#actuator.whats-next)13\. 接下æ�¥è¯»ä»€ä¹ˆ -Äã¿ÉÄÜÏë¶ÁһϠ[Graphite](https://graphiteapp.org/) µÈͼÐι¤¾ß¡£ +ä½ å�¯èƒ½æƒ³è¯»ä¸€ä¸‹ [Graphite](https://graphiteapp.org/) 等图形工具。 -·ñÔò£¬Äã¿ÉÒÔ¼ÌÐøÔĶÁ [¡°²¿ÊðÑ¡Ï](https://springdoc.cn/spring-boot/deployment.html#deployment) £¬»òÕßÌøµ½Ç°ÃæÈ¥Á˽âÓйØSpring Boot [¹¹½¨¹¤¾ß²å](https://springdoc.cn/spring-boot/build-tool-plugins.html#build-tool-plugins)¼þµÄһЩÉîÈëÐÅÏ¢¡£ +å�¦åˆ™ï¼Œä½ å�¯ä»¥ç»§ç»­é˜…读 [“部署选项â€�](https://springdoc.cn/spring-boot/deployment.html#deployment) ,或者跳到å‰�é�¢åŽ»äº†è§£æœ‰å…³Spring Boot [构建工具æ�’](https://springdoc.cn/spring-boot/build-tool-plugins.html#build-tool-plugins)件的一些深入信æ�¯ã€‚ diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" index 0318193..963dace 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" @@ -1,85 +1,85 @@ -starterÊÇSpringBootÖеÄÒ»¸öз¢Ã÷£¬ËüÓÐЧµÄ½µµÍÁËÏîÄ¿¿ª·¢¹ý³ÌµÄ¸´Ôӳ̶ȣ¬¶ÔÓÚ¼ò»¯¿ª·¢²Ù×÷ÓÐ×ŷdz£ºÃµÄЧ¹û¡£±¾ÎÄ×ªÔØÁËһƬÎÄÕ£¬Ïêϸ½éÉÜÁËspring boot staterÊÇʲô£¿ËüµÄ×÷ÓÃÊÇʲô£¿ +starter是SpringBoot中的一个新å�‘明,它有效的é™�低了项目开å�‘过程的å¤�æ�‚程度,对于简化开å�‘æ“�作有ç�€é�žå¸¸å¥½çš„æ•ˆæžœã€‚本文转载了一片文章,详细介ç»�了spring boot stater是什么?它的作用是什么? -Spring Boot StarterÊÇÔÚSpringBoot×é¼þÖб»Ìá³öÀ´µÄÒ»ÖÖ¸ÅÄstackoverflowÉÏÃæÒѾ­ÓÐÈ˸ÅÀ¨ÁËÕâ¸östarterÊÇʲô¶«Î÷£¬Ïë¿´ÍêÕûµÄ»Ø´ð´Á[ÕâÀï](https://stackoverflow.com/a/28273660)£¨https://stackoverflow.com/questions/28273543/what-are-spring-boot-starter-jars/28273660#28273660£© +Spring Boot Starter是在SpringBoot组件中被æ��出æ�¥çš„一ç§�概念,stackoverflow上é�¢å·²ç»�有人概括了这个starter是什么东西,想看完整的回答戳[这里](https://stackoverflow.com/a/28273660)(https://stackoverflow.com/questions/28273543/what-are-spring-boot-starter-jars/28273660#28273660) ![](https://images2018.cnblogs.com/blog/697611/201804/697611-20180409110042391-1447358002.png) -´ó¸ÅÒâ˼¾ÍÊÇ˵starterÊÇÒ»ÖÖ¶ÔÒÀÀµµÄsynthesize£¨ºÏ³É£©£¬ÕâÊÇʲôÒâË¼ÄØ£¿ÎÒ¿ÉÒÔ¾Ù¸öÀý×ÓÀ´ËµÃ÷¡£ +大概æ„�æ€�就是说starter是一ç§�对ä¾�èµ–çš„synthesize(å�ˆæˆ�),这是什么æ„�æ€�呢?我å�¯ä»¥ä¸¾ä¸ªä¾‹å­�æ�¥è¯´æ˜Žã€‚ -### ¡¡ ? ´«Í³µÄ×ö·¨ +###   ? 传统的å�𿳕 -ÔÚûÓÐstarter֮ǰ£¬¼ÙÈçÎÒÏëÒªÔÚSpringÖÐʹÓÃjpa£¬ÄÇÎÒ¿ÉÄÜÐèÒª×öÒÔϲÙ×÷£º +在没有starter之å‰�,å�‡å¦‚我想è¦�在Spring中使用jpa,那我å�¯èƒ½éœ€è¦�å�šä»¥ä¸‹æ“�作: -1. ÔÚMavenÖÐÒýÈëʹÓõÄÊý¾Ý¿âµÄÒÀÀµ£¨¼´JDBCµÄjar£© -2. ÒýÈëjpaµÄÒÀÀµ -3. ÔÚxxx.xmlÖÐÅäÖÃһЩÊôÐÔÐÅÏ¢ -4. ·´¸´µÄµ÷ÊÔÖ±µ½¿ÉÒÔÕý³£ÔËÐÐ +1. 在Maven中引入使用的数æ�®åº“çš„ä¾�赖(å�³JDBCçš„jar) +2. 引入jpaçš„ä¾�èµ– +3. 在xxx.xml中é…�置一些属性信æ�¯ +4. å��å¤�的调试直到å�¯ä»¥æ­£å¸¸è¿�行 -ÐèҪעÒâµÄÊÇ£¬ÕâÀï²Ù×÷ÔÚÎÒÃÇ**_ÿ´Îн¨Ò»¸öÐèÒªÓõ½jpaµÄÏîÄ¿µÄʱºò¶¼ÐèÒªÖØ¸´µÄ×öÒ»´Î_**¡£Ò²ÐíÄãÔÚµÚÒ»´Î×Ô¼º½¨Á¢ÏîÄ¿µÄʱºòÊÇÔÚGoogleÉÏ×Ô¼ºËÑË÷ÁËÒ»·¬£¬»¨Á˰ëÌìʱ¼ä½â¾öµôÁ˸÷ÖÖÆæ¹ÖµÄÎÊÌâÖ®ºó£¬jpaÖÕÓÚÄÜÕý³£ÔËÐÐÁË¡£ÓÐЩÓо­ÑéµÄÈË»áÔÚOneNoteÉÏÃæ°ÑÕâ´Î½¨Á¢ÏîÄ¿µÄ¹ý³Ì¸ø¼Ç¼ÏÂÀ´£¬°üÀ¨²Ù×÷µÄ²½ÖèÒÔ¼°ÐèÒªÓõ½µÄÅäÖÃÎļþµÄÄÚÈÝ£¬ÔÚÏÂÒ»´ÎÔÙ´´½¨jpaÏîÄ¿µÄʱºò£¬¾Í²»ÐèÒªÔÙ´ÎÈ¥GoogleÁË£¬Ö»ÐèÒªÕÕ×űʼÇÀ´£¬Ö®ºóÔÙ°ÑËùÓеÄÅäÖÃÎļþcopy&paste¾Í¿ÉÒÔÁË¡£ +需è¦�注æ„�的是,这里æ“�作在我们**_æ¯�次新建一个需è¦�用到jpa的项目的时候都需è¦�é‡�å¤�çš„å�šä¸€æ¬¡_**。也许你在第一次自己建立项目的时候是在Google上自己æ�œç´¢äº†ä¸€ç•ªï¼ŒèŠ±äº†å�Šå¤©æ—¶é—´è§£å†³æŽ‰äº†å�„ç§�奇怪的问题之å�Žï¼Œjpa终于能正常è¿�行了。有些有ç»�验的人会在OneNote上é�¢æŠŠè¿™æ¬¡å»ºç«‹é¡¹ç›®çš„过程给记录下æ�¥ï¼ŒåŒ…括æ“�作的步骤以å�Šéœ€è¦�用到的é…�置文件的内容,在下一次å†�创建jpa项目的时候,就ä¸�需è¦�å†�次去Google了,å�ªéœ€è¦�ç…§ç�€ç¬”è®°æ�¥ï¼Œä¹‹å�Žå†�把所有的é…�置文件copy&pasteå°±å�¯ä»¥äº†ã€‚ -ÏñÉÏÃæÕâÑùµÄ²Ù×÷Ò²²»Ëã²»ÐУ¬ÊÂʵÉÏÎÒÃÇÔÚûÓÐstarter֮ǰ¶¼ÊÇÕâô¸ÉµÄ£¬µ«ÊÇÕâÑù×öÓм¸¸öÎÊÌ⣺ +åƒ�上é�¢è¿™æ ·çš„æ“�作也ä¸�ç®—ä¸�行,事实上我们在没有starter之å‰�都是这么干的,但是这样å�šæœ‰å‡ ä¸ªé—®é¢˜ï¼š -1. Èç¹û¹ý³Ì±È½Ï·±Ëö£¬ÕâÑùÒ»²½²½²Ù×÷»áÔö¼Ó³ö´íµÄ¿ÉÄÜÐÔ -2. ²»Í£µØcopy&paste²»·ûºÏ[Don¡¯t repeat yourself](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)¾«Éñ -3. ÔÚµÚÒ»´ÎÅäÖõÄʱºò£¨ÓÈÆäÈç¹û¿ª·¢Õ߱ȽÏС°×£©£¬ÐèÒª»¨·Ñµô´óÁ¿µÄʱ¼ä +1. 如果过程比较ç¹�ç��,这样一步步æ“�作会增加出错的å�¯èƒ½æ€§ +2. ä¸�å�œåœ°copy&pasteä¸�符å�ˆ[Don’t repeat yourself](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)精神 +3. 在第一次é…�置的时候(尤其如果开å�‘者比较å°�白),需è¦�花费掉大é‡�的时间 -### ¡¡¡¡Ê¹ÓÃSpring Boot StarterÌáÉýЧÂÊ +###   使用Spring Boot Starteræ��å�‡æ•ˆçއ -starterµÄÖ÷ҪĿµÄ¾ÍÊÇΪÁ˽â¾öÉÏÃæµÄÕâЩÎÊÌâ¡£ +starter的主è¦�目的就是为了解决上é�¢çš„这些问题。 -starterµÄÀíÄstarter»á°ÑËùÓÐÓõ½µÄÒÀÀµ¶¼¸ø°üº¬½øÀ´£¬±ÜÃâÁË¿ª·¢Õß×Ô¼ºÈ¥ÒýÈëÒÀÀµËù´øÀ´µÄÂé·³¡£ÐèҪעÒâµÄÊDz»Í¬µÄstarterÊÇΪÁ˽â¾ö²»Í¬µÄÒÀÀµ£¬ËùÒÔËüÃÇÄÚ²¿µÄʵÏÖ¿ÉÄÜ»áÓкܴóµÄ²îÒ죬ÀýÈçjpaµÄstarterºÍRedisµÄstarter¿ÉÄÜʵÏ־Ͳ»Ò»Ñù£¬ÕâÊÇÒòΪstarterµÄ±¾ÖÊÔÚÓÚsynthesize£¬ÕâÊÇÒ»²ãÔÚÂß¼­²ãÃæµÄ³éÏó£¬Ò²ÐíÕâÖÖÀíÄîÓеãÀàËÆÓÚDocker£¬ÒòΪËüÃǶ¼ÊÇÔÚ×öÒ»¸ö¡°°ü×°¡±µÄ²Ù×÷£¬Èç¹ûÄãÖªµÀDockerÊÇΪÁ˽â¾öʲôÎÊÌâµÄ£¬Ò²ÐíÄã¿ÉÒÔÓÃDockerºÍstarter×öÒ»¸öÀà±È¡£ +starterçš„ç�†å¿µï¼šstarter会把所有用到的ä¾�赖都给包å�«è¿›æ�¥ï¼Œé�¿å…�了开å�‘者自己去引入ä¾�赖所带æ�¥çš„麻烦。需è¦�注æ„�的是ä¸�å�Œçš„starter是为了解决ä¸�å�Œçš„ä¾�赖,所以它们内部的实现å�¯èƒ½ä¼šæœ‰å¾ˆå¤§çš„差异,例如jpaçš„starterå’ŒRedisçš„starterå�¯èƒ½å®žçް就ä¸�一样,这是因为starter的本质在于synthesize,这是一层在逻辑层é�¢çš„æŠ½è±¡ï¼Œä¹Ÿè®¸è¿™ç§�ç�†å¿µæœ‰ç‚¹ç±»ä¼¼äºŽDocker,因为它们都是在å�šä¸€ä¸ªâ€œåŒ…装â€�çš„æ“�作,如果你知é�“Docker是为了解决什么问题的,也许你å�¯ä»¥ç”¨Dockerå’Œstarterå�šä¸€ä¸ªç±»æ¯”。 -starterµÄʵÏÖ£ºËäÈ»²»Í¬µÄstarterʵÏÖÆðÀ´¸÷ÓвîÒ죬µ«ÊÇËûÃÇ»ù±¾É϶¼»áʹÓõ½Á½¸öÏàͬµÄÄÚÈÝ£ºConfigurationPropertiesºÍAutoConfiguration¡£ÒòΪSpring Boot¼áÐÅ¡°Ô¼¶¨´óÓÚÅäÖá±ÕâÒ»ÀíÄËùÒÔÎÒÃÇʹÓÃConfigurationPropertiesÀ´±£´æÎÒÃǵÄÅäÖ㬲¢ÇÒÕâЩÅäÖö¼¿ÉÒÔÓÐÒ»¸öĬÈÏÖµ£¬¼´ÔÚÎÒÃÇûÓÐÖ÷¶¯¸²Ð´Ô­Ê¼ÅäÖõÄÇé¿öÏ£¬Ä¬ÈÏÖµ¾Í»áÉúЧ£¬ÕâÔںܶàÇé¿öÏÂÊǷdz£ÓÐÓõġ£³ý´ËÖ®Í⣬starterµÄConfigurationProperties»¹Ê¹µÃËùÓеÄÅäÖÃÊôÐÔ±»¾Û¼¯µ½Ò»¸öÎļþÖУ¨Ò»°ãÔÚresourcesĿ¼ÏµÄapplication.properties£©£¬ÕâÑùÎÒÃǾ͸æ±ðÁËSpringÏîÄ¿ÖÐXMLµØÓü¡£ +starter的实现:虽然ä¸�å�Œçš„starter实现起æ�¥å�„有差异,但是他们基本上都会使用到两个相å�Œçš„内容:ConfigurationPropertieså’ŒAutoConfiguration。因为Spring Bootå�šä¿¡â€œçº¦å®šå¤§äºŽé…�ç½®â€�这一ç�†å¿µï¼Œæ‰€ä»¥æˆ‘们使用ConfigurationPropertiesæ�¥ä¿�存我们的é…�置,并且这些é…�置都å�¯ä»¥æœ‰ä¸€ä¸ªé»˜è®¤å€¼ï¼Œå�³åœ¨æˆ‘们没有主动覆写原始é…�置的情况下,默认值就会生效,这在很多情况下是é�žå¸¸æœ‰ç”¨çš„。除此之外,starterçš„ConfigurationProperties还使得所有的é…�置属性被è�šé›†åˆ°ä¸€ä¸ªæ–‡ä»¶ä¸­ï¼ˆä¸€èˆ¬åœ¨resources目录下的application.properties),这样我们就告别了Spring项目中XML地狱。 -starterµÄÕûÌåÂß¼­£º +starter的整体逻辑: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/697611-20180409110236645-2097376440.png) -ÉÏÃæµÄstarterÒÀÀµµÄjarºÍÎÒÃÇ×Ô¼ºÊÖ¶¯ÅäÖõÄʱºòÒÀÀµµÄjar²¢Ã»ÓÐʲô²»Í¬£¬ËùÒÔÎÒÃÇ¿ÉÒÔÈÏΪstarterÆäʵÊǰÑÕâһЩ·±ËöµÄÅäÖòÙ×÷½»¸øÁË×Ô¼º£¬¶ø°Ñ¼òµ¥½»¸øÁËÓû§¡£³ýÁ˰ïÖúÓû§È¥³ýÁË·±ËöµÄ¹¹½¨²Ù×÷£¬ÔÚ¡°Ô¼¶¨´óÓÚÅäÖá±µÄÀíÄîÏ£¬ConfigurationProperties»¹°ïÖúÓû§¼õÉÙÁËÎÞνµÄÅäÖòÙ×÷¡£²¢ÇÒÒòΪ?`application.properties`?ÎļþµÄ´æÔÚ£¬¼´Ê¹ÐèÒª×Ô¶¨ÒåÅäÖã¬ËùÓеÄÅäÖÃÒ²Ö»ÐèÒªÔÚÒ»¸öÎļþÖнøÐУ¬Ê¹ÓÃÆðÀ´·Ç³£·½±ã¡£ +上é�¢çš„starterä¾�èµ–çš„jar和我们自己手动é…�置的时候ä¾�èµ–çš„jar并没有什么ä¸�å�Œï¼Œæ‰€ä»¥æˆ‘们å�¯ä»¥è®¤ä¸ºstarter其实是把这一些ç¹�ç��çš„é…�ç½®æ“�作交给了自己,而把简å�•交给了用户。除了帮助用户去除了ç¹�ç��的构建æ“�作,在“约定大于é…�ç½®â€�çš„ç�†å¿µä¸‹ï¼ŒConfigurationProperties还帮助用户å‡�少了无谓的é…�ç½®æ“�作。并且因为?`application.properties`?文件的存在,å�³ä½¿éœ€è¦�自定义é…�置,所有的é…�置也å�ªéœ€è¦�在一个文件中进行,使用起æ�¥é�žå¸¸æ–¹ä¾¿ã€‚ -Á˽âÁËstarterÆäʵ¾ÍÊǰïÖúÓû§¼ò»¯ÁËÅäÖõIJÙ×÷Ö®ºó£¬ÒªÀí½âstarterºÍ±»ÅäÖÃÁËstarterµÄ×é¼þÖ®¼ä²¢²»ÊǾºÕù¹ØÏµ£¬¶øÊǸ¨Öú¹ØÏµ£¬¼´ÎÒÃÇ¿ÉÒÔ¸øÒ»¸ö×é¼þ´´½¨Ò»¸östarterÀ´ÈÃ×îÖÕÓû§ÔÚʹÓÃÕâ¸ö×é¼þµÄʱºò¸ü¼ÓµÄ¼òµ¥·½±ã¡£»ùÓÚÕâÖÖÀíÄÎÒÃÇ¿ÉÒÔ¸øÈÎÒâÒ»¸öÏÖÓеÄ×é¼þ´´½¨Ò»¸östarterÀ´ÈñðÈËÔÚʹÓÃÕâ¸ö×é¼þµÄʱºò¸ü¼ÓµÄ¼òµ¥·½±ã£¬ÊÂʵÉÏSpring BootÍŶÓÒѾ­°ïÖúÏÖÓд󲿷ֵÄÁ÷ÐеÄ×é¼þ´´½¨ºÃÁËËüÃǵÄstarter£¬Äã¿ÉÒÔÔÚ[ÕâÀï](https://github.com/spring-projects/spring-boot/tree/v1.5.7.RELEASE/spring-boot-starters)²é¿´ÕâЩstarterµÄÁÐ±í¡£ +了解了starter其实就是帮助用户简化了é…�置的æ“�作之å�Žï¼Œè¦�ç�†è§£starter和被é…�置了starter的组件之间并ä¸�是竞争关系,而是辅助关系,å�³æˆ‘们å�¯ä»¥ç»™ä¸€ä¸ªç»„件创建一个starteræ�¥è®©æœ€ç»ˆç”¨æˆ·åœ¨ä½¿ç”¨è¿™ä¸ªç»„件的时候更加的简å�•方便。基于这ç§�ç�†å¿µï¼Œæˆ‘们å�¯ä»¥ç»™ä»»æ„�一个现有的组件创建一个starteræ�¥è®©åˆ«äººåœ¨ä½¿ç”¨è¿™ä¸ªç»„件的时候更加的简å�•方便,事实上Spring Boot团队已ç»�帮助现有大部分的æµ�行的组件创建好了它们的starter,你å�¯ä»¥åœ¨[这里](https://github.com/spring-projects/spring-boot/tree/v1.5.7.RELEASE/spring-boot-starters)查看这些starter的列表。 -ÓÃÁËspringboot ÄÇô¾ÃÁ˾ÓÈ»¶¼»¹Ã»×Ô¶¨Òå¹ýstarter£¬ÏëÏë¶¼¾õµÃÐßÀ¢£¬ËùÒÔ½ñÌìÀ´ÍæÒ»Ï¡£ +用了springboot 那么久了居然都还没自定义过starter,想想都觉得羞愧,所以今天æ�¥çŽ©ä¸€ä¸‹ã€‚ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416200541.png) # SpringBoot starter -SpringBootÖеÄstarterÊÇÒ»Öַdz£ÖØÒªµÄ»úÖÆ£¬Äܹ»ÅׯúÒÔǰ·±ÔÓµÄÅäÖ㬽«Æäͳһ¼¯³É½østarter£¬Ó¦ÓÃÕßÖ»ÐèÒªÔÚmavenÖÐÒýÈëstarterÒÀÀµ£¬SpringBoot¾ÍÄÜ×Ô¶¯É¨Ãèµ½Òª¼ÓÔØµÄÐÅÏ¢²¢Æô¶¯ÏàÓ¦µÄĬÈÏÅäÖá£starterÈÃÎÒÃǰÚÍÑÁ˸÷ÖÖÒÀÀµ¿âµÄ´¦Àí£¬ÐèÒªÅäÖø÷ÖÖÐÅÏ¢µÄÀ§ÈÅ¡£SpringBoot»á×Ô¶¯Í¨¹ýclasspath·¾¶ÏµÄÀà·¢ÏÖÐèÒªµÄBean£¬²¢×¢²á½øIOCÈÝÆ÷¡£SpringBootÌṩÁËÕë¶ÔÈÕ³£ÆóÒµÓ¦ÓÃÑз¢¸÷ÖÖ³¡¾°µÄspring-boot-starterÒÀÀµÄ£¿é¡£ËùÓÐÕâЩÒÀÀµÄ£¿é¶¼×ñÑ­×ÅÔ¼¶¨³ÉË×µÄĬÈÏÅäÖ㬲¢ÔÊÐíÎÒÃǵ÷ÕûÕâЩÅäÖ㬼´×ñÑ­¡°Ô¼¶¨´óÓÚÅäÖá±µÄÀíÄî¡£ +SpringBoot中的starter是一ç§�é�žå¸¸é‡�è¦�的机制,能够抛弃以å‰�ç¹�æ�‚çš„é…�置,将其统一集æˆ�è¿›starter,应用者å�ªéœ€è¦�在maven中引入starterä¾�赖,SpringBoot就能自动扫æ��到è¦�加载的信æ�¯å¹¶å�¯åŠ¨ç›¸åº”çš„é»˜è®¤é…�置。starter让我们摆脱了å�„ç§�ä¾�赖库的处ç�†ï¼Œéœ€è¦�é…�ç½®å�„ç§�ä¿¡æ�¯çš„困扰。SpringBoot会自动通过classpath路径下的类å�‘现需è¦�çš„Bean,并注册进IOC容器。SpringBootæ��供了针对日常ä¼�业应用研å�‘å�„ç§�场景的spring-boot-starterä¾�赖模å�—。所有这些ä¾�赖模å�—都é�µå¾ªç�€çº¦å®šæˆ�俗的默认é…�置,并å…�许我们调整这些é…�置,å�³é�µå¾ªâ€œçº¦å®šå¤§äºŽé…�ç½®â€�çš„ç�†å¿µã€‚ -# ×Ô¶¨Òåstarter +# 自定义starter -ÈÕ³£¹¤×÷ÖÐÓÐʱÓÐһЩ¶ÀÁ¢ÓÚÒµÎñÖ®ÍâµÄ¹¦ÄÜ»òÄ£¿é£¬¿ÉÄÜÕâ¸öÏîÄ¿ÔÚÓã¬ÁíÒ»¸öÏîĿҲҪÓã¬Èç¹ûÿ´Î¶¼ÖØÐ¼¯³ÉµÄ»°¾Í»áºÜÂé·³£¬ÕâʱÎÒÃÇÖ»Òª°ÑÕâЩ¹¦ÄÜ»òÄ£¿é·â×°³ÉÒ»¸ö¸östarterµÄ»°£¬ÔÚʹÓõÄʱºòÒýÈë½øÈ¥¾ÍºÜ·½±ãÁË¡£ +日常工作中有时有一些独立于业务之外的功能或模å�—,å�¯èƒ½è¿™ä¸ªé¡¹ç›®åœ¨ç”¨ï¼Œå�¦ä¸€ä¸ªé¡¹ç›®ä¹Ÿè¦�用,如果æ¯�次都é‡�新集æˆ�çš„è¯�就会很麻烦,这时我们å�ªè¦�把这些功能或模å�—å°�装æˆ�一个个starterçš„è¯�,在使用的时候引入进去就很方便了。 -## ×Ô¶¨Òåstarter²½Öè +## 自定义starter步骤 -Æäʵ×Ô¶¨ÒåstarterºÜ¼òµ¥£¬´óÖÂÐèÒªÒÔÏÂ5²½£º +其实自定义starter很简å�•,大致需è¦�以下5步: -1. н¨Á½¸öÄ£¿é£¬ÃüÃû¹æ·¶£º springboot×Ô´øµÄstarterÃüÃû¹æ·¶Îªspring-boot-starter-xxx£¬ ×Ô¶¨ÒåµÄstarterÃüÃû¹æ·¶Îªxxx-spring-boot-starter +1. 新建两个模å�—,命å��规范: springboot自带的starter命å��规范为spring-boot-starter-xxx, 自定义的starter命å��规范为xxx-spring-boot-starter -¡ñ xxx-spring-boot-autoconfigure£º×Ô¶¯ÅäÖúËÐÄ´úÂë -¡ñ xxx-spring-boot-starter£º¹ÜÀíÒÀÀµ -Èç¹û²»ÐèÒª½«×Ô¶¯ÅäÖôúÂëºÍÒÀÀµÏî¹ÜÀí·ÖÀ뿪À´£¬Ôò¿ÉÒÔ½«ËüÃÇ×éºÏµ½Ò»¸öÄ£¿éÖС£Ö»²»¹ýspringboot¹Ù·½½¨Ò齫Á½¸öÄ£¿é·Ö¿ª¡£ -2\. ÒýÈëspring-boot-autoconfigureÒÀÀµ -3\. ´´½¨×Ô¶¨ÒåµÄXXXProperties Àà: Õâ¸öÀàµÄÊôÐÔ¸ù¾ÝÐèÒªÊÇÒª³öÏÖÔÚÅäÖÃÎļþÖеġ£ -4\. ´´½¨×Ô¶¨ÒåµÄXXXAutoConfigurationÀࣺÕâ¸öÀàÒªÅäÖÃ×Ô¶¯ÅäÖÃʱµÄһЩÂß¼­£¬Í¬Ê±Ò²ÒªÈÃXXXProperties ÀàÉúЧ¡£ -5\. ´´½¨×Ô¶¨ÒåµÄspring.factoriesÎļþ£ºÔÚresources/META-INF´´½¨Ò»¸öspring.factoriesÎļþºÍspring-configuration-metadata.json£¬spring-configuration-metadata.jsonÎļþÊÇÓÃÓÚÔÚÌîдÅäÖÃÎļþʱµÄÖÇÄÜÌáʾ£¬¿ÉÒª¿É²»Òª£¬ÓеϰÌáʾÆðÀ´¸üÓѺá£spring.factoriesÓÃÓÚµ¼Èë×Ô¶¯ÅäÖÃÀ࣬±ØÐëÒªÓÐ +â—� xxx-spring-boot-autoconfigure:自动é…�置核心代ç � +â—� xxx-spring-boot-starter:管ç�†ä¾�èµ– +如果ä¸�需è¦�将自动é…�置代ç �å’Œä¾�赖项管ç�†åˆ†ç¦»å¼€æ�¥ï¼Œåˆ™å�¯ä»¥å°†å®ƒä»¬ç»„å�ˆåˆ°ä¸€ä¸ªæ¨¡å�—中。å�ªä¸�过springboot官方建议将两个模å�—分开。 +2\. 引入spring-boot-autoconfigureä¾�èµ– +3\. 创建自定义的XXXProperties ç±»: 这个类的属性根æ�®éœ€è¦�是è¦�出现在é…�置文件中的。 +4\. 创建自定义的XXXAutoConfiguration类:这个类è¦�é…�置自动é…�置时的一些逻辑,å�Œæ—¶ä¹Ÿè¦�让XXXProperties 类生效。 +5\. 创建自定义的spring.factories文件:在resources/META-INF创建一个spring.factories文件和spring-configuration-metadata.json,spring-configuration-metadata.json文件是用于在填写é…�置文件时的智能æ��示,å�¯è¦�å�¯ä¸�è¦�,有的è¯�æ��示起æ�¥æ›´å�‹å¥½ã€‚spring.factories用于导入自动é…�置类,必须è¦�有 -## ʵÏÖ +## 实现 -ÎÒÕâÀïΪÁË·½±ã¾ÍÖ»´´½¨Ò»¸öÄ£¿éÁË£¬ +我这里为了方便就å�ªåˆ›å»ºä¸€ä¸ªæ¨¡å�—了, -1. ´´½¨Ò»¸öÄ£¿é£¬ÃüÃûΪspring-boot-starter-my-starter£¬¶ÔÓ¦pomÎļþ +1. 创建一个模å�—,命å��为spring-boot-starter-my-starter,对应pom文件 ``` com.example spring-boot-starter-my-starter 1.0 my-starter -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. ÒýÈëspring-boot-autoconfigureÒÀÀµ ÎÒÕâÀïʹÓõÄspring-boot-autoconfigure°æ±¾ÊÇ2.6.2 +1. 引入spring-boot-autoconfigureä¾�èµ– 我这里使用的spring-boot-autoconfigure版本是2.6.2 ``` @@ -89,10 +89,10 @@ SpringBoot 2.6.2 -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. ´´½¨×Ô¶¨ÒåµÄXXXProperties Àà +1. 创建自定义的XXXProperties ç±» ``` @ConfigurationProperties(prefix = "com.arron") @@ -108,10 +108,10 @@ public class MyStarterProperties { this.name = name; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÔÙ´´½¨Ò»¸öMyStarterConfigÓÃÓÚ¶ÁÈ¡MyStarterProperties ÀïµÄÊôÐÔ +å†�创建一个MyStarterConfig用于读å�–MyStarterProperties 里的属性 ``` public class MyStarterConfig { @@ -132,14 +132,14 @@ public class MyStarterConfig { this.name = name; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. ´´½¨×Ô¶¨ÒåµÄXXXAutoConfigurationÀà +1. 创建自定义的XXXAutoConfigurationç±» ``` @Configuration -// EnableConfigurationProperties valueÊý×éÖеÄÅäÖÃÀàÆð×÷Óà +// EnableConfigurationProperties value数组中的é…�置类起作用 @EnableConfigurationProperties(value = {MyStarterProperties.class}) public class MyStarterAutoConfiguration { @@ -153,16 +153,16 @@ public class MyStarterAutoConfiguration { } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. ÔÚresources/META-INF´´½¨Ò»¸öspring.factoriesÎļþ +1. 在resources/META-INF创建一个spring.factories文件 spring.factories ``` org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.myStarter.MyStarterAutoConfiguration -¸´ÖÆ´úÂë +å¤�制代ç � ``` spring-configuration-metadata.json @@ -186,16 +186,16 @@ spring-configuration-metadata.json } ] } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## ´ò°ü²âÊÔ +## 打包测试 -ÕÒµ½Èçͼmaven£¬µã»÷install£¬°²×°µ½±¾µØ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230416200527082.png) +找到如图maven,点击install,安装到本地 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230416200527082.png) -È»ºóн¨Ò»¸öÏîÄ¿µ¼°ü½øÐвâÊÔ£¬´´½¨ÏîÄ¿¹ý³Ì¾Í²»½éÉÜÁË¡£ +ç„¶å�Žæ–°å»ºä¸€ä¸ªé¡¹ç›®å¯¼åŒ…进行测试,创建项目过程就ä¸�介ç»�了。 -1. ÒýÈëÒÀÀµ +1. 引入ä¾�èµ– ``` @@ -203,19 +203,19 @@ spring-configuration-metadata.json spring-boot-starter-my-starter 1.0 -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. ÅäÖÃÎļþÌí¼ÓÊôÐÔ£º +1. é…�置文件添加属性: ``` com: arron: name: myname -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. µ¥Ôª²âÊÔ£º +1. å�•元测试: ``` @RunWith(SpringRunner.class) @@ -230,33 +230,33 @@ class RabbitmqApplicationTests { System.out.println(name); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -¿ØÖÆÌ¨Êä³ö£º +控制å�°è¾“出: ``` myname -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÖÁ´Ë£¬Ò»¸ö¼òµ¥×Ô¶¨ÒåµÄspringboot starter¾ÍÍê³ÉÁË¡£ +至此,一个简å�•自定义的springboot starter就完æˆ�了。 -# ×¢½â½âÊÍ +# 注解解释 -ÏÂÃæÕâЩע½âÔÚ×Ô¶¨ÒåstarterÊÇ¿ÉÄÜ»áÓõ½¡£ +下é�¢è¿™äº›æ³¨è§£åœ¨è‡ªå®šä¹‰starter是å�¯èƒ½ä¼šç”¨åˆ°ã€‚ -* @Conditional£º°´ÕÕÒ»¶¨µÄÌõ¼þ½øÐÐÅжϣ¬Âú×ãÌõ¼þ¸øÈÝÆ÷×¢²ábean -* @ConditionalOnMissingBean£º¸ø¶¨µÄÔÚbean²»´æÔÚʱ,ÔòʵÀý»¯µ±Ç°Bean -* @ConditionalOnProperty£ºÅäÖÃÎļþÖÐÂú×㶨ÒåµÄÊôÐÔÔò´´½¨bean£¬·ñÔò²»´´½¨ -* @ConditionalOnBean£º¸ø¶¨µÄÔÚbean´æÔÚʱ,ÔòʵÀý»¯µ±Ç°Bean -* @ConditionalOnClass£º µ±¸ø¶¨µÄÀàÃûÔÚÀà·¾¶ÉÏ´æÔÚ£¬ÔòʵÀý»¯µ±Ç°Bean -* @ConditionalOnMissingClass £ºµ±¸ø¶¨µÄÀàÃûÔÚÀà·¾¶Éϲ»´æÔÚ£¬ÔòʵÀý»¯µ±Ç°Bean +* @Conditional:按照一定的æ�¡ä»¶è¿›è¡Œåˆ¤æ–­ï¼Œæ»¡è¶³æ�¡ä»¶ç»™å®¹å™¨æ³¨å†Œbean +* @ConditionalOnMissingBean:给定的在beanä¸�存在时,则实例化当å‰�Bean +* @ConditionalOnProperty:é…�置文件中满足定义的属性则创建bean,å�¦åˆ™ä¸�创建 +* @ConditionalOnBean:给定的在bean存在时,则实例化当å‰�Bean +* @ConditionalOnClass: 当给定的类å��在类路径上存在,则实例化当å‰�Bean +* @ConditionalOnMissingClass :当给定的类å��在类路径上ä¸�存在,则实例化当å‰�Bean -×÷ÕߣºË÷ÂëÀí -Á´½Ó£ºhttps://juejin.cn/post/7127468724046528525 -À´Ô´£ºÏ¡ÍÁ¾ò½ð -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +作者:索ç �ç�† +链接:https://juejin.cn/post/7127468724046528525 +æ�¥æº�:稀土掘金 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\211\215\344\270\226\344\273\212\347\224\237.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\211\215\344\270\226\344\273\212\347\224\237.md" index c524bd5..ecd543b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\211\215\344\270\226\344\273\212\347\224\237.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\211\215\344\270\226\344\273\212\347\224\237.md" @@ -1,65 +1,65 @@ -# SpringBootµÄǰÊÀ½ñÉú +# SpringBootçš„å‰�世今生 -Spring Boot 2.0 µÄÍÆ³öÓÖ¼¤ÆðÁËÒ»Õóѧϰ Spring Boot ÈÈ£¬¾Íµ¥´ÓÎÒ¸öÈ˵IJ©¿ÍµÄ·ÃÎÊÁ¿´ó·ùÔö¼Ó¾Í¿ÉÒÔ¸ÐÊܵ½´ó¼Ò¶Ôѧϰ Spring Boot µÄÈÈÇ飬ÄÇôÔÚÕâô¶àÈËÈÈÖÔÓÚѧϰ Spring Boot ֮ʱ£¬ÎÒ×Ô¼ºÒ²ÔÚ˼¿¼£º Spring Boot µ®ÉúµÄ±³¾°ÊÇʲô£¿Spring ÆóÒµÓÖÊÇ»ùÓÚʲôÑùµÄ¿¼ÂÇ´´½¨ Spring Boot? ´«Í³ÆóҵʹÓà Spring Boot »á¸øÎÒÃÇ´øÀ´Ê²Ã´Ñù±ä¸ï? +Spring Boot 2.0 的推出å�ˆæ¿€èµ·äº†ä¸€é˜µå­¦ä¹  Spring Boot 热,就å�•从我个人的å�šå®¢çš„访问é‡�大幅增加就å�¯ä»¥æ„Ÿå�—到大家对学习 Spring Boot 的热情,那么在这么多人热衷于学习 Spring Boot 之时,我自己也在æ€�考: Spring Boot 诞生的背景是什么?Spring ä¼�业å�ˆæ˜¯åŸºäºŽä»€ä¹ˆæ ·çš„考虑创建 Spring Boot? 传统ä¼�业使用 Spring Boot 会给我们带æ�¥ä»€ä¹ˆæ ·å�˜é�©? -´ø×ÅÕâЩÎÊÌ⣬ÎÒÃÇÒ»ÆðÀ´Á˽âÏ Spring Boot µ½µ×ÊÇʲô? +带ç�€è¿™äº›é—®é¢˜ï¼Œæˆ‘们一起æ�¥äº†è§£ä¸‹ Spring Boot 到底是什么? -## Spring ÀúÊ· +## Spring 历å�² -˵Æð Spring Boot ÎÒÃDz»µÃ²»ÏÈÁ˽âһϠSpring Õâ¸öÆóÒµ£¬²»½öÒòΪ Spring Boot À´Ô´ÓÚ Spirng ´ó¼Ò×壬¶øÇÒ Spring Boot µÄµ®ÉúºÍ Sping ¿ò¼ÜµÄ·¢Õ¹Ï¢Ï¢Ïà¹Ø¡£ +说起 Spring Boot 我们ä¸�å¾—ä¸�先了解一下 Spring 这个ä¼�业,ä¸�仅因为 Spring Boot æ�¥æº�于 Spirng 大家æ—�,而且 Spring Boot 的诞生和 Sping 框架的å�‘展æ�¯æ�¯ç›¸å…³ã€‚ -ʱ¼ä»Øµ½2002Ä꣬µ±Ê±ÕýÊÇ Java EE ºÍ EJB ´óÐÐÆäµÀµÄʱºò£¬ºÜ¶àÖªÃû¹«Ë¾¶¼ÊDzÉÓô˼¼Êõ·½°¸½øÐÐÏîÄ¿¿ª·¢¡£ÕâʱºòÓÐÒ»¸öÃÀ¹úµÄС»ï×ÓÈÏΪ EJB Ì«¹ýÓ·Ö×£¬²¢²»ÊÇËùÓеÄÏîÄ¿¶¼ÐèҪʹÓà EJB ÕâÖÖ´óÐÍ¿ò¼Ü£¬Ó¦¸Ã»áÓÐÒ»ÖÖ¸üºÃµÄ·½°¸À´½â¾öÕâ¸öÎÊÌâ¡£ +时间回到2002年,当时正是 Java EE å’Œ EJB 大行其é�“的时候,很多知å��å…¬å�¸éƒ½æ˜¯é‡‡ç”¨æ­¤æŠ€æœ¯æ–¹æ¡ˆè¿›è¡Œé¡¹ç›®å¼€å�‘。这时候有一个美国的å°�ä¼™å­�认为 EJB 太过臃肿,并ä¸�是所有的项目都需è¦�使用 EJB è¿™ç§�大型框架,应该会有一ç§�更好的方案æ�¥è§£å†³è¿™ä¸ªé—®é¢˜ã€‚ -ΪÁËÖ¤Ã÷ËûµÄÏë·¨ÊÇÕýÈ·µÄ£¬ÓÚ2002Äê10ÔÂÉõÖÁдÁËÒ»±¾Êé¡¶ Expert One-on-One J2EE ¡·£¬½éÉÜÁ˵±Ê± Java ÆóÒµÓ¦ÓóÌÐò¿ª·¢µÄÇé¿ö£¬²¢Ö¸³öÁË Java EE ºÍ EJB ×é¼þ¿ò¼ÜÖдæÔÚµÄһЩÖ÷ҪȱÏÝ¡£ÔÚÕâ±¾ÊéÖУ¬ËûÌá³öÁËÒ»¸ö»ùÓÚÆÕͨ Java ÀàºÍÒÀÀµ×¢ÈëµÄ¸ü¼òµ¥µÄ½â¾ö·½°¸¡£ +为了è¯�明他的想法是正确的,于2002å¹´10月甚至写了一本书《 Expert One-on-One J2EE 》,介ç»�了当时 Java ä¼�业应用程åº�å¼€å�‘的情况,并指出了 Java EE å’Œ EJB 组件框架中存在的一些主è¦�缺陷。在这本书中,他æ��出了一个基于普通 Java 类和ä¾�赖注入的更简å�•的解决方案。 -ÔÚÊéÖУ¬ËûչʾÁËÈçºÎÔÚ²»Ê¹Óà EJB µÄÇé¿öϹ¹½¨¸ßÖÊÁ¿£¬¿ÉÀ©Õ¹µÄÔÚÏß×ùλԤÁôϵͳ¡£ÎªÁ˹¹½¨Ó¦ÓóÌÐò£¬Ëû±àдÁ˳¬¹ý 30,000 ÐеĻù´¡½á¹¹´úÂ룬ÏîÄ¿Öеĸù°üÃüÃûΪ com.interface21£¬ËùÒÔÈËÃÇ×î³õ³ÆÕâÌ׿ªÔ´¿ò¼ÜΪ interface21£¬Ò²¾ÍÊÇ Spring µÄǰÉí¡£ +在书中,他展示了如何在ä¸�使用 EJB 的情况下构建高质é‡�,å�¯æ‰©å±•的在线座ä½�预留系统。为了构建应用程åº�,他编写了超过 30,000 行的基础结构代ç �,项目中的根包命å��为 com.interface21,所以人们最åˆ�称这套开æº�框架为 interface21,也就是 Spring çš„å‰�身。 -ËûÊÇË­ÄØ£¬Ëû¾ÍÊÇ´óÃû¶¦¶¦µÄ Rod Johnson £¨ÏÂͼ£©, Rod Johnson ÔÚϤÄá´óѧ²»½ö»ñµÃÁ˼ÆËã»úѧλ£¬Í¬Ê±»¹»ñµÃÁËÒôÀÖѧ룬¸üÁîÈ˳ԾªµÄÊÇÔڻص½Èí¼þ¿ª·¢ÁìÓò֮ǰ£¬Ëû»¹»ñµÃÁËÒôÀÖѧµÄ²©Ê¿Ñ§Î»¡£ÏÖÔÚ Rod Johnson ÒѾ­À뿪ÁË Spring £¬³ÉΪÁËÒ»¸öÌìʹͶ×ÊÈË£¬Í¬Ê±Ò²ÊǶà¸ö¹«Ë¾µÄ¶­Ê£¬ÔçÒÑ×ßÉÏÈËÉúáÛ·å¡£ +他是è°�呢,他就是大å��鼎鼎的 Rod Johnson (下图), Rod Johnson 在悉尼大学ä¸�仅获得了计算机学ä½�,å�Œæ—¶è¿˜èŽ·å¾—äº†éŸ³ä¹�å­¦ä½�,更令人å�ƒæƒŠçš„æ˜¯åœ¨å›žåˆ°è½¯ä»¶å¼€å�‘领域之å‰�,他还获得了音ä¹�学的å�šå£«å­¦ä½�。现在 Rod Johnson å·²ç»�离开了 Spring ,æˆ�为了一个天使投资人,å�Œæ—¶ä¹Ÿæ˜¯å¤šä¸ªå…¬å�¸çš„董事,早已走上人生巅峰。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springboot-hot.png) -ÔÚÕâ±¾Êé·¢²¼ºó£¬Ò»¶ÔÒ»µÄ J2EE Éè¼ÆºÍ¿ª·¢Ò»ÅÚ¶øºì¡£Õâ±¾ÊéÃâ·ÑÌṩµÄ´ó²¿·Ö»ù´¡¼Ü¹¹´úÂë¶¼ÊǸ߶ȿÉÖØÓõġ£ 2003 Äê Rod Johnson ºÍͬ°éÔÚ´Ë¿ò¼ÜµÄ»ù´¡ÉÏ¿ª·¢ÁËÒ»¸öȫеĿò¼ÜÃüÃûΪ Spring ,¾Ý Rod Johnson ½éÉÜ Spring ÊÇ´«Í³ J2EE еĿªÊ¼¡£Ëæºó Spring ·¢Õ¹½øÈë¿ì³µµÀ¡£ +在这本书å�‘布å�Žï¼Œä¸€å¯¹ä¸€çš„ J2EE 设计和开å�‘一炮而红。这本书å…�è´¹æ��供的大部分基础架构代ç �都是高度å�¯é‡�用的。 2003 å¹´ Rod Johnson å’Œå�Œä¼´åœ¨æ­¤æ¡†æž¶çš„基础上开å�‘了一个全新的框架命å��为 Spring ,æ�® Rod Johnson 介ç»� Spring 是传统 J2EE 新的开始。éš�å�Ž Spring å�‘展进入快车é�“。 -* 2004 Äê 03 Ô£¬1.0 °æ·¢²¼¡£ -* 2006 Äê 10 Ô£¬2.0 °æ·¢²¼¡£ -* 2007 Äê 11 Ô¸üÃûΪ SpringSource£¬Í¬Ê±·¢²¼ÁË Spring 2.5¡£ -* 2009 Äê 12 Ô£¬Spring 3.0 ·¢²¼¡£ -* 2013 Äê 12 Ô£¬Pivotal Ðû²¼·¢²¼ Spring ¿ò¼Ü 4.0¡£ -* 2017 Äê 09 Ô£¬Spring 5.0 ·¢²¼¡£ +* 2004 å¹´ 03 月,1.0 版å�‘布。 +* 2006 å¹´ 10 月,2.0 版å�‘布。 +* 2007 å¹´ 11 月更å��为 SpringSource,å�Œæ—¶å�‘布了 Spring 2.5。 +* 2009 å¹´ 12 月,Spring 3.0 å�‘布。 +* 2013 å¹´ 12 月,Pivotal 宣布å�‘布 Spring 框架 4.0。 +* 2017 å¹´ 09 月,Spring 5.0 å�‘布。 -## Spring Boot µÄµ®Éú +## Spring Boot 的诞生 -Ëæ×ÅʹÓà Spring ½øÐпª·¢µÄ¸öÈËºÍÆóÒµÔ½À´Ô½¶à£¬Spring Ò²ÂýÂý´ÓÒ»¸öµ¥Ò»¼ò½àµÄС¿ò¼Ü±ä³ÉÒ»¸ö´ó¶øÈ«µÄ¿ªÔ´Èí¼þ£¬Spring µÄ±ß½ç²»¶ÏµÄ½øÐÐÀ©³ä£¬µ½Á˺óÀ´ Spring ¼¸ºõ¿ÉÒÔ×öÈκÎÊÂÇéÁË£¬ÊÐÃæÉÏÖ÷Á÷µÄ¿ªÔ´Èí¼þ¡¢Öмä¼þ¶¼ÓÐ Spring ¶ÔÓ¦×é¼þÖ§³Ö£¬ÈËÃÇÔÚÏíÓà Spring µÄÕâÖÖ±ãÀûÖ®ºó£¬Ò²Óöµ½ÁËһЩÎÊÌâ¡£ +éš�ç�€ä½¿ç”¨ Spring 进行开å�‘的个人和ä¼�业越æ�¥è¶Šå¤šï¼ŒSpring 也慢慢从一个å�•一简æ´�çš„å°�框架å�˜æˆ�一个大而全的开æº�软件,Spring 的边界ä¸�断的进行扩充,到了å�Žæ�¥ Spring 几乎å�¯ä»¥å�šä»»ä½•事情了,市é�¢ä¸Šä¸»æµ�的开æº�软件ã€�中间件都有 Spring 对应组件支æŒ�,人们在享用 Spring 的这ç§�便利之å�Žï¼Œä¹Ÿé�‡åˆ°äº†ä¸€äº›é—®é¢˜ã€‚ -Spring ÿ¼¯³ÉÒ»¸ö¿ªÔ´Èí¼þ£¬¾ÍÐèÒªÔö¼ÓһЩ»ù´¡ÅäÖã¬ÂýÂýµÄËæ×ÅÈËÃÇ¿ª·¢µÄÏîĿԽÀ´Ô½ÅÓ´ó£¬ÍùÍùÐèÒª¼¯³ÉºÜ¶à¿ªÔ´Èí¼þ£¬Òò´ËºóÆÚʹÓà Spirng ¿ª·¢´óÐÍÏîÄ¿ÐèÒªÒýÈëºÜ¶àÅäÖÃÎļþ£¬Ì«¶àµÄÅäÖ÷dz£ÄÑÒÔÀí½â£¬²¢ÈÝÒ×ÅäÖóö´í£¬µ½Á˺óÀ´ÈËÃÇÉõÖÁ³Æ Spring ΪÅäÖõØÓü¡£ +Spring æ¯�集æˆ�一个开æº�软件,就需è¦�增加一些基础é…�置,慢慢的éš�ç�€äººä»¬å¼€å�‘的项目越æ�¥è¶Šåºžå¤§ï¼Œå¾€å¾€éœ€è¦�集æˆ�很多开æº�软件,因此å�ŽæœŸä½¿ç”¨ Spirng å¼€å�‘大型项目需è¦�引入很多é…�置文件,太多的é…�ç½®é�žå¸¸éš¾ä»¥ç�†è§£ï¼Œå¹¶å®¹æ˜“é…�置出错,到了å�Žæ�¥äººä»¬ç”šè‡³ç§° Spring 为é…�置地狱。 -Spring ËÆºõÒ²Òâʶµ½ÁËÕâЩÎÊÌ⣬¼±ÐèÓÐÕâôһÌ×Èí¼þ¿ÉÒÔ½â¾öÕâЩÎÊÌ⣬Õâ¸öʱºò΢·þÎñµÄ¸ÅÄîÒ²ÂýÂýÐËÆð£¬¿ìËÙ¿ª·¢Î¢Ð¡¶ÀÁ¢µÄÓ¦ÓñäµÃ¸üΪ¼±ÆÈ£¬Spring ¸ÕºÃ´¦ÔÚÕâôһ¸ö½»²æµãÉÏ£¬ÓÚ 2013 Äê³õ¿ªÊ¼µÄ Spring Boot ÏîÄ¿µÄÑз¢£¬2014Äê4Ô£¬Spring Boot 1.0.0 ·¢²¼¡£ +Spring 似乎也æ„�识到了这些问题,急需有这么一套软件å�¯ä»¥è§£å†³è¿™äº›é—®é¢˜ï¼Œè¿™ä¸ªæ—¶å€™å¾®æœ�务的概念也慢慢兴起,快速开å�‘å¾®å°�独立的应用å�˜å¾—更为急迫,Spring 刚好处在这么一个交å�‰ç‚¹ä¸Šï¼ŒäºŽ 2013 å¹´åˆ�开始的 Spring Boot 项目的研å�‘,2014å¹´4月,Spring Boot 1.0.0 å�‘布。 -Spring Boot µ®ÉúÖ®³õ£¬¾ÍÊܵ½¿ªÔ´ÉçÇøµÄ³ÖÐø¹Ø×¢£¬Â½ÐøÓÐһЩ¸öÈËºÍÆóÒµ³¢ÊÔ×ÅʹÓÃÁË Spring Boot£¬²¢Ñ¸ËÙϲ»¶ÉÏÁËÕâ¿î¿ªÔ´Èí¼þ¡£Ö±µ½2016Ä꣬ÔÚ¹úÄÚ Spring Boot ²Å±»ÕýÕæÊ¹ÓÃÁËÆðÀ´£¬ÆÚ¼äºÜ¶àÑо¿ Spring Boot µÄ¿ª·¢ÕßÔÚÍøÉÏдÁË´óÁ¿¹ØÓÚ Spring Boot µÄÎÄÕ£¬Í¬Ê±ÓÐһЩ¹«Ë¾ÔÚÆóÒµÄÚ²¿½øÐÐÁËС¹æÄ£µÄʹÓ㬲¢½«Ê¹Óþ­Ñé·ÖÏíÁ˳öÀ´¡£´Ó2016Äêµ½2018Ä꣬ʹÓà Spring Boot µÄÆóÒµºÍ¸öÈË¿ª·¢ÕßÔ½À´Ô½¶à£¬ÎÒÃÇ´Ó Spring Boot ¹Ø¼ü×ֵİٶÈÖ¸Êý¾Í¿ÉÒÔ¿´³ö¡£ +Spring Boot 诞生之åˆ�,就å�—到开æº�社区的æŒ�续关注,陆续有一些个人和ä¼�业å°�试ç�€ä½¿ç”¨äº† Spring Boot,并迅速喜欢上了这款开æº�软件。直到2016年,在国内 Spring Boot æ‰�被正真使用了起æ�¥ï¼ŒæœŸé—´å¾ˆå¤šç ”ç©¶ Spring Boot 的开å�‘者在网上写了大é‡�关于 Spring Boot 的文章,å�Œæ—¶æœ‰ä¸€äº›å…¬å�¸åœ¨ä¼�业内部进行了å°�规模的使用,并将使用ç»�验分享了出æ�¥ã€‚从2016年到2018年,使用 Spring Boot çš„ä¼�业和个人开å�‘者越æ�¥è¶Šå¤šï¼Œæˆ‘们从 Spring Boot 关键字的百度指数就å�¯ä»¥çœ‹å‡ºã€‚ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springboot-hot.png) -ÉÏͼΪ2014Äêµ½2018Äê Spring Boot µÄ°Ù¶ÈÖ¸Êý£¬¿ÉÒÔ¿´³ö Spring Boot 2.0 µÄÍÆ³öÒý·¢ÁËËÑË÷¸ß·å¡£ +上图为2014年到2018å¹´ Spring Boot 的百度指数,å�¯ä»¥çœ‹å‡º Spring Boot 2.0 的推出引å�‘了æ�œç´¢é«˜å³°ã€‚ -µ±È» Spring Boot ²»ÊÇΪÁËÈ¡´ú Spring ,Spring Boot »ùÓÚ Spring ¿ª·¢£¬ÊÇΪÁËÈÃÈËÃǸüÈÝÒ×µÄʹÓà Spring¡£¿´µ½ Spring Boot µÄÊг¡·´Ó¦£¬Spring ¹Ù·½Ò²·Ç³£ÖØÊÓ Spring Boot µÄºóÐø·¢Õ¹£¬ÒѾ­½« Spring Boot ×÷Ϊ¹«Ë¾×î¶¥¼¶µÄÏîÄ¿À´Íƹ㣬·Åµ½Á˹ÙÍøÉϵÚÒ»µÄλÖã¬Òò´ËºóÐø Spring Boot µÄ³ÖÐø·¢Õ¹Ò²±»¿´ºÃ¡£ +当然 Spring Boot ä¸�是为了å�–代 Spring ,Spring Boot 基于 Spring å¼€å�‘,是为了让人们更容易的使用 Spring。看到 Spring Boot 的市场å��应,Spring 官方也é�žå¸¸é‡�视 Spring Boot çš„å�Žç»­å�‘展,已ç»�å°† Spring Boot 作为公å�¸æœ€é¡¶çº§çš„项目æ�¥æŽ¨å¹¿ï¼Œæ”¾åˆ°äº†å®˜ç½‘上第一的ä½�置,因此å�Žç»­ Spring Boot çš„æŒ�ç»­å�‘展也被看好。 -# »ù±¾½éÉÜ +# 基本介ç»� ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230415111020.png) -ÕâÊÇspring¹ÙÍø¶ÔÓÚspringbootµÄ»ù±¾½éÉÜ +这是spring官网对于springboot的基本介ç»� Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "just run". We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need minimal Spring configuration. -¼ò¶øÑÔÖ®£¬¾ÍÊÇÔÚ¸æËßÎÒÃÇ£¬springboot¿ÉÒÔ°ïÖúÎÒÃÇ¿ìËÙ¹¹½¨¶ÀÁ¢²¿ÊðµÄÉú²ú¼¶Ó¦Óà +简而言之,就是在告诉我们,springbootå�¯ä»¥å¸®åŠ©æˆ‘ä»¬å¿«é€Ÿæž„å»ºç‹¬ç«‹éƒ¨ç½²çš„ç”Ÿäº§çº§åº”ç”¨ -£¬Ö»ÐèÒªÒ»¸ö´øÓÐ@SpringBootApplication ×¢½âµÄÓ¦ÓÃÈë¿Ú£¬¼´¿É±»Ê¶±ðΪһ¸öspringbootÓ¦Óà +,å�ªéœ€è¦�一个带有@SpringBootApplication 注解的应用入å�£ï¼Œå�³å�¯è¢«è¯†åˆ«ä¸ºä¸€ä¸ªspringboot应用 -²¢ÇÒ£¬springboot¼Ì³ÐÁË´óÁ¿µÄµÚÈý·½¿â£¬ÎÒÃǽöÐèºÜÉÙÉõÖÁÊÇÍêÈ«²»ÐèÒª¶îÍâµÄÅäÖ㬾ͿÉÒÔ½øÐÐÓ¦Óô£¬ÒòΪspringboot¿ò¼Ü±¾ÉíÒѾ­°ïÎÒÃÇÉèÖúÃÁË´óÁ¿µÄĬÈÏÅäÖᣠ+并且,springboot继承了大é‡�的第三方库,我们仅需很少甚至是完全ä¸�需è¦�é¢�外的é…�置,就å�¯ä»¥è¿›è¡Œåº”用æ�­å»ºï¼Œå› ä¸ºspringboot框架本身已ç»�帮我们设置好了大é‡�的默认é…�置。 -# »ù±¾ÌØÐÔ +# 基本特性 Features @@ -70,139 +70,139 @@ Features * Provide production-ready features such as metrics, health checks, and externalized configuration * Absolutely no code generation and no requirement for XML configuration -¹Ù·½¶ÔÓÚspringboot¼¸´óÌØÐÔµÄÃèÊöÈçÉÏ +官方对于springboot几大特性的æ��述如上 -1¡¢´´½¨Ò»¸ö¶ÀÁ¢²¿ÊðµÄspringÓ¦Óã¬Ëü³£ÓÃÓÚ¶¨Òå΢·þÎñ£¬»òÕßÊÇÒ»¸öwebÓ¦Óà +1ã€�创建一个独立部署的spring应用,它常用于定义微æœ�务,或者是一个web应用 -2¡¢ÄÚÖõÄtomcatÈÝÆ÷£¬ÎÒÃÇÔÙÒ²ÐèÒª°ÑspringÓ¦Óôò°ü³Éwar°ü£¬¶øÊÇÖ»ÐèÒª½«Æä´ò°ü³Éjar°ü½øÐв¿Êð¼´¿É¡£ +2ã€�内置的tomcat容器,我们å†�也需è¦�把spring应用打包æˆ�war包,而是å�ªéœ€è¦�将其打包æˆ�jar包进行部署å�³å�¯ã€‚ -3¡¢ÌṩstarterÒÀÀµ£¬¸ü¼Ó¼ò»¯ÁËspringbootÉú̬ÖеÄÒÀÀµºÍÅäÖã¬ÀýÈçµ±ÎÒÃÇʹÓÃspringwebÏà¹ØÒÀÀµÊ±£¬ÎÒÃDz»ÐèÒªµ¥¶ÀµØÌí¼Ó¶à¸öspringmvcÏà¹ØµÄmavenÒÀÀµ£¬¶øÊÇÖ±½ÓÒýÓÃspring-boot-starter-web¾Í¿ÉÒÔÁË£¬Õâ¸östarter»á×Ô¶¯ÒýÈëÏà¹ØµÄÒÀÀµ£¬²¢ÇÒ°ïÄã¹ÜÀí°æ±¾ºÅ£¬»á´óÁ¿µØ¼ò»¯ºÍÓÅ»¯ÄãµÄmavenÅäÖà +3ã€�æ��ä¾›starterä¾�赖,更加简化了springboot生æ€�中的ä¾�èµ–å’Œé…�置,例如当我们使用springweb相关ä¾�赖时,我们ä¸�需è¦�å�•独地添加多个springmvc相关的mavenä¾�赖,而是直接引用spring-boot-starter-webå°±å�¯ä»¥äº†ï¼Œè¿™ä¸ªstarter会自动引入相关的ä¾�赖,并且帮你管ç�†ç‰ˆæœ¬å�·ï¼Œä¼šå¤§é‡�地简化和优化你的mavené…�ç½® -4¡¢×Ô¶¯×°ÅäspringºÍµÚÈý·½¿â£¬ÕâÀïÖ÷ÒªÊÇָͨ¹ý×¢½âºÍÅäÖÃÎļþ½øÐÐ×Ô¶¯×°Å䣬²¢ÇÒ»¹ÓÐһЩÊÇ»ùÓÚÔ¼¶¨µÄ×Ô¶¯×°Åä»úÖÆ£¬Õâ¿ÉÒÔ°ïÎÒÃǽÚÊ¡´óÁ¿µÄ¶îÍâÅäÖã¬Ò²¿ÉÒÔ×Ô¶¯×°ÅäÍⲿjar°üÌṩµÄspringÏà¹ØbeanºÍÅäÖᣠ+4ã€�自动装é…�spring和第三方库,这里主è¦�是指通过注解和é…�置文件进行自动装é…�,并且还有一些是基于约定的自动装é…�机制,这å�¯ä»¥å¸®æˆ‘们节çœ�大é‡�çš„é¢�外é…�置,也å�¯ä»¥è‡ªåŠ¨è£…é…�外部jar包æ��供的spring相关beanå’Œé…�置。 -5¡¢ÌṩÁËÉú²ú»·¾³Ïà¹ØµÄÌØÐÔ£¬±ÈÈç¼à¿Ø¡¢Ö¸±ê´òµã¡¢½¡¿µ¼ì²éµÈ¹¦ÄÜ£¬springbootÌṩÁËÇ¿´óµÄÉú̬×é¼þ£¬ÕâÀï²»½ö°üÀ¨springboot×Ô¼ºµÄ×é¼þ£¬Ò²°üÀ¨Ò»Ð©ÍⲿµÄÉú̬×é¼þ¡£ +5ã€�æ��供了生产环境相关的特性,比如监控ã€�指标打点ã€�å�¥åº·æ£€æŸ¥ç­‰åŠŸèƒ½ï¼Œspringbootæ��供了强大的生æ€�组件,这里ä¸�仅包括springboot自己的组件,也包括一些外部的生æ€�组件。 -6¡¢²»²»´æÔÚ´úÂëÉú³É£¬Ò²²»ÐèÒªxmlÅäÖÃÎļþ£¬ÕâÖ¤Ã÷ÁËspringbootµÄ¿ò¼ÜÍêÕû¶È£¬ÒÔ¼°¶ÔÓÚÅäÖüò»¯µÄ¼«ÖÂ×·Çó£¬ÎÒÃǽöÐèÒªapplication.properties½øÐлù±¾ÅäÖòÎÊý¹ÜÀí£¬ÄãÒ²²»»áÔÚspringboot±àÒëÆ÷ÕÒµ½¶¯Ì¬Éú³ÉµÄ¶àÓàclassÎļþ¡£ +6ã€�ä¸�ä¸�存在代ç �生æˆ�,也ä¸�需è¦�xmlé…�置文件,这è¯�明了springboot的框架完整度,以å�Šå¯¹äºŽé…�置简化的æž�致追求,我们仅需è¦�application.properties进行基本é…�ç½®å�‚数管ç�†ï¼Œä½ ä¹Ÿä¸�会在springboot编译器找到动æ€�生æˆ�的多余class文件。 -# ºÍSpringµÄ¹ØÏµ +# å’ŒSpring的关系 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230415111139.png) -## SpringFramework½â¾öÁËʲôÎÊÌ⣿ +## SpringFramework解决了什么问题? -SpringÊÇJavaÆóÒµ°æ£¨Java Enterprise Edition£¬JEE£¬Ò²³ÆJ2EE£©µÄÇáÁ¿¼¶´úÌæÆ·¡£ÎÞÐ迪·¢ÖØÁ¿¼¶µÄEnterpriseJavaBean£¨EJB£©£¬SpringΪÆóÒµ¼¶Java¿ª·¢ÌṩÁËÒ»ÖÖÏà¶Ô¼òµ¥µÄ·½·¨£¬Í¨¹ýÒÀÀµ×¢ÈëºÍÃæÏòÇÐÃæ±à³Ì£¬Óüòµ¥µÄJava¶ÔÏó£¨Plain Old Java Object£¬POJO£©ÊµÏÖÁËEJBµÄ¹¦ÄÜ¡£ +Spring是Javaä¼�业版(Java Enterprise Edition,JEE,也称J2EE)的轻é‡�级代替å“�。无需开å�‘é‡�é‡�级的EnterpriseJavaBean(EJB),Spring为ä¼�业级Javaå¼€å�‘æ��供了一ç§�相对简å�•的方法,通过ä¾�赖注入和é�¢å�‘切é�¢ç¼–程,用简å�•çš„Java对象(Plain Old Java Object,POJO)实现了EJB的功能。 -1.ʹÓÃSpringµÄIOCÈÝÆ÷,½«¶ÔÏóÖ®¼äµÄÒÀÀµ¹ØÏµ½»¸øSpring,½µµÍ×é¼þÖ®¼äµÄñîºÏÐÔ,ÈÃÎÒÃǸüרעÓÚÓ¦ÓÃÂß¼­ +1.使用Springçš„IOC容器,将对象之间的ä¾�赖关系交给Spring,é™�低组件之间的耦å�ˆæ€§,让我们更专注于应用逻辑 -2.¿ÉÒÔÌṩÖÚ¶à·þÎñ,ÊÂÎñ¹ÜÀí,WSµÈ¡£ +2.å�¯ä»¥æ��供众多æœ�务,事务管ç�†,WS等。 -3.ºÜºÃµØÖ§³ÖAOP,·½±ãÃæÏòÇÐÃæ±à³Ì¡£ +3.很好地支æŒ�AOP,方便é�¢å�‘切é�¢ç¼–程。 -4.¶ÔÖ÷Á÷µÄ¿ò¼ÜÌṩÁ˺ܺõÉÖ§³Ö,ÈçHibernate,Struts2,JPAµÈ +4.对主æµ�的框架æ��供了很好的集æˆ�支æŒ�,如Hibernate,Struts2,JPAç­‰ -5.Spring DI»úÖÆ½µµÍÁËÒµÎñ¶ÔÏóÌæ»»µÄ¸´ÔÓÐÔ¡£ +5.Spring DI机制é™�低了业务对象替æ�¢çš„å¤�æ�‚性。 -6.SpringÊôÓÚµÍÇÖÈë,´úÂëÎÛȾ¼«µÍ¡£ +6.Spring属于低侵入,代ç �污染æž�低。 -7.SpringµÄ¸ß¶È¿É¿ª·ÅÐÔ,²¢²»Ç¿ÖÆÒÀÀµÓÚSpring,¿ª·¢Õß¿ÉÒÔ×ÔÓÉÑ¡ÔñSpring²¿·Ö»òÈ«²¿ +7.Spring的高度å�¯å¼€æ”¾æ€§,å¹¶ä¸�强制ä¾�赖于Spring,å¼€å�‘者å�¯ä»¥è‡ªç”±é€‰æ‹©Spring部分或全部 -## SpringFrameworkûÓнâ¾öÁËʲôÎÊÌ⣿ +## SpringFramework没有解决了什么问题? -ËäÈ»SpringµÄ×é¼þ´úÂëÊÇÇáÁ¿¼¶µÄ£¬µ«ËüµÄÅäÖÃÈ´ÊÇÖØÁ¿¼¶µÄ¡£Ò»¿ªÊ¼£¬SpringÓÃXMLÅäÖ㬶øÇÒÊǺܶàXMLÅäÖá£Spring 2.5ÒýÈëÁË»ùÓÚ×¢½âµÄ×é¼þɨÃ裬ÕâÏû³ýÁË´óÁ¿Õë¶ÔÓ¦ÓóÌÐò×ÔÉí×é¼þµÄÏÔʽXMLÅäÖá£Spring 3.0ÒýÈëÁË»ùÓÚJavaµÄÅäÖã¬ÕâÊÇÒ»ÖÖÀàÐͰ²È«µÄ¿ÉÖØ¹¹ÅäÖ÷½Ê½£¬¿ÉÒÔ´úÌæXML¡£ +虽然Spring的组件代ç �是轻é‡�级的,但它的é…�ç½®å�´æ˜¯é‡�é‡�级的。一开始,Spring用XMLé…�置,而且是很多XMLé…�置。Spring 2.5引入了基于注解的组件扫æ��,这消除了大é‡�针对应用程åº�自身组件的显å¼�XMLé…�置。Spring 3.0引入了基于Javaçš„é…�置,这是一ç§�类型安全的å�¯é‡�æž„é…�置方å¼�,å�¯ä»¥ä»£æ›¿XML。 -ËùÓÐÕâЩÅäÖö¼´ú±íÁË¿ª·¢Ê±µÄËðºÄ¡£ÒòΪÔÚ˼¿¼SpringÌØÐÔÅäÖúͽâ¾öÒµÎñÎÊÌâÖ®¼äÐèÒª½øÐÐ˼άÇл»£¬ËùÒÔ±àдÅäÖü·Õ¼Á˱àдӦÓóÌÐòÂß¼­µÄʱ¼ä¡£ºÍËùÓпò¼ÜÒ»Ñù£¬SpringʵÓ㬵«Óë´ËͬʱËüÒªÇóµÄ»Ø±¨Ò²²»ÉÙ¡£ +所有这些é…�置都代表了开å�‘æ—¶çš„æ�Ÿè€—。因为在æ€�考Spring特性é…�置和解决业务问题之间需è¦�进行æ€�维切æ�¢ï¼Œæ‰€ä»¥ç¼–写é…�置挤å� äº†ç¼–写应用程åº�逻辑的时间。和所有框架一样,Spring实用,但与此å�Œæ—¶å®ƒè¦�求的回报也ä¸�少。 -³ý´ËÖ®Í⣬ÏîÄ¿µÄÒÀÀµ¹ÜÀíÒ²ÊÇÒ»¼þºÄʱºÄÁ¦µÄÊÂÇé¡£ÔÚ»·¾³´î½¨Ê±£¬ÐèÒª·ÖÎöÒªµ¼ÈëÄÄЩ¿âµÄ×ø±ê£¬¶øÇÒ»¹ÐèÒª·ÖÎöµ¼ÈëÓëÖ®ÓÐÒÀÀµ¹ØÏµµÄÆäËû¿âµÄ×ø±ê£¬Ò»µ©Ñ¡´íÁËÒÀÀµµÄ°æ±¾£¬ËæÖ®¶øÀ´µÄ²»¼æÈÝÎÊÌâ¾Í»áÑÏÖØ×è°­ÏîÄ¿µÄ¿ª·¢½ø¶È¡£ +除此之外,项目的ä¾�赖管ç�†ä¹Ÿæ˜¯ä¸€ä»¶è€—时耗力的事情。在环境æ�­å»ºæ—¶ï¼Œéœ€è¦�分æž�è¦�导入哪些库的å��标,而且还需è¦�分æž�导入与之有ä¾�赖关系的其他库的å��标,一旦选错了ä¾�赖的版本,éš�之而æ�¥çš„ä¸�兼容问题就会严é‡�阻ç¢�项目的开å�‘进度。 -## SpringBoot½â¾öÉÏÊöSpringµÄȱµã +## SpringBoot解决上述Spring的缺点 -SpringBoot¶ÔÉÏÊöSpringµÄȱµã½øÐеĸÄÉÆºÍÓÅ»¯£¬»ùÓÚÔ¼¶¨ÓÅÓÚÅäÖõÄ˼Ï룬¿ÉÒÔÈÿª·¢ÈËÔ±²»±ØÔÚÅäÖÃÓëÂß¼­ÒµÎñÖ®¼ä½øÐÐ˼άµÄÇл»£¬È«ÉíÐĵÄͶÈëµ½Âß¼­ÒµÎñµÄ´úÂë±àдÖУ¬´Ó¶ø´ó´óÌá¸ßÁË¿ª·¢µÄЧÂÊ£¬Ò»¶¨³Ì¶ÈÉÏËõ¶ÌÁËÏîÄ¿ÖÜÆÚ¡£ +SpringBoot对上述Spring的缺点进行的改善和优化,基于约定优于é…�置的æ€�想,å�¯ä»¥è®©å¼€å�‘人员ä¸�必在é…�置与逻辑业务之间进行æ€�维的切æ�¢ï¼Œå…¨èº«å¿ƒçš„æŠ•入到逻辑业务的代ç �编写中,从而大大æ��高了开å�‘的效率,一定程度上缩短了项目周期。 -ÔÚʹÓÃSpring¿ò¼Ü½øÐпª·¢µÄ¹ý³ÌÖУ¬ÐèÒªÅäÖúܶàSpring¿ò¼Ü°üµÄÒÀÀµ£¬Èçspring-core¡¢spring-bean¡¢spring-contextµÈ£¬¶øÕâЩÅäÖÃͨ³£¶¼ÊÇÖØ¸´Ìí¼ÓµÄ£¬¶øÇÒÐèÒª×öºÜ¶à¿ò¼ÜʹÓü°»·¾³²ÎÊýµÄÖØ¸´ÅäÖã¬È翪Æô×¢½â¡¢ÅäÖÃÈÕÖ¾µÈ¡£Spring BootÖÂÁ¦ÓÚÈõ»¯ÕâЩ²»±ØÒªµÄ²Ù×÷£¬ÌṩĬÈÏÅäÖ㬵±È»ÕâЩĬÈÏÅäÖÃÊÇ¿ÉÒÔ°´ÐèÐ޸ĵģ¬¿ìËٴ¡¢¿ª·¢ºÍÔËÐÐSpringÓ¦Óà +在使用Spring框架进行开å�‘的过程中,需è¦�é…�置很多Spring框架包的ä¾�赖,如spring-coreã€�spring-beanã€�spring-context等,而这些é…�置通常都是é‡�å¤�添加的,而且需è¦�å�šå¾ˆå¤šæ¡†æž¶ä½¿ç”¨å�ŠçŽ¯å¢ƒå�‚æ•°çš„é‡�å¤�é…�置,如开å�¯æ³¨è§£ã€�é…�置日志等。Spring Boot致力于弱化这些ä¸�å¿…è¦�çš„æ“�作,æ��供默认é…�置,当然这些默认é…�置是å�¯ä»¥æŒ‰éœ€ä¿®æ”¹çš„,快速æ�­å»ºã€�å¼€å�‘å’Œè¿�行Spring应用 -# ºÍSpringMVCµÄ¹ØÏµ +# å’ŒSpringMVC的关系 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230415111153.png) -Spring Boot£ºSpring Bootʹ¿ìËÙÒýµ¼ºÍ¿ªÊ¼¿ª·¢»ùÓÚSpringµÄÓ¦ÓóÌÐò±äµÃÈÝÒס£ Ëü±ÜÃâÁ˺ܶàÑù°å´úÂë¡£ ËüÔÚÄ»ºóÒþ²ØÁ˺ܶิÔÓÐÔ£¬Òò´Ë¿ª·¢ÈËÔ±¿ÉÒÔ¿ìËÙÉÏÊÖ²¢ÇáËÉ¿ª·¢»ùÓÚSpringµÄÓ¦ÓóÌÐò¡£ +Spring Boot:Spring Boot使快速引导和开始开å�‘基于Spring的应用程åº�å�˜å¾—容易。 它é�¿å…�了很多样æ�¿ä»£ç �。 它在幕å�Žéš�è—�了很多å¤�æ�‚性,因此开å�‘人员å�¯ä»¥å¿«é€Ÿä¸Šæ‰‹å¹¶è½»æ�¾å¼€å�‘基于Spring的应用程åº�。 -Spring MVC£ºSpring MVCÊÇÓÃÓÚ¹¹½¨WebÓ¦ÓóÌÐòµÄWeb MVC¿ò¼Ü¡£ Ëü°üº¬Ðí¶àÓÃÓÚ¸÷ÖÖ¹¦ÄܵÄÅäÖÃÎļþ¡£ ÕâÊÇÒ»¸öÃæÏòHTTPµÄWebÓ¦ÓóÌÐò¿ª·¢¿ò¼Ü¡£ +Spring MVC:Spring MVC是用于构建Web应用程åº�çš„Web MVC框架。 它包å�«è®¸å¤šç”¨äºŽå�„ç§�功能的é…�置文件。 这是一个é�¢å�‘HTTPçš„Web应用程åº�å¼€å�‘框架。 -Spring BootºÍSpring MVC³öÓÚ²»Í¬µÄÄ¿µÄ¶ø´æÔÚ¡£ ÏÂÃæÌÖÂÛÁËSpring BootºÍSpring MVCÖ®¼äµÄÖ÷񻂿±ð£º +Spring Bootå’ŒSpring MVC出于ä¸�å�Œçš„目的而存在。 下é�¢è®¨è®ºäº†Spring Bootå’ŒSpring MVC之间的主è¦�区别: | Spring Boot | Spring MVC | | --- | --- | -| Spring BootÓÃÓÚʹÓúÏÀíµÄĬÈÏÖµ´ò°ü»ùÓÚSpringµÄÓ¦ÓóÌÐò¡£ | Spring MVCÊÇSpring¿ò¼ÜÏ»ùÓÚÄ£ÐÍÊÓͼ¿ØÖÆÆ÷µÄWeb¿ò¼Ü¡£ | -| ËüÌṩÁËĬÈÏÅäÖÃÀ´¹¹½¨SpringÖ§³ÖµÄ¿ò¼Ü¡£ | ËüÌṩÁËÓÃÓÚ¹¹½¨WebÓ¦ÓóÌÐòµÄ¼´ÓÃÐ͹¦ÄÜ¡£ | -| ÎÞÐèÊÖ¶¯¹¹½¨ÅäÖᣠ| ËüÐèÒªÊÖ¶¯½øÐй¹½¨ÅäÖᣠ| -| ²»ÐèÒª²¿ÊðÃèÊö·û¡£ | ²¿ÊðÃèÊö·ûÊDZØÐèµÄ¡£ | -| Ëü±ÜÃâÁËÑù°å´úÂ룬²¢½«ÒÀÀµÏî°ü×°ÔÚÒ»¸öµ¥ÔªÖС£ | Ëü·Ö±ðÖ¸¶¨Ã¿¸öÒÀÀµÏî¡£ | -| Ëü¼õÉÙÁË¿ª·¢Ê±¼ä²¢Ìá¸ßÁËÉú²úÂÊ¡£ | ʵÏÖÏàͬĿµÄÐèÒª¸ü¶àʱ¼ä¡£ | +| Spring Boot用于使用å�ˆç�†çš„默认值打包基于Spring的应用程åº�。 | Spring MVC是Spring框架下基于模型视图控制器的Web框架。 | +| 它æ��供了默认é…�ç½®æ�¥æž„建Spring支æŒ�的框架。 | 它æ��供了用于构建Web应用程åº�çš„å�³ç”¨åž‹åŠŸèƒ½ã€‚ | +| 无需手动构建é…�置。 | 它需è¦�手动进行构建é…�置。 | +| ä¸�需è¦�部署æ��述符。 | 部署æ��述符是必需的。 | +| 它é�¿å…�了样æ�¿ä»£ç �,并将ä¾�赖项包装在一个å�•元中。 | 它分别指定æ¯�个ä¾�赖项。 | +| 它å‡�少了开å�‘æ—¶é—´å¹¶æ��高了生产率。 | 实现相å�Œç›®çš„需è¦�更多时间。 | -# ºÍ΢·þÎñ¡¢SpringCloudµÄ¹ØÏµ +# 和微æœ�务ã€�SpringCloud的关系 -Spring BootÊÇSpring¼Ò×åµÄ³ÉÔ±£¬ËüÊÇÒ»¸öȫеĿò¼Ü£¬ËüµÄÉè¼ÆÄ¿µÄÊǾ¡¿ÉÄܼòµ¥ºÍ¿ìËٵĿª·¢¡¢ÔËÐÐSpringÓ¦ÓóÌÐò£¬¼ò»¯ÅäÖá£ËüΪ¿ª·¢Õß¿ì½ÝµÄʹÓÃSpring¼°Ïà¹Ø¿ª·¢¿ò¼ÜÌṩÁ˱ãÀû£¬µ«ÊÇËü²¢²»ÊÇ΢·þÎñµÄ¿ò¼Ü£¬ËüÖ»ÊÇΪ΢·þÎñ¿ò¼ÜµÄʹÓÃÒ²ÌṩÁ˺ܺõĽÅÊּܡ£ +Spring Boot是Springå®¶æ—�çš„æˆ�员,它是一个全新的框架,它的设计目的是尽å�¯èƒ½ç®€å�•和快速的开å�‘ã€�è¿�行Spring应用程åº�,简化é…�置。它为开å�‘者快æ�·çš„使用Springå�Šç›¸å…³å¼€å�‘框架æ��供了便利,但是它并ä¸�是微æœ�务的框架,它å�ªæ˜¯ä¸ºå¾®æœ�务框架的使用也æ��供了很好的脚手架。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230415111929.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230415111950.png) -ÉÏÃæÁ½ÕÅͼ±íÃ÷ÁËÁ½ÕߵĻù±¾Çø±ð£¬springbootÓÃÓÚ¹¹½¨µ¥¸ö·þÎñÓ¦Óã¬Ò²¾ÍÊÇÎÒÃdz£ËµµÄ΢·þÎñ +上é�¢ä¸¤å¼ å›¾è¡¨æ˜Žäº†ä¸¤è€…的基本区别,springboot用于构建å�•个æœ�务应用,也就是我们常说的微æœ�务 -¶øspringcloudÓÃÓÚ·þÎñÖÎÀí£¬Ò²¾ÍÊÇ´®Áª¡¢¹ÜÀíºÍЭµ÷¶à¸ö΢·þÎñ£¨springbootÓ¦ÓóÌÐò£© +而springcloud用于æœ�务治ç�†ï¼Œä¹Ÿå°±æ˜¯ä¸²è�”ã€�管ç�†å’Œå��调多个微æœ�务(springboot应用程åº�) -springcloudÖаüº¬ÁËÖÚ¶à·þÎñÖÎÀíÏà¹ØµÄ×é¼þ£º·þÎñAPIÍø¹ØSpringcloud Gateway£¬ÅäÖÃÖÐÐÄ×é¼þConfig Serever£¬¶Ï·Æ÷Circuit Breaker¡¢·þÎñ×¢²áÖÐÐÄService Registty£¬¼à¿Ø×é¼þSleuthµÈ +springcloud中包å�«äº†ä¼—多æœ�务治ç�†ç›¸å…³çš„组件:æœ�务API网关Springcloud Gateway,é…�置中心组件Config Serever,断路器Circuit Breakerã€�æœ�务注册中心Service Registty,监控组件Sleuthç­‰ -# ʹÓÃSpringbootµÄ8¸öÔ­Òò +# 使用Springbootçš„8个原因 -## ¸ü¿ìµÄ¿ª·¢ +## 更快的开å�‘ -Spring Boot ÔÚ Spring Éú̬ϵͳÉÏ×ö³öÁ˺ܶà¾ö¶¨ºÍ¹ÌÖ´¼º¼ûµÄĬÈÏÉèÖᣠÕâÖÖÐÔÖÊÓÐÖúÓÚ¿ª·¢ÈËÔ±¿ìËÙÉèÖò¢Í¶È뿪·¢¡£ +Spring Boot 在 Spring 生æ€�系统上å�šå‡ºäº†å¾ˆå¤šå†³å®šå’Œå›ºæ‰§å·±è§�的默认设置。 è¿™ç§�性质有助于开å�‘人员快速设置并投入开å�‘。 -ÀýÈ磬Spring MVC ¿ÉÒÔͨ¹ý´óÁ¿ XML bean ¶¨ÒåºÍ×Ô¶¨Òå servlet ÀàʵÏÖ¡£ µ«ÊÇʹÓà Spring Boot£¬Ëü¾ÍÏñÌí¼ÓÆô¶¯Æ÷ÒÀÀµÏîÒ»Ñù¼òµ¥¡£ ¾ø¶Ô²»ÐèÒª´úÂëÉú³É XML ÅäÖᣠ+例如,Spring MVC å�¯ä»¥é€šè¿‡å¤§é‡� XML bean 定义和自定义 servlet 类实现。 但是使用 Spring Boot,它就åƒ�添加å�¯åЍ噍ä¾�赖项一样简å�•。 ç»�对ä¸�需è¦�代ç �生æˆ� XML é…�置。 -## Ò»ÇнÔÓÐÏÈ»ú +## 一切皆有先机 -Spring Boot Starters Êǰüº¬¿âºÍËüÃǵÄһЩ×Ô¶¯ÅäÖÃµÄ Maven ÃèÊö·û¡£ ¶øÇÒ£¬ÕâЩÆô¶¯Æ÷ÓÐÖúÓÚΪ Spring Boot Ó¦ÓóÌÐòÌṩ¹¦ÄÜ¡£ ÏëÒª½¨Á¢Êý¾Ý¿âÁ¬½Ó£¿ ÓÐÒ»¸öÆô¶¯Æ÷ÒÀÀµÏî¡£ ÏëÓëÏûÏ¢¶ÓÁÐͨ»°»ò·¢Ë͵ç×ÓÓʼþ£¿ Spring Boot º­¸ÇÁËÕâÒ»ÇС£ +Spring Boot Starters 是包å�«åº“和它们的一些自动é…�置的 Maven æ��述符。 而且,这些å�¯åŠ¨å™¨æœ‰åŠ©äºŽä¸º Spring Boot 应用程åº�æ��供功能。 想è¦�建立数æ�®åº“连接? 有一个å�¯åЍ噍ä¾�赖项。 想与消æ�¯é˜Ÿåˆ—通è¯�或å�‘é€�电å­�邮件? Spring Boot 涵盖了这一切。 -¶ÔÓÚ¼¸ºõËùÓÐµÄ Spring Ä£¿é£¬¶¼ÓÐÒ»¸öÆô¶¯Æ÷ÒÀÀµÏî¿ÉÒÔΪÄúÅäÖÃËùÓÐÄÚÈÝ¡£ ÉõÖÁһЩµÚÈý·½¿âҲͨ¹ýËûÃÇµÄÆô¶¯Ä£¿éÌṩ¶Ô Spring µÄÖ§³Ö¡£ Èç¹ûûÓÐÕâЩÆô¶¯Æ÷£¬Äú×÷Ϊ¿ª·¢ÈËÔ±½«²»µÃ²»Î¬»¤ÒÀÀµÏîºÍ XML ÅäÖᣠÕâÊÇÄúÓ¦¸ÃʹÓà Spring Boot µÄÁíÒ»¸öÔ­Òò¡£ +对于几乎所有的 Spring 模å�—,都有一个å�¯åЍ噍ä¾�赖项å�¯ä»¥ä¸ºæ‚¨é…�置所有内容。 甚至一些第三方库也通过他们的å�¯åŠ¨æ¨¡å�—æ��供对 Spring 的支æŒ�。 如果没有这些å�¯åŠ¨å™¨ï¼Œæ‚¨ä½œä¸ºå¼€å�‘人员将ä¸�å¾—ä¸�维护ä¾�赖项和 XML é…�置。 这是您应该使用 Spring Boot çš„å�¦ä¸€ä¸ªåŽŸå› ã€‚ -## ǶÈëʽ·þÎñÆ÷ +## 嵌入å¼�æœ�务器 -Spring Boot ΪǶÈëʽ Tomcat¡¢Jetty ºÍ Undertow ·þÎñÆ÷Ìṩ¿ªÏä¼´ÓõÄÖ§³Ö¡£ ÕâÑù£¬¿ª·¢ÈËÔ±¾Í²»±Øµ£ÐÄÔÚ´«Í³Ó¦Ó÷þÎñÆ÷Öв¿Êð Web Ó¦ÓóÌÐò¡£ ͨ¹ýÊʵ±µÄÆô¶¯Æ÷ÒÀÀµÏÄúÉõÖÁ¿ÉÒÔ½«Ò»ÖÖ·þÎñÆ÷¼¼ÊõÓëÆäËû·þÎñÆ÷¼¼Êõ½»»»¡£ ËùÒÔÄãʵ¼ÊÉÏ×îÖյõ½ÁËÒ»¸ö¿ÉÒÔÏñÈκΠJAR Ò»ÑùÔËÐÐµÄ JAR Îļþ¡£ ÔÚÆô¶¯Ê±£¬JAR °üº¬×ã¹»µÄ¿âºÍÅäÖÃÒÔ×÷ΪӦÓóÌÐò·þÎñÆ÷Æô¶¯²¢ÕìÌýÇëÇó¡£ +Spring Boot 为嵌入å¼� Tomcatã€�Jetty å’Œ Undertow æœ�务器æ��供开箱å�³ç”¨çš„æ”¯æŒ�。 这样,开å�‘人员就ä¸�必担心在传统应用æœ�务器中部署 Web 应用程åº�。 通过适当的å�¯åЍ噍ä¾�赖项,您甚至å�¯ä»¥å°†ä¸€ç§�æœ�务器技术与其他æœ�务器技术交æ�¢ã€‚ 所以你实际上最终得到了一个å�¯ä»¥åƒ�任何 JAR 一样è¿�行的 JAR 文件。 在å�¯åŠ¨æ—¶ï¼ŒJAR 包å�«è¶³å¤Ÿçš„库和é…�置以作为应用程åº�æœ�务器å�¯åЍ并侦å�¬è¯·æ±‚。 -Èç¹ûÄú¶ÔǶÈëʽ·þÎñÆ÷²»¸ÐÐËȤ£¬Äú¿ÉÒÔËæÊ±½« Spring Boot Ó¦ÓóÌÐò´Ó JAR ת»»Îª WAR£¬²¢½«ËüÃDz¿Êðµ½´«Í³·þÎñÆ÷¡£ +如果您对嵌入å¼�æœ�务器ä¸�感兴趣,您å�¯ä»¥éš�æ—¶å°† Spring Boot 应用程åº�从 JAR 转æ�¢ä¸º WAR,并将它们部署到传统æœ�务器。 -## IDE ¶Ô Spring Boot µÄÖ§³Ö +## IDE 对 Spring Boot 的支æŒ� -ËùÓÐÖ÷ÒªµÄ IDE ¶¼Ìṩ¶Ô Spring Boot ´úÂë°ïÖúµÄÖ§³Ö¡£ ÀýÈ磬IntelliJ IDEA Ultimate Ϊ Spring Boot ÏîÄ¿ÌṩÁ˳öÉ«µÄ´úÂëÍê³ÉºÍµ¼º½¹¦ÄÜ¡£³ý´ËÖ®Í⣬VSCode ºÍ Eclipse Ò²¶ÔÆäÌṩÁ˷ḻµÄ¹¦ÄÜÖ§³Ö¡£ +所有主è¦�çš„ IDE 都æ��供对 Spring Boot 代ç �帮助的支æŒ�。 例如,IntelliJ IDEA Ultimate 为 Spring Boot 项目æ��供了出色的代ç �完æˆ�和导航功能。除此之外,VSCode å’Œ Eclipse 也对其æ��供了丰富的功能支æŒ�。 -## Éú²ú»·¾³³£Óù¦ÄÜ +## 生产环境常用功能 -Spring Boot ÌṩÁËÉú²ú¾ÍÐ÷µÄÌØÐÔ£¬ÀýÈç¼à¿Ø¡¢Ö¸±êºÍ¿ªÏä¼´ÓõÄ×¢Ïú¡£ ÓÐÁËÕâÐ©ÌØÐÔ£¬¿ª·¢ÈËÔ±¿ÉÒÔ±ÜÃâ¶îÍâµÄÅäÖᣠÀýÈ磬½¡¿µÖ´ÐÐÆ÷¶ËµãµÈ¹¦ÄÜʹӦÓóÌÐò״̬¼à¿Ø³ÉΪ¿ÉÄÜ¡£ ÀýÈ磬 +Spring Boot æ��供了生产就绪的特性,例如监控ã€�指标和开箱å�³ç”¨çš„æ³¨é”€ã€‚ 有了这些特性,开å�‘人员å�¯ä»¥é�¿å…�é¢�外的é…�置。 例如,å�¥åº·æ‰§è¡Œå™¨ç«¯ç‚¹ç­‰åŠŸèƒ½ä½¿åº”ç”¨ç¨‹åº�状æ€�监控æˆ�为å�¯èƒ½ã€‚ 例如, -Äú¿ÉÒÔÈÃÏñ Prometheus ÕâÑùµÄ¹¤¾ßÊÕ¼¯Ó¦ÓóÌÐòÖ¸±ê +您å�¯ä»¥è®©åƒ� Prometheus 这样的工具收集应用程åº�指标 -ÔÚÄúµÄ Kubernetes »ò Openshift »·¾³ÖÐʹÓþÍÐ÷ÐԺͻîÔ¾¶È½¡¿µ¶Ëµã¡£ +在您的 Kubernetes 或 Openshift 环境中使用就绪性和活跃度å�¥åº·ç«¯ç‚¹ã€‚ -Ö»ÐèÌí¼ÓÆäËûÊôÐÔ»òͨ¹ý /actuator/logging ¶Ëµã¼´¿É¸ü¸ÄÈÕÖ¾¼Ç¼¼¶±ð¡£ +å�ªéœ€æ·»åŠ å…¶ä»–å±žæ€§æˆ–é€šè¿‡ /actuator/logging 端点å�³å�¯æ›´æ”¹æ—¥å¿—记录级别。 -´ËÍ⣬¿ª·¢ÈËÔ±¿ÉÒÔʹÓÃ×Ô¼ºµÄ×Ô¶¨Ò彡¿µ¶ËµãÅäÖÃÕâЩִÐÐÆ÷¶Ëµã¡£ +此外,开å�‘人员å�¯ä»¥ä½¿ç”¨è‡ªå·±çš„自定义å�¥åº·ç«¯ç‚¹é…�置这些执行器端点。 -## ¿ªÏä¼´ÓÃµÄ JUnit Ö§³Ö +## 开箱å�³ç”¨çš„ JUnit 支æŒ� -ĬÈÏÇé¿öÏ£¬ËùÓÐ Spring Boot ÏîÄ¿¶¼´øÓÐ JUnit 5¡£ ´ËÍ⣬Spring Boot ÌṩÁË@SpringBootTest ×¢½âÀ´ÔÚÎÒÃÇÐèҪʱ³õʼ»¯²âÊÔÉÏÏÂÎÄ¡£ ËùÒÔ¿ª·¢ÈËÔ±Ö»ÐèÒª±àд²âÊÔÓÃÀý¡£ ËûÃDz»±ØÔÙµ£ÐIJâÊÔÓÃÀýµÄ¸´ÔÓ spring ÉÏÏÂÎÄ¡£ +默认情况下,所有 Spring Boot 项目都带有 JUnit 5。 此外,Spring Boot æ��供了@SpringBootTest 注解æ�¥åœ¨æˆ‘们需è¦�æ—¶åˆ�始化测试上下文。 所以开å�‘人员å�ªéœ€è¦�编写测试用例。 他们ä¸�å¿…å†�担心测试用例的å¤�æ�‚ spring 上下文。 -ÀýÈ磬ÏÂÃæ×Ô¶¯Éú³ÉµÄ²âÊÔ½«¼ì²éÉÏÏÂÎÄÊÇ·ñÕýÈ·¼ÓÔØ¡£ +例如,下é�¢è‡ªåŠ¨ç”Ÿæˆ�的测试将检查上下文是å�¦æ­£ç¡®åŠ è½½ã€‚ ```` @SpringBootTest class SpringBootDerbyDatabaseApplicationTests { - @²âÊÔ + @测试 void contextLoads() { } @@ -211,25 +211,25 @@ class SpringBootDerbyDatabaseApplicationTests { ## Spring Profiles -Spring Profiles ÊÇ spring Boot µÄÒ»¸öÇ¿´óÌØÐÔ£¬ÓÐÖúÓÚ¸ôÀëÓ¦ÓóÌÐòÖеIJ»Í¬×é¼þ¡£ ʹÓÃÅäÖÃÎļþ£¬Äú¿ÉÒÔÔÚÌØ¶¨»·¾³ÖÐÆôÓûò½ûÓÃ×é¼þ¡£ µ±Äú±ØÐë¸ù¾ÝÌØ¶¨Ìõ¼þʹÓò»Í¬µÄ×é¼þʱ£¬Õâ¿ÉÄÜ»áÅÉÉÏÓó¡¡£ +Spring Profiles 是 spring Boot 的一个强大特性,有助于隔离应用程åº�中的ä¸�å�Œç»„件。 使用é…�置文件,您å�¯ä»¥åœ¨ç‰¹å®šçŽ¯å¢ƒä¸­å�¯ç”¨æˆ–ç¦�用组件。 当您必须根æ�®ç‰¹å®šæ�¡ä»¶ä½¿ç”¨ä¸�å�Œçš„组件时,这å�¯èƒ½ä¼šæ´¾ä¸Šç”¨åœºã€‚ ```` @Profile(value = {"prod","uat"}) class RabbitMQConfig { -// ÌýÖÚ +// å�¬ä¼— } ```` -ÔÚÉÏÃæµÄ´úÂëÖУ¬ÉÏÏÂÎĽ«ÏÞÖÆÍÃ×ÓÕìÌýÆ÷½öÔÚ¾ßÓÐ prod »ò uat ×÷Ϊ»î¶¯ÅäÖÃÎļþµÄ»·¾³ÖÐÔËÐС£ +在上é�¢çš„代ç �中,上下文将é™�制兔å­�侦å�¬å™¨ä»…在具有 prod 或 uat 作为活动é…�置文件的环境中è¿�行。 -## ¶àÖÖ´ò°üºÍ²¿ÊðÑ¡Ïî +## 多ç§�打包和部署选项 -¸Ã¿ò¼ÜÌṩÁ˶àÖÖ·½Ê½À´´ò°üÄúµÄÓ¦ÓóÌÐò¡£ ÕýÈçÎÒÃÇ֮ǰËù˵£¬Ó¦ÓóÌÐò¿ÉÒÔÊÇ JAR »ò WAR Îļþ¡£ ͨ¹ýһЩ¶îÍâµÄÅäÖúͲÎÊý£¬Äú»¹¿ÉÒÔ´´½¨¿ªÏä¼´ÓõĸßÐÔÄÜ docker ¾µÏñ¡£ +该框架æ��供了多ç§�æ–¹å¼�æ�¥æ‰“包您的应用程åº�。 正如我们之å‰�所说,应用程åº�å�¯ä»¥æ˜¯ JAR 或 WAR 文件。 通过一些é¢�外的é…�置和å�‚数,您还å�¯ä»¥åˆ›å»ºå¼€ç®±å�³ç”¨çš„高性能 docker 镜åƒ�。 -Æô¶¯ºÍÍ£Ö¹ Spring Boot Ó¦ÓóÌÐò·Ç³£¼òµ¥¡£ ´ËÍ⣬Äú¿ÉÒÔͨ¹ý¼¸¸ö¶îÍâµÄ²½Ö轫ÕâЩ JAR Îļþ²¿ÊðΪ linux ·þÎñ¡£ JAR Îļþ³ÆÎª FAT jar£¬ËüÃǰüº¬ÓëÓ¦ÓóÌÐòÏà¹ØµÄËùÓÐÒÀÀµÏî¡£ ÕâʹµÃ²¿Êð¹ý³Ì²»ÄÇô¸´ÔÓ¡£ ʵ¼ÊÉÏ£¬ÕâЩ¹¹½¨¿ÉÒÔÔÚÈκÎ×°ÓÐ Java 8 »ò¸ü¸ß°æ±¾µÄ»úÆ÷ÉÏÔËÐС£ +å�¯åŠ¨å’Œå�œæ­¢ Spring Boot 应用程åº�é�žå¸¸ç®€å�•。 此外,您å�¯ä»¥é€šè¿‡å‡ ä¸ªé¢�外的步骤将这些 JAR 文件部署为 linux æœ�务。 JAR 文件称为 FAT jar,它们包å�«ä¸Žåº”用程åº�相关的所有ä¾�赖项。 这使得部署过程ä¸�那么å¤�æ�‚。 实际上,这些构建å�¯ä»¥åœ¨ä»»ä½•装有 Java 8 或更高版本的机器上è¿�行。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 [https://spring.io/](https://spring.io/) diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\237\272\346\234\254\344\275\277\347\224\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\237\272\346\234\254\344\275\277\347\224\250.md" index 247e419..e1f633e 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\237\272\346\234\254\344\275\277\347\224\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\345\237\272\346\234\254\344\275\277\347\224\250.md" @@ -1,30 +1,30 @@ -# ¿ìËÙ¹¹½¨SpringBootÓ¦Óà +# 快速构建SpringBoot应用 -Õâ¸ö½Ì³ÌÀ´×ÔÓÚspringboot¹ÙÍø£¬×㹻ȨÍþ£¬Ò²×ã¹»¼òµ¥¡£ +这个教程æ�¥è‡ªäºŽspringboot官网,足够æ�ƒå¨�,也足够简å�•。 -## µÚÒ»¸ö hello world ³ÌÐò +## 第一个 hello world 程åº� -Äú½«¹¹½¨Ò»¸ö¾­µäµÄ¡°Hello World£¡¡±ÈκÎä¯ÀÀÆ÷¶¼¿ÉÒÔÁ¬½Óµ½µÄ¶Ëµã¡£ÄãÉõÖÁ¿ÉÒÔ¸æËßËüÄãµÄÃû×Ö£¬Ëü»áÒÔ¸üÓѺõķ½Ê½»ØÓ¦¡£ +您将构建一个ç»�典的“Hello Worldï¼�â€�任何æµ�览器都å�¯ä»¥è¿žæŽ¥åˆ°çš„端点。你甚至å�¯ä»¥å‘Šè¯‰å®ƒä½ çš„å��字,它会以更å�‹å¥½çš„æ–¹å¼�回应。 -## »ù±¾»·¾³ÒªÇó +## 基本环境è¦�求 -1¡¢Ê×ÏÈÄã×îºÃÓÐÒ»¸ö³ÃÊÖµÄIDE,ÈÈÃÅÑ¡Ôñ°üÀ¨ IntelliJ IDEA¡¢Spring Tools¡¢Visual Studio Code »ò Eclipse µÈµÈ¡£ +1ã€�首先你最好有一个è¶�手的IDE,热门选择包括 IntelliJ IDEAã€�Spring Toolsã€�Visual Studio Code 或 Eclipse 等等。 -2¡¢JDK£¬ÖÁÓÚ°æ±¾µÄ»°£¬8-17¶¼ÊDz»´íµÄÑ¡Ôñ +2ã€�JDK,至于版本的è¯�,8-17都是ä¸�错的选择 -3¡¢µ±È»ÕâÀﻹÐèÒªµ¼ÈëmavenµÄpomÒÀÀµ£¬ËùÒÔÎÒÃÇÒ²ÐèÒªmaven£¬maven²å¼þÔÚidea×Ô´øÁË¡£ÎÒÃÇ»áÔÚ½ÓÏÂÀ´µÄ²¿·Ö½øÐнéÉÜ£¬ÐèÒªÒýÈëÄÄЩÒÀÀµ +3ã€�当然这里还需è¦�导入mavençš„pomä¾�赖,所以我们也需è¦�maven,mavenæ�’件在idea自带了。我们会在接下æ�¥çš„部分进行介ç»�,需è¦�引入哪些ä¾�èµ– -## µÚÒ»²½£ºÆô¶¯Ò»¸öеÄSpring BootÏîÄ¿ +## 第一步:å�¯åŠ¨ä¸€ä¸ªæ–°çš„Spring Boot项目 -ʹÓÃ[start.spring.io](http://start.spring.io/)´´½¨Ò»¸ö¡°web¡±ÏîÄ¿¡£ÔÚ¡°dependencies¡±¶Ô»°¿òÖÐËÑË÷²¢Ìí¼Ó¡°web¡±ÒÀÀµÏÈçÆÁÄ»½ØÍ¼Ëùʾ¡£ +使用[start.spring.io](http://start.spring.io/)创建一个“webâ€�项目。在“dependenciesâ€�对è¯�框中æ�œç´¢å¹¶æ·»åŠ â€œwebâ€�ä¾�赖项,如å±�幕截图所示。 -µã»÷¡°Éú³É¡±°´Å¥£¬ÏÂÔØ zip Îļþ£¬²¢½«Æä½âѹµ½Äú¼ÆËã»úÉϵÄÒ»¸öÎļþ¼ÐÖС£ +点击“生æˆ�â€�按钮,下载 zip 文件,并将其解压到您计算机上的一个文件夹中。 -![Start.spring.io ¿ìËÙÈëÃÅ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/quickstart-1.png) +![Start.spring.io 快速入门](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/quickstart-1.png) -[start.spring.io](http://start.spring.io/)´´½¨µÄÏîÄ¿°üº¬[Spring Boot](https://spring.io/projects/spring-boot)£¬Ò»¸öÈÃSpring×¼±¸ºÃÔÚÄúµÄÓ¦ÓóÌÐòÄÚ²¿¹¤×÷£¬µ«²»ÐèҪ̫¶à´úÂë»òÅäÖᣠSpring Boot ÊÇÆô¶¯ Spring ÏîÄ¿µÄ×î¿ìºÍ×îÁ÷Ðеķ½Ê½¡£ +[start.spring.io](http://start.spring.io/)创建的项目包å�«[Spring Boot](https://spring.io/projects/spring-boot),一个让Spring准备好在您的应用程åº�内部工作,但ä¸�需è¦�太多代ç �或é…�置。 Spring Boot 是å�¯åЍ Spring 项目的最快和最æµ�行的方å¼�。 -ÕâÀïÎÒÃÇÑ¡ÔñʹÓÃmaven×÷Ϊ°ü¹ÜÀí¹¤¾ß£¬ÏÂÔØÏÂÀ´µÄÏîÄ¿Àï»á°üº¬pomÎļþ£¬pomÎļþÀï°üº¬ÁËÄãµÄÌí¼ÓµÄÒÀÀµ¡£ +这里我们选择使用maven作为包管ç�†å·¥å…·ï¼Œä¸‹è½½ä¸‹æ�¥çš„项目里会包å�«pom文件,pom文件里包å�«äº†ä½ çš„æ·»åŠ çš„ä¾�赖。 ```` @@ -36,11 +36,11 @@ ```` -## µÚ¶þ²½£ºÌí¼ÓÄãµÄ´úÂë +## 第二步:添加你的代ç � -ÔÚÄúµÄ IDE Öдò¿ªÏîÄ¿²¢ÔÚ `src/main/java/com/example/demo` Îļþ¼ÐÖÐÕÒµ½ `DemoApplication.java` Îļþ¡£ +在您的 IDE 中打开项目并在 `src/main/java/com/example/demo` 文件夹中找到 `DemoApplication.java` 文件。 -ÏÖÔÚͨ¹ýÌí¼ÓÏÂÃæ´úÂëÖÐÏÔʾµÄ¶îÍâ·½·¨ºÍ×¢ÊÍÀ´¸ü¸ÄÎļþµÄÄÚÈÝ¡£Äú¿ÉÒÔ¸´ÖƲ¢Õ³Ìù´úÂë»òÖ±½Ó¼üÈë´úÂë¡£ +现在通过添加下é�¢ä»£ç �中显示的é¢�外方法和注释æ�¥æ›´æ”¹æ–‡ä»¶çš„内容。您å�¯ä»¥å¤�制并粘贴代ç �或直接键入代ç �。 ``` package com.example.demo; import org.springframework.boot.SpringApplication; @@ -56,22 +56,22 @@ public class DemoApplication { ``` -ÕâÊÇÔÚ Spring Boot Öд´½¨Ò»¸ö¼òµ¥µÄ¡°Hello World¡± Web ·þÎñËùÐèµÄËùÓдúÂë¡£ +这是在 Spring Boot 中创建一个简å�•的“Hello Worldâ€� Web æœ�务所需的所有代ç �。 -ÎÒÃÇÌí¼ÓµÄ`hello()`·½·¨Ö¼ÔÚ»ñȡһ¸öÃûΪnameµÄString²ÎÊý£¬È»ºó½«´Ë²ÎÊýÓë´úÂëÖеĵ¥´Ê`"Hello"`½áºÏÆðÀ´¡£ +我们添加的`hello()`方法旨在获å�–一个å��为nameçš„Stringå�‚数,然å�Žå°†æ­¤å�‚数与代ç �中的å�•è¯�`"Hello"`结å�ˆèµ·æ�¥ã€‚ -ÕâÒâζ×ÅÈç¹ûÄúÔÚÇëÇóÖн«ÄúµÄÃû×ÖÉèÖÃΪ¡°Amy¡±£¬ÔòÏìÓ¦½«ÊÇ¡°Hello Amy¡±¡£ +è¿™æ„�味ç�€å¦‚果您在请求中将您的å��字设置为“Amyâ€�,则å“�应将是“Hello Amyâ€�。 -`@RestController` ×¢Ê͸æËß Spring£¬´Ë´úÂëÃèÊöÁËÒ»¸ö¶Ëµã£¬¸Ã¶ËµãÓ¦ÔÚ Web ÉÏ¿ÉÓᣠ-@GetMapping(¡°/hello¡±) ¸æËß Spring ʹÓÃÎÒÃÇµÄ hello() ·½·¨À´ÏìÓ¦·¢Ë͵½ http://localhost:8080/hello µØÖ·µÄÇëÇó¡£ +`@RestController` 注释告诉 Spring,此代ç �æ��述了一个端点,该端点应在 Web 上å�¯ç”¨ã€‚ +@GetMapping(“/helloâ€�) 告诉 Spring 使用我们的 hello() 方法æ�¥å“�应å�‘é€�到 http://localhost:8080/hello 地å�€çš„请求。 -×îºó£¬@RequestParam ¸æËß Spring ÔÚÇëÇóÖÐÆÚÍûÒ»¸öÃû³ÆÖµ£¬µ«Èç¹û²»´æÔÚ£¬Ëü½«Ä¬ÈÏʹÓõ¥´Ê¡°World¡±¡£ +最å�Žï¼Œ@RequestParam 告诉 Spring 在请求中期望一个å��称值,但如果ä¸�存在,它将默认使用å�•è¯�“Worldâ€�。 -## µÚÈý²½£ºÆô¶¯ +## 第三步:å�¯åЍ -ÈÃÎÒÃǹ¹½¨²¢ÔËÐгÌÐò¡£´ò¿ªÃüÁîÐУ¨»òÖÕ¶Ë£©²¢µ¼º½µ½ÄúÓµÓÐÏîÄ¿ÎļþµÄÎļþ¼Ð¡£ +让我们构建并è¿�行程åº�。打开命令行(或终端)并导航到您拥有项目文件的文件夹。 -ÎÒÃÇ¿ÉÒÔͨ¹ý·¢³öÒÔÏÂÃüÁîÀ´¹¹½¨ºÍÔËÐÐÓ¦ÓóÌÐò£º +我们å�¯ä»¥é€šè¿‡å�‘出以下命令æ�¥æž„建和è¿�行应用程åº�: **MacOS/Linux:** @@ -87,22 +87,22 @@ COPY.\gradlew.bat bootRun ``` -ÄúÓ¦¸Ã»á¿´µ½Ò»Ð©Óë´Ë·Ç³£ÏàËÆµÄÊä³ö£º +您应该会看到一些与此é�žå¸¸ç›¸ä¼¼çš„输出: ![Quick Start On Start.spring.io](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/quickstart-2.png) -ÕâÀïµÄ×îºó¼¸ÐиæËßÎÒÃÇ£¬SpringÓ¦ÓÃÒѾ­¿ªÊ¼ÔËÐÐÁË¡£ Spring Boot µÄǶÈëʽ Apache Tomcat ·þÎñÆ÷³äµ±ÍøÂç·þÎñÆ÷£¬²¢ÕýÔÚ¼àÌý¡°localhost¡±¶Ë¿Ú¡°8080¡±ÉϵÄÇëÇó¡£ +这里的最å�Žå‡ è¡Œå‘Šè¯‰æˆ‘们,Spring应用已ç»�开始è¿�行了。 Spring Boot 的嵌入å¼� Apache Tomcat æœ�务器充当网络æœ�务器,并正在监å�¬â€œlocalhostâ€�端å�£â€œ8080â€�上的请求。 -´ò¿ªä¯ÀÀÆ÷£¬ÔÚ¶¥²¿µÄµØÖ·À¸ÖÐÊäÈë`http://localhost:8080/hello`¡£ +打开æµ�览器,在顶部的地å�€æ �中输入`http://localhost:8080/hello`。 -ÄãÓ¦¸ÃµÃµ½ÕâÑùÒ»¸öÓѺõĻØÓ¦£º +你应该得到这样一个å�‹å¥½çš„回应: ![Quick Start On Start.spring.io](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/quickstart-3.png) -# ×ܽá -¾ÍÊÇÈç´Ë¼òµ¥£¬µÚÒ»¸öSpringBootÓ¦ÓþÍÕâô¹¹½¨Íê³ÉÁË£¬Äã²»ÐèÒª¶îÍâµÄÅäÖÃÎļþ£¬¶îÍâµÄÒÀÀµ£¬ÉõÖÁÊǶîÍâµÄ·þÎñÆ÷¡£ -Ö»ÐèÒªÒ»¸öÆô¶¯À࣬¾Í¿ÉÒÔʵÏÖÒ»¸ö×î»ù±¾µÄSpringBootµÄÓ¦Óᣠ+# 总结 +就是如此简å�•,第一个SpringBoot应用就这么构建完æˆ�了,你ä¸�需è¦�é¢�外的é…�置文件,é¢�外的ä¾�赖,甚至是é¢�外的æœ�务器。 +å�ªéœ€è¦�一个å�¯åŠ¨ç±»ï¼Œå°±å�¯ä»¥å®žçŽ°ä¸€ä¸ªæœ€åŸºæœ¬çš„SpringBoot的应用。 -ÕâÒ²ÊÇΪʲôspringboot¿ÉÒÔÓÃÀ´¿ìËÙ¹¹½¨Ò»¸ö΢·þÎñ£¬ÒòΪËüʵÔÚÊÇÌ«·½±ãÁË¡£ -µ±È»£¬Êµ¼Ê¿ª·¢ÖÐÎÒÃÇÐèÒªÓõ½¸ü¶àspringbootµÄ¹¦ÄܺÍÌØÐÔ£¬ÎÒÃǽ«»áÔÚ½ÓÏÂÀ´µÄÕ½ÚÖÐÖð½¥Õ¹¿ª½éÉÜ¡£ +这也是为什么springbootå�¯ä»¥ç”¨æ�¥å¿«é€Ÿæž„建一个微æœ�务,因为它实在是太方便了。 +当然,实际开å�‘中我们需è¦�用到更多springboot的功能和特性,我们将会在接下æ�¥çš„章节中é€�æ¸�展开介ç»�。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://spring.io/quickstart \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\351\205\215\347\275\256\346\226\207\344\273\266\347\256\241\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\351\205\215\347\275\256\346\226\207\344\273\266\347\256\241\347\220\206.md" index 46c6771..6953e99 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\351\205\215\347\275\256\346\226\207\344\273\266\347\256\241\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204\351\205\215\347\275\256\346\226\207\344\273\266\347\256\241\347\220\206.md" @@ -1,68 +1,68 @@ -## 1.SpringBootÅäÖùÜÀíµÄ±³¾°Óë»ù´¡ +## 1.SpringBooté…�置管ç�†çš„背景与基础 -ΪʵÏÖ¿ìËٴºÍ¿ª·¢£¬ÏîÄ¿ÒÔSpringboot¿ò¼Ü´î½¨£¬springboot´î½¨µÄÏîÄ¿¿ÉÒÔ½«ÏîĿֱ½Ó´ò³Éjar°ü²¢ÔËÐУ¬ÎÞÐè×Ô¼º°²×°ÅäÖÃTomcat»òÕ߯äËû·þÎñÆ÷£¬ÊÇÒ»ÖÖ·½±ã¿ì½ÝµÄ²¿Êð·½Ê½¡£ +为实现快速æ�­å»ºå’Œå¼€å�‘,项目以Springboot框架æ�­å»ºï¼Œspringbootæ�­å»ºçš„项目å�¯ä»¥å°†é¡¹ç›®ç›´æŽ¥æ‰“æˆ�jar包并è¿�行,无需自己安装é…�ç½®Tomcat或者其他æœ�务器,是一ç§�方便快æ�·çš„部署方å¼�。 -¼ÙÉèÏîÄ¿ÒÔ×î³£¹æµÄ·½Ê½´ò°ü³ÉÒ»¸öÕûÌåµÄjar°ü²¿Ê𣬼´ÅäÖÃÎļþºÍµÚÈý·½ÒÀÀµ°ü¶¼°üº¬ÔÚjar°üÀ¾Í»áÓÐÈçÏÂÁ½¸öÎÊÌâ +å�‡è®¾é¡¹ç›®ä»¥æœ€å¸¸è§„的方å¼�打包æˆ�一个整体的jar包部署,å�³é…�置文件和第三方ä¾�赖包都包å�«åœ¨jar包里,就会有如下两个问题 -ÎÊÌâÒ»£ºÏîÄ¿ÔËÐйý³ÌÖУ¬Òª¸Ä¶¯ÅäÖÃÎļþµÄ»°ÐèÒªÖØÐ´ò°ü²¢²¿Êð¡£ +问题一:项目è¿�行过程中,è¦�改动é…�置文件的è¯�需è¦�é‡�新打包并部署。 -ÎÊÌâ¶þ£º¶à¸öµÚÈý·½ÒÀÀµ°ü¶¼Ïà½üµÄÏîĿҪ²¿ÊðÔÚͬһ̨·þÎñÆ÷ʱ£¬¸÷×ÔµÄjar°ü¶¼°üº¬ÁËÏàͬµÄµÚÈý·½ÒÀÀµ°ü£¨¼ÙÉèÏîÄ¿jar°üÓÐ100M£¬µÚÈý·½ÒÀÀµ°ü¿ÉÄܾÍÕ¼ÓÃÁË99M£©£¬ÕâÑùµÚÈý·½ÒÀÀµ°üÈßÓàÔì³ÉÁË·þÎñÆ÷×ÊÔ´µÄÀË·ÑÒÔ¼°½µµÍÁËÏîÄ¿²¿ÊðµÄЧÂÊ¡£ +问题二:多个第三方ä¾�赖包都相近的项目è¦�部署在å�Œä¸€å�°æœ�务器时,å�„自的jar包都包å�«äº†ç›¸å�Œçš„第三方ä¾�赖包(å�‡è®¾é¡¹ç›®jar包有100M,第三方ä¾�赖包å�¯èƒ½å°±å� ç”¨äº†99M),这样第三方ä¾�赖包冗余造æˆ�了æœ�务器资æº�的浪费以å�Šé™�低了项目部署的效率。 -Èç¹û½«¸÷ÏîÄ¿µÄÅäÖÃÎļþ¡¢µÚÈý·½ÒÀÀµ°ü¶¼ÌáÈ¡µ½jar°üÍâͳһ¹ÜÀí£¬ÕâÑù¼´ÌáÉýÁËÏîÄ¿´ò°üЧÂÊÓÖ½ÚÔ¼ÁË·þÎñÆ÷µÄ´ÅÅÌÏûºÄ£¬Í¬Ê±ÏîÄ¿µÄÔËάҲÊǷdz£·½±ãµÄ£¬¸Ä¶¯ÁËÅäÖÃÎļþÖØÆôÏ·þÎñ¾Í¿ÉÒÔÁË£¬ÎÞÐèÖØÐ¹¹½¨²¿Êð¡£ +如果将å�„项目的é…�置文件ã€�第三方ä¾�赖包都æ��å�–到jar包外统一管ç�†ï¼Œè¿™æ ·å�³æ��å�‡äº†é¡¹ç›®æ‰“包效率å�ˆèŠ‚çº¦äº†æœ�务器的ç£�盘消耗,å�Œæ—¶é¡¹ç›®çš„è¿�维也是é�žå¸¸æ–¹ä¾¿çš„,改动了é…�置文件é‡�å�¯ä¸‹æœ�务就å�¯ä»¥äº†ï¼Œæ— éœ€é‡�新构建部署。 -ÏÂÃæÊǾßÌåµÄʵÏÖ·½°¸ +下é�¢æ˜¯å…·ä½“的实现方案 -### 1.1 **ÅäÖÃÎļþͳһ¹ÜÀí** +### 1.1 **é…�置文件统一管ç�†** ``` - - springbootºËÐÄÅäÖÃÎļþ - - Springboot¶ÁÈ¡ºËÐÄÅäÖÃÎļþ£¨application.properties£©µÄÓÅÏȼ¶Îª - - Jar°üͬ¼¶Ä¿Â¼µÄconfigĿ¼ - - Jar°üͬ¼¶Ä¿Â¼ - - classPath(¼´resourcesĿ¼)µÄconfigĿ¼ - - classpathĿ¼ + - springboot核心é…�置文件 + - Springboot读å�–核心é…�置文件(application.properties)的优先级为 + - Jar包å�Œçº§ç›®å½•çš„config目录 + - Jar包å�Œçº§ç›®å½• + - classPath(å�³resources目录)çš„config目录 + - classpath目录 ``` -ÉÏÃæÊÇspringbootĬÈÏÈ¥ÄÃ×Ô¼ºµÄºËÐÄÅäÖÃÎļþµÄÓÅÏȼ¶£¬»¹ÓÐÒ»ÖÖ×î¸ßÓÅÏȼ¶µÄ·½Ê½ÊÇÏîÄ¿Æô¶¯Ê±Í¨¹ýÃüÁîµÄ·½Ê½Ö¸¶¨ÏîÄ¿¼ÓÔØºËÐÄÅäÖÃÎļþ£¬ÃüÁîÈçÏ -java ¨Cjar -Dspring.config.location=xxx/xxx/xxxx.properties xxxx.jar +上é�¢æ˜¯springboot默认去拿自己的核心é…�置文件的优先级,还有一ç§�最高优先级的方å¼�是项目å�¯åŠ¨æ—¶é€šè¿‡å‘½ä»¤çš„æ–¹å¼�指定项目加载核心é…�置文件,命令如下 +java –jar -Dspring.config.location=xxx/xxx/xxxx.properties xxxx.jar -Èç¹ûSpring BootÔÚÓÅÏȼ¶¸ü¸ßµÄλÖÃÕÒµ½ÁËÅäÖã¬ÄÇôËü»áÎÞÊÓÓÅÏȼ¶¸üµÍµÄÅäÖà +如果Spring Boot在优先级更高的ä½�置找到了é…�置,那么它会无视优先级更低的é…�ç½® -### 1.2 **ÆäËû×ÊÔ´ÅäÖÃÎļþ** +### 1.2 **其他资æº�é…�置文件** -ÉÏÃæÃèÊöµÄSpringbootºËÐÄÎļþÒѾ­Äܹ»ÌáÈ¡³öjar°üÍâ½øÐйÜÀíÁË£¬µ«ÊÇ»¹ÓÐÆäËûһЩҵÎñÉϵÄÅäÖÃÎļþ£¬ÈçÊý¾ÝÔ´ÅäÖÃÎļþ£¬¹«¹²×ÊÔ´¶¨ÒåÅäÖÃÎļþ£¨³£Á¿£¬FTPÐÅÏ¢µÈ£©£¬quartz¶¨Ê±Æ÷£¬ÈÕÖ¾µÈÅäÖÃÎļþÎÒÃÇÈçºÎÈ¥ÌáÈ¡³öÀ´²¢È·±£ÄÜÔÚ´úÂëÖÐÒýÓõ½ÄØ +上é�¢æ��è¿°çš„Springboot核心文件已ç»�能够æ��å�–出jar包外进行管ç�†äº†ï¼Œä½†æ˜¯è¿˜æœ‰å…¶ä»–一些业务上的é…�置文件,如数æ�®æº�é…�置文件,公共资æº�定义é…�置文件(常é‡�,FTPä¿¡æ�¯ç­‰ï¼‰ï¼Œquartz定时器,日志等é…�置文件我们如何去æ��å�–出æ�¥å¹¶ç¡®ä¿�能在代ç �中引用到呢 -ÎÒÃÇÖªµÀSpringbootÏîÄ¿¿ÉÒÔͨ¹ý×¢½â·½Ê½À´»ñÈ¡Ïà¹ØÅäÖÃÎļþ£¬ËùÒÔÎÒÃÇÒ²ÊÇͨ¹ý×¢½â·½Ê½ÈÃÏîÄ¿Äܹ»ÒýÓõ½jar°üÍⲿµÄÅäÖÃÎļþµÄ£¬ÈçÏÂͼ£º -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://img-blog.csdnimg.cn/20190121170400864.png) +我们知é�“Springboot项目å�¯ä»¥é€šè¿‡æ³¨è§£æ–¹å¼�æ�¥èŽ·å�–相关é…�置文件,所以我们也是通过注解方å¼�让项目能够引用到jar包外部的é…�置文件的,如下图: +![在这里æ�’入图片æ��è¿°](https://img-blog.csdnimg.cn/20190121170400864.png) -@PropertySourceÀïÃæµÄvalueÓÐÁ½¸öÖµ£¬µÚÒ»¸öÊÇclasspathÏÂconfigĿ¼ÏµÄÊý¾ÝÔ´ÅäÖÃÎļþ£¬µÚ¶þ¸öÔòÊǸù¾Ýspring.profiles.path¶¯Ì¬»ñÈ¡µÄĿ¼£¬spring.profiles.pathÊÇÎÒÃÇÔÚºËÐÄÎļþ×Ô¶¨ÒåµÄÒ»¸öÅäÖÃÏËüµÄÖµÊÇÎÒÃÇÅäÖÃÎļþͳһ¹ÜÀíµÄÎļþ¼Ð·¾¶£¬ºóÃæµÄignoreResourceNotFound=trueÔòÊÇÉ趨¼ÙÈç¸ù¾ÝÇ°ÃæÒ»¸ö·¾¶Ã»ÓÐÕÒµ½Ïà¹ØÅäÖÃÎļþ£¬Ôò¸ù¾ÝµÚ¶þ¸ö·¾¶È¥ÕÒ¡£ +@PropertySource里é�¢çš„value有两个值,第一个是classpath下config目录下的数æ�®æº�é…�置文件,第二个则是根æ�®spring.profiles.path动æ€�获å�–的目录,spring.profiles.path是我们在核心文件自定义的一个é…�置项,它的值是我们é…�置文件统一管ç�†çš„æ–‡ä»¶å¤¹è·¯å¾„,å�Žé�¢çš„ignoreResourceNotFound=true则是设定å�‡å¦‚æ ¹æ�®å‰�é�¢ä¸€ä¸ªè·¯å¾„没有找到相关é…�置文件,则根æ�®ç¬¬äºŒä¸ªè·¯å¾„去找。 -ÎÒÃÇ»¹¿ÉÒÔÖ±½Ó¸ù¾Ý·¾¶£¬ÓÃFileSystemResourceÀàÈ¥¼ÓÔØÒ»¸öÅäÖÃÎļþʵÀý³öÀ´£¬ÈçÏÂͼ -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://img-blog.csdnimg.cn/20190121170338934.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0dlZUxvb25n,size_16,color_FFFFFF,t_70) +我们还å�¯ä»¥ç›´æŽ¥æ ¹æ�®è·¯å¾„,用FileSystemResource类去加载一个é…�置文件实例出æ�¥ï¼Œå¦‚下图 +![在这里æ�’入图片æ��è¿°](https://img-blog.csdnimg.cn/20190121170338934.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0dlZUxvb25n,size_16,color_FFFFFF,t_70) -Ô­ÀíÀàËÆ£¬¸ù¾ÝÔÚºËÐÄÎļþ×Ô¶¨ÒåµÄͳһÅäÖÃĿ¼µÄ·¾¶À´¼ÓÔØÅäÖÃÎļþ +原ç�†ç±»ä¼¼ï¼Œæ ¹æ�®åœ¨æ ¸å¿ƒæ–‡ä»¶è‡ªå®šä¹‰çš„统一é…�置目录的路径æ�¥åŠ è½½é…�置文件 -ÁíÍâlogbackÈÕÖ¾ÅäÖÃÎļþ¼ÓÔØ·½Ê½ÈçÏ£º -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://img-blog.csdnimg.cn/20190121170306979.png) +å�¦å¤–logback日志é…�置文件加载方å¼�如下: +![在这里æ�’入图片æ��è¿°](https://img-blog.csdnimg.cn/20190121170306979.png) -×ÛÉÏËùÊö£¬ÎÒÃÇÊáÀíÒ»ÏÂʵÏÖ·½°¸µÄ˼· +综上所述,我们梳ç�†ä¸€ä¸‹å®žçŽ°æ–¹æ¡ˆçš„æ€�è·¯ ``` - - ÔÚspringbootºËÐÄÎļþÀﶨÒåÒ»¸öspring.profiles.pathÅäÖÃÏËüµÄÖµÖ¸ÏòÎÒÃÇËùÓÐÅäÖÃÎļþͳһ·ÅÖõÄĿ¼£¬°üº¬ºËÐÄÎļþ×ÔÉíÒ²ÊÇ·ÅÖÃÔÚÀïÃæµÄ + - 在springboot核心文件里定义一个spring.profiles.pathé…�置项,它的值指å�‘我们所有é…�置文件统一放置的目录,包å�«æ ¸å¿ƒæ–‡ä»¶è‡ªèº«ä¹Ÿæ˜¯æ”¾ç½®åœ¨é‡Œé�¢çš„ - - ´úÂë»òÕßÅäÖÃÎļþÀï¼ÓÔØÅäÖÃÎļþµÄµØ·½Ò²Ó¦¸Ã»ñÈ¡spring.profiles.pathÅäÖÃÏîÀ´¶¯Ì¬¼ÓÔØ¸Ã·¾¶ÏµÄÅäÖÃÎļþ + - 代ç �或者é…�置文件里加载é…�置文件的地方也应该获å�–spring.profiles.pathé…�置项æ�¥åЍæ€�加载该路径下的é…�置文件 - - Pom.xmlÎļþÐ޸Ĵò°üÏà¹ØÄ£¿é£¬½«ÅäÖÃÎļþÅųý£¬ÕâÑùÎÒÃÇ´ò³öµÄjar°üÊDz»º¬ÅäÖÃÎļþµÄ£¬´ò°üÅäÖÃÇë²Î¿¼Îĵµ½Úµã3 + - Pom.xml文件修改打包相关模å�—,将é…�置文件排除,这样我们打出的jar包是ä¸�å�«é…�置文件的,打包é…�置请å�‚考文档节点3 - - Æô¶¯jar°üʱ£¬Í¨¹ýÃüÁîÖ¸¶¨¼ÓÔØµÄºËÐÄÎļþΪspring.profiles.pathϵĺËÐÄÎļþ + - å�¯åЍjar包时,通过命令指定加载的核心文件为spring.profiles.path下的核心文件 ``` -**µÚÈý·½ÒÀÀµ°üͳһ¹ÜÀí** +**第三方ä¾�赖包统一管ç�†** -ͨ³£µÚÈý·½jar°ü¿ÉÒÔ´ò½øjar°üÀҲ¿ÉÒÔ·ÅÔÚÏîÄ¿jar°üͬ¼¶Ä¿Â¼ÏµÄlibĿ¼£¬ÎÒÃÇ¿ÉÒÔ¸ù¾ÝÐÞ¸Äpom.xml´ò°üÅäÖÃÀ´ÊµÏÖ£¬Çë²Î¿¼Îĵµ½Úµã3´ò°üÅäÖà +通常第三方jar包å�¯ä»¥æ‰“è¿›jar包里,也å�¯ä»¥æ”¾åœ¨é¡¹ç›®jar包å�Œçº§ç›®å½•下的lib目录,我们å�¯ä»¥æ ¹æ�®ä¿®æ”¹pom.xml打包é…�ç½®æ�¥å®žçŽ°ï¼Œè¯·å�‚考文档节点3打包é…�ç½® -**´ò°üÅäÖÃ** +**打包é…�ç½®** ``` @@ -77,7 +77,7 @@ java src/main/resources - + **/*.properties **/*.xml @@ -145,33 +145,33 @@ java ``` -¸ÄºÃpom.xmlµÄbuildÄ£¿éºó£¬¾Í¿ÉÒÔͨ¹ýmvn package »òÕßmvn install´ò³öÎÒÃǵÄjar°üÁË +改好pom.xmlçš„build模å�—å�Žï¼Œå°±å�¯ä»¥é€šè¿‡mvn package 或者mvn install打出我们的jar包了 -1. **ÏîÄ¿¹ÜÀíshell½Å±¾±àд** - ×Ô¶¨Òåshell½Å±¾£¬ÊµÏÖÏîÄ¿µÄÆô¶¯£¬Í£Ö¹£¬×´Ì¬£¬ÖØÆô²Ù×÷£º +1. **项目管ç�†shell脚本编写** + 自定义shell脚本,实现项目的å�¯åŠ¨ï¼Œå�œæ­¢ï¼Œçжæ€�,é‡�å�¯æ“�作: ``` #!/bin/bash -#ÕâÀï¿ÉÌæ»»ÎªÄã×Ô¼ºµÄÖ´ÐгÌÐò,ÆäËû´úÂëÎÞÐè¸ü¸Ä +#这里å�¯æ›¿æ�¢ä¸ºä½ è‡ªå·±çš„æ‰§è¡Œç¨‹åº�,其他代ç �无需更改 APP_NAME=demo1-0.0.1-SNAPSHOT.jar JVM="-server -Xms512m -Xmx512m -XX:PermSize=64M -XX:MaxNewSize=128m -XX:MaxPermSize=128m -Djava.awt.headless=true -XX:+CMSClassUnloadingEnabled -XX:+CMSPermGenSweepingEnabled" APPFILE_PATH="-Dspring.config.location=/usr/local/demo/config/application-demo1.properties" -#ʹÓÃ˵Ã÷,ÓÃÀ´ÌáʾÊäÈë²ÎÊý +#使用说明,用æ�¥æ��示输入å�‚æ•° usage() { -echo "Usage: sh Ö´Ðнű¾.sh [start|stop|restart|status]" +echo "Usage: sh 执行脚本.sh [start|stop|restart|status]" exit 1 } -#¼ì²é³ÌÐòÊÇ·ñÔÚÔËÐÐ +#检查程åº�是å�¦åœ¨è¿�行 is_exist(){ pid=`ps -ef|grep $APP_NAME|grep -v grep|awk '{print $2}' ` -#Èç¹û²»´æÔÚ·µ»Ø1,´æÔÚ·µ»Ø0 +#如果ä¸�存在返回1,存在返回0 if [ -z "${pid}" ]; then return 1 else return 0 fi } -#Æô¶¯·½·¨ +#å�¯åŠ¨æ–¹æ³• start(){ is_exist if [ $? -eq "0" ]; then @@ -180,7 +180,7 @@ else nohup java $JVM -jar $APPFILE_PATH $APP_NAME > /dev/null 2>&1 fi } -#Í£Ö¹·½·¨ +#å�œæ­¢æ–¹æ³• stop(){ is_exist if [ $? -eq "0" ]; then @@ -189,7 +189,7 @@ else echo "${APP_NAME} is not running" fi } -#Êä³öÔËÐÐ״̬ +#输出è¿�行状æ€� status(){ is_exist if [ $? -eq "0" ]; then @@ -198,12 +198,12 @@ else echo "${APP_NAME} is NOT running." fi } -#ÖØÆô +#é‡�å�¯ restart(){ stop start } -#¸ù¾ÝÊäÈë²ÎÊý,Ñ¡ÔñÖ´ÐжÔÓ¦·½·¨,²»ÊäÈëÔòÖ´ÐÐʹÓÃ˵Ã÷ +#æ ¹æ�®è¾“å…¥å�‚æ•°,选择执行对应方法,ä¸�输入则执行使用说明 case "$1" in "start") start @@ -224,114 +224,114 @@ esac ``` -**²¿Êð** +**部署** -linux·þÎñÆ÷ÉÏн¨¸öÎļþ¼Ð£¬½«ÎÒÃÇ´òºÃµÄÏîÄ¿jar°ü¶¼¶ª½øÈ¥£¬ÔÚjar°üµÄͬ¼¶Ä¿Â¼Ð½¨configºÍlibÎļþ¼Ð£¬·Ö±ð½«ÅäÖÃÎļþºÍµÚÈý·½ÒÀÀµ°ü¶ª½øÈ¥£¬Æä½á¹¹ÈçÏÂͼ£¬*.shΪ×Ô¼ºÐ´µÄÏîÄ¿Æô¶¯shell½Å±¾ +linuxæœ�务器上新建个文件夹,将我们打好的项目jar包都丢进去,在jar包的å�Œçº§ç›®å½•新建configå’Œlib文件夹,分别将é…�置文件和第三方ä¾�赖包丢进去,其结构如下图,*.sh为自己写的项目å�¯åЍshell脚本 -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://img-blog.csdnimg.cn/20190121170223384.png) +![在这里æ�’入图片æ��è¿°](https://img-blog.csdnimg.cn/20190121170223384.png) -´ò¿ªconfigÄÚµÄspringbootºËÐÄÎļþ£¨Èçapplication-demo1.propertiesÎļþ£©£¬ +打开config内的springboot核心文件(如application-demo1.properties文件), -spring.profiles.pathÅäÖÃÏî¸Ä³Éµ±Ç°ÅäÖÃÎļþËùÔÚµÄĿ¼£¬¼ÙÉèΪ/usr/local/demo/config +spring.profiles.pathé…�置项改æˆ�当å‰�é…�置文件所在的目录,å�‡è®¾ä¸º/usr/local/demo/config -´ò¿ª*.sh½Å±¾£¬ÐÞ¸ÄAPPFILE_PATHµÄÖµ£¬ÈçÏ +打开*.sh脚本,修改APPFILE_PATH的值,如下 APPFILE_PATH="-Dspring.config.location=/usr/local/demo/config/application-demo1.properties" -**ÏîÄ¿¹ÜÀí** +**项目管ç�†** -½øÈëjar°üËùÔÚĿ¼ִÐÐÏÂÃæÃüÁî +进入jar包所在目录执行下é�¢å‘½ä»¤ -sh [demo1.sh](http://demo1.sh/) start Æô¶¯ÏîÄ¿ +sh [demo1.sh](http://demo1.sh/) start å�¯åŠ¨é¡¹ç›® -sh [demo1.sh](http://demo1.sh/) stop Í£Ö¹ÏîÄ¿ +sh [demo1.sh](http://demo1.sh/) stop å�œæ­¢é¡¹ç›® -sh [demo1.sh](http://demo1.sh/) restartÖØÆôÏîÄ¿ +sh [demo1.sh](http://demo1.sh/) restarté‡�å�¯é¡¹ç›® -sh [demo1.sh](http://demo1.sh/) statusÏîĿ״̬ +sh [demo1.sh](http://demo1.sh/) status项目状æ€� -## 2\. Íⲿ»¯µÄÅäÖà +## 2\. 外部化的é…�ç½® -Spring Boot¿ÉÒÔÈÃÄ㽫ÅäÖÃÍⲿ»¯£¬ÕâÑùÄã¾Í¿ÉÒÔÔÚ²»Í¬µÄ»·¾³ÖÐʹÓÃÏàͬµÄÓ¦ÓóÌÐò´úÂë¡£ Äã¿ÉÒÔʹÓø÷ÖÖÍⲿÅäÖÃÔ´£¬°üÀ¨Java properties Îļþ¡¢YAMLÎļþ¡¢»·¾³±äÁ¿ºÍÃüÁîÐвÎÊý¡£ +Spring Bootå�¯ä»¥è®©ä½ å°†é…�置外部化,这样你就å�¯ä»¥åœ¨ä¸�å�Œçš„环境中使用相å�Œçš„应用程åº�代ç �。 ä½ å�¯ä»¥ä½¿ç”¨å�„ç§�外部é…�ç½®æº�,包括Java properties 文件ã€�YAML文件ã€�环境å�˜é‡�和命令行å�‚数。 -ÊôÐÔÖµ¿ÉÒÔͨ¹ýʹÓà `@Value` ×¢½âÖ±½Ó×¢ÈëÄãµÄBean£¬Ò²¿ÉÒÔͨ¹ýSpring µÄ `Environment` ·ÃÎÊ£¬»òÕßͨ¹ý `@ConfigurationProperties` [°ó¶¨µ½¶ÔÏó](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties)¡£ +属性值å�¯ä»¥é€šè¿‡ä½¿ç”¨ `@Value` 注解直接注入你的Bean,也å�¯ä»¥é€šè¿‡Spring çš„ `Environment` 访问,或者通过 `@ConfigurationProperties` [绑定到对象](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties)。 -Spring Boot ʹÓÃÒ»¸ö·Ç³£ÌرðµÄ `PropertySource` ˳Ðò£¬Ö¼ÔÚÔÊÐíºÏÀíµØÖØÐ´Öµ¡£ ºóÃæµÄ property source ¿ÉÒÔ¸²¸ÇÇ°ÃæÊôÐÔÔ´Öж¨ÒåµÄÖµ¡£ °´ÒÔÏÂ˳Ðò¿¼ÂÇ¡£ +Spring Boot 使用一个é�žå¸¸ç‰¹åˆ«çš„ `PropertySource` 顺åº�,旨在å…�许å�ˆç�†åœ°é‡�写值。 å�Žé�¢çš„ property source å�¯ä»¥è¦†ç›–å‰�é�¢å±žæ€§æº�中定义的值。 按以下顺åº�考虑。 -1. ĬÈÏÊôÐÔ£¨Í¨¹ý `SpringApplication.setDefaultProperties` Ö¸¶¨£©¡£ +1. 默认属性(通过 `SpringApplication.setDefaultProperties` 指定)。 -2. @Configuration ÀàÉ쵀 [`@PropertySource`](https://docs.spring.io/spring-framework/docs/6.0.5/javadoc-api/org/springframework/context/annotation/PropertySource.html) ×¢½â¡£Çë×¢Ò⣬ÕâÑùµÄÊôÐÔÔ´Ö±µ½application context±»Ë¢ÐÂʱ²Å»á±»Ìí¼Óµ½»·¾³ÖС£Õâ¶ÔÓÚÅäÖÃijЩÊôÐÔÀ´ËµÒѾ­Ì«ÍíÁË£¬±ÈÈç `logging.*` ºÍ `spring.main.*` £¬ËüÃÇÔÚˢпªÊ¼Ç°¾ÍÒѾ­±»¶ÁÈ¡ÁË¡£ +2. @Configuration 类上的 [`@PropertySource`](https://docs.spring.io/spring-framework/docs/6.0.5/javadoc-api/org/springframework/context/annotation/PropertySource.html) 注解。请注æ„�,这样的属性æº�直到application context被刷新时æ‰�会被添加到环境中。这对于é…�ç½®æŸ�些属性æ�¥è¯´å·²ç»�太晚了,比如 `logging.*` å’Œ `spring.main.*` ,它们在刷新开始å‰�就已ç»�被读å�–了。 -3. ÅäÖÃÊý¾Ý£¨Èç `application.properties` Îļþ£©¡£ +3. é…�置数æ�®ï¼ˆå¦‚ `application.properties` 文件)。 -4. `RandomValuePropertySource`£¬ËüÖ»ÓÐ `random.*` ÊôÐÔ¡£ +4. `RandomValuePropertySource`,它å�ªæœ‰ `random.*` 属性。 -5. ²Ù×÷ϵͳ»·¾³±äÁ¿ +5. æ“�作系统环境å�˜é‡� 6. Java System properties (`System.getProperties()`). -7. `java:comp/env` ÖÐµÄ JNDI ÊôÐÔ¡£ +7. `java:comp/env` 中的 JNDI 属性。 8. `ServletContext` init parameters. 9. `ServletConfig` init parameters. -10. À´×Ô `SPRING_APPLICATION_JSON` µÄÊôÐÔ£¨Ç¶Èë»·¾³±äÁ¿»òϵͳÊôÐÔÖеÄÄÚÁªJSON£©¡£ +10. æ�¥è‡ª `SPRING_APPLICATION_JSON` 的属性(嵌入环境å�˜é‡�或系统属性中的内è�”JSON)。 -11. ÃüÁîÐвÎÊý +11. 命令行å�‚æ•° -12. ÄãÔÚ²âÊÔÖÐµÄ `properties` ÊôÐÔ¡£ÔÚ [`@SpringBootTest`](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/test/context/SpringBootTest.html) ºÍ²âÊÔ×¢½âÖпÉÓã¬[ÓÃÓÚ²âÊÔÄãµÄÓ¦ÓóÌÐòµÄÒ»¸öÌØ¶¨Æ¬¶Ï](https://springdoc.cn/spring-boot/features.html#features.testing.spring-boot-applications.autoconfigured-tests)¡£ +12. 你在测试中的 `properties` 属性。在 [`@SpringBootTest`](https://docs.spring.io/spring-boot/docs/3.1.0-SNAPSHOT/api/org/springframework/boot/test/context/SpringBootTest.html) 和测试注解中å�¯ç”¨ï¼Œ[用于测试你的应用程åº�的一个特定片断](https://springdoc.cn/spring-boot/features.html#features.testing.spring-boot-applications.autoconfigured-tests)。 -13. Äã²âÊÔÖеÄhttps://docs.spring.io/spring-framework/docs/6.0.5/javadoc-api/org/springframework/test/context/TestPropertySource.html[`@TestPropertySource`] ×¢½â. +13. 你测试中的https://docs.spring.io/spring-framework/docs/6.0.5/javadoc-api/org/springframework/test/context/TestPropertySource.html[`@TestPropertySource`] 注解. -14. µ±devtools´¦Óڻ״̬ʱ£¬`$HOME/.config/spring-boot` Ŀ¼ÏµÄ[DevtoolsÈ«¾ÖÉèÖÃÊôÐÔ](https://springdoc.cn/spring-boot/using.html#using.devtools.globalsettings)¡£ +14. 当devtools处于活动状æ€�时,`$HOME/.config/spring-boot` 目录下的[Devtools全局设置属性](https://springdoc.cn/spring-boot/using.html#using.devtools.globalsettings)。 -ÅäÖÃÊý¾ÝÎļþ°´ÒÔÏÂ˳Ðò¿¼ÂÇ¡£ +é…�置数æ�®æ–‡ä»¶æŒ‰ä»¥ä¸‹é¡ºåº�考虑。 -1. ÔÚÄãµÄjarÖдò°üµÄ[Application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files)£¨application.properties ºÍ YAML£©¡£ +1. 在你的jar中打包的[Application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files)(application.properties å’Œ YAML)。 -2. ÔÚÄãµÄjarÖдò°üµÄ [ÌØ¶¨µÄ Profile application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)£¨`application-{profile}.properties` ºÍ YAML£©¡£ +2. 在你的jar中打包的 [特定的 Profile application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)(`application-{profile}.properties` å’Œ YAML)。 -3. ÔÚÄã´ò°üµÄjarÖ®ÍâµÄ[Application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files)ÐÔ£¨application.propertiesºÍYAML£©¡£ +3. 在你打包的jar之外的[Application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files)性(application.propertieså’ŒYAML)。 -4. ÔÚÄã´ò°üµÄjarÖ®ÍâµÄ[ÌØ¶¨µÄ Profile application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)£¨ `application-{profile}.properties` ºÍYAML£©¡£ +4. 在你打包的jar之外的[特定的 Profile application properties](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)( `application-{profile}.properties` å’ŒYAML)。 -| | ½¨ÒéÄãÔÚÕû¸öÓ¦ÓóÌÐòÖмá³ÖʹÓÃÒ»ÖÖ¸ñʽ¡£ Èç¹ûÄãÔÚͬһ¸öµØ·½ÓÐ `.properties` ºÍ `.yml` ¸ñʽµÄÅäÖÃÎļþ£¬`.properties` ÓÅÏÈ¡£ | +| | 建议你在整个应用程åº�中å�šæŒ�使用一ç§�æ ¼å¼�。 如果你在å�Œä¸€ä¸ªåœ°æ–¹æœ‰ `.properties` å’Œ `.yml` æ ¼å¼�çš„é…�置文件,`.properties` 优先。 | | --- | --- | -ΪÁËÌṩһ¸ö¾ßÌåµÄÀý×Ó£¬¼ÙÉèÄ㿪·¢ÁËÒ»¸ö `@Component`£¬Ê¹ÓÃÁËÒ»¸ö `name` ÊôÐÔ£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +为了æ��供一个具体的例å­�,å�‡è®¾ä½ å¼€å�‘了一个 `@Component`,使用了一个 `name` 属性,如下é�¢çš„例å­�所示。 @@ -366,30 +366,30 @@ public class MyBean { -ÔÚÄãµÄÓ¦ÓóÌÐòµÄclasspath£¨ÀýÈ磬ÔÚÄãµÄjarÖУ©£¬Äã¿ÉÒÔÓÐÒ»¸ö `application.properties` Îļþ£¬Îª `name` Ìṩһ¸öºÏÀíµÄĬÈÏÊôÐÔÖµ¡£µ±ÔÚÒ»¸öÐµĻ·¾³ÖÐÔËÐÐʱ£¬¿ÉÒÔÔÚÄãµÄjarÖ®ÍâÌṩһ¸ö `application.properties` ÎļþÀ´¸²¸Ç `name` ¡£¶ÔÓÚÒ»´ÎÐԵIJâÊÔ£¬Äã¿ÉÒÔÓÃÒ»¸öÌØ¶¨µÄÃüÁîÐвÎÊýÀ´Æô¶¯£¨ÀýÈ磬`java -jar app.jar --name="Spring"`£©¡£ +在你的应用程åº�çš„classpath(例如,在你的jar中),你å�¯ä»¥æœ‰ä¸€ä¸ª `application.properties` 文件,为 `name` æ��供一个å�ˆç�†çš„默认属性值。当在一个新的环境中è¿�行时,å�¯ä»¥åœ¨ä½ çš„jar之外æ��供一个 `application.properties` 文件æ�¥è¦†ç›– `name` 。对于一次性的测试,你å�¯ä»¥ç”¨ä¸€ä¸ªç‰¹å®šçš„命令行å�‚æ•°æ�¥å�¯åŠ¨ï¼ˆä¾‹å¦‚ï¼Œ`java -jar app.jar --name="Spring"`)。 -| | `env` ºÍ `configprops` ¶ËµãÔÚÈ·¶¨Ò»¸öÊôÐÔΪʲôÓÐÒ»¸öÌØ¶¨µÄֵʱ·Ç³£ÓÐÓá£Äã¿ÉÒÔʹÓÃÕâÁ½¸ö¶ËµãÀ´Õï¶ÏÒâÍâµÄÊôÐÔÖµ¡£Ïê¼û "[Éú²ú¾ÍÐ÷¹¦ÄÜ](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints)" ²¿·Ö¡£ | +| | `env` å’Œ `configprops` 端点在确定一个属性为什么有一个特定的值时é�žå¸¸æœ‰ç”¨ã€‚ä½ å�¯ä»¥ä½¿ç”¨è¿™ä¸¤ä¸ªç«¯ç‚¹æ�¥è¯Šæ–­æ„�外的属性值。详è§� "[生产就绪功能](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints)" 部分。 | | --- | --- | -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.command-line-args)2.1\. ·ÃÎÊÃüÁîÐÐÊôÐÔ +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.command-line-args)2.1\. 访问命令行属性 -ĬÈÏÇé¿öÏ£¬`SpringApplication` »á½«ÈκÎÃüÁîÐÐÑ¡Ïî²ÎÊý£¨¼´ÒÔ `--` ¿ªÍ·µÄ²ÎÊý£¬Èç `--server.port=9000` £©×ª»»Îª `property` ²¢½«ÆäÌí¼Óµ½Spring `Environment` ÖС£ ÈçǰËùÊö£¬ÃüÁîÐÐÊôÐÔ×ÜÊÇÓÅÏÈÓÚ»ùÓÚÎļþµÄÊôÐÔÔ´¡£ +默认情况下,`SpringApplication` 会将任何命令行选项å�‚数(å�³ä»¥ `--` 开头的å�‚数,如 `--server.port=9000` )转æ�¢ä¸º `property` 并将其添加到Spring `Environment` 中。 如å‰�所述,命令行属性总是优先于基于文件的属性æº�。 -Èç¹ûÄ㲻ϣÍûÃüÁîÐÐÊôÐÔ±»Ìí¼Óµ½ `Environment` ÖУ¬Äã¿ÉÒÔͨ¹ý `SpringApplication.setAddCommandLineProperties(false)` ½ûÓÃËüÃÇ¡£ +如果你ä¸�希望命令行属性被添加到 `Environment` 中,你å�¯ä»¥é€šè¿‡ `SpringApplication.setAddCommandLineProperties(false)` ç¦�用它们。 @@ -401,19 +401,19 @@ public class MyBean { -»·¾³±äÁ¿ºÍϵͳÊôÐÔÍùÍùÓÐÏÞÖÆ£¬ÕâÒâζ×ÅÓÐЩÊôÐÔÃû³Æ²»ÄÜʹÓᣠΪÁ˰ïÖú½â¾öÕâ¸öÎÊÌ⣬Spring BootÔÊÐíÄ㽫һ¸öÊôÐÔ¿é±àÂëΪһ¸öµ¥Ò»µÄJSON½á¹¹¡£ +环境å�˜é‡�和系统属性往往有é™�制,这æ„�味ç�€æœ‰äº›å±žæ€§å��ç§°ä¸�能使用。 为了帮助解决这个问题,Spring Bootå…�许你将一个属性å�—ç¼–ç �为一个å�•一的JSON结构。 -µ±ÄãµÄÓ¦ÓóÌÐòÆô¶¯Ê±£¬ÈκΠ`spring.application.json` »ò `SPRING_APPLICATION_JSON` ÊôÐÔ½«±»½âÎö²¢Ìí¼Óµ½ `Environment` ÖС£ +当你的应用程åº�å�¯åŠ¨æ—¶ï¼Œä»»ä½• `spring.application.json` 或 `SPRING_APPLICATION_JSON` 属性将被解æž�并添加到 `Environment` 中。 -ÀýÈ磬`SPRING_APPLICATION_JSON` ÊôÐÔ¿ÉÒÔÔÚ UN*X shell µÄÃüÁîÐÐÖÐ×÷Ϊ»·¾³±äÁ¿Ìṩ¡£ +例如,`SPRING_APPLICATION_JSON` 属性å�¯ä»¥åœ¨ UN*X shell 的命令行中作为环境å�˜é‡�æ��供。 @@ -431,13 +431,13 @@ $ SPRING_APPLICATION_JSON='{"my":{"name":"test"}}' java -jar myapp.jar -ÔÚÇ°ÃæµÄÀý×ÓÖУ¬ÄãÔÚSpringµÄ `Environment` ÖÐ×îÖյõ½ÁË `my.name=test`¡£ +在å‰�é�¢çš„例å­�中,你在Springçš„ `Environment` 中最终得到了 `my.name=test`。 -ͬÑùµÄJSONÒ²¿ÉÒÔ×÷Ϊһ¸öϵͳÊôÐÔÌṩ¡£ +å�Œæ ·çš„JSON也å�¯ä»¥ä½œä¸ºä¸€ä¸ªç³»ç»Ÿå±žæ€§æ��供。 @@ -455,7 +455,7 @@ $ java -Dspring.application.json='{"my":{"name":"test"}}' -jar myapp.jar -»òÕßÄã¿ÉÒÔͨ¹ýʹÓÃÒ»¸öÃüÁîÐвÎÊýÀ´ÌṩJSON¡£ +或者你å�¯ä»¥é€šè¿‡ä½¿ç”¨ä¸€ä¸ªå‘½ä»¤è¡Œå�‚æ•°æ�¥æ��ä¾›JSON。 @@ -473,13 +473,13 @@ $ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}' -Èç¹ûÄãÒª²¿Êðµ½Ò»¸ö¾­µäµÄÓ¦Ó÷þÎñÆ÷ÖУ¬ÄãÒ²¿ÉÒÔʹÓÃÒ»¸öÃûΪ `java:comp/env/spring.application.json` µÄJNDI±äÁ¿¡£ +如果你è¦�部署到一个ç»�典的应用æœ�务器中,你也å�¯ä»¥ä½¿ç”¨ä¸€ä¸ªå��为 `java:comp/env/spring.application.json` çš„JNDIå�˜é‡�。 -| | ¾¡¹ÜJSONÖÐµÄ `null` Öµ½«±»Ìí¼Óµ½Éú³ÉµÄÊôÐÔÔ´ÖУ¬µ« `PropertySourcesPropertyResolver` ½« `null` ÊôÐÔÊÓΪȱʧֵ¡£ ÕâÒâζ×ÅJSON²»ÄÜÓà `null` Öµ¸²¸ÇÀ´×Եͽ×ÊôÐÔÔ´µÄÊôÐÔ¡£ | +| | 尽管JSON中的 `null` 值将被添加到生æˆ�的属性æº�中,但 `PropertySourcesPropertyResolver` å°† `null` 属性视为缺失值。 è¿™æ„�味ç�€JSONä¸�能用 `null` 值覆盖æ�¥è‡ªä½Žé˜¶å±žæ€§æº�的属性。 | | --- | --- | @@ -488,11 +488,11 @@ $ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}' -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files)2.3\. ÍⲿµÄ Application Properties +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files)2.3\. 外部的 Application Properties -µ±ÄãµÄÓ¦ÓóÌÐòÆô¶¯Ê±£¬Spring Boot»á×Ô¶¯´ÓÒÔÏÂλÖÃÕÒµ½²¢¼ÓÔØ `application.properties` ºÍ `application.yaml` Îļþ¡£ +当你的应用程åº�å�¯åŠ¨æ—¶ï¼ŒSpring Boot会自动从以下ä½�置找到并加载 `application.properties` å’Œ `application.yaml` 文件。 @@ -502,21 +502,21 @@ $ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}' - 1. classpath ¸ù·¾¶ + 1. classpath 根路径 - 2. classpath Ï嵀 `/config` °ü + 2. classpath 下的 `/config` 包 -2. µ±Ç°Ä¿Â¼ +2. 当å‰�目录 - 1. µ±Ç°Ä¿Â¼Ï + 1. 当å‰�目录下 - 2. µ±Ç°Ä¿Â¼Ï嵀 `config/` ×ÓĿ¼ + 2. 当å‰�目录下的 `config/` å­�目录 - 3. `config/` ×ÓĿ¼µÄÖ±½Ó×ÓĿ¼ + 3. `config/` å­�目录的直接å­�目录 @@ -524,13 +524,13 @@ $ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}' -ÁÐ±í°´ÓÅÏȼ¶ÅÅÐò£¨½ÏµÍÏîÄ¿µÄÖµ¸²¸Ç½ÏÔçÏîÄ¿µÄÖµ£©¡£ ¼ÓÔØµÄÎļþ±»×÷Ϊ `PropertySources` Ìí¼Óµ½SpringµÄ `Environment` ÖС£ +列表按优先级排åº�(较低项目的值覆盖较早项目的值)。 加载的文件被作为 `PropertySources` 添加到Springçš„ `Environment` 中。 -Èç¹ûÄ㲻ϲ»¶ `application` ×÷ΪÅäÖÃÎļþÃû³Æ£¬Äã¿ÉÒÔͨ¹ýÖ¸¶¨ `spring.config.name` »·¾³ÊôÐÔÇл»µ½ÁíÒ»¸öÎļþÃû³Æ¡£ ÀýÈ磬ΪÁËѰÕÒ `myproject.properties` ºÍ `myproject.yaml` Îļþ£¬Äã¿ÉÒÔ°´ÒÔÏ·½Ê½ÔËÐÐÄãµÄÓ¦ÓóÌÐò¡£ +如果你ä¸�喜欢 `application` 作为é…�置文件å��称,你å�¯ä»¥é€šè¿‡æŒ‡å®š `spring.config.name` 环境属性切æ�¢åˆ°å�¦ä¸€ä¸ªæ–‡ä»¶å��称。 例如,为了寻找 `myproject.properties` å’Œ `myproject.yaml` 文件,你å�¯ä»¥æŒ‰ä»¥ä¸‹æ–¹å¼�è¿�行你的应用程åº�。 @@ -548,13 +548,13 @@ $ java -jar myproject.jar --spring.config.name=myproject -ÄãÒ²¿ÉÒÔͨ¹ýʹÓà `spring.config.location` »·¾³ÊôÐÔÀ´ÒýÓÃÒ»¸öÃ÷È·µÄλÖᣠ¸ÃÊôÐÔ½ÓÊÜÒ»¸ö¶ººÅ·Ö¸ôµÄÁÐ±í£¬ÆäÖаüº¬Ò»¸ö»ò¶à¸öÒª¼ì²éµÄλÖᣠ+你也å�¯ä»¥é€šè¿‡ä½¿ç”¨ `spring.config.location` 环境属性æ�¥å¼•用一个明确的ä½�置。 该属性接å�—一个逗å�·åˆ†éš”的列表,其中包å�«ä¸€ä¸ªæˆ–多个è¦�检查的ä½�置。 -ÏÂÃæµÄÀý×ÓÏÔʾÁËÈçºÎÖ¸¶¨Á½¸ö²»Í¬µÄÎļþ¡£ +下é�¢çš„例å­�显示了如何指定两个ä¸�å�Œçš„æ–‡ä»¶ã€‚ @@ -574,46 +574,46 @@ $ java -jar myproject.jar --spring.config.location=\ -| | Èç¹û [ÅäÖÃÎļþÊÇ¿ÉÑ¡µÄ](https://springdoc.cn/spring-boot/features.html#features.external-config.files.optional-prefix)£¬²¢ÇÒ¿ÉÒÔÊDz»´æÔڵģ¬ÄÇôÇëʹÓà `optional:` ǰ׺¡£ | +| | 如果 [é…�置文件是å�¯é€‰çš„](https://springdoc.cn/spring-boot/features.html#features.external-config.files.optional-prefix),并且å�¯ä»¥æ˜¯ä¸�存在的,那么请使用 `optional:` å‰�缀。 | | --- | --- | -| | `spring.config.name`, `spring.config.location`, ºÍ `spring.config.extra-location` ºÜÔç¾ÍÓÃÀ´È·¶¨ÄÄЩÎļþ±ØÐë±»¼ÓÔØ¡£ ËüÃDZØÐë±»¶¨ÒåΪ»·¾³ÊôÐÔ£¨Í¨³£ÊDzÙ×÷ϵͳ»·¾³±äÁ¿£¬ÏµÍ³ÊôÐÔ£¬»òÃüÁîÐвÎÊý£©¡£ | +| | `spring.config.name`, `spring.config.location`, å’Œ `spring.config.extra-location` 很早就用æ�¥ç¡®å®šå“ªäº›æ–‡ä»¶å¿…须被加载。 它们必须被定义为环境属性(通常是æ“�作系统环境å�˜é‡�,系统属性,或命令行å�‚数)。 | | --- | --- | -Èç¹û `spring.config.location` °üº¬Ä¿Â¼£¨¶ø²»ÊÇÎļþ£©£¬ËüÃÇÓ¦¸ÃÒÔ `/` ½áβ¡£ ÔÚÔËÐÐʱ£¬ËüÃǽ«±»¸½¼ÓÉÏÓÉ `spring.config.name` Éú³ÉµÄÃû³Æ£¬È»ºó±»¼ÓÔØ¡£ ÔÚ `spring.config.location` ÖÐÖ¸¶¨µÄÎļþ±»Ö±½Óµ¼Èë¡£ +如果 `spring.config.location` 包å�«ç›®å½•(而ä¸�是文件),它们应该以 `/` 结尾。 在è¿�行时,它们将被附加上由 `spring.config.name` 生æˆ�çš„å��称,然å�Žè¢«åŠ è½½ã€‚ 在 `spring.config.location` 中指定的文件被直接导入。 -| | Ŀ¼ºÍÎļþλÖÃÖµÒ²±»À©Õ¹£¬ÒÔ¼ì²é[ÌØ¶¨µÄÅäÖÃÎļþ](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)¡£ÀýÈ磬Èç¹ûÄãµÄ `spring.config.location` ÊÇ `classpath:myconfig.properties`£¬ÄãÒ²»á·¢ÏÖÊʵ±µÄ `classpath:myconfig-.properties` Îļþ±»¼ÓÔØ¡£ | +| | 目录和文件ä½�置值也被扩展,以检查[特定的é…�置文件](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)。例如,如果你的 `spring.config.location` 是 `classpath:myconfig.properties`,你也会å�‘现适当的 `classpath:myconfig-.properties` 文件被加载。 | | --- | --- | -ÔÚ´ó¶àÊýÇé¿öÏ£¬ÄãÌí¼ÓµÄÿ¸ö `spring.config.location` ÏÒýÓÃÒ»¸öÎļþ»òĿ¼¡£ λÖÃÊǰ´ÕÕËüÃDZ»¶¨ÒåµÄ˳ÐòÀ´´¦ÀíµÄ£¬ºóÃæµÄλÖÿÉÒÔ¸²¸ÇÇ°ÃæµÄλÖõÄÖµ¡£ +在大多数情况下,你添加的æ¯�个 `spring.config.location` 项将引用一个文件或目录。 ä½�置是按照它们被定义的顺åº�æ�¥å¤„ç�†çš„,å�Žé�¢çš„ä½�ç½®å�¯ä»¥è¦†ç›–å‰�é�¢çš„ä½�置的值。 -Èç¹ûÄãÓÐÒ»¸ö¸´ÔÓµÄλÖÃÉèÖ㬶øÇÒÄãʹÓÃÌØ¶¨µÄÅäÖÃÎļþ£¬Äã¿ÉÄÜÐèÒªÌṩ½øÒ»²½µÄÌáʾ£¬ÒÔ±ãSpring BootÖªµÀËüÃÇÓ¦¸ÃÈçºÎ·Ö×é¡£Ò»¸öλÖÃ×éÊÇÒ»¸öλÖõļ¯ºÏ£¬ÕâЩλÖö¼±»ÈÏΪÊÇÔÚͬһ¼¶±ð¡£ÀýÈ磬Äã¿ÉÄÜÏë°ÑËùÓÐclasspathλÖ÷Ö×飬ȻºóÊÇËùÓÐÍⲿλÖá£Ò»¸öλÖÃ×éÄÚµÄÏîĿӦ¸ÃÓà `;` ·Ö¸ô¡£¸ü¶àϸ½Ú¼û ¡°[Ö¸¶¨ profile](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)¡± ²¿·ÖµÄÀý×Ó¡£ +如果你有一个å¤�æ�‚çš„ä½�置设置,而且你使用特定的é…�置文件,你å�¯èƒ½éœ€è¦�æ��供进一步的æ��示,以便Spring Boot知é�“它们应该如何分组。一个ä½�置组是一个ä½�置的集å�ˆï¼Œè¿™äº›ä½�置都被认为是在å�Œä¸€çº§åˆ«ã€‚例如,你å�¯èƒ½æƒ³æŠŠæ‰€æœ‰classpathä½�置分组,然å�Žæ˜¯æ‰€æœ‰å¤–部ä½�置。一个ä½�置组内的项目应该用 `;` 分隔。更多细节è§� “[指定 profile](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)â€� 部分的例å­�。 -ͨ¹ýʹÓà `spring.config.location` ÅäÖõÄλÖÃÈ¡´úĬÈÏλÖᣠÀýÈ磬Èç¹û `spring.config.location` ±»ÅäÖÃΪ `optional:classpath:/custom-config/,optional:file:./custom-config/` £¬¿¼ÂǵÄÍêÕûλÖü¯ÈçÏ¡£ +通过使用 `spring.config.location` é…�置的ä½�ç½®å�–代默认ä½�置。 例如,如果 `spring.config.location` 被é…�置为 `optional:classpath:/custom-config/,optional:file:./custom-config/` ,考虑的完整ä½�置集如下。 @@ -627,7 +627,7 @@ $ java -jar myproject.jar --spring.config.location=\ -Èç¹ûÄãϲ»¶Ìí¼Ó¶îÍâµÄλÖ㬶ø²»ÊÇÌæ»»ËüÃÇ£¬Äã¿ÉÒÔʹÓà `spring.config.extra-location` ¡£ ´Ó¸½¼ÓλÖüÓÔØµÄÊôÐÔ¿ÉÒÔ¸²¸ÇĬÈÏλÖõÄÊôÐÔ¡£ ÀýÈ磬Èç¹û `spring.config.extra-location` ±»ÅäÖÃΪ `optional:classpath:/custom-config/,optional:file:./custom-config/` £¬¿¼ÂǵÄÍêÕûλÖü¯ÈçÏ¡£ +如果你喜欢添加é¢�外的ä½�置,而ä¸�是替æ�¢å®ƒä»¬ï¼Œä½ å�¯ä»¥ä½¿ç”¨ `spring.config.extra-location` 。 从附加ä½�置加载的属性å�¯ä»¥è¦†ç›–默认ä½�置的属性。 例如,如果 `spring.config.extra-location` 被é…�置为 `optional:classpath:/custom-config/,optional:file:./custom-config/` ,考虑的完整ä½�置集如下。 @@ -645,49 +645,49 @@ $ java -jar myproject.jar --spring.config.location=\ -ÕâÖÖËÑË÷ÅÅÐòÈÃÄãÔÚÒ»¸öÅäÖÃÎļþÖÐÖ¸¶¨Ä¬ÈÏÖµ£¬È»ºóÔÚÁíÒ»¸öÎļþÖÐÑ¡ÔñÐԵظ²¸ÇÕâЩֵ¡£ Äã¿ÉÒÔÔÚÆäÖÐÒ»¸öĬÈÏλÖÃµÄ `application.properties` £¨»òÄãÓà `spring.config.name` Ñ¡ÔñµÄÆäËûbasename£©ÖÐΪÄãµÄÓ¦ÓóÌÐòÌṩĬÈÏÖµ¡£ È»ºó£¬ÕâЩĬÈÏÖµ¿ÉÒÔÔÚÔËÐÐʱ±»Î»ÓÚÆäÖÐÒ»¸ö×Ô¶¨ÒåλÖõIJ»Í¬Îļþ¸²¸Ç¡£ +è¿™ç§�æ�œç´¢æŽ’åº�让你在一个é…�置文件中指定默认值,然å�Žåœ¨å�¦ä¸€ä¸ªæ–‡ä»¶ä¸­é€‰æ‹©æ€§åœ°è¦†ç›–这些值。 ä½ å�¯ä»¥åœ¨å…¶ä¸­ä¸€ä¸ªé»˜è®¤ä½�置的 `application.properties` (或你用 `spring.config.name` 选择的其他basename)中为你的应用程åº�æ��供默认值。 ç„¶å�Žï¼Œè¿™äº›é»˜è®¤å€¼å�¯ä»¥åœ¨è¿�行时被ä½�于其中一个自定义ä½�置的ä¸�å�Œæ–‡ä»¶è¦†ç›–。 -| | Èç¹ûÄãʹÓû·¾³±äÁ¿¶ø²»ÊÇϵͳÊôÐÔ£¬´ó¶àÊý²Ù×÷ϵͳ²»ÔÊÐíʹÓþäµã·Ö¸ôµÄ¼üÃû£¬µ«Äã¿ÉÒÔʹÓÃÏ»®Ïß´úÌæ£¨ÀýÈ磬 `SPRING_CONFIG_NAME` ¶ø²»ÊÇ `spring.config.name` £©¡£ ²Î¼û[´Ó»·¾³±äÁ¿°ó¶¨](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables) Á˽âÏêÇé¡£ | +| | 如果你使用环境å�˜é‡�而ä¸�是系统属性,大多数æ“�作系统ä¸�å…�许使用å�¥ç‚¹åˆ†éš”的键å��,但你å�¯ä»¥ä½¿ç”¨ä¸‹åˆ’线代替(例如, `SPRING_CONFIG_NAME` 而ä¸�是 `spring.config.name` )。 å�‚è§�[从环境å�˜é‡�绑定](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables) 了解详情。 | | --- | --- | -| | Èç¹ûÄãµÄÓ¦ÓóÌÐòÔÚservletÈÝÆ÷»òÓ¦Ó÷þÎñÆ÷ÖÐÔËÐУ¬ÄÇôJNDIÊôÐÔ£¨ÔÚ `java:comp/env` ÖУ©»òservletÉÏÏÂÎijõʼ»¯²ÎÊý¿ÉÒÔ´úÌæ»·¾³±äÁ¿»òϵͳÊôÐÔ£¬»òÕßÓëÖ®Ò»Ñù¡£ | +| | 如果你的应用程åº�在servlet容器或应用æœ�务器中è¿�行,那么JNDI属性(在 `java:comp/env` 中)或servlet上下文åˆ�始化å�‚æ•°å�¯ä»¥ä»£æ›¿çŽ¯å¢ƒå�˜é‡�或系统属性,或者与之一样。 | | --- | --- | -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.optional-prefix)2.3.1\. ¿ÉÑ¡µÄλÖÃ(Optional Locations) +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.optional-prefix)2.3.1\. å�¯é€‰çš„ä½�ç½®(Optional Locations) -ĬÈÏÇé¿öÏ£¬µ±Ö¸¶¨µÄÅäÖÃÊý¾ÝλÖò»´æÔÚʱ£¬Spring Boot½«Å׳öÒ»¸ö `ConfigDataLocationNotFoundException` £¬ÄãµÄÓ¦ÓóÌÐò½«ÎÞ·¨Æô¶¯¡£ +默认情况下,当指定的é…�置数æ�®ä½�ç½®ä¸�存在时,Spring Boot将抛出一个 `ConfigDataLocationNotFoundException` ,你的应用程åº�将无法å�¯åŠ¨ã€‚ -Èç¹ûÄãÏëÖ¸¶¨Ò»¸öλÖ㬵«Äã²»½éÒâËü²¢²»×ÜÊÇ´æÔÚ£¬Äã¿ÉÒÔʹÓà `optional:` ǰ׺¡£Äã¿ÉÒÔÔÚ `spring.config.locationºÍspring.config.extra-location` ÊôÐÔÖÐʹÓÃÕâ¸öǰ׺£¬Ò²¿ÉÒÔÔÚ [`spring.config.import`](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing) ÉùÃ÷ÖÐʹÓᣠ+如果你想指定一个ä½�置,但你ä¸�介æ„�它并ä¸�总是存在,你å�¯ä»¥ä½¿ç”¨ `optional:` å‰�缀。你å�¯ä»¥åœ¨ `spring.config.locationå’Œspring.config.extra-location` 属性中使用这个å‰�缀,也å�¯ä»¥åœ¨ [`spring.config.import`](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing) 声明中使用。 -ÀýÈ磬`spring.config.import` ֵΪ `optional:file:./myconfig.properties` ÔÊÐíÄãµÄÓ¦ÓóÌÐòÆô¶¯£¬¼´Ê¹ `myconfig.properties` Îļþ¶ªÊ§¡£ +例如,`spring.config.import` 值为 `optional:file:./myconfig.properties` å…�许你的应用程åº�å�¯åŠ¨ï¼Œå�³ä½¿ `myconfig.properties` 文件丢失。 -Èç¹ûÄãÏëºöÂÔËùÓÐµÄ `ConfigDataLocationNotFoundExceptions` ²¢Ê¼ÖÕ¼ÌÐøÆô¶¯ÄãµÄÓ¦ÓóÌÐò£¬Äã¿ÉÒÔʹÓà `spring.config.on-not-found` ÊôÐÔ¡£ ʹÓà `SpringApplication.setDefaultProperties(..)` »òʹÓÃϵͳ/»·¾³±äÁ¿½«ÆäÖµÉèÖÃΪ `ignore`¡£ +如果你想忽略所有的 `ConfigDataLocationNotFoundExceptions` 并始终继续å�¯åŠ¨ä½ çš„åº”ç”¨ç¨‹åº�,你å�¯ä»¥ä½¿ç”¨ `spring.config.on-not-found` 属性。 使用 `SpringApplication.setDefaultProperties(..)` 或使用系统/环境å�˜é‡�将其值设置为 `ignore`。 @@ -695,48 +695,48 @@ $ java -jar myproject.jar --spring.config.location=\ -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.wildcard-locations)2.3.2\. ͨÅä·ûµØÖ· +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.wildcard-locations)2.3.2\. 通é…�符地å�€ -Èç¹ûÒ»¸öÅäÖÃÎļþµÄλÖÃÔÚ×îºóÒ»¸ö·¾¶¶ÎÖаüº¬ `*` ×Ö·û£¬Ëü¾Í±»ÈÏΪÊÇÒ»¸öͨÅä·ûλÖᣠͨÅä·ûÔÚ¼ÓÔØÅäÖÃʱ±»À©Õ¹£¬Òò´Ë£¬Ö±½ÓµÄ×ÓĿ¼Ҳ±»¼ì²é¡£ ͨÅä·ûλÖÃÔÚKubernetesÕâÖÖÓжà¸öÅäÖÃÊôÐÔµÄÀ´Ô´µÄ»·¾³ÖÐÌØ±ðÓÐÓᣠ+如果一个é…�置文件的ä½�置在最å�Žä¸€ä¸ªè·¯å¾„段中包å�« `*` 字符,它就被认为是一个通é…�符ä½�置。 通é…�符在加载é…�置时被扩展,因此,直接的å­�目录也被检查。 通é…�符ä½�置在Kubernetesè¿™ç§�有多个é…�置属性的æ�¥æº�的环境中特别有用。 -ÀýÈ磬Èç¹ûÄãÓÐһЩRedisÅäÖúÍһЩMySQLÅäÖã¬Äã¿ÉÄÜÏë°ÑÕâÁ½²¿·ÖÅäÖ÷ֿª£¬Í¬Ê±ÒªÇóÕâÁ½²¿·Ö¶¼´æÔÚÓÚÒ»¸ö `application.properties` ÎļþÖС£ +例如,如果你有一些Redisé…�置和一些MySQLé…�置,你å�¯èƒ½æƒ³æŠŠè¿™ä¸¤éƒ¨åˆ†é…�置分开,å�Œæ—¶è¦�求这两部分都存在于一个 `application.properties` 文件中。 -Õâ¿ÉÄܻᵼÖÂÁ½¸ö¶ÀÁ¢µÄ `application.properties` Îļþ¹ÒÔØÔÚ²»Í¬µÄλÖã¬Èç `/config/redis/application.properties` ºÍ `/config/mysql/application.properties` ¡£ ÔÚÕâÖÖÇé¿öÏ£¬ÓÐÒ»¸öͨÅä·ûλÖà `config/*/` £¬½«µ¼ÖÂÁ½¸öÎļþ±»´¦Àí¡£ +è¿™å�¯èƒ½ä¼šå¯¼è‡´ä¸¤ä¸ªç‹¬ç«‹çš„ `application.properties` 文件挂载在ä¸�å�Œçš„ä½�置,如 `/config/redis/application.properties` å’Œ `/config/mysql/application.properties` 。 在这ç§�情况下,有一个通é…�符ä½�ç½® `config/*/` ,将导致两个文件被处ç�†ã€‚ -ĬÈÏÇé¿öÏ£¬Spring Boot½« `config/*/` ÁÐÈëĬÈÏËÑË÷λÖᣠÕâÒâζ×ÅÄãµÄjarÖ®ÍâµÄ `/config` Ŀ¼µÄËùÓÐ×ÓĿ¼¶¼»á±»ËÑË÷µ½¡£ +默认情况下,Spring Bootå°† `config/*/` 列入默认æ�œç´¢ä½�置。 è¿™æ„�味ç�€ä½ çš„jar之外的 `/config` 目录的所有å­�目录都会被æ�œç´¢åˆ°ã€‚ -Äã¿ÉÒÔÔÚ `spring.config.location` ºÍ `spring.config.extra-location` ÊôÐÔÖÐʹÓÃͨÅä·ûλÖᣠ+ä½ å�¯ä»¥åœ¨ `spring.config.location` å’Œ `spring.config.extra-location` 属性中使用通é…�符ä½�置。 -| | ͨÅä·ûλÖñØÐëÖ»°üº¬Ò»¸ö `*` ²¢ÒÔ `*/` ½á⣬ÓÃÓÚËÑË÷ÊôÓÚĿ¼µÄλÖ㬻ò `*/` ÓÃÓÚËÑË÷ÊôÓÚÎļþµÄλÖᣠ´øÓÐͨÅä·ûµÄλÖý«¸ù¾ÝÎļþÃûµÄ¾ø¶Ô·¾¶°´×Öĸ˳ÐòÅÅÐò¡£ | +| | 通é…�符ä½�置必须å�ªåŒ…å�«ä¸€ä¸ª `*` 并以 `*/` 结尾,用于æ�œç´¢å±žäºŽç›®å½•çš„ä½�置,或 `*/` 用于æ�œç´¢å±žäºŽæ–‡ä»¶çš„ä½�置。 带有通é…�符的ä½�置将根æ�®æ–‡ä»¶å��çš„ç»�对路径按字æ¯�顺åº�排åº�。 | | --- | --- | -| | ͨÅä·ûλÖÃÖ»¶ÔÍⲿĿ¼Æð×÷ÓᣠÄã²»ÄÜÔÚ `classpath:` λÖÃÖÐʹÓÃͨÅä·û¡£ | +| | 通é…�符ä½�ç½®å�ªå¯¹å¤–部目录起作用。 ä½ ä¸�能在 `classpath:` ä½�置中使用通é…�符。 | | --- | --- | @@ -745,36 +745,36 @@ $ java -jar myproject.jar --spring.config.location=\ -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)2.3.3\. ÌØ¶¨Îļþ£¨Profile Specific Files£© +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)2.3.3\. 特定文件(Profile Specific Files) -³ýÁË `application` ÊôÐÔÎļþ£¬Spring Boot»¹½«³¢ÊÔʹÓà `application-{profile}` µÄÃüÃû¹ßÀý¼ÓÔØprofileÌØ¶¨µÄÎļþ¡£ ÀýÈ磬Èç¹ûÄãµÄÓ¦ÓóÌÐò¼¤»îÁËÃûΪ `prod` µÄÅäÖÃÎļþ£¨`spring.profiles.active=prod`£©²¢Ê¹ÓÃYAMLÎļþ£¬ÄÇô `application.yml` ºÍ `application-prod.yml` ¶¼½«±»¿¼ÂÇ¡£ +除了 `application` 属性文件,Spring Boot还将å°�试使用 `application-{profile}` 的命å��惯例加载profile特定的文件。 例如,如果你的应用程åº�激活了å��为 `prod` çš„é…�置文件(`spring.profiles.active=prod`)并使用YAML文件,那么 `application.yml` å’Œ `application-prod.yml` 都将被考虑。 -ÌØ¶¨Îļþ(`profiles`)µÄÊôÐÔÓë±ê×¼µÄ `application.properties` µÄλÖÃÏàͬ£¬Ìض¨Îļþ×ÜÊÇÓÅÏÈÓÚ·ÇÌØ¶¨Îļþ¡£ Èç¹ûÖ¸¶¨Á˼¸¸öÅäÖÃÎļþ£¬Ôò²ÉÓÃ×îºóʤ³öµÄ²ßÂÔ¡£ ÀýÈ磬Èç¹ûÅäÖÃÎļþ `prod,live` ÊÇÓÉ `spring.profiles.active` ÊôÐÔÖ¸¶¨µÄ£¬`application-prod.properties` ÖеÄÖµ¿ÉÒÔ±» `application-live.properties` ÖеÄÖµËù¸²¸Ç¡£ +特定文件(`profiles`)的属性与标准的 `application.properties` çš„ä½�置相å�Œï¼Œç‰¹å®šæ–‡ä»¶æ€»æ˜¯ä¼˜å…ˆäºŽé�žç‰¹å®šæ–‡ä»¶ã€‚ 如果指定了几个é…�置文件,则采用最å�Žèƒœå‡ºçš„策略。 例如,如果é…�置文件 `prod,live` 是由 `spring.profiles.active` 属性指定的,`application-prod.properties` 中的值å�¯ä»¥è¢« `application-live.properties` 中的值所覆盖。 -| | ×îºóʤ³öµÄ²ßÂÔÊÊÓÃÓÚ[location group](https://springdoc.cn/spring-boot/features.html#features.external-config.files.location-groups)¼¶±ð¡£ `spring.config.location` µÄ `classpath:/cfg/,classpath:/ext/` ½«²»»áÓÐÓë `classpath:/cfg/;classpath:/ext/` ÏàͬµÄ¸²¸Ç¹æÔò¡£ÀýÈ磬ÄÃÎÒÃÇÉÏÃæµÄ `prod,live` Àý×ÓÀ´Ëµ£¬ÎÒÃÇ¿ÉÄÜÓÐÒÔÏÂÎļþ¡£ /cfg application-live.properties/ext application-live.properties application-prod.properties µ±ÎÒÃÇÓÐÒ»¸ö `spring.config.location` Ϊ `classpath:/cfg/,classpath:/ext/` ʱ£¬ÎÒÃÇ»áÔÚËùÓÐ `/ext` Îļþ֮ǰ´¦ÀíËùÓÐ `/cfg` Îļþ¡£1. `/cfg/application-live.properties` 2. `/ext/application-prod.properties` 3. `/ext/application-live.properties` µ±ÎÒÃÇÓà `classpath:/cfg/;classpath:/ext/` ´úÌæÊ±£¨Óà `;` ·Ö¸ô·û£©£¬ÎÒÃÇÔÚͬһ¼¶±ð´¦Àí `/cfg` ºÍ `/ext` ¡£1. `/ext/application-prod.properties` 2. `/cfg/application-live.properties` 3. `/ext/application-live.properties` | +| | 最å�Žèƒœå‡ºçš„策略适用于[location group](https://springdoc.cn/spring-boot/features.html#features.external-config.files.location-groups)级别。 `spring.config.location` çš„ `classpath:/cfg/,classpath:/ext/` å°†ä¸�会有与 `classpath:/cfg/;classpath:/ext/` 相å�Œçš„覆盖规则。例如,拿我们上é�¢çš„ `prod,live` 例å­�æ�¥è¯´ï¼Œæˆ‘们å�¯èƒ½æœ‰ä»¥ä¸‹æ–‡ä»¶ã€‚ /cfg application-live.properties/ext application-live.properties application-prod.properties 当我们有一个 `spring.config.location` 为 `classpath:/cfg/,classpath:/ext/` 时,我们会在所有 `/ext` 文件之å‰�处ç�†æ‰€æœ‰ `/cfg` 文件。1. `/cfg/application-live.properties` 2. `/ext/application-prod.properties` 3. `/ext/application-live.properties` 当我们用 `classpath:/cfg/;classpath:/ext/` 代替时(用 `;` 分隔符),我们在å�Œä¸€çº§åˆ«å¤„ç�† `/cfg` å’Œ `/ext` 。1. `/ext/application-prod.properties` 2. `/cfg/application-live.properties` 3. `/ext/application-live.properties` | | --- | --- | -`Environment` ÓÐÒ»×éĬÈϵÄÅäÖÃÎļþ£¨Ä¬ÈÏΪ `[default]` £©£¬Èç¹ûûÓÐÉèÖûµÄÅäÖÃÎļþ£¬¾Í»áʹÓÃÕâЩÅäÖÃÎļþ¡£ »»¾ä»°Ëµ£¬Èç¹ûûÓÐÃ÷È·¼¤»îµÄÅäÖÃÎļþ£¬ÄÇô¾Í»á¿¼ÂÇÀ´×Ô `application-default` µÄÊôÐÔ¡£ +`Environment` 有一组默认的é…�置文件(默认为 `[default]` ),如果没有设置活动的é…�置文件,就会使用这些é…�置文件。 æ�¢å�¥è¯�说,如果没有明确激活的é…�置文件,那么就会考虑æ�¥è‡ª `application-default` 的属性。 -| | ÊôÐÔÎļþÖ»±»¼ÓÔØÒ»´Î¡£ Èç¹ûÄãÒѾ­Ö±½Ó[µ¼ÈëÁË](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing)Ò»¸öÅäÖÃÎļþµÄÌØ¶¨ÊôÐÔÎļþ£¬ÄÇôËü½«²»»á±»µÚ¶þ´Îµ¼Èë¡£ | +| | 属性文件å�ªè¢«åŠ è½½ä¸€æ¬¡ã€‚ 如果你已ç»�直接[导入了](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing)一个é…�置文件的特定属性文件,那么它将ä¸�会被第二次导入。 | | --- | --- | @@ -783,17 +783,17 @@ $ java -jar myproject.jar --spring.config.location=\ -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing)2.3.4\. µ¼Èë¶îÍâµÄÊý¾Ý +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing)2.3.4\. 导入é¢�外的数æ�® -application properties ÖпÉÒÔʹÓà `spring.config.import` ÊôÐÔ´ÓÆäËûµØ·½µ¼Èë¸ü¶àµÄÅäÖÃÊý¾Ý¡£ µ¼ÈëÔÚ±»·¢ÏÖʱ±»´¦Àí£¬²¢±»ÊÓΪ½ô½Ó×ÅÉùÃ÷µ¼ÈëµÄÎļþÏÂÃæ²åÈëµÄ¶îÍâÎļþ¡£ +application properties 中å�¯ä»¥ä½¿ç”¨ `spring.config.import` 属性从其他地方导入更多的é…�置数æ�®ã€‚ 导入在被å�‘现时被处ç�†ï¼Œå¹¶è¢«è§†ä¸ºç´§æŽ¥ç�€å£°æ˜Žå¯¼å…¥çš„æ–‡ä»¶ä¸‹é�¢æ�’入的é¢�外文件。 -ÀýÈ磬Äã¿ÉÄÜÔÚÄãµÄ classpath `application.properties` ÎļþÖÐÓÐÒÔÏÂÄÚÈÝ¡£ +例如,你å�¯èƒ½åœ¨ä½ çš„ classpath `application.properties` 文件中有以下内容。 @@ -821,13 +821,13 @@ spring.config.import=optional:file:./dev.properties -Õ⽫´¥·¢µ¼È뵱ǰĿ¼Ï嵀 `dev.properties` Îļþ£¨Èç¹û´æÔÚÕâÑùµÄÎļþ£©¡£ µ¼ÈëµÄ `dev.properties` ÖеÄÖµ½«ÓÅÏÈÓÚ´¥·¢µ¼ÈëµÄÎļþ¡£ ÔÚÉÏÃæµÄÀý×ÓÖУ¬`dev.properties` ¿ÉÒÔ½« `spring.application.name` ÖØÐ¶¨ÒåΪһ¸ö²»Í¬µÄÖµ¡£ +这将触å�‘导入当å‰�目录下的 `dev.properties` 文件(如果存在这样的文件)。 导入的 `dev.properties` 中的值将优先于触å�‘导入的文件。 在上é�¢çš„例å­�中,`dev.properties` å�¯ä»¥å°† `spring.application.name` é‡�新定义为一个ä¸�å�Œçš„值。 -Ò»¸öµ¼ÈëÖ»»á±»µ¼ÈëÒ»´Î£¬ÎÞÂÛËü±»ÉùÃ÷¶àÉٴΡ£ Ò»¸öµ¼ÈëÔÚproperties/yamlÎļþÄڵĵ¥¸öÎļþÖб»¶¨ÒåµÄ˳Ðò²¢²»ÖØÒª¡£ ÀýÈ磬ÏÂÃæµÄÁ½¸öÀý×Ó²úÉúÏàͬµÄ½á¹û¡£ +一个导入å�ªä¼šè¢«å¯¼å…¥ä¸€æ¬¡ï¼Œæ— è®ºå®ƒè¢«å£°æ˜Žå¤šå°‘次。 一个导入在properties/yaml文件内的å�•个文件中被定义的顺åº�å¹¶ä¸�é‡�è¦�。 例如,下é�¢çš„两个例å­�产生相å�Œçš„结果。 @@ -877,26 +877,26 @@ spring.config.import=my.properties -ÔÚÉÏÊöÁ½¸öÀý×ÓÖУ¬`my.properties` ÎļþµÄÖµ½«ÓÅÏÈÓÚ´¥·¢Æäµ¼ÈëµÄÎļþ¡£ +在上述两个例å­�中,`my.properties` 文件的值将优先于触å�‘其导入的文件。 -ÔÚÒ»¸öµ¥Ò»µÄ `spring.config.import` ÊôÐÔÏ¿ÉÒÔÖ¸¶¨¶à¸öλÖᣠλÖý«°´ÕÕËüÃDZ»¶¨ÒåµÄ˳Ðò±»´¦Àí£¬ºóÀ´µÄµ¼È뽫±»ÓÅÏÈ´¦Àí¡£ +在一个å�•一的 `spring.config.import` 属性下å�¯ä»¥æŒ‡å®šå¤šä¸ªä½�置。 ä½�置将按照它们被定义的顺åº�被处ç�†ï¼Œå�Žæ�¥çš„导入将被优先处ç�†ã€‚ -| | ÔÚÊʵ±µÄʱºò£¬[ÌØ¶¨ÅäÖÃÎļþµÄ±äÌå](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)Ò²±»¿¼Âǵ¼Èë¡£ ÉÏÃæµÄÀý×Ó½«µ¼Èë `my.properties` ÒÔ¼°ÈκΠ`my-.properties` ±äÌå¡£ | +| | 在适当的时候,[特定é…�置文件的å�˜ä½“](https://springdoc.cn/spring-boot/features.html#features.external-config.files.profile-specific)也被考虑导入。 上é�¢çš„例å­�将导入 `my.properties` 以å�Šä»»ä½• `my-.properties` å�˜ä½“。 | | --- | --- | -| | Spring Boot ÌṩÁ˿ɲå°ÎµÄAPI£¨²å¼þ£©£¬ÔÊÐíÖ§³Ö¸÷ÖÖ²»Í¬µÄλÖõØÖ·¡£ ĬÈÏÇé¿öÏ£¬Äã¿ÉÒÔµ¼ÈëJava Properties¡¢YAMLºÍ ¡°[ÅäÖÃÊ÷](https://springdoc.cn/spring-boot/features.html#features.external-config.files.configtree)¡± ¡£µÚÈý·½jar¿ÉÒÔÌṩ¶ÔÆäËû¼¼ÊõµÄÖ§³Ö£¨²»ÒªÇó±ØÐëÊDZ¾µØÎļþ£©¡£ ÀýÈ磬Äã¿ÉÒÔÏëÏóÅäÖÃÊý¾ÝÀ´×ÔÍⲿ´æ´¢£¬ÈçConsul¡¢Apache ZooKeeper»òNetflix Archaius£¨°üÀ¨Nacos£©¡£Èç¹ûÄãÏëÖ§³ÖÄã×Ô¼ºµÄλÖã¨ÊµÏÖ×Ô¼º¶¨ÒåµÄÅäÖüÓÔØ£©£¬Çë²ÎÔÄ `org.springframework.boot.context.config` °üÖÐµÄ `ConfigDataLocationResolver` ºÍ `ConfigDataLoader` Àà¡£ | +| | Spring Boot æ��供了å�¯æ�’拔的API(æ�’件),å…�许支æŒ�å�„ç§�ä¸�å�Œçš„ä½�置地å�€ã€‚ 默认情况下,你å�¯ä»¥å¯¼å…¥Java Propertiesã€�YAMLå’Œ “[é…�置树](https://springdoc.cn/spring-boot/features.html#features.external-config.files.configtree)â€� 。第三方jarå�¯ä»¥æ��供对其他技术的支æŒ�(ä¸�è¦�求必须是本地文件)。 例如,你å�¯ä»¥æƒ³è±¡é…�置数æ�®æ�¥è‡ªå¤–部存储,如Consulã€�Apache ZooKeeper或Netflix Archaius(包括Nacos)。如果你想支æŒ�你自己的ä½�置(实现自己定义的é…�置加载),请å�‚阅 `org.springframework.boot.context.config` 包中的 `ConfigDataLocationResolver` å’Œ `ConfigDataLoader` 类。 | | --- | --- | @@ -905,17 +905,17 @@ spring.config.import=my.properties -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing-extensionless)2.3.5\. µ¼ÈëÎÞÀ©Õ¹ÃûµÄÎļþ +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing-extensionless)2.3.5\. 导入无扩展å��的文件 -ÓÐÐ©ÔÆÆ½Ì¨²»ÄÜΪ¾í×°Îļþ£¨volume mounted files£©Ìí¼ÓÎļþÀ©Õ¹Ãû¡£ Òªµ¼ÈëÕâЩÎÞÀ©Õ¹ÃûµÄÎļþ£¬ÄãÐèÒª¸øSpring BootÒ»¸öÌáʾ£¬ÒÔ±ãËüÖªµÀÈçºÎ¼ÓÔØËüÃÇ¡£ Äã¿ÉÒÔͨ¹ý°ÑÀ©Õ¹ÃûÌáʾ·ÅÔÚ·½À¨ºÅÀïÀ´×öµ½ÕâÒ»µã¡£ +有些云平å�°ä¸�能为å�·è£…文件(volume mounted files)添加文件扩展å��。 è¦�导入这些无扩展å��的文件,你需è¦�ç»™Spring Boot一个æ��示,以便它知é�“如何加载它们。 ä½ å�¯ä»¥é€šè¿‡æŠŠæ‰©å±•å��æ��示放在方括å�·é‡Œæ�¥å�šåˆ°è¿™ä¸€ç‚¹ã€‚ -ÀýÈ磬¼ÙÉèÄãÓÐÒ»¸ö `/etc/config/myconfig` Îļþ£¬ÄãÏ£ÍûÒÔyamlÐÎʽµ¼Èë¡£ Äã¿ÉÒÔÓÃÏÂÃæµÄ·½·¨´ÓÄãµÄ `application.properties` Öе¼ÈëËü¡£ +例如,å�‡è®¾ä½ æœ‰ä¸€ä¸ª `/etc/config/myconfig` 文件,你希望以yamlå½¢å¼�导入。 ä½ å�¯ä»¥ç”¨ä¸‹é�¢çš„æ–¹æ³•从你的 `application.properties` 中导入它。 @@ -944,43 +944,43 @@ spring.config.import=file:/etc/config/myconfig[.yaml] -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.configtree)2.3.6\. ʹÓÃÅäÖÃÊ÷£¨Configuration Trees£© +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.configtree)2.3.6\. 使用é…�置树(Configuration Trees) -µ±ÔÚÔÆÆ½Ì¨£¨ÈçKubernetes£©ÉÏÔËÐÐÓ¦ÓóÌÐòʱ£¬Äã¾­³£ÐèÒª¶Áȡƽ̨ÌṩµÄÅäÖÃÖµ¡£ ½«»·¾³±äÁ¿ÓÃÓÚ´ËÀàÄ¿µÄ²¢²»ÉÙ¼û£¬µ«Õâ¿ÉÄÜÓÐȱµã£¬ÌرðÊÇÈç¹û¸ÃÖµÊÇ secret µÄ¡£ +当在云平å�°ï¼ˆå¦‚Kubernetes)上è¿�行应用程åº�时,你ç»�常需è¦�读å�–å¹³å�°æ��供的é…�置值。 将环境å�˜é‡�用于此类目的并ä¸�å°‘è§�,但这å�¯èƒ½æœ‰ç¼ºç‚¹ï¼Œç‰¹åˆ«æ˜¯å¦‚果该值是 secret 的。 -×÷Ϊ»·¾³±äÁ¿µÄÌæ´ú·½°¸£¬Ðí¶àÔÆÆ½Ì¨ÏÖÔÚÔÊÐíÄ㽫ÅäÖÃÓ³Éäµ½¹ÒÔØµÄÊý¾Ý¾í¡£ ÀýÈ磬Kubernetes ¿ÉÒÔ¾í¹ÒÔØ [`ConfigMaps`](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap) ºÍ [`Secrets`](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod)¡£ +作为环境å�˜é‡�的替代方案,许多云平å�°çŽ°åœ¨å…�许你将é…�置映射到挂载的数æ�®å�·ã€‚ 例如,Kubernetes å�¯ä»¥å�·æŒ‚è½½ [`ConfigMaps`](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap) å’Œ [`Secrets`](https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod)。 -¿ÉÒÔʹÓÃÁ½ÖÖ³£¼ûµÄ volume ¹ÒÔØÄ£Ê½£º +å�¯ä»¥ä½¿ç”¨ä¸¤ç§�常è§�çš„ volume 挂载模å¼�: -1. Ò»¸öÎļþ°üº¬Ò»Ì×ÍêÕûµÄÊôÐÔ£¨Í¨³£Ð´³ÉYAML£©¡£ +1. 一个文件包å�«ä¸€å¥—完整的属性(通常写æˆ�YAML)。 -2. ¶à¸öÎļþ±»Ð´ÈëÒ»¸öĿ¼Ê÷ÖУ¬ÎļþÃû³ÉΪ ¡®key¡¯£¬ÄÚÈݳÉΪ ¡®value¡¯¡£ +2. 多个文件被写入一个目录树中,文件å��æˆ�为 ‘key’,内容æˆ�为 ‘value’。 -¶ÔÓÚµÚÒ»ÖÖÇé¿ö£¬Äã¿ÉÒÔʹÓà `spring.config.import` Ö±½Óµ¼ÈëYAML»òÊôÐÔÎļþ£¬[ÈçÉÏËùÊö](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing)¡£ ¶ÔÓÚµÚ¶þÖÖÇé¿ö£¬ÄãÐèҪʹÓà `configtree:` ǰ׺£¬ÒÔ±ãSpring BootÖªµÀËüÐèÒª½«ËùÓÐÎļþ×÷ΪÊôÐÔ¹«¿ª¡£ +对于第一ç§�情况,你å�¯ä»¥ä½¿ç”¨ `spring.config.import` 直接导入YAML或属性文件,[如上所述](https://springdoc.cn/spring-boot/features.html#features.external-config.files.importing)。 对于第二ç§�情况,你需è¦�使用 `configtree:` å‰�缀,以便Spring Boot知é�“它需è¦�将所有文件作为属性公开。 -¾Ù¸öÀý×Ó£¬ÈÃÎÒÃÇÏëÏóһϣ¬KubernetesÒѾ­¹ÒÔØÁËÒÔÏÂvolume¡£ +举个例å­�,让我们想象一下,Kuberneteså·²ç»�挂载了以下volume。 @@ -1000,13 +1000,13 @@ spring.config.import=file:/etc/config/myconfig[.yaml] -`username` ÎļþµÄÄÚÈݽ«ÊÇÒ»¸öÅäÖÃÖµ£¬¶ø `password` µÄÄÚÈݽ«ÊÇÒ»¸ö secret¡£ +`username` 文件的内容将是一个é…�置值,而 `password` 的内容将是一个 secret。 -Òªµ¼ÈëÕâЩÊôÐÔ£¬Äã¿ÉÒÔÔÚÄãµÄ `application.properties` »ò `application.yaml` ÎļþÖÐÌí¼ÓÒÔÏÂÄÚÈÝ¡£ +è¦�导入这些属性,你å�¯ä»¥åœ¨ä½ çš„ `application.properties` 或 `application.yaml` 文件中添加以下内容。 @@ -1033,40 +1033,40 @@ spring.config.import=optional:configtree:/etc/config/ -È»ºóÄã¿ÉÒÔ´Ó `Environment` ÖÐÒÔ³£¹æ·½Ê½·ÃÎÊ»ò×¢Èë `myapp.username` ºÍ `myapp.password` ÊôÐÔ¡£ +ç„¶å�Žä½ å�¯ä»¥ä»Ž `Environment` 中以常规方å¼�访问或注入 `myapp.username` å’Œ `myapp.password` 属性。 -| | ÅäÖÃÊ÷ϵÄÎļþ¼Ð¹¹³ÉÁËÊôÐÔÃû³Æ¡£ ÔÚÉÏÃæµÄÀý×ÓÖУ¬ÎªÁË·ÃÎÊÊôÐÔΪ `username` ºÍ `password`£¬Äã¿ÉÒÔ½« `spring.config.import` ÉèÖÃΪ `optional:configtree:/etc/config/myapp` ¡£ | +| | é…�置树下的文件夹构æˆ�了属性å��称。 在上é�¢çš„例å­�中,为了访问属性为 `username` å’Œ `password`,你å�¯ä»¥å°† `spring.config.import` 设置为 `optional:configtree:/etc/config/myapp` 。 | | --- | --- | -| | ´øÓеã·ûºÅµÄÎļþÃûÒ²»á±»ÕýÈ·Ó³Éä¡£ ÀýÈ磬ÔÚÉÏÃæµÄÀý×ÓÖУ¬`/etc/config` ÖÐÃûΪ `myapp.username` µÄÎļþÔÚ `Environment` ÖеÄÊôÐÔÃû½«»áÊÇ `myapp.username` ¡£ | +| | 带有点符å�·çš„æ–‡ä»¶å��也会被正确映射。 例如,在上é�¢çš„例å­�中,`/etc/config` 中å��为 `myapp.username` 的文件在 `Environment` 中的属性å��将会是 `myapp.username` 。 | | --- | --- | -| | ÅäÖÃÊ÷µÄÖµ¿ÉÒÔ±»°ó¶¨µ½×Ö·û´® `String` ºÍ `byte[]` ÀàÐÍ£¬ÕâÈ¡¾öÓÚÔ¤ÆÚµÄÄÚÈÝ¡£ | +| | é…�置树的值å�¯ä»¥è¢«ç»‘定到字符串 `String` å’Œ `byte[]` 类型,这å�–决于预期的内容。 | | --- | --- | -Èç¹ûÄãÓжà¸öÅäÖÃÊ÷Òª´Óͬһ¸ö¸¸Îļþ¼Ðµ¼È룬Äã¿ÉÒÔʹÓÃͨÅä·û¿ì½Ý·½Ê½¡£ ÈκÎÒÔ `/*/` ½áβµÄ `configtree:` λÖý«µ¼ÈëËùÓÐÖ±½ÓµÄ×ÓÎļþ¼Ð×÷ΪÅäÖÃÊ÷¡£ +如果你有多个é…�置树è¦�从å�Œä¸€ä¸ªçˆ¶æ–‡ä»¶å¤¹å¯¼å…¥ï¼Œä½ å�¯ä»¥ä½¿ç”¨é€šé…�符快æ�·æ–¹å¼�。 任何以 `/*/` 结尾的 `configtree:` ä½�置将导入所有直接的å­�文件夹作为é…�置树。 -ÀýÈ磬¸ø¶¨ÒÔÏÂvolume£º +例如,给定以下volume: @@ -1091,7 +1091,7 @@ spring.config.import=optional:configtree:/etc/config/ -Äã¿ÉÒÔʹÓà `configtree:/etc/config/*/` ×÷Ϊµ¼ÈëλÖᣠ+ä½ å�¯ä»¥ä½¿ç”¨ `configtree:/etc/config/*/` 作为导入ä½�置。 @@ -1118,20 +1118,20 @@ spring.config.import=optional:configtree:/etc/config/*/ -Õ⽫Ìí¼Ó `db.username`¡¢`db.password`¡¢`mq.username` ºÍ `mq.password` ÊôÐÔ¡£ +这将添加 `db.username`ã€�`db.password`ã€�`mq.username` å’Œ `mq.password` 属性。 -| | ʹÓÃͨÅä·û¼ÓÔØµÄĿ¼Êǰ´×Öĸ˳ÐòÅÅÁеġ£ Èç¹ûÄãÐèÒªÒ»¸ö²»Í¬µÄ˳Ðò£¬ÄÇôÄãÓ¦¸Ã°Ñÿ¸öλÖÃ×÷Ϊһ¸öµ¥¶ÀµÄµ¼ÈëÁгö¡£ | +| | 使用通é…�符加载的目录是按字æ¯�顺åº�排列的。 如果你需è¦�一个ä¸�å�Œçš„顺åº�,那么你应该把æ¯�个ä½�置作为一个å�•独的导入列出。 | | --- | --- | -ÅäÖÃÊ÷Ò²¿ÉÓÃÓÚDocker secret¡£ µ±Docker swarm·þÎñ±»ÊÚÓè¶ÔsecretµÄ·ÃÎÊȨʱ£¬¸Ãsecret»á±»×°Ôص½ÈÝÆ÷ÖС£ ÀýÈ磬Èç¹ûÒ»¸öÃûΪ `db.password` µÄsecret¡£±»¹ÒÔØÔÚ `/run/secrets/` µÄλÖã¬Äã¿ÉÒÔÓÃÒÔÏ·½·¨Èà `db.password` ¶ÔSpring»·¾³¿ÉÓᣠ+é…�置树也å�¯ç”¨äºŽDocker secret。 当Docker swarmæœ�务被授予对secret的访问æ�ƒæ—¶ï¼Œè¯¥secret会被装载到容器中。 例如,如果一个å��为 `db.password` çš„secret。被挂载在 `/run/secrets/` çš„ä½�置,你å�¯ä»¥ç”¨ä»¥ä¸‹æ–¹æ³•让 `db.password` 对Spring环境å�¯ç”¨ã€‚ @@ -1160,17 +1160,17 @@ spring.config.import=optional:configtree:/run/secrets/ -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.property-placeholders)2.3.7\. ÊôÐÔռλ·û +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.property-placeholders)2.3.7\. 属性å� ä½�符 -`application.properties` ºÍ `application.yml` ÖеÄÖµÔÚʹÓÃʱͨ¹ýÏÖÓÐµÄ `Environment` ¹ýÂË£¬ËùÒÔÄã¿ÉÒԲο¼ÒÔǰ¶¨ÒåµÄÖµ£¨ÀýÈ磬À´×ÔϵͳÊôÐÔ»ò»·¾³±äÁ¿£©¡£ ±ê×¼µÄ `${name}` ÊôÐÔռλ·ûÓï·¨¿ÉÒÔÓÃÔÚÒ»¸öÖµµÄÈκεط½¡£ ÊôÐÔռλ·ûÒ²¿ÉÒÔÖ¸¶¨Ò»¸öĬÈÏÖµ£¬Ê¹Óà `:` À´·Ö¸ôĬÈÏÖµºÍÊôÐÔÃû³Æ£¬ÀýÈç `${name:default}` ¡£ +`application.properties` å’Œ `application.yml` 中的值在使用时通过现有的 `Environment` 过滤,所以你å�¯ä»¥å�‚考以å‰�定义的值(例如,æ�¥è‡ªç³»ç»Ÿå±žæ€§æˆ–环境å�˜é‡�)。 标准的 `${name}` 属性å� ä½�符语法å�¯ä»¥ç”¨åœ¨ä¸€ä¸ªå€¼çš„任何地方。 属性å� ä½�符也å�¯ä»¥æŒ‡å®šä¸€ä¸ªé»˜è®¤å€¼ï¼Œä½¿ç”¨ `:` æ�¥åˆ†éš”默认值和属性å��称,例如 `${name:default}` 。 -ÏÂÃæµÄÀý×ÓÏÔʾÁË´øÄ¬ÈÏÖµºÍ²»´øÄ¬ÈÏÖµµÄռλ·ûµÄʹÓÃÇé¿ö¡£ +下é�¢çš„例å­�显示了带默认值和ä¸�带默认值的å� ä½�符的使用情况。 @@ -1198,20 +1198,20 @@ app.description=${app.name} is a Spring Boot application written by ${username:U -¼ÙÉè `username` ÊôÐÔûÓÐÔÚÆäËûµØ·½ÉèÖã¬`app.description` µÄÖµ½«ÊÇ `MyApp is a Spring Boot application written by Unknown`¡£ +å�‡è®¾ `username` 属性没有在其他地方设置,`app.description` 的值将是 `MyApp is a Spring Boot application written by Unknown`。 -| | ÄãÓ¦¸ÃʼÖÕʹÓÃռλ·ûÖеÄÊôÐÔÃû³ÆµÄ¹æ·¶ÐÎʽ£¨½öʹÓÃСд×ÖĸµÄkebab-case£©À´ÒýÓÃËüÃÇ¡£ Õ⽫ÔÊÐíSpring BootʹÓÃÓë[¿íËɰó¶¨](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) `@ConfigurationProperties` ʱÏàͬµÄÂß¼­¡£ÀýÈ磬`${demo.item-price}` ½«´Ó `application.properties` ÎļþÖлñÈ¡ `demo.item-price` ºÍ `demo.itemPrice` ÐÎʽµÄÊôÐÔ£¬ÒÔ¼°´Óϵͳ»·¾³ÖлñÈ¡ `DEMO_ITEMPRICE` ¡£ Èç¹ûÄãÓà `${demo.itemPrice}` µÄ»°£¬ `demo.item-price` ºÍ `DEMO_ITEMPRICE` ¾Í²»»á±»¿¼ÂÇ¡£ | +| | 你应该始终使用å� ä½�符中的属性å��称的规范形å¼�(仅使用å°�写字æ¯�çš„kebab-case)æ�¥å¼•用它们。 这将å…�许Spring Boot使用与[宽æ�¾ç»‘定](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) `@ConfigurationProperties` 时相å�Œçš„逻辑。例如,`${demo.item-price}` 将从 `application.properties` 文件中获å�– `demo.item-price` å’Œ `demo.itemPrice` å½¢å¼�的属性,以å�Šä»Žç³»ç»ŸçŽ¯å¢ƒä¸­èŽ·å�– `DEMO_ITEMPRICE` 。 如果你用 `${demo.itemPrice}` çš„è¯�, `demo.item-price` å’Œ `DEMO_ITEMPRICE` å°±ä¸�会被考虑。 | | --- | --- | -| | ÄãÒ²¿ÉÒÔʹÓÃÕâÖÖ¼¼ÊõÀ´´´½¨ÏÖÓÐSpring BootÊôÐ﵀ ¡°short¡± ±äÌå¡£ ÏêÇéÇë²Î¼û_[howto.html](https://springdoc.cn/spring-boot/howto.html#howto.properties-and-configuration.short-command-line-arguments)_µÄ·½·¨¡£ | +| | 你也å�¯ä»¥ä½¿ç”¨è¿™ç§�技术æ�¥åˆ›å»ºçŽ°æœ‰Spring Boot属性的 “shortâ€� å�˜ä½“。 详情请å�‚è§�_[howto.html](https://springdoc.cn/spring-boot/howto.html#howto.properties-and-configuration.short-command-line-arguments)_的方法。 | | --- | --- | @@ -1220,23 +1220,23 @@ app.description=${app.name} is a Spring Boot application written by ${username:U -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.multi-document)2.3.8\. ʹÓöàÎĵµÎļþ£¨Working with Multi-Document Files£© +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.multi-document)2.3.8\. 使用多文档文件(Working with Multi-Document Files) -Spring BootÔÊÐíÄ㽫һ¸öÎïÀíÎļþ·Ö³É¶à¸öÂß¼­Îļþ£¬Ã¿¸öÎļþ¶¼ÊǶÀÁ¢Ìí¼ÓµÄ¡£ ÎļþÊǰ´Ë³Ðò´¦ÀíµÄ£¬´ÓÉϵ½Ï¡£ ºóÃæµÄÎļþ¿ÉÒÔ¸²¸ÇÇ°ÃæÎļþÖж¨ÒåµÄÊôÐÔ¡£ +Spring Bootå…�许你将一个物ç�†æ–‡ä»¶åˆ†æˆ�多个逻辑文件,æ¯�个文件都是独立添加的。 文件是按顺åº�处ç�†çš„,从上到下。 å�Žé�¢çš„æ–‡ä»¶å�¯ä»¥è¦†ç›–å‰�é�¢æ–‡ä»¶ä¸­å®šä¹‰çš„属性。 -¶ÔÓÚ `application.yml` Îļþ£¬Ê¹Óñê×¼µÄYAML¶àÎĵµÓï·¨¡£ Èý¸öÁ¬ÐøµÄÁ¬×Ö·û£¨`---`£©´ú±íÒ»¸öÎļþµÄ½áÊø£¬ºÍÏÂÒ»¸öÎļþµÄ¿ªÊ¼¡£ +对于 `application.yml` 文件,使用标准的YAML多文档语法。 三个连续的连字符(`---`)代表一个文件的结æ�Ÿï¼Œå’Œä¸‹ä¸€ä¸ªæ–‡ä»¶çš„开始。 -ÀýÈ磬ÏÂÃæµÄÎļþÓÐÁ½¸öÂß¼­Îĵµ¡£ +例如,下é�¢çš„æ–‡ä»¶æœ‰ä¸¤ä¸ªé€»è¾‘文档。 @@ -1263,7 +1263,7 @@ spring: -¶ÔÓÚ `application.properties` Îļþ£¬Ò»¸öÌØÊâµÄ `#---` »ò `!---` ×¢Êͱ»ÓÃÀ´±ê¼ÇÎļþµÄ·Ö¸î¡£ +对于 `application.properties` 文件,一个特殊的 `#---` 或 `!---` 注释被用æ�¥æ ‡è®°æ–‡ä»¶çš„分割。 @@ -1284,21 +1284,21 @@ spring.config.activate.on-cloud-platform=kubernetes -| | properties ÎļþµÄ·Ö¸ô·û²»ÄÜÓÐÈκÎǰµ¼¿Õ°×£¬²¢ÇÒ±ØÐëÕýºÃÓÐÈý¸öÁ¬×Ö·û¡£ ·Ö¸ô·ûµÄǰºóÁ½Ðв»ÄÜÊÇÏàͬµÄ×¢ÊÍǰ׺¡£ | +| | properties 文件的分隔符ä¸�能有任何å‰�导空白,并且必须正好有三个连字符。 分隔符的å‰�å�Žä¸¤è¡Œä¸�能是相å�Œçš„æ³¨é‡Šå‰�缀。 | | --- | --- | -| | ¶àÎĵµÊôÐÔÎļþͨ³£Ó뼤»îÊôÐÔÒ»ÆðʹÓã¬Èç `spring.config.activated.on-profile`¡£ Ïê¼û[ÏÂÒ»½Ú](https://springdoc.cn/spring-boot/features.html#features.external-config.files.activation-properties)¡£ | +| | 多文档属性文件通常与激活属性一起使用,如 `spring.config.activated.on-profile`。 详è§�[下一节](https://springdoc.cn/spring-boot/features.html#features.external-config.files.activation-properties)。 | | --- | --- | -| | ¶àÎĵµÊôÐÔÎļþ²»ÄÜͨ¹ýʹÓà `@PropertySource` »ò `@TestPropertySource` ×¢½â¼ÓÔØ¡£ | +| | 多文档属性文件ä¸�能通过使用 `@PropertySource` 或 `@TestPropertySource` 注解加载。 | | --- | --- | @@ -1307,35 +1307,35 @@ spring.config.activate.on-cloud-platform=kubernetes -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.activation-properties)2.3.9\. ¼¤»îÊôÐÔ£¨Activation Properties£© +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.files.activation-properties)2.3.9\. 激活属性(Activation Properties) -ÓÐʱ£¬Ö»ÔÚÂú×ãijЩÌõ¼þʱ¼¤»îÒ»×éÌØ¶¨µÄÊôÐÔÊǺÜÓÐÓõġ£ ÀýÈ磬Äã¿ÉÄÜÓÐһЩÊôÐÔÖ»ÓÐÔÚÌØ¶¨µÄÅäÖÃÎļþ±»¼¤»îʱ²ÅÏà¹Ø¡£ +有时,å�ªåœ¨æ»¡è¶³æŸ�些æ�¡ä»¶æ—¶æ¿€æ´»ä¸€ç»„特定的属性是很有用的。 例如,你å�¯èƒ½æœ‰ä¸€äº›å±žæ€§å�ªæœ‰åœ¨ç‰¹å®šçš„é…�置文件被激活时æ‰�相关。 -Äã¿ÉÒÔʹÓà `spring.config.activation.*` ÓÐÌõ¼þµØ¼¤»îÒ»¸öÊôÐÔÎļþ¡£ +ä½ å�¯ä»¥ä½¿ç”¨ `spring.config.activation.*` 有æ�¡ä»¶åœ°æ¿€æ´»ä¸€ä¸ªå±žæ€§æ–‡ä»¶ã€‚ -¼¤»îÊôÐÔÓÐÈçÏ¡£ +激活属性有如下。 Table 2\. activation properties -| ÊôÐÔ | ˵Ã÷ | +| 属性 | 说明 | | --- | --- | -| `on-profile` | Ò»¸ö±ØÐëÓë֮ƥÅäµÄÅäÖÃÎļþ±í´ïʽ£¬ÒÔʹÎļþ´¦Óڻ״̬£¨¼¤»îÖ¸¶¨µÄÅäÖÃÎļþʱÓÐЧ£©¡£ | -| `on-cloud-platform` | ±ØÐë¼ì²âµ½µÄ `CloudPlatform`£¬ÒÔʹÎļþ´¦Óڻ״̬¡££¨ÔÆÆ½Ì¨×´Ì¬ÏÂÓÐЧ£© | +| `on-profile` | 一个必须与之匹é…�çš„é…�置文件表达å¼�,以使文件处于活动状æ€�(激活指定的é…�置文件时有效)。 | +| `on-cloud-platform` | 必须检测到的 `CloudPlatform`,以使文件处于活动状æ€�。(云平å�°çжæ€�下有效) | -ÀýÈ磬ÏÂÃæÖ¸¶¨µÚ¶þ¸öÎļþÖ»ÓÐÔÚKubernetesÉÏÔËÐÐʱ²ÅÓÐЧ£¬²¢ÇÒÖ»ÓÐÔÚ ¡°prod¡± »ò ¡°staging¡± ÅäÖÃÎļþ´¦Óڻ״̬ʱ²ÅÓÐЧ¡£ +例如,下é�¢æŒ‡å®šç¬¬äºŒä¸ªæ–‡ä»¶å�ªæœ‰åœ¨Kubernetes上è¿�行时æ‰�有效,并且å�ªæœ‰åœ¨ “prodâ€� 或 “stagingâ€� é…�置文件处于活动状æ€�æ—¶æ‰�有效。 @@ -1370,17 +1370,17 @@ myotherprop=sometimes-set -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.encrypting)2.4\. ¼ÓÃÜÅäÖÃÊôÐÔ£¨Encrypting Properties£© +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.encrypting)2.4\. 加密é…�置属性(Encrypting Properties) -Spring BootûÓÐΪ¼ÓÃÜÊôÐÔÖµÌṩÈκÎÄÚÖÃÖ§³Ö£¬µ«ËüÌṩÁËHookm£¬¿ÉÒÔÓÃÀ´ÐÞ¸ÄSpring `Environment` Öаüº¬µÄÖµ¡£ `EnvironmentPostProcessor` ½Ó¿ÚÔÊÐíÄãÔÚÓ¦ÓóÌÐòÆô¶¯Ç°²Ù×÷ `Environment`¡£ ²Î¼û[howto.html](https://springdoc.cn/spring-boot/howto.html#howto.application.customize-the-environment-or-application-context)ÒÔÁ˽âÏêÇé¡£ +Spring Boot没有为加密属性值æ��供任何内置支æŒ�,但它æ��供了Hookm,å�¯ä»¥ç”¨æ�¥ä¿®æ”¹Spring `Environment` 中包å�«çš„值。 `EnvironmentPostProcessor` 接å�£å…�许你在应用程åº�å�¯åЍå‰�æ“�作 `Environment`。 å�‚è§�[howto.html](https://springdoc.cn/spring-boot/howto.html#howto.application.customize-the-environment-or-application-context)以了解详情。 -Èç¹ûÄãÐèÒªÒ»ÖÖ°²È«µÄ·½Ê½À´´æ´¢Æ¾Ö¤ºÍÃÜÂ룬 [Spring Cloud Vault](https://cloud.spring.io/spring-cloud-vault/) ÏîÄ¿ÌṩÁ˶ÔÔÚ [HashiCorp Vault](https://www.vaultproject.io/)Öд洢Íⲿ»¯ÅäÖõÄÖ§³Ö¡£ +如果你需è¦�一ç§�安全的方å¼�æ�¥å­˜å‚¨å‡­è¯�和密ç �, [Spring Cloud Vault](https://cloud.spring.io/spring-cloud-vault/) 项目æ��供了对在 [HashiCorp Vault](https://www.vaultproject.io/)中存储外部化é…�置的支æŒ�。 @@ -1388,28 +1388,28 @@ Spring Bootû -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.yaml)2.5\. ʹÓà YAML +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.yaml)2.5\. 使用 YAML -[YAML](https://yaml.org/) ÊÇJSONµÄ³¬¼¯£¬Òò´ËÊÇÖ¸¶¨·Ö²ãÅäÖÃÊý¾ÝµÄ·½±ã¸ñʽ¡£ Ö»ÒªÄãµÄclasspathÉÏÓÐ [SnakeYAML](https://github.com/snakeyaml/snakeyaml) ¿â£¬`SpringApplication` Àà¾Í»á×Ô¶¯Ö§³ÖYAML×÷ΪpropertiesµÄÌæ´úÆ·¡£ +[YAML](https://yaml.org/) 是JSON的超集,因此是指定分层é…�置数æ�®çš„æ–¹ä¾¿æ ¼å¼�。 å�ªè¦�ä½ çš„classpath上有 [SnakeYAML](https://github.com/snakeyaml/snakeyaml) 库,`SpringApplication` 类就会自动支æŒ�YAML作为properties的替代å“�。 -| | Èç¹ûÄãʹÓà ¡°Starter¡±£¬SnakeYAML½«ÓÉ `spring-boot-starter` ×Ô¶¯Ìṩ¡£ | +| | 如果你使用 “Starterâ€�,SnakeYAML将由 `spring-boot-starter` 自动æ��供。 | | --- | --- | -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.yaml.mapping-to-properties)2.5.1\. ½«YAMLÓ³Éäµ½Properties +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.yaml.mapping-to-properties)2.5.1\. å°†YAML映射到Properties -YAML ÎĵµÐèÒª´ÓÆä·Ö²ã¸ñʽת»»Îª¿ÉÓë Spring `Environment` Ò»ÆðʹÓÃµÄ±âÆ½½á¹¹¡£ ÀýÈ磬¿¼ÂÇÏÂÃæÕâ¸öYAMLÎĵµ¡£ +YAML 文档需è¦�从其分层格å¼�转æ�¢ä¸ºå�¯ä¸Ž Spring `Environment` 一起使用的æ‰�平结构。 例如,考虑下é�¢è¿™ä¸ªYAML文档。 @@ -1433,7 +1433,7 @@ environments: -ΪÁË´Ó `Environment` ÖзÃÎÊÕâЩÊôÐÔ£¬ËüÃǽ«±»±âƽ»¯£¬ÈçÏÂËùʾ¡£ +为了从 `Environment` 中访问这些属性,它们将被æ‰�平化,如下所示。 @@ -1454,7 +1454,7 @@ environments.prod.name=My Cool App -ͬÑùµØ£¬YAMLÖеÄÁбíÒ²ÐèÒª½øÐÐ±âÆ½»¯´¦Àí¡£ ËüÃDZ»±íʾΪ´øÓÐ `[index]` Ë÷ÒýµÄkey¡£ ÀýÈ磬¿¼ÂÇÏÂÃæµÄYAML¡£ +å�Œæ ·åœ°ï¼ŒYAML中的列表也需è¦�进行æ‰�平化处ç�†ã€‚ 它们被表示为带有 `[index]` 索引的key。 例如,考虑下é�¢çš„YAML。 @@ -1475,7 +1475,7 @@ my: -Ç°ÃæµÄÀý×Ó½«±»×ª»¯ÎªÈçÏÂÊôÐÔ¡£ +å‰�é�¢çš„例å­�将被转化为如下属性。 @@ -1494,14 +1494,14 @@ my.servers[1]=another.example.com -| | ʹÓà `[index]` ·ûºÅµÄÊôÐÔ¿ÉÒÔʹÓÃSpring BootµÄ `Binder` Àà°ó¶¨µ½Java `List` »ò `Set` ¶ÔÏó¡£ ¸ü¶àϸ½Ú¼ûÏÂÃæµÄ ¡°[ÀàÐͰ²È«µÄÅäÖÃÊôÐÔ](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties)¡± ²¿·Ö¡£ | +| | 使用 `[index]` 符å�·çš„属性å�¯ä»¥ä½¿ç”¨Spring Bootçš„ `Binder` 类绑定到Java `List` 或 `Set` 对象。 更多细节è§�下é�¢çš„ “[类型安全的é…�置属性](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties)â€� 部分。 | | --- | --- | -| | YAMLÎļþ²»ÄÜͨ¹ýʹÓà `@PropertySource` »ò `@TestPropertySource` ×¢½âÀ´¼ÓÔØ¡£ ËùÒÔ£¬ÔÚÄãÐèÒªÒÔÕâÖÖ·½Ê½¼ÓÔØÖµµÄÇé¿öÏ£¬ÄãÐèҪʹÓÃÒ»¸ö properties Îļþ¡£ | +| | YAML文件ä¸�能通过使用 `@PropertySource` 或 `@TestPropertySource` 注解æ�¥åŠ è½½ã€‚ 所以,在你需è¦�以这ç§�æ–¹å¼�加载值的情况下,你需è¦�使用一个 properties 文件。 | | --- | --- | @@ -1510,17 +1510,17 @@ my.servers[1]=another.example.com -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.yaml.directly-loading)2.5.2\. Ö±½Ó¼ÓÔØYAML +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.yaml.directly-loading)2.5.2\. 直接加载YAML -Spring FrameworkÌṩÁËÁ½¸ö·½±ãµÄÀ࣬¿ÉÒÔÓÃÀ´¼ÓÔØYAMLÎĵµ¡£ `YamlPropertiesFactoryBean` ½«YAML×÷Ϊ `Properties` ¼ÓÔØ£¬`YamlMapFactoryBean` ½«YAML×÷Ϊ `Map` ¼ÓÔØ¡£ +Spring Frameworkæ��供了两个方便的类,å�¯ä»¥ç”¨æ�¥åŠ è½½YAML文档。 `YamlPropertiesFactoryBean` å°†YAML作为 `Properties` 加载,`YamlMapFactoryBean` å°†YAML作为 `Map` 加载。 -Èç¹ûÄãÏë°ÑYAML¼ÓÔØÎªSpringµÄ `PropertySource` £¬ÄãÒ²¿ÉÒÔʹÓà `YamlPropertySourceLoader` Àà¡£ +如果你想把YAML加载为Springçš„ `PropertySource` ,你也å�¯ä»¥ä½¿ç”¨ `YamlPropertySourceLoader` 类。 @@ -1530,7 +1530,7 @@ Spring Framework -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.random-values)2.6\. ÅäÖÃËæ»úÖµ +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.random-values)2.6\. é…�ç½®éš�机值 @@ -1540,7 +1540,7 @@ The `RandomValuePropertySource` is useful for injecting random values (for examp -`RandomValuePropertySource` ¶ÔÓÚ×¢ÈëËæ»úÖµºÜÓÐÓã¨ÀýÈ磬עÈëÃÜÂë»ò²âÊÔ°¸Àý£©¡£ Ëü¿ÉÒÔ²úÉúInteger¡¢Long¡¢UUID£¬»òString£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +`RandomValuePropertySource` 对于注入éš�机值很有用(例如,注入密ç �或测试案例)。 它å�¯ä»¥äº§ç”ŸIntegerã€�Longã€�UUID,或String,如下é�¢çš„例å­�所示。 @@ -1572,7 +1572,7 @@ my.number-in-range=${random.int[1024,65536]} -`random.int*` µÄÓï·¨ÊÇ `OPEN value (,max) CLOSE`£¬ÆäÖÐ `OPEN,CLOSE` ÊÇÈκÎ×Ö·û£¬ `value,max` ÊÇÕûÊý¡£ Èç¹ûÌṩÁË `max`£¬ÄÇô `value` ÊÇ×îСֵ£¬ `max` ÊÇ×î´óÖµ£¨¶ÀÕ¼£©¡£ +`random.int*` 的语法是 `OPEN value (,max) CLOSE`,其中 `OPEN,CLOSE` 是任何字符, `value,max` 是整数。 如果æ��供了 `max`,那么 `value` 是最å°�值, `max` 是最大值(独å� ï¼‰ã€‚ @@ -1580,17 +1580,17 @@ my.number-in-range=${random.int[1024,65536]} -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.system-environment)2.7\. ÅäÖÃϵͳ»·¾³ÊôÐÔ +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.system-environment)2.7\. é…�置系统环境属性 -Spring BootÖ§³ÖΪ»·¾³ÊôÐÔÉèÖÃÒ»¸öǰ׺¡£ Èç¹ûϵͳ»·¾³±»¶à¸ö¾ßÓв»Í¬ÅäÖÃÒªÇóµÄSpring BootÓ¦ÓóÌÐò¹²Ïí£¬Õâ¾ÍºÜÓÐÓᣠϵͳ»·¾³ÊôÐÔµÄǰ׺¿ÉÒÔÖ±½ÓÔÚ `SpringApplication` ÉÏÉèÖᣠ+Spring Boot支æŒ�为环境属性设置一个å‰�缀。 如果系统环境被多个具有ä¸�å�Œé…�ç½®è¦�求的Spring Boot应用程åº�共享,这就很有用。 系统环境属性的å‰�ç¼€å�¯ä»¥ç›´æŽ¥åœ¨ `SpringApplication` 上设置。 -ÀýÈ磬Èç¹ûÄ㽫ǰ׺ÉèÖÃΪ `input` £¬ÖîÈç `remote.timeout` ÕâÑùµÄÊôÐÔÔÚϵͳ»·¾³ÖÐÒ²½«±»½âÎöΪ `input.remote.timeout`¡£ +例如,如果你将å‰�缀设置为 `input` ,诸如 `remote.timeout` 这样的属性在系统环境中也将被解æž�为 `input.remote.timeout`。 @@ -1598,28 +1598,28 @@ Spring BootÖ§ -### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties)2.8\. ÀàÐͰ²È«µÄÅäÖÃÊôÐÔ +### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties)2.8\. 类型安全的é…�置属性 -ʹÓà `@Value("${property}")` ×¢½âÀ´×¢ÈëÅäÖÃÊôÐÔÓÐʱ»áºÜÂé·³£¬ÌرðÊǵ±ÄãÒª´¦Àí¶à¸öÊôÐÔ»òÄãµÄÊý¾ÝÊÇ·Ö²ãµÄ¡£ Spring BootÌṩÁËÒ»ÖÖ´¦ÀíÊôÐÔµÄÌæ´ú·½·¨£¬ÈÃÇ¿ÀàÐ͵ÄBean¹ÜÀíºÍÑéÖ¤ÄãµÄÓ¦ÓóÌÐòµÄÅäÖᣠ+使用 `@Value("${property}")` 注解æ�¥æ³¨å…¥é…�置属性有时会很麻烦,特别是当你è¦�处ç�†å¤šä¸ªå±žæ€§æˆ–你的数æ�®æ˜¯åˆ†å±‚的。 Spring Bootæ��供了一ç§�处ç�†å±žæ€§çš„æ›¿ä»£æ–¹æ³•,让强类型的Bean管ç�†å’ŒéªŒè¯�你的应用程åº�çš„é…�置。 -| | ÁíÇë²Î¼û[`@Value` ºÍÀàÐͰ²È«ÅäÖÃÊôÐÔÖ®¼äµÄÇø±ð](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.vs-value-annotation)¡£ | +| | å�¦è¯·å�‚è§�[`@Value` 和类型安全é…�置属性之间的区别](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.vs-value-annotation)。 | | --- | --- | -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.java-bean-binding)2.8.1\. JavaBean ÊôÐÔ°ó¶¨ +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.java-bean-binding)2.8.1\. JavaBean 属性绑定 -ÈçÏÂÃæµÄÀý×ÓËùʾ£¬¿ÉÒÔ°ó¶¨Ò»¸öÉùÃ÷Á˱ê×¼JavaBeanÊôÐÔµÄbean¡£ +如下é�¢çš„例å­�所示,å�¯ä»¥ç»‘定一个声明了标准JavaBean属性的bean。 @@ -1669,34 +1669,34 @@ public class MyProperties { -Ç°ÃæµÄPOJO¶¨ÒåÁËÒÔÏÂÊôÐÔ¡£ +å‰�é�¢çš„POJO定义了以下属性。 -* `my.service.enabled`£¬Ä¬ÈÏֵΪ`false`¡£ +* `my.service.enabled`,默认值为`false`。 -* `my.service.remote-address`£¬ÆäÀàÐÍ¿ÉÓÉ`String`Ç¿ÖÆÌṩ¡£ +* `my.service.remote-address`,其类型å�¯ç”±`String`强制æ��供。 -* `my.service.security.username`£¬ÓÐÒ»¸öǶÌ×µÄ `security` ¶ÔÏ󣬯äÃû³ÆÓɸÃÊôÐÔµÄÃû³Æ¾ö¶¨¡£ ÌØ±ðÊÇ£¬ÄÇÀïÍêȫûÓÐʹÓÃÀàÐÍ£¬¿ÉÒÔÊÇ `SecurityProperties`¡£ +* `my.service.security.username`,有一个嵌套的 `security` 对象,其å��称由该属性的å��称决定。 特别是,那里完全没有使用类型,å�¯ä»¥æ˜¯ `SecurityProperties`。 * `my.service.security.password`. -* `my.service.security.role`£¬ÓÐÒ»¸ö `String` µÄ¼¯ºÏ£¬Ä¬ÈÏΪ `USER`¡£ +* `my.service.security.role`,有一个 `String` 的集å�ˆï¼Œé»˜è®¤ä¸º `USER`。 -| | Ó³Éäµ½Spring BootÖпÉÓÃµÄ `@ConfigurationProperties` ÀàµÄÊôÐÔ£¬Í¨¹ýpropertiesÎļþ¡¢YAMLÎļþ¡¢»·¾³±äÁ¿ºÍÆäËû»úÖÆ½øÐÐÅäÖã¬ÕâЩÊôÐÔÊǹ«¹²API£¬µ«Àà±¾ÉíµÄ getters/setters ²¢²»Òâζ×Å¿ÉÒÔÖ±½ÓʹÓã¨Ò»¾ä»°£¬SpringÒ²ÊÇͨ¹ýgetter/setterÕâЩpublic·½·¨½øÐÐÉèÖÃÖµµÄ£¬Äã±ðÓã©¡£ | +| | 映射到Spring Boot中å�¯ç”¨çš„ `@ConfigurationProperties` 类的属性,通过properties文件ã€�YAML文件ã€�环境å�˜é‡�和其他机制进行é…�置,这些属性是公共API,但类本身的 getters/setters å¹¶ä¸�æ„�味ç�€å�¯ä»¥ç›´æŽ¥ä½¿ç”¨ï¼ˆä¸€å�¥è¯�,Spring也是通过getter/setter这些public方法进行设置值的,你别用)。 | | --- | --- | -| | ÕâÑùµÄÉè¼ÆÒÀÀµÓÚÒ»¸öĬÈϵÄÎ޲ι¹Ô캯Êý£¬getterºÍsetterͨ³£ÊDZØÐëµÄ£¬ÒòΪ°ó¶¨ÊÇͨ¹ý±ê×¼µÄJava Beans property descriptor£¨JavaÄÚÊ¡£©ÊµÏֵ쬾ÍÏñÔÚSpring MVCÖÐÒ»Ñù¡£ ÔÚÒÔÏÂÇé¿öÏ£¬¿ÉÒÔÊ¡ÂÔsetter¡£* Map, Ö»ÒªËüÃDZ»³õʼ»¯£¬¾ÍÐèÒªÒ»¸ögetter£¬µ«²»Ò»¶¨ÐèÒªÒ»¸ösetter£¬ÒòΪËüÃÇ¿ÉÒÔ±»°ó¶¨Æ÷Í»±ä¡£ * CollectionºÍarray ¿ÉÒÔͨ¹ýË÷Òý£¨Í¨³£ÓÃYAML£©»òʹÓõ¥¸ö¶ººÅ·Ö¸ôµÄÖµ£¨ÊôÐÔ£©À´·ÃÎÊ¡£ ÔÚºóÒ»ÖÖÇé¿öÏ£¬Ò»¸ösetterÊDZØÐëµÄ¡£ ÎÒÃǽ¨Òé×ÜÊÇΪÕâÀàÀàÐÍÌí¼ÓÒ»¸ösetter¡£ Èç¹ûÄã³õʼ»¯Ò»¸ö¼¯ºÏ£¬È·±£Ëü²»ÊDz»¿É±äµÄ£¨ÈçÇ°ÃæµÄÀý×Ó£©¡£ * Èç¹ûǶÌ×µÄPOJOÊôÐÔ±»³õʼ»¯£¨¾ÍÏñÇ°ÃæÀý×ÓÖÐµÄ `Security` ×ֶΣ©£¬¾Í²»ÐèÒªsetter¡£ Èç¹ûÄãÏëÈÃ°ó¶¨Æ÷ͨ¹ýʹÓÃËüµÄĬÈϹ¹Ô캯ÊýÀ´¼´Ê±´´½¨ÊµÀý£¬ÄãÐèÒªÒ»¸ösetter¡£ ÓÐЩÈËʹÓÃProject LombokÀ´×Ô¶¯Ìí¼ÓgetterºÍsetter¡£ ÇëÈ·±£Lombok²»»áΪÕâÑùµÄÀàÐÍÉú³ÉÈκÎÌØ¶¨µÄ¹¹Ô캯Êý£¬ÒòΪËü±»ÈÝÆ÷×Ô¶¯ÓÃÀ´ÊµÀý»¯¶ÔÏó¡£×îºó£¬Ö»¿¼ÂDZê×¼µÄJava BeanÊôÐÔ£¬²»Ö§³Ö¶Ô¾²Ì¬ÊôÐԵİ󶨡£ | +| | 这样的设计ä¾�赖于一个默认的无å�‚构造函数,getterå’Œsetter通常是必须的,因为绑定是通过标准的Java Beans property descriptor(Java内çœ�)实现的,就åƒ�在Spring MVC中一样。 在以下情况下,å�¯ä»¥çœ�ç•¥setter。* Map, å�ªè¦�它们被åˆ�始化,就需è¦�一个getter,但ä¸�一定需è¦�一个setter,因为它们å�¯ä»¥è¢«ç»‘定器çª�å�˜ã€‚ * Collectionå’Œarray å�¯ä»¥é€šè¿‡ç´¢å¼•(通常用YAML)或使用å�•个逗å�·åˆ†éš”的值(属性)æ�¥è®¿é—®ã€‚ 在å�Žä¸€ç§�情况下,一个setter是必须的。 我们建议总是为这类类型添加一个setter。 如果你åˆ�始化一个集å�ˆï¼Œç¡®ä¿�它ä¸�是ä¸�å�¯å�˜çš„(如å‰�é�¢çš„例å­�)。 * 如果嵌套的POJO属性被åˆ�始化(就åƒ�å‰�é�¢ä¾‹å­�中的 `Security` 字段),就ä¸�需è¦�setter。 如果你想让绑定器通过使用它的默认构造函数æ�¥å�³æ—¶åˆ›å»ºå®žä¾‹ï¼Œä½ éœ€è¦�一个setter。 有些人使用Project Lombokæ�¥è‡ªåŠ¨æ·»åŠ getterå’Œsetter。 请确ä¿�Lombokä¸�会为这样的类型生æˆ�任何特定的构造函数,因为它被容器自动用æ�¥å®žä¾‹åŒ–对象。最å�Žï¼Œå�ªè€ƒè™‘标准的Java Bean属性,ä¸�支æŒ�对é�™æ€�属性的绑定。 | | --- | --- | @@ -1705,11 +1705,11 @@ public class MyProperties { -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.constructor-binding)2.8.2\. ¹¹Ô캯Êý°ó¶¨ +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.constructor-binding)2.8.2\. 构造函数绑定 -ÉÏÒ»½ÚµÄÀý×Ó¿ÉÒÔÓò»¿É±äµÄ·½Ê½ÖØÐ´£¬ÈçÏÂÀýËùʾ¡£ +上一节的例å­�å�¯ä»¥ç”¨ä¸�å�¯å�˜çš„æ–¹å¼�é‡�写,如下例所示。 @@ -1763,25 +1763,25 @@ public class MyProperties { -ÔÚÕâÖÖÉèÖÃÖУ¬Î¨Ò»µÄ¡°´ø²ÎÊý¹¹Ô캯Êý¡±µÄ´æÔÚÒâζ×ÅÓ¦¸ÃʹÓøù¹Ô캯Êý½øÐа󶨡£ ÕâÒâζ×Ű󶍯÷»áÕÒµ½Ò»¸ö´øÓÐÄãÏ£Íû°ó¶¨µÄ²ÎÊýµÄ¹¹Ô캯Êý¡£ Èç¹ûÄãµÄÀàÓжà¸ö¹¹Ô캯Êý£¬¿ÉÒÔʹÓà `@ConstructorBinding` ×¢½âÀ´Ö¸¶¨Ê¹ÓÃÄĸö¹¹Ô캯Êý½øÐй¹Ô캯Êý°ó¶¨¡£ Èç¹ûҪΪһ¸öÖ»ÓÐÒ»¸ö¡°´ø²ÎÊý¹¹Ô캯Êý¡±µÄÀàÑ¡Ôñ²»°ó¶¨¹¹Ô캯Êý£¬¸Ã¹¹Ô캯Êý±ØÐëÓà `@Autowired` À´×¢½â¡£ ¹¹Ô캯Êý°ó¶¨¿ÉÒÔÓë `Record` Ò»ÆðʹÓᣠ³ý·ÇÄãµÄ¼Ç¼Óжà¸ö¹¹Ô캯Êý£¬·ñÔòûÓбØÒªÊ¹Óà `@ConstructorBinding`¡£ +在这ç§�设置中,唯一的“带å�‚数构造函数â€�的存在æ„�味ç�€åº”该使用该构造函数进行绑定。 è¿™æ„�味ç�€ç»‘定器会找到一个带有你希望绑定的å�‚数的构造函数。 如果你的类有多个构造函数,å�¯ä»¥ä½¿ç”¨ `@ConstructorBinding` 注解æ�¥æŒ‡å®šä½¿ç”¨å“ªä¸ªæž„造函数进行构造函数绑定。 如果è¦�为一个å�ªæœ‰ä¸€ä¸ªâ€œå¸¦å�‚数构造函数â€�的类选择ä¸�绑定构造函数,该构造函数必须用 `@Autowired` æ�¥æ³¨è§£ã€‚ 构造函数绑定å�¯ä»¥ä¸Ž `Record` 一起使用。 除é�žä½ çš„记录有多个构造函数,å�¦åˆ™æ²¡æœ‰å¿…è¦�使用 `@ConstructorBinding`。 -¹¹Ô캯Êý°ó¶¨ÀàµÄǶÌ׳ÉÔ±£¨ÈçÉÏÃæÀý×ÓÖÐµÄ `Security`£©Ò²½«Í¨¹ýÆä¹¹Ô캯Êý±»°ó¶¨¡£ +构造函数绑定类的嵌套æˆ�员(如上é�¢ä¾‹å­�中的 `Security`)也将通过其构造函数被绑定。 -ĬÈÏÖµ¿ÉÒÔÔÚ¹¹Ô캯Êý²ÎÊýºÍRecord×é¼þÉÏʹÓà `@DefaultValue` À´Ö¸¶¨¡£ ת»»·þÎñ½«±»Ó¦ÓÃÓÚ½«×¢½âµÄ `String` ÖµÇ¿ÖÆ×ª»»ÎªÈ±Ê§ÊôÐÔµÄÄ¿±êÀàÐÍ¡£ +默认值å�¯ä»¥åœ¨æž„造函数å�‚æ•°å’ŒRecord组件上使用 `@DefaultValue` æ�¥æŒ‡å®šã€‚ 转æ�¢æœ�务将被应用于将注解的 `String` 值强制转æ�¢ä¸ºç¼ºå¤±å±žæ€§çš„目标类型。 -²Î¿¼Ç°ÃæµÄÀý×Ó£¬Èç¹ûûÓÐÊôÐ԰󶨵½ `Security` £¬ `MyProperties` ʵÀý½«°üº¬Ò»¸ö `security` ÀàÐ굀 `null` Öµ¡£ ΪÁËʹËü°üº¬Ò»¸ö·Ç null µÄ `Security` ʵÀý£¬¼´Ê¹Ã»ÓÐÊôÐÔÓëÖ®°ó¶¨£¨µ±Ê¹ÓÃKotlinʱ£¬Õ⽫ҪÇó `Security` µÄ `username` ºÍ `password` ²ÎÊý±»ÉùÃ÷Ϊ nullable£¬ÒòΪËüÃÇûÓÐĬÈÏÖµ£©£¬Ê¹ÓÃÒ»¸ö¿ÕµÄ `@DefaultValue` ×¢½â¡£ +å�‚考å‰�é�¢çš„例å­�,如果没有属性绑定到 `Security` , `MyProperties` 实例将包å�«ä¸€ä¸ª `security` 类型的 `null` 值。 为了使它包å�«ä¸€ä¸ªé�ž null çš„ `Security` 实例,å�³ä½¿æ²¡æœ‰å±žæ€§ä¸Žä¹‹ç»‘定(当使用Kotlin时,这将è¦�求 `Security` çš„ `username` å’Œ `password` å�‚数被声明为 nullable,因为它们没有默认值),使用一个空的 `@DefaultValue` 注解。 @@ -1812,21 +1812,21 @@ public MyProperties(boolean enabled, InetAddress remoteAddress, @DefaultValue Se -| | ҪʹÓù¹Ô캯Êý°ó¶¨£¬¸ÃÀà±ØÐëʹÓà `@EnableConfigurationProperties` »òÅäÖÃÊôÐÔɨÃèÀ´ÆôÓᣠÄã²»ÄܶÔͨ¹ý³£¹æSpring»úÖÆ´´½¨µÄBeanʹÓù¹Ô캯Êý°ó¶¨£¨ÀýÈç `@Component` Bean£¬Í¨¹ýʹÓà `@Bean` ·½·¨´´½¨µÄBean»òͨ¹ýʹÓà `@Import` ¼ÓÔØµÄBean£©¡£ | +| | è¦�使用构造函数绑定,该类必须使用 `@EnableConfigurationProperties` 或é…�置属性扫æ��æ�¥å�¯ç”¨ã€‚ ä½ ä¸�能对通过常规Spring机制创建的Bean使用构造函数绑定(例如 `@Component` Bean,通过使用 `@Bean` 方法创建的Bean或通过使用 `@Import` 加载的Bean)。 | | --- | --- | -| | ÒªÔÚÔ­Éú¾µÏñÖÐʹÓù¹Ô캯Êý°ó¶¨£¬±ØÐëÓà `-parameters` ²ÎÊý±àÒë¸ÃÀà¡£Èç¹ûÄãʹÓà Spring Boot µÄ Gradle ²å¼þ»òʹÓà Maven ºÍ `spring-boot-starter-parent`£¬Õ⽫×Ô¶¯ÅäÖᣠ| +| | è¦�在原生镜åƒ�中使用构造函数绑定,必须用 `-parameters` å�‚数编译该类。如果你使用 Spring Boot çš„ Gradle æ�’件或使用 Maven å’Œ `spring-boot-starter-parent`,这将自动é…�置。 | | --- | --- | -| | ²»½¨Ò齫 `java.util.Optional` Óë `@ConfigurationProperties` Ò»ÆðʹÓã¬ÒòΪËüÖ÷ÒªÊÇ×÷Ϊһ¸ö·µ»ØÀàÐÍʹÓᣠÒò´Ë£¬Ëü²¢²»ÊʺÏÅäÖÃÊôÐÔ×¢Èë¡£ ΪÁËÓëÆäËûÀàÐ͵ÄÊôÐÔ±£³ÖÒ»Ö£¬Èç¹ûÄãȷʵÉùÃ÷ÁËÒ»¸ö `Optional` ÊôÐÔ£¬µ«ËüûÓÐÖµ£¬`null` ¶ø²»ÊÇÒ»¸ö¿ÕµÄ `Optional` ½«±»°ó¶¨¡£ | +| | ä¸�建议将 `java.util.Optional` 与 `@ConfigurationProperties` 一起使用,因为它主è¦�是作为一个返回类型使用。 因此,它并ä¸�适å�ˆé…�置属性注入。 为了与其他类型的属性ä¿�æŒ�一致,如果你确实声明了一个 `Optional` 属性,但它没有值,`null` 而ä¸�是一个空的 `Optional` 将被绑定。 | | --- | --- | @@ -1835,17 +1835,17 @@ public MyProperties(boolean enabled, InetAddress remoteAddress, @DefaultValue Se -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.enabling-annotated-types)2.8.3\. ÆôÓà @ConfigurationProperties Àà +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.enabling-annotated-types)2.8.3\. å�¯ç”¨ @ConfigurationProperties ç±» -Spring BootÌṩÁË°ó¶¨ `@ConfigurationProperties` ÀàÐͲ¢½«Æä×¢²áΪBeanµÄ»ù´¡ÉèÊ©¡£ Äã¿ÉÒÔÔÚÖð¸öÀàµÄ»ù´¡ÉÏÆôÓÃÅäÖÃÊôÐÔ£¬»òÕ߯ôÓÃÅäÖÃÊôÐÔɨÃ裬Æä¹¤×÷·½Ê½Óë×é¼þɨÃèÀàËÆ¡£ +Spring Bootæ��供了绑定 `@ConfigurationProperties` 类型并将其注册为Bean的基础设施。 ä½ å�¯ä»¥åœ¨é€�个类的基础上å�¯ç”¨é…�置属性,或者å�¯ç”¨é…�置属性扫æ��,其工作方å¼�与组件扫æ��类似。 -ÓÐʱ£¬Óà `@ConfigurationProperties` ×¢½âµÄÀà¿ÉÄܲ»ÊʺÏɨÃ裬ÀýÈ磬Èç¹ûÄãÕýÔÚ¿ª·¢Äã×Ô¼ºµÄ×Ô¶¯ÅäÖûòÕßÄãÏëÓÐÌõ¼þµØÆôÓÃËüÃÇ¡£ ÔÚÕâЩÇé¿öÏ£¬Ê¹Óà `@EnableConfigurationProperties` ×¢½âÖ¸¶¨Òª´¦ÀíµÄÀàÐÍÁÐ±í£¬ Ëü¿ÉÒÔ×¢½âÔÚÈκΠ`@Configuration` ÀàÉÏ£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +有时,用 `@ConfigurationProperties` 注解的类å�¯èƒ½ä¸�适å�ˆæ‰«æ��,例如,如果你正在开å�‘你自己的自动é…�置或者你想有æ�¡ä»¶åœ°å�¯ç”¨å®ƒä»¬ã€‚ 在这些情况下,使用 `@EnableConfigurationProperties` 注解指定è¦�处ç�†çš„类型列表, 它å�¯ä»¥æ³¨è§£åœ¨ä»»ä½• `@Configuration` 类上,如下é�¢çš„例å­�所示。 @@ -1900,7 +1900,7 @@ public class SomeProperties { -ҪʹÓÃÅäÖÃÊôÐÔɨÃ裬ÇëÏòÄãµÄapplicationÌí¼Ó `@ConfigurationPropertiesScan` ×¢½â¡£ ͨ³££¬Ëü±»Ìí¼Óµ½Óà `@SpringBootApplication` ×¢½âµÄmainÀàÖУ¬µ«ËüÒ²¿ÉÒÔ±»Ìí¼Óµ½ÈκΠ`@Configuration` ÀàÉÏ¡£ ĬÈÏÇé¿öÏ£¬É¨Ãè»á´Ó×¢½âËùÔڵİü¿ªÊ¼£¬ÄãÈç¹ûÏë×Ô¶¨ÒåɨÃèÆäËû°ü£¬¿ÉÒԲο¼ÈçÏ¡£ +è¦�使用é…�置属性扫æ��,请å�‘ä½ çš„application添加 `@ConfigurationPropertiesScan` 注解。 通常,它被添加到用 `@SpringBootApplication` 注解的main类中,但它也å�¯ä»¥è¢«æ·»åŠ åˆ°ä»»ä½• `@Configuration` 类上。 默认情况下,扫æ��会从注解所在的包开始,你如果想自定义扫æ��其他包,å�¯ä»¥å�‚考如下。 @@ -1931,14 +1931,14 @@ public class MyApplication { -| | µ± `@ConfigurationProperties` BeanʹÓÃÅäÖÃÊôÐÔɨÃè»òͨ¹ý `@EnableConfigurationProperties` ×¢²áʱ£¬¸ÃBeanÓÐÒ»¸ö³£¹æÃû³Æ£º`-`£¬ÆäÖÐ `` ÊÇ `@ConfigurationProperties` ×¢½âÖÐÖ¸¶¨µÄ»·¾³¼üǰ׺£¬ `` ÊÇBeanµÄÍêÈ«ÏÞ¶¨Ãû³Æ¡£ Èç¹û×¢½âûÓÐÌṩÈκÎǰ׺£¬ÔòֻʹÓÃBeanµÄÍêÈ«ÏÞ¶¨Ãû³Æ¡£¼ÙÉèËüÔÚ `com.example.app` °üÖУ¬ÉÏÃæµÄ `SomeProperties` Àý× bean Ãû³ÆÊÇ `some.properties-com.example.app.SomeProperties`¡£ | +| | 当 `@ConfigurationProperties` Bean使用é…�置属性扫æ��或通过 `@EnableConfigurationProperties` 注册时,该Bean有一个常规å��称:`-`,其中 `` 是 `@ConfigurationProperties` 注解中指定的环境键å‰�缀, `` 是Bean的完全é™�定å��称。 如果注解没有æ��供任何å‰�缀,则å�ªä½¿ç”¨Bean的完全é™�定å��称。å�‡è®¾å®ƒåœ¨ `com.example.app` 包中,上é�¢çš„ `SomeProperties` 例å­�çš„ bean å��称是 `some.properties-com.example.app.SomeProperties`。 | | --- | --- | -ÎÒÃǽ¨Òé `@ConfigurationProperties` Ö»´¦Àí environment£¬ÌرðÊDz»´ÓÉÏÏÂÎÄ×¢ÈëÆäËûBean¡£ ¶ÔÓڱ߽ǰ¸Àý£¨ÌØÊâÇé¿ö£©£¬¿ÉÒÔʹÓà setter ×¢Èë»ò¿ò¼ÜÌṩµÄÈκΠ`*Aware` ½Ó¿Ú£¨Èç `EnvironmentAware` £¬Èç¹ûÄãÐèÒª·ÃÎÊ `Environment`£©¡£ Èç¹ûÄãÈÔÈ»ÏëʹÓù¹ÔìÆ÷×¢ÈëÆäËûBean£¬ÅäÖÃÊôÐÔBean±ØÐëÓà `@Component` À´×¢½â£¬²¢Ê¹ÓûùÓÚJavaBeanµÄÊôÐ԰󶨡£ +我们建议 `@ConfigurationProperties` å�ªå¤„ç�† environment,特别是ä¸�从上下文注入其他Bean。 对于边角案例(特殊情况),å�¯ä»¥ä½¿ç”¨ setter 注入或框架æ��供的任何 `*Aware` 接å�£ï¼ˆå¦‚ `EnvironmentAware` ,如果你需è¦�访问 `Environment`)。 如果你ä»�然想使用构造器注入其他Bean,é…�置属性Bean必须用 `@Component` æ�¥æ³¨è§£ï¼Œå¹¶ä½¿ç”¨åŸºäºŽJavaBean的属性绑定。 @@ -1946,11 +1946,11 @@ public class MyApplication { -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.using-annotated-types)2.8.4\. ʹÓà @ConfigurationProperties Àà +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.using-annotated-types)2.8.4\. 使用 @ConfigurationProperties ç±» -ÕâÖÖÅäÖ÷½Ê½Óë `SpringApplication` ÍⲿYAMLÅäÖÃÅäºÏµÃÌØ±ðºÃ£¬ÈçÒÔÏÂÀý×ÓËùʾ¡£ +è¿™ç§�é…�置方å¼�与 `SpringApplication` 外部YAMLé…�ç½®é…�å�ˆå¾—特别好,如以下例å­�所示。 @@ -1975,7 +1975,7 @@ my: -ҪʹÓà `@ConfigurationProperties` Bean£¬Äã¿ÉÒÔÓÃÓëÆäËûBeanÏàͬµÄ·½Ê½×¢ÈëËüÃÇ£¬ÈçÏÂÀýËùʾ¡£ +è¦�使用 `@ConfigurationProperties` Bean,你å�¯ä»¥ç”¨ä¸Žå…¶ä»–Bean相å�Œçš„æ–¹å¼�注入它们,如下例所示。 @@ -2019,7 +2019,7 @@ public class MyService { -| | ʹÓà `@ConfigurationProperties` »¹¿ÉÒÔÈÃÄãÉú³ÉÔªÊý¾ÝÎļþ£¬ÕâЩÎļþ¿ÉÒÔ±»IDEÓÃÀ´ÅäÖÃÊôÐԵġ°×Ô¶¯²¹È«¡±¹¦ÄÜ¡£ ÏêÇé¼û[¸½Â¼](https://springdoc.cn/spring-boot/configuration-metadata.html#appendix.configuration-metadata)¡£ | +| | 使用 `@ConfigurationProperties` 还å�¯ä»¥è®©ä½ ç”Ÿæˆ�元数æ�®æ–‡ä»¶ï¼Œè¿™äº›æ–‡ä»¶å�¯ä»¥è¢«IDE用æ�¥é…�置属性的“自动补全â€�功能。 详情è§�[附录](https://springdoc.cn/spring-boot/configuration-metadata.html#appendix.configuration-metadata)。 | | --- | --- | @@ -2028,17 +2028,17 @@ public class MyService { -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.third-party-configuration)2.8.5\. µÚÈý·½ÅäÖà +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.third-party-configuration)2.8.5\. 第三方é…�ç½® -³ýÁËʹÓà `@ConfigurationProperties` À´×¢½âÒ»¸öÀàÖ®Í⣬Ä㻹¿ÉÒÔÔÚ¹«¹²µÄ `@Bean` ·½·¨ÉÏʹÓÃËü¡£ µ±ÄãÏë°ÑÊôÐ԰󶨵½Äã¿ØÖÆÖ®ÍâµÄµÚÈý·½×é¼þʱ£¬ÕâÑù×öÌØ±ðÓÐÓᣠ+除了使用 `@ConfigurationProperties` æ�¥æ³¨è§£ä¸€ä¸ªç±»ä¹‹å¤–,你还å�¯ä»¥åœ¨å…¬å…±çš„ `@Bean` 方法上使用它。 当你想把属性绑定到你控制之外的第三方组件时,这样å�šç‰¹åˆ«æœ‰ç”¨ã€‚ -Òª´Ó `Environment` ÊôÐÔÖÐÅäÖÃÒ»¸öBean£¬ÇëÔÚÆäBean×¢²áÖÐÌí¼Ó `@ConfigurationProperties` £¬ÈçÏÂÀýËùʾ¡£ +è¦�从 `Environment` 属性中é…�置一个Bean,请在其Bean注册中添加 `@ConfigurationProperties` ,如下例所示。 @@ -2074,7 +2074,7 @@ public class ThirdPartyConfiguration { -ÈκÎÓà `another` ǰ׺¶¨ÒåµÄJavaBeanÊôÐÔ¶¼»á±»Ó³Éäµ½ `AnotherComponent` BeanÉÏ£¬Æä·½Ê½ÀàËÆÓÚÇ°ÃæµÄ `SomeProperties` Àý×Ó¡£ +任何用 `another` å‰�缀定义的JavaBean属性都会被映射到 `AnotherComponent` Bean上,其方å¼�类似于å‰�é�¢çš„ `SomeProperties` 例å­�。 @@ -2082,17 +2082,17 @@ public class ThirdPartyConfiguration { -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding)2.8.6\. ¿íËÉµÄ°ó¶¨ +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding)2.8.6\. 宽æ�¾çš„绑定 -Spring BootÔÚ½« `Environment` ÊôÐ԰󶨵½ `@ConfigurationProperties` beanʱʹÓÃÁËһЩ¿íËɵĹæÔò£¬Òò´Ë `Environment` ÊôÐÔÃû³ÆºÍbeanÊôÐÔÃû³ÆÖ®¼ä²»ÐèÒªÍêȫƥÅä¡£ ÕâºÜÓÐÓ㬳£¼ûµÄÀý×Ó°üÀ¨ÆÆÕۺŷָôµÄÊôÐÔÃû³Æ£¨ÀýÈ磬 `context-path` °ó¶¨µ½ `contextPath` £©£¬ºÍ´óдµÄÊôÐÔÃû³Æ£¨ÀýÈ磬`PORT` °ó¶¨µ½ `port` £©¡£ +Spring Boot在将 `Environment` 属性绑定到 `@ConfigurationProperties` bean时使用了一些宽æ�¾çš„规则,因此 `Environment` 属性å��ç§°å’Œbean属性å��称之间ä¸�需è¦�完全匹é…�。 这很有用,常è§�的例å­�包括破折å�·åˆ†éš”的属性å��称(例如, `context-path` 绑定到 `contextPath` ),和大写的属性å��称(例如,`PORT` 绑定到 `port` )。 -ÑÝʾһ¸öÀý×Ó£¬¿¼ÂÇÒÔÏ `@ConfigurationProperties` Àà¡£ +演示一个例å­�,考虑以下 `@ConfigurationProperties` 类。 @@ -2132,53 +2132,53 @@ public class MyPersonProperties { -¶ÔÒÔÉϵĴúÂëÀ´Ëµ£¬ÒÔϵÄÊôÐÔÃû³Æ¶¼¿ÉÒÔʹÓᣠ+对以上的代ç �æ�¥è¯´ï¼Œä»¥ä¸‹çš„属性å��称都å�¯ä»¥ä½¿ç”¨ã€‚ Table 3\. relaxed binding | Property | Note | | --- | --- | -| `my.main-project.person.first-name` | Kebab ·ç¸ñ£¨¶ÌºáÏ߸ô¿ª£©£¬½¨ÒéÔÚ `.properties` ºÍ `.yml` ÎļþÖÐʹÓᣠ| -| `my.main-project.person.firstName` | ±ê×¼µÄÍÕ·åÓï·¨¡£ | -| `my.main-project.person.first_name` | Ï»®Ïߣ¬ÕâÊÇÒ»ÖÖÓÃÓÚ `.properties` ºÍ `.yml` ÎļþµÄÌæ´ú¸ñʽ¡£ | -| `MY_MAINPROJECT_PERSON_FIRSTNAME` | ´óд¸ñʽ£¬ÔÚʹÓÃϵͳ»·¾³±äÁ¿Ê±½¨ÒéʹÓôóд¸ñʽ¡£ | +| `my.main-project.person.first-name` | Kebab 风格(短横线隔开),建议在 `.properties` å’Œ `.yml` 文件中使用。 | +| `my.main-project.person.firstName` | 标准的驼峰语法。 | +| `my.main-project.person.first_name` | 下划线,这是一ç§�用于 `.properties` å’Œ `.yml` 文件的替代格å¼�。 | +| `MY_MAINPROJECT_PERSON_FIRSTNAME` | 大写格å¼�,在使用系统环境å�˜é‡�时建议使用大写格å¼�。 | -| | ×¢½âµÄ `prefix` Öµ _±ØÐë_ ÊÇkebab·ç¸ñ£¨Ð¡Ð´²¢ÒÔ `-` ·Ö¸ô£¬Èç `my.main-project.person` £©¡£ | +| | 注解的 `prefix` 值 _å¿…é¡»_ 是kebab风格(å°�写并以 `-` 分隔,如 `my.main-project.person` )。 | | --- | --- | -Table 4\. ÿÖÖÊôÐÔÔ´µÄ¿íËɰ󶨹æÔò -| ÊôÐÔÔ´ | ¼òµ¥µÄ | Áбí | +Table 4\. æ¯�ç§�属性æº�的宽æ�¾ç»‘定规则 +| 属性æº� | 简å�•çš„ | 列表 | | --- | --- | --- | -| Properties Îļþ | ÍÕ·å, kebab , Ï»®Ïß | ʹÓà `[ ]` »ò¶ººÅ·Ö¸ôÖµµÄ±ê×¼ÁбíÓï·¨ | -| YAML Îļþ | ÍÕ·å, kebab , Ï»®Ïß | ±ê×¼YAMLÁбíÓï·¨»ò¶ººÅ·Ö¸ôµÄÖµ | -| »·¾³±äÁ¿ | ´óд£¬Ï»®ÏßΪ·Ö¸ô·û(¼û [´Ó»·¾³±äÁ¿°ó¶¨](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)). | Numeric values surrounded by underscores (see [´Ó»·¾³±äÁ¿°ó¶¨](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)) | -| ϵͳÊôÐÔ£¨System properties£© | ÍÕ·å, kebab , Ï»®Ïß | ʹÓà `[ ]` »ò¶ººÅ·Ö¸ôÖµµÄ±ê×¼ÁбíÓï·¨ | +| Properties 文件 | 驼峰, kebab , 下划线 | 使用 `[ ]` 或逗å�·åˆ†éš”值的标准列表语法 | +| YAML 文件 | 驼峰, kebab , 下划线 | 标准YAML列表语法或逗å�·åˆ†éš”的值 | +| 环境å�˜é‡� | 大写,下划线为分隔符(è§� [从环境å�˜é‡�绑定](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)). | Numeric values surrounded by underscores (see [从环境å�˜é‡�绑定](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)) | +| 系统属性(System properties) | 驼峰, kebab , 下划线 | 使用 `[ ]` 或逗å�·åˆ†éš”值的标准列表语法 | -| | ÎÒÃǽ¨Ò飬ÔÚ¿ÉÄܵÄÇé¿öÏ£¬ÊôÐÔÓ¦ÒÔСдµÄkebab¸ñʽ´æ´¢£¬ÀýÈç `my.person.first-name=Rod` ¡£ | +| | 我们建议,在å�¯èƒ½çš„æƒ…况下,属性应以å°�写的kebabæ ¼å¼�存储,例如 `my.person.first-name=Rod` 。 | | --- | --- | -##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.maps)°ó¶¨Map +##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.maps)绑定Map -µ±°ó¶¨µ½ `Map` ÊôÐÔʱ£¬Äã¿ÉÄÜÐèҪʹÓÃÒ»¸öÌØÊâµÄÀ¨ºÅ·ûºÅ£¬ÒԱ㱣ÁôԭʼµÄ `key` Öµ¡£ Èç¹ûkeyûÓб» `[ ]` °ü¹ü£¬ÈκηÇ×ÖĸÊý×Ö¡¢`-` »ò `.` µÄ×Ö·û½«±»É¾³ý¡£ +当绑定到 `Map` 属性时,你å�¯èƒ½éœ€è¦�使用一个特殊的括å�·ç¬¦å�·ï¼Œä»¥ä¾¿ä¿�留原始的 `key` 值。 如果key没有被 `[ ]` 包裹,任何é�žå­—æ¯�æ•°å­—ã€�`-` 或 `.` 的字符将被删除。 -ÀýÈ磬¿¼Âǽ«ÒÔÏÂÊôÐ԰󶨵½Ò»¸ö `Map`¡£ +例如,考虑将以下属性绑定到一个 `Map`。 @@ -2206,20 +2206,20 @@ my.map./key3=value3 -| | ¶ÔÓÚYAMLÎļþ£¬À¨ºÅÐèÒªÓÃÒýºÅ°ü¹ü£¬ÒÔʹkey±»ÕýÈ·½âÎö¡£ | +| | 对于YAML文件,括å�·éœ€è¦�用引å�·åŒ…裹,以使key被正确解æž�。 | | --- | --- | -ÉÏÃæµÄÊôÐÔ½«°ó¶¨µ½Ò»¸ö `Map` £¬`/key1`£¬`/key2` ºÍ `key3` ×÷ΪmapµÄkey¡£ бÏßÒѾ­´Ó `key3` ÖÐɾ³ý£¬ÒòΪËüûÓб»·½À¨ºÅ°ü¹ü¡£ +上é�¢çš„属性将绑定到一个 `Map` ,`/key1`,`/key2` å’Œ `key3` 作为mapçš„key。 斜线已ç»�从 `key3` 中删除,因为它没有被方括å�·åŒ…裹。 -µ±°ó¶¨µ½±êÁ¿ÖµÊ±£¬´øÓÐ `.` µÄ¼ü²»ÐèÒªÓà `[]` °ü¹ü¡£ ±êÁ¿Öµ°üÀ¨Ã¶¾ÙºÍËùÓÐ `java.lang` °üÖеÄÀàÐÍ£¬³ýÁË `Object` ¡£ ½« `a.b=c` °ó¶¨µ½ `Map` ½«±£Áô¼üÖÐµÄ `.` £¬²¢·µ»ØÒ»¸ö´øÓÐ `{"a.b"="c"}` EntryµÄMap¡£ ¶ÔÓÚÈÎºÎÆäËûÀàÐÍ£¬Èç¹ûÄãµÄ `key` °üº¬ `.` £¬ÄãÐèҪʹÓÃÀ¨ºÅ·ûºÅ¡£ ÀýÈ磬½« `a.b=c` °ó¶¨µ½ `Map` ½«·µ»ØÒ»¸ö´øÓÐ `{"a"={"b"="c"}` entryµÄMap£¬¶ø `[a.b]=c` ½«·µ»ØÒ»¸ö´øÓÐ `{"a.b"="c"}` entry µÄMap¡£ +当绑定到标é‡�值时,带有 `.` 的键ä¸�需è¦�用 `[]` 包裹。 æ ‡é‡�值包括枚举和所有 `java.lang` 包中的类型,除了 `Object` 。 å°† `a.b=c` 绑定到 `Map` å°†ä¿�留键中的 `.` ,并返回一个带有 `{"a.b"="c"}` Entryçš„Map。 对于任何其他类型,如果你的 `key` 包å�« `.` ,你需è¦�使用括å�·ç¬¦å�·ã€‚ 例如,将 `a.b=c` 绑定到 `Map` 将返回一个带有 `{"a"={"b"="c"}` entryçš„Map,而 `[a.b]=c` 将返回一个带有 `{"a.b"="c"}` entry çš„Map。 @@ -2227,51 +2227,51 @@ my.map./key3=value3 -##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)´Ó»·¾³±äÁ¿°ó¶¨ +##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables)从环境å�˜é‡�绑定 -ÀýÈ磬Linux shell±äÁ¿Ö»Äܰüº¬×Öĸ£¨`a` µ½ `z` »ò `A` µ½ `Z` £©¡¢Êý×Ö£¨ `0` µ½ `9` £©»òÏ»®Ïß×Ö·û£¨ `_` £©¡£ °´ÕÕ¹ßÀý£¬Unix shell±äÁ¿µÄÃû³ÆÒ²½«²ÉÓôóд×Öĸ¡£ +例如,Linux shellå�˜é‡�å�ªèƒ½åŒ…å�«å­—æ¯�(`a` 到 `z` 或 `A` 到 `Z` )ã€�数字( `0` 到 `9` )或下划线字符( `_` )。 按照惯例,Unix shellå�˜é‡�çš„å��称也将采用大写字æ¯�。 -Spring Boot¿íËɵİ󶨹æÔò±»Éè¼ÆÎª¾¡¿ÉÄܵØÓëÕâЩÃüÃûÏÞÖÆ¼æÈÝ¡£ +Spring Boot宽æ�¾çš„绑定规则被设计为尽å�¯èƒ½åœ°ä¸Žè¿™äº›å‘½å��é™�制兼容。 -Òª½«¹æ·¶ÐÎʽµÄÊôÐÔÃû³Æ×ª»»Îª»·¾³±äÁ¿Ãû³Æ£¬Äã¿ÉÒÔ×ñÑ­ÕâЩ¹æÔò¡£ +è¦�将规范形å¼�的属性å��称转æ�¢ä¸ºçŽ¯å¢ƒå�˜é‡�å��称,你å�¯ä»¥é�µå¾ªè¿™äº›è§„则。 -* ÓÃÏ»®Ïߣ¨`_`£©Ìæ»»µã£¨`.`£©¡£ +* 用下划线(`_`)替æ�¢ç‚¹ï¼ˆ`.`)。 -* ɾ³ýÈÎºÎÆÆÕۺţ¨`-`£©¡£ +* 删除任何破折å�·ï¼ˆ`-`)。 -* ת»»Îª´óд×Öĸ¡£ +* 转æ�¢ä¸ºå¤§å†™å­—æ¯�。 -ÀýÈ磬ÅäÖÃÊôÐÔ `spring.main.log-startup-info` ½«ÊÇÒ»¸öÃûΪ `SPRING_MAIN_LOGSTARTUPINFO` µÄ»·¾³±äÁ¿¡£ +例如,é…�置属性 `spring.main.log-startup-info` 将是一个å��为 `SPRING_MAIN_LOGSTARTUPINFO` 的环境å�˜é‡�。 -»·¾³±äÁ¿Ò²¿ÉÒÔÔڰ󶨵½¶ÔÏóÁÐ±í£¨List£©Ê±Ê¹ÓᣠҪ°ó¶¨µ½Ò»¸ö `List`£¬ÔÚ±äÁ¿Ãû³ÆÖУ¬ÔªËرàºÅ£¨Ë÷Òý£©Ó¦¸ÃÓÃÏ»®Ïß°ü¹ü¡£ +环境å�˜é‡�也å�¯ä»¥åœ¨ç»‘定到对象列表(List)时使用。 è¦�绑定到一个 `List`,在å�˜é‡�å��称中,元素编å�·ï¼ˆç´¢å¼•)应该用下划线包裹。 -ÀýÈ磬ÅäÖÃÊôÐÔ `my.service[0].other` ½«Ê¹ÓÃÒ»¸öÃûΪ `MY_SERVICE_0_OTHER` µÄ»·¾³±äÁ¿¡£ +例如,é…�置属性 `my.service[0].other` 将使用一个å��为 `MY_SERVICE_0_OTHER` 的环境å�˜é‡�。 @@ -2281,17 +2281,17 @@ Spring Boot -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.merging-complex-types)2.8.7\. ºÏ²¢¸´ÔÓµÄÀàÐÍ +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.merging-complex-types)2.8.7\. å�ˆå¹¶å¤�æ�‚的类型 -µ±List±»ÅäÖÃÔÚ¶à¸öµØ·½Ê±£¬¸²¸ÇµÄ×÷ÓÃÊÇÌæ»»Õû¸ölist¡£ +当List被é…�置在多个地方时,覆盖的作用是替æ�¢æ•´ä¸ªlist。 -ÀýÈ磬¼ÙÉèÒ»¸ö `MyPojo` ¶ÔÏóµÄ `name` ºÍ `description` ÊôÐÔĬÈÏΪ `null`¡£ ÏÂÃæµÄÀý×Ó´Ó `MyProperties` Öб©Â¶ÁËÒ»¸ö `MyPojo` ¶ÔÏóµÄÁÐ±í¡£ +例如,å�‡è®¾ä¸€ä¸ª `MyPojo` 对象的 `name` å’Œ `description` 属性默认为 `null`。 下é�¢çš„例å­�从 `MyProperties` 中暴露了一个 `MyPojo` 对象的列表。 @@ -2327,7 +2327,7 @@ public class MyProperties { -¿¼ÂÇÒÔÏÂÅäÖᣠ+考虑以下é…�置。 @@ -2358,13 +2358,13 @@ my.list[0].name=my another name -Èç¹û `dev` ÅäÖÃÎļþδ±»¼¤»î£¬`MyProperties.list` °üº¬Ò»¸ö `MyPojo` ÌõÄ¿£¬Èç֮ǰ¶¨ÒåµÄÄÇÑù¡£ È»¶ø£¬Èç¹û `dev` ÅäÖÃÎļþ±»¼¤»î£¬`list` ÈÔȻֻ°üº¬Ò»¸öÌõÄ¿£¨name Ϊ `my another name`£¬descriptionΪ `null`£©¡£ ÕâÖÖÅäÖò»»áÔÚÁбíÖÐÌí¼ÓµÚ¶þ¸ö `MyPojo` ʵÀý£¬Ò²²»»áºÏ²¢ÏîÄ¿¡£ +如果 `dev` é…�置文件未被激活,`MyProperties.list` 包å�«ä¸€ä¸ª `MyPojo` æ�¡ç›®ï¼Œå¦‚之å‰�定义的那样。 然而,如果 `dev` é…�置文件被激活,`list` ä»�ç„¶å�ªåŒ…å�«ä¸€ä¸ªæ�¡ç›®ï¼ˆname 为 `my another name`,description为 `null`)。 è¿™ç§�é…�ç½®ä¸�会在列表中添加第二个 `MyPojo` 实例,也ä¸�会å�ˆå¹¶é¡¹ç›®ã€‚ -µ±Ò»¸ö `List` ÔÚ¶à¸öÅäÖÃÎļþÖб»Ö¸¶¨Ê±£¬½«Ê¹ÓþßÓÐ×î¸ßÓÅÏȼ¶µÄÄǸö£¨²¢ÇÒÖ»ÓÐÄǸö£©¡£ ¿¼ÂÇÏÂÃæµÄÀý×Ó¡£ +当一个 `List` 在多个é…�置文件中被指定时,将使用具有最高优先级的那个(并且å�ªæœ‰é‚£ä¸ªï¼‰ã€‚ 考虑下é�¢çš„例å­�。 @@ -2397,13 +2397,13 @@ my.list[0].name=my another name -ÔÚÇ°ÃæµÄÀý×ÓÖУ¬Èç¹û `dev` ÅäÖÃÎļþÊǼ¤»îµÄ£¬`MyProperties.list` °üº¬ _Ò»¸ö_ `MyPojo` ÌõÄ¿£¨name ÊÇ `my another name`£¬descriptionÊÇ `null`£©¡£ ¶ÔÓÚYAML£¬¶ººÅ·Ö¸ôµÄÁбíºÍYAMLÁÐ±í¶¼¿ÉÒÔÓÃÀ´ÍêÈ«¸²¸ÇÁбíµÄÄÚÈÝ¡£ +在å‰�é�¢çš„例å­�中,如果 `dev` é…�置文件是激活的,`MyProperties.list` 包å�« _一个_ `MyPojo` æ�¡ç›®ï¼ˆname 是 `my another name`,description是 `null`)。 对于YAML,逗å�·åˆ†éš”的列表和YAML列表都å�¯ä»¥ç”¨æ�¥å®Œå…¨è¦†ç›–列表的内容。 -¶ÔÓÚ `Map` ÊôÐÔ£¬Äã¿ÉÒÔÓôӶà¸öÀ´Ô´»ñÈ¡µÄÊôÐÔÖµ½øÐа󶨡£ È»¶ø£¬¶ÔÓÚ¶à¸öÀ´Ô´ÖеÄͬһÊôÐÔ£¬Ê¹ÓþßÓÐ×î¸ßÓÅÏȼ¶µÄÄǸö¡£ ÏÂÃæµÄÀý×Ó´Ó `MyProperties` ±©Â¶ÁËÒ»¸ö `Map`¡£ +对于 `Map` 属性,你å�¯ä»¥ç”¨ä»Žå¤šä¸ªæ�¥æº�获å�–的属性值进行绑定。 然而,对于多个æ�¥æº�中的å�Œä¸€å±žæ€§ï¼Œä½¿ç”¨å…·æœ‰æœ€é«˜ä¼˜å…ˆçº§çš„那个。 下é�¢çš„例å­�从 `MyProperties` 暴露了一个 `Map`。 @@ -2439,7 +2439,7 @@ public class MyProperties { -¿¼ÂÇÒÔÏÂÅäÖᣠ+考虑以下é…�置。 @@ -2472,13 +2472,13 @@ my.map.key2.description=dev description 2 -Èç¹û `dev` ÅäÖÃÎļþûÓм¤»î£¬`MyProperties.map` °üº¬Ò»¸ökeyΪ `key1` µÄÌõÄ¿£¨nameΪ `my name 1` £¬descriptionΪ `my description 1` £©¡£ È»¶ø£¬Èç¹û `dev` ÅäÖÃÎļþ±»¼¤»î£¬`map` °üº¬Á½¸öÌõÄ¿£¬keyΪ `key1` £¨nameΪ `dev name 1`£¬descriptionΪ `my description 1` £©ºÍ `key2`£¨nameΪ `dev name 2`£¬descriptionΪ `dev description 2`£©¡£ +如果 `dev` é…�置文件没有激活,`MyProperties.map` 包å�«ä¸€ä¸ªkey为 `key1` çš„æ�¡ç›®ï¼ˆname为 `my name 1` ,description为 `my description 1` )。 然而,如果 `dev` é…�置文件被激活,`map` 包å�«ä¸¤ä¸ªæ�¡ç›®ï¼Œkey为 `key1` (name为 `dev name 1`,description为 `my description 1` )和 `key2`(name为 `dev name 2`,description为 `dev description 2`)。 -| | Ç°ÃæµÄºÏ²¢¹æÔòÊÊÓÃÓÚËùÓÐÊôÐÔÔ´µÄÊôÐÔ£¬¶ø²»½ö½öÊÇÎļþ¡£ | +| | å‰�é�¢çš„å�ˆå¹¶è§„则适用于所有属性æº�的属性,而ä¸�仅仅是文件。 | | --- | --- | @@ -2487,44 +2487,44 @@ my.map.key2.description=dev description 2 -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion)2.8.8\. ÊôÐÔ£¨Properties£©×ª»» +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion)2.8.8\. 属性(Properties)转æ�¢ -µ±Spring BootÓë `@ConfigurationProperties` Bean°ó¶¨Ê±£¬ËüÊÔͼ½«Íⲿapplication propertiesÇ¿ÖÆ¸ÄΪÕýÈ·µÄÀàÐÍ¡£ Èç¹ûÄãÐèÒª×Ô¶¨ÒåÀàÐÍת»»£¬Äã¿ÉÒÔÌṩһ¸ö `ConversionService` bean£¨BeanµÄÃû³ÆÎª `conversionService` £©»ò×Ô¶¨ÒåÊôÐԱ༭Æ÷£¨Í¨¹ý `CustomEditorConfigurer` bean£©»ò×Ô¶¨Òå `Converters` Bean£¨Ê¹Óà `@ConfigurationPropertiesBinding` ×¢½â£©¡£ +当Spring Boot与 `@ConfigurationProperties` Bean绑定时,它试图将外部application properties强制改为正确的类型。 如果你需è¦�自定义类型转æ�¢ï¼Œä½ å�¯ä»¥æ��供一个 `ConversionService` bean(Beançš„å��称为 `conversionService` )或自定义属性编辑器(通过 `CustomEditorConfigurer` bean)或自定义 `Converters` Bean(使用 `@ConfigurationPropertiesBinding` 注解)。 -| | ÓÉÓÚÕâ¸öBeanÊÇÔÚÓ¦ÓóÌÐòÉúÃüÖÜÆÚµÄÔçÆÚ±»ÇëÇóµÄ£¬ÇëÈ·±£ÏÞÖÆÄãµÄ `ConversionService` ËùʹÓõÄÒÀÀµ¹ØÏµ¡£ ͨ³£Çé¿öÏ£¬ÄãËùÐèÒªµÄÈκÎÒÀÀµ¹ØÏµÔÚ´´½¨Ê±¿ÉÄÜûÓÐÍêÈ«³õʼ»¯¡£ Èç¹ûÄãµÄ×Ô¶¨Òå `ConversionService` ²»ÐèÒªÅäÖÃkeys coercion£¬Äã¿ÉÄÜÏëÖØÃüÃûËü£¬²¢ÇÒÖ»ÒÀÀµÓà `@ConfigurationPropertiesBinding` ÏÞ¶¨µÄ×Ô¶¨Òåת»»Æ÷¡£ | +| | 由于这个Bean是在应用程åº�生命周期的早期被请求的,请确ä¿�é™�制你的 `ConversionService` 所使用的ä¾�赖关系。 通常情况下,你所需è¦�的任何ä¾�赖关系在创建时å�¯èƒ½æ²¡æœ‰å®Œå…¨åˆ�始化。 如果你的自定义 `ConversionService` ä¸�需è¦�é…�ç½®keys coercion,你å�¯èƒ½æƒ³é‡�命å��它,并且å�ªä¾�赖用 `@ConfigurationPropertiesBinding` é™�定的自定义转æ�¢å™¨ã€‚ | | --- | --- | -##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion.durations)ת»»Îª Duration +##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion.durations)转æ�¢ä¸º Duration -Spring Boot¶Ô±í´ï³ÖÐøÊ±¼äÓÐרÃŵÄÖ§³Ö¡£ Èç¹ûÄ㹫¿ªÁËÒ»¸ö `java.time.Duration` ÊôÐÔ£¬application propertiesÖеÄÒÔϸñʽ¾Í¿ÉÓᣠ+Spring Boot对表达æŒ�续时间有专门的支æŒ�。 如果你公开了一个 `java.time.Duration` 属性,application properties中的以下格å¼�å°±å�¯ç”¨ã€‚ -* ÆÕͨµÄ `long` £¨Ê¹ÓúÁÃë×÷ΪĬÈϵ¥Î»£¬³ý·ÇÖ¸¶¨ÁË `@DurationUnit` £©¡£ +* 普通的 `long` (使用毫秒作为默认å�•ä½�,除é�žæŒ‡å®šäº† `@DurationUnit` )。 -* ±ê×¼µÄISO-8601¸ñʽ [ÓÉ `java.time.Duration` ʹÓÃ](https://docs.oracle.com/javase/17/docs/api/java/time/Duration.html#parse-java.lang.CharSequence-)¡£ +* 标准的ISO-8601æ ¼å¼� [ç”± `java.time.Duration` 使用](https://docs.oracle.com/javase/17/docs/api/java/time/Duration.html#parse-java.lang.CharSequence-)。 -* Ò»¸ö¸üÒ×¶ÁµÄ¸ñʽ£¬ÆäÖÐÖµºÍµ¥Î»ÊÇñîºÏµÄ£¨`10s` ±íʾ10Ã룩¡£ +* 一个更易读的格å¼�,其中值和å�•ä½�是耦å�ˆçš„(`10s` 表示10秒)。 -Ç뿼ÂÇÒÔÏÂÀý×Ó¡£ +请考虑以下例å­�。 @@ -2561,43 +2561,43 @@ public class MyProperties { -ÒªÖ¸¶¨Ò»¸ö30ÃëµÄ»á»°³¬Ê±£¬ `30` ¡¢ `PT30S` ºÍ `30s` ¶¼Êǵȼ۵ġ£ ¶ÁÈ¡³¬Ê±Îª500ms£¬¿ÉÒÔÓÃÒÔÏÂÈκÎÒ»ÖÖÐÎʽָ¶¨¡£ `500`, `PT0.5S` ºÍ `500ms`. +è¦�指定一个30秒的会è¯�超时, `30` ã€� `PT30S` å’Œ `30s` 都是等价的。 读å�–超时为500ms,å�¯ä»¥ç”¨ä»¥ä¸‹ä»»ä½•一ç§�å½¢å¼�指定。 `500`, `PT0.5S` å’Œ `500ms`. -ÄãÒ²¿ÉÒÔʹÓÃÈçÏÂÖ§³ÖµÄʱ¼äµ¥Î»¡£ +你也å�¯ä»¥ä½¿ç”¨å¦‚下支æŒ�的时间å�•ä½�。 -* `ns` ÄÉÃë +* `ns` 纳秒 -* `us` ΢Ãë +* `us` 微秒 -* `ms` ºÁÃë +* `ms` 毫秒 -* `s` Ãë +* `s` ç§’ -* `m` ·Ö +* `m` 分 -* `h` Сʱ +* `h` å°�æ—¶ -* `d` Ìì +* `d` 天 -ĬÈϵ¥Î»ÊǺÁÃ룬¿ÉÒÔʹÓà `@DurationUnit` À´ÖØÐ´£¬ÈçÉÏÃæµÄÀý×ÓËùʾ¡£ +默认å�•ä½�是毫秒,å�¯ä»¥ä½¿ç”¨ `@DurationUnit` æ�¥é‡�写,如上é�¢çš„例å­�所示。 -Èç¹ûÄãϲ»¶Ê¹Óù¹Ô캯Êý°ó¶¨£¬Í¬ÑùµÄÊôÐÔ¿ÉÒÔ±»±©Â¶³öÀ´£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +如果你喜欢使用构造函数绑定,å�Œæ ·çš„属性å�¯ä»¥è¢«æš´éœ²å‡ºæ�¥ï¼Œå¦‚下é�¢çš„例å­�所示。 @@ -2637,7 +2637,7 @@ public class MyProperties { -| | Èç¹ûÄãÒªÉý¼¶Ò»¸ö `Long` µÄÊôÐÔ£¬Èç¹ûËü²»ÊǺÁÃ룬ÇëÈ·±£¶¨Ò嵥λ£¨Ê¹Óà `@DurationUnit` £©¡£ ÕâÑù×öÌṩÁËÒ»¸ö͸Ã÷µÄÉý¼¶Â·¾¶£¬Í¬Ê±Ö§³Ö¸ü·á¸»µÄ¸ñʽ | +| | 如果你è¦�å�‡çº§ä¸€ä¸ª `Long` 的属性,如果它ä¸�是毫秒,请确ä¿�定义å�•ä½�(使用 `@DurationUnit` )。 这样å�šæ��供了一个é€�明的å�‡çº§è·¯å¾„,å�Œæ—¶æ”¯æŒ�更丰富的格å¼� | | --- | --- | @@ -2646,45 +2646,45 @@ public class MyProperties { -##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion.periods)ת»»ÎªÆÚ¼ä£¨Period£© +##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion.periods)转æ�¢ä¸ºæœŸé—´ï¼ˆPeriod) -³ýÁËduration£¬Spring Boot»¹¿ÉÒÔʹÓà `java.time.Period` ÀàÐÍ¡£ ÒÔϸñʽ¿ÉÒÔÔÚapplication propertiesÖÐʹÓᣠ+除了duration,Spring Boot还å�¯ä»¥ä½¿ç”¨ `java.time.Period` 类型。 以下格å¼�å�¯ä»¥åœ¨application properties中使用。 -* Ò»¸ö³£¹æµÄ `int` ±íʾ·¨£¨Ê¹ÓÃÌì×÷ΪĬÈϵ¥Î»£¬³ý·ÇÖ¸¶¨ÁË `@PeriodUnit` £©¡£ +* 一个常规的 `int` 表示法(使用天作为默认å�•ä½�,除é�žæŒ‡å®šäº† `@PeriodUnit` )。 -* ±ê×¼µÄISO-8601¸ñʽ [ÓÉ `java.time.Period` ʹÓÃ](https://docs.oracle.com/javase/17/docs/api/java/time/Period.html#parse-java.lang.CharSequence-)¡£ +* 标准的ISO-8601æ ¼å¼� [ç”± `java.time.Period` 使用](https://docs.oracle.com/javase/17/docs/api/java/time/Period.html#parse-java.lang.CharSequence-)。 -* Ò»¸ö¸ü¼òµ¥µÄ¸ñʽ£¬ÆäÖÐÖµºÍµ¥Î»¶ÔÊÇñîºÏµÄ£¨ `1y3d` ±íʾ1Äê3Ì죩¡£ +* 一个更简å�•的格å¼�,其中值和å�•ä½�对是耦å�ˆçš„( `1y3d` 表示1å¹´3天)。 -Ö§³ÖÏÂÁмòµ¥µÄµ¥Î»¸ñʽ¡£ +支æŒ�下列简å�•çš„å�•ä½�æ ¼å¼�。 -* `y` Äê +* `y` å¹´ -* `m` Ô +* `m` 月 -* `w` ÖÜ +* `w` 周 -* `d` ÈÕ +* `d` æ—¥ -| | `java.time.Period` ÀàÐÍʵ¼ÊÉÏ´Óδ´æ´¢¹ýÖÜÊý£¬ËüÊÇÒ»¸ö¿ì½Ý·½Ê½£¬Òâζ×Å ¡°7Ì족¡£ | +| | `java.time.Period` 类型实际上从未存储过周数,它是一个快æ�·æ–¹å¼�,æ„�味ç�€ “7天â€�。 | | --- | --- | @@ -2693,25 +2693,25 @@ public class MyProperties { -##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion.data-sizes)ת»»ÎªÊý¾Ý´óС£¨Data Sizes£© +##### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.conversion.data-sizes)转æ�¢ä¸ºæ•°æ�®å¤§å°�(Data Sizes) -Spring FrameworkÓÐÒ»¸ö `DataSize` ÖµÀàÐÍ£¬ÒÔ×Ö½ÚΪµ¥Î»±í´ï´óС¡£ Èç¹ûÄ㹫¿ªÁËÒ»¸ö `DataSize` ÊôÐÔ£¬application propertiesÖеÄÒÔϸñʽ¾Í¿ÉÓᣠ+Spring Framework有一个 `DataSize` 值类型,以字节为å�•ä½�表达大å°�。 如果你公开了一个 `DataSize` 属性,application properties中的以下格å¼�å°±å�¯ç”¨ã€‚ -* Ò»¸ö³£¹æµÄ `long` ±íʾ£¨Ê¹ÓÃ×Ö½Ú×÷ΪĬÈϵ¥Î»£¬³ý·ÇÖ¸¶¨ÁË `@DataSizeUnit`£©¡£ +* 一个常规的 `long` 表示(使用字节作为默认å�•ä½�,除é�žæŒ‡å®šäº† `@DataSizeUnit`)。 -* Ò»¸ö¸üÒ×¶ÁµÄ¸ñʽ£¬ÆäÖÐÖµºÍµ¥Î»ÊÇñîºÏµÄ£¨`10MB` Òâζ×Å10Õ××Ö½Ú£©¡£ +* 一个更易读的格å¼�,其中值和å�•ä½�是耦å�ˆçš„(`10MB` æ„�味ç�€10兆字节)。 -¿¼ÂÇÒÔÏÂÀý×Ó¡£ +考虑以下例å­�。 @@ -2748,19 +2748,19 @@ public class MyProperties { -ÒªÖ¸¶¨Ò»¸ö10Õ××Ö½Ú£¨Mb£©µÄ»º³åÇø´óС£¬ `10` ºÍ `10MB` Êǵȼ۵ġ£ 256×ֽڵĴóСãÐÖµ¿ÉÒÔÖ¸¶¨Îª `256` »ò `256B`¡£ +è¦�指定一个10兆字节(Mb)的缓冲区大å°�, `10` å’Œ `10MB` 是等价的。 256字节的大å°�阈值å�¯ä»¥æŒ‡å®šä¸º `256` 或 `256B`。 -ÄãÒ²¿ÉÒÔʹÓÃÈçÏÂÕâЩ֧³ÖµÄµ¥Î»¡£ +你也å�¯ä»¥ä½¿ç”¨å¦‚下这些支æŒ�çš„å�•ä½�。 -* `B` ×Ö½Ú +* `B` 字节 * `KB` KB @@ -2774,13 +2774,13 @@ public class MyProperties { -ĬÈϵ¥Î»ÊÇ×Ö½Ú£¬¿ÉÒÔʹÓà `@DataSizeUnit` À´ÖØÐ´£¬ÈçÉÏÃæµÄÀý×ÓËùʾ¡£ +默认å�•ä½�是字节,å�¯ä»¥ä½¿ç”¨ `@DataSizeUnit` æ�¥é‡�写,如上é�¢çš„例å­�所示。 -Èç¹ûÄãϲ»¶Ê¹Óù¹Ô캯Êý°ó¶¨£¬Í¬ÑùµÄÊôÐÔ¿ÉÒÔ±»±©Â¶³öÀ´£¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +如果你喜欢使用构造函数绑定,å�Œæ ·çš„属性å�¯ä»¥è¢«æš´éœ²å‡ºæ�¥ï¼Œå¦‚下é�¢çš„例å­�所示。 @@ -2820,7 +2820,7 @@ public class MyProperties { -| | Èç¹ûÄãÕýÔÚÉý¼¶Ò»¸ö `Long` ÊôÐÔ£¬È·±£¶¨Ò嵥λ£¨Ê¹Óà `@DataSizeUnit`£©£¬Èç¹ûËü²»ÊÇ×Ö½Ú¡£ ÕâÑù×öÌṩÁËÒ»¸ö͸Ã÷µÄÉý¼¶Â·¾¶£¬Í¬Ê±Ö§³Ö¸ü·á¸»µÄ¸ñʽ¡£ | +| | 如果你正在å�‡çº§ä¸€ä¸ª `Long` 属性,确ä¿�定义å�•ä½�(使用 `@DataSizeUnit`),如果它ä¸�是字节。 这样å�šæ��供了一个é€�明的å�‡çº§è·¯å¾„,å�Œæ—¶æ”¯æŒ�更丰富的格å¼�。 | | --- | --- | @@ -2831,11 +2831,11 @@ public class MyProperties { -#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.validation)2.8.9\. @ConfigurationProperties УÑé +#### [](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.validation)2.8.9\. @ConfigurationProperties 校验 -ֻҪʹÓÃSpringµÄ `@Validated` ×¢½â£¬Spring Boot¾Í»á³¢ÊÔÑéÖ¤ `@ConfigurationProperties` Àà¡£ Äã¿ÉÒÔÖ±½ÓÔÚÄãµÄÅäÖÃÀàÉÏʹÓÃJSR-303µÄ `jakarta.validation` Ô¼Êø×¢½â¡£ Òª×öµ½ÕâÒ»µã£¬ÇëÈ·±£ÄãµÄclasspathÉÏÓÐÒ»¸ö¼æÈݵÄJSR-303ʵÏÖ£¬È»ºó½«Ô¼Êø×¢½âÌí¼Óµ½ÄãµÄ×Ö¶ÎÖУ¬ÈçÏÂÃæµÄÀý×ÓËùʾ¡£ +å�ªè¦�使用Springçš„ `@Validated` 注解,Spring Boot就会å°�试验è¯� `@ConfigurationProperties` 类。 ä½ å�¯ä»¥ç›´æŽ¥åœ¨ä½ çš„é…�置类上使用JSR-303çš„ `jakarta.validation` 约æ�Ÿæ³¨è§£ã€‚ è¦�å�šåˆ°è¿™ä¸€ç‚¹ï¼Œè¯·ç¡®ä¿�ä½ çš„classpath上有一个兼容的JSR-303实现,然å�Žå°†çº¦æ�Ÿæ³¨è§£æ·»åŠ åˆ°ä½ çš„å­—æ®µä¸­ï¼Œå¦‚ä¸‹é�¢çš„例å­�所示。 @@ -2871,14 +2871,14 @@ public class MyProperties { -| | ÄãÒ²¿ÉÒÔͨ¹ýÔÚ configuration properties µÄ `@Bean` ·½·¨ÉÏ×¢½â `@Validated` À´´¥·¢ÑéÖ¤¡£ | +| | 你也å�¯ä»¥é€šè¿‡åœ¨ configuration properties çš„ `@Bean` 方法上注解 `@Validated` æ�¥è§¦å�‘验è¯�。 | | --- | --- | -ΪÁËÈ·±£×ÜÊÇΪǶÌ×µÄÊôÐÔ´¥·¢ÑéÖ¤£¬¼´Ê¹Ã»ÓÐÕÒµ½ÊôÐÔ£¬Ïà¹ØµÄ×ֶαØÐëÓà `@Valid` À´×¢ÊÍ¡£ ÏÂÃæµÄÀý×Ó½¨Á¢ÔÚÇ°ÃæµÄ `MyProperties` µÄ»ù´¡ÉÏ¡£ +为了确ä¿�总是为嵌套的属性触å�‘验è¯�,å�³ä½¿æ²¡æœ‰æ‰¾åˆ°å±žæ€§ï¼Œç›¸å…³çš„字段必须用 `@Valid` æ�¥æ³¨é‡Šã€‚ 下é�¢çš„例å­�建立在å‰�é�¢çš„ `MyProperties` 的基础上。 @@ -2926,13 +2926,13 @@ public class MyProperties { -ÄãÒ²¿ÉÒÔͨ¹ý´´½¨Ò»¸öÃûΪ `configurationPropertiesValidator` µÄbean¶¨ÒåÀ´Ìí¼ÓÒ»¸ö×Ô¶¨ÒåµÄSpring `Validator`¡£ `@Bean` ·½·¨Ó¦¸Ã±»ÉùÃ÷Ϊ `static`¡£ ÅäÖÃÊôÐÔÑéÖ¤Æ÷ÊÇÔÚÓ¦ÓóÌÐòÉúÃüÖÜÆÚµÄÔçÆÚ´´½¨µÄ£¬½« `@Bean` ·½·¨ÉùÃ÷Ϊ¾²Ì¬£¬¿ÉÒÔÈÃBeanµÄ´´½¨²»ÐèҪʵÀý»¯ `@Configuration` Àà¡£ ÕâÑù×ö¿ÉÒÔ±ÜÃâ¹ýÔçʵÀý»¯¿ÉÄÜÒýÆðµÄÈκÎÎÊÌâ¡£ +你也å�¯ä»¥é€šè¿‡åˆ›å»ºä¸€ä¸ªå��为 `configurationPropertiesValidator` çš„bean定义æ�¥æ·»åŠ ä¸€ä¸ªè‡ªå®šä¹‰çš„Spring `Validator`。 `@Bean` 方法应该被声明为 `static`。 é…�置属性验è¯�器是在应用程åº�生命周期的早期创建的,将 `@Bean` 方法声明为é�™æ€�,å�¯ä»¥è®©Bean的创建ä¸�需è¦�实例化 `@Configuration` 类。 这样å�šå�¯ä»¥é�¿å…�过早实例化å�¯èƒ½å¼•起的任何问题。 -| | `spring-boot-actuator` Ä£¿é°üÀ¨Ò»¸ö±©Â¶ËùÓÐ `@ConfigurationProperties` Bean µÄ¶Ëµã¡£ Äã¿ÉÒÔͨ¹ýä¯ÀÀÆ÷·ÃÎÊ `/actuator/configprops` »òʹÓÃÏàÓ¦µÄJMX¶Ëµã¡£ ÏêÇé¼û"[Éú²ú¾ÍÐ÷](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints)"²¿·Ö¡£ | +| | `spring-boot-actuator` 模å�—包括一个暴露所有 `@ConfigurationProperties` Bean 的端点。 ä½ å�¯ä»¥é€šè¿‡æµ�览器访问 `/actuator/configprops` 或使用相应的JMX端点。 详情è§�"[生产就绪](https://springdoc.cn/spring-boot/actuator.html#actuator.endpoints)"部分。 | | --- | --- | @@ -2945,33 +2945,33 @@ public class MyProperties { -`@Value` ×¢½âÊÇÒ»¸öºËÐĵÄÈÝÆ÷¹¦ÄÜ£¬Ëü²»ÌṩÓëÀàÐͰ²È«µÄÅäÖÃÊôÐÔÏàͬµÄ¹¦ÄÜ¡£ ϱí×ܽáÁË `@ConfigurationProperties` ºÍ `@Value` ËùÖ§³ÖµÄ¹¦ÄÜ¡£ +`@Value` 注解是一个核心的容器功能,它ä¸�æ��供与类型安全的é…�置属性相å�Œçš„功能。 下表总结了 `@ConfigurationProperties` å’Œ `@Value` 所支æŒ�的功能。 -| ¹¦ÄÜ | `@ConfigurationProperties` | `@Value` | +| 功能 | `@ConfigurationProperties` | `@Value` | | --- | --- | --- | -| [¿íËɰó¶¨](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) | Yes | ÓÐÏÞÖÆ (¼û [ÏÂÎÄ×¢ÊÍ](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.vs-value-annotation.note)) | -| [Ö§³Ö Meta-data](https://springdoc.cn/spring-boot/configuration-metadata.html#appendix.configuration-metadata) | Yes | No | -| `SpEL` ±í´ïʽ | No | Yes | +| [宽æ�¾ç»‘定](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) | Yes | 有é™�制 (è§� [下文注释](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.vs-value-annotation.note)) | +| [支æŒ� Meta-data](https://springdoc.cn/spring-boot/configuration-metadata.html#appendix.configuration-metadata) | Yes | No | +| `SpEL` 表达å¼� | No | Yes | -| | Èç¹ûÄãȷʵÏëʹÓà `@Value`£¬ÎÒÃǽ¨ÒéÄãʹÓÃÊôÐÔÃû³ÆµÄ¹æ·¶ÐÎʽ£¨½öʹÓÃСд×ÖĸµÄkebab-case£©À´ÒýÓÃÊôÐÔÃû³Æ¡£ Õ⽫ÔÊÐíSpring BootʹÓÃÓë [¿íËɰó¶¨](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) `@ConfigurationProperties` ʱÏàͬµÄÂß¼­¡£ÀýÈ磬`@Value("${demo.item-price}")` ½«´Ó `application.properties` ÎļþÖлñÈ¡ `demo.item-price` ºÍ `demo.itemPrice` ÐÎʽ£¬ÒÔ¼°´Óϵͳ»·¾³ÖлñÈ¡ `DEMO_ITEMPRICE`¡£ Èç¹ûÄãÓà `@Value("${demo.itemPrice}")` ´úÌæ£¬`demo.item-price` ºÍ `DEMO_ITEMPRICE` ½«²»»á±»¿¼ÂÇ¡£ | +| | 如果你确实想使用 `@Value`,我们建议你使用属性å��称的规范形å¼�(仅使用å°�写字æ¯�çš„kebab-case)æ�¥å¼•用属性å��称。 这将å…�许Spring Boot使用与 [宽æ�¾ç»‘定](https://springdoc.cn/spring-boot/features.html#features.external-config.typesafe-configuration-properties.relaxed-binding) `@ConfigurationProperties` 时相å�Œçš„逻辑。例如,`@Value("${demo.item-price}")` 将从 `application.properties` 文件中获å�– `demo.item-price` å’Œ `demo.itemPrice` å½¢å¼�,以å�Šä»Žç³»ç»ŸçŽ¯å¢ƒä¸­èŽ·å�– `DEMO_ITEMPRICE`。 如果你用 `@Value("${demo.itemPrice}")` 代替,`demo.item-price` å’Œ `DEMO_ITEMPRICE` å°†ä¸�会被考虑。 | | --- | --- | -Èç¹ûÄãΪÄã×Ô¼ºµÄ×é¼þ¶¨ÒåÁËÒ»×éÅäÖüü£¬ÎÒÃǽ¨ÒéÄ㽫ËüÃÇ·Ö×éÔÚÒ»¸öÓà `@ConfigurationProperties` ×¢½âµÄPOJOÖС£ ÕâÑù×ö½«ÎªÄãÌṩ½á¹¹»¯µÄ¡¢ÀàÐͰ²È«µÄ¶ÔÏó£¬Äã¿ÉÒÔ½«Æä×¢Èëµ½Äã×Ô¼ºµÄbeanÖС£ +如果你为你自己的组件定义了一组é…�置键,我们建议你将它们分组在一个用 `@ConfigurationProperties` 注解的POJO中。 这样å�šå°†ä¸ºä½ æ��供结构化的ã€�类型安全的对象,你å�¯ä»¥å°†å…¶æ³¨å…¥åˆ°ä½ è‡ªå·±çš„bean中。 -À´×ÔÓ¦ÓÃ[application property](https://springdoc.cn/spring-boot/features.html#features.external-config.files) ÎļþµÄ `SpEL` ±í´ïʽÔÚ½âÎöÕâЩÎļþºÍÌî³äenvironmentʱ²»»á±»´¦Àí¡£ È»¶ø£¬¿ÉÒÔÔÚ `@Value` ÖÐдһ¸ö `SpEL` ±í´ïʽ¡£ Èç¹ûÀ´×ÔÓ¦ÓóÌÐòÊôÐÔÎļþµÄÊôÐÔÖµÊÇÒ»¸ö `SpEL` ±í´ïʽ£¬Ëü½«ÔÚ±» `@Value` Ïû·Ñʱ±»½âÎö¡£ +æ�¥è‡ªåº”用[application property](https://springdoc.cn/spring-boot/features.html#features.external-config.files) 文件的 `SpEL` 表达å¼�在解æž�这些文件和填充environmentæ—¶ä¸�会被处ç�†ã€‚ 然而,å�¯ä»¥åœ¨ `@Value` 中写一个 `SpEL` 表达å¼�。 如果æ�¥è‡ªåº”用程åº�属性文件的属性值是一个 `SpEL` 表达å¼�,它将在被 `@Value` 消费时被解æž�。 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\350\207\252\345\270\246\347\232\204\347\203\255\351\203\250\347\275\262\345\267\245\345\205\267.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\350\207\252\345\270\246\347\232\204\347\203\255\351\203\250\347\275\262\345\267\245\345\205\267.md" index 477370a..e8be143 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\350\207\252\345\270\246\347\232\204\347\203\255\351\203\250\347\275\262\345\267\245\345\205\267.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\350\207\252\345\270\246\347\232\204\347\203\255\351\203\250\347\275\262\345\267\245\345\205\267.md" @@ -1,58 +1,58 @@ -# SpringBootÈëÃÅ - ÅäÖÃÈȲ¿Êðdevtools¹¤¾ß +# SpringBoot入门 - é…�置热部署devtools工具 -> ÔÚSpringBoot¿ª·¢µ÷ÊÔÖУ¬Èç¹ûÎÒÿÐдúÂëµÄÐ޸ͼÐèÒªÖØÆôÆô¶¯ÔÙµ÷ÊÔ£¬¿ÉÄܱȽϷÑʱ¼ä£»SpringBootÍŶÓÕë¶Ô´ËÎÊÌâÌṩÁËspring-boot-devtools£¨¼ò³Ædevtools£©²å¼þ£¬ËüÊÔͼÌáÉý¿ª·¢µ÷ÊÔµÄЧÂÊ¡£@pdai +> 在SpringBootå¼€å�‘调试中,如果我æ¯�行代ç �的修改都需è¦�é‡�å�¯å�¯åЍå†�调试,å�¯èƒ½æ¯”较费时间;SpringBoot团队针对此问题æ��供了spring-boot-devtools(简称devtools)æ�’件,它试图æ��å�‡å¼€å�‘调试的效率。@pdai -* [SpringBootÈëÃÅ - ÅäÖÃÈȲ¿Êðdevtools¹¤¾ß](#springboot%E5%85%A5%E9%97%A8---%E9%85%8D%E7%BD%AE%E7%83%AD%E9%83%A8%E7%BD%B2devtools%E5%B7%A5%E5%85%B7) - * [×¼±¸ÖªÊ¶µã](#%E5%87%86%E5%A4%87%E7%9F%A5%E8%AF%86%E7%82%B9) - * [ʲôÊÇÈȲ¿ÊðºÍÈȼÓÔØ£¿](#%E4%BB%80%E4%B9%88%E6%98%AF%E7%83%AD%E9%83%A8%E7%BD%B2%E5%92%8C%E7%83%AD%E5%8A%A0%E8%BD%BD) - * [ʲôÊÇLiveLoad£¿](#%E4%BB%80%E4%B9%88%E6%98%AFliveload) - * [ÅäÖÃdevtoolsʵÏÖÈȲ¿Êð](#%E9%85%8D%E7%BD%AEdevtools%E5%AE%9E%E7%8E%B0%E7%83%AD%E9%83%A8%E7%BD%B2) - * [POMÅäÖÃ](#pom%E9%85%8D%E7%BD%AE) - * [IDEAÅäÖÃ](#idea%E9%85%8D%E7%BD%AE) - * [application.ymlÅäÖÃ](#applicationyml%E9%85%8D%E7%BD%AE) - * [ʹÓÃLiveLoad](#%E4%BD%BF%E7%94%A8liveload) - * [½øÒ»²½Àí½â](#%E8%BF%9B%E4%B8%80%E6%AD%A5%E7%90%86%E8%A7%A3) - * [devtoolµÄÔ­Àí£¿ÎªºÎ»á×Ô¶¯ÖØÆô£¿](#devtool%E7%9A%84%E5%8E%9F%E7%90%86%E4%B8%BA%E4%BD%95%E4%BC%9A%E8%87%AA%E5%8A%A8%E9%87%8D%E5%90%AF) - * [devtoolÊÇ·ñ»á±»´ò°ü½øJar£¿](#devtool%E6%98%AF%E5%90%A6%E4%BC%9A%E8%A2%AB%E6%89%93%E5%8C%85%E8%BF%9Bjar) - * [devtoolΪºÎ»áĬÈϽûÓûº´æÑ¡Ï](#devtool%E4%B8%BA%E4%BD%95%E4%BC%9A%E9%BB%98%E8%AE%A4%E7%A6%81%E7%94%A8%E7%BC%93%E5%AD%98%E9%80%89%E9%A1%B9) - * [devtoolÊÇ·ñ¿ÉÒÔ¸øËùÓÐSpringbootÓ¦ÓÃ×öÈ«¾ÖµÄÅäÖã¿](#devtool%E6%98%AF%E5%90%A6%E5%8F%AF%E4%BB%A5%E7%BB%99%E6%89%80%E6%9C%89springboot%E5%BA%94%E7%94%A8%E5%81%9A%E5%85%A8%E5%B1%80%E7%9A%84%E9%85%8D%E7%BD%AE) - * [Èç¹ûÎÒ²»ÓÃdevtool£¬»¹ÓÐʲôѡÔñ£¿](#%E5%A6%82%E6%9E%9C%E6%88%91%E4%B8%8D%E7%94%A8devtool%E8%BF%98%E6%9C%89%E4%BB%80%E4%B9%88%E9%80%89%E6%8B%A9) - * [ʾÀýÔ´Âë](#%E7%A4%BA%E4%BE%8B%E6%BA%90%E7%A0%81) - * [²Î¿¼ÎÄÕÂ](#%E5%8F%82%E8%80%83%E6%96%87%E7%AB%A0) +* [SpringBoot入门 - é…�置热部署devtools工具](#springboot%E5%85%A5%E9%97%A8---%E9%85%8D%E7%BD%AE%E7%83%AD%E9%83%A8%E7%BD%B2devtools%E5%B7%A5%E5%85%B7) + * [准备知识点](#%E5%87%86%E5%A4%87%E7%9F%A5%E8%AF%86%E7%82%B9) + * [什么是热部署和热加载?](#%E4%BB%80%E4%B9%88%E6%98%AF%E7%83%AD%E9%83%A8%E7%BD%B2%E5%92%8C%E7%83%AD%E5%8A%A0%E8%BD%BD) + * [什么是LiveLoad?](#%E4%BB%80%E4%B9%88%E6%98%AFliveload) + * [é…�ç½®devtools实现热部署](#%E9%85%8D%E7%BD%AEdevtools%E5%AE%9E%E7%8E%B0%E7%83%AD%E9%83%A8%E7%BD%B2) + * [POMé…�ç½®](#pom%E9%85%8D%E7%BD%AE) + * [IDEAé…�ç½®](#idea%E9%85%8D%E7%BD%AE) + * [application.ymlé…�ç½®](#applicationyml%E9%85%8D%E7%BD%AE) + * [使用LiveLoad](#%E4%BD%BF%E7%94%A8liveload) + * [进一步ç�†è§£](#%E8%BF%9B%E4%B8%80%E6%AD%A5%E7%90%86%E8%A7%A3) + * [devtool的原ç�†ï¼Ÿä¸ºä½•会自动é‡�å�¯ï¼Ÿ](#devtool%E7%9A%84%E5%8E%9F%E7%90%86%E4%B8%BA%E4%BD%95%E4%BC%9A%E8%87%AA%E5%8A%A8%E9%87%8D%E5%90%AF) + * [devtool是å�¦ä¼šè¢«æ‰“包进Jar?](#devtool%E6%98%AF%E5%90%A6%E4%BC%9A%E8%A2%AB%E6%89%93%E5%8C%85%E8%BF%9Bjar) + * [devtool为何会默认ç¦�用缓存选项?](#devtool%E4%B8%BA%E4%BD%95%E4%BC%9A%E9%BB%98%E8%AE%A4%E7%A6%81%E7%94%A8%E7%BC%93%E5%AD%98%E9%80%89%E9%A1%B9) + * [devtool是å�¦å�¯ä»¥ç»™æ‰€æœ‰Springboot应用å�šå…¨å±€çš„é…�置?](#devtool%E6%98%AF%E5%90%A6%E5%8F%AF%E4%BB%A5%E7%BB%99%E6%89%80%E6%9C%89springboot%E5%BA%94%E7%94%A8%E5%81%9A%E5%85%A8%E5%B1%80%E7%9A%84%E9%85%8D%E7%BD%AE) + * [如果我ä¸�用devtool,还有什么选择?](#%E5%A6%82%E6%9E%9C%E6%88%91%E4%B8%8D%E7%94%A8devtool%E8%BF%98%E6%9C%89%E4%BB%80%E4%B9%88%E9%80%89%E6%8B%A9) + * [示例æº�ç �](#%E7%A4%BA%E4%BE%8B%E6%BA%90%E7%A0%81) + * [å�‚考文章](#%E5%8F%82%E8%80%83%E6%96%87%E7%AB%A0) -## [#](#×¼±¸ÖªÊ¶µã) ×¼±¸ÖªÊ¶µã +## [#](#准备知识点) 准备知识点 -### [#](#ʲôÊÇÈȲ¿ÊðºÍÈȼÓÔØ) ʲôÊÇÈȲ¿ÊðºÍÈȼÓÔØ£¿ +### [#](#什么是热部署和热加载) 什么是热部署和热加载? -> ÈȲ¿ÊðºÍÈȼÓÔØÊÇÔÚÓ¦ÓÃÕýÔÚÔËÐеÄʱºò£¬×Ô¶¯¸üУ¨ÖØÐ¼ÓÔØ»òÕßÌæ»»classµÈ£©Ó¦ÓõÄÒ»ÖÖÄÜÁ¦¡££¨PS£ºspring-boot-devtoolsÌṩµÄ·½°¸Ò²ÊÇÒªÖØÆôµÄ£¬Ö»ÊÇÎÞÐèÊÖ¶¯ÖØÆôÄÜʵÏÖ×Ô¶¯¼ÓÔØ¶øÒÑ¡££© +> 热部署和热加载是在应用正在è¿�行的时候,自动更新(é‡�新加载或者替æ�¢class等)应用的一ç§�能力。(PS:spring-boot-devtoolsæ��供的方案也是è¦�é‡�å�¯çš„,å�ªæ˜¯æ— éœ€æ‰‹åЍé‡�å�¯èƒ½å®žçŽ°è‡ªåŠ¨åŠ è½½è€Œå·²ã€‚ï¼‰ -ÑϸñÒâÒåÉÏ£¬ÎÒÃÇÐè񻂿·ÖÏÂÈȲ¿ÊðºÍÈȼÓÔØ, ¶ÔÓÚJavaÏîÄ¿¶øÑÔ£º +严格æ„�义上,我们需è¦�区分下热部署和热加载, 对于Java项目而言: -* **ÈȲ¿Êð** +* **热部署** - * ÔÚ·þÎñÆ÷ÔËÐÐÊ±ÖØÐ²¿ÊðÏîÄ¿ - * ËüÊÇÖ±½ÓÖØÐ¼ÓÔØÕû¸öÓ¦Óã¬ÕâÖÖ·½Ê½»áÊÍ·ÅÄڴ棬±ÈÈȼÓÔØ¸ü¼Ó¸É¾»³¹µ×£¬µ«Í¬Ê±Ò²¸ü·Ñʱ¼ä¡£ -* **ÈȼÓÔØ** + * 在æœ�务器è¿�行时é‡�新部署项目 + * 它是直接é‡�新加载整个应用,这ç§�æ–¹å¼�会释放内存,比热加载更加干净彻底,但å�Œæ—¶ä¹Ÿæ›´è´¹æ—¶é—´ã€‚ +* **热加载** - * ÔÚÔÚÔËÐÐÊ±ÖØÐ¼ÓÔØclass£¬´Ó¶øÉý¼¶Ó¦Óᣠ- * ÈȼÓÔØµÄʵÏÖÔ­ÀíÖ÷ÒªÒÀÀµ[javaµÄÀà¼ÓÔØ»úÖÆ](/md/java/jvm/java-jvm-classload.html)£¬ÔÚʵÏÖ·½Ê½¿ÉÒÔ¸ÅÀ¨ÎªÔÚÈÝÆ÷Æô¶¯µÄʱºòÆðÒ»Ìõºǫ́Ị̈߳¬¶¨Ê±µÄ¼ì²âÀàÎļþµÄʱ¼ä´Á±ä»¯£¬Èç¹ûÀàµÄʱ¼ä´Á±äµôÁË£¬Ôò½«ÀàÖØÐÂÔØÈë¡£ - * ¶Ô±È·´Éä»úÖÆ£¬·´ÉäÊÇÔÚÔËÐÐʱ»ñÈ¡ÀàÐÅÏ¢£¬Í¨¹ý¶¯Ì¬µÄµ÷ÓÃÀ´¸Ä±ä³ÌÐòÐÐΪ£» ÈȼÓÔØÔòÊÇÔÚÔËÐÐʱͨ¹ýÖØÐ¼ÓÔØ¸Ä±äÀàÐÅÏ¢£¬Ö±½Ó¸Ä±ä³ÌÐòÐÐΪ¡£ + * 在在è¿�行时é‡�新加载class,从而å�‡çº§åº”用。 + * 热加载的实现原ç�†ä¸»è¦�ä¾�èµ–[java的类加载机制](/md/java/jvm/java-jvm-classload.html),在实现方å¼�å�¯ä»¥æ¦‚括为在容器å�¯åŠ¨çš„æ—¶å€™èµ·ä¸€æ�¡å�Žå�°çº¿ç¨‹ï¼Œå®šæ—¶çš„æ£€æµ‹ç±»æ–‡ä»¶çš„æ—¶é—´æˆ³å�˜åŒ–,如果类的时间戳å�˜æŽ‰äº†ï¼Œåˆ™å°†ç±»é‡�新载入。 + * 对比å��射机制,å��射是在è¿�行时获å�–类信æ�¯ï¼Œé€šè¿‡åЍæ€�的调用æ�¥æ”¹å�˜ç¨‹åº�行为; 热加载则是在è¿�行时通过é‡�新加载改å�˜ç±»ä¿¡æ�¯ï¼Œç›´æŽ¥æ”¹å�˜ç¨‹åº�行为。 -### [#](#ʲôÊÇliveload) ʲôÊÇLiveLoad£¿ +### [#](#什么是liveload) 什么是LiveLoad? -LiveLoadÊÇÌṩä¯ÀÀÆ÷¿Í»§¶Ë×Ô¶¯¼ÓÔØ¸üÐµĹ¤¾ß£¬·ÖΪLiveLoad·þÎñÆ÷ºÍLiveloadä¯ÀÀÆ÷²å¼þÁ½²¿·Ö£» devtoolsÖÐÒѾ­¼¯³ÉÁËLiveLoad·þÎñÆ÷£¬ËùÒÔÈç¹ûÎÒÃÇ¿ª·¢µÄÊÇwebÓ¦Ó㬲¢ÇÒÆÚÍûä¯ÀÀÆ÷×Ô¶¯Ë¢Ð£¬ Õâʱºò¿ÉÒÔ¿¼ÂÇLiveLoad. +LiveLoad是æ��ä¾›æµ�览器客户端自动加载更新的工具,分为LiveLoadæœ�务器和Liveloadæµ�览器æ�’件两部分; devtools中已ç»�集æˆ�了LiveLoadæœ�务器,所以如果我们开å�‘的是web应用,并且期望æµ�览器自动刷新, 这时候å�¯ä»¥è€ƒè™‘LiveLoad. ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205152.png) -ͬһʱ¼äÖ»ÄÜÔËÐÐÒ»¸öLiveReload·þÎñÆ÷¡£ ¿ªÊ¼Ó¦ÓóÌÐò֮ǰ£¬ÇëÈ·±£Ã»ÓÐÆäËûLiveReload·þÎñÆ÷ÕýÔÚÔËÐС£Èç¹û´ÓIDEÆô¶¯¶à¸öÓ¦ÓóÌÐò£¬ÔòÖ»ÓеÚÒ»¸öÓ¦ÓóÌÐò½«Ö§³ÖLiveReload¡£ +å�Œä¸€æ—¶é—´å�ªèƒ½è¿�行一个LiveReloadæœ�务器。 开始应用程åº�之å‰�,请确ä¿�没有其他LiveReloadæœ�务器正在è¿�行。如果从IDEå�¯åŠ¨å¤šä¸ªåº”ç”¨ç¨‹åº�,则å�ªæœ‰ç¬¬ä¸€ä¸ªåº”用程åº�将支æŒ�LiveReload。 -## [#](#ÅäÖÃdevtoolsʵÏÖÈȲ¿Êð) ÅäÖÃdevtoolsʵÏÖÈȲ¿Êð +## [#](#é…�ç½®devtools实现热部署) é…�ç½®devtools实现热部署 -> ÎÒÃÇͨ¹ýÈçÏÂÅäÖÃÀ´ÊµÏÖ×Ô¶¯ÖØÆô·½Ê½µÄÈȲ¿Êð¡£ +> 我们通过如下é…�ç½®æ�¥å®žçŽ°è‡ªåŠ¨é‡�å�¯æ–¹å¼�的热部署。 -### [#](#pomÅäÖÃ) POMÅäÖà +### [#](#pomé…�ç½®) POMé…�ç½® -Ìí¼Óspring-boot-devtoolsµÄÒÀÀµ +添加spring-boot-devtoolsçš„ä¾�èµ– @@ -61,7 +61,7 @@ LiveLoad org.springframework.boot spring-boot-devtools - true + true @@ -69,37 +69,37 @@ LiveLoad -### [#](#ideaÅäÖÃ) IDEAÅäÖà +### [#](#ideaé…�ç½®) IDEAé…�ç½® -> Èç¹ûÄãʹÓÃIDEA¿ª·¢¹¤¾ß£¬Í¨³£ÓÐÈçÏÂÁ½ÖÖ·½Ê½£º +> 如果你使用IDEAå¼€å�‘工具,通常有如下两ç§�æ–¹å¼�: -* ·½Ê½Ò»£º **ÎÞÈκÎÅäÖÃʱ£¬ÊÖ¶¯´¥·¢ÖØÆô¸üУ¨Ctrl+F9£©** +* æ–¹å¼�一: **无任何é…�置时,手动触å�‘é‡�å�¯æ›´æ–°ï¼ˆCtrl+F9)** ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205320.png) -£¨Ò²¿ÉÒÔÓÃ`mvn compile`±àÒë´¥·¢ÖØÆô¸üУ© +(也å�¯ä»¥ç”¨`mvn compile`编译触å�‘é‡�å�¯æ›´æ–°ï¼‰ -* ·½Ê½¶þ£º **IDEAÐ迪ÆôÔËÐÐʱ±àÒ룬×Ô¶¯ÖØÆô¸üÐÂ** +* æ–¹å¼�二: **IDEA需开å�¯è¿�行时编译,自动é‡�å�¯æ›´æ–°** -**ÉèÖÃ1**£º +**设置1**: File->Setting->Build,Execution,Deployment->Compile -¹´Ñ¡£ºMake project automatically +勾选:Make project automatically ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205335.png) -**ÉèÖÃ2**£º +**设置2**: -¿ì½Ý¼ü£ºctrl+alt+shift+/ +å¿«æ�·é”®ï¼šctrl+alt+shift+/ -Ñ¡Ôñ£ºRegistry +选择:Registry -¹´Ñ¡£ºcompiler.automake.allow.when.app.running +勾选:compiler.automake.allow.when.app.running -а汾µÄIDEA¿ÉÒÔÔÚFile->setting->Advanced SetttingsÀïÃæµÄµÚÒ»¸öÉèÖ㺠+新版本的IDEAå�¯ä»¥åœ¨File->setting->Advanced Setttings里é�¢çš„第一个设置: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205405.png) -### [#](#application-ymlÅäÖÃ) application.ymlÅäÖà +### [#](#application-ymlé…�ç½®) application.ymlé…�ç½® @@ -107,56 +107,56 @@ File->Setting->Build,Execution,Deployment->Compile spring: devtools: restart: - enabled: true #ÉèÖÿªÆôÈȲ¿Êð - additional-paths: src/main/java #ÖØÆôĿ¼ + enabled: true #设置开å�¯çƒ­éƒ¨ç½² + additional-paths: src/main/java #é‡�å�¯ç›®å½• exclude: WEB-INF/** thymeleaf: - cache: false #ʹÓÃThymeleafÄ£°åÒýÇæ£¬¹Ø±Õ»º´æ + cache: false #使用Thymeleaf模æ�¿å¼•擎,关闭缓存 ``` -### [#](#ʹÓÃliveload) ʹÓÃLiveLoad +### [#](#使用liveload) 使用LiveLoad -spring-boot-devtoolsÄ£¿é°üº¬**ǶÈëʽLiveReload·þÎñÆ÷**£¬¿ÉÒÔÔÚ×ÊÔ´¸ü¸ÄʱÓÃÓÚ´¥·¢ä¯ÀÀÆ÷ˢС£ LiveReloadä¯ÀÀÆ÷À©Õ¹³ÌÐòÖ§³ÖChrome£¬FirefoxºÍSafari£¬Äã¿ÉÒÔ´Ólivereload.comÃâ·ÑÏÂÔØ¡£ +spring-boot-devtools模å�—包å�«**嵌入å¼�LiveReloadæœ�务器**,å�¯ä»¥åœ¨èµ„æº�更改时用于触å�‘æµ�览器刷新。 LiveReloadæµ�览器扩展程åº�支æŒ�Chrome,Firefoxå’ŒSafari,你å�¯ä»¥ä»Žlivereload.comå…�费下载。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205417.png) -»òÕß´Óä¯ÀÀÆ÷²å¼þÖÐÐÄÏÂÔØ£¬±ÈÈçfirefox: +或者从æµ�览器æ�’件中心下载,比如firefox: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205426.png) -°²×°ÍêÖ®ºó£¬¿ÉÒÔͨ¹ýÈçÏÂͼ±ê¹ÜÀí +安装完之å�Žï¼Œå�¯ä»¥é€šè¿‡å¦‚下图标管ç�† ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416205442.png) -Èç¹ûÄã²»ÏëÔÚÓ¦ÓóÌÐòÔËÐÐʱÆô¶¯LiveReload·þÎñÆ÷£¬Ôò¿ÉÒÔ½«spring.devtools.livereload.enabledÊôÐÔÉèÖÃΪfalse ¡£ +如果你ä¸�想在应用程åº�è¿�行时å�¯åЍLiveReloadæœ�务器,则å�¯ä»¥å°†spring.devtools.livereload.enabled属性设置为false 。 -ͬһʱ¼äÖ»ÄÜÔËÐÐÒ»¸öLiveReload·þÎñÆ÷¡£ ¿ªÊ¼Ó¦ÓóÌÐò֮ǰ£¬ÇëÈ·±£Ã»ÓÐÆäËûLiveReload·þÎñÆ÷ÕýÔÚÔËÐС£Èç¹û´ÓIDEÆô¶¯¶à¸öÓ¦ÓóÌÐò£¬ÔòÖ»ÓеÚÒ»¸öÓ¦ÓóÌÐò½«Ö§³ÖLiveReload¡£ +å�Œä¸€æ—¶é—´å�ªèƒ½è¿�行一个LiveReloadæœ�务器。 开始应用程åº�之å‰�,请确ä¿�没有其他LiveReloadæœ�务器正在è¿�行。如果从IDEå�¯åŠ¨å¤šä¸ªåº”ç”¨ç¨‹åº�,则å�ªæœ‰ç¬¬ä¸€ä¸ªåº”用程åº�将支æŒ�LiveReload。 -## [#](#½øÒ»²½Àí½â) ½øÒ»²½Àí½â +## [#](#进一步ç�†è§£) 进一步ç�†è§£ -> ËäȻһЩ¿ª·¢Õß»áʹÓÃdevtool¹¤¾ß£¬µ«ÊǺÜÉÙÓÐÄܹ»ÉîÈëÀí½âµÄ£»ÈÃÎÒÃÇÀí½âÈçϼ¸¸öÎÊÌ⣬°ïÖúÄã½øÒ»²½Àí½â¡£@pdai +> 虽然一些开å�‘者会使用devtool工具,但是很少有能够深入ç�†è§£çš„;让我们ç�†è§£å¦‚下几个问题,帮助你进一步ç�†è§£ã€‚@pdai -### [#](#devtoolµÄÔ­Àí-ΪºÎ»á×Ô¶¯ÖØÆô) devtoolµÄÔ­Àí£¿ÎªºÎ»á×Ô¶¯ÖØÆô£¿ +### [#](#devtool的原ç�†-为何会自动é‡�å�¯) devtool的原ç�†ï¼Ÿä¸ºä½•会自动é‡�å�¯ï¼Ÿ -> ΪʲôͬÑùÊÇÖØÆôÓ¦Óã¬ÎªÊ²Ã´²»ÊÖ¶¯ÖØÆô£¬¶øÊǽ¨ÒéʹÓÃspring-boot-devtools½øÐÐÈȲ¿ÊðÖØÆô£¿ +> 为什么å�Œæ ·æ˜¯é‡�å�¯åº”用,为什么ä¸�手动é‡�å�¯ï¼Œè€Œæ˜¯å»ºè®®ä½¿ç”¨spring-boot-devtools进行热部署é‡�å�¯ï¼Ÿ -spring-boot-devtoolsʹÓÃÁËÁ½¸öÀà¼ÓÔØÆ÷ClassLoader£¬Ò»¸öClassLoader¼ÓÔØ²»»á·¢Éú¸ü¸ÄµÄÀࣨµÚÈý·½jar°ü£©£¬ÁíÒ»¸öClassLoader£¨restart ClassLoader£©¼ÓÔØ»á¸ü¸ÄµÄÀࣨ×Ô¶¨ÒåµÄÀࣩ¡£ +spring-boot-devtools使用了两个类加载器ClassLoader,一个ClassLoader加载ä¸�会å�‘生更改的类(第三方jar包),å�¦ä¸€ä¸ªClassLoader(restart ClassLoader)加载会更改的类(自定义的类)。 -ºǫ́Æô¶¯Ò»¸ö**Îļþ¼àÌýỊ̈߳¨File Watcher£©**£¬**¼à²âµÄĿ¼ÖеÄÎļþ·¢Éú±ä¶¯Ê±£¬ Ô­À´µÄrestart ClassLoader±»¶ªÆú£¬½«»áÖØÐ¼ÓÔØÐµÄrestart ClassLoader**¡£ +å�Žå�°å�¯åŠ¨ä¸€ä¸ª**文件监å�¬çº¿ç¨‹ï¼ˆFile Watcher)**,**监测的目录中的文件å�‘生å�˜åŠ¨æ—¶ï¼Œ 原æ�¥çš„restart ClassLoader被丢弃,将会é‡�新加载新的restart ClassLoader**。 -ÒòΪÎļþ±ä¶¯ºó£¬µÚÈý·½jar°ü²»ÔÙÖØÐ¼ÓÔØ£¬Ö»¼ÓÔØ×Ô¶¨ÒåµÄÀ࣬¼ÓÔØµÄÀà±È½ÏÉÙ£¬ËùÒÔÖØÆô±È½Ï¿ì¡£ +因为文件å�˜åЍå�Žï¼Œç¬¬ä¸‰æ–¹jar包ä¸�å†�é‡�新加载,å�ªåŠ è½½è‡ªå®šä¹‰çš„ç±»ï¼ŒåŠ è½½çš„ç±»æ¯”è¾ƒå°‘ï¼Œæ‰€ä»¥é‡�å�¯æ¯”较快。 -ÕâÒ²ÊÇΪʲô£¬Í¬ÑùÊÇÖØÆôÓ¦Óã¬ÎªÊ²Ã´²»ÊÖ¶¯ÖØÆô£¬½¨ÒéʹÓÃspring-boot-devtools½øÐÐÈȲ¿ÊðÖØÆô¡£ +这也是为什么,å�Œæ ·æ˜¯é‡�å�¯åº”用,为什么ä¸�手动é‡�å�¯ï¼Œå»ºè®®ä½¿ç”¨spring-boot-devtools进行热部署é‡�å�¯ã€‚ -ÔÚ×Ô¶¯ÖØÆôÖÐÓм¸µãÐèҪעÒâ: +在自动é‡�å�¯ä¸­æœ‰å‡ ç‚¹éœ€è¦�注æ„�: -* **×Ô¶¯ÖØÆô»á¼Ç¼ÈÕÖ¾µÄ** +* **自动é‡�å�¯ä¼šè®°å½•日志的** -£¨¼Ç¼ÔÚʲôÇé¿öÏÂÖØÆôµÄÈÕÖ¾£© +(记录在什么情况下é‡�å�¯çš„æ—¥å¿—) -¿ÉÒÔͨ¹ýÈçÏÂ¹Ø±Õ +å�¯ä»¥é€šè¿‡å¦‚下关闭 @@ -170,9 +170,9 @@ spring: -* **ÅųýһЩ²»ÐèÒª×Ô¶¯ÖØÆôµÄ×ÊÔ´** +* **排除一些ä¸�需è¦�自动é‡�å�¯çš„资æº�** -ijЩ×ÊÔ´ÔÚ¸ü¸Äʱ²»Ò»¶¨ÐèÒª´¥·¢ÖØÐÂÆô¶¯¡£Ä¬ÈÏÇé¿öÏ£¬¸Ä±ä×ÊÔ´/META-INF/maven£¬/META-INF/resources£¬/resources£¬/static£¬/public£¬»ò/templates²»´¥·¢ÖØÐÂÆô¶¯£¬µ«È·»á´¥·¢ÏÖ³¡ÖØ×°¡£Èç¹ûÒª×Ô¶¨ÒåÕâЩÅųýÏ¿ÉÒÔʹÓøÃspring.devtools.restart.excludeÊôÐÔ¡£ÀýÈ磬Ҫ½öÅųý/static£¬/publicÄ㽫ÉèÖÃÒÔÏÂÊôÐÔ£º +æŸ�些资æº�在更改时ä¸�一定需è¦�触å�‘é‡�æ–°å�¯åŠ¨ã€‚é»˜è®¤æƒ…å†µä¸‹ï¼Œæ”¹å�˜èµ„æº�/META-INF/maven,/META-INF/resources,/resources,/static,/public,或/templatesä¸�触å�‘é‡�æ–°å�¯åŠ¨ï¼Œä½†ç¡®ä¼šè§¦å�‘现场é‡�装。如果è¦�自定义这些排除项,å�¯ä»¥ä½¿ç”¨è¯¥spring.devtools.restart.exclude属性。例如,è¦�仅排除/static,/public你将设置以下属性: @@ -186,15 +186,15 @@ spring: -Èç¹ûÒª±£ÁôÕâЩĬÈÏÖµ²¢Ìí¼ÓÆäËûÅųýÏÇë¸ÄÓøÃspring.devtools.restart.additional-excludeÊôÐÔ¡£ +如果è¦�ä¿�留这些默认值并添加其他排除项,请改用该spring.devtools.restart.additional-exclude属性。 -* **×Ô¶¨ÒåÖØÆôÀà¼ÓÔØÆ÷** +* **自定义é‡�å�¯ç±»åŠ è½½å™¨** -ÖØÆô¹¦ÄÜÊÇͨ¹ýʹÓÃÁ½¸öÀà¼ÓÔØÆ÷À´ÊµÏֵġ£¶ÔÓÚ´ó¶àÊýÓ¦ÓóÌÐò£¬ÕâÖÖ·½·¨Ð§¹ûºÜºÃ¡£µ«ÊÇ£¬ËüÓÐʱ»áµ¼ÖÂÀà¼ÓÔØÎÊÌâ¡£ +é‡�å�¯åŠŸèƒ½æ˜¯é€šè¿‡ä½¿ç”¨ä¸¤ä¸ªç±»åŠ è½½å™¨æ�¥å®žçŽ°çš„ã€‚å¯¹äºŽå¤§å¤šæ•°åº”ç”¨ç¨‹åº�,这ç§�方法效果很好。但是,它有时会导致类加载问题。 -ĬÈÏÇé¿öÏ£¬IDE ÖеÄÈκδò¿ªÏîÄ¿¶¼Ê¹Óá°ÖØÆô¡±Àà¼ÓÔØÆ÷¼ÓÔØ£¬Èκγ£¹æ.jarÎļþ¶¼Ê¹Óá°»ù±¾¡±Àà¼ÓÔØÆ÷¼ÓÔØ¡£Èç¹ûÄã´¦ÀíÒ»¸ö¶àÄ£¿éÏîÄ¿£¬²¢ÇÒ²»ÊÇÿ¸öÄ£¿é¶¼µ¼Èëµ½ÄãµÄ IDE ÖУ¬Äã¿ÉÄÜÐèÒª×Ô¶¨ÒåһЩ¶«Î÷¡£Îª´Ë£¬Äã¿ÉÒÔ´´½¨Ò»¸öMETA-INF/spring-devtools.propertiesÎļþ¡£ +默认情况下,IDE 中的任何打开项目都使用“é‡�å�¯â€�类加载器加载,任何常规.jar文件都使用“基本â€�类加载器加载。如果你处ç�†ä¸€ä¸ªå¤šæ¨¡å�—项目,并且ä¸�是æ¯�个模å�—都导入到你的 IDE 中,你å�¯èƒ½éœ€è¦�自定义一些东西。为此,你å�¯ä»¥åˆ›å»ºä¸€ä¸ªMETA-INF/spring-devtools.properties文件。 -¸Ãspring-devtools.propertiesÎļþ¿ÉÒÔ°üº¬ÒÔrestart.excludeºÍΪǰ׺µÄÊôÐÔrestart.include¡£¸ÃincludeÔªËØÊÇÓ¦¸Ã±»À­¸ßµ½¡°ÖØÆô¡±µÄÀà¼ÓÔØÆ÷µÄÏîÄ¿£¬ÒÔ¼°excludeÒªËØÊÇÓ¦¸ÃÏòÏÂÍÆÈë¡°Base¡±Àà¼ÓÔØÆ÷µÄÏîÄ¿¡£¸ÃÊôÐÔµÄÖµÊÇÓ¦ÓÃÓÚÀà·¾¶µÄÕýÔò±í´ïʽģʽ£¬ÈçÒÔÏÂʾÀýËùʾ£º +该spring-devtools.properties文件å�¯ä»¥åŒ…å�«ä»¥restart.exclude和为å‰�缀的属性restart.include。该include元素是应该被拉高到“é‡�å�¯â€�的类加载器的项目,以å�Šexcludeè¦�素是应该å�‘下推入“Baseâ€�类加载器的项目。该属性的值是应用于类路径的正则表达å¼�模å¼�,如以下示例所示: @@ -209,31 +209,31 @@ restart: -¸ü¶àÏà¹ØµÄÐÅÏ¢¿ÉÒÔÔÚ[ÕâÀïÔÚд°¿Ú´ò¿ª](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools)²é¿´¡£ +更多相关的信æ�¯å�¯ä»¥åœ¨[这里在新窗å�£æ‰“å¼€](https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools)查看。 -### [#](#devtoolÊÇ·ñ»á±»´ò°ü½øjar) devtoolÊÇ·ñ»á±»´ò°ü½øJar£¿ +### [#](#devtool是å�¦ä¼šè¢«æ‰“包进jar) devtool是å�¦ä¼šè¢«æ‰“包进Jar? -> devtoolÔ­ÔòÉÏÀ´ËµÓ¦¸ÃÊÇÖ»ÔÚ¿ª·¢µ÷ÊÔµÄʱºòʹÓ㬶øÔÚÉú²ú»·¾³ÔËÐÐjar°üʱÊDz»ÐèÒªµÄ£¬ËùÒÔSpring´ò°ü»á²»»á°ÑËü´ò½øJARÂ𣿠+> devtool原则上æ�¥è¯´åº”该是å�ªåœ¨å¼€å�‘调试的时候使用,而在生产环境è¿�行jar包时是ä¸�需è¦�的,所以Spring打包会ä¸�会把它打进JARå�—? -* **ĬÈÏÇé¿öÏ£¬²»»á±»´ò°ü½øJAR** +* **默认情况下,ä¸�会被打包进JAR** -ÔËÐдò°üµÄÓ¦ÓóÌÐòʱ£¬¿ª·¢ÈËÔ±¹¤¾ß**»á×Ô¶¯½ûÓÃ**¡£Èç¹ûÄãͨ¹ý java -jar»òÕ߯äËûÌØÊâµÄÀà¼ÓÔØÆ÷½øÐÐÆô¶¯Ê±£¬¶¼»á±»ÈÏΪÊÇ¡°Éú²ú»·¾³µÄÓ¦Óᱡ£ +è¿�行打包的应用程åº�时,开å�‘人员工具**会自动ç¦�用**。如果你通过 java -jar或者其他特殊的类加载器进行å�¯åŠ¨æ—¶ï¼Œéƒ½ä¼šè¢«è®¤ä¸ºæ˜¯â€œç”Ÿäº§çŽ¯å¢ƒçš„åº”ç”¨â€�。 -* **Èç¹ûÎÒÃÇÆÚÍûÔ¶³Ìµ÷ÊÔÓ¦ÓÃ** +* **如果我们期望远程调试应用** -£¨_Éú²ú»·¾³ÎðÓã¬Ö»ÓÐÔÚÊÜÐÅÈεÄÍøÂçÉÏÔËÐлòʹÓà SSL ½øÐб£»¤Ê±£¬²ÅÓ¦ÆôÓÃËü_£© +(_生产环境勿用,å�ªæœ‰åœ¨å�—信任的网络上è¿�行或使用 SSL 进行ä¿�护时,æ‰�应å�¯ç”¨å®ƒ_) -ÔÚÕâÖÖÇé¿öÏ£¬devtoolÒ²¾ß±¸Ô¶³Ìµ÷ÊÔµÄÄÜÁ¦£ºÔ¶³Ì¿Í»§¶ËÓ¦ÓóÌÐòÖ¼ÔÚ´ÓÄãµÄ IDE ÖÐÔËÐС£ÄãÐèÒªorg.springframework.boot.devtools.RemoteSpringApplicationʹÓÃÓëÄãÁ¬½ÓµÄÔ¶³ÌÏîÄ¿ÏàͬµÄÀà·¾¶ÔËÐС£Ó¦ÓóÌÐòµÄΨһ±ØÐè²ÎÊýÊÇËüÁ¬½Óµ½µÄÔ¶³Ì URL¡£ +在这ç§�情况下,devtool也具备远程调试的能力:远程客户端应用程åº�旨在从你的 IDE 中è¿�行。你需è¦�org.springframework.boot.devtools.RemoteSpringApplication使用与你连接的远程项目相å�Œçš„类路径è¿�行。应用程åº�的唯一必需å�‚数是它连接到的远程 URL。 -ÀýÈ磬Èç¹ûʹÓà Eclipse »ò Spring Tools£¬²¢ÇÒÄãÓÐÒ»¸ömy-appÒѲ¿Êðµ½ Cloud Foundry µÄÃûΪµÄÏîÄ¿£¬Ö´ÐÐÒÔϲÙ×÷£º +例如,如果使用 Eclipse 或 Spring Tools,并且你有一个my-app已部署到 Cloud Foundry çš„å��为的项目,执行以下æ“�作: -1. Ñ¡ÔñRun Configurations¡­?´ÓRun²Ëµ¥¡£ -2. ´´½¨Ò»¸öеÄJava Application¡°Æô¶¯ÅäÖᱡ£ -3. ä¯ÀÀmy-appÏîÄ¿¡£ -4. ʹÓÃorg.springframework.boot.devtools.RemoteSpringApplication×÷ΪÖ÷Àà¡£ -5. Ìí¼Óhttps://myapp.cfapps.ioµ½Program arguments£¨»òÈκÎÄãµÄÔ¶³Ì URL£©¡£ +1. 选择Run Configurations…?从Runè�œå�•。 +2. 创建一个新的Java Application“å�¯åЍé…�ç½®â€�。 +3. æµ�览my-app项目。 +4. 使用org.springframework.boot.devtools.RemoteSpringApplication作为主类。 +5. 添加https://myapp.cfapps.io到Program arguments(或任何你的远程 URL)。 -ÕýÔÚÔËÐеÄÔ¶³Ì¿Í»§¶Ë¿ÉÄÜÀàËÆÓÚÒÔÏÂÁÐ±í£º +正在è¿�行的远程客户端å�¯èƒ½ç±»ä¼¼äºŽä»¥ä¸‹åˆ—表: @@ -256,15 +256,15 @@ restart: -### [#](#devtoolΪºÎ»áĬÈϽûÓûº´æÑ¡Ïî) devtoolΪºÎ»áĬÈϽûÓûº´æÑ¡Ï +### [#](#devtool为何会默认ç¦�用缓存选项) devtool为何会默认ç¦�用缓存选项? -> Spring Boot Ö§³ÖµÄһЩ¿â**ʹÓûº´æÀ´Ìá¸ßÐÔÄÜ**¡£ÀýÈ磬ģ°åÒýÇæ»º´æÒѱàÒëµÄÄ£°åÒÔ±ÜÃâÖØ¸´½âÎöÄ£°åÎļþ¡£´ËÍ⣬Spring MVC ¿ÉÒÔÔÚÌṩ¾²Ì¬×ÊԴʱÏòÏìÓ¦Ìí¼Ó HTTP »º´æ±êÍ·¡£ +> Spring Boot 支æŒ�的一些库**使用缓存æ�¥æ��高性能**。例如,模æ�¿å¼•擎缓存已编译的模æ�¿ä»¥é�¿å…�é‡�å¤�è§£æž�模æ�¿æ–‡ä»¶ã€‚此外,Spring MVC å�¯ä»¥åœ¨æ��ä¾›é�™æ€�资æº�æ—¶å�‘å“�应添加 HTTP 缓存标头。 -ËäÈ»»º´æ**ÔÚÉú²úÖзdz£ÓÐÒæ£¬µ«ÔÚ¿ª·¢¹ý³ÌÖпÉÄÜ»áÊÊµÃÆä·´**£¬Ê¹ÄãÎÞ·¨¿´µ½¸Õ¸ÕÔÚÓ¦ÓóÌÐòÖÐËù×öµÄ¸ü¸Ä¡£³öÓÚÕâ¸öÔ­Òò£¬ spring-boot-devtools ĬÈϽûÓûº´æÑ¡Ïî¡£ +虽然缓存**在生产中é�žå¸¸æœ‰ç›Šï¼Œä½†åœ¨å¼€å�‘过程中å�¯èƒ½ä¼šé€‚å¾—å…¶å��**,使你无法看到刚刚在应用程åº�中所å�šçš„æ›´æ”¹ã€‚出于这个原因, spring-boot-devtools 默认ç¦�用缓存选项。 -±ÈÈçThymeleaf ÌṩÁËspring.thymeleaf.cacheÀ´ÉèÖÃÄ£°åÒýÇæµÄ»º´æ£¬Ê¹ÓÃspring-boot-devtoolsÄ£¿éʱÊDz»ÐèÒªÊÖ¶¯ÉèÖÃÕâЩÊôÐԵģ¬ÒòΪspring-boot-devtools»á×Ô¶¯½øÐÐÉèÖᣠ+比如Thymeleaf æ��供了spring.thymeleaf.cacheæ�¥è®¾ç½®æ¨¡æ�¿å¼•擎的缓存,使用spring-boot-devtools模å�—时是ä¸�需è¦�手动设置这些属性的,因为spring-boot-devtools会自动进行设置。 -ÄÇô»á×Ô¶¯ÉèÖÃÄÄЩÅäÖÃÄØ£¿Äã¿ÉÒÔÔÚDevToolsPropertyDefaultsPostProcessorÀàÕÒµ½¶ÔÓ¦µÄĬÈÏÅäÖᣠ+那么会自动设置哪些é…�置呢?你å�¯ä»¥åœ¨DevToolsPropertyDefaultsPostProcessor类找到对应的默认é…�置。 @@ -295,13 +295,13 @@ public class DevToolsPropertyDefaultsPostProcessor implements EnvironmentPostPro -µ±È»Èç¹ûÄã²»Ïë±»Ó¦ÓÃÊôÐÔ±»spring-boot-devtoolsĬÈÏÉèÖ㬠¿ÉÒÔͨ¹ýspring.devtools.add-propertiesµ½falseÄãapplication.ymlÖС£ +当然如果你ä¸�想被应用属性被spring-boot-devtools默认设置, å�¯ä»¥é€šè¿‡spring.devtools.add-properties到falseä½ application.yml中。 -### [#](#devtoolÊÇ·ñ¿ÉÒÔ¸øËùÓÐspringbootÓ¦ÓÃ×öÈ«¾ÖµÄÅäÖÃ) devtoolÊÇ·ñ¿ÉÒÔ¸øËùÓÐSpringbootÓ¦ÓÃ×öÈ«¾ÖµÄÅäÖã¿ +### [#](#devtool是å�¦å�¯ä»¥ç»™æ‰€æœ‰springboot应用å�šå…¨å±€çš„é…�ç½®) devtool是å�¦å�¯ä»¥ç»™æ‰€æœ‰Springboot应用å�šå…¨å±€çš„é…�置? -> ¿ÉÒÔͨ¹ý½«spring-boot-devtools.ymlÎļþÌí¼Óµ½$HOME/.config/spring-bootĿ¼À´**ÅäÖÃÈ«¾Ö devtools ÉèÖÃ**¡£ +> å�¯ä»¥é€šè¿‡å°†spring-boot-devtools.yml文件添加到$HOME/.config/spring-boot目录æ�¥**é…�置全局 devtools 设置**。 -Ìí¼Óµ½ÕâЩÎļþµÄÈκÎÊôÐÔ¶¼ÊÊÓÃÓÚÄã»úÆ÷ÉÏʹÓà devtools µÄËùÓÐSpring Boot Ó¦ÓóÌÐò¡£ÀýÈ磬Ҫ½«ÖØÐÂÆô¶¯ÅäÖÃΪʼÖÕʹÓô¥·¢Æ÷Îļþ£¬ÄãÐèÒª½«ÒÔÏÂÊôÐÔÌí¼Óµ½ÄãµÄspring-boot-devtoolsÎļþÖУº +添加到这些文件的任何属性都适用于你机器上使用 devtools 的所有Spring Boot 应用程åº�。例如,è¦�å°†é‡�æ–°å�¯åЍé…�置为始终使用触å�‘器文件,你需è¦�将以下属性添加到你的spring-boot-devtools文件中: @@ -315,26 +315,26 @@ spring: -### [#](#Èç¹ûÎÒ²»ÓÃdevtool-»¹ÓÐʲôѡÔñ) Èç¹ûÎÒ²»ÓÃdevtool£¬»¹ÓÐʲôѡÔñ£¿ +### [#](#如果我ä¸�用devtool-还有什么选择) 如果我ä¸�用devtool,还有什么选择? -> Èç¹ûÎÒ²»ÓÃdevtool£¬»¹ÓÐʲôѡÔñ£¿ +> 如果我ä¸�用devtool,还有什么选择? -**ÔÚʵ¼ÊµÄ¿ª·¢¹ý³ÌÖУ¬ÎÒÒ²²»»áȥʹÓÃdevtool¹¤¾ß**, ÒòΪ£º +**在实际的开å�‘过程中,我也ä¸�会去使用devtool工具**, 因为: -* devtool±¾Éí»ùÓÚÖØÆô·½Ê½£¬ÕâÖÖÈÔÈ»²»ÊÇÕæÕýµÄÈÈÌæ»»·½°¸£¬JRebel²ÅÊÇ£¨ËüÊÇÊշѵģ© -* ¿ª·¢µ÷ÊÔ×îÖØÒªµÄ»¹ÊÇÒ»ÖÖȨºâ - * ×Ô¶¯ÖØÆôµÄ¿ªÏúÈç¹ûºÍÊÖ¶¯ÖØÆôûÓÐʲô̫´ó²î±ð£¬ÄÇô»¹²»ÈçÊÖ¶¯ÖØÆô£¨°´ÐèÖØÆô£© - * ¶àÊýÇé¿öÏ£¬Èç¹ûÊÇ**·½·¨ÄÚ²¿µÄÐ޸ĻòÕß¾²Ì¬×ÊÔ´µÄÐÞ¸Ä**£¬ÔÚIDEAÖÐÊÇ¿ÉÒÔͨ¹ýRebuild£¨Ctrl + Shift + F9£©½øÐÐÈȸüµÄ +* devtool本身基于é‡�å�¯æ–¹å¼�,这ç§�ä»�ç„¶ä¸�是真正的热替æ�¢æ–¹æ¡ˆï¼ŒJRebelæ‰�是(它是收费的) +* å¼€å�‘调试最é‡�è¦�的还是一ç§�æ�ƒè¡¡ + * 自动é‡�å�¯çš„开销如果和手动é‡�å�¯æ²¡æœ‰ä»€ä¹ˆå¤ªå¤§å·®åˆ«ï¼Œé‚£ä¹ˆè¿˜ä¸�如手动é‡�å�¯ï¼ˆæŒ‰éœ€é‡�å�¯ï¼‰ + * 多数情况下,如果是**方法内部的修改或者é�™æ€�资æº�的修改**,在IDEA中是å�¯ä»¥é€šè¿‡Rebuild(Ctrl + Shift + F9)进行热更的 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416211745.png) -* ´ËÍ⻹ÓÐÒ»¸ö¹¤¾ßspring loaded£¬ ¿ÉʵÏÖÐÞ¸ÄÀàÎļþµÄÈȲ¿Ê𣬾ßÌå¿É¿´Æä[githubµØÖ·ÔÚд°¿Ú´ò¿ª](https://github.com/spring-projects/spring-loaded)ÉϵÄ˵Ã÷¡£ +* 此外还有一个工具spring loaded, å�¯å®žçŽ°ä¿®æ”¹ç±»æ–‡ä»¶çš„çƒ­éƒ¨ç½²ï¼Œå…·ä½“å�¯çœ‹å…¶[github地å�€åœ¨æ–°çª—å�£æ‰“å¼€](https://github.com/spring-projects/spring-loaded)上的说明。 -## [#](#ʾÀýÔ´Âë) ʾÀýÔ´Âë +## [#](#示例æº�ç �) 示例æº�ç � https://github.com/realpdai/tech-pdai-spring-demos -## [#](#²Î¿¼ÎÄÕÂ) ²Î¿¼ÎÄÕ +## [#](#å�‚考文章) å�‚考文章 https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools @@ -342,4 +342,4 @@ https://liayun.blog.csdn.net/article/details/116541775 * * * -Öø×÷Ȩ¹é@pdaiËùÓÐ Ô­ÎÄÁ´½Ó£ºhttps://pdai.tech/md/spring/springboot/springboot-x-hello-devtool.html \ No newline at end of file +著作æ�ƒå½’@pdai所有 原文链接:https://pdai.tech/md/spring/springboot/springboot-x-hello-devtool.html \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\351\233\206\346\210\220Swagger\345\256\236\347\216\260API\346\226\207\346\241\243\350\207\252\345\212\250\347\224\237\346\210\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\351\233\206\346\210\220Swagger\345\256\236\347\216\260API\346\226\207\346\241\243\350\207\252\345\212\250\347\224\237\346\210\220.md" index e225d74..9963f10 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\351\233\206\346\210\220Swagger\345\256\236\347\216\260API\346\226\207\346\241\243\350\207\252\345\212\250\347\224\237\346\210\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\351\233\206\346\210\220Swagger\345\256\236\347\216\260API\346\226\207\346\241\243\350\207\252\345\212\250\347\224\237\346\210\220.md" @@ -1,68 +1,68 @@ -Ŀ¼ - -* [SwaggerµÄ½éÉÜ](https://www.cnblogs.com/progor/p/13297904.html#swagger%E7%9A%84%E4%BB%8B%E7%BB%8D) - * [ÓŵãÓëȱµã](https://www.cnblogs.com/progor/p/13297904.html#%E4%BC%98%E7%82%B9%E4%B8%8E%E7%BC%BA%E7%82%B9) -* [Ìí¼Óswagger](https://www.cnblogs.com/progor/p/13297904.html#%E6%B7%BB%E5%8A%A0swagger) - * [1.Ìí¼ÓÒÀÀµ°ü£º](https://www.cnblogs.com/progor/p/13297904.html#1%E6%B7%BB%E5%8A%A0%E4%BE%9D%E8%B5%96%E5%8C%85) - * [2.ÅäÖÃSwagger:](https://www.cnblogs.com/progor/p/13297904.html#2%E9%85%8D%E7%BD%AEswagger) - * [3.²âÊÔ](https://www.cnblogs.com/progor/p/13297904.html#3%E6%B5%8B%E8%AF%95) -* [³¡¾°£º](https://www.cnblogs.com/progor/p/13297904.html#%E5%9C%BA%E6%99%AF) - * [¶¨Òå½Ó¿Ú×é](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E7%BB%84) - * [¶¨Òå½Ó¿Ú](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3) - * [¶¨Òå½Ó¿ÚÇëÇó²ÎÊý](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0) - * [³¡¾°Ò»£ºÇëÇó²ÎÊýÊÇʵÌåÀà¡£](https://www.cnblogs.com/progor/p/13297904.html#%E5%9C%BA%E6%99%AF%E4%B8%80%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%E6%98%AF%E5%AE%9E%E4%BD%93%E7%B1%BB) - * [³¡¾°¶þ£ºÇëÇó²ÎÊýÊÇ·ÇʵÌåÀà¡£](https://www.cnblogs.com/progor/p/13297904.html#%E5%9C%BA%E6%99%AF%E4%BA%8C%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%E6%98%AF%E9%9D%9E%E5%AE%9E%E4%BD%93%E7%B1%BB) - * [¶¨Òå½Ó¿ÚÏìÓ¦](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E5%93%8D%E5%BA%94) - * [ÏìÓ¦ÊÇʵÌåÀࣺ](https://www.cnblogs.com/progor/p/13297904.html#%E5%93%8D%E5%BA%94%E6%98%AF%E5%AE%9E%E4%BD%93%E7%B1%BB) - * [ÏìÓ¦ÊÇ·ÇʵÌåÀࣺ](https://www.cnblogs.com/progor/p/13297904.html#%E5%93%8D%E5%BA%94%E6%98%AF%E9%9D%9E%E5%AE%9E%E4%BD%93%E7%B1%BB) -* [Swagger UIÔöÇ¿](https://www.cnblogs.com/progor/p/13297904.html#swagger-ui%E5%A2%9E%E5%BC%BA) - * [UI¶Ô±È£º](https://www.cnblogs.com/progor/p/13297904.html#ui%E5%AF%B9%E6%AF%94) - * [ʹÓÃ](https://www.cnblogs.com/progor/p/13297904.html#%E4%BD%BF%E7%94%A8) - * [Óŵã](https://www.cnblogs.com/progor/p/13297904.html#%E4%BC%98%E7%82%B9) -* [ÕûºÏSpring Security×¢Òâ](https://www.cnblogs.com/progor/p/13297904.html#%E6%95%B4%E5%90%88spring-security%E6%B3%A8%E6%84%8F) -* [¶ÔÓÚtokenµÄ´¦Àí](https://www.cnblogs.com/progor/p/13297904.html#%E5%AF%B9%E4%BA%8Etoken%E7%9A%84%E5%A4%84%E7%90%86) -* [SwaggerµÄ°²È«¹ÜÀí](https://www.cnblogs.com/progor/p/13297904.html#swagger%E7%9A%84%E5%AE%89%E5%85%A8%E7%AE%A1%E7%90%86) +目录 + +* [Swagger的介ç»�](https://www.cnblogs.com/progor/p/13297904.html#swagger%E7%9A%84%E4%BB%8B%E7%BB%8D) + * [优点与缺点](https://www.cnblogs.com/progor/p/13297904.html#%E4%BC%98%E7%82%B9%E4%B8%8E%E7%BC%BA%E7%82%B9) +* [添加swagger](https://www.cnblogs.com/progor/p/13297904.html#%E6%B7%BB%E5%8A%A0swagger) + * [1.添加ä¾�赖包:](https://www.cnblogs.com/progor/p/13297904.html#1%E6%B7%BB%E5%8A%A0%E4%BE%9D%E8%B5%96%E5%8C%85) + * [2.é…�ç½®Swagger:](https://www.cnblogs.com/progor/p/13297904.html#2%E9%85%8D%E7%BD%AEswagger) + * [3.测试](https://www.cnblogs.com/progor/p/13297904.html#3%E6%B5%8B%E8%AF%95) +* [场景:](https://www.cnblogs.com/progor/p/13297904.html#%E5%9C%BA%E6%99%AF) + * [定义接å�£ç»„](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E7%BB%84) + * [定义接å�£](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3) + * [定义接å�£è¯·æ±‚å�‚æ•°](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0) + * [场景一:请求å�‚数是实体类。](https://www.cnblogs.com/progor/p/13297904.html#%E5%9C%BA%E6%99%AF%E4%B8%80%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%E6%98%AF%E5%AE%9E%E4%BD%93%E7%B1%BB) + * [场景二:请求å�‚数是é�žå®žä½“类。](https://www.cnblogs.com/progor/p/13297904.html#%E5%9C%BA%E6%99%AF%E4%BA%8C%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0%E6%98%AF%E9%9D%9E%E5%AE%9E%E4%BD%93%E7%B1%BB) + * [定义接å�£å“�应](https://www.cnblogs.com/progor/p/13297904.html#%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E5%93%8D%E5%BA%94) + * [å“�应是实体类:](https://www.cnblogs.com/progor/p/13297904.html#%E5%93%8D%E5%BA%94%E6%98%AF%E5%AE%9E%E4%BD%93%E7%B1%BB) + * [å“�应是é�žå®žä½“类:](https://www.cnblogs.com/progor/p/13297904.html#%E5%93%8D%E5%BA%94%E6%98%AF%E9%9D%9E%E5%AE%9E%E4%BD%93%E7%B1%BB) +* [Swagger UI增强](https://www.cnblogs.com/progor/p/13297904.html#swagger-ui%E5%A2%9E%E5%BC%BA) + * [UI对比:](https://www.cnblogs.com/progor/p/13297904.html#ui%E5%AF%B9%E6%AF%94) + * [使用](https://www.cnblogs.com/progor/p/13297904.html#%E4%BD%BF%E7%94%A8) + * [优点](https://www.cnblogs.com/progor/p/13297904.html#%E4%BC%98%E7%82%B9) +* [æ•´å�ˆSpring Security注æ„�](https://www.cnblogs.com/progor/p/13297904.html#%E6%95%B4%E5%90%88spring-security%E6%B3%A8%E6%84%8F) +* [对于token的处ç�†](https://www.cnblogs.com/progor/p/13297904.html#%E5%AF%B9%E4%BA%8Etoken%E7%9A%84%E5%A4%84%E7%90%86) +* [Swagger的安全管ç�†](https://www.cnblogs.com/progor/p/13297904.html#swagger%E7%9A%84%E5%AE%89%E5%85%A8%E7%AE%A1%E7%90%86) * * * -# SwaggerµÄ½éÉÜ +# Swagger的介ç»� -?Äã¿ÉÄܳ¢ÊÔ¹ýдÍêÒ»¸ö½Ó¿Úºó£¬×Ô¼ºÈ¥´´½¨½Ó¿ÚÎĵµ£¬»òÕßÐ޸ĽӿںóÐ޸ĽӿÚÎĵµ¡£¶àÁËÖ®ºó£¬Äã¿Ï¶¨»á·¢ÉúÒ»¸ö²Ù×÷£¬ÄǾÍÊÇÍü¼ÇÁËÐÞ¸ÄÎĵµ»òÕß´´½¨Îĵµ£¨³ý·ÇÄãÃǹ«Ë¾°Ñ½Ó¿ÚÎĵµºÍд½Ó¿ÚÒªÇóµÃºÜ½ôÃÜ?Íü¼ÇдÎĵµ¾Í¿Û¹¤×Ê£¿£¬·ñÔòÁ½¸ö·ÖÀëµÄ¹¤×÷×ÜÊÇÓпÉÄÜÒÅ©µÄ£©¡£¶øswagger¾ÍÊÇÒ»¸öÔÚÄãд½Ó¿ÚµÄʱºò×Ô¶¯°ïÄãÉú³É½Ó¿ÚÎĵµµÄ¶«Î÷£¬Ö»ÒªÄã×ñÑ­ËüµÄ¹æ·¶²¢Ð´Ò»Ð©½Ó¿ÚµÄ˵Ã÷×¢½â¼´¿É¡£ +?ä½ å�¯èƒ½å°�试过写完一个接å�£å�Žï¼Œè‡ªå·±åŽ»åˆ›å»ºæŽ¥å�£æ–‡æ¡£ï¼Œæˆ–者修改接å�£å�Žä¿®æ”¹æŽ¥å�£æ–‡æ¡£ã€‚多了之å�Žï¼Œä½ è‚¯å®šä¼šå�‘生一个æ“�作,那就是忘记了修改文档或者创建文档(除é�žä½ ä»¬å…¬å�¸æŠŠæŽ¥å�£æ–‡æ¡£å’Œå†™æŽ¥å�£è¦�求得很紧密?忘记写文档就扣工资?,å�¦åˆ™ä¸¤ä¸ªåˆ†ç¦»çš„工作总是有å�¯èƒ½é�—æ¼�的)。而swagger就是一个在你写接å�£çš„æ—¶å€™è‡ªåŠ¨å¸®ä½ ç”Ÿæˆ�接å�£æ–‡æ¡£çš„东西,å�ªè¦�ä½ é�µå¾ªå®ƒçš„规范并写一些接å�£çš„说明注解å�³å�¯ã€‚ -## ÓŵãÓëȱµã +## 优点与缺点 -?Óŵ㣺 +?优点: -* ×Ô¶¯Éú³ÉÎĵµ£¬Ö»ÐèÒªÔÚ½Ó¿ÚÖÐʹÓÃ×¢½â½øÐбê×¢£¬¾ÍÄÜÉú³É¶ÔÓ¦µÄ½Ó¿ÚÎĵµ¡£ -* ×Ô¶¯¸üÐÂÎĵµ£¬ÓÉÓÚÊǶ¯Ì¬Éú³ÉµÄ£¬ËùÒÔÈç¹ûÄãÐÞ¸ÄÁ˽ӿڣ¬ÎĵµÒ²»á×Ô¶¯¶ÔÓ¦Ð޸ģ¨Èç¹ûÄãÒ²¸üÐÂÁË×¢½âµÄ»°£©¡£ÕâÑù¾Í²»»á·¢ËÍÎÒÐÞ¸ÄÁ˽ӿڣ¬È´Íü¼Ç¸üнӿÚÎĵµµÄÇé¿ö¡£ -* Ö§³ÖÔÚÏßµ÷ÊÔ£¬swaggerÌṩÁËÔÚÏßµ÷ÓýӿڵŦÄÜ¡£ +* 自动生æˆ�文档,å�ªéœ€è¦�在接å�£ä¸­ä½¿ç”¨æ³¨è§£è¿›è¡Œæ ‡æ³¨ï¼Œå°±èƒ½ç”Ÿæˆ�对应的接å�£æ–‡æ¡£ã€‚ +* 自动更新文档,由于是动æ€�生æˆ�的,所以如果你修改了接å�£ï¼Œæ–‡æ¡£ä¹Ÿä¼šè‡ªåŠ¨å¯¹åº”ä¿®æ”¹ï¼ˆå¦‚æžœä½ ä¹Ÿæ›´æ–°äº†æ³¨è§£çš„è¯�)。这样就ä¸�会å�‘é€�我修改了接å�£ï¼Œå�´å¿˜è®°æ›´æ–°æŽ¥å�£æ–‡æ¡£çš„æƒ…况。 +* 支æŒ�在线调试,swaggeræ��供了在线调用接å�£çš„功能。 -?ȱµã£º +?缺点: -* ²»ÄÜ´´½¨²âÊÔÓÃÀý£¬ËùÒÔËûÔÝʱ²»ÄܰïÄã´¦ÀíÍêËùÓеÄÊÂÇé¡£ËûÖ»ÄÜÌṩһ¸ö¼òµ¥µÄÔÚÏßµ÷ÊÔ£¬Èç¹ûÄãÏë´æ´¢ÄãµÄ²âÊÔÓÃÀý£¬¿ÉÒÔʹÓÃPostman»òÕßYAPIÕâÑùÖ§³Ö´´½¨²âÊÔÓû§µÄ¹¦ÄÜ¡£ -* Òª×ñѭһЩ¹æ·¶£¬Ëü²»ÊÇÈÎÒâ¹æ·¶µÄ¡£±ÈÈç˵£¬Äã¿ÉÄܻ᷵»ØÒ»¸öjsonÊý¾Ý£¬¶øÕâ¸öÊý¾Ý¿ÉÄÜÊÇÒ»¸öMap¸ñʽµÄ£¬ÄÇôÎÒÃÇ´Ëʱ²»Äܱê×¢Õâ¸öMap¸ñʽµÄ·µ»ØÊý¾ÝµÄÿ¸ö×ֶεÄ˵Ã÷£¬¶øÈç¹ûËüÊÇÒ»¸öʵÌåÀàµÄ»°£¬ÎÒÃÇ¿ÉÒÔͨ¹ý±ê×¢ÀàµÄÊôÐÔÀ´¸ø·µ»Ø×ֶμÓ˵Ã÷¡£Ò²±ÈÈç˵£¬¶ÔÓÚswagger£¬²»ÍƼöÔÚʹÓÃGET·½Ê½Ìá½»Êý¾ÝµÄʱºò»¹Ê¹ÓÃBody£¬½öÍÆ¼öʹÓÃquery²ÎÊý¡¢header²ÎÊý»òÕß·¾¶²ÎÊý£¬µ±È»ÁËÕâ¸öÏÞÖÆÖ»ÊÊÓÃÓÚÔÚÏßµ÷ÊÔ¡£ -* ûÓнӿÚÎĵµ¸üйÜÀí£¬ËäȻһ¸ö½Ó¿Ú¸üÐÂÖ®ºó£¬¿ÉÄܲ»»á¹ØÐľɰæµÄ½Ó¿ÚÐÅÏ¢£¬µ«Äã¡°¿ÉÄÜ¡±Ïë¿´¿´¾É°æµÄ½Ó¿ÚÐÅÏ¢£¬ÀýÈçÓÐЩ»Ò¶È¸üз¢²¼µÄʱºò¿ÉÄÜ»¹»á¹ØÐľɰæµÄ½Ó¿Ú¡£ÄÇô´ËʱֻÄÜÓɺó¶ËÈ¥¿´¿´ÓÐûÓÐ×¢ÊÍÁôÏÂÁË£¬ËùÒÔ¿ÉÒÔ¿¼ÂǽӿÚÎĵµ´ó¸üеÄʱºò×¢Ê;ɰæµÄ£¬È»ºóдÏÂаæµÄ¡£¡¾µ±È»Õâ¸öÎÊÌâ¿ÉÒÔͨ¹ýµ¼³ö½Ó¿ÚÎĵµÀ´¶Ô±È¡£¡¿ -* ËäÈ»ÏÖÔÚJavaµÄʵÌåÀàÖÐÓв»ÉÙÄ£ÐÍ£¬po,dto,voµÈ£¬Ä£Ð͵ÄÇø·ÖÊÇΪÁËÆÁ±ÎһЩ¶àÓà²ÎÊý£¬±ÈÈçÒ»¸öÓû§µÇ¼µÄʱºòÖ»ÐèÒªusername,password£¬µ«²éȨÏÞµÄʱºòÐèÒªÁ¬½ÓÉÏȨÏÞ±íµÄÐÅÏ¢£¬¶øÈç¹ûÉÏÊöÁ½¸ö²Ù×÷¶¼ÊÇʹÓÃÁËUserÕâ¸öʵÌåµÄ»°£¬ÔÚÎĵµÖоͻá×Ô¶¯Éú³ÉÁ˶àÓàµÄÐÅÏ¢£¬Õâ¾ÍÒªÇóÁËÄã»ùÓÚÄ£ÐÍÀ´´´½¨¶à¸öʵÌåÀ࣬±ÈÈçµÇ¼µÄʱºòÒ»¸öLoginForm£¬ÐèÒªÓû§-ȨÏÞµÈÐÅÏ¢µÄʱºò²ÅʹÓÃUserÀà¡££¨µ±È»ÁË£¬Õâ¸öÎÊÌâµÈÄã»áswaggerÖ®ºóÄã¾Í´ó¸Å¾Í»áÔõô¹æ±ÜÕâ¸öÎÊÌâÁË¡££© +* ä¸�能创建测试用例,所以他暂时ä¸�能帮你处ç�†å®Œæ‰€æœ‰çš„事情。他å�ªèƒ½æ��供一个简å�•的在线调试,如果你想存储你的测试用例,å�¯ä»¥ä½¿ç”¨Postman或者YAPI这样支æŒ�创建测试用户的功能。 +* è¦�é�µå¾ªä¸€äº›è§„范,它ä¸�是任æ„�规范的。比如说,你å�¯èƒ½ä¼šè¿”回一个jsonæ•°æ�®ï¼Œè€Œè¿™ä¸ªæ•°æ�®å�¯èƒ½æ˜¯ä¸€ä¸ªMapæ ¼å¼�的,那么我们此时ä¸�能标注这个Mapæ ¼å¼�的返回数æ�®çš„æ¯�个字段的说明,而如果它是一个实体类的è¯�,我们å�¯ä»¥é€šè¿‡æ ‡æ³¨ç±»çš„属性æ�¥ç»™è¿”回字段加说明。也比如说,对于swagger,ä¸�推è��在使用GETæ–¹å¼�æ��交数æ�®çš„æ—¶å€™è¿˜ä½¿ç”¨Body,仅推è��使用queryå�‚æ•°ã€�headerå�‚数或者路径å�‚数,当然了这个é™�制å�ªé€‚用于在线调试。 +* 没有接å�£æ–‡æ¡£æ›´æ–°ç®¡ç�†ï¼Œè™½ç„¶ä¸€ä¸ªæŽ¥å�£æ›´æ–°ä¹‹å�Žï¼Œå�¯èƒ½ä¸�会关心旧版的接å�£ä¿¡æ�¯ï¼Œä½†ä½ â€œå�¯èƒ½â€�想看看旧版的接å�£ä¿¡æ�¯ï¼Œä¾‹å¦‚有些ç�°åº¦æ›´æ–°å�‘布的时候å�¯èƒ½è¿˜ä¼šå…³å¿ƒæ—§ç‰ˆçš„æŽ¥å�£ã€‚那么此时å�ªèƒ½ç”±å�Žç«¯åŽ»çœ‹çœ‹æœ‰æ²¡æœ‰æ³¨é‡Šç•™ä¸‹äº†ï¼Œæ‰€ä»¥å�¯ä»¥è€ƒè™‘接å�£æ–‡æ¡£å¤§æ›´æ–°çš„æ—¶å€™æ³¨é‡Šæ—§ç‰ˆçš„,然å�Žå†™ä¸‹æ–°ç‰ˆçš„。ã€�当然这个问题å�¯ä»¥é€šè¿‡å¯¼å‡ºæŽ¥å�£æ–‡æ¡£æ�¥å¯¹æ¯”。】 +* 虽然现在Java的实体类中有ä¸�少模型,po,dto,vo等,模型的区分是为了å±�蔽一些多余å�‚数,比如一个用户登录的时候å�ªéœ€è¦�username,password,但查æ�ƒé™�的时候需è¦�连接上æ�ƒé™�表的信æ�¯ï¼Œè€Œå¦‚果上述两个æ“�作都是使用了User这个实体的è¯�,在文档中就会自动生æˆ�了多余的信æ�¯ï¼Œè¿™å°±è¦�求了你基于模型æ�¥åˆ›å»ºå¤šä¸ªå®žä½“类,比如登录的时候一个LoginForm,需è¦�用户-æ�ƒé™�等信æ�¯çš„æ—¶å€™æ‰�使用User类。(当然了,这个问题等你会swagger之å�Žä½ å°±å¤§æ¦‚就会怎么规é�¿è¿™ä¸ªé—®é¢˜äº†ã€‚) -?ÉÏÃæµÄȱµãºÃÏñдµÄÓеã¶à£¬Äã¿ÉÄÜ»á¾õµÃswaggerÕâ¸ö¿ÓÓеã´ó¡£µ«ÆäʵÖ÷ÒªÊǹ淶ÎÊÌ⣬¶ø¹æ·¶ÎÊÌâÓÐʱºòÓÖ»áÌá¸ßÄãµÄ´úÂë¹æ·¶ÐÔ£¬Õâ¸ö¾Í¼ûÈʼûÖÇÁË£¬ÄãÒÔǰ¿ÉÄÜʲô½Ó¿ÚµÄ²ÎÊý¶¼Ê¹ÓÃÒ»¸öÀ࣬¶øÏÖÔÚswaggerÒªÇóÄã·Ö¿ªºó£¬Ä³ÖÖ²ã´ÎÉÏÌá¸ßÁËÄãµÄ´úÂë¹æ·¶ÐÔ¡£ +?上é�¢çš„缺点好åƒ�写的有点多,你å�¯èƒ½ä¼šè§‰å¾—swagger这个å�‘有点大。但其实主è¦�是规范问题,而规范问题有时候å�ˆä¼šæ��高你的代ç �规范性,这个就è§�ä»�è§�智了,你以å‰�å�¯èƒ½ä»€ä¹ˆæŽ¥å�£çš„å�‚数都使用一个类,而现在swaggerè¦�求你分开å�Žï¼ŒæŸ�ç§�层次上æ��高了你的代ç �规范性。 -?×¢£ºÒÔÏ´úÂëʾÀý»ùÓÚSpring Boot¡£ÍêÕû´úÂë¿ÉÒԲο¼£º[swagger-demo](https://github.com/alprogor/swagger-demo) +?注:以下代ç �示例基于Spring Boot。完整代ç �å�¯ä»¥å�‚考:[swagger-demo](https://github.com/alprogor/swagger-demo) * * * -# Ìí¼Óswagger +# 添加swagger -?ÕâÀïÏȽ²Ìí¼Óswagger£¬Ò²¾ÍÊÇÏÈÕûºÏ½øÀ´£¬ÖÁÓÚÔõôʹÓã¬ÏÂÃæµÄ¡°³¡¾°¡±ÖÐÔÙ½²½â¡£ +?这里先讲添加swagger,也就是先整å�ˆè¿›æ�¥ï¼Œè‡³äºŽæ€Žä¹ˆä½¿ç”¨ï¼Œä¸‹é�¢çš„“场景â€�中å†�讲解。 -## 1.Ìí¼ÓÒÀÀµ°ü£º +## 1.添加ä¾�赖包: -?×¢Ò⣬ÕâÀïµÄǰÌáÊÇÒѾ­µ¼ÈëÁËspring bootµÄweb°ü¡£ +?注æ„�,这里的å‰�æ��是已ç»�导入了spring bootçš„web包。 -¸´ÖÆ´úÂë +å¤�制代ç � ``` @@ -78,11 +78,11 @@ ``` -## 2.ÅäÖÃSwagger: +## 2.é…�ç½®Swagger: -ҪʹÓÃswagger£¬ÎÒÃDZØÐë¶Ôswagger½øÐÐÅäÖã¬ÎÒÃÇÐèÒª´´½¨Ò»¸öswaggerµÄÅäÖÃÀ࣬±ÈÈç¿ÉÒÔÃüÃûΪSwaggerConfig.java +è¦�使用swagger,我们必须对swagger进行é…�置,我们需è¦�创建一个swaggerçš„é…�置类,比如å�¯ä»¥å‘½å��为SwaggerConfig.java -¸´ÖÆ´úÂë +å¤�制代ç � ``` package com.example.config; @@ -97,92 +97,92 @@ import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; -@Configuration // ±êÃ÷ÊÇÅäÖÃÀà -@EnableSwagger2 //¿ªÆôswagger¹¦ÄÜ +@Configuration // 标明是é…�置类 +@EnableSwagger2 //å¼€å�¯swagger功能 public class SwaggerConfig { @Bean public Docket createRestApi() { - return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 ¹Ì¶¨µÄ£¬´ú±íswagger2 -// .groupName("·Ö²¼Ê½ÈÎÎñϵͳ") // Èç¹ûÅäÖöà¸öÎĵµµÄʱºò£¬ÄÇôÐèÒªÅäÖÃgroupNameÀ´·Ö×é±êʶ - .apiInfo(apiInfo()) // ÓÃÓÚÉú³ÉAPIÐÅÏ¢ - .select() // select()º¯Êý·µ»ØÒ»¸öApiSelectorBuilderʵÀý,ÓÃÀ´¿ØÖƽӿڱ»swagger×ö³ÉÎĵµ - .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // ÓÃÓÚÖ¸¶¨É¨ÃèÄĸö°üÏÂµÄ½Ó¿Ú - .paths(PathSelectors.any())// Ñ¡ÔñËùÓеÄAPI,Èç¹ûÄãÏëֻΪ²¿·ÖAPIÉú³ÉÎĵµ£¬¿ÉÒÔÅäÖÃÕâÀï + return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 固定的,代表swagger2 +// .groupName("分布å¼�任务系统") // 如果é…�置多个文档的时候,那么需è¦�é…�ç½®groupNameæ�¥åˆ†ç»„标识 + .apiInfo(apiInfo()) // 用于生æˆ�APIä¿¡æ�¯ + .select() // select()函数返回一个ApiSelectorBuilder实例,用æ�¥æŽ§åˆ¶æŽ¥å�£è¢«swaggerå�šæˆ�文档 + .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 用于指定扫æ��哪个包下的接å�£ + .paths(PathSelectors.any())// 选择所有的API,如果你想å�ªä¸ºéƒ¨åˆ†API生æˆ�文档,å�¯ä»¥é…�置这里 .build(); } /** - * ÓÃÓÚ¶¨ÒåAPIÖ÷½çÃæµÄÐÅÏ¢£¬±ÈÈç¿ÉÒÔÉùÃ÷ËùÓеÄAPIµÄ×ܱêÌâ¡¢ÃèÊö¡¢°æ±¾ + * 用于定义API主界é�¢çš„ä¿¡æ�¯ï¼Œæ¯”如å�¯ä»¥å£°æ˜Žæ‰€æœ‰çš„API的总标题ã€�æ��è¿°ã€�版本 * @return */ private ApiInfo apiInfo() { return new ApiInfoBuilder() - .title("XXÏîÄ¿API") // ¿ÉÒÔÓÃÀ´×Ô¶¨ÒåAPIµÄÖ÷±êÌâ - .description("XXÏîÄ¿SwaggerAPI¹ÜÀí") // ¿ÉÒÔÓÃÀ´ÃèÊöÕûÌåµÄAPI - .termsOfServiceUrl("") // ÓÃÓÚ¶¨Òå·þÎñµÄÓòÃû - .version("1.0") // ¿ÉÒÔÓÃÀ´¶¨Òå°æ±¾¡£ + .title("XX项目API") // å�¯ä»¥ç”¨æ�¥è‡ªå®šä¹‰API的主标题 + .description("XX项目SwaggerAPI管ç�†") // å�¯ä»¥ç”¨æ�¥æ��述整体的API + .termsOfServiceUrl("") // 用于定义æœ�务的域å�� + .version("1.0") // å�¯ä»¥ç”¨æ�¥å®šä¹‰ç‰ˆæœ¬ã€‚ .build(); // } } ``` -## 3.²âÊÔ +## 3.测试 -ÔËÐÐÎÒÃǵÄSpring BootÏîÄ¿£¬£¨ÎÒĬÈÏÊÇ8080¶Ë¿Ú£¬Èç¹ûÄã²»Ò»Ñù£¬Çë×¢ÒâÐ޸ĺóÐøµÄurl£©£¬·ÃÎÊ`http://localhost:8080/swagger-ui.html` -È»ºóÄã¾Í¿ÉÒÔ¿´µ½Ò»¸öÈçϵĽçÃæ£¬ÓÉÓÚÎÒÃÇÔÝʱûÓÐÅäÖýӿÚÊý¾Ý£¬ËùÒÔÏÂÃæÏÔʾ`No operations defined in spec!` +è¿�行我们的Spring Boot项目,(我默认是8080端å�£ï¼Œå¦‚果你ä¸�一样,请注æ„�修改å�Žç»­çš„url),访问`http://localhost:8080/swagger-ui.html` +ç„¶å�Žä½ å°±å�¯ä»¥çœ‹åˆ°ä¸€ä¸ªå¦‚下的界é�¢ï¼Œç”±äºŽæˆ‘们暂时没有é…�置接å�£æ•°æ�®ï¼Œæ‰€ä»¥ä¸‹é�¢æ˜¾ç¤º`No operations defined in spec!` ![20200711013419](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200711013419.png) -?ÏÂÃæÎÒÃǽ«½éÉÜÈçºÎ¶¨Òå½Ó¿Ú£¬ÒÔ¼°ÔÚswagger UI½çÃæÖеÄÄÚÈÝ¡£ +?下é�¢æˆ‘们将介ç»�如何定义接å�£ï¼Œä»¥å�Šåœ¨swagger UI界é�¢ä¸­çš„内容。 * * * -# ³¡¾°£º +# 场景: -## ¶¨Òå½Ó¿Ú×é +## 定义接å�£ç»„ -½Ó¿ÚÓÐʱºòÓ¦¸ÃÊÇ·Ö×éµÄ£¬¶øÇҴ󲿷ֶ¼ÊÇÔÚÒ»¸öcontrollerÖе쬱ÈÈçÓû§¹ÜÀíÏà¹ØµÄ½Ó¿ÚÓ¦¸Ã¶¼ÔÚUserControllerÖУ¬ÄÇô²»Í¬µÄÒµÎñµÄʱºò£¬Ó¦¸Ã¶¨Òå/»®·Ö²»Í¬µÄ½Ó¿Ú×é¡£½Ó¿Ú×é¿ÉÒÔʹÓÃ`@Api`À´»®·Ö¡£ -±ÈÈ磺 +接å�£æœ‰æ—¶å€™åº”该是分组的,而且大部分都是在一个controller中的,比如用户管ç�†ç›¸å…³çš„æŽ¥å�£åº”该都在UserController中,那么ä¸�å�Œçš„业务的时候,应该定义/划分ä¸�å�Œçš„æŽ¥å�£ç»„。接å�£ç»„å�¯ä»¥ä½¿ç”¨`@Api`æ�¥åˆ’分。 +比如: -¸´ÖÆ´úÂë +å¤�制代ç � ``` -@Api(tags = "½ÇÉ«¹ÜÀí") // tags£ºÄã¿ÉÒÔµ±×÷ÊÇÕâ¸ö×éµÄÃû×Ö¡£ +@Api(tags = "角色管ç�†") // tags:你å�¯ä»¥å½“作是这个组的å��字。 @RestController public class RoleController { } ``` -ºÍ +å’Œ -¸´ÖÆ´úÂë +å¤�制代ç � ``` -@Api(tags = "Óû§¹ÜÀí") // tags£ºÄã¿ÉÒÔµ±×÷ÊÇÕâ¸ö×éµÄÃû×Ö¡£ +@Api(tags = "用户管ç�†") // tags:你å�¯ä»¥å½“作是这个组的å��字。 @RestController public class UserController { } ``` -?ÄãÒ²¿ÉÒÔÀí½â³É»ùÓÚtagsÀ´·Ö×飬¾ÍºÃÏñһЩÎÄÕÂÀïÃæµÄ±êǩһÑù£¬Ê¹ÓñêÇ©À´·ÖÀà¡£ -?Èç¹ûÕâ¸öControllerÏ£¨½Ó¿Ú×飩ÏÂÃæÃ»Óнӿڣ¬ÄÇôÔÚswagger uiÖÐÊDz»»áÏÔʾµÄ£¬Èç¹ûÓеϰ¾Í»áÕâÑùÏÔʾ£º +?你也å�¯ä»¥ç�†è§£æˆ�基于tagsæ�¥åˆ†ç»„,就好åƒ�一些文章里é�¢çš„æ ‡ç­¾ä¸€æ ·ï¼Œä½¿ç”¨æ ‡ç­¾æ�¥åˆ†ç±»ã€‚ +?如果这个Controller下(接å�£ç»„)下é�¢æ²¡æœ‰æŽ¥å�£ï¼Œé‚£ä¹ˆåœ¨swagger ui中是ä¸�会显示的,如果有的è¯�就会这样显示: ![20200712022545](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712022545.png) -## ¶¨Òå½Ó¿Ú +## 定义接å�£ -ʹÓÃÁË`@Api`À´±ê×¢Ò»¸öControllerÖ®ºó£¬Èç¹ûÏÂÃæÓнӿڣ¬ÄÇô¾Í»áĬÈÏÉú³ÉÎĵµ£¬µ«Ã»ÓÐÎÒÃÇ×Ô¶¨ÒåµÄ˵Ã÷£º +使用了`@Api`æ�¥æ ‡æ³¨ä¸€ä¸ªController之å�Žï¼Œå¦‚果下é�¢æœ‰æŽ¥å�£ï¼Œé‚£ä¹ˆå°±ä¼šé»˜è®¤ç”Ÿæˆ�文档,但没有我们自定义的说明: -¸´ÖÆ´úÂë +å¤�制代ç � ``` -@Api(tags = "Óû§¹ÜÀí") +@Api(tags = "用户管ç�†") @RestController public class UserController { - // ×¢Ò⣬¶ÔÓÚswagger£¬²»ÒªÊ¹ÓÃ@RequestMapping£¬ - // ÒòΪ@RequestMappingÖ§³ÖÈÎÒâÇëÇó·½Ê½£¬swagger»áΪÕâ¸ö½Ó¿ÚÉú³É7ÖÖÇëÇó·½Ê½µÄ½Ó¿ÚÎĵµ + // 注æ„�,对于swagger,ä¸�è¦�使用@RequestMapping, + // 因为@RequestMapping支æŒ�ä»»æ„�请求方å¼�,swagger会为这个接å�£ç”Ÿæˆ�7ç§�请求方å¼�的接å�£æ–‡æ¡£ @GetMapping("/info") public String info(String id){ return "aaa"; @@ -195,12 +195,12 @@ public class UserController { ![20200711020149](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200711020149.png) -ÎÒÃÇ¿ÉÒÔʹÓÃ`@ApiOperation`À´ÃèÊö½Ó¿Ú£¬±ÈÈ磺 +我们å�¯ä»¥ä½¿ç”¨`@ApiOperation`æ�¥æ��述接å�£ï¼Œæ¯”如: -¸´ÖÆ´úÂë +å¤�制代ç � ``` - @ApiOperation(value = "Óû§²âÊÔ",notes = "Óû§²âÊÔnotes") + @ApiOperation(value = "用户测试",notes = "用户测试notes") @GetMapping("/test") public String test(String id){ return "test"; @@ -209,57 +209,57 @@ public class UserController { ``` ![20200711021112](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200711021112.png) -³£ÓÃÅäÖÃÏ +常用é…�置项: -* value£º¿ÉÒÔµ±×÷Êǽӿڵļò³Æ -* notes£º½Ó¿ÚµÄÃèÊö -* tags£º¿ÉÒÔ¶îÍⶨÒå½Ó¿Ú×飬±ÈÈçÕâ¸ö½Ó¿ÚÍâ²ãÒѾ­ÓÐ`@Api(tags = "Óû§¹ÜÀí")`£¬½«½Ó¿Ú»®·Öµ½ÁË¡°Óû§¹ÜÀí¡±ÖУ¬µ«Äã¿ÉÒÔ¶îÍâµÄʹÓÃtags£¬ÀýÈç`tags = "½ÇÉ«¹ÜÀí"`ÈýÇÉ«¹ÜÀíÖÐÒ²ÓÐÕâ¸ö½Ó¿ÚÎĵµ¡£ +* value:å�¯ä»¥å½“作是接å�£çš„简称 +* notes:接å�£çš„æ��è¿° +* tags:å�¯ä»¥é¢�外定义接å�£ç»„,比如这个接å�£å¤–层已ç»�有`@Api(tags = "用户管ç�†")`,将接å�£åˆ’分到了“用户管ç�†â€�中,但你å�¯ä»¥é¢�外的使用tags,例如`tags = "角色管ç�†"`让角色管ç�†ä¸­ä¹Ÿæœ‰è¿™ä¸ªæŽ¥å�£æ–‡æ¡£ã€‚ -## ¶¨Òå½Ó¿ÚÇëÇó²ÎÊý +## 定义接å�£è¯·æ±‚å�‚æ•° -ÉÏÃæÊ¹ÓÃÁË`@ApiOperation`À´ÁËÃèÊö½Ó¿Ú£¬µ«Æäʵ»¹È±ÉÙ½Ó¿ÚÇëÇó²ÎÊýµÄ˵Ã÷£¬ÏÂÃæÎÒÃÇ·Ö³¡¾°À´½²¡£ -?×¢Òâһϣ¬**¶ÔÓÚGET·½Ê½£¬swagger²»ÍƼöʹÓÃbody·½Ê½À´´«µÝÊý¾Ý**£¬Ò²¾ÍÊDz»Ï£ÍûÔÚGET·½Ê½Ê±Ê¹ÓÃjson¡¢form-dataµÈ·½Ê½À´´«µÝ£¬Õâʱºò×îºÃʹÓ÷¾¶²ÎÊý»òÕßurl²ÎÊý¡£(?ËäÈ»POSTMANµÈÊÇÖ§³ÖµÄ)£¬ËùÒÔÈç¹û½Ó¿Ú´«µÝµÄÊý¾ÝÊÇjson»òÕßform-data·½Ê½µÄ£¬»¹ÊÇʹÓÃPOST·½Ê½ºÃ¡£ +上é�¢ä½¿ç”¨äº†`@ApiOperation`æ�¥äº†æ��述接å�£ï¼Œä½†å…¶å®žè¿˜ç¼ºå°‘接å�£è¯·æ±‚å�‚数的说明,下é�¢æˆ‘们分场景æ�¥è®²ã€‚ +?注æ„�一下,**对于GETæ–¹å¼�,swaggerä¸�推è��使用bodyæ–¹å¼�æ�¥ä¼ é€’æ•°æ�®**,也就是ä¸�希望在GETæ–¹å¼�时使用jsonã€�form-data等方å¼�æ�¥ä¼ é€’,这时候最好使用路径å�‚数或者urlå�‚数。(?虽然POSTMAN等是支æŒ�çš„),所以如果接å�£ä¼ é€’的数æ�®æ˜¯json或者form-dataæ–¹å¼�的,还是使用POSTæ–¹å¼�好。 -### ³¡¾°Ò»£ºÇëÇó²ÎÊýÊÇʵÌåÀà¡£ +### 场景一:请求å�‚数是实体类。 -´ËʱÎÒÃÇÐèҪʹÓÃ`@ApiModel`À´±êעʵÌåÀ࣬ȻºóÔÚ½Ó¿ÚÖж¨ÒåÈë²ÎΪʵÌåÀ༴¿É£º +此时我们需è¦�使用`@ApiModel`æ�¥æ ‡æ³¨å®žä½“类,然å�Žåœ¨æŽ¥å�£ä¸­å®šä¹‰å…¥å�‚为实体类å�³å�¯ï¼š -* @ApiModel£ºÓÃÀ´±êÀà - * ³£ÓÃÅäÖÃÏ - * value£ºÊµÌåÀà¼ò³Æ - * description£ºÊµÌåÀà˵Ã÷ -* @ApiModelProperty£ºÓÃÀ´ÃèÊöÀàµÄ×ֶεÄÒâÒå¡£ - * ³£ÓÃÅäÖÃÏ - * value£º×Ö¶Î˵Ã÷ - * example£ºÉèÖÃÇëÇóʾÀý£¨Example Value£©µÄĬÈÏÖµ£¬Èç¹û²»ÅäÖ㬵±×Ö¶ÎΪstringµÄʱºò£¬´ËʱÇëÇóʾÀýÖÐĬÈÏֵΪ"". - * name£ºÓÃеÄ×Ö¶ÎÃûÀ´Ìæ´ú¾ÉµÄ×Ö¶ÎÃû¡£ - * allowableValues£ºÏÞÖÆÖµµÃ·¶Î§£¬ÀýÈç`{1,2,3}`´ú±íÖ»ÄÜÈ¡ÕâÈý¸öÖµ£»`[1,5]`´ú±íÈ¡1µ½5µÄÖµ£»`(1,5)`´ú±í1µ½5µÄÖµ£¬²»°üÀ¨1ºÍ5£»»¹¿ÉÒÔʹÓÃinfinity»ò-infinityÀ´ÎÞÏÞÖµ£¬±ÈÈç`[1, infinity]`´ú±í×îСֵΪ1£¬×î´óÖµÎÞÇî´ó¡£ - * required£º±ê¼Ç×Ö¶ÎÊÇ·ñ±ØÌĬÈÏÊÇfalse, - * hidden£ºÓÃÀ´Òþ²Ø×ֶΣ¬Ä¬ÈÏÊÇfalse£¬Èç¹ûÒªÒþ²ØÐèҪʹÓÃtrue£¬ÒòΪ×Ö¶ÎĬÈ϶¼»áÏÔʾ£¬¾ÍËãûÓÐ`@ApiModelProperty`¡£ +* @ApiModel:用æ�¥æ ‡ç±» + * 常用é…�置项: + * value:实体类简称 + * description:实体类说明 +* @ApiModelProperty:用æ�¥æ��述类的字段的æ„�义。 + * 常用é…�置项: + * value:字段说明 + * example:设置请求示例(Example Value)的默认值,如果ä¸�é…�置,当字段为string的时候,此时请求示例中默认值为"". + * name:用新的字段å��æ�¥æ›¿ä»£æ—§çš„字段å��。 + * allowableValues:é™�制值得范围,例如`{1,2,3}`代表å�ªèƒ½å�–这三个值;`[1,5]`代表å�–1到5的值;`(1,5)`代表1到5的值,ä¸�包括1å’Œ5;还å�¯ä»¥ä½¿ç”¨infinity或-infinityæ�¥æ— é™�值,比如`[1, infinity]`代表最å°�值为1,最大值无穷大。 + * required:标记字段是å�¦å¿…填,默认是false, + * hidden:用æ�¥éš�è—�字段,默认是false,如果è¦�éš�è—�需è¦�使用true,因为字段默认都会显示,就算没有`@ApiModelProperty`。 -¸´ÖÆ´úÂë +å¤�制代ç � ``` -// ÏÈʹÓÃ@ApiModelÀ´±ê×¢Àà -@ApiModel(value="Óû§µÇ¼±íµ¥¶ÔÏó",description="Óû§µÇ¼±íµ¥¶ÔÏó") +// 先使用@ApiModelæ�¥æ ‡æ³¨ç±» +@ApiModel(value="用户登录表å�•对象",description="用户登录表å�•对象") public class LoginForm { - // ʹÓÃApiModelPropertyÀ´±ê×¢×Ö¶ÎÊôÐÔ¡£ - @ApiModelProperty(value = "Óû§Ãû",required = true,example = "root") + // 使用ApiModelPropertyæ�¥æ ‡æ³¨å­—段属性。 + @ApiModelProperty(value = "用户å��",required = true,example = "root") private String username; - @ApiModelProperty(value = "ÃÜÂë",required = true,example = "123456") + @ApiModelProperty(value = "密ç �",required = true,example = "123456") private String password; - // ´Ë´¦Ê¡ÂÔÈë²Î¸³ÖµÊ±ÐèÒªµÄgetter,setter,swaggerÒ²ÐèÒªÕâ¸ö + // 此处çœ�略入å�‚赋值时需è¦�çš„getter,setter,swagger也需è¦�这个 } ``` -¶¨Òå³ÉÈë²Î£º +定义æˆ�å…¥å�‚: -¸´ÖÆ´úÂë +å¤�制代ç � ``` - @ApiOperation(value = "µÇ¼½Ó¿Ú",notes = "µÇ¼½Ó¿ÚµÄ˵Ã÷") + @ApiOperation(value = "登录接å�£",notes = "登录接å�£çš„说明") @PostMapping("/login") public LoginForm login(@RequestBody LoginForm loginForm){ return loginForm; @@ -267,40 +267,40 @@ public class LoginForm { ``` -Ч¹û£º +效果: ![20200711181038](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200711181038.png) -### ³¡¾°¶þ£ºÇëÇó²ÎÊýÊÇ·ÇʵÌåÀà¡£ +### 场景二:请求å�‚数是é�žå®žä½“类。 -£¨**ÔÙ˵һ´Î£º¶ÔÓÚGET·½Ê½£¬swagger²»ÍƼöʹÓÃbody·½Ê½À´´«µÝÊý¾Ý£¬ËùÒÔËäÈ»Spring MVC¿ÉÒÔ×Ô¶¯·â×°²ÎÊý£¬µ«¶ÔÓÚGETÇëÇó»¹ÊDz»ÒªÊ¹ÓÃform-data£¬jsonµÈ·½Ê½´«µÝ²ÎÊý£¬³ý·ÇÄãʹÓÃPostmanÀ´²âÊÔ½Ó¿Ú£¬swaggerÔÚÏß²âÊÔÊDz»Ö§³ÖÕâ¸ö²Ù×÷µÄ**£© -¶ÔÓÚ·ÇʵÌåÀà²ÎÊý£¬¿ÉÒÔʹÓÃ`@ApiImplicitParams`ºÍ`@ApiImplicitParam`À´ÉùÃ÷ÇëÇó²ÎÊý¡£ -`@ApiImplicitParams`ÓÃÔÚ·½·¨Í·ÉÏ£¬`@ApiImplicitParam`¶¨ÒåÔÚ`@ApiImplicitParams`ÀïÃæ£¬Ò»¸ö`@ApiImplicitParam`¶ÔÓ¦Ò»¸ö²ÎÊý¡£ -`@ApiImplicitParam`³£ÓÃÅäÖÃÏ +(**å†�说一次:对于GETæ–¹å¼�,swaggerä¸�推è��使用bodyæ–¹å¼�æ�¥ä¼ é€’æ•°æ�®ï¼Œæ‰€ä»¥è™½ç„¶Spring MVCå�¯ä»¥è‡ªåЍå°�装å�‚数,但对于GET请求还是ä¸�è¦�使用form-data,json等方å¼�传递å�‚数,除é�žä½ ä½¿ç”¨Postmanæ�¥æµ‹è¯•接å�£ï¼Œswagger在线测试是ä¸�支æŒ�这个æ“�作的**) +对于é�žå®žä½“ç±»å�‚数,å�¯ä»¥ä½¿ç”¨`@ApiImplicitParams`å’Œ`@ApiImplicitParam`æ�¥å£°æ˜Žè¯·æ±‚å�‚数。 +`@ApiImplicitParams`用在方法头上,`@ApiImplicitParam`定义在`@ApiImplicitParams`里é�¢ï¼Œä¸€ä¸ª`@ApiImplicitParam`对应一个å�‚数。 +`@ApiImplicitParam`常用é…�置项: -* name£ºÓÃÀ´¶¨Òå²ÎÊýµÄÃû×Ö£¬Ò²¾ÍÊÇ×ֶεÄÃû×Ö,¿ÉÒÔÓë½Ó¿ÚµÄÈë²ÎÃû¶ÔÓ¦¡£**Èç¹û²»¶ÔÓ¦£¬Ò²»áÉú³É£¬ËùÒÔ¿ÉÒÔÓÃÀ´¶¨Òå¶îÍâ²ÎÊý£¡** -* value£ºÓÃÀ´ÃèÊö²ÎÊý -* required£ºÓÃÀ´±ê×¢²ÎÊýÊÇ·ñ±ØÌî -* paramTypeÓÐpath,query,body,form,headerµÈ·½Ê½£¬µ«¶ÔÓÚ¶ÔÓÚ·ÇʵÌåÀà²ÎÊýµÄʱºò£¬³£ÓõÄÖ»ÓÐpath,query,header£»bodyºÍformÊDz»³£Óõġ£body²»ÊÊÓÃÓÚ¶à¸öÁãÉ¢²ÎÊýµÄÇé¿ö£¬Ö»ÊÊÓÃÓÚjson¶ÔÏóµÈÇé¿ö¡£¡¾Èç¹ûÄãµÄ½Ó¿ÚÊÇ`form-data`,`x-www-form-urlencoded`µÄʱºò¿ÉÄܲ»ÄÜʹÓÃswaggerÒ³ÃæAPIµ÷ÊÔ£¬µ«¿ÉÒÔÔÚºóÃæ½²µ½»ùÓÚBootstrapUIµÄswaggerÔöÇ¿Öе÷ÊÔ£¬»ùÓÚBootstrapUIµÄswaggerÖ§³ÖÖ¸¶¨`form-data`»ò`x-www-form-urlencoded`¡¿ +* name:用æ�¥å®šä¹‰å�‚æ•°çš„å��字,也就是字段的å��å­—,å�¯ä»¥ä¸ŽæŽ¥å�£çš„å…¥å�‚å��对应。**如果ä¸�对应,也会生æˆ�,所以å�¯ä»¥ç”¨æ�¥å®šä¹‰é¢�外å�‚æ•°ï¼�** +* value:用æ�¥æ��è¿°å�‚æ•° +* required:用æ�¥æ ‡æ³¨å�‚数是å�¦å¿…å¡« +* paramType有path,query,body,form,header等方å¼�,但对于对于é�žå®žä½“ç±»å�‚数的时候,常用的å�ªæœ‰path,query,headerï¼›bodyå’Œform是ä¸�常用的。bodyä¸�适用于多个零散å�‚数的情况,å�ªé€‚用于json对象等情况。ã€�如果你的接å�£æ˜¯`form-data`,`x-www-form-urlencoded`的时候å�¯èƒ½ä¸�能使用swagger页é�¢API调试,但å�¯ä»¥åœ¨å�Žé�¢è®²åˆ°åŸºäºŽBootstrapUIçš„swagger增强中调试,基于BootstrapUIçš„swagger支æŒ�指定`form-data`或`x-www-form-urlencoded`】 -ʾÀýÒ»£ºÉùÃ÷Èë²ÎÊÇURL²ÎÊý +示例一:声明入å�‚是URLå�‚æ•° -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // ʹÓÃURL query²ÎÊý - @ApiOperation(value = "µÇ¼½Ó¿Ú2",notes = "µÇ¼½Ó¿ÚµÄ˵Ã÷2") + // 使用URL queryå�‚æ•° + @ApiOperation(value = "登录接å�£2",notes = "登录接å�£çš„说明2") @ApiImplicitParams({ - @ApiImplicitParam(name = "username",//²ÎÊýÃû×Ö - value = "Óû§Ãû",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë - //paramType¶¨Òå²ÎÊý´«µÝÀàÐÍ£ºÓÐpath,query,body,form,header + @ApiImplicitParam(name = "username",//å�‚æ•°å��å­— + value = "用户å��",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 + //paramType定义å�‚数传递类型:有path,query,body,form,header paramType = "query" ) , - @ApiImplicitParam(name = "password",//²ÎÊýÃû×Ö - value = "ÃÜÂë",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë + @ApiImplicitParam(name = "password",//å�‚æ•°å��å­— + value = "密ç �",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 paramType = "query" ) }) @@ -315,25 +315,25 @@ public class LoginForm { ``` -ʾÀý¶þ£ºÉùÃ÷Èë²ÎÊÇURL·¾¶²ÎÊý +示例二:声明入å�‚是URL路径å�‚æ•° -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // ʹÓ÷¾¶²ÎÊý + // 使用路径å�‚æ•° @PostMapping("/login3/{id1}/{id2}") - @ApiOperation(value = "µÇ¼½Ó¿Ú3",notes = "µÇ¼½Ó¿ÚµÄ˵Ã÷3") + @ApiOperation(value = "登录接å�£3",notes = "登录接å�£çš„说明3") @ApiImplicitParams({ - @ApiImplicitParam(name = "id1",//²ÎÊýÃû×Ö - value = "Óû§Ãû",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë - //paramType¶¨Òå²ÎÊý´«µÝÀàÐÍ£ºÓÐpath,query,body,form,header + @ApiImplicitParam(name = "id1",//å�‚æ•°å��å­— + value = "用户å��",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 + //paramType定义å�‚数传递类型:有path,query,body,form,header paramType = "path" ) , - @ApiImplicitParam(name = "id2",//²ÎÊýÃû×Ö - value = "ÃÜÂë",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë + @ApiImplicitParam(name = "id2",//å�‚æ•°å��å­— + value = "密ç �",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 paramType = "path" ) }) @@ -343,25 +343,25 @@ public class LoginForm { ``` -ʾÀýÈý£ºÉùÃ÷Èë²ÎÊÇheader²ÎÊý +示例三:声明入å�‚是headerå�‚æ•° -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // ÓÃheader´«µÝ²ÎÊý + // 用header传递å�‚æ•° @PostMapping("/login4") - @ApiOperation(value = "µÇ¼½Ó¿Ú4",notes = "µÇ¼½Ó¿ÚµÄ˵Ã÷4") + @ApiOperation(value = "登录接å�£4",notes = "登录接å�£çš„说明4") @ApiImplicitParams({ - @ApiImplicitParam(name = "username",//²ÎÊýÃû×Ö - value = "Óû§Ãû",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë - //paramType¶¨Òå²ÎÊý´«µÝÀàÐÍ£ºÓÐpath,query,body,form,header + @ApiImplicitParam(name = "username",//å�‚æ•°å��å­— + value = "用户å��",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 + //paramType定义å�‚数传递类型:有path,query,body,form,header paramType = "header" ) , - @ApiImplicitParam(name = "password",//²ÎÊýÃû×Ö - value = "ÃÜÂë",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë + @ApiImplicitParam(name = "password",//å�‚æ•°å��å­— + value = "密ç �",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 paramType = "header" ) }) @@ -372,25 +372,25 @@ public class LoginForm { ``` -ʾÀýËÄ£ºÉùÃ÷ÎļþÉÏ´«²ÎÊý +示例四:声明文件上传å�‚æ•° -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // ÓÐÎļþÉÏ´«Ê±ÒªÓÃ@ApiParam£¬Ó÷¨»ù±¾Óë@ApiImplicitParamÒ»Ñù£¬²»¹ý@ApiParamÓÃÔÚ²ÎÊýÉÏ - // »òÕßÄãÒ²¿ÉÒÔ²»×¢½â£¬swagger»á×Ô¶¯Éú³É˵Ã÷ - @ApiOperation(value = "ÉÏ´«Îļþ",notes = "ÉÏ´«Îļþ") + // 有文件上传时è¦�用@ApiParam,用法基本与@ApiImplicitParam一样,ä¸�过@ApiParam用在å�‚数上 + // 或者你也å�¯ä»¥ä¸�注解,swagger会自动生æˆ�说明 + @ApiOperation(value = "上传文件",notes = "上传文件") @PostMapping(value = "/upload") - public String upload(@ApiParam(value = "ͼƬÎļþ", required = true)MultipartFile uploadFile){ + public String upload(@ApiParam(value = "图片文件", required = true)MultipartFile uploadFile){ String originalFilename = uploadFile.getOriginalFilename(); return originalFilename; } - // ¶à¸öÎļþÉÏ´«Ê±£¬**swaggerÖ»ÄܲâÊÔµ¥ÎļþÉÏ´«** - @ApiOperation(value = "ÉÏ´«¶à¸öÎļþ",notes = "ÉÏ´«¶à¸öÎļþ") + // 多个文件上传时,**swaggerå�ªèƒ½æµ‹è¯•å�•文件上传** + @ApiOperation(value = "上传多个文件",notes = "上传多个文件") @PostMapping(value = "/upload2",consumes = "multipart/*", headers = "content-type=multipart/form-data") - public String upload2(@ApiParam(value = "ͼƬÎļþ", required = true,allowMultiple = true)MultipartFile[] uploadFile){ + public String upload2(@ApiParam(value = "图片文件", required = true,allowMultiple = true)MultipartFile[] uploadFile){ StringBuffer sb = new StringBuffer(); for (int i = 0; i < uploadFile.length; i++) { System.out.println(uploadFile[i].getOriginalFilename()); @@ -400,16 +400,16 @@ public class LoginForm { return sb.toString(); } - // ¼ÈÓÐÎļþ£¬ÓÖÓвÎÊý - @ApiOperation(value = "¼ÈÓÐÎļþ£¬ÓÖÓвÎÊý",notes = "¼ÈÓÐÎļþ£¬ÓÖÓвÎÊý") + // 既有文件,å�ˆæœ‰å�‚æ•° + @ApiOperation(value = "既有文件,å�ˆæœ‰å�‚æ•°",notes = "既有文件,å�ˆæœ‰å�‚æ•°") @PostMapping(value = "/upload3") @ApiImplicitParams({ @ApiImplicitParam(name = "name", - value = "ͼƬÐÂÃû×Ö", + value = "图片新å��å­—", required = true ) }) - public String upload3(@ApiParam(value = "ͼƬÎļþ", required = true)MultipartFile uploadFile, + public String upload3(@ApiParam(value = "图片文件", required = true)MultipartFile uploadFile, String name){ String originalFilename = uploadFile.getOriginalFilename(); @@ -418,19 +418,19 @@ public class LoginForm { ``` -## ¶¨Òå½Ó¿ÚÏìÓ¦ +## 定义接å�£å“�应 -¶¨Òå½Ó¿ÚÏìÓ¦£¬ÊÇ·½±ã²é¿´½Ó¿ÚÎĵµµÄÈËÄܹ»ÖªµÀ½Ó¿Ú·µ»ØµÄÊý¾ÝµÄÒâÒå¡£ +定义接å�£å“�应,是方便查看接å�£æ–‡æ¡£çš„人能够知é�“接å�£è¿”回的数æ�®çš„æ„�义。 -### ÏìÓ¦ÊÇʵÌåÀࣺ +### å“�应是实体类: -Ç°ÃæÔÚ¶¨Òå½Ó¿ÚÇëÇó²ÎÊýµÄʱºòÓÐÌᵽʹÓÃ`@ApiModel`À´±ê×¢À࣬Èç¹û½Ó¿Ú·µ»ØÁËÕâ¸öÀ࣬ÄÇôÕâ¸öÀàÉϵÄ˵Ã÷Ò²»á×÷ΪÏìÓ¦µÄ˵Ã÷£º +å‰�é�¢åœ¨å®šä¹‰æŽ¥å�£è¯·æ±‚å�‚数的时候有æ��到使用`@ApiModel`æ�¥æ ‡æ³¨ç±»ï¼Œå¦‚果接å�£è¿”回了这个类,那么这个类上的说明也会作为å“�应的说明: -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // ·µ»Ø±»@ApiModel±ê×¢µÄÀà¶ÔÏó - @ApiOperation(value = "ʵÌåÀàÏìÓ¦",notes = "·µ»ØÊý¾ÝΪʵÌåÀàµÄ½Ó¿Ú") + // 返回被@ApiModel标注的类对象 + @ApiOperation(value = "实体类å“�应",notes = "返回数æ�®ä¸ºå®žä½“类的接å�£") @PostMapping("/role1") public LoginForm role1(@RequestBody LoginForm loginForm){ return loginForm; @@ -440,27 +440,27 @@ public class LoginForm { ![20200712000406](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712000406.png) -### ÏìÓ¦ÊÇ·ÇʵÌåÀࣺ +### å“�应是é�žå®žä½“类: -swaggerÎÞ·¨¶Ô·ÇʵÌåÀàµÄÏìÓ¦½øÐÐÏêϸ˵Ã÷£¬Ö»Äܱê×¢ÏìÓ¦ÂëµÈÐÅÏ¢¡£ÊÇͨ¹ý`@ApiResponses`ºÍ`@ApiResponse`À´ÊµÏֵġ£ -`@ApiResponses`ºÍ`@ApiResponse`¿ÉÒÔÓë`@ApiModel`Ò»ÆðʹÓᣠ+swagger无法对é�žå®žä½“类的å“�应进行详细说明,å�ªèƒ½æ ‡æ³¨å“�应ç �等信æ�¯ã€‚是通过`@ApiResponses`å’Œ`@ApiResponse`æ�¥å®žçŽ°çš„ã€‚ +`@ApiResponses`å’Œ`@ApiResponse`å�¯ä»¥ä¸Ž`@ApiModel`一起使用。 -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // ÆäËûÀàÐ͵Ä,´Ëʱ²»ÄÜÔö¼Ó×Ö¶Î×¢ÊÍ£¬ËùÒÔÆäʵswaggerÍÆ¼öʹÓÃʵÌåÀà - @ApiOperation(value = "·ÇʵÌåÀà",notes = "·ÇʵÌåÀà") + // 其他类型的,此时ä¸�能增加字段注释,所以其实swagger推è��使用实体类 + @ApiOperation(value = "é�žå®žä½“ç±»",notes = "é�žå®žä½“ç±»") @ApiResponses({ - @ApiResponse(code=200,message = "µ÷Óóɹ¦"), - @ApiResponse(code=401,message = "ÎÞȨÏÞ" ) + @ApiResponse(code=200,message = "调用æˆ�功"), + @ApiResponse(code=401,message = "æ— æ�ƒé™�" ) } ) @PostMapping("/role2") public String role2(){ return " {\n" + - " name:\"¹ã¶«\",\n" + + " name:\"广东\",\n" + " citys:{\n" + - " city:[\"¹ãÖÝ\",\"ÉîÛÚ\",\"Ö麣\"]\n" + + " city:[\"广州\",\"深圳\",\"ç� æµ·\"]\n" + " }\n" + " }"; } @@ -471,24 +471,24 @@ swagger * * * -# Swagger UIÔöÇ¿ +# Swagger UI增强 -Äã¿ÉÄÜ»á¾õµÃÏÖÔÚÕâ¸öUI²»ÊǺܺÿ´£¬ÏÖÔÚÓÐһЩµÚÈý·½ÌṩÁËһЩSwagger UIÔöÇ¿£¬±È½ÏÁ÷ÐеÄÊÇ`swagger-bootstrap-ui`£¬ÎÒÃÇÕâÀïÒÔ`swagger-bootstrap-ui`ΪÀý¡£ +ä½ å�¯èƒ½ä¼šè§‰å¾—现在这个UIä¸�是很好看,现在有一些第三方æ��供了一些Swagger UI增强,比较æµ�行的是`swagger-bootstrap-ui`,我们这里以`swagger-bootstrap-ui`为例。 -## UI¶Ô±È£º +## UI对比: ![20200712013653](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712013653.png) ![20200712013723](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712013723.png) -## ʹÓà +## 使用 -1.Ìí¼ÓÒÀÀµ°ü£º +1.添加ä¾�赖包: -¸´ÖÆ´úÂë +å¤�制代ç � ``` - + io.springfox springfox-swagger2 @@ -499,7 +499,7 @@ swagger springfox-swagger-ui 2.9.2 - + com.github.xiaoymin swagger-bootstrap-ui @@ -508,96 +508,96 @@ swagger ``` -2.ÔÚswaggerÅäÖÃÀàÖÐÔö¼Ó×¢½â`@EnableSwaggerBootstrapUI`: +2.在swaggeré…�置类中增加注解`@EnableSwaggerBootstrapUI`: -¸´ÖÆ´úÂë +å¤�制代ç � ``` -@Configuration // ±êÃ÷ÊÇÅäÖÃÀà -@EnableSwagger2 //¿ªÆôswagger¹¦ÄÜ -@EnableSwaggerBootstrapUI // ¿ªÆôSwaggerBootstrapUI +@Configuration // 标明是é…�置类 +@EnableSwagger2 //å¼€å�¯swagger功能 +@EnableSwaggerBootstrapUI // å¼€å�¯SwaggerBootstrapUI public class SwaggerConfig { - // Ê¡ÂÔÅäÖÃÄÚÈÝ + // çœ�ç•¥é…�置内容 } ``` -3.·ÃÎÊAPI£º`http://localhost:8080/doc.html`£¬¼´¿ÉÔ¤ÀÀµ½»ùÓÚbootstarpµÄSwagger UI½çÃæ¡£ +3.访问API:`http://localhost:8080/doc.html`,å�³å�¯é¢„览到基于bootstarpçš„Swagger UI界é�¢ã€‚ -## Óŵã +## 优点 -1.?½çÃæºÃ¿´ÁËÒ»µã +1.?界é�¢å¥½çœ‹äº†ä¸€ç‚¹ -2.ÉÏÃæËµ¹ýÁË£¬»ùÓÚBootstrapUIµÄswaggerÖ§³ÖÖ¸¶¨`form-data`»ò`x-www-form-urlencoded`£º +2.上é�¢è¯´è¿‡äº†ï¼ŒåŸºäºŽBootstrapUIçš„swagger支æŒ�指定`form-data`或`x-www-form-urlencoded`: ![20200712024858](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712024858.png) -3.Ö§³Ö¸´ÖƵ¥¸öAPIÎĵµºÍµ¼³öÈ«²¿APIÎĵµ£º +3.支æŒ�å¤�制å�•个API文档和导出全部API文档: ![20200712025020](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712025020.png) ![20200712025044](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20200712025044.png) * * * -# ÕûºÏSpring Security×¢Òâ +# æ•´å�ˆSpring Security注æ„� -ÔÚSpring BootÕûºÏSpring SecurityºÍSwaggerµÄʱºò£¬ÐèÒªÅäÖÃÀ¹½ØµÄ·¾¶ºÍ·ÅÐеÄ·¾¶£¬×¢ÒâÊÇ·ÅÐÐÒÔϼ¸¸ö·¾¶¡£ +在Spring Bootæ•´å�ˆSpring Securityå’ŒSwagger的时候,需è¦�é…�置拦截的路径和放行的路径,注æ„�是放行以下几个路径。 -¸´ÖÆ´úÂë +å¤�制代ç � ``` .antMatchers("/swagger**/**").permitAll() .antMatchers("/webjars/**").permitAll() .antMatchers("/v2/**").permitAll() -.antMatchers("/doc.html").permitAll() // Èç¹ûÄãÓÃÁËbootstarpµÄSwagger UI½çÃæ£¬¼ÓÒ»¸öÕâ¸ö¡£ +.antMatchers("/doc.html").permitAll() // 如果你用了bootstarpçš„Swagger UI界é�¢ï¼ŒåŠ ä¸€ä¸ªè¿™ä¸ªã€‚ ``` * * * -# ¶ÔÓÚtokenµÄ´¦Àí +# 对于token的处ç�† -ÔÚswaggerÖÐÖ»Ö§³ÖÁ˼òµ¥µÄµ÷ÊÔ£¬µ«¶ÔÓÚһЩ½Ó¿Ú£¬ÎÒÃDzâÊÔµÄʱºò¿ÉÄÜÐèÒª°ÑtokenÐÅϢдµ½headerÖУ¬Ä¿Ç°ºÃÏñû¿´µ½¿ÉÒÔ×Ô¶¨Òå¼ÓÇëÇóÍ·µÄµØ·½£¿ -?·½·¨Ò»£º -¡¡¡¡Èç¹ûÄãʹÓÃÁËSwagger BootstrapUI£¬ÄÇôÄã¿ÉÒÔÔÚ¡°Îĵµ¹ÜÀí¡±ÖÐÔö¼ÓÈ«¾Ö²ÎÊý£¬Õâ°üÀ¨ÁËÌí¼Óheader²ÎÊý¡£ +在swagger中å�ªæ”¯æŒ�了简å�•的调试,但对于一些接å�£ï¼Œæˆ‘们测试的时候å�¯èƒ½éœ€è¦�把tokenä¿¡æ�¯å†™åˆ°header中,目å‰�好åƒ�没看到å�¯ä»¥è‡ªå®šä¹‰åŠ è¯·æ±‚å¤´çš„åœ°æ–¹ï¼Ÿ +?方法一: +  如果你使用了Swagger BootstrapUI,那么你å�¯ä»¥åœ¨â€œæ–‡æ¡£ç®¡ç�†â€�中增加全局å�‚数,这包括了添加headerå�‚数。 -?·½·¨¶þ£ºÔÚswaggerÅäÖÃÀàÖÐÔö¼ÓÈ«¾Ö²ÎÊýÅäÖ㺠+?方法二:在swaggeré…�置类中增加全局å�‚æ•°é…�置: -¸´ÖÆ´úÂë +å¤�制代ç � ``` - //Èç¹ûÓжîÍâµÄÈ«¾Ö²ÎÊý£¬±ÈÈç˵ÇëÇóÍ·²ÎÊý£¬¿ÉÒÔÕâÑùÌí¼Ó + //如果有é¢�外的全局å�‚数,比如说请求头å�‚数,å�¯ä»¥è¿™æ ·æ·»åŠ  ParameterBuilder parameterBuilder = new ParameterBuilder(); List parameters = new ArrayList(); - parameterBuilder.name("authorization").description("ÁîÅÆ") + parameterBuilder.name("authorization").description("令牌") .modelRef(new ModelRef("string")).parameterType("header").required(false).build(); parameters.add(parameterBuilder.build()); - return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 ¹Ì¶¨µÄ£¬´ú±íswagger2 - .apiInfo(apiInfo()) // ÓÃÓÚÉú³ÉAPIÐÅÏ¢ - .select() // select()º¯Êý·µ»ØÒ»¸öApiSelectorBuilderʵÀý,ÓÃÀ´¿ØÖƽӿڱ»swagger×ö³ÉÎĵµ - .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // ÓÃÓÚÖ¸¶¨É¨ÃèÄĸö°üÏÂµÄ½Ó¿Ú - .paths(PathSelectors.any())// Ñ¡ÔñËùÓеÄAPI,Èç¹ûÄãÏëֻΪ²¿·ÖAPIÉú³ÉÎĵµ£¬¿ÉÒÔÅäÖÃÕâÀï + return new Docket(DocumentationType.SWAGGER_2) // DocumentationType.SWAGGER_2 固定的,代表swagger2 + .apiInfo(apiInfo()) // 用于生æˆ�APIä¿¡æ�¯ + .select() // select()函数返回一个ApiSelectorBuilder实例,用æ�¥æŽ§åˆ¶æŽ¥å�£è¢«swaggerå�šæˆ�文档 + .apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 用于指定扫æ��哪个包下的接å�£ + .paths(PathSelectors.any())// 选择所有的API,如果你想å�ªä¸ºéƒ¨åˆ†API生æˆ�文档,å�¯ä»¥é…�置这里 .build().globalOperationParameters(parameters); ``` -?·½·¨Èý£ºÊ¹ÓÃ`@ApiImplicitParams`À´¶îÍâ±ê×¢Ò»¸öÇëÇóÍ·²ÎÊý£¬ÀýÈ磺 +?方法三:使用`@ApiImplicitParams`æ�¥é¢�外标注一个请求头å�‚数,例如: -¸´ÖÆ´úÂë +å¤�制代ç � ``` - // Èç¹ûÐèÒª¶îÍâµÄ²ÎÊý£¬·Ç±¾·½·¨Óõ½£¬µ«¹ýÂËÆ÷ÒªÓÃ,ÀàËÆÓÚȨÏÞtoken + // 如果需è¦�é¢�外的å�‚数,é�žæœ¬æ–¹æ³•用到,但过滤器è¦�用,类似于æ�ƒé™�token @PostMapping("/login6") - @ApiOperation(value = "´øtokenµÄ½Ó¿Ú",notes = "´øtokenµÄ½Ó¿Ú") + @ApiOperation(value = "带token的接å�£",notes = "带token的接å�£") @ApiImplicitParams({ - @ApiImplicitParam(name = "authorization",//²ÎÊýÃû×Ö - value = "ÊÚȨtoken",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë + @ApiImplicitParam(name = "authorization",//å�‚æ•°å��å­— + value = "授æ�ƒtoken",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 paramType = "header" ) , - @ApiImplicitParam(name = "username",//²ÎÊýÃû×Ö - value = "Óû§Ãû",//²ÎÊýµÄÃèÊö - required = true,//ÊÇ·ñ±ØÐë´«Èë + @ApiImplicitParam(name = "username",//å�‚æ•°å��å­— + value = "用户å��",//å�‚æ•°çš„æ��è¿° + required = true,//是å�¦å¿…须传入 paramType = "query" ) }) @@ -609,17 +609,17 @@ public class SwaggerConfig { * * * -# SwaggerµÄ°²È«¹ÜÀí +# Swagger的安全管ç�† -1.Èç¹ûÄãÕûºÏÁËȨÏÞ¹ÜÀí£¬¿ÉÒÔ¸øswagger¼ÓÉÏȨÏÞ¹ÜÀí£¬ÒªÇó·ÃÎÊswaggerÒ³ÃæÊäÈëÓû§ÃûºÍÃÜÂ룬ÕâЩÊÇspring securityºÍshiroµÄÊÂÁË£¬ÕâÀï²»½²¡£ +1.如果你整å�ˆäº†æ�ƒé™�管ç�†ï¼Œå�¯ä»¥ç»™swagger加上æ�ƒé™�管ç�†ï¼Œè¦�求访问swagger页é�¢è¾“入用户å��和密ç �,这些是spring securityå’Œshiro的事了,这里ä¸�讲。 -2.Èç¹ûÄã½ö½öÊDz»ÏëÔÚÕýʽ»·¾³ÖпÉÒÔ·ÃÎÊ£¬¿ÉÒÔÔÚÕýʽ»·¾³ÖйرÕSwagger×Ô¶¯ÅäÖã¬Õâ¾Í²»»áÓÐswaggerÒ³ÃæÁË¡£Ê¹ÓÃ`@Profile({"dev","test"})`×¢½âÀ´ÏÞÖÆÖ»ÔÚdev»òÕßtestÏÂÆôÓÃSwagger×Ô¶¯ÅäÖᣠ-È»ºóÔÚSpring BootÅäÖÃÎļþÖÐÐ޸ĵ±Ç°profile`spring.profiles.active=release`£¬ÖØÆôÖ®ºó£¬´ËʱÎÞ·¨·ÃÎÊ`http://localhost:8080/swagger-ui.html` +2.如果你仅仅是ä¸�想在正å¼�环境中å�¯ä»¥è®¿é—®ï¼Œå�¯ä»¥åœ¨æ­£å¼�环境中关闭Swagger自动é…�置,这就ä¸�会有swagger页é�¢äº†ã€‚使用`@Profile({"dev","test"})`注解æ�¥é™�制å�ªåœ¨dev或者test下å�¯ç”¨Swagger自动é…�置。 +ç„¶å�Žåœ¨Spring Booté…�置文件中修改当å‰�profile`spring.profiles.active=release`,é‡�å�¯ä¹‹å�Žï¼Œæ­¤æ—¶æ— æ³•访问`http://localhost:8080/swagger-ui.html` * * * -×÷Õߣº[progor](https://www.cnblogs.com/progor/) -±¾ÎÄΪ×÷ÕßÔ­´´£¬×ªÔØÇë×¢Ã÷³ö´¦ +作者:[progor](https://www.cnblogs.com/progor/) +本文为作者原创,转载请注明出处 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/Spring\345\270\270\350\247\201\346\263\250\350\247\243\344\275\277\347\224\250\346\214\207\345\215\227(\345\214\205\345\220\253Spring+SpringMVC+SpringBoot).md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/Spring\345\270\270\350\247\201\346\263\250\350\247\243\344\275\277\347\224\250\346\214\207\345\215\227(\345\214\205\345\220\253Spring+SpringMVC+SpringBoot).md" index 813fabe..f50c56b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/Spring\345\270\270\350\247\201\346\263\250\350\247\243\344\275\277\347\224\250\346\214\207\345\215\227(\345\214\205\345\220\253Spring+SpringMVC+SpringBoot).md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/Spring\345\270\270\350\247\201\346\263\250\350\247\243\344\275\277\347\224\250\346\214\207\345\215\227(\345\214\205\345\220\253Spring+SpringMVC+SpringBoot).md" @@ -1,25 +1,25 @@ -# Spring×¢½â -## 1 ¸ÅÊö +# Spring注解 +## 1 概述 -ÎÒÃǶ¼ÖªµÀSpring×îºËÐĵÄÌØÐÔ¾ÍÊÇIOC+AOP£¬IOCµÄÔ­Àí¾ÍÊÇʵÏÖÁËÒ»¸öSpringÈÝÆ÷£¬ÓÃÀ´¹ÜÀíËùÓÐSpring BeanʵÀý -DI£¬Ò²¾ÍÊÇÒÀÀµ×¢È룬ÊÇÎÒÃÇ×÷Ϊ¿ª·¢ÕßÐèÒª¹ØÐĵĺËÐÄ»°Ì⣬ÈçºÎ×¢ÈëÒÀÀµ£¬×¢ÈëÄĸöÒÀÀµ£¬ÊÇÎÒÃÇÐèÒªÃ÷È·ÖªµÀµÄ¡£ -ÔÚÒÔǰ£¬ÎÒÃÇϰ¹ßÓÚÓÃxmlÅäÖÃÎļþÀ´ÉùÃ÷Ò»¸öbean£¬µ«ÏÖÔÚ£¬ÎÒÃǸü¶àµØÊ¹ÓÃ×¢½âºÍ´úÂëÀ´Íê³ÉDIµÄ¹ý³Ì +我们都知é�“Spring最核心的特性就是IOC+AOP,IOC的原ç�†å°±æ˜¯å®žçŽ°äº†ä¸€ä¸ªSpring容器,用æ�¥ç®¡ç�†æ‰€æœ‰Spring Bean实例 +DI,也就是ä¾�赖注入,是我们作为开å�‘者需è¦�关心的核心è¯�题,如何注入ä¾�赖,注入哪个ä¾�赖,是我们需è¦�明确知é�“的。 +在以å‰�,我们习惯于用xmlé…�置文件æ�¥å£°æ˜Žä¸€ä¸ªbean,但现在,我们更多地使用注解和代ç �æ�¥å®Œæˆ�DI的过程 -ÎÒÃÇ¿ÉÒÔʹÓà org.springframework.beans.factory.annotation ºÍ org.springframework.context.annotation °üÖеÄ×¢ÊÍÀ´ÆôÓà Spring DI ÒýÇæµÄ¹¦ÄÜ¡£ +我们å�¯ä»¥ä½¿ç”¨ org.springframework.beans.factory.annotation å’Œ org.springframework.context.annotation 包中的注释æ�¥å�¯ç”¨ Spring DI 引擎的功能。 -ÎÒÃÇͨ³£½«ÕâЩ³ÆÎª¡°Spring ºËÐÄ×¢ÊÍ¡±£¬ÎÒÃǽ«ÔÚ±¾½Ì³ÌÖÐ¶ÔÆä½øÐлعˡ£ +我们通常将这些称为“Spring 核心注释â€�,我们将在本教程中对其进行回顾。 -## 2 DIÏà¹Ø×¢½â +## 2 DI相关注解 ### 2.1 @Autowired -ÎÒÃÇ¿ÉÒÔʹÓà @Autowired À´±ê¼Ç Spring ½«Òª½âÎöºÍ×¢ÈëµÄÒÀÀµÏî¡£ -ÎÒÃÇ¿ÉÒÔ½«´Ë×¢ÊÍÓë¹¹Ô캯Êý¡¢setter »ò×Ö¶Î×¢ÈëÒ»ÆðʹÓᣠ+我们å�¯ä»¥ä½¿ç”¨ @Autowired æ�¥æ ‡è®° Spring å°†è¦�è§£æž�和注入的ä¾�赖项。 +我们å�¯ä»¥å°†æ­¤æ³¨é‡Šä¸Žæž„造函数ã€�setter 或字段注入一起使用。 Constructor injection: -**¹¹ÔìÆ÷×¢Èë** +**构造器注入** ```` class Car { @@ -32,7 +32,7 @@ class Car { } ```` -**Setter×¢Èë** +**Setter注入** ```` class Car { Engine engine; @@ -43,7 +43,7 @@ class Car { } } ```` -**±äÁ¿×¢Èë** +**å�˜é‡�注入** ```` class Car { @Autowired @@ -51,17 +51,17 @@ class Car { } ```` -@Autowired ÓÐÒ»¸öÃûΪ required µÄ²¼¶û²ÎÊý£¬Ä¬ÈÏֵΪ true¡£ +@Autowired 有一个å��为 required 的布尔å�‚数,默认值为 true。 -µ±ËüÕÒ²»µ½ºÏÊ浀 bean À´Á¬½Óʱ£¬Ëü»áµ÷Õû Spring µÄÐÐΪ¡£ µ±Îª true ʱ£¬½«Å׳öÒì³££¬·ñÔò²»Á¬½ÓÈκÎÄÚÈÝ¡£ +当它找ä¸�到å�ˆé€‚çš„ bean æ�¥è¿žæŽ¥æ—¶ï¼Œå®ƒä¼šè°ƒæ•´ Spring 的行为。 当为 true 时,将抛出异常,å�¦åˆ™ä¸�连接任何内容。 -Çë×¢Ò⣬Èç¹ûÎÒÃÇʹÓù¹Ô캯Êý×¢È룬ÔòËùÓй¹Ô캯Êý²ÎÊý¶¼ÊÇÇ¿ÖÆÐԵġ£ +请注æ„�,如果我们使用构造函数注入,则所有构造函数å�‚数都是强制性的。 -´Ó 4.3 °æ±¾¿ªÊ¼£¬ÎÒÃDz»ÐèÒªÏÔʽµØÊ¹Óà @Autowired ×¢½â¹¹Ô캯Êý£¬³ý·ÇÎÒÃÇÉùÃ÷ÖÁÉÙÁ½¸ö¹¹Ô캯Êý¡£ +从 4.3 版本开始,我们ä¸�需è¦�显å¼�地使用 @Autowired 注解构造函数,除é�žæˆ‘们声明至少两个构造函数。 ### 2.2 @Bean -@Bean ±ê¼ÇʵÀý»¯ Spring bean µÄ¹¤³§·½·¨£º +@Bean 标记实例化 Spring bean 的工厂方法: ``` @Bean @@ -70,9 +70,9 @@ Engine engine() { } ```` -µ±ÐèÒª·µ»ØÀàÐ͵ÄÐÂʵÀýʱ£¬Spring »áµ÷ÓÃÕâЩ·½·¨¡£ +当需è¦�返回类型的新实例时,Spring 会调用这些方法。 -Éú³ÉµÄ bean Ó빤³§·½·¨Í¬Ãû¡£ Èç¹ûÎÒÃÇÏëÒÔ²»Í¬µÄ·½Ê½ÃüÃû£¬ÎÒÃÇ¿ÉÒÔʹÓôË×¢Ê͵ÄÃû³Æ»òÖµ²ÎÊý£¨²ÎÊýÖµÊDzÎÊýÃû³ÆµÄ±ðÃû£©£º +生æˆ�çš„ bean 与工厂方法å�Œå��。 如果我们想以ä¸�å�Œçš„æ–¹å¼�命å��,我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨é‡Šçš„å��称或值å�‚数(å�‚数值是å�‚æ•°å��称的别å��): ```` @Bean("engine") @@ -80,17 +80,17 @@ Engine getEngine() { return new Engine(); } ```` -ÕâÊÇÒ»Öַdz£³£¼ûµÄbeanÉùÃ÷·½Ê½£¬ÒòΪºÜ¶àµÄbean²¢²»ÊÇÎÒÃÇÒ»¿ªÊ¼¾ÍÔÚ´úÂëÀﶨÒåºÃµÄ£¬Ëü¿ÉÄÜÐèÒª»ùÓÚÔËÐÐʱ»·¾³À´½øÐа´Ðè¹¹½¨¡£ +这是一ç§�é�žå¸¸å¸¸è§�çš„bean声明方å¼�,因为很多的beanå¹¶ä¸�是我们一开始就在代ç �里定义好的,它å�¯èƒ½éœ€è¦�基于è¿�行时环境æ�¥è¿›è¡ŒæŒ‰éœ€æž„建。 -ÎÒÃÇ¿ÉÒÔ×ÔÓɵØÉùÃ÷ºÍ¶¨ÒåBean£¬²¢ÇÒÒ²¿ÉÒÔ¸³ÓèËü×Ô¶¨ÒåµÄbeanÃû³Æ¡£ +我们å�¯ä»¥è‡ªç”±åœ°å£°æ˜Žå’Œå®šä¹‰Bean,并且也å�¯ä»¥èµ‹äºˆå®ƒè‡ªå®šä¹‰çš„beanå��称。 -×¢Ò⣬ËùÓÐÓÃ@Bean ×¢Ê͵ķ½·¨¶¼±ØÐëÔÚ@Configuration ÀàÖС£ +注æ„�,所有用@Bean 注释的方法都必须在@Configuration 类中。 ### 2.3 @Qualifier -ÎÒÃÇʹÓÃ@Qualifier ºÍ@Autowired À´ÌṩÎÒÃÇÏëÒªÔÚ²»Ã÷È·Çé¿öÏÂʹÓõÄbean id »òbean Ãû³Æ¡£ +我们使用@Qualifier å’Œ@Autowired æ�¥æ��供我们想è¦�在ä¸�明确情况下使用的bean id 或bean å��称。 -ÀýÈ磬ÒÔÏÂÁ½¸ö bean ʵÏÖÏàͬµÄ½Ó¿Ú£º +例如,以下两个 bean 实现相å�Œçš„æŽ¥å�£ï¼š ```` class Bike implements Vehicle {} @@ -98,9 +98,9 @@ class Car implements Vehicle {} ```` -Èç¹û Spring ÐèҪעÈëÒ»¸ö Vehicle bean£¬Ëü»áÒÔ¶à¸öÆ¥Å䶨Òå½áÊø¡£ ÔÚÕâÖÖÇé¿öÏ£¬ÎÒÃÇ¿ÉÒÔʹÓà @Qualifier ×¢ÊÍÏÔʽÌṩ bean µÄÃû³Æ¡£ +如果 Spring 需è¦�注入一个 Vehicle bean,它会以多个匹é…�定义结æ�Ÿã€‚ 在这ç§�情况下,我们å�¯ä»¥ä½¿ç”¨ @Qualifier 注释显å¼�æ��ä¾› bean çš„å��称。 -**¹¹ÔìÆ÷×¢Èë** +**构造器注入** ```` @Autowired Biker(@Qualifier("bike") Vehicle vehicle) { @@ -108,7 +108,7 @@ this.vehicle = vehicle; } ```` -**Setter×¢Èë** +**Setter注入** ```` @Autowired @@ -116,7 +116,7 @@ void setVehicle(@Qualifier("bike") Vehicle vehicle) { this.vehicle = vehicle; } ```` -»òÕß: +或者: ```` @Autowired @@ -124,18 +124,18 @@ this.vehicle = vehicle; void setVehicle(Vehicle vehicle) { this.vehicle = vehicle; ```` -**±äÁ¿×¢Èë** +**å�˜é‡�注入** ```` @Autowired @Qualifier("bike") Vehicle vehicle; ```` -Õâ¸ö×¢½âÎÒÃÇ¿ÉÄÜÆ½³£ÓõIJ»¶à£¬µ«Êǵ±Ò»¸ö½Ó¿ÚÓжà¸öʵÏÖÀàʱ£¬Ëü¾Í»á¾­³£ÅÉÉÏÓ󡣡 +这个注解我们å�¯èƒ½å¹³å¸¸ç”¨çš„ä¸�多,但是当一个接å�£æœ‰å¤šä¸ªå®žçŽ°ç±»æ—¶ï¼Œå®ƒå°±ä¼šç»�常派上用场ï¼� ### 2.4 @Required -@Required ÔÚ setter ·½·¨Éϱê¼ÇÎÒÃÇÏëҪͨ¹ý XML Ìî³äµÄÒÀÀµÏ +@Required 在 setter 方法上标记我们想è¦�通过 XML å¡«å……çš„ä¾�赖项: ```` @Required void setColor(String color) { @@ -148,22 +148,22 @@ xml
```` -·ñÔò£¬½«Å׳ö BeanInitializationException¡£ -·Ç³£ÉÙ¼ûµÄÓ÷¨£¬ÖªµÀһϾÍÐÐÁË +å�¦åˆ™ï¼Œå°†æŠ›å‡º BeanInitializationException。 +é�žå¸¸å°‘è§�的用法,知é�“一下就行了 ### 2.5 @Value -ÎÒÃÇ¿ÉÒÔʹÓà @Value ½«ÊôÐÔÖµ×¢Èë bean¡£ ËüÓë¹¹Ô캯Êý¡¢setter ºÍ×Ö¶Î×¢Èë¼æÈÝ¡£ +我们å�¯ä»¥ä½¿ç”¨ @Value 将属性值注入 bean。 它与构造函数ã€�setter 和字段注入兼容。 -ÕâÒ²ÊǷdz£³£ÓõÄÒ»¸ö×¢½â£¬ÒòΪÎÒÃǺܶàʱºò¶¼ÐèÒª´Óapplication.properties»òÕ߯äËûÅäÖÃÎļþÖÐÀ´¶ÁÈ¡ÅäÖÃÊôÐÔÖµ¡£ +这也是é�žå¸¸å¸¸ç”¨çš„一个注解,因为我们很多时候都需è¦�从application.properties或者其他é…�置文件中æ�¥è¯»å�–é…�置属性值。 -**¹¹ÔìÆ÷×¢Èë** +**构造器注入** ```` Engine(@Value("8") int cylinderCount) { this.cylinderCount = cylinderCount; } ```` -**setter×¢Èë** +**setter注入** ```` @Autowired @@ -172,7 +172,7 @@ this.cylinderCount = cylinderCount; } ```` -»òÕß: +或者: ```` @Value("8") @@ -181,33 +181,33 @@ this.cylinderCount = cylinderCount; } ```` -**±äÁ¿×¢Èë** +**å�˜é‡�注入** ```` @Value("8") int cylinderCount; ```` -µ±È»£¬×¢È뾲ֵ̬ÊÇûÓÐÓõġ£ Òò´Ë£¬ÎÒÃÇ¿ÉÒÔÔÚ @Value ÖÐʹÓÃռλ·û×Ö·û´®À´Á¬½ÓÔÚÍⲿԴÖж¨ÒåµÄÖµ£¬ÀýÈçÔÚ .properties »ò .yaml ÎļþÖС£ +当然,注入é�™æ€�值是没有用的。 因此,我们å�¯ä»¥åœ¨ @Value 中使用å� ä½�符字符串æ�¥è¿žæŽ¥åœ¨å¤–部æº�中定义的值,例如在 .properties 或 .yaml 文件中。 ```` engine.fuelType=petrol ```` -ÎÒÃÇ¿ÉÒÔͨ¹ýÒÔÏ·½Ê½×¢Èë engine.fuelType µÄÖµ£º +我们å�¯ä»¥é€šè¿‡ä»¥ä¸‹æ–¹å¼�注入 engine.fuelType 的值: ```` @Value("${engine.fuelType}") String fuelType; ```` -ÎÒÃÇÉõÖÁ¿ÉÒÔʹÓà SpEL À´Ê¹ÓÃ@Value¡£ ¸ü¶à¸ß¼¶Ê¾Àý¿ÉÒÔÔÚÎÒÃǹØÓÚ@Value µÄÎÄÕÂÖÐÕÒµ½¡£ +我们甚至å�¯ä»¥ä½¿ç”¨ SpEL æ�¥ä½¿ç”¨@Value。 更多高级示例å�¯ä»¥åœ¨æˆ‘们关于@Value 的文章中找到。 ### 2.6 @DependsOn -ÎÒÃÇ¿ÉÒÔʹÓôË×¢½âÈà Spring ÔÚ×¢½âµÄ bean ֮ǰ³õʼ»¯ÆäËû bean¡£ ͨ³££¬´ËÐÐΪÊÇ×Ô¶¯µÄ£¬»ùÓÚ bean Ö®¼äµÄÏÔʽÒÀÀµ¹ØÏµ¡£ +我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨è§£è®© Spring 在注解的 bean 之å‰�åˆ�始化其他 bean。 通常,此行为是自动的,基于 bean 之间的显å¼�ä¾�赖关系。 -ÎÒÃÇÖ»ÓÐÔÚÒÀÀµÊÇÒþʽµÄʱºò²ÅÐèÒªÕâ¸ö×¢½â£¬±ÈÈçJDBCÇý¶¯¼ÓÔØ»òÕß¾²Ì¬±äÁ¿³õʼ»¯¡£ +我们å�ªæœ‰åœ¨ä¾�赖是éš�å¼�的时候æ‰�需è¦�这个注解,比如JDBC驱动加载或者é�™æ€�å�˜é‡�åˆ�始化。 -ÎÒÃÇ¿ÉÒÔÔÚÖ¸¶¨ÒÀÀµ bean Ãû³ÆµÄÒÀÀµÀàÉÏʹÓà @DependsOn¡£ ×¢Ê͵ÄÖµ²ÎÊýÐèÒªÒ»¸ö°üº¬ÒÀÀµ bean Ãû³ÆµÄÊý×飺 +我们å�¯ä»¥åœ¨æŒ‡å®šä¾�èµ– bean å��ç§°çš„ä¾�赖类上使用 @DependsOn。 注释的值å�‚数需è¦�一个包å�«ä¾�èµ– bean å��称的数组: ```` @DependsOn("engine") @@ -222,18 +222,18 @@ return new Engine(); } ```` ### 2.7 @Lazy -µ±ÎÒÃÇÏëÀÁ¶èµØ³õʼ»¯ÎÒÃÇµÄ bean ʱ£¬ÎÒÃÇʹÓà @Lazy¡£ ĬÈÏÇé¿öÏ£¬Spring ÔÚÓ¦ÓóÌÐòÉÏÏÂÎĵįô¶¯/Òýµ¼Ê±¼±Çеش´½¨ËùÓе¥Àý bean¡£ +当我们想懒惰地åˆ�始化我们的 bean 时,我们使用 @Lazy。 默认情况下,Spring 在应用程åº�上下文的å�¯åЍ/引导时急切地创建所有å�•例 bean。 -µ«ÊÇ£¬ÓÐЩÇé¿öÏÂÎÒÃÇÐèÒªÔÚÇëÇóʱ´´½¨ bean£¬¶ø²»ÊÇÔÚÓ¦ÓóÌÐòÆô¶¯Ê±´´½¨¡£ +但是,有些情况下我们需è¦�在请求时创建 bean,而ä¸�是在应用程åº�å�¯åŠ¨æ—¶åˆ›å»ºã€‚ -Õâ¸ö×¢½âµÄÐÐΪ»á¸ù¾ÝÎÒÃÇ·ÅÖÃËüµÄÈ·ÇÐλÖöøÓÐËù²»Í¬¡£ ÎÒÃÇ¿ÉÒÔ°ÑËü·ÅÔÚ£º +这个注解的行为会根æ�®æˆ‘们放置它的确切ä½�置而有所ä¸�å�Œã€‚ 我们å�¯ä»¥æŠŠå®ƒæ”¾åœ¨ï¼š -Ò»¸ö @Bean ×¢Ê굀 bean ¹¤³§·½·¨£¬ÒÔÑÓ³Ù·½·¨µ÷Óã¨Òò´Ë´´½¨ bean£© -@Configuration ÀàºÍËùÓаüº¬µÄ@Bean ·½·¨¶¼»áÊܵ½Ó°Ïì +一个 @Bean 注释的 bean 工厂方法,以延迟方法调用(因此创建 bean) +@Configuration 类和所有包å�«çš„@Bean 方法都会å�—到影å“� -Ò»¸ö @Component À࣬Ëü²»ÊÇ @Configuration À࣬Õâ¸ö bean ½«±»ÑÓ³Ù³õʼ»¯ +一个 @Component 类,它ä¸�是 @Configuration 类,这个 bean 将被延迟åˆ�始化 -@Autowired ¹¹Ô캯Êý¡¢setter »ò×ֶΣ¬ÓÃÓÚÑÓ³Ù¼ÓÔØÒÀÀµÏî±¾Éí£¨Í¨¹ý´úÀí£© +@Autowired 构造函数ã€�setter 或字段,用于延迟加载ä¾�赖项本身(通过代ç�†ï¼‰ ```` @Configuration @@ -247,31 +247,31 @@ class VehicleFactoryConfig { } } ```` -ÕâͬÑù²»ÊÇÒ»¸ö³£ÓõÄ×¢½â¡£ +è¿™å�Œæ ·ä¸�是一个常用的注解。 -µ±ÎÒÃÇά»¤Ò»¸öÓдóÁ¿beanµÄÏîĿʱ£¬»á·¢ÏÖÓкܶàbean¿ÉÄܶ¼Êǰ´ÐèʹÓõ쬲»Ò»¶¨ÐèÒªÔÚÈÝÆ÷³õʼ»¯Ê±¾Í½øÐгõʼ»¯£¬Õâ¿ÉÒÔ°ïÎÒÃǽÚÊ¡ºÜ¶àʱ¼äºÍÐÔÄÜ¡£ +当我们维护一个有大é‡�bean的项目时,会å�‘现有很多beanå�¯èƒ½éƒ½æ˜¯æŒ‰éœ€ä½¿ç”¨çš„,ä¸�一定需è¦�在容器åˆ�始化时就进行åˆ�始化,这å�¯ä»¥å¸®æˆ‘们节çœ�很多时间和性能。 ### 2.8 @Lookup -ͬÑùÊÇÒ»¸ö±È½ÏÉÙÓõ½µÄ×¢½â +å�Œæ ·æ˜¯ä¸€ä¸ªæ¯”较少用到的注解 -@Lookup »á¸æËß Spring ÔÚÎÒÃǵ÷ÓÃËüʱ·µ»Ø·½·¨·µ»ØÀàÐ͵ÄʵÀý¡£ +@Lookup 会告诉 Spring 在我们调用它时返回方法返回类型的实例。 -±¾ÖÊÉÏ£¬Spring ½«¸²¸ÇÎÒÃÇ´ø×¢Ê͵ķ½·¨²¢Ê¹ÓÃÎÒÃÇ·½·¨µÄ·µ»ØÀàÐͺͲÎÊý×÷Ϊ BeanFactory#getBean µÄ²ÎÊý¡£ +本质上,Spring 将覆盖我们带注释的方法并使用我们方法的返回类型和å�‚数作为 BeanFactory#getBean çš„å�‚数。 -@Lookup ÊÊÓÃÓÚ£º +@Lookup 适用于: -½«Ô­ÐÍ bean ×¢ÈëÎÒÃÇ×Ô¼ºµÄbean£¨ÀàËÆÓÚ Provider£© +将原型 bean 注入我们自己的bean(类似于 Provider) -Èç¹ûÎÒÃÇÅöÇɾö¶¨ÓµÓÐÒ»¸öÔ­ÐÍ Spring bean£¬ÄÇôÎÒÃǼ¸ºõ»áÁ¢¼´ÃæÁÙÕâÑùµÄÎÊÌ⣺ +如果我们碰巧决定拥有一个原型 Spring bean,那么我们几乎会立å�³é�¢ä¸´è¿™æ ·çš„问题: -ÎÒÃǵĵ¥Àý Spring bean ½«ÈçºÎ·ÃÎÊÕâЩԭÐÍ Spring bean£¿ +我们的å�•例 Spring bean 将如何访问这些原型 Spring bean? -ÏÖÔÚ£¬Provider ¿Ï¶¨ÊÇÒ»ÖÖ·½Ê½£¬¾¡¹Ü @Lookup ÔÚijЩ·½Ãæ¸ü¼ÓͨÓᣠ+现在,Provider 肯定是一ç§�æ–¹å¼�,尽管 @Lookup 在æŸ�些方é�¢æ›´åŠ é€šç”¨ã€‚ -ҪעÒâµÄÊÇ£¬springĬÈÏʹÓõĵ¥Àýbean£¬ËùÒÔÈç¹ûÎÒÃÇҪעÈëÔ­ÐÍbean£¬ÎÒÃDzÅÐèÒª×öÕâÑùµÄ¶îÍ⹤×÷ +è¦�注æ„�的是,spring默认使用的å�•例bean,所以如果我们è¦�注入原型bean,我们æ‰�需è¦�å�šè¿™æ ·çš„é¢�外工作 -Ê×ÏÈ£¬ÈÃÎÒÃÇ´´½¨Ò»¸öÔ­ÐÍ bean£¬ÉÔºóÎÒÃǽ«Æä×¢Èëµ½µ¥Àý bean ÖУº +首先,让我们创建一个原型 bean,ç¨�å�Žæˆ‘们将其注入到å�•例 bean 中: ```` @Component @Scope("prototype") @@ -279,7 +279,7 @@ public class SchoolNotification { // ... prototype-scoped state } ```` -ʹÓÃ@Lookup£¬ÎÒÃÇ¿ÉÒÔͨ¹ýµ¥Àý bean »ñÈ¡ SchoolNotification µÄʵÀý£º +使用@Lookup,我们å�¯ä»¥é€šè¿‡å�•例 bean 获å�– SchoolNotification 的实例: ```` @Component @@ -307,19 +307,19 @@ StudentServices second = this.context.getBean(StudentServices.class); assertNotEquals(first.getNotification(), second.getNotification()); } ```` -Çë×¢Ò⣬ÔÚ StudentServices ÖУ¬ÎÒÃǽ« getNotification ·½·¨±£ÁôΪ´æ¸ù¡£ +请注æ„�,在 StudentServices 中,我们将 getNotification 方法ä¿�留为存根。 -ÕâÊÇÒòΪ Spring ͨ¹ýµ÷Óà beanFactory.getBean(StudentNotification.class) ¸²¸ÇÁ˸÷½·¨£¬Òò´ËÎÒÃÇ¿ÉÒÔ½«ÆäÁô¿Õ¡£ +这是因为 Spring 通过调用 beanFactory.getBean(StudentNotification.class) 覆盖了该方法,因此我们å�¯ä»¥å°†å…¶ç•™ç©ºã€‚ ### 2.9 @Primary -ÓÐʱÎÒÃÇÐèÒª¶¨Òå¶à¸öÏàͬÀàÐ͵Äbean¡£ ÔÚÕâЩÇé¿öÏ£¬×¢È뽫²»³É¹¦£¬ÒòΪ Spring ²»ÖªµÀÎÒÃÇÐèÒªÄĸö bean¡£ +有时我们需è¦�定义多个相å�Œç±»åž‹çš„bean。 在这些情况下,注入将ä¸�æˆ�功,因为 Spring ä¸�知é�“我们需è¦�哪个 bean。 -ÎÒÃÇÒѾ­¿´µ½ÁË´¦ÀíÕâÖÖÇé¿öµÄÑ¡ÏÓÃ@Qualifier ±ê¼ÇËùÓнÓÏߵ㲢ָ¶¨ËùÐè bean µÄÃû³Æ¡£ +我们已ç»�看到了处ç�†è¿™ç§�情况的选项:用@Qualifier 标记所有接线点并指定所需 bean çš„å��称。 -È»¶ø£¬´ó¶àÊýʱºòÎÒÃÇÐèÒªÒ»¸öÌØ¶¨µÄ bean£¬ºÜÉÙÐèÒªÆäËû bean¡£ +然而,大多数时候我们需è¦�一个特定的 bean,很少需è¦�å…¶ä»– bean。 -ÎÒÃÇ¿ÉÒÔʹÓÃ@Primary À´¼ò»¯ÕâÖÖÇé¿ö£ºÈç¹ûÎÒÃÇÓÃ@Primary ±ê¼Ç×î³£ÓõÄbean£¬Ëü½«ÔÚunqualifiedµÄ×¢ÈëµãÉϱ»Ñ¡Ôñ£º +我们å�¯ä»¥ä½¿ç”¨@Primary æ�¥ç®€åŒ–è¿™ç§�情况:如果我们用@Primary 标记最常用的bean,它将在unqualified的注入点上被选择: ```` @Component @@ -342,15 +342,15 @@ class Biker { Vehicle vehicle; } ```` -ÔÚÇ°ÃæµÄʾÀýÖУ¬Æû³µÊÇÖ÷Òª³µÁ¾¡£ Òò´Ë£¬ÔÚ Driver ÀàÖУ¬Spring ×¢ÈëÁËÒ»¸ö Car bean¡£ µ±È»£¬ÔÚ Biker bean ÖУ¬×Ö¶Î vehicle µÄÖµ½«ÊÇÒ»¸ö Bike ¶ÔÏó£¬ÒòΪËüÊÇqualifiedµÄ¡£ +在å‰�é�¢çš„示例中,汽车是主è¦�车辆。 因此,在 Driver 类中,Spring 注入了一个 Car bean。 当然,在 Biker bean 中,字段 vehicle 的值将是一个 Bike 对象,因为它是qualified的。 ### 2.10 @Scope -¶ÔÓÚͨ³£µÄÓ¦ÓÃÀ´Ëµ£¬ÎÒÃÇbeanµÄscopeĬÈ϶¼Êǵ¥ÀýµÄ£¬µ«Êµ¼ÊÉÏspring bean¿ÉÒÔÖ§³Ö¶àÖÖ¶àÑùµÄ×÷Ó÷¶Î§£¬ËüÃÇÓÐ×Ų»Í¬µÄÉúÃüÖÜÆÚ¡£ +对于通常的应用æ�¥è¯´ï¼Œæˆ‘们beançš„scope默认都是å�•例的,但实际上spring beanå�¯ä»¥æ”¯æŒ�多ç§�多样的作用范围,它们有ç�€ä¸�å�Œçš„生命周期。 -ÎÒÃÇʹÓÃ@Scope À´¶¨Òå@Component Àà»ò@Bean ¶¨ÒåµÄ·¶Î§¡£ Ëü¿ÉÒÔÊǵ¥Àý¡¢Ô­ÐÍ¡¢ÇëÇ󡢻Ự¡¢globalSession »òһЩ×Ô¶¨Ò巶Χ¡£ +我们使用@Scope æ�¥å®šä¹‰@Component 类或@Bean 定义的范围。 它å�¯ä»¥æ˜¯å�•例ã€�原型ã€�请求ã€�会è¯�ã€�globalSession 或一些自定义范围。 -¶ÔÓ¦µÄö¾ÙֵΪ +对应的枚举值为 ```` singleton prototype @@ -360,28 +360,28 @@ application websocket ```` -Àý×Ó +例å­� ```` @Component @Scope("prototype") class Engine {} ```` -ÎÒÃÇ¿ÉÒÔÏëÏóһЩ³¡¾°£¬±ÈÈçrequest¡¢session¡¢websocketÕâÀà×÷ÓÃÓòµÄbean£¬Í¨³£Ó¦¸ÃÊǺÍÍøÂçÇëÇóÏà¹ØµÄ£¬±ÈÈçÓô洢Óû§ÐÅÏ¢¡¢sessionÖ®ÀàµÄbean¡£ +我们å�¯ä»¥æƒ³è±¡ä¸€äº›åœºæ™¯ï¼Œæ¯”如requestã€�sessionã€�websocket这类作用域的bean,通常应该是和网络请求相关的,比如用存储用户信æ�¯ã€�session之类的bean。 -¾ßÌåÔõôʹÓ㬾ÍÒª¸ù¾ÝÄãµÄ¾ßÌ峡¾°À´Ñ¡ÔñÁË£¬Õâ»áÊÇÒ»¸öºÜ´óµÄ»°Ì⣬ÕâÀï¾ÍÏȲ»Õ¹¿ªÁË£¬ÒÔºó¿ÉÒÔÔÚµ¥¶ÀµÄÎÄÕÂÀï¼ÌÐø½éÉÜ¡£ +具体怎么使用,就è¦�æ ¹æ�®ä½ çš„具体场景æ�¥é€‰æ‹©äº†ï¼Œè¿™ä¼šæ˜¯ä¸€ä¸ªå¾ˆå¤§çš„è¯�题,这里就先ä¸�展开了,以å�Žå�¯ä»¥åœ¨å�•独的文章里继续介ç»�。 -## 3 ÉÏÏÂÎÄÅäÖÃ×¢½â -ÎÒÃÇ¿ÉÒÔʹÓñ¾½ÚÖÐÃèÊöµÄ×¢ÊÍÀ´ÅäÖÃÓ¦ÓóÌÐòÉÏÏÂÎÄ¡£ +## 3 上下文é…�置注解 +我们å�¯ä»¥ä½¿ç”¨æœ¬èЂ䏭æ��述的注释æ�¥é…�置应用程åº�上下文。 ### 3.1 @Profile -Èç¹ûÎÒÃÇÏ£Íû Spring ½öÔÚÌØ¶¨ÅäÖÃÎļþ´¦Óڻ״̬ʱʹÓÃ@Component Àà»ò@Bean ·½·¨£¬ÎÒÃÇ¿ÉÒÔʹÓÃ@Profile ¶ÔÆä½øÐбê¼Ç¡£ +如果我们希望 Spring 仅在特定é…�置文件处于活动状æ€�时使用@Component 类或@Bean 方法,我们å�¯ä»¥ä½¿ç”¨@Profile 对其进行标记。 -ÎÒÃÇ¿ÉÒÔʹÓÃ×¢Ê͵ÄÖµ²ÎÊýÅäÖÃÅäÖÃÎļþµÄÃû³Æ£º +我们å�¯ä»¥ä½¿ç”¨æ³¨é‡Šçš„值å�‚æ•°é…�ç½®é…�置文件的å��称: -ÎÒÃÇͨ³£Õâ¸ö×¢½âÀ´ÅäÖò»Í¬»·¾³µÄÅäÖᣠ-±ÈÈçÏÂÃæÕâ¸öÀý×Ó +我们通常这个注解æ�¥é…�ç½®ä¸�å�ŒçŽ¯å¢ƒçš„é…�置。 +比如下é�¢è¿™ä¸ªä¾‹å­� ```` public interface DatasourceConfig { @@ -389,7 +389,7 @@ public void setup(); } ```` -ÏÂÃæÊÇ¿ª·¢»·¾³µÄÅäÖ㺠+下é�¢æ˜¯å¼€å�‘环境的é…�置: ```` @Component @@ -401,7 +401,7 @@ System.out.println("Setting up datasource for DEV environment. "); } } ```` -ÏÂÃæÊÇÉú²ú»·¾³µÄÅäÖ㺠+下é�¢æ˜¯ç”Ÿäº§çŽ¯å¢ƒçš„é…�置: ```` @Component @@ -413,7 +413,7 @@ System.out.println("Setting up datasource for PRODUCTION environment. "); } } ```` -µ±È»ÎÒÃÇÒ²¿ÉÒÔʹÓÃxml»òÕ߯äËûÀàÐ͵ÄÅäÖÃÎļþÀ´ÃèÊöÕâ¸öÅäÖÃbean +当然我们也å�¯ä»¥ä½¿ç”¨xml或者其他类型的é…�置文件æ�¥æ��述这个é…�ç½®bean xml ```` @@ -424,11 +424,11 @@ xml ```` ### 3.2 @Import -ÎÒÃÇ¿ÉÒÔʹÓÃÌØ¶¨µÄ @Configuration À࣬¶øÎÞÐèʹÓôË×¢½â½øÐÐ×é¼þɨÃè¡£ ÎÒÃÇ¿ÉÒÔΪÕâЩÀàÌṩ@Import µÄÖµ²ÎÊý +我们å�¯ä»¥ä½¿ç”¨ç‰¹å®šçš„ @Configuration 类,而无需使用此注解进行组件扫æ��。 我们å�¯ä»¥ä¸ºè¿™äº›ç±»æ��ä¾›@Import 的值å�‚æ•° -Õý³£À´Ëµ£¬Èç¹ûÒªÓõ½@Configuration×¢½âµÄbean£¬ÄÇôspringÓ¦ÓñØÐëҪɨÃèµ½¸ÃĿ¼£¬Èç¹ûÇ¡ºÃûÓжԸ÷¾¶½øÐÐɨÃ裬»òÕßÎÒÃÇÖ»ÊÇÏëʹÓ÷¾¶Ïµĵ¥¸öÅäÖÃÀ࣬ÄÇôÎÒÃǾͿÉÒÔʹÓÃ@ImportÀ´µ¼ÈëÕâ¸öÅäÖÃÀàÁË¡£ +正常æ�¥è¯´ï¼Œå¦‚æžœè¦�用到@Configuration注解的bean,那么spring应用必须è¦�扫æ��到该目录,如果æ�°å¥½æ²¡æœ‰å¯¹è¯¥è·¯å¾„进行扫æ��,或者我们å�ªæ˜¯æƒ³ä½¿ç”¨è·¯å¾„下的å�•个é…�置类,那么我们就å�¯ä»¥ä½¿ç”¨@Importæ�¥å¯¼å…¥è¿™ä¸ªé…�置类了。 -Õâ¸ö×¢½â»¹ÊǷdz£³£Óõģ¬¿´Ò»ÏÂÏÂÃæÕâ¸öÀý×Ó +这个注解还是é�žå¸¸å¸¸ç”¨çš„,看一下下é�¢è¿™ä¸ªä¾‹å­� ```` @Import(VehiclePartSupplier.class) @@ -441,32 +441,32 @@ class VehiclePartSupplier{ ### 3.3 @ImportResource -±ÈÈç˵£ºÏÖÔÚÓÐÒ»¸ö bean.xml µÄÅäÖÃÎļþ£¬ÐèÒª½«¸Ã beans.xml Öж¨ÒåµÄ bean¶ÔÏó ¶¼µ¼Èëµ½ Spring Boot »·¾³µÄÈÝÆ÷ÖУ¬¸ÃÈçºÎ²Ù×÷ÄØ£¿ +比如说:现在有一个 bean.xml çš„é…�置文件,需è¦�将该 beans.xml 中定义的 bean对象 都导入到 Spring Boot 环境的容器中,该如何æ“�作呢? -1.Spring ·½Ê½µÄÅäÖÃÎļþ bean.xml ´Ë´¦Ëæ±ã¾Ù¸öʾÀý£¬±ÈÈç˵ xml ÖÐÅäÖÃÁËÒ»¸ö helloService£¬ÈçÏÂËùʾ +1.Spring æ–¹å¼�çš„é…�置文件 bean.xml 此处éš�便举个示例,比如说 xml 中é…�置了一个 helloService,如下所示 ```` - + ```` -2.ʹÓÃ@ImportResource×¢½â£¬ÒýÈë xml ÅäÖà +2.使用@ImportResource注解,引入 xml é…�ç½® ```` /** - * Spring BootÀïÃæÃ»ÓÐSpringµÄÅäÖÃÎļþ£¬ÎÒÃÇ×Ô¼º±àдµÄÅäÖÃÎļþ£¬Ò²²»ÄÜ×Ô¶¯Ê¶±ð£» - * Èç¹ûÏëÈÃSpringµÄÅäÖÃÎļþÉúЧ£¬¼ÓÔØµ½Spring ÈÝÆ÷ÖÐÀ´£» - * ʹÓÃ@ImportResource×¢½â£¬½«Æä±ê×¢ÔÚÒ»¸öÅäÖÃÀàÉÏ(´Ë´¦ÅäÖÃÔÚÆô¶¯Àà) + * Spring Boot里é�¢æ²¡æœ‰Springçš„é…�置文件,我们自己编写的é…�置文件,也ä¸�能自动识别; + * 如果想让Springçš„é…�置文件生效,加载到Spring 容器中æ�¥ï¼› + * 使用@ImportResource注解,将其标注在一个é…�置类上(此处é…�置在å�¯åŠ¨ç±») */ @SpringBootApplication @ImportResource(locations = {"classpath:beans.xml"}) public class BootApplication { public static void main(String[] args) { - // SpringÓ¦ÓÃÆô¶¯ÆðÀ´ + // Spring应用å�¯åŠ¨èµ·æ�¥ SpringApplication.run(BootApplication.class,args); } @@ -474,19 +474,19 @@ public class BootApplication { ```` ### 3.4 @PropertySource -ͨ¹ýÕâ¸ö×¢½â£¬ÎÒÃÇ¿ÉÒÔΪӦÓóÌÐòÉèÖö¨ÒåÊôÐÔÎļþ£º +通过这个注解,我们å�¯ä»¥ä¸ºåº”用程åº�设置定义属性文件: -@PropertySource ×¢½âÌṩÁËÒ»ÖÖ·½±ãµÄÉùÃ÷ÐÔ»úÖÆ£¬ÓÃÓÚ½« PropertySource Ìí¼Óµ½ Spring µÄ Environment ÖУ¬Óë @Configuration ÀàÒ»ÆðʹÓᣠ+@PropertySource 注解æ��供了一ç§�方便的声明性机制,用于将 PropertySource 添加到 Spring çš„ Environment 中,与 @Configuration 类一起使用。 -Äã¿ÉÒÔʹÓà @Value È¥ÒýÓö¨ÒåµÄÊôÐÔ£¬ÀýÈ磺@Value("testbean.name")£»Ò²¿ÉÒÔÖ¸¶¨Ä¬ÈÏÖµ£¬È磺@Value("testbean.name:defaultValue")¡£ +ä½ å�¯ä»¥ä½¿ç”¨ @Value 去引用定义的属性,例如:@Value("testbean.name");也å�¯ä»¥æŒ‡å®šé»˜è®¤å€¼ï¼Œå¦‚:@Value("testbean.name:defaultValue")。 -Ó÷¨Ê¾Àý +用法示例 -¸ø¶¨Ò»¸öÅäÖÃÎļþapp.properties +给定一个é…�置文件app.properties ```` testbean.name=myTestBean ```` -ÒÔÏ @Configuration ÀàʹÓà @PropertySource ½« app.properties ÉèÖøø Environment µÄ PropertySources ¼¯ºÏ¡£ +以下 @Configuration 类使用 @PropertySource å°† app.properties 设置给 Environment çš„ PropertySources 集å�ˆã€‚ ```` @Configuration @PropertySource("classpath:/com/myco/app.properties") @@ -504,10 +504,10 @@ public class AppConfig { } ```` -×¢Ò⣺ʹÓà @Autowired ½« Environment ¶ÔÏó×¢Èëµ½ÅäÖÃÀàÖУ¬È»ºóÔÚ testBean() ·½·¨ÖÐʹÓᣠ-ÒÔÉÏÅäÖÃÖУ¬µ÷Óà testBean.getName() ·½·¨½«·µ»Ø¡°myTestBean¡±×Ö·û´®¡£ +注æ„�:使用 @Autowired å°† Environment 对象注入到é…�置类中,然å�Žåœ¨ testBean() 方法中使用。 +以上é…�置中,调用 testBean.getName() 方法将返回“myTestBeanâ€�字符串。 -@PropertySource ÀûÓÃÁË Java 8 µÄÖØ¸´×¢½âÌØÐÔ£¬ÕâÒâζ×ÅÎÒÃÇ¿ÉÒÔÓÃËü¶à´Î±ê¼ÇÒ»¸öÀࣺ +@PropertySource 利用了 Java 8 çš„é‡�å¤�注解特性,这æ„�味ç�€æˆ‘们å�¯ä»¥ç”¨å®ƒå¤šæ¬¡æ ‡è®°ä¸€ä¸ªç±»ï¼š ```` @Configuration @@ -517,7 +517,7 @@ class VehicleFactoryConfig {} ```` ### 3.5 @PropertySources -Ó÷¨Í¬ÉÏ£¬Ö»²»¹ý£¬ÕâÒ»´ÎÎÒÃÇ¿ÉÒÔʹÓÃÕâ¸ö×¢½âÖ¸¶¨¶à¸ö@PropertySource ÅäÖ㺠+用法å�Œä¸Šï¼Œå�ªä¸�过,这一次我们å�¯ä»¥ä½¿ç”¨è¿™ä¸ªæ³¨è§£æŒ‡å®šå¤šä¸ª@PropertySource é…�置: ```` @Configuration @PropertySources({ @@ -526,40 +526,40 @@ class VehicleFactoryConfig {} }) class VehicleFactoryConfig {} ```` -Çë×¢Ò⣬×Ô Java 8 ÒÔÀ´£¬ÎÒÃÇ¿ÉÒÔͨ¹ýÉÏÊöÖØ¸´×¢Ê͹¦ÄÜʵÏÖÏàͬµÄ¹¦ÄÜ¡£ +请注æ„�,自 Java 8 以æ�¥ï¼Œæˆ‘们å�¯ä»¥é€šè¿‡ä¸Šè¿°é‡�å¤�注释功能实现相å�Œçš„功能。 -## 4.½áÂÛ +## 4.结论 -ÔÚ±¾ÎÄÖУ¬ÎÒÃÇ¿´µ½ÁË×î³£¼ûµÄ Spring ºËÐÄ×¢Ê͵ĸÅÊö¡£ ÎÒÃÇ¿´µ½ÁËÈçºÎÅäÖà bean Á¬½ÓºÍÓ¦ÓÃÉÏÏÂÎÄ£¬ÒÔ¼°ÈçºÎΪ×é¼þɨÃè±ê¼ÇÀà¡£ +在本文中,我们看到了最常è§�çš„ Spring 核心注释的概述。 我们看到了如何é…�ç½® bean 连接和应用上下文,以å�Šå¦‚何为组件扫æ��标记类。 -springÌåϵÖеij£¼û×¢½â»¹Óкܶ࣬һƪÎÄÕ²»¿ÉÄÜÈ«²¿¸²¸Ç£¬ÈçÓÐÒÅ©£¬»¶Ó­²¹³ä¡£ +spring体系中的常è§�注解还有很多,一篇文章ä¸�å�¯èƒ½å…¨éƒ¨è¦†ç›–,如有é�—æ¼�,欢迎补充。 -# Spring Bean×¢½â +# Spring Bean注解 -## 1 ¸ÅÊö -ÔÚ±¾½Ì³ÌÖУ¬ÎÒÃǽ«ÌÖÂÛÓÃÓÚ¶¨Ò岻ͬÀàÐÍ bean µÄ×î³£¼ûµÄ Spring bean ×¢ÊÍ¡£ +## 1 概述 +在本教程中,我们将讨论用于定义ä¸�å�Œç±»åž‹ bean 的最常è§�çš„ Spring bean 注释。 -Óм¸ÖÖ·½·¨¿ÉÒÔÔÚ Spring ÈÝÆ÷ÖÐÅäÖà bean¡£ Ê×ÏÈ£¬ÎÒÃÇ¿ÉÒÔʹÓà XML ÅäÖÃÉùÃ÷ËüÃÇ¡£ ÎÒÃÇ»¹¿ÉÒÔÔÚÅäÖÃÀàÖÐʹÓÃ@Bean ×¢½âÀ´ÉùÃ÷ bean¡£ +有几ç§�方法å�¯ä»¥åœ¨ Spring 容器中é…�ç½® bean。 首先,我们å�¯ä»¥ä½¿ç”¨ XML é…�置声明它们。 我们还å�¯ä»¥åœ¨é…�置类中使用@Bean 注解æ�¥å£°æ˜Ž bean。 -×îºó£¬ÎÒÃÇ¿ÉÒÔʹÓà org.springframework.stereotype °üÖеÄ×¢ÊÍÖ®Ò»À´±ê¼Ç¸ÃÀ࣬²¢½«ÆäÓಿ·ÖÁô¸ø×é¼þɨÃè¡£ +最å�Žï¼Œæˆ‘们å�¯ä»¥ä½¿ç”¨ org.springframework.stereotype 包中的注释之一æ�¥æ ‡è®°è¯¥ç±»ï¼Œå¹¶å°†å…¶ä½™éƒ¨åˆ†ç•™ç»™ç»„件扫æ��。 ## 2 @ComponentScan -ÕâÊÇÎÒÃǾ­³£»áʹÓõÄÒ»¸ö×¢½â£¬ÔÚÎÒÃǵÄÓ¦ÓÃÖУ¬ÓÐʱºò²»Ò»¶¨»áɨÃèËùÓеİü£¬ÌرðÊǵ±ÎÒÃÇҪɨÃèÍⲿjar°üÖеÄbeanʱ£¬Ëü·Ç³£ÓÐÓᣠ+这是我们ç»�常会使用的一个注解,在我们的应用中,有时候ä¸�一定会扫æ��所有的包,特别是当我们è¦�扫æ��外部jar包中的bean时,它é�žå¸¸æœ‰ç”¨ã€‚ -Ëü¿ÉÒÔ¼ÓÔÚSpringBootApplicationÉÏ£¬Ò²¿ÉÒÔ¼ÓÔÚ@configuration×¢½âÉϵÄÅäÖÃÀàÉÏ +它å�¯ä»¥åŠ åœ¨SpringBootApplication上,也å�¯ä»¥åŠ åœ¨@configuration注解上的é…�置类上 -Èç¹ûÆôÓÃÁË×é¼þɨÃ裬Spring ¿ÉÒÔ×Ô¶¯É¨Ãè°üÖÐµÄ bean¡£ +如果å�¯ç”¨äº†ç»„件扫æ��,Spring å�¯ä»¥è‡ªåŠ¨æ‰«æ��包中的 bean。 -@ComponentScan ÅäÖÃʹÓÃ×¢½âÅäÖÃɨÃèÄÄЩ°üµÄÀà¡£ +@ComponentScan é…�置使用注解é…�置扫æ��哪些包的类。 -ÎÒÃÇ¿ÉÒÔÖ±½ÓʹÓà basePackages »ò value ²ÎÊýÖ®Ò»Ö¸¶¨»ù±¾°üÃû³Æ£¨value ÊÇ basePackages µÄ±ðÃû£© +我们å�¯ä»¥ç›´æŽ¥ä½¿ç”¨ basePackages 或 value å�‚数之一指定基本包å��称(value 是 basePackages 的别å��) ```` @Configuration @ComponentScan(basePackages = "com.baeldung.annotations") class VehicleFactoryConfig {} ```` -´ËÍ⣬ÎÒÃÇ¿ÉÒÔʹÓà basePackageClasses ²ÎÊýÖ¸Ïò»ù´¡°üÖеÄÀࣺ +此外,我们å�¯ä»¥ä½¿ç”¨ basePackageClasses å�‚数指å�‘基础包中的类: ```` @Configuration @@ -567,11 +567,11 @@ class VehicleFactoryConfig {} class VehicleFactoryConfig {} ```` -ÕâÁ½¸ö²ÎÊý¶¼ÊÇÊý×飬Òò´ËÎÒÃÇ¿ÉÒÔΪÿ¸ö²ÎÊýÌṩ¶à¸ö°ü¡£ +这两个å�‚数都是数组,因此我们å�¯ä»¥ä¸ºæ¯�个å�‚æ•°æ��供多个包。 -Èç¹ûδָ¶¨²ÎÊý£¬ÔòɨÃè·¢ÉúÔÚ´æÔÚ @ComponentScan ×¢ÊÍÀàµÄͬһ°üÖС£ +如果未指定å�‚数,则扫æ��å�‘生在存在 @ComponentScan 注释类的å�Œä¸€åŒ…中。 -@ComponentScan ÀûÓÃÁË Java 8 µÄÖØ¸´×¢½âÌØÐÔ£¬ÕâÒâζ×ÅÎÒÃÇ¿ÉÒÔÓÃËü¶à´Î±ê¼ÇÒ»¸öÀࣺ +@ComponentScan 利用了 Java 8 çš„é‡�å¤�注解特性,这æ„�味ç�€æˆ‘们å�¯ä»¥ç”¨å®ƒå¤šæ¬¡æ ‡è®°ä¸€ä¸ªç±»ï¼š ```` @Configuration @@ -580,7 +580,7 @@ class VehicleFactoryConfig {} class VehicleFactoryConfig {} ```` -»òÕߣ¬ÎÒÃÇ¿ÉÒÔʹÓà @ComponentScans Ö¸¶¨¶à¸ö @ComponentScan ÅäÖ㺠+或者,我们å�¯ä»¥ä½¿ç”¨ @ComponentScans 指定多个 @ComponentScan é…�置: ```` @Configuration @@ -593,7 +593,7 @@ class VehicleFactoryConfig {} class VehicleFactoryConfig { } ```` -ʹÓà XML ÅäÖÃʱ£¬ÅäÖÃ×é¼þɨÃèͬÑù¼òµ¥£º +使用 XML é…�置时,é…�置组件扫æ��å�Œæ ·ç®€å�•: ```` @@ -601,7 +601,7 @@ class VehicleFactoryConfig { ### 3 @Component -@Component ÊÇÀ༶±ðµÄ×¢½â¡£ ÔÚ×é¼þɨÃèÆÚ¼ä£¬Spring Framework »á×Ô¶¯¼ì²âʹÓÃ@Component ×¢½âµÄÀࣺ +@Component 是类级别的注解。 在组件扫æ��期间,Spring Framework 会自动检测使用@Component 注解的类: ```` @Component class CarUtility { @@ -609,13 +609,13 @@ class CarUtility { } ```` -ĬÈÏÇé¿öÏ£¬´ËÀàµÄ bean ʵÀýÓëÀàÃûͬÃû£¬Ê××ÖĸСд¡£ ´ËÍ⣬ÎÒÃÇ¿ÉÒÔʹÓôË×¢Ê͵ĿÉѡֵ²ÎÊýÖ¸¶¨²»Í¬µÄÃû³Æ¡£ +默认情况下,此类的 bean 实例与类å��å�Œå��,首字æ¯�å°�写。 此外,我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨é‡Šçš„å�¯é€‰å€¼å�‚数指定ä¸�å�Œçš„å��称。 -ÓÉÓÚ@Repository¡¢@Service¡¢@Configuration ºÍ@Controller ¶¼ÊÇ´øÓÐ@Component µÄ×¢½â£¬ËüÃǹ²ÏíÏàͬµÄbean ÃüÃûÐÐΪ¡£ +由于@Repositoryã€�@Serviceã€�@Configuration å’Œ@Controller 都是带有@Component 的注解,它们共享相å�Œçš„bean 命å��行为。 -Spring »¹»áÔÚ×é¼þɨÃè¹ý³ÌÖÐ×Ô¶¯¼ì²âËüÃÇ¡£ +Spring 还会在组件扫æ��过程中自动检测它们。 -ͨ³£À´Ëµ£¬ÎÒÃÇ»áÔÚmvcÓ¦ÓÃÖÐÎÒÃÇ»áÓõ½ÉÏÊö¼¸ÖÖ×¢½â£¬¶øÎÒÃÇÔÚ·ÇwebÓ¦ÓÃÖиü¶àµØ¿ÉÒÔʹÓÃ@componentÀ´×¢½âbean +通常æ�¥è¯´ï¼Œæˆ‘们会在mvc应用中我们会用到上述几ç§�注解,而我们在é�žweb应用中更多地å�¯ä»¥ä½¿ç”¨@componentæ�¥æ³¨è§£bean ### 4 @Repository @@ -626,25 +626,25 @@ class VehicleRepository { // ... } ```` -ʹÓôË×¢Ê͵ÄÒ»¸öÓŵãÊÇËüÆôÓÃÁË×Ô¶¯³Ö¾ÃÐÔÒ쳣ת»»¡£ µ±Ê¹Óó־ÃÐÔ¿ò¼Ü£¨Èç Hibernate£©Ê±£¬ÔÚʹÓà @Repository ×¢Ê͵ÄÀàÖÐÅ׳öµÄ±¾»úÒì³£½«×Ô¶¯×ª»»Îª Spring µÄ DataAccessExeption µÄ×ÓÀà¡£ +使用此注释的一个优点是它å�¯ç”¨äº†è‡ªåЍæŒ�久性异常转æ�¢ã€‚ 当使用æŒ�久性框架(如 Hibernate)时,在使用 @Repository 注释的类中抛出的本机异常将自动转æ�¢ä¸º Spring çš„ DataAccessExeption çš„å­�类。 -ÒªÆôÓÃÒ쳣ת»»£¬ÎÒÃÇÐèÒªÉùÃ÷ÎÒÃÇ×Ô¼ºµÄ PersistenceExceptionTranslationPostProcessor bean£º +è¦�å�¯ç”¨å¼‚常转æ�¢ï¼Œæˆ‘们需è¦�声明我们自己的 PersistenceExceptionTranslationPostProcessor bean: ```` @Bean public PersistenceExceptionTranslationPostProcessor exceptionTranslation() { return new PersistenceExceptionTranslationPostProcessor(); } ```` -Çë×¢Ò⣬ÔÚ´ó¶àÊýÇé¿öÏ£¬Spring »á×Ô¶¯Ö´ÐÐÉÏÊö²½Öè¡£ +请注æ„�,在大多数情况下,Spring 会自动执行上述步骤。 -»òÕßͨ¹ý XML ÅäÖ㺠+或者通过 XML é…�置: ```` ```` ### 5 @Service -Ó¦ÓóÌÐòµÄÒµÎñÂß¼­Í¨³£×¤ÁôÔÚ·þÎñ²ãÖУ¬Òò´ËÎÒÃǽ«Ê¹ÓÃ@Service ×¢ÊÍÀ´Ö¸Ê¾Ò»¸öÀàÊôÓڸò㣺 +应用程åº�的业务逻辑通常驻留在æœ�务层中,因此我们将使用@Service 注释æ�¥æŒ‡ç¤ºä¸€ä¸ªç±»å±žäºŽè¯¥å±‚: ```` @Service @@ -653,9 +653,9 @@ public class VehicleService { } ```` ### 6 @Controller -@Controller ÊÇÒ»¸öÀ༶±ðµÄ×¢½â£¬Ëü¸æËß Spring Framework Õâ¸öÀà×÷Ϊ Spring MVC ÖеĿØÖÆÆ÷£º +@Controller 是一个类级别的注解,它告诉 Spring Framework 这个类作为 Spring MVC 中的控制器: -spring»á¶Ô@Controller ×¢½âµÄbean×öºÜ¶àÊÂÇ飬¾ßÌåÄÚÈÝÎÒÃÇ»áÔÚSpringMVCÏà¹ØµÄÄÚÈÝÀ´½²Êö +spring会对@Controller 注解的beanå�šå¾ˆå¤šäº‹æƒ…,具体内容我们会在SpringMVC相关的内容æ�¥è®²è¿° ```` @Controller @@ -666,7 +666,7 @@ public class VehicleController { ```` ## 7 @Configuration -ÅäÖÃÀà¿ÉÒÔ°üº¬ÓÃ@Bean ×¢Ê굀 bean ¶¨Òå·½·¨£º +é…�置类å�¯ä»¥åŒ…å�«ç”¨@Bean 注释的 bean 定义方法: ```` @Configuration class VehicleFactoryConfig { @@ -678,10 +678,10 @@ class VehicleFactoryConfig { } ```` -## 8 AOP×¢½â -µ±ÎÒÃÇʹÓà Spring ¹¹ÔìÐÍ×¢ÊÍʱ£¬ºÜÈÝÒ×´´½¨Ò»¸öÇÐÈëµã£¬¸ÃÇÐÈëµãÒÔËùÓоßÓÐÌØ¶¨¹¹ÔìÐ͵ÄÀàΪĿ±ê¡£ +## 8 AOP注解 +当我们使用 Spring 构造型注释时,很容易创建一个切入点,该切入点以所有具有特定构造型的类为目标。 -ÀýÈ磬¼ÙÉèÎÒÃÇÏë²âÁ¿ DAO ²ã·½·¨µÄÖ´ÐÐʱ¼ä¡£ ÎÒÃǽ«´´½¨ÒÔÏ·½Ã棨ʹÓà AspectJ ×¢ÊÍ£©£¬ÀûÓà @Repository ¹¹ÔìÐÍ£º +例如,å�‡è®¾æˆ‘们想测é‡� DAO 层方法的执行时间。 我们将创建以下方é�¢ï¼ˆä½¿ç”¨ AspectJ 注释),利用 @Repository 构造型: ``` @Aspect @@ -705,34 +705,34 @@ public void repositoryClassMethods() {}; } ```` -ÔÚ´ËʾÀýÖУ¬ÎÒÃÇ´´½¨ÁËÒ»¸öÇÐÈëµã£¬¸ÃÇÐÈëµãÆ¥ÅäʹÓÃ@Repository ×¢Ê͵ÄÀàÖеÄËùÓз½·¨¡£ È»ºóÎÒÃÇʹÓÃ@Around ֪ͨÀ´¶¨Î»ÄǸöÇÐÈëµã£¬²¢È·¶¨À¹½Ø·½·¨µ÷ÓõÄÖ´ÐÐʱ¼ä¡£ +在此示例中,我们创建了一个切入点,该切入点匹é…�使用@Repository 注释的类中的所有方法。 ç„¶å�Žæˆ‘们使用@Around 通知æ�¥å®šä½�那个切入点,并确定拦截方法调用的执行时间。 -´ËÍ⣬ʹÓÃÕâÖÖ·½·¨£¬ÎÒÃÇ¿ÉÒÔΪÿ¸öÓ¦ÓóÌÐò²ãÌí¼ÓÈÕÖ¾¼Ç¼¡¢ÐÔÄܹÜÀí¡¢Éó¼ÆºÍÆäËûÐÐΪ¡£ +此外,使用这ç§�方法,我们å�¯ä»¥ä¸ºæ¯�个应用程åº�层添加日志记录ã€�性能管ç�†ã€�审计和其他行为。 -µ±È»ÁË£¬aspectJµÄÏà¹Ø×¢½â»¹ºÜ¶à£¬¿ÉÒÔÓÃÀ´ÉùÃ÷ÇÐÃæ£¬Î´À´ÎÒÃÇÒ²»áµ¥¶ÀдÎĽéÉÜ¡£ +当然了,aspectJ的相关注解还很多,å�¯ä»¥ç”¨æ�¥å£°æ˜Žåˆ‡é�¢ï¼Œæœªæ�¥æˆ‘们也会å�•独写文介ç»�。 -## 9 ½áÂÛ +## 9 结论 -ÔÚ±¾ÎÄÖУ¬ÎÒÃǼì²éÁË Spring ¹¹ÔìÐÍ×¢ÊͲ¢ÌÖÂÛÁËËüÃǸ÷×Ô´ú±íµÄÓïÒåÀàÐÍ¡£ +在本文中,我们检查了 Spring 构造型注释并讨论了它们å�„自代表的语义类型。 -ÎÒÃÇ»¹Ñ§Ï°ÁËÈçºÎʹÓÃ×é¼þɨÃèÀ´¸æËßÈÝÆ÷ÔÚÄÄÀï¿ÉÒÔÕÒµ½´ø×¢Ê͵ÄÀà¡£ +我们还学习了如何使用组件扫æ��æ�¥å‘Šè¯‰å®¹å™¨åœ¨å“ªé‡Œå�¯ä»¥æ‰¾åˆ°å¸¦æ³¨é‡Šçš„类。 -×îºó£¬ÎÒÃÇÁ˽âÁËÕâЩעÊÍÈçºÎµ¼Ö¸ɾ»¡¢·Ö²ãµÄÉè¼ÆÒÔ¼°Ó¦ÓóÌÐò¹Ø×¢µãÖ®¼äµÄ·ÖÀë¡£ ËüÃÇ»¹Ê¹ÅäÖøüС£¬ÒòΪÎÒÃDz»ÔÙÐèÒªÊÖ¶¯ÏÔʽ¶¨Òå bean¡£ -# SpringMVC×¢½â -## 1. ¸ÅÊö -ÔÚ±¾½Ì³ÌÖУ¬ÎÒÃǽ«Ì½Ë÷ org.springframework.web.bind.annotation °üÖÐµÄ Spring Web ×¢ÊÍ¡£ +最å�Žï¼Œæˆ‘们了解了这些注释如何导致干净ã€�分层的设计以å�Šåº”用程åº�关注点之间的分离。 它们还使é…�置更å°�,因为我们ä¸�å†�需è¦�手动显å¼�定义 bean。 +# SpringMVC注解 +## 1. 概述 +在本教程中,我们将探索 org.springframework.web.bind.annotation 包中的 Spring Web 注释。 ## 2. @RequestMapping -¼òµ¥µØËµ£¬@RequestMapping ±ê¼Ç@Controller ÀàÄÚ²¿µÄÇëÇó´¦Àí³ÌÐò·½·¨£» Ëü¿ÉÒÔʹÓÃÅäÖ㺠+简å�•地说,@RequestMapping 标记@Controller 类内部的请求处ç�†ç¨‹åº�方法; 它å�¯ä»¥ä½¿ç”¨é…�置: -·¾¶£¬»òÆä±ðÃû¡¢Ãû³ÆºÍÖµ£º·½·¨Ó³Éäµ½Äĸö URL -·½·¨£º¼æÈÝµÄ HTTP ·½·¨ -params£º¸ù¾Ý HTTP ²ÎÊýµÄ´æÔÚ¡¢²»´æÔÚ»òÖµ¹ýÂËÇëÇó -headers£º¸ù¾Ý HTTP ±êÍ·µÄ´æÔÚ¡¢²»´æÔÚ»òÖµ¹ýÂËÇëÇó -ÏûºÄ£º¸Ã·½·¨¿ÉÒÔÔÚ HTTP ÇëÇóÕýÎÄÖÐÏûºÄÄÄЩýÌåÀàÐÍ -produces£º¸Ã·½·¨¿ÉÒÔÔÚ HTTP ÏìÓ¦ÕýÎÄÖÐÉú³ÉÄÄЩýÌåÀàÐÍ -ÕâÊÇÒ»¸ö¼òµ¥µÄʾÀý£º +路径,或其别å��ã€�å��称和值:方法映射到哪个 URL +方法:兼容的 HTTP 方法 +params:根æ�® HTTP å�‚数的存在ã€�ä¸�存在或值过滤请求 +headers:根æ�® HTTP 标头的存在ã€�ä¸�存在或值过滤请求 +消耗:该方法å�¯ä»¥åœ¨ HTTP 请求正文中消耗哪些媒体类型 +produces:该方法å�¯ä»¥åœ¨ HTTP å“�应正文中生æˆ�哪些媒体类型 +这是一个简å�•的示例: ```` @Controller @@ -744,9 +744,9 @@ class VehicleController { } } ```` -Èç¹ûÎÒÃÇÔÚÀ༶±ðÓ¦ÓôË×¢ÊÍ£¬ÎÒÃÇ¿ÉÒÔΪ @Controller ÀàÖеÄËùÓд¦Àí³ÌÐò·½·¨ÌṩĬÈÏÉèÖᣠΨһµÄÀýÍâÊÇ Spring ²»»áʹÓ÷½·¨¼¶±ðÉèÖø²¸Çµ«»á¸½¼ÓÁ½¸ö·¾¶²¿·ÖµÄ URL¡£ +如果我们在类级别应用此注释,我们å�¯ä»¥ä¸º @Controller 类中的所有处ç�†ç¨‹åº�方法æ��供默认设置。 唯一的例外是 Spring ä¸�会使用方法级别设置覆盖但会附加两个路径部分的 URL。 -ÀýÈ磬ÏÂÃæµÄÅäÖúÍÉÏÃæµÄЧ¹ûÊÇÒ»ÑùµÄ£º +例如,下é�¢çš„é…�置和上é�¢çš„æ•ˆæžœæ˜¯ä¸€æ ·çš„: ```` @Controller @@ -760,13 +760,13 @@ class VehicleController { } ```` -´ËÍ⣬@GetMapping¡¢@PostMapping¡¢@PutMapping¡¢@DeleteMapping ºÍ@PatchMapping ÊÇ@RequestMapping µÄ²»Í¬±äÌ壬ÆäHTTP ·½·¨ÒÑ·Ö±ðÉèÖÃΪGET¡¢POST¡¢PUT¡¢DELETE ºÍPATCH¡£ +此外,@GetMappingã€�@PostMappingã€�@PutMappingã€�@DeleteMapping å’Œ@PatchMapping 是@RequestMapping çš„ä¸�å�Œå�˜ä½“,其HTTP 方法已分别设置为GETã€�POSTã€�PUTã€�DELETE å’ŒPATCH。 -ÕâЩ´Ó Spring 4.3 °æ±¾¿ªÊ¼¿ÉÓᣠ+这些从 Spring 4.3 版本开始å�¯ç”¨ã€‚ ## 3 @RequestBody -ÈÃÎÒÃǼÌÐø@RequestBody¡ª¡ªËü½« HTTP ÇëÇóµÄÖ÷ÌåÓ³Éäµ½Ò»¸ö¶ÔÏó£º +让我们继续@RequestBody——它将 HTTP 请求的主体映射到一个对象: ```` @PostMapping("/save") @@ -774,14 +774,14 @@ void saveVehicle(@RequestBody Vehicle vehicle) { // ... } ```` -·´ÐòÁл¯ÊÇ×Ô¶¯µÄ£¬È¡¾öÓÚÇëÇóµÄÄÚÈÝÀàÐÍ¡£ +å��åº�列化是自动的,å�–决于请求的内容类型。 ## 4 @PathVariable -½ÓÏÂÀ´ËµËµ@PathVariable¡£ +接下æ�¥è¯´è¯´@PathVariable。 -´Ë×¢ÊÍָʾ·½·¨²ÎÊý°ó¶¨µ½ URI Ä£°å±äÁ¿¡£ ÎÒÃÇ¿ÉÒÔʹÓà @RequestMapping ×¢ÊÍÖ¸¶¨ URI Ä£°å£¬²¢Ê¹Óà @PathVariable ½«·½·¨²ÎÊý°ó¶¨µ½Ä£°å²¿·ÖÖ®Ò»¡£ +此注释指示方法å�‚数绑定到 URI 模æ�¿å�˜é‡�。 我们å�¯ä»¥ä½¿ç”¨ @RequestMapping 注释指定 URI 模æ�¿ï¼Œå¹¶ä½¿ç”¨ @PathVariable 将方法å�‚数绑定到模æ�¿éƒ¨åˆ†ä¹‹ä¸€ã€‚ -ÎÒÃÇ¿ÉÒÔʹÓÃÃû³Æ»òÆä±ðÃû£¬¼´Öµ²ÎÊýÀ´ÊµÏÖÕâÒ»µã£º +我们å�¯ä»¥ä½¿ç”¨å��称或其别å��,å�³å€¼å�‚æ•°æ�¥å®žçŽ°è¿™ä¸€ç‚¹ï¼š ```` @RequestMapping("/{id}") @@ -789,7 +789,7 @@ Vehicle getVehicle(@PathVariable("id") long id) { // ... } ```` -Èç¹ûÄ£°åÖв¿·ÖµÄÃû³ÆÓë·½·¨²ÎÊýµÄÃû³ÆÏàÆ¥Å䣬ÎÒÃǾͲ»±ØÔÚ×¢ÊÍÖÐÖ¸¶¨Ëü£º +如果模æ�¿ä¸­éƒ¨åˆ†çš„å��称与方法å�‚æ•°çš„å��称相匹é…�,我们就ä¸�必在注释中指定它: ```` @RequestMapping("/{id}") @@ -797,7 +797,7 @@ Vehicle getVehicle(@PathVariable long id) { // ... } ```` -´ËÍ⣬ÎÒÃÇ¿ÉÒÔͨ¹ý½«ËùÐèµÄ²ÎÊýÉèÖÃΪ false À´½«Â·¾¶±äÁ¿±ê¼ÇΪ¿ÉÑ¡£º +此外,我们å�¯ä»¥é€šè¿‡å°†æ‰€éœ€çš„å�‚数设置为 false æ�¥å°†è·¯å¾„å�˜é‡�标记为å�¯é€‰ï¼š ```` @RequestMapping("/{id}") @@ -813,27 +813,27 @@ Vehicle getVehicleByParam(@RequestParam("id") long id) { // ... } ```` -Ëü¾ßÓÐÓë @PathVariable ×¢ÊÍÏàͬµÄÅäÖÃÑ¡Ïî¡£ +它具有与 @PathVariable 注释相å�Œçš„é…�置选项。 -³ýÁËÕâЩÉèÖÃÖ®Í⣬µ± Spring ÔÚÇëÇóÖз¢ÏÖûÓÐÖµ»òΪ¿Õֵʱ£¬ÎÒÃÇ¿ÉÒÔʹÓà @RequestParam Ö¸¶¨×¢ÈëÖµ¡£ Ϊ´Ë£¬ÎÒÃDZØÐëÉèÖà defaultValue ²ÎÊý¡£ +除了这些设置之外,当 Spring 在请求中å�‘现没有值或为空值时,我们å�¯ä»¥ä½¿ç”¨ @RequestParam 指定注入值。 为此,我们必须设置 defaultValue å�‚数。 -ÌṩĬÈÏÖµÒþʽÉèÖà required Ϊ false£º +æ��供默认值éš�å¼�设置 required 为 false: ```` @RequestMapping("/buy") Car buyCar(@RequestParam(defaultValue = "5") int seatCount) { // ... } ```` -³ýÁ˲ÎÊýÖ®Í⣬ÎÒÃÇ»¹¿ÉÒÔ·ÃÎÊÆäËû HTTP ÇëÇ󲿷֣ºcookie ºÍ±êÍ·¡£ +除了å�‚数之外,我们还å�¯ä»¥è®¿é—®å…¶ä»– HTTP 请求部分:cookie 和标头。 -ÎÒÃÇ¿ÉÒÔ·Ö±ðʹÓÃ×¢½â@CookieValue ºÍ@RequestHeader À´·ÃÎÊËüÃÇ¡£ +我们å�¯ä»¥åˆ†åˆ«ä½¿ç”¨æ³¨è§£@CookieValue å’Œ@RequestHeader æ�¥è®¿é—®å®ƒä»¬ã€‚ ## 6. Response Handling Annotations -ÔÚ½ÓÏÂÀ´µÄ²¿·ÖÖУ¬ÎÒÃǽ«¿´µ½ÔÚ Spring MVC ÖвÙ×÷ HTTP ÏìÓ¦µÄ×î³£¼û×¢ÊÍ¡£ +在接下æ�¥çš„部分中,我们将看到在 Spring MVC 中æ“�作 HTTP å“�应的最常è§�注释。 ### 6.1 @ResponseBody -Èç¹ûÎÒÃÇÓÃ@ResponseBody ±ê¼ÇÇëÇó´¦Àí³ÌÐò·½·¨£¬Spring »á½«·½·¨µÄ½á¹ûÊÓΪÏìÓ¦±¾Éí£º +如果我们用@ResponseBody 标记请求处ç�†ç¨‹åº�方法,Spring 会将方法的结果视为å“�应本身: ```` @ResponseBody @@ -842,13 +842,13 @@ String hello() { return "Hello World!"; } ```` -Èç¹ûÎÒÃÇÓÃÕâ¸ö×¢½âÀ´×¢½â @Controller À࣬ËùÓÐÇëÇó´¦Àí³ÌÐò·½·¨¶¼½«Ê¹ÓÃËü¡£ +如果我们用这个注解æ�¥æ³¨è§£ @Controller 类,所有请求处ç�†ç¨‹åº�方法都将使用它。 ### 6.2 @ExceptionHandler -ʹÓôË×¢ÊÍ£¬ÎÒÃÇ¿ÉÒÔÉùÃ÷Ò»¸ö×Ô¶¨Òå´íÎó´¦Àí³ÌÐò·½·¨¡£ µ±ÇëÇó´¦Àí³ÌÐò·½·¨Å׳öÈκÎÖ¸¶¨µÄÒ쳣ʱ£¬Spring µ÷Óô˷½·¨¡£ +使用此注释,我们å�¯ä»¥å£°æ˜Žä¸€ä¸ªè‡ªå®šä¹‰é”™è¯¯å¤„ç�†ç¨‹åº�方法。 当请求处ç�†ç¨‹åº�方法抛出任何指定的异常时,Spring 调用此方法。 -²¶»ñµÄÒì³£¿ÉÒÔ×÷Ϊ²ÎÊý´«µÝ¸ø·½·¨£º +æ�•获的异常å�¯ä»¥ä½œä¸ºå�‚数传递给方法: ```` @ExceptionHandler(IllegalArgumentException.class) void onIllegalArgumentException(IllegalArgumentException exception) { @@ -857,11 +857,11 @@ void onIllegalArgumentException(IllegalArgumentException exception) { ```` ### 6.3 @ResponseStatus -Èç¹ûÎÒÃÇʹÓôË×¢ÊͶÔÇëÇó´¦Àí³ÌÐò·½·¨½øÐÐ×¢ÊÍ£¬Ôò¿ÉÒÔÖ¸¶¨ÏìÓ¦µÄËùÐè HTTP ״̬¡£ ÎÒÃÇ¿ÉÒÔʹÓà code ²ÎÊý»òÆä±ðÃû value ²ÎÊýÀ´ÉùÃ÷״̬´úÂë¡£ +如果我们使用此注释对请求处ç�†ç¨‹åº�方法进行注释,则å�¯ä»¥æŒ‡å®šå“�应的所需 HTTP 状æ€�。 我们å�¯ä»¥ä½¿ç”¨ code å�‚数或其别å�� value å�‚æ•°æ�¥å£°æ˜Žçжæ€�代ç �。 -´ËÍ⣬ÎÒÃÇ¿ÉÒÔʹÓà reason ²ÎÊýÌṩԭÒò¡£ +此外,我们å�¯ä»¥ä½¿ç”¨ reason å�‚æ•°æ��供原因。 -ÎÒÃÇÒ²¿ÉÒÔ½«ËüÓë@ExceptionHandler Ò»ÆðʹÓ㺠+我们也å�¯ä»¥å°†å®ƒä¸Ž@ExceptionHandler 一起使用: @ExceptionHandler(IllegalArgumentException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) @@ -869,18 +869,18 @@ void onIllegalArgumentException(IllegalArgumentException exception) { // ... } -ÓÐ¹Ø HTTP ÏìӦ״̬µÄ¸ü¶àÐÅÏ¢£¬Çë·ÃÎʱ¾ÎÄ¡£ +有关 HTTP å“�应状æ€�的更多信æ�¯ï¼Œè¯·è®¿é—®æœ¬æ–‡ã€‚ -## 7 ÆäËû Web×¢½â -һЩעÊͲ»Ö±½Ó¹ÜÀí HTTP ÇëÇó»òÏìÓ¦¡£ ÔÚ½ÓÏÂÀ´µÄ²¿·ÖÖУ¬ÎÒÃǽ«½éÉÜ×î³£¼ûµÄ¡£ +## 7 å…¶ä»– Web注解 +一些注释ä¸�直接管ç�† HTTP 请求或å“�应。 在接下æ�¥çš„部分中,我们将介ç»�最常è§�的。 ### 7.1 @Controller -ÎÒÃÇ¿ÉÒÔʹÓÃ@Controller ¶¨ÒåÒ»¸öSpring MVC ¿ØÖÆÆ÷¡£ Óйظü¶àÐÅÏ¢£¬Çë·ÃÎÊÎÒÃǹØÓÚ Spring Bean Annotations µÄÎÄÕ¡£ +我们å�¯ä»¥ä½¿ç”¨@Controller 定义一个Spring MVC 控制器。 有关更多信æ�¯ï¼Œè¯·è®¿é—®æˆ‘们关于 Spring Bean Annotations 的文章。 ### 7.2 @RestController -@RestController ½áºÏÁË@Controller ºÍ@ResponseBody¡£ +@RestController 结å�ˆäº†@Controller å’Œ@ResponseBody。 -Òò´Ë£¬ÒÔÏÂÉùÃ÷ÊǵÈЧµÄ£º +因此,以下声明是等效的: ```` @Controller @@ -897,7 +897,7 @@ class VehicleRestController { } ```` ### 7.3 @ModelAttribute -ͨ¹ýÕâ¸ö×¢½â£¬ÎÒÃÇ¿ÉÒÔͨ¹ýÌṩģÐͼüÀ´·ÃÎÊÒѾ­´æÔÚÓÚ MVC @Controller Ä£ÐÍÖеÄÔªËØ£º +通过这个注解,我们å�¯ä»¥é€šè¿‡æ��供模型键æ�¥è®¿é—®å·²ç»�存在于 MVC @Controller 模型中的元素: ```` @PostMapping("/assemble") @@ -905,7 +905,7 @@ void assembleVehicle(@ModelAttribute("vehicle") Vehicle vehicleInModel) { // ... } ```` -Óë@PathVariable ºÍ@RequestParam Ò»Ñù£¬Èç¹û²ÎÊý¾ßÓÐÏàͬµÄÃû³Æ£¬ÎÒÃDz»±ØÖ¸¶¨Ä£Ðͼü£º +与@PathVariable å’Œ@RequestParam 一样,如果å�‚数具有相å�Œçš„å��称,我们ä¸�必指定模型键: ```` @PostMapping("/assemble") @@ -913,7 +913,7 @@ void assembleVehicle(@ModelAttribute Vehicle vehicle) { // ... } ```` -´ËÍ⣬@ModelAttribute»¹ÓÐÒ»¸öÓÃ;£ºÈç¹ûÎÒÃÇÓÃËü×¢½âÒ»¸ö·½·¨£¬Spring»á×Ô¶¯½«·½·¨µÄ·µ»ØÖµÌí¼Óµ½Ä£ÐÍÖУº +此外,@ModelAttribute还有一个用途:如果我们用它注解一个方法,Spring会自动将方法的返回值添加到模型中: ```` @ModelAttribute("vehicle") @@ -921,19 +921,19 @@ Vehicle getVehicle() { // ... } ```` -ºÍÒÔǰһÑù£¬ÎÒÃDz»±ØÖ¸¶¨Ä£Ðͼü£¬Spring ĬÈÏʹÓ÷½·¨µÄÃû³Æ£º +和以å‰�一样,我们ä¸�必指定模型键,Spring 默认使用方法的å��称: ```` @ModelAttribute Vehicle vehicle() { // ... } ```` -ÔÚ Spring µ÷ÓÃÇëÇó´¦Àí³ÌÐò·½·¨Ö®Ç°£¬Ëü»áµ÷ÓÃÀàÖÐËùÓÐ @ModelAttribute ×¢Ê͵ķ½·¨¡£ +在 Spring 调用请求处ç�†ç¨‹åº�方法之å‰�,它会调用类中所有 @ModelAttribute 注释的方法。 -ÓÐ¹Ø @ModelAttribute µÄ¸ü¶àÐÅÏ¢£¬Çë²ÎÔı¾ÎÄ¡£ +有关 @ModelAttribute 的更多信æ�¯ï¼Œè¯·å�‚阅本文。 ### 7.4 @CrossOrigin -@CrossOrigin Ϊ´ø×¢Ê͵ÄÇëÇó´¦Àí³ÌÐò·½·¨ÆôÓÿçÓòͨÐÅ£º +@CrossOrigin 为带注释的请求处ç�†ç¨‹åº�方法å�¯ç”¨è·¨åŸŸé€šä¿¡ï¼š ```` @CrossOrigin @@ -942,23 +942,23 @@ String hello() { return "Hello World!"; } ```` -Èç¹ûÎÒÃÇÓÃËü±ê¼ÇÒ»¸öÀ࣬ËüÊÊÓÃÓÚÆäÖеÄËùÓÐÇëÇó´¦Àí³ÌÐò·½·¨¡£ +如果我们用它标记一个类,它适用于其中的所有请求处ç�†ç¨‹åº�方法。 -ÎÒÃÇ¿ÉÒÔʹÓôË×¢Ê͵IJÎÊý΢µ÷ CORS ÐÐΪ¡£ +我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨é‡Šçš„å�‚数微调 CORS 行为。 -ÓйØÏêϸÐÅÏ¢£¬Çë·ÃÎʱ¾ÎÄ¡£ +有关详细信æ�¯ï¼Œè¯·è®¿é—®æœ¬æ–‡ã€‚ -# SpringBoot×¢½â -## 1 ¸ÅÊö -Spring Boot ͨ¹ýÆä×Ô¶¯ÅäÖù¦ÄÜʹÅäÖà Spring ±äµÃ¸ü¼ÓÈÝÒס£ +# SpringBoot注解 +## 1 概述 +Spring Boot 通过其自动é…�置功能使é…�ç½® Spring å�˜å¾—更加容易。 -ÔÚ±¾¿ìËٽ̳ÌÖУ¬ÎÒÃǽ«Ì½Ë÷ org.springframework.boot.autoconfigure ºÍ org.springframework.boot.autoconfigure.condition °üÖеÄ×¢½â¡£ +在本快速教程中,我们将探索 org.springframework.boot.autoconfigure å’Œ org.springframework.boot.autoconfigure.condition 包中的注解。 ## 2 @SpringBootApplication -ÎÒÃÇʹÓÃÕâ¸ö×¢½âÀ´±ê¼Ç Spring Boot Ó¦ÓóÌÐòµÄÖ÷Àࣺ +我们使用这个注解æ�¥æ ‡è®° Spring Boot 应用程åº�的主类: @SpringBootApplication -ÎÒÃÇʹÓÃÕâ¸ö×¢½âÀ´±ê¼Ç Spring Boot Ó¦ÓóÌÐòµÄÖ÷Àࣺ +我们使用这个注解æ�¥æ ‡è®° Spring Boot 应用程åº�的主类: ```` @SpringBootApplication class VehicleFactoryApplication { @@ -968,13 +968,13 @@ class VehicleFactoryApplication { } } ```` -@SpringBootApplication ·â×°ÁË@Configuration¡¢@EnableAutoConfiguration ºÍ@ComponentScan ×¢½â¼°ÆäĬÈÏÊôÐÔ¡£ +@SpringBootApplication å°�装了@Configurationã€�@EnableAutoConfiguration å’Œ@ComponentScan 注解å�Šå…¶é»˜è®¤å±žæ€§ã€‚ ## 3 @EnableAutoConfiguration -@EnableAutoConfiguration£¬¹ËÃû˼Ò壬ÆôÓÃ×Ô¶¯ÅäÖᣠÕâÒâζ×Å Spring Boot ÔÚÆäÀà·¾¶ÖвéÕÒ×Ô¶¯ÅäÖà bean ²¢×Ô¶¯Ó¦ÓÃËüÃÇ¡£ +@EnableAutoConfiguration,顾å��æ€�义,å�¯ç”¨è‡ªåЍé…�置。 è¿™æ„�味ç�€ Spring Boot 在其类路径中查找自动é…�ç½® bean 并自动应用它们。 -Çë×¢Ò⣬ÎÒÃDZØÐ뽫´Ë×¢ÊÍÓë@Configuration Ò»ÆðʹÓ㺠+请注æ„�,我们必须将此注释与@Configuration 一起使用: ```` @Configuration @@ -982,17 +982,17 @@ class VehicleFactoryApplication { class VehicleFactoryConfig {} ```` -## 4 @ConfigurationÒÔ¼°Ïà¹ØÀà +## 4 @Configuration以å�Šç›¸å…³ç±» -@ConfigurationµÄ×÷Ó㺱ê×¢ÔÚÀàÉÏ£¬ÅäÖÃspringÈÝÆ÷(Ó¦ÓÃÉÏÏÂÎÄ)¡£ +@Configuration的作用:标注在类上,é…�ç½®spring容器(应用上下文)。 -ÒÔÍùÎÒÃÇÔÚspringÖÐÅäÖÃbean»áʹÓõ½xmlÅäÖÃÎļþ£¬¶¨ÒåÒ»¸ö¸öbean£¬ÔÚspringbootÖУ¬ÎªÁË×öµ½ÁãÅäÖã¬spring¿ò¼ÜÌṩÁË@ConfigurationÕâÒ»×¢½â +以往我们在spring中é…�ç½®bean会使用到xmlé…�置文件,定义一个个bean,在springboot中,为了å�šåˆ°é›¶é…�置,spring框架æ��供了@Configuration这一注解 -Ï൱ÓڰѸÃÀà×÷ΪspringµÄxmlÅäÖÃÎļþÖÐµÄ +相当于把该类作为springçš„xmlé…�置文件中的 -@Configuration×¢½âµÄÀàÖУ¬Ê¹ÓÃ@Bean×¢½â±ê×¢µÄ·½·¨£¬·µ»ØµÄÀàÐͶ¼»áÖ±½Ó×¢²áΪbean¡£ +@Configuration注解的类中,使用@Bean注解标注的方法,返回的类型都会直接注册为bean。 -@Configure×¢½âµÄ¶¨ÒåÈçÏ£º +@Configure注解的定义如下: ```` @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @@ -1002,20 +1002,20 @@ public @interface Configuration { String value() default ""; } ```` -´Ó¶¨ÒåÀ´¿´£¬µ×²ãÊǺ¬ÓÐ@Component £¬ËùÒÔ@Configuration ¾ßÓÐºÍ @Component µÄ×÷Óá£Òò´Ëcontext:component-scan/»òÕß@ComponentScan¶¼ÄÜ´¦Àí@Configuration×¢½âµÄÀà¡£ +从定义æ�¥çœ‹ï¼Œåº•层是å�«æœ‰@Component ,所以@Configuration 具有和 @Component 的作用。因此context:component-scan/或者@ComponentScan都能处ç�†@Configuration注解的类。 -ͨ³££¬µ±ÎÒÃDZàд×Ô¶¨Òå×Ô¶¯ÅäÖÃʱ£¬ÎÒÃÇÏ£Íû Spring ÓÐÌõ¼þµØÊ¹ÓÃËüÃÇ¡£ ÎÒÃÇ¿ÉÒÔͨ¹ý±¾½ÚÖеÄ×¢ÊÍÀ´ÊµÏÖÕâÒ»µã¡£ +通常,当我们编写自定义自动é…�置时,我们希望 Spring 有æ�¡ä»¶åœ°ä½¿ç”¨å®ƒä»¬ã€‚ 我们å�¯ä»¥é€šè¿‡æœ¬èŠ‚ä¸­çš„æ³¨é‡Šæ�¥å®žçŽ°è¿™ä¸€ç‚¹ã€‚ -ÎÒÃÇ¿ÉÒÔ½«´Ë²¿·ÖÖеÄ×¢ÊÍ·ÅÔÚ@Configuration Àà»ò@Bean ·½·¨ÉÏ¡£ +我们å�¯ä»¥å°†æ­¤éƒ¨åˆ†ä¸­çš„æ³¨é‡Šæ”¾åœ¨@Configuration 类或@Bean 方法上。 -ÔÚ½ÓÏÂÀ´µÄ²¿·ÖÖУ¬ÎÒÃǽ«Ö»½éÉÜÿ¸öÌõ¼þ±³ºóµÄ»ù±¾¸ÅÄî¡£ ÓûÁ˽â¸ü¶àÐÅÏ¢£¬Çë·ÃÎÊÕâÆªÎÄÕ¡£ +在接下æ�¥çš„部分中,我们将å�ªä»‹ç»�æ¯�个æ�¡ä»¶èƒŒå�Žçš„基本概念。 欲了解更多信æ�¯ï¼Œè¯·è®¿é—®è¿™ç¯‡æ–‡ç« ã€‚ ### 4.1 @ConditionalOnClass and @ConditionalOnMissingClass -ºÜÃ÷ÏÔÕâÊÇÒ»¸ö´øÓÐÌõ¼þÅжϵÄÅäÖÃ×¢½â£¬ÒªÖªµÀ£¬ºÜ¶àʱºòÎÒÃǰ´Ðè¼ÓÔØbeanµÄ£¬ÉõÖÁÊǸù¾ÝÍⲿjar°üÊÇ·ñ´æÔÚÀ´½øÐмÓÔØºÍÅжϵġ£ +很明显这是一个带有æ�¡ä»¶åˆ¤æ–­çš„é…�置注解,è¦�知é�“,很多时候我们按需加载bean的,甚至是根æ�®å¤–部jar包是å�¦å­˜åœ¨æ�¥è¿›è¡ŒåŠ è½½å’Œåˆ¤æ–­çš„ã€‚ -ÕâÖÖʱºò£¬¾ÍÒª¸ù¾ÝÍⲿÀàÊÇ·ñ´æÔÚÀ´¾ö¶¨ÊÇ·ñÊÇ·ñ¼ÓÔØ¸Ãbean +è¿™ç§�时候,就è¦�æ ¹æ�®å¤–部类是å�¦å­˜åœ¨æ�¥å†³å®šæ˜¯å�¦æ˜¯å�¦åŠ è½½è¯¥bean -ʹÓÃÕâЩÌõ¼þ£¬Èç¹û×¢ÊͲÎÊýÖеÄÀà´æÔÚ/²»´æÔÚ£¬Spring ½«½öʹÓñê¼ÇµÄ×Ô¶¯ÅäÖà bean£º +使用这些æ�¡ä»¶ï¼Œå¦‚果注释å�‚数中的类存在/ä¸�存在,Spring 将仅使用标记的自动é…�ç½® bean: ```` @Configuration @@ -1027,9 +1027,9 @@ class MySQLAutoconfiguration { ### 4.2 @ConditionalOnBean and @ConditionalOnMissingBean -µ±ÎÒÃÇÏëÒª¸ù¾ÝÌØ¶¨ bean µÄ´æÔÚ»ò²»´æÔÚÀ´¶¨ÒåÌõ¼þʱ£¬ÎÒÃÇ¿ÉÒÔʹÓÃÕâЩעÊÍ£º +当我们想è¦�æ ¹æ�®ç‰¹å®š bean 的存在或ä¸�存在æ�¥å®šä¹‰æ�¡ä»¶æ—¶ï¼Œæˆ‘们å�¯ä»¥ä½¿ç”¨è¿™äº›æ³¨é‡Šï¼š -ºÍÉÏÃæÒ»¸ö×¢½âÉÔÓÐЩ²»Í¬£¬ÒòΪÎÒÃǵÄÅжÏÌõ¼þ±ä³ÉÁËbean +和上é�¢ä¸€ä¸ªæ³¨è§£ç¨�有些ä¸�å�Œï¼Œå› ä¸ºæˆ‘们的判断æ�¡ä»¶å�˜æˆ�了bean ```` @Bean @@ -1039,9 +1039,9 @@ LocalContainerEntityManagerFactoryBean entityManagerFactory() { } ```` ### 4.3 @ConditionalOnProperty -ͨ¹ýÕâ¸ö×¢½â£¬ÎÒÃÇ¿ÉÒÔ¶ÔÊôÐÔµÄÖµÉèÖÃÌõ¼þ +通过这个注解,我们å�¯ä»¥å¯¹å±žæ€§çš„值设置æ�¡ä»¶ -ҪעÒ⣬ÕâÀïµÄÊôÐÔÖµÀ´Ô´ÓÚapplication.propertiesÎļþÖеÄÅäÖà +è¦�注æ„�,这里的属性值æ�¥æº�于application.properties文件中的é…�ç½® ```` @Bean @@ -1056,8 +1056,8 @@ DataSource dataSource() { ### 4.4 @ConditionalOnResource -ÎÒÃÇ¿ÉÒÔÈà Spring ½öÔÚ´æÔÚÌØ¶¨×ÊԴʱʹÓö¨Ò壺 -¹ËÃû˼Ò壬ҪÇóclasspath´æÔÚÕâ¸ö×ÊÔ´Îļþʱ²Å½øÐмÓÔØ£¬ÕâÒ²ÊǺܳ£ÓõÄÒ»¸ö×¢½â¡£ +我们å�¯ä»¥è®© Spring 仅在存在特定资æº�时使用定义: +顾å��æ€�义,è¦�求classpath存在这个资æº�文件时æ‰�进行加载,这也是很常用的一个注解。 ```` @@ -1068,9 +1068,9 @@ Properties ditionalProperties() { ```` ### 4.5 @ConditionalOnWebApplication and @ConditionalOnNotWebApplication -Õâ¸ö×¢½âͨ³£ÓÃÓÚºÍwebÓÐÇ¿¹ØÁª£¬»òÕßÍêÈ«ÎÞ¹ØÁªµÄÅäÖÃÉÏ +这个注解通常用于和web有强关è�”,或者完全无关è�”çš„é…�置上 -ʹÓÃÕâЩעÊÍ£¬ÎÒÃÇ¿ÉÒÔ¸ù¾Ýµ±Ç°Ó¦ÓóÌÐòÊÇ·ñÊÇ Web Ó¦ÓóÌÐòÀ´´´½¨Ìõ¼þ£º +使用这些注释,我们å�¯ä»¥æ ¹æ�®å½“å‰�应用程åº�是å�¦æ˜¯ Web 应用程åº�æ�¥åˆ›å»ºæ�¡ä»¶ï¼š ```` @ConditionalOnWebApplication @@ -1080,9 +1080,9 @@ HealthCheckController healthCheckController() { ```` ### 4.6 @ConditionalExpression -springbootÕæµÄΪÎÒÃÇÏëµ½ÁËËùÓÐÇé¿ö£¬Èç¹ûÉÏÃæµÄ×¢½â»¹²»ÄÜÂú×ãÄãµÄÒªÇó£¬ÄÇô¸É´à¾ÍÈÃÄã×Ô¼ºÐ´£¬ÕâÏÂÓ¦¸ÃûÓÐÎÊÌâ°É£¿ +springboot真的为我们想到了所有情况,如果上é�¢çš„æ³¨è§£è¿˜ä¸�能满足你的è¦�求,那么干脆就让你自己写,这下应该没有问题å�§ï¼Ÿ -ÎÒÃÇ¿ÉÒÔÔÚ¸ü¸´ÔÓµÄÇé¿öÏÂʹÓÃÕâ¸ö×¢½â¡£ µ± SpEL ±í´ïʽ±»ÆÀ¹ÀÎªÕæÊ±£¬Spring ½«Ê¹Óñê¼ÇµÄ¶¨Ò壺 +我们å�¯ä»¥åœ¨æ›´å¤�æ�‚的情况下使用这个注解。 当 SpEL 表达å¼�被评估为真时,Spring 将使用标记的定义: ```` @Bean @@ -1093,10 +1093,10 @@ DataSource dataSource() { ```` ### 4.7 @Conditional -ʲô£¬»¹ÓÐÎÊÌ⣿ -ÄÇspringbootÒ²²»ÔÙÌṩʲô±í´ïʽ¸øÄãÁË£¬Ö±½ÓÈÃÓû§Ð´Ò»¸öÅжÏÌõ¼þ£¬¸æËßÎÒtrue»òÕßfalse¾ÍÐÐÁË +什么,还有问题? +é‚£springboot也ä¸�å†�æ��供什么表达å¼�给你了,直接让用户写一个判断æ�¡ä»¶ï¼Œå‘Šè¯‰æˆ‘true或者false就行了 -¶ÔÓÚ¸ü¸´ÔÓµÄÌõ¼þ£¬ÎÒÃÇ¿ÉÒÔ´´½¨Ò»¸öÆÀ¹À×Ô¶¨ÒåÌõ¼þµÄÀà¡£ ÎÒÃǸæËß Spring ½«Õâ¸ö×Ô¶¨ÒåÌõ¼þÓë @Conditional Ò»ÆðʹÓ㺠+对于更å¤�æ�‚çš„æ�¡ä»¶ï¼Œæˆ‘们å�¯ä»¥åˆ›å»ºä¸€ä¸ªè¯„估自定义æ�¡ä»¶çš„类。 我们告诉 Spring 将这个自定义æ�¡ä»¶ä¸Ž @Conditional 一起使用: ```` @Conditional(HibernateCondition.class) @@ -1105,8 +1105,8 @@ Properties ditionalProperties() { } ```` -## 5 ×ܽá -ÔÚ±¾ÎÄÖУ¬ÎÒÃǸÅÊöÁËÈçºÎ΢µ÷×Ô¶¯ÅäÖùý³Ì²¢Îª×Ô¶¨Òå×Ô¶¯ÅäÖà bean ÌṩÌõ¼þ¡£ +## 5 总结 +在本文中,我们概述了如何微调自动é…�置过程并为自定义自动é…�ç½® bean æ��ä¾›æ�¡ä»¶ã€‚ -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.baeldung.com/spring-annotations diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/\345\237\272\344\272\216SpringBoot\344\270\255\347\232\204\345\274\200\346\272\220\347\233\221\346\216\247\345\267\245\345\205\267SpringBootAdmin.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/\345\237\272\344\272\216SpringBoot\344\270\255\347\232\204\345\274\200\346\272\220\347\233\221\346\216\247\345\267\245\345\205\267SpringBootAdmin.md" index fc25a2c..1e4b0f8 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/\345\237\272\344\272\216SpringBoot\344\270\255\347\232\204\345\274\200\346\272\220\347\233\221\346\216\247\345\267\245\345\205\267SpringBootAdmin.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/\345\237\272\344\272\216SpringBoot\344\270\255\347\232\204\345\274\200\346\272\220\347\233\221\346\216\247\345\267\245\345\205\267SpringBootAdmin.md" @@ -1,28 +1,28 @@ -Spring Boot Admin(SBA)ÊÇÒ»¸ö¿ªÔ´µÄÉçÇøÏîÄ¿£¬ÓÃÓÚ¹ÜÀíºÍ¼à¿Ø Spring Boot Ó¦ÓóÌÐò¡£Ó¦ÓóÌÐò¿ÉÒÔͨ¹ý http µÄ·½Ê½£¬»ò Spring Cloud ·þÎñ·¢ÏÖ»ú֯ע²áµ½ SBA ÖУ¬È»ºó¾Í¿ÉÒÔʵÏÖ¶Ô Spring Boot ÏîÄ¿µÄ¿ÉÊÓ»¯¹ÜÀíºÍ²é¿´ÁË¡£ +Spring Boot Admin(SBA)是一个开æº�的社区项目,用于管ç�†å’Œç›‘控 Spring Boot 应用程åº�。应用程åº�å�¯ä»¥é€šè¿‡ http 的方å¼�,或 Spring Cloud æœ�务å�‘现机制注册到 SBA 中,然å�Žå°±å�¯ä»¥å®žçް坹 Spring Boot 项目的å�¯è§†åŒ–管ç�†å’ŒæŸ¥çœ‹äº†ã€‚ -Spring Boot Admin ¿ÉÒÔ¼à¿Ø Spring Boot µ¥»ú»ò¼¯ÈºÏîÄ¿£¬ËüÌṩÏêϸµÄ½¡¿µ (Health)ÐÅÏ¢¡¢ÄÚ´æÐÅÏ¢¡¢JVM ϵͳºÍ»·¾³ÊôÐÔ¡¢À¬»ø»ØÊÕÐÅÏ¢¡¢ÈÕÖ¾ÉèÖúͲ鿴¡¢¶¨Ê±ÈÎÎñ²é¿´¡¢Spring Boot »º´æ²é¿´ºÍ¹ÜÀíµÈ¹¦ÄÜ¡£½ÓÏÂÀ´ÎÒÃÇÒ»ÆðÀ´´î½¨ºÍʹÓðɡ£ +Spring Boot Admin å�¯ä»¥ç›‘控 Spring Boot å�•机或集群项目,它æ��供详细的å�¥åº· (Health)ä¿¡æ�¯ã€�内存信æ�¯ã€�JVM 系统和环境属性ã€�垃圾回收信æ�¯ã€�日志设置和查看ã€�定时任务查看ã€�Spring Boot 缓存查看和管ç�†ç­‰åŠŸèƒ½ã€‚æŽ¥ä¸‹æ�¥æˆ‘们一起æ�¥æ�­å»ºå’Œä½¿ç”¨å�§ã€‚ -Ëü×îÖÕµÄչʾЧ¹ûÈçÏ£º +它最终的展示效果如下: [![](https://s5.51cto.com/oss/202201/14/5d142e8c6b544f7b981b3eff8099b3d8.png)](https://s5.51cto.com/oss/202201/14/5d142e8c6b544f7b981b3eff8099b3d8.png) -## 1.´î½¨SBA¼à¿Ø¶Ë +## 1.æ�­å»ºSBA监控端 -ÎÒÃÇÐèÒª´´½¨Ò»¸ö Spring Boot Admin ÏîÄ¿£¬ÓÃÀ´¼à¿ØºÍ¹ÜÀíÎÒÃÇµÄ Spring Boot ÏîÄ¿£¬´î½¨µÄ·½Ê½ºÍ´´½¨ÆÕͨµÄ Spring Boot ÏîÄ¿ÀàËÆ£¬¾ßÌå²½ÖèÈçÏ¡£Ê¹Óà Idea ´´½¨Ò»¸ö Spring Boot ÏîÄ¿£º +我们需è¦�创建一个 Spring Boot Admin 项目,用æ�¥ç›‘控和管ç�†æˆ‘们的 Spring Boot 项目,æ�­å»ºçš„æ–¹å¼�和创建普通的 Spring Boot 项目类似,具体步骤如下。使用 Idea 创建一个 Spring Boot 项目: [![](https://s5.51cto.com/oss/202201/14/d97c492785db6ff2ded49175184ceda9.png)](https://s5.51cto.com/oss/202201/14/d97c492785db6ff2ded49175184ceda9.png) [![](https://s3.51cto.com/oss/202201/14/8bb1f0389b95e174b56ac01ba313ec7b.png)](https://s3.51cto.com/oss/202201/14/8bb1f0389b95e174b56ac01ba313ec7b.png) -ÕâÀïÐèҪעÒ⣬ÐèÒªÌí¼Ó Spring Boot Admin(Server)·þÎñ¶Ë¿ò¼ÜµÄÖ§³Ö£¬ÈçÏÂͼËùʾ£º +这里需è¦�注æ„�,需è¦�添加 Spring Boot Admin(Server)æœ�务端框架的支æŒ�,如下图所示: [![](https://s4.51cto.com/oss/202201/14/122e9f0726fde8ac0c8936c79ef12f5f.png)](https://s4.51cto.com/oss/202201/14/122e9f0726fde8ac0c8936c79ef12f5f.png) -Ò²¾ÍÊÇ´´½¨µÄ Spring Boot ÏîÄ¿ÐèÒªÌí¼ÓÒÔÏÂÁ½¸öÖØÒªµÄ¿ò¼ÜÖ§³Ö£º +也就是创建的 Spring Boot 项目需è¦�添加以下两个é‡�è¦�的框架支æŒ�: - + ``` @@ -42,20 +42,20 @@ Spring Boot Admin -### 1.1 ¿ªÆôSBA·þÎñ +### 1.1 å¼€å�¯SBAæœ�务 -´´½¨ÍêÏîĿ֮ºó£¬ÐèÒªÔÚÆô¶¯ÀàÉÏ¿ªÆô SBA ·þÎñ£º +创建完项目之å�Žï¼Œéœ€è¦�在å�¯åŠ¨ç±»ä¸Šå¼€å�¯ SBA æœ�务: - + ``` import de.codecentric.boot.admin.server.config.EnableAdminServer; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; -@EnableAdminServer // Ìí¼Ó´ËÐдúÂë +@EnableAdminServer // 添加此行代ç � @SpringBootApplication public class SbaserverApplication { public static void main(String[] args) { @@ -69,13 +69,13 @@ public class SbaserverApplication { -### 1.2 ÅäÖÃSBA¶Ë¿ÚºÅ +### 1.2 é…�ç½®SBA端å�£å�· -ÔÚ application.properties ÖÐÅäÖÃÒ»¸öÏîÄ¿µÄ¶Ë¿ÚºÅ¾Í¿ÉÒÔÖ±½ÓÆô¶¯ÁË£¬ÎÒÅäÖõĶ˿ںÅÊÇ 9001£º +在 application.properties 中é…�置一个项目的端å�£å�·å°±å�¯ä»¥ç›´æŽ¥å�¯åŠ¨äº†ï¼Œæˆ‘é…�置的端å�£å�·æ˜¯ 9001: - + ``` server.port=9001 @@ -86,23 +86,23 @@ server.port=9001 -PS£ºÅäÖö˿ںŵÄÖ÷ҪĿµÄÊÇΪÁ˲»ºÍÆäËû Spring Boot ÏîÄ¿³åÍ»£¬Èç¹û SBA Êǵ¥¶À²¿Êð´Ë²½Öè¿ÉÒÔºöÂÔ¡£ +PS:é…�置端å�£å�·çš„主è¦�目的是为了ä¸�和其他 Spring Boot 项目冲çª�,如果 SBA 是å�•独部署此步骤å�¯ä»¥å¿½ç•¥ã€‚ -Æô¶¯ÏîĿ֮ºó£¬¾Í¿ÉÒÔ¿´µ½ SBA µÄÖ÷Ò³ÁË£¬ÈçÏÂͼËùʾ£º +å�¯åŠ¨é¡¹ç›®ä¹‹å�Žï¼Œå°±å�¯ä»¥çœ‹åˆ° SBA 的主页了,如下图所示: [![](https://s5.51cto.com/oss/202201/14/20418ce88230b20b234f9e9c15e07f47.png)](https://s5.51cto.com/oss/202201/14/20418ce88230b20b234f9e9c15e07f47.png) -´Ëʱ SBA Öл¹Ã»ÓÐÌí¼ÓÈκÎÐèÒª¼à¿ØµÄÏîÄ¿£¬½ÓÏÂÀ´ÎÒÃÇÔÙ´´½¨Ò»¸ö Spring Boot ÏîÄ¿£¬¼ÓÈëµ½ SBA ÖÐÀ´½øÐÐ¼à¿ØºÍ¹ÜÀí°É¡£ +此时 SBA 中还没有添加任何需è¦�监控的项目,接下æ�¥æˆ‘们å†�创建一个 Spring Boot 项目,加入到 SBA 中æ�¥è¿›è¡Œç›‘控和管ç�†å�§ã€‚ -## 2.´´½¨Ò»¸öÆÕͨSpringBootÏîÄ¿ +## 2.创建一个普通SpringBoot项目 -Ê×ÏÈ£¬ÎÒÃÇÐèÒª´´½¨Ò»¸öÆÕͨµÄ Spring Boot ÏîÄ¿£¬¾ßÌåµÄ´´½¨²½ÖèÕâÀï¾Í²»ÑÝʾÁË¡£µ±´´½¨ºÃ Spring Boot ÏîĿ֮ºó£¬ÐèÒªÔÚÕâ¸ö Spring Boot ÏîÄ¿ÖÐÐèÒªÌí¼Ó SBA ¿Í»§¶Ë¿ò¼ÜµÄÖ§³Ö£¬Ò²¾ÍÊÇÔÚ pom.xml ÖÐÅäÖÃÈçÏÂÄÚÈÝ£º +首先,我们需è¦�创建一个普通的 Spring Boot 项目,具体的创建步骤这里就ä¸�演示了。当创建好 Spring Boot 项目之å�Žï¼Œéœ€è¦�在这个 Spring Boot 项目中需è¦�添加 SBA 客户端框架的支æŒ�,也就是在 pom.xml 中é…�置如下内容: - + ``` @@ -116,16 +116,16 @@ PS -È»ºóÔÚ application.properties ÎļþÖÐÅäÖà SBA ·þÎñÆ÷¶ËµØÖ·£¬Ò²¾ÍÊÇÔÛÃǵÚÒ»²½´´½¨ SBA ÏîÄ¿µÄµØÖ·£¬ÅäÖÃÄÚÈÝÈçÏ£º +ç„¶å�Žåœ¨ application.properties 文件中é…�ç½® SBA æœ�务器端地å�€ï¼Œä¹Ÿå°±æ˜¯å’±ä»¬ç¬¬ä¸€æ­¥åˆ›å»º SBA 项目的地å�€ï¼Œé…�置内容如下: - + ``` -# µ±Ç°ÏîÄ¿¶Ë¿ÚºÅ +# 当å‰�项目端å�£å�· server.port=8080 -# Spring Boot Admin ¼à¿Ø·þÎñÆ÷¶ËµØÖ· +# Spring Boot Admin 监控æœ�务器端地å�€ spring.boot.admin.client.url=http://localhost:9001 ``` @@ -134,55 +134,55 @@ spring.boot.admin.client.url=http://localhost:9001 -ÆäÖС°spring.boot.admin.client.url¡±Îª SBA ¼à¿ØµØÖ·¡£ +其中“spring.boot.admin.client.urlâ€�为 SBA 监控地å�€ã€‚ -## 3.SpringBootAdmin¼à¿Ø×ÜÀÀ +## 3.SpringBootAdmin监控总览 -ÅäÖÃÍêÒÔÉÏÐÅÏ¢Ö®ºó£¬´Ëʱ²é¿´ Spring Boot Admin Ò³ÃæÖоÍÓб»¼à¿ØµÄ Spring Boot ÏîÄ¿ÁË£¬ÈçÏÂͼËùʾ£º +é…�置完以上信æ�¯ä¹‹å�Žï¼Œæ­¤æ—¶æŸ¥çœ‹ Spring Boot Admin 页é�¢ä¸­å°±æœ‰è¢«ç›‘控的 Spring Boot 项目了,如下图所示: [![](https://s5.51cto.com/oss/202201/14/c010770a5cdfe5fad0ad1e8f0c3b07dc.png)](https://s5.51cto.com/oss/202201/14/c010770a5cdfe5fad0ad1e8f0c3b07dc.png) -Ò²¿ÉÒÔµã»÷¡°Ó¦ÓÃǽ¡±²é¿´ Spring Boot Admin ÖÐËùÓб»¼à¿ØµÄ Spring Boot ÏîÄ¿£¬ÈçÏÂͼËùʾ£º +也å�¯ä»¥ç‚¹å‡»â€œåº”用墙â€�查看 Spring Boot Admin 中所有被监控的 Spring Boot 项目,如下图所示: [![](https://s4.51cto.com/oss/202201/14/d88e33f87e116000f9717e8c19c43cc4.png)](https://s4.51cto.com/oss/202201/14/d88e33f87e116000f9717e8c19c43cc4.png) -µã»÷Ó¦ÓýøÈëÏêÇéÒ³Ãæ£¬ÈçÏÂͼËùʾ£º +点击应用进入详情页é�¢ï¼Œå¦‚下图所示: [![](https://s2.51cto.com/oss/202201/14/4c3609840ea5cb45779eafbc2b260324.png)](https://s2.51cto.com/oss/202201/14/4c3609840ea5cb45779eafbc2b260324.png) [![](https://s4.51cto.com/oss/202201/14/2912ed434d97f8dd49c27ce73252d34c.png)](https://s4.51cto.com/oss/202201/14/2912ed434d97f8dd49c27ce73252d34c.png) -ʼþÈÕÖ¾Öаüº¬ Spring Boot ¸÷ÖÖ״̬µÄչʾ(UP ΪÕý³£¡¢OFFLINE ΪÒì³£)ºÍ·¢ÉúµÄʱ¼ä£¬ÈçÏÂͼËùʾ£º +事件日志中包å�« Spring Boot å�„ç§�状æ€�的展示(UP 为正常ã€�OFFLINE 为异常)å’Œå�‘生的时间,如下图所示: [![](https://s5.51cto.com/oss/202201/14/5792a62fbcafe6978bfe3bd26cf1e3ab.png)](https://s5.51cto.com/oss/202201/14/5792a62fbcafe6978bfe3bd26cf1e3ab.png) -## 4.SpringBootÒì³£¼à¿Ø +## 4.SpringBoot异常监控 -µ±ÎÒÃÇÊÖ¶¯°Ñ±»¼à¿ØµÄ Spring Boot ÏîĿֹ֮ͣºó£¬ÔÚ Spring Boot Admin ÖоͿÉÒԲ鿴µ½Ò»¸öÓ¦ÓÃÒѾ­±»Í£µôÁË£¬ÈçÏÂͼËùʾ£º +当我们手动把被监控的 Spring Boot 项目å�œæ­¢ä¹‹å�Žï¼Œåœ¨ Spring Boot Admin 中就å�¯ä»¥æŸ¥çœ‹åˆ°ä¸€ä¸ªåº”用已ç»�被å�œæŽ‰äº†ï¼Œå¦‚下图所示: [![](https://s5.51cto.com/oss/202201/14/47569a3fe09e62b2364c26bdbd7da4bc.png)](https://s5.51cto.com/oss/202201/14/47569a3fe09e62b2364c26bdbd7da4bc.png) -ÎÒÃÇÒ²¿ÉÒÔͨ¹ýʼþÈÕÖ¾²é¿´ Spring Boot å´»úµÄ¾ßÌåʱ¼ä£¬ÈçÏÂͼËùʾ£º +我们也å�¯ä»¥é€šè¿‡äº‹ä»¶æ—¥å¿—查看 Spring Boot 宕机的具体时间,如下图所示: [![](https://s2.51cto.com/oss/202201/14/b63f631561fa646f85ccf3e1e4321939.png)](https://s2.51cto.com/oss/202201/14/b63f631561fa646f85ccf3e1e4321939.png) -## 5.ÅäÖò鿴¸ü¶à¼à¿ØÏî +## 5.é…�置查看更多监控项 -ͨ¹ýÉÏÃæµÄÄÚÈÝÎÒÃÇ¿ÉÒÔ¿´³ö£¬¼à¿ØµÄ Spring Boot Ñ¡ÏÊDZȽÏÉٵģ¬Ôõô²ÅÄܲ鿴¸ü¶àµÄ¼à¿ØÏîÄØ?Òª½â¾öÕâ¸öÎÊÌ⣬ÎÒÃÇÐèÒªÔÚ±»¼à¿ØµÄ Spring Boot ÏîÄ¿ÖÐÌí¼Ó spring-boot-starter-actuator ¿ò¼ÜµÄÖ§³Ö£¬²¢¿ªÆô²é¿´ËùÓÐ¼à¿ØÏîµÄÅäÖòÅÐУ¬×îÖÕչʾЧ¹ûÈçÏ£º +通过上é�¢çš„内容我们å�¯ä»¥çœ‹å‡ºï¼Œç›‘控的 Spring Boot 选项还是比较少的,怎么æ‰�能查看更多的监控项呢?è¦�解决这个问题,我们需è¦�在被监控的 Spring Boot 项目中添加 spring-boot-starter-actuator 框架的支æŒ�,并开å�¯æŸ¥çœ‹æ‰€æœ‰ç›‘控项的é…�ç½®æ‰�行,最终展示效果如下: [![](https://s4.51cto.com/oss/202201/14/03938ac0bded4487b6720fc4657f9e99.png)](https://s4.51cto.com/oss/202201/14/03938ac0bded4487b6720fc4657f9e99.png) -½ÓÏÂÀ´ÎÒÃÇÀ´ÅäÖÃÒ»ÏÂÕâЩ¼à¿ØÏî¡£ +接下æ�¥æˆ‘们æ�¥é…�置一下这些监控项。 -### 5.1 Ìí¼Óactuator¿ò¼ÜÖ§³Ö +### 5.1 添加actuator框架支æŒ� -ÔÚ±»¼à¿ØµÄ Spring Boot ÏîÄ¿ÖÐÌí¼Ó actuator ¿ò¼ÜÖ§³Ö£¬Ò²¾ÍÊÇÔÚ pom.xml ÖÐÌí¼ÓÒÔÏÂÅäÖ㺠+在被监控的 Spring Boot 项目中添加 actuator 框架支æŒ�,也就是在 pom.xml 中添加以下é…�置: - + ``` @@ -196,18 +196,18 @@ spring.boot.admin.client.url=http://localhost:9001 -ÊÖ¶¯µã»÷ Maven µ¼ÈëÒÀÀµ°ü(Èç¹û¿ªÆôÁË×Ô¶¯µ¼È룬´Ë²½Öè¿ÉºöÂÔ)¡£ +手动点击 Maven 导入ä¾�赖包(如果开å�¯äº†è‡ªåŠ¨å¯¼å…¥ï¼Œæ­¤æ­¥éª¤å�¯å¿½ç•¥)。 -### 5.2 ÅäÖÿª·ÅËùÓÐ¼à¿ØÏî +### 5.2 é…�置开放所有监控项 -ÔÚ±»¼à¿ØµÄ Spring Boot ÏîÄ¿ÖÐÌí¼ÓÒÔÏÂÅäÖ㺠+在被监控的 Spring Boot 项目中添加以下é…�置: - + ``` -# ¿ªÆô¼à¿ØËùÓÐÏî +# å¼€å�¯ç›‘控所有项 management.endpoints.web.exposure.include=* ``` @@ -216,63 +216,63 @@ management.endpoints.web.exposure.include=* -ÒÔÉϵÄÅäÖÃÊÇ¿ª·Å¼à¿ØËùÓÐÑ¡ÏÅäÖÃÍêÖ®ºó£¬ÖØÆô´Ë Spring Boot ÏîÄ¿£¬È»ºóÔÙˢРSpring Boot Admin ¸ü¶àµÄ¼à¿ØÏî¾Íչʾ³öÀ´ÁË£¬ÈçÏÂͼËùʾ£º +以上的é…�置是开放监控所有选项,é…�置完之å�Žï¼Œé‡�å�¯æ­¤ Spring Boot 项目,然å�Žå†�刷新 Spring Boot Admin 更多的监控项就展示出æ�¥äº†ï¼Œå¦‚下图所示: [![](https://s6.51cto.com/oss/202201/14/2cc24e05bc6185ba1869872db5a864a5.png)](https://s6.51cto.com/oss/202201/14/2cc24e05bc6185ba1869872db5a864a5.png) -### 5.3 ¼à¿ØÏîĿԤÀÀ +### 5.3 监控项目预览 -½« Spring Boot µÄËùÓÐ¼à¿ØÏî¶¼¿ªÆôÖ®ºó£¬Í¨¹ý SBA ¾Í¿ÉÒԲ鿴ÒÔÏÂÄÚÈÝÁË£º +å°† Spring Boot 的所有监控项都开å�¯ä¹‹å�Žï¼Œé€šè¿‡ SBA å°±å�¯ä»¥æŸ¥çœ‹ä»¥ä¸‹å†…容了: -* Æô¶¯Ê±¼ä¡¢ÀÛ¼ÆÔËÐÐʱ¼ä; -* ½ø³ÌºÍÏß³ÌÊýÁ¿ºÍÕ¼ÓÃµÄ CPU ×ÊÔ´; -* À¬»ø»ØÊÕÏêÇéÐÅÏ¢£¬»ØÊÕ´ÎÊýºÍ»¨·Ñʱ¼ä; -* JVM Ïß³Ìת´¢¡¢ÄÚ´æ×ª´¢ÏêÇéºÍ¶ÔÓ¦µÄÎļþÏÂÔØ; -* ¿ÉÒԲ鿴ºÍÅäÖà Spring Boot ÏîÄ¿ÖеÄÈÕÖ¾¼¶±ð; -* ²é¿´ Spring Boot ÏîÄ¿ÐÔÄÜ¼à¿Ø; -* ²é¿´ Spring Boot ÔËÐл·¾³ÐÅÏ¢; -* ²é¿´ Spring Boot ËùÓÐÀàÐÅÏ¢; -* ²é¿´ Spring Boot ÖеĶ¨Ê±ÈÎÎñ; -* ²é¿´ºÍ¹ÜÀí Spring Boot ÏîÄ¿ÖеÄËùÓлº´æ¡£ +* å�¯åŠ¨æ—¶é—´ã€�累计è¿�行时间; +* 进程和线程数é‡�å’Œå� ç”¨çš„ CPU 资æº�; +* 垃圾回收详情信æ�¯ï¼Œå›žæ”¶æ¬¡æ•°å’ŒèŠ±è´¹æ—¶é—´; +* JVM 线程转储ã€�内存转储详情和对应的文件下载; +* å�¯ä»¥æŸ¥çœ‹å’Œé…�ç½® Spring Boot 项目中的日志级别; +* 查看 Spring Boot 项目性能监控; +* 查看 Spring Boot è¿�行环境信æ�¯; +* 查看 Spring Boot 所有类信æ�¯; +* 查看 Spring Boot 中的定时任务; +* 查看和管ç�† Spring Boot 项目中的所有缓存。 -ÒÔÏÂÊǼ¸¸öÖØÒªÒ³ÃæµÄ½ØÍ¼£¬ÎÒÃÇÒ»ÆðÀ´¿´¡£ +以下是几个é‡�è¦�页é�¢çš„æˆªå›¾ï¼Œæˆ‘们一起æ�¥çœ‹ã€‚ -### 5.3.1 ²é¿´ÔËÐл·¾³ +### 5.3.1 查看è¿�行环境 [![](https://s5.51cto.com/oss/202201/14/a9db77b1b0e378450086edd1ab438df5.png)](https://s5.51cto.com/oss/202201/14/a9db77b1b0e378450086edd1ab438df5.png) [![](https://s2.51cto.com/oss/202201/14/17604f4f5eb388a2a6c08f55e1e050ac.png)](https://s2.51cto.com/oss/202201/14/17604f4f5eb388a2a6c08f55e1e050ac.png) -### 5.3.2 ²é¿´¶¨Ê±ÈÎÎñ +### 5.3.2 查看定时任务 [![](https://s5.51cto.com/oss/202201/14/113d94b9bd488e239967915aededc89c.png)](https://s5.51cto.com/oss/202201/14/113d94b9bd488e239967915aededc89c.png) -### 5.3.3 ÏîÄ¿ÈÕÖ¾¼¶±ðÅäÖà +### 5.3.3 项目日志级别é…�ç½® [![](https://s3.51cto.com/oss/202201/14/8da60846eecbdbd9472ae6dbf17d951f.png)](https://s3.51cto.com/oss/202201/14/8da60846eecbdbd9472ae6dbf17d951f.png) -ÎÒÃÇ¿ÉÒÔͨ¹ý Spring Boot Admin À´¶¯Ì¬µÄÅäÖÃÏîÄ¿ÖеÄÈÕÖ¾¼¶±ð¡£ +我们å�¯ä»¥é€šè¿‡ Spring Boot Admin æ�¥åЍæ€�çš„é…�置项目中的日志级别。 -### 5.3.4 JVMÏ̺߳ÍÄÚ´æ²é¿´ +### 5.3.4 JVM线程和内存查看 [![](https://s2.51cto.com/oss/202201/14/d3f98228a8b19675475c863457821034.png)](https://s2.51cto.com/oss/202201/14/d3f98228a8b19675475c863457821034.png) -### 5.3.5 ²é¿´SpringBootËùÓлº´æ +### 5.3.5 查看SpringBoot所有缓存 [![](https://s5.51cto.com/oss/202201/14/ae811102080c26b11135be50cd889710.png)](https://s5.51cto.com/oss/202201/14/ae811102080c26b11135be50cd889710.png) -µ±È»ÎÒÃÇ»¹¿ÉÒÔ¶ÔÕâЩ»º´æ½øÐÐɾ³ý²Ù×÷¡£ +当然我们还å�¯ä»¥å¯¹è¿™äº›ç¼“存进行删除æ“�作。 -## 6.²é¿´ÏîĿʵʱÈÕÖ¾ +## 6.查看项目实时日志 -ÏëÒª²é¿´¼à¿ØÏîÄ¿ÖеÄÈÕÖ¾ÐÅÏ¢£¬ÓÐÒ»¸öǰÌáÌõ¼þ£¬Ç°ÌáÌõ¼þÊÇÄã±»¼à¿ØµÄ Spring Boot ÏîÄ¿£¬±ØÐëÅäÖÃÁËÈÕÖ¾µÄ±£´æÂ·¾¶»òÕßÈÕÖ¾±£´æÎļþÃû£¬Ö»ÓÐÅäÖÃÕâÁ½ÏîÖеÄÈÎÒâÒ»ÏÄãµÄ Spring Boot ÏîÄ¿²Å»á½«ÈÕÖ¾±£´æµ½´ÅÅÌÉÏ£¬ÕâÑù²ÅÄÜͨ¹ý SBA ²é¿´µ½£¬ÎÒÅäÖõÄÊÇÈÕ־·¾¶£¬ÔÚ Spring Boot µÄ application.properties ÅäÖÃÎļþÖÐÌí¼ÓÒÔÏÂÅäÖ㺠+想è¦�查看监控项目中的日志信æ�¯ï¼Œæœ‰ä¸€ä¸ªå‰�æ��æ�¡ä»¶ï¼Œå‰�æ��æ�¡ä»¶æ˜¯ä½ è¢«ç›‘控的 Spring Boot 项目,必须é…�置了日志的ä¿�存路径或者日志ä¿�存文件å��,å�ªæœ‰é…�置这两项中的任æ„�一项,你的 Spring Boot 项目æ‰�会将日志ä¿�存到ç£�盘上,这样æ‰�能通过 SBA 查看到,我é…�置的是日志路径,在 Spring Boot çš„ application.properties é…�置文件中添加以下é…�置: - + ``` -# ÉèÖÃÈÕÖ¾±£´æÂ·¾¶ +# 设置日志ä¿�存路径 logging.file.path=C:\\work\\log ``` @@ -281,14 +281,14 @@ logging.file.path=C:\\work\\log -ÉèÖÃÍê³ÉÖ®ºó£¬ÖØÆôÄãµÄ Spring Boot ÏîÄ¿£¬È»ºóˢРSBA Ò³Ãæ£¬×îÖÕչʾЧ¹ûÈçÏ£º +设置完æˆ�之å�Žï¼Œé‡�å�¯ä½ çš„ Spring Boot 项目,然å�Žåˆ·æ–° SBA 页é�¢ï¼Œæœ€ç»ˆå±•示效果如下: [![](https://s6.51cto.com/oss/202201/14/3f03c6402cc8a2532ed45ab43be156ac.png)](https://s6.51cto.com/oss/202201/14/3f03c6402cc8a2532ed45ab43be156ac.png) -´ËʱÎÒÃǾͿÉÒԲ鿴ʵʱµÄÈÕÖ¾ÐÅÏ¢ÁË£¬µ±È»ÄãÒ²¿ÉÒÔËæÊ±ÏÂÔØÈÕÖ¾£¬Èç¹ûÐèÒªµÄ»°¡£ +此时我们就å�¯ä»¥æŸ¥çœ‹å®žæ—¶çš„æ—¥å¿—ä¿¡æ�¯äº†ï¼Œå½“然你也å�¯ä»¥éš�时下载日志,如果需è¦�çš„è¯�。 -## ×ܽá +## 总结 -Spring Boot Admin(SBA)ÊÇÒ»¸öÉçÇø¿ªÔ´ÏîÄ¿£¬ÓÃÓÚ¹ÜÀíºÍ¼àÊÓ Spring Boot Ó¦ÓóÌÐò£¬ËüÌṩÏêϸµÄ½¡¿µ (Health)ÐÅÏ¢¡¢ÄÚ´æÐÅÏ¢¡¢JVM ϵͳºÍ»·¾³ÊôÐÔ¡¢À¬»ø»ØÊÕÐÅÏ¢¡¢ÈÕÖ¾ÉèÖúͲ鿴¡¢¶¨Ê±ÈÎÎñ²é¿´¡¢Spring Boot »º´æ²é¿´ºÍ¹ÜÀíµÈ¹¦ÄÜ¡£ +Spring Boot Admin(SBA)是一个社区开æº�项目,用于管ç�†å’Œç›‘视 Spring Boot 应用程åº�,它æ��供详细的å�¥åº· (Health)ä¿¡æ�¯ã€�内存信æ�¯ã€�JVM 系统和环境属性ã€�垃圾回收信æ�¯ã€�日志设置和查看ã€�定时任务查看ã€�Spring Boot 缓存查看和管ç�†ç­‰åŠŸèƒ½ã€‚ -ÎÒÃÇÐèÒª´´½¨Ò»¸ö SBA ·þÎñÆ÷¶ËÓÃÀ´¼à¿ØÒ»¸ö»ò¶à¸ö Spring Boot ÏîÄ¿£¬±»¼à¿ØµÄ Spring Boot ÏîĿҪÌí¼Ó SBA Client ¿ò¼ÜµÄÖ§³Ö£¬ÇÒÌí¼Ó actuator ¿ò¼ÜºÍÏàÓ¦µÄÅäÖ㬾ͿÉÒÔʵÏÖ¶Ô Spring Boot ÏîÄ¿µÄÍêÃÀ¼à¿ØÁË¡£ \ No newline at end of file +我们需è¦�创建一个 SBA æœ�务器端用æ�¥ç›‘控一个或多个 Spring Boot 项目,被监控的 Spring Boot 项目è¦�添加 SBA Client 框架的支æŒ�,且添加 actuator 框架和相应的é…�置,就å�¯ä»¥å®žçް坹 Spring Boot 项目的完美监控了。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/@SpringBootApplication\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/@SpringBootApplication\346\263\250\350\247\243.md" index dd72d1f..85a9f61 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/@SpringBootApplication\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/@SpringBootApplication\346\263\250\350\247\243.md" @@ -1,6 +1,6 @@ -springboot ÔÚÆô¶¯ÀàÉÏ»á±ê×¢Ò»¸ö×¢½â£º`@SpringBootApplication`£¬±¾È˽«´ÓÔ´Âë½âÎö·ÖÎöÕâ ¸ö×¢½âµÄ×÷Óᣠ+springboot 在å�¯åŠ¨ç±»ä¸Šä¼šæ ‡æ³¨ä¸€ä¸ªæ³¨è§£ï¼š`@SpringBootApplication`,本人将从æº�ç �è§£æž�分æž�è¿™ 个注解的作用。 -`@SpringBootApplication` ´úÂëÈçÏ£º +`@SpringBootApplication` 代ç �如下: ``` @Target(ElementType.TYPE) @@ -15,31 +15,31 @@ springboot public @interface SpringBootApplication { /** - * ×Ô¶¯×°ÅäÒªÅųýµÄÀ࣬¹¦ÄÜÀ´×ÔÓÚ @EnableAutoConfiguration + * 自动装é…�è¦�排除的类,功能æ�¥è‡ªäºŽ @EnableAutoConfiguration */ @AliasFor(annotation = EnableAutoConfiguration.class) Class[] exclude() default {}; /** - * ×Ô¶¯×°ÅäÒªÅųýµÄÀàÃû£¬¹¦ÄÜÀ´×ÔÓÚ @EnableAutoConfiguration + * 自动装é…�è¦�排除的类å��,功能æ�¥è‡ªäºŽ @EnableAutoConfiguration */ @AliasFor(annotation = EnableAutoConfiguration.class) String[] excludeName() default {}; /** - * ÅäÖÃɨÃèµÄ°ü£¬¹¦ÄÜÀ´×ÔÓÚ @ComponentScan + * é…�置扫æ��的包,功能æ�¥è‡ªäºŽ @ComponentScan */ @AliasFor(annotation = ComponentScan.class, attribute = "basePackages") String[] scanBasePackages() default {}; /** - * ÅäÖÃɨÃèµÄclass£¬¸ÃclassËùÔڵİü¶¼»á±»É¨Ã裬¹¦ÄÜÀ´×ÔÓÚ @ComponentScan + * é…�置扫æ��çš„class,该class所在的包都会被扫æ��,功能æ�¥è‡ªäºŽ @ComponentScan */ @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses") Class[] scanBasePackageClasses() default {}; /** - * ÊÇ·ñÆôÓà @Bean ·½·¨´úÀí£¬¹¦ÄÜÀ´×ÔÓÚ @Configuration + * 是å�¦å�¯ç”¨ @Bean 方法代ç�†ï¼ŒåŠŸèƒ½æ�¥è‡ªäºŽ @Configuration */ @AliasFor(annotation = Configuration.class) boolean proxyBeanMethods() default true; @@ -48,14 +48,14 @@ public @interface SpringBootApplication { ``` -1. `@SpringBootApplication` ÊÇÒ»¸ö×éºÏ×¢½â£¬°üº¬ÁË `@SpringBootConfiguration`¡¢`@EnableAutoConfiguration`¡¢`@ComponentScan` Èý¸ö×¢½âµÄ¹¦ÄÜ£» -2. `@SpringBootApplication` ÖÐÒ²ÌṩÁËһЩÅäÖÃÊôÐÔ£¬¶øÕâЩÊôÐÔÀ´×ÔÓÚÒÔÉÏÈý¸ö×¢½â¡£ +1. `@SpringBootApplication` 是一个组å�ˆæ³¨è§£ï¼ŒåŒ…å�«äº† `@SpringBootConfiguration`ã€�`@EnableAutoConfiguration`ã€�`@ComponentScan` 三个注解的功能; +2. `@SpringBootApplication` 中也æ��供了一些é…�置属性,而这些属性æ�¥è‡ªäºŽä»¥ä¸Šä¸‰ä¸ªæ³¨è§£ã€‚ -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ÕâÈý¸ö×¢½âµÄ×÷Ó÷ֱðÊÇʲô¡£ +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹è¿™ä¸‰ä¸ªæ³¨è§£çš„作用分别是什么。 ### 1. `@SpringBootConfiguration` -½øÈë `@SpringBootConfiguration`£¬´úÂëÈçÏ£º +进入 `@SpringBootConfiguration`,代ç �如下: ``` @Target(ElementType.TYPE) @@ -71,34 +71,34 @@ public @interface SpringBootConfiguration { ``` -Õâ¸ö×¢½â±È½Ï¼òµ¥£¬ÉÏÃæ±ê¼ÇÁË `@Configuration`£¬È»ºóÊÇÒ»¸öÊôÐÔ `proxyBeanMethods()`£¬ËüÀ´×ÔÓÚ `@Configuration`¡£Òò´Ë£¬`@SpringBootConfiguration` ²¢Ã»ÓÐ×öʲô£¬½ö½öÖ»Êǽ« `@Configuration` ʹÓÃÁË `@Configuration` µÄ¹¦ÄÜ¡£ +这个注解比较简å�•,上é�¢æ ‡è®°äº† `@Configuration`,然å�Žæ˜¯ä¸€ä¸ªå±žæ€§ `proxyBeanMethods()`,它æ�¥è‡ªäºŽ `@Configuration`。因此,`@SpringBootConfiguration` 并没有å�šä»€ä¹ˆï¼Œä»…ä»…å�ªæ˜¯å°† `@Configuration` 使用了 `@Configuration` 的功能。 -¹ØÓÚ `@Configuration`£¬ËüÀ´×ÔÓÚ spring£¬Äܱ» spring ʶ±ðΪ `Component`£¬ÇÒ `proxyBeanMethods != false` ʱ£¬»á±» spring ±ê¼ÇΪ `Full` ÅäÖÃÀ࣬ÔÚºóÐø¶ÔÆäÖÐµÄ `@Bean` ·½·¨´¦Àíʱ£¬»á½øÐÐ cglib ´úÀí£¬¹ØÓÚÕâ·½ÃæµÄÄÚÈÝ£¬¿É²Î¿¼ [ConfigurationClassPostProcessor£¨¶þ£©£º´¦Àí @Bean ×¢½â](https://my.oschina.net/funcy/blog/4492878). +关于 `@Configuration`,它æ�¥è‡ªäºŽ spring,能被 spring 识别为 `Component`,且 `proxyBeanMethods != false` 时,会被 spring 标记为 `Full` é…�置类,在å�Žç»­å¯¹å…¶ä¸­çš„ `@Bean` 方法处ç�†æ—¶ï¼Œä¼šè¿›è¡Œ cglib 代ç�†ï¼Œå…³äºŽè¿™æ–¹é�¢çš„内容,å�¯å�‚考 [ConfigurationClassPostProcessor(二):处ç�† @Bean 注解](https://my.oschina.net/funcy/blog/4492878). ### 2. `@EnableAutoConfiguration` -`@EnableAutoConfiguration` Ö÷Òª ÓÃÀ´¿ªÆô×Ô¶¯×°Å书ÄÜ£¬´úÂëÈçÏ£º +`@EnableAutoConfiguration` 主è¦� 用æ�¥å¼€å�¯è‡ªåŠ¨è£…é…�功能,代ç �如下: ``` @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited -// ×Ô¶¯×°ÅäµÄ°ü +// 自动装é…�的包 @AutoConfigurationPackage -// ÒýÈëµÄ×Ô¶¯×°ÅäÀà +// 引入的自动装é…�ç±» @Import(AutoConfigurationImportSelector.class) public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; /** - * ¿É×ÔÐж¨ÒåÅųý×Ô¶¯×°ÅäµÄÀà + * å�¯è‡ªè¡Œå®šä¹‰æŽ’除自动装é…�的类 */ Class[] exclude() default {}; /** - * ¿É×ÔÐж¨ÒåÅųý×Ô¶¯×°ÅäµÄÀàÃû + * å�¯è‡ªè¡Œå®šä¹‰æŽ’除自动装é…�的类å�� */ String[] excludeName() default {}; @@ -106,17 +106,17 @@ public @interface EnableAutoConfiguration { ``` -´Ó´úÂëÖпÉÒÔ¿´µ½£¬ +从代ç �中å�¯ä»¥çœ‹åˆ°ï¼Œ -1. ¸Ã×¢½â×éºÏÁË `@AutoConfigurationPackage` ×¢½âµÄ¹¦ÄÜ£¬¸Ã×¢½âÓÃÀ´Ö¸¶¨×Ô¶¯×°ÅäµÄ°ü£» -2. ¸Ã×¢½âͨ¹ý `@Import` ×¢½âÒýÈëÁËÒ»¸öÀà `AutoConfigurationImportSelector`£¬Õâ¸öÀàÊÇ×Ô¶¯×°ÅäµÄ¹Ø¼ü£» -3. ¸Ã×¢½âÌṩÁËÁ½¸öÅäÖã¬ÓÃÀ´ÅųýÖ¸¶¨µÄ×Ô¶¯×°ÅäÀ࣬¿ÉÒÔ¸ù¾ÝÀàÀ´Åųý (`Class` ¶ÔÏó)£¬Ò²¿ÉÒÔ¸ù¾ÝÀàÃû (`°üÃû.ÀàÃû`) Åųý¡£ +1. 该注解组å�ˆäº† `@AutoConfigurationPackage` 注解的功能,该注解用æ�¥æŒ‡å®šè‡ªåŠ¨è£…é…�的包; +2. 该注解通过 `@Import` 注解引入了一个类 `AutoConfigurationImportSelector`,这个类是自动装é…�的关键; +3. 该注解æ��供了两个é…�置,用æ�¥æŽ’除指定的自动装é…�类,å�¯ä»¥æ ¹æ�®ç±»æ�¥æŽ’除 (`Class` 对象),也å�¯ä»¥æ ¹æ�®ç±»å�� (`包å��.ç±»å��`) 排除。 -½ÓÏÂÀ´ÎÒÃÇÀ´¹Ø×¢ `@AutoConfigurationPackage` ¼°ÒýÈëµÄ `AutoConfigurationImportSelector`¡£ +接下æ�¥æˆ‘们æ�¥å…³æ³¨ `@AutoConfigurationPackage` å�Šå¼•入的 `AutoConfigurationImportSelector`。 #### 2.1 `@AutoConfigurationPackage` -`@AutoConfigurationPackage` Ö¸¶¨ÁË×Ô¶¯×°ÅäµÄ°ü£¬´úÂëÈçÏ£º +`@AutoConfigurationPackage` 指定了自动装é…�的包,代ç �如下: ``` @Target(ElementType.TYPE) @@ -130,7 +130,7 @@ public @interface AutoConfigurationPackage { ``` -Õâ¸ö×¢½âµÄÄÚÈݷdz£¼òµ¥£¬½öʹÓà `@Import` ×¢½âÒýÈëÁË `AutoConfigurationPackages.Registrar`£¬ÎÒÃÇÀ´¿´ÏÂËüµÄÄÚÈÝ£º +这个注解的内容é�žå¸¸ç®€å�•,仅使用 `@Import` 注解引入了 `AutoConfigurationPackages.Registrar`,我们æ�¥çœ‹ä¸‹å®ƒçš„内容: ``` public abstract class AutoConfigurationPackages { @@ -140,7 +140,7 @@ public abstract class AutoConfigurationPackages { static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports { /** - * ¸ù¾Ý ImportBeanDefinitionRegistrar µÄ´¦Àí£¬spring½«µ÷Óà registerBeanDefinitions() ×¢²áÄÚÈÝ + * æ ¹æ�® ImportBeanDefinitionRegistrar 的处ç�†ï¼Œspring将调用 registerBeanDefinitions() 注册内容 */ @Override public void registerBeanDefinitions(AnnotationMetadata metadata, @@ -156,26 +156,26 @@ public abstract class AutoConfigurationPackages { } /** - * ´¦Àí¾ßÌåµÄ×¢²á²Ù×÷ - * 1\. Èç¹û beanFacotry Öаüº¬ BEAN£¬Ôò½«´«ÈëµÄ°üÃûÌí¼Óµ½ BEAN ¶ÔÓ¦µÄ BeanDefinition µÄ¹¹Ôì·½·¨²ÎÊýÖµÉÏ£» - * 2\. Èç¹û beanFacotry Öв»°üº¬ BEAN£¬Ôò´´½¨ beanDefinition£¬ÉèÖòÎÊýÖµ£¬È»ºó½«Æä×¢²áµ½ beanFacotry¡£ - * ×¢²áµ½beanFacotryÖеÄbeanΪBasePackages + * 处ç�†å…·ä½“的注册æ“�作 + * 1\. 如果 beanFacotry 中包å�« BEAN,则将传入的包å��添加到 BEAN 对应的 BeanDefinition 的构造方法å�‚数值上; + * 2\. 如果 beanFacotry 中ä¸�包å�« BEAN,则创建 beanDefinition,设置å�‚数值,然å�Žå°†å…¶æ³¨å†Œåˆ° beanFacotry。 + * 注册到beanFacotry中的bean为BasePackages */ public static void register(BeanDefinitionRegistry registry, String... packageNames) { if (registry.containsBeanDefinition(BEAN)) { BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN); - // bean ÊÇ BasePackages£¬¹¹Ôì·½·¨ÊÇ BasePackages(String... names)£¬ÕâÀï»ñȡԭ±¾µÄ¹¹Ôì²ÎÊýµÄÖµ + // bean 是 BasePackages,构造方法是 BasePackages(String... names),这里获å�–原本的构造å�‚数的值 ConstructorArgumentValues constructorArguments = beanDefinition.getConstructorArgumentValues(); - // ½«Ô­±¾µÄ¹¹Ôì²ÎÊýÖµ£¬ÒÔ¼°´«ÈëµÄ packageNames ͳһÌí¼Óµ½¹¹Ôì·½·¨µÄµÚ0¸ö²ÎÊýÖµÉÏ + // 将原本的构造å�‚数值,以å�Šä¼ å…¥çš„ packageNames 统一添加到构造方法的第0个å�‚数值上 constructorArguments.addIndexedArgumentValue(0, addBasePackages(constructorArguments, packageNames)); } else { GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); - // ÉèÖÃBeanClassΪBasePackages.class + // 设置BeanClass为BasePackages.class beanDefinition.setBeanClass(BasePackages.class); - // ÉèÖù¹Ôì·½·¨µÄ²ÎÊýÖµ + // 设置构造方法的å�‚数值 beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames); beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE); registry.registerBeanDefinition(BEAN, beanDefinition); @@ -183,15 +183,15 @@ public abstract class AutoConfigurationPackages { } /** - * packageName µÄ°ü×°Àà - * packageName ÊÇ´«ÈëÀàËùÔڵİüÃû£¬ÔÚPackageImportµÄ¹¹Ôì·½·¨ÖлñÈ¡ + * packageName 的包装类 + * packageName 是传入类所在的包å��,在PackageImport的构造方法中获å�– */ private static final class PackageImport { private final String packageName; PackageImport(AnnotationMetadata metadata) { - // »ñÈ¡´«ÈëÀàËùÔÚ°üÃû + // 获å�–传入类所在包å�� this.packageName = ClassUtils.getPackageName(metadata.getClassName()); } @@ -199,17 +199,17 @@ public abstract class AutoConfigurationPackages { return this.packageName; } - // Ê¡ÂÔ equals/toString/hashCode ·½·¨ + // çœ�ç•¥ equals/toString/hashCode 方法 ... } /** - * ×¢½âµ½ beanFactory ÖеÄÀà - * ¸ÃÀàÖÐÓÐÒ»¸öList½á¹¹£¬ÓÃÀ´±£´æ°üɨÃè·¾¶ + * 注解到 beanFactory 中的类 + * 该类中有一个List结构,用æ�¥ä¿�存包扫æ��路径 */ static final class BasePackages { - // °üɨÃè·¾¶ÔÚÕâÀï±£´æ + // 包扫æ��路径在这里ä¿�å­˜ private final List packages; private boolean loggedBasePackageInfo; @@ -224,7 +224,7 @@ public abstract class AutoConfigurationPackages { this.packages = packages; } - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... } @@ -232,14 +232,14 @@ public abstract class AutoConfigurationPackages { ``` -´úÂëÓе㳤£¬µ«Âß¼­²¢²»¸´ÔÓ£¬Á÷³ÌÈçÏ£º +代ç �有点长,但逻辑并ä¸�å¤�æ�‚,æµ�程如下: -1. `AutoConfigurationPackages.Registrar` ʵÏÖÁË `ImportBeanDefinitionRegistrar`£¬`registerBeanDefinitions(...)` ·½·¨Ïò spring ÖÐ×¢²áÁË `BasePackages`£¬×¢²áÂß¼­ÔÚ `AutoConfigurationPackages#register` ·½·¨ÖУ» -2. `AutoConfigurationPackages#register` ·½·¨µÄ×¢²áÂß¼­Îª£¬ÏÈÅжÏÊÇ·ñÒÑ×¢²áÁË `BasePackages`£¬Èç¹û×¢²áÁË£¬¾Í½«µ±Ç°ÀàËùÔڵİüÌí¼Óµ½ `BasePackages` µÄ¹¹Ôì·½·¨²ÎÊýÖµÖУ¬·ñÔò¾Í´´½¨ `BeanDefinition`£¬ÉèÖù¹Ôì·½·¨µÄ²ÎÊýÖµ£¬È»ºó×¢²áµ½ spring ÖУ» +1. `AutoConfigurationPackages.Registrar` 实现了 `ImportBeanDefinitionRegistrar`,`registerBeanDefinitions(...)` 方法å�‘ spring 中注册了 `BasePackages`,注册逻辑在 `AutoConfigurationPackages#register` 方法中; +2. `AutoConfigurationPackages#register` 方法的注册逻辑为,先判断是å�¦å·²æ³¨å†Œäº† `BasePackages`,如果注册了,就将当å‰�类所在的包添加到 `BasePackages` 的构造方法å�‚数值中,å�¦åˆ™å°±åˆ›å»º `BeanDefinition`,设置构造方法的å�‚数值,然å�Žæ³¨å†Œåˆ° spring 中; #### 2.2 `AutoConfigurationImportSelector` -`AutoConfigurationImportSelector` ÊÇ´¦Àí×Ô¶¯ÅäÖõĹؼü£¬´úÂëÈçÏ£º +`AutoConfigurationImportSelector` 是处ç�†è‡ªåЍé…�置的关键,代ç �如下: ``` public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware, @@ -250,23 +250,23 @@ public class AutoConfigurationImportSelector implements DeferredImportSelector, ``` -`AutoConfigurationImportSelector` ʵÏÖÁË `DeferredImportSelector`£¬ÕâÊÇÒ»¸ö `ImportSelector` À࣬µ«´¦ÀíµÄÓÅÏȼ¶×îµÍ (ÔÚ `@ComponentScan`¡¢`@Component`¡¢`@Bean`¡¢`@Configuration` ¼°ÆäËû `@Import` ×¢½â´¦ÀíÍêÖ®ºóÔÙ´¦Àí)£¬ÔÚ `AutoConfigurationImportSelector` ÀàÖлᴦÀí×Ô¶¯ÅäÖÃÀàµÄ¼ÓÔØÁ÷³Ì£¬ÕýÊÇͨ¹ýÕâÖÖ·½Ê½£¬½«×Ô¶¯ÅäÖÃÀàÒýÈëÁË spring ÈÝÆ÷ÖС£ +`AutoConfigurationImportSelector` 实现了 `DeferredImportSelector`,这是一个 `ImportSelector` 类,但处ç�†çš„优先级最低 (在 `@ComponentScan`ã€�`@Component`ã€�`@Bean`ã€�`@Configuration` å�Šå…¶ä»– `@Import` 注解处ç�†å®Œä¹‹å�Žå†�处ç�†),在 `AutoConfigurationImportSelector` 类中会处ç�†è‡ªåЍé…�置类的加载æµ�程,正是通过这ç§�æ–¹å¼�,将自动é…�置类引入了 spring 容器中。 -¹ØÓÚ spring ¶Ô `@Import` µÄ´¦Àí£¬¿ÉÒԲο¼ [ConfigurationClassPostProcessor Ö®´¦Àí @Import ×¢½â](https://my.oschina.net/funcy/blog/4678152). +关于 spring 对 `@Import` 的处ç�†ï¼Œå�¯ä»¥å�‚考 [ConfigurationClassPostProcessor 之处ç�† @Import 注解](https://my.oschina.net/funcy/blog/4678152). -¹ØÓÚ `AutoConfigurationImportSelector` »ñÈ¡×Ô¶¯ÅäÖÃÀàµÄÁ÷³Ì£¬½«ÔÚºóÃæµÄÎÄÕÂÖоßÌå·ÖÎö£¬±¾ÎľͲ»Õ¹¿ªÁË¡£ +关于 `AutoConfigurationImportSelector` 获å�–自动é…�置类的æµ�程,将在å�Žé�¢çš„æ–‡ç« ä¸­å…·ä½“分æž�,本文就ä¸�展开了。 ### 3. `@ComponentScan` -Õâ¸ö×¢½âÏë±Ø´ó¼ÒÒѾ­ºÜÊìϤÁË£¬ËüÖ¸¶¨Á˰üɨÃè·¾¶£¬Èç¹û²»Ö¸¶¨£¬¾ÍɨÃèËùÔÚÀàµÄ°ü£¬¹ØÓÚÕâЩ£¬ÔÚ [ConfigurationClassPostProcessor Ö®´¦Àí @ComponentScan ×¢½â](https://my.oschina.net/funcy/blog/4836178)Ò»ÎÄÖÐÒѾ­Ïêϸ·ÖÎö¹ýÁË£¬¾Í²»ÔÙ·ÖÎöÁË¡£ +这个注解想必大家已ç»�很熟悉了,它指定了包扫æ��路径,如果ä¸�指定,就扫æ��所在类的包,关于这些,在 [ConfigurationClassPostProcessor 之处ç�† @ComponentScan 注解](https://my.oschina.net/funcy/blog/4836178)一文中已ç»�详细分æž�过了,就ä¸�å†�分æž�了。 -±¾ÎÄÎÒÃÇÀ´·ÖÎöÕâ¸ö×¢½âÊôÐÔÖÐʹÓÃµÄ 2 ¸öÀࣺ +本文我们æ�¥åˆ†æž�这个注解属性中使用的 2 个类: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-19d14d3d8262eead434d5ca09369e1789d5.png) #### 3.1 `TypeExcludeFilter` -Õâ¸öÀà±íʾÔÚ½øÐаüɨÃèʱ£¬¿ÉÒÔÅųýһЩÀ࣬´úÂëÈçÏ£º +这个类表示在进行包扫æ��时,å�¯ä»¥æŽ’除一些类,代ç �如下: ``` public class TypeExcludeFilter implements TypeFilter, BeanFactoryAware { @@ -285,8 +285,8 @@ public class TypeExcludeFilter implements TypeFilter, BeanFactoryAware { MetadataReaderFactory metadataReaderFactory) throws IOException { if (this.beanFactory instanceof ListableBeanFactory && getClass() == TypeExcludeFilter.class) { - // getDelegates() »ñÈ¡µ±Ç°ÈÝÆ÷ÖÐËùÓÐµÄ TypeExcludeFilter ʵÀý - // ¿ÉÒÔ×ÔÖ÷¼Ì³Ð TypeExcludeFilter£¬×Ô¶¨Ò寥Å乿Ôò + // getDelegates() 获å�–当å‰�容器中所有的 TypeExcludeFilter 实例 + // å�¯ä»¥è‡ªä¸»ç»§æ‰¿ TypeExcludeFilter,自定义匹é…�规则 for (TypeExcludeFilter delegate : getDelegates()) { if (delegate.match(metadataReader, metadataReaderFactory)) { return true; @@ -310,11 +310,11 @@ public class TypeExcludeFilter implements TypeFilter, BeanFactoryAware { ``` -´Ó´úÂëÉÏÀ´¿´£¬Èç¹ûÒªÅųýһЩ À࣬ÎÒÃÇ¿ÉÒÔ×ÔÖ÷¼Ì³Ð `TypeExcludeFilter` À࣬ȻºóÖØÐ´ `match(...)` ·½·¨£¬ÔÚÆäÖж¨Ò寥ÅäÂß¼­¡£ +从代ç �上æ�¥çœ‹ï¼Œå¦‚æžœè¦�排除一些 类,我们å�¯ä»¥è‡ªä¸»ç»§æ‰¿ `TypeExcludeFilter` 类,然å�Žé‡�写 `match(...)` 方法,在其中定义匹é…�逻辑。 #### 3.1 `AutoConfigurationExcludeFilter` -`AutoConfigurationExcludeFilter` ÓÃÀ´Åųý×Ô¶¯ÅäÖÃÀ࣬Ҳ¾ÍÊÇ˵£¬spring ÔÚ½øÐаüɨÃèʱ£¬²»»áɨÃè×Ô¶¯ÅäÖÃÀ࣬´úÂëÈçÏ£º +`AutoConfigurationExcludeFilter` 用æ�¥æŽ’除自动é…�置类,也就是说,spring 在进行包扫æ��时,ä¸�会扫æ��自动é…�置类,代ç �如下: ``` public class AutoConfigurationExcludeFilter implements TypeFilter, BeanClassLoaderAware { @@ -331,8 +331,8 @@ public class AutoConfigurationExcludeFilter implements TypeFilter, BeanClassLoad @Override public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException { - // isConfiguration(...)£ºµ±Ç°ÀàÊÇ·ñ±» @Configuration ±ê¼Ç - // isAutoConfiguration(...)£ºµ±Ç°ÀàÊÇ·ñΪ×Ô¶¯ÅäÖÃÀà + // isConfiguration(...):当å‰�类是å�¦è¢« @Configuration 标记 + // isAutoConfiguration(...):当å‰�类是å�¦ä¸ºè‡ªåЍé…�置类 return isConfiguration(metadataReader) && isAutoConfiguration(metadataReader); } @@ -341,7 +341,7 @@ public class AutoConfigurationExcludeFilter implements TypeFilter, BeanClassLoad } private boolean isAutoConfiguration(MetadataReader metadataReader) { - // »ñÈ¡ËùÓеÄ×Ô¶¯ÅäÖÃÀ࣬ȻºóÅжϵ±Ç°ÀàÊÇ·ñ´æÔÚÓÚÆäÖÐ + // 获å�–所有的自动é…�置类,然å�Žåˆ¤æ–­å½“å‰�类是å�¦å­˜åœ¨äºŽå…¶ä¸­ return getAutoConfigurations().contains(metadataReader.getClassMetadata().getClassName()); } @@ -357,26 +357,26 @@ public class AutoConfigurationExcludeFilter implements TypeFilter, BeanClassLoad ``` -ÎÒÃÇÖ÷Òª¿´ `match(...)` ·½·¨£¬ËüµÄÆ¥ÅäµÄÀàΪ£º +我们主è¦�看 `match(...)` 方法,它的匹é…�的类为: -1. ±» `@Configuration` ±ê¼Ç£» -2. ÊÇ×Ô¶¯ÅäÖÃÀà¡£ +1. 被 `@Configuration` 标记; +2. 是自动é…�置类。 -Âú×ãÒÔÉÏÁ½¸öÌõ¼þ£¬spring ¾Í²»»á¶ÔÆä½øÐÐɨÃè´¦Àí¡£ +满足以上两个æ�¡ä»¶ï¼Œspring å°±ä¸�会对其进行扫æ��处ç�†ã€‚ -ÄÇʲôÊÇ×Ô¶¯ÅäÖÃÀàÄØ£¿´Ó `isAutoConfiguration(...)` ¿ÉÒÔ¿´µ½£¬ÔÚÅжÏÊÇ·ñΪ×Ô¶¯ÅäÖÃÀàÉÏ£¬springboot ÏÈʹÓà `SpringFactoriesLoader` ¼ÓÔØËùÓÐÅäÖÃÀ࣬ȻºóÔÙÅжϴ«ÈëµÄÀàÊÇ·ñΪÆäÖÐÖ®Ò»¡£´ÓÕâÀï¿ÉÒÔ¿´³ö£¬×Ô¶¯ÅäÖÃÀಢ²»½øÐаüɨÃè²Ù×÷¡£ +那什么是自动é…�置类呢?从 `isAutoConfiguration(...)` å�¯ä»¥çœ‹åˆ°ï¼Œåœ¨åˆ¤æ–­æ˜¯å�¦ä¸ºè‡ªåЍé…�置类上,springboot 先使用 `SpringFactoriesLoader` 加载所有é…�置类,然å�Žå†�判断传入的类是å�¦ä¸ºå…¶ä¸­ä¹‹ä¸€ã€‚从这里å�¯ä»¥çœ‹å‡ºï¼Œè‡ªåЍé…�置类并ä¸�进行包扫æ��æ“�作。 -¹ØÓÚ `SpringFactoriesLoader` ÈçºÎ¼ÓÔØÅäÖÃÀ࣬ºóÃæµÄÎÄÕ»áÏêϸ·ÖÎö¡£ +关于 `SpringFactoriesLoader` 如何加载é…�置类,å�Žé�¢çš„æ–‡ç« ä¼šè¯¦ç»†åˆ†æž�。 -### 4\. ×ܽá +### 4\. 总结 -±¾ÎÄÖ÷Òª·ÖÎö `@SpringBootApplication` µÄ¹¦ÄÜ£¬×ܽáÈçÏ£º +本文主è¦�分æž� `@SpringBootApplication` 的功能,总结如下: -1. `@SpringBootApplication` ÊÇÒ»¸ö×éºÏ×¢½â£¬°üº¬ÁË `@SpringBootConfiguration`¡¢`@EnableAutoConfiguration`¡¢`@ComponentScan` Èý¸ö×¢½âµÄ¹¦ÄÜ£¬Í¬Ê±ÌṩÁËһЩÊôÐÔÅäÖã¬Ò²ÊÇÀ´×ÔÓÚÒÔÉÏ 3 ¸ö×¢½â£» -2. `@SpringBootConfiguration` °üº¬ÁË `Configuration` ×¢½âµÄ¹¦ÄÜ£» -3. `@EnableAutoConfiguration` ÊÇ¿ªÆô×Ô¶¯×°ÅäµÄ¹Ø¼ü×¢½â£¬ÆäÖбê¼ÇÁË `@AutoConfigurationPackage`£¬»á½«±» `@SpringBootApplication` ±ê¼ÇµÄÀàËùÔڵİü£¬°ü×°³É `BasePackages`£¬È»ºó×¢²áµ½ spring ÈÝÆ÷ÖУ»`@EnableAutoConfiguration` »¹Í¨¹ý `@Import` ×¢½âÏòÈÝÆ÷ÖÐÒýÈëÁË `AutoConfigurationImportSelector`£¬¸ÃÀà»á½«µ±Ç°ÏîĿ֧³ÖµÄ×Ô¶¯ÅäÖÃÀàÌí¼Óµ½ spring ÈÝÆ÷ÖУ» -4. `@ComponentScan` ¶¨ÒåÁ˰üɨÃè·¾¶£¬Æä `excludeFilters` Öµ¿ÉÒÔÓÃÀ´ÅųýÀàµÄɨÃ裬springboot Ö¸¶¨ÁË `TypeExcludeFilter`£¬±íÃ÷ÎÒÃÇ¿ÉÒԼ̳иÃÀàÀ´×ÔÖ÷¶¨ÒåÅųýµÄÀà £»Í¬Ê±Ò²Ö¸¶¨ÁË `AutoConfigurationExcludeFilter` £¬¸Ã `Filter` ¿ÉÒÔÓÃÀ´Åųý×Ô¶¯ÅäÖÃÀ࣬Ҳ¾ÍÊÇ˵£¬×Ô¶¯ÅäÖÃÀ಻»á½øÐаüÃèÊö²Ù×÷¡£ +1. `@SpringBootApplication` 是一个组å�ˆæ³¨è§£ï¼ŒåŒ…å�«äº† `@SpringBootConfiguration`ã€�`@EnableAutoConfiguration`ã€�`@ComponentScan` 三个注解的功能,å�Œæ—¶æ��供了一些属性é…�置,也是æ�¥è‡ªäºŽä»¥ä¸Š 3 个注解; +2. `@SpringBootConfiguration` 包å�«äº† `Configuration` 注解的功能; +3. `@EnableAutoConfiguration` 是开å�¯è‡ªåŠ¨è£…é…�的关键注解,其中标记了 `@AutoConfigurationPackage`,会将被 `@SpringBootApplication` 标记的类所在的包,包装æˆ� `BasePackages`,然å�Žæ³¨å†Œåˆ° spring 容器中;`@EnableAutoConfiguration` 还通过 `@Import` 注解å�‘容器中引入了 `AutoConfigurationImportSelector`,该类会将当å‰�项目支æŒ�的自动é…�置类添加到 spring 容器中; +4. `@ComponentScan` 定义了包扫æ��路径,其 `excludeFilters` 值å�¯ä»¥ç”¨æ�¥æŽ’除类的扫æ��,springboot 指定了 `TypeExcludeFilter`,表明我们å�¯ä»¥ç»§æ‰¿è¯¥ç±»æ�¥è‡ªä¸»å®šä¹‰æŽ’除的类 ï¼›å�Œæ—¶ä¹ŸæŒ‡å®šäº† `AutoConfigurationExcludeFilter` ,该 `Filter` å�¯ä»¥ç”¨æ�¥æŽ’除自动é…�置类,也就是说,自动é…�置类ä¸�会进行包æ��è¿°æ“�作。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4870882](https://my.oschina.net/funcy/blog/4870882) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4870882](https://my.oschina.net/funcy/blog/4870882) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\270\200\357\274\211\357\274\232servlet\347\273\204\344\273\266\347\232\204\346\263\250\345\206\214\346\265\201\347\250\213.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\270\200\357\274\211\357\274\232servlet\347\273\204\344\273\266\347\232\204\346\263\250\345\206\214\346\265\201\347\250\213.md" index 052d637..d055ea1 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\270\200\357\274\211\357\274\232servlet\347\273\204\344\273\266\347\232\204\346\263\250\345\206\214\346\265\201\347\250\213.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\270\200\357\274\211\357\274\232servlet\347\273\204\344\273\266\347\232\204\346\263\250\345\206\214\346\265\201\347\250\213.md" @@ -1,32 +1,32 @@ -ÔÚ springboot ÖУ¬Èç¹ûÎÒÃÇÐèҪע²á servlet Èý´ó×é¼þ£º`servlet`¡¢`filter`¡¢`listener`£¬¸ÃÔõô×öÄØ£¬springboot ÌùÐĵØÎªÎÒÃÇÌṩÁË 3 ÖÖ·½·¨£¬±¾ÎľÍÀ´·ÖÎöÕâ 3 ÖÖ·½·¨µÄÔ´ÂëʵÏÖ¡£ +在 springboot 中,如果我们需è¦�注册 servlet 三大组件:`servlet`ã€�`filter`ã€�`listener`,该怎么å�šå‘¢ï¼Œspringboot 贴心地为我们æ��供了 3 ç§�方法,本文就æ�¥åˆ†æž�è¿™ 3 ç§�方法的æº�ç �实现。 -### 1\. ×¢²á·½Ê½ +### 1\. 注册方å¼� -#### 1.1 ʹÓà `XxxRegistrationBean` ×¢²á +#### 1.1 使用 `XxxRegistrationBean` 注册 -springboot ÌṩÁËÈý¸öÀàÐ굀 `RegistrationBean` À´´¦Àí servlet Èý´ó×é¼þµÄ×¢²á£¬·Ö±ðÊÇ `ServletRegistrationBean`¡¢`FilterRegistrationBean`¡¢`ServletListenerRegistrationBean`£¬ÕâÀïÎÒÃǼòµ¥Ê¾ÒâÏÂËüÃǵÄÓ÷¨£º +springboot æ��供了三个类型的 `RegistrationBean` æ�¥å¤„ç�† servlet 三大组件的注册,分别是 `ServletRegistrationBean`ã€�`FilterRegistrationBean`ã€�`ServletListenerRegistrationBean`,这里我们简å�•示æ„�下它们的用法: ``` /** - * ×¼±¸ÁËÒ»¸öservlet + * 准备了一个servlet */ public class MyServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException { - // ´¦ÀíһЩ²Ù×÷ + // 处ç�†ä¸€äº›æ“�作 ... } } /** - * ½øÐÐ×¢²á²Ù×÷ + * 进行注册æ“�作 */ @Bean public ServletRegistrationBean registerServlet() { ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean( new MyServlet(), "/myServlet"); - // ´¦ÀíһЩÅäÖòÙ×÷ + // 处ç�†ä¸€äº›é…�ç½®æ“�作 servletRegistrationBean.setXxx(); ... return servletRegistrationBean; @@ -34,17 +34,17 @@ public ServletRegistrationBean registerServlet() { ``` -ÒÔÉÏÌṩÁË `servlet` µÄ×¢²á·½Ê½£¬Òª×¢²á `filter`¡¢`listener`£¬Ö»ÐèʹÓöÔÓ¦µÄ `RegistrationBean` ¼´¿É£¬ÕâÀï¾Í²»Õ¹Ê¾ÁË¡£ +以上æ��供了 `servlet` 的注册方å¼�,è¦�注册 `filter`ã€�`listener`,å�ªéœ€ä½¿ç”¨å¯¹åº”çš„ `RegistrationBean` å�³å�¯ï¼Œè¿™é‡Œå°±ä¸�展示了。 -#### 1.2 ʹÓà servlet ×¢½â×¢²á +#### 1.2 使用 servlet 注解注册 -ÔÚ `Servlet 3.0`£¬servlet ÈÝÆ÷ÌṩÁË 3 ¸ö×¢½âÀ´´¦Àí `servlet` Èý´ó×é¼þµÄ×¢²á£º +在 `Servlet 3.0`,servlet 容器æ��供了 3 个注解æ�¥å¤„ç�† `servlet` 三大组件的注册: -* `@WebServlet`: ´¦Àí `servlet` ×¢²á -* `@WebFilter`: ´¦Àí `filter` ×¢²á -* `@WebListener`: ´¦Àí `listener` ×¢²á +* `@WebServlet`: 处ç�† `servlet` 注册 +* `@WebFilter`: 处ç�† `filter` 注册 +* `@WebListener`: 处ç�† `listener` 注册 -»¹ÊÇÒÔ `servlet` ×¢²áΪÀý£¬ÏÈÀ´¿´¿´ `@WebServlet`: +还是以 `servlet` 注册为例,先æ�¥çœ‹çœ‹ `@WebServlet`: ``` @Target({ElementType.TYPE}) @@ -74,7 +74,7 @@ public @interface WebServlet { ``` -¿ÉÒÔ¿´µ½£¬`@WebServlet` Ö§³Ö¶à¸öÊôÐÔÅäÖã¬ÏñÖ¸¶¨ servlet µÄÃû³Æ¡¢Ó³ÉäµÄ url ¶¼¿ÉÒÔÔÚÕâÀïÖ¸¶¨£¬ÎÒÃÇÒ²Ìṩһ¸öʾÀý£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`@WebServlet` 支æŒ�多个属性é…�置,åƒ�指定 servlet çš„å��ç§°ã€�映射的 url 都å�¯ä»¥åœ¨è¿™é‡ŒæŒ‡å®šï¼Œæˆ‘们也æ��供一个示例: ``` @WebServlet(name = "myServlet", urlPatterns = "/myServlet") @@ -82,7 +82,7 @@ public class JavaServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException { - // ´¦ÀíһЩ²Ù×÷ + // 处ç�†ä¸€äº›æ“�作 ... } @@ -90,10 +90,10 @@ public class JavaServlet extends HttpServlet { ``` -ÕâÑù´¦Àíºó£¬»¹Òª×öÒ»¸öÖØÒªµÄ²Ù×÷£¬ÄǾÍÊÇʹÓà `@ServletComponentScan` À´¿ªÆôɨÃ蹦ÄÜ£º +这样处ç�†å�Žï¼Œè¿˜è¦�å�šä¸€ä¸ªé‡�è¦�çš„æ“�作,那就是使用 `@ServletComponentScan` æ�¥å¼€å�¯æ‰«æ��功能: ``` -// ʹÓà @ServletComponentScan À´¿ªÆô servlet ×é¼þµÄɨÃ蹦ÄÜ +// 使用 @ServletComponentScan æ�¥å¼€å�¯ servlet 组件的扫æ��功能 @ServletComponentScan @SpringBootApplication public class MyApplication { @@ -104,34 +104,34 @@ public class MyApplication { ``` -#### 1.3 `ServletContextInitializer` ×¢²á +#### 1.3 `ServletContextInitializer` 注册 -ʹÓÃÕâÖÖ·½Ê½×¢²á£¬ÐèҪʵÏÖ `ServletContextInitializer` ½Ó¿Ú£º +使用这ç§�æ–¹å¼�注册,需è¦�实现 `ServletContextInitializer` 接å�£ï¼š ``` /** - * ×¼±¸Ò»¸öservlet + * 准备一个servlet */ public class MyServlet extends HttpServlet { @Override protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException { - // ´¦ÀíһЩ²Ù×÷ + // 处ç�†ä¸€äº›æ“�作 ... } } /** - * ʵÏÖ ServletContextInitializer + * 实现 ServletContextInitializer */ @Component public class ServletConfig implements ServletContextInitializer { @Override public void onStartup(ServletContext servletContext) { - // ʹÓà servletContext ½øÐÐ×¢²á + // 使用 servletContext 进行注册 ServletRegistration initServlet = servletContext.addServlet("myServlet", MyServlet.class); - // ¿ÉÒÔ½øÐÐһЩÅäÖà + // å�¯ä»¥è¿›è¡Œä¸€äº›é…�ç½® initServlet.addMapping("/myServlet"); } @@ -139,15 +139,15 @@ public class ServletConfig implements ServletContextInitializer { ``` -ʹÓÃÕâÖÖ·½Ê½×¢²á£¬ÏÈҪʵÏÖ `ServletContextInitializer`£¬È»ºóÖØÐ´ `ServletContextInitializer#onStartup` ·½·¨£¬ÔÚ `ServletContextInitializer#onStartup` ʹÓà `ServletContext` ¶ÔÏó½øÐÐ×¢²á¡£`ServletContext` ¶ÔÏóÓÉ servlet ÈÝÆ÷Ìṩ£¬Õâ¸ö¶ÔÏó¾ÍÊÇ×¢²áµÄÖÕ¼«À࣬²»¹ÜÊÇʹÓà `RegistrationBean` ×¢²á£¬»¹ÊÇʹÓà `@ServletComponentScan` ɨÃè×¢²á£¬×îÖÕ¶¼ÊÇͨ¹ý `ServletContext` ×¢²áµ½ servlet ÈÝÆ÷ÖС£ +使用这ç§�æ–¹å¼�注册,先è¦�实现 `ServletContextInitializer`,然å�Žé‡�写 `ServletContextInitializer#onStartup` 方法,在 `ServletContextInitializer#onStartup` 使用 `ServletContext` 对象进行注册。`ServletContext` 对象由 servlet 容器æ��供,这个对象就是注册的终æž�类,ä¸�管是使用 `RegistrationBean` 注册,还是使用 `@ServletComponentScan` 扫æ��注册,最终都是通过 `ServletContext` 注册到 servlet 容器中。 -### 2\. Ô´ÂëʵÏÖ +### 2\. æº�ç �实现 -Á˽âÍêÈçºÎʹÓú󣬽ÓÏÂÀ´ÎÒÃÇ¾Í ½øÈëÔ´Âë¿´¿´ÕâЩÁ÷³ÌÊÇÈçºÎʵÏÖ¡£ +了解完如何使用å�Žï¼ŒæŽ¥ä¸‹æ�¥æˆ‘们就 进入æº�ç �看看这些æµ�程是如何实现。 -#### 2.1 `@ServletComponentScan` ɨÃè +#### 2.1 `@ServletComponentScan` 扫æ�� -ÎÒÃÇÖ±½Ó½øÈë `@ServletComponentScan`£º +我们直接进入 `@ServletComponentScan`: ``` @Target(ElementType.TYPE) @@ -160,12 +160,12 @@ public @interface ServletComponentScan { ``` -Õâ¸ö×¢²áÉÏÃæ±ê¼ÇÁË `@Import` ×¢½â£¬ÒýÈëÁËÒ»¸öÀࣺ`ServletComponentScanRegistrar`£¬ÎÒÃÇ¿´¿´Õâ¸öÀ྿¾¹×öÁËɶ£º +这个注册上é�¢æ ‡è®°äº† `@Import` 注解,引入了一个类:`ServletComponentScanRegistrar`,我们看看这个类究竟å�šäº†å•¥ï¼š ``` /** - * ʵÏÖÁËImportBeanDefinitionRegistrar - * ÏòÈÝÆ÷ÖÐ×¢²áÁË ServletComponentRegisteringPostProcessor + * 实现了ImportBeanDefinitionRegistrar + * å�‘容器中注册了 ServletComponentRegisteringPostProcessor */ class ServletComponentScanRegistrar implements ImportBeanDefinitionRegistrar { @@ -179,22 +179,22 @@ class ServletComponentScanRegistrar implements ImportBeanDefinitionRegistrar { updatePostProcessor(registry, packagesToScan); } else { - // ×¢²á BeanFactoryPostProcessor + // 注册 BeanFactoryPostProcessor addPostProcessor(registry, packagesToScan); } } /** - * ×¢²á BeanFactoryPostProcessor - * ×¢²áÁË ServletComponentRegisteringPostProcessor + * 注册 BeanFactoryPostProcessor + * 注册了 ServletComponentRegisteringPostProcessor */ private void addPostProcessor(BeanDefinitionRegistry registry, Set packagesToScan) { GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); - // ServletComponentRegisteringPostProcessor: ´¦ÀíɨÃèµÄ BeanFactoryPostProcessor + // ServletComponentRegisteringPostProcessor: 处ç�†æ‰«æ��çš„ BeanFactoryPostProcessor beanDefinition.setBeanClass(ServletComponentRegisteringPostProcessor.class); beanDefinition.getConstructorArgumentValues().addGenericArgumentValue(packagesToScan); beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE); - // ServletComponentScanRegistrar ¾ÍÊÇΪÁË×¢²á ServletComponentRegisteringPostProcessor + // ServletComponentScanRegistrar 就是为了注册 ServletComponentRegisteringPostProcessor registry.registerBeanDefinition(BEAN_NAME, beanDefinition); } @@ -204,37 +204,37 @@ class ServletComponentScanRegistrar implements ImportBeanDefinitionRegistrar { ``` -¿ÉÒÔ¿´µ½£¬Õâ¸öÀàʵÏÖÁË `ImportBeanDefinitionRegistrar`£¬Ö÷ÒªÊÇÏò spring ÈÝÆ÷ÖÐ×¢²áÁË `ServletComponentRegisteringPostProcessor`¡£ÎÒÃǼÌÐø¿´ÏÂÈ¥£¬½øÈë `ServletComponentRegisteringPostProcessor`£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªç±»å®žçŽ°äº† `ImportBeanDefinitionRegistrar`,主è¦�是å�‘ spring 容器中注册了 `ServletComponentRegisteringPostProcessor`。我们继续看下去,进入 `ServletComponentRegisteringPostProcessor`: ``` class ServletComponentRegisteringPostProcessor implements BeanFactoryPostProcessor, ApplicationContextAware { /** - * ÐèҪɨÃèµÄ°ü. + * 需è¦�扫æ��的包. */ private final Set packagesToScan; /** - * ҪɨÃèµÄ°üÓɹ¹Ôì·½·¨´«Èë + * è¦�扫æ��的包由构造方法传入 */ ServletComponentRegisteringPostProcessor(Set packagesToScan) { this.packagesToScan = packagesToScan; } /** - * ÖØÐ´ÁËBeanFactoryPostProcessorµÄ·½·¨ + * é‡�写了BeanFactoryPostProcessor的方法 */ @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException { - // ÅжÏÊÇ·ñÔËÐÐÔÚÄÚǶµÄ web ÈÝÆ÷ÖÐ + // 判断是å�¦è¿�行在内嵌的 web 容器中 if (isRunningInEmbeddedWebServer()) { - // ɨÃèÆ÷£¬ÅäÖÃÁËɨÃè¹æÔò + // 扫æ��器,é…�置了扫æ��规则 ClassPathScanningCandidateComponentProvider componentProvider = createComponentProvider(); for (String packageToScan : this.packagesToScan) { - // ½øÐаüɨÃè²Ù×÷ + // 进行包扫æ��æ“�作 scanPackage(componentProvider, packageToScan); } } @@ -246,12 +246,12 @@ class ServletComponentRegisteringPostProcessor implements BeanFactoryPostProcess ``` -¿ÉÒÔ¿´µ½£¬`ServletComponentRegisteringPostProcessor` ʵÏÖÁË `BeanFactoryPostProcessor`£¬ÔÚÖØÐ´µÄ `BeanFactoryPostProcessor#postProcessBeanFactory` ·½·¨Öд¦ÀíɨÃè²Ù×÷£¬É¨Ãèǰ£¬ÏÈÊÇ´´½¨ÁËɨÃèÆ÷ `ClassPathScanningCandidateComponentProvider`£¬È»ºóÔÙ½øÐÐɨÃè¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`ServletComponentRegisteringPostProcessor` 实现了 `BeanFactoryPostProcessor`,在é‡�写的 `BeanFactoryPostProcessor#postProcessBeanFactory` 方法中处ç�†æ‰«æ��æ“�作,扫æ��å‰�,先是创建了扫æ��器 `ClassPathScanningCandidateComponentProvider`,然å�Žå†�进行扫æ��。 -ÎÒÃÇÏÈÀ´¿´É¨ÃèÆ÷µÄ´´½¨·½·¨ `createComponentProvider()`£º +我们先æ�¥çœ‹æ‰«æ��器的创建方法 `createComponentProvider()`: ``` -// ´¦Àí¸÷ÖÖ handler +// 处ç�†å�„ç§� handler private static final List HANDLERS; static { @@ -263,16 +263,16 @@ static { } /** - * ´´½¨É¨ÃèÆ÷ + * 创建扫æ��器 */ private ClassPathScanningCandidateComponentProvider createComponentProvider() { - // ´´½¨¶ÔÏó + // 创建对象 ClassPathScanningCandidateComponentProvider componentProvider = new ClassPathScanningCandidateComponentProvider(false); componentProvider.setEnvironment(this.applicationContext.getEnvironment()); componentProvider.setResourceLoader(this.applicationContext); for (ServletComponentHandler handler : HANDLERS) { - // ÅäÖùýÂ˹æÔò + // é…�置过滤规则 componentProvider.addIncludeFilter(handler.getTypeFilter()); } return componentProvider; @@ -280,9 +280,9 @@ private ClassPathScanningCandidateComponentProvider createComponentProvider() { ``` -`createComponentProvider()` ·½·¨ÖУ¬ÏÈÊÇ´´½¨ÁËɨÃèÆ÷¶ÔÏó£¬È»ºóÉèÖÃÁËһЩÊôÐÔ£¬½ÓמÍÊÇÅäÖùýÂ˹æÔò£¬ÎÒÃÇÕâÀïÖØµãÀ´¿´Ï¹ýÂ˹æÔòµÄÅäÖã¬ÕâЩ¹æÔòÓÉ `WebServletHandler`/`WebFilterHandler`/`WebListenerHandler` µÄ `getTypeFilter()` ·½·¨Ìṩ£º +`createComponentProvider()` 方法中,先是创建了扫æ��器对象,然å�Žè®¾ç½®äº†ä¸€äº›å±žæ€§ï¼ŒæŽ¥ç�€å°±æ˜¯é…�置过滤规则,我们这里é‡�点æ�¥çœ‹ä¸‹è¿‡æ»¤è§„则的é…�置,这些规则由 `WebServletHandler`/`WebFilterHandler`/`WebListenerHandler` çš„ `getTypeFilter()` 方法æ��供: -`getTypeFilter()` ·½·¨Î»ÓÚÒ»¸ö³éÏó·½·¨ÖУº +`getTypeFilter()` 方法ä½�于一个抽象方法中: ``` abstract class ServletComponentHandler { @@ -290,7 +290,7 @@ abstract class ServletComponentHandler { private final TypeFilter typeFilter; /** - * ´«Èë×¢½â£¬×ª»»Îª AnnotationTypeFilter ¶ÔÏó + * 传入注解,转æ�¢ä¸º AnnotationTypeFilter 对象 */ protected ServletComponentHandler(Class annotationType) { this.typeFilter = new AnnotationTypeFilter(annotationType); @@ -298,7 +298,7 @@ abstract class ServletComponentHandler { } /** - * ·µ»Ø TypeFilter + * 返回 TypeFilter */ TypeFilter getTypeFilter() { return this.typeFilter; @@ -308,13 +308,13 @@ abstract class ServletComponentHandler { ``` -ÔÚ `ServletComponentHandler` ÖУ¬ÓÐÒ»¸ö³ÉÔ±±äÁ¿ `typeFilter`£¬ÔÚ¹¹Ôì·½·¨Öд«Èë×¢²áÖµºó»áת»»»á `AnnotationTypeFilter`£¬È»ºó¸³Öµ¸ø `typeFilter`£¬¶ø `getTypeFilter()` ·½·¨·µ»ØµÄ¾ÍÊÇÕâ¸ö `typeFilter`¡£ +在 `ServletComponentHandler` 中,有一个æˆ�员å�˜é‡� `typeFilter`,在构造方法中传入注册值å�Žä¼šè½¬æ�¢ä¼š `AnnotationTypeFilter`,然å�Žèµ‹å€¼ç»™ `typeFilter`,而 `getTypeFilter()` 方法返回的就是这个 `typeFilter`。 -Á˽âÍêÕâ¸ö `typeFilter` µÄÀ´Ô´ºó£¬ÎÒÃÇÀ´¿´¿´ËüµÄ¼¸¸öʵÏÖÀࣺ +了解完这个 `typeFilter` çš„æ�¥æº�å�Žï¼Œæˆ‘们æ�¥çœ‹çœ‹å®ƒçš„几个实现类: ``` /** - * WebFilterHandler ¹¹Ôì·½·¨´«ÈëµÄ²ÎÊýÊÇ WebFilter + * WebFilterHandler 构造方法传入的å�‚数是 WebFilter */ class WebFilterHandler extends ServletComponentHandler { WebFilterHandler() { @@ -324,7 +324,7 @@ class WebFilterHandler extends ServletComponentHandler { } /** - * WebListenerHandler ¹¹Ôì·½·¨´«ÈëµÄ²ÎÊýÊÇ WebListener + * WebListenerHandler 构造方法传入的å�‚数是 WebListener */ class WebListenerHandler extends ServletComponentHandler { WebListenerHandler() { @@ -334,7 +334,7 @@ class WebListenerHandler extends ServletComponentHandler { } /** - * WebServletHandler ¹¹Ôì·½·¨´«ÈëµÄ²ÎÊýÊÇ WebServlet + * WebServletHandler 构造方法传入的å�‚数是 WebServlet */ class WebServletHandler extends ServletComponentHandler { WebServletHandler() { @@ -345,20 +345,20 @@ class WebServletHandler extends ServletComponentHandler { ``` -Óɴ˾ÍÃ÷°×ÁË£¬`createComponentProvider()` µÃµ½µÄ `ClassPathScanningCandidateComponentProvider` Ö»´¦Àí°üº¬ 3 ¸ö×¢½âµÄÀࣺ +由此就明白了,`createComponentProvider()` 得到的 `ClassPathScanningCandidateComponentProvider` å�ªå¤„ç�†åŒ…å�« 3 个注解的类: * `@WebFilter` * `@WebListener` * `@WebServlet` -ÎÒÃǼÌÐø£¬½ÓÏÂÀ´¿´¿´É¨ÃèÁ÷³Ì£¬·½·¨Îª `ServletComponentRegisteringPostProcessor#scanPackage`: +我们继续,接下æ�¥çœ‹çœ‹æ‰«æ��æµ�程,方法为 `ServletComponentRegisteringPostProcessor#scanPackage`: ``` private void scanPackage(ClassPathScanningCandidateComponentProvider componentProvider, String packageToScan) { for (BeanDefinition candidate : componentProvider.findCandidateComponents(packageToScan)) { if (candidate instanceof AnnotatedBeanDefinition) { - // ´¦ÀíµÃµ½µÄ BeanDefinition + // 处ç�†å¾—到的 BeanDefinition for (ServletComponentHandler handler : HANDLERS) { handler.handle(((AnnotatedBeanDefinition) candidate), (BeanDefinitionRegistry) this.applicationContext); @@ -369,14 +369,14 @@ private void scanPackage(ClassPathScanningCandidateComponentProvider componentPr ``` -¹ØÓÚ¾ßÌåµÄɨÃèÁ÷³Ì£¨`ClassPathScanningCandidateComponentProvider#findCandidateComponents` ·½·¨£©£¬Í¬ spring µÄ°üɨÃèÁ÷³Ì»ù±¾Ò»Ö£¬ÕâÀï¾Í²»Õ¹¿ªÏ¸½²ÁË£¬ÎÒÃǰÑÖØµã·ÅÔÚ `BeanDefinition` µÄ´¦ÀíÉÏ£¬Ò²¾ÍÊÇ `ServletComponentHandler#handle` ·½·¨£º +关于具体的扫æ��æµ�程(`ClassPathScanningCandidateComponentProvider#findCandidateComponents` 方法),å�Œ spring 的包扫æ��æµ�程基本一致,这里就ä¸�展开细讲了,我们把é‡�点放在 `BeanDefinition` 的处ç�†ä¸Šï¼Œä¹Ÿå°±æ˜¯ `ServletComponentHandler#handle` 方法: ``` void handle(AnnotatedBeanDefinition beanDefinition, BeanDefinitionRegistry registry) { - // ÕâÀïµÄ annotationType ¾ÍÊǹ¹Ôì·½·¨Öд«ÈëµÄ×¢½â£¬Èç@WebFilter£¬@WebListener µÈ + // 这里的 annotationType 就是构造方法中传入的注解,如@WebFilter,@WebListener ç­‰ Map attributes = beanDefinition.getMetadata() .getAnnotationAttributes(this.annotationType.getName()); - // Åж϶ÔÓ¦µÄ×¢½âÊÇ·ñ´æÔÚ£¬´æÔÚÔò´¦Àí + // 判断对应的注解是å�¦å­˜åœ¨ï¼Œå­˜åœ¨åˆ™å¤„ç�† if (attributes != null) { doHandle(attributes, beanDefinition, registry); } @@ -384,20 +384,20 @@ void handle(AnnotatedBeanDefinition beanDefinition, BeanDefinitionRegistry regis ``` -ÔÚ´¦ÀíɨÃèµÃµ½µÄ `BeanDefinition` ʱ£¬ÏȱéÀúËùÓÐµÄ `handler`(`WebServletHandler`/`WebFilterHandler`/`WebListenerHandler`)£¬È»ºóµ÷Óà `ServletComponentHandler#handle` ·½·¨½øÐд¦Àí¡£ÔÚ `ServletComponentHandler#handle` ÖУ¬ÓÖ»á¸ù¾ÝÊÇ·ñ´æÔÚ¶ÔÓ¦µÄ×¢½âÊÇ·ñ´æÔÚ£¨Ê¹Óà `AnnotatedBeanDefinition#getMetadata` »ñÈ¡¶ÔӦע²áµÄÐÅÏ¢£©À´¾ö¶¨ÊÇ·ñµ÷ÓÃ×ÓÀàµÄ `doHandler()` ·½·¨¡£ +在处ç�†æ‰«æ��得到的 `BeanDefinition` 时,先é��历所有的 `handler`(`WebServletHandler`/`WebFilterHandler`/`WebListenerHandler`),然å�Žè°ƒç”¨ `ServletComponentHandler#handle` 方法进行处ç�†ã€‚在 `ServletComponentHandler#handle` 中,å�ˆä¼šæ ¹æ�®æ˜¯å�¦å­˜åœ¨å¯¹åº”的注解是å�¦å­˜åœ¨ï¼ˆä½¿ç”¨ `AnnotatedBeanDefinition#getMetadata` 获å�–对应注册的信æ�¯ï¼‰æ�¥å†³å®šæ˜¯å�¦è°ƒç”¨å­�类的 `doHandler()` 方法。 -ÄÇôÕâ¸ö `doHandler()` ·½·¨¸ÉÁËÊ²Ã´ÄØ£¿ÎÒÃǽøÈë `WebServletHandler#doHandle`£º +那么这个 `doHandler()` 方法干了什么呢?我们进入 `WebServletHandler#doHandle`: ``` public void doHandle(Map attributes, AnnotatedBeanDefinition beanDefinition, BeanDefinitionRegistry registry) { - // ×¢²áµÄÊÇ ServletRegistrationBean ¶ÔÓ¦µÄ BeanDefinition + // 注册的是 ServletRegistrationBean 对应的 BeanDefinition BeanDefinitionBuilder builder = BeanDefinitionBuilder .rootBeanDefinition(ServletRegistrationBean.class); builder.addPropertyValue("asyncSupported", attributes.get("asyncSupported")); builder.addPropertyValue("initParameters", extractInitParameters(attributes)); builder.addPropertyValue("loadOnStartup", attributes.get("loadOnStartup")); - // »ñÈ¡ servlet Ãû³Æ£¬Èç¹ûÖ¸¶¨ÁËÃû³Æ£¬¾ÍʹÓÃÖ¸¶¨Ãû³Æ£¬Èç¹ûûÓÐÖ¸¶¨£¬¾ÍʹÓÃÊÇbeanµÄÃû³Æ + // 获å�– servlet å��称,如果指定了å��称,就使用指定å��称,如果没有指定,就使用是beançš„å��ç§° String name = determineName(attributes, beanDefinition); builder.addPropertyValue("name", name); builder.addPropertyValue("servlet", beanDefinition); @@ -408,34 +408,34 @@ public void doHandle(Map attributes, AnnotatedBeanDefinition bea ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½·¨Ö÷ÒªÊÇ´¦Àí `Servlet` µÄÅäÖã¬×îÖÕÏò spring ÈÝÆ÷ÖÐ×¢²áµÄÊÇ `ServletRegistrationBean` ¶ÔÓ¦µÄ `beanDefinition`¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ³•主è¦�是处ç�† `Servlet` çš„é…�置,最终å�‘ spring 容器中注册的是 `ServletRegistrationBean` 对应的 `beanDefinition`。 -ÆäËûÁ½¸ö `Handler` ÀàµÄ `doHandle()` ·½·¨´¦ÀíÁ÷³ÌÒ²²î²»¶à£¬²»¹ý×îÖÕÏò spring ÈÝÆ÷ÖÐ×¢²áµÄ `beanDefinition` ÓÐËù²»Í¬£¬ÕâÀï¾Í²»Ï¸¶ÁÁË¡£ +其他两个 `Handler` 类的 `doHandle()` 方法处ç�†æµ�程也差ä¸�多,ä¸�过最终å�‘ spring 容器中注册的 `beanDefinition` 有所ä¸�å�Œï¼Œè¿™é‡Œå°±ä¸�细读了。 -ÕâÀï×ܽáÏÂÕ⼸¸ö×¢½â×îÖÕÏò spring ÈÝÆ÷ÖÐ×¢²áµÄ `beanDefinition`£º +这里总结下这几个注解最终å�‘ spring 容器中注册的 `beanDefinition`: -* `@WebServlet`: ×¢²áÁË `ServletRegistrationBean` ¶ÔÓ¦µÄ `beanDefinition` -* `@WebFilter`: ×¢²áÁË `FilterRegistrationBean` ¶ÔÓ¦µÄ `beanDefinition` -* `@WebListener`: ×¢²áÁË `ServletListenerRegistrationBean` ¶ÔÓ¦µÄ `beanDefinition` +* `@WebServlet`: 注册了 `ServletRegistrationBean` 对应的 `beanDefinition` +* `@WebFilter`: 注册了 `FilterRegistrationBean` 对应的 `beanDefinition` +* `@WebListener`: 注册了 `ServletListenerRegistrationBean` 对应的 `beanDefinition` -ÔÚʹÓà `XxxRegistrationBean` ×¢²áʱ£¬ÎÒÃÇÊÇÊÖ¶¯´´½¨ÁË `XxxRegistrationBean`£¬È»ºóͨ¹ý `@Bean` ×¢½â×¢²áµ½ spring ÈÝÆ÷ÖУ¬¶øÊ¹Óà `@WebServlet`/`@WebFilter`/`@WebListener` ÄÖÁËһȦ£¬×îÖÕÒ²Êǻص½ÁË `XxxRegistrationBean`£¡ +在使用 `XxxRegistrationBean` 注册时,我们是手动创建了 `XxxRegistrationBean`,然å�Žé€šè¿‡ `@Bean` 注解注册到 spring 容器中,而使用 `@WebServlet`/`@WebFilter`/`@WebListener` 闹了一圈,最终也是回到了 `XxxRegistrationBean`ï¼� -#### 2.2 `XxxRegistrationBean` µÄ×¢²á +#### 2.2 `XxxRegistrationBean` 的注册 -ÎÞÂÛÊÇʹÓà `XxxRegistrationBean` ×¢²á£¬»¹ÊÇʹÓà `@ServletComponentScan` ɨÃè×¢²á£¬×îÖÕ¶¼»áµÃµ½ `XxxRegistrationBean` ¶ÔÓ¦µÄ bean£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´Ì½¾¿ÏÂÕâЩ bean ÊÇÈçºÎ×¢²áµ½ servlet ÈÝÆ÷Öеġ£ +无论是使用 `XxxRegistrationBean` 注册,还是使用 `@ServletComponentScan` 扫æ��注册,最终都会得到 `XxxRegistrationBean` 对应的 bean,接下æ�¥æˆ‘们就æ�¥æŽ¢ç©¶ä¸‹è¿™äº› bean 是如何注册到 servlet 容器中的。 -´Ó´úÂëÉÏ¿´£¬`ServletRegistrationBean`¡¢`FilterRegistrationBean` Óë `ServletListenerRegistrationBean` ¶¼ÊÇ `ServletContextInitializer` ½Ó¿ÚµÄʵÏÖÀ࣬`ServletRegistrationBean` µÄ¼Ì³Ð½á¹¹ÈçÏ£º +从代ç �上看,`ServletRegistrationBean`ã€�`FilterRegistrationBean` 与 `ServletListenerRegistrationBean` 都是 `ServletContextInitializer` 接å�£çš„实现类,`ServletRegistrationBean` 的继承结构如下: -![ͼƬÀ´×ÔÍøÂç](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0397d56cfb328683ae349d0822db2320231.png) +![图片æ�¥è‡ªç½‘络](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0397d56cfb328683ae349d0822db2320231.png) -`ServletContextInitializer` ÖÐÖ»ÓÐÒ»¸ö·½·¨ `onStartup(...)`£º +`ServletContextInitializer` 中å�ªæœ‰ä¸€ä¸ªæ–¹æ³• `onStartup(...)`: ``` @FunctionalInterface public interface ServletContextInitializer { /** - * ¾ÍÊÇÕâ¸ö servletContext£¬ÓÐÁËËü£¬¾ÍÊǽøÐÐ Servlet£¬filter£¬listener µÄ×¢²áÁË + * 就是这个 servletContext,有了它,就是进行 Servlet,filter,listener 的注册了 */ void onStartup(ServletContext servletContext) throws ServletException; @@ -443,28 +443,28 @@ public interface ServletContextInitializer { ``` -ÎÒÃÇÔÚ½éÉÜ `servlet` Èý´ó×é¼þµÄ×¢²á·½Ê½Ê±£¬ÎÒÃÇÌáµ½¿ÉÒÔͨ¹ýʵÏÖ `ServletContextInitializer`£¬ÖØÐ´Æä `onStartup()` À´ÊµÏÖ `servlet` ×é¼þµÄ×¢²á£¬¶ø `XxxRegistrationBean` µÄµ×²ãʵÏÖÒ²ÊÇÕâô×öµÄ¡£ +我们在介ç»� `servlet` 三大组件的注册方å¼�时,我们æ��到å�¯ä»¥é€šè¿‡å®žçް `ServletContextInitializer`,é‡�写其 `onStartup()` æ�¥å®žçް `servlet` 组件的注册,而 `XxxRegistrationBean` 的底层实现也是这么å�šçš„。 -ÒÔ `ServletRegistrationBean`£¬ÎÒÃÇÀ´¿´¿´ËüµÄ `onStartup(...)` ·½·¨×öÁËɶ£º +以 `ServletRegistrationBean`,我们æ�¥çœ‹çœ‹å®ƒçš„ `onStartup(...)` 方法å�šäº†å•¥ï¼š -`ServletRegistrationBean` ûÓÐÖØÐ´ `onStartup(...)` ·½·¨£¬Ö±½Ó¼Ì³Ð×Ô `RegistrationBean`: +`ServletRegistrationBean` 没有é‡�写 `onStartup(...)` 方法,直接继承自 `RegistrationBean`: ``` public final void onStartup(ServletContext servletContext) throws ServletException { - // »ñÈ¡ÃèÊöÐÅÏ¢ + // 获å�–æ��è¿°ä¿¡æ�¯ String description = getDescription(); - // ÊÇ·ñ¿ªÆô×¢²á£¬Ä¬ÈÏΪtrue + // 是å�¦å¼€å�¯æ³¨å†Œï¼Œé»˜è®¤ä¸ºtrue if (!isEnabled()) { logger.info(StringUtils.capitalize(description) + " was not registered (disabled)"); return; } - // ½øÐÐ×¢²á²Ù×÷ + // 进行注册æ“�作 register(description, servletContext); } ``` -Õâ¸ö·½·¨²¢²»¸´ÔÓ£¬ÏÈ»ñÈ¡ÁËÒ»ÏÂÃèÊöÐÅÏ¢£¬È»ºóÅжÏÊÇ·ñ¿ªÆôÁË×¢²á£¬½ÓמÍÊǽøÐÐ×¢²á²Ù×÷ÁË¡£ÎÒÃÇÖ±½Ó²é¿´×¢²á²Ù×÷£¬½øÈë `DynamicRegistrationBean#register`: +这个方法并ä¸�å¤�æ�‚,先获å�–了一下æ��è¿°ä¿¡æ�¯ï¼Œç„¶å�Žåˆ¤æ–­æ˜¯å�¦å¼€å�¯äº†æ³¨å†Œï¼ŒæŽ¥ç�€å°±æ˜¯è¿›è¡Œæ³¨å†Œæ“�作了。我们直接查看注册æ“�作,进入 `DynamicRegistrationBean#register`: ``` protected final void register(String description, ServletContext servletContext) { @@ -473,33 +473,33 @@ protected final void register(String description, ServletContext servletContext) logger.info(...); return; } - // ´¦ÀíÅäÖà + // 处ç�†é…�ç½® configure(registration); } ``` -Õâ¸ö·½·¨Ö÷Òª×öÁËÁ½¸ö¼þÊ£º×¢²á `servlet` Óë´¦ÀíÅäÖã¬ÎÒÃÇÏÈÀ´¿´¿´×¢²á²Ù×÷£¬½øÈë `ServletRegistrationBean#addRegistration` ·½·¨: +这个方法主è¦�å�šäº†ä¸¤ä¸ªä»¶äº‹ï¼šæ³¨å†Œ `servlet` 与处ç�†é…�置,我们先æ�¥çœ‹çœ‹æ³¨å†Œæ“�作,进入 `ServletRegistrationBean#addRegistration` 方法: ``` protected ServletRegistration.Dynamic addRegistration(String description, ServletContext servletContext) { String name = getServletName(); - // ×¢²á + // 注册 return servletContext.addServlet(name, this.servlet); } ``` -×¢²á²Ù×÷»¹ÊDZȽϼòµ¥µÄ£¬Ö±½Óµ÷Óà `ServletContext#addServlet` ½øÐС£ +注册æ“�作还是比较简å�•的,直接调用 `ServletContext#addServlet` 进行。 -¼ÌÐø²é¿´ÅäÖô¦Àí£¬½øÈë `ServletRegistrationBean#configure` ·½·¨£º +继续查看é…�置处ç�†ï¼Œè¿›å…¥ `ServletRegistrationBean#configure` 方法: ``` protected void configure(ServletRegistration.Dynamic registration) { - // µ÷Óø¸Àà + // 调用父类 super.configure(registration); - // ÅäÖÃurlMapping + // é…�ç½®urlMapping String[] urlMapping = StringUtils.toStringArray(this.urlMappings); if (urlMapping.length == 0 && this.alwaysMapUrl) { urlMapping = DEFAULT_MAPPINGS; @@ -507,9 +507,9 @@ protected void configure(ServletRegistration.Dynamic registration) { if (!ObjectUtils.isEmpty(urlMapping)) { registration.addMapping(urlMapping); } - // ÅäÖÃloadOnStartup + // é…�ç½®loadOnStartup registration.setLoadOnStartup(this.loadOnStartup); - // »¹´¦ÀíÁËһЩÆäËûÅäÖà + // 还处ç�†äº†ä¸€äº›å…¶ä»–é…�ç½® if (this.multipartConfig != null) { registration.setMultipartConfig(this.multipartConfig); } @@ -517,17 +517,17 @@ protected void configure(ServletRegistration.Dynamic registration) { ``` -Õâ¸ö·½·¨ÏÈÊǵ÷ÓÃÁ˸¸ÀàµÄ·½·¨£¬È»ºó¾ÍÊÇÅäÖô¦ÀíÁË£¬ÔÚÕâ¸ö·½·¨ÀïÖ÷ÒªÊÇ´¦ÀíÁË `urlMapping` Óë `loadOnStartup`£¬¾Í²»¶à×ö·ÖÎöÁË¡£ +这个方法先是调用了父类的方法,然å�Žå°±æ˜¯é…�置处ç�†äº†ï¼Œåœ¨è¿™ä¸ªæ–¹æ³•里主è¦�是处ç�†äº† `urlMapping` 与 `loadOnStartup`,就ä¸�多å�šåˆ†æž�了。 -ÎÒÃÇÔÙÀ´¿´¿´ `super.configure(...)` ÅäÖÃÁËɶ£¬½øÈë `DynamicRegistrationBean#configure`: +我们å†�æ�¥çœ‹çœ‹ `super.configure(...)` é…�置了啥,进入 `DynamicRegistrationBean#configure`: ``` /** - * Ò²ÊÇ´¦ÀíһЩÅäÖà + * 也是处ç�†ä¸€äº›é…�ç½® */ protected void configure(D registration) { registration.setAsyncSupported(this.asyncSupported); - // ÅäÖóõʼ»¯²ÎÊý + // é…�ç½®åˆ�始化å�‚æ•° if (!this.initParameters.isEmpty()) { registration.setInitParameters(this.initParameters); } @@ -535,20 +535,20 @@ protected void configure(D registration) { ``` -Õâ¸ö·½·¨Ö÷Òª´¦ÀíÁ˳õʼ²ÎÊýµÄÅäÖᣠ+这个方法主è¦�处ç�†äº†åˆ�å§‹å�‚æ•°çš„é…�置。 -´ÓÉÏÃæµÄ·ÖÎöÀ´¿´£¬`ServletRegistrationBean` µÄ `onStartup(...)` ·½·¨Ö÷Òª´¦ÀíÁËÁ½¸ö²Ù×÷£º +从上é�¢çš„分æž�æ�¥çœ‹ï¼Œ`ServletRegistrationBean` çš„ `onStartup(...)` 方法主è¦�处ç�†äº†ä¸¤ä¸ªæ“�作: -1. ½« `servlet` Ìí¼Óµ½ÈÝÆ÷ÖÐ -2. ´¦Àí `servlet` ²ÎÊýÅäÖà +1. å°† `servlet` 添加到容器中 +2. 处ç�† `servlet` å�‚æ•°é…�ç½® -`FilterRegistrationBean` Óë `ServletListenerRegistrationBean` µÄ×¢²á²Ù×÷ÀàËÆ£¬ÕâÀï¾Í²»¶à˵ÁË¡£ +`FilterRegistrationBean` 与 `ServletListenerRegistrationBean` 的注册æ“�作类似,这里就ä¸�多说了。 -#### 2.3 `ServletContextInitializer#onStartup` µÄÖ´ÐÐ +#### 2.3 `ServletContextInitializer#onStartup` 的执行 -×¢²áÁ÷³ÌÒѾ­ÞÛÍêÁË£¬ÎÒÃÇÔÙÀ´¿´¿´ `ServletContextInitializer#onStartup` ÊÇÔÚÄÄÀïÖ´Ðеġ£×¢£ºÕâÒ»²½µÄÁ÷³Ì±È½Ï¸´ÔÓ£¬»áÉæ¼°µ½ tomcat µÄÆô¶¯Á÷³Ì£¬Òò´ËÕⲿ·ÖÖ»¹Ø×¢Öصã´úÂ룬²»¾ßÌå·ÖÎöÒ»²½²½Á÷³Ì¡£ +注册æµ�程已ç»�æ�‹å®Œäº†ï¼Œæˆ‘们å†�æ�¥çœ‹çœ‹ `ServletContextInitializer#onStartup` 是在哪里执行的。注:这一步的æµ�程比较å¤�æ�‚,会涉å�Šåˆ° tomcat çš„å�¯åЍæµ�程,因此这部分å�ªå…³æ³¨é‡�点代ç �,ä¸�具体分æž�一步步æµ�程。 -ÒÔ tomcat ÈÝÆ÷ΪÀý£¬¾­¹ýһϵÁеĵ÷ÊÔÓë´úÂë×·×Ù£¬·¢ÏÖËüÊÇÔÚ `TomcatStarter` ÖÐÔËÐе쬴úÂëÈçÏ£º +以 tomcat 容器为例,ç»�过一系列的调试与代ç �追踪,å�‘现它是在 `TomcatStarter` 中è¿�行的,代ç �如下: ``` class TomcatStarter implements ServletContainerInitializer { @@ -564,7 +564,7 @@ class TomcatStarter implements ServletContainerInitializer { throws ServletException { try { for (ServletContextInitializer initializer : this.initializers) { - // ÕâÀïÖ´ÐÐ ServletContextInitializer#onStartup·½·¨ + // 这里执行 ServletContextInitializer#onStartup方法 initializer.onStartup(servletContext); } } @@ -580,22 +580,22 @@ class TomcatStarter implements ServletContainerInitializer { ``` -`TomcatStarter` ÊÇ springboot ÌṩµÄÀ࣬ËüʵÏÖÁË `ServletContainerInitializer`£¬Çø±ðÓÚ `ServletContextInitializer`£¬`ServletContainerInitializer` ÊÇÓÉ tomcat ÌṩµÄ£¬ÔÚ tomcat Æô¶¯Ê±£¬»áÖ´ÐÐ `ServletContainerInitializer#onStartup` ·½·¨£¨`servlt 3.0` ¹æ·¶£©¡£ +`TomcatStarter` 是 springboot æ��供的类,它实现了 `ServletContainerInitializer`,区别于 `ServletContextInitializer`,`ServletContainerInitializer` 是由 tomcat æ��供的,在 tomcat å�¯åŠ¨æ—¶ï¼Œä¼šæ‰§è¡Œ `ServletContainerInitializer#onStartup` 方法(`servlt 3.0` 规范)。 -ÄÇô `TomcatStarter` ÊÇÈçºÎÌí¼Óµ½ tomcat ÈÝÆ÷ÖеÄÄØ£¿ËäÈ» `servlt 3.0` ¹æ·¶¿ÉÒÔͨ¹ý `spi` ¼¼ÊõɨÃèµ½ `ServletContainerInitializer` µÄʵÏÖ£¬µ«ÊÇÕâÀïÃ÷ÏÔ²»ÊÇÕâÑù×öµÄ£¬ÒòΪÈç¹ûÓÉ tomcat ͨ¹ý `spi` ɨÃèµÃµ½ `TomcatStarter` µÄʵÀý£¬ÄÇËüµÄ³ÉÔ±±äÁ¿ `initializers` ¾ÍÎÞ·¨¸³ÖµÁË£¬ËùÒÔÔÚÌí¼Óµ½ tomcat ǰ£¬`TomcatStarter` ¾ÍҪʵÀý»¯²¢ÇÒ `initializers` ¾ÍÒª±»¸³Öµ¡£ +那么 `TomcatStarter` 是如何添加到 tomcat 容器中的呢?虽然 `servlt 3.0` 规范å�¯ä»¥é€šè¿‡ `spi` 技术扫æ��到 `ServletContainerInitializer` 的实现,但是这里明显ä¸�是这样å�šçš„,因为如果由 tomcat 通过 `spi` 扫æ��得到 `TomcatStarter` 的实例,那它的æˆ�员å�˜é‡� `initializers` 就无法赋值了,所以在添加到 tomcat å‰�,`TomcatStarter` å°±è¦�实例化并且 `initializers` å°±è¦�被赋值。 -¾­¹ý¶à´Îµ÷ÊÔ£¬·¢ÏÖ `TomcatStarter` ÊÇÔÚ `TomcatServletWebServerFactory#configureContext` ÖÐÌí¼Óµ½ tomcat ÈÝÆ÷µÄ£¬¹Ø¼ü´úÂëÈçÏÂ: +ç»�过多次调试,å�‘现 `TomcatStarter` 是在 `TomcatServletWebServerFactory#configureContext` 中添加到 tomcat 容器的,关键代ç �如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6625407ce4d1dad8de736db00db124a2a99.png) -¿ÉÒÔ¿´µ½£¬`initializers` ±»µ±×÷¹¹Ôì²ÎÊý´«Èëµ½ `TomcatStarter` µÄ¹¹Ôì·½·¨ÖУ¬µÃµ½ `TomcatStarter` µÄʵÀý£¬ÔÙÊÖ¶¯Ìí¼Óµ½ tomcat ÈÝÆ÷ÖÐÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`initializers` 被当作构造å�‚数传入到 `TomcatStarter` 的构造方法中,得到 `TomcatStarter` 的实例,å†�手动添加到 tomcat 容器中了。 -ÄÇô£¬Õâ¸ö `initializers` ÊÇÔÚÄÄÀï»ñÈ¡µ½µÄÄØ£¿ÊÂʵÉÏ£¬ÎÒÃÇµÄ `XxxRegistrationBean` ¶¼Òª spring ÈÝÆ÷ÖУ¬Òª»ñÈ¡µÄ»°£¬Ö»Òªµ÷Óà `beanFactory.getBeansOfType(...)` ¾Í¿ÉÒÔÁË£¬`ServletContextInitializerBeans#addServletContextInitializerBean(String, ServletContextInitializer, ListableBeanFactory)` ¾ÍÊǸÉÕâ¼þÊµģº +那么,这个 `initializers` 是在哪里获å�–到的呢?事实上,我们的 `XxxRegistrationBean` 都è¦� spring 容器中,è¦�获å�–çš„è¯�,å�ªè¦�调用 `beanFactory.getBeansOfType(...)` å°±å�¯ä»¥äº†ï¼Œ`ServletContextInitializerBeans#addServletContextInitializerBean(String, ServletContextInitializer, ListableBeanFactory)` 就是干这件事的: ``` private void addServletContextInitializerBeans(ListableBeanFactory beanFactory) { for (Class initializerType : this.initializerTypes) { - // »ñÈ¡ ServletContextInitializer: getOrderedBeansOfType(beanFactory, initializerType) + // 获å�– ServletContextInitializer: getOrderedBeansOfType(beanFactory, initializerType) for (Entry initializerBean : getOrderedBeansOfType(beanFactory, initializerType)) { addServletContextInitializerBean(initializerBean.getKey(), @@ -605,35 +605,35 @@ private void addServletContextInitializerBeans(ListableBeanFactory beanFactory) } /** - * ´¦ÀíÌí¼Ó²Ù×÷ + * 处ç�†æ·»åŠ æ“�作 */ private void addServletContextInitializerBean(String beanName, ServletContextInitializer initializer, ListableBeanFactory beanFactory) { - // Ìí¼Ó ServletRegistrationBean + // 添加 ServletRegistrationBean if (initializer instanceof ServletRegistrationBean) { Servlet source = ((ServletRegistrationBean) initializer).getServlet(); addServletContextInitializerBean(Servlet.class, beanName, initializer, beanFactory, source); } - // Ìí¼Ó FilterRegistrationBean + // 添加 FilterRegistrationBean else if (initializer instanceof FilterRegistrationBean) { Filter source = ((FilterRegistrationBean) initializer).getFilter(); addServletContextInitializerBean(Filter.class, beanName, initializer, beanFactory, source); } - // Ìí¼Ó DelegatingFilterProxyRegistrationBean + // 添加 DelegatingFilterProxyRegistrationBean else if (initializer instanceof DelegatingFilterProxyRegistrationBean) { String source = ((DelegatingFilterProxyRegistrationBean) initializer).getTargetBeanName(); addServletContextInitializerBean(Filter.class, beanName, initializer, beanFactory, source); } - // Ìí¼Ó ServletListenerRegistrationBean + // 添加 ServletListenerRegistrationBean else if (initializer instanceof ServletListenerRegistrationBean) { EventListener source = ((ServletListenerRegistrationBean) initializer).getListener(); addServletContextInitializerBean(EventListener.class, beanName, initializer, beanFactory, source); } else { - // ÆäËûµÄ ServletContextInitializer Bean + // å…¶ä»–çš„ ServletContextInitializer Bean addServletContextInitializerBean(ServletContextInitializer.class, beanName, initializer, beanFactory, initializer); } @@ -641,15 +641,15 @@ private void addServletContextInitializerBean(String beanName, ``` -### 3\. ×ܽá +### 3\. 总结 -±¾ÎÄ·ÖÎöÁË springboot ×¢²á servlet Èý´ó×é¼þµÄÁ÷³Ì£º +本文分æž�了 springboot 注册 servlet 三大组件的æµ�程: -1. ÒÔ `Servlet` ΪÀý£¬½éÉÜÁË 3 ÖÖ×¢²á·½Ê½£ºÊ¹Óà `XxxRegistrationBean` ×¢²á¡¢Ê¹Óà `servlet` ×¢½â (`@WebServlet`/`@WebFilter`/`@WebListener`) ×¢²á£¬ÒÔ¼°ÊµÏÖ `ServletContextInitializer` ½Ó¿ÚÊÖ¶¯×¢²á£» -2. ·ÖÎöÁË `@ServletComponentScan` ×¢²áµÄɨÃèÁ÷³Ì -3. ÒÔ `ServletRegistrationBean` ΪÀý£¬·ÖÎöÁ˽« `ServletRegistrationBean` ×¢²áµ½ servlet µÄÁ÷³Ì -4. ·ÖÎöÁË `ServletContainerInitializer#onStartup` µÄÖ´ÐÐ +1. 以 `Servlet` 为例,介ç»�了 3 ç§�注册方å¼�:使用 `XxxRegistrationBean` 注册ã€�使用 `servlet` 注解 (`@WebServlet`/`@WebFilter`/`@WebListener`) 注册,以å�Šå®žçް `ServletContextInitializer` 接å�£æ‰‹åŠ¨æ³¨å†Œï¼› +2. 分æž�了 `@ServletComponentScan` 注册的扫æ��æµ�程 +3. 以 `ServletRegistrationBean` 为例,分æž�了将 `ServletRegistrationBean` 注册到 servlet çš„æµ�程 +4. 分æž�了 `ServletContainerInitializer#onStartup` 的执行 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4951050](https://my.oschina.net/funcy/blog/4951050) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4951050](https://my.oschina.net/funcy/blog/4951050) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\272\214\357\274\211\357\274\232WebMvc\350\243\205\351\205\215\350\277\207\347\250\213.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\272\214\357\274\211\357\274\232WebMvc\350\243\205\351\205\215\350\277\207\347\250\213.md" index 46adf6d..2cf7c5a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\272\214\357\274\211\357\274\232WebMvc\350\243\205\351\205\215\350\277\207\347\250\213.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBootWeb\345\272\224\347\224\250\357\274\210\344\272\214\357\274\211\357\274\232WebMvc\350\243\205\351\205\215\350\277\207\347\250\213.md" @@ -1,24 +1,24 @@ -ƽʱ¹¤×÷ÖУ¬springboot ¾ø´ó¶àÊýÇé¿öÏÂÔËÐеÄÊÇ web ÏîÄ¿£¬±¾ÎĽ«·ÖÎö springboot ×Ô¶¯ springMvc ÏîÄ¿µÄÁ÷³Ì¡£ +平时工作中,springboot ç»�大多数情况下è¿�行的是 web 项目,本文将分æž� springboot 自动 springMvc 项目的æµ�程。 -### 1\. springMvc µÄ×Ô¶¯×°ÅäÀà +### 1\. springMvc 的自动装é…�ç±» -springMvc µÄ×Ô¶¯×°ÅäÀàΪ +springMvc 的自动装é…�类为 ``` @Configuration(proxyBeanMethods = false) -// ¼¸¸ö×°ÅäÌõ¼þ +// 几个装é…�æ�¡ä»¶ @ConditionalOnWebApplication(type = Type.SERVLET) @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class }) -// Èç¹ûûÓÐ×Ô¶¨ÒåWebMvcµÄÅäÖÃÀ࣬ÔòʹÓñ¾ÅäÖà +// 如果没有自定义WebMvcçš„é…�置类,则使用本é…�ç½® @ConditionalOnMissingBean(WebMvcConfigurationSupport.class) -// ×°Åä˳Ðò +// 装é…�顺åº� @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10) @AutoConfigureAfter({ - // DispatcherServlet µÄ×Ô¶¯×°Åä + // DispatcherServlet 的自动装é…� DispatcherServletAutoConfiguration.class, - // Ï̳߳صÄ×Ô¶¯×°Åä + // 线程池的自动装é…� TaskExecutionAutoConfiguration.class, - // jsr 303 ÑéÖ¤¿ò¼ÜµÄ×Ô¶¯×°Åä + // jsr 303 验è¯�框架的自动装é…� ValidationAutoConfiguration.class }) public class WebMvcAutoConfiguration { ... @@ -26,20 +26,20 @@ public class WebMvcAutoConfiguration { ``` -´ÓÉÏÃæµÄ `@AutoConfigureAfter` ×¢½âÖУ¬`WebMvcAutoConfiguration` ÐèÒªÔÚ `DispatcherServletAutoConfiguration`¡¢`TaskExecutionAutoConfiguration`¡¢`ValidationAutoConfiguration` µÈÀà×°ÅäÍê³ÉÖ®ºóÔÙ×°Å䣬¶ÔÕâЩÀàµÄ×÷ÓÃÁоÙÈçÏ£º +从上é�¢çš„ `@AutoConfigureAfter` 注解中,`WebMvcAutoConfiguration` 需è¦�在 `DispatcherServletAutoConfiguration`ã€�`TaskExecutionAutoConfiguration`ã€�`ValidationAutoConfiguration` 等类装é…�完æˆ�之å�Žå†�装é…�,对这些类的作用列举如下: -* `DispatcherServletAutoConfiguration`£º`DispatcherServlet` ×Ô¶¯×°Åä -* `TaskExecutionAutoConfiguration`£ºÈÎÎñÖ´ÐÐÆ÷£¬Æäʵ¾ÍÊÇ´´½¨ÁËÒ»¸öÏß³Ì³Ø -* `ValidationAutoConfiguration`£ºjsr 303 ÑéÖ¤Æ÷µÄ×Ô¶¯×°Å䣬ÑéÖ¤Æ÷ÓÃÀ´´¦Àí `@NotNull`¡¢`@NotEmpty` µÈ×¢½âµÄÑéÖ¤¹¦ÄÜ +* `DispatcherServletAutoConfiguration`:`DispatcherServlet` 自动装é…� +* `TaskExecutionAutoConfiguration`:任务执行器,其实就是创建了一个线程池 +* `ValidationAutoConfiguration`:jsr 303 验è¯�器的自动装é…�,验è¯�器用æ�¥å¤„ç�† `@NotNull`ã€�`@NotEmpty` 等注解的验è¯�功能 -Õâ 3 ¸öÀàÖУ¬Óë springMvc ÓйصÄÖ»ÓÐ `DispatcherServletAutoConfiguration`£¬ÎÒÃÇÀ´ÈÏʶһÏÂËü£º +è¿™ 3 个类中,与 springMvc 有关的å�ªæœ‰ `DispatcherServletAutoConfiguration`,我们æ�¥è®¤è¯†ä¸€ä¸‹å®ƒï¼š ``` @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) @Configuration(proxyBeanMethods = false) @ConditionalOnWebApplication(type = Type.SERVLET) @ConditionalOnClass(DispatcherServlet.class) -// ÐèÒªÔÚ ServletWebServerFactoryAutoConfiguration ×Ô¶¯×°ÅäÍê³Éºó´¦Àí +// 需è¦�在 ServletWebServerFactoryAutoConfiguration 自动装é…�完æˆ�å�Žå¤„ç�† @AutoConfigureAfter(ServletWebServerFactoryAutoConfiguration.class) public class DispatcherServletAutoConfiguration { ... @@ -47,7 +47,7 @@ public class DispatcherServletAutoConfiguration { ``` -`DispatcherServletAutoConfiguration` ÐèÒªµÈ `ServletWebServerFactoryAutoConfiguration` ×Ô¶¯×°ÅäÍê³É²Å½øÐÐ×°Å䣬Õâ¸öÀàÊÇ×öʲôµÄÄØ£¿¾ç͸Ï£¬ËüÊÇ´¦Àí servlet ÈÝÆ÷£¨`tomcat`, `jetty`, `undertow` µÈ£©µÄÉú³ÉµÄ£¬ÎÒÃÇÔÙÀ´¿´¿´ `ServletWebServerFactoryAutoConfiguration`£º +`DispatcherServletAutoConfiguration` 需è¦�ç­‰ `ServletWebServerFactoryAutoConfiguration` 自动装é…�完æˆ�æ‰�进行装é…�,这个类是å�šä»€ä¹ˆçš„呢?剧é€�下,它是处ç�† servlet 容器(`tomcat`, `jetty`, `undertow` 等)的生æˆ�的,我们å†�æ�¥çœ‹çœ‹ `ServletWebServerFactoryAutoConfiguration`: ``` @Configuration(proxyBeanMethods = false) @@ -55,9 +55,9 @@ public class DispatcherServletAutoConfiguration { @ConditionalOnClass(ServletRequest.class) @ConditionalOnWebApplication(type = Type.SERVLET) @EnableConfigurationProperties(ServerProperties.class) -// ÒýÈëÁËһЩÀà +// 引入了一些类 @Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class, - // 3¸ö web ÈÝÆ÷ + // 3个 web 容器 ServletWebServerFactoryConfiguration.EmbeddedTomcat.class, ServletWebServerFactoryConfiguration.EmbeddedJetty.class, ServletWebServerFactoryConfiguration.EmbeddedUndertow.class }) @@ -67,19 +67,19 @@ public class ServletWebServerFactoryAutoConfiguration { ``` -¿ÉÒÔ¿´µ½£¬Õâ¸öÀàÖÐ×ÜËãÊÇûÓÐ `@AutoConfigureAfter` ×¢½âÁË£¬Òò´ËÕâ¸öÀà springMvc ¾ÍÊÇ×î³õ×Ô¶¯×°ÅäµÄÀ࣬ÎÒÃǵķÖÎö¾Í´ÓÕâ¸öÀ࿪ʼ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªç±»ä¸­æ€»ç®—是没有 `@AutoConfigureAfter` 注解了,因此这个类 springMvc 就是最åˆ�自动装é…�的类,我们的分æž�就从这个类开始。 -×ܽáÏÂÒÔÉϼ¸¸öÀàµÄ×°Åä˳Ðò£º +总结下以上几个类的装é…�顺åº�: 1. `ServletWebServerFactoryAutoConfiguration` 2. `DispatcherServletAutoConfiguration` 3. `WebMvcAutoConfiguration` -½ÓÏÂÀ´ÎÒÃǵķÖÎöÒ²°´ÕâÑùµÄ˳Ðò£¬ÖðÒ»·ÖÎöÕâЩ×Ô¶¯×°ÅäÀà¡£ +接下æ�¥æˆ‘们的分æž�也按这样的顺åº�,é€�一分æž�这些自动装é…�类。 -### 2. `ServletWebServerFactoryAutoConfiguration` µÄ×Ô¶¯×°Åä +### 2. `ServletWebServerFactoryAutoConfiguration` 的自动装é…� -`ServletWebServerFactoryAutoConfiguration` ÀàÈçÏ£º +`ServletWebServerFactoryAutoConfiguration` 类如下: ``` @Configuration(proxyBeanMethods = false) @@ -87,9 +87,9 @@ public class ServletWebServerFactoryAutoConfiguration { @ConditionalOnClass(ServletRequest.class) @ConditionalOnWebApplication(type = Type.SERVLET) @EnableConfigurationProperties(ServerProperties.class) -// ÒýÈëÁËһЩÀà +// 引入了一些类 @Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class, - // 3¸ö web ÈÝÆ÷ + // 3个 web 容器 ServletWebServerFactoryConfiguration.EmbeddedTomcat.class, ServletWebServerFactoryConfiguration.EmbeddedJetty.class, ServletWebServerFactoryConfiguration.EmbeddedUndertow.class }) @@ -99,11 +99,11 @@ public class ServletWebServerFactoryAutoConfiguration { ``` -Õâ¸öÀàÒýÈëÁË `BeanPostProcessorsRegistrar`¡¢`EmbeddedTomcat`¡¢`EmbeddedJetty`¡¢`EmbeddedUndertow`£¬ÎÒÃÇÀ´ÖðÒ»·ÖÎö°É£¡ +这个类引入了 `BeanPostProcessorsRegistrar`ã€�`EmbeddedTomcat`ã€�`EmbeddedJetty`ã€�`EmbeddedUndertow`,我们æ�¥é€�一分æž�å�§ï¼� #### 2.1 `BeanPostProcessorsRegistrar` -`BeanPostProcessorsRegistrar` ÊÇ `ServletWebServerFactoryAutoConfiguration` µÄÄÚ²¿À࣬´úÂëÈçÏ£º +`BeanPostProcessorsRegistrar` 是 `ServletWebServerFactoryAutoConfiguration` 的内部类,代ç �如下: ``` public static class BeanPostProcessorsRegistrar @@ -112,7 +112,7 @@ public static class BeanPostProcessorsRegistrar ... /** - * À´×Ô ImportBeanDefinitionRegistrar µÄ·½·¨ + * æ�¥è‡ª ImportBeanDefinitionRegistrar 的方法 */ @Override public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, @@ -120,7 +120,7 @@ public static class BeanPostProcessorsRegistrar if (this.beanFactory == null) { return; } - // ×¢²á×é¼þ + // 注册组件 registerSyntheticBeanIfMissing(registry, "webServerFactoryCustomizerBeanPostProcessor", WebServerFactoryCustomizerBeanPostProcessor.class); registerSyntheticBeanIfMissing(registry, "errorPageRegistrarBeanPostProcessor", @@ -128,7 +128,7 @@ public static class BeanPostProcessorsRegistrar } /** - * ¾ßÌåµÄ×¢²á²Ù×÷ + * 具体的注册æ“�作 */ private void registerSyntheticBeanIfMissing(BeanDefinitionRegistry registry, String name, Class beanClass) { @@ -142,11 +142,11 @@ public static class BeanPostProcessorsRegistrar ``` -Õâ¸öÀàÖ÷ÒªÊÇÏò spring ÈÝÆ÷ÖÐ×¢²áÁËÁ½¸öÀࣺ`WebServerFactoryCustomizerBeanPostProcessor`¡¢`ErrorPageRegistrarBeanPostProcessor`£¬ÎÒÃÇÀ´¿´ÏÂËüÃÇ·Ö±ðÊǸöɶ¡£ +这个类主è¦�是å�‘ spring 容器中注册了两个类:`WebServerFactoryCustomizerBeanPostProcessor`ã€�`ErrorPageRegistrarBeanPostProcessor`,我们æ�¥çœ‹ä¸‹å®ƒä»¬åˆ†åˆ«æ˜¯ä¸ªå•¥ã€‚ ##### 1. `WebServerFactoryCustomizerBeanPostProcessor` -`WebServerFactoryCustomizerBeanPostProcessor` µÄ´úÂëÈçÏ£º +`WebServerFactoryCustomizerBeanPostProcessor` 的代ç �如下: ``` public class WebServerFactoryCustomizerBeanPostProcessor @@ -157,7 +157,7 @@ public class WebServerFactoryCustomizerBeanPostProcessor @Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { - // bean µÄÀàÐÍÊÇ WebServerFactory ²Å´¦Àí + // bean 的类型是 WebServerFactory æ‰�处ç�† if (bean instanceof WebServerFactory) { postProcessBeforeInitialization((WebServerFactory) bean); } @@ -168,12 +168,12 @@ public class WebServerFactoryCustomizerBeanPostProcessor private void postProcessBeforeInitialization(WebServerFactory webServerFactory) { LambdaSafe.callbacks(WebServerFactoryCustomizer.class, getCustomizers(), webServerFactory) .withLogger(WebServerFactoryCustomizerBeanPostProcessor.class) - // ´¦ÀíÅäÖà + // 处ç�†é…�ç½® .invoke((customizer) -> customizer.customize(webServerFactory)); } /** - * »ñÈ¡ WebServerFactoryCustomizer£¬µÃµ½µÄÊÇÒ»¸ö²»¿É±äµÄ List + * 获å�– WebServerFactoryCustomizer,得到的是一个ä¸�å�¯å�˜çš„ List */ private Collection> getCustomizers() { if (this.customizers == null) { @@ -185,7 +185,7 @@ public class WebServerFactoryCustomizerBeanPostProcessor } /** - * »ñÈ¡ beanFactory ÖÐËùÓÐµÄ WebServerFactoryCustomizer + * 获å�– beanFactory 中所有的 WebServerFactoryCustomizer */ private Collection> getWebServerFactoryCustomizerBeans() { return (Collection) this.beanFactory.getBeansOfType( @@ -196,11 +196,11 @@ public class WebServerFactoryCustomizerBeanPostProcessor ``` -Õâ¸öÀàÊÇÓÃÀ´´¦Àí `WebServerFactory` µÄ×Ô¶¨ÒåÅäÖõģ¬ËüʵÏÖÁË `BeanPostProcessor`£¬ ÎÒÃÇÖ÷Òª¹Ø×¢ËüµÄ `postProcessBeforeInitialization(...)` ·½·¨¡£ +这个类是用æ�¥å¤„ç�† `WebServerFactory` 的自定义é…�置的,它实现了 `BeanPostProcessor`, 我们主è¦�关注它的 `postProcessBeforeInitialization(...)` 方法。 -ÔÚ `WebServerFactoryCustomizerBeanPostProcessor` µÄ `postProcessBeforeInitialization(...)` ·½·¨ÖУ¬Èç¹ûµ±Ç° bean µÄÀàÐÍÊÇ `WebServerFactory`£¬»áÏÈ»ñÈ¡ `beanFactory` ÖÐËùÓÐÀàÐÍΪ `WebServerFactoryCustomizer` µÄ bean£¬È»ºó½«ÕâЩ `WebServerFactoryCustomizer` ÅäÖõ½ `WebServerFactory`bean ÖС£ +在 `WebServerFactoryCustomizerBeanPostProcessor` çš„ `postProcessBeforeInitialization(...)` 方法中,如果当å‰� bean 的类型是 `WebServerFactory`,会先获å�– `beanFactory` 中所有类型为 `WebServerFactoryCustomizer` çš„ bean,然å�Žå°†è¿™äº› `WebServerFactoryCustomizer` é…�置到 `WebServerFactory`bean 中。 -Èç¹ûÎÒÃÇÒª×Ô¶¨Òå `Tomcat` µÄÅäÖ㬿ÉÒÔÕâÑù´¦Àí£º +如果我们è¦�自定义 `Tomcat` çš„é…�置,å�¯ä»¥è¿™æ ·å¤„ç�†ï¼š ``` @Component @@ -210,7 +210,7 @@ public class MyCustomizer implements WebServerFactoryCustomizer getRegistrars() { if (this.registrars == null) { - // »ñÈ¡ËùÓеĴíÎóÒ³ + // 获å�–所有的错误页 this.registrars = new ArrayList<>(this.beanFactory.getBeansOfType( ErrorPageRegistrar.class, false, false).values()); this.registrars.sort(AnnotationAwareOrderComparator.INSTANCE); @@ -308,29 +308,29 @@ public class ErrorPageRegistrarBeanPostProcessor implements BeanPostProcessor, B ``` -ÎÒÃÇÖ÷Òª¹Ø×¢ `postProcessBeforeInitialization` µÄÁ÷³Ì£º +我们主è¦�关注 `postProcessBeforeInitialization` çš„æµ�程: -1. Èç¹û bean µÄÀàÐÍÊÇ `ErrorPageRegistry`£¬½øÐÐµÚ 2 ²½ -2. »ñÈ¡ beanFactory ÖÐËùÓÐ `ErrorPageRegistrar` ÀàÐ굀 bean£¬±éÀú½øÐÐµÚ 3 ²½ -3. µ÷Óà `registrar.registerErrorPages(registry)` ½øÐдíÎóÒ³²Ù×÷ +1. 如果 bean 的类型是 `ErrorPageRegistry`,进行第 2 æ­¥ +2. 获å�– beanFactory 中所有 `ErrorPageRegistrar` 类型的 bean,é��历进行第 3 æ­¥ +3. 调用 `registrar.registerErrorPages(registry)` 进行错误页æ“�作 -ÕâÀïÓÐÁ½¸öÀàÐèҪ˵Ã÷£º +这里有两个类需è¦�说明: -* `ErrorPageRegistrar`£º´íÎóÒ³×¢²áÆ÷£¨Èà `ErrorPageRegistry` ¸É»îµÄÀࣩ -* `ErrorPageRegistry`£º´íÎóµÄ×¢²áÆ÷Àࣨʵ¼Ê¸É»îµÄÀࣩ +* `ErrorPageRegistrar`:错误页注册器(让 `ErrorPageRegistry` 干活的类) +* `ErrorPageRegistry`:错误的注册器类(实际干活的类) -Èç¹ûÎÒÃÇÏëÒª×Ô¶¨Òå´íÎóÒ³£¬¿ÉÒÔʵÏÖ `ErrorPageRegistry` ½Ó¿Ú£º +如果我们想è¦�自定义错误页,å�¯ä»¥å®žçް `ErrorPageRegistry` 接å�£ï¼š ``` @Component public class MyErrorPage implements ErrorPageRegistrar { /** - * ×¢²á´íÎóÒ³ + * 注册错误页 */ @Override public void registerErrorPages(ErrorPageRegistry errorPageRegistry) { - // ×îÖÕµ÷ÓõÄÊÇ ErrorPageRegistry#addErrorPages ½øÐÐ×¢²á + // 最终调用的是 ErrorPageRegistry#addErrorPages 进行注册 errorPageRegistry.addErrorPages(new ErrorPage("/error/page")); } } @@ -339,16 +339,16 @@ public class MyErrorPage implements ErrorPageRegistrar { #### 2.2 `EmbeddedTomcat` -½øÈë `ServletWebServerFactoryConfiguration.EmbeddedTomcat` Àࣺ +进入 `ServletWebServerFactoryConfiguration.EmbeddedTomcat` 类: ``` @Configuration(proxyBeanMethods = false) class ServletWebServerFactoryConfiguration { @Configuration(proxyBeanMethods = false) - // Ìõ¼þ×¢½â£¬Ìõ¼þ´æÔÚʱ²ÅÒýÈë + // æ�¡ä»¶æ³¨è§£ï¼Œæ�¡ä»¶å­˜åœ¨æ—¶æ‰�引入 @ConditionalOnClass({ Servlet.class, Tomcat.class, UpgradeProtocol.class }) - // ×¢Òâ ServletWebServerFactory£¬ÎÒÃÇ¿ÉÒÔ×ÔÖ÷ʵÏÖ tomcat ÈÝÆ÷µÄ×°Åä + // 注æ„� ServletWebServerFactory,我们å�¯ä»¥è‡ªä¸»å®žçް tomcat 容器的装é…� @ConditionalOnMissingBean(value = ServletWebServerFactory.class, search = SearchStrategy.CURRENT) public static class EmbeddedTomcat { @@ -359,7 +359,7 @@ class ServletWebServerFactoryConfiguration { ObjectProvider contextCustomizers, ObjectProvider> protocolHandlerCustomizers) { TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory(); - // ÅäÖÃһЩ²ÎÊý + // é…�置一些å�‚æ•° factory.getTomcatConnectorCustomizers() .addAll(connectorCustomizers.orderedStream().collect(Collectors.toList())); factory.getTomcatContextCustomizers() @@ -377,28 +377,28 @@ class ServletWebServerFactoryConfiguration { ``` -Õâ¸öÀàÖ÷Òª¾ÍÊÇ·µ»Ø `TomcatServletWebServerFactory` bean£¬¿ÉÒÔ×¢ÈëһЩ `connectorCustomizers`¡¢`contextCustomizers`¡¢`protocolHandlerCustomizers` µÈ²ÎÊý½øÐÐ×Ô¶¨ÒåÅäÖã¬ÕâЩ²ÎÊý¾ÍÊÇ´Ó `BeanPostProcessorsRegistrar` ÖÐÀ´µÄ¡£ +这个类主è¦�就是返回 `TomcatServletWebServerFactory` bean,å�¯ä»¥æ³¨å…¥ä¸€äº› `connectorCustomizers`ã€�`contextCustomizers`ã€�`protocolHandlerCustomizers` ç­‰å�‚数进行自定义é…�置,这些å�‚数就是从 `BeanPostProcessorsRegistrar` 中æ�¥çš„。 -ÕâÀïÓиöµØ·½ÐèÒªÌáһϣ¬Èç¹û²»ÏëʹÓà springboot ÌṩµÄ `TomcatServletWebServerFactory`£¬ÎÒÃÇ¿ÉÒÔ×Ô¼ºÊµÏÖ `TomcatServletWebServerFactory`£¬ÏñÕâÑù£º +这里有个地方需è¦�æ��一下,如果ä¸�想使用 springboot æ��供的 `TomcatServletWebServerFactory`,我们å�¯ä»¥è‡ªå·±å®žçް `TomcatServletWebServerFactory`,åƒ�这样: ``` @Bean public ServletWebServerFactory servletWebServerFactory() { TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory(); - // ´¦Àí×Ô¶¨ÒåµÄ¸÷ÖÖÅäÖà + // 处ç�†è‡ªå®šä¹‰çš„å�„ç§�é…�ç½® ... return tomcat; } ``` -ÕâÑù´¦ÀíÖ®ºó£¬springboot ÌṩµÄ `tomcatServletWebServerFactory` ¾Í²»»á´¦ÀíÁË¡£ +这样处ç�†ä¹‹å�Žï¼Œspringboot æ��供的 `tomcatServletWebServerFactory` å°±ä¸�会处ç�†äº†ã€‚ -ÆäËûÁ½¸öÀà `EmbeddedJetty`¡¢`EmbeddedUndertow`£¬¸ú `EmbeddedTomcat` µÄ´¦Àí»ù±¾ÏàËÆ£¬¾Í²»¶à˵ÁË¡£ +其他两个类 `EmbeddedJetty`ã€�`EmbeddedUndertow`,跟 `EmbeddedTomcat` 的处ç�†åŸºæœ¬ç›¸ä¼¼ï¼Œå°±ä¸�多说了。 ### 3. `DispatcherServletAutoConfiguration` -ÎÒÃÇÔÙÀ´¿´¿´ `DispatcherServletAutoConfiguration`£¬¹Ø¼ü´úÂëÈçÏ£º +我们å†�æ�¥çœ‹çœ‹ `DispatcherServletAutoConfiguration`,关键代ç �如下: ``` public class DispatcherServletAutoConfiguration { @@ -415,10 +415,10 @@ public class DispatcherServletAutoConfiguration { protected static class DispatcherServletConfiguration { /** - * ´óÃû¶¦¶¦µÄ DispatcherServlet. - * @param httpProperties httpÊôÐÔ. - * @param webMvcProperties webMvc ÊôÐÔ. - * @return ·µ»Ø¶ÔÏó + * 大å��鼎鼎的 DispatcherServlet. + * @param httpProperties http属性. + * @param webMvcProperties webMvc 属性. + * @return 返回对象 */ @Bean(name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME) public DispatcherServlet dispatcherServlet(HttpProperties httpProperties, @@ -435,9 +435,9 @@ public class DispatcherServletAutoConfiguration { } /** - * ÎļþÉÏ´«×é¼þ. - * @param resolver ²ÎÊý. - * @return ·µ»ØÖµ. + * 文件上传组件. + * @param resolver å�‚æ•°. + * @return 返回值. */ @Bean @ConditionalOnBean(MultipartResolver.class) @@ -449,8 +449,8 @@ public class DispatcherServletAutoConfiguration { } /** - * Éú³É DispatcherServletRegistrationBean - * Ëü»á½«dispatcherServlet×¢²áµ½servletÈÝÆ÷ + * 生æˆ� DispatcherServletRegistrationBean + * 它会将dispatcherServlet注册到servlet容器 */ @Configuration(proxyBeanMethods = false) @Conditional(DispatcherServletRegistrationCondition.class) @@ -465,7 +465,7 @@ public class DispatcherServletAutoConfiguration { public DispatcherServletRegistrationBean dispatcherServletRegistration( DispatcherServlet dispatcherServlet, WebMvcProperties webMvcProperties, ObjectProvider multipartConfig) { - // Éú³É DispatcherServletRegistrationBean£¨Ëü»á½«dispatcherServlet×¢²áµ½servletÈÝÆ÷£© + // 生æˆ� DispatcherServletRegistrationBean(它会将dispatcherServlet注册到servlet容器) DispatcherServletRegistrationBean registration = new DispatcherServletRegistrationBean(dispatcherServlet, webMvcProperties.getServlet().getPath()); @@ -483,20 +483,20 @@ public class DispatcherServletAutoConfiguration { ``` -ËüÖ÷ÒªÊÇ×¢²áÁË 3 ¸ö bean£º +它主è¦�是注册了 3 个 bean: -* `dispatcherServlet`£ºspringMvc µÄÇëÇóÈë¿Ú£¬url ÇëÇóÓɴ˽øÈ룬Ȼºóת»¯µ½ `requestMapping` -* `multipartResolver`£º´¦ÀíÎļþÉÏ´« -* `dispatcherServletRegistration`£º´¦Àí `dispatcherServlet` µÄ×¢²á£¬Ëü»á½« `dispatcherServlet` ×¢²áµ½ servlet ÈÝÆ÷ÖУ¨¹ØÓÚ springboot ×¢²á servlet ×é¼þµÄÄÚÈÝ£¬¿ÉÒԲο¼ [springboot web Ó¦ÓÃÖ® servlet ×é¼þµÄ×¢²áÁ÷³Ì](https://my.oschina.net/funcy/blog/4951050)£© +* `dispatcherServlet`:springMvc 的请求入å�£ï¼Œurl 请求由此进入,然å�Žè½¬åŒ–到 `requestMapping` +* `multipartResolver`:处ç�†æ–‡ä»¶ä¸Šä¼  +* `dispatcherServletRegistration`:处ç�† `dispatcherServlet` 的注册,它会将 `dispatcherServlet` 注册到 servlet 容器中(关于 springboot 注册 servlet 组件的内容,å�¯ä»¥å�‚考 [springboot web 应用之 servlet 组件的注册æµ�程](https://my.oschina.net/funcy/blog/4951050)) ### 4. `WebMvcAutoConfiguration` -¼ÌÐø¿´ `WebMvcAutoConfiguration`: +继续看 `WebMvcAutoConfiguration`: ``` @Configuration(proxyBeanMethods = false) ... -// Èç¹ûûÓÐ×Ô¶¨ÒåWebMvcµÄÅäÖÃÀ࣬ÔòʹÓñ¾ÅäÖà +// 如果没有自定义WebMvcçš„é…�置类,则使用本é…�ç½® @ConditionalOnMissingBean(WebMvcConfigurationSupport.class) ... public class WebMvcAutoConfiguration { @@ -505,31 +505,31 @@ public class WebMvcAutoConfiguration { ``` -`WebMvcAutoConfiguration` ÉÏÓиö×¢½âÐèҪעÒâÏ£º +`WebMvcAutoConfiguration` 上有个注解需è¦�注æ„�下: ``` @ConditionalOnMissingBean(WebMvcConfigurationSupport.class) ``` -ÕâÐдúÂë±íÃ÷ÁË `WebMvcAutoConfiguration` Ö»ÓÐÔÚ `WebMvcConfigurationSupport` ÀàÐ굀 bean ²»´æÔÚʱ£¬Ëü²Å»á½øÐÐ×Ô¶¯×°Åä¡£ +这行代ç �表明了 `WebMvcAutoConfiguration` å�ªæœ‰åœ¨ `WebMvcConfigurationSupport` 类型的 bean ä¸�存在时,它æ‰�会进行自动装é…�。 -`WebMvcConfigurationSupport` ÊǸöɶĨ£¿ÔÚ [springmvc demo Óë @EnableWebMvc ×¢½â](https://my.oschina.net/funcy/blog/4696657)Ò»ÎÄÖУ¬ÎÒÃÇÌáµ½ÒýÈë springMvc ×é¼þµÄÁ½ÖÖ·½Ê½£º +`WebMvcConfigurationSupport` 是个啥呢?在 [springmvc demo 与 @EnableWebMvc 注解](https://my.oschina.net/funcy/blog/4696657)一文中,我们æ��到引入 springMvc 组件的两ç§�æ–¹å¼�: -* ʹÓà `@EnableWebMvc` ×¢½â -* ¼Ì³Ð `WebMvcConfigurationSupport` Àà +* 使用 `@EnableWebMvc` 注解 +* 继承 `WebMvcConfigurationSupport` ç±» -¶øÕâÖÖ·½·¨×îÖÕ¶¼»áÏò spring ÈÝÆ÷ÖÐÒýÈëÀàÐÍΪ `WebMvcConfigurationSupport` µÄ bean£¬Òò´ËÔÚ `springboot` ÏîÄ¿ÖУ¬Èç¹ûÎÒÃǽøÐÐÁËÒÔÉÏÁ½ÖÖ²Ù×÷Ö®Ò»£¬ÄÇô¾ÍÒýÈëÁË `WebMvcConfigurationSupport`£¬`WebMvcAutoConfiguration` µÄ×Ô¶¯×°Åä¾Í²»Ö´ÐÐÁË¡£ +而这ç§�方法最终都会å�‘ spring 容器中引入类型为 `WebMvcConfigurationSupport` çš„ bean,因此在 `springboot` 项目中,如果我们进行了以上两ç§�æ“�作之一,那么就引入了 `WebMvcConfigurationSupport`,`WebMvcAutoConfiguration` 的自动装é…�å°±ä¸�执行了。 -ÎÒÃÇÔÙÀ´¿´¿´ `WebMvcAutoConfiguration` ×°ÅäµÄ bean¡£ +我们å†�æ�¥çœ‹çœ‹ `WebMvcAutoConfiguration` 装é…�çš„ bean。 #### 4.1 `WebMvcAutoConfigurationAdapter` -`WebMvcAutoConfigurationAdapter` ÊÇ `WebMvcAutoConfiguration` µÄÄÚ²¿À࣬¶¨ÒåÈçÏ£º +`WebMvcAutoConfigurationAdapter` 是 `WebMvcAutoConfiguration` 的内部类,定义如下: ``` @Configuration(proxyBeanMethods = false) -// ÒýÈëÁË EnableWebMvcConfiguration +// 引入了 EnableWebMvcConfiguration @Import(EnableWebMvcConfiguration.class) @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class }) @Order(0) @@ -539,7 +539,7 @@ public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer { ``` -ËüʵÏÖÁË `WebMvcConfigurer`£¬ÇÒÒýÈëÁË `EnableWebMvcConfiguration`¡£`WebMvcConfigurer` ¿ÉÒÔÓÃÀ´´¦Àí springMvc µÄÅäÖã¬Ö»ÐèÒªÖØÐ´ÆäÖжÔÓ¦µÄ·½·¨¼´¿É£¬`EnableWebMvcConfiguration` ´ÓÃû³ÆÀ´¿´£¬ÊÇ ¡°ÆôÓà webMvc ÅäÖá±£¬ËüÒ²ÊÇ `WebMvcAutoConfiguration` µÄÄÚ²¿À࣬ÎÒÃÇÀ´¿´¿´Ëü×öÁËɶ£º +它实现了 `WebMvcConfigurer`,且引入了 `EnableWebMvcConfiguration`。`WebMvcConfigurer` å�¯ä»¥ç”¨æ�¥å¤„ç�† springMvc çš„é…�置,å�ªéœ€è¦�é‡�写其中对应的方法å�³å�¯ï¼Œ`EnableWebMvcConfiguration` 从å��ç§°æ�¥çœ‹ï¼Œæ˜¯ “å�¯ç”¨ webMvc é…�ç½®â€�,它也是 `WebMvcAutoConfiguration` 的内部类,我们æ�¥çœ‹çœ‹å®ƒå�šäº†å•¥ï¼š ``` @Configuration(proxyBeanMethods = false) @@ -550,7 +550,7 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat ``` -¿ÉÒÔ¿´µ½£¬ËüÊÇ `DelegatingWebMvcConfiguration` µÄ×ÓÀ࣬¶ø `DelegatingWebMvcConfiguration` ÓÖÊǸöɶĨ£¿ÎÒÃÇÒ²À´¿´¿´ËüµÄ¶¨Ò壺 +å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒæ˜¯ `DelegatingWebMvcConfiguration` çš„å­�类,而 `DelegatingWebMvcConfiguration` å�ˆæ˜¯ä¸ªå•¥å‘¢ï¼Ÿæˆ‘们也æ�¥çœ‹çœ‹å®ƒçš„定义: ``` @Configuration(proxyBeanMethods = false) @@ -560,15 +560,15 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { ``` -`DelegatingWebMvcConfiguration` ÊÇÓÉ springMvc ÌṩµÄ£¬¿ÉÒÔ¿´µ½£¬ËüʵÏÖÁË `WebMvcConfigurationSupport`£¬Òò´Ë£¬springboot ͨ¹ý `@Import(EnableWebMvcConfiguration.class)` µÄ·½Ê½Ïò spring ÈÝÆ÷ÖÐÒýÈëÁË `WebMvcConfigurationSupport` ÀàÐ굀 bean¡£ +`DelegatingWebMvcConfiguration` 是由 springMvc æ��供的,å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒå®žçŽ°äº† `WebMvcConfigurationSupport`,因此,springboot 通过 `@Import(EnableWebMvcConfiguration.class)` 的方å¼�å�‘ spring 容器中引入了 `WebMvcConfigurationSupport` 类型的 bean。 -ÊÂʵÉÏ£¬`DelegatingWebMvcConfiguration` ÕýÊÇ `@EnableWebMvc` ÒýÈëµÄ bean£º +事实上,`DelegatingWebMvcConfiguration` 正是 `@EnableWebMvc` 引入的 bean: ``` @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Documented -// ÒýÈëÁË DelegatingWebMvcConfiguration +// 引入了 DelegatingWebMvcConfiguration @Import(DelegatingWebMvcConfiguration.class) public @interface EnableWebMvc { ... @@ -576,13 +576,13 @@ public @interface EnableWebMvc { ``` -springbot ²»Ö±½ÓÒýÈë `DelegatingWebMvcConfiguration` ¶øÊÇÒýÈëËüµÄ×ÓÀà `EnableWebMvcConfiguration`£¬ËäÈ»ËüÊÇ×öÁËһЩ×Ô¶¨ÒåÅäÖõġ£ +springbot ä¸�直接引入 `DelegatingWebMvcConfiguration` 而是引入它的å­�ç±» `EnableWebMvcConfiguration`,虽然它是å�šäº†ä¸€äº›è‡ªå®šä¹‰é…�置的。 -¹ØÓÚ `EnableWebMvcConfiguration` ÅäÖÃÁËЩɶ£¬ÎÒÃÇÒ»»áÔÙ·ÖÎö£¬¼ÌÐø·ÖÎö `WebMvcAutoConfigurationAdapter` µÄÒýÈë bean£º +关于 `EnableWebMvcConfiguration` é…�置了些啥,我们一会å†�分æž�,继续分æž� `WebMvcAutoConfigurationAdapter` 的引入 bean: ``` /** - * http ÏûϢת»»Æ÷. + * http 消æ�¯è½¬æ�¢å™¨. */ @Override public void configureMessageConverters(List> converters) { @@ -591,7 +591,7 @@ public void configureMessageConverters(List> converters) } /** - * ÊÓͼ½âÎöÆ÷. + * 视图解æž�器. */ @Bean @ConditionalOnMissingBean @@ -622,7 +622,7 @@ public ContentNegotiatingViewResolver viewResolver(BeanFactory beanFactory) { } /** - * ÒýÈë¹ú¼Ê»¯ÅäÖÃ. + * 引入国际化é…�ç½®. */ @Bean @ConditionalOnMissingBean @@ -637,7 +637,7 @@ public LocaleResolver localeResolver() { } /** - * ¾²Ì¬×ÊÔ´Ó³Éä + * é�™æ€�资æº�映射 */ @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { @@ -645,7 +645,7 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) { logger.debug("Default resource handling disabled"); return; } - // Ó³Éäwebjars + // 映射webjars Duration cachePeriod = this.resourceProperties.getCache().getPeriod(); CacheControl cacheControl = this.resourceProperties.getCache() .getCachecontrol().toHttpCacheControl(); @@ -654,11 +654,11 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) { .addResourceLocations("classpath:/META-INF/resources/webjars/") .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl)); } - // Ó³É侲̬×ÊԴ·¾¶ + // 映射é�™æ€�资æº�路径 String staticPathPattern = this.mvcProperties.getStaticPathPattern(); if (!registry.hasMappingForPattern(staticPathPattern)) { customizeResourceHandlerRegistration(registry.addResourceHandler(staticPathPattern) - // staticLocations ĬÈÏΪ classpath:[/META-INF/resources/, + // staticLocations 默认为 classpath:[/META-INF/resources/, // /resources/, /static/, /public/] .addResourceLocations(getResourceLocations( this.resourceProperties.getStaticLocations())) @@ -668,15 +668,15 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) { ``` -¿ÉÒÔ¿´µ½£¬`WebMvcAutoConfigurationAdapter` ÒýÈëÁËÈýÀà bean: +å�¯ä»¥çœ‹åˆ°ï¼Œ`WebMvcAutoConfigurationAdapter` 引入了三类 bean: -1. http ÏûϢת»»Æ÷ -2. ÊÓͼ½âÎöÆ÷ -3. ¹ú¼Ê»¯ÅäÖà +1. http 消æ�¯è½¬æ�¢å™¨ +2. 视图解æž�器 +3. 国际化é…�ç½® -ÕâÀïÎÒÃÇÖØµãÀ´¿´¿´ `httpÏûϢת»»Æ÷`¡£ÔÚʹÓà springMvc ʱ£¬Í¨¹ýÔÚ `Controller` Àà»òÆäÖеķ½·¨Éϱê¼Ç `@ResponseBody`£¬·µ»Ø²ÎÊý¾Í»áת»»Îª json£¬Õâ¾ÍÊÇ `httpÏûϢת»»Æ÷`Ëù×öµÄ¹¤×÷ÁË¡£springboot ĬÈ쵀 jaon ´¦ÀíÊÇ `jackson`£¬ËüµÄʵÀý»¯ÔÚ `JacksonAutoConfiguration` ÖУ¬×°ÅäΪ `HttpMessageConverter` µÄ´¦ÀíÔÚ `JacksonHttpMessageConvertersConfiguration`£¬ÕâÀï¾Í²»Õ¹¿ªÁË¡£ +这里我们é‡�点æ�¥çœ‹çœ‹ `http消æ�¯è½¬æ�¢å™¨`。在使用 springMvc 时,通过在 `Controller` 类或其中的方法上标记 `@ResponseBody`,返回å�‚数就会转æ�¢ä¸º json,这就是 `http消æ�¯è½¬æ�¢å™¨`所å�šçš„工作了。springboot 默认的 jaon 处ç�†æ˜¯ `jackson`,它的实例化在 `JacksonAutoConfiguration` 中,装é…�为 `HttpMessageConverter` 的处ç�†åœ¨ `JacksonHttpMessageConvertersConfiguration`,这里就ä¸�展开了。 -ÔÚÉÏÃæ µÄ·ÖÎöÖУ¬¶à´Î³öÏÖÁË `WebMvcProperties` ÅäÖã¬ÎÒÃÇÀ´¿´¿´ËüÊǸöɶ£º +在上é�¢ 的分æž�中,多次出现了 `WebMvcProperties` é…�置,我们æ�¥çœ‹çœ‹å®ƒæ˜¯ä¸ªå•¥ï¼š ``` @ConfigurationProperties(prefix = "spring.mvc") @@ -686,20 +686,20 @@ public class WebMvcProperties { ``` -ºÜÃ÷ÏÔ£¬ËüÊǸöÅäÖÃÀà £¬¿ÉÒÔ¿´µ½£¬ËüµÄÅäÖÃǰ׺Ϊ `spring.mvc`£¬Ö§³ÖµÄÅäÖÃÈçÏ£º +很明显,它是个é…�置类 ,å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒçš„é…�ç½®å‰�缀为 `spring.mvc`,支æŒ�çš„é…�置如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-062f490afbb74e496f50f4cad4bd13ede82.png) #### 4.2 `EnableWebMvcConfiguration` -ÎÒÃÇÀ´¿´¿´ `EnableWebMvcConfiguration` ×Ô¶¨ÒåµÄÅäÖ㺠+我们æ�¥çœ‹çœ‹ `EnableWebMvcConfiguration` 自定义的é…�置: ``` public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware { /** - * ÅäÖÃÊÊÅäÆ÷ + * é…�置适é…�器 */ @Bean @Override @@ -716,7 +716,7 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat } /** - * ·¾¶Ó³Éä + * 路径映射 */ @Bean @Primary @@ -732,7 +732,7 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat } /** - * »¶Ó­Ò³ + * 欢迎页 */ @Bean public WelcomePageHandlerMapping welcomePageHandlerMapping( @@ -748,7 +748,7 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat } /** - * mvcÅäÖã¬Ìí¼ÓÁËÈÕÆÚ¸ñʽµÄ´¦Àí + * mvcé…�置,添加了日期格å¼�的处ç�† */ @Bean @Override @@ -760,7 +760,7 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat } /** - * ²ÎÊýУÑéÆ÷ + * å�‚数校验器 */ @Bean @Override @@ -772,7 +772,7 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat } /** - * Òì³£´¦Àí + * 异常处ç�† */ @Override protected ExceptionHandlerExceptionResolver createExceptionHandlerExceptionResolver() { @@ -801,15 +801,15 @@ public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfigurat ``` -Ïà±ÈÓÚÔ­ÉúµÄ springMvc£¬Ëü¶îÍâÅäÖÃÁËÊÊÅäÆ÷¡¢Â·¾¶Ó³Éä¡¢²ÎÊýУÑé¡¢Òì³£´¦ÀíµÈ¡£ +相比于原生的 springMvc,它é¢�外é…�置了适é…�器ã€�路径映射ã€�å�‚数校验ã€�异常处ç�†ç­‰ã€‚ -### 5\. ×ܽá +### 5\. 总结 -1. `webMvc` ÔÚ×°Åäʱ£¬ÏÈ×°Åä `ServletWebServerFactoryAutoConfiguration`£¬ÔÙ×°Åä `DispatcherServletAutoConfiguration`£¬×îºó×°Åä `WebMvcAutoConfiguration` -2. `ServletWebServerFactoryAutoConfiguration` ´¦Àí servlet ÈÝÆ÷µÄ×°Å䣬`DispatcherServletAutoConfiguration` ´¦Àí `DispatcherServlet` µÄ×°Å䣬`WebMvcAutoConfiguration` ´¦Àí `webMvc` ×é¼þ£¨ÏûϢת»»Æ÷¡¢ÊÓͼ½âÎöÆ÷¡¢¾²Ì¬×ÊÔ´Ó³ÉäµÈ£©µÄ×°Åä -3. Èç¹ûÏò spring ÈÝÆ÷ÖÐÒýÈëÁË `WebMvcConfigurationSupport`£¬ `WebMvcAutoConfiguration` µÄ×°Åä²Ù×÷½«²»»áÖ´ÐÐ -4. `servlet` µÄÏà¹ØÅäÖÃÒÔ `servlet` Ϊǰ׺£¬`webMvc` µÄÅäÖÃÒÔ `spring.mvc` Ϊǰ׺£¬ÎÒÃÇ¿ÉÒÔÔÚÅäÖÃÎļþ£¨Ò»°ãΪ `application.properties/application.yml`£©ÖнøÐÐÅäÖà +1. `webMvc` 在装é…�时,先装é…� `ServletWebServerFactoryAutoConfiguration`,å†�装é…� `DispatcherServletAutoConfiguration`,最å�Žè£…é…� `WebMvcAutoConfiguration` +2. `ServletWebServerFactoryAutoConfiguration` 处ç�† servlet 容器的装é…�,`DispatcherServletAutoConfiguration` 处ç�† `DispatcherServlet` 的装é…�,`WebMvcAutoConfiguration` 处ç�† `webMvc` 组件(消æ�¯è½¬æ�¢å™¨ã€�视图解æž�器ã€�é�™æ€�资æº�映射等)的装é…� +3. 如果å�‘ spring 容器中引入了 `WebMvcConfigurationSupport`, `WebMvcAutoConfiguration` 的装é…�æ“�作将ä¸�会执行 +4. `servlet` 的相关é…�置以 `servlet` 为å‰�缀,`webMvc` çš„é…�置以 `spring.mvc` 为å‰�缀,我们å�¯ä»¥åœ¨é…�置文件(一般为 `application.properties/application.yml`)中进行é…�ç½® * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4921595](https://my.oschina.net/funcy/blog/4921595) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4921595](https://my.oschina.net/funcy/blog/4921595) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\357\274\232\345\207\206\345\244\207SpringApplication.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\357\274\232\345\207\206\345\244\207SpringApplication.md" index ece7a22..1afd990 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\357\274\232\345\207\206\345\244\207SpringApplication.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\357\274\232\345\207\206\345\244\207SpringApplication.md" @@ -1,39 +1,39 @@ -±¾ÎÄÀ´Ì½¾¿ springboot ÊÇÈçºÎÆô¶¯µÄ£¬±¾ÎÄʹÓõ½µÄ demo λÓÚ?[gitee/funcy](https://gitee.com/funcy/spring-boot/tree/v2.2.2.RELEASE_learn/spring-boot-project/spring-boot-learn/src/main/java/org/springframework/boot/learn/autoconfigure/demo01). +本文æ�¥æŽ¢ç©¶ springboot 是如何å�¯åŠ¨çš„ï¼Œæœ¬æ–‡ä½¿ç”¨åˆ°çš„ demo ä½�于?[gitee/funcy](https://gitee.com/funcy/spring-boot/tree/v2.2.2.RELEASE_learn/spring-boot-project/spring-boot-learn/src/main/java/org/springframework/boot/learn/autoconfigure/demo01). -## 1\. ´Ó?`Demo01Application#main(...)`?¿ªÊ¼ +## 1\. 从?`Demo01Application#main(...)`?开始 -springboot µÄÆô¶¯·½Ê½·Ç³£¼òµ¥£¬¾ÍÒ»ÐУº +springboot çš„å�¯åŠ¨æ–¹å¼�é�žå¸¸ç®€å�•,就一行: ``` @SpringBootApplication public class Demo01Application { public static void main(String[] args) { - // ÕâÒ»ÐоÍÊÇÓÃÀ´Æô¶¯springbootµÄ + // 这一行就是用æ�¥å�¯åЍspringbootçš„ SpringApplication.run(Demo01Application.class, args); } } ``` -È»ºóÎÒÃǾͽøÈëÕâ¸ö·½·¨£¬¿´¿´Ëü¸ÉÁËʲô£º +ç„¶å�Žæˆ‘们就进入这个方法,看看它干了什么: ``` public class SpringApplication { ... - // primarySource ¾ÍÊÇÎÒÃÇ´«ÈëµÄ Demo01Application.class£¬ - // args ¾ÍÊÇ main() ·½·¨µÄ²ÎÊý + // primarySource 就是我们传入的 Demo01Application.class, + // args 就是 main() 方法的å�‚æ•° public static ConfigurableApplicationContext run( Class primarySource, String... args) { - // ½« primarySource °ü×°³ÉÊý×飬¼ÌÐøµ÷Óà run(...) ·½·¨ + // å°† primarySource 包装æˆ�数组,继续调用 run(...) 方法 return run(new Class[] { primarySource }, args); } - // primarySources ¾ÍÊÇÎÒÃÇ´«ÈëµÄ Demo01Application.class °ü×°³ÉµÄÊý×飬 - // args ¾ÍÊÇ main() ·½·¨µÄ²ÎÊý + // primarySources 就是我们传入的 Demo01Application.class 包装æˆ�的数组, + // args 就是 main() 方法的å�‚æ•° public static ConfigurableApplicationContext run( Class[] primarySources, String[] args) { - // ÕâÀ↑ʼ¸ÉÕýÊÂÁË + // 这里开始干正事了 return new SpringApplication(primarySources).run(args); } ... @@ -41,69 +41,69 @@ public class SpringApplication { ``` -ͨ¹ý·½·¨Ò»²½²½×·²éÏÂÈ¥ºó£¬×îºóµ½ÁË?`SpringApplication#run(Class[], String[])`?·½·¨£¬¹Ø¼ü´úÂëÈçÏ£º +通过方法一步步追查下去å�Žï¼Œæœ€å�Žåˆ°äº†?`SpringApplication#run(Class[], String[])`?方法,关键代ç �如下: ``` return new SpringApplication(primarySources).run(args); ``` -Õâ¿é´úÂëÐèÒª²ð¿ªÀ´¿´£¬¿ÉÒÔ²ð³ÉÒÔÏÂÁ½²¿·Ö£º +è¿™å�—代ç �需è¦�拆开æ�¥çœ‹ï¼Œå�¯ä»¥æ‹†æˆ�以下两部分: -* ¹¹Ôì·½·¨£º`SpringApplication#SpringApplication(Class...)` -* ʵÀý·½·¨£º`SpringApplication#run(String...)` +* 构造方法:`SpringApplication#SpringApplication(Class...)` +* 实例方法:`SpringApplication#run(String...)` -¿´À´£¬ÕâÁ½¸ö·½·¨¾ÍÊÇ springboot µÄÆô¶¯ËùÓÐÁ÷³ÌÁË£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÕâÁ½¸ö·½·¨¡£ +看æ�¥ï¼Œè¿™ä¸¤ä¸ªæ–¹æ³•就是 springboot çš„å�¯åŠ¨æ‰€æœ‰æµ�程了,接下æ�¥æˆ‘们就æ�¥åˆ†æž�这两个方法。 -## 2\. ´´½¨?`SpringApplication`£º`SpringApplication#SpringApplication(Class...)` +## 2\. 创建?`SpringApplication`:`SpringApplication#SpringApplication(Class...)` ``` public class SpringApplication { public SpringApplication(Class... primarySources) { - // ¼ÌÐøµ÷Óà + // 继续调用 this(null, primarySources); } /** - * ÕâÀï¾Í×îÖÕµ÷ÓõĹ¹Ôì·½·¨ÁË - * resourceLoader Ϊ null - * primarySources Ϊ Demo01Application.class + * 这里就最终调用的构造方法了 + * resourceLoader 为 null + * primarySources 为 Demo01Application.class */ @SuppressWarnings({ "unchecked", "rawtypes" }) public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) { - // 1\. ½«´«ÈëµÄresourceLoaderÉèÖõ½³ÉÔ±±äÁ¿£¬ÕâÀïµÄֵΪnull + // 1\. 将传入的resourceLoader设置到æˆ�员å�˜é‡�,这里的值为null this.resourceLoader = resourceLoader; Assert.notNull(primarySources, "PrimarySources must not be null"); - // 2\. ½«´«ÈëµÄprimarySourcesÉèÖõ½³ÉÔ±±äÁ¿£¬ÕâÀïµÄֵΪ Demo01Application.class + // 2\. 将传入的primarySources设置到æˆ�员å�˜é‡�,这里的值为 Demo01Application.class this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources)); - // 3\. µ±Ç°µÄ web Ó¦ÓÃÀàÐÍ£¬REACTIVE£¬NONE£¬SERVLET + // 3\. 当å‰�çš„ web 应用类型,REACTIVE,NONE,SERVLET this.webApplicationType = WebApplicationType.deduceFromClasspath(); - // 4\. ÉèÖóõʼ»¯Æ÷£¬getSpringFactoriesInstances£º´Ó META-INF/spring.factories ÖлñÈ¡ÅäÖà + // 4\. 设置åˆ�始化器,getSpringFactoriesInstances:从 META-INF/spring.factories 中获å�–é…�ç½® setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class)); - // 5\. ÉèÖüàÌýÆ÷£¬getSpringFactoriesInstances£º´Ó META-INF/spring.factories ÖлñÈ¡ÅäÖà + // 5\. 设置监å�¬å™¨ï¼ŒgetSpringFactoriesInstances:从 META-INF/spring.factories 中获å�–é…�ç½® setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class)); - // 6\. ·µ»Ø°üº¬main()·½·¨µÄclass + // 6\. 返回包å�«main()方法的class this.mainApplicationClass = deduceMainApplicationClass(); } } ``` -Õâ¸ö·½·¨Ëù×öµÄÊ»¹ÊDZȽÏÇåÎúµÄ£¬Ïà¹ØÄÚÈݶ¼ÒÑÔÚ´úÂëÖÐ×¢ÊÍÁË£¬²»¹ýÓÐЩ·½·¨»¹ÐèÒªÕ¹¿ª£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´¿´¿´¡£ +这个方法所å�šçš„事还是比较清晰的,相关内容都已在代ç �中注释了,ä¸�过有些方法还需è¦�展开,接下æ�¥æˆ‘们就æ�¥çœ‹çœ‹ã€‚ -### 2.1 »ñÈ¡µ±Ç° web Ó¦ÓÃÀàÐÍ£º`WebApplicationType.deduceFromClasspath()` +### 2.1 获å�–当å‰� web 应用类型:`WebApplicationType.deduceFromClasspath()` -`WebApplicationType.deduceFromClasspath()`?·½·¨ÊÇÓÃÀ´Íƶϵ±Ç°ÏîÄ¿ÊÇʲôÀàÐ͵쬴úÂëÈçÏ£º +`WebApplicationType.deduceFromClasspath()`?方法是用æ�¥æŽ¨æ–­å½“å‰�项目是什么类型的,代ç �如下: ``` public enum WebApplicationType { - // ²»ÊÇ web Ó¦Óà + // ä¸�是 web 应用 NONE, - // servlet ÀàÐ굀 web Ó¦Óà + // servlet 类型的 web 应用 SERVLET, - // reactive ÀàÐ굀 web Ó¦Óà + // reactive 类型的 web 应用 REACTIVE; ... @@ -122,20 +122,20 @@ public enum WebApplicationType { = "org.glassfish.jersey.servlet.ServletContainer"; static WebApplicationType deduceFromClasspath() { - // classpath Öнö´æÔÚ WEBFLUX Ïà¹ØÀà + // classpath 中仅存在 WEBFLUX 相关类 if (ClassUtils.isPresent(WEBFLUX_INDICATOR_CLASS, null) && !ClassUtils.isPresent(WEBMVC_INDICATOR_CLASS, null) && !ClassUtils.isPresent(JERSEY_INDICATOR_CLASS, null)) { return WebApplicationType.REACTIVE; } - // classpath ²»´æÔÚ SERVLET Ïà¹ØÀà + // classpath ä¸�存在 SERVLET 相关类 for (String className : SERVLET_INDICATOR_CLASSES) { if (!ClassUtils.isPresent(className, null)) { return WebApplicationType.NONE; } } - // ĬÈÏ web ÀàÐÍΪ SERVLET - // Ò²¾ÍÊÇ˵£¬Í¬Ê±´æÔÚ WEBFLUX Óë SERVLET Ïà¹ØÀ࣬×îÖÕ·µ»ØµÄÊÇ SERVLET + // 默认 web 类型为 SERVLET + // 也就是说,å�Œæ—¶å­˜åœ¨ WEBFLUX 与 SERVLET 相关类,最终返回的是 SERVLET return WebApplicationType.SERVLET; } @@ -144,54 +144,54 @@ public enum WebApplicationType { ``` -¿ÉÒÔ¿´µ½£¬springboot ¶¨ÒåÁËÈýÖÖÏîÄ¿ÀàÐÍ£º`NONE`(²»ÊÇ web Ó¦ÓÃ)¡¢`SERVLET`(`servlet`?ÀàÐ굀 web Ó¦ÓÃ)¡¢`REACTIVE`(`reactive`?ÀàÐ굀 web Ó¦ÓÃ)£¬`WebApplicationType.deduceFromClasspath()`?µÄÖ´ÐÐÁ÷³ÌÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œspringboot 定义了三ç§�项目类型:`NONE`(ä¸�是 web 应用)ã€�`SERVLET`(`servlet`?类型的 web 应用)ã€�`REACTIVE`(`reactive`?类型的 web 应用),`WebApplicationType.deduceFromClasspath()`?的执行æµ�程如下: -1. Èç¹û?`classpath`?Öнö´æÔÚ?`WEBFLUX`?Ïà¹ØÀ࣬Ôò±íÃ÷µ±Ç°ÏîÄ¿ÊÇ?`reactive`?ÀàÐ굀 web Ó¦Ó㬷µ»Ø£» -2. Èç¹û?`classpath`?Öв»´æÔÚ?`SERVLET`?Ïà¹ØÀ࣬Ôò±íÃ÷µ±Ç°ÏîÄ¿²»ÊÇ web Ó¦Ó㬷µ»Ø£» -3. Èç¹ûÒÔÉÏÌõ¼þ¶¼²»Âú×㣬Ôò±íÃ÷µ±Ç°ÏîÄ¿ÊÇ?`servlet`?ÀàÐ굀 web Ó¦Óᣠ+1. 如果?`classpath`?中仅存在?`WEBFLUX`?相关类,则表明当å‰�项目是?`reactive`?类型的 web 应用,返回; +2. 如果?`classpath`?中ä¸�存在?`SERVLET`?相关类,则表明当å‰�项目ä¸�是 web 应用,返回; +3. 如果以上æ�¡ä»¶éƒ½ä¸�满足,则表明当å‰�项目是?`servlet`?类型的 web 应用。 -ÓÉÓÚ demo ÒýÓÃÁË?`spring-boot-starter-web`?Ïà¹ØÒÀÀµ£¬Òò´Ëµ±Ç°ÏîÄ¿ÊÇ?`servlet`?ÀàÐ굀 web Ó¦Óᣠ+由于 demo 引用了?`spring-boot-starter-web`?相关ä¾�赖,因此当å‰�项目是?`servlet`?类型的 web 应用。 -### 2.2 ÉèÖóõʼ»¯Æ÷£º`setInitializers(...)` +### 2.2 设置åˆ�始化器:`setInitializers(...)` -Õâ¿é´úÂëÈçÏ£º +è¿™å�—代ç �如下: ``` setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class)); ``` -ÕâÐдúÂë·ÖΪÁ½²¿·Ö: +这行代ç �分为两部分: -* »ñÈ¡?`ApplicationContextInitializer`£º`getSpringFactoriesInstances(ApplicationContextInitializer.class)` -* ÉèÖóõʼ»¯Æ÷£º`setInitializers(...)` +* 获å�–?`ApplicationContextInitializer`:`getSpringFactoriesInstances(ApplicationContextInitializer.class)` +* 设置åˆ�始化器:`setInitializers(...)` -ÎÒÃÇÏÈÀ´¿´¿´»ñÈ¡?`ApplicationContextInitializer`?µÄÁ÷³Ì£¬´úÂëÈçÏ£º +我们先æ�¥çœ‹çœ‹èŽ·å�–?`ApplicationContextInitializer`?çš„æµ�程,代ç �如下: ``` public class SpringApplication { ... - // type Ϊ ApplicationContextInitializer.class + // type 为 ApplicationContextInitializer.class private Collection getSpringFactoriesInstances(Class type) { return getSpringFactoriesInstances(type, new Class[] {}); } /** - * type Ϊ ApplicationContextInitializer.class - * parameterTypes Ϊ ew Class[] {} - * args Ϊ null + * type 为 ApplicationContextInitializer.class + * parameterTypes 为 ew Class[] {} + * args 为 null */ private Collection getSpringFactoriesInstances(Class type, Class[] parameterTypes, Object... args) { ClassLoader classLoader = getClassLoader(); - // ´Ó META-INF/spring.factories ¼ÓÔØÄÚÈÝ + // 从 META-INF/spring.factories 加载内容 Set names = new LinkedHashSet<>( SpringFactoriesLoader.loadFactoryNames(type, classLoader)); - // ʵÀý»¯£¬Ê¹Óõķ´Éä²Ù×÷ + // 实例化,使用的å��å°„æ“�作 List instances = createSpringFactoriesInstances( type, parameterTypes, classLoader, args, names); - // ÅÅÐò£¬±È½ÏµÄÊÇ @Order ×¢½â£¬»òʵÏÖµÄ Orderd ½Ó¿Ú + // 排åº�,比较的是 @Order 注解,或实现的 Orderd 接å�£ AnnotationAwareOrderComparator.sort(instances); return instances; } @@ -200,25 +200,25 @@ public class SpringApplication { ``` -ÒÔÉÏ´úÂë±È½Ï¼òµ¥£¬ÏÈ´Ó?`META-INF/spring.factories`?»ñÈ¡ÄÚÈÝ£¬È»ºóʹÓ÷´Éä½øÐÐʵÀý»¯£¬½øÐÐÅÅÐòºóÔÙ·µ»Ø¡£ +以上代ç �比较简å�•,先从?`META-INF/spring.factories`?获å�–内容,然å�Žä½¿ç”¨å��射进行实例化,进行排åº�å�Žå†�返回。 -¹ØÓÚ?`SpringFactoriesLoader.loadFactoryNames(...)`£¬Ëü×îÖÕ»á´Ó?`META-INF/spring.factories`?¼ÓÔØÄÚÈÝ£¬`META-INF/spring.factories`?¿ÉÒÔÀí½âΪһ¸öÅäÖÃÎļþ£¬key Ϊ´«ÈëµÄ type£¬¸Ã·½·¨µÄÏêϸ·ÖÎö£¬¿ÉÒԲο¼?[springboot ×Ô¶¯×°ÅäÖ®¼ÓÔØ×Ô¶¯×°ÅäÀà](https://my.oschina.net/funcy/blog/4870868)¡£ +关于?`SpringFactoriesLoader.loadFactoryNames(...)`,它最终会从?`META-INF/spring.factories`?加载内容,`META-INF/spring.factories`?å�¯ä»¥ç�†è§£ä¸ºä¸€ä¸ªé…�置文件,key 为传入的 type,该方法的详细分æž�,å�¯ä»¥å�‚考?[springboot 自动装é…�之加载自动装é…�ç±»](https://my.oschina.net/funcy/blog/4870868)。 -×îÖÕ»áÓжàÉÙ¸ö?`ApplicationContextInitializer`?¼ÓÔØ½øÀ´ÄØ£¿Í¨¹ýµ÷ÊÔ£¬·¢ÏÖÒ»¹²ÓÐ 7 ¸ö£º +最终会有多少个?`ApplicationContextInitializer`?加载进æ�¥å‘¢ï¼Ÿé€šè¿‡è°ƒè¯•,å�‘现一共有 7 个: ![](https://oscimg.oschina.net/oscnet/up-53f764fefeb0c55fcfef6e34634805162f5.png) -¶ÔÕâ 7 ¸ö?`ApplicationContextInitializer`£¬ËµÃ÷ÈçÏ£º +对这 7 个?`ApplicationContextInitializer`,说明如下: -* `ConfigurationWarningsApplicationContextInitializer`£º±¨¸æ IOC ÈÝÆ÷µÄһЩ³£¼ûµÄ´íÎóÅäÖà -* `ContextIdApplicationContextInitializer`£ºÉèÖà Spring Ó¦ÓÃÉÏÏÂÎÄµÄ ID -* `DelegatingApplicationContextInitializer`£º¼ÓÔØ?`application.properties`?ÖÐ?`context.initializer.classes`?ÅäÖõÄÀà -* `RSocketPortInfoApplicationContextInitializer`£º½«?`RSocketServer`?ʵ¼ÊʹÓõļàÌý¶Ë¿ÚдÈëµ½?`Environment`?»·¾³ÊôÐÔÖÐ -* `ServerPortInfoApplicationContextInitializer`£º½«ÄÚÖà servlet ÈÝÆ÷ʵ¼ÊʹÓõļàÌý¶Ë¿ÚдÈëµ½?`Environment`?»·¾³ÊôÐÔÖÐ -* `SharedMetadataReaderFactoryContextInitializer`£º´´½¨Ò»¸ö?`SpringBoot`?ºÍ?`ConfigurationClassPostProcessor`?¹²ÓõÄ?`CachingMetadataReaderFactory`?¶ÔÏó -* `ConditionEvaluationReportLoggingListener`£º½«?`ConditionEvaluationReport`?дÈëÈÕÖ¾ +* `ConfigurationWarningsApplicationContextInitializer`:报告 IOC 容器的一些常è§�的错误é…�ç½® +* `ContextIdApplicationContextInitializer`:设置 Spring 应用上下文的 ID +* `DelegatingApplicationContextInitializer`:加载?`application.properties`?中?`context.initializer.classes`?é…�置的类 +* `RSocketPortInfoApplicationContextInitializer`:将?`RSocketServer`?实际使用的监å�¬ç«¯å�£å†™å…¥åˆ°?`Environment`?环境属性中 +* `ServerPortInfoApplicationContextInitializer`:将内置 servlet 容器实际使用的监å�¬ç«¯å�£å†™å…¥åˆ°?`Environment`?环境属性中 +* `SharedMetadataReaderFactoryContextInitializer`:创建一个?`SpringBoot`?å’Œ?`ConfigurationClassPostProcessor`?共用的?`CachingMetadataReaderFactory`?对象 +* `ConditionEvaluationReportLoggingListener`:将?`ConditionEvaluationReport`?写入日志 -»ñÈ¡µ½?`ApplicationContextInitializer`£¬ÎÒÃÇÔÙÀ´¿´¿´?`setInitializers(...)`?·½·¨£º +获å�–到?`ApplicationContextInitializer`,我们å†�æ�¥çœ‹çœ‹?`setInitializers(...)`?方法: ``` public class SpringApplication { @@ -232,36 +232,36 @@ public class SpringApplication { ``` -ÕâÊÇÒ»¸ö±ê×¼µÄ?`setter`?·½·¨£¬Ëù×öµÄ¾ÍÖ»ÊÇÉèÖóÉÔ±±äÁ¿¡£ +这是一个标准的?`setter`?方法,所å�šçš„å°±å�ªæ˜¯è®¾ç½®æˆ�员å�˜é‡�。 -### 2.3 ÉèÖüàÌýÆ÷£º`setListeners(...)` +### 2.3 设置监å�¬å™¨ï¼š`setListeners(...)` -ÉèÖüàÌýÆ÷µÄ´úÂëÈçÏ£º +设置监å�¬å™¨çš„代ç �如下: ``` setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class)); ``` -´ÓÐÎʽÉÏ¿´£¬Í¬?`Initializer`?Ò»Ñù£¬Ò²ÊÇÏÈ´Ó?`META-INF/spring.factories`?ÖмÓÔØ?`ApplicationListener`£¬È»ºóÌí¼Óµ½³ÉÔ±±äÁ¿ÖУ¬ÕâÀïÎÒÃÇÖ±½Ó¿´ÄÜ»ñÈ¡µ½ÄÄЩ?`listener`£º +从形å¼�上看,å�Œ?`Initializer`?一样,也是先从?`META-INF/spring.factories`?中加载?`ApplicationListener`,然å�Žæ·»åŠ åˆ°æˆ�员å�˜é‡�中,这里我们直接看能获å�–到哪些?`listener`: ![](https://oscimg.oschina.net/oscnet/up-0440eb21c69a75686850a1b44eb9f1287c8.png) -¿ÉÒÔ¿´µ½£¬Ò»¹²¿ÉÒÔ»ñÈ¡µ½ 11 ¸ö?`listener`£¬ÕâЩ?`listener`?µÄ×÷ÓÃÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œä¸€å…±å�¯ä»¥èŽ·å�–到 11 个?`listener`,这些?`listener`?的作用如下: -* `ClearCachesApplicationListener`£ºÓ¦ÓÃÉÏÏÂÎļÓÔØÍê³Éºó¶Ô»º´æ×öÇå³ý¹¤×÷ -* `ParentContextCloserApplicationListener`£º¼àÌýË«Ç×Ó¦ÓÃÉÏÏÂÎĵĹرÕʼþ²¢Íù×Ô¼ºµÄ×ÓÓ¦ÓÃÉÏÏÂÎÄÖд«²¥ -* `CloudFoundryVcapEnvironmentPostProcessor`£º¶Ô?`CloudFoundry`?Ìṩ֧³Ö -* `FileEncodingApplicationListener`£º¼ì²âϵͳÎļþ±àÂëÓëÓ¦Óû·¾³±àÂëÊÇ·ñÒ»Ö£¬Èç¹ûϵͳÎļþ±àÂëºÍÓ¦Óû·¾³µÄ±àÂ벻ͬÔòÖÕÖ¹Ó¦ÓÃÆô¶¯ -* `AnsiOutputApplicationListener`£º¸ù¾Ý?`spring.output.ansi.enabled`?²ÎÊýÅäÖÃ?`AnsiOutput` -* `ConfigFileApplicationListener`£º´Ó³£¼ûµÄÄÇЩԼ¶¨µÄλÖöÁÈ¡ÅäÖÃÎļþ -* `DelegatingApplicationListener`£º¼àÌýµ½Ê¼þºóת·¢¸ø?`application.properties`?ÖÐÅäÖõÄ?`context.listener.classes`?µÄ¼àÌýÆ÷ -* `ClasspathLoggingApplicationListener`£º¶Ô»·¾³¾ÍÐ÷ʼþ?`ApplicationEnvironmentPreparedEvent`?ºÍÓ¦ÓÃʧ°Üʼþ?`ApplicationFailedEvent`?×ö³öÏìÓ¦ -* `LoggingApplicationListener`£ºÅäÖÃ?`LoggingSystem`£¬Ê¹ÓÃ?`logging.config`?»·¾³±äÁ¿Ö¸¶¨µÄÅäÖûòÕßȱʡÅäÖà -* `LiquibaseServiceLocatorApplicationListener`£ºÊ¹ÓÃÒ»¸ö¿ÉÒÔºÍ?`SpringBoot`?¿ÉÖ´ÐÐ jar °üÅäºÏ¹¤×÷µÄ°æ±¾Ìæ»»?`LiquibaseServiceLocator` -* `BackgroundPreinitializer`£ºÊ¹ÓÃÒ»¸öºǫ́Ï߳̾¡Ôç´¥·¢Ò»Ð©ºÄʱµÄ³õʼ»¯ÈÎÎñ +* `ClearCachesApplicationListener`:应用上下文加载完æˆ�å�Žå¯¹ç¼“å­˜å�šæ¸…é™¤å·¥ä½œ +* `ParentContextCloserApplicationListener`:监å�¬å�Œäº²åº”用上下文的关闭事件并往自己的å­�应用上下文中传播 +* `CloudFoundryVcapEnvironmentPostProcessor`:对?`CloudFoundry`?æ��供支æŒ� +* `FileEncodingApplicationListener`:检测系统文件编ç �与应用环境编ç �是å�¦ä¸€è‡´ï¼Œå¦‚果系统文件编ç �和应用环境的编ç �ä¸�å�Œåˆ™ç»ˆæ­¢åº”用å�¯åЍ +* `AnsiOutputApplicationListener`:根æ�®?`spring.output.ansi.enabled`?å�‚æ•°é…�ç½®?`AnsiOutput` +* `ConfigFileApplicationListener`:从常è§�的那些约定的ä½�置读å�–é…�置文件 +* `DelegatingApplicationListener`:监å�¬åˆ°äº‹ä»¶å�Žè½¬å�‘ç»™?`application.properties`?中é…�置的?`context.listener.classes`?的监å�¬å™¨ +* `ClasspathLoggingApplicationListener`:对环境就绪事件?`ApplicationEnvironmentPreparedEvent`?和应用失败事件?`ApplicationFailedEvent`?å�šå‡ºå“�应 +* `LoggingApplicationListener`:é…�ç½®?`LoggingSystem`,使用?`logging.config`?环境å�˜é‡�指定的é…�置或者缺çœ�é…�ç½® +* `LiquibaseServiceLocatorApplicationListener`:使用一个å�¯ä»¥å’Œ?`SpringBoot`?å�¯æ‰§è¡Œ jar 包é…�å�ˆå·¥ä½œçš„版本替æ�¢?`LiquibaseServiceLocator` +* `BackgroundPreinitializer`:使用一个å�Žå�°çº¿ç¨‹å°½æ—©è§¦å�‘一些耗时的åˆ�始化任务 -ÔÙÀ´¿´¿´?`SpringApplication#setListeners`£º +å†�æ�¥çœ‹çœ‹?`SpringApplication#setListeners`: ``` public void setListeners(Collection> listeners) { @@ -270,18 +270,18 @@ public void setListeners(Collection> listeners) ``` -ÕâÒ²ÊÇÒ»¸ö±ê×¼µÄ?`setter`?·½·¨¡£ +这也是一个标准的?`setter`?方法。 -### 2.4 ÍÆ¶ÏÖ÷Àࣺ`deduceMainApplicationClass()` +### 2.4 推断主类:`deduceMainApplicationClass()` -ËùνÖ÷À࣬¾ÍÊǰüº¬?`main(String[])`£¬Ò²¾ÍÊǵ±Ç° spring Ó¦ÓÃµÄÆô¶¯À࣬`SpringApplication#deduceMainApplicationClass`?´úÂëÈçÏ£º +所谓主类,就是包å�«?`main(String[])`,也就是当å‰� spring 应用的å�¯åŠ¨ç±»ï¼Œ`SpringApplication#deduceMainApplicationClass`?代ç �如下: ``` private Class deduceMainApplicationClass() { try { - // »ñÈ¡µ÷ÓÃÕ» + // 获å�–调用栈 StackTraceElement[] stackTrace = new RuntimeException().getStackTrace(); - // ±éÀúµ÷ÓÃÕ»£¬ÕÒ µ½main·½·¨ + // é��历调用栈,找 到main方法 for (StackTraceElement stackTraceElement : stackTrace) { if ("main".equals(stackTraceElement.getMethodName())) { return Class.forName(stackTraceElement.getClassName()); @@ -296,23 +296,23 @@ private Class deduceMainApplicationClass() { ``` -ÕâÀïÖ÷ÒªÊÇͨ¹ý?`new RuntimeException().getStackTrace()`?»ñÈ¡µ÷ÓÃÕ»£¬È»ºó±éÀú£¬µÃµ½°üº¬?`main`?·½·¨µÄÀ࣬µÃµ½µÄµ÷ÓÃÕ»ÈçÏ£º +这里主è¦�是通过?`new RuntimeException().getStackTrace()`?获å�–调用栈,然å�Žé��历,得到包å�«?`main`?方法的类,得到的调用栈如下: ![](https://oscimg.oschina.net/oscnet/up-8c04487e6b05f583e7d45b83c293634f42a.png) -¿ÉÒÔ¿´µ½£¬`main()`?¾Í°üº¬ÔÚµ÷ÓÃÕ»ÖÐÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`main()`?就包å�«åœ¨è°ƒç”¨æ ˆä¸­äº†ã€‚ -### 2.5 ×ܽá +### 2.5 总结 -±¾ÎÄÖ÷ÒªÊǽéÉÜ?`SpringApplication`?µÄ´´½¨¹ý³Ì£¬ÎÒÃÇÖØµã·ÖÎöÁËÒÔϼ¸µã£º +本文主è¦�是介ç»�?`SpringApplication`?的创建过程,我们é‡�点分æž�了以下几点: -1. ÍÆ¶Ïµ±Ç° web Ó¦ÓÃÀàÐÍ£ºNONE, SERVLET,REACTIVE£» -2. ÉèÖóõʼ»¯Æ÷£º`ApplicationContextInitializer`£» -3. ÉèÖüàÌýÆ÷£º`ApplicationListener`£» -4. ÍÆ¶ÏÖ÷Àà¡£ +1. 推断当å‰� web 应用类型:NONE, SERVLET,REACTIVEï¼› +2. 设置åˆ�始化器:`ApplicationContextInitializer`ï¼› +3. 设置监å�¬å™¨ï¼š`ApplicationListener`ï¼› +4. 推断主类。 ![](https://oscimg.oschina.net/oscnet/up-e9a43f1c523c0f19d37e4741580ed32ca08.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4877610](https://my.oschina.net/funcy/blog/4877610)?£¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4877610](https://my.oschina.net/funcy/blog/4877610)?,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\207\206\345\244\207IOC\345\256\271\345\231\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\207\206\345\244\207IOC\345\256\271\345\231\250.md" index f916074..54bcf7d 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\207\206\345\244\207IOC\345\256\271\345\231\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\207\206\345\244\207IOC\345\256\271\345\231\250.md" @@ -1,33 +1,33 @@ -ÉÏһƪÎÄÕÂ×ܽá springboot Æô¶¯Á÷³ÌÈçÏ£º +上一篇文章总结 springboot å�¯åЍæµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-07a6b491fbe69b8dcbd41e59a8543f06671.png) -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö½ÓÏÂÀ´µÄ²½Öè¡£ +接上文,我们继续分æž�接下æ�¥çš„æ­¥éª¤ã€‚ -### 3.8 ´´½¨ ioc ÈÝÆ÷ +### 3.8 创建 ioc 容器 -´´½¨ ioc ÈÝÆ÷µÄ´úÂëÈçÏ£º +创建 ioc 容器的代ç �如下: ``` ConfigurableApplicationContext context = null; .... -// ´´½¨applicationContext +// 创建applicationContext context = createApplicationContext(); ``` -ÎÒÃǽøÈë `SpringApplication#createApplicationContext` ·½·¨£º +我们进入 `SpringApplication#createApplicationContext` 方法: ``` -/** ĬÈ쵀 ApplicationContext */ +/** 默认的 ApplicationContext */ public static final String DEFAULT_CONTEXT_CLASS = "org.springframework.context." + "annotation.AnnotationConfigApplicationContext"; -/** servlet Ó¦ÓÃµÄµÄ ApplicationContext */ +/** servlet 应用的的 ApplicationContext */ public static final String DEFAULT_SERVLET_WEB_CONTEXT_CLASS = "org.springframework.boot." + "web.servlet.context.AnnotationConfigServletWebServerApplicationContext"; -/** Reactive Ó¦ÓÃµÄ ApplicationContext */ +/** Reactive 应用的 ApplicationContext */ public static final String DEFAULT_REACTIVE_WEB_CONTEXT_CLASS = "org.springframework." + "boot.web.reactive.context.AnnotationConfigReactiveWebServerApplicationContext"; @@ -35,17 +35,17 @@ protected ConfigurableApplicationContext createApplicationContext() { Class contextClass = this.applicationContextClass; if (contextClass == null) { try { - // ¸ù¾ÝÓ¦ÓÃÀàÐÍÀ´´´½¨²»Í¬µÄÈÝÆ÷ + // æ ¹æ�®åº”用类型æ�¥åˆ›å»ºä¸�å�Œçš„容器 switch (this.webApplicationType) { case SERVLET: - // ʹÓõÄÊÇ AnnotationConfigServletWebServerApplicationContext + // 使用的是 AnnotationConfigServletWebServerApplicationContext contextClass = Class.forName(DEFAULT_SERVLET_WEB_CONTEXT_CLASS); break; case REACTIVE: contextClass = Class.forName(DEFAULT_REACTIVE_WEB_CONTEXT_CLASS); break; default: - // ĬÈÏʹÓõÄÊÇ AnnotationConfigApplicationContext + // 默认使用的是 AnnotationConfigApplicationContext contextClass = Class.forName(DEFAULT_CONTEXT_CLASS); } } @@ -53,28 +53,28 @@ protected ConfigurableApplicationContext createApplicationContext() { throw new IllegalStateException(...); } } - // ʹÓ÷´Éä½øÐÐʵÀý»¯ + // 使用å��射进行实例化 return (ConfigurableApplicationContext) BeanUtils.instantiateClass(contextClass); } ``` -Õâ¸ö·½·¨Ö÷Òª¾ÍÊǸù¾ÝÓ¦ÓÃÀàÐÍÀ´´´½¨²»Í¬ `ApplicationContext`£¬Ê¹Ó÷´ÉäµÄ·½·¨½øÐÐʵÀý»¯£¬¸÷Ó¦ÓÃÀàÐͶÔÓ¦µÄ `ApplicationContext` ÈçÏ£º +这个方法主è¦�就是根æ�®åº”用类型æ�¥åˆ›å»ºä¸�å�Œ `ApplicationContext`,使用å��射的方法进行实例化,å�„应用类型对应的 `ApplicationContext` 如下: -1. `servlet` Ó¦Óãº`AnnotationConfigServletWebServerApplicationContext` -2. `reactive` Ó¦Óãº`AnnotationConfigReactiveWebServerApplicationContext` -3. ÒÔÉ϶¼²»ÊÇ£º`AnnotationConfigApplicationContext` +1. `servlet` 应用:`AnnotationConfigServletWebServerApplicationContext` +2. `reactive` 应用:`AnnotationConfigReactiveWebServerApplicationContext` +3. 以上都ä¸�是:`AnnotationConfigApplicationContext` -µ±Ç°Ó¦ÓõÄÀàÐÍÊÇ `servlet`£¬Òò´Ë´´½¨µÄ `ApplicationContext` ÊÇ `AnnotationConfigReactiveWebServerApplicationContext`£¬À´¿´¿´ËüµÄ¹¹Ôì·½·¨£º +当å‰�应用的类型是 `servlet`,因此创建的 `ApplicationContext` 是 `AnnotationConfigReactiveWebServerApplicationContext`,æ�¥çœ‹çœ‹å®ƒçš„æž„造方法: ``` public class AnnotationConfigServletWebServerApplicationContext extends ServletWebServerApplicationContext implements AnnotationConfigRegistry { - // ÓÃÀ´´¦Àí BeanDefinition µÄ×¢²á + // 用æ�¥å¤„ç�† BeanDefinition 的注册 private final AnnotatedBeanDefinitionReader reader; - // ÓÃÀ´´¦Àí°üµÄɨÃè + // 用æ�¥å¤„ç�†åŒ…的扫æ�� private final ClassPathBeanDefinitionScanner scanner; ... @@ -89,7 +89,7 @@ public class AnnotationConfigServletWebServerApplicationContext ``` -`AnnotationConfigServletWebServerApplicationContext` µÄ¹¹Ôì·½·¨»¹ÊDZȽϼòµ¥µÄ£¬Ö»ÊÇÉèÖÃÁËÁ½¸öÊôÐÔ£¬¾Í²»¶à˵ÁË¡£²»¹ý£¬ÎÒÃÇÒ²Òª°ÑÄ¿¹â·ÅÔ¶Ò»µã£¬¿´¿´Æä¸¸ÀàµÄ¹¹Ôì·½·¨£¬×îÖÕÔÚ `GenericApplicationContext` µÄ¹¹Ôì·½·¨ÖÐÕÒµ½Õâôһ¾ä£º +`AnnotationConfigServletWebServerApplicationContext` 的构造方法还是比较简å�•的,å�ªæ˜¯è®¾ç½®äº†ä¸¤ä¸ªå±žæ€§ï¼Œå°±ä¸�多说了。ä¸�过,我们也è¦�把目光放远一点,看看其父类的构造方法,最终在 `GenericApplicationContext` 的构造方法中找到这么一å�¥ï¼š ``` public GenericApplicationContext() { @@ -98,11 +98,11 @@ public GenericApplicationContext() { ``` -ÕâÐдúÂë´´½¨ÁË `DefaultListableBeanFactory` ²¢½«Æä¸³Öµ¸øÁË `beanFactory`£¬Õâ±íÃ÷ÎÒÃÇÔÚ `ApplicationContext` ʹÓÃµÄ `beanFactory` ¾ÍÊÇ `DefaultListableBeanFactory`¡£ +这行代ç �创建了 `DefaultListableBeanFactory` 并将其赋值给了 `beanFactory`,这表明我们在 `ApplicationContext` 使用的 `beanFactory` 就是 `DefaultListableBeanFactory`。 -### 3.9 ×¼±¸ ioc ÈÝÆ÷ +### 3.9 准备 ioc 容器 -´´½¨Íê ioc ÈÝÆ÷ºó£¬½ÓמÍÊǶÔÈÝÆ÷½øÐÐһЩ׼±¸²Ù×÷£¬´úÂëÈçÏ£º +创建完 ioc 容器å�Žï¼ŒæŽ¥ç�€å°±æ˜¯å¯¹å®¹å™¨è¿›è¡Œä¸€äº›å‡†å¤‡æ“�作,代ç �如下: ``` public class SpringApplication { @@ -112,68 +112,68 @@ public class SpringApplication { private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) { - // ½«´´½¨ºÃµÄÓ¦Óû·¾³ÉèÖõ½IOCÈÝÆ÷ÖÐ + // 将创建好的应用环境设置到IOC容器中 context.setEnvironment(environment); - // ÉèÖÃÈÝÆ÷µÄһЩ²ÎÊý + // 设置容器的一些å�‚æ•° postProcessApplicationContext(context); - // Ó¦ÓÃInitializer½øÐгõʼ»¯²Ù×÷ + // 应用Initializer进行åˆ�始化æ“�作 applyInitializers(context); - // ¼àÌýÆ÷£ºSpringApplicationRunListenersµÄcontextPrepared·½·¨ - // £¨ÔÚ´´½¨ºÍ×¼±¸ApplicationContextÖ®ºó£¬µ«ÔÚ¼ÓÔØÖ®Ç°£© + // 监å�¬å™¨ï¼šSpringApplicationRunListenersçš„contextPrepared方法 + // (在创建和准备ApplicationContext之å�Žï¼Œä½†åœ¨åŠ è½½ä¹‹å‰�) listeners.contextPrepared(context); - // ´òÓ¡¸öÈÕÖ¾ + // 打å�°ä¸ªæ—¥å¿— if (this.logStartupInfo) { logStartupInfo(context.getParent() == null); logStartupProfileInfo(context); } - // »ñÈ¡beanFactory + // 获å�–beanFactory ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); - // ½«ÔËÐвÎÊý×÷Ϊbean×¢²áµ½beanFactoryÖÐ + // å°†è¿�行å�‚数作为bean注册到beanFactory中 beanFactory.registerSingleton("springApplicationArguments", applicationArguments); - // ½« banner ×÷Ϊbean×¢²áµ½beanFactoryÖÐ + // å°† banner 作为bean注册到beanFactory中 if (printedBanner != null) { beanFactory.registerSingleton("springBootBanner", printedBanner); } if (beanFactory instanceof DefaultListableBeanFactory) { - // ÊÇ·ñÔÊÐíbeanµÄÐÅÏ¢±»¸²¸Ç + // 是å�¦å…�许bean的信æ�¯è¢«è¦†ç›– ((DefaultListableBeanFactory) beanFactory) .setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding); } - // ´¦ÀíÀÁ¼ÓÔØ + // 处ç�†æ‡’加载 if (this.lazyInitialization) { context.addBeanFactoryPostProcessor( new LazyInitializationBeanFactoryPostProcessor()); } - // »ñÈ¡ËùÓÐ×ÊÔ´ + // 获å�–所有资æº� Set sources = getAllSources(); Assert.notEmpty(sources, "Sources must not be empty"); - // ¼ÓÔØ class + // 加载 class load(context, sources.toArray(new Object[0])); - // ·¢²¼Ê¼þ + // å�‘布事件 listeners.contextLoaded(context); } } ``` -×¼±¸¹¤×÷µÄ²½Ö軹ÊǺÜÇåÎúµÄ£¬ÖØÒªÄÚÈݶ¼ÒÑÔÚ´úÂëÖнøÐÐÁË×¢ÊÍ£¬ÕâÀï¶ÔһЩ²Ù×÷ÎÒÃÇÉÔ΢չ¿ªÏ¡£ +准备工作的步骤还是很清晰的,é‡�è¦�内容都已在代ç �中进行了注释,这里对一些æ“�作我们ç¨�微展开下。 -#### 1\. ÉèÖà `Environment` +#### 1\. 设置 `Environment` -¸Ã²Ù×÷µÄ´úÂëΪ +该æ“�作的代ç �为 ``` private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) { - // ½«´´½¨ºÃµÄÓ¦Óû·¾³ÉèÖõ½IOCÈÝÆ÷ÖÐ + // 将创建好的应用环境设置到IOC容器中 context.setEnvironment(environment); ... } ``` -Õâ¸ö `environment` ¾ÍÊÇÇ°Ãæ´´½¨µÄ `environment`£¬ioc ÈÝÆ÷Ò²ÊÇʹÓÃÕâ¸ö£¬ÎÒÃÇÀ´¿´¿´ÉèÖòÙ×÷£º +这个 `environment` 就是å‰�é�¢åˆ›å»ºçš„ `environment`,ioc 容器也是使用这个,我们æ�¥çœ‹çœ‹è®¾ç½®æ“�作: ``` public class AnnotationConfigServletWebServerApplicationContext extends ... { @@ -182,9 +182,9 @@ public class AnnotationConfigServletWebServerApplicationContext extends ... { @Override public void setEnvironment(ConfigurableEnvironment environment) { - // µ÷Óø¸ÀàµÄ·½·¨½øÐÐÉèÖà + // 调用父类的方法进行设置 super.setEnvironment(environment); - // Ò²½«environmentÉèÖõ½ÕâÁ½¸öÊôÐÔÖÐ + // 也将environment设置到这两个属性中 this.reader.setEnvironment(environment); this.scanner.setEnvironment(environment); } @@ -194,9 +194,9 @@ public class AnnotationConfigServletWebServerApplicationContext extends ... { ``` -#### 2\. ´¦Àí ioc µÄ²¿·ÖÊôÐÔ +#### 2\. 处ç�† ioc 的部分属性 -ÎÒÃÇÀ´¿´¿´ `postProcessApplicationContext(context);` Ëù×öµÄ¹¤×÷£º +我们æ�¥çœ‹çœ‹ `postProcessApplicationContext(context);` 所å�šçš„工作: ``` public class SpringApplication { @@ -204,13 +204,13 @@ public class SpringApplication { ... protected void postProcessApplicationContext(ConfigurableApplicationContext context) { - // ÉèÖà beanNameGenerator£¬ÓÃÀ´Éú³É bean µÄÃû³Æ£¬ÕâÀï´«ÈëµÄÊÇnull + // 设置 beanNameGenerator,用æ�¥ç”Ÿæˆ� bean çš„å��称,这里传入的是null if (this.beanNameGenerator != null) { context.getBeanFactory().registerSingleton( AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR, this.beanNameGenerator); } - // ÉèÖà resourceLoaderµÄÏà¹Ø²ÎÊý£¬ÓÉÓÚΪnull£¬ifÀïµÄ´úÂë²»»áÖ´ÐÐ + // 设置 resourceLoader的相关å�‚数,由于为null,if里的代ç �ä¸�会执行 if (this.resourceLoader != null) { if (context instanceof GenericApplicationContext) { ((GenericApplicationContext) context).setResourceLoader(this.resourceLoader); @@ -220,9 +220,9 @@ public class SpringApplication { this.resourceLoader.getClassLoader()); } } - // ÕâÀï»áÖ´ÐÐ + // 这里会执行 if (this.addConversionService) { - // ÉèÖÃÀàÐÍת»»Æ÷£¬Èç°ÑStringתNumberµÈ + // 设置类型转æ�¢å™¨ï¼Œå¦‚把String转Numberç­‰ context.getBeanFactory().setConversionService( ApplicationConversionService.getSharedInstance()); } @@ -234,7 +234,7 @@ public class SpringApplication { ``` -Õⲿ·Ö¾ÍÊÇÉèÖà `ApplicationContext` µÄ¼¸¸öÊôÐÔ£¬ÔÚÎÒÃÇµÄ demo ÖУ¬`beanNameGenerator` Óë `resourceLoader` ¶¼ÊÇ `null`£¬Òò´ËÕâÁ½¿é¶¼²»»áÔËÐУ¬ÄÜÔËÐеľÍÖ»ÓÐÕâ¿é´úÂ룺 +这部分就是设置 `ApplicationContext` 的几个属性,在我们的 demo 中,`beanNameGenerator` 与 `resourceLoader` 都是 `null`,因此这两å�—都ä¸�会è¿�行,能è¿�行的就å�ªæœ‰è¿™å�—代ç �: ``` context.getBeanFactory().setConversionService( @@ -242,11 +242,11 @@ public class SpringApplication { ``` -`ConversionService` ÔÚÇ°ÃæÒ²Ìáµ½¹ý£¬ËüÖ÷ÒªÊÇÓÃÀ´½øÐвÎÊýÀàÐÍת»»µÄ¡£ +`ConversionService` 在å‰�é�¢ä¹Ÿæ��到过,它主è¦�是用æ�¥è¿›è¡Œå�‚数类型转æ�¢çš„。 -#### 3\. Ó¦Óóõʼ»¯Æ÷£º`applyInitializers(context)` +#### 3\. 应用åˆ�始化器:`applyInitializers(context)` -`SpringApplication#applyInitializers` ·½·¨ÈçÏ£º +`SpringApplication#applyInitializers` 方法如下: ``` public class SpringApplication { @@ -255,12 +255,12 @@ public class SpringApplication { @SuppressWarnings({ "rawtypes", "unchecked" }) protected void applyInitializers(ConfigurableApplicationContext context) { - // getInitializers()£º»ñÈ¡ËùÓеijõʼ»¯Æ÷ + // getInitializers():获å�–所有的åˆ�始化器 for (ApplicationContextInitializer initializer : getInitializers()) { Class requiredType = GenericTypeResolver.resolveTypeArgument(initializer.getClass(), ApplicationContextInitializer.class); Assert.isInstanceOf(requiredType, context, "Unable to call initializer."); - // ÖðÒ»µ÷ÓÃinitializerµÄinitialize(...)·½·¨ + // é€�一调用initializerçš„initialize(...)方法 initializer.initialize(context); } } @@ -269,9 +269,9 @@ public class SpringApplication { ``` -Õâ¿é²Ù×÷»¹ÊǺÜÇåÎúµÄ£¬¾ÍÊÇ»ñÈ¡ËùÓÐµÄ `Initializer`£¬È»ºó±éÀú£¬Öð¸öµ÷ÓÃÆä `initialize(...)` ·½·¨¡£ +è¿™å�—æ“�作还是很清晰的,就是获å�–所有的 `Initializer`,然å�Žé��历,é€�个调用其 `initialize(...)` 方法。 -ÕâÀﻹÐèÒªÌáÏ£¬`getInitializers()` ÊÇÔõô»ñÈ¡ `Initializer` µÄÄØ£¿Ïà¹Ø´úÂëÈçÏ£º +这里还需è¦�æ��下,`getInitializers()` 是怎么获å�– `Initializer` 的呢?相关代ç �如下: ``` public class SpringApplication { @@ -280,18 +280,18 @@ public class SpringApplication { ... - // ÔÚ¹¹Ôì·½·¨ÖÐÉèÖÃµÄ initializers + // 在构造方法中设置的 initializers public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) { ... - // ÉèÖóõʼ»¯Æ÷£¬getSpringFactoriesInstances£º´Ó META-INF/spring.factories ÖлñÈ¡ÅäÖà + // 设置åˆ�始化器,getSpringFactoriesInstances:从 META-INF/spring.factories 中获å�–é…�ç½® setInitializers((Collection) getSpringFactoriesInstances( ApplicationContextInitializer.class)); ... } - // »ñÈ¡ Initializer µÄ²Ù×÷£¬´ÓÊôÐÔÖлñÈ¡ + // 获å�– Initializer çš„æ“�作,从属性中获å�– public Set> getInitializers() { return asUnmodifiableOrderedSet(this.initializers); } @@ -300,34 +300,34 @@ public class SpringApplication { ``` -¿´ÁË´úÂë¾ÍÃ÷°×ÁË£¬ÔÚÇ°Ãæ·ÖÎö `SpringApplication` µÄ¹¹Ôì·½·¨Ê±£¬ÎÒÃÇÌáµ½ springboot »á´Ó `META-INF/spring.factories` »ñÈ¡ÅäÖÃµÄ `Initializer`£¬½«ÆäÉèÖõ½ `initializers` ÊôÐÔ£¬¶øÕâÀï¾ÍÊÇʹÓà `Initializer` µÄµØ·½ÁË¡£ +看了代ç �就明白了,在å‰�é�¢åˆ†æž� `SpringApplication` 的构造方法时,我们æ��到 springboot 会从 `META-INF/spring.factories` 获å�–é…�置的 `Initializer`,将其设置到 `initializers` 属性,而这里就是使用 `Initializer` 的地方了。 -#### 4\. »ñÈ¡ËùÓÐ×ÊÔ´ +#### 4\. 获å�–所有资æº� -´úÂëÈçÏ£º +代ç �如下: ``` private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) { ... - // »ñÈ¡ËùÓÐ×ÊÔ´ + // 获å�–所有资æº� Set sources = getAllSources(); ... } ``` -½øÈë `getAllSources()` ·½·¨£º +进入 `getAllSources()` 方法: ``` -// ½« primarySources ·ÅÈësetÖУ¬È»ºó½«setת»¯Îª²»¿É±äµÄset£¬·µ»Ø +// å°† primarySources 放入set中,然å�Žå°†set转化为ä¸�å�¯å�˜çš„set,返回 public Set getAllSources() { Set allSources = new LinkedHashSet<>(); if (!CollectionUtils.isEmpty(this.primarySources)) { allSources.addAll(this.primarySources); } - // sources Ϊ¿Õ£¬if²»Ö´ÐÐ + // sources 为空,ifä¸�执行 if (!CollectionUtils.isEmpty(this.sources)) { allSources.addAll(this.sources); } @@ -336,14 +336,14 @@ public Set getAllSources() { ``` -Õâ¸ö·½·¨ºÜ¼òµ¥£¬¾ÍÒ»¸ö»°£º½« `primarySources` ·ÅÈë `set` ÖУ¬È»ºó½« `set` ת»¯Îª²»¿É±äµÄ `set`£¬·µ»Ø¡£ +这个方法很简å�•,就一个è¯�:将 `primarySources` 放入 `set` 中,然å�Žå°† `set` 转化为ä¸�å�¯å�˜çš„ `set`,返回。 -ÄÇÕâ¸ö `primarySources` ÊÇɶĨ£¿Õâ¾ÍÓÖÒª»Øµ½ `SpringApplication` µÄ¹¹Ôì·½·¨ÁË£º +那这个 `primarySources` 是啥呢?这就å�ˆè¦�回到 `SpringApplication` 的构造方法了: ``` public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) { ... - // ÕâÀïÉèÖÃÁË primarySources + // 这里设置了 primarySources Assert.notNull(primarySources, "PrimarySources must not be null"); this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources)); ... @@ -351,14 +351,14 @@ public SpringApplication(ResourceLoader resourceLoader, Class... primarySourc ``` -È»ºó¼ÌÐøÍùÉÏ£¬×îºó·¢ÏÖ `primarySources` ÊÇÎÒÃÇÔÚ `main` ·½·¨Öд«ÈëµÄ£º +ç„¶å�Žç»§ç»­å¾€ä¸Šï¼Œæœ€å�Žå�‘现 `primarySources` 是我们在 `main` 方法中传入的: ``` @SpringBootApplication public class Demo01Application { public static void main(String[] args) { - // Demo01Application.class ¾ÍÊÇ primarySources + // Demo01Application.class 就是 primarySources SpringApplication.run(Demo01Application.class, args); } @@ -366,48 +366,48 @@ public class Demo01Application { ``` -ÎÒÃÇ´«ÈëµÄ `Demo01Application.class` ¾ÍÊÇ `primarySources`£¡ +我们传入的 `Demo01Application.class` 就是 `primarySources`ï¼� -Òò´Ë£¬`getAllSources()` ·µ»ØÁËÒ»¸ö set£¬set ÖÐÖ»ÓÐÒ»¸öÔªËØ£º`Demo01Application.class`£¬ÎÒÃÇÒ²¿ÉÒÔͨ¹ýµ÷ÊÔÀ´ÑéÖ¤£º +因此,`getAllSources()` 返回了一个 set,set 中å�ªæœ‰ä¸€ä¸ªå…ƒç´ ï¼š`Demo01Application.class`,我们也å�¯ä»¥é€šè¿‡è°ƒè¯•æ�¥éªŒè¯�: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-29dd8056dc457c56e6fe41020516d02fe80.png) -#### 5\. ¼ÓÔØ×ÊÔ´ +#### 5\. 加载资æº� -Õâ¸ö²Ù×÷µÄ´úÂëÈçÏ£º +这个æ“�作的代ç �如下: ``` private void prepareContext(ConfigurableApplicationContext context, ConfigurableEnvironment environment, SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments, Banner printedBanner) { ... - // ¼ÓÔØ class + // 加载 class load(context, sources.toArray(new Object[0])); ... } ``` -½øÈë `SpringApplication#load` ·½·¨£º +进入 `SpringApplication#load` 方法: ``` public class SpringApplication { ... protected void load(ApplicationContext context, Object[] sources) { - // ´´½¨Ò»¸öBeanDefinitionµÄ¼ÓÔØÆ÷ + // 创建一个BeanDefinition的加载器 BeanDefinitionLoader loader = createBeanDefinitionLoader( getBeanDefinitionRegistry(context), sources); - // µ±Ç° beanNameGenerator Ϊ null£¬²»µ÷Óà + // 当å‰� beanNameGenerator 为 null,ä¸�调用 if (this.beanNameGenerator != null) { loader.setBeanNameGenerator(this.beanNameGenerator); } - // µ±Ç° resourceLoader Ϊ null£¬²»µ÷Óà + // 当å‰� resourceLoader 为 null,ä¸�调用 if (this.resourceLoader != null) { loader.setResourceLoader(this.resourceLoader); } - // µ±Ç° environment Ϊ null£¬²»µ÷Óà - // Ç°Ãæ´´½¨µÄenvironment²¢Ã»Óи³Öµµ½³ÉÔ±±äÁ¿ + // 当å‰� environment 为 null,ä¸�调用 + // å‰�é�¢åˆ›å»ºçš„environment并没有赋值到æˆ�员å�˜é‡� if (this.environment != null) { loader.setEnvironment(this.environment); } @@ -418,9 +418,9 @@ public class SpringApplication { ``` -Õâ¸ö·½·¨ÏÈÊÇ´´½¨ÁËÒ»¸ö `BeanDefinitionLoader` ʵÀý£¬ÉÏÃæ»ñÈ¡µÄ `source` »áÔÚ `BeanDefinitionLoader` µÄ¹¹Ôì·½·¨Öд«È뵽ʵÀýÖУ¬È»ºó¶Ô¸Ã `loader` ½øÐÐһϵÁеÄÊôÐÔÉèÖã¬×îºóÔÙµ÷ÓÃÆä `load()` ·½·¨¡£ÕâÀïÐèҪ˵Ã÷µÄÊÇ£¬ËäÈ»Ç°Ãæ´´½¨ÁË `environment`£¬µ« `this.environment` »¹ÊÇΪ `null`£¬Ô­ÒòÊÇÇ°Ãæ´´½¨µÄ `environment` ²¢Ã»Óи³Öµ¸ø `this.environment`¡£ +这个方法先是创建了一个 `BeanDefinitionLoader` 实例,上é�¢èŽ·å�–çš„ `source` 会在 `BeanDefinitionLoader` 的构造方法中传入到实例中,然å�Žå¯¹è¯¥ `loader` 进行一系列的属性设置,最å�Žå†�调用其 `load()` 方法。这里需è¦�说明的是,虽然å‰�é�¢åˆ›å»ºäº† `environment`,但 `this.environment` 还是为 `null`,原因是å‰�é�¢åˆ›å»ºçš„ `environment` 并没有赋值给 `this.environment`。 -ÎÒÃǼÌÐø£¬½øÈë `BeanDefinitionLoader#load()`£º +我们继续,进入 `BeanDefinitionLoader#load()`: ``` class BeanDefinitionLoader { @@ -429,19 +429,19 @@ class BeanDefinitionLoader { int load() { int count = 0; - // ÕâÀïµÄ sources ÖоÍÖ»ÓÐÒ»¸öÔªËØ£ºDemo01Application.class + // 这里的 sources 中就å�ªæœ‰ä¸€ä¸ªå…ƒç´ ï¼šDemo01Application.class for (Object source : this.sources) { count += load(source); } return count; } - // ´¦Àí¼ÓÔØ²Ù×÷ + // 处ç�†åŠ è½½æ“�作 private int load(Object source) { Assert.notNull(source, "Source must not be null"); - // Class ÀàÐÍÔÚÕâÀï¼ÓÔØ + // Class 类型在这里加载 if (source instanceof Class) { - // source Ϊ Demo01Application.class£¬ÎÒÃÇÖ÷Òª¹Ø×¢Õâ¸ö·½·¨ + // source 为 Demo01Application.class,我们主è¦�关注这个方法 return load((Class) source); } if (source instanceof Resource) { @@ -456,17 +456,17 @@ class BeanDefinitionLoader { throw new IllegalArgumentException("Invalid source type " + source.getClass()); } - // Class ÀàÐ͵ļÓÔØ²Ù×÷ + // Class 类型的加载æ“�作 private int load(Class source) { - // ´¦Àí grouovy ÓïÑԵ쬲»ÓÃ¹Ü + // 处ç�† grouovy 语言的,ä¸�用管 if (isGroovyPresent() && GroovyBeanDefinitionSource.class.isAssignableFrom(source)) { GroovyBeanDefinitionSource loader = BeanUtils.instantiateClass(source, GroovyBeanDefinitionSource.class); load(loader); } - // ÊÇ·ñÓÐ @Component ×¢½â + // 是å�¦æœ‰ @Component 注解 if (isComponent(source)) { - // ÔÚÕâÀïÉú³É BeanDefinition ¶ÔÏ󣬲¢×¢²áµ½springÖÐ + // 在这里生æˆ� BeanDefinition 对象,并注册到spring中 this.annotatedReader.register(source); return 1; } @@ -476,9 +476,9 @@ class BeanDefinitionLoader { ``` -ÔÚ´´½¨ `BeanDefinitionLoader` ʵÀýʱ£¬Í¨¹ýÆä¹¹Ôì·½·¨½« `sources` ´«ÈëÁË `BeanDefinitionLoader` µÄʵÀýÖУ¬`sources` ÖоÍÖ»ÓÐÒ»¸öÔªËØ£º`Demo01Application.class`£¬Òò´ËÎÒÃÇÖ»Ðè¹Ø×¢ `Class` ÀàÐÍ×ÊÔ´µÄ¼ÓÔØ¾Í¿ÉÒÔÁË£¬×îÖÕµ½ÁË `BeanDefinitionLoader#load(java.lang.Class)` ·½·¨£¬¸Ã·½·¨Ëù×öµÄ²Ù×÷Ϊ£ºÅжϴ«ÈëµÄ `Class` ÊÇ·ñÓÐ `@Component`£¬Èç¹ûÓоͽ«Æä×¢²áµ½ ioc ÈÝÆ÷ÖС£ +在创建 `BeanDefinitionLoader` 实例时,通过其构造方法将 `sources` 传入了 `BeanDefinitionLoader` 的实例中,`sources` 中就å�ªæœ‰ä¸€ä¸ªå…ƒç´ ï¼š`Demo01Application.class`,因此我们å�ªéœ€å…³æ³¨ `Class` 类型资æº�的加载就å�¯ä»¥äº†ï¼Œæœ€ç»ˆåˆ°äº† `BeanDefinitionLoader#load(java.lang.Class)` 方法,该方法所å�šçš„æ“�作为:判断传入的 `Class` 是å�¦æœ‰ `@Component`,如果有就将其注册到 ioc 容器中。 -ÄÇô `Demo01Application.class` ÊÇ·ñÓÐ `@Component` ×¢½âÄØ£¿Óе쬲»¹ýÒþ²ØµÃ±È½ÏÉÆä×¢½â²ã¼¶ÈçÏ£º +那么 `Demo01Application.class` 是å�¦æœ‰ `@Component` 注解呢?有的,ä¸�过éš�è—�得比较深,其注解层级如下: ``` @SpringBootApplication @@ -488,7 +488,7 @@ public class Demo01Application { ``` -½øÈë `@SpringBootApplication`£º +进入 `@SpringBootApplication`: ``` ... @@ -500,7 +500,7 @@ public @interface SpringBootApplication { ``` -¼ÌÐø½øÈë `@SpringBootApplication`£º +继续进入 `@SpringBootApplication`: ``` ... @@ -511,7 +511,7 @@ public @interface SpringBootConfiguration { ``` -¼ÌÐø½øÈë `@Configuration`£º +继续进入 `@Configuration`: ``` ... @@ -522,14 +522,14 @@ public @interface Configuration { ``` -¾­¹ýÖØÖØ²¨ÕÛ£¬×îÖÕÔÚ `@Configuration` ×¢½âÉÏÕÒµ½ÁË `@Component`. +ç»�过é‡�é‡�波折,最终在 `@Configuration` 注解上找到了 `@Component`. -¹ØÓÚ `this.annotatedReader.register(source)` ×¢²áµÄ¾ßÌå²Ù×÷£¬Õâ¿éÔÚ [spring ·ÖÎö](https://my.oschina.net/funcy/blog/4527454)ÖУ¬ÒѾ­·ÖÎö¹ýÁË£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË¡£ +关于 `this.annotatedReader.register(source)` 注册的具体æ“�作,这å�—在 [spring 分æž�](https://my.oschina.net/funcy/blog/4527454)中,已ç»�分æž�过了,这里就ä¸�å†�分æž�了。 -ÏÞÓÚÆª·ù£¬±¾Îľ͵½ÕâÀïÁË£¬ÏÂÆª¼ÌÐø·ÖÎöʣϵÄÁ÷³Ì¡£ +é™�于篇幅,本文就到这里了,下篇继续分æž�剩下的æµ�程。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fba95ddd84c68cdd1757f060ab131478a3c.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4884127](https://my.oschina.net/funcy/blog/4884127) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4884127](https://my.oschina.net/funcy/blog/4884127) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232\345\207\206\345\244\207\350\277\220\350\241\214\347\216\257\345\242\203.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232\345\207\206\345\244\207\350\277\220\350\241\214\347\216\257\345\242\203.md" index 4fceb03..58c1e4c 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232\345\207\206\345\244\207\350\277\220\350\241\214\347\216\257\345\242\203.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232\345\207\206\345\244\207\350\277\220\350\241\214\347\216\257\345\242\203.md" @@ -1,54 +1,54 @@ -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö£¬±¾ÎĽ«·ÖÎö`SpringApplication#run(String...)`·½·¨¡£ +接上文,我们继续分æž�,本文将分æž�`SpringApplication#run(String...)`方法。 -## 3.`springboot`µÄÔËÐУº`SpringApplication#run(String...)` +## 3.`springboot`çš„è¿�行:`SpringApplication#run(String...)` -·½·¨ÄÚÈÝÈçÏ£º +方法内容如下: ``` public ConfigurableApplicationContext run(String... args) { - // 1\. ´´½¨ StopWatch ʵÀý£¬Æäʵ¾ÍÊǸö¼ÆÊ±Æ÷£¬ÓÃÀ´Í³¼ÆspringbootÆô¶¯ºÄʱ + // 1\. 创建 StopWatch 实例,其实就是个计时器,用æ�¥ç»Ÿè®¡springbootå�¯åŠ¨è€—æ—¶ StopWatch stopWatch = new StopWatch(); stopWatch.start(); - // ×¼±¸¿ÕµÄApplicationContext£¬ÒÔ¼°Ò»×éÒì³£±¨¸æÆ÷ + // 准备空的ApplicationContext,以å�Šä¸€ç»„异常报告器 ConfigurableApplicationContext context = null; Collection exceptionReporters = new ArrayList<>(); - // 2\. ÅäÖÃÒ»¸öϵͳÊôÐÔ£ºjava.awt.headless£¬java.awt.headlessģʽÊÇϵͳµÄÒ»ÖÖÅäÖÃģʽ£¬ - // ÔÚϵͳ¿ÉÄÜȱÉÙÏÔʾÉ豸¡¢¼üÅÌ»òÊó±êÕâЩÍâÉèµÄÇé¿öÏ¿ÉÒÔʹÓøÃģʽ + // 2\. é…�置一个系统属性:java.awt.headless,java.awt.headless模å¼�是系统的一ç§�é…�置模å¼�, + // 在系统å�¯èƒ½ç¼ºå°‘显示设备ã€�键盘或鼠标这些外设的情况下å�¯ä»¥ä½¿ç”¨è¯¥æ¨¡å¼� configureHeadlessProperty(); - // 3\. »ñÈ¡¼àÌýÆ÷£¬Ò²ÊÇ´Ó META-INF/spring.factories ÖлñÈ¡ + // 3\. 获å�–监å�¬å™¨ï¼Œä¹Ÿæ˜¯ä»Ž META-INF/spring.factories 中获å�– SpringApplicationRunListeners listeners = getRunListeners(args); - // starting()£ºÊ×´ÎÆô¶¯run·½·¨Ê±Á¢¼´µ÷Ó᣿ÉÓÃÓڷdz£ÔçÆÚµÄ³õʼ»¯£¨×¼±¸ÔËÐÐʱ»·¾³Ö®Ç°£©¡£ - // 4\. ·¢²¼Ê¼þ + // starting():首次å�¯åЍrun方法时立å�³è°ƒç”¨ã€‚å�¯ç”¨äºŽé�žå¸¸æ—©æœŸçš„åˆ�始化(准备è¿�行时环境之å‰�)。 + // 4\. å�‘布事件 listeners.starting(); try { - // ·â×°´«ÈëµÄ²ÎÊý + // å°�装传入的å�‚æ•° ApplicationArguments applicationArguments = new DefaultApplicationArguments(args); - // 5\. ´¦Àí»·¾³²ÎÊý + // 5\. 处ç�†çŽ¯å¢ƒå�‚æ•° ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments); - // 6\. Èç¹ûÓÐÅäÖà spring.beaninfo.ignore£¬Ôò½«¸ÃÅäÖÃÉèÖýøÏµÍ³²ÎÊý + // 6\. 如果有é…�ç½® spring.beaninfo.ignore,则将该é…�置设置进系统å�‚æ•° configureIgnoreBeanInfo(environment); - // 7\. Êä³öbanner + // 7\. 输出banner Banner printedBanner = printBanner(environment); - // 8\. ´´½¨applicationContext + // 8\. 创建applicationContext context = createApplicationContext(); - // Æô¶¯´íÎ󱨸æµÄ×Ô¶¨Ò廨µ÷½Ó¿Ú + // å�¯åŠ¨é”™è¯¯æŠ¥å‘Šçš„è‡ªå®šä¹‰å›žè°ƒæŽ¥å�£ exceptionReporters = getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[] { ConfigurableApplicationContext.class }, context); - // 9\. ×¼±¸ÉÏÏÂÎÄ£¬ÉèÖÃÁËһϵÁеÄÊôÐÔÖµ + // 9\. 准备上下文,设置了一系列的属性值 prepareContext(context, environment, listeners, applicationArguments, printedBanner); - // 10\. µ÷Óà AbstractApplicationContext.refresh£¬Æô¶¯springÈÝÆ÷ + // 10\. 调用 AbstractApplicationContext.refresh,å�¯åЍspring容器 refreshContext(context); - // 11\. ˢкóµÄ´¦Àí + // 11\. 刷新å�Žçš„处ç�† afterRefresh(context, applicationArguments); stopWatch.stop(); if (this.logStartupInfo) { new StartupInfoLogger(this.mainApplicationClass) .logStarted(getApplicationLog(), stopWatch); } - // 12\. ·¢²¼Ê¼þ + // 12\. å�‘布事件 listeners.started(context); - // 13\. µ÷Óà runner£¬ÊµÏÖÁË ApplicationRunner»òCommandLineRunner µÄ½Ó¿Ú + // 13\. 调用 runner,实现了 ApplicationRunner或CommandLineRunner 的接å�£ callRunners(context, applicationArguments); } catch (Throwable ex) { @@ -56,7 +56,7 @@ public ConfigurableApplicationContext run(String... args) { throw new IllegalStateException(ex); } try { - // 14\. ·¢²¼Ê¼þ + // 14\. å�‘布事件 listeners.running(context); } catch (Throwable ex) { @@ -68,21 +68,21 @@ public ConfigurableApplicationContext run(String... args) { ``` -Õû¸öÆô¶¯Á÷³ÌÈçÏ£º +整个å�¯åЍæµ�程如下: ![](https://oscimg.oschina.net/oscnet/up-07a6b491fbe69b8dcbd41e59a8543f06671.png) -½ÓÏÂÀ´ÎÒÃÇÀ´Öصã·ÖÎöÕâ 13 ¸öÆô¶¯Á÷³Ì¡£ +接下æ�¥æˆ‘们æ�¥é‡�点分æž�è¿™ 13 个å�¯åЍæµ�程。 -### 3.1`stopWatch`£º´´½¨¼ÆÊ±Æ÷²¢Æô¶¯ +### 3.1`stopWatch`:创建计时器并å�¯åЍ -Ò»¿ªÊ¼£¬springboot ¾Í´´½¨ÁË`stopWatch`ʵÀý£¬È»ºóµ÷ÓÃ`StopWatch#start()`Æô¶¯¼ÆÊ±¹¦ÄÜ£¬¹ØÓÚÕâ¸öÀàûɶºÃ˵µÄ£¬Ëü¾ÍÊǸö¼ÆÊ±Æ÷£¬ÕâÀïÊÇÓÃÀ´¼ÆËã springboot Æô¶¯ºÄʱ£¬ÒÔÏÂÈÕÖ¾ÖеÄʱ¼ä¾ÍÊÇÓÉÕâ¸ö¼ÆÊ±Æ÷µÃµ½µÄ£º +一开始,springboot 就创建了`stopWatch`实例,然å�Žè°ƒç”¨`StopWatch#start()`å�¯åŠ¨è®¡æ—¶åŠŸèƒ½ï¼Œå…³äºŽè¿™ä¸ªç±»æ²¡å•¥å¥½è¯´çš„ï¼Œå®ƒå°±æ˜¯ä¸ªè®¡æ—¶å™¨ï¼Œè¿™é‡Œæ˜¯ç”¨æ�¥è®¡ç®— springboot å�¯åŠ¨è€—æ—¶ï¼Œä»¥ä¸‹æ—¥å¿—ä¸­çš„æ—¶é—´å°±æ˜¯ç”±è¿™ä¸ªè®¡æ—¶å™¨å¾—åˆ°çš„ï¼š ![](https://oscimg.oschina.net/oscnet/up-70a9e95e6c1208288334341bdb54bd59c17.png) -### 3.2 ÉèÖÃ`java.awt.headless`ÊôÐÔÖµ +### 3.2 设置`java.awt.headless`属性值 -`SpringApplication#configureHeadlessProperty`·½·¨µÄÏà¹Ø´úÂëÈçÏ£º +`SpringApplication#configureHeadlessProperty`方法的相关代ç �如下: ``` public class SpringApplication { @@ -99,7 +99,7 @@ public class SpringApplication { ... private void configureHeadlessProperty() { - // ½« java.awt.headless µÄÖµÅäÖõ½ÏµÍ³±äÁ¿ + // å°† java.awt.headless 的值é…�置到系统å�˜é‡� System.setProperty(SYSTEM_PROPERTY_JAVA_AWT_HEADLESS, System.getProperty(SYSTEM_PROPERTY_JAVA_AWT_HEADLESS, Boolean.toString(this.headless))); @@ -109,19 +109,19 @@ public class SpringApplication { ``` -Õâ¸ö·½·¨½ö½öÊǽ«`java.awt.headless`µÄÖµÉèÖõ½ÁËϵͳ±äÁ¿£¬ÉèÖóÉ`true`£¬±íʾÆô¶¯`java.awt.headless`ģʽ¡£ÄÇôËüÊǸöÉ¶Ä£Ê½ÄØ£¿¼òµ¥À´Ëµ£¬¸Ãģʽ¾ÍÊÇϵͳȱÉÙÁËÏÔʾÉ豸¡¢¼üÅÌ»òÊó±êµÈÇé¿öµÄģʽ£¬·þÎñÆ÷Ò»°ã¶¼ÊÇÔÚÕâÖÖÇé¿öϹ¤×÷µÄ¡£ +这个方法仅仅是将`java.awt.headless`的值设置到了系统å�˜é‡�,设置æˆ�`true`,表示å�¯åЍ`java.awt.headless`模å¼�。那么它是个啥模å¼�呢?简å�•æ�¥è¯´ï¼Œè¯¥æ¨¡å¼�就是系统缺少了显示设备ã€�键盘或鼠标等情况的模å¼�,æœ�务器一般都是在这ç§�情况下工作的。 -### 3.3 »ñÈ¡ÔËÐмàÌýÆ÷ +### 3.3 获å�–è¿�行监å�¬å™¨ -¼ÌÐø£¬ÕâÒ»²½ÊÇ»ñÈ¡ÔËÐмàÌýÆ÷£¬¿ÉÒÔ¼àÌýÔËÐÐÆÚ¼äµÄһЩ״̬£¬¿´´úÂ룺 +继续,这一步是获å�–è¿�行监å�¬å™¨ï¼Œå�¯ä»¥ç›‘å�¬è¿�行期间的一些状æ€�,看代ç �: ``` -// »ñÈ¡¼àÌýÆ÷£¬Ò²ÊÇ´Ó META-INF/spring.factories ÖлñÈ¡ +// 获å�–监å�¬å™¨ï¼Œä¹Ÿæ˜¯ä»Ž META-INF/spring.factories 中获å�– SpringApplicationRunListeners listeners = getRunListeners(args); ``` -½øÈë`SpringApplication#getRunListeners`£º +进入`SpringApplication#getRunListeners`: ``` public class SpringApplication { @@ -130,7 +130,7 @@ public class SpringApplication { private SpringApplicationRunListeners getRunListeners(String[] args) { Class[] types = new Class[] { SpringApplication.class, String[].class }; return new SpringApplicationRunListeners(logger, - // ÒÀÈ»ÊÇ´ÓMETA-INF/spring.factories ÖлñÈ¡£¬key ÊÇ SpringApplicationRunListener + // ä¾�然是从META-INF/spring.factories 中获å�–,key 是 SpringApplicationRunListener getSpringFactoriesInstances(SpringApplicationRunListener.class, types, this, args)); } ... @@ -138,51 +138,51 @@ public class SpringApplication { ``` -¿ÉÒÔ¿´µ½£¬`SpringApplicationRunListener`ÒÀÈ»ÊÇ´Ó`META-INF/spring.factories`ÖлñÈ¡£¬ÄÇ`SpringApplicationRunListener`ÊǸöɶĨ£¿ÎÒÃÇÀ´¿´´úÂ룺 +å�¯ä»¥çœ‹åˆ°ï¼Œ`SpringApplicationRunListener`ä¾�然是从`META-INF/spring.factories`中获å�–,那`SpringApplicationRunListener`是个啥呢?我们æ�¥çœ‹ä»£ç �: ``` public interface SpringApplicationRunListener { /** - * Ê×´ÎÆô¶¯run·½·¨Ê±Á¢¼´µ÷Ó᣿ÉÓÃÓڷdz£ÔçÆÚµÄ³õʼ»¯¡£ + * 首次å�¯åЍrun方法时立å�³è°ƒç”¨ã€‚å�¯ç”¨äºŽé�žå¸¸æ—©æœŸçš„åˆ�始化。 */ default void starting() { } /** - * ×¼±¸ºÃ»·¾³£¨Environment¹¹½¨Íê³É£©£¬µ«ÔÚ´´½¨ApplicationContext֮ǰµ÷Óᣠ+ * 准备好环境(Environment构建完æˆ�),但在创建ApplicationContext之å‰�调用。 */ default void environmentPrepared(ConfigurableEnvironment environment) { } /** - * ÔÚ´´½¨ºÍ¹¹½¨ApplicationContextÖ®ºó£¬µ«ÔÚ¼ÓÔØÖ®Ç°µ÷Óᣠ+ * 在创建和构建ApplicationContext之å�Žï¼Œä½†åœ¨åŠ è½½ä¹‹å‰�调用。 */ default void contextPrepared(ConfigurableApplicationContext context) { } /** - * ApplicationContextÒѼÓÔØµ«ÔÚË¢ÐÂ֮ǰµ÷Óᣠ+ * ApplicationContext已加载但在刷新之å‰�调用。 */ default void contextLoaded(ConfigurableApplicationContext context) { } /** - * ApplicationContextÒÑˢУ¬Ó¦ÓóÌÐòÒÑÆô¶¯£¬ - * µ«ÉÐδµ÷ÓÃCommandLineRunnersºÍApplicationRunners¡£ + * ApplicationContext已刷新,应用程åº�å·²å�¯åŠ¨ï¼Œ + * 但尚未调用CommandLineRunnerså’ŒApplicationRunners。 */ default void started(ConfigurableApplicationContext context) { } /** - * ÔÚÔËÐз½·¨³¹µ×Íê³É֮ǰÁ¢¼´µ÷Ó㬠- * Ë¢ÐÂApplicationContext²¢µ÷ÓÃËùÓÐCommandLineRunnersºÍApplicationRunner¡£ + * 在è¿�行方法彻底完æˆ�之å‰�ç«‹å�³è°ƒç”¨ï¼Œ + * 刷新ApplicationContext并调用所有CommandLineRunnerså’ŒApplicationRunner。 */ default void running(ConfigurableApplicationContext context) { } /** - * ÔÚÔËÐÐÓ¦ÓóÌÐòʱʧ°Üʱµ÷Óᣠ+ * 在è¿�行应用程åº�时失败时调用。 */ default void failed(ConfigurableApplicationContext context, Throwable exception) { } @@ -190,25 +190,25 @@ public interface SpringApplicationRunListener { ``` -`SpringApplicationRunListener`ÊÇÒ»¸ö½Ó¿Ú£¬¶¨ÒåÁËһϵÁеķ½·¨À´¼àÌý springboot µÄÆô¶¯¹ý³Ì£¬·½·¨µÄ˵Ã÷ÒѾ­ÔÚÎĵµÖÐÓÐÏêϸ¶¨Ò壬Èç¹ûÎÒÃÇÐèÒªÔÚ springboot µÄÆô¶¯ÖеÄij¸ö¹ý³Ì×öһЩÊÂÇ飬¾Í¿ÉÒÔʵÏÖ`SpringApplicationRunListener`È»ºóÖØÐ´¶ÔÓ¦µÄ·½·¨¡£ +`SpringApplicationRunListener`是一个接å�£ï¼Œå®šä¹‰äº†ä¸€ç³»åˆ—的方法æ�¥ç›‘å�¬ springboot çš„å�¯åŠ¨è¿‡ç¨‹ï¼Œæ–¹æ³•çš„è¯´æ˜Žå·²ç»�在文档中有详细定义,如果我们需è¦�在 springboot çš„å�¯åŠ¨ä¸­çš„æŸ�个过程å�šä¸€äº›äº‹æƒ…,就å�¯ä»¥å®žçް`SpringApplicationRunListener`ç„¶å�Žé‡�写对应的方法。 -ͨ¹ýµ÷ÊÔ£¬·¢ÏÖ springboot »ñµÃµÄÔËÐмàÌýÆ÷ÈçÏ£º +通过调试,å�‘现 springboot 获得的è¿�行监å�¬å™¨å¦‚下: ![](https://oscimg.oschina.net/oscnet/up-3ed62d827b3bf1989af74f9c4db1fc0b9ce.png) -### 3.4 ÔËÐмàÌýÆ÷·½·¨£º`listeners.starting()` +### 3.4 è¿�行监å�¬å™¨æ–¹æ³•:`listeners.starting()` -»Øµ½`SpringApplication#run(java.lang.String...)`£¬»ñÈ¡µ½ÔËÐмàÌýÆ÷ºó£¬»áÁ¢¼´µ÷ÓÃ`starting()`·½·¨À´·¢²¼Æô¶¯Ê¼þ£º +回到`SpringApplication#run(java.lang.String...)`,获å�–到è¿�行监å�¬å™¨å�Žï¼Œä¼šç«‹å�³è°ƒç”¨`starting()`方法æ�¥å�‘布å�¯åŠ¨äº‹ä»¶ï¼š ``` -// »ñÈ¡¼àÌýÆ÷ +// 获å�–监å�¬å™¨ SpringApplicationRunListeners listeners = getRunListeners(args); -// starting()£ºÊ×´ÎÆô¶¯run·½·¨Ê±Á¢¼´µ÷Ó᣿ÉÓÃÓڷdz£ÔçÆÚµÄ³õʼ»¯£¨×¼±¸ÔËÐÐʱ»·¾³Ö®Ç°£©¡£ +// starting():首次å�¯åЍrun方法时立å�³è°ƒç”¨ã€‚å�¯ç”¨äºŽé�žå¸¸æ—©æœŸçš„åˆ�始化(准备è¿�行时环境之å‰�)。 listeners.starting(); ``` -½øÈë`SpringApplicationRunListeners#starting`·½·¨£º +进入`SpringApplicationRunListeners#starting`方法: ``` void starting() { @@ -219,34 +219,34 @@ void starting() { ``` -¿ÉÒÔ¿´µ½£¬ËùνµÄ·¢²¼Ê¼þ£¬¾ÍÊDZéÀúËùÓеļàÌýÆ÷£¬ÖðÒ»µ÷ÓÃÆä`starting()`°ÕÁË£¬`this.listeners`¾ÍÊÇÉÏÃæ»ñÈ¡µ½µÄËùÓеÄÔËÐмàÌýÆ÷¡£²»½öÈç´Ë£¬`SpringApplicationRunListener`µÄÆäËû·½·¨Èç`environmentPrepared(...)`¡¢`contextPrepared(...)`µÈ¶¼ÊÇÕâÑùµÄµ÷ÓÃÌ×·£¬ºóÃæ¿´µ½Á˾Ͳ»Öظ´·ÖÎöÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œæ‰€è°“çš„å�‘布事件,就是é��历所有的监å�¬å™¨ï¼Œé€�一调用其`starting()`罢了,`this.listeners`就是上é�¢èŽ·å�–到的所有的è¿�行监å�¬å™¨ã€‚ä¸�仅如此,`SpringApplicationRunListener`的其他方法如`environmentPrepared(...)`ã€�`contextPrepared(...)`等都是这样的调用套路,å�Žé�¢çœ‹åˆ°äº†å°±ä¸�é‡�å¤�分æž�了。 -### 3.5 ×¼±¸ÔËÐÐʱ»·¾³ +### 3.5 准备è¿�行时环境 -½ÓÏÂÎÒÃÇÀ´¿´¿´»·¾³²ÎÊýµÄ´¦Àí£¬´úÂëÈçÏ£º +接下我们æ�¥çœ‹çœ‹çŽ¯å¢ƒå�‚数的处ç�†ï¼Œä»£ç �如下: ``` -// ·â×°´«ÈëµÄ²ÎÊý +// å°�装传入的å�‚æ•° ApplicationArguments applicationArguments = new DefaultApplicationArguments(args); -// ´¦Àí»·¾³²ÎÊý +// 处ç�†çŽ¯å¢ƒå�‚æ•° ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments); ``` -½øÈë`SpringApplication#prepareEnvironment`£º +进入`SpringApplication#prepareEnvironment`: ``` private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) { - // »ñÈ¡»·¾³£¬Èç¹û²»´æÔÚÔò´´½¨ + // 获å�–环境,如果ä¸�存在则创建 ConfigurableEnvironment environment = getOrCreateEnvironment(); - // ÅäÖÃÔËÐÐʱ»·¾³ + // é…�ç½®è¿�行时环境 configureEnvironment(environment, applicationArguments.getSourceArgs()); ConfigurationPropertySources.attach(environment); - // SpringApplicationRunListener µÄ environmentPrepared ·½·¨ - // £¨Environment¹¹½¨Íê³É£¬µ«ÔÚ´´½¨ApplicationContext֮ǰ£© + // SpringApplicationRunListener çš„ environmentPrepared 方法 + // (Environment构建完æˆ�,但在创建ApplicationContext之å‰�) listeners.environmentPrepared(environment); - // »·¾³ÓëÓ¦ÓÃ°ó¶¨ + // 环境与应用绑定 bindToSpringApplication(environment); if (!this.isCustomEnvironment) { environment = new EnvironmentConverter(getClassLoader()) @@ -258,11 +258,11 @@ private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners ``` -¿ÉÒÔ¿´µ½¸÷ÖÖ»·¾³×¼±¸£¬ÔÛÃÇÌôÖØµã½²¡£ +å�¯ä»¥çœ‹åˆ°å�„ç§�环境准备,咱们挑é‡�点讲。 -#### 1\. »ñÈ¡»ò´´½¨`Environment` +#### 1\. 获å�–或创建`Environment` -Ö±½Ó½øÈë`SpringApplication#getOrCreateEnvironment`£º +直接进入`SpringApplication#getOrCreateEnvironment`: ``` private ConfigurableEnvironment getOrCreateEnvironment() { @@ -281,9 +281,9 @@ private ConfigurableEnvironment getOrCreateEnvironment() { ``` -´Ó´úÂëÀ´¿´£¬Õâ¸ö·½·¨ÊǸù¾ÝÓ¦ÓÃÀàÐÍÀ´´´½¨¶ÔÓ¦µÄ`Environment`ʵÀý£¬µ±Ç°Ó¦ÓÃÀàÐÍÊÇ`SERVLET`£¬ÔÛÃÇÖ±½Ó¿´`StandardServletEnvironment`ÊÇÈçºÎ´´½¨µÄ¡£ +从代ç �æ�¥çœ‹ï¼Œè¿™ä¸ªæ–¹æ³•是根æ�®åº”用类型æ�¥åˆ›å»ºå¯¹åº”çš„`Environment`实例,当å‰�应用类型是`SERVLET`,咱们直接看`StandardServletEnvironment`是如何创建的。 -ÎÒÃÇÖªµÀ£¬ÔÚ java ÖУ¬´´½¨Ààʱ£¬»áÏȵ÷Óø¸ÀàµÄ¹¹Ôì·½·¨£¬ÕâÀïÎÒÃÇÖ±½Ó½øÈë`AbstractEnvironment`¹¹Ôì·½·¨£º +我们知é�“,在 java 中,创建类时,会先调用父类的构造方法,这里我们直接进入`AbstractEnvironment`构造方法: ``` @@ -300,7 +300,7 @@ public abstract class AbstractEnvironment implements ConfigurableEnvironment { ``` -·¢ÏÖÔÚ`AbstractEnvironment`µÄ¹¹Ôì·½·¨ÖУ¬µ÷ÓÃÁË`customizePropertySources()`£¬¶øÕâ¸ö·½·¨ÔÚ`StandardServletEnvironment`ʵÏÖ£º +å�‘现在`AbstractEnvironment`的构造方法中,调用了`customizePropertySources()`,而这个方法在`StandardServletEnvironment`实现: ``` public class StandardServletEnvironment extends StandardEnvironment @@ -311,22 +311,22 @@ public class StandardServletEnvironment extends StandardEnvironment @Override protected void customizePropertySources(MutablePropertySources propertySources) { - // Ìí¼Ó servletConfigInitParams + // 添加 servletConfigInitParams propertySources.addLast(new StubPropertySource(SERVLET_CONFIG_PROPERTY_SOURCE_NAME)); - // Ìí¼Ó servletContextInitParams + // 添加 servletContextInitParams propertySources.addLast(new StubPropertySource(SERVLET_CONTEXT_PROPERTY_SOURCE_NAME)); if (JndiLocatorDelegate.isDefaultJndiEnvironmentAvailable()) { propertySources.addLast(new JndiPropertySource(JNDI_PROPERTY_SOURCE_NAME)); } - // µ÷Óø¸ÀàµÄ·½·¨ + // 调用父类的方法 super.customizePropertySources(propertySources); } @Override public void initPropertySources(@Nullable ServletContext servletContext, @Nullable ServletConfig servletConfig) { - // Ìæ»»ÉÏÃæÉèÖÃµÄ servletContextInitParams Ϊ servletContext - // Ìæ»»ÉÏÃæÉèÖÃµÄ servletConfigInitParams Ϊ servletConfig + // 替æ�¢ä¸Šé�¢è®¾ç½®çš„ servletContextInitParams 为 servletContext + // 替æ�¢ä¸Šé�¢è®¾ç½®çš„ servletConfigInitParams 为 servletConfig WebApplicationContextUtils.initServletPropertySources( getPropertySources(), servletContext, servletConfig); } @@ -335,25 +335,25 @@ public class StandardServletEnvironment extends StandardEnvironment ``` -¿ÉÒÔ¿´µ½£¬`StandardServletEnvironment`µÄ`customizePropertySources()`·½·¨Ö»ÊÇÌí¼ÓÁ˼¸¸ö servlet Ïà¹ØµÄ²ÎÊý£¬È»ºó¾ÍÈ¥µ÷Óø¸ÀàµÄ¹¹Ôì·½·¨ÁË£¬ÎÒÃǼÌÐø½øÈë`StandardEnvironment`£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`StandardServletEnvironment`çš„`customizePropertySources()`方法å�ªæ˜¯æ·»åŠ äº†å‡ ä¸ª servlet 相关的å�‚数,然å�Žå°±åŽ»è°ƒç”¨çˆ¶ç±»çš„æž„é€ æ–¹æ³•äº†ï¼Œæˆ‘ä»¬ç»§ç»­è¿›å…¥`StandardEnvironment`: -Õâ¸öÀàËÆºõ²¢Ã»ÓÐ×öʲô£¬ÎÒÃǼÌÐø×·×Ù£¬¿´Ëü¸¸ÀàµÄ¹¹Ôì·½·¨£º +这个类似乎并没有å�šä»€ä¹ˆï¼Œæˆ‘们继续追踪,看它父类的构造方法: ``` public class StandardEnvironment extends AbstractEnvironment { - /** ϵͳ»·¾³ */ + /** 系统环境 */ public static final String SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME = "systemEnvironment"; - /** ϵͳÊôÐÔ */ + /** 系统属性 */ public static final String SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME = "systemProperties"; @Override protected void customizePropertySources(MutablePropertySources propertySources) { - // »ñȡϵͳÊôÐÔ£¬µ÷ÓõÄÊÇ System.getenv() + // 获å�–系统属性,调用的是 System.getenv() propertySources.addLast(new PropertiesPropertySource( SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME, getSystemProperties())); - // »ñȡϵͳ»·¾³£¬µ÷ÓõÄÊÇ System.getProperties() + // 获å�–系统环境,调用的是 System.getProperties() propertySources.addLast(new SystemEnvironmentPropertySource( SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, getSystemEnvironment())); } @@ -362,41 +362,41 @@ public class StandardEnvironment extends AbstractEnvironment { ``` -¿ÉÒÔ¿´µ½£¬`StandardEnvironment`µÄ`customizePropertySources()`·½·¨Ö÷ÒªÊǽ«ÏµÍ³ÊôÐÔÓëϵͳ»·¾³Ìí¼Óµ½`Environment`ÖС£¶øÊµ¼ÊÉÏ£¬`Environment`Öаüº¬ÁËÐí¶àµÄϵͳÓë»·¾³Ïà¹ØµÄ²ÎÊý£¬±¾ÉíÒ²ÌṩÁËһЩ`getter`·½·¨¿ÉÒԺܷ½±ãµØ»ñÈ¡ÕâЩ²ÎÊý£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`StandardEnvironment`çš„`customizePropertySources()`方法主è¦�是将系统属性与系统环境添加到`Environment`中。而实际上,`Environment`中包å�«äº†è®¸å¤šçš„系统与环境相关的å�‚数,本身也æ��供了一些`getter`方法å�¯ä»¥å¾ˆæ–¹ä¾¿åœ°èŽ·å�–这些å�‚数: ![](https://oscimg.oschina.net/oscnet/up-d2d69692db15146f2981db94633e7c575d5.png) -µ½ÕâÀÎÒÃǾÍÃ÷°×ÁË£¬`StandardServletEnvironment`Öаüº¬ÁËÈçÏÂÄÚÈÝ£º +到这里,我们就明白了,`StandardServletEnvironment`中包å�«äº†å¦‚下内容: -* ϵͳÊôÐÔ£¬ÎÒÃÇÆ½Ê±µ÷ÓÃ`System.getenv()`µÃµ½µÄ²ÎÊý£» -* ϵͳ»·¾³£¬ÎÒÃÇÆ½Ê±µ÷ÓÃ`System.getProperties()`µÃµ½µÄ²ÎÊý£» -* `servlet`µÄ`servletContext`Óë`servletConfig`. +* 系统属性,我们平时调用`System.getenv()`得到的å�‚æ•°ï¼› +* 系统环境,我们平时调用`System.getProperties()`得到的å�‚æ•°ï¼› +* `servlet`çš„`servletContext`与`servletConfig`. -#### 2\. ÅäÖû·¾³ +#### 2\. é…�置环境 -ÎÒÃǼÌÐø·ÖÎö£¬½Ó×Å¿´¿´ÅäÖû·¾³µÄÁ÷³Ì£¬Ò²¾ÍÊÇ`SpringApplication#configureEnvironment`·½·¨£º +我们继续分æž�,接ç�€çœ‹çœ‹é…�置环境的æµ�程,也就是`SpringApplication#configureEnvironment`方法: ``` protected void configureEnvironment(ConfigurableEnvironment environment, String[] args) { if (this.addConversionService) { - // Ìí¼Óת»»Æ÷£¬´¦Àí²ÎÊýÀàÐÍת»»£¬Èç StringתNumber£¬IntegerתEnumµÈ + // 添加转æ�¢å™¨ï¼Œå¤„ç�†å�‚数类型转æ�¢ï¼Œå¦‚ String转Number,Integer转Enumç­‰ ConversionService conversionService = ApplicationConversionService.getSharedInstance(); environment.setConversionService((ConfigurableConversionService) conversionService); } - // ½«Æô¶¯²ÎÊýÌí¼Óµ½ environment ÖÐ + // å°†å�¯åЍå�‚数添加到 environment 中 configurePropertySources(environment, args); - // ´¦Àí ActiveProfiles Öµ + // 处ç�† ActiveProfiles 值 configureProfiles(environment, args); } ``` -Õâ¸ö·½·¨´úÂë²»¶à£¬¹Ø¼üµã¶¼ÒÑÔÚ´úÂëÖÐ×¢ÊÍÇå³þÁË£¬ÕâÀïÐèÒªÉÔ΢ÌáÏÂ`SpringApplication#configurePropertySources`£º +这个方法代ç �ä¸�多,关键点都已在代ç �中注释清楚了,这里需è¦�ç¨�å¾®æ��下`SpringApplication#configurePropertySources`: ``` protected void configurePropertySources(ConfigurableEnvironment environment, String[] args) { MutablePropertySources sources = environment.getPropertySources(); - // ÉèÖÃĬÈÏÊôÐÔ£¬Èç¹ûÖ¸¶¨ÁËĬÈÏÊôÐÔ£¬¾ÍÔÚÕâÀïÅäÖà + // 设置默认属性,如果指定了默认属性,就在这里é…�ç½® if (this.defaultProperties != null && !this.defaultProperties.isEmpty()) { sources.addLast(new MapPropertySource("defaultProperties", this.defaultProperties)); } @@ -406,7 +406,7 @@ protected void configurePropertySources(ConfigurableEnvironment environment, Str PropertySource source = sources.get(name); CompositePropertySource composite = new CompositePropertySource(name); composite.addPropertySource( - // ½âÎöÆô¶¯Ê±´«ÈëµÄ²ÎÊý + // è§£æž�å�¯åŠ¨æ—¶ä¼ å…¥çš„å�‚æ•° new SimpleCommandLinePropertySource("springApplicationCommandLineArgs", args)); composite.addPropertySource(source); sources.replace(name, composite); @@ -419,7 +419,7 @@ protected void configurePropertySources(ConfigurableEnvironment environment, Str ``` -ÔÚÕâ¸ö·½·¨Àï»á¶Ô´«ÈëµÄ²ÎÊý½øÐнâÎö£¬½øÈë`SimpleCommandLinePropertySource`£º +在这个方法里会对传入的å�‚数进行解æž�,进入`SimpleCommandLinePropertySource`: ``` public class SimpleCommandLinePropertySource @@ -433,7 +433,7 @@ public class SimpleCommandLinePropertySource ``` -×îÖÕ½âÎöµÄ·½·¨ÊÇ`SimpleCommandLineArgsParser#parse`£º +最终解æž�的方法是`SimpleCommandLineArgsParser#parse`: ``` public class SimpleCommandLineArgsParser { @@ -445,7 +445,7 @@ public class SimpleCommandLineArgsParser { String optionName; String optionValue = null; if (optionText.contains("=")) { - // -- ¿ªÍ·ÇÒ°üº¬ = µÄ²ÎÊý£¬»á±»½âÎö³É key/value + // -- 开头且包å�« = çš„å�‚数,会被解æž�æˆ� key/value optionName = optionText.substring(0, optionText.indexOf('=')); optionValue = optionText.substring(optionText.indexOf('=')+1, optionText.length()); } @@ -469,40 +469,40 @@ public class SimpleCommandLineArgsParser { ``` -½âÎö·½·¨»¹ÊDZȽϼòµ¥µÄ£¬¾ÍÊÇ×Ö·û´®µÄ´¦Àí¶øÒÑ¡£ +è§£æž�方法还是比较简å�•的,就是字符串的处ç�†è€Œå·²ã€‚ -springboot µÄÆô¶¯²ÎÊýÓÐɶºÃ½âÎöµÄÄØ£¿ÔÚÆô¶¯ spring ÏîĿʱ£¬ÎÒÃÇ¿ÉÒÔÕâÑùÖ¸¶¨²ÎÊý£º +springboot çš„å�¯åЍå�‚数有啥好解æž�的呢?在å�¯åЍ spring 项目时,我们å�¯ä»¥è¿™æ ·æŒ‡å®šå�‚数: ``` java -jar xxx.jar --a1=aaa --b1=bbb ``` -È»ºóÎÒÃǾÍÄÜͨ¹ý`@Value("${a1}")`»ñÈ¡µ½£¬¹Ø¼ü¾ÍÊÇÔÚÕâÀ¿ÉÒÔ¿´µ½£¬springboot »á°Ñ´«ÈëµÄ`--a1=aaa`¡¢`--b1=bbb`½âÎö³É`a1/aaa`¡¢`b1/bbb`¼üÖµ¶ÔµÄÐÎʽ£¬±£´æµ½`Environment`£¬ºóÐøÒªÓõ½Ê±£¬¾Í¿ÉºÜ·½±ãµØ´Ó`Environment`ÖлñÈ¡ÁË¡£ +ç„¶å�Žæˆ‘们就能通过`@Value("${a1}")`获å�–到,关键就是在这里,å�¯ä»¥çœ‹åˆ°ï¼Œspringboot 会把传入的`--a1=aaa`ã€�`--b1=bbb`è§£æž�æˆ�`a1/aaa`ã€�`b1/bbb`键值对的形å¼�,ä¿�存到`Environment`,å�Žç»­è¦�用到时,就å�¯å¾ˆæ–¹ä¾¿åœ°ä»Ž`Environment`中获å�–了。 -ºÃÁË£¬×¼±¸»·¾³µÄ·ÖÎö¾Íµ½ÕâÀïÁË¡£ +好了,准备环境的分æž�就到这里了。 -### 3.6 ÅäÖÃϵͳ²ÎÊý +### 3.6 é…�置系统å�‚æ•° -Õâ¿éÖ÷ÒªÊÇÅäÖÃÁËÒ»¸ö²ÎÊý£º`spring.beaninfo.ignore`£¬ÓÃÀ´¿ØÖÆÊÇ·ñÌø¹ý`BeanInfo`ÀàµÄËÑË÷£¬`²¢ÇÒÓÉÔ´Âë¿É֪ĬÈÏÖµÊÇtrue`£¬¸Ð¾õÓõIJ»¶à£¬¾Í²»·ÖÎöÁË¡£ +è¿™å�—主è¦�是é…�置了一个å�‚数:`spring.beaninfo.ignore`,用æ�¥æŽ§åˆ¶æ˜¯å�¦è·³è¿‡`BeanInfo`类的æ�œç´¢ï¼Œ`并且由æº�ç �å�¯çŸ¥é»˜è®¤å€¼æ˜¯true`,感觉用的ä¸�多,就ä¸�分æž�了。 -### 3.7 ´òÓ¡`banner` +### 3.7 打å�°`banner` -`banner`ÊÇÔÚÕâÀï´òÓ¡³öµÄ£º +`banner`是在这里打å�°å‡ºçš„: ``` Banner printedBanner = printBanner(environment); ``` -ÎÒÃÇÒ²¿ÉÒÔ×Ô¼º¶¨Òå banner£¬Õâ¸öÍøÉϽ̳ÌÒ»´ó¶Ñ£¬demo ¾Í²»ÌṩÁË¡£ +我们也å�¯ä»¥è‡ªå·±å®šä¹‰ banner,这个网上教程一大堆,demo å°±ä¸�æ��供了。 -¹ØÓÚ`banner`£¬Óë springboot µÄÆô¶¯Á÷³Ì¹ØÏµ²»´ó£¬¾Í²»·ÖÎöÁË£¬Ð¡»ï°éÃÇÖ»ÐèÁ˽âÔõôÑùÓü´¿É¡£ +关于`banner`,与 springboot çš„å�¯åЍæµ�程关系ä¸�大,就ä¸�分æž�了,å°�伙伴们å�ªéœ€äº†è§£æ€Žä¹ˆæ ·ç”¨å�³å�¯ã€‚ -ºÃÁË£¬ÏÞÓÚÆª·ù£¬±¾Îľ͵½ÕâÀïÁË£¬ÏÂÆªÎÒÃǼÌÐø¡£ +好了,é™�于篇幅,本文就到这里了,下篇我们继续。 ![](https://oscimg.oschina.net/oscnet/up-38d3824690292937a6b0cba5b081c8f8fec.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4882417](https://my.oschina.net/funcy/blog/4882417)£¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4882417](https://my.oschina.net/funcy/blog/4882417),é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\345\256\214\346\210\220\345\220\257\345\212\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\345\256\214\346\210\220\345\220\257\345\212\250.md" index 8e6b041..d12f57a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\345\256\214\346\210\220\345\220\257\345\212\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\345\256\214\346\210\220\345\220\257\345\212\250.md" @@ -1,43 +1,43 @@ -ÉÏһƪÎÄÕÂ×ܽá springboot Æô¶¯Á÷³ÌÈçÏ£º +上一篇文章总结 springboot å�¯åЍæµ�程如下: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-07a6b491fbe69b8dcbd41e59a8543f06671.png) -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö½ÓÏÂÀ´µÄ²½Öè¡£ +接上文,我们继续分æž�接下æ�¥çš„æ­¥éª¤ã€‚ -### 3.11 ˢкóµÄ´¦Àí +### 3.11 刷新å�Žçš„处ç�† -ˢкóµÄ´¦Àí·½·¨Îª `SpringApplication#afterRefresh`£¬ÄÚÈÝÈçÏ£º +刷新å�Žçš„处ç�†æ–¹æ³•为 `SpringApplication#afterRefresh`,内容如下: ``` protected void afterRefresh(ConfigurableApplicationContext context, ApplicationArguments args) { } ``` -¿ÉÒÔ¿´µ½£¬ÕâÊÇÒ»¸ö¿Õ·½·¨£¬springboot ÌṩµÄÀ©Õ¹¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™æ˜¯ä¸€ä¸ªç©ºæ–¹æ³•,springboot æ��供的扩展。 -### 3.12 ·¢²¼ `started` ʼþ +### 3.12 å�‘布 `started` 事件 -¸Ã²Ù×÷µÄ·½·¨Îª `listeners.started(context)`£¬·¢²¼Âß¼­Ç°ÃæÒѾ­·ÖÎö¹ý£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË¡£ +该æ“�作的方法为 `listeners.started(context)`,å�‘布逻辑å‰�é�¢å·²ç»�分æž�过,这里就ä¸�å†�分æž�了。 -### 3.13 ÔËÐÐÆ÷»Øµ÷ +### 3.13 è¿�行器回调 -´¦ÀíÔËÐÐÆ÷µÄ·½·¨ÊÇ `SpringApplication#callRunners`£¬´úÂëÈçÏ£º +处ç�†è¿�行器的方法是 `SpringApplication#callRunners`,代ç �如下: ``` private void callRunners(ApplicationContext context, ApplicationArguments args) { List runners = new ArrayList<>(); - // »ñÈ¡ËùÓÐµÄ ApplicationRunner Óë CommandLineRunner + // 获å�–所有的 ApplicationRunner 与 CommandLineRunner runners.addAll(context.getBeansOfType(ApplicationRunner.class).values()); runners.addAll(context.getBeansOfType(CommandLineRunner.class).values()); - // ÅÅÐò + // 排åº� AnnotationAwareOrderComparator.sort(runners); - // ±éÀúµ÷Óà + // é��历调用 for (Object runner : new LinkedHashSet<>(runners)) { - // µ÷Óà ApplicationRunner#run ·½·¨ + // 调用 ApplicationRunner#run 方法 if (runner instanceof ApplicationRunner) { callRunner((ApplicationRunner) runner, args); } - // µ÷Óà CommandLineRunner#run ·½·¨ + // 调用 CommandLineRunner#run 方法 if (runner instanceof CommandLineRunner) { callRunner((CommandLineRunner) runner, args); } @@ -45,7 +45,7 @@ private void callRunners(ApplicationContext context, ApplicationArguments args) } /** - * µ÷Óà ApplicationRunner#run ·½·¨ + * 调用 ApplicationRunner#run 方法 */ private void callRunner(ApplicationRunner runner, ApplicationArguments args) { try { @@ -57,7 +57,7 @@ private void callRunner(ApplicationRunner runner, ApplicationArguments args) { } /** - * µ÷Óà CommandLineRunner#run ·½·¨ + * 调用 CommandLineRunner#run 方法 */ private void callRunner(CommandLineRunner runner, ApplicationArguments args) { try { @@ -69,11 +69,11 @@ private void callRunner(CommandLineRunner runner, ApplicationArguments args) { } ``` -ÕâÁ½¸ö·½·¨±íʾ£¬springboot ΪÎÒÃÇÌṩÁËÁ½¸ö½Ó¿Ú£º`ApplicationRunner` Óë `CommandLineRunner`£¬ÎÒÃÇ¿ÉÒÔʵÏÖËüÀ´Íê³ÉһЩ²Ù×÷£¬Ó¦ÓÃʾÀýÈçÏ£º +这两个方法表示,springboot 为我们æ��供了两个接å�£ï¼š`ApplicationRunner` 与 `CommandLineRunner`,我们å�¯ä»¥å®žçŽ°å®ƒæ�¥å®Œæˆ�一些æ“�作,应用示例如下: ``` /** - * ApplicationRunner ʾÀý + * ApplicationRunner 示例 */ @Component public class MyApplicationRunner implements ApplicationRunner { @@ -84,7 +84,7 @@ public class MyApplicationRunner implements ApplicationRunner { } /** - * CommandLineRunner ʾÀý + * CommandLineRunner 示例 */ @Component public class MyCommandLineRunner implements CommandLineRunner { @@ -95,14 +95,14 @@ public class MyCommandLineRunner implements CommandLineRunner { } ``` -### 3.14 ÔËÐмàÌýÆ÷·½·¨£º `listeners.running(...)` +### 3.14 è¿�行监å�¬å™¨æ–¹æ³•: `listeners.running(...)` -Õâ¸ö·½·¨µÄÔËÐÐÍ¬Ç°Ãæ·ÖÎöµÄ `listeners.starting()` Ì×·һÑù£¬ÕâÀï¾Í²»·ÖÎöÁË¡£ +这个方法的è¿�行å�Œå‰�é�¢åˆ†æž�çš„ `listeners.starting()` 套路一样,这里就ä¸�分æž�了。 -ºÃÁË£¬±¾ÎĵķÖÎö¾Íµ½ÕâÀïÁË£¬¹ØÓÚ springboot µÄÆô¶¯Á÷³ÌµÄ·ÖÎöÒ²µ½ÕâÀïÁË¡£ +好了,本文的分æž�就到这里了,关于 springboot çš„å�¯åЍæµ�程的分æž�也到这里了。 ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-9b539b547c6004c40d2b6f8bd59481b8e34.png) ------ -*±¾ÎÄÔ­ÎÄÁ´½Ó£ºhttps://my.oschina.net/funcy/blog/4906553 £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£* \ No newline at end of file +*本文原文链接:https://my.oschina.net/funcy/blog/4906553 ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。* \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" index 8b2d0ee..8ed1311 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" @@ -1,41 +1,41 @@ -Ç°Ãæ¼¸ÆªÎÄÕ·ÖÎö springboot µÄÆô¶¯Á÷³Ì£¬±¾ÎÄÀ´×ܽáÏ¡£ +å‰�é�¢å‡ ç¯‡æ–‡ç« åˆ†æž� springboot çš„å�¯åЍæµ�程,本文æ�¥æ€»ç»“下。 -ÎÄÕÂÒ»¿ªÊ¼£¬´Ó `SpringApplication.run(Demo01Application.class, args);` ´úÂëÈëÊÖ£¬×ÅÖØ·ÖÎöÁËÁ½¸ö·½·¨£º +文章一开始,从 `SpringApplication.run(Demo01Application.class, args);` 代ç �入手,ç�€é‡�分æž�了两个方法: * `SpringApplication#SpringApplication(...)` * `SpringApplication#run(...)` -ÕâÁ½¸ö·½·¨º­¸ÇÁË springboot Æô¶¯µÄÕû¸öÁ÷³Ì£¬ÕâÀïÎÒÃÇÖðÒ»×ܽáÏ ¡£ +这两个方法涵盖了 springboot å�¯åŠ¨çš„æ•´ä¸ªæµ�程,这里我们é€�一总结下 。 ### `SpringApplication#SpringApplication(...)` -Õâ¸ö·½·¨µÄÁ÷³ÌÈçÏ£º +这个方法的æµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-e9a43f1c523c0f19d37e4741580ed32ca08.png) -ÆäÖУ¬ +其中, -* `webApplicationType` »áÔÚºóÃæ¾ö¶¨´´½¨Ê²Ã´ÀàÐ굀 `applicationContext`£» -* `Initialzers` À´×ÔÓÚ `META-INF/spring.factories`£¬»áÔÚ springboot Æô¶¯Ê±×öһЩ³õʼ»¯²Ù×÷£» -* `Listteners` ͬÑùÀ´×ÔÓÚ `META-INF/spring.factories`£¬ÌṩÁ˶à¸ö·½·¨£¬¿ÉÒÔ·½±ãµØ¼àÌý springboot µÄÖ´Ðйý³Ì¡£ +* `webApplicationType` 会在å�Žé�¢å†³å®šåˆ›å»ºä»€ä¹ˆç±»åž‹çš„ `applicationContext`ï¼› +* `Initialzers` æ�¥è‡ªäºŽ `META-INF/spring.factories`,会在 springboot å�¯åŠ¨æ—¶å�šä¸€äº›åˆ�始化æ“�作; +* `Listteners` å�Œæ ·æ�¥è‡ªäºŽ `META-INF/spring.factories`,æ��供了多个方法,å�¯ä»¥æ–¹ä¾¿åœ°ç›‘å�¬ springboot 的执行过程。 ### `SpringApplication#run(...)` -Õⲿ·ÖµÄÁ÷³ÌÈçÏ£º +这部分的æµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-07a6b491fbe69b8dcbd41e59a8543f06671.png) -ÆäÖУ¬ +其中, -* `getRunListener()` »á»ñÈ¡ËùÓÐµÄ `Listeners`£¬Ò²¾ÍÊÇÔÚ `SpringApplication#SpringApplication(...)` ÖÐ »ñÈ¡µÄ `Listeners`£¬`Listeners` ÖÐÌṩÁËÖÚ¶à·½·¨£¬¿É¼àÌý springboot µÄÆô¶¯Á÷³Ì£» -* ×¼±¸ÔËÐл·¾³Ê±£¬»á¸ù¾Ý `webApplicationType` µÄÀàÐÍÀ´´´½¨¡¢ÅäÖ㬵õ½ÏàÓ¦ÀàÐ굀 `Environment` ¶ÔÏó£¬Õâ ¸ö¶ÔÏóºóÃæ»áÉèÖõ½ spring ÈÝÆ÷ÖУ¬spring ÈÝÆ÷ÖÐʹÓÃµÄ `Environment` ¾ÍÊÇÔÚÕâÀï´´½¨¼°ÅäÖõģ» -* ´´½¨ ioc ÈÝÆ÷ʱ£¬Ò²ÊǸù¾Ý `webApplicationType` µÄÀàÐÍÀ´´´½¨¶ÔÓ¦µÄ `ApplicationContext`£» -* ÔÚ×¼±¸ ioc ÈÝÆ÷µÄ·½·¨ÖУ¬»á¶Ô `ApplicationContext` ×öÒ»¸öÅäÖà £¬`Initializers` Ò²»áÔÚÕâÀïÔËÐУ» -* Æô¶¯ ioc ÈÝÆ÷ʱ£¬springboot »á×¢²áÒ»¸ö shutdownhook£¬ÓÃÒÔÔÚÏîÄ¿¹Ø±Õʱ´¦Àí¹Ø±Õ²Ù×÷£¬ÁíÍ⣬¶ÔÓÚ ioc µÄÆô¶¯Á÷³Ì£¬springboot ÔÚÆäÀ©Õ¹Öлᴴ½¨¼°Æô¶¯ web ÈÝÆ÷£» -* springboot ÌṩÁËÁ½ÖÖÀàÐ͵ÄÔËÐÐÆ÷£º`ApplicationRunner`¡¢`CommandLineRunner`£¬ÔÚÆô¶¯ºó»áµ÷ÓÃÁ½Õߵķ½·¨¡£ +* `getRunListener()` 会获å�–所有的 `Listeners`,也就是在 `SpringApplication#SpringApplication(...)` 中 获å�–çš„ `Listeners`,`Listeners` 中æ��供了众多方法,å�¯ç›‘å�¬ springboot çš„å�¯åЍæµ�程; +* 准备è¿�行环境时,会根æ�® `webApplicationType` 的类型æ�¥åˆ›å»ºã€�é…�置,得到相应类型的 `Environment` 对象,这 个对象å�Žé�¢ä¼šè®¾ç½®åˆ° spring 容器中,spring 容器中使用的 `Environment` 就是在这里创建å�Šé…�置的; +* 创建 ioc 容器时,也是根æ�® `webApplicationType` 的类型æ�¥åˆ›å»ºå¯¹åº”çš„ `ApplicationContext`ï¼› +* 在准备 ioc 容器的方法中,会对 `ApplicationContext` å�šä¸€ä¸ªé…�ç½® ,`Initializers` 也会在这里è¿�行; +* å�¯åЍ ioc 容器时,springboot 会注册一个 shutdownhook,用以在项目关闭时处ç�†å…³é—­æ“�作,å�¦å¤–,对于 ioc çš„å�¯åЍæµ�程,springboot 在其扩展中会创建å�Šå�¯åЍ web 容器; +* springboot æ��供了两ç§�类型的è¿�行器:`ApplicationRunner`ã€�`CommandLineRunner`,在å�¯åЍå�Žä¼šè°ƒç”¨ä¸¤è€…的方法。 -ÒÔÉÏÄÚÈݽ²µÄ±È½Ï¼òÂÔ£¬Èç¹ûÒªÏêϸÁ˽⣬¿É×ÔÐÐÔĶÁÇ°ÃæµÄÎÄÕ¡£ +以上内容讲的比较简略,如果è¦�详细了解,å�¯è‡ªè¡Œé˜…读å‰�é�¢çš„æ–‡ç« ã€‚ * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4906588](https://my.oschina.net/funcy/blog/4906588) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4906588](https://my.oschina.net/funcy/blog/4906588) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250IOC\345\256\271\345\231\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250IOC\345\256\271\345\231\250.md" index 507a1a5..7112779 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250IOC\345\256\271\345\231\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250IOC\345\256\271\345\231\250.md" @@ -1,20 +1,20 @@ -ÉÏһƪÎÄÕÂ×ܽá springboot Æô¶¯Á÷³ÌÈçÏ£º +上一篇文章总结 springboot å�¯åЍæµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-07a6b491fbe69b8dcbd41e59a8543f06671.png) -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö½ÓÏÂÀ´µÄ²½Öè¡£ +接上文,我们继续分æž�接下æ�¥çš„æ­¥éª¤ã€‚ -### 3.10 ˢРioc ÈÝÆ÷ +### 3.10 刷新 ioc 容器 -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `SpringApplication#refreshContext` ·½·¨£º +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `SpringApplication#refreshContext` 方法: ``` private void refreshContext(ConfigurableApplicationContext context) { - // Æô¶¯springÈÝÆ÷ + // å�¯åЍspring容器 refresh(context); if (this.registerShutdownHook) { try { - // ×¢²á ShutdownHook + // 注册 ShutdownHook context.registerShutdownHook(); } catch (AccessControlException ex) { @@ -25,45 +25,45 @@ private void refreshContext(ConfigurableApplicationContext context) { ``` -Õâ¸ö·½·¨²Ù×÷¾ÍÁ½¸ö£º +这个方法æ“�作就两个: -1. `refresh(context)`£ºÆô¶¯ spring ÈÝÆ÷£¬Ò²²»Êǵ÷Óà `AbstractApplicationContext#refresh` ·½·¨£» -2. `context.registerShutdownHook()`£º×¢²á `ShutdownHook`£¬¿ÉÒÔÔÚ jvm ½ø³Ì¹Ø±Õʱ´¦ÀíÒ»Ð©ÌØ¶¨µÄ²Ù×÷¡£ +1. `refresh(context)`:å�¯åЍ spring 容器,也ä¸�是调用 `AbstractApplicationContext#refresh` 方法; +2. `context.registerShutdownHook()`:注册 `ShutdownHook`,å�¯ä»¥åœ¨ jvm 进程关闭时处ç�†ä¸€äº›ç‰¹å®šçš„æ“�作。 -#### 3.10.1 Æô¶¯ spring ÈÝÆ÷ +#### 3.10.1 å�¯åЍ spring 容器 -½øÈë `SpringApplication#refresh`£º +进入 `SpringApplication#refresh`: ``` protected void refresh(ApplicationContext applicationContext) { Assert.isInstanceOf(AbstractApplicationContext.class, applicationContext); - // spring ÈÝÆ÷µÄÆô¶¯²Ù×÷ÁË + // spring 容器的å�¯åЍæ“�作了 ((AbstractApplicationContext) applicationContext).refresh(); } ``` -Õâ¸ö·½·¨ºÜ¼òµ¥£¬ÏÈÅÐ¶Ï `applicationContext` µÄÀàÐÍÊÇ·ñΪ `AbstractApplicationContext`£¬È»ºóÔÙµ÷Óà `AbstractApplicationContext#refresh()`¡£ +这个方法很简å�•,先判断 `applicationContext` 的类型是å�¦ä¸º `AbstractApplicationContext`,然å�Žå†�调用 `AbstractApplicationContext#refresh()`。 -¹ØÓÚ `AbstractApplicationContext#refresh()`£¬ÄÇ¿ÉÊÇ´óÃû¶¦¶¦°¡£¬¸Ã·½·¨º­¸ÇÁË spring ÈÝÆ÷µÄÆô¶¯Á÷³Ì¡£ÓÉÓÚ±¾ÎIJ»ÊÇ·ÖÎö spring µÄÎÄÕ£¬Òò´ËÕâ¿é¾Í²»Õ¹¿ª·ÖÎöÁË£¬ÏëÒªÁ˽âµÄÆô¶¯Á÷³ÌµÄС»ï°é¿ÉÒԲο¼ÒÔÏÂÎÄÕ£º +关于 `AbstractApplicationContext#refresh()`,那å�¯æ˜¯å¤§å��鼎鼎啊,该方法涵盖了 spring 容器的å�¯åЍæµ�程。由于本文ä¸�是分æž� spring 的文章,因此这å�—å°±ä¸�展开分æž�了,想è¦�了解的å�¯åЍæµ�程的å°�伙伴å�¯ä»¥å�‚考以下文章: -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨ËÄ£©£ºÆô¶¯Ç°µÄ×¼±¸¹¤×÷](https://my.oschina.net/funcy/blog/4633169) -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨Î壩£ºÖ´ÐÐ BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4641114) -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨Áù£©£º×¢²á BeanPostProcessor](https://my.oschina.net/funcy/blog/4657181) -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨Æß£©£º¹ú¼Ê»¯Óëʼþ´¦Àí](https://my.oschina.net/funcy/blog/4892120) -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨°Ë£©£ºÍê³É BeanFactory µÄ³õʼ»¯](https://my.oschina.net/funcy/blog/4658230) -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨¾Å£©£ºµ¥Àý bean µÄ´´½¨](https://my.oschina.net/funcy/blog/4659524) -* [¡¾spring Ô´Âë·ÖÎö¡¿spring Æô¶¯Á÷³Ì£¨Ê®£©£ºÆô¶¯Íê³ÉµÄ´¦Àí](https://my.oschina.net/funcy/blog/4892555) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(四):å�¯åЍå‰�的准备工作](https://my.oschina.net/funcy/blog/4633169) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(五):执行 BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4641114) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(六):注册 BeanPostProcessor](https://my.oschina.net/funcy/blog/4657181) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(七):国际化与事件处ç�†](https://my.oschina.net/funcy/blog/4892120) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(八):完æˆ� BeanFactory çš„åˆ�始化](https://my.oschina.net/funcy/blog/4658230) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(ä¹�):å�•例 bean 的创建](https://my.oschina.net/funcy/blog/4659524) +* [ã€�spring æº�ç �分æž�】spring å�¯åЍæµ�程(å��):å�¯åŠ¨å®Œæˆ�的处ç�†](https://my.oschina.net/funcy/blog/4892555) -ÔÚ `AbstractApplicationContext#refresh()` ÖУ¬spring ÌṩÁ˼¸¸öÀ©Õ¹µã£º +在 `AbstractApplicationContext#refresh()` 中,spring æ��供了几个扩展点: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b86d0fb2e3790f63b5c6590884be9401354.png) -ÎÒÃǵ±Ç°Ê¹ÓÃµÄ `applicationContext` Ϊ `AnnotationConfigServletWebServerApplicationContext`£¬ÆäÖÐҲʹÓÃÁËÕâЩÀ©Õ¹µã£¬ÎÒÃÇÖ÷Òª¹Ø×¢ÕâЩÀ©Õ¹µãµÄÓ¦Óᣠ+我们当å‰�使用的 `applicationContext` 为 `AnnotationConfigServletWebServerApplicationContext`,其中也使用了这些扩展点,我们主è¦�关注这些扩展点的应用。 -##### 1\. Æô¶¯Ç°×¼±¸£º`prepareRefresh()` +##### 1\. å�¯åЍå‰�准备:`prepareRefresh()` -¾­¹ýµ÷ÊÔ·¢ÏÖ£¬`initPropertySources()` ·½·¨»áÔËÐе½£¬µ÷ÓÃÁ´ÈçÏ£º +ç»�过调试å�‘现,`initPropertySources()` 方法会è¿�行到,调用链如下: ``` AbstractApplicationContext#refresh @@ -73,7 +73,7 @@ AbstractApplicationContext#refresh ``` -×îÖÕµ÷ÓõÄÊÇ `GenericWebApplicationContext#initPropertySources`£º +最终调用的是 `GenericWebApplicationContext#initPropertySources`: ``` protected void initPropertySources() { @@ -85,43 +85,43 @@ protected void initPropertySources() { ``` -Õâ¸ö·½·¨ÀïÏÈ»ñÈ¡ `Environment`£¬È»ºóÅжÏÊÇ·ñΪ `ConfigurableWebEnvironment` µÄʵÀý£¬ÔÚÇ°Ãæ·ÖÎö**×¼±¸ÔËÐÐʱ»·¾³**ʱ£¬ÎÒÃǵõ½µÄ `Environment` Ϊ `StandardServletEnvironment`£¬ÊÇ `ConfigurableWebEnvironment` µÄ·ûºÏ£¬È»ºóµ÷Óà `ConfigurableWebEnvironment#initPropertySources` ·½·¨£¬½á¹ûµ½ÁË `StandardServletEnvironment#initPropertySources`£º +这个方法里先获å�– `Environment`,然å�Žåˆ¤æ–­æ˜¯å�¦ä¸º `ConfigurableWebEnvironment` 的实例,在å‰�é�¢åˆ†æž�**准备è¿�行时环境**时,我们得到的 `Environment` 为 `StandardServletEnvironment`,是 `ConfigurableWebEnvironment` 的符å�ˆï¼Œç„¶å�Žè°ƒç”¨ `ConfigurableWebEnvironment#initPropertySources` 方法,结果到了 `StandardServletEnvironment#initPropertySources`: ``` public void initPropertySources(@Nullable ServletContext servletContext, @Nullable ServletConfigservletConfig) { - // Ìæ»»ÉÏÃæÉèÖÃµÄ servletContextInitParams Ϊ servletContext - // Ìæ»»ÉÏÃæÉèÖÃµÄ servletConfigInitParams Ϊ servletConfig + // 替æ�¢ä¸Šé�¢è®¾ç½®çš„ servletContextInitParams 为 servletContext + // 替æ�¢ä¸Šé�¢è®¾ç½®çš„ servletConfigInitParams 为 servletConfig WebApplicationContextUtils.initServletPropertySources(getPropertySources(), servletContext, servletConfig); } ``` -Õâ¸ö·½·¨»¹ÊǺܼòµ¥£¬Ö»Êǽ« `servletContext` Óë `servletConfig` ÉèÖõ½ÁË `Environment` ÖС£ +这个方法还是很简å�•,å�ªæ˜¯å°† `servletContext` 与 `servletConfig` 设置到了 `Environment` 中。 -##### 2\. »ñÈ¡ `beanFactory`: `obtainFreshBeanFactory()` +##### 2\. 获å�– `beanFactory`: `obtainFreshBeanFactory()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 3\. ×¼±¸ `beanFactory`: `prepareBeanFactory(beanFactory)` +##### 3\. 准备 `beanFactory`: `prepareBeanFactory(beanFactory)` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 4\. À©Õ¹µã£º`postProcessBeanFactory(beanFactory)` +##### 4\. 扩展点:`postProcessBeanFactory(beanFactory)` -`AnnotationConfigServletWebServerApplicationContext` ÖØÐ´ÁËÕâ¸ö·½·¨£º +`AnnotationConfigServletWebServerApplicationContext` é‡�写了这个方法: ``` @Override protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { - // µ÷Óø¸ÀàµÄ·½·¨ + // 调用父类的方法 super.postProcessBeanFactory(beanFactory); - // ½øÐаüɨÃ裬ÕâÀïµÄ°ü²¢²»´æÔÚ + // 进行包扫æ��,这里的包并ä¸�存在 if (this.basePackages != null && this.basePackages.length > 0) { this.scanner.scan(this.basePackages); } - // ×¢²ábean£¬Îª¿Õ + // 注册bean,为空 if (!this.annotatedClasses.isEmpty()) { this.reader.register(ClassUtils.toClassArray(this.annotatedClasses)); } @@ -129,29 +129,29 @@ protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactor ``` -Õâ¸ö·½·¨µÄÖ´Ðйý³ÌÈçÏ£º +这个方法的执行过程如下: -1. µ÷ÓÃÁ˸¸ÀàµÄ·½·¨ `super.postProcessBeanFactory(beanFactory)` -2. ½øÐаüɨÃ裬ͨ¹ýµ÷ÊÔ·¢ÏÖ£¬ÕâÀïµÄ `basePackages` Ϊ nul -3. ×¢²á `annotatedClasses`£¬ÕâÀïµÄ `annotatedClasses` Ϊ¿Õ +1. 调用了父类的方法 `super.postProcessBeanFactory(beanFactory)` +2. 进行包扫æ��,通过调试å�‘现,这里的 `basePackages` 为 nul +3. 注册 `annotatedClasses`,这里的 `annotatedClasses` 为空 -ÎÒÃÇÖ÷ÒªÀ´¿´¿´ `super.postProcessBeanFactory(beanFactory)`£¬¸Ã·½·¨ÔÚ `ServletWebServerApplicationContext` ÖУº +我们主è¦�æ�¥çœ‹çœ‹ `super.postProcessBeanFactory(beanFactory)`,该方法在 `ServletWebServerApplicationContext` 中: ``` @Override protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { - // Ìí¼ÓÒ»¸ö BeanPostProcessor + // 添加一个 BeanPostProcessor beanFactory.addBeanPostProcessor( new WebApplicationContextServletContextAwareProcessor(this)); - // ºöÂÔ ServletContextAware µÄ×Ô¶¯×¢Èë + // 忽略 ServletContextAware 的自动注入 beanFactory.ignoreDependencyInterface(ServletContextAware.class); - // ×¢²á web bean µÄ·¶Î§£¬ÕâÀï»á×¢²árequest¡¢session¡¢globalSessionµÄ×÷ÓÃÓò + // 注册 web bean 的范围,这里会注册requestã€�sessionã€�globalSession的作用域 registerWebApplicationScopes(); } ``` -Õâ¸ö·½·¨ÄÚÈݱȽϼòµ¥£¬Ö÷ÒªÊÇ×¢²á `BeanPostProcessor` ÒÔ¼°×¢²á `web bean` µÄ×÷Ó÷¶Î§¡£ÕâÀïÎÒÃÇÖ÷Òª¿´Ï `WebApplicationContextServletContextAwareProcessor` µÄ×÷Ó㬴úÂëÈçÏ£º +这个方法内容比较简å�•,主è¦�是注册 `BeanPostProcessor` 以å�Šæ³¨å†Œ `web bean` 的作用范围。这里我们主è¦�看下 `WebApplicationContextServletContextAwareProcessor` 的作用,代ç �如下: ``` public class WebApplicationContextServletContextAwareProcessor @@ -166,7 +166,7 @@ public class WebApplicationContextServletContextAwareProcessor } /** - * »ñÈ¡ ServletContext + * 获å�– ServletContext */ @Override protected ServletContext getServletContext() { @@ -175,7 +175,7 @@ public class WebApplicationContextServletContextAwareProcessor } /** - * »ñÈ¡ ServletConfig + * 获å�– ServletConfig */ @Override protected ServletConfig getServletConfig() { @@ -187,7 +187,7 @@ public class WebApplicationContextServletContextAwareProcessor ``` -Õâ¸öÀàËÆºõ²¢Ã»ÓÐ×öʲô£¬ÎÒÃÇÔÙ¸ú½ø¸¸À࣬ÓÉÓÚËüÊǸö `BeanPostProcessor`£¬ÎÒÃÇÖ÷Òª¹Ø×¢ËüµÄ `postProcessBeforeInitialization()` Óë `postProcessAfterInitialization()` Á½¸ö·½·¨£º +这个类似乎并没有å�šä»€ä¹ˆï¼Œæˆ‘们å†�跟进父类,由于它是个 `BeanPostProcessor`,我们主è¦�关注它的 `postProcessBeforeInitialization()` 与 `postProcessAfterInitialization()` 两个方法: ``` public class ServletContextAwareProcessor implements BeanPostProcessor { @@ -196,11 +196,11 @@ public class ServletContextAwareProcessor implements BeanPostProcessor { public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { - // ÉèÖà ServletContext + // 设置 ServletContext if (getServletContext() != null && bean instanceof ServletContextAware) { ((ServletContextAware) bean).setServletContext(getServletContext()); } - // ÉèÖà ServletConfig + // 设置 ServletConfig if (getServletConfig() != null && bean instanceof ServletConfigAware) { ((ServletConfigAware) bean).setServletConfig(getServletConfig()); } @@ -216,37 +216,37 @@ public class ServletContextAwareProcessor implements BeanPostProcessor { ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö `BeanPostProcessor` ÊÇÓÃÀ´´¦Àí `ServletContextAware` Óë `ServletConfigAware` Á½¸ö `Aware` ½Ó¿ÚµÄ£¬Ì×·ͬ´¦Àí `ApplicationAware`¡¢`BeanFactoryAware` µÈÒ»Ñù¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ª `BeanPostProcessor` 是用æ�¥å¤„ç�† `ServletContextAware` 与 `ServletConfigAware` 两个 `Aware` 接å�£çš„,套路å�Œå¤„ç�† `ApplicationAware`ã€�`BeanFactoryAware` 等一样。 -##### 5\. Ö´ÐÐ `BeanFactoryPostProcessors`: `invokeBeanFactoryPostProcessors(beanFactory)` +##### 5\. 执行 `BeanFactoryPostProcessors`: `invokeBeanFactoryPostProcessors(beanFactory)` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -ÖµµÃÒ»ÌáµÄÊÇ£¬ÔÚÕâ¸ö·½·¨ÖУ¬ÓиöÖØµÄ `BeanFactoryPostProcessor` »á±»Ö´ÐУº`ConfigurationClassPostProcessor`£¬springboot µÄ×Ô¶¯×°ÅäµÄÆôÓÃ×¢½â `@EnableAutoConfiguration` »áÔÚÕâÀï´¦Àí£¬×Ô¶¯×°ÅäÀàµÄ¼ÓÔØ¡¢Ìõ¼þ×¢½âÒ²ÊÇÔÚ `ConfigurationClassPostProcessor` ÖС£ +值得一æ��的是,在这个方法中,有个é‡�çš„ `BeanFactoryPostProcessor` 会被执行:`ConfigurationClassPostProcessor`,springboot 的自动装é…�çš„å�¯ç”¨æ³¨è§£ `@EnableAutoConfiguration` 会在这里处ç�†ï¼Œè‡ªåŠ¨è£…é…�类的加载ã€�æ�¡ä»¶æ³¨è§£ä¹Ÿæ˜¯åœ¨ `ConfigurationClassPostProcessor` 中。 -##### 6\. ×¢²á `BeanPostProcessor`: `registerBeanPostProcessors(beanFactory)` +##### 6\. 注册 `BeanPostProcessor`: `registerBeanPostProcessors(beanFactory)` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 7\. ³õʼ»¯` MessageSource`(ÓÃÓÚ¹ú¼Ê»¯²Ù×÷): `initMessageSource()` +##### 7\. åˆ�始化` MessageSource`(用于国际化æ“�作): `initMessageSource()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 8\. ³õʼ»¯Ê¼þ¹ã²¥Æ÷£º`initApplicationEventMulticaster()` +##### 8\. åˆ�始化事件广播器:`initApplicationEventMulticaster()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 9\. À©Õ¹µã£º`onRefresh()` +##### 9\. 扩展点:`onRefresh()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨µÄÀ©Õ¹Îª `ServletWebServerApplicationContext#onRefresh` ·½·¨£¬´úÂëÈçÏ£º +当å‰� `applicationContext` 对该方法的扩展为 `ServletWebServerApplicationContext#onRefresh` 方法,代ç �如下: ``` @Override protected void onRefresh() { - // µ÷Óø¸Àà·½·¨ + // 调用父类方法 super.onRefresh(); try { - // ´´½¨web·þÎñÆ÷£¬Èçtomcat,jettyµÈ + // 创建webæœ�务器,如tomcat,jettyç­‰ createWebServer(); } catch (Throwable ex) { @@ -256,34 +256,34 @@ protected void onRefresh() { ``` -¿ÉÒÔ ¿´µ½£¬web ·þÎñÆ÷ÊÇÔÚÕâ¸ö·½·¨Öд´½¨µÄ¡£²»¹ý web ·þÎñÆ÷µÄ´´½¨²¢²»¼òµ¥£¬ÐèÒª¾­¹ý¶àÖÖÌõ¼þÅжϣ¬¹ØÓÚÕâµãÎÒÃǺóÃæÔÙÏêϸ˵Ã÷¡£ +å�¯ä»¥ 看到,web æœ�务器是在这个方法中创建的。ä¸�过 web æœ�务器的创建并ä¸�简å�•,需è¦�ç»�过多ç§�æ�¡ä»¶åˆ¤æ–­ï¼Œå…³äºŽè¿™ç‚¹æˆ‘们å�Žé�¢å†�详细说明。 -##### 10\. ×¢²áʼþ¼àÌýÆ÷£º`registerListeners()` +##### 10\. 注册事件监å�¬å™¨ï¼š`registerListeners()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 11\. ³õʼ»¯µ¥Àý `bean`: `finishBeanFactoryInitialization(beanFactory)` +##### 11\. åˆ�始化å�•例 `bean`: `finishBeanFactoryInitialization(beanFactory)` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -##### 12\. Íê³ÉÆô¶¯²Ù×÷: `finishRefresh()` +##### 12\. 完æˆ�å�¯åЍæ“�作: `finishRefresh()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨µÄÀ©Õ¹Îª `ServletWebServerApplicationContext#finishRefresh` ·½·¨£¬´úÂëÈçÏ£º +当å‰� `applicationContext` 对该方法的扩展为 `ServletWebServerApplicationContext#finishRefresh` 方法,代ç �如下: ``` @Override protected void finishRefresh() { super.finishRefresh(); - // Æô¶¯webÈÝÆ÷ + // å�¯åЍweb容器 WebServer webServer = startWebServer(); if (webServer != null) { - // ·¢²¼ ServletWebServerInitializedEvent ʼþ + // å�‘布 ServletWebServerInitializedEvent 事件 publishEvent(new ServletWebServerInitializedEvent(webServer, this)); } } /** - * Æô¶¯webÈÝÆ÷ + * å�¯åЍweb容器 */ private WebServer startWebServer() { WebServer webServer = this.webServer; @@ -295,15 +295,15 @@ private WebServer startWebServer() { ``` -¿ÉÒÔ¿´µ½£¬ÕâÀï²ÅÊÇÕæÕýÆô¶¯ web ÈÝÆ÷¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œæ‰�是真正å�¯åЍ web 容器。 -##### 13\. Çå³ý»º´æ: `resetCommonCaches()` +##### 13\. 清除缓存: `resetCommonCaches()` -µ±Ç° `applicationContext` ¶Ô¸Ã·½·¨ÎÞÀ©Õ¹£¬²»·ÖÎö¡£ +当å‰� `applicationContext` 对该方法无扩展,ä¸�分æž�。 -#### 3.10.2 ×¢²á `ShutdownHook` +#### 3.10.2 注册 `ShutdownHook` -ÎÒÃÇÔÙÀ´¿´ `context.registerShutdownHook()`£¬¸Ã·½·¨ÓÉ `AbstractApplicationContext#registerShutdownHook` Ìṩ£º +我们å†�æ�¥çœ‹ `context.registerShutdownHook()`,该方法由 `AbstractApplicationContext#registerShutdownHook` æ��供: ``` public abstract class AbstractApplicationContext extends DefaultResourceLoader @@ -312,12 +312,12 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader @Override public void registerShutdownHook() { if (this.shutdownHook == null) { - // Ö¸¶¨Ï̵߳ÄÃû×Ö + // 指定线程的å��å­— this.shutdownHook = new Thread(SHUTDOWN_HOOK_THREAD_NAME) { @Override public void run() { synchronized (startupShutdownMonitor) { - // ÕâÀï¾ÍÊÇ ShutdownHook µÄÄÚÈÝ + // 这里就是 ShutdownHook 的内容 doClose(); } } @@ -327,7 +327,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader } /** - * ´¦ÀíÈÝÆ÷µÄ¹Ø±Õ²Ù×÷ + * 处ç�†å®¹å™¨çš„关闭æ“�作 */ protected void doClose() { // Check whether an actual close attempt is necessary... @@ -335,14 +335,14 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader LiveBeansView.unregisterApplicationContext(this); try { - // ·¢²¼¹Ø±Õʼþ + // å�‘布关闭事件 publishEvent(new ContextClosedEvent(this)); } catch (Throwable ex) { logger.warn(...); } - // µ÷Óà lifecycle µÄ onClose() ·½·¨ + // 调用 lifecycle çš„ onClose() 方法 if (this.lifecycleProcessor != null) { try { this.lifecycleProcessor.onClose(); @@ -352,22 +352,22 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader } } - // Ïú»Ù bean + // 销æ¯� bean destroyBeans(); - // ¹Ø±ÕÈÝÆ÷ + // 关闭容器 closeBeanFactory(); - // À©Õ¹µã£¬´ý×ÓÀàʵÏÖ + // 扩展点,待å­�类实现 onClose(); - // Çå³ý¼àÌýÆ÷ + // 清除监å�¬å™¨ if (this.earlyApplicationListeners != null) { this.applicationListeners.clear(); this.applicationListeners.addAll(this.earlyApplicationListeners); } - // ÉèÖà active ±êʶ + // 设置 active 标识 this.active.set(false); } } @@ -378,12 +378,12 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader ``` -¿ÉÒÔ¿´µ½£¬`context.registerShutdownHook()` ʵ¼ÊÉÏÊÇÔËÐÐÁË `doClose()` ·½·¨£¬ÓÃÀ´´¦ÀíÈÝÆ÷µÄ¹Ø±Õ²Ù×÷¡£¹Ø±Õ spring ÈÝÆ÷µÄ¹Ø±Õ£¬×¢ÊÍÒѾ­Ï൱Çå³þÁË£¬ÕâÀï¾Í²»ÉîÈëÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`context.registerShutdownHook()` 实际上是è¿�行了 `doClose()` 方法,用æ�¥å¤„ç�†å®¹å™¨çš„关闭æ“�作。关闭 spring 容器的关闭,注释已ç»�相当清楚了,这里就ä¸�深入了。 -ºÃÁË£¬ÈÝÆ÷µÄÆô¶¯¾Í·ÖÎöµ½ÕâÀïÁË£¬´ÓÁ÷³ÌÉÏÀ´½²£¬Óë spring ÈÝÆ÷Æô¶¯µÄ×î´óÀ©Õ¹ÔÚÓÚ `onRefresh()` Óë `finishRefresh()`£¬Ç°Õß´´½¨ÁË `webServer` ÈÝÆ÷£¬ºóÕ߯ô¶¯ÁË `webServer` ÈÝÆ÷¡£ +好了,容器的å�¯åŠ¨å°±åˆ†æž�到这里了,从æµ�程上æ�¥è®²ï¼Œä¸Ž spring 容器å�¯åŠ¨çš„æœ€å¤§æ‰©å±•åœ¨äºŽ `onRefresh()` 与 `finishRefresh()`,å‰�者创建了 `webServer` 容器,å�Žè€…å�¯åŠ¨äº† `webServer` 容器。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-81033ec78641ad875623cf452ef9cd62eb6.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4888129](https://my.oschina.net/funcy/blog/4888129) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4888129](https://my.oschina.net/funcy/blog/4888129) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\200\357\274\211\357\274\232\345\212\240\350\275\275\350\207\252\345\212\250\350\243\205\351\205\215\347\261\273.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\200\357\274\211\357\274\232\345\212\240\350\275\275\350\207\252\345\212\250\350\243\205\351\205\215\347\261\273.md" index 2dbdfc7..a41c239 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\200\357\274\211\357\274\232\345\212\240\350\275\275\350\207\252\345\212\250\350\243\205\351\205\215\347\261\273.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\200\357\274\211\357\274\232\345\212\240\350\275\275\350\207\252\345\212\250\350\243\205\351\205\215\347\261\273.md" @@ -1,27 +1,27 @@ -×Ô¶¯×°ÅäÊÇ springboot µÄºËÐÄÖ®Ò»£¬±¾ÎĽ«À´Ì½¾¿ springboot ÊÇÈçºÎ¼ÓÔØ×Ô¶¯×°ÅäÀàµÄ¡£ +自动装é…�是 springboot 的核心之一,本文将æ�¥æŽ¢ç©¶ springboot 是如何加载自动装é…�类的。 -ÔÚ [@SpringBootApplication ×¢½â](https://my.oschina.net/funcy/blog/4870882)Ò»ÎÄÖУ¬ÎÒÃÇÌáµ½ springboot ´¦Àí×Ô¶¯×°ÅäµÄ×¢½âÊÇ `@EnableAutoConfiguration`£¬´úÂëÈçÏ£º +在 [@SpringBootApplication 注解](https://my.oschina.net/funcy/blog/4870882)一文中,我们æ��到 springboot 处ç�†è‡ªåŠ¨è£…é…�的注解是 `@EnableAutoConfiguration`,代ç �如下: ``` @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Inherited -// ×Ô¶¯×°ÅäµÄ°ü +// 自动装é…�的包 @AutoConfigurationPackage -// ÒýÈëµÄ×Ô¶¯×°ÅäÀà +// 引入的自动装é…�ç±» @Import(AutoConfigurationImportSelector.class) public @interface EnableAutoConfiguration { String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; /** - * ¿É×ÔÐж¨ÒåÅųý×Ô¶¯×°ÅäµÄÀà + * å�¯è‡ªè¡Œå®šä¹‰æŽ’除自动装é…�的类 */ Class[] exclude() default {}; /** - * ¿É×ÔÐж¨ÒåÅųý×Ô¶¯×°ÅäµÄÀàÃû + * å�¯è‡ªè¡Œå®šä¹‰æŽ’除自动装é…�的类å�� */ String[] excludeName() default {}; @@ -29,19 +29,19 @@ public @interface EnableAutoConfiguration { ``` -ÒÔÉÏ´úÂë°üº¬Èý¸ö²¿·Ö£º +以上代ç �包å�«ä¸‰ä¸ªéƒ¨åˆ†ï¼š -1. `@AutoConfigurationPackage`£ºÖ¸¶¨×Ô¶¯×°ÅäµÄ°ü£» -2. `@Import(AutoConfigurationImportSelector.class)`£ºÒýÈë×Ô¶¯×°ÅäµÄ´¦ÀíÀà `AutoConfigurationImportSelector`£¬Õâ¸öÀàÊÇ×Ô¶¯×°ÅäµÄ¹Ø¼üËùÔÚ£» -3. `@EnableAutoConfiguration` µÄÊôÐÔ£º`@EnableAutoConfiguration` ÌṩÁËÁ½¸öÊôÐÔ£º`exclude` Óë `excludeName`£¬¿ÉÒÔÓÃÀ´Åųý²»ÐèÒª×Ô¶¯×°ÅäµÄÀà¡£ +1. `@AutoConfigurationPackage`:指定自动装é…�的包; +2. `@Import(AutoConfigurationImportSelector.class)`:引入自动装é…�的处ç�†ç±» `AutoConfigurationImportSelector`,这个类是自动装é…�的关键所在; +3. `@EnableAutoConfiguration` 的属性:`@EnableAutoConfiguration` æ��供了两个属性:`exclude` 与 `excludeName`,å�¯ä»¥ç”¨æ�¥æŽ’除ä¸�需è¦�自动装é…�的类。 -±¾ÎÄÖØµãÀ´·ÖÎö `AutoConfigurationImportSelector` Àà¡£ +本文é‡�点æ�¥åˆ†æž� `AutoConfigurationImportSelector` 类。 ### 1. `AutoConfigurationImportSelector.AutoConfigurationGroup` -`AutoConfigurationImportSelector` ʵÏÖÁË `DeferredImportSelector`£¬¹ØÓÚ `DeferredImportSelector` µÄ·ÖÎö£¬¿ÉÒԲο¼ [ConfigurationClassPostProcessor Ö®´¦Àí @Import ×¢½â](https://my.oschina.net/funcy/blog/4678152)£¬ÕâÀïÎÒÃÇÖ±½Ó¸ø³ö½áÂÛ£º +`AutoConfigurationImportSelector` 实现了 `DeferredImportSelector`,关于 `DeferredImportSelector` 的分æž�,å�¯ä»¥å�‚考 [ConfigurationClassPostProcessor 之处ç�† @Import 注解](https://my.oschina.net/funcy/blog/4678152),这里我们直接给出结论: -* `DeferredImportSelector` ÊÇ `ImportSelector` µÄ×Ó½Ó¿Ú£¬ÆäÄÚ²¿ÓÐÒ»¸ö½Ó¿Ú `Group`£¬¸Ã½Ó¿Ú¶¨ÒåÁËÁ½¸ö·½·¨£º +* `DeferredImportSelector` 是 `ImportSelector` çš„å­�接å�£ï¼Œå…¶å†…部有一个接å�£ `Group`,该接å�£å®šä¹‰äº†ä¸¤ä¸ªæ–¹æ³•: ``` public interface DeferredImportSelector extends ImportSelector { @@ -50,12 +50,12 @@ public @interface EnableAutoConfiguration { interface Group { /** - * ´¦Àíµ¼Èë²Ù×÷ + * 处ç�†å¯¼å…¥æ“�作 */ void process(AnnotationMetadata metadata, DeferredImportSelector selector); /** - * ·µ»Øµ¼ÈëÀà + * 返回导入类 */ Iterable selectImports() } @@ -63,34 +63,34 @@ public @interface EnableAutoConfiguration { ``` - ÔÚ´¦Àí `DeferredImportSelector` µÄµ¼ÈëÀàʱ£¬`DeferredImportSelector.Group#process` ·½·¨»áÏȵ÷Óã¬È»ºóÔÙµ÷Óà `DeferredImportSelector.Group#selectImports` ·µ»Øµ¼ÈëÀࣻ + 在处ç�† `DeferredImportSelector` 的导入类时,`DeferredImportSelector.Group#process` 方法会先调用,然å�Žå†�调用 `DeferredImportSelector.Group#selectImports` 返回导入类; -* `DeferredImportSelector` ¿ÉÒÔÖ¸¶¨µ¼ÈëÀàµÄ·Ö×飬ÔÚ´¦Àíʱ£¬¿ÉÒÔ°´·Ö×é´¦Àíµ¼ÈëÀࣻ +* `DeferredImportSelector` å�¯ä»¥æŒ‡å®šå¯¼å…¥ç±»çš„分组,在处ç�†æ—¶ï¼Œå�¯ä»¥æŒ‰åˆ†ç»„处ç�†å¯¼å…¥ç±»ï¼› -* `DeferredImportSelector` ÔÚ´¦Àíµ¼ÈëÀàʱ£¬ÏȽ«µ¼ÈëÀà°´·Ö×é·ÅÈëÒ»¸ö `map` ÖУ¬ÔÚ´¦ÀíÍêÆäËûÅäÖÃÀࣨspring µÄÅäÖÃÀàΪ `@Component`¡¢`@ComponentScan`¡¢`@Import`¡¢`@Configuration`¡¢`@Bean` ±ê¼ÇµÄÀࣩºóÔÙÀ´´¦Àí·Ö×éÖеĵ¼ÈëÀ࣬Ҳ¾ÍÊÇ˵£¬`DeferredImportSelector` µ¼ÈëµÄÀ࣬»áÔÚÆäËûÀà×¢²áµ½ `beanFactory` Öкó£¬ÔÙ½øÐÐ×¢²á£¨×¢²áǰ»¹ÐèÅжÏÄÜ·ñ×¢²áµ½ `beanFactory`£¬ÈôÄܲÅ×¢²á£©¡£ +* `DeferredImportSelector` 在处ç�†å¯¼å…¥ç±»æ—¶ï¼Œå…ˆå°†å¯¼å…¥ç±»æŒ‰åˆ†ç»„放入一个 `map` 中,在处ç�†å®Œå…¶ä»–é…�置类(spring çš„é…�置类为 `@Component`ã€�`@ComponentScan`ã€�`@Import`ã€�`@Configuration`ã€�`@Bean` 标记的类)å�Žå†�æ�¥å¤„ç�†åˆ†ç»„中的导入类,也就是说,`DeferredImportSelector` 导入的类,会在其他类注册到 `beanFactory` 中å�Žï¼Œå†�进行注册(注册å‰�还需判断能å�¦æ³¨å†Œåˆ° `beanFactory`,若能æ‰�注册)。 -ÎÒÃÇÀ´¿´¿´ `AutoConfigurationImportSelector` µÄ´úÂ룺 +我们æ�¥çœ‹çœ‹ `AutoConfigurationImportSelector` 的代ç �: ``` -// ʵÏÖÁË DeferredImportSelector +// 实现了 DeferredImportSelector public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware,ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered { ... /** - * ÕâÀïʵÏÖÁË DeferredImportSelector.Group + * 这里实现了 DeferredImportSelector.Group */ private static class AutoConfigurationGroup implements DeferredImportSelector.Group, BeanClassLoaderAware, BeanFactoryAware, ResourceLoaderAware { /** - * ±£´æµ¼ÈëµÄÀà + * ä¿�存导入的类 */ private final List autoConfigurationEntries = new ArrayList<>(); /** - * ´¦Àíµ¼ÈëÀà + * 处ç�†å¯¼å…¥ç±» */ @Override public void process(AnnotationMetadata annotationMetadata, @@ -99,12 +99,12 @@ public class AutoConfigurationImportSelector implements DeferredImportSelector, () -> String.format("Only %s implementations are supported, got %s", AutoConfigurationImportSelector.class.getSimpleName(), deferredImportSelector.getClass().getName())); - // 1\. µ÷Óà AutoConfigurationImportSelector#getAutoConfigurationEntry(...) ·½·¨£¬ - // ÔÚÕâ¸ö·½·¨Àï»á¼ÓÔØ×Ô¶¯×°ÅäÀà + // 1\. 调用 AutoConfigurationImportSelector#getAutoConfigurationEntry(...) 方法, + // 在这个方法里会加载自动装é…�ç±» AutoConfigurationEntry autoConfigurationEntry = ((AutoConfigurationImportSelector) deferredImportSelector) .getAutoConfigurationEntry(getAutoConfigurationMetadata(), annotationMetadata); - // 2\. ½«»ñÈ¡µ½µÄ autoConfigurationEntry ±£´æÆðÀ´ + // 2\. 将获å�–到的 autoConfigurationEntry ä¿�存起æ�¥ this.autoConfigurationEntries.add(autoConfigurationEntry); for (String importClassName : autoConfigurationEntry.getConfigurations()) { this.entries.putIfAbsent(importClassName, annotationMetadata); @@ -112,24 +112,24 @@ public class AutoConfigurationImportSelector implements DeferredImportSelector, } /** - * ·µ»Øµ¼ÈëÀà + * 返回导入类 */ @Override public Iterable selectImports() { if (this.autoConfigurationEntries.isEmpty()) { return Collections.emptyList(); } - // 3\. µÃµ½¹ýÂËÀà + // 3\. 得到过滤类 Set allExclusions = this.autoConfigurationEntries.stream() .map(AutoConfigurationEntry::getExclusions).flatMap(Collection::stream) .collect(Collectors.toSet()); - // 4\. ½« autoConfigurationEntries ת»»Îª LinkedHashSet + // 4\. å°† autoConfigurationEntries 转æ�¢ä¸º LinkedHashSet Set processedConfigurations = this.autoConfigurationEntries.stream() .map(AutoConfigurationEntry::getConfigurations).flatMap(Collection::stream) .collect(Collectors.toCollection(LinkedHashSet::new)); - // 5\. È¥³ýÐèÒª¹ýÂ˵ÄÀà + // 5\. 去除需è¦�过滤的类 processedConfigurations.removeAll(allExclusions); - // 6\. ½øÐÐÅÅÐò + // 6\. 进行排åº� return sortAutoConfigurations(processedConfigurations, getAutoConfigurationMetadata()) .stream().map((importClassName) -> new Entry( this.entries.get(importClassName), importClassName)) @@ -143,28 +143,28 @@ public class AutoConfigurationImportSelector implements DeferredImportSelector, ``` -ÕâÀïÎÒÃǽ« `DeferredImportSelector.Group#process` Óë `DeferredImportSelector.Group#selectImports` Á½¸ö·½·¨½áºÏÆðÀ´¿´£¬´¦Àí²½Öè×ܽáÈçÏÂ: +这里我们将 `DeferredImportSelector.Group#process` 与 `DeferredImportSelector.Group#selectImports` 两个方法结å�ˆèµ·æ�¥çœ‹ï¼Œå¤„ç�†æ­¥éª¤æ€»ç»“如下: -1. µ÷Óà `AutoConfigurationImportSelector#getAutoConfigurationEntry(...)` ·½·¨¼ÓÔØ×Ô¶¯×°ÅäÀࣻ -2. ½«µÃµ½µÄ×Ô¶¯×°ÅäÀà±£´æµ½ `autoConfigurationEntries` ÖУ» -3. µÃµ½¹ýÂËÀ࣬ÕâЩ¹ýÂËÀà¾ÍÊÇÓÉ `@EnableAutoConfiguration` µÄ `exclude` »ò `excludeName` Ö¸¶¨µÄ£» -4. ½« `autoConfigurationEntries` ת»»Îª `LinkedHashSet`£¬½á¹ûΪ `processedConfigurations`£» -5. È¥³ý `processedConfigurations` ÐèÒª¹ýÂ˵ÄÀࣻ -6. ½«µÚ 5 ²½µÃµ½µÄÀàÅÅÐòºó£¬·µ»Ø¡£ +1. 调用 `AutoConfigurationImportSelector#getAutoConfigurationEntry(...)` 方法加载自动装é…�类; +2. 将得到的自动装é…�ç±»ä¿�存到 `autoConfigurationEntries` 中; +3. 得到过滤类,这些过滤类就是由 `@EnableAutoConfiguration` çš„ `exclude` 或 `excludeName` 指定的; +4. å°† `autoConfigurationEntries` 转æ�¢ä¸º `LinkedHashSet`,结果为 `processedConfigurations`ï¼› +5. 去除 `processedConfigurations` 需è¦�过滤的类; +6. 将第 5 步得到的类排åº�å�Žï¼Œè¿”回。 -½ÓÏÂÀ´ÎÒÃǶÔÕâЩ¹Ø¼ü²½Öè½øÐзÖÎö¡£ +接下æ�¥æˆ‘们对这些关键步骤进行分æž�。 -> ÌØ±ð˵Ã÷£º`DeferredImportSelector` ÊÇ `ImportSelector` µÄ×Ó½Ó¿Ú£¬`ImportSelector` ´¦Àíµ¼ÈëÀàµÄ·½·¨ÊÇ `selectImports(...)`£¬ÔÚ `DeferredImportSelector` ÖÐÒ²ÖØÐ´Á˸÷½·¨£º +> 特别说明:`DeferredImportSelector` 是 `ImportSelector` çš„å­�接å�£ï¼Œ`ImportSelector` 处ç�†å¯¼å…¥ç±»çš„æ–¹æ³•是 `selectImports(...)`,在 `DeferredImportSelector` 中也é‡�写了该方法: > > ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-75a2839c622af2d0f374189b2e2765a64d7.png) > -> Õâ¸ö·½·¨Ëù×öµÄÒ²ÊǼÓÔØ×Ô¶¯×°ÅäÀ࣬·µ»Ø×îÖÕµ¼ÈëµÄÀ࣬µ«ÐèҪעÒâµÄÊÇ£¬springboot µÄ×Ô¶¯µ¼ÈëÀà**²»ÊÇ**ÔÚÕâÀï´¦ÀíµÄ£¬¹ØÓÚÕâµã£¬¿ÉÒÔÔÚ·½·¨ÄÚ´ò¸ö¶Ïµã£¬È»ºó¾Í»á·¢ÏÖÕâ¸ö·½·¨²¢Ã»ÓÐÔËÐе½£¡ +> 这个方法所å�šçš„也是加载自动装é…�类,返回最终导入的类,但需è¦�注æ„�的是,springboot 的自动导入类**ä¸�是**在这里处ç�†çš„,关于这点,å�¯ä»¥åœ¨æ–¹æ³•内打个断点,然å�Žå°±ä¼šå�‘现这个方法并没有è¿�行到ï¼� > -> ×îºóÔÙÉùÃ÷Ï£ºspringboot µÄ×Ô¶¯µ¼ÈëÀà**²»ÊÇ**ÔÚ `AutoConfigurationImportSelector#selectImports` ·½·¨Öд¦ÀíµÄ£¬¶øÊÇÔÚ `AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports` ·½·¨Öд¦ÀíµÄ¡£ +> 最å�Žå†�声明下:springboot 的自动导入类**ä¸�是**在 `AutoConfigurationImportSelector#selectImports` 方法中处ç�†çš„,而是在 `AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports` 方法中处ç�†çš„。 -### 2\. »ñȡװÅäÀࣺ`AutoConfigurationImportSelector#getAutoConfigurationEntry` +### 2\. 获å�–装é…�类:`AutoConfigurationImportSelector#getAutoConfigurationEntry` -×Ô¶¯ÅäÖà ÀàµÄ¼ÓÔØ´úÂëΪ£º +自动é…�ç½® 类的加载代ç �为: ``` AutoConfigurationEntry autoConfigurationEntry = @@ -173,77 +173,77 @@ AutoConfigurationEntry autoConfigurationEntry = ``` -¸Ã´úÂë¾ÍÊÇÓÃÀ´¼ÓÔØ×Ô¶¯×°ÅäÀàµÄ£¬ÎÒÃÇÖ±½Ó½øÈë `AutoConfigurationImportSelector#getAutoConfigurationEntry` ·½·¨£º +该代ç �就是用æ�¥åŠ è½½è‡ªåŠ¨è£…é…�类的,我们直接进入 `AutoConfigurationImportSelector#getAutoConfigurationEntry` 方法: ``` protected AutoConfigurationEntry getAutoConfigurationEntry( AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) { - // ÓÖÒ»´ÎÅжÏÊÇ·ñ¿ªÆô×Ô¶¯×°Åä + // å�ˆä¸€æ¬¡åˆ¤æ–­æ˜¯å�¦å¼€å�¯è‡ªåŠ¨è£…é…� if (!isEnabled(annotationMetadata)) { return EMPTY_ENTRY; } - // »ñȡע½âµÄÊôÐÔ + // 获å�–注解的属性 AnnotationAttributes attributes = getAttributes(annotationMetadata); - // 1\. ¼ÓÔØºòÑ¡µÄ×Ô¶¯ÅäÖÃÀà + // 1\. 加载候选的自动é…�置类 List configurations = getCandidateConfigurations(annotationMetadata, attributes); - // 2\. È¥ÖØ£¬×ª»»³Éset£¬ÔÙת»»³Élist + // 2\. 去é‡�,转æ�¢æˆ�set,å†�转æ�¢æˆ�list configurations = removeDuplicates(configurations); - // 3\. È¥³ýÐèÒªÅųýµÄÀ࣬Æäʵ¾ÍÊÇ´¦Àí@EnableAutoConfigurationµÄexcludeÓëexcludeName + // 3\. 去除需è¦�排除的类,其实就是处ç�†@EnableAutoConfigurationçš„exclude与excludeName Set exclusions = getExclusions(annotationMetadata, attributes); checkExcludedClasses(configurations, exclusions); configurations.removeAll(exclusions); - // 4\. ¹ýÂ˲»ÐèÒª×Ô¶¯×°ÅäµÄÀà + // 4\. 过滤ä¸�需è¦�自动装é…�的类 configurations = filter(configurations, autoConfigurationMetadata); - // 5\. ´¥·¢ AutoConfigurationImportEvent ʼþ + // 5\. 触å�‘ AutoConfigurationImportEvent 事件 fireAutoConfigurationImportEvents(configurations, exclusions); - // 6\. ×îÖÕ·µ»ØµÄÖµ + // 6\. 最终返回的值 return new AutoConfigurationEntry(configurations, exclusions); } ``` -Õâ¸ö·½·¨·Ç³£ÖØÒª£¬°üº¬ÁË»ñÈ¡×Ô¶¯×°ÅäÀàµÄÈ«²¿²Ù×÷£¬¸Ã²Ù×÷Á÷³ÌÈçÏ£º +这个方法é�žå¸¸é‡�è¦�,包å�«äº†èŽ·å�–自动装é…�类的全部æ“�作,该æ“�作æµ�程如下: -1. ¼ÓÔØºòÑ¡µÄ×Ô¶¯×°ÅäÀ࣬springboot ×Ô¶¯×°ÅäµÄÀàλÓÚ `classpath` Ï嵀 `META-INF/spring.factories` ÎļþÖУ¬key Ϊ `org.springframework.boot.autoconfigure.EnableAutoConfiguration`£¬Õâ¸öÎÒÃǺóÃæÔÙÏêϸ·ÖÎö£» +1. 加载候选的自动装é…�类,springboot 自动装é…�的类ä½�于 `classpath` 下的 `META-INF/spring.factories` 文件中,key 为 `org.springframework.boot.autoconfigure.EnableAutoConfiguration`,这个我们å�Žé�¢å†�详细分æž�ï¼› -2. È¥³ýÖØ¸´µÄ×Ô¶¯×°ÅäÀ࣬ÉÏÒ»²½¼ÓÔØµÃµ½µÄ×Ô¶¯×°ÅäÀà¿ÉÄÜ»áÓÐÖØ¸´£¬ÔÚÕâÀï»áÈ¥³ýÖØ¸´µÄÀ࣬ȥ³ý·½Ê½Ò²·Ç³£¼òµ¥£¬springboot ¾ÍÖ»ÊÇÏÈת»»³É `Set`£¬ÔÙת»»³É `List`£» +2. 去除é‡�å¤�的自动装é…�类,上一步加载得到的自动装é…�ç±»å�¯èƒ½ä¼šæœ‰é‡�å¤�,在这里会去除é‡�å¤�的类,去除方å¼�也é�žå¸¸ç®€å�•,springboot å°±å�ªæ˜¯å…ˆè½¬æ�¢æˆ� `Set`,å†�转æ�¢æˆ� `List`ï¼› -3. È¥³ýÅųýµÄÀà£¬Ç°ÃæÌáµ½ `@EnableAutoConfiguration` ¿ÉÒÔͨ¹ý `exclude` Óë `excludeName` Ö¸¶¨ÐèÒªÅųýµÄÀ࣬ÕâÒ»²½¾ÍÊÇÀ´´¦ÀíÕâÁ½¸öÊôÐԵģ» +3. 去除排除的类,å‰�é�¢æ��到 `@EnableAutoConfiguration` å�¯ä»¥é€šè¿‡ `exclude` 与 `excludeName` 指定需è¦�排除的类,这一步就是æ�¥å¤„ç�†è¿™ä¸¤ä¸ªå±žæ€§çš„ï¼› -4. ¹ýÂ˲»ÐèÒª×Ô¶¯×°ÅäµÄÀ࣬¸ù¾Ý±¾È˵÷ÊÔ£¬·¢ÏÖ²¢Ã»ÓÐÍê³É¹ýÂË£º +4. 过滤ä¸�需è¦�自动装é…�的类,根æ�®æœ¬äººè°ƒè¯•,å�‘现并没有完æˆ�过滤: - ¹ýÂËǰÊÇ 124 ¸ö£º + 过滤å‰�是 124 个: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-773695c0161c8126f239c2e66529fc8a394.png) - ¹ýÂ˺ó»¹ÊÇ 124 ¸ö£º + 过滤å�Žè¿˜æ˜¯ 124 个: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-7144d971f729b5dfbddfeff2d3319c7705c.png) -5. ´¥·¢ `AutoConfigurationImportEvent` ʼþ£» +5. 触å�‘ `AutoConfigurationImportEvent` 事件; -6. ½«µÚ 3 ²½µÃµ½µÄÅųýÀàÓëµÚ 4 ²½µÃµ½µÄ×Ô¶¯×°ÅäÀà°ü×°³É `AutoConfigurationEntry` ·µ»Ø¡£ +6. 将第 3 步得到的排除类与第 4 步得到的自动装é…�类包装æˆ� `AutoConfigurationEntry` 返回。 -×¢Òâ×îºóÒ»ÐдúÂ룺 +注æ„�最å�Žä¸€è¡Œä»£ç �: ``` -// 6\. ×îÖÕ·µ»ØµÄÖµ +// 6\. 最终返回的值 return new AutoConfigurationEntry(configurations, exclusions); ``` -ÕâÀï°Ñ `configurations` Óë `exclusions` ¶¼´«ÈëÁË `AutoConfigurationEntry` µÄ¹¹Ôì·½·¨£¬ÎÒÃÇÀ´¿´¿´ `AutoConfigurationEntry`£º +这里把 `configurations` 与 `exclusions` 都传入了 `AutoConfigurationEntry` 的构造方法,我们æ�¥çœ‹çœ‹ `AutoConfigurationEntry`: ``` protected static class AutoConfigurationEntry { - // ×Ô¶¯×°ÅäÀà + // 自动装é…�ç±» private final List configurations; - // ÐèÒªÅųýµÄ×Ô¶¯×°ÅäÀà + // 需è¦�排除的自动装é…�ç±» private final Set exclusions; /** - * ¹¹Ôì·½·¨£¬¶ÔÔÙÕß½øÐи³Öµ + * 构造方法,对å†�者进行赋值 */ AutoConfigurationEntry(Collection configurations, Collection exclusions) { this.configurations = new ArrayList<>(configurations); @@ -255,22 +255,22 @@ protected static class AutoConfigurationEntry { ``` -ÓÉЩ¿É¼û£¬×îÖÕ·µ»ØµÄ `AutoConfigurationEntry` °üº¬Á½´óÄÚÈÝ£º +由些å�¯è§�,最终返回的 `AutoConfigurationEntry` 包å�«ä¸¤å¤§å†…容: -* `configurations`£º×Ô¶¯×°ÅäÀ࣬ÒѾ­È¥³ýÁËÐèÒªÅųýµÄÀà -* `exclusions`£ºÍ¨¹ý `@EnableAutoConfiguration` Ö¸¶¨µÄÐèÒªÅųýµÄÀà +* `configurations`:自动装é…�类,已ç»�去除了需è¦�排除的类 +* `exclusions`:通过 `@EnableAutoConfiguration` 指定的需è¦�排除的类 -Õû¸ö×Ô¶¯×°ÅäÀàµÄ»ñÈ¡¾ÍÊÇÕâÑùÁË£¬ÏÂÃæÎÒÃÇÀ´¿´¿´¼ÓÔØºòÑ¡µÄ×Ô¶¯×°ÅäÀàµÄÁ÷³Ì¡£ +整个自动装é…�类的获å�–就是这样了,下é�¢æˆ‘们æ�¥çœ‹çœ‹åŠ è½½å€™é€‰çš„è‡ªåŠ¨è£…é…�类的æµ�程。 -### 3\. ¼ÓÔØºòÑ¡µÄ×Ô¶¯×°ÅäÀà +### 3\. 加载候选的自动装é…�ç±» -×Ô¶¯×°ÅäÀàµÄ¼ÓÔØÎ»ÓÚ `AutoConfigurationImportSelector#getCandidateConfigurations`£¬´úÂëÈçÏ£º +自动装é…�类的加载ä½�于 `AutoConfigurationImportSelector#getCandidateConfigurations`,代ç �如下: ``` protected List getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) { - // µ÷ÓõÄÊÇ spring ÌṩµÄ·½·¨£ºSpringFactoriesLoader.loadFactoryNames(...) - // getSpringFactoriesLoaderFactoryClass() ·µ»ØµÄÊÇEnableAutoConfiguration + // 调用的是 spring æ��供的方法:SpringFactoriesLoader.loadFactoryNames(...) + // getSpringFactoriesLoaderFactoryClass() 返回的是EnableAutoConfiguration List configurations = SpringFactoriesLoader .loadFactoryNames(getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader()); Assert.notEmpty(configurations, "..."); @@ -283,7 +283,7 @@ protected Class getSpringFactoriesLoaderFactoryClass() { ``` -¼ÌÐø½øÈë `SpringFactoriesLoader#loadFactoryNames`£º +继续进入 `SpringFactoriesLoader#loadFactoryNames`: ``` public final class SpringFactoriesLoader { @@ -291,13 +291,13 @@ public final class SpringFactoriesLoader { public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories"; public static List loadFactoryNames(Class factoryType, @Nullable ClassLoader classLoader) { - // µÃµ½µÄ factoryTypeName ÊÇ org.springframework.boot.autoconfigure.EnableAutoConfiguration + // 得到的 factoryTypeName 是 org.springframework.boot.autoconfigure.EnableAutoConfiguration String factoryTypeName = factoryType.getName(); return loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList()); } /** - * ÔÚÕâÀï½øÐмÓÔØ£¬¼ÓÔØµÄÊÇ META-INF/spring.factories ÖеÄÊôÐÔ + * 在这里进行加载,加载的是 META-INF/spring.factories 中的属性 */ private static Map> loadSpringFactories(@Nullable ClassLoader classLoader) { MultiValueMap result = cache.get(classLoader); @@ -306,7 +306,7 @@ public final class SpringFactoriesLoader { } try { - // ¼ÓÔØ META-INF/spring.factories µÄÄÚÈÝ + // 加载 META-INF/spring.factories 的内容 Enumeration urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION)); @@ -314,11 +314,11 @@ public final class SpringFactoriesLoader { while (urls.hasMoreElements()) { URL url = urls.nextElement(); UrlResource resource = new UrlResource(url); - // ½« META-INF/spring.factories µÄÄÚÈÝת»»Îª Properties ¶ÔÏó + // å°† META-INF/spring.factories 的内容转æ�¢ä¸º Properties 对象 Properties properties = PropertiesLoaderUtils.loadProperties(resource); for (Map.Entry entry : properties.entrySet()) { String factoryTypeName = ((String) entry.getKey()).trim(); - // StringUtils.commaDelimitedListToStringArray(...) ¶ººÅ·Ö¸îΪÊý×é + // StringUtils.commaDelimitedListToStringArray(...) 逗å�·åˆ†å‰²ä¸ºæ•°ç»„ for (String factoryImplementationName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) { result.add(factoryTypeName, factoryImplementationName.trim()); @@ -338,52 +338,52 @@ public final class SpringFactoriesLoader { ``` -¿ÉÒÔ¿´µ½£¬ÕâÀï¼ÓÔØµÄÊÇ `classpath` Ï嵀 `META-INF/spring.factories` Îļþ£¬×¢Ò⣺Õâ¸öÎļþ¿ÉÄÜ»áÓжà¸ö£¬Î»ÓÚ²»Í¬µÄ jar °üÖС£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡ŒåŠ è½½çš„æ˜¯ `classpath` 下的 `META-INF/spring.factories` 文件,注æ„�:这个文件å�¯èƒ½ä¼šæœ‰å¤šä¸ªï¼Œä½�于ä¸�å�Œçš„ jar 包中。 -springboot ×Ô´øµÄ `META-INF/spring.factories` λÓÚ `spring-boot-autoconfigure` Ä£¿éÏ£º +springboot 自带的 `META-INF/spring.factories` ä½�于 `spring-boot-autoconfigure` 模å�—下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ace5e83645626966eae1e62a50752f2417d.png) -ÎÒÃÇÀ´¿´Ò»ÑÛ `spring.factories`£º +我们æ�¥çœ‹ä¸€çœ¼ `spring.factories`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d7de9ecd19345f0dc77cc304843c588fe4d.png) -Õâ¸öÎļþ¶¨ÒåÁËÐí¶àµÄÅäÖÃÀ࣬ÒÔ `key-value` µÄÐÎʽ±£´æ£¬¶à¸öÖµÖ®¼äʹÓà ¡°,¡± ·Ö¿ª£¬ÉÏÃæÌáµ½µÄ×Ô¶¯×°ÅäÀàµÄ key ÊÇ `org.springframework.boot.autoconfigure.EnableAutoConfiguration`£¬¶ÔÓ¦µÄ `value` ·Ç³£¶à£¬ÕâÀï¾Í²»Õ¹Ê¾ÁË¡£ +这个文件定义了许多的é…�置类,以 `key-value` 的形å¼�ä¿�存,多个值之间使用 “,â€� 分开,上é�¢æ��到的自动装é…�类的 key 是 `org.springframework.boot.autoconfigure.EnableAutoConfiguration`,对应的 `value` é�žå¸¸å¤šï¼Œè¿™é‡Œå°±ä¸�展示了。 -ÕâÒ»²½Ö®ºó£¬×Ô¶¯×°ÅäÀà¾Í±»×¢²áµ½ spring ÈÝÆ÷ÖÐÁË¡£×¢£º´Ëʱ¼ÓÔØµ½ spring ÈÝÆ÷ÖеϹÊÇ `BeanDefinition`£¬ÒªÏë³ÉΪ spring bean£¬»¹µÃ¾­¹ý `ConditionalOnBean`¡¢`ConditionalOnClass` µÈ×¢½âµÄ¿¼Ñ飬ÕâЩÎÒÃǺóÃæÔÙ·ÖÎö¡£ +这一步之å�Žï¼Œè‡ªåŠ¨è£…é…�类就被注册到 spring 容器中了。注:此时加载到 spring 容器中的还是 `BeanDefinition`,è¦�想æˆ�为 spring bean,还得ç»�过 `ConditionalOnBean`ã€�`ConditionalOnClass` 等注解的考验,这些我们å�Žé�¢å†�分æž�。 -### 4\. »ñÈ¡×Ô¶¯×°ÅäÀàºóµÄ´¦Àí +### 4\. 获å�–自动装é…�ç±»å�Žçš„处ç�† -ÈÃÎÒÃÇÔٻص½ `AutoConfigurationImportSelector.AutoConfigurationGroup`£¬ÔÚµÚ 1 ½ÚÎÒÃÇ×ܽáµÄÁ÷³ÌÈçÏ£º +让我们å†�回到 `AutoConfigurationImportSelector.AutoConfigurationGroup`,在第 1 节我们总结的æµ�程如下: -1. µ÷Óà `AutoConfigurationImportSelector#getAutoConfigurationEntry(...)` ·½·¨¼ÓÔØ×Ô¶¯×°ÅäÀࣻ -2. ½«µÃµ½µÄ×Ô¶¯×°ÅäÀà±£´æµ½ `autoConfigurationEntries` ÖУ» -3. µÃµ½¹ýÂËÀ࣬ÕâЩ¹ýÂËÀà¾ÍÊÇÓÉ `@EnableAutoConfiguration` µÄ `exclude` »ò `excludeName` Ö¸¶¨µÄ£» -4. ½« `autoConfigurationEntries` ת»»Îª `LinkedHashSet`£¬½á¹ûΪ `processedConfigurations`£» -5. È¥³ý `processedConfigurations` ÐèÒª¹ýÂ˵ÄÀࣻ -6. ½«µÚ 5 ²½µÃµ½µÄÀàÅÅÐòºó£¬·µ»Ø¡£ +1. 调用 `AutoConfigurationImportSelector#getAutoConfigurationEntry(...)` 方法加载自动装é…�类; +2. 将得到的自动装é…�ç±»ä¿�存到 `autoConfigurationEntries` 中; +3. 得到过滤类,这些过滤类就是由 `@EnableAutoConfiguration` çš„ `exclude` 或 `excludeName` 指定的; +4. å°† `autoConfigurationEntries` 转æ�¢ä¸º `LinkedHashSet`,结果为 `processedConfigurations`ï¼› +5. 去除 `processedConfigurations` 需è¦�过滤的类; +6. 将第 5 步得到的类排åº�å�Žï¼Œè¿”回。 -ÒÔÉÏµÚ 2 ½ÚÓëµÚ 3 ½Ú£¬·ÖÎöµÄÊÇ×Ô¶¯¼ÓÔØÀàµÄ¼ÓÔØ¹ý³Ì£¬ÎÒÃÇÔÙÀ´¿´¿´½ÓÏÂÀ´µÄ²½Öè¡£ +以上第 2 节与第 3 节,分æž�的是自动加载类的加载过程,我们å†�æ�¥çœ‹çœ‹æŽ¥ä¸‹æ�¥çš„æ­¥éª¤ã€‚ -¶ÔÕÕ×Å´úÂ룬ÎÒÃǻᷢÏÖ½ÓÏÂÀ´µÄ²½Öè¶¼±È½Ï¼òµ¥£¬ÕâÀïÒ²Öðһ˵Ã÷ϰɡ£ +对照ç�€ä»£ç �,我们会å�‘现接下æ�¥çš„æ­¥éª¤éƒ½æ¯”较简å�•,这里也é€�一说明下å�§ã€‚ -* µÚ 2 ²½£¬±£´æµÃµ½µÄ×Ô¶¯×°ÅäÀ࣬Õâ¸ö²Ù×÷½ö½öÖ»Êǵ÷ÓÃÁË `List#add(...)` ·½·¨£¬½«µÃµ½µÄ `autoConfigurationEntry` ±£´æµ½ `autoConfigurationEntries`£¬Õâ¸ö½á¹¹ÊÇ `AutoConfigurationGroup` µÄ³ÉÔ±±äÁ¿£¬ÔÚ `AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports` ·½·¨ÖлáÓõ½£» +* 第 2 步,ä¿�存得到的自动装é…�类,这个æ“�作仅仅å�ªæ˜¯è°ƒç”¨äº† `List#add(...)` 方法,将得到的 `autoConfigurationEntry` ä¿�存到 `autoConfigurationEntries`,这个结构是 `AutoConfigurationGroup` çš„æˆ�员å�˜é‡�,在 `AutoConfigurationImportSelector.AutoConfigurationGroup#selectImports` 方法中会用到; -* µÚ 3 ²½£¬µÃµ½µÄÊÇËùÓеĹýÂËÀ࣬¸Ã¹ýÂËÀàÊDZéÀú `autoConfigurationEntries`£¬È»ºóͨ¹ý `autoConfigurationEntry#getExclusions` ·½·¨µÃµ½µÄ £¬Ç°ÃæÎÒÃÇÒ²Ìáµ½¹ý£¬`autoConfigurationEntry` Ö»°üº¬Á½¸ö³ÉÔ±±äÁ¿£º`configurations`(È¥³ýÅųýÀàºóµÄ×Ô¶¯×°ÅäÀà) Óë `exclusions`(ͨ¹ý `@EnableAutoConfiguration` Ö¸¶¨µÄÅųýÀà)£» +* 第 3 步,得到的是所有的过滤类,该过滤类是é��历 `autoConfigurationEntries`,然å�Žé€šè¿‡ `autoConfigurationEntry#getExclusions` 方法得到的 ,å‰�é�¢æˆ‘们也æ��到过,`autoConfigurationEntry` å�ªåŒ…å�«ä¸¤ä¸ªæˆ�员å�˜é‡�:`configurations`(去除排除类å�Žçš„自动装é…�ç±») 与 `exclusions`(通过 `@EnableAutoConfiguration` 指定的排除类)ï¼› -* µÚ 4 ²½£¬½« `List` ת»»Îª `LinkedHashSet`£¬²»·ÖÎö£» +* 第 4 步,将 `List` 转æ�¢ä¸º `LinkedHashSet`,ä¸�分æž�ï¼› -* µÚ 5 ²½£¬¶ÔËùÓеÄ×Ô¶¯×°ÅäÀàÔÙ½øÐÐÒ»´ÎÈ¥³ýÅųýÀàµÄ²Ù×÷£¬ÅųýµÄ¶ÔÏóÊÇËùÓеÄÅųýÀ࣬ÕâÖÖÇé¿öÓ¦¸ÃÊÇ»á¶ÔͬһÏîÄ¿ÖÐÓжà¸ö `@EnableAutoConfiguration` µÄÇé¿ö£¬±ÈÈçµÚÒ»¸ö `@EnableAutoConfiguration` ×¢½âÅųý `A`¡¢`B` Á½¸öÀ࣬µÚ¶þ¸ö `@EnableAutoConfiguration` ×¢½âÅųý `C`£¬`D` Á½¸öÀ࣬ÄÇ×îÖÕÅųýµÄÊÇ `A`¡¢`B`¡¢`C`£¬`D` ËĸöÀࣻ +* 第 5 步,对所有的自动装é…�ç±»å†�进行一次去除排除类的æ“�作,排除的对象是所有的排除类,这ç§�情况应该是会对å�Œä¸€é¡¹ç›®ä¸­æœ‰å¤šä¸ª `@EnableAutoConfiguration` 的情况,比如第一个 `@EnableAutoConfiguration` 注解排除 `A`ã€�`B` 两个类,第二个 `@EnableAutoConfiguration` 注解排除 `C`,`D` 两个类,那最终排除的是 `A`ã€�`B`ã€�`C`,`D` 四个类; -* µÚ 6 ²½£¬ÕâÒ»²½µÄÖ÷Òª²Ù×÷ÊÇÅÅÐò£¬Õâ¸ö˳Ðò¾ö¶¨ÁË×Ô¶¯×°ÅäÀà×¢²áµ½ `beanFactory` ÖеÄ˳Ðò£¬`AutoConfigureOrder`¡¢`@AutoConfigureAfter` Óë `@AutoConfigureBefore` ¾ÍÊÇÔÚÕâÀï´¦ÀíµÄ£¬¹ØÓÚÕâ¿éÄÚÈÝ£¬¿ÉÒԲο¼ [springboot ×Ô¶¯×°ÅäÖ®×Ô¶¯×°Åä˳Ðò](https://my.oschina.net/funcy/blog/4921594). +* 第 6 步,这一步的主è¦�æ“�作是排åº�,这个顺åº�决定了自动装é…�类注册到 `beanFactory` 中的顺åº�,`AutoConfigureOrder`ã€�`@AutoConfigureAfter` 与 `@AutoConfigureBefore` 就是在这里处ç�†çš„,关于这å�—内容,å�¯ä»¥å�‚考 [springboot 自动装é…�之自动装é…�顺åº�](https://my.oschina.net/funcy/blog/4921594). -¾­¹ýÕâЩ²½Öèºó£¬×Ô¶¯×°ÅäµÄ»ñÈ¡¾ÍÍê³ÉÁË¡£ +ç»�过这些步骤å�Žï¼Œè‡ªåŠ¨è£…é…�的获å�–就完æˆ�了。 -### 5\. ×Ô¶¨Òå×Ô¶¯×°ÅäÀà +### 5\. 自定义自动装é…�ç±» -Á˽âÍê×Ô¶¯×°ÅäÀàµÄ¼ÓÔØ¹ý³Ìºó£¬ÎÒÃÇÒ²¿ÉÒÔ×Ô¶¨ÒåÒ»¸ö×Ô¶¯×°ÅäÀà¡£ +了解完自动装é…�类的加载过程å�Žï¼Œæˆ‘们也å�¯ä»¥è‡ªå®šä¹‰ä¸€ä¸ªè‡ªåŠ¨è£…é…�类。 -1. ×¼±¸Ò»¸ö×Ô¶¯×°ÅäÀà +1. 准备一个自动装é…�ç±» ``` @Configuration @@ -398,9 +398,9 @@ public class MyAutoConfiguration { ``` -Õâ¸öÀàºÜ¼òµ¥£¬¾ÍÊÇÒ»¸ö±ê¼ÇÁË `@Configuration` µÄÀ࣬ÀàÖÐʹÓà `@Bean` ×¢½â´´½¨ÁËÒ»¸ö bean£¬ÔÚ´´½¨ bean µÄ¹ý³ÌÖÐ»á ´òÓ¡ "create object"¡£ +这个类很简å�•,就是一个标记了 `@Configuration` 的类,类中使用 `@Bean` 注解创建了一个 bean,在创建 bean 的过程中会 打å�° "create object"。 -1. ×¼±¸ `META-INF/spring.factories` ÄÚÈÝÈçÏ£º +1. 准备 `META-INF/spring.factories` 内容如下: ``` # Auto Configure @@ -409,7 +409,7 @@ org.springframework.boot.learn.autoconfigure.demo01.configure.MyAutoConfiguratio ``` -1. Ö÷Àà +1. 主类 ``` @SpringBootApplication @@ -423,34 +423,34 @@ public class AutoconfigureDemo01Application { ``` -ÔËÐнá¹ûÈçÏ£º +è¿�行结果如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-9337a7ac4ce4ff7d71e69bc952bfac30b12.png) -¿ÉÒÔ¿´µ½£¬`create object` ³É¹¦´òÓ¡ÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`create object` æˆ�功打å�°äº†ã€‚ -ÄÇÕâ¸ö `bean` ÊÇͨ¹ý°üɨÃè´´½¨µÄ£¬»¹ÊÇ×Ô¶¯×°Åäµ¼ÈëµÄÄØ£¿ÎÒÃÇͨ¹ýµ÷ÊԵķ½Ê½À´¿´ÏÂ×Ô¶¯×°ÅäµÃµ½µÄÀࣺ +那这个 `bean` 是通过包扫æ��创建的,还是自动装é…�导入的呢?我们通过调试的方å¼�æ�¥çœ‹ä¸‹è‡ªåŠ¨è£…é…�得到的类: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-27bea49ddeae2f0f720ea338914cc443aec.png) -¿ÉÒÔ¿´µ½£¬`MyAutoConfiguration` ¾ÍÔÚ×Ô¶¯×°ÅäÀàµÄÁбíÖÐÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`MyAutoConfiguration` 就在自动装é…�类的列表中了。 -×¢Òâµ½£¬`MyAutoConfiguration` ¼ÓÁË `@Configuration` ×¢½â£¬ ÄÇôËü¾¿¾¹ÊÇÓÉ sping ÈÝÆ÷ɨÃèµ½µÄ£¬»¹ÊÇÓÉ×Ô¶¯×°ÅäµÃµ½µÄÄØ£¿ +注æ„�到,`MyAutoConfiguration` 加了 `@Configuration` 注解, 那么它究竟是由 sping 容器扫æ��到的,还是由自动装é…�得到的呢? -ÔÚ[¡¾springboot Ô´Âë·ÖÎö¡¿@SpringBootApplication ×¢½â](https://my.oschina.net/funcy/blog/4870882)Ò»ÎÄÖУ¬ÎÒÃÇÌáµ½ `SpringBootApplication` ×¢½âÖÐµÄ `@ComponentScan` »áÖ¸¶¨Ò»¸ö¹ýÂËÆ÷£º`AutoConfigurationExcludeFilter`£¬Õâ¸ö¹ýÂËÆ÷»á¹ýÂË×Ô¶¯×°ÅäÀ࣬ÕâÀïÎÒÃÇ¿´ÏÂĿǰΪֹ `beanFactory` ¶¼ÓÐÄÄЩ `beanName`£º +在[ã€�springboot æº�ç �分æž�】@SpringBootApplication 注解](https://my.oschina.net/funcy/blog/4870882)一文中,我们æ��到 `SpringBootApplication` 注解中的 `@ComponentScan` 会指定一个过滤器:`AutoConfigurationExcludeFilter`,这个过滤器会过滤自动装é…�类,这里我们看下目å‰�为止 `beanFactory` 都有哪些 `beanName`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1725008451f5516ab540bcc3ae13d1f37ee.png) -¿ÉÒÔ¿´µ½£¬²¢Ã»ÓÐ `MyAutoConfiguration`£¬Òò´Ë´ËʱËü»¹Ã»±»É¨Ãè½ø `beanFactory` ÖС£ +å�¯ä»¥çœ‹åˆ°ï¼Œå¹¶æ²¡æœ‰ `MyAutoConfiguration`,因此此时它还没被扫æ��è¿› `beanFactory` 中。 -µ±È»£¬ÎÒÃÇÒ²¿ÉÒÔ°Ñ `MyAutoConfiguration` ÉÏÃæµÄ `@Configuration` ×¢½âÈ¥µô£¬ÕâÑù¾Í²»»áÓÐÕâ¸öÀ§»óÁË¡£ +当然,我们也å�¯ä»¥æŠŠ `MyAutoConfiguration` 上é�¢çš„ `@Configuration` 注解去掉,这样就ä¸�会有这个困惑了。 -### 6\. ×ܽá +### 6\. 总结 -±¾ÎÄ´Ó `@EnableAutoConfiguration` ×¢½â³ö·¢£¬·ÖÎöÁË×Ô¶¯×°ÅäÀàµÄ¼ÓÔØÁ÷³Ì£¬¼ÓÔØÁ÷³ÌÔÚ `AutoConfigurationImportSelector#getAutoConfigurationEntry` ·½·¨ÖУ¬×îÖÕ¼ÓÔØµÄÊÇ `META-INF/spring.factories` ÎļþÖÐ key ÊÇ `org.springframework.boot.autoconfigure.EnableAutoConfiguration` µÄÀà¡£ +本文从 `@EnableAutoConfiguration` 注解出å�‘,分æž�了自动装é…�类的加载æµ�程,加载æµ�程在 `AutoConfigurationImportSelector#getAutoConfigurationEntry` 方法中,最终加载的是 `META-INF/spring.factories` 文件中 key 是 `org.springframework.boot.autoconfigure.EnableAutoConfiguration` 的类。 -µÃµ½×Ô¶¯×°ÅäÀàºó£¬spring »á½«Æä×¢²áµ½ÈÝÆ÷ÖУ¬´ËʱËüÃÇ»¹ÊÇÒ»¸öµÄ `BeanDefinition`£¬ÒªÏë³ÉΪ spring bean£¬»¹µÃ¾­¹ý `ConditionalOnBean`¡¢`ConditionalOnClass` µÈ×¢½âµÄ¿¼Ñ飬ÕâЩÎÒÃǺóÃæÔÙ·ÖÎö¡£ +得到自动装é…�ç±»å�Žï¼Œspring 会将其注册到容器中,此时它们还是一个的 `BeanDefinition`,è¦�想æˆ�为 spring bean,还得ç»�过 `ConditionalOnBean`ã€�`ConditionalOnClass` 等注解的考验,这些我们å�Žé�¢å†�分æž�。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4870868](https://my.oschina.net/funcy/blog/4870868) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4870868](https://my.oschina.net/funcy/blog/4870868) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\211\357\274\211\357\274\232\350\207\252\345\212\250\350\243\205\351\205\215\351\241\272\345\272\217.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\211\357\274\211\357\274\232\350\207\252\345\212\250\350\243\205\351\205\215\351\241\272\345\272\217.md" index 03744e2..28dec91 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\211\357\274\211\357\274\232\350\207\252\345\212\250\350\243\205\351\205\215\351\241\272\345\272\217.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\270\211\357\274\211\357\274\232\350\207\252\345\212\250\350\243\205\351\205\215\351\241\272\345\272\217.md" @@ -1,19 +1,19 @@ -ÔÚ [springboot ×Ô¶¯×°ÅäÖ®Ìõ¼þ×¢½â£¨Ò»£©](https://my.oschina.net/funcy/blog/4918863)Ò»ÎÄÖУ¬ÔÚ·ÖÎö `@ConditionalOnBean/@ConditionalOnMissingBean` ×¢½âµÄÌõ¼þÅжÏʱ£¬¹Ù·½Ç¿ÁÒ½¨ÒéÎÒÃÇÔÚ×Ô¶¯×°ÅäÀàÖÐʹÓÃÕâÁ½¸ö×¢½â£¬²¢ÇÒ `@ConditionalOnBean/@ConditionalOnMissingBean` ±ê¼ÇµÄÀàÒªÔÚÖ¸¶¨µÄÀàÖ®ºó³õʼ»¯£¬ÄÇ springboot ÈçºÎÀ´¿ØÖÆ×Ô¶¯×°Åä˳ÐòÄØ£¿±¾ÎĽ«À´Ñо¿Ï¡£ +在 [springboot 自动装é…�之æ�¡ä»¶æ³¨è§£ï¼ˆä¸€ï¼‰](https://my.oschina.net/funcy/blog/4918863)一文中,在分æž� `@ConditionalOnBean/@ConditionalOnMissingBean` 注解的æ�¡ä»¶åˆ¤æ–­æ—¶ï¼Œå®˜æ–¹å¼ºçƒˆå»ºè®®æˆ‘们在自动装é…�类中使用这两个注解,并且 `@ConditionalOnBean/@ConditionalOnMissingBean` 标记的类è¦�在指定的类之å�Žåˆ�始化,那 springboot 如何æ�¥æŽ§åˆ¶è‡ªåŠ¨è£…é…�顺åº�呢?本文将æ�¥ç ”究下。 -### 1\. springboot ´¦Àí×Ô¶¯×°ÅäÀàµÄ¹ý³Ì +### 1\. springboot 处ç�†è‡ªåŠ¨è£…é…�类的过程 -ÐèÒªÃ÷È·µÄÊÇ£¬±¾ÎÄ̽ÌÖµÄ`×Ô¶¯×°Åä˳Ðò`ÊÇÖ¸½« `class` ×¢²áµ½ `beanFactory` µÄ˳Ðò£¬springboot ´¦Àí×Ô¶¯×°ÅäÀàµÄ´óÖ¹ý³ÌÈçÏ£º +需è¦�明确的是,本文探讨的`自动装é…�顺åº�`是指将 `class` 注册到 `beanFactory` 的顺åº�,springboot 处ç�†è‡ªåŠ¨è£…é…�类的大致过程如下: -1. ¼ÓÔØ×Ô¶¯×°ÅäÀ࣬ÔÚ [springboot ×Ô¶¯×°ÅäÖ®¼ÓÔØ×Ô¶¯×°ÅäÀà](https://my.oschina.net/funcy/blog/4870868) Ò»ÎÄÖÐÒÑ·ÖÎö¹ý£» -2. ¶Ô×Ô¶¯×°ÅäÀà½øÐÐÅÅÐò£¬ÕâÊDZ¾ÎĽ«Òª·ÖÎöµÄÄÚÈÝ£» -3. ±éÀú×Ô¶¯×°ÅäÀ࣬¶Ôÿ¸ö×Ô¶¯×°ÅäÀàÖðÒ»½øÐÐÒÔϲÙ×÷£º - 1. ¸ù¾ÝÌõ¼þ×¢½âÅжϵ±Ç°×Ô¶¯×°ÅäÀàÊÇ·ñÂú×ã×°ÅäÌõ¼þ£» - 2. Èç¹ûµ±Ç°×Ô¶¯×°ÅäÀàÂú×ì×°ÅäÌõ¼þ£¬×¢²áµ½ `beanFactory` ÖС£ +1. 加载自动装é…�类,在 [springboot 自动装é…�之加载自动装é…�ç±»](https://my.oschina.net/funcy/blog/4870868) 一文中已分æž�过; +2. 对自动装é…�类进行排åº�,这是本文将è¦�分æž�的内容; +3. é��历自动装é…�类,对æ¯�个自动装é…�ç±»é€�一进行以下æ“�作: + 1. æ ¹æ�®æ�¡ä»¶æ³¨è§£åˆ¤æ–­å½“å‰�自动装é…�类是å�¦æ»¡è¶³è£…é…�æ�¡ä»¶ï¼› + 2. 如果当å‰�自动装é…�类满嘴装é…�æ�¡ä»¶ï¼Œæ³¨å†Œåˆ° `beanFactory` 中。 -Ôٻص½ `@ConditionalOnBean/@ConditionalOnMissingBean`£¬¶ÔÈçÏÂÁ½¸ö×Ô¶¯×°ÅäÀࣺ +å†�回到 `@ConditionalOnBean/@ConditionalOnMissingBean`,对如下两个自动装é…�类: ``` -// AÊÇ×Ô¶¯×°ÅäÀà +// A是自动装é…�ç±» @Configuration public class A { @Bean @@ -23,7 +23,7 @@ public class A { } } -// BÊÇ×Ô¶¯×°ÅäÀà +// B是自动装é…�ç±» @Configuration public class B { @Bean @@ -34,25 +34,25 @@ public class B { ``` -`a1` Óë `b1` ÔÚÁ½¸ö²»Í¬µÄ×Ô¶¯×°ÅäÀàÖгõʼ»¯£¬ÇÒ `a1` Ö»ÓÐÔÚ `b1` ²»´æÔÚʱ£¬²Å»á³õʼ»¯£¬¸ù¾ÝÉÏÃæ×ܽáµÄ springboot ´¦Àí×Ô¶¯×°ÅäÀàµÄ²½Ö裬ÎÒÃÇÖ»ÒªÖ¸¶¨ `b1` ÔÚ `a1` ֮ǰ³õʼ»¯¾Í²»»á²úÉúÒì³£ÁË¡£ +`a1` 与 `b1` 在两个ä¸�å�Œçš„自动装é…�类中åˆ�始化,且 `a1` å�ªæœ‰åœ¨ `b1` ä¸�存在时,æ‰�会åˆ�始化,根æ�®ä¸Šé�¢æ€»ç»“çš„ springboot 处ç�†è‡ªåŠ¨è£…é…�类的步骤,我们å�ªè¦�指定 `b1` 在 `a1` 之å‰�åˆ�始化就ä¸�会产生异常了。 -ÄÇô£¬×Ô¶¯×°ÅäÀàµÄ˳ÐòÈçºÎÖ¸¶¨ÄØ£¿ +那么,自动装é…�类的顺åº�如何指定呢? -### 2\. ×Ô¶¯×°ÅäÀàµÄ˳Ðò¿ØÖÆ×¢½â +### 2\. 自动装é…�类的顺åº�控制注解 -springboot ΪÎÒÃÇÌṩÁËÁ½ÖÖ×Ô¶¯×°ÅäÀàµÄÅÅÐòÊֶΣº +springboot 为我们æ��供了两ç§�自动装é…�类的排åº�手段: -* ¾ø¶Ô×Ô¶¯×°Åä˳Ðò ¡ª¡ª`@AutoConfigOrder` -* Ïà¶Ô×Ô¶¯×°Åä˳Ðò ¡ª¡ª`@AutoConfigureBefore` Óë `@AutoConfigureAfter` +* ç»�对自动装é…�顺åº� ——`@AutoConfigOrder` +* 相对自动装é…�顺åº� ——`@AutoConfigureBefore` 与 `@AutoConfigureAfter` -ÕâÈý¸ö×¢½â¾ÍÊÇÓÃÀ´´¦Àí×Ô¶¯×°ÅäÀàµÄÅÅÐòµÄÁË£¬`@AutoConfigOrder` Ö¸¶¨ÁË×°Åä˳Ðò£¬Í¬ spring ÌṩµÄ `@Order` ÀàËÆ£¬`@AutoConfigureBefore` Óë `@AutoConfigureAfter` ¿ÉÒÔÖ¸¶¨ `class`£¬±íʾÔÚÄĸö `class` ֮ǰ»òÖ®ºó×°Åä¡£ +这三个注解就是用æ�¥å¤„ç�†è‡ªåŠ¨è£…é…�类的排åº�的了,`@AutoConfigOrder` 指定了装é…�顺åº�,å�Œ spring æ��供的 `@Order` 类似,`@AutoConfigureBefore` 与 `@AutoConfigureAfter` å�¯ä»¥æŒ‡å®š `class`,表示在哪个 `class` 之å‰�或之å�Žè£…é…�。 -»Øµ½Ê¾Àý£¬ÎÒÃÇ¿ÉÒÔÕâÑùÖ¸¶¨×°Åä˳Ðò£º +回到示例,我们å�¯ä»¥è¿™æ ·æŒ‡å®šè£…é…�顺åº�: ``` -// AÊÇ×Ô¶¯×°ÅäÀà +// A是自动装é…�ç±» @Configuration -// ÔÚB.classÖ®ºó×Ô¶¯×°Åä +// 在B.class之å�Žè‡ªåŠ¨è£…é…� @AutoConfigureAfter(B.class) public class A { @Bean @@ -62,7 +62,7 @@ public class A { } } -// BÊÇ×Ô¶¯×°ÅäÀà +// B是自动装é…�ç±» @Configuration public class B { ... @@ -70,36 +70,36 @@ public class B { ``` -### 3\. ×Ô¶¯×°ÅäÀàµÄÅÅÐò +### 3\. 自动装é…�类的排åº� -Ç°ÃæÎÒÃÇÌáµ½£¬`@AutoConfigOrder`¡¢`@AutoConfigureBefore` Óë `@AutoConfigureAfter` ¿ÉÒÔ¿ØÖÆ×Ô¶¯×°ÅäÀàµÄ×°Åä˳Ðò£¬ÄÇôËüÃÇÊÇÔÚÄÄÀï½øÐÐÅÅÐòµÄÄØ£¿ÔÚ [springboot ×Ô¶¯×°ÅäÖ®¼ÓÔØ×Ô¶¯×°ÅäÀà](https://my.oschina.net/funcy/blog/4870868) Ò»ÎÄÖУ¬ÎÒÃÇÌá×ܽáÁË»ñÈ¡×Ô¶¯×°ÅäÀàµÄ²½ÖèÓÐ 6 ²½£º +å‰�é�¢æˆ‘们æ��到,`@AutoConfigOrder`ã€�`@AutoConfigureBefore` 与 `@AutoConfigureAfter` å�¯ä»¥æŽ§åˆ¶è‡ªåŠ¨è£…é…�类的装é…�顺åº�,那么它们是在哪里进行排åº�的呢?在 [springboot 自动装é…�之加载自动装é…�ç±»](https://my.oschina.net/funcy/blog/4870868) 一文中,我们æ��总结了获å�–自动装é…�类的步骤有 6 步: -1. µ÷Óà `AutoConfigurationImportSelector#getAutoConfigurationEntry(...)` ·½·¨¼ÓÔØ×Ô¶¯×°ÅäÀࣻ -2. ½«µÃµ½µÄ×Ô¶¯×°ÅäÀà±£´æµ½ `autoConfigurationEntries` ÖУ» -3. µÃµ½¹ýÂËÀ࣬ÕâЩ¹ýÂËÀà¾ÍÊÇÓÉ `@EnableAutoConfiguration` µÄ `exclude` »ò `excludeName` Ö¸¶¨µÄ£» -4. ½« `autoConfigurationEntries` ת»»Îª `LinkedHashSet`£¬½á¹ûΪ `processedConfigurations`£» -5. È¥³ý `processedConfigurations` ÐèÒª¹ýÂ˵ÄÀࣻ -6. ½«µÚ 5 ²½µÃµ½µÄÀàÅÅÐòºó£¬·µ»Ø¡£ +1. 调用 `AutoConfigurationImportSelector#getAutoConfigurationEntry(...)` 方法加载自动装é…�类; +2. 将得到的自动装é…�ç±»ä¿�存到 `autoConfigurationEntries` 中; +3. 得到过滤类,这些过滤类就是由 `@EnableAutoConfiguration` çš„ `exclude` 或 `excludeName` 指定的; +4. å°† `autoConfigurationEntries` 转æ�¢ä¸º `LinkedHashSet`,结果为 `processedConfigurations`ï¼› +5. 去除 `processedConfigurations` 需è¦�过滤的类; +6. 将第 5 步得到的类排åº�å�Žï¼Œè¿”回。 -¶ø¶Ô×Ô¶¯×°ÅäÀàµÄÅÅÐòÕýÊÇÔÚµÚ 6 ²½£¬¶ÔÓ¦µÄ·½·¨ÊÇ `AutoConfigurationImportSelector.AutoConfigurationGroup#sortAutoConfigurations`£¬´úÂëÈçÏ£º +而对自动装é…�类的排åº�正是在第 6 步,对应的方法是 `AutoConfigurationImportSelector.AutoConfigurationGroup#sortAutoConfigurations`,代ç �如下: ``` private List sortAutoConfigurations(Set configurations, AutoConfigurationMetadata autoConfigurationMetadata) { - // ÏÈ´´½¨ÁË AutoConfigurationSorter ¶ÔÏó£¬ - // È»ºóµ÷Óà AutoConfigurationSorter.getInPriorityOrder ½øÐÐÅÅÐò + // 先创建了 AutoConfigurationSorter 对象, + // ç„¶å�Žè°ƒç”¨ AutoConfigurationSorter.getInPriorityOrder 进行排åº� return new AutoConfigurationSorter(getMetadataReaderFactory(), autoConfigurationMetadata) .getInPriorityOrder(configurations); } ``` -Õâ¸ö·½·¨µÄ´¦Àí·ÖΪÁ½²½£º +这个方法的处ç�†åˆ†ä¸ºä¸¤æ­¥ï¼š -1. ´´½¨ÁË `AutoConfigurationSorter` ¶ÔÏó -2. µ÷Óà `AutoConfigurationSorter.getInPriorityOrder` ½øÐÐÅÅÐò +1. 创建了 `AutoConfigurationSorter` 对象 +2. 调用 `AutoConfigurationSorter.getInPriorityOrder` 进行排åº� -ÎÒÃÇÏÈÀ´¿´¿´ `AutoConfigurationSorter` µÄ´´½¨²Ù×÷£º +我们先æ�¥çœ‹çœ‹ `AutoConfigurationSorter` 的创建æ“�作: ``` class AutoConfigurationSorter { @@ -109,8 +109,8 @@ class AutoConfigurationSorter { private final AutoConfigurationMetadata autoConfigurationMetadata; /** - * ¹¹Ôì·½·¨ - * ½ö½öÖ»ÊǶԴ«ÈëµÄ²ÎÊý½øÐи³Öµ£¬½«ËûÃǸ³ÖµÎª³ÉÔ±±äÁ¿ + * 构造方法 + * ä»…ä»…å�ªæ˜¯å¯¹ä¼ å…¥çš„å�‚数进行赋值,将他们赋值为æˆ�员å�˜é‡� */ AutoConfigurationSorter(MetadataReaderFactory metadataReaderFactory, AutoConfigurationMetadata autoConfigurationMetadata) { @@ -125,78 +125,78 @@ class AutoConfigurationSorter { ``` -¿ÉÒÔ¿´µ½£¬`AutoConfigurationSorter` µÄ¹¹Ôì·½·¨²¢Ã»ÓÐ×öʲôʵÖÊÐԵIJÙ×÷£¬¿´À´ÅÅÐòµÄ¹Ø¼ü»¹µÃ¿´ `AutoConfigurationSorter.getInPriorityOrder` ·½·¨£¬¸Ã·½·¨µÄ´úÂëÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`AutoConfigurationSorter` 的构造方法并没有å�šä»€ä¹ˆå®žè´¨æ€§çš„æ“�作,看æ�¥æŽ’åº�的关键还得看 `AutoConfigurationSorter.getInPriorityOrder` 方法,该方法的代ç �如下: ``` List getInPriorityOrder(Collection classNames) { - // 1\. ½« classNames °ü×°³É AutoConfigurationClasses + // 1\. å°† classNames 包装æˆ� AutoConfigurationClasses AutoConfigurationClasses classes = new AutoConfigurationClasses(this.metadataReaderFactory, this.autoConfigurationMetadata, classNames); List orderedClassNames = new ArrayList<>(classNames); - // 2\. °´ÀàÃûÅÅÐò + // 2\. 按类å��排åº� Collections.sort(orderedClassNames); - // 3\. ʹÓà @AutoConfigureOrder ÅÅÐò + // 3\. 使用 @AutoConfigureOrder 排åº� orderedClassNames.sort((o1, o2) -> { int i1 = classes.get(o1).getOrder(); int i2 = classes.get(o2).getOrder(); return Integer.compare(i1, i2); }); - // 4\. ʹÓà @AutoConfigureBefore£¬@AutoConfigureAfter ÅÅÐò + // 4\. 使用 @AutoConfigureBefore,@AutoConfigureAfter 排åº� orderedClassNames = sortByAnnotation(classes, orderedClassNames); return orderedClassNames; } ``` -´Ó´úÂëÀ´ ¿´£¬Õâ¸ö·½·¨µÄÖ´Ðв½ÖèÈçÏ£º +从代ç �æ�¥ 看,这个方法的执行步骤如下: -1. ½« `classNames` °ü×°³É `AutoConfigurationClasses` -2. °´ÀàÃûÅÅÐò -3. ʹÓà `@AutoConfigureOrder` ÅÅÐò -4. ʹÓà `@AutoConfigureBefore`£¬`@AutoConfigureAfter` ÅÅÐò +1. å°† `classNames` 包装æˆ� `AutoConfigurationClasses` +2. 按类å��排åº� +3. 使用 `@AutoConfigureOrder` 排åº� +4. 使用 `@AutoConfigureBefore`,`@AutoConfigureAfter` 排åº� -Õâ¸ö·½·¨ÅÅÐò¹²½øÐÐÁË 3 ´Î£¬¶¼ÊÇ¶Ô `orderedClassNames` ½øÐÐÅÅÐò£¬ÕâÑùÒ»À´£¬ºóÃæµÄÅÅÐò»á´òÂÒÇ°ÃæµÄÅÅÐò£¬×îÏȵÄÅÅÐòÊǰ´ÀàÃûÅÅÐò£¬Ò²¾ÍÊÇ˵£¬Èç¹ûûÓÐÖ¸¶¨ `@AutoConfigureOrder`¡¢`@AutoConfigureBefore` µÈ×¢½â£¬¾Í»áʹÓÃÀàÃû½øÐÐÅÅÐò¡£ +这个方法排åº�共进行了 3 次,都是对 `orderedClassNames` 进行排åº�,这样一æ�¥ï¼Œå�Žé�¢çš„æŽ’åº�会打乱å‰�é�¢çš„æŽ’åº�,最先的排åº�是按类å��排åº�,也就是说,如果没有指定 `@AutoConfigureOrder`ã€�`@AutoConfigureBefore` 等注解,就会使用类å��进行排åº�。 -½ÓÏÂÀ´ÎÒÃǾßÌå·ÖÎöÕ⼸¸ö²Ù×÷°É¡£ +接下æ�¥æˆ‘们具体分æž�这几个æ“�作å�§ã€‚ -### 4\. ½« `classNames` °ü×°³É `AutoConfigurationClasses` +### 4\. å°† `classNames` 包装æˆ� `AutoConfigurationClasses` -¸Ã²Ù×÷λÓÚ `AutoConfigurationSorter.AutoConfigurationClasses#AutoConfigurationClasses` ·½·¨£¬´úÂëÈçÏ£º +该æ“�作ä½�于 `AutoConfigurationSorter.AutoConfigurationClasses#AutoConfigurationClasses` 方法,代ç �如下: ``` private static class AutoConfigurationClasses { - // ±£´æ½á¹û + // ä¿�存结果 private final Map classes = new HashMap<>(); /** - * ¹¹Ôì·½·¨ + * 构造方法 */ AutoConfigurationClasses(MetadataReaderFactory metadataReaderFactory, AutoConfigurationMetadata autoConfigurationMetadata, Collection classNames) { - // ½øÐз½·¨µ÷Óà + // 进行方法调用 addToClasses(metadataReaderFactory, autoConfigurationMetadata, classNames, true); } /** - * Ìí¼ÓÀ࣬¾ÍÊǽ«Àà°ü×°³É AutoConfigurationClass£¬Ìí¼Óµ½ÃûΪ classes µÄ Map ÖÐ - * classNames ¾ÍÊÇÈ¥³ýÁËÅųýÀàµÄËùÓÐ×Ô¶¯×°ÅäÀà + * 添加类,就是将类包装æˆ� AutoConfigurationClass,添加到å��为 classes çš„ Map 中 + * classNames 就是去除了排除类的所有自动装é…�ç±» */ private void addToClasses(MetadataReaderFactory metadataReaderFactory, AutoConfigurationMetadata autoConfigurationMetadata, Collection classNames, boolean required) { for (String className : classNames) { if (!this.classes.containsKey(className)) { - // ½« className °ü×°³É AutoConfigurationClass + // å°† className 包装æˆ� AutoConfigurationClass AutoConfigurationClass autoConfigurationClass = new AutoConfigurationClass( className, metadataReaderFactory, autoConfigurationMetadata); boolean available = autoConfigurationClass.isAvailable(); - // @AutoConfigureBefore Óë @AutoConfigureAfter ±ê¼ÇµÄÀàµÄ required Ϊ false + // @AutoConfigureBefore 与 @AutoConfigureAfter 标记的类的 required 为 false if (required || available) { this.classes.put(className, autoConfigurationClass); } if (available) { - // µÝ¹éµ÷Óà + // 递归调用 addToClasses(metadataReaderFactory, autoConfigurationMetadata, autoConfigurationClass.getBefore(), false); addToClasses(metadataReaderFactory, autoConfigurationMetadata, @@ -210,36 +210,36 @@ private static class AutoConfigurationClasses { ``` -´ÓÒÔÉÏ´úÂëÀ´¿´£¬ +从以上代ç �æ�¥çœ‹ï¼Œ -* `AutoConfigurationClasses` °üº¬Ò»¸ö³ÉÔ±±äÁ¿£º`classes`£¬ÀàÐÍÊÇ `Map`£¬`key` ÊÇ `String`£¨Ò²¾ÍÊÇ `className`£©£¬`value` ÊÇ `AutoConfigurationClass`£¨Ò²¾ÍÊÇ `className` µÄ°üº¬Àࣩ; -* `AutoConfigurationClasses` µÄ¹¹Ôì·½·¨»áµ÷Óà `addToClasses(...)` ¸Ã·½·¨»á±éÀú´«ÈëµÄ `classNames`£¬½«Æä°ü×°³É `AutoConfigurationClass` ºó£¬ÔÙ±£´æµ½ `classes` ÖС£ +* `AutoConfigurationClasses` 包å�«ä¸€ä¸ªæˆ�员å�˜é‡�:`classes`,类型是 `Map`,`key` 是 `String`(也就是 `className`),`value` 是 `AutoConfigurationClass`(也就是 `className` 的包å�«ç±»ï¼‰; +* `AutoConfigurationClasses` 的构造方法会调用 `addToClasses(...)` 该方法会é��历传入的 `classNames`,将其包装æˆ� `AutoConfigurationClass` å�Žï¼Œå†�ä¿�存到 `classes` 中。 -ÔÚ·ÖÎö `addToClasses(...)` µÄ¾ßÌåÂß¼­Ç°£¬ÎÒÃÇÏÈÀ´¿´¿´ `AutoConfigurationClass` ÊǸöɶ£º +在分æž� `addToClasses(...)` 的具体逻辑å‰�,我们先æ�¥çœ‹çœ‹ `AutoConfigurationClass` 是个啥: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fd9c1a4c335951391a33f86a86fe89ff496.png) -¿ÉÒÔ¿´µ½ £¬`AutoConfigurationClass` ÊÇÀàÃûµÄ°ü×°£¬²¢ÇÒ»¹±£´æÁË `@AutoConfigureBefore` Óë `@AutoConfigureAfter` Ö¸¶¨µÄÀ࣬ÒÔ¼°ÌṩÁ˸ú `@AutoConfigureOrder`¡¢ `@AutoConfigureBefore`¡¢`@AutoConfigureAfter` Ïà¹ØµÄһЩ·½·¨¡£ +å�¯ä»¥çœ‹åˆ° ,`AutoConfigurationClass` 是类å��的包装,并且还ä¿�存了 `@AutoConfigureBefore` 与 `@AutoConfigureAfter` 指定的类,以å�Šæ��供了跟 `@AutoConfigureOrder`ã€� `@AutoConfigureBefore`ã€�`@AutoConfigureAfter` 相关的一些方法。 -ÎÒÃÇÔٻعýÍ·¿´ `addToClasses(...)` µÄÖ´ÐÐÁ÷³Ì£¬¸Ã·½·¨µÄÖ´ÐÐÁ÷³ÌÈçÏ£º +我们å†�回过头看 `addToClasses(...)` 的执行æµ�程,该方法的执行æµ�程如下: -1. ±éÀú´«ÈëµÄ `classNames`£¬¶ÔÆäÖÐÿһ¸ö `className`£¬½øÐÐÏÂÃæµÄ²Ù×÷£» -2. ´´½¨ `AutoConfigurationClass`£¬´«Èë `className`£» -3. µ÷Óà `AutoConfigurationSorter.AutoConfigurationClass#isAvailable` ·½·¨£¬µÃµ½ `available`£» -4. ÅÐ¶Ï `available` Óë `required` µÄÖµ£¬Èç¹ûÆäһΪ ture£¬¾Í½«ÆäÌí¼Óµ½ `classes`£» -5. Èç¹û `available` Ϊ `true`£¬µÝ¹é´¦Àí `className` ÓÉ `@AutoConfigureBefore` Óë `@AutoConfigureAfter` Ö¸¶¨µÄÀà¡£ +1. é��历传入的 `classNames`,对其中æ¯�一个 `className`,进行下é�¢çš„æ“�作; +2. 创建 `AutoConfigurationClass`,传入 `className`ï¼› +3. 调用 `AutoConfigurationSorter.AutoConfigurationClass#isAvailable` 方法,得到 `available`ï¼› +4. 判断 `available` 与 `required` 的值,如果其一为 ture,就将其添加到 `classes`ï¼› +5. 如果 `available` 为 `true`,递归处ç�† `className` ç”± `@AutoConfigureBefore` 与 `@AutoConfigureAfter` 指定的类。 -Á÷³Ì¿´×Ų»¸´ÔÓ£¬²»¹ýÓм¸¸ö¾ÍÈ¥ÐèÒª·ÖÎöÏ £º +æµ�程看ç�€ä¸�å¤�æ�‚,ä¸�过有几个就去需è¦�分æž�下 : -1. `AutoConfigurationSorter.AutoConfigurationClass#isAvailable`£ºÅжϵ±Ç° `class` ÊÇ·ñ´æÔÚ -2. `AutoConfigurationSorter.AutoConfigurationClass#getBefore`£º»ñÈ¡ `class`£ºµ±Ç° `class` ÐèÒªÔÚÕâЩ `class` ֮ǰ´¦Àí -3. `AutoConfigurationSorter.AutoConfigurationClass#getAfter`£º»ñÈ¡ `class`£ºµ±Ç° `class` ÐèÒªÔÚÕâЩ `class` Ö®ºó´¦Àí +1. `AutoConfigurationSorter.AutoConfigurationClass#isAvailable`:判断当å‰� `class` 是å�¦å­˜åœ¨ +2. `AutoConfigurationSorter.AutoConfigurationClass#getBefore`:获å�– `class`:当å‰� `class` 需è¦�在这些 `class` 之å‰�处ç�† +3. `AutoConfigurationSorter.AutoConfigurationClass#getAfter`:获å�– `class`:当å‰� `class` 需è¦�在这些 `class` 之å�Žå¤„ç�† -½ÓÏÂÀ´ÎÒÃÇÒ»Ò»À´·ÖÎöÏÂÕ⼸¸ö·½·¨¡£ +接下æ�¥æˆ‘们一一æ�¥åˆ†æž�下这几个方法。 #### 4.1 `AutoConfigurationSorter.AutoConfigurationClass#isAvailable` -Õâ¸ö·½·¨ÊÇÓÃÀ´Åжϵ±Ç° `class` ÊÇ·ñÔÚµ±Ç°ÏîÄ¿µÄ `classpath` ÖУ¬¿´´úÂ룺 +这个方法是用æ�¥åˆ¤æ–­å½“å‰� `class` 是å�¦åœ¨å½“å‰�项目的 `classpath` 中,看代ç �: ``` boolean isAvailable() { @@ -256,49 +256,49 @@ boolean isAvailable() { ``` -Õâ¸ö·½·¨´úÂë²»¶à£¬ÏÈÊǵ÷Óà `wasProcessed()` ·½·¨£¬ÔÙµ÷Óà `getAnnotationMetadata()`£¬ÐèҪעÒâµÄÊÇ£¬`getAnnotationMetadata()` ¿ÉÄÜ»áÅ׳öÒì³££¬ÕÐÆ¸Òì³£Ò²»á·µ»Ø `false`. +这个方法代ç �ä¸�多,先是调用 `wasProcessed()` 方法,å†�调用 `getAnnotationMetadata()`,需è¦�注æ„�的是,`getAnnotationMetadata()` å�¯èƒ½ä¼šæŠ›å‡ºå¼‚常,招è�˜å¼‚常也会返回 `false`. -ÎÒÃǼÌÐø¸ú½ø `AutoConfigurationSorter.AutoConfigurationClass#wasProcessed` ·½·¨£º +我们继续跟进 `AutoConfigurationSorter.AutoConfigurationClass#wasProcessed` 方法: ``` private boolean wasProcessed() { return (this.autoConfigurationMetadata != null - // ÅÐ¶Ï META-INF/spring-autoconfigure-metadata.properties ÎļþÖÐÊÇ·ñ´æÔÚ¸ÃÅäÖà + // 判断 META-INF/spring-autoconfigure-metadata.properties 文件中是å�¦å­˜åœ¨è¯¥é…�ç½® && this.autoConfigurationMetadata.wasProcessed(this.className)); } ``` -Õâ¸ö·½·¨ÀïÖ÷Òªµ÷ÓÃÁË `AutoConfigurationMetadataLoader.PropertiesAutoConfigurationMetadata#wasProcessed` ·½·¨À´Åжϣº +这个方法里主è¦�调用了 `AutoConfigurationMetadataLoader.PropertiesAutoConfigurationMetadata#wasProcessed` 方法æ�¥åˆ¤æ–­ï¼š ``` @Override public boolean wasProcessed(String className) { - // ÅÐ¶Ï properties ÊÇ·ñ´æÔÚ¶ÔÓ¦µÄ className + // 判断 properties 是å�¦å­˜åœ¨å¯¹åº”çš„ className return this.properties.containsKey(className); } ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½·¨½öÊÇÅÐ¶Ï `properties` ÀïÊÇ·ñ°üº¬´«ÈëµÄ `className`£¬`properties` µÄÄÚÈÝÀ´×ÔÓÚ `META-INF/spring-autoconfigure-metadata.properties`£¬ÄÚÈÝʾÀýÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ³•仅是判断 `properties` 里是å�¦åŒ…å�«ä¼ å…¥çš„ `className`,`properties` 的内容æ�¥è‡ªäºŽ `META-INF/spring-autoconfigure-metadata.properties`,内容示例如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-069444fdaa952c6fa8c39576e776275982b.png) -ÐèҪעÒâµÄÊÇ£¬¸ÃÎļþÔÚÔ´ÂëÖÐÊDz»´æÔڵģ¬ËüÊÇÔÚ±àÒëʱдÈëµÄ£¬¹ØÓÚ¸ÃÎļþµÄдÈë¡¢¼ÓÔØµ½ `properties` µÄÁ÷³Ì£¬±¾ÎľͲ»Õ¹¿ª·ÖÎöÁË£¬ÕâÀïÌṩ¸ö´ó¸Å˼·£º +需è¦�注æ„�的是,该文件在æº�ç �中是ä¸�存在的,它是在编译时写入的,关于该文件的写入ã€�加载到 `properties` çš„æµ�程,本文就ä¸�展开分æž�了,这里æ��供个大概æ€�路: -* ÎļþµÄдÈ룺ÔÚ´úÂë±àÒëʱ£¬springboot »á½«×Ô¶¯×°ÅäÀàµÄһЩÐÅÏ¢ (ÀýÈ磬`@ConditionalOnClass` Ö¸¶¨µÄ `class`£¬`@ConditionalOnBean` Ö¸¶¨µÄ `bean`£¬`@AutoConfigureBefore` Óë `@AutoConfigureAfter` µÄÖ¸¶¨µÄ `class` µÈ) дÈëµ½ `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖУ¬´¦ÀíÀàΪ `AutoConfigureAnnotationProcessor`£¬Õâ¸öÀàÊÇ `javax.annotation.processing.AbstractProcessor` µÄ×ÓÀ࣬¶ø `AbstractProcessor` ÓÉ jdk Ìṩ£¬¿ÉÒÔÔÚ±àÒëÆÚ¶Ô×¢½â½øÐд¦Àí£» +* 文件的写入:在代ç �编译时,springboot 会将自动装é…�类的一些信æ�¯ (例如,`@ConditionalOnClass` 指定的 `class`,`@ConditionalOnBean` 指定的 `bean`,`@AutoConfigureBefore` 与 `@AutoConfigureAfter` 的指定的 `class` ç­‰) 写入到 `META-INF/spring-autoconfigure-metadata.properties` 文件中,处ç�†ç±»ä¸º `AutoConfigureAnnotationProcessor`,这个类是 `javax.annotation.processing.AbstractProcessor` çš„å­�类,而 `AbstractProcessor` ç”± jdk æ��供,å�¯ä»¥åœ¨ç¼–译期对注解进行处ç�†ï¼› -* ÎļþµÄ¼ÓÔØ£ºÔÚ `AutoConfigurationImportSelector.AutoConfigurationGroup#process` ·½·¨Öе÷Óà `AutoConfigurationImportSelector#getAutoConfigurationEntry` ʱ£¬»á´«Èë `AutoConfigurationMetadata`£¬Îļþ `META-INF/spring-autoconfigure-metadata.properties` ÖеÄÄÚÈݾÍÊÇ´ÓÕâÀï¼ÓÔØµ½ `AutoConfigurationMetadataLoader.PropertiesAutoConfigurationMetadata#properties` Öеģ» +* 文件的加载:在 `AutoConfigurationImportSelector.AutoConfigurationGroup#process` 方法中调用 `AutoConfigurationImportSelector#getAutoConfigurationEntry` 时,会传入 `AutoConfigurationMetadata`,文件 `META-INF/spring-autoconfigure-metadata.properties` 中的内容就是从这里加载到 `AutoConfigurationMetadataLoader.PropertiesAutoConfigurationMetadata#properties` 中的; -ÓÉЩ¿É¼û£¬`AutoConfigurationMetadataLoader.PropertiesAutoConfigurationMetadata#wasProcessed` ·½·¨Êµ¼ÊÉϾÍÊÇÅÐ¶Ï `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖÐÊÇ·ñÓÐ `className` µÄÅäÖᣠ+由些å�¯è§�,`AutoConfigurationMetadataLoader.PropertiesAutoConfigurationMetadata#wasProcessed` 方法实际上就是判断 `META-INF/spring-autoconfigure-metadata.properties` 文件中是å�¦æœ‰ `className` çš„é…�置。 -ÈÃÎÒÃǻص½ `AutoConfigurationSorter.AutoConfigurationClass#isAvailable`£¬ÔÙÀ´¿´¿´ÁíÒ»¸ö·½·¨£º`getAnnotationMetadata()`£¬¸Ã·½·¨Î»ÓÚ `AutoConfigurationSorter.AutoConfigurationClass` ÖУ¬´úÂëÈçÏ£º +让我们回到 `AutoConfigurationSorter.AutoConfigurationClass#isAvailable`,å†�æ�¥çœ‹çœ‹å�¦ä¸€ä¸ªæ–¹æ³•:`getAnnotationMetadata()`,该方法ä½�于 `AutoConfigurationSorter.AutoConfigurationClass` 中,代ç �如下: ``` private AnnotationMetadata getAnnotationMetadata() { if (this.annotationMetadata == null) { try { - // ¼ÓÔØ`className`¶ÔÓ¦µÄ×ÊÔ´£¬µ± className ¶ÔÓ¦µÄ×ÊÔ´²»´æÔÚʱ£¬»áÅ׳öÒì³£ + // 加载`className`对应的资æº�,当 className 对应的资æº�ä¸�存在时,会抛出异常 MetadataReader metadataReader = this.metadataReaderFactory .getMetadataReader(this.className); this.annotationMetadata = metadataReader.getAnnotationMetadata(); @@ -312,37 +312,37 @@ private AnnotationMetadata getAnnotationMetadata() { ``` -¼ÌÐø½øÈë `SimpleMetadataReaderFactory#getMetadataReader(String)`£º +继续进入 `SimpleMetadataReaderFactory#getMetadataReader(String)`: ``` @Override /** - * Õâ¸ö·½·¨»á»ñÈ¡ className ¶ÔÓ¦µÄ .class Îļþ - * Èç¹û .class Îļþ²»´æÔÚ£¬¾Í±¨Òì³£ÁË£ºIOException + * 这个方法会获å�– className 对应的 .class 文件 + * 如果 .class 文件ä¸�存在,就报异常了:IOException */ public MetadataReader getMetadataReader(String className) throws IOException { try { - // ת»»Ãû³Æ£º"classpath:xxx/xxx/Xxx.class" + // 转æ�¢å��称:"classpath:xxx/xxx/Xxx.class" String resourcePath = ResourceLoader.CLASSPATH_URL_PREFIX + lassUtils.convertClassNameToResourcePath(className) + ClassUtils.CLASS_FILE_SUFFIX; - // »ñÈ¡×ÊÔ´£¬Ä¬È쵀 resourceLoader Ϊ classLoader + // 获å�–资æº�,默认的 resourceLoader 为 classLoader Resource resource = this.resourceLoader.getResource(resourcePath); - // ½« resource ת»»³É MetadataReader ¶ÔÏ󣬲»´æÔھͻáÅ׳öÒì³££ºIOException + // å°† resource 转æ�¢æˆ� MetadataReader 对象,ä¸�存在就会抛出异常:IOException return getMetadataReader(resource); } catch (FileNotFoundException ex) { - // ÓпÉÄÜÊÇÄÚ²¿À࣬ÔÙ°´ÄÚ²¿ÀàµÄÃüÃû·½Ê½´¦ÀíÒ»´Î + // 有å�¯èƒ½æ˜¯å†…部类,å†�按内部类的命å��æ–¹å¼�处ç�†ä¸€æ¬¡ int lastDotIndex = className.lastIndexOf('.'); if (lastDotIndex != -1) { String innerClassName = className.substring(0, lastDotIndex) + '$' + className.substring(lastDotIndex + 1); - // ת»»Ãû³Æ£º"classpath:xxx/Xxx$Xxx.class" + // 转æ�¢å��称:"classpath:xxx/Xxx$Xxx.class" String innerClassResourcePath = ResourceLoader.CLASSPATH_URL_PREFIX + ClassUtils.convertClassNameToResourcePath(innerClassName) + ClassUtils.CLASS_FILE_SUFFIX; Resource innerClassResource = this.resourceLoader.getResource(innerClassResourcePath); - // ÅжÏÊÇ·ñ´æÔÚ£¬²»´æÔÚ»¹ÊǻᱨÒì³£µÄ£ºIOException + // 判断是å�¦å­˜åœ¨ï¼Œä¸�存在还是会报异常的:IOException if (innerClassResource.exists()) { return getMetadataReader(innerClassResource); } @@ -353,32 +353,32 @@ public MetadataReader getMetadataReader(String className) throws IOException { ``` -Õâ¸ö·½·¨µÄ´¦ÀíÁ÷³ÌÈçÏ£º +这个方法的处ç�†æµ�程如下: -1. ½«´«ÈëµÄ `className` ת»»Îª `classpath:xxx/xxx/Xxx.class` µÄÐÎʽ£¬È»ºóÈ¥¼ÓÔØ¶ÔÓ¦µÄ×ÊÔ´£¬Èç¹û×ÊÔ´²»´æÔÚ¼´ `className` ¶ÔÓ¦µÄ`.class` Îļþ²»´æÔÚ£¬ÔòÅ׳öÒì³££» -2. ÔÚÒì³£µÄ `catch` ¿éÖУ¬ÎªÁË·ÀÖ¹ `className` ÊÇÄÚ²¿À࣬»á½« `className` ת»»Îª `classpath:xxx/Xxx$Xxx.class` µÄÐÎʽ£¬È»ºóÔÙ¼ÓÔØÒ»´Î×ÊÔ´£¬Èç¹û×ÊÔ´´æÔÚ£¬Ö±½Ó·µ»Ø£¬·ñÔò½«Òì³£ÍùÍâÅ×£» +1. 将传入的 `className` 转æ�¢ä¸º `classpath:xxx/xxx/Xxx.class` 的形å¼�,然å�ŽåŽ»åŠ è½½å¯¹åº”çš„èµ„æº�,如果资æº�ä¸�存在å�³ `className` 对应的`.class` 文件ä¸�存在,则抛出异常; +2. 在异常的 `catch` å�—中,为了防止 `className` 是内部类,会将 `className` 转æ�¢ä¸º `classpath:xxx/Xxx$Xxx.class` 的形å¼�,然å�Žå†�加载一次资æº�,如果资æº�存在,直接返回,å�¦åˆ™å°†å¼‚常往外抛; -µ½ÁËÕâÀÎÒÃǾÍÃ÷°×ÁË£¬`getAnnotationMetadata()` ¾ÍÊÇÓÃÀ´Åжϵ±Ç° `className` ¶ÔÓ¦µÄ`.class` ÔÚÏîÄ¿µÄ `classpath` ·¾¶ÖÐÊÇ·ñ´æÔÚ¡£ +到了这里,我们就明白了,`getAnnotationMetadata()` 就是用æ�¥åˆ¤æ–­å½“å‰� `className` 对应的`.class` 在项目的 `classpath` 路径中是å�¦å­˜åœ¨ã€‚ -¶ÔÕâÁ½¸ö·½·¨£¬ÎÒÃÇ×ܽáÈçÏ£º +对这两个方法,我们总结如下: -* `AutoConfigurationSorter.AutoConfigurationClass#wasProcessed`£ºµ±Ç° `className` ÊÇ·ñÔÚ `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖÐ -* `AutoConfigurationSorter.AutoConfigurationClass#isAvailable`£ºµ±Ç° `className` ¶ÔÓ¦µÄ`.class` ÎļþÊÇ·ñ´æÔÚ +* `AutoConfigurationSorter.AutoConfigurationClass#wasProcessed`:当å‰� `className` 是å�¦åœ¨ `META-INF/spring-autoconfigure-metadata.properties` 文件中 +* `AutoConfigurationSorter.AutoConfigurationClass#isAvailable`:当å‰� `className` 对应的`.class` 文件是å�¦å­˜åœ¨ -×îÖյĽáÂÛ£º`AutoConfigurationSorter.AutoConfigurationClass#isAvailable` ¾ÍÊÇÓÃÀ´Åжϵ±Ç° `className` ¶ÔÓ¦µÄ`.class` ÎļþÔÚÏîÄ¿µÄ `classpath` ·¾¶ÖÐ. +最终的结论:`AutoConfigurationSorter.AutoConfigurationClass#isAvailable` 就是用æ�¥åˆ¤æ–­å½“å‰� `className` 对应的`.class` 文件在项目的 `classpath` 路径中. #### 4.2 `AutoConfigurationSorter.AutoConfigurationClass#getBefore/getAfter` -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `AutoConfigurationSorter.AutoConfigurationClass` ÀàµÄÁ½¸ö·½·¨£º`getAfter()` Óë `getBefore()`£º +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `AutoConfigurationSorter.AutoConfigurationClass` 类的两个方法:`getAfter()` 与 `getBefore()`: ``` Set getBefore() { if (this.before == null) { this.before = (wasProcessed() - // Èç¹û´æÔÚÓÚ `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖУ¬Ö±½Ó»ñȡֵ + // 如果存在于 `META-INF/spring-autoconfigure-metadata.properties` 文件中,直接获å�–值 ? this.autoConfigurationMetadata.getSet(this.className, "AutoConfigureBefore", Collections.emptySet()) - // ·ñÔò´Ó @AutoConfigureBefore ×¢½âÉÏ»ñÈ¡ + // å�¦åˆ™ä»Ž @AutoConfigureBefore 注解上获å�– : getAnnotationValue(AutoConfigureBefore.class)); } return this.before; @@ -387,17 +387,17 @@ Set getBefore() { Set getAfter() { if (this.after == null) { this.after = (wasProcessed() - // Èç¹û´æÔÚÓÚ `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖУ¬Ö±½Ó»ñȡֵ + // 如果存在于 `META-INF/spring-autoconfigure-metadata.properties` 文件中,直接获å�–值 ? this.autoConfigurationMetadata.getSet(this.className, "AutoConfigureAfter", Collections.emptySet()) - // ·ñÔò´Ó @AutoConfigureAfter ×¢½âÉÏ»ñÈ¡ + // å�¦åˆ™ä»Ž @AutoConfigureAfter 注解上获å�– : getAnnotationValue(AutoConfigureAfter.class)); } return this.after; } /** - * ´Ó @AutoConfigureBefore/@AutoConfigureAfter ×¢½âÖлñȡֵ£ºvalue Óë name Ö¸¶¨µÄÖµ + * 从 @AutoConfigureBefore/@AutoConfigureAfter 注解中获å�–值:value 与 name 指定的值 */ private Set getAnnotationValue(Class annotation) { Map attributes = getAnnotationMetadata() @@ -413,17 +413,17 @@ private Set getAnnotationValue(Class annotation) { ``` -ÕâÁ½¸ö·½·¨ÔÚ´úÂëÐÎʽ»ù±¾Ò»Ö£¬ÏÈ¿´ `getBefore()` µÄÁ÷³Ì£º +这两个方法在代ç �å½¢å¼�基本一致,先看 `getBefore()` çš„æµ�程: -1. Èç¹ûµ±Ç° `className` ´æÔÚÓÚ `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖУ¬Ö±½Óȡֵ£¬Ç°Ãæ·ÖÎöÒ²Ìáµ½£¬springboot ÔÚ±àÒëʱ£¬»á°ÑһЩע½âµÄÐÅϢдÈëµ½ `META-INF/spring-autoconfigure-metadata.properties` ÎļþÖУ» +1. 如果当å‰� `className` 存在于 `META-INF/spring-autoconfigure-metadata.properties` 文件中,直接å�–值,å‰�é�¢åˆ†æž�也æ��到,springboot 在编译时,会把一些注解的信æ�¯å†™å…¥åˆ° `META-INF/spring-autoconfigure-metadata.properties` 文件中; -2. Èç¹ûµÚ 1 ²½²»³É¹¦£¬Ôò´Óµ±Ç° `class` µÄ `@AutoConfigureBefore` ȡֵ£» +2. 如果第 1 æ­¥ä¸�æˆ�功,则从当å‰� `class` çš„ `@AutoConfigureBefore` å�–值; -`getAfter()` ·½·¨µÄÁ÷³ÌÓë `getBefore()` µÄÁ÷³Ì»ù±¾Ò»Ö£¬¾Í²»·ÖÎöÁË¡£ +`getAfter()` 方法的æµ�程与 `getBefore()` çš„æµ�程基本一致,就ä¸�分æž�了。 -### 5\. ʹÓà `@AutoConfigureOrder` ÅÅÐò +### 5\. 使用 `@AutoConfigureOrder` 排åº� -ÈÃÎÒÃǻص½ `AutoConfigurationSorter#getInPriorityOrder` ·½·¨£¬ÎÒÃÇÀ´¿´¿´ `@AutoConfigureOrder` µÄÅÅÐò¹ý³Ì£º +让我们回到 `AutoConfigurationSorter#getInPriorityOrder` 方法,我们æ�¥çœ‹çœ‹ `@AutoConfigureOrder` 的排åº�过程: ``` List getInPriorityOrder(Collection classNames) { @@ -438,93 +438,93 @@ List getInPriorityOrder(Collection classNames) { ``` -Õâ¸öÅÅÐò²Ù×÷ʹÓõÄÊÇ `List#sort`£¬`sort(...)` ÀïµÄ²ÎÊýΪ `Comparator`£¬Ö¸¶¨ÁËÅÅÐò¹æÔò¡£´Ó´úÂëÀ´¿´£¬Í¨¹ý `getOrder()` »ñÈ¡µ½µ±Ç°ÀàµÄ˳Ðòºó£¬ÔÙʹÓõÄÊÇ `Integer` µÄ±È½Ï¹æÔò½øÐÐÅÅÐò£¬Òò´Ë `getOrder()` ÊÇÅÅÐòµÄ¹Ø¼ü£¬ËüËù¶Ô¾ÍµÄ·½·¨ÊÇ `AutoConfigurationSorter.AutoConfigurationClass#getOrder`£¬´úÂëÈçÏ£º +这个排åº�æ“�作使用的是 `List#sort`,`sort(...)` 里的å�‚数为 `Comparator`,指定了排åº�规则。从代ç �æ�¥çœ‹ï¼Œé€šè¿‡ `getOrder()` 获å�–到当å‰�类的顺åº�å�Žï¼Œå†�使用的是 `Integer` 的比较规则进行排åº�,因此 `getOrder()` 是排åº�的关键,它所对就的方法是 `AutoConfigurationSorter.AutoConfigurationClass#getOrder`,代ç �如下: ``` private int getOrder() { - // ÅÐ¶Ï META-INF/spring-autoconfigure-metadata.properties ÎļþÖÐÊÇ·ñ´æÔÚµ±Ç° className + // 判断 META-INF/spring-autoconfigure-metadata.properties 文件中是å�¦å­˜åœ¨å½“å‰� className if (wasProcessed()) { - // Èç¹û´æÔÚ£¬¾ÍʹÓÃÎļþÖÐÖ¸¶¨µÄ˳Ðò£¬·ñÔò¾ÍʹÓÃĬÈÏ˳Ðò + // 如果存在,就使用文件中指定的顺åº�,å�¦åˆ™å°±ä½¿ç”¨é»˜è®¤é¡ºåº� return this.autoConfigurationMetadata.getInteger(this.className, "AutoConfigureOrder", AutoConfigureOrder.DEFAULT_ORDER); } - // ´¦Àí²»´æÔÚµÄÇé¿ö£º»ñÈ¡ @AutoConfigureOrder ×¢½âÖ¸¶¨µÄ˳Ðò + // 处ç�†ä¸�存在的情况:获å�– @AutoConfigureOrder 注解指定的顺åº� Map attributes = getAnnotationMetadata() .getAnnotationAttributes(AutoConfigureOrder.class.getName()); - // Èç¹û @AutoConfigureOrder δÅäÖ㬾ÍʹÓÃĬÈÏ˳Ðò + // 如果 @AutoConfigureOrder 未é…�置,就使用默认顺åº� return (attributes != null) ? (Integer) attributes.get("value") : AutoConfigureOrder.DEFAULT_ORDER; } ``` -Õâ¸ö·½·¨»¹ÊDZȽϼòµ¥µÄ£¬¾ÍÊÇ»ñÈ¡ `@AutoConfigureOrder` ×¢½âÖ¸¶¨µÄ˳Ðò£¬Èç¹ûûÓÐ `@AutoConfigureOrder` ×¢½â£¬¾ÍʹÓÃĬÈÏ˳Ðò£¬Ä¬ÈÏ˳Ðò `AutoConfigureOrder.DEFAULT_ORDER` µÄֵΪ 0¡£ +这个方法还是比较简å�•的,就是获å�– `@AutoConfigureOrder` 注解指定的顺åº�,如果没有 `@AutoConfigureOrder` 注解,就使用默认顺åº�,默认顺åº� `AutoConfigureOrder.DEFAULT_ORDER` 的值为 0。 -### 6\. ʹÓà `@AutoConfigureBefore`£¬`@AutoConfigureAfter` ÅÅÐò +### 6\. 使用 `@AutoConfigureBefore`,`@AutoConfigureAfter` 排åº� -½ÓÏÂÀ´¾ÍÊÇ×¶¯ÈËÐÄµÄ `@AutoConfigureBefore` Óë `@AutoConfigureAfter` ×¢½âµÄÅÅÐòÁË£¬¶ÔÓ¦µÄ·½·¨Îª `AutoConfigurationSorter#sortByAnnotation`£¬´úÂëÈçÏ£º +接下æ�¥å°±æ˜¯æœ€æ¿€åŠ¨äººå¿ƒçš„ `@AutoConfigureBefore` 与 `@AutoConfigureAfter` 注解的排åº�了,对应的方法为 `AutoConfigurationSorter#sortByAnnotation`,代ç �如下: ``` /** - * ½øÐÐÅÅÐò£¬ - * ʵ¼ÊÉÏÕâ¸ö·½·¨ÀïÖ»ÊÇ×¼±¸ÁËһЩÊý¾Ý£¬ÕæÕý¸É»îµÄÊÇ doSortByAfterAnnotation(...) + * 进行排åº�, + * 实际上这个方法里å�ªæ˜¯å‡†å¤‡äº†ä¸€äº›æ•°æ�®ï¼ŒçœŸæ­£å¹²æ´»çš„æ˜¯ doSortByAfterAnnotation(...) */ private List sortByAnnotation(AutoConfigurationClasses classes, List classNames) { - // ÐèÒªÅÅÐòµÄ className + // 需è¦�排åº�çš„ className List toSort = new ArrayList<>(classNames); toSort.addAll(classes.getAllNames()); - // ÅÅÐòºÃµÄ className + // 排åº�好的 className Set sorted = new LinkedHashSet<>(); - // ÕýÔÚÅÅÐòÖÐµÄ className + // 正在排åº�中的 className Set processing = new LinkedHashSet<>(); while (!toSort.isEmpty()) { - // ÕæÕý´¦ÀíÅÅÐòµÄ·½·¨ + // 真正处ç�†æŽ’åº�的方法 doSortByAfterAnnotation(classes, toSort, sorted, processing, null); } - // ´æÔÚÓÚ¼¯ºÏ sorted ÖУ¬µ«²»´æÔÚÓÚ classNames ÖеÄÔªËØ½«»á±»ÒƳý + // 存在于集å�ˆ sorted 中,但ä¸�存在于 classNames 中的元素将会被移除 sorted.retainAll(classNames); return new ArrayList<>(sorted); } /** - * ¾ßÌå½øÐÐÅÅÐòµÄ·½·¨ + * 具体进行排åº�的方法 */ private void doSortByAfterAnnotation(AutoConfigurationClasses classes, List toSort, Set sorted, Set processing, String current) { if (current == null) { current = toSort.remove(0); } - // ʹÓà processing À´ÅжÏÊÇ·ñ´æÔÚÑ­»·±È½Ï£¬±ÈÈ磬ÀàA after ÀàB£¬¶ø ÀàB ÓÖ after ÀàA + // 使用 processing æ�¥åˆ¤æ–­æ˜¯å�¦å­˜åœ¨å¾ªçŽ¯æ¯”è¾ƒï¼Œæ¯”å¦‚ï¼Œç±»A after ç±»B,而 ç±»B å�ˆ after ç±»A processing.add(current); - // classes.getClassesRequestedAfter£ºµ±Ç° className ÐèÒªÔÚÄÄЩ className Ö®ºóÖ´ÐÐ + // classes.getClassesRequestedAfter:当å‰� className 需è¦�在哪些 className 之å�Žæ‰§è¡Œ for (String after : classes.getClassesRequestedAfter(current)) { Assert.state(!processing.contains(after), "AutoConfigure cycle detected between " + current + " and " + after); if (!sorted.contains(after) && toSort.contains(after)) { - // µÝ¹éµ÷Óà + // 递归调用 doSortByAfterAnnotation(classes, toSort, sorted, processing, after); } } processing.remove(current); - // Ìí¼Óµ½ÒÑÅÅÐò½á¹ûÖÐ + // 添加到已排åº�结果中 sorted.add(current); } ``` -`AutoConfigurationSorter#sortByAnnotation` ÌṩÁ˱£´æÊý¾ÝµÄ½á¹¹£¬¶ø `AutoConfigurationSorter#doSortByAfterAnnotation` ²ÅÊÇÕæÕý´¦ÀíÅÅÐòµÄ·½·¨£¬ÅÅÐò²Ù×÷²»Ì«ºÃ¶®£¬´óÖÂÁ÷³ÌÈçÏ£º +`AutoConfigurationSorter#sortByAnnotation` æ��供了ä¿�存数æ�®çš„结构,而 `AutoConfigurationSorter#doSortByAfterAnnotation` æ‰�是真正处ç�†æŽ’åº�的方法,排åº�æ“�作ä¸�太好懂,大致æµ�程如下: -1. ²éÕÒµ±Ç° `className` ÐèÒªÔÚÄÄЩ `className` Ö®ºó×°Å䣬½«Æä±£´æÎª `afterClasses`£¬Ò²¾ÍÊÇ˵£¬`afterClasses` ÖеÄÿһ¸ö `className` ¶¼ÒªÔÚµ±Ç° `className` ֮ǰװÅ䣻 +1. 查找当å‰� `className` 需è¦�在哪些 `className` 之å�Žè£…é…�,将其ä¿�存为 `afterClasses`,也就是说,`afterClasses` 中的æ¯�一个 `className` 都è¦�在当å‰� `className` 之å‰�装é…�ï¼› -2. ±éÀú `afterClasses`£¬¶ÔÆäÖÐÿһ¸ö `className`£¬¼ÌÐø²éÕÒÆä `afterClasses`£¬ÕâÑùµÝ¹éÏÂÈ¥£¬²»¿¼ÂÇÑ­»·±È½ÏµÄÇé¿öÏ£¬×îÖÕ±ØÈ»»á´æÔÚÒ»¸ö `className`£¬ËüµÄ `afterClasses` Ϊ¿Õ£¬ÕâÀï¾Í°Ñ `className` ¼ÓÈëµ½ÒÑÍê³ÉÅÅÐòµÄ½á¹¹ÖС£ +2. é��历 `afterClasses`,对其中æ¯�一个 `className`,继续查找其 `afterClasses`,这样递归下去,ä¸�考虑循环比较的情况下,最终必然会存在一个 `className`,它的 `afterClasses` 为空,这里就把 `className` 加入到已完æˆ�排åº�的结构中。 -ÎÒÃÇÔÙÀ´¿´¿´»ñÈ¡ `afterClasses` µÄ²Ù×÷£¬·½·¨Îª `AutoConfigurationSorter.AutoConfigurationClasses#getClassesRequestedAfter`£¬´úÂëÈçÏ£º +我们å†�æ�¥çœ‹çœ‹èŽ·å�– `afterClasses` çš„æ“�作,方法为 `AutoConfigurationSorter.AutoConfigurationClasses#getClassesRequestedAfter`,代ç �如下: ``` Set getClassesRequestedAfter(String className) { - // µ±Ç°Àࣺ»ñÈ¡ÔÚÄÄЩÀàÖ®ºóÖ´ÐУ¬¾ÍÊÇ»ñÈ¡ @AutoConfigureAfter ×¢½âÖ¸¶¨µÄÀà + // 当å‰�类:获å�–在哪些类之å�Žæ‰§è¡Œï¼Œå°±æ˜¯èŽ·å�– @AutoConfigureAfter 注解指定的类 Set classesRequestedAfter = new LinkedHashSet<>(get(className).getAfter()); - // ÆäËûÀࣺÐèҪǰÖÃÖ´ÐеÄÀàÖÐ + // 其他类:需è¦�å‰�置执行的类中 this.classes.forEach((name, autoConfigurationClass) -> { if (autoConfigurationClass.getBefore().contains(className)) { classesRequestedAfter.add(name); @@ -535,34 +535,34 @@ Set getClassesRequestedAfter(String className) { ``` -´Ó´úÂëÀ´µÄÀ´¿´£¬Õâ¸ö `afterClasses` °üº¬Á½¸öÄÚÈÝ£º +从代ç �æ�¥çš„æ�¥çœ‹ï¼Œè¿™ä¸ª `afterClasses` 包å�«ä¸¤ä¸ªå†…容: -* »ñÈ¡ÔÚÄÄЩÀà×°ÅäÍê³ÉÖ®ºó×°Å䣬¾ÍÊÇ»ñÈ¡ `@AutoConfigureAfter` ×¢½âÖ¸¶¨µÄÀà -* »ñÈ¡ÄÄЩÀàÐèÒªÔÚµ±Ç°Àà×°Åä֮ǰ½øÐÐ×°Åä +* 获å�–在哪些类装é…�完æˆ�之å�Žè£…é…�,就是获å�– `@AutoConfigureAfter` 注解指定的类 +* 获å�–哪些类需è¦�在当å‰�类装é…�之å‰�进行装é…� -### 7\. ÔÙÀ´¿´£º`@ConditionalOnBean/@ConditionalOnMissingBean` +### 7\. å†�æ�¥çœ‹ï¼š`@ConditionalOnBean/@ConditionalOnMissingBean` -Ç°ÃæÌáµ½ÁË `@ConditionalOnBean/@ConditionalOnMissingBean` µÄ¿Ó£¬Á˽âÍê×Ô¶¯×°ÅäµÄ˳Ðòºó£¬¾ÍÄܺܺùæ±ÜÕâЩ¿ÓÁË£º +å‰�é�¢æ��到了 `@ConditionalOnBean/@ConditionalOnMissingBean` çš„å�‘,了解完自动装é…�的顺åº�å�Žï¼Œå°±èƒ½å¾ˆå¥½è§„é�¿è¿™äº›å�‘了: -1. Á½¸ö `bean` ¶¼ÊÇ×Ô¶¯×°ÅäÀࣺ±Ü¿Ó·½Ê½ÊÇ£¬Ê¹Óà `@AutoConfigureBefore` / `@AutoConfigureAfter` »ò `@AutoConfigureOrder` Ö¸¶¨Ìõ¼þ˳Ðò£¬±£Ö¤Ìõ¼þ×¢½âÖÐµÄ `bean` ÏÈ×°Åä¼´¿É£» -2. Ò»¸öÊÇÆÕͨ `spring bean`£¬Ò»¸öÊÇ×Ô¶¯×°ÅäÀࣺÈç¹ûÌõ¼þ×¢½âÖÐµÄ `bean` ÊÇÆÕͨ spring bean£¬ÁíÒ»¸öÊÇ×Ô¶¯×°ÅäÀ࣬ÕâÖÖÇé¿öϲ»Óô¦Àí£¬×Ô¶¯×°ÅäµÄ´¦ÀíÀàÊÇ `DeferredImportSelector` µÄ×ÓÀ࣬ÏÈÌì¾ö¶¨×Ô¶¯×°ÅäÀàÔÚÆÕͨ `spring bean` Ö®ºó´¦Àí£»·´Ö® £¬Ìõ¼þ×¢½âÖÐµÄ `bean` ÊÇ×Ô¶¯×°ÅäÀ࣬ÁíÒ»¸öÊÇÆÕͨ `spring bean`£¬ÕâÖÖÒ»¶¨»á³ö´í£¬²»ÒªÊ¹Óã» -3. Á½¸ö¶¼ÊÇÆÕͨ `spring bean`£ºÎޱܿӷ½·¨£¬`spring bean` ×¢²áµ½ `beanFactory` µÄ˳Ðò²»¿É¿Ø£¬²»½¨ÒéÔÚÕâÖÖÇé¿öÏÂʹÓã» +1. 两个 `bean` 都是自动装é…�类:é�¿å�‘æ–¹å¼�是,使用 `@AutoConfigureBefore` / `@AutoConfigureAfter` 或 `@AutoConfigureOrder` 指定æ�¡ä»¶é¡ºåº�,ä¿�è¯�æ�¡ä»¶æ³¨è§£ä¸­çš„ `bean` 先装é…�å�³å�¯ï¼› +2. 一个是普通 `spring bean`,一个是自动装é…�类:如果æ�¡ä»¶æ³¨è§£ä¸­çš„ `bean` 是普通 spring bean,å�¦ä¸€ä¸ªæ˜¯è‡ªåŠ¨è£…é…�类,这ç§�情况下ä¸�用处ç�†ï¼Œè‡ªåŠ¨è£…é…�的处ç�†ç±»æ˜¯ `DeferredImportSelector` çš„å­�类,先天决定自动装é…�类在普通 `spring bean` 之å�Žå¤„ç�†ï¼›å��之 ,æ�¡ä»¶æ³¨è§£ä¸­çš„ `bean` 是自动装é…�类,å�¦ä¸€ä¸ªæ˜¯æ™®é€š `spring bean`,这ç§�一定会出错,ä¸�è¦�使用; +3. 两个都是普通 `spring bean`:无é�¿å�‘方法,`spring bean` 注册到 `beanFactory` 的顺åº�ä¸�å�¯æŽ§ï¼Œä¸�建议在这ç§�情况下使用; -### 8\. ×ܽá +### 8\. 总结 -±¾ÎÄ×ܽáÁË×Ô¶¯×°ÅäÀàµÄ×°Åä˳Ðò£¬Ö÷Òª½éÉÜÁËÈçÏÂÄÚÈÝ£º +本文总结了自动装é…�类的装é…�顺åº�,主è¦�介ç»�了如下内容: -1. ¶Ô×Ô¶¯×°ÅäÀàÅÅÐò£º`AutoConfigurationImportSelector.AutoConfigurationGroup#sortAutoConfigurations` -2. Ö¸¶¨×Ô¶¯×°ÅäÀàµÄ×°Åä˳Ðò£ºÊ¹Óà `@AutoConfigureBefore` / `@AutoConfigureAfter` »ò `@AutoConfigureOrder` -3. ÅÅÐò·½Ê½ÓÐÈýÖÖ£¬ÒÀ´ÎÊÇ£º - 1. °´ className ÅÅÐò£¬ÓÉ `String` ÌṩÅÅÐò¹æÔò - 2. ¸ù¾Ý `@AutoConfigureOrder` Ö¸¶¨µÄÖµ½øÐÐÅÅÐò£¬ÓÉ `Integer` ÌṩÅÅÐò¹æÔò - 3. ¸ù¾Ý `@AutoConfigureBefore` / `@AutoConfigureAfter` ½øÐÐÅÅÐò ÐèҪעÒâµÄÊÇ£¬ÒÔÉÏÈýÖÖÅÅÐò·½Ê½ÏȺó½øÐУ¬ÒÔ×îºóÅÅÐòÍêµÄ½á¹ûΪ×îÖÕ˳Ðò -4. ¹ØÓÚ `@ConditionalOnBean/@ConditionalOnMissingBean` ±Ü¿ÓÖ¸ÄÏ£º - 1. Á½¸ö `bean` ¶¼ÊÇ×Ô¶¯×°ÅäÀࣺ±Ü¿Ó·½Ê½ÊÇ£¬Ê¹Óà `@AutoConfigureBefore` / `@AutoConfigureAfter` »ò `@AutoConfigureOrder` Ö¸¶¨Ìõ¼þ˳Ðò£¬±£Ö¤Ìõ¼þ×¢½âÖÐµÄ `bean` ÏÈ×°Åä¼´¿É£» - 2. Ò»¸öÊÇÆÕͨ `spring bean`£¬Ò»¸öÊÇ×Ô¶¯×°ÅäÀࣺÌõ¼þ×¢½âÖÐµÄ `bean` ±ØÐëΪÆÕͨµÄ `spring bean`£» - 3. ÆäËûÇé¿ö²»¿É¿Ø£¬²»½¨ÒéʹÓᣠ+1. 对自动装é…�类排åº�:`AutoConfigurationImportSelector.AutoConfigurationGroup#sortAutoConfigurations` +2. 指定自动装é…�类的装é…�顺åº�:使用 `@AutoConfigureBefore` / `@AutoConfigureAfter` 或 `@AutoConfigureOrder` +3. 排åº�æ–¹å¼�有三ç§�,ä¾�次是: + 1. 按 className 排åº�,由 `String` æ��供排åº�规则 + 2. æ ¹æ�® `@AutoConfigureOrder` 指定的值进行排åº�,由 `Integer` æ��供排åº�规则 + 3. æ ¹æ�® `@AutoConfigureBefore` / `@AutoConfigureAfter` 进行排åº� 需è¦�注æ„�的是,以上三ç§�排åº�æ–¹å¼�å…ˆå�Žè¿›è¡Œï¼Œä»¥æœ€å�޿ޒåº�完的结果为最终顺åº� +4. 关于 `@ConditionalOnBean/@ConditionalOnMissingBean` é�¿å�‘指å�—: + 1. 两个 `bean` 都是自动装é…�类:é�¿å�‘æ–¹å¼�是,使用 `@AutoConfigureBefore` / `@AutoConfigureAfter` 或 `@AutoConfigureOrder` 指定æ�¡ä»¶é¡ºåº�,ä¿�è¯�æ�¡ä»¶æ³¨è§£ä¸­çš„ `bean` 先装é…�å�³å�¯ï¼› + 2. 一个是普通 `spring bean`,一个是自动装é…�类:æ�¡ä»¶æ³¨è§£ä¸­çš„ `bean` 必须为普通的 `spring bean`ï¼› + 3. 其他情况ä¸�å�¯æŽ§ï¼Œä¸�建议使用。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4921594](https://my.oschina.net/funcy/blog/4921594) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4921594](https://my.oschina.net/funcy/blog/4921594) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\272\214\357\274\211\357\274\232\346\235\241\344\273\266\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\272\214\357\274\211\357\274\232\346\235\241\344\273\266\346\263\250\350\247\243.md" index 31d27a9..ce9f3da 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\272\214\357\274\211\357\274\232\346\235\241\344\273\266\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot\346\272\220\347\240\201\350\247\243\346\236\220/SpringBoot\350\207\252\345\212\250\350\243\205\351\205\215\357\274\210\344\272\214\357\274\211\357\274\232\346\235\241\344\273\266\346\263\250\350\247\243.md" @@ -1,23 +1,23 @@ -### 1\. Ìõ¼þ×¢½â¼°ÆäÅжÏÀà +### 1\. æ�¡ä»¶æ³¨è§£å�Šå…¶åˆ¤æ–­ç±» -ÔÚ [springboot ×Ô¶¯×°ÅäÖ®¼ÓÔØ×Ô¶¯×°ÅäÀà](https://my.oschina.net/funcy/blog/4870868)Ò»ÎÄÖУ¬ÎÒÃÇ·ÖÎöµ½ springboot »á¼ÓÔØ `META-INF/spring.factories` ÎļþÖж¨ÒåµÄ×Ô¶¯×°ÅäÀ࣬¼ÓÔØµ½ÕâЩ×Ô¶¯×°ÅäÀàºó£¬ÕâЩÀàÖÐµÄ bean ¾ÍÒ»¶¨»á³õʼ»¯Â𣿲¢²»ÊÇ£¬ÎÒÃÇ¿ÉÒÔÔÚ¶ÔÓ¦µÄ Bean Éú³É·½·¨ÉÏʹÓÃ**Ìõ¼þ×¢½â**À´¿ØÖÆÀàÊÇ·ñ½øÐгõʼ»¯£¡ +在 [springboot 自动装é…�之加载自动装é…�ç±»](https://my.oschina.net/funcy/blog/4870868)一文中,我们分æž�到 springboot 会加载 `META-INF/spring.factories` 文件中定义的自动装é…�类,加载到这些自动装é…�ç±»å�Žï¼Œè¿™äº›ç±»ä¸­çš„ bean 就一定会åˆ�始化å�—?并ä¸�是,我们å�¯ä»¥åœ¨å¯¹åº”çš„ Bean 生æˆ�方法上使用**æ�¡ä»¶æ³¨è§£**æ�¥æŽ§åˆ¶ç±»æ˜¯å�¦è¿›è¡Œåˆ�始化ï¼� -springboot ÌṩµÄÌõ¼þ×¢½âÈçÏ£º +springboot æ��供的æ�¡ä»¶æ³¨è§£å¦‚下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0e8d27c887fb6ca142672cad1c60e9de207.png) -ÕâÀïÁоٲ¿·ÖÈçÏ£º +这里列举部分如下: -| ×¢½âÀàÐÍ | ×¢½âÀàÐÍ | ¹¦ÄÜ˵Ã÷ | +| 注解类型 | 注解类型 | 功能说明 | | --------------------- | ------------------------------------------------------------ | --------------------------------------------- | -| class Ìõ¼þ×¢½â | `@ConditionalOnClass`/`@ConditionalOnMissingClass` | µ±Ö¸¶¨µÄÀà**´æÔÚ / ȱʧ**ʱ³õʼ»¯¸Ã bean | -| bean Ìõ¼þ×¢½â | `@ConditionalOnBean`/`@ConditionalOnMissingBean` | µ±Ö¸¶¨µÄ bean **´æÔÚ / ȱʧ**ʱ³õʼ»¯¸Ã bean | -| ÊôÐÔÌõ¼þ×¢½â | `@ConditionalOnProperty` | µ±Ö¸¶¨µÄÊôÐÔ´æÔÚ³õʼ»¯¸Ã bean | -| Resource Ìõ¼þ×¢½â | `@ConditionalOnResource` | µ±Ö¸¶¨µÄ×ÊÔ´´æÔÚ³õʼ»¯¸Ã bean | -| Web Ó¦ÓÃÌõ¼þ×¢½â | `@ConditionalOnWebApplication` / `@ConditionalOnNotWebApplication` | µ±Ç°Ó¦ÓÃ**Ϊ / ²»Îª** web Ó¦ÓÃʱ³õʼ»¯¸Ã bean | -| spring ±í´ïʽÌõ¼þ×¢½â | `@ConditionalOnExpression` | µ±±í´ïʽ½á¹ûΪ true ʱ³õʼ»¯¸Ã bean | +| class æ�¡ä»¶æ³¨è§£ | `@ConditionalOnClass`/`@ConditionalOnMissingClass` | 当指定的类**存在 / 缺失**æ—¶åˆ�始化该 bean | +| bean æ�¡ä»¶æ³¨è§£ | `@ConditionalOnBean`/`@ConditionalOnMissingBean` | 当指定的 bean **存在 / 缺失**æ—¶åˆ�始化该 bean | +| 属性æ�¡ä»¶æ³¨è§£ | `@ConditionalOnProperty` | 当指定的属性存在åˆ�始化该 bean | +| Resource æ�¡ä»¶æ³¨è§£ | `@ConditionalOnResource` | 当指定的资æº�存在åˆ�始化该 bean | +| Web 应用æ�¡ä»¶æ³¨è§£ | `@ConditionalOnWebApplication` / `@ConditionalOnNotWebApplication` | 当å‰�应用**为 / ä¸�为** web 应用时åˆ�始化该 bean | +| spring 表达å¼�æ�¡ä»¶æ³¨è§£ | `@ConditionalOnExpression` | 当表达å¼�结果为 true æ—¶åˆ�始化该 bean | -ÎÒÃǽøÈë `@ConditionalOnClass` ¿´¿´¸Ã×¢½âµÄÄÚÈÝ£º +我们进入 `@ConditionalOnClass` 看看该注解的内容: ``` ... @@ -28,20 +28,20 @@ public @interface ConditionalOnClass { ``` -¿ÉÒÔ¿´µ½£¬`ConditionalOnClass` ×éºÏÁË `@Conditional` ×¢½âµÄ¹¦ÄÜ£¬´¦ÀíÀàÊÇ `OnClassCondition.class`¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`ConditionalOnClass` 组å�ˆäº† `@Conditional` 注解的功能,处ç�†ç±»æ˜¯ `OnClassCondition.class`。 -¹ØÓÚ `@Conditional` ×¢½â¿ÉÒԲο¼ [ConfigurationClassPostProcessor Ö®´¦Àí @Conditional ×¢½â](https://my.oschina.net/funcy/blog/4873444)£¬ÕâÀïÎÒÃÇÖ±½Ó˵ `@Conditional` µÄʹÓ÷½Ê½£º +关于 `@Conditional` 注解å�¯ä»¥å�‚考 [ConfigurationClassPostProcessor 之处ç�† @Conditional 注解](https://my.oschina.net/funcy/blog/4873444),这里我们直接说 `@Conditional` 的使用方å¼�: -1. `@Conditional` ÊÇ spring ´¦ÀíµÄÌõ¼þ×¢½â£» +1. `@Conditional` 是 spring 处ç�†çš„æ�¡ä»¶æ³¨è§£ï¼› -2. `@Conditional` ÌṩÁËÒ»¸öÊôÐÔ `value`£¬ÀàÐÍΪ `Class`£¬Æä±ØÐëÊÇ `Condition` µÄ×ÓÀࣺ +2. `@Conditional` æ��供了一个属性 `value`,类型为 `Class`,其必须是 `Condition` çš„å­�类: ``` Class[] value(); ``` -3. `Condition` ÊÇÒ»¸ö½Ó¿Ú£¬ÆäÖÐÓÐÒ»¸ö `matches(...)` ·½·¨£º +3. `Condition` 是一个接å�£ï¼Œå…¶ä¸­æœ‰ä¸€ä¸ª `matches(...)` 方法: ``` public interface Condition { @@ -52,24 +52,24 @@ public @interface ConditionalOnClass { ``` - Ö»ÓÐÔÚ `matches(...)` ·½·¨·µ»Ø `true` ʱ£¬`ConfigurationClassPostProcessor` ²Å»á½«Æä¶ÔÓ¦µÄ bean ×¢²áµ½ `beanFactory` µÄ `beanDefinitionMap` ÖÐ. + å�ªæœ‰åœ¨ `matches(...)` 方法返回 `true` 时,`ConfigurationClassPostProcessor` æ‰�会将其对应的 bean 注册到 `beanFactory` çš„ `beanDefinitionMap` 中. -×ܽáÍê `@Conditional` µÄʹÓ÷½Ê½ºó£¬ÎÒÃǾÍÃ÷°×ÁË£º`OnClassCondition.class` ÊÇ `Condition` µÄ×ÓÀ࣬Æä `matches(...)` ·½·¨ÓÃÀ´´¦ÀíÖ÷ÒªÌõ¼þ¹æÔò¡£Í¬Àí£¬ÆäËûÌõ¼þ×¢½âµÄ´¦Àí·½Ê½Ò²ÀàËÆ£¬ÕâÀï×ܽáÏÂÌõ¼þ×¢½âµÄÅжÏÀࣺ +总结完 `@Conditional` 的使用方å¼�å�Žï¼Œæˆ‘们就明白了:`OnClassCondition.class` 是 `Condition` çš„å­�类,其 `matches(...)` 方法用æ�¥å¤„ç�†ä¸»è¦�æ�¡ä»¶è§„则。å�Œç�†ï¼Œå…¶ä»–æ�¡ä»¶æ³¨è§£çš„处ç�†æ–¹å¼�也类似,这里总结下æ�¡ä»¶æ³¨è§£çš„判断类: -| ×¢½âÀàÐÍ | ×¢½âÀàÐÍ | Ìõ¼þÅжÏÀà | +| 注解类型 | 注解类型 | æ�¡ä»¶åˆ¤æ–­ç±» | | --------------------- | ------------------------------------------------------------ | --------------------------- | -| class Ìõ¼þ×¢½â | `@ConditionalOnClass`/`@ConditionalOnMissingClass` | `OnClassCondition` | -| bean Ìõ¼þ×¢½â | `@ConditionalOnBean`/`@ConditionalOnMissingBean` | `OnBeanCondition` | -| ÊôÐÔÌõ¼þ×¢½â | `@ConditionalOnProperty` | `OnPropertyCondition` | -| Resource Ìõ¼þ×¢½â | `@ConditionalOnResource` | `OnResourceCondition` | -| Web Ó¦ÓÃÌõ¼þ×¢½â | `@ConditionalOnWebApplication` / `@ConditionalOnNotWebApplication` | `OnWebApplicationCondition` | -| spring ±í´ïʽÌõ¼þ×¢½â | `@ConditionalOnExpression` | `OnExpressionCondition` | +| class æ�¡ä»¶æ³¨è§£ | `@ConditionalOnClass`/`@ConditionalOnMissingClass` | `OnClassCondition` | +| bean æ�¡ä»¶æ³¨è§£ | `@ConditionalOnBean`/`@ConditionalOnMissingBean` | `OnBeanCondition` | +| 属性æ�¡ä»¶æ³¨è§£ | `@ConditionalOnProperty` | `OnPropertyCondition` | +| Resource æ�¡ä»¶æ³¨è§£ | `@ConditionalOnResource` | `OnResourceCondition` | +| Web 应用æ�¡ä»¶æ³¨è§£ | `@ConditionalOnWebApplication` / `@ConditionalOnNotWebApplication` | `OnWebApplicationCondition` | +| spring 表达å¼�æ�¡ä»¶æ³¨è§£ | `@ConditionalOnExpression` | `OnExpressionCondition` | -½ÓÏÂÀ´£¬·ÖÎöÄ¿µÄ¾ÍºÜÃ÷È·ÁË£ºÒª·ÖÎöÕâЩÌõ¼þ×¢½âµÄÅжÏÂß¼­£¬Ö»ÐèÒª·ÖÎö¶ÔÓ¦Ìõ¼þÅжÏÀàµÄ `matches(...)` ·½·¨¾Í¿ÉÒÔÁË¡£ +接下æ�¥ï¼Œåˆ†æž�目的就很明确了:è¦�分æž�这些æ�¡ä»¶æ³¨è§£çš„判断逻辑,å�ªéœ€è¦�分æž�对应æ�¡ä»¶åˆ¤æ–­ç±»çš„ `matches(...)` 方法就å�¯ä»¥äº†ã€‚ ### 2. `SpringBootCondition#matches` -½øÈë `OnClassCondition#matches` ·½·¨£¬·¢ÏÖÀ´µ½µÄÊÇ `SpringBootCondition`£¬Ïà¹Ø·½·¨ÈçÏ£º +进入 `OnClassCondition#matches` 方法,å�‘现æ�¥åˆ°çš„æ˜¯ `SpringBootCondition`,相关方法如下: ``` public abstract class SpringBootCondition implements Condition { @@ -80,13 +80,13 @@ public abstract class SpringBootCondition implements Condition { public final boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { String classOrMethodName = getClassOrMethodName(metadata); try { - // »ñÈ¡Ìõ¼þÆ¥Åä½á¹û + // 获å�–æ�¡ä»¶åŒ¹é…�结果 ConditionOutcome outcome = getMatchOutcome(context, metadata); - // ´òÓ¡Ò»ÌõÈÕÖ¾ + // 打å�°ä¸€æ�¡æ—¥å¿— logOutcome(classOrMethodName, outcome); - // ¼Ç¼Ìõ¼þÆÀ¹ÀµÄ·¢Éú£¬¼òµ¥Àí½âΪ¼Ç¼һÌõÌõ¼þÅжϼǼ°É + // 记录æ�¡ä»¶è¯„ä¼°çš„å�‘生,简å�•ç�†è§£ä¸ºè®°å½•一æ�¡æ�¡ä»¶åˆ¤æ–­è®°å½•å�§ recordEvaluation(context, classOrMethodName, outcome); - // ÕâÀï·µ»Ø×îÖÕ½á¹û£ºtrue »ò false + // 这里返回最终结果:true 或 false return outcome.isMatch(); } catch (NoClassDefFoundError ex) { @@ -98,7 +98,7 @@ public abstract class SpringBootCondition implements Condition { } /** - * ÕâÊǸö³éÏó·½Ê½£¬¾ßÌåÄÚÈÝÓÉ×ÓÀàʵÏÖ + * 这是个抽象方å¼�,具体内容由å­�类实现 */ public abstract ConditionOutcome getMatchOutcome( ConditionContext context, AnnotatedTypeMetadata metadata); @@ -109,7 +109,7 @@ public abstract class SpringBootCondition implements Condition { ``` -`SpringBootCondition` µÄ `matches(...)` ¹Ø¼ü¾ÍÁ½ÐУº +`SpringBootCondition` çš„ `matches(...)` 关键就两行: ``` ... @@ -119,9 +119,9 @@ return outcome.isMatch(); ``` -¶ø `SpringBootCondition` µÄ `getMatchOutcome(...)` ÓÖÊǸö³éÏó·½·¨£¬¾ßÌåµÄÂß¼­ÓÉ×ÓÀàÌṩ£¬`OnClassCondition` ËüµÄʵÏÖÖ®Ò»¡£Êµ¼ÊÉÏ£¬ÉÏÊöÌõ¼þÅжÏÀà¶¼ÊÇ `SpringBootCondition` µÄ×ÓÀ࣬ºóÃæÎÒÃǾÍÖ±½Ó½øÈë¾ßÌåÀàµÄ `getMatchOutcome(...)` ·½·¨·ÖÎöÁË¡£ +而 `SpringBootCondition` çš„ `getMatchOutcome(...)` å�ˆæ˜¯ä¸ªæŠ½è±¡æ–¹æ³•,具体的逻辑由å­�ç±»æ��供,`OnClassCondition` 它的实现之一。实际上,上述æ�¡ä»¶åˆ¤æ–­ç±»éƒ½æ˜¯ `SpringBootCondition` çš„å­�类,å�Žé�¢æˆ‘们就直接进入具体类的 `getMatchOutcome(...)` 方法分æž�了。 -`getMatchOutcome(...)` ·½·¨·µ»ØµÄ½á¹ûÊÇ `ConditionOutcome`£¬½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `ConditionOutcome` ÊǸöɶ£º +`getMatchOutcome(...)` 方法返回的结果是 `ConditionOutcome`,接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `ConditionOutcome` 是个啥: ``` public class ConditionOutcome { @@ -131,14 +131,14 @@ public class ConditionOutcome { private final ConditionMessage message; /** - * ¹¹Ôì·½·¨ + * 构造方法 */ public ConditionOutcome(boolean match, String message) { this(match, ConditionMessage.of(message)); } /** - * ¹¹Ôì·½·¨ + * 构造方法 */ public ConditionOutcome(boolean match, ConditionMessage message) { Assert.notNull(message, "ConditionMessage must not be null"); @@ -147,7 +147,7 @@ public class ConditionOutcome { } /** - * ·µ»ØÆ¥ÅäµÄ½á¹û + * 返回匹é…�的结果 */ public boolean isMatch() { return this.match; @@ -158,12 +158,12 @@ public class ConditionOutcome { ``` -´Ó´úÂëÀ´¿´£¬Õâ¸öÀà¾ÍÊÇÓÃÀ´·â×°±È½Ï½á¹ûµÄ£¬ÄÚ²¿ÓÐÁ½¸öÊôÐÔ£º`match` Óë `message`: +从代ç �æ�¥çœ‹ï¼Œè¿™ä¸ªç±»å°±æ˜¯ç”¨æ�¥å°�装比较结果的,内部有两个属性:`match` 与 `message`: -* `match` µÄÀàÐÍÊÇ `boolean`£¬Õâ¸ö¾ÍÊÇ×îÖÕÆ¥Åä³É¹¦»¹ÊÇʧ°ÜµÄ±êʶ -* `message` µÄÀàÐÍÊÇ `ConditionMessage`£¬Ëü±íʾƥÅä½á¹ûµÄ˵Ã÷ +* `match` 的类型是 `boolean`,这个就是最终匹é…�æˆ�功还是失败的标识 +* `message` 的类型是 `ConditionMessage`,它表示匹é…�结果的说明 -ÎÒÃÇÔÙÀ´¿´¿´ `ConditionMessage`: +我们å†�æ�¥çœ‹çœ‹ `ConditionMessage`: ``` public final class ConditionMessage { @@ -183,23 +183,23 @@ public final class ConditionMessage { ``` -Ëü½öÓÐÒ»¸öÊôÐÔ£º`message`£¬Õâ±íÃ÷Ëü¾ÍÊǶÔ˵Ã÷ÐÅÏ¢µÄ°ü×°¡£ +它仅有一个属性:`message`,这表明它就是对说明信æ�¯çš„包装。 ### 3. `@ConditionalOnClass`: `OnClassCondition#getMatchOutcome` -½ÓÏÂÀ´ÎÒÃÇÀ´·ÖÎö `OnClassCondition` µÄÆ¥ÅäÂß¼­£¬Ö±½Ó½øÈë `getMatchOutcome` ·½·¨£º +接下æ�¥æˆ‘们æ�¥åˆ†æž� `OnClassCondition` 的匹é…�逻辑,直接进入 `getMatchOutcome` 方法: ``` public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { ClassLoader classLoader = context.getClassLoader(); ConditionMessage matchMessage = ConditionMessage.empty(); - // 1\. ´¦Àí @ConditionalOnClass ×¢½â + // 1\. 处ç�† @ConditionalOnClass 注解 List onClasses = getCandidates(metadata, ConditionalOnClass.class); if (onClasses != null) { - // 1.1 ´¦ÀíÌõ¼þÅÐ¶Ï + // 1.1 处ç�†æ�¡ä»¶åˆ¤æ–­ List missing = filter(onClasses, ClassNameFilter.MISSING, classLoader); if (!missing.isEmpty()) { - // 1.2 ¹¹½¨·µ»Ø½á¹û£º²»Æ¥ÅäµÄÇé¿ö + // 1.2 构建返回结果:ä¸�匹é…�的情况 return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnClass.class) .didNotFind("required class", "required classes").items(Style.QUOTE, missing)); } @@ -208,13 +208,13 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM .items(Style.QUOTE, filter(onClasses, ClassNameFilter.PRESENT, classLoader)); } - // 2\. ´¦Àí @ConditionalOnMissingClass ×¢½â + // 2\. 处ç�† @ConditionalOnMissingClass 注解 List onMissingClasses = getCandidates(metadata, ConditionalOnMissingClass.class); if (onMissingClasses != null) { - // 2.1 ´¦ÀíÌõ¼þÅÐ¶Ï + // 2.1 处ç�†æ�¡ä»¶åˆ¤æ–­ List present = filter(onMissingClasses, ClassNameFilter.PRESENT, classLoader); if (!present.isEmpty()) { - // 2.2 ¹¹½¨·µ»Ø½á¹û£º²»Æ¥ÅäµÄÇé¿ö + // 2.2 构建返回结果:ä¸�匹é…�的情况 return ConditionOutcome.noMatch(ConditionMessage .forCondition(ConditionalOnMissingClass.class) .found("unwanted class", "unwanted classes").items(Style.QUOTE, present)); @@ -223,13 +223,13 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM .didNotFind("unwanted class", "unwanted classes") .items(Style.QUOTE, filter(onMissingClasses, ClassNameFilter.MISSING, classLoader)); } - // ×îºó·µ»ØÆ¥ÅäµÄ½á¹û + // 最å�Žè¿”回匹é…�的结果 return ConditionOutcome.match(matchMessage); } ``` -Õâ¸ö·½·¨Í¬Ê±´¦ÀíÁË `@ConditionalOnClass` Óë `@ConditionalOnMissingClass` Á½¸ö×¢½â£¬´¦ÀíÁ÷³Ì¼«ÆäÏàËÆ£¬Á½¸ö×¢½âµÄÌõ¼þÅж϶¼ÊÇͨ¹ý `FilteringSpringBootCondition#filter` ÄÚÈÝÈçÏ£º +这个方法å�Œæ—¶å¤„ç�†äº† `@ConditionalOnClass` 与 `@ConditionalOnMissingClass` 两个注解,处ç�†æµ�程æž�其相似,两个注解的æ�¡ä»¶åˆ¤æ–­éƒ½æ˜¯é€šè¿‡ `FilteringSpringBootCondition#filter` 内容如下: ``` protected final List filter(Collection classNames, ClassNameFilter classNameFilter, @@ -239,7 +239,7 @@ protected final List filter(Collection classNames, ClassNameFilt } List matches = new ArrayList<>(classNames.size()); for (String candidate : classNames) { - // ½øÐÐÌõ¼þÆ¥Åä + // 进行æ�¡ä»¶åŒ¹é…� if (classNameFilter.matches(candidate, classLoader)) { matches.add(candidate); } @@ -249,20 +249,20 @@ protected final List filter(Collection classNames, ClassNameFilt ``` -Óɴ˿ɼû£¬´«ÈëµÄ `classNameFilter` ³ÉÁ˹ؼü£º +由此å�¯è§�,传入的 `classNameFilter` æˆ�了关键: -* ´¦Àí `@ConditionalOnClass` ʱ£¬`classNameFilter` Ϊ `ClassNameFilter.MISSING` -* ´¦Àí `@ConditionalOnMissingClass` ʱ£¬`classNameFilter` Ϊ `ClassNameFilter.PRESENT` +* 处ç�† `@ConditionalOnClass` 时,`classNameFilter` 为 `ClassNameFilter.MISSING` +* 处ç�† `@ConditionalOnMissingClass` 时,`classNameFilter` 为 `ClassNameFilter.PRESENT` -ÈÃÎÒÃǽøÈë `ClassNameFilter` һ̽¾¿¾¹£¬ËüÊÇ `FilteringSpringBootCondition` µÄ×ÓÀ࣬ÄÚÈÝÈçÏ£º +让我们进入 `ClassNameFilter` 一探究竟,它是 `FilteringSpringBootCondition` çš„å­�类,内容如下: ``` abstract class FilteringSpringBootCondition extends SpringBootCondition implements AutoConfigurationImportFilter, BeanFactoryAware, BeanClassLoaderAware { ... /** - * Èç¹û classLoader ´æÔÚ£¬Ôòµ÷Óà ClassLoader#loadClass ·½·¨ - * ·ñÔòµ÷Óà Class#forName ·½·¨ + * 如果 classLoader 存在,则调用 ClassLoader#loadClass 方法 + * å�¦åˆ™è°ƒç”¨ Class#forName 方法 */ protected static Class resolve(String className, ClassLoader classLoader) throws ClassNotFoundException { @@ -273,7 +273,7 @@ abstract class FilteringSpringBootCondition extends SpringBootCondition } /** - * ´¦ÀíÌõ¼þÆ¥Åä + * 处ç�†æ�¡ä»¶åŒ¹é…� */ protected enum ClassNameFilter { @@ -298,15 +298,15 @@ abstract class FilteringSpringBootCondition extends SpringBootCondition abstract boolean matches(String className, ClassLoader classLoader); /** - * Class ÊÇ·ñ´æÔÚ - * ͨ¹ý²¶»ñÀà¼ÓÔØÊ±µÄÒì³£À´ÅжÏÀàÊÇ·ñ´æÔÚ£¬Î´Å׳öÒì³£Ôò±íʾÀà´æÔÚ + * Class 是å�¦å­˜åœ¨ + * 通过æ�•获类加载时的异常æ�¥åˆ¤æ–­ç±»æ˜¯å�¦å­˜åœ¨ï¼ŒæœªæŠ›å‡ºå¼‚常则表示类存在 */ static boolean isPresent(String className, ClassLoader classLoader) { if (classLoader == null) { classLoader = ClassUtils.getDefaultClassLoader(); } try { - // ͨ¹ýÒì³£²¶»ñÀ´ÅжÏÊÇ·ñ´æÔÚ¸Ãclass + // 通过异常æ�•获æ�¥åˆ¤æ–­æ˜¯å�¦å­˜åœ¨è¯¥class resolve(className, classLoader); return true; } @@ -320,25 +320,25 @@ abstract class FilteringSpringBootCondition extends SpringBootCondition ``` -¿´µ½ÕâÀïÎÒÃǾÍÃ÷°×ÁË£ºÅÐ¶Ï `Class` ÊÇ·ñ´æÔÚ£¬spring ÊÇͨ¹ý²¶»ñ `ClassLoader.load(String)` »ò `Class.forName(String)` ·½·¨µÄÒì³£À´´¦ÀíµÄ£¬Èç¹ûÅ׳öÁËÒì³£¾Í±íÃ÷ `Class` ²»´æÔÚ¡£ +看到这里我们就明白了:判断 `Class` 是å�¦å­˜åœ¨ï¼Œspring 是通过æ�•获 `ClassLoader.load(String)` 或 `Class.forName(String)` 方法的异常æ�¥å¤„ç�†çš„,如果抛出了异常就表明 `Class` ä¸�存在。 -ÕâÀï×ܽáÏ `@ConditionalOnClass`/`@ConditionalOnMissingClass` µÄ´¦Àí·½Ê½£º**Á½ÕߵĴ¦ÀíÀ඼Ϊ `OnClassCondition`£¬Í¨¹ý²¶»ñ `ClassLoader.load(String)` »ò `Class.forName(String)` ·½·¨µÄÒì³£À´ÅÐ¶Ï `Class` ÊÇ·ñ´æÔÚ£¬Èç¹ûÅ׳öÁËÒì³£¾Í±íÃ÷ `Class` ²»´æÔÚ**¡£ +这里总结下 `@ConditionalOnClass`/`@ConditionalOnMissingClass` 的处ç�†æ–¹å¼�:**两者的处ç�†ç±»éƒ½ä¸º `OnClassCondition`,通过æ�•获 `ClassLoader.load(String)` 或 `Class.forName(String)` 方法的异常æ�¥åˆ¤æ–­ `Class` 是å�¦å­˜åœ¨ï¼Œå¦‚果抛出了异常就表明 `Class` ä¸�存在**。 ### 4. `@ConditionalOnBean`: `OnBeanCondition#getMatchOutcome` -¼ÌÐø¿´¿´ `@ConditionalOnBean` µÄ ´¦Àí£¬Ö±½Ó½øÈë `OnBeanCondition#getMatchOutcome`£º +继续看看 `@ConditionalOnBean` çš„ 处ç�†ï¼Œç›´æŽ¥è¿›å…¥ `OnBeanCondition#getMatchOutcome`: ``` public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { ConditionMessage matchMessage = ConditionMessage.empty(); MergedAnnotations annotations = metadata.getAnnotations(); - // ´¦Àí @ConditionalOnBean + // 处ç�† @ConditionalOnBean if (annotations.isPresent(ConditionalOnBean.class)) { Spec spec = new Spec<>(context, metadata, annotations, ConditionalOnBean.class); - // ´¦ÀíÆ¥Åä + // 处ç�†åŒ¹é…� MatchResult matchResult = getMatchingBeans(context, spec); - // ×¢ÒâÅжÏÌõ¼þ + // 注æ„�判断æ�¡ä»¶ if (!matchResult.isAllMatched()) { String reason = createOnBeanNoMatchReason(matchResult); return ConditionOutcome.noMatch(spec.message().because(reason)); @@ -347,13 +347,13 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM matchResult.getNamesOfAllMatches()); } - // ´¦Àí @ConditionalOnSingleCandidate + // 处ç�† @ConditionalOnSingleCandidate if (metadata.isAnnotated(ConditionalOnSingleCandidate.class.getName())) { Spec spec = new SingleCandidateSpec(context, metadata, annotations); - // ´¦ÀíÆ¥Åä + // 处ç�†åŒ¹é…� MatchResult matchResult = getMatchingBeans(context, spec); - // ×¢ÒâÅжÏÌõ¼þ + // 注æ„�判断æ�¡ä»¶ if (!matchResult.isAllMatched()) { return ConditionOutcome.noMatch(spec.message().didNotFind("any beans").atAll()); } @@ -366,13 +366,13 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM .items(Style.QUOTE, matchResult.getNamesOfAllMatches()); } - // ´¦Àí @ConditionalOnMissingBean + // 处ç�† @ConditionalOnMissingBean if (metadata.isAnnotated(ConditionalOnMissingBean.class.getName())) { Spec spec = new Spec<>(context, metadata, annotations, ConditionalOnMissingBean.class); - // ´¦ÀíÆ¥Åä + // 处ç�†åŒ¹é…� MatchResult matchResult = getMatchingBeans(context, spec); - // ×¢ÒâÅжÏÌõ¼þ + // 注æ„�判断æ�¡ä»¶ if (matchResult.isAnyMatched()) { String reason = createOnMissingBeanNoMatchReason(matchResult); return ConditionOutcome.noMatch(spec.message().because(reason)); @@ -384,11 +384,11 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½·¨Ò»¹²´¦ÀíÁËÁ½¸ö×¢½âµÄÌõ¼þÆ¥Å䣺`@ConditionalOnBean`¡¢`@ConditionalOnSingleCandidate` Óë `@ConditionalOnMissingBean`£¬ÈýÕß¶¼µ÷ÓÃÁËͬһ¸ö·½·¨ `getMatchingBeans(...)` À´»ñȡƥÅä½á¹û£¬È»ºóʹÓà `matchResult.isAllMatched()` »ò `matchResult.isAnyMatched()` À´×ö×îÖյĽá¹ûÅжϡ£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ³•一共处ç�†äº†ä¸¤ä¸ªæ³¨è§£çš„æ�¡ä»¶åŒ¹é…�:`@ConditionalOnBean`ã€�`@ConditionalOnSingleCandidate` 与 `@ConditionalOnMissingBean`,三者都调用了å�Œä¸€ä¸ªæ–¹æ³• `getMatchingBeans(...)` æ�¥èŽ·å�–匹é…�结果,然å�Žä½¿ç”¨ `matchResult.isAllMatched()` 或 `matchResult.isAnyMatched()` æ�¥å�šæœ€ç»ˆçš„ç»“æžœåˆ¤æ–­ã€‚ #### `OnBeanCondition#getMatchingBeans` -`getMatchingBeans(...)` µÄ´úÂëÈçÏ£º +`getMatchingBeans(...)` 的代ç �如下: ``` protected final MatchResult getMatchingBeans(ConditionContext context, Spec spec) { @@ -403,11 +403,11 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec s beanFactory = (ConfigurableListableBeanFactory) parent; } MatchResult result = new MatchResult(); - // 1\. »ñÈ¡ ignoreType£¬Ö»ÓÐ @ConditionalOnMissingBean ÓÐÕâ¸öÊôÐÔ + // 1\. 获å�– ignoreType,å�ªæœ‰ @ConditionalOnMissingBean 有这个属性 Set beansIgnoredByType = getNamesOfBeansIgnoredByType(classLoader, beanFactory, considerHierarchy, spec.getIgnoredTypes(), parameterizedContainers); - // 2\. ´¦Àí types + // 2\. 处ç�† types for (String type : spec.getTypes()) { Collection typeMatches = getBeanNamesForType(classLoader, considerHierarchy, beanFactory, type, parameterizedContainers); @@ -420,7 +420,7 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec s } } - // 3\. ´¦ÀíÀàÉϵÄ×¢½â @ConditionalOnMissingBean ÓÐÕâ¸öÊôÐÔ + // 3\. 处ç�†ç±»ä¸Šçš„æ³¨è§£ @ConditionalOnMissingBean 有这个属性 for (String annotation : spec.getAnnotations()) { Set annotationMatches = getBeanNamesForAnnotation(classLoader, beanFactory, annotation, considerHierarchy); @@ -433,7 +433,7 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec s } } - // 4\. ´¦Àí beanName + // 4\. 处ç�† beanName for (String beanName : spec.getNames()) { if (!beansIgnoredByType.contains(beanName) && containsBean(beanFactory, beanName, considerHierarchy)) { @@ -448,32 +448,32 @@ protected final MatchResult getMatchingBeans(ConditionContext context, Spec s ``` -ÐèҪ˵Ã÷µÄÊÇ£¬Õâ¸ö·½·¨»á´¦Àí 3 ¸ö×¢½âµÄÆ¥Å乿Ôò£º`@ConditionalOnBean`¡¢`@ConditionalOnSingleCandidate` Óë `@ConditionalOnMissingBean`£¬´¦Àí²½ÖèÈçÏ£º +需è¦�说明的是,这个方法会处ç�† 3 个注解的匹é…�规则:`@ConditionalOnBean`ã€�`@ConditionalOnSingleCandidate` 与 `@ConditionalOnMissingBean`,处ç�†æ­¥éª¤å¦‚下: -1. »ñÈ¡ `ignoreType`£¬Ö»ÓÐ `@ConditionalOnMissingBean` ÓÐÕâ¸öÊôÐÔ -2. ´¦Àí `types` µÄÆ¥Å乿Ôò -3. ´¦Àí×¢½â£¨ÀàÉϵÄ×¢½â£©µÄÆ¥Å乿Ôò£¬ Ö»ÓÐ `@ConditionalOnMissingBean` ÓÐÕâ¸öÊôÐÔ -4. ´¦Àí `beanName` µÄÆ¥Å乿Ôò +1. 获å�– `ignoreType`,å�ªæœ‰ `@ConditionalOnMissingBean` 有这个属性 +2. 处ç�† `types` 的匹é…�规则 +3. 处ç�†æ³¨è§£ï¼ˆç±»ä¸Šçš„æ³¨è§£ï¼‰çš„匹é…�规则, å�ªæœ‰ `@ConditionalOnMissingBean` 有这个属性 +4. 处ç�† `beanName` 的匹é…�规则 -¹ØÓÚÒÔÉϲ½ÖèµÄ¾ßÌåϸ½Ú£¬±¾ÎľͲ»¾ßÌåÕ¹¿ªÁË£¬ÕâÀï½öÌṩÁ÷³Ì£º +关于以上步骤的具体细节,本文就ä¸�具体展开了,这里仅æ��ä¾›æµ�程: -1. »ñÈ¡ `ignoreType`£º - 1. ʹÓà `ListableBeanFactory#getBeanNamesForType(Class, boolean, boolean)` ·½·¨»ñÈ¡ÈÝÆ÷ÖÐËùÓÐµÄ `ignoreType` µÄ `beanName` - 2. ½á¹ûΪ `beansIgnoredByType`(ÀàÐÍÊÇ `Set`) -2. ´¦Àí `types` µÄÆ¥Å乿Ôò - 1. ʹÓà `ListableBeanFactory#getBeanNamesForType(Class, boolean, boolean)` ·½·¨»ñÈ¡ÈÝÆ÷ÖÐËùÓÐµÄ `type` ¶ÔÓ¦µÄ `beanName`£¬½á¹ûΪ `typeMatches` - 2. ½« `typeMatches` ÖеÄֵȥ³ý `ignoreType` - 3. Åжϵڶþ²½µÃµ½µÄ `typeMatches`£¬Èç¹ûÄÚÈÝΪ¿Õ£¬½«µ±Ç° `Type` ±£´æµ½ `unmatchedTypes` ÖУ¬·ñÔò±£´æµ½ `matchedTypes` Óë `namesOfAllMatches` ÖÐ -3. ´¦Àí×¢½âµÄÆ¥Å乿Ôò - 1. ʹÓà `ListableBeanFactory#getBeanNamesForAnnotation` ·½·¨»ñÈ¡ÈÝÆ÷ÖÐËùÓÐµÄ `annotation` ¶ÔÓ¦µÄ `beanName`£¬½á¹ûΪ `annotationMatches` - 2. ½« `annotationMatches` ÖеÄֵȥ³ý `ignoreType` - 3. Åжϵڶþ²½µÃµ½µÄ `annotationMatches`£¬Èç¹ûÄÚÈÝΪ¿Õ£¬½«µ±Ç° `Annotation` ±£´æµ½ `unmatchedAnnotations` ÖУ¬·ñÔò±£´æµ½ `matchedAnnotations` Óë `namesOfAllMatches` ÖÐ -4. ´¦Àí `beanName` µÄÆ¥Å乿Ôò - 1. ÅÐ¶Ï `beansIgnoredByType` ÊÇ·ñ°üº¬ `beanName` - 2. ʹÓà `BeanFactory#containsBean` ·½·¨ÅжÏÈÝÆ÷ÖÐÓиà `beanName` - 3. Èç¹ûµÚ 2 ²½½á¹ûΪ `false`£¬µÚ¶þ²½½á¹ûΪ `true`£¬Ôò½«µ±Ç° `beanName` ¼ÓÈëµ½ `matchedNames` Óë `namesOfAllMatches`£¬·ñÔò±£´æµ½ `unmatchedNames` ÖÐ +1. 获å�– `ignoreType`: + 1. 使用 `ListableBeanFactory#getBeanNamesForType(Class, boolean, boolean)` 方法获å�–容器中所有的 `ignoreType` çš„ `beanName` + 2. 结果为 `beansIgnoredByType`(类型是 `Set`) +2. 处ç�† `types` 的匹é…�规则 + 1. 使用 `ListableBeanFactory#getBeanNamesForType(Class, boolean, boolean)` 方法获å�–容器中所有的 `type` 对应的 `beanName`,结果为 `typeMatches` + 2. å°† `typeMatches` 中的值去除 `ignoreType` + 3. 判断第二步得到的 `typeMatches`,如果内容为空,将当å‰� `Type` ä¿�存到 `unmatchedTypes` 中,å�¦åˆ™ä¿�存到 `matchedTypes` 与 `namesOfAllMatches` 中 +3. 处ç�†æ³¨è§£çš„匹é…�规则 + 1. 使用 `ListableBeanFactory#getBeanNamesForAnnotation` 方法获å�–容器中所有的 `annotation` 对应的 `beanName`,结果为 `annotationMatches` + 2. å°† `annotationMatches` 中的值去除 `ignoreType` + 3. 判断第二步得到的 `annotationMatches`,如果内容为空,将当å‰� `Annotation` ä¿�存到 `unmatchedAnnotations` 中,å�¦åˆ™ä¿�存到 `matchedAnnotations` 与 `namesOfAllMatches` 中 +4. 处ç�† `beanName` 的匹é…�规则 + 1. 判断 `beansIgnoredByType` 是å�¦åŒ…å�« `beanName` + 2. 使用 `BeanFactory#containsBean` 方法判断容器中有该 `beanName` + 3. 如果第 2 步结果为 `false`,第二步结果为 `true`,则将当å‰� `beanName` 加入到 `matchedNames` 与 `namesOfAllMatches`,å�¦åˆ™ä¿�存到 `unmatchedNames` 中 -µÃµ½ `matchedTypes`¡¢`unmatchedNames` µÈÄÚÈݺó£¬`matchResult.isAllMatched()` »ò `matchResult.isAnyMatched()` ×îÖÕµÄÅжϽá¹û¾ÍÊÇÅжÏÕâЩ½á¹¹ÊÇ·ñ¿Õ£º +得到 `matchedTypes`ã€�`unmatchedNames` 等内容å�Žï¼Œ`matchResult.isAllMatched()` 或 `matchResult.isAnyMatched()` 最终的判断结果就是判断这些结构是å�¦ç©ºï¼š ``` boolean isAllMatched() { @@ -488,11 +488,11 @@ boolean isAnyMatched() { ``` -¿´À´£¬`@ConditionalOnBean`/`@ConditionalOnMissingBean` µÄ¹Ø¼ü£¬¾ÍÊÇʹÓà `ListableBeanFactory#getBeanNamesForType` »ò `BeanFactory#containsBean` À´ÅÐ¶Ï `beanName`¡¢`beanType` ÊÇ·ñ´æÔÚÁË¡£ +看æ�¥ï¼Œ`@ConditionalOnBean`/`@ConditionalOnMissingBean` 的关键,就是使用 `ListableBeanFactory#getBeanNamesForType` 或 `BeanFactory#containsBean` æ�¥åˆ¤æ–­ `beanName`ã€�`beanType` 是å�¦å­˜åœ¨äº†ã€‚ -ÔÚʹÓà `@ConditionalOnBean`/`@ConditionalOnMissingBean` ʱ£¬ÓÐÒ»¸ö¿ÓÐèÒªÌØ±ð×¢Ò⣺Ìõ¼þ×¢½âµÄÖ´ÐÐʱ»úÊÇÔÚ spring µÄ `ConfigurationClassPostProcessor` Öеģ¬È·ÇеØËµ£¬ÊÇÔÚ½« `bean` ¼ÓÈëµ½ `beanFactory` µÄ `beanDefinitionMap` ֮ǰÅжϵģ¬Èç¹ûÂú×ãÌõ¼þÔòÌí¼Óµ½ `beanDefinitionMap` ÖУ¬·ñÔò¾Í²»Ìí¼Ó¡£ÕâÑù¾Íµ¼ÖÂÁËÒ»¸öÎÊÌ⣺Èç¹ûÔÚ `@ConditionalOnBean`/`@ConditionalOnMissingBean` µÄ `bean` Ôڸà `bean` Ö®ºó¼ÓÈëµ½ `beanDefinitionMap` ÖУ¬¾ÍÓпÉÄܳöÏÖÎóÅУ¬¾ÙÀý˵Ã÷£º +在使用 `@ConditionalOnBean`/`@ConditionalOnMissingBean` 时,有一个å�‘需è¦�特别注æ„�:æ�¡ä»¶æ³¨è§£çš„æ‰§è¡Œæ—¶æœºæ˜¯åœ¨ spring çš„ `ConfigurationClassPostProcessor` 中的,确切地说,是在将 `bean` 加入到 `beanFactory` çš„ `beanDefinitionMap` 之å‰�判断的,如果满足æ�¡ä»¶åˆ™æ·»åŠ åˆ° `beanDefinitionMap` 中,å�¦åˆ™å°±ä¸�添加。这样就导致了一个问题:如果在 `@ConditionalOnBean`/`@ConditionalOnMissingBean` çš„ `bean` 在该 `bean` 之å�ŽåŠ å…¥åˆ° `beanDefinitionMap` 中,就有å�¯èƒ½å‡ºçŽ°è¯¯åˆ¤ï¼Œä¸¾ä¾‹è¯´æ˜Žï¼š -ÏÖÔÚÓÐÁ½¸öÀࣺ +现在有两个类: ``` @Component @@ -508,47 +508,47 @@ public class B { ``` -ÆäÖÐ `A` Óë `B` ¶¼Ìí¼ÓÁË `@Component`£¬±íÃ÷ÕâÊÇ spring bean£¬È»ºóÔÚ `A` ÉÏÌí¼ÓÁË×¢½â `@ConditionalOnMissingBean("b")`£¬±íÃ÷ÔÚ `b` ²»´æÔÚʱ£¬`A` ²Å½øÐгõʼ»¯¡£ÓÐÁËÕâЩǰÌᣬÎÒÃÇÔÙÀ´¿´¿´Á½ÖÖÇé¿ö£º +其中 `A` 与 `B` 都添加了 `@Component`,表明这是 spring bean,然å�Žåœ¨ `A` 上添加了注解 `@ConditionalOnMissingBean("b")`,表明在 `b` ä¸�存在时,`A` æ‰�进行åˆ�始化。有了这些å‰�æ��,我们å†�æ�¥çœ‹çœ‹ä¸¤ç§�情况: -1. Èç¹û `b` ÏÈÌí¼Óµ½ `beanDefinitionMap` ÖУ¬ÔÚ½« `a` Ìí¼Óµ½ `beanDefinitionMap` ʱ£¬·¢ÏÖ `b` ÒѾ­´æÔÚÁË£¬ÓÚÊǾͲ»Ìí¼ÓÁË£¬·ûºÏÎÒÃǵÄÔ¤ÆÚ£» -2. Èç¹û `a` Ïȱ»´¦Àí£¬ÔÚÌí¼Óʱ£¬·¢ÏÖ `beanDefinitionMap` Öв¢Ã»ÓÐ `b`£¬ÓÚÊÇ `a` ±»Ìí¼Óµ½ `beanDefinitionMap` ÖУ¬ÔÙ´¦Àí `b`£¬`b` Ò²»á±»Ìí¼Óµ½ `beanDefinitionMap`£¬ÕâÑùÒ»À´£¬`a` Óë `b` ͬʱ´æÔÚÓÚ `beanDefinitionMap` ÖУ¬×îÖÕ¶¼»á±»³õʼ»¯³É spring bean£¬ÕâÓëÎÒÃǵÄÔ¤ÆÚ²»·û¡£ +1. 如果 `b` 先添加到 `beanDefinitionMap` 中,在将 `a` 添加到 `beanDefinitionMap` 时,å�‘现 `b` å·²ç»�存在了,于是就ä¸�添加了,符å�ˆæˆ‘们的预期; +2. 如果 `a` 先被处ç�†ï¼Œåœ¨æ·»åŠ æ—¶ï¼Œå�‘现 `beanDefinitionMap` 中并没有 `b`,于是 `a` 被添加到 `beanDefinitionMap` 中,å†�处ç�† `b`,`b` 也会被添加到 `beanDefinitionMap`,这样一æ�¥ï¼Œ`a` 与 `b` å�Œæ—¶å­˜åœ¨äºŽ `beanDefinitionMap` 中,最终都会被åˆ�始化æˆ� spring bean,这与我们的预期ä¸�符。 -ÄÇô springboot ÈçºÎ½â¾öÒÔÉÏÎÊÌâÄØ£¿ÎÒÃÇÀ´¿´¿´ `@ConditionalOnBean`/`@ConditionalOnMissingBean` µÄ˵Ã÷£º +那么 springboot 如何解决以上问题呢?我们æ�¥çœ‹çœ‹ `@ConditionalOnBean`/`@ConditionalOnMissingBean` 的说明: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-30df67cb01c73a6b201695298aad14fd0a5.png) -ÉÔ΢·­ÒëÈçÏ£º +ç¨�微翻译如下: -¸ÃÌõ¼þÖ»ÄÜÆ¥Å䵽ĿǰΪֹµÄÓ¦ÓóÌÐòÉÏÏÂÎÄÖÐµÄ bean ´æÔÚÇé¿ö£¬Òò´Ë£¬Ç¿ÁÒ½¨Òé½öÓÚ×Ô¶¯ÅäÖÃÀàÖÐʹÓá£Èç¹ûºòÑ¡ bean ÒªÔÚÁíÒ»ÖÖ×Ô¶¯ÅäÖÃÏ´´½¨£¬ÇëÈ·±£Ê¹ÓôËÌõ¼þµÄÅäÖÃÔÚ´ËÖ®ºóÔËÐС£ +该æ�¡ä»¶å�ªèƒ½åŒ¹é…�到目å‰�为止的应用程åº�上下文中的 bean 存在情况,因此,强烈建议仅于自动é…�置类中使用。如果候选 bean è¦�在å�¦ä¸€ç§�自动é…�置下创建,请确ä¿�使用此æ�¡ä»¶çš„é…�置在此之å�Žè¿�行。 -¶ÔÒÔÉÏÄÚÈÝ£¬ÎҵĽâ¶ÁÈçÏ£º +对以上内容,我的解读如下: -* ±» `@ConditionalOnBean`/`@ConditionalOnMissingBean` ±ê¼Ç `bean` ¼ÓÈëµ½ `beanDefinitionMap` ÄÇÒ»¿Ì£¬½öÆ¥ÅäĿǰΪֹ `beanDefinitionMap` ÖÐÒÑ´æÔÚµÄ bean£¬¶ÔÖ®ºó¼ÓÈëµÄ bean ²»¿¼ÂÇ£¬Õâ¾ÍÓпÉÄÜÔì³ÉÎóÅУ¬¿ÉÒԲο¼ÉÏÃæ¾ÙµÄ `a` Óë `b` µÄÀý×Ó -* Ç¿ÁÒ½¨Òé½öÔÚ×Ô¶¯ÅäÖÃÀàÖÐʹÓà `@ConditionalOnBean`/`@ConditionalOnMissingBean` ÕâÁ½¸ö×¢½â£¬Ò²¾ÍÊÇ˵ÔÚ×Ô¶¯ÅäÖÃÀàÖÐʹÓõϰ£¬ÄÜÕýÈ·´¦ÀíÆ¥Åä -* »¹ÊÇÄÃÉÏÃæµÄ `a` Óë `b` ¾ÙÀý£¬Èç¹û `a` Óë `b` ·Ö±ðλÓÚ²»Í¬µÄ×Ô¶¯ÅäÖÃÀàÖУ¬ÄÇô `a` ÐèÒªÔÚ `b` Ö®ºó¼ÓÔØµ½ `beanDefinitionMap` ÖУ¬Õâ¸ö¿ÉÒÔͨ¹ý `@AutoConfigureAfter`¡¢`@AutoConfigureBefore`¡¢`@AutoConfigureOrder` µÈ×¢½âÀ´Ö¸¶¨ +* 被 `@ConditionalOnBean`/`@ConditionalOnMissingBean` 标记 `bean` 加入到 `beanDefinitionMap` 那一刻,仅匹é…�ç›®å‰�为止 `beanDefinitionMap` 中已存在的 bean,对之å�ŽåŠ å…¥çš„ bean ä¸�考虑,这就有å�¯èƒ½é€ æˆ�误判,å�¯ä»¥å�‚考上é�¢ä¸¾çš„ `a` 与 `b` 的例å­� +* 强烈建议仅在自动é…�置类中使用 `@ConditionalOnBean`/`@ConditionalOnMissingBean` 这两个注解,也就是说在自动é…�置类中使用的è¯�,能正确处ç�†åŒ¹é…� +* 还是拿上é�¢çš„ `a` 与 `b` 举例,如果 `a` 与 `b` 分别ä½�于ä¸�å�Œçš„自动é…�置类中,那么 `a` 需è¦�在 `b` 之å�ŽåŠ è½½åˆ° `beanDefinitionMap` 中,这个å�¯ä»¥é€šè¿‡ `@AutoConfigureAfter`ã€�`@AutoConfigureBefore`ã€�`@AutoConfigureOrder` 等注解æ�¥æŒ‡å®š -¹ØÓÚ×Ô¶¯ÅäÖÃÀàµÄ¼ÓÔØË³Ðò£¬ºóÃæÔÙ×ö·ÖÎö°É¡£ +关于自动é…�置类的加载顺åº�,å�Žé�¢å†�å�šåˆ†æž�å�§ã€‚ -ÏÞÓÚÆª·ù£¬±¾ÎľÍÏȵ½ÕâÀïÁË£¬ÏÂÆª¼ÌÐø·ÖÎöʣϵÄÌõ¼þ×¢½â¡£ +é™�于篇幅,本文就先到这里了,下篇继续分æž�剩下的æ�¡ä»¶æ³¨è§£ã€‚ * * * -±¾ÎÄÊÇ springboot Ìõ¼þ×¢½â·ÖÎöµÄµÚ¶þƪ£¬ÉÏÎÄÎÒÃÇ×ܽáÁË springboot µÄ¼¸¸öÌõ¼þ×ܽ᣺ +本文是 springboot æ�¡ä»¶æ³¨è§£åˆ†æž�的第二篇,上文我们总结了 springboot 的几个æ�¡ä»¶æ€»ç»“: -| ×¢½âÀàÐÍ | ×¢½âÀàÐÍ | Ìõ¼þÅжÏÀà | +| 注解类型 | 注解类型 | æ�¡ä»¶åˆ¤æ–­ç±» | | --------------------- | ------------------------------------------------------------ | --------------------------- | -| class Ìõ¼þ×¢½â | `@ConditionalOnClass`/`@ConditionalOnMissingClass` | `OnClassCondition` | -| bean Ìõ¼þ×¢½â | `@ConditionalOnBean`/`@ConditionalOnMissingBean` | `OnBeanCondition` | -| ÊôÐÔÌõ¼þ×¢½â | `@ConditionalOnProperty` | `OnPropertyCondition` | -| Resource Ìõ¼þ×¢½â | `@ConditionalOnResource` | `OnResourceCondition` | -| Web Ó¦ÓÃÌõ¼þ×¢½â | `@ConditionalOnWebApplication` / `@ConditionalOnNotWebApplication` | `OnWebApplicationCondition` | -| spring ±í´ïʽÌõ¼þ×¢½â | `@ConditionalOnExpression` | `OnExpressionCondition` | +| class æ�¡ä»¶æ³¨è§£ | `@ConditionalOnClass`/`@ConditionalOnMissingClass` | `OnClassCondition` | +| bean æ�¡ä»¶æ³¨è§£ | `@ConditionalOnBean`/`@ConditionalOnMissingBean` | `OnBeanCondition` | +| 属性æ�¡ä»¶æ³¨è§£ | `@ConditionalOnProperty` | `OnPropertyCondition` | +| Resource æ�¡ä»¶æ³¨è§£ | `@ConditionalOnResource` | `OnResourceCondition` | +| Web 应用æ�¡ä»¶æ³¨è§£ | `@ConditionalOnWebApplication` / `@ConditionalOnNotWebApplication` | `OnWebApplicationCondition` | +| spring 表达å¼�æ�¡ä»¶æ³¨è§£ | `@ConditionalOnExpression` | `OnExpressionCondition` | -±¾ÎļÌÐø·ÖÎöÌõ¼þÅжϡ£ +本文继续分æž�æ�¡ä»¶åˆ¤æ–­ã€‚ -### 5. `@ConditionalOnProperty`£º`OnPropertyCondition#getMatchOutcome` +### 5. `@ConditionalOnProperty`:`OnPropertyCondition#getMatchOutcome` -ÎÒÃÇÔÙÀ´¿´¿´ `@ConditionalOnProperty` µÄ´¦Àí£¬½øÈë `OnPropertyCondition#getMatchOutcome` ·½·¨£º +我们å†�æ�¥çœ‹çœ‹ `@ConditionalOnProperty` 的处ç�†ï¼Œè¿›å…¥ `OnPropertyCondition#getMatchOutcome` 方法: ``` class OnPropertyCondition extends SpringBootCondition { @@ -556,13 +556,13 @@ class OnPropertyCondition extends SpringBootCondition { @Override public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { - // »ñÈ¡ @ConditionalOnProperty µÄÊôÐÔÖµ + // 获å�– @ConditionalOnProperty 的属性值 List allAnnotationAttributes = annotationAttributesFromMultiValueMap( metadata.getAllAnnotationAttributes(ConditionalOnProperty.class.getName())); List noMatch = new ArrayList<>(); List match = new ArrayList<>(); for (AnnotationAttributes annotationAttributes : allAnnotationAttributes) { - // ÔÚ determineOutcome(...) ·½·¨ÖнøÐÐÅжϣ¬×¢Òâ²ÎÊý£ºcontext.getEnvironment() + // 在 determineOutcome(...) 方法中进行判断,注æ„�å�‚数:context.getEnvironment() ConditionOutcome outcome = determineOutcome(annotationAttributes, context.getEnvironment()); (outcome.isMatch() ? match : noMatch).add(outcome.getConditionMessage()); @@ -579,47 +579,47 @@ class OnPropertyCondition extends SpringBootCondition { ``` -Õâ¸ö·½·¨»¹ÊDZȽϼòµ¥µÄ£¬ÏÈÊÇ»ñÈ¡ `@ConditionalOnProperty` µÄÊôÐÔÖµ£¬ÔÙµ÷Óà `determineOutcome(...)` ·½·¨½øÐд¦Àí£¬ÈÃÎÒÃÇÔÙ½øÐÐ `OnPropertyCondition#determineOutcome` ·½·¨£º +这个方法还是比较简å�•的,先是获å�– `@ConditionalOnProperty` 的属性值,å†�调用 `determineOutcome(...)` 方法进行处ç�†ï¼Œè®©æˆ‘们å†�进行 `OnPropertyCondition#determineOutcome` 方法: ``` /** - * ´¦Àí½á¹û - * ×¢Ò⣺resolver ´«ÈëµÄµÄÊÇ Environment£¬Õâ¾ÍÊÇ applicationContext ÖÐµÄ Environment + * 处ç�†ç»“æžœ + * 注æ„�:resolver 传入的的是 Environment,这就是 applicationContext 中的 Environment */ private ConditionOutcome determineOutcome(AnnotationAttributes annotationAttributes, PropertyResolver resolver) { Spec spec = new Spec(annotationAttributes); List missingProperties = new ArrayList<>(); List nonMatchingProperties = new ArrayList<>(); - // ´¦Àí²Ù×÷ + // 处ç�†æ“�作 spec.collectProperties(resolver, missingProperties, nonMatchingProperties); - // ÅжϽá¹û + // 判断结果 if (!missingProperties.isEmpty()) { return ConditionOutcome.noMatch(ConditionMessage .forCondition(ConditionalOnProperty.class, spec) .didNotFind("property", "properties").items(Style.QUOTE, missingProperties)); } - // ÅжϽá¹û + // 判断结果 if (!nonMatchingProperties.isEmpty()) { return ConditionOutcome.noMatch(ConditionMessage .forCondition(ConditionalOnProperty.class, spec) .found("different value in property", "different value in properties") .items(Style.QUOTE, nonMatchingProperties)); } - // ÅжϽá¹û + // 判断结果 return ConditionOutcome.match(ConditionMessage .forCondition(ConditionalOnProperty.class, spec).because("matched")); } /** - * ´¦ÀíÊôÐÔ + * 处ç�†å±žæ€§ */ private void collectProperties(PropertyResolver resolver, List missing, List nonMatching) { for (String name : this.names) { String key = this.prefix + name; - // resolver ´«ÈëµÄ environment - // properties Ìõ¼þÅжϾÍÊÇÅÐ¶Ï environment ÀïÓÐûÓÐÏàÓ¦ÊôÐÔ + // resolver 传入的 environment + // properties æ�¡ä»¶åˆ¤æ–­å°±æ˜¯åˆ¤æ–­ environment 里有没有相应属性 if (resolver.containsProperty(key)) { if (!isMatch(resolver.getProperty(key), this.havingValue)) { nonMatching.add(name); @@ -635,11 +635,11 @@ private void collectProperties(PropertyResolver resolver, List missing, ``` -¿ÉÒÔ¿´µ½£¬`@ConditionalOnProperty` ×îÖÕÊÇͨ¹ýÅÐ¶Ï `environment` ÖÐÊÇ·ñÓиÃÊôÐÔÀ´´¦ÀíÌõ¼þÅжϵġ£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`@ConditionalOnProperty` 最终是通过判断 `environment` 中是å�¦æœ‰è¯¥å±žæ€§æ�¥å¤„ç�†æ�¡ä»¶åˆ¤æ–­çš„。 -### 6. `@ConditionalOnResource`£º`OnResourceCondition#getMatchOutcome` +### 6. `@ConditionalOnResource`:`OnResourceCondition#getMatchOutcome` -ÎÒÃÇÔÙÀ´¿´¿´ `@ConditionalOnResource` µÄ´¦Àí£¬Ò»°ãÎÒÃÇÕâÑùʹÓ㺠+我们å†�æ�¥çœ‹çœ‹ `@ConditionalOnResource` 的处ç�†ï¼Œä¸€èˆ¬æˆ‘们这样使用: ``` @Bean @@ -650,32 +650,32 @@ public Config config() { ``` -±íʾµ± `classpath` ÖдæÔÚ `config.properties` ʱ£¬`config` ²Å»á±»³õʼ»¯ springbean¡£ +表示当 `classpath` 中存在 `config.properties` 时,`config` æ‰�会被åˆ�始化 springbean。 -ÔÙ½øÈë `OnResourceCondition#getOutcomes` ·½·¨£º +å†�进入 `OnResourceCondition#getOutcomes` 方法: ``` @Override public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { MultiValueMap attributes = metadata .getAllAnnotationAttributes(ConditionalOnResource.class.getName(), true); - // »ñÈ¡ ResourceLoader + // 获å�– ResourceLoader ResourceLoader loader = context.getResourceLoader(); List locations = new ArrayList<>(); collectValues(locations, attributes.get("resources")); Assert.isTrue(!locations.isEmpty(), "@ConditionalOnResource annotations must specify at least one resource location"); List missing = new ArrayList<>(); - // ±éÀúÅжÏ×ÊÔ´ÊÇ·ñ´æÔÚ + // é��历判断资æº�是å�¦å­˜åœ¨ for (String location : locations) { - // location ÖпÉÄÜÓÐռλ·û£¬ÔÚÕâÀï´¦Àí + // location 中å�¯èƒ½æœ‰å� ä½�符,在这里处ç�† String resource = context.getEnvironment().resolvePlaceholders(location); - // ÅÐ¶Ï resource ÊÇ·ñ´æÔÚ + // 判断 resource 是å�¦å­˜åœ¨ if (!loader.getResource(resource).exists()) { missing.add(location); } } - // ´¦Àí½á¹û + // 处ç�†ç»“æžœ if (!missing.isEmpty()) { return ConditionOutcome.noMatch(ConditionMessage.forCondition(ConditionalOnResource.class) .didNotFind("resource", "resources").items(Style.QUOTE, missing)); @@ -686,13 +686,13 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeM ``` -ÏÈÊÇͨ¹ý `OnResourceCondition#getOutcomes` ·½·¨À´»ñÈ¡ `ResourceLoader`£¬Í¨¹ýµ÷ÊÔ·½Ê½·¢ÏÖµ±Ç°µÄ `ResourceLoader` Ϊ `AnnotationConfigServletWebServerApplicationContext`£º +先是通过 `OnResourceCondition#getOutcomes` 方法æ�¥èŽ·å�– `ResourceLoader`,通过调试方å¼�å�‘现当å‰�çš„ `ResourceLoader` 为 `AnnotationConfigServletWebServerApplicationContext`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8f1de99f757eca7aeb0307b06b28d1020d2.png) -»ñÈ¡µ½ `ResourceLoader` ºó£¬µ÷Óà `ResourceLoader#getResource(String)` À´»ñÈ¡×ÊÔ´£¬È»ºóµ÷Óà `Resource#exists` À´ÅжÏ×ÊÔ´ÊÇ·ñ´æÔÚ£¬×îºó´¦ÀíÆ¥Åä½á¹û¡£ +获å�–到 `ResourceLoader` å�Žï¼Œè°ƒç”¨ `ResourceLoader#getResource(String)` æ�¥èŽ·å�–资æº�,然å�Žè°ƒç”¨ `Resource#exists` æ�¥åˆ¤æ–­èµ„æº�是å�¦å­˜åœ¨ï¼Œæœ€å�Žå¤„ç�†åŒ¹é…�结果。 -Õû¸öÁ÷³ÌµÄ¹Ø¼üÊÇÔÚ `ResourceLoader#getResource(String)`£¬ÎÒÃÇÀ´¿´¿´¸Ã·½·¨µÄ´¦Àí£¬½øÈëµ½ `GenericApplicationContext#getResource` ·½·¨£º +整个æµ�程的关键是在 `ResourceLoader#getResource(String)`,我们æ�¥çœ‹çœ‹è¯¥æ–¹æ³•的处ç�†ï¼Œè¿›å…¥åˆ° `GenericApplicationContext#getResource` 方法: ``` @Override @@ -705,7 +705,7 @@ public Resource getResource(String location) { ``` -ÕâÀïµÄ `this.resourceLoader` Ϊ `null`£¬½øÈ븸ÀàµÄ·½·¨ `DefaultResourceLoader#getResource`£º +这里的 `this.resourceLoader` 为 `null`,进入父类的方法 `DefaultResourceLoader#getResource`: ``` public Resource getResource(String location) { @@ -716,31 +716,31 @@ public Resource getResource(String location) { return resource; } } - // ´¦Àí/¿ªÍ·µÄ×ÊÔ´ + // 处ç�†/开头的资æº� if (location.startsWith("/")) { return getResourceByPath(location); } else if (location.startsWith(CLASSPATH_URL_PREFIX)) { - // ´¦Àíclasspath¿ªÍ·µÄ×ÊÔ´ + // 处ç�†classpath开头的资æº� return new ClassPathResource( location.substring(CLASSPATH_URL_PREFIX.length()), getClassLoader()); } else { try { - // ÒÔÉ϶¼²»Âú×㣬ʹÓà url À´½âÎö + // 以上都ä¸�满足,使用 url æ�¥è§£æž� URL url = new URL(location); return (ResourceUtils.isFileURL(url) ? new FileUrlResource(url) : new UrlResource(url)); } catch (MalformedURLException ex) { - // url½âÎö³öÁËÎÊÌ⣬×îÖÕ»¹ÊÇÓà getResourceByPath(...) À´½âÎö + // urlè§£æž�出了问题,最终还是用 getResourceByPath(...) æ�¥è§£æž� return getResourceByPath(location); } } } /** - * ͨ¹ý·¾¶µÃµ½ Resource + * 通过路径得到 Resource */ protected Resource getResourceByPath(String path) { return new ClassPathContextResource(path, getClassLoader()); @@ -748,17 +748,17 @@ protected Resource getResourceByPath(String path) { ``` -¿ÉÒÔ¿´µ½£¬`DefaultResourceLoader#getResource` ͨ¹ýÅÐ¶Ï `location` µÄǰ׺£¬µÃµ½ÁË 4 ÖÖ `Resource`£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`DefaultResourceLoader#getResource` 通过判断 `location` çš„å‰�缀,得到了 4 ç§� `Resource`: * `ClassPathContextResource` * `FileUrlResource` * `UrlResource` -µÃµ½ `Resource` ºó£¬½ÓמÍÊÇÅжϸà `Resource` ÊÇ·ñ´æÔÚÁË£¬ÎÒÃÇÏÈÀ´¿´¿´ `ClassPathContextResource#exist` ·½·¨£¬¸Ã·½·¨ÔÚ `ClassPathResource#exists`£º +得到 `Resource` å�Žï¼ŒæŽ¥ç�€å°±æ˜¯åˆ¤æ–­è¯¥ `Resource` 是å�¦å­˜åœ¨äº†ï¼Œæˆ‘们先æ�¥çœ‹çœ‹ `ClassPathContextResource#exist` 方法,该方法在 `ClassPathResource#exists`: ``` /** - * ÅÐ¶Ï Resource ÊÇ·ñ´æÔÚ + * 判断 Resource 是å�¦å­˜åœ¨ */ @Override public boolean exists() { @@ -766,45 +766,45 @@ public boolean exists() { } /** - * ×ÊÔ´ÄÜ»ñÈ¡µ½£¬Ôò·µ»Ø×ÊÔ´¶ÔÓ¦µÄurl£¬·ñÔò·µ»Ønull + * 资æº�能获å�–到,则返回资æº�对应的url,å�¦åˆ™è¿”回null */ @Nullable protected URL resolveURL() { if (this.clazz != null) { - // ʹÓõ±Ç°µÄ class ¶ÔÓ¦µÄ classLoader À´»ñÈ¡ + // 使用当å‰�çš„ class 对应的 classLoader æ�¥èŽ·å�– return this.clazz.getResource(this.path); } else if (this.classLoader != null) { - // ʹÓÃÖ¸¶¨µÄ classLoader À´»ñÈ¡ + // 使用指定的 classLoader æ�¥èŽ·å�– return this.classLoader.getResource(this.path); } else { - // »ñȡϵͳÀà¼ÓÔØÆ÷»ñÈ¡ + // 获å�–系统类加载器获å�– return ClassLoader.getSystemResource(this.path); } } ``` -´Ó´úÂë¿ÉÒÔ¿´µ½£¬×îÖÕÊÇͨ¹ý `classLoader` »ñÈ¡ÎļþµÄ `url`£¬Í¨¹ýÅжÏÎļþ `url` ÊÇ·ñΪ `null` À´ÅÐ¶Ï `resource` ÊÇ·ñ´æÔÚ¡£ +从代ç �å�¯ä»¥çœ‹åˆ°ï¼Œæœ€ç»ˆæ˜¯é€šè¿‡ `classLoader` 获å�–文件的 `url`,通过判断文件 `url` 是å�¦ä¸º `null` æ�¥åˆ¤æ–­ `resource` 是å�¦å­˜åœ¨ã€‚ -ÔÙÀ´¿´¿´ `FileUrlResource` µÄÅжϣ¬Êµ¼ÊÉÏ `FileUrlResource` Óë `UrlResource` µÄ `exist()` ·½·¨¶¼ÊÇ `AbstractFileResolvingResource#exists`£¬ÕâÀïͳһ·ÖÎö¾Í¿ÉÒÔÁË£¬¸Ã·½·¨ÄÚÈÝÈçÏ£º +å†�æ�¥çœ‹çœ‹ `FileUrlResource` 的判断,实际上 `FileUrlResource` 与 `UrlResource` çš„ `exist()` 方法都是 `AbstractFileResolvingResource#exists`,这里统一分æž�å°±å�¯ä»¥äº†ï¼Œè¯¥æ–¹æ³•内容如下: ``` public boolean exists() { try { URL url = getURL(); if (ResourceUtils.isFileURL(url)) { - // Èç¹ûÊÇÎļþ£¬Ö±½ÓÅжÏÎļþÊÇ·ñ´æÔÚ + // 如果是文件,直接判断文件是å�¦å­˜åœ¨ return getFile().exists(); } else { - // ·ñÔòʹÓÃÍøÂçÎļþÀ´´¦Àí + // å�¦åˆ™ä½¿ç”¨ç½‘络文件æ�¥å¤„ç�† URLConnection con = url.openConnection(); customizeConnection(con); HttpURLConnection httpCon = (con instanceof HttpURLConnection ? (HttpURLConnection) con : null); - // Èç¹ûÊÇhttp£¬ÔòÅжϿ´¿´Á´½Ó·µ»ØµÄ״̬Âë + // 如果是http,则判断看看链接返回的状æ€�ç � if (httpCon != null) { int code = httpCon.getResponseCode(); if (code == HttpURLConnection.HTTP_OK) { @@ -814,7 +814,7 @@ public boolean exists() { return false; } } - // Á¬½Ó contentLengthLong ´óÓÚ0£¬Ò²µ±³ÉÊÇtrue + // 连接 contentLengthLong 大于0,也当æˆ�是true if (con.getContentLengthLong() > 0) { return true; } @@ -835,17 +835,17 @@ public boolean exists() { ``` -Èç¹ûÊDZ¾µØÎļþ£¬Ö±½ÓʹÓà `File#exists()` ·½·¨ÅжÏÎļþÊÇ·ñ´æÔÚ£¬·ñÔò¾ÍÅжÏÍøÂçÎļþÊÇ·ñ´æÔÚ£¬ÅжϷ½Ê½ÕâÀï¾Í²»Ï¸ËµÁË¡£ +如果是本地文件,直接使用 `File#exists()` 方法判断文件是å�¦å­˜åœ¨ï¼Œå�¦åˆ™å°±åˆ¤æ–­ç½‘络文件是å�¦å­˜åœ¨ï¼Œåˆ¤æ–­æ–¹å¼�这里就ä¸�细说了。 -×ܵÄÀ´Ëµ£¬springboot ¶Ô `@ConditionalOnResource` µÄÅжϻ¹ÊÇÓÐЩ¸´Ôӵģ¬ÕâÀï×ܽáÈçÏ£º +总的æ�¥è¯´ï¼Œspringboot 对 `@ConditionalOnResource` 的判断还是有些å¤�æ�‚的,这里总结如下: -1. Èç¹ûÊÇ `classpath` Îļþ£¬Í¨¹ý `classloader` »ñÈ¡Îļþ¶ÔÓ¦µÄ `url` ÊÇ·ñΪ `null` À´ÅжÏÎļþÊÇ·ñ´æÔÚ£» -2. Èç¹ûÊÇÆÕͨÎļþ£¬ÔòÖ±½Ó `File#exists()` ·½·¨ÅжÏÎļþÊÇ·ñ´æÔÚ£» -3. Èç¹ûÊÇÍøÂçÎļþ£¬ÏÈ´ò¿ªÒ»¸öÍøÂçÁ¬½Ó£¬ÅжÏÎļþÊÇ·ñ´æÔÚ¡£ +1. 如果是 `classpath` 文件,通过 `classloader` 获å�–文件对应的 `url` 是å�¦ä¸º `null` æ�¥åˆ¤æ–­æ–‡ä»¶æ˜¯å�¦å­˜åœ¨ï¼› +2. 如果是普通文件,则直接 `File#exists()` 方法判断文件是å�¦å­˜åœ¨ï¼› +3. 如果是网络文件,先打开一个网络连接,判断文件是å�¦å­˜åœ¨ã€‚ -### 7. `@ConditionalOnWebApplication`£º`OnWebApplicationCondition#getMatchOutcome` +### 7. `@ConditionalOnWebApplication`:`OnWebApplicationCondition#getMatchOutcome` -ÎÒÃÇÔÙÀ´¿´¿´ `@ConditionalOnWebApplication` µÄ´¦Àí£¬½øÈë `OnWebApplicationCondition#getOutcomes` ·½·¨£º +我们å†�æ�¥çœ‹çœ‹ `@ConditionalOnWebApplication` 的处ç�†ï¼Œè¿›å…¥ `OnWebApplicationCondition#getOutcomes` 方法: ``` @Override @@ -855,7 +855,7 @@ protected ConditionOutcome[] getOutcomes(String[] autoConfigurationClasses, for (int i = 0; i < outcomes.length; i++) { String autoConfigurationClass = autoConfigurationClasses[i]; if (autoConfigurationClass != null) { - // ´¦Àí½á¹û + // 处ç�†ç»“æžœ outcomes[i] = getOutcome(autoConfigurationMetadata.get(autoConfigurationClass, "ConditionalOnWebApplication")); } @@ -864,8 +864,8 @@ protected ConditionOutcome[] getOutcomes(String[] autoConfigurationClasses, } /** - * ´¦Àí½á¹û - * springbootÖ§³ÖµÄwebÀàÐÍÓÐÁ½ÖÖ£ºSERVLET£¬REACTIVE + * 处ç�†ç»“æžœ + * springboot支æŒ�çš„web类型有两ç§�:SERVLET,REACTIVE */ private ConditionOutcome getOutcome(String type) { if (type == null) { @@ -873,21 +873,21 @@ private ConditionOutcome getOutcome(String type) { } ConditionMessage.Builder message = ConditionMessage .forCondition(ConditionalOnWebApplication.class); - // Èç¹ûÖ¸¶¨µÄÀàÐÍÊÇ SERVLET + // 如果指定的类型是 SERVLET if (ConditionalOnWebApplication.Type.SERVLET.name().equals(type)) { if (!ClassNameFilter.isPresent(SERVLET_WEB_APPLICATION_CLASS, getBeanClassLoader())) { return ConditionOutcome.noMatch( message.didNotFind("servlet web application classes").atAll()); } } - // Èç¹ûÖ¸¶¨µÄÀàÐÍÊÇ REACTIVE + // 如果指定的类型是 REACTIVE if (ConditionalOnWebApplication.Type.REACTIVE.name().equals(type)) { if (!ClassNameFilter.isPresent(REACTIVE_WEB_APPLICATION_CLASS, getBeanClassLoader())) { return ConditionOutcome.noMatch( message.didNotFind("reactive web application classes").atAll()); } } - // Èç¹ûûÓÐÖ¸¶¨webÀàÐÍ + // 如果没有指定web类型 if (!ClassNameFilter.isPresent(SERVLET_WEB_APPLICATION_CLASS, getBeanClassLoader()) && !ClassUtils.isPresent(REACTIVE_WEB_APPLICATION_CLASS, getBeanClassLoader())) { return ConditionOutcome.noMatch( @@ -898,33 +898,33 @@ private ConditionOutcome getOutcome(String type) { ``` -Õâ¸ö·½·¨ºÜ¼òµ¥£¬´¦ÀíÂß¼­Îª£º¸ù¾Ý `@ConditionalOnWebApplication` ÖÐÖ¸¶¨µÄÀàÐÍ£¬Åж϶ÔÓ¦µÄÀàÊÇ·ñ´æÔÚ£¬ÅжϷ½Ê½Óë `@ConditionalOnClass` ÅжÏÀàÊÇ·ñ´æÔÚÒ»Ö£¬¶øÁ½ÖÖÀàÐͶÔÓ¦µÄÀàÈçÏ£º +这个方法很简å�•,处ç�†é€»è¾‘为:根æ�® `@ConditionalOnWebApplication` 中指定的类型,判断对应的类是å�¦å­˜åœ¨ï¼Œåˆ¤æ–­æ–¹å¼�与 `@ConditionalOnClass` 判断类是å�¦å­˜åœ¨ä¸€è‡´ï¼Œè€Œä¸¤ç§�类型对应的类如下: -* Servlet£º`org.springframework.web.context.support.GenericWebApplicationContext` -* Reactive£º`org.springframework.web.reactive.HandlerResult` +* Servlet:`org.springframework.web.context.support.GenericWebApplicationContext` +* Reactive:`org.springframework.web.reactive.HandlerResult` -### 8. `@ConditionalOnExpression`£º`OnExpressionCondition#getMatchOutcome` +### 8. `@ConditionalOnExpression`:`OnExpressionCondition#getMatchOutcome` -ÎÒÃÇÔÙÀ´¿´¿´ `@ConditionalOnExpression` µÄ´¦Àí£¬½øÈë `OnExpressionCondition#getOutcomes` ·½·¨£º +我们å†�æ�¥çœ‹çœ‹ `@ConditionalOnExpression` 的处ç�†ï¼Œè¿›å…¥ `OnExpressionCondition#getOutcomes` 方法: ``` /** - * ´¦ÀíÆ¥Åä½á¹û + * 处ç�†åŒ¹é…�结果 */ @Override public ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) { - // »ñÈ¡±í´ïʽ + // 获å�–表达å¼� String expression = (String) metadata.getAnnotationAttributes( ConditionalOnExpression.class.getName()).get("value"); expression = wrapIfNecessary(expression); ConditionMessage.Builder messageBuilder = ConditionMessage .forCondition(ConditionalOnExpression.class, "(" + expression + ")"); - // ´¦Àíռλ·û + // 处ç�†å� ä½�符 expression = context.getEnvironment().resolvePlaceholders(expression); ConfigurableListableBeanFactory beanFactory = context.getBeanFactory(); if (beanFactory != null) { - // ¼ÆËã±í´ïʽµÄÖµ + // 计算表达å¼�的值 boolean result = evaluateExpression(beanFactory, expression); return new ConditionOutcome(result, messageBuilder.resultedIn(result)); } @@ -932,7 +932,7 @@ public ConditionOutcome getMatchOutcome(ConditionContext context, } /** - * ¼ÆËã±í´ïʽµÄÖµ + * 计算表达å¼�的值 */ private Boolean evaluateExpression(ConfigurableListableBeanFactory beanFactory, String expression) { @@ -940,7 +940,7 @@ private Boolean evaluateExpression(ConfigurableListableBeanFactory beanFactory, if (resolver == null) { resolver = new StandardBeanExpressionResolver(); } - // ÔÚÕâÀï½âÎö±í´ïʽµÄÖµ + // 在这里解æž�表达å¼�的值 BeanExpressionContext expressionContext = new BeanExpressionContext(beanFactory, null); Object result = resolver.evaluate(expression, expressionContext); return (result != null && (boolean) result); @@ -948,14 +948,14 @@ private Boolean evaluateExpression(ConfigurableListableBeanFactory beanFactory, ``` -¿ÉÒÔ¿´µ½£¬springboot ×îÖÕÊÇͨ¹ý `BeanExpressionResolver#evaluate` ·½·¨À´¼ÆËã±í´ïʽ½á¹û£¬¹ØÓÚ spring ±í´ïʽ£¬±¾ÎľͲ»Õ¹¿ª·ÖÎöÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œspringboot 最终是通过 `BeanExpressionResolver#evaluate` 方法æ�¥è®¡ç®—表达å¼�结果,关于 spring 表达å¼�,本文就ä¸�展开分æž�了。 -ºÃÁË£¬spring Ìõ¼þ×¢½âµÄ·ÖÎö¾Íµ½ÕâÀïÁË£¬ÐèҪ˵Ã÷µÄÊÇ£¬springboot »¹ ÓÐÆäËûÌõ¼þ×¢½â£º +好了,spring æ�¡ä»¶æ³¨è§£çš„分æž�就到这里了,需è¦�说明的是,springboot 还 有其他æ�¡ä»¶æ³¨è§£ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0e8d27c887fb6ca142672cad1c60e9de207.png) -ÕâЩע½âµÄÅжϷ½Ê½Óë±¾Îĵķ½Ê½ÏàÀàËÆ£¬¾Í²»Ò»Ò»½øÐзÖÎöÁË¡£ +这些注解的判断方å¼�与本文的方å¼�相类似,就ä¸�一一进行分æž�了。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4921590](https://my.oschina.net/funcy/blog/4921590) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4921590](https://my.oschina.net/funcy/blog/4921590) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConfig.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConfig.md" index cb6a94c..6c4d638 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConfig.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConfig.md" @@ -1,58 +1,58 @@ -ÔÚ·Ö²¼Ê½Î¢·þÎñϵͳÖУ¬¼¸ºõËùÓзþÎñµÄÔËÐж¼Àë²»¿ªÅäÖÃÎļþµÄÖ§³Ö£¬ÕâЩÅäÖÃÎļþͨ³£Óɸ÷¸ö·þÎñ×ÔÐйÜÀí£¬ÒÔ properties »ò yml ¸ñʽ±£´æÔÚ¸÷¸ö΢·þÎñµÄÀà·¾¶Ï£¬ÀýÈç application.properties »ò application.yml µÈ¡£ +在分布å¼�å¾®æœ�务系统中,几乎所有æœ�务的è¿�行都离ä¸�å¼€é…�置文件的支æŒ�,这些é…�置文件通常由å�„个æœ�务自行管ç�†ï¼Œä»¥ properties 或 yml æ ¼å¼�ä¿�存在å�„个微æœ�务的类路径下,例如 application.properties 或 application.yml 等。 -ÕâÖÖ½«ÅäÖÃÎļþÉ¢ÂäÔÚ¸÷¸ö·þÎñÖеĹÜÀí·½Ê½£¬´æÔÚÒÔÏÂÎÊÌ⣺ +è¿™ç§�å°†é…�置文件散è�½åœ¨å�„个æœ�务中的管ç�†æ–¹å¼�,存在以下问题: -* **¹ÜÀíÄѶȴó**£ºÅäÖÃÎļþÉ¢ÂäÔÚ¸÷¸ö΢·þÎñÖУ¬ÄÑÒÔ¹ÜÀí¡£ -* **°²È«ÐÔµÍ**£ºÅäÖøúËæÔ´´úÂë±£´æÔÚ´úÂë¿âÖУ¬ÈÝÒ×Ôì³ÉÅäÖÃй©¡£ -* **ʱЧÐÔ²î**£ºÎ¢·þÎñÖеÄÅäÖÃÐ޸ĺ󣬱ØÐëÖØÆô·þÎñ£¬·ñÔòÎÞ·¨ÉúЧ¡£ -* **¾ÖÏÞÐÔÃ÷ÏÔ**£ºÎÞ·¨Ö§³Ö¶¯Ì¬µ÷Õû£¬ÀýÈçÈÕÖ¾¿ª¹Ø¡¢¹¦ÄÜ¿ª¹Ø¡£ +* **管ç�†éš¾åº¦å¤§**:é…�置文件散è�½åœ¨å�„个微æœ�务中,难以管ç�†ã€‚ +* **安全性低**:é…�置跟éš�æº�代ç �ä¿�存在代ç �库中,容易造æˆ�é…�置泄æ¼�。 +* **时效性差**:微æœ�务中的é…�置修改å�Žï¼Œå¿…é¡»é‡�å�¯æœ�务,å�¦åˆ™æ— æ³•生效。 +* **å±€é™�性明显**:无法支æŒ�动æ€�调整,例如日志开关ã€�功能开关。 -ΪÁ˽â¾öÕâЩÎÊÌ⣬ͨ³£ÎÒÃǶ¼»áʹÓÃÅäÖÃÖÐÐĶÔÅäÖýøÐÐͳһ¹ÜÀí¡£ÊÐÃæÉÏ¿ªÔ´µÄÅäÖÃÖÐÐÄÓкܶ࣬ÀýÈç°Ù¶ÈµÄ Disconf¡¢ÌÔ±¦µÄ diamond¡¢360 µÄ QConf¡¢Ð¯³ÌµÄ Apollo µÈ¶¼Êǽâ¾öÕâÀàÎÊÌâµÄ¡£Spring Cloud Ò²ÓÐ×Ô¼ºµÄ·Ö²¼Ê½ÅäÖÃÖÐÐÄ£¬ÄǾÍÊÇ Spring Cloud Config¡£ +为了解决这些问题,通常我们都会使用é…�置中心对é…�置进行统一管ç�†ã€‚市é�¢ä¸Šå¼€æº�çš„é…�置中心有很多,例如百度的 Disconfã€�æ·˜å®�çš„ diamondã€�360 çš„ QConfã€�æ�ºç¨‹çš„ Apollo 等都是解决这类问题的。Spring Cloud 也有自己的分布å¼�é…�置中心,那就是 Spring Cloud Config。 ## Spring Cloud Config -Spring Cloud Config ÊÇÓÉ Spring Cloud ÍŶӿª·¢µÄÏîÄ¿£¬Ëü¿ÉÒÔΪ΢·þÎñ¼Ü¹¹Öи÷¸ö΢·þÎñÌṩ¼¯Öл¯µÄÍⲿÅäÖÃÖ§³Ö¡£ +Spring Cloud Config 是由 Spring Cloud 团队开å�‘的项目,它å�¯ä»¥ä¸ºå¾®æœ�务架构中å�„个微æœ�务æ��供集中化的外部é…�置支æŒ�。 -¼òµ¥µã˵¾ÍÊÇ£¬Spring Cloud Config ¿ÉÒÔ½«¸÷¸ö΢·þÎñµÄÅäÖÃÎļþ¼¯Öд洢ÔÚÒ»¸öÍⲿµÄ´æ´¢²Ö¿â»òϵͳ£¨ÀýÈç Git ¡¢SVN µÈ£©ÖУ¬¶ÔÅäÖõÄͳһ¹ÜÀí£¬ÒÔÖ§³Ö¸÷¸ö΢·þÎñµÄÔËÐС£ -Spring Cloud Config °üº¬ÒÔÏÂÁ½¸ö²¿·Ö£º +简å�•点说就是,Spring Cloud Config å�¯ä»¥å°†å�„个微æœ�务的é…�置文件集中存储在一个外部的存储仓库或系统(例如 Git ã€�SVN 等)中,对é…�置的统一管ç�†ï¼Œä»¥æ”¯æŒ�å�„个微æœ�务的è¿�行。 +Spring Cloud Config 包å�«ä»¥ä¸‹ä¸¤ä¸ªéƒ¨åˆ†ï¼š -* Config Server£ºÒ²±»³ÆÎª·Ö²¼Ê½ÅäÖÃÖÐÐÄ£¬ËüÊÇÒ»¸ö¶ÀÁ¢ÔËÐеÄ΢·þÎñÓ¦Óã¬ÓÃÀ´Á¬½ÓÅäÖòֿⲢΪ¿Í»§¶ËÌṩ»ñÈ¡ÅäÖÃÐÅÏ¢¡¢¼ÓÃÜÐÅÏ¢ºÍ½âÃÜÐÅÏ¢µÄ·ÃÎʽӿڡ£ -* Config Client£ºÖ¸µÄÊÇ΢·þÎñ¼Ü¹¹Öеĸ÷¸ö΢·þÎñ£¬ËüÃÇͨ¹ý Config Server ¶ÔÅäÖýøÐйÜÀí£¬²¢´Ó Config Sever ÖлñÈ¡ºÍ¼ÓÔØÅäÖÃÐÅÏ¢¡£ +* Config Server:也被称为分布å¼�é…�置中心,它是一个独立è¿�行的微æœ�务应用,用æ�¥è¿žæŽ¥é…�置仓库并为客户端æ��供获å�–é…�置信æ�¯ã€�加密信æ�¯å’Œè§£å¯†ä¿¡æ�¯çš„访问接å�£ã€‚ +* Config Client:指的是微æœ�务架构中的å�„个微æœ�务,它们通过 Config Server 对é…�置进行管ç�†ï¼Œå¹¶ä»Ž Config Sever 中获å�–和加载é…�置信æ�¯ã€‚ -Spring Cloud Config ĬÈÏʹÓà Git ´æ´¢ÅäÖÃÐÅÏ¢£¬Òò´ËʹÓà Spirng Cloud Config ¹¹½¨µÄÅäÖ÷þÎñÆ÷ÌìÈ»¾ÍÖ§³Ö¶Ô΢·þÎñÅäÖõİ汾¹ÜÀí¡£ÎÒÃÇ¿ÉÒÔʹÓà Git ¿Í»§¶Ë¹¤¾ß·½±ãµØ¶ÔÅäÖÃÄÚÈݽøÐйÜÀíºÍ·ÃÎÊ¡£³ýÁË Git Í⣬Spring Cloud Config »¹ÌṩÁË¶ÔÆäËû´æ´¢·½Ê½µÄÖ§³Ö£¬ÀýÈç SVN¡¢±¾µØ»¯ÎļþϵͳµÈ¡£ +Spring Cloud Config 默认使用 Git 存储é…�置信æ�¯ï¼Œå› æ­¤ä½¿ç”¨ Spirng Cloud Config 构建的é…�ç½®æœ�务器天然就支æŒ�对微æœ�务é…�置的版本管ç�†ã€‚我们å�¯ä»¥ä½¿ç”¨ Git 客户端工具方便地对é…�置内容进行管ç�†å’Œè®¿é—®ã€‚除了 Git 外,Spring Cloud Config 还æ��供了对其他存储方å¼�的支æŒ�,例如 SVNã€�本地化文件系统等。 -## Spring Cloud Config ¹¤×÷Ô­Àí +## Spring Cloud Config 工作原ç�† -Spring Cloud Config ¹¤×÷Ô­ÀíÈçÏÂͼ¡£ +Spring Cloud Config 工作原ç�†å¦‚下图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019425240-0.png) -ͼ1£ºSpring Cloud Config ¹¤×÷Ô­Àí +图1:Spring Cloud Config 工作原ç�† -Spring Cloud Config ¹¤×÷Á÷³ÌÈçÏ£º +Spring Cloud Config 工作æµ�程如下: -1. ¿ª·¢»òÔËάÈËÔ±Ìá½»ÅäÖÃÎļþµ½Ô¶³ÌµÄ Git ²Ö¿â¡£ -2. Config ·þÎñ¶Ë£¨·Ö²¼Ê½ÅäÖÃÖÐÐÄ£©¸ºÔðÁ¬½ÓÅäÖòֿâ Git£¬²¢¶Ô Config ¿Í»§¶Ë±©Â¶»ñÈ¡ÅäÖõĽӿڡ£ -3. Config ¿Í»§¶Ëͨ¹ý Config ·þÎñ¶Ë±©Â¶³öÀ´µÄ½Ó¿Ú£¬À­È¡ÅäÖòֿâÖеÄÅäÖᣠ-4. Config ¿Í»§¶Ë»ñÈ¡µ½ÅäÖÃÐÅÏ¢£¬ÒÔÖ§³Ö·þÎñµÄÔËÐС£ +1. å¼€å�‘或è¿�维人员æ��交é…�置文件到远程的 Git 仓库。 +2. Config æœ�务端(分布å¼�é…�置中心)负责连接é…�置仓库 Git,并对 Config 客户端暴露获å�–é…�置的接å�£ã€‚ +3. Config 客户端通过 Config æœ�务端暴露出æ�¥çš„æŽ¥å�£ï¼Œæ‹‰å�–é…�置仓库中的é…�置。 +4. Config 客户端获å�–到é…�置信æ�¯ï¼Œä»¥æ”¯æŒ�æœ�务的è¿�行。 -## Spring Cloud Config µÄÌØµã +## Spring Cloud Config 的特点 -Spring Cloud Config ¾ßÓÐÒÔÏÂÌØµã£º +Spring Cloud Config 具有以下特点: -* Spring Cloud Config ÓÉ Spring Cloud ÍŶӿª·¢£¬¿ÉÒÔ˵ÊÇ Spring µÄÇ×¶ù×Ó£¬Äܹ»Óë Spring µÄÉú̬ÌåϵÎ޷켯³É¡£ -* Spring Cloud Config ½«ËùÓÐ΢·þÎñµÄÅäÖÃÎļþ¼¯Öд洢ÔÚÒ»¸öÍⲿµÄ´æ´¢²Ö¿â»òϵͳ£¨ÀýÈç Git£©ÖУ¬Í³Ò»¹ÜÀí¡£ -* Spring Cloud Config ÅäÖÃÖÐÐĽ«ÅäÖÃÒÔ REST ½Ó¿ÚµÄÐÎʽ±©Â¶¸ø¸÷¸ö΢·þÎñ£¬ÒÔ·½±ã¸÷¸ö΢·þÎñ»ñÈ¡¡£ -* ΢·þÎñ¿ÉÒÔͨ¹ý Spring Cloud Config ÏòÅäÖÃÖÐÐÄͳһÀ­È¡ÊôÓÚËüÃÇ×Ô¼ºµÄÅäÖÃÐÅÏ¢¡£ -* µ±ÅäÖ÷¢Éú±ä»¯Ê±£¬Î¢·þÎñ²»ÐèÒªÖØÆô¼´¿É¸ÐÖªµ½ÅäÖõı仯£¬²¢×Ô¶¯»ñÈ¡ºÍÓ¦ÓÃ×îÐÂÅäÖᣠ-* Ò»¸öÓ¦ÓÿÉÄÜÓжà¸ö»·¾³£¬ÀýÈ翪·¢£¨dev£©»·¾³¡¢²âÊÔ£¨test£©»·¾³¡¢Éú²ú£¨prod£©»·¾³µÈµÈ£¬¿ª·¢ÈËÔ±¿ÉÒÔͨ¹ý Spring Cloud Config ¶Ô²»Í¬»·¾³µÄ¸÷ÅäÖýøÐйÜÀí£¬ÇÒÄܹ»È·±£Ó¦ÓÃÔÚ»·¾³Ç¨ÒƺóÈÔÈ»ÓÐÍêÕûµÄÅäÖÃÖ§³ÖÆäÕý³£ÔËÐС£ +* Spring Cloud Config ç”± Spring Cloud 团队开å�‘,å�¯ä»¥è¯´æ˜¯ Spring 的亲儿å­�,能够与 Spring 的生æ€�体系无ç¼�集æˆ�。 +* Spring Cloud Config 将所有微æœ�务的é…�置文件集中存储在一个外部的存储仓库或系统(例如 Git)中,统一管ç�†ã€‚ +* Spring Cloud Config é…�置中心将é…�置以 REST 接å�£çš„å½¢å¼�暴露给å�„个微æœ�务,以方便å�„个微æœ�务获å�–。 +* å¾®æœ�务å�¯ä»¥é€šè¿‡ Spring Cloud Config å�‘é…�置中心统一拉å�–属于它们自己的é…�置信æ�¯ã€‚ +* 当é…�ç½®å�‘生å�˜åŒ–时,微æœ�务ä¸�需è¦�é‡�å�¯å�³å�¯æ„ŸçŸ¥åˆ°é…�置的å�˜åŒ–,并自动获å�–和应用最新é…�置。 +* 一个应用å�¯èƒ½æœ‰å¤šä¸ªçŽ¯å¢ƒï¼Œä¾‹å¦‚å¼€å�‘(dev)环境ã€�测试(test)环境ã€�生产(prod)环境等等,开å�‘人员å�¯ä»¥é€šè¿‡ Spring Cloud Config 对ä¸�å�ŒçŽ¯å¢ƒçš„å�„é…�置进行管ç�†ï¼Œä¸”能够确ä¿�应用在环境è¿�ç§»å�Žä»�然有完整的é…�置支æŒ�其正常è¿�行。 -ÏÂÃæÎÒÃǾÍͨ¹ý¼¸¸öʵÀýÀ´ÑÝʾ Spring Cloud Config µÄʹÓᣠ+下é�¢æˆ‘们就通过几个实例æ�¥æ¼”示 Spring Cloud Config 的使用。 -## ´î½¨ Config ·þÎñ¶Ë +## æ�­å»º Config æœ�务端 -1\. ÔÚ Github ÉÏ´´½¨Ò»¸öÃûΪ springcloud-config µÄ²Ö¿â£¨Repository£©²¢»ñÈ¡¸Ã²Ö¿âµÄµØÖ·¡£ÓÉÓÚ Github Õ¾µã¶ÔÓÚ¹úÄÚÓû§À´Ëµ²»¹»Îȶ¨£¬ºÜ¿ÉÄÜ´æÔÚ¼ÓÔØ»ºÂýµÈÎÊÌ⣬Òò´ËÎÒÃÇ¿ÉÒÔÔÚ[ÂëÔÆ](https://gitee.com/)ÉÏÖ´ÐиòÙ×÷¡£ +1\. 在 Github 上创建一个å��为 springcloud-config 的仓库(Repository)并获å�–该仓库的地å�€ã€‚由于 Github 站点对于国内用户æ�¥è¯´ä¸�够稳定,很å�¯èƒ½å­˜åœ¨åŠ è½½ç¼“æ…¢ç­‰é—®é¢˜ï¼Œå› æ­¤æˆ‘ä»¬å�¯ä»¥åœ¨[ç �云](https://gitee.com/)上执行该æ“�作。 -2\. ÔÚ¸¸¹¤³Ì spring-cloud-demo2 Ï£¬´´½¨Ò»¸öÃûΪ micro-service-cloud-config-center-3344 µÄ Spring Boot Ä£¿é£¬²¢ÔÚ pom.xml ÖÐÌí¼Ó Spring Cloud Config ·þÎñ¶ËÒÀÀµ£¬ÅäÖÃÈçÏ¡£ +2\. 在父工程 spring-cloud-demo2 下,创建一个å��为 micro-service-cloud-config-center-3344 çš„ Spring Boot 模å�—,并在 pom.xml 中添加 Spring Cloud Config æœ�务端ä¾�赖,é…�置如下。 @@ -87,7 +87,7 @@ Spring Cloud Config spring-boot-starter-test test - + org.springframework.cloud spring-cloud-config-server @@ -119,7 +119,7 @@ Spring Cloud Config -3\. ÔÚ micro-service-cloud-config-center-3344 Àà·¾¶£¨/resources Ŀ¼£©Ï£¬´´½¨Ò»¸öÃûΪ application.yml µÄÅäÖÃÎļþ£¬ÅäÖÃÈçÏ¡£ +3\. 在 micro-service-cloud-config-center-3344 类路径(/resources 目录)下,创建一个å��为 application.yml çš„é…�置文件,é…�置如下。 @@ -128,38 +128,38 @@ Spring Cloud Config ``` server: - port: 3344 #¶Ë¿ÚºÅ + port: 3344 #端å�£å�· spring: application: - name: spring-cloud-config-center #·þÎñÃû + name: spring-cloud-config-center #æœ�务å�� cloud: config: server: git: - # Git µØÖ·£¬https://gitee.com/java-mohan/springcloud-config.git - # ÂëÔÆ£¨gitee£©µØÖ· uri: https://github.com/javmohan/springcloud-config.git (github Õ¾µã·ÃÎʽÏÂý£¬Òò´ËÕâÀïÎÒÃÇʹÓà gitee) + # Git 地å�€ï¼Œhttps://gitee.com/java-mohan/springcloud-config.git + # ç �云(gitee)地å�€ uri: https://github.com/javmohan/springcloud-config.git (github 站点访问较慢,因此这里我们使用 gitee) uri: https://gitee.com/java-mohan/springcloud-config.git - #²Ö¿âÃû + #仓库å�� search-paths: - springcloud-config force-pull: true - # Èç¹ûGit²Ö¿âΪ¹«¿ª²Ö¿â£¬¿ÉÒÔ²»ÌîдÓû§ÃûºÍÃÜÂ룬Èç¹ûÊÇ˽ÓвֿâÐèÒªÌîд + # 如果Git仓库为公开仓库,å�¯ä»¥ä¸�填写用户å��和密ç �,如果是ç§�有仓库需è¦�填写 # username: ******** # password: ******** - #·ÖÖ§Ãû + #分支å�� label: master eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka ¼¯Èº + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka 集群 ``` -4\. ÔÚ micro-service-cloud-config-center-3344 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableConfigServer ×¢½â¿ªÆô Spring Cloud Config ÅäÖÃÖÐÐŦÄÜ£¬´úÂëÈçÏ¡£ +4\. 在 micro-service-cloud-config-center-3344 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableConfigServer 注解开å�¯ Spring Cloud Config é…�置中心功能,代ç �如下。 @@ -190,7 +190,7 @@ public class MicroServiceCloudConfigCenter3344Application { -5\. н¨Ò»¸öÃûΪ config-dev.yml µÄÎļþ£¬²¢½«ÆäÉÏ´«µ½ springcloud-config ²Ö¿â master ·ÖÖ§Ï£¬config-dev.yml µÄÄÚÈÝÈçÏ¡£ +5\. 新建一个å��为 config-dev.yml 的文件,并将其上传到 springcloud-config 仓库 master 分支下,config-dev.yml 的内容如下。 ``` config: @@ -199,44 +199,44 @@ config: ``` -6\. ÒÀ´ÎÆô¶¯·þÎñ×¢²áÖÐÐÄ£¨¼¯Èº£©ºÍ micro-service-cloud-config-center-3344£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3344/master/config-dev.yml¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. ä¾�次å�¯åЍæœ�务注册中心(集群)和 micro-service-cloud-config-center-3344,使用æµ�览器访问“http://localhost:3344/master/config-dev.ymlâ€�,结果如下图。 -![Spring Cloud Config ·ÃÎÊÅäÖÃÎļþ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019423313-2.png) -ͼ2£º·ÃÎÊÅäÖÃÎļþ +![Spring Cloud Config 访问é…�置文件](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019423313-2.png) +图2:访问é…�置文件 -Spring Cloud Config ¹æ¶¨ÁËÒ»Ì×ÅäÖÃÎļþ·ÃÎʹæÔò£¬ÈçÏÂ±í¡£ +Spring Cloud Config 规定了一套é…�置文件访问规则,如下表。 -| ·ÃÎʹæÔò | ʾÀý | +| 访问规则 | 示例 | | ----------------------------------------- | ---------------------- | | /{application}/{profile}[/{label}] | /config/dev/master | | /{application}-{profile}.{suffix} | /config-dev.yml | | /{label}/{application}-{profile}.{suffix} | /master/config-dev.yml | -·ÃÎʹæÔòÄÚ¸÷²ÎÊý˵Ã÷ÈçÏ¡£ +访问规则内å�„å�‚数说明如下。 -* {application}£ºÓ¦ÓÃÃû³Æ£¬¼´ÅäÖÃÎļþµÄÃû³Æ£¬ÀýÈç config-dev¡£ -* {profile}£º»·¾³Ãû£¬Ò»¸öÏîĿͨ³£¶¼Óпª·¢£¨dev£©°æ±¾¡¢²âÊÔ£¨test£©»·¾³°æ±¾¡¢Éú²ú£¨prod£©»·¾³°æ±¾£¬ÅäÖÃÎļþÔòÒÔ application-{profile}.yml µÄÐÎʽ½øÐÐÇø·Ö£¬ÀýÈç application-dev.yml¡¢application-test.yml¡¢application-prod.yml µÈ¡£ -* {label}£ºGit ·ÖÖ§Ãû£¬Ä¬ÈÏÊÇ master ·ÖÖ§£¬µ±·ÃÎÊĬÈÏ·Ö֧ϵÄÅäÖÃÎļþʱ£¬¸Ã²ÎÊý¿ÉÒÔÊ¡ÂÔ£¬¼´µÚ¶þÖÖ·ÃÎÊ·½Ê½¡£ -* {suffix}£ºÅäÖÃÎļþµÄºó׺£¬ÀýÈç config-dev.yml µÄºó׺Ϊ yml¡£ +* {application}:应用å��称,å�³é…�置文件的å��称,例如 config-dev。 +* {profile}:环境å��,一个项目通常都有开å�‘(dev)版本ã€�测试(test)环境版本ã€�生产(prod)环境版本,é…�置文件则以 application-{profile}.yml 的形å¼�进行区分,例如 application-dev.ymlã€�application-test.ymlã€�application-prod.yml 等。 +* {label}:Git 分支å��,默认是 master 分支,当访问默认分支下的é…�置文件时,该å�‚æ•°å�¯ä»¥çœ�略,å�³ç¬¬äºŒç§�访问方å¼�。 +* {suffix}:é…�置文件的å�Žç¼€ï¼Œä¾‹å¦‚ config-dev.yml çš„å�Žç¼€ä¸º yml。 -ͨ¹ýÕâÌ×¹æÔò£¬ÎÒÃÇÔÚä¯ÀÀÆ÷ÉϾÍÖ±½Ó¶ÔÅäÖÃÎļþ½øÐзÃÎÊ¡£ +通过这套规则,我们在æµ�览器上就直接对é…�置文件进行访问。 -7\. ÔÚä¯ÀÀÆ÷ÉÏ·ÃÎÊ¡°http://localhost:3344/config-dev.yml¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. 在æµ�览器上访问“http://localhost:3344/config-dev.ymlâ€�,结果如下图。 -![Spring Cloud Config ·ÃÎÊÅäÖÃÎļþ2](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422606-3.png) -ͼ3£ºSpring Cloud Config ·ÃÎÊÅäÖÃÎļþ +![Spring Cloud Config 访问é…�置文件2](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422606-3.png) +图3:Spring Cloud Config 访问é…�置文件 -8\. ÔÚä¯ÀÀÆ÷ÉÏ·ÃÎÊ¡°http://localhost:3344/config/dev/master¡±£¬½á¹ûÈçÏ¡£ +8\. 在æµ�览器上访问“http://localhost:3344/config/dev/masterâ€�,结果如下。 ``` {"name":"config","profiles":["dev"],"label":"master","version":"9caafcc3498e04147463482f8b29e925e8afcc3a","state":null,"propertySources":[{"name":"https://gitee.com/java-mohan/springcloud-config.git/config-dev.yml","source":{"config.info":"c.biancheng.net","config.version":1.0}}]} ``` -×Ô´ËÎÒÃǾÍÍê³ÉÁË¶Ô Spring Cloud Config ·þÎñ¶ËµÄ´î½¨ºÍ²âÊÔ¡£ +自此我们就完æˆ�了对 Spring Cloud Config æœ�务端的æ�­å»ºå’Œæµ‹è¯•。 -## ´î½¨ Config ¿Í»§¶Ë +## æ�­å»º Config 客户端 -1\. ÔÚ¸¸¹¤³Ì spring-cloud-demo2 Ï£¬´´½¨Ò»¸öÃûΪ micro-service-cloud-config-client-3355 µÄ Spring Boot Ä£¿é£¬²¢ÔÚÆä pom.xml ÖÐÌí¼Ó Spring Cloud Config ¿Í»§¶ËµÄÒÀÀµ£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +1\. 在父工程 spring-cloud-demo2 下,创建一个å��为 micro-service-cloud-config-client-3355 çš„ Spring Boot 模å�—,并在其 pom.xml 中添加 Spring Cloud Config 客户端的ä¾�赖,é…�置内容如下。 @@ -283,7 +283,7 @@ Spring Cloud Config test - + org.springframework.cloud spring-cloud-starter-config @@ -317,38 +317,38 @@ Spring Cloud Config -2\. ÔÚ micro-service-cloud-config-client-3355 ÖÐÀà·¾¶£¨/resources Ŀ¼£©Ï£¬´´½¨Ò»¸öÃûΪ bootstrap.yml µÄÅäÖÃÎļþ£¬ÅäÖÃÈçÏ¡£ +2\. 在 micro-service-cloud-config-client-3355 中类路径(/resources 目录)下,创建一个å��为 bootstrap.yml çš„é…�置文件,é…�置如下。 ``` -#bootstrap.yml ÊÇϵͳ¼¶±ðµÄ£¬¼ÓÔØÓÅÏȼ¶¸ßÓÚ application.yml £¬¸ºÔð´ÓÍⲿ¼ÓÔØÅäÖò¢½âÎö +#bootstrap.yml 是系统级别的,加载优先级高于 application.yml ,负责从外部加载é…�置并解æž� server: - port: 3355 #¶Ë¿ÚºÅ + port: 3355 #端å�£å�· spring: application: - name: spring-cloud-config-client #·þÎñÃû + name: spring-cloud-config-client #æœ�务å�� cloud: config: - label: master #·ÖÖ§Ãû³Æ - name: config #ÅäÖÃÎļþÃû³Æ£¬config-dev.yml ÖÐµÄ config - profile: dev #»·¾³Ãû config-dev.yml ÖÐµÄ dev - #ÕâÀï²»ÒªÍü¼ÇÌí¼Ó http:// ·ñÔòÎÞ·¨¶ÁÈ¡ - uri: http://localhost:3344 #Spring Cloud Config ·þÎñ¶Ë£¨ÅäÖÃÖÐÐÄ£©µØÖ· + label: master #分支å��ç§° + name: config #é…�置文件å��称,config-dev.yml 中的 config + profile: dev #环境å�� config-dev.yml 中的 dev + #这里ä¸�è¦�忘记添加 http:// å�¦åˆ™æ— æ³•读å�– + uri: http://localhost:3344 #Spring Cloud Config æœ�务端(é…�置中心)地å�€ eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka ¼¯Èº + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka 集群 ``` -3\. ÔÚ net.biancheng.c.controller °üÏ£¬´´½¨Ò»¸öÃûΪ ConfigClientController µÄÀ࣬ͨ¹ý¸ÃÀà»ñÈ¡ÅäÖÃÎļþÖеÄÅäÖ㬴úÂëÈçÏ¡£ +3\. 在 net.biancheng.c.controller 包下,创建一个å��为 ConfigClientController 的类,通过该类获å�–é…�置文件中的é…�置,代ç �如下。 @@ -362,7 +362,7 @@ import org.springframework.beans.factory.annotation.Value; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; -//¶ÁÈ¡ÅäÖÃÖÐÐÄÖ¸¶¨ÅäÖÃÎļþµÄÄÚÈÝ£¬²¢Õ¹Ê¾µ½Ò³Ãæ +//读å�–é…�置中心指定é…�置文件的内容,并展示到页é�¢ @RestController public class ConfigClientController { @Value("${server.port}") @@ -376,7 +376,7 @@ public class ConfigClientController { @GetMapping(value = "/getConfig") public String getConfig() { - return "info£º" + configInfo + "
version£º" + configVersion + "
port£º" + serverPort; + return "info:" + configInfo + "
version:" + configVersion + "
port:" + serverPort; } } ``` @@ -385,7 +385,7 @@ public class ConfigClientController { -4\. ÔÚ micro-service-cloud-config-client-3355 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableEurekaClient ×¢½â¿ªÆô Eureka ¿Í»§¶Ë¹¦ÄÜ£¬´úÂëÈçÏ¡£ +4\. 在 micro-service-cloud-config-client-3355 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableEurekaClient 注解开å�¯ Eureka 客户端功能,代ç �如下。 @@ -415,12 +415,12 @@ public class MicroServiceCloudConfigClient3355Application { -5\. Æô¶¯ micro-service-cloud-config-client-3355£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3355/getConfig¡±,½á¹ûÈçÏÂͼ¡£ +5\. å�¯åЍ micro-service-cloud-config-client-3355,使用æµ�览器访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![Config ¿Í»§¶Ë»ñÈ¡ÅäÖÃÐÅÏ¢](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422604-4.png) -ͼ4£ºSpring Cloud Config ¿Í»§¶Ë»ñÈ¡ÅäÖÃÐÅÏ¢ +![Config 客户端获å�–é…�置信æ�¯](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422604-4.png) +图4:Spring Cloud Config 客户端获å�–é…�置信æ�¯ -6\. ½«ÅäÖÃÎļþ config-dev.yml ÖÐ config.version µÄÖµÐÞ¸ÄΪ 2.0£¬ÅäÖÃÈçÏ¡£ +6\. å°†é…�置文件 config-dev.yml 中 config.version 的值修改为 2.0,é…�置如下。 ``` config: @@ -429,33 +429,33 @@ config: ``` -7\. ÒÀ´ÎÆô¶¯ Eureka ·þÎñ×¢²áÖÐÐÄ£¨¼¯Èº£©ºÍ micro-service-cloud-config-center-3344£¬ ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3344/master/config-dev.yml¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. ä¾�次å�¯åЍ Eureka æœ�务注册中心(集群)和 micro-service-cloud-config-center-3344, 使用æµ�览器访问“http://localhost:3344/master/config-dev.ymlâ€�,结果如下图。 -![ÅäÖÃÖÐÐÄ»ñÈ¡Ð޸ĺóµÄÅäÖÃÎļþ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194255O-5.png) -ͼ5£ºÅäÖÃÖÐÐÄ»ñÈ¡Ð޸ĺóµÄÅäÖÃÎļþ +![é…�置中心获å�–修改å�Žçš„é…�置文件](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194255O-5.png) +图5:é…�置中心获å�–修改å�Žçš„é…�置文件 -´Óͼ 6 ¿ÉÒÔ¿´³ö£¬ÅäÖÃÖÐÐÄÒѾ­³É¹¦µØ»ñÈ¡µ½ÁËÐ޸ĺóµÄÅäÖᣠ+从图 6 å�¯ä»¥çœ‹å‡ºï¼Œé…�置中心已ç»�æˆ�功地获å�–到了修改å�Žçš„é…�置。 -8\. ÔٴηÃÎÊ¡°http://localhost:3355/getConfig¡±£¬³¢ÊÔͨ¹ý Spring Cloud Config ¿Í»§¶Ë»ñÈ¡Ð޸ĺóµÄÅäÖÃÐÅÏ¢£¬½á¹ûÈçÏÂͼ¡£ +8\. å†�次访问“http://localhost:3355/getConfigâ€�,å°�试通过 Spring Cloud Config 客户端获å�–修改å�Žçš„é…�置信æ�¯ï¼Œç»“果如下图。 -![Config ¿Í»§¶Ë»ñÈ¡ÅäÖÃÐÅÏ¢](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422604-4.png) -ͼ6£ºSpring Cloud Config ¿Í»§¶Ë»ñÈ¡Ð޸ĺóµÄÅäÖÃÐÅÏ¢ +![Config 客户端获å�–é…�置信æ�¯](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422604-4.png) +图6:Spring Cloud Config 客户端获å�–修改å�Žçš„é…�置信æ�¯ -9\. ÖØÆô micro-service-cloud-config-client-3355£¬ÔÙ´ÎʹÓ÷ÃÎÊ¡°http://localhost:3355/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +9\. é‡�å�¯ micro-service-cloud-config-client-3355,å†�次使用访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![ÖØÆôConfig ¿Í»§¶Ë](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019425023-7.png) -ͼ7£ºÖØÆô Spring Cloud Config ¿Í»§¶Ë»ñÈ¡ÅäÖà +![é‡�å�¯Config 客户端](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019425023-7.png) +图7:é‡�å�¯ Spring Cloud Config 客户端获å�–é…�ç½® -ͨ¹ý¸ÃʵÀý£¬ÎÒÃÇ¿ÉÒԵõ½ÒÔÏ 2 µã½áÂÛ£¬ +通过该实例,我们å�¯ä»¥å¾—到以下 2 点结论, -* ÅäÖøüкó£¬Spring Cloud Config ·þÎñ¶Ë£¨Server£©¿ÉÒÔÖ±½Ó´Ó Git ²Ö¿âÖлñÈ¡×îеÄÅäÖᣠ-* ³ý·ÇÖØÆô Spring Cloud Config ¿Í»§¶Ë£¨Client£©£¬·ñÔòÎÞ·¨Í¨¹ý Spring Cloud Config ·þÎñ¶Ë»ñÈ¡×îеÄÅäÖÃÐÅÏ¢¡£ +* é…�置更新å�Žï¼ŒSpring Cloud Config æœ�务端(Server)å�¯ä»¥ç›´æŽ¥ä»Ž Git 仓库中获å�–最新的é…�置。 +* 除é�žé‡�å�¯ Spring Cloud Config 客户端(Client),å�¦åˆ™æ— æ³•通过 Spring Cloud Config æœ�务端获å�–最新的é…�置信æ�¯ã€‚ -## ÊÖ¶¯Ë¢ÐÂÅäÖà +## 手动刷新é…�ç½® -ΪÁ˽â¾ö²»ÖØÆô Config ¿Í»§¶ËÎÞ·¨»ñÈ¡×îÐÂÅäÖõÄÎÊÌ⣬½ÓÏÂÀ´£¬ÎÒÃÇ¾Í¶Ô micro-service-cloud-config-client-3355 ½øÐиÄÔ죬¸ÄÔì²½ÖèÈçÏ¡£ +为了解决ä¸�é‡�å�¯ Config 客户端无法获å�–最新é…�置的问题,接下æ�¥ï¼Œæˆ‘们就对 micro-service-cloud-config-client-3355 进行改造,改造步骤如下。 -1\. ÔÚ micro-service-cloud-config-client-3355 µÄ pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ£¬ÒýÈë Spring Boot actuator ¼à¿ØÄ£¿é¡£ +1\. 在 micro-service-cloud-config-client-3355 çš„ pom.xml 中添加以下ä¾�赖,引入 Spring Boot actuator 监控模å�—。 @@ -475,7 +475,7 @@ config: -2\. ÔÚÅäÖÃÎļþ bootstrap.yml ÖÐÌí¼ÓÒÔÏÂÅäÖ㬶ÔÍⱩ¶ Spring Boot actuator µÄ¼à¿Ø½Úµã¡£ +2\. 在é…�置文件 bootstrap.yml 中添加以下é…�置,对外暴露 Spring Boot actuator 的监控节点。 @@ -483,12 +483,12 @@ config: ``` -# Spring Boot 2.50¶Ô actuator ¼à¿ØÆÁ±ÎÁË´ó¶àÊýµÄ½Úµã£¬Ö»±©Â¶ÁË health ½Úµã£¬±¾¶ÎÅäÖã¨*£©¾ÍÊÇΪÁË¿ªÆôËùÓеĽڵã +# Spring Boot 2.50对 actuator 监控å±�蔽了大多数的节点,å�ªæš´éœ²äº† health 节点,本段é…�置(*)就是为了开å�¯æ‰€æœ‰çš„节点 management: endpoints: web: exposure: - include: "*" # * ÔÚyaml ÎļþÊôÓڹؼü×Ö£¬ËùÒÔÐèÒª¼ÓÒýºÅ + include: "*" # * 在yaml 文件属于关键字,所以需è¦�加引å�· ``` @@ -497,7 +497,7 @@ management: -3\. ÔÚ ConfigClientController ÀàÉÏʹÓà @RefreshScope ×¢½â¿ªÆôÅäÖÃˢУ¬´úÂëÈçÏ¡£ +3\. 在 ConfigClientController 类上使用 @RefreshScope 注解开å�¯é…�置刷新,代ç �如下。 @@ -512,8 +512,8 @@ import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; -// ¶ÁÈ¡ÅäÖÃÖÐÐÄÖ¸¶¨ÅäÖÃÎļþµÄÄÚÈÝ£¬²¢Õ¹Ê¾µ½Ò³Ãæ -@RefreshScope //ΪÁËÈö¯Ì¬£¨ÊÖ¶¯£©µÄ»ñÈ¡×îеÄgit ÅäÖã¬ÔÚÌí¼Ó actuator ¼à¿Ø¼ÓÔØ RefreshScope£¬ +// 读å�–é…�置中心指定é…�置文件的内容,并展示到页é�¢ +@RefreshScope //为了让动æ€�(手动)的获å�–最新的git é…�置,在添加 actuator 监控加载 RefreshScope, @RestController public class ConfigClientController { @Value("${server.port}") @@ -527,7 +527,7 @@ public class ConfigClientController { @GetMapping(value = "/getConfig") public String getConfig() { - return "info£º" + configInfo + "
version£º" + configVersion + "
port£º" + serverPort; + return "info:" + configInfo + "
version:" + configVersion + "
port:" + serverPort; } } ``` @@ -536,7 +536,7 @@ public class ConfigClientController { -4\. ÖØÆô micro-service-cloud-config-client-3355£¬È»ºó½«ÅäÖÃÎļþ config-dev.yml ÖÐµÄ config.version ÐÞ¸ÄΪ 3.0£¬ÅäÖÃÈçÏ¡£ +4\. é‡�å�¯ micro-service-cloud-config-client-3355,然å�Žå°†é…�置文件 config-dev.yml 中的 config.version 修改为 3.0,é…�置如下。 ``` config: @@ -545,69 +545,69 @@ config: ``` -5\. ʹÓÃä¯ÀÀÆ÷ÔٴηÃÎÊ¡°http://localhost:3355/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +5\. 使用æµ�览器å†�次访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![ÖØÆôConfig ¿Í»§¶Ë](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019425023-7.png) -ͼ8£ºÖØÆô Spring Cloud Config ¿Í»§¶Ëºó»ñÈ¡ÅäÖà +![é‡�å�¯Config 客户端](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019425023-7.png) +图8:é‡�å�¯ Spring Cloud Config 客户端å�ŽèŽ·å�–é…�ç½® -´Óͼ 9 ¿ÉÒÔ¿´³ö£¬¼´Ê¹ÎÒÃÇ¶Ô Spring Cloud Config ¿Í»§¶Ë½øÐÐÁ˸ÄÔ죬ҲÒÀÈ»ÎÞ·¨Ö±½Ó»ñÈ¡µ½×îÐÂÅäÖᣠ+从图 9 å�¯ä»¥çœ‹å‡ºï¼Œå�³ä½¿æˆ‘们对 Spring Cloud Config 客户端进行了改造,也ä¾�然无法直接获å�–到最新é…�置。 -6\. ´ò¿ªÃüÁîÐд°¿Ú£¬Ê¹ÓÃÒÔÏÂÃüÁî·¢ËÍÒ»¸ö POST ÇëÇóˢРSpring Cloud Config 3355 ¿Í»§¶Ë£¬Í¨Öª¿Í»§¶ËÅäÖÃÎļþÒѾ­Ð޸ģ¬ÐèÒªÖØÐÂÀ­È¥ÅäÖᣠ+6\. 打开命令行窗å�£ï¼Œä½¿ç”¨ä»¥ä¸‹å‘½ä»¤å�‘é€�一个 POST 请求刷新 Spring Cloud Config 3355 客户端,通知客户端é…�置文件已ç»�修改,需è¦�é‡�新拉去é…�置。 ```curl -X POST "http://localhost:3355/actuator/refresh"``` -7. ʹÓÃä¯ÀÀÆ÷ÔٴηÃÎÊ¡°http://localhost:3355/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +7. 使用æµ�览器å†�次访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![ÊÖ¶¯Ë¢ÐÂ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101942C62-9.png) -ͼ9£ºÊÖ¶¯Ë¢Ð¿ͻ§¶Ë +![手动刷新](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101942C62-9.png) +图9:手动刷新客户端 -#### ÊÖ¶¯Ë¢ÐÂÅäÖõÄÎÊÌâ +#### 手动刷新é…�置的问题 -ÔÚÉÏÃæµÄʵÀýÖУ¬ÎÒÃÇͨ¹ýÔÚ Config ¿Í»§¶Ë£¨¶Ë¿ÚºÅ£º3355£©ÖÐÒýÈë Spring Boot actuator ¼à¿Ø×é¼þÀ´¼à¿ØÅäÖõı仯£¬Ê¹ÎÒÃÇ¿ÉÒÔÔÚ²»ÖØÆô Config ¿Í»§¶ËµÄÇé¿öÏ»ñÈ¡µ½ÁË×îÐÂÅäÖã¬Ô­ÀíÈçÏÂͼ¡£ +在上é�¢çš„实例中,我们通过在 Config 客户端(端å�£å�·ï¼š3355)中引入 Spring Boot actuator 监控组件æ�¥ç›‘控é…�置的å�˜åŒ–,使我们å�¯ä»¥åœ¨ä¸�é‡�å�¯ Config 客户端的情况下获å�–到了最新é…�置,原ç�†å¦‚下图。 -![Spring Cloud Config ÊÖ¶¯Ë¢ÐÂ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019424S8-10.png) -ͼ10£ºSpring Cloud Congfig ÊÖ¶¯Ë¢Ð +![Spring Cloud Config 手动刷新](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019424S8-10.png) +图10:Spring Cloud Congfig 手动刷新 -ÕâÖÖ·½Ê½ËäÈ»½â¾öÁËÖØÆô Config ¿Í»§¶Ë²ÅÄÜ»ñÈ¡×îÐÂÅäÖõÄÎÊÌ⣬µ«ÁíÒ»¸öÎÊÌâÈ´Ò²½Óõà¶øÖÁ£¬ÄǾÍÊÇÖ»ÒªÅäÖòֿâÖеÄÅäÖ÷¢Éú¸Ä±ä£¬¾ÍÐèÒªÎÒÃǰ¤¸öÏò Config ¿Í»§¶ËÊÖ¶¯·¢ËÍ POST ÇëÇó£¬Í¨ÖªËüÃÇÖØÐÂÀ­È¡ÅäÖᣠ+è¿™ç§�æ–¹å¼�虽然解决了é‡�å�¯ Config 客户端æ‰�能获å�–最新é…�置的问题,但å�¦ä¸€ä¸ªé—®é¢˜å�´ä¹ŸæŽ¥è¸µè€Œè‡³ï¼Œé‚£å°±æ˜¯å�ªè¦�é…�置仓库中的é…�ç½®å�‘生改å�˜ï¼Œå°±éœ€è¦�我们挨个å�‘ Config 客户端手动å�‘é€� POST 请求,通知它们é‡�新拉å�–é…�置。 -ÎÒÃÇÖªµÀ£¬ËùνµÄ Config ¿Í»§¶ËÆäʵ¾ÍÊÇÒ»¸öÒ»¸öµÄ·þÎñ¡£ÔÚ΢·þÎñ¼Ü¹¹ÖУ¬Ò»¸öϵͳÍùÍù°üº¬Ê®¼¸ÉõÖÁ¼¸Ê®¸ö·þÎñ£¬Èç¹ûÒòΪijһ¸öÅäÖÃÎļþµÄÐ޸ĶøÏò¼¸Ê®¸ö΢·þÎñ·¢ËÍ POST ÇëÇó£¬ÕâÏÔÈ»ÊDz»ºÏÀíµÄ¡£ +我们知é�“,所谓的 Config 客户端其实就是一个一个的æœ�务。在微æœ�务架构中,一个系统往往包å�«å��几甚至几å��个æœ�务,如果因为æŸ�一个é…�置文件的修改而å�‘几å��个微æœ�务å�‘é€� POST 请求,这显然是ä¸�å�ˆç�†çš„。 -ÄÇôÓÐûÓС°Ò»´Î֪ͨ£¬´¦´¦ÉúЧ¡±µÄ·½Ê½ÄØ£¿´ð°¸Êǿ϶¨µÄ¡£Spring Cloud Config ÅäºÏ Bus ¾Í¿ÉÒÔʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð¡£ +那么有没有“一次通知,处处生效â€�的方å¼�呢?答案是肯定的。Spring Cloud Config é…�å�ˆ Bus å°±å�¯ä»¥å®žçްé…�置的动æ€�刷新。 -## Config+Bus ʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð +## Config+Bus 实现é…�置的动æ€�刷新 -Spring Cloud Bus ÓÖ±»³ÆÎªÏûÏ¢×ÜÏߣ¬ËüÄܹ»Í¨¹ýÇáÁ¿¼¶µÄÏûÏ¢´úÀí£¨ÀýÈç RabbitMQ¡¢Kafka µÈ£©½«Î¢·þÎñ¼Ü¹¹Öеĸ÷¸ö·þÎñÁ¬½ÓÆðÀ´£¬ÊµÏֹ㲥״̬¸ü¸Ä¡¢Ê¼þÍÆË͵ȹ¦ÄÜ£¬»¹¿ÉÒÔʵÏÖ΢·þÎñÖ®¼äµÄͨÐŹ¦ÄÜ¡£ +Spring Cloud Bus å�ˆè¢«ç§°ä¸ºæ¶ˆæ�¯æ€»çº¿ï¼Œå®ƒèƒ½å¤Ÿé€šè¿‡è½»é‡�级的消æ�¯ä»£ç�†ï¼ˆä¾‹å¦‚ RabbitMQã€�Kafka 等)将微æœ�务架构中的å�„个æœ�务连接起æ�¥ï¼Œå®žçŽ°å¹¿æ’­çŠ¶æ€�更改ã€�事件推é€�等功能,还å�¯ä»¥å®žçް微æœ�务之间的通信功能。 -Ŀǰ Spring Cloud Bus Ö§³ÖÁ½ÖÖÏûÏ¢´úÀí£ºRabbitMQ ºÍ Kafka¡£ +ç›®å‰� Spring Cloud Bus 支æŒ�两ç§�消æ�¯ä»£ç�†ï¼šRabbitMQ å’Œ Kafka。 -#### Spring Cloud Bus µÄ»ù±¾Ô­Àí +#### Spring Cloud Bus 的基本原ç�† -Spring Cloud Bus »áʹÓÃÒ»¸öÇáÁ¿¼¶µÄÏûÏ¢´úÀíÀ´¹¹½¨Ò»¸ö¹«¹²µÄÏûÏ¢Ö÷Ìâ Topic£¨Ä¬ÈÏΪ¡°springCloudBus¡±£©£¬Õâ¸ö Topic ÖеÄÏûÏ¢»á±»ËùÓзþÎñʵÀý¼àÌýºÍÏû·Ñ¡£µ±ÆäÖеÄÒ»¸ö·þÎñË¢ÐÂÊý¾Ýʱ£¬Spring Cloud Bus »á°ÑÐÅÏ¢±£´æµ½ Topic ÖУ¬ÕâÑù¼àÌýÕâ¸ö Topic µÄ·þÎñ¾ÍÊÕµ½ÏûÏ¢²¢×Ô¶¯Ïû·Ñ¡£ +Spring Cloud Bus 会使用一个轻é‡�级的消æ�¯ä»£ç�†æ�¥æž„建一个公共的消æ�¯ä¸»é¢˜ Topic(默认为“springCloudBusâ€�),这个 Topic 中的消æ�¯ä¼šè¢«æ‰€æœ‰æœ�务实例监å�¬å’Œæ¶ˆè´¹ã€‚当其中的一个æœ�务刷新数æ�®æ—¶ï¼ŒSpring Cloud Bus 会把信æ�¯ä¿�存到 Topic 中,这样监å�¬è¿™ä¸ª Topic çš„æœ�务就收到消æ�¯å¹¶è‡ªåŠ¨æ¶ˆè´¹ã€‚ -#### Spring Cloud Bus ¶¯Ì¬Ë¢ÐÂÅäÖõÄÔ­Àí +#### Spring Cloud Bus 动æ€�刷新é…�置的原ç�† -ÀûÓà Spring Cloud Bus µÄÌØÊâ»úÖÆ¿ÉÒÔʵÏֺܶ๦ÄÜ£¬ÆäÖÐÅäºÏ Spring Cloud Config ʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð¾ÍÊÇ×îµäÐ͵ÄÓ¦Óó¡¾°Ö®Ò»¡£ +利用 Spring Cloud Bus 的特殊机制å�¯ä»¥å®žçŽ°å¾ˆå¤šåŠŸèƒ½ï¼Œå…¶ä¸­é…�å�ˆ Spring Cloud Config 实现é…�置的动æ€�刷新就是最典型的应用场景之一。 -µ± Git ²Ö¿âÖеÄÅäÖ÷¢ÉúÁ˸ı䣬ÎÒÃÇÖ»ÐèÒªÏòijһ¸ö·þÎñ£¨¼È¿ÉÒÔÊÇ Config ·þÎñ¶Ë£¬Ò²¿ÉÒÔÊÇ Config ¿Í»§¶Ë£©·¢ËÍÒ»¸ö POST ÇëÇó£¬Spring Cloud Bus ¾Í¿ÉÒÔͨ¹ýÏûÏ¢´úÀí֪ͨÆäËû·þÎñÖØÐÂÀ­È¡×îÐÂÅäÖã¬ÒÔʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð¡£ +当 Git 仓库中的é…�ç½®å�‘生了改å�˜ï¼Œæˆ‘们å�ªéœ€è¦�å�‘æŸ�一个æœ�务(既å�¯ä»¥æ˜¯ Config æœ�务端,也å�¯ä»¥æ˜¯ Config 客户端)å�‘é€�一个 POST 请求,Spring Cloud Bus å°±å�¯ä»¥é€šè¿‡æ¶ˆæ�¯ä»£ç�†é€šçŸ¥å…¶ä»–æœ�务é‡�新拉å�–最新é…�置,以实现é…�置的动æ€�刷新。 -Spring Cloud Bus ¶¯Ì¬Ë¢ÐÂÅäÖõŤ×÷Ô­Àí£¬ÈçÏÂͼËùʾ¡£ +Spring Cloud Bus 动æ€�刷新é…�置的工作原ç�†ï¼Œå¦‚下图所示。 -![bus+config ¶¯Ì¬Ë¢ÐÂÅäÖÃ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101942GY-11.png) -ͼ11£ºBus+Config ʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð +![bus+config 动æ€�刷新é…�ç½®](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101942GY-11.png) +图11:Bus+Config 实现é…�置的动æ€�刷新 -¸ù¾Ýͼ 12£¬ÀûÓà Spring Cloud Bus ʵÏÖÅäÖõĶ¯Ì¬Ë¢ÐÂÐèÒªÒÔϲ½Öè: +æ ¹æ�®å›¾ 12,利用 Spring Cloud Bus 实现é…�置的动æ€�刷新需è¦�以下步骤: -1. µ± Git ²Ö¿âÖеÄÅäÖ÷¢Éú¸Ä±äºó£¬ÔËάÈËÔ±Ïò Config ·þÎñ¶Ë·¢ËÍÒ»¸ö POST ÇëÇó£¬ÇëÇ󷾶Ϊ¡°/actuator/refresh¡±¡£ -2. Config ·þÎñ¶Ë½ÓÊÕµ½ÇëÇóºó£¬»á½«¸ÃÇëÇóת·¢¸ø·þÎñ×ÜÏß Spring Cloud Bus¡£ -3. Spring Cloud Bus ½Óµ½ÏûÏ¢ºó£¬»á֪ͨ¸øËùÓÐ Config ¿Í»§¶Ë¡£ -4. Config ¿Í»§¶Ë½ÓÊÕµ½Í¨Öª£¬ÇëÇó Config ·þÎñ¶ËÀ­È¡×îÐÂÅäÖᣠ-5. ËùÓÐ Config ¿Í»§¶Ë¶¼»ñÈ¡µ½×îеÄÅäÖᣠ+1. 当 Git 仓库中的é…�ç½®å�‘生改å�˜å�Žï¼Œè¿�维人员å�‘ Config æœ�务端å�‘é€�一个 POST 请求,请求路径为“/actuator/refreshâ€�。 +2. Config æœ�务端接收到请求å�Žï¼Œä¼šå°†è¯¥è¯·æ±‚转å�‘ç»™æœ�务总线 Spring Cloud Bus。 +3. Spring Cloud Bus 接到消æ�¯å�Žï¼Œä¼šé€šçŸ¥ç»™æ‰€æœ‰ Config 客户端。 +4. Config 客户端接收到通知,请求 Config æœ�务端拉å�–最新é…�置。 +5. 所有 Config 客户端都获å�–到最新的é…�置。 -#### Spring Cloud Bus ¶¯Ì¬Ë¢ÐÂÅäÖã¨È«¾Ö¹ã²¥£© +#### Spring Cloud Bus 动æ€�刷新é…�置(全局广播) -ÏÂÃæÎÒÃÇÒÔ RabbitMQ ΪÀý£¬À´ÑÝʾÈçºÎʹÓà Config+Bus ʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð¡£ +下é�¢æˆ‘们以 RabbitMQ 为例,æ�¥æ¼”示如何使用 Config+Bus 实现é…�置的动æ€�刷新。 -1\. ÔÚ micro-service-cloud-config-center-3344 µÄ pom.xml ÖУ¬Ìí¼Ó Spring Boot actuator ¼à¿ØÄ£¿éºÍ Spring Cloud Bus µÄÒÀÀµ£¬´úÂëÈçÏ¡£ +1\. 在 micro-service-cloud-config-center-3344 çš„ pom.xml 中,添加 Spring Boot actuator 监控模å�—å’Œ Spring Cloud Bus çš„ä¾�赖,代ç �如下。 @@ -615,12 +615,12 @@ Spring Cloud Bus ``` - + org.springframework.cloud spring-cloud-starter-bus-amqp - + org.springframework.boot spring-boot-starter-actuator @@ -632,14 +632,14 @@ Spring Cloud Bus -2\. ÔÚ micro-service-cloud-config-center-3344 µÄÅäÖÃÎļþ application.yml ÖУ¬Ìí¼Ó RabbitMQ ºÍ Spring Boot actuator µÄÏà¹ØÅäÖã¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2\. 在 micro-service-cloud-config-center-3344 çš„é…�置文件 application.yml 中,添加 RabbitMQ å’Œ Spring Boot actuator 的相关é…�置,é…�置内容如下。 ``` -##### RabbitMQ Ïà¹ØÅäÖã¬15672 ÊÇweb ¹ÜÀí½çÃæµÄ¶Ë¿Ú£¬5672 ÊÇ MQ µÄ·ÃÎʶ˿Ú########### +##### RabbitMQ 相关é…�置,15672 是web 管ç�†ç•Œé�¢çš„端å�£ï¼Œ5672 是 MQ 的访问端å�£########### spring: rabbitmq: host: 127.0.0.1 @@ -647,7 +647,7 @@ spring: username: guest password: guest -# Spring Boot 2.50¶Ô actuator ¼à¿ØÆÁ±ÎÁË´ó¶àÊýµÄ½Úµã£¬Ö»±©Â¶ÁË heath ½Úµã£¬±¾¶ÎÅäÖã¨*£©¾ÍÊÇΪÁË¿ªÆôËùÓеĽڵã +# Spring Boot 2.50对 actuator 监控å±�蔽了大多数的节点,å�ªæš´éœ²äº† heath 节点,本段é…�置(*)就是为了开å�¯æ‰€æœ‰çš„节点 management: endpoints: web: @@ -660,7 +660,7 @@ management: -3\. ÔÚ micro-service-cloud-config-client-3355 µÄ pom.xml ÖУ¬Ìí¼Ó Spring Cloud Bus µÄÏà¹ØÒÀÀµ£¬´úÂëÈçÏ¡£ +3\. 在 micro-service-cloud-config-client-3355 çš„ pom.xml 中,添加 Spring Cloud Bus 的相关ä¾�赖,代ç �如下。 @@ -669,7 +669,7 @@ management: ``` -1. +1. 2. 3. org.springframework.cloud 4. spring-cloud-starter-bus-amqp @@ -681,7 +681,7 @@ management: -4. ÔÚ micro-service-cloud-config-client-3355 µÄÅäÖÃÎļþ bootstrap.yml ÖÐÌí¼ÓÒÔÏÂÅäÖᣠ+4. 在 micro-service-cloud-config-client-3355 çš„é…�置文件 bootstrap.yml 中添加以下é…�置。 @@ -689,7 +689,7 @@ management: ``` - + org.springframework.cloud spring-cloud-starter-bus-amqp @@ -701,7 +701,7 @@ management: -5\. ²ÎÕÕ micro-service-cloud-config-client-3355£¬Ð½¨Ò»¸öÃûΪ micro-service-cloud-config-client-bus-3366 µÄ Spring Boot Ä£¿é£¨¶Ë¿ÚºÅΪ 3366£©£¬²¢ÔÚÆäÅäÖÃÎļþ bootstrap.yml ÖÐÌí¼ÓÒÔÏÂÅäÖᣠ+5\. å�‚ç…§ micro-service-cloud-config-client-3355,新建一个å��为 micro-service-cloud-config-client-bus-3366 çš„ Spring Boot 模å�—(端å�£å�·ä¸º 3366),并在其é…�置文件 bootstrap.yml 中添加以下é…�置。 @@ -709,39 +709,39 @@ management: ``` -#bootstrap.yml ÊÇϵͳ¼¶±ðµÄ£¬¼ÓÔØÓÅÏȼ¶¸ßÓÚ application.yml £¬¸ºÔð´ÓÍⲿ¼ÓÔØÅäÖò¢½âÎö +#bootstrap.yml 是系统级别的,加载优先级高于 application.yml ,负责从外部加载é…�置并解æž� server: - port: 3366 #¶Ë¿ÚºÅΪ 3366 + port: 3366 #端å�£å�·ä¸º 3366 spring: application: name: spring-cloud-config-client-bus cloud: config: - label: master #·ÖÖ§Ãû³Æ - name: config #ÅäÖÃÎļþÃû³Æ£¬config-dev.yml ÖÐµÄ config - profile: dev #ÅäÖÃÎļþµÄºó׺Ãû config-dev.yml ÖÐµÄ dev - #ÕâÀï²»ÒªÍü¼ÇÌí¼Ó http:// ·ñÔòÎÞ·¨¶ÁÈ¡ - uri: http://localhost:3344 #spring cloud ÅäÖÃÖÐÐĵØÖ· + label: master #分支å��ç§° + name: config #é…�置文件å��称,config-dev.yml 中的 config + profile: dev #é…�置文件的å�Žç¼€å�� config-dev.yml 中的 dev + #这里ä¸�è¦�忘记添加 http:// å�¦åˆ™æ— æ³•读å�– + uri: http://localhost:3344 #spring cloud é…�置中心地å�€ -##### RabbitMQ Ïà¹ØÅäÖã¬15672 ÊÇweb ¹ÜÀí½çÃæµÄ¶Ë¿Ú£¬5672 ÊÇ MQ µÄ·ÃÎʶ˿Ú########### +##### RabbitMQ 相关é…�置,15672 是web 管ç�†ç•Œé�¢çš„端å�£ï¼Œ5672 是 MQ 的访问端å�£########### rabbitmq: host: 127.0.0.1 port: 5672 username: guest password: guest -###################### eureka ÅäÖà #################### +###################### eureka é…�ç½® #################### eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka ¼¯Èº + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka 集群 -# Spring Boot 2.50¶Ô actuator ¼à¿ØÆÁ±ÎÁË´ó¶àÊýµÄ½Úµã£¬Ö»±©Â¶ÁË heath ½Úµã£¬±¾¶ÎÅäÖã¨*£©¾ÍÊÇΪÁË¿ªÆôËùÓеĽڵã +# Spring Boot 2.50对 actuator 监控å±�蔽了大多数的节点,å�ªæš´éœ²äº† heath 节点,本段é…�置(*)就是为了开å�¯æ‰€æœ‰çš„节点 management: endpoints: web: exposure: - include: "*" # * ÔÚyaml ÎļþÊôÓڹؼü×Ö£¬ËùÒÔÐèÒª¼ÓÒýºÅ + include: "*" # * 在yaml 文件属于关键字,所以需è¦�加引å�· ``` @@ -749,17 +749,17 @@ management: -6\. ÒÀ´ÎÖØÆô micro-service-cloud-config-center-3344¡¢micro-service-cloud-config-client-3355£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3355/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. ä¾�次é‡�å�¯ micro-service-cloud-config-center-3344ã€�micro-service-cloud-config-client-3355,使用æµ�览器访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![Bus ¶¯Ì¬ÅäÖøüÐÂ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422S4-12.png) -ͼ12£ºSpring Cloud Bus ¶¯Ì¬Ë¢ÐÂÅäÖà +![Bus 动æ€�é…�置更新](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019422S4-12.png) +图12:Spring Cloud Bus 动æ€�刷新é…�ç½® -7\. Æô¶¯ micro-service-cloud-config-client-bus-3366£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3366/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. å�¯åЍ micro-service-cloud-config-client-bus-3366,使用æµ�览器访问“http://localhost:3366/getConfigâ€�,结果如下图。 -![Bus ¶¯Ì¬¸üÐÂ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194254S-13.png) -ͼ13£ºSpring Cloud Bus ¶¯Ì¬Ë¢ÐÂÅäÖà +![Bus 动æ€�æ›´æ–°](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194254S-13.png) +图13:Spring Cloud Bus 动æ€�刷新é…�ç½® -8. ½«ÅäÖÃÎļþ config-dev.yml ÖÐµÄ config.version ÐÞ¸ÄΪ 4.0£¬ÅäÖÃÈçÏ¡£ +8. å°†é…�置文件 config-dev.yml 中的 config.version 修改为 4.0,é…�置如下。 ``` config: @@ -768,39 +768,39 @@ config: ``` -9\. ´ò¿ªÃüÁîÐд°¿Ú£¬Ê¹ÓÃÒÔÏÂÃüÁîÏò micro-service-cloud-config-center-3344£¨Config Server£©·¢ËÍÒ»¸ö POST ÇëÇó£¬Ë¢ÐÂÅäÖᣠ+9\. 打开命令行窗å�£ï¼Œä½¿ç”¨ä»¥ä¸‹å‘½ä»¤å�‘ micro-service-cloud-config-center-3344(Config Server)å�‘é€�一个 POST 请求,刷新é…�置。 ```curl -X POST "http://localhost:3344/actuator/bus-refresh"``` -10. ʹÓÃä¯ÀÀÆ÷ÔٴηÃÎÊ¡°http://localhost:3355/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +10. 使用æµ�览器å†�次访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![bus ¶¯Ì¬Ë¢ÐÂÅäÖÃ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019423453-14.png) -ͼ14£ºSpring Cloud Bus ¶¯Ì¬Ë¢Ð +![bus 动æ€�刷新é…�ç½®](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1019423453-14.png) +图14:Spring Cloud Bus 动æ€�刷新 -11. ʹÓÃä¯ÀÀÆ÷ÔٴηÃÎÊ¡°http://localhost:3366/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +11. 使用æµ�览器å†�次访问“http://localhost:3366/getConfigâ€�,结果如下图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194222Y-15.png) -ͼ15£ºSpring Cloud Bus ¶¯Ì¬Ë¢Ð +图15:Spring Cloud Bus 动æ€�刷新 -> ×¢Ò⣺ÔÚʹÓà Spring Cloud Bus ʱ£¬±ØÐë±£Ö¤ Bus ËùÁ¬½ÓµÄÏûÏ¢´úÀíÈí¼þ£¨ÀýÈç RabbitMQ£©ÒѾ­ÕýÈ·°²×°ÇÒÔËÐÐÕý³£¡£ +> 注æ„�:在使用 Spring Cloud Bus 时,必须ä¿�è¯� Bus 所连接的消æ�¯ä»£ç�†è½¯ä»¶ï¼ˆä¾‹å¦‚ RabbitMQ)已ç»�正确安装且è¿�行正常。 -#### Spring Cloud Bus ¶¯Ì¬Ë¢ÐÂÅäÖ㨶¨µã֪ͨ£© +#### Spring Cloud Bus 动æ€�刷新é…�置(定点通知) -Ëùν¶¨µã֪ͨ£¬¾ÍÊDz»ÔÙ֪ͨËùÓÐµÄ Config ¿Í»§¶Ë£¬¶øÊǸù¾ÝÐèÇóֻ֪ͨÆäÖÐijһ¸ö Config ¿Í»§¶Ë¡£ +所谓定点通知,就是ä¸�å†�通知所有的 Config 客户端,而是根æ�®éœ€æ±‚å�ªé€šçŸ¥å…¶ä¸­æŸ�一个 Config 客户端。 -ʹÓà Spring Cloud Bus ʵÏÖ¶¨µã֪ͨµÄ·½·¨Ê®·Ö¼òµ¥£¬Ö»ÒªÎÒÃÇÔÚ·¢ËÍ POST ÇëÇóʱʹÓÃÒÔϸñʽ¼´¿É¡£ +使用 Spring Cloud Bus 实现定点通知的方法å��分简å�•,å�ªè¦�我们在å�‘é€� POST 请求时使用以下格å¼�å�³å�¯ã€‚ ```http://{hostname}:{port}/actuator/bus-refresh/{destination}``` -²ÎÊý˵Ã÷ÈçÏ£º +å�‚数说明如下: -* {hostname}£º ±íʾ Config ·þÎñ¶ËµÄÖ÷»úµØÖ·£¬¼È¿ÉÒÔÊÇÓòÃû£¬Ò²¿ÉÒÔÊÇ IP µØÖ·¡£ -* {port}£º±íʾ Config ·þÎñ¶ËµÄ¶Ë¿ÚºÅ. -* {destination}£º±íʾÐèÒª¶¨µã֪ͨµÄ Config ¿Í»§¶Ë£¨Î¢·þÎñ£©£¬ÓÉ Config ¿Í»§¶ËµÄ·þÎñÃû£¨spring.application.name£©+¶Ë¿ÚºÅ£¨server.port£©×é³É£¬ÀýÈçֻ֪ͨ micro-service-cloud-config-client-3355 Ë¢ÐÂÅäÖã¬ÔòȡֵΪ spring-cloud-config-client:3355¡£ +* {hostname}: 表示 Config æœ�务端的主机地å�€ï¼Œæ—¢å�¯ä»¥æ˜¯åŸŸå��,也å�¯ä»¥æ˜¯ IP 地å�€ã€‚ +* {port}:表示 Config æœ�务端的端å�£å�·. +* {destination}:表示需è¦�定点通知的 Config 客户端(微æœ�务),由 Config 客户端的æœ�务å��(spring.application.name)+端å�£å�·ï¼ˆserver.port)组æˆ�,例如å�ªé€šçŸ¥ micro-service-cloud-config-client-3355 刷新é…�置,则å�–值为 spring-cloud-config-client:3355。 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸ö¼òµ¥µÄʵÀý£¬À´ÑÝʾÏ Spring Cloud Bus ¶¯Ì¬Ë¢ÐµĶ¨µã֪ͨ¡£ +下é�¢æˆ‘们就通过一个简å�•的实例,æ�¥æ¼”示下 Spring Cloud Bus 动æ€�刷新的定点通知。 -1\. ½«ÅäÖÃÎļþ config-dev.yml ÖÐµÄ config.version ÐÞ¸ÄΪ 5.0£¬ÅäÖÃÈçÏ¡£ +1\. å°†é…�置文件 config-dev.yml 中的 config.version 修改为 5.0,é…�置如下。 ``` config: @@ -809,22 +809,22 @@ config: ``` -2\. ´ò¿ªÃüÁîÐд°¿Ú£¬Ê¹ÓÃÒÔÏÂÃüÁîÏò micro-service-cloud-config-center-3344 ·¢ËÍÒ»¸ö POST ÇëÇó¡£ +2\. 打开命令行窗å�£ï¼Œä½¿ç”¨ä»¥ä¸‹å‘½ä»¤å�‘ micro-service-cloud-config-center-3344 å�‘é€�一个 POST 请求。 ```curl -X POST "http://localhost:3344/actuator/bus-refresh/spring-cloud-config-client:3355"``` -3\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3355/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +3\. 使用æµ�览器访问“http://localhost:3355/getConfigâ€�,结果如下图。 -![Bus ¶¨µã֪ͨ 3355](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194233O-16.png) -ͼ16£ºSpring Cloud Bus ¶¨µã֪ͨ +![Bus 定点通知 3355](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194233O-16.png) +图16:Spring Cloud Bus 定点通知 -4\. ʹÓÃä¯ÀÀÆ÷ÔٴηÃÎÊ¡°http://localhost:3366/getConfig¡±£¬½á¹ûÈçÏÂͼ¡£ +4\. 使用æµ�览器å†�次访问“http://localhost:3366/getConfigâ€�,结果如下图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10194222Y-15.png) -ͼ17£ºSpring Cloud Bus ¶¨µã֪ͨ +图17:Spring Cloud Bus 定点通知 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConsul.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConsul.md" index 85fcf19..a3a5b7a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConsul.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudConsul.md" @@ -1,27 +1,27 @@ -Spring Cloud Consul Ϊ SpringBoot Ó¦ÓÃÌṩÁË ConsulµÄÖ§³Ö£¬Consul¼È¿ÉÒÔ×÷Ϊע²áÖÐÐÄʹÓã¬Ò²¿ÉÒÔ×÷ΪÅäÖÃÖÐÐÄʹÓ㬱¾ÎĽ«¶ÔÆäÓ÷¨½øÐÐÏêϸ½éÉÜ¡£ +Spring Cloud Consul 为 SpringBoot 应用æ��供了 Consul的支æŒ�,Consulæ—¢å�¯ä»¥ä½œä¸ºæ³¨å†Œä¸­å¿ƒä½¿ç”¨ï¼Œä¹Ÿå�¯ä»¥ä½œä¸ºé…�置中心使用,本文将对其用法进行详细介ç»�。 -# Consul ¼ò½é +# Consul 简介 -ConsulÊÇHashiCorp¹«Ë¾ÍƳöµÄ¿ªÔ´Èí¼þ£¬ÌṩÁË΢·þÎñϵͳÖеķþÎñÖÎÀí¡¢ÅäÖÃÖÐÐÄ¡¢¿ØÖÆ×ÜÏߵȹ¦ÄÜ¡£ÕâЩ¹¦ÄÜÖеÄÿһ¸ö¶¼¿ÉÒÔ¸ù¾ÝÐèÒªµ¥¶ÀʹÓã¬Ò²¿ÉÒÔÒ»ÆðʹÓÃÒÔ¹¹½¨È«·½Î»µÄ·þÎñÍø¸ñ£¬×ÜÖ®ConsulÌṩÁËÒ»ÖÖÍêÕûµÄ·þÎñÍø¸ñ½â¾ö·½°¸¡£ +Consul是HashiCorpå…¬å�¸æŽ¨å‡ºçš„å¼€æº�软件,æ��供了微æœ�务系统中的æœ�务治ç�†ã€�é…�置中心ã€�控制总线等功能。这些功能中的æ¯�一个都å�¯ä»¥æ ¹æ�®éœ€è¦�å�•独使用,也å�¯ä»¥ä¸€èµ·ä½¿ç”¨ä»¥æž„建全方ä½�çš„æœ�务网格,总之Consulæ��供了一ç§�完整的æœ�务网格解决方案。 -Spring Cloud Consul ¾ßÓÐÈçÏÂÌØÐÔ£º +Spring Cloud Consul 具有如下特性: -- Ö§³Ö·þÎñÖÎÀí£ºConsul×÷Ϊע²áÖÐÐÄʱ£¬Î¢·þÎñÖеÄÓ¦ÓÿÉÒÔÏòConsul×¢²á×Ô¼º£¬²¢ÇÒ¿ÉÒÔ´ÓConsul»ñÈ¡ÆäËûÓ¦ÓÃÐÅÏ¢£» -- Ö§³Ö¿Í»§¶Ë¸ºÔð¾ùºâ£º°üÀ¨RibbonºÍSpring Cloud LoadBalancer£» -- Ö§³ÖZuul£ºµ±Zuul×÷ÎªÍø¹ØÊ±£¬¿ÉÒÔ´ÓConsulÖÐ×¢²áºÍ·¢ÏÖÓ¦Óã» -- Ö§³Ö·Ö²¼Ê½ÅäÖùÜÀí£ºConsul×÷ΪÅäÖÃÖÐÐÄʱ£¬Ê¹ÓüüÖµ¶ÔÀ´´æ´¢ÅäÖÃÐÅÏ¢£» -- Ö§³Ö¿ØÖÆ×ÜÏߣº¿ÉÒÔÔÚÕû¸ö΢·þÎñϵͳÖÐͨ¹ý Control Bus ·Ö·¢Ê¼þÏûÏ¢¡£ +- 支æŒ�æœ�务治ç�†ï¼šConsul作为注册中心时,微æœ�务中的应用å�¯ä»¥å�‘Consul注册自己,并且å�¯ä»¥ä»ŽConsul获å�–其他应用信æ�¯ï¼› +- 支æŒ�客户端负责å�‡è¡¡ï¼šåŒ…括Ribbonå’ŒSpring Cloud LoadBalancerï¼› +- 支æŒ�Zuul:当Zuul作为网关时,å�¯ä»¥ä»ŽConsul中注册和å�‘现应用; +- 支æŒ�分布å¼�é…�置管ç�†ï¼šConsul作为é…�置中心时,使用键值对æ�¥å­˜å‚¨é…�置信æ�¯ï¼› +- 支æŒ�控制总线:å�¯ä»¥åœ¨æ•´ä¸ªå¾®æœ�务系统中通过 Control Bus 分å�‘事件消æ�¯ã€‚ -# ʹÓÃConsul×÷Ϊע²áÖÐÐÄ +# 使用Consul作为注册中心 -# °²×°²¢ÔËÐÐConsul +# 安装并è¿�行Consul -- Ê×ÏÈÎÒÃÇ´Ó¹ÙÍøÏÂÔØConsul£¬µØÖ·£ºhttps://www.consul.io/downloads.html +- 首先我们从官网下载Consul,地å�€ï¼šhttps://www.consul.io/downloads.html -- ÏÂÔØÍê³ÉºóÖ»ÓÐÒ»¸öexeÎļþ£¬Ë«»÷ÔËÐУ» -- ÔÚÃüÁîÐÐÖÐÊäÈëÒÔÏÂÃüÁî¿ÉÒԲ鿴°æ±¾ºÅ£º +- 下载完æˆ�å�Žå�ªæœ‰ä¸€ä¸ªexe文件,å�Œå‡»è¿�行; +- 在命令行中输入以下命令å�¯ä»¥æŸ¥çœ‹ç‰ˆæœ¬å�·ï¼š @@ -29,7 +29,7 @@ Spring Cloud Consul -- ²é¿´°æ±¾ºÅÐÅÏ¢ÈçÏ£º +- 查看版本å�·ä¿¡æ�¯å¦‚下: @@ -37,7 +37,7 @@ Spring Cloud Consul Protocol 2 spoken by default, understands 2 to 3 (agent will automatically use protocol >2 when speaking to compatible agents) -- ʹÓÿª·¢Ä£Ê½Æô¶¯£º +- 使用开å�‘模å¼�å�¯åŠ¨ï¼š @@ -48,16 +48,16 @@ Spring Cloud Consul -- ͨ¹ýÒÔϵØÖ·¿ÉÒÔ·ÃÎÊConsulµÄÊ×Ò³£ºhttp://localhost:8500 +- 通过以下地å�€å�¯ä»¥è®¿é—®Consul的首页:http://localhost:8500 -# ´´½¨Ó¦ÓÃ×¢²áµ½Consul +# 创建应用注册到Consul -ÎÒÃÇͨ¹ý¸ÄÔìuser-serviceºÍribbon-serviceÀ´ÑÝʾÏ·þÎñ×¢²áÓë·¢ÏֵŦÄÜ£¬Ö÷ÒªÊǽ«Ó¦ÓÃÔ­À´µÄEureka×¢²áÖÐÐÄÖ§³Ö¸ÄΪConsul×¢²áÖÐÐÄÖ§³Ö¡£ +我们通过改造user-serviceå’Œribbon-serviceæ�¥æ¼”示下æœ�务注册与å�‘现的功能,主è¦�是将应用原æ�¥çš„Eureka注册中心支æŒ�改为Consul注册中心支æŒ�。 -- ´´½¨consul-user-serviceÄ£¿éºÍconsul-ribbon-serviceÄ£¿é£» -- ÐÞ¸ÄÏà¹ØÒÀÀµ£¬°ÑÔ­À´µÄEureka×¢²á·¢ÏÖµÄÒÀÀµ¸ÄΪConsulµÄ£¬²¢Ìí¼ÓSpringBoot ActuatorµÄÒÀÀµ£º +- 创建consul-user-service模å�—å’Œconsul-ribbon-service模å�—ï¼› +- 修改相关ä¾�赖,把原æ�¥çš„Eureka注册å�‘现的ä¾�赖改为Consul的,并添加SpringBoot Actuatorçš„ä¾�赖: @@ -73,7 +73,7 @@ Spring Cloud Consul -- ÐÞ¸ÄÅäÖÃÎļþapplication.yml£¬½«EurekaµÄ×¢²á·¢ÏÖÅäÖøÄΪConsulµÄ£º +- 修改é…�置文件application.yml,将Eureka的注册å�‘现é…�置改为Consul的: @@ -83,7 +83,7 @@ Spring Cloud Consul application: name: consul-user-service cloud: - consul: #Consul·þÎñ×¢²á·¢ÏÖÅäÖà + consul: #Consulæœ�务注册å�‘现é…�ç½® host: localhost port: 8500 discovery: @@ -92,30 +92,30 @@ Spring Cloud Consul -- ÔËÐÐÁ½¸öconsul-user-serviceºÍÒ»¸öconsul-ribbon-service£¬ÔÚConsulÒ³ÃæÉÏ¿ÉÒÔ¿´µ½ÈçÏÂÐÅÏ¢£º +- è¿�行两个consul-user-service和一个consul-ribbon-service,在Consul页é�¢ä¸Šå�¯ä»¥çœ‹åˆ°å¦‚下信æ�¯ï¼š -# ¸ºÔؾùºâ¹¦ÄÜ +# è´Ÿè½½å�‡è¡¡åŠŸèƒ½ -ÓÉÓÚÎÒÃÇÔËÐÐÁËÁ½¸öconsul-user-service£¬¶øconsul-ribbon-serviceĬÈÏ»áÈ¥µ÷ÓÃËüµÄ½Ó¿Ú£¬ÎÒÃǵ÷ÓÃconsul-ribbon-serviceµÄ½Ó¿ÚÀ´ÑÝʾϸºÔؾùºâ¹¦ÄÜ¡£ +由于我们è¿�行了两个consul-user-service,而consul-ribbon-service默认会去调用它的接å�£ï¼Œæˆ‘们调用consul-ribbon-service的接å�£æ�¥æ¼”示下负载å�‡è¡¡åŠŸèƒ½ã€‚ -¶à´Îµ÷Óýӿڣºhttp://localhost:8308/user/1 £¬¿ÉÒÔ·¢ÏÖÁ½¸öconsul-user-serviceµÄ¿ØÖÆÌ¨½»Ìæ´òÓ¡ÈçÏÂÐÅÏ¢¡£ +多次调用接å�£ï¼šhttp://localhost:8308/user/1 ,å�¯ä»¥å�‘现两个consul-user-service的控制å�°äº¤æ›¿æ‰“å�°å¦‚下信æ�¯ã€‚ - 2019-10-20 10:39:32.580 INFO 12428 --- [io-8206-exec-10] c.macro.cloud.controller.UserController : ¸ù¾Ýid»ñÈ¡Óû§ÐÅÏ¢£¬Óû§Ãû³ÆÎª£ºmacro + 2019-10-20 10:39:32.580 INFO 12428 --- [io-8206-exec-10] c.macro.cloud.controller.UserController : æ ¹æ�®id获å�–用户信æ�¯ï¼Œç”¨æˆ·å��称为:macro -# ʹÓÃConsul×÷ΪÅäÖÃÖÐÐÄ +# 使用Consul作为é…�置中心 -ÎÒÃÇͨ¹ý´´½¨consul-config-clientÄ£¿é£¬²¢ÔÚConsulÖÐÌí¼ÓÅäÖÃÐÅÏ¢À´ÑÝʾÏÂÅäÖùÜÀíµÄ¹¦ÄÜ¡£ +我们通过创建consul-config-client模å�—,并在Consul中添加é…�置信æ�¯æ�¥æ¼”示下é…�置管ç�†çš„功能。 -# ´´½¨consul-config-clientÄ£¿é +# 创建consul-config-client模å�— -- ÔÚpom.xmlÖÐÌí¼ÓÏà¹ØÒÀÀµ£º +- 在pom.xml中添加相关ä¾�赖: @@ -130,7 +130,7 @@ Spring Cloud Consul -- Ìí¼ÓÅäÖÃÎļþapplication.yml£¬ÆôÓõÄÊÇdev»·¾³µÄÅäÖ㺠+- 添加é…�置文件application.yml,å�¯ç”¨çš„æ˜¯dev环境的é…�置: @@ -141,7 +141,7 @@ Spring Cloud Consul -- Ìí¼ÓÅäÖÃÎļþbootstrap.yml£¬Ö÷ÒªÊǶÔConsulµÄÅäÖù¦ÄܽøÐÐÅäÖ㺠+- 添加é…�置文件bootstrap.yml,主è¦�是对Consulçš„é…�置功能进行é…�置: @@ -157,14 +157,14 @@ Spring Cloud Consul discovery: serviceName: consul-config-client config: - enabled: true #ÊÇ·ñÆôÓÃÅäÖÃÖÐÐŦÄÜ - format: yaml #ÉèÖÃÅäÖÃÖµµÄ¸ñʽ - prefix: config #ÉèÖÃÅäÖÃËùÔÚĿ¼ - profile-separator: ':' #ÉèÖÃÅäÖõķָô·û - data-key: data #ÅäÖÃkeyµÄÃû×Ö£¬ÓÉÓÚConsulÊÇK/V´æ´¢£¬ÅäÖô洢ÔÚ¶ÔÓ¦KµÄVÖÐ + enabled: true #是å�¦å�¯ç”¨é…�置中心功能 + format: yaml #设置é…�置值的格å¼� + prefix: config #设置é…�置所在目录 + profile-separator: ':' #设置é…�置的分隔符 + data-key: data #é…�ç½®keyçš„å��字,由于Consul是K/V存储,é…�置存储在对应Kçš„V中 -- ´´½¨ConfigClientController£¬´ÓConsulÅäÖÃÖÐÐÄÖлñÈ¡ÅäÖÃÐÅÏ¢£º +- 创建ConfigClientController,从Consulé…�置中心中获å�–é…�置信æ�¯ï¼š @@ -185,9 +185,9 @@ Spring Cloud Consul } -# ÔÚConsulÖÐÌí¼ÓÅäÖà +# 在Consul中添加é…�ç½® -- ÔÚconsulÖÐÌí¼ÓÅäÖô洢µÄkeyΪ: +- 在consul中添加é…�置存储的key为: @@ -197,7 +197,7 @@ Spring Cloud Consul -- ÔÚconsulÖÐÌí¼ÓÅäÖô洢µÄvalueΪ£º +- 在consul中添加é…�置存储的value为: @@ -207,11 +207,11 @@ Spring Cloud Consul -- ´æ´¢ÐÅÏ¢½ØÍ¼ÈçÏ£º +- 存储信æ�¯æˆªå›¾å¦‚下: -- Æô¶¯consul-config-client£¬µ÷Óýӿڲ鿴ÅäÖÃÐÅÏ¢£ºhttp://localhost:9101/configInfo +- å�¯åЍconsul-config-client,调用接å�£æŸ¥çœ‹é…�置信æ�¯ï¼šhttp://localhost:9101/configInfo @@ -220,26 +220,26 @@ Spring Cloud Consul -# ConsulµÄ¶¯Ì¬Ë¢ÐÂÅäÖà +# Consul的动æ€�刷新é…�ç½® -ÎÒÃÇÖ»ÒªÐÞ¸ÄÏÂConsulÖеÄÅäÖÃÐÅÏ¢£¬Ôٴε÷Óò鿴ÅäÖõĽӿڣ¬¾Í»á·¢ÏÖÅäÖÃÒѾ­Ë¢Ð¡£»ØÏëÏÂÔÚʹÓÃSpring Cloud ConfigµÄʱºò£¬ÎÒÃÇÐèÒªµ÷Óýӿڣ¬Í¨¹ýSpring Cloud Bus²ÅÄÜË¢ÐÂÅäÖá£ConsulʹÓÃÆä×Ô´øµÄControl Bus ʵÏÖÁËÒ»ÖÖʼþ´«µÝ»úÖÆ£¬´Ó¶øÊµÏÖÁ˶¯Ì¬Ë¢Ð¹¦ÄÜ¡£ +我们å�ªè¦�修改下Consul中的é…�置信æ�¯ï¼Œå†�次调用查看é…�置的接å�£ï¼Œå°±ä¼šå�‘现é…�置已ç»�刷新。回想下在使用Spring Cloud Config的时候,我们需è¦�调用接å�£ï¼Œé€šè¿‡Spring Cloud Busæ‰�能刷新é…�置。Consul使用其自带的Control Bus 实现了一ç§�事件传递机制,从而实现了动æ€�刷新功能。 -# ʹÓõ½µÄÄ£¿é +# 使用到的模å�— springcloud-learning - ©À©¤©¤ consul-config-client -- ÓÃÓÚÑÝʾconsul×÷ΪÅäÖÃÖÐÐĵÄconsul¿Í»§¶Ë - ©À©¤©¤ consul-user-service -- ×¢²áµ½consulµÄÌṩUser¶ÔÏóCRUD½Ó¿ÚµÄ·þÎñ - ©¸©¤©¤ consul-service -- ×¢²áµ½consulµÄribbon·þÎñµ÷ÓòâÊÔ·þÎñ + ├── consul-config-client -- 用于演示consul作为é…�置中心的consul客户端 + ├── consul-user-service -- 注册到consulçš„æ��ä¾›User对象CRUD接å�£çš„æœ�务 + └── consul-service -- 注册到consulçš„ribbonæœ�务调用测试æœ�务 -# ÏîĿԴÂëµØÖ· +# 项目æº�ç �地å�€ https://github.com/macrozheng/springcloud-learning -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudEureka.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudEureka.md" index 960e5c7..d088f0b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudEureka.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudEureka.md" @@ -1,52 +1,52 @@ -Eureka Ò»´ÊÀ´Ô´ÓÚ¹ÅÏ£À°´Ê»ã£¬ÊÇ¡°·¢ÏÖÁË¡±µÄÒâ˼¡£ÔÚÈí¼þÁìÓò£¬Eureka ÊÇ Netflix ¹«Ë¾¿ª·¢µÄÒ»¿î¿ªÔ´µÄ·þÎñ×¢²áÓë·¢ÏÖ×é¼þ¡£ +Eureka 一è¯�æ�¥æº�于å�¤å¸Œè…Šè¯�汇,是“å�‘现了â€�çš„æ„�æ€�。在软件领域,Eureka 是 Netflix å…¬å�¸å¼€å�‘的一款开æº�çš„æœ�务注册与å�‘现组件。 -Spring Cloud ½« Eureka Óë Netflix ÖÐµÄÆäËû¿ªÔ´·þÎñ×é¼þ£¨ÀýÈç Ribbon¡¢Feign ÒÔ¼° Hystrix µÈ£©Ò»ÆðÕûºÏ½ø Spring Cloud Netflix Ä£¿éÖУ¬ÕûºÏºóµÄ×é¼þÈ«³ÆÎª Spring Cloud Netflix Eureka¡£ +Spring Cloud å°† Eureka 与 Netflix 中的其他开æº�æœ�务组件(例如 Ribbonã€�Feign 以å�Š Hystrix 等)一起整å�ˆè¿› Spring Cloud Netflix 模å�—中,整å�ˆå�Žçš„组件全称为 Spring Cloud Netflix Eureka。 -Eureka ÊÇ Spring Cloud Netflix Ä£¿éµÄ×ÓÄ£¿é£¬ËüÊÇ Spring Cloud ¶Ô Netflix Eureka µÄ¶þ´Î·â×°£¬Ö÷Òª¸ºÔð Spring Cloud µÄ·þÎñ×¢²áÓë·¢ÏÖ¹¦ÄÜ¡£ +Eureka 是 Spring Cloud Netflix 模å�—çš„å­�模å�—,它是 Spring Cloud 对 Netflix Eureka 的二次å°�装,主è¦�è´Ÿè´£ Spring Cloud çš„æœ�务注册与å�‘现功能。 -Spring Cloud ʹÓà Spring Boot ˼ÏëΪ Eureka Ôö¼ÓÁË×Ô¶¯»¯ÅäÖ㬿ª·¢ÈËÔ±Ö»ÐèÒªÒýÈëÏà¹ØÒÀÀµºÍ×¢½â£¬¾ÍÄܽ« Spring Boot ¹¹½¨µÄ΢·þÎñÇáËɵØÓë Eureka ½øÐÐÕûºÏ¡£ +Spring Cloud 使用 Spring Boot æ€�想为 Eureka 增加了自动化é…�置,开å�‘人员å�ªéœ€è¦�引入相关ä¾�赖和注解,就能将 Spring Boot 构建的微æœ�务轻æ�¾åœ°ä¸Ž Eureka 进行整å�ˆã€‚ -## Eureka Á½´ó×é¼þ +## Eureka 两大组件 -Eureka ²ÉÓà CS£¨Client/Server£¬¿Í»§¶Ë/·þÎñÆ÷£© ¼Ü¹¹£¬Ëü°üÀ¨ÒÔÏÂÁ½´ó×é¼þ£º +Eureka 采用 CS(Client/Server,客户端/æœ�务器) 架构,它包括以下两大组件: -* **Eureka Server**£ºEureka ·þÎñ×¢²áÖÐÐÄ£¬Ö÷ÒªÓÃÓÚÌṩ·þÎñ×¢²á¹¦ÄÜ¡£µ±Î¢·þÎñÆô¶¯Ê±£¬»á½«×Ô¼ºµÄ·þÎñ×¢²áµ½ Eureka Server¡£Eureka Server ά»¤ÁËÒ»¸ö¿ÉÓ÷þÎñÁÐ±í£¬´æ´¢ÁËËùÓÐ×¢²áµ½ Eureka Server µÄ¿ÉÓ÷þÎñµÄÐÅÏ¢£¬ÕâЩ¿ÉÓ÷þÎñ¿ÉÒÔÔÚ Eureka Server µÄ¹ÜÀí½çÃæÖÐÖ±¹Û¿´µ½¡£ -* **Eureka Client**£ºEureka ¿Í»§¶Ë£¬Í¨³£Ö¸µÄÊÇ΢·þÎñϵͳÖи÷¸ö΢·þÎñ£¬Ö÷ÒªÓÃÓÚºÍ Eureka Server ½øÐн»»¥¡£ÔÚ΢·þÎñÓ¦ÓÃÆô¶¯ºó£¬Eureka Client »áÏò Eureka Server ·¢ËÍÐÄÌø£¨Ä¬ÈÏÖÜÆÚΪ 30 Ã룩¡£Èô Eureka Server ÔÚ¶à¸öÐÄÌøÖÜÆÚÄÚûÓнÓÊÕµ½Ä³¸ö Eureka Client µÄÐÄÌø£¬Eureka Server ½«Ëü´Ó¿ÉÓ÷þÎñÁбíÖÐÒÆ³ý£¨Ä¬ÈÏ 90 Ã룩¡£ +* **Eureka Server**:Eureka æœ�务注册中心,主è¦�用于æ��ä¾›æœ�务注册功能。当微æœ�务å�¯åŠ¨æ—¶ï¼Œä¼šå°†è‡ªå·±çš„æœ�务注册到 Eureka Server。Eureka Server 维护了一个å�¯ç”¨æœ�务列表,存储了所有注册到 Eureka Server çš„å�¯ç”¨æœ�务的信æ�¯ï¼Œè¿™äº›å�¯ç”¨æœ�务å�¯ä»¥åœ¨ Eureka Server 的管ç�†ç•Œé�¢ä¸­ç›´è§‚看到。 +* **Eureka Client**:Eureka 客户端,通常指的是微æœ�务系统中å�„个微æœ�务,主è¦�用于和 Eureka Server 进行交互。在微æœ�务应用å�¯åЍå�Žï¼ŒEureka Client 会å�‘ Eureka Server å�‘é€�心跳(默认周期为 30 秒)。若 Eureka Server 在多个心跳周期内没有接收到æŸ�个 Eureka Client 的心跳,Eureka Server 将它从å�¯ç”¨æœ�务列表中移除(默认 90 秒)。 -> ×¢£º¡°ÐÄÌø¡±Ö¸µÄÊÇÒ»¶Î¶¨Ê±·¢Ë͵Ä×Ô¶¨ÒåÐÅÏ¢£¬ÈöԷ½ÖªµÀ×Ô¼º¡°´æ»î¡±£¬ÒÔÈ·±£Á¬½ÓµÄÓÐЧÐÔ¡£´ó²¿·Ö CS ¼Ü¹¹µÄÓ¦ÓóÌÐò¶¼²ÉÓÃÁËÐÄÌø»úÖÆ£¬·þÎñ¶ËºÍ¿Í»§¶Ë¶¼¿ÉÒÔ·¢ÐÄÌø¡£Í¨³£Çé¿öÏÂÊǿͻ§¶ËÏò·þÎñÆ÷¶Ë·¢ËÍÐÄÌø°ü£¬·þÎñ¶ËÓÃÓÚÅжϿͻ§¶ËÊÇ·ñÔÚÏß¡£ +> 注:“心跳â€�指的是一段定时å�‘é€�的自定义信æ�¯ï¼Œè®©å¯¹æ–¹çŸ¥é�“自己“存活â€�,以确ä¿�连接的有效性。大部分 CS 架构的应用程åº�都采用了心跳机制,æœ�务端和客户端都å�¯ä»¥å�‘心跳。通常情况下是客户端å�‘æœ�务器端å�‘é€�心跳包,æœ�务端用于判断客户端是å�¦åœ¨çº¿ã€‚ -## Eureka ·þÎñ×¢²áÓë·¢ÏÖ +## Eureka æœ�务注册与å�‘现 -Eureka ʵÏÖ·þÎñ×¢²áÓë·¢ÏÖµÄÔ­Àí£¬ÈçÏÂͼËùʾ¡£ +Eureka 实现æœ�务注册与å�‘现的原ç�†ï¼Œå¦‚下图所示。 -![Eureka ·þÎñ×¢²áÓë·¢ÏÖ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010305209-0.png) -ͼ1£ºEureka Ô­Àíͼ +![Eureka æœ�务注册与å�‘现](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010305209-0.png) +图1:Eureka 原ç�†å›¾ -ÉÏͼÖй²Éæ¼°µ½ÒÔÏ 3 ¸ö½ÇÉ«£º +上图中共涉å�Šåˆ°ä»¥ä¸‹ 3 个角色: -* **·þÎñ×¢²áÖÐÐÄ£¨Register Service£©**£ºËüÊÇÒ»¸ö Eureka Server£¬ÓÃÓÚÌṩ·þÎñ×¢²áºÍ·¢ÏÖ¹¦ÄÜ¡£ -* **·þÎñÌṩÕߣ¨Provider Service£©**£ºËüÊÇÒ»¸ö Eureka Client£¬ÓÃÓÚÌṩ·þÎñ¡£Ëü½«×Ô¼ºÌṩµÄ·þÎñ×¢²áµ½·þÎñ×¢²áÖÐÐÄ£¬ÒÔ¹©·þÎñÏû·ÑÕß·¢ÏÖ¡£ -* **·þÎñÏû·ÑÕߣ¨Consumer Service£©**£ºËüÊÇÒ»¸ö Eureka Client£¬ÓÃÓÚÏû·Ñ·þÎñ¡£Ëü¿ÉÒÔ´Ó·þÎñ×¢²áÖÐÐÄ»ñÈ¡·þÎñÁÐ±í£¬µ÷ÓÃËùÐèµÄ·þÎñ¡£ +* **æœ�务注册中心(Register Service)**:它是一个 Eureka Server,用于æ��ä¾›æœ�务注册和å�‘现功能。 +* **æœ�务æ��供者(Provider Service)**:它是一个 Eureka Client,用于æ��ä¾›æœ�务。它将自己æ��供的æœ�务注册到æœ�务注册中心,以供æœ�务消费者å�‘现。 +* **æœ�务消费者(Consumer Service)**:它是一个 Eureka Client,用于消费æœ�务。它å�¯ä»¥ä»Žæœ�务注册中心获å�–æœ�务列表,调用所需的æœ�务。 -Eureka ʵÏÖ·þÎñ×¢²áÓë·¢ÏÖµÄÁ÷³ÌÈçÏ£º +Eureka 实现æœ�务注册与å�‘现的æµ�程如下: -1. ´î½¨Ò»¸ö Eureka Server ×÷Ϊ·þÎñ×¢²áÖÐÐÄ£» -2. ·þÎñÌṩÕß Eureka Client Æô¶¯Ê±£¬»á°Ñµ±Ç°·þÎñÆ÷µÄÐÅÏ¢ÒÔ·þÎñÃû£¨spring.application.name£©µÄ·½Ê½×¢²áµ½·þÎñ×¢²áÖÐÐÄ£» -3. ·þÎñÏû·ÑÕß Eureka Client Æô¶¯Ê±£¬Ò²»áÏò·þÎñ×¢²áÖÐÐÄ×¢²á£» -4. ·þÎñÏû·ÑÕß»¹»á»ñȡһ·Ý¿ÉÓ÷þÎñÁÐ±í£¬¸ÃÁбíÖаüº¬ÁËËùÓÐ×¢²áµ½·þÎñ×¢²áÖÐÐĵķþÎñÐÅÏ¢£¨°üÀ¨·þÎñÌṩÕߺÍ×ÔÉíµÄÐÅÏ¢£©£» -5. ÔÚ»ñµÃÁË¿ÉÓ÷þÎñÁбíºó£¬·þÎñÏû·ÑÕßͨ¹ý HTTP »òÏûÏ¢Öмä¼þÔ¶³Ìµ÷Ó÷þÎñÌṩÕßÌṩµÄ·þÎñ¡£ +1. æ�­å»ºä¸€ä¸ª Eureka Server 作为æœ�务注册中心; +2. æœ�务æ��供者 Eureka Client å�¯åŠ¨æ—¶ï¼Œä¼šæŠŠå½“å‰�æœ�务器的信æ�¯ä»¥æœ�务å��(spring.application.name)的方å¼�注册到æœ�务注册中心; +3. æœ�务消费者 Eureka Client å�¯åŠ¨æ—¶ï¼Œä¹Ÿä¼šå�‘æœ�务注册中心注册; +4. æœ�务消费者还会获å�–一份å�¯ç”¨æœ�务列表,该列表中包å�«äº†æ‰€æœ‰æ³¨å†Œåˆ°æœ�务注册中心的æœ�务信æ�¯ï¼ˆåŒ…括æœ�务æ��供者和自身的信æ�¯ï¼‰ï¼› +5. 在获得了å�¯ç”¨æœ�务列表å�Žï¼Œæœ�务消费者通过 HTTP 或消æ�¯ä¸­é—´ä»¶è¿œç¨‹è°ƒç”¨æœ�务æ��供者æ��供的æœ�务。 -·þÎñ×¢²áÖÐÐÄ£¨Eureka Server£©Ëù°çÑݵĽÇɫʮ·ÖÖØÒª£¬ËüÊÇ·þÎñÌṩÕߺͷþÎñÏû·ÑÕßÖ®¼äµÄÇÅÁº¡£·þÎñÌṩÕßÖ»Óн«×Ô¼ºµÄ·þÎñ×¢²áµ½·þÎñ×¢²áÖÐÐIJſÉÄܱ»·þÎñÏû·ÑÕßµ÷Ó㬶ø·þÎñÏû·ÑÕßÒ²Ö»ÓÐͨ¹ý·þÎñ×¢²áÖÐÐÄ»ñÈ¡¿ÉÓ÷þÎñÁбíºó£¬²ÅÄܵ÷ÓÃËùÐèµÄ·þÎñ¡£ +æœ�务注册中心(Eureka Server)所扮演的角色å��分é‡�è¦�,它是æœ�务æ��供者和æœ�务消费者之间的桥æ¢�。æœ�务æ��供者å�ªæœ‰å°†è‡ªå·±çš„æœ�务注册到æœ�务注册中心æ‰�å�¯èƒ½è¢«æœ�务消费者调用,而æœ�务消费者也å�ªæœ‰é€šè¿‡æœ�务注册中心获å�–å�¯ç”¨æœ�务列表å�Žï¼Œæ‰�能调用所需的æœ�务。 -## ʾÀý 1 +## 示例 1 -ÏÂÃæ£¬ÎÒÃÇͨ¹ýÒ»¸ö°¸ÀýÀ´Õ¹Ê¾Ï Eureka ÊÇÈçºÎʵÏÖ·þÎñ×¢²áÓë·¢Ïֵġ£ +下é�¢ï¼Œæˆ‘们通过一个案例æ�¥å±•示下 Eureka 是如何实现æœ�务注册与å�‘现的。 -#### 1\. ´´½¨Ö÷¹¤³Ì£¨Maven Project£© +#### 1\. 创建主工程(Maven Project) -ÓÉÓÚ±¾°¸ÀýÖУ¬»áÉæ¼°µ½¶à¸öÓÉ Spring Boot ´´½¨µÄ΢·þÎñ£¬ÎªÁË·½±ã¹ÜÀí£¬ÕâÀïÎÒÃDzÉÓà Maven µÄ¶à Module ½á¹¹£¨¼´Ò»¸ö Project °üº¬¶à¸ö Module£©À´¹¹½¨¹¤³Ì¡£ +由于本案例中,会涉å�Šåˆ°å¤šä¸ªç”± Spring Boot 创建的微æœ�务,为了方便管ç�†ï¼Œè¿™é‡Œæˆ‘们采用 Maven 的多 Module 结构(å�³ä¸€ä¸ª Project 包å�«å¤šä¸ª Module)æ�¥æž„建工程。 -´´½¨Ò»¸öÃûΪ spring-cloud-demo2 µÄ Maven Ö÷¹¤³Ì £¬È»ºóÔÚ¸ÃÖ÷¹¤³ÌµÄ pom.xml ÖÐʹÓà dependencyManagement À´¹ÜÀí Spring Cloud µÄ°æ±¾£¬ÄÚÈÝÈçÏ¡£ +创建一个å��为 spring-cloud-demo2 çš„ Maven 主工程 ,然å�Žåœ¨è¯¥ä¸»å·¥ç¨‹çš„ pom.xml 中使用 dependencyManagement æ�¥ç®¡ç�† Spring Cloud 的版本,内容如下。 @@ -84,9 +84,9 @@ Eureka ʵ - + org.springframework.cloud spring-cloud-dependencies @@ -124,9 +124,9 @@ Eureka ʵ -#### 2\. ´´½¨¹«¹²×ÓÄ£¿é£¨Maven Module£© +#### 2\. 创建公共å­�模å�—(Maven Module) -1) ÔÚÖ÷¹¤³ÌÏ£¬´´½¨Ò»¸öÃûΪ micro-service-cloud-api µÄ Maven Module£ºmicro-service-cloud-api£¬Æä pom.xml ÅäÖÃÈçÏ¡£ +1) 在主工程下,创建一个å��为 micro-service-cloud-api çš„ Maven Module:micro-service-cloud-api,其 pom.xml é…�置如下。 @@ -162,9 +162,9 @@ Eureka ʵ -> ×¢£ºmicro-service-cloud-api ÊÇÕû¸ö¹¤³ÌµÄ¹«¹²×ÓÄ£¿é£¬Ëü°üº¬ÁËһЩÆäËû×ÓÄ£¿é¹²ÓеÄÄÚÈÝ£¬ÀýÈçʵÌåÀà¡¢¹«¹²¹¤¾ßÀà¡¢¹«¹²ÒÀÀµÏîµÈ¡£µ±ÆäËû×ÓÄ£¿éÐèҪʹÓù«¹²×ÓÄ£¿éÖеÄÄÚÈÝʱ£¬Ö»ÐèÒªÔÚÆä pom.xml ÒýÈ빫¹²×ÓÄ£¿éµÄÒÀÀµ¼´¿É¡£ +> 注:micro-service-cloud-api 是整个工程的公共å­�模å�—,它包å�«äº†ä¸€äº›å…¶ä»–å­�模å�—共有的内容,例如实体类ã€�公共工具类ã€�公共ä¾�赖项等。当其他å­�模å�—需è¦�使用公共å­�模å�—中的内容时,å�ªéœ€è¦�在其 pom.xml 引入公共å­�模å�—çš„ä¾�èµ–å�³å�¯ã€‚ -2) ÔÚ micro-service-cloud-api µÄ net.biancheng.c.entity °üÏ£¬´´½¨Ò»¸öÃûΪ Dept µÄʵÌåÀ࣬´úÂëÈçÏ¡£ +2) 在 micro-service-cloud-api çš„ net.biancheng.c.entity 包下,创建一个å��为 Dept 的实体类,代ç �如下。 @@ -180,8 +180,8 @@ import lombok.experimental.Accessors; import java.io.Serializable; -@NoArgsConstructor //Î޲ι¹Ô캯Êý -@Data // ÌṩÀàµÄget¡¢set¡¢equals¡¢hashCode¡¢canEqual¡¢toString ·½·¨ +@NoArgsConstructor //æ— å�‚构造函数 +@Data // æ��供类的getã€�setã€�equalsã€�hashCodeã€�canEqualã€�toString 方法 @Accessors(chain = true) public class Dept implements Serializable { private Integer deptNo; @@ -195,9 +195,9 @@ public class Dept implements Serializable { -#### 3\. ´î½¨·þÎñ×¢²áÖÐÐÄ +#### 3\. æ�­å»ºæœ�务注册中心 -1) ÔÚÖ÷¹¤³ÌÏ´´½¨Ò»¸öÃûΪ micro-service-cloud-eureka-7001 µÄ Spring Boot Module ×÷Ϊ·þÎñ×¢²áÖÐÐÄ£¬²¢ÔÚÆä pom.xml ÖÐÒýÈëÒÔÏÂÒÀÀµ¡£ +1) 在主工程下创建一个å��为 micro-service-cloud-eureka-7001 çš„ Spring Boot Module 作为æœ�务注册中心,并在其 pom.xml 中引入以下ä¾�赖。 @@ -209,7 +209,7 @@ public class Dept implements Serializable { 4.0.0 - + spring-cloud-demo2 net.biancheng.c @@ -230,12 +230,12 @@ public class Dept implements Serializable { org.springframework.boot spring-boot-starter-web - + org.springframework.cloud spring-cloud-starter-netflix-eureka-server - + org.springframework.boot spring-boot-devtools @@ -277,7 +277,7 @@ public class Dept implements Serializable { -2) ÔÚ micro-service-cloud-eureka-7001 µÄÀà·¾¶£¨/resouces Ŀ¼£©Ï£¬Ìí¼ÓÒ»¸öÅäÖÃÎļþ application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2) 在 micro-service-cloud-eureka-7001 的类路径(/resouces 目录)下,添加一个é…�置文件 application.yml,é…�置内容如下。 @@ -285,24 +285,24 @@ public class Dept implements Serializable { ``` server: - port: 7001 #¸Ã Module µÄ¶Ë¿ÚºÅ + port: 7001 #该 Module 的端å�£å�· eureka: instance: - hostname: localhost #eureka·þÎñ¶ËµÄʵÀýÃû³Æ£¬ + hostname: localhost #eurekaæœ�务端的实例å��称, client: - register-with-eureka: false #false±íʾ²»Ïò×¢²áÖÐÐÄ×¢²á×Ô¼º¡£ - fetch-registry: false #false±íʾ×Ô¼º¶Ë¾ÍÊÇ×¢²áÖÐÐÄ£¬ÎÒµÄÖ°Ôð¾ÍÊÇά»¤·þÎñʵÀý£¬²¢²»ÐèҪȥ¼ìË÷·þÎñ + register-with-eureka: false #false表示ä¸�å�‘注册中心注册自己。 + fetch-registry: false #false表示自己端就是注册中心,我的è�Œè´£å°±æ˜¯ç»´æŠ¤æœ�务实例,并ä¸�需è¦�去检索æœ�务 service-url: - defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #µ¥»ú°æ·þÎñ×¢²áÖÐÐÄ + defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #å�•机版æœ�务注册中心 ``` -3) ÔÚ micro-service-cloud-eureka-7001 µÄÖ÷Æô¶¯ÀàÉÏʹÓà @EnableEurekaServer ×¢½â¿ªÆô·þÎñ×¢²áÖÐÐŦÄÜ£¬½ÓÊÜÆäËû·þÎñµÄ×¢²á£¬´úÂëÈçÏ¡£ +3) 在 micro-service-cloud-eureka-7001 的主å�¯åŠ¨ç±»ä¸Šä½¿ç”¨ @EnableEurekaServer 注解开å�¯æœ�务注册中心功能,接å�—å…¶ä»–æœ�务的注册,代ç �如下。 @@ -315,7 +315,7 @@ import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer; @SpringBootApplication -@EnableEurekaServer //¿ªÆô Eureka server,½ÓÊÜÆäËû΢·þÎñµÄ×¢²á +@EnableEurekaServer //å¼€å�¯ Eureka server,接å�—å…¶ä»–å¾®æœ�务的注册 public class MicroServiceCloudEureka7001Application { public static void main(String[] args) { SpringApplication.run(MicroServiceCloudEureka7001Application.class, args); @@ -328,15 +328,15 @@ public class MicroServiceCloudEureka7001Application { -4) Æô¶¯ micro-service-cloud-eureka-7001£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ Eureka ·þÎñ×¢²áÖÐÐÄÖ÷Ò³£¬µØÖ·Îª¡°http://localhost:7001/¡±£¬½á¹ûÈçÏÂͼ¡£ +4) å�¯åЍ micro-service-cloud-eureka-7001,使用æµ�览器访问 Eureka æœ�务注册中心主页,地å�€ä¸ºâ€œhttp://localhost:7001/â€�,结果如下图。 -![Eureka Server 7001 ·þÎñ×¢²áÖÐÐÄ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010306360-1.png) +![Eureka Server 7001 æœ�务注册中心](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010306360-1.png) -ͼ2£ºEureka 7001 ·þÎñ×¢²áÖÐÐÄ +图2:Eureka 7001 æœ�务注册中心 -#### 4\. ´î½¨·þÎñÌṩÕß +#### 4\. æ�­å»ºæœ�务æ��供者 -1) ÔÚÖ÷¹¤³ÌÏ´´½¨Ò»¸öÃûΪ micro-service-cloud-provider-dept-8001 µÄ Spring Boot Module£¬²¢ÔÚÆä pom.xml ÖÐÒýÈëÒÔÏÂÒÀÀµ¡£ +1) 在主工程下创建一个å��为 micro-service-cloud-provider-dept-8001 çš„ Spring Boot Module,并在其 pom.xml 中引入以下ä¾�赖。 @@ -348,7 +348,7 @@ public class MicroServiceCloudEureka7001Application { 4.0.0 - + spring-cloud-demo2 net.biancheng.c @@ -370,60 +370,60 @@ public class MicroServiceCloudEureka7001Application { org.springframework.boot spring-boot-starter-web - + org.springframework.boot spring-boot-devtools runtime true - + org.springframework.boot spring-boot-starter-test test - + net.biancheng.c micro-service-cloud-api ${project.version} - + junit junit 4.12 - + mysql mysql-connector-java 5.1.49 - + ch.qos.logback logback-core - + org.mybatis.spring.boot mybatis-spring-boot-starter 2.2.0 - + org.springframework springloaded 1.2.8.RELEASE - + org.springframework.cloud spring-cloud-starter-netflix-eureka-client - + org.springframework.boot spring-boot-starter-actuator @@ -432,7 +432,7 @@ public class MicroServiceCloudEureka7001Application { - + org.mybatis.generator mybatis-generator-maven-plugin @@ -440,11 +440,11 @@ public class MicroServiceCloudEureka7001Application { src/main/resources/mybatis-generator/generatorConfig.xml true - + true - + mysql mysql-connector-java @@ -471,7 +471,7 @@ public class MicroServiceCloudEureka7001Application { -2) ÔÚ micro-service-cloud-provider-dept-8001 Àà·¾¶£¨/resources Ŀ¼£©Ï£¬Ìí¼ÓÅäÖÃÎļþ application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2) 在 micro-service-cloud-provider-dept-8001 类路径(/resources 目录)下,添加é…�置文件 application.yml,é…�置内容如下。 @@ -480,46 +480,46 @@ public class MicroServiceCloudEureka7001Application { ``` server: - port: 8001 #·þÎñ¶Ë¿ÚºÅ + port: 8001 #æœ�务端å�£å�· spring: application: - name: microServiceCloudProviderDept #΢·þÎñÃû³Æ£¬¶ÔÍⱩ©µÄ΢·þÎñÃû³Æ£¬Ê®·ÖÖØÒª -################################################## JDBC ͨÓÃÅäÖà ########################################## + name: microServiceCloudProviderDept #å¾®æœ�务å��称,对外暴æ¼�的微æœ�务å��称,å��分é‡�è¦� +################################################## JDBC 通用é…�ç½® ########################################## datasource: - username: root #Êý¾Ý¿âµÇ½Óû§Ãû - password: root #Êý¾Ý¿âµÇ½ÃÜÂë - url: jdbc:mysql://127.0.0.1:3306/bianchengbang_jdbc #Êý¾Ý¿âurl - driver-class-name: com.mysql.jdbc.Driver #Êý¾Ý¿âÇý¶¯ + username: root #æ•°æ�®åº“登陆用户å�� + password: root #æ•°æ�®åº“登陆密ç � + url: jdbc:mysql://127.0.0.1:3306/bianchengbang_jdbc #æ•°æ�®åº“url + driver-class-name: com.mysql.jdbc.Driver #æ•°æ�®åº“驱动 -############################### ²»¼ì²é spring.config.import=configserver:################## +############################### ä¸�检查 spring.config.import=configserver:################## # cloud: # config: # enabled: false -###################################### MyBatis ÅäÖà ###################################### +###################################### MyBatis é…�ç½® ###################################### mybatis: - # Ö¸¶¨ mapper.xml µÄλÖà + # 指定 mapper.xml çš„ä½�ç½® mapper-locations: classpath:mybatis/mapper/*.xml - #ɨÃèʵÌåÀàµÄλÖÃ,ÔÚ´Ë´¦Ö¸Ã÷ɨÃèʵÌåÀàµÄ°ü£¬ÔÚ mapper.xml ÖоͿÉÒÔ²»Ð´ÊµÌåÀàµÄȫ·¾¶Ãû + #扫æ��实体类的ä½�ç½®,在此处指明扫æ��实体类的包,在 mapper.xml 中就å�¯ä»¥ä¸�写实体类的全路径å�� type-aliases-package: net.biancheng.c.entity configuration: - #ĬÈÏ¿ªÆôÍÕ·åÃüÃû·¨£¬¿ÉÒÔ²»ÓÃÉèÖøÃÊôÐÔ + #默认开å�¯é©¼å³°å‘½å��法,å�¯ä»¥ä¸�用设置该属性 map-underscore-to-camel-case: true -########################################### Spring cloud ×Ô¶¨Òå·þÎñÃû³ÆºÍ ip µØÖ·############################################### +########################################### Spring cloud 自定义æœ�务å��ç§°å’Œ ip 地å�€############################################### eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - defaultZone: http://eureka7001.com:7001/eureka #Õâ¸öµØÖ·ÊÇ 7001×¢²áÖÐÐÄÔÚ application.yml Öб©Â¶³öÀ´¶î×¢²áµØÖ· £¨µ¥»ú°æ£© + defaultZone: http://eureka7001.com:7001/eureka #这个地å�€æ˜¯ 7001注册中心在 application.yml 中暴露出æ�¥é¢�注册地å�€ (å�•机版) instance: - instance-id: spring-cloud-provider-8001 #×Ô¶¨Òå·þÎñÃû³ÆÐÅÏ¢ - prefer-ip-address: true #ÏÔʾ·ÃÎÊ·¾¶µÄ ip µØÖ· -########################################## spring cloud ʹÓà Spring Boot actuator ¼à¿ØÍêÉÆÐÅÏ¢################################### -# Spring Boot 2.50¶Ô actuator ¼à¿ØÆÁ±ÎÁË´ó¶àÊýµÄ½Úµã£¬Ö»±©Â¶ÁË heath ½Úµã£¬±¾¶ÎÅäÖã¨*£©¾ÍÊÇΪÁË¿ªÆôËùÓеĽڵã + instance-id: spring-cloud-provider-8001 #自定义æœ�务å��ç§°ä¿¡æ�¯ + prefer-ip-address: true #显示访问路径的 ip 地å�€ +########################################## spring cloud 使用 Spring Boot actuator 监控完善信æ�¯################################### +# Spring Boot 2.50对 actuator 监控å±�蔽了大多数的节点,å�ªæš´éœ²äº† heath 节点,本段é…�置(*)就是为了开å�¯æ‰€æœ‰çš„节点 management: endpoints: web: exposure: - include: "*" # * ÔÚyaml ÎļþÊôÓڹؼü×Ö£¬ËùÒÔÐèÒª¼ÓÒýºÅ + include: "*" # * 在yaml 文件属于关键字,所以需è¦�加引å�· info: app.name: micro-service-cloud-provider-dept company.name: c.biancheng.net @@ -531,7 +531,7 @@ info: -3) ÔÚ net.biancheng.c.mapper °üÏ´´½¨Ò»¸öÃûΪ DeptMapper µÄ½Ó¿Ú£¬´úÂëÈçÏ¡£ +3) 在 net.biancheng.c.mapper 包下创建一个å��为 DeptMapper 的接å�£ï¼Œä»£ç �如下。 @@ -545,9 +545,9 @@ import org.apache.ibatis.annotations.Mapper; import java.util.List; @Mapper public interface DeptMapper { - //¸ù¾ÝÖ÷¼ü»ñÈ¡Êý¾Ý + //æ ¹æ�®ä¸»é”®èŽ·å�–æ•°æ�® Dept selectByPrimaryKey(Integer deptNo); - //»ñÈ¡±íÖеÄÈ«²¿Êý¾Ý + //获å�–表中的全部数æ�® List GetAll(); } @@ -557,7 +557,7 @@ public interface DeptMapper { -4) ÔÚ resources/mybatis/mapper/ Ŀ¼Ï£¬´´½¨Ò»¸öÃûΪ DeptMapper.xml µÄ MyBatis Ó³ÉäÎļþ£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +4) 在 resources/mybatis/mapper/ 目录下,创建一个å��为 DeptMapper.xml çš„ MyBatis 映射文件,é…�置内容如下。 @@ -597,7 +597,7 @@ public interface DeptMapper { -5) ÔÚ net.biancheng.c.service °üÏ´´½¨Ò»¸öÃûΪ DeptService µÄ½Ó¿Ú£¬´úÂëÈçÏ¡£ +5) 在 net.biancheng.c.service 包下创建一个å��为 DeptService 的接å�£ï¼Œä»£ç �如下。 @@ -620,7 +620,7 @@ public interface DeptService { -6) ÔÚ net.biancheng.c.service.impl °üÏ´´½¨ DeptService ½Ó¿ÚµÄʵÏÖÀà DeptServiceImpl£¬´úÂëÈçÏ¡£ +6) 在 net.biancheng.c.service.impl 包下创建 DeptService 接å�£çš„实现类 DeptServiceImpl,代ç �如下。 @@ -659,7 +659,7 @@ public class DeptServiceImpl implements DeptService { -7) ÔÚ net.biancheng.c.controller °üÏ´´½¨Ò»¸öÃûΪ DeptController µÄ Controller À࣬´úÂëÈçÏ¡£ +7) 在 net.biancheng.c.controller 包下创建一个å��为 DeptController çš„ Controller 类,代ç �如下。 @@ -679,8 +679,8 @@ import org.springframework.web.bind.annotation.*; import java.util.List; /** -* ·þÎñÌṩÕߵĿØÖƲã -* author:cÓïÑÔÖÐÎÄÍø c.biancheng.net +* æœ�务æ��供者的控制层 +* author:c语言中文网 c.biancheng.net */ @RestController @Slf4j @@ -707,7 +707,7 @@ public class DeptController { -8) ÔÚ micro-service-cloud-provider-dept-8001 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableEurekaClient ×¢½â¿ªÆô Eureka ¿Í»§¶Ë¹¦ÄÜ£¬½«·þÎñ×¢²áµ½·þÎñ×¢²áÖÐÐÄ£¨Eureka Server£©£¬´úÂëÈçÏ¡£ +8) 在 micro-service-cloud-provider-dept-8001 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableEurekaClient 注解开å�¯ Eureka 客户端功能,将æœ�务注册到æœ�务注册中心(Eureka Server),代ç �如下。 @@ -723,7 +723,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.netflix.eureka.EnableEurekaClient; @SpringBootApplication -@EnableEurekaClient // Spring cloud Eureka ¿Í»§¶Ë£¬×Ô¶¯½«±¾·þÎñ×¢²áµ½ Eureka Server ×¢²áÖÐÐÄÖÐ +@EnableEurekaClient // Spring cloud Eureka 客户端,自动将本æœ�务注册到 Eureka Server 注册中心中 public class MicroServiceCloudProviderDept8001Application { public static void main(String[] args) { @@ -737,19 +737,19 @@ public class MicroServiceCloudProviderDept8001Application { -9) ÒÀ´ÎÆô¶¯ micro-service-cloud-eureka-7001 ºÍ micro-service-cloud-provider-dept-8001£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÔÙ´ÎÎÊ Eureka ·þÎñ×¢²áÖÐÐÄÖ÷Ò³£¨http://localhost:7001/£©£¬ÈçÏÂͼ¡£ +9) ä¾�次å�¯åЍ micro-service-cloud-eureka-7001 å’Œ micro-service-cloud-provider-dept-8001,使用æµ�览器访å†�次问 Eureka æœ�务注册中心主页(http://localhost:7001/),如下图。 -![Eureka Client ×¢²áµ½·þÎñ×¢²áÖÐÐÄ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010304436-2.png) -ͼ3£º·þÎñÌṩÕß×¢²áµ½·þÎñ×¢²áÖÐÐÄ +![Eureka Client 注册到æœ�务注册中心](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010304436-2.png) +图3:æœ�务æ��供者注册到æœ�务注册中心 -´Óͼ 3 ¿ÉÒÔ¿´µ½£¬ Instances currently registered with Eureka £¨×¢²áµ½ Eureka Server µÄʵÀý£©Ñ¡ÏîÖÐÒѾ­°üº¬ÁËÒ»Ìõ·þÎñÐÅÏ¢£¬¼´ÒѾ­ÓзþÎñ×¢²áµ½ Eureka Server ÉÏÁË¡£ +从图 3 å�¯ä»¥çœ‹åˆ°ï¼Œ Instances currently registered with Eureka (注册到 Eureka Server 的实例)选项中已ç»�包å�«äº†ä¸€æ�¡æœ�务信æ�¯ï¼Œå�³å·²ç»�有æœ�务注册到 Eureka Server 上了。 -Instances currently registered with Eureka Ñ¡ÏîÖаüº¬ÒÔÏÂÄÚÈÝ£º +Instances currently registered with Eureka 选项中包å�«ä»¥ä¸‹å†…容: -* Application£ºMICROSERVICECLOUDPROVIDERDEPT£¬¸ÃȡֵΪ micro-service-cloud-provider-dept-8001 ÅäÖÃÎļþ application.yml ÖÐ spring.application.name µÄȡֵ¡£ -* Status£º UP (1) - spring-cloud-provider-8001£¬UP ±íʾ·þÎñÔÚÏߣ¬ (1) ±íʾÓм¯ÈºÖзþÎñµÄÊýÁ¿£¬spring-cloud-provider-8001 ÔòÊÇ micro-service-cloud-provider-dept-8001 ÅäÖÃÎļþ application.yml ÖÐ eureka.instance.instance-id µÄȡֵ¡£ +* Application:MICROSERVICECLOUDPROVIDERDEPT,该å�–值为 micro-service-cloud-provider-dept-8001 é…�置文件 application.yml 中 spring.application.name çš„å�–值。 +* Status: UP (1) - spring-cloud-provider-8001,UP 表示æœ�务在线, (1) 表示有集群中æœ�务的数é‡�,spring-cloud-provider-8001 则是 micro-service-cloud-provider-dept-8001 é…�置文件 application.yml 中 eureka.instance.instance-id çš„å�–值。 -10) ÔÚ MySQL µÄ bianchengbang_jdbc Êý¾Ý¿âÖÐÖ´ÐÐÒÔÏ SQL£¬×¼±¸²âÊÔÊý¾Ý¡£ +10) 在 MySQL çš„ bianchengbang_jdbc æ•°æ�®åº“中执行以下 SQL,准备测试数æ�®ã€‚ ``` DROP TABLE IF EXISTS `dept`; @@ -761,25 +761,25 @@ CREATE TABLE `dept` ( ) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci; -INSERT INTO `dept` VALUES ('1', '¿ª·¢²¿', 'bianchengbang_jdbc'); -INSERT INTO `dept` VALUES ('2', 'ÈËʲ¿', 'bianchengbang_jdbc'); -INSERT INTO `dept` VALUES ('3', '²ÆÎñ²¿', 'bianchengbang_jdbc'); -INSERT INTO `dept` VALUES ('4', 'Êг¡²¿', 'bianchengbang_jdbc'); -INSERT INTO `dept` VALUES ('5', 'ÔËά²¿', 'bianchengbang_jdbc'); +INSERT INTO `dept` VALUES ('1', 'å¼€å�‘部', 'bianchengbang_jdbc'); +INSERT INTO `dept` VALUES ('2', '人事部', 'bianchengbang_jdbc'); +INSERT INTO `dept` VALUES ('3', '财务部', 'bianchengbang_jdbc'); +INSERT INTO `dept` VALUES ('4', '市场部', 'bianchengbang_jdbc'); +INSERT INTO `dept` VALUES ('5', 'è¿�维部', 'bianchengbang_jdbc'); ``` -11) ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:8001/dept/list¡±£¬½á¹ûÈçÏÂͼ¡£ +11) 使用æµ�览器访问“http://localhost:8001/dept/listâ€�,结果如下图。 -![Eureka Client 8001 ·ÃÎÊÊý¾Ý¿â](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010301b2-3.png) -ͼ4£º·þÎñÌṩÕßÌṩ·þÎñ·ÃÎÊÊý¾Ý¿â +![Eureka Client 8001 访问数æ�®åº“](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010301b2-3.png) +图4:æœ�务æ��供者æ��ä¾›æœ�务访问数æ�®åº“ -## Eureka Server ¼¯Èº +## Eureka Server 集群 -ÔÚ΢·þÎñ¼Ü¹¹ÖУ¬Ò»¸öϵͳÍùÍùÓÉÊ®¼¸ÉõÖÁ¼¸Ê®¸ö·þÎñ×é³É£¬Èô½«ÕâЩ·þÎñÈ«²¿×¢²áµ½Í¬Ò»¸ö Eureka Server ÖУ¬¾Í¼«ÓпÉÄܵ¼Ö Eureka Server Òò²»¿°Öظº¶ø±ÀÀ££¬×îÖÕµ¼ÖÂÕû¸öϵͳ̱»¾¡£½â¾öÕâ¸öÎÊÌâ×îÖ±½ÓµÄ°ì·¨¾ÍÊDz¿Êð Eureka Server ¼¯Èº¡£ +在微æœ�务架构中,一个系统往往由å��几甚至几å��个æœ�务组æˆ�,若将这些æœ�务全部注册到å�Œä¸€ä¸ª Eureka Server 中,就æž�有å�¯èƒ½å¯¼è‡´ Eureka Server å› ä¸�å ªé‡�负而崩溃,最终导致整个系统瘫痪。解决这个问题最直接的办法就是部署 Eureka Server 集群。 -ÎÒÃÇÖªµÀ£¬ÔÚ Eureka ʵÏÖ·þÎñ×¢²áÓë·¢ÏÖʱһ¹²Éæ¼°ÁË 3 ¸ö½ÇÉ«£º·þÎñ×¢²áÖÐÐÄ¡¢·þÎñÌṩÕßÒÔ¼°·þÎñÏû·ÑÕߣ¬ÕâÈý¸ö½ÇÉ«·Ö¹¤Ã÷È·£¬¸÷˾ÆäÖ°¡£µ«ÊÇÆäʵÔÚ Eureka ÖУ¬ËùÓзþÎñ¶¼¼ÈÊÇ·þÎñÏû·ÑÕßÒ²ÊÇ·þÎñÌṩÕߣ¬·þÎñ×¢²áÖÐÐÄ Eureka Server Ò²²»ÀýÍâ¡£ +我们知é�“,在 Eureka 实现æœ�务注册与å�‘现时一共涉å�Šäº† 3 个角色:æœ�务注册中心ã€�æœ�务æ��供者以å�Šæœ�务消费者,这三个角色分工明确,å�„å�¸å…¶è�Œã€‚但是其实在 Eureka 中,所有æœ�务都既是æœ�务消费者也是æœ�务æ��供者,æœ�务注册中心 Eureka Server 也ä¸�例外。 -ÎÒÃÇÔڴ·þÎñ×¢²áÖÐÐÄʱ£¬ÔÚ application.yml ÖÐÉæ¼°ÁËÕâÑùµÄÅäÖ㺠+我们在æ�­å»ºæœ�务注册中心时,在 application.yml 中涉å�Šäº†è¿™æ ·çš„é…�置: @@ -790,31 +790,31 @@ INSERT INTO `dept` VALUES ('5', ' eureka: client: - register-with-eureka: false #false ±íʾ²»Ïò×¢²áÖÐÐÄ×¢²á×Ô¼º¡£ - fetch-registry: false #false±íʾ×Ô¼º¶Ë¾ÍÊÇ×¢²áÖÐÐÄ£¬Ö°Ôð¾ÍÊÇά»¤·þÎñʵÀý£¬²¢²»ÐèҪȥ¼ìË÷·þÎñ + register-with-eureka: false #false 表示ä¸�å�‘注册中心注册自己。 + fetch-registry: false #false表示自己端就是注册中心,è�Œè´£å°±æ˜¯ç»´æŠ¤æœ�务实例,并ä¸�需è¦�去检索æœ�务 ``` -ÕâÑùÉèÖõÄÔ­ÒòÊÇ micro-service-cloud-eureka-7001 ±¾Éí×Ô¼º¾ÍÊÇ·þÎñ×¢²áÖÐÐÄ£¬·þÎñ×¢²áÖÐÐÄÊDz»Äܽ«×Ô¼º×¢²áµ½×Ô¼ºÉíÉϵ쬵«·þÎñ×¢²áÖÐÐÄÊÇ¿ÉÒÔ½«×Ô¼º×÷Ϊ·þÎñÏòÆäËûµÄ·þÎñ×¢²áÖÐÐÄ×¢²á×Ô¼ºµÄ¡£ +这样设置的原因是 micro-service-cloud-eureka-7001 本身自己就是æœ�务注册中心,æœ�务注册中心是ä¸�能将自己注册到自己身上的,但æœ�务注册中心是å�¯ä»¥å°†è‡ªå·±ä½œä¸ºæœ�务å�‘å…¶ä»–çš„æœ�务注册中心注册自己的。 -¾Ù¸öÀý×Ó£¬ÓÐÁ½¸ö Eureka Server ·Ö±ðΪ A ºÍ B£¬ËäÈ» A ²»Äܽ«×Ô¼º×¢²áµ½ A ÉÏ£¬B Ò²²»Äܽ«×Ô¼º×¢²áµ½ B ÉÏ£¬µ« A ÊÇ¿ÉÒÔ×÷Ϊһ¸ö·þÎñ°Ñ×Ô¼º×¢²áµ½ B Éϵģ¬Í¬Àí B Ò²¿ÉÒÔ½«×Ô¼º×¢²áµ½ A ÉÏ¡£ +举个例å­�,有两个 Eureka Server 分别为 A å’Œ B,虽然 A ä¸�能将自己注册到 A 上,B 也ä¸�能将自己注册到 B 上,但 A 是å�¯ä»¥ä½œä¸ºä¸€ä¸ªæœ�务把自己注册到 B 上的,å�Œç�† B 也å�¯ä»¥å°†è‡ªå·±æ³¨å†Œåˆ° A 上。 -ÕâÑù¾Í¿ÉÒÔÐγÉÒ»×黥Ïà×¢²áµÄ Eureka Server ¼¯Èº£¬µ±·þÎñÌṩÕß·¢ËÍ×¢²áÇëÇóµ½ Eureka Server ʱ£¬Eureka Server »á½«ÇëÇóת·¢¸ø¼¯ÈºÖÐËùÓÐÓëÖ®ÏàÁ¬µÄ Eureka Server ÉÏ£¬ÒÔʵÏÖ Eureka Server Ö®¼äµÄ·þÎñͬ²½¡£ +这样就å�¯ä»¥å½¢æˆ�一组互相注册的 Eureka Server 集群,当æœ�务æ��供者å�‘é€�注册请求到 Eureka Server 时,Eureka Server 会将请求转å�‘给集群中所有与之相连的 Eureka Server 上,以实现 Eureka Server 之间的æœ�务å�Œæ­¥ã€‚ -ͨ¹ý·þÎñͬ²½£¬·þÎñÏû·ÑÕß¿ÉÒÔÔÚ¼¯ÈºÖеÄÈÎÒâһ̨ Eureka Server ÉÏ»ñÈ¡·þÎñÌṩÕßÌṩµÄ·þÎñ¡£ÕâÑù£¬¼´Ê¹¼¯ÈºÖеÄij¸ö·þÎñ×¢²áÖÐÐÄ·¢Éú¹ÊÕÏ£¬·þÎñÏû·ÑÕßÈÔÈ»¿ÉÒÔ´Ó¼¯ÈºÖÐµÄÆäËû Eureka Server ÖлñÈ¡·þÎñÐÅÏ¢²¢µ÷Ó㬶ø²»»áµ¼ÖÂϵͳµÄÕûÌå̱»¾£¬Õâ¾ÍÊÇ Eureka Server ¼¯ÈºµÄ¸ß¿ÉÓÃÐÔ¡£ +通过æœ�务å�Œæ­¥ï¼Œæœ�务消费者å�¯ä»¥åœ¨é›†ç¾¤ä¸­çš„ä»»æ„�一å�° Eureka Server 上获å�–æœ�务æ��供者æ��供的æœ�务。这样,å�³ä½¿é›†ç¾¤ä¸­çš„æŸ�个æœ�务注册中心å�‘生故障,æœ�务消费者ä»�ç„¶å�¯ä»¥ä»Žé›†ç¾¤ä¸­çš„å…¶ä»– Eureka Server 中获å�–æœ�务信æ�¯å¹¶è°ƒç”¨ï¼Œè€Œä¸�会导致系统的整体瘫痪,这就是 Eureka Server 集群的高å�¯ç”¨æ€§ã€‚ -## ʾÀý 2 +## 示例 2 -ÏÂÃæÎÒÃÇÔÚʾÀý 1 µÄ»ù´¡ÉϽøÐÐÀ©Õ¹£¬¹¹½¨Ò»¸öÓµÓÐ 3 ¸ö Eureka Server ʵÀýµÄ¼¯Èº¡£ +下é�¢æˆ‘们在示例 1 的基础上进行扩展,构建一个拥有 3 个 Eureka Server 实例的集群。 -1\. ²ÎÕÕ micro-service-cloud-eureka-7001 µÄ´î½¨¹ý³Ì£¬ÔÚÖ÷¹¤³ÌÏÂÁíÍâÔÙ´´½¨Á½¸ö Eureka Server£ºmicro-service-cloud-eureka-7002 ºÍ micro-service-cloud-eureka-7003£¬´ËʱÕâ 3 ¸ö Eureka Server ÎÞÂÛÊÇ Maven ÒÀÀµ¡¢´úÂ뻹ÊÇÅäÖö¼ÊÇһģһÑùµÄ¡£ +1\. å�‚ç…§ micro-service-cloud-eureka-7001 çš„æ�­å»ºè¿‡ç¨‹ï¼Œåœ¨ä¸»å·¥ç¨‹ä¸‹å�¦å¤–å†�创建两个 Eureka Server:micro-service-cloud-eureka-7002 å’Œ micro-service-cloud-eureka-7003,此时这 3 个 Eureka Server 无论是 Maven ä¾�èµ–ã€�代ç �还是é…�置都是一模一样的。 -2\. ÐÞ¸Ä micro-service-cloud-eureka-7001¡¢micro-service-cloud-eureka-7002¡¢micro-service-cloud-eureka-7003 ÖÐ application.yml µÄÅäÖ㬾ßÌåÅäÖÃÈçÏ ¡£ +2\. 修改 micro-service-cloud-eureka-7001ã€�micro-service-cloud-eureka-7002ã€�micro-service-cloud-eureka-7003 中 application.yml çš„é…�置,具体é…�置如下 。 -micro-service-cloud-eureka-7001 ÖÐ application.yml µÄÅäÖÃÈçÏ¡£ +micro-service-cloud-eureka-7001 中 application.yml çš„é…�置如下。 @@ -822,23 +822,23 @@ micro-service-cloud-eureka-7001 ``` server: - port: 7001 #¶Ë¿ÚºÅ + port: 7001 #端å�£å�· eureka: instance: - hostname: eureka7001.com #eureka·þÎñ¶ËµÄʵÀýÃû³Æ + hostname: eureka7001.com #eurekaæœ�务端的实例å��ç§° client: - register-with-eureka: false #false ±íʾ²»Ïò×¢²áÖÐÐÄ×¢²á×Ô¼º¡£ - fetch-registry: false #false ±íʾ×Ô¼º¶Ë¾ÍÊÇ×¢²áÖÐÐÄ£¬ÎÒµÄÖ°Ôð¾ÍÊÇά»¤·þÎñʵÀý£¬²¢²»ÐèҪȥ¼ìË÷·þÎñ + register-with-eureka: false #false 表示ä¸�å�‘注册中心注册自己。 + fetch-registry: false #false 表示自己端就是注册中心,我的è�Œè´£å°±æ˜¯ç»´æŠ¤æœ�务实例,并ä¸�需è¦�去检索æœ�务 service-url: - #defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #µ¥»ú°æ - defaultZone: http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #¼¯Èº°æ ½«µ±Ç°µÄ Eureka Server ×¢²áµ½ 7003 ºÍ 7003 ÉÏ£¬ÐγÉÒ»×黥Ïà×¢²áµÄ Eureka Server ¼¯Èº + #defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/ #å�•机版 + defaultZone: http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #集群版 将当å‰�çš„ Eureka Server 注册到 7003 å’Œ 7003 上,形æˆ�一组互相注册的 Eureka Server 集群 ``` -micro-service-cloud-eureka-7002 ÖÐ application.yml µÄÅäÖÃÈçÏ¡£ +micro-service-cloud-eureka-7002 中 application.yml çš„é…�置如下。 @@ -847,24 +847,24 @@ micro-service-cloud-eureka-7002 ``` server: - port: 7002 #¶Ë¿ÚºÅ + port: 7002 #端å�£å�· eureka: instance: - hostname: eureka7002.com #Eureka Server ʵÀýÃû³Æ + hostname: eureka7002.com #Eureka Server 实例å��ç§° client: - register-with-eureka: false #false ±íʾ²»Ïò×¢²áÖÐÐÄ×¢²á×Ô¼º¡£ - fetch-registry: false #false ±íʾ×Ô¼º¶Ë¾ÍÊÇ×¢²áÖÐÐÄ£¬ÎÒµÄÖ°Ôð¾ÍÊÇά»¤·þÎñʵÀý£¬²¢²»ÐèҪȥ¼ìË÷·þÎñ + register-with-eureka: false #false 表示ä¸�å�‘注册中心注册自己。 + fetch-registry: false #false 表示自己端就是注册中心,我的è�Œè´£å°±æ˜¯ç»´æŠ¤æœ�务实例,并ä¸�需è¦�去检索æœ�务 service-url: - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7003.com:7003/eureka/ #½«Õâ¸ö Eureka Server ×¢²áµ½ 7001 ºÍ 7003 ÉÏ + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7003.com:7003/eureka/ #将这个 Eureka Server 注册到 7001 å’Œ 7003 上 ``` -micro-service-cloud-eureka-7003 ÖÐ application.yml µÄÅäÖÃÈçÏ¡£ +micro-service-cloud-eureka-7003 中 application.yml çš„é…�置如下。 @@ -873,34 +873,34 @@ micro-service-cloud-eureka-7003 ``` server: - port: 7003 #¶Ë¿ÚºÅ + port: 7003 #端å�£å�· eureka: instance: - hostname: eureka7003.com #Eureka Server ʵÀýÃû³Æ + hostname: eureka7003.com #Eureka Server 实例å��ç§° client: - register-with-eureka: false #false ±íʾ²»Ïò×¢²áÖÐÐÄ×¢²á×Ô¼º¡£ - fetch-registry: false #false ±íʾ×Ô¼º¶Ë¾ÍÊÇ×¢²áÖÐÐÄ£¬ÎÒµÄÖ°Ôð¾ÍÊÇά»¤·þÎñʵÀý£¬²¢²»ÐèҪȥ¼ìË÷·þÎñ + register-with-eureka: false #false 表示ä¸�å�‘注册中心注册自己。 + fetch-registry: false #false 表示自己端就是注册中心,我的è�Œè´£å°±æ˜¯ç»´æŠ¤æœ�务实例,并ä¸�需è¦�去检索æœ�务 service-url: - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/ #½«Õâ¸ö Eureka Server ×¢²áµ½ 7001 ºÍ 7002 ÉÏ + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/ #将这个 Eureka Server 注册到 7001 å’Œ 7002 上 ``` -3\. ÓÉÓÚÎÒÃÇÊÇÔÚ±¾µØ´î½¨µÄ Eureka Server ¼¯Èº£¬Òò´ËÎÒÃÇÐèÒªÐ޸ı¾µØµÄ host Îļþ£¬Windows ²Ù×÷ϵͳµÄµçÄÔÔÚ C:/Windows/System/drivers/etc/hosts ÖÐÐ޸ģ¬Mac ϵͳµÄµçÄÔÔòÐèÒªÔÚ vim/etc/hosts ÖÐÐ޸ģ¬ÐÞ¸ÄÄÚÈÝÈçÏ¡£ +3\. 由于我们是在本地æ�­å»ºçš„ Eureka Server 集群,因此我们需è¦�修改本地的 host 文件,Windows æ“�作系统的电脑在 C:/Windows/System/drivers/etc/hosts 中修改,Mac 系统的电脑则需è¦�在 vim/etc/hosts 中修改,修改内容如下。 ``` -#Spring Cloud eureka ¼¯Èº +#Spring Cloud eureka 集群 127.0.0.1 eureka7001.com 127.0.0.1 eureka7002.com 127.0.0.1 eureka7003.com ``` -4\. ÐÞ¸Ä micro-service-cloud-provider-dept-8001£¨·þÎñÌṩÕߣ©ÅäÖÃÎļþ application.yml ÖÐ eureka.client.service-url.defaultZone µÄȡֵ£¬½«·þÎñ×¢²áµ½ Eureka Server ¼¯ÈºÉÏ£¬¾ßÌåÅäÖÃÈçÏ¡£ +4\. 修改 micro-service-cloud-provider-dept-8001(æœ�务æ��供者)é…�置文件 application.yml 中 eureka.client.service-url.defaultZone çš„å�–值,将æœ�务注册到 Eureka Server 集群上,具体é…�置如下。 @@ -909,60 +909,60 @@ eureka: ``` eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - #defaultZone: http://eureka7001.com:7001/eureka #Õâ¸öµØÖ·ÊÇ 7001 ×¢²áÖÐÐÄÔÚ application.yml Öб©Â¶³öÀ´µÄ×¢²áµØÖ· £¨µ¥»ú°æ£© - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka Server ¼¯Èº + #defaultZone: http://eureka7001.com:7001/eureka #这个地å�€æ˜¯ 7001 注册中心在 application.yml 中暴露出æ�¥çš„æ³¨å†Œåœ°å�€ (å�•机版) + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka Server 集群 ``` -5\. Æô¶¯ micro-service-cloud-eureka-7001£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:7001/¡±£¬½á¹ûÈçÏÂͼ¡£ +5\. å�¯åЍ micro-service-cloud-eureka-7001,使用æµ�览器访问“http://eureka7001.com:7001/â€�,结果如下图。 -![Eureka ¼¯Èº 7001](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010302b3-4.png) +![Eureka 集群 7001](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010302b3-4.png) -ͼ5£ºEureka Server ¼¯Èº -7001 +图5:Eureka Server 集群 -7001 -´ÓÉÏͼ¿ÉÒÔ¿´µ½£¬ ·þÎñÌṩÕߣ¨micro-service-cloud-provider-dept-8001£©µÄ·þÎñÒѾ­×¢²áµ½ÁË Eureka Server 7001£¬²¢ÇÒÔÚ DS Replicas Ñ¡ÏîÖÐÒ²ÏÔʾÁ˼¯ÈºÖеÄÁíÍâÁ½¸ö Eureka Server£ºEureka Server 7002 ºÍ Eureka Server 7003¡£ +从上图å�¯ä»¥çœ‹åˆ°ï¼Œ æœ�务æ��供者(micro-service-cloud-provider-dept-8001)的æœ�务已ç»�注册到了 Eureka Server 7001,并且在 DS Replicas 选项中也显示了集群中的å�¦å¤–两个 Eureka Server:Eureka Server 7002 å’Œ Eureka Server 7003。 -6\. Æô¶¯ micro-service-cloud-eureka-7002£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7002.com:7002/¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. å�¯åЍ micro-service-cloud-eureka-7002,使用æµ�览器访问“http://eureka7002.com:7002/â€�,结果如下图。 -![Eureka ¼¯Èº 7002](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101030E36-5.png) -ͼ6£ºEureka Server ¼¯Èº -7002 +![Eureka 集群 7002](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101030E36-5.png) +图6:Eureka Server 集群 -7002 -´ÓÉÏͼ¿ÉÒÔ¿´µ½£¬ ·þÎñÌṩÕߣ¨micro-service-cloud-provider-dept-8001£©ËùÌṩµÄ·þÎñÒѾ­×¢²áµ½ÁË Eureka Server 7002£¬²¢ÇÒÔÚ DS Replicas Ñ¡ÏîÖÐÒ²ÏÔʾÁ˼¯ÈºÖеÄÁíÍâÁ½¸ö Eureka Server£ºEureka Server 7001 ºÍ Eureka Server 7003¡£ +从上图å�¯ä»¥çœ‹åˆ°ï¼Œ æœ�务æ��供者(micro-service-cloud-provider-dept-8001)所æ��供的æœ�务已ç»�注册到了 Eureka Server 7002,并且在 DS Replicas 选项中也显示了集群中的å�¦å¤–两个 Eureka Server:Eureka Server 7001 å’Œ Eureka Server 7003。 -7. Æô¶¯ micro-service-cloud-eureka-7003£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7003.com:7003/¡±£¬½á¹ûÈçÏÂͼ¡£ +7. å�¯åЍ micro-service-cloud-eureka-7003,使用æµ�览器访问“http://eureka7003.com:7003/â€�,结果如下图。 -![Eureka ¼¯Èº 7003](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010306034-6.png) -ͼ7£ºEureka Server ¼¯Èº -7003 +![Eureka 集群 7003](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010306034-6.png) +图7:Eureka Server 集群 -7003 -´ÓÉÏͼ¿ÉÒÔ¿´µ½£¬ ·þÎñÌṩÕߣ¨micro-service-cloud-provider-dept-8001£©ËùÌṩµÄ·þÎñÒѾ­×¢²áµ½ÁË Eureka Server 7003£¬²¢ÇÒÔÚ DS Replicas Ñ¡ÏîÖÐÒ²ÏÔʾÁ˼¯ÈºÖеÄÁíÍâÁ½¸ö Eureka Server£ºEureka Server 7001 ºÍ Eureka Server 7002¡£ +从上图å�¯ä»¥çœ‹åˆ°ï¼Œ æœ�务æ��供者(micro-service-cloud-provider-dept-8001)所æ��供的æœ�务已ç»�注册到了 Eureka Server 7003,并且在 DS Replicas 选项中也显示了集群中的å�¦å¤–两个 Eureka Server:Eureka Server 7001 å’Œ Eureka Server 7002。 -×Ô´ËÎÒÃǾÍÍê³ÉÁË Eureka Server ¼¯ÈºµÄ´î½¨ºÍʹÓᣠ+自此我们就完æˆ�了 Eureka Server 集群的æ�­å»ºå’Œä½¿ç”¨ã€‚ -## Eureka ×ÔÎÒ±£»¤»úÖÆ +## Eureka 自我ä¿�护机制 -µ±ÎÒÃÇÔÚ±¾µØµ÷ÊÔ»ùÓÚ Eureka µÄ³ÌÐòʱ£¬Eureka ·þÎñ×¢²áÖÐÐĺÜÓпÉÄÜ»á³öÏÖÈçÏÂͼËùʾµÄºìÉ«¾¯¸æ¡£ +当我们在本地调试基于 Eureka 的程åº�时,Eureka æœ�务注册中心很有å�¯èƒ½ä¼šå‡ºçŽ°å¦‚ä¸‹å›¾æ‰€ç¤ºçš„çº¢è‰²è­¦å‘Šã€‚ -![Eureka ×ÔÎÒ±£»¤»úÖÆ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10103014a-7.png) -ͼ8£ºEureka ×ÔÎÒ±£»¤Ìáʾ +![Eureka 自我ä¿�护机制](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10103014a-7.png) +图8:Eureka 自我ä¿�护æ��示 -ʵ¼ÊÉÏ£¬Õâ¸ö¾¯¸æÊÇ´¥·¢ÁË Eureka µÄ×ÔÎÒ±£»¤»úÖÆ¶ø³öÏֵġ£Ä¬ÈÏÇé¿öÏ£¬Èç¹û Eureka Server ÔÚÒ»¶Îʱ¼äÄÚ£¨Ä¬ÈÏΪ 90 Ã룩ûÓнÓÊÕµ½Ä³¸ö·þÎñÌṩÕߣ¨Eureka Client£©µÄÐÄÌø£¬¾Í»á½«Õâ¸ö·þÎñÌṩÕßÌṩµÄ·þÎñ´Ó·þÎñ×¢²á±íÖÐÒÆ³ý¡£ ÕâÑù·þÎñÏû·ÑÕß¾ÍÔÙÒ²ÎÞ·¨´Ó·þÎñ×¢²áÖÐÐÄÖлñÈ¡µ½Õâ¸ö·þÎñÁË£¬¸üÎÞ·¨µ÷Óø÷þÎñ¡£ +实际上,这个警告是触å�‘了 Eureka 的自我ä¿�护机制而出现的。默认情况下,如果 Eureka Server 在一段时间内(默认为 90 秒)没有接收到æŸ�个æœ�务æ��供者(Eureka Client)的心跳,就会将这个æœ�务æ��供者æ��供的æœ�务从æœ�务注册表中移除。 这样æœ�务消费者就å†�也无法从æœ�务注册中心中获å�–到这个æœ�务了,更无法调用该æœ�务。 -µ«ÔÚʵ¼ÊµÄ·Ö²¼Ê½Î¢·þÎñϵͳÖУ¬½¡¿µµÄ·þÎñ£¨Eureka Client£©Ò²ÓпÉÄÜ»áÓÉÓÚÍøÂç¹ÊÕÏ£¨ÀýÈçÍøÂçÑÓ³Ù¡¢¿¨¶Ù¡¢Óµ¼·µÈÔ­Òò£©¶øÎÞ·¨Óë Eureka Server Õý³£Í¨Ñ¶¡£Èô´Ëʱ Eureka Server ÒòΪûÓнÓÊÕÐÄÌø¶øÎ󽫽¡¿µµÄ·þÎñ´Ó·þÎñÁбíÖÐÒÆ³ý£¬ÕâÏÔÈ»ÊDz»ºÏÀíµÄ¡£¶ø Eureka µÄ×ÔÎÒ±£»¤»úÖÆ¾ÍÊÇÀ´½â¾ö´ËÎÊÌâµÄ¡£ +但在实际的分布å¼�å¾®æœ�务系统中,å�¥åº·çš„æœ�务(Eureka Client)也有å�¯èƒ½ä¼šç”±äºŽç½‘络故障(例如网络延迟ã€�å�¡é¡¿ã€�拥挤等原因)而无法与 Eureka Server 正常通讯。若此时 Eureka Server 因为没有接收心跳而误将å�¥åº·çš„æœ�务从æœ�务列表中移除,这显然是ä¸�å�ˆç�†çš„。而 Eureka 的自我ä¿�护机制就是æ�¥è§£å†³æ­¤é—®é¢˜çš„。 -Ëùν ¡°Eureka µÄ×ÔÎÒ±£»¤»úÖÆ¡±£¬ÆäÖÐÐÄ˼Ïë¾ÍÊÇ¡°ºÃËÀ²»ÈçÀµ»î×Å¡±¡£Èç¹û Eureka Server ÔÚÒ»¶Îʱ¼äÄÚûÓнÓÊÕµ½ Eureka Client µÄÐÄÌø£¬ÄÇô Eureka Server ¾Í»á¿ªÆô×ÔÎÒ±£»¤Ä£Ê½£¬½«ËùÓÐµÄ Eureka Client µÄ×¢²áÐÅÏ¢±£»¤ÆðÀ´£¬¶ø²»ÊÇÖ±½Ó´Ó·þÎñ×¢²á±íÖÐÒÆ³ý¡£Ò»µ©ÍøÂç»Ö¸´£¬ÕâЩ Eureka Client ÌṩµÄ·þÎñ»¹¿ÉÒÔ¼ÌÐø±»·þÎñÏû·ÑÕßÏû·Ñ¡£ +所谓 “Eureka 的自我ä¿�护机制â€�,其中心æ€�想就是“好死ä¸�如赖活ç�€â€�。如果 Eureka Server 在一段时间内没有接收到 Eureka Client 的心跳,那么 Eureka Server 就会开å�¯è‡ªæˆ‘ä¿�护模å¼�,将所有的 Eureka Client 的注册信æ�¯ä¿�护起æ�¥ï¼Œè€Œä¸�是直接从æœ�务注册表中移除。一旦网络æ�¢å¤�,这些 Eureka Client æ��供的æœ�务还å�¯ä»¥ç»§ç»­è¢«æœ�务消费者消费。 -×ÛÉÏ£¬Eureka µÄ×ÔÎÒ±£»¤»úÖÆÊÇÒ»ÖÖÓ¦¶ÔÍøÂçÒì³£µÄ°²È«±£»¤´ëÊ©¡£ËüµÄ¼Ü¹¹ÕÜѧÊÇ£ºÄþ¿Éͬʱ±£ÁôËùÓÐ΢·þÎñ£¨½¡¿µµÄ·þÎñºÍ²»½¡¿µµÄ·þÎñ¶¼»á±£Áô£©Ò²²»Ã¤Ä¿ÒƳýÈκν¡¿µµÄ·þÎñ¡£Í¨¹ý Eureka µÄ×ÔÎÒ±£»¤»úÖÆ£¬¿ÉÒÔÈà Eureka Server ¼¯Èº¸ü¼ÓµÄ½¡×³¡¢Îȶ¨¡£ +综上,Eureka 的自我ä¿�护机制是一ç§�应对网络异常的安全ä¿�护措施。它的架构哲学是:å®�å�¯å�Œæ—¶ä¿�留所有微æœ�务(å�¥åº·çš„æœ�务和ä¸�å�¥åº·çš„æœ�务都会ä¿�留)也ä¸�盲目移除任何å�¥åº·çš„æœ�务。通过 Eureka 的自我ä¿�护机制,å�¯ä»¥è®© Eureka Server 集群更加的å�¥å£®ã€�稳定。 -> Eureka µÄ×ÔÎÒ±£»¤»úÖÆÒ²´æÔÚ±×¶Ë¡£Èç¹ûÔÚ Eureka ×ÔÎÒ±£»¤»úÖÆ´¥·¢ÆÚ¼ä£¬·þÎñÌṩÕßÌṩµÄ·þÎñ³öÏÖÎÊÌ⣬ÄÇô·þÎñÏû·ÑÕ߾ͺÜÈÝÒ×»ñÈ¡µ½ÒѾ­²»´æÔڵķþÎñ½ø¶ø³öÏÖµ÷ÓÃʧ°ÜµÄÇé¿ö£¬´Ëʱ£¬ÎÒÃÇ¿ÉÒÔͨ¹ý¿Í»§¶ËµÄÈÝ´í»úÖÆÀ´½â¾ö´ËÎÊÌ⣬ÏêÇéÇë²Î¿¼ [Spring Cloud Netflix Ribbon](http://c.biancheng.net/springcloud/ribbon.html) ºÍ [Spring Cloud Netflix Hystrix](http://c.biancheng.net/springcloud/hystrix.html)¡£ +> Eureka 的自我ä¿�护机制也存在弊端。如果在 Eureka 自我ä¿�护机制触å�‘期间,æœ�务æ��供者æ��供的æœ�务出现问题,那么æœ�务消费者就很容易获å�–到已ç»�ä¸�存在的æœ�务进而出现调用失败的情况,此时,我们å�¯ä»¥é€šè¿‡å®¢æˆ·ç«¯çš„容错机制æ�¥è§£å†³æ­¤é—®é¢˜ï¼Œè¯¦æƒ…请å�‚考 [Spring Cloud Netflix Ribbon](http://c.biancheng.net/springcloud/ribbon.html) å’Œ [Spring Cloud Netflix Hystrix](http://c.biancheng.net/springcloud/hystrix.html)。 -ĬÈÏÇé¿öÏ£¬Eureka µÄ×ÔÎÒ±£»¤»úÖÆÊÇ¿ªÆôµÄ£¬Èç¹ûÏëÒª¹Ø±Õ£¬ÔòÐèÒªÔÚÅäÖÃÎļþÖÐÌí¼ÓÒÔÏÂÅäÖᣠ+默认情况下,Eureka 的自我ä¿�护机制是开å�¯çš„,如果想è¦�关闭,则需è¦�在é…�置文件中添加以下é…�置。 @@ -973,7 +973,7 @@ eureka: eureka: server: -enable-self-preservation: false # false ¹Ø±Õ Eureka µÄ×ÔÎÒ±£»¤»úÖÆ£¬Ä¬ÈÏÊÇ¿ªÆô,Ò»°ã²»½¨Òé´ó¼ÒÐÞ¸Ä +enable-self-preservation: false # false 关闭 Eureka 的自我ä¿�护机制,默认是开å�¯,一般ä¸�建议大家修改 ``` @@ -981,11 +981,11 @@ enable-self-preservation: false # false -## ʾÀý 3 +## 示例 3 -ÏÂÃæÎÒÃÇͨ¹ýÒ»¸öʵÀý£¬À´Ñé֤ϠEureka µÄ×ÔÎÒ±£»¤»úÖÆ¡£ +下é�¢æˆ‘们通过一个实例,æ�¥éªŒè¯�下 Eureka 的自我ä¿�护机制。 -1\. ÔÚ micro-service-cloud-eureka-7001 µÄÅäÖÃÎļþ application.yml ÖÐÌí¼ÓÒÔÏÂÅäÖã¬¹Ø±Õ Eureka µÄ×ÔÎÒ±£»¤»úÖÆ¡£ +1\. 在 micro-service-cloud-eureka-7001 çš„é…�置文件 application.yml 中添加以下é…�置,关闭 Eureka 的自我ä¿�护机制。 @@ -996,7 +996,7 @@ enable-self-preservation: false # false eureka: server: -enable-self-preservation: false # false ¹Ø±Õ Eureka µÄ×ÔÎÒ±£»¤»úÖÆ£¬Ä¬ÈÏÊÇ¿ªÆô,Ò»°ã²»½¨Òé´ó¼ÒÐÞ¸Ä +enable-self-preservation: false # false 关闭 Eureka 的自我ä¿�护机制,默认是开å�¯,一般ä¸�建议大家修改 ``` @@ -1004,46 +1004,46 @@ enable-self-preservation: false # false -2\. ¼¯ÈºÖÐµÄ micro-service-cloud-eureka-7002 ºÍ micro-service-cloud-eureka-7002 ²»×÷ÈκÎÐ޸쬼´ËüÃǵÄ×ÔÎÒ±£»¤»úÖÆÊÇ¿ªÆôµÄ¡£ +2\. 集群中的 micro-service-cloud-eureka-7002 å’Œ micro-service-cloud-eureka-7002 ä¸�作任何修改,å�³å®ƒä»¬çš„自我ä¿�护机制是开å�¯çš„。 -3\. ÖØÆô Eureka Server ¼¯ÈºÒÔ¼° micro-service-cloud-provider-dept-8001£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:7001/¡±£¬½á¹ûÈçÏÂͼ¡£ +3\. é‡�å�¯ Eureka Server 集群以å�Š micro-service-cloud-provider-dept-8001,使用æµ�览器访问“http://eureka7001.com:7001/â€�,结果如下图。 -![Eureka ×ÔÎÒ±£»¤»úÖÆ 7001](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101030J48-8.png) -ͼ9£ºEureka ¹Ø±Õ×ÔÎÒ±£»¤»úÖÆ +![Eureka 自我ä¿�护机制 7001](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101030J48-8.png) +图9:Eureka 关闭自我ä¿�护机制 -´Óͼ 8 £¬Äú¿ÉÒÔ¿´µ½ÒÔÏÂÄÚÈÝ£º +从图 8 ,您å�¯ä»¥çœ‹åˆ°ä»¥ä¸‹å†…容: -* ÔÚ DS Replicas Ñ¡ÏîÉÏÃæ³öÏÖÁ˺ìÉ«¾¯¸æÐÅÏ¢¡°THE SELF PRESERVATION MODE IS TURNED OFF. THIS MAY NOT PROTECT INSTANCE EXPIRY IN CASE OF NETWORK/OTHER PROBLEMS.¡±£¬³öÏÖ¸ÃÐÅÏ¢Ôò±íʾ¡° Eureka ×ÔÎÒ±£»¤Ä£Ê½Òѹرա£¡± -* micro-service-cloud-provider-dept-8001 ÌṩµÄ·þÎñÒѾ­×¢²áµ½¸Ã Eureka Server ÖС£ +* 在 DS Replicas 选项上é�¢å‡ºçŽ°äº†çº¢è‰²è­¦å‘Šä¿¡æ�¯â€œTHE SELF PRESERVATION MODE IS TURNED OFF. THIS MAY NOT PROTECT INSTANCE EXPIRY IN CASE OF NETWORK/OTHER PROBLEMS.â€�,出现该信æ�¯åˆ™è¡¨ç¤ºâ€œ Eureka 自我ä¿�护模å¼�已关闭。â€� +* micro-service-cloud-provider-dept-8001 æ��供的æœ�务已ç»�注册到该 Eureka Server 中。 -4\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7002.com:7002/¡±£¬½á¹ûÈçÏÂͼ¡£ +4\. 使用æµ�览器访问“http://eureka7002.com:7002/â€�,结果如下图。 -![Eureka ×ÔÎÒ±£»¤»úÖÆ 7002](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010301938-9.png) -ͼ10£ºEureka ×ÔÎÒ±£»¤»úÖÆ +![Eureka 自我ä¿�护机制 7002](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010301938-9.png) +图10:Eureka 自我ä¿�护机制 -´Óͼ 9 ¿ÉÒÔ¿´³ö£¬micro-service-cloud-provider-dept-8001 ÌṩµÄ·þÎñÒ²ÒѾ­×¢²áµ½µ±Ç° Eureka Server ÖУ¬µ« DS Replicas Ñ¡ÏîÉÏ·½Ã»ÓÐÈκξ¯¸æÌáʾ¡£ +从图 9 å�¯ä»¥çœ‹å‡ºï¼Œmicro-service-cloud-provider-dept-8001 æ��供的æœ�务也已ç»�注册到当å‰� Eureka Server 中,但 DS Replicas 选项上方没有任何警告æ��示。 -5\. ¹Ø±Õ micro-service-cloud-provider-dept-8001£¬µÈ´ý¼¸·ÖÖÓ£¬ÔٴηÃÎÊ¡°http://eureka7001.com:7001/¡±£¬½á¹ûÈçÏÂͼ¡£ +5\. 关闭 micro-service-cloud-provider-dept-8001,等待几分钟,å†�次访问“http://eureka7001.com:7001/â€�,结果如下图。 -![Eureka ×ÔÎÒ±£»¤»úÖÆ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10103014J-10.png) -ͼ11£ºEureka ¹Ø±Õ×ÔÎÒ±£»¤»úÖÆ-2 +![Eureka 自我ä¿�护机制](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10103014J-10.png) +图11:Eureka 关闭自我ä¿�护机制-2 -ÔÚͼ 10 ÖÐ £¬ÎÒÃÇ¿ÉÒÔ¿´µ½ÒÔÏÂÄÚÈÝ£º +在图 10 中 ,我们å�¯ä»¥çœ‹åˆ°ä»¥ä¸‹å†…容: -* ÔÚ DS Replicas Ñ¡ÏîÉÏÃæ³öÏÖÁ˺ìÉ«¾¯¸æÐÅÏ¢¡°RENEWALS ARE LESSER THAN THE THRESHOLD. THE SELF PRESERVATION MODE IS TURNED OFF. THIS MAY NOT PROTECT INSTANCE EXPIRY IN CASE OF NETWORK/OTHER PROBLEMS.¡±£¬³öÏÖ¸ÃÐÅÏ¢Ôò±íʾ Eureka µÄ×ÔÎÒ±£»¤Ä£Ê½Òѹرգ¬ÇÒÒѾ­ÓзþÎñ±»ÒƳý¡£ -* micro-service-cloud-provider-dept-8001 ÌṩµÄ·þÎñÒѾ­´Ó·þÎñÁбíÖÐÒÆ³ý¡£ +* 在 DS Replicas 选项上é�¢å‡ºçŽ°äº†çº¢è‰²è­¦å‘Šä¿¡æ�¯â€œRENEWALS ARE LESSER THAN THE THRESHOLD. THE SELF PRESERVATION MODE IS TURNED OFF. THIS MAY NOT PROTECT INSTANCE EXPIRY IN CASE OF NETWORK/OTHER PROBLEMS.â€�,出现该信æ�¯åˆ™è¡¨ç¤º Eureka 的自我ä¿�护模å¼�已关闭,且已ç»�有æœ�务被移除。 +* micro-service-cloud-provider-dept-8001 æ��供的æœ�务已ç»�从æœ�务列表中移除。 -6\. ÔٴηÃÎÊ¡°http://eureka7002.com:7002/¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. å†�次访问“http://eureka7002.com:7002/â€�,结果如下图。 -![Eureka ×ÔÎÒ±£»¤»úÖÆ¿ªÆô](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010301210-11.png) -ͼ12£ºEureka ×ÔÎÒ±£»¤»úÖÆÉúЧ +![Eureka 自我ä¿�护机制开å�¯](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1010301210-11.png) +图12:Eureka 自我ä¿�护机制生效 -ÔÚͼ 11 ÖÐ £¬Äú¿ÉÒÔ¿´µ½ÒÔÏÂÄÚÈÝ£º +在图 11 中 ,您å�¯ä»¥çœ‹åˆ°ä»¥ä¸‹å†…容: -* ÔÚ DS Replicas Ñ¡ÏîÉÏÃæ³öÏÖÁ˺ìÉ«¾¯¸æÐÅÏ¢¡°EMERGENCY! EUREKA MAY BE INCORRECTLY CLAIMING INSTANCES ARE UP WHEN THEY'RE NOT. RENEWALS ARE LESSER THAN THRESHOLD AND HENCE THE INSTANCES ARE NOT BEING EXPIRED JUST TO BE SAFE.¡±£¬³öÏÖ¸ÃÐÅÏ¢±íÃ÷ Eureka µÄ×ÔÎÒ±£»¤»úÖÆ´¦ÓÚ¿ªÆô״̬£¬ÇÒÒѾ­±»´¥·¢¡£ -* micro-service-cloud-provider-dept-8001 µÄ·þÎñÐÅÏ¢ÒÀÈ»±£´æ Eureka Server ·þÎñ×¢²á±íÖУ¬²¢Î´±»ÒƳý¡£ +* 在 DS Replicas 选项上é�¢å‡ºçŽ°äº†çº¢è‰²è­¦å‘Šä¿¡æ�¯â€œEMERGENCY! EUREKA MAY BE INCORRECTLY CLAIMING INSTANCES ARE UP WHEN THEY'RE NOT. RENEWALS ARE LESSER THAN THRESHOLD AND HENCE THE INSTANCES ARE NOT BEING EXPIRED JUST TO BE SAFE.â€�,出现该信æ�¯è¡¨æ˜Ž Eureka 的自我ä¿�护机制处于开å�¯çжæ€�,且已ç»�被触å�‘。 +* micro-service-cloud-provider-dept-8001 çš„æœ�务信æ�¯ä¾�ç„¶ä¿�å­˜ Eureka Server æœ�务注册表中,并未被移除。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudGateway.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudGateway.md" index e99968d..44f2de5 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudGateway.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudGateway.md" @@ -1,31 +1,31 @@ -ÔÚ΢·þÎñ¼Ü¹¹ÖУ¬Ò»¸öϵͳÍùÍùÓɶà¸ö΢·þÎñ×é³É£¬¶øÕâЩ·þÎñ¿ÉÄܲ¿ÊðÔÚ²»Í¬»ú·¿¡¢²»Í¬µØÇø¡¢²»Í¬ÓòÃûÏ¡£ÕâÖÖÇé¿öÏ£¬¿Í»§¶Ë£¨ÀýÈçä¯ÀÀÆ÷¡¢ÊÖ»ú¡¢Èí¼þ¹¤¾ßµÈ£©ÏëÒªÖ±½ÓÇëÇóÕâЩ·þÎñ£¬¾ÍÐèÒªÖªµÀËüÃǾßÌåµÄµØÖ·ÐÅÏ¢£¬ÀýÈç IP µØÖ·¡¢¶Ë¿ÚºÅµÈ¡£ +在微æœ�务架构中,一个系统往往由多个微æœ�务组æˆ�,而这些æœ�务å�¯èƒ½éƒ¨ç½²åœ¨ä¸�å�Œæœºæˆ¿ã€�ä¸�å�Œåœ°åŒºã€�ä¸�å�ŒåŸŸå��下。这ç§�情况下,客户端(例如æµ�览器ã€�手机ã€�软件工具等)想è¦�直接请求这些æœ�务,就需è¦�知é�“它们具体的地å�€ä¿¡æ�¯ï¼Œä¾‹å¦‚ IP 地å�€ã€�端å�£å�·ç­‰ã€‚ -ÕâÖÖ¿Í»§¶ËÖ±½ÓÇëÇó·þÎñµÄ·½Ê½´æÔÚÒÔÏÂÎÊÌ⣺ +è¿™ç§�客户端直接请求æœ�务的方å¼�存在以下问题: -* µ±·þÎñÊýÁ¿ÖÚ¶àʱ£¬¿Í»§¶ËÐèҪά»¤´óÁ¿µÄ·þÎñµØÖ·£¬Õâ¶ÔÓÚ¿Í»§¶ËÀ´Ëµ£¬ÊǷdz£·±Ëö¸´Ôӵġ£ -* ÔÚijЩ³¡¾°Ï¿ÉÄÜ»á´æÔÚ¿çÓòÇëÇóµÄÎÊÌâ¡£ -* Éí·ÝÈÏÖ¤µÄÄѶȴó£¬Ã¿¸ö΢·þÎñÐèÒª¶ÀÁ¢ÈÏÖ¤¡£ +* 当æœ�务数é‡�众多时,客户端需è¦�维护大é‡�çš„æœ�务地å�€ï¼Œè¿™å¯¹äºŽå®¢æˆ·ç«¯æ�¥è¯´ï¼Œæ˜¯é�žå¸¸ç¹�ç��å¤�æ�‚的。 +* 在æŸ�些场景下å�¯èƒ½ä¼šå­˜åœ¨è·¨åŸŸè¯·æ±‚的问题。 +* 身份认è¯�的难度大,æ¯�个微æœ�务需è¦�独立认è¯�。 -ÎÒÃÇ¿ÉÒÔͨ¹ý API Íø¹ØÀ´½â¾öÕâЩÎÊÌ⣬ÏÂÃæ¾ÍÈÃÎÒÃÇÀ´¿´¿´Ê²Ã´ÊÇ API Íø¹Ø¡£ +我们å�¯ä»¥é€šè¿‡ API 网关æ�¥è§£å†³è¿™äº›é—®é¢˜ï¼Œä¸‹é�¢å°±è®©æˆ‘们æ�¥çœ‹çœ‹ä»€ä¹ˆæ˜¯ API 网关。 -## API Íø¹Ø +## API 网关 -API Íø¹ØÊÇÒ»¸ö´î½¨ÔÚ¿Í»§¶ËºÍ΢·þÎñÖ®¼äµÄ·þÎñ£¬ÎÒÃÇ¿ÉÒÔÔÚ API Íø¹ØÖд¦ÀíһЩ·ÇÒµÎñ¹¦ÄܵÄÂß¼­£¬ÀýÈçȨÏÞÑéÖ¤¡¢¼à¿Ø¡¢»º´æ¡¢ÇëÇó·Óɵȡ£ +API 网关是一个æ�­å»ºåœ¨å®¢æˆ·ç«¯å’Œå¾®æœ�务之间的æœ�务,我们å�¯ä»¥åœ¨ API 网关中处ç�†ä¸€äº›é�žä¸šåŠ¡åŠŸèƒ½çš„é€»è¾‘ï¼Œä¾‹å¦‚æ�ƒé™�验è¯�ã€�监控ã€�缓存ã€�请求路由等。 -API Íø¹Ø¾ÍÏñÕû¸ö΢·þÎñϵͳµÄÃÅÃæÒ»Ñù£¬ÊÇϵͳ¶ÔÍâµÄΨһÈë¿Ú¡£ÓÐÁËËü£¬¿Í»§¶Ë»áÏȽ«ÇëÇó·¢Ë͵½ API Íø¹Ø£¬È»ºóÓÉ API Íø¹Ø¸ù¾ÝÇëÇóµÄ±êʶÐÅÏ¢½«ÇëÇóת·¢µ½Î¢·þÎñʵÀý¡£ +API 网关就åƒ�整个微æœ�务系统的门é�¢ä¸€æ ·ï¼Œæ˜¯ç³»ç»Ÿå¯¹å¤–的唯一入å�£ã€‚有了它,客户端会先将请求å�‘é€�到 API 网关,然å�Žç”± API 网关根æ�®è¯·æ±‚的标识信æ�¯å°†è¯·æ±‚转å�‘到微æœ�务实例。 ![](http://c.biancheng.net/uploads/allimg/211210/101P46212-0.png) -ͼ1£ºÁ½ÖÖ·þÎñ·ÃÎÊ·½Ê½¶Ô±È +图1:两ç§�æœ�务访问方å¼�对比 -¶ÔÓÚ·þÎñÊýÁ¿ÖÚ¶à¡¢¸´ÔӶȽϸߡ¢¹æÄ£±È½Ï´óµÄϵͳÀ´Ëµ£¬Ê¹Óà API Íø¹Ø¾ßÓÐÒÔϺô¦£º +对于æœ�务数é‡�众多ã€�å¤�æ�‚度较高ã€�规模比较大的系统æ�¥è¯´ï¼Œä½¿ç”¨ API 网关具有以下好处: -* ¿Í»§¶Ëͨ¹ý API Íø¹ØÓë΢·þÎñ½»»¥Ê±£¬¿Í»§¶ËÖ»ÐèÒªÖªµÀ API Íø¹ØµØÖ·¼´¿É£¬¶ø²»ÐèҪά»¤´óÁ¿µÄ·þÎñµØÖ·£¬¼ò»¯Á˿ͻ§¶ËµÄ¿ª·¢¡£ -* ¿Í»§¶ËÖ±½ÓÓë API Íø¹ØÍ¨ÐÅ£¬Äܹ»¼õÉÙ¿Í»§¶ËÓë¸÷¸ö·þÎñµÄ½»»¥´ÎÊý¡£ -* ¿Í»§¶ËÓëºó¶ËµÄ·þÎññîºÏ¶È½µµÍ¡£ -* ½ÚÊ¡Á÷Á¿£¬Ìá¸ßÐÔÄÜ£¬ÌáÉýÓû§ÌåÑé¡£ -* API Íø¹Ø»¹ÌṩÁ˰²È«¡¢Á÷¿Ø¡¢¹ýÂË¡¢»º´æ¡¢¼Æ·ÑÒÔ¼°¼à¿ØµÈ API ¹ÜÀí¹¦ÄÜ¡£ +* 客户端通过 API 网关与微æœ�务交互时,客户端å�ªéœ€è¦�知é�“ API 网关地å�€å�³å�¯ï¼Œè€Œä¸�需è¦�维护大é‡�çš„æœ�务地å�€ï¼Œç®€åŒ–了客户端的开å�‘。 +* 客户端直接与 API 网关通信,能够å‡�少客户端与å�„个æœ�务的交互次数。 +* 客户端与å�Žç«¯çš„æœ�务耦å�ˆåº¦é™�低。 +* 节çœ�æµ�é‡�,æ��高性能,æ��å�‡ç”¨æˆ·ä½“验。 +* API 网关还æ��供了安全ã€�æµ�控ã€�过滤ã€�缓存ã€�计费以å�Šç›‘控等 API 管ç�†åŠŸèƒ½ã€‚ -³£¼ûµÄ API Íø¹ØÊµÏÖ·½°¸Ö÷ÒªÓÐÒÔÏ 5 ÖÖ£º +常è§�çš„ API 网关实现方案主è¦�有以下 5 ç§�: * Spring Cloud Gateway * Spring Cloud Netflix Zuul @@ -33,92 +33,92 @@ API * Nginx+Lua * Traefik -±¾½Ú£¬ÎÒÃÇ¾Í¶Ô Spring Cloud Gateway ½øÐÐÏêϸ½éÉÜ¡£ +本节,我们就对 Spring Cloud Gateway 进行详细介ç»�。 ## Spring Cloud Gateway``` -Spring Cloud Gateway ÊÇ Spring Cloud ÍŶӻùÓÚ Spring 5.0¡¢Spring Boot 2.0 ºÍ Project Reactor µÈ¼¼Êõ¿ª·¢µÄ¸ßÐÔÄÜ API Íø¹Ø×é¼þ¡£ +Spring Cloud Gateway 是 Spring Cloud 团队基于 Spring 5.0ã€�Spring Boot 2.0 å’Œ Project Reactor 等技术开å�‘的高性能 API 网关组件。 -Spring Cloud Gateway Ö¼ÔÚÌṩһÖÖ¼òµ¥¶øÓÐЧµÄ;¾¶À´·¢ËÍ API£¬²¢ÎªËüÃÇÌṩºáÇйØ×¢µã£¬ÀýÈ磺°²È«ÐÔ£¬¼à¿Ø/Ö¸±êºÍµ¯ÐÔ¡£``` +Spring Cloud Gateway 旨在æ��供一ç§�简å�•而有效的途径æ�¥å�‘é€� API,并为它们æ��供横切关注点,例如:安全性,监控/指标和弹性。``` -> Spring Cloud Gateway ÊÇ»ùÓÚ WebFlux ¿ò¼ÜʵÏֵ쬶ø WebFlux ¿ò¼Üµ×²ãÔòʹÓÃÁ˸ßÐÔÄÜµÄ Reactor ģʽͨÐÅ¿ò¼Ü Netty¡£ +> Spring Cloud Gateway 是基于 WebFlux 框架实现的,而 WebFlux 框架底层则使用了高性能的 Reactor 模å¼�通信框架 Netty。 -#### Spring Cloud Gateway ºËÐĸÅÄî +#### Spring Cloud Gateway 核心概念 -Spring Cloud GateWay ×îÖ÷ÒªµÄ¹¦ÄܾÍÊÇ·ÓÉת·¢£¬¶øÔÚ¶¨Òåת·¢¹æÔòʱÖ÷񻃾¼°ÁËÒÔÏÂÈý¸öºËÐĸÅÄÈçÏÂ±í¡£ +Spring Cloud GateWay 最主è¦�的功能就是路由转å�‘,而在定义转å�‘规则时主è¦�涉å�Šäº†ä»¥ä¸‹ä¸‰ä¸ªæ ¸å¿ƒæ¦‚念,如下表。 -| ºËÐĸÅÄî | ÃèÊö | +| 核心概念 | æ��è¿° | | --- | --- | -| Route£¨Â·ÓÉ£© | Íø¹Ø×î»ù±¾µÄÄ£¿é¡£ËüÓÉÒ»¸ö ID¡¢Ò»¸öÄ¿±ê URI¡¢Ò»×é¶ÏÑÔ£¨Predicate£©ºÍÒ»×é¹ýÂËÆ÷£¨Filter£©×é³É¡£ | -| Predicate£¨¶ÏÑÔ£© | ·ÓÉת·¢µÄÅжÏÌõ¼þ£¬ÎÒÃÇ¿ÉÒÔͨ¹ý Predicate ¶Ô```HTTP ÇëÇó½øÐÐÆ¥Å䣬ÀýÈçÇëÇó·½Ê½¡¢ÇëÇó·¾¶¡¢ÇëÇóÍ·¡¢²ÎÊýµÈ£¬Èç¹ûÇëÇóÓë¶ÏÑÔÆ¥Åä³É¹¦£¬Ôò½«ÇëÇóת·¢µ½ÏàÓ¦µÄ·þÎñ¡£ | -| Filter£¨¹ýÂËÆ÷£© | ¹ýÂËÆ÷£¬ÎÒÃÇ¿ÉÒÔʹÓÃËü¶ÔÇëÇó½øÐÐÀ¹½ØºÍÐ޸쬻¹¿ÉÒÔʹÓÃËü¶ÔÉÏÎĵÄÏìÓ¦½øÐÐÔÙ´¦Àí¡£ | +| Route(路由) | 网关最基本的模å�—。它由一个 IDã€�一个目标 URIã€�一组断言(Predicate)和一组过滤器(Filter)组æˆ�。 | +| Predicate(断言) | 路由转å�‘的判断æ�¡ä»¶ï¼Œæˆ‘们å�¯ä»¥é€šè¿‡ Predicate 对```HTTP 请求进行匹é…�,例如请求方å¼�ã€�请求路径ã€�请求头ã€�å�‚数等,如果请求与断言匹é…�æˆ�功,则将请求转å�‘到相应的æœ�务。 | +| Filter(过滤器) | 过滤器,我们å�¯ä»¥ä½¿ç”¨å®ƒå¯¹è¯·æ±‚进行拦截和修改,还å�¯ä»¥ä½¿ç”¨å®ƒå¯¹ä¸Šæ–‡çš„å“�应进行å†�处ç�†ã€‚ | -> ×¢Ò⣺ÆäÖÐ Route ºÍ Predicate ±ØÐëͬʱÉùÃ÷¡£ +> 注æ„�:其中 Route å’Œ Predicate å¿…é¡»å�Œæ—¶å£°æ˜Žã€‚ -#### Spring Cloud Gateway µÄÌØÕ÷ +#### Spring Cloud Gateway 的特å¾� -Spring Cloud Gateway ¾ßÓÐÒÔÏÂÌØÐÔ£º +Spring Cloud Gateway 具有以下特性: -* »ùÓÚ Spring Framework 5¡¢Project Reactor ºÍ Spring Boot 2.0 ¹¹½¨¡£ -* Äܹ»ÔÚÈÎÒâÇëÇóÊôÐÔÉÏÆ¥Åä·ÓÉ¡£ -* predicates£¨¶ÏÑÔ£© ºÍ filters£¨¹ýÂËÆ÷£©ÊÇÌØ¶¨ÓÚ·Óɵġ£ -* ¼¯³ÉÁË Hystrix ÈÛ¶ÏÆ÷¡£ -* ¼¯³ÉÁË Spring Cloud DiscoveryClient£¨·þÎñ·¢ÏÖ¿Í»§¶Ë£©¡£ -* Ò×ÓÚ±àд¶ÏÑԺ͹ýÂËÆ÷¡£ -* Äܹ»ÏÞÖÆÇëÇóƵÂÊ¡£ -* Äܹ»ÖØÐ´ÇëÇó·¾¶¡£ +* 基于 Spring Framework 5ã€�Project Reactor å’Œ Spring Boot 2.0 构建。 +* 能够在任æ„�请求属性上匹é…�路由。 +* predicates(断言) å’Œ filters(过滤器)是特定于路由的。 +* 集æˆ�了 Hystrix 熔断器。 +* 集æˆ�了 Spring Cloud DiscoveryClient(æœ�务å�‘现客户端)。 +* 易于编写断言和过滤器。 +* 能够é™�制请求频率。 +* 能够é‡�写请求路径。 -## Gateway µÄ¹¤×÷Á÷³Ì +## Gateway 的工作æµ�程 -Spring Cloud Gateway ¹¤×÷Á÷³ÌÈçÏÂͼ¡£ +Spring Cloud Gateway 工作æµ�程如下图。 -![Spring Cloud Gateway ¹¤×÷Á÷³Ì](http://c.biancheng.net/uploads/allimg/211210/101P45T2-1.png) -ͼ2£ºSpring Cloud Gateway ¹¤×÷Á÷³Ì +![Spring Cloud Gateway 工作æµ�程](http://c.biancheng.net/uploads/allimg/211210/101P45T2-1.png) +图2:Spring Cloud Gateway 工作æµ�程 -Spring Cloud Gateway ¹¤×÷Á÷³Ì˵Ã÷ÈçÏ£º +Spring Cloud Gateway 工作æµ�程说明如下: -1. ¿Í»§¶Ë½«ÇëÇó·¢Ë͵½```Spring Cloud Gateway ÉÏ¡£ -2. Spring Cloud Gateway ͨ¹ý```Gateway Handler Mapping ÕÒµ½ÓëÇëÇóÏàÆ¥ÅäµÄ·ÓÉ£¬½«Æä·¢Ë͸ø Gateway Web Handler¡£ -3. Gateway Web Handler```ͨ¹ýÖ¸¶¨µÄ¹ýÂËÆ÷Á´£¨Filter Chain£©£¬½«ÇëÇóת·¢µ½Êµ¼ÊµÄ·þÎñ½ÚµãÖУ¬Ö´ÐÐÒµÎñÂß¼­·µ»ØÏìÓ¦½á¹û¡£ -4. ¹ýÂËÆ÷Ö®¼äÓÃÐéÏß·Ö¿ªÊÇÒòΪ¹ýÂËÆ÷¿ÉÄÜ»áÔÚת·¢ÇëÇó֮ǰ£¨pre£©»òÖ®ºó£¨post£©Ö´ÐÐÒµÎñÂß¼­¡£ -5. ¹ýÂËÆ÷£¨Filter£©¿ÉÒÔÔÚÇëÇó±»×ª·¢µ½·þÎñ¶Ëǰ£¬¶ÔÇëÇó½øÐÐÀ¹½ØºÍÐ޸ģ¬ÀýÈç²ÎÊýУÑ顢ȨÏÞУÑé¡¢Á÷Á¿¼à¿Ø¡¢ÈÕÖ¾Êä³öÒÔ¼°Ð­Òéת»»µÈ¡£ -6. ¹ýÂËÆ÷¿ÉÒÔÔÚÏìÓ¦·µ»Ø¿Í»§¶Ë֮ǰ£¬¶ÔÏìÓ¦½øÐÐÀ¹½ØºÍÔÙ´¦Àí£¬ÀýÈçÐÞ¸ÄÏìÓ¦ÄÚÈÝ»òÏìӦͷ¡¢ÈÕÖ¾Êä³ö¡¢Á÷Á¿¼à¿ØµÈ¡£ -7. ÏìӦԭ··µ»Ø¸ø¿Í»§¶Ë¡£ +1. 客户端将请求å�‘é€�到```Spring Cloud Gateway 上。 +2. Spring Cloud Gateway 通过```Gateway Handler Mapping 找到与请求相匹é…�的路由,将其å�‘é€�ç»™ Gateway Web Handler。 +3. Gateway Web Handler```通过指定的过滤器链(Filter Chain),将请求转å�‘到实际的æœ�务节点中,执行业务逻辑返回å“�应结果。 +4. 过滤器之间用虚线分开是因为过滤器å�¯èƒ½ä¼šåœ¨è½¬å�‘请求之å‰�(pre)或之å�Žï¼ˆpost)执行业务逻辑。 +5. 过滤器(Filter)å�¯ä»¥åœ¨è¯·æ±‚被转å�‘到æœ�务端å‰�,对请求进行拦截和修改,例如å�‚数校验ã€�æ�ƒé™�校验ã€�æµ�é‡�监控ã€�日志输出以å�Šå��议转æ�¢ç­‰ã€‚ +6. 过滤器å�¯ä»¥åœ¨å“�应返回客户端之å‰�,对å“�应进行拦截和å†�处ç�†ï¼Œä¾‹å¦‚修改å“�应内容或å“�应头ã€�日志输出ã€�æµ�é‡�监控等。 +7. å“�应原路返回给客户端。 -×ܶøÑÔÖ®£¬¿Í»§¶Ë·¢Ë͵½ Spring Cloud Gateway µÄÇëÇóÐèҪͨ¹ýÒ»¶¨µÄÆ¥ÅäÌõ¼þ£¬²ÅÄܶ¨Î»µ½ÕæÕýµÄ·þÎñ½Úµã¡£ÔÚ½«ÇëÇóת·¢µ½·þÎñ½øÐд¦ÀíµÄ¹ý³Ìǰºó£¨pre ºÍ post£©£¬ÎÒÃÇ»¹¿ÉÒÔ¶ÔÇëÇóºÍÏìÓ¦½øÐÐһЩ¾«Ï¸»¯¿ØÖÆ¡£ +总而言之,客户端å�‘é€�到 Spring Cloud Gateway 的请求需è¦�通过一定的匹é…�æ�¡ä»¶ï¼Œæ‰�能定ä½�到真正的æœ�务节点。在将请求转å�‘到æœ�务进行处ç�†çš„过程å‰�å�Žï¼ˆpre å’Œ post),我们还å�¯ä»¥å¯¹è¯·æ±‚å’Œå“�应进行一些精细化控制。 -Predicate ¾ÍÊÇ·Óɵį¥ÅäÌõ¼þ£¬¶ø Filter ¾ÍÊǶÔÇëÇóºÍÏìÓ¦½øÐо«Ï¸»¯¿ØÖƵŤ¾ß¡£ÓÐÁËÕâÁ½¸öÔªËØ£¬ÔÙ¼ÓÉÏÄ¿±ê URI£¬¾Í¿ÉÒÔʵÏÖÒ»¸ö¾ßÌåµÄ·ÓÉÁË¡£ +Predicate 就是路由的匹é…�æ�¡ä»¶ï¼Œè€Œ Filter 就是对请求和å“�应进行精细化控制的工具。有了这两个元素,å†�加上目标 URI,就å�¯ä»¥å®žçŽ°ä¸€ä¸ªå…·ä½“çš„è·¯ç”±äº†ã€‚ -## Predicate ¶ÏÑÔ +## Predicate 断言 -Spring Cloud Gateway ͨ¹ý```Predicate ¶ÏÑÔÀ´ÊµÏÖ Route ·Óɵį¥Å乿Ôò¡£¼òµ¥µã˵£¬Predicate ÊÇ·ÓÉת·¢µÄÅжÏÌõ¼þ£¬ÇëÇóÖ»ÓÐÂú×ãÁË Predicate µÄÌõ¼þ£¬²Å»á±»×ª·¢µ½Ö¸¶¨µÄ·þÎñÉϽøÐд¦Àí¡£ +Spring Cloud Gateway 通过```Predicate 断言æ�¥å®žçް Route 路由的匹é…�规则。简å�•点说,Predicate 是路由转å�‘的判断æ�¡ä»¶ï¼Œè¯·æ±‚å�ªæœ‰æ»¡è¶³äº† Predicate çš„æ�¡ä»¶ï¼Œæ‰�会被转å�‘到指定的æœ�务上进行处ç�†ã€‚ -ʹÓà Predicate ¶ÏÑÔÐèҪעÒâÒÔÏ 3 µã£º +使用 Predicate 断言需è¦�注æ„�以下 3 点: -* Route ·ÓÉÓë Predicate ¶ÏÑԵĶÔÓ¦¹ØÏµÎª¡°Ò»¶Ô¶à¡±£¬Ò»¸ö·ÓÉ¿ÉÒÔ°üº¬¶à¸ö²»Í¬¶ÏÑÔ¡£ -* Ò»¸öÇëÇóÏëҪת·¢µ½Ö¸¶¨µÄ·ÓÉÉÏ£¬¾Í±ØÐëͬʱƥÅä·ÓÉÉϵÄËùÓжÏÑÔ¡£ -* µ±Ò»¸öÇëÇóͬʱÂú×ã¶à¸ö·ÓɵĶÏÑÔÌõ¼þʱ£¬ÇëÇóÖ»»á±»Ê׸ö³É¹¦Æ¥ÅäµÄ·ÓÉת·¢¡£ +* Route 路由与 Predicate 断言的对应关系为“一对多â€�,一个路由å�¯ä»¥åŒ…å�«å¤šä¸ªä¸�å�Œæ–­è¨€ã€‚ +* 一个请求想è¦�转å�‘到指定的路由上,就必须å�Œæ—¶åŒ¹é…�路由上的所有断言。 +* 当一个请求å�Œæ—¶æ»¡è¶³å¤šä¸ªè·¯ç”±çš„æ–­è¨€æ�¡ä»¶æ—¶ï¼Œè¯·æ±‚å�ªä¼šè¢«é¦–个æˆ�功匹é…�的路由转å�‘。 ![](http://c.biancheng.net/uploads/allimg/211210/101P42B6-2.png) -ͼ3£ºPredicate ¶ÏÑÔÆ¥Åä +图3:Predicate 断言匹é…� -³£¼ûµÄ Predicate ¶ÏÑÔÈçÏÂ±í£¨¼ÙÉèת·¢µÄ URI Ϊ http://localhost:8001£©¡£ +常è§�çš„ Predicate 断言如下表(å�‡è®¾è½¬å�‘çš„ URI 为 http://localhost:8001)。 -| ¶ÏÑÔ | ʾÀý | ˵Ã÷ | +| 断言 | 示例 | 说明 | | --- | --- | --- | -| Path | - Path=/dept/list/**``` | µ±ÇëÇó·¾¶Óë /dept/list/** Æ¥Åäʱ£¬¸ÃÇëÇó²ÅÄܱ»×ª·¢µ½```http://localhost:8001 ÉÏ¡£ | -| Before | - Before=2021-10-20T11:47:34.255+08:00[Asia/Shanghai] | ÔÚ```2021 Äê 10 Ô 20 ÈÕ 11 ʱ 47 ·Ö 34.255 Ãë֮ǰµÄÇëÇ󣬲Żᱻת·¢µ½```http://localhost:8001 ÉÏ¡£ | -| After | - After=2021-10-20T11:47:34.255+08:00[Asia/Shanghai] | ÔÚ 2021 Äê 10 Ô 20 ÈÕ 11 ʱ 47 ·Ö 34.255 ÃëÖ®ºóµÄÇëÇ󣬲Żᱻת·¢µ½```http://localhost:8001 ÉÏ¡£ | -| Between | - Between=2021-10-20T15:18:33.226+08:00[Asia/Shanghai],2021-10-20T15:23:33.226+08:00[Asia/Shanghai] | ÔÚ 2021 Äê 10 Ô 20 ÈÕ 15 ʱ 18 ·Ö 33.226 Ãë µ½ 2021 Äê 10 Ô 20 ÈÕ 15 ʱ 23 ·Ö 33.226 ÃëÖ®¼äµÄÇëÇ󣬲Żᱻת·¢µ½```http://localhost:8001 ·þÎñÆ÷ÉÏ¡£ | -| Cookie | - Cookie=name,c.biancheng.net | Я´ø```Cookie ÇÒ Cookie µÄÄÚÈÝΪ```name=c.biancheng.net µÄÇëÇ󣬲Żᱻת·¢µ½ http://localhost:8001 ÉÏ¡£ | -| Header | - Header=X-Request-Id,\d+ | ÇëÇóÍ·ÉÏЯ´øÊôÐÔ X-Request-Id ÇÒÊôÐÔֵΪÕûÊýµÄÇëÇ󣬲Żᱻת·¢µ½ http://localhost:8001 ÉÏ¡£ | -| Method | - Method=GET | Ö»ÓÐ GET ÇëÇó²Å»á±»×ª·¢µ½ http://localhost:8001 ÉÏ¡£ | +| Path | - Path=/dept/list/**``` | 当请求路径与 /dept/list/** 匹é…�时,该请求æ‰�能被转å�‘到```http://localhost:8001 上。 | +| Before | - Before=2021-10-20T11:47:34.255+08:00[Asia/Shanghai] | 在```2021 å¹´ 10 月 20 æ—¥ 11 æ—¶ 47 分 34.255 秒之å‰�的请求,æ‰�会被转å�‘到```http://localhost:8001 上。 | +| After | - After=2021-10-20T11:47:34.255+08:00[Asia/Shanghai] | 在 2021 å¹´ 10 月 20 æ—¥ 11 æ—¶ 47 分 34.255 秒之å�Žçš„请求,æ‰�会被转å�‘到```http://localhost:8001 上。 | +| Between | - Between=2021-10-20T15:18:33.226+08:00[Asia/Shanghai],2021-10-20T15:23:33.226+08:00[Asia/Shanghai] | 在 2021 å¹´ 10 月 20 æ—¥ 15 æ—¶ 18 分 33.226 ç§’ 到 2021 å¹´ 10 月 20 æ—¥ 15 æ—¶ 23 分 33.226 秒之间的请求,æ‰�会被转å�‘到```http://localhost:8001 æœ�务器上。 | +| Cookie | - Cookie=name,c.biancheng.net | æ�ºå¸¦```Cookie 且 Cookie 的内容为```name=c.biancheng.net 的请求,æ‰�会被转å�‘到 http://localhost:8001 上。 | +| Header | - Header=X-Request-Id,\d+ | 请求头上æ�ºå¸¦å±žæ€§ X-Request-Id 且属性值为整数的请求,æ‰�会被转å�‘到 http://localhost:8001 上。 | +| Method | - Method=GET | å�ªæœ‰ GET 请求æ‰�会被转å�‘到 http://localhost:8001 上。 | -#### ʾÀý +#### 示例 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý£¬À´ÑÝʾÏ Predicate ÊÇÈçºÎʹÓõġ£ +下é�¢æˆ‘们就通过一个实例,æ�¥æ¼”示下 Predicate 是如何使用的。 -1\. ÔÚ¸¸¹¤³Ì```spring-cloud-demo2 Ï´´½¨Ò»¸öÃûΪ```micro-service-cloud-gateway-9527 µÄ Spring Boot Ä£¿é£¬²¢ÔÚÆä pom.xml ÖÐÒýÈëÏà¹ØÒÀÀµ£¬ÅäÖÃÈçÏ¡£ +1\. 在父工程```spring-cloud-demo2 下创建一个å��为```micro-service-cloud-gateway-9527 çš„ Spring Boot 模å�—,并在其 pom.xml 中引入相关ä¾�赖,é…�置如下。 @@ -155,13 +155,13 @@ Spring Cloud Gateway ͨ test - - + + org.springframework.cloud spring-cloud-starter-gateway - + org.springframework.cloud spring-cloud-starter-netflix-eureka-client @@ -191,7 +191,7 @@ Spring Cloud Gateway ͨ -2\. ÔÚ```micro-service-cloud-gateway-9527 µÄÀà·¾¶£¨/resources Ŀ¼£©Ï£¬Ð½¨Ò»¸öÅäÖÃÎļþ application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2\. 在```micro-service-cloud-gateway-9527 的类路径(/resources 目录)下,新建一个é…�置文件 application.yml,é…�置内容如下。 @@ -199,20 +199,20 @@ Spring Cloud Gateway ͨ ``` server: - port: 9527 #¶Ë¿ÚºÅ + port: 9527 #端å�£å�· spring: application: name: microServiceCloudGateway cloud: - gateway: #Íø¹ØÂ·ÓÉÅäÖà + gateway: #网关路由é…�ç½® routes: - #½« micro-service-cloud-provider-dept-8001 ÌṩµÄ·þÎñÒþ²ØÆðÀ´£¬²»±©Â¶¸ø¿Í»§¶Ë£¬Ö»¸ø¿Í»§¶Ë±©Â¶ API Íø¹ØµÄµØÖ· 9527 - - id: provider_dept_list_routh #·ÓÉ id,ûÓй̶¨¹æÔò£¬µ«Î¨Ò»£¬½¨ÒéÓë·þÎñÃû¶ÔÓ¦ - uri: http://localhost:8001 #Æ¥ÅäºóÌṩ·þÎñµÄ·ÓɵØÖ· + #å°† micro-service-cloud-provider-dept-8001 æ��供的æœ�务éš�è—�èµ·æ�¥ï¼Œä¸�暴露给客户端,å�ªç»™å®¢æˆ·ç«¯æš´éœ² API 网关的地å�€ 9527 + - id: provider_dept_list_routh #路由 id,没有固定规则,但唯一,建议与æœ�务å��对应 + uri: http://localhost:8001 #匹é…�å�Žæ��ä¾›æœ�务的路由地å�€ predicates: - #ÒÔÏÂÊǶÏÑÔÌõ¼þ£¬±ØÑ¡È«²¿·ûºÏÌõ¼þ - - Path=/dept/list/** #¶ÏÑÔ£¬Â·¾¶Æ¥Åä ×¢Ò⣺Path ÖÐ P Ϊ´óд - - Method=GET #Ö»ÄÜʱ GET ÇëÇóʱ£¬²ÅÄÜ·ÃÎÊ + #以下是断言æ�¡ä»¶ï¼Œå¿…选全部符å�ˆæ�¡ä»¶ + - Path=/dept/list/** #断言,路径匹é…� 注æ„�:Path 中 P 为大写 + - Method=GET #å�ªèƒ½æ—¶ GET 请求时,æ‰�能访问 eureka: instance: @@ -229,14 +229,14 @@ eureka: -ÒÔÉÏÅäÖÃÖУ¬ÎÒÃÇÔÚ spring.cloud.gateway.routes ÏÂʹÓà predicates ÊôÐÔ£¬¶¨ÒåÁËÒÔÏÂÁ½¸ö¶ÏÑÔÌõ¼þ£º +以上é…�置中,我们在 spring.cloud.gateway.routes 下使用 predicates 属性,定义了以下两个断言æ�¡ä»¶ï¼š ``` - Path=/dept/list/** - Method=GET ``` -Ö»Óе±Íⲿ£¨¿Í»§¶Ë£©·¢Ë͵½ micro-service-cloud-gateway-9527 µÄ HTTP ÇëÇóͬʱÂú×ãÒÔÉÏËùÓеĶÏÑÔʱ£¬¸ÃÇëÇó²Å»á±»×ª·¢µ½Ö¸¶¨µÄ·þÎñ¶ËÖУ¨¼´ http://localhost:8001£©¡£3\. ÔÚ```micro-service-cloud-gateway-9527 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableEurekaClient ×¢½â¿ªÆô Eureka ¿Í»§¶Ë¹¦ÄÜ£¬´úÂëÈçÏ¡£ +å�ªæœ‰å½“外部(客户端)å�‘é€�到 micro-service-cloud-gateway-9527 çš„ HTTP 请求å�Œæ—¶æ»¡è¶³ä»¥ä¸Šæ‰€æœ‰çš„æ–­è¨€æ—¶ï¼Œè¯¥è¯·æ±‚æ‰�会被转å�‘到指定的æœ�务端中(å�³ http://localhost:8001)。3\. 在```micro-service-cloud-gateway-9527 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableEurekaClient 注解开å�¯ Eureka 客户端功能,代ç �如下。 @@ -264,29 +264,29 @@ public class MicroServiceCloudGateway9527Application { -4\. ÒÀ´ÎÆô¶¯ Eureka ·þÎñ×¢²áÖÐÐÄ£¨¼¯Èº£©¡¢micro-service-cloud-provider-dept-8001 ÒÔ¼°```micro-service-cloud-gateway-9527£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:9527/dept/list¡±£¬½á¹ûÈçÏÂͼ¡£ +4\. ä¾�次å�¯åЍ Eureka æœ�务注册中心(集群)ã€�micro-service-cloud-provider-dept-8001 以å�Š```micro-service-cloud-gateway-9527,使用æµ�览器访问“http://localhost:9527/dept/listâ€�,结果如下图。 -![Spring Cloud ¶ÏÑÔÌõ¼þ](http://c.biancheng.net/uploads/allimg/211210/101P43419-3.png) -ͼ4£ºSpring Cloud Gateway ·ÓÉת·¢ +![Spring Cloud 断言æ�¡ä»¶](http://c.biancheng.net/uploads/allimg/211210/101P43419-3.png) +图4:Spring Cloud Gateway 路由转å�‘ -## Spring Cloud Gateway ¶¯Ì¬Â·ÓÉ +## Spring Cloud Gateway 动æ€�路由 -ĬÈÏÇé¿öÏ£¬Spring Cloud Gateway »á¸ù¾Ý·þÎñ×¢²áÖÐÐÄ£¨ÀýÈç Eureka Server£©ÖÐά»¤µÄ·þÎñÁÐ±í£¬ÒÔ·þÎñÃû£¨spring.application.name£©×÷Ϊ·¾¶´´½¨¶¯Ì¬Â·ÓɽøÐÐת·¢£¬´Ó¶øÊµÏÖ¶¯Ì¬Â·Óɹ¦ÄÜ¡£ +默认情况下,Spring Cloud Gateway 会根æ�®æœ�务注册中心(例如 Eureka Server)中维护的æœ�务列表,以æœ�务å��(spring.application.name)作为路径创建动æ€�路由进行转å�‘,从而实现动æ€�路由功能。 -ÎÒÃÇ¿ÉÒÔÔÚÅäÖÃÎļþÖУ¬½« Route µÄ uri µØÖ·ÐÞ¸ÄΪÒÔÏÂÐÎʽ¡£ +我们å�¯ä»¥åœ¨é…�置文件中,将 Route çš„ uri 地å�€ä¿®æ”¹ä¸ºä»¥ä¸‹å½¢å¼�。 ```lb://service-name``` -ÒÔÉÏÅäÖÃ˵Ã÷ÈçÏ£º +以上é…�置说明如下: -* lb£ºuri µÄЭÒ飬±íʾ¿ªÆô Spring Cloud Gateway µÄ¸ºÔؾùºâ¹¦ÄÜ¡£ -* service-name£º·þÎñÃû£¬Spring Cloud Gateway »á¸ù¾ÝËü»ñÈ¡µ½¾ßÌåµÄ΢·þÎñµØÖ·¡£ +* lb:uri çš„å��议,表示开å�¯ Spring Cloud Gateway 的负载å�‡è¡¡åŠŸèƒ½ã€‚ +* service-name:æœ�务å��,Spring Cloud Gateway 会根æ�®å®ƒèŽ·å�–到具体的微æœ�务地å�€ã€‚ -#### ʾÀý +#### 示例 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý£¬À´Õ¹Ê¾Ï Spring Cloud Gateway ÊÇÈçºÎʵÏÖ¶¯Ì¬Â·Óɵġ£ +下é�¢æˆ‘们就通过一个实例,æ�¥å±•示下 Spring Cloud Gateway 是如何实现动æ€�路由的。 -1\. ÐÞ¸Ä```micro-service-cloud-gateway-9527 ÖÐ application.yml µÄÅäÖã¬Ê¹ÓÃ×¢²áÖÐÐÄÖеÄ΢·þÎñÃû´´½¨¶¯Ì¬Â·ÓɽøÐÐת·¢£¬ÅäÖÃÈçÏ¡£ +1\. 修改```micro-service-cloud-gateway-9527 中 application.yml çš„é…�置,使用注册中心中的微æœ�务å��创建动æ€�路由进行转å�‘,é…�置如下。 @@ -294,27 +294,27 @@ public class MicroServiceCloudGateway9527Application { ``` server: - port: 9527 #¶Ë¿ÚºÅ + port: 9527 #端å�£å�· spring: application: - name: microServiceCloudGateway #·þÎñ×¢²áÖÐÐÄ×¢²áµÄ·þÎñÃû + name: microServiceCloudGateway #æœ�务注册中心注册的æœ�务å�� cloud: - gateway: #Íø¹ØÂ·ÓÉÅäÖà + gateway: #网关路由é…�ç½® discovery: locator: - enabled: true #ĬÈÏֵΪ true£¬¼´Ä¬ÈÏ¿ªÆô´Ó×¢²áÖÐÐĶ¯Ì¬´´½¨Â·ÓɵŦÄÜ£¬ÀûÓÃ΢·þÎñÃû½øÐзÓÉ + enabled: true #默认值为 true,å�³é»˜è®¤å¼€å�¯ä»Žæ³¨å†Œä¸­å¿ƒåЍæ€�创建路由的功能,利用微æœ�务å��进行路由 routes: - #½« micro-service-cloud-provider-dept-8001 ÌṩµÄ·þÎñÒþ²ØÆðÀ´£¬²»±©Â¶¸ø¿Í»§¶Ë£¬Ö»¸ø¿Í»§¶Ë±©Â¶ API Íø¹ØµÄµØÖ· 9527 - - id: provider_dept_list_routh #·ÓÉ id,ûÓй̶¨¹æÔò£¬µ«Î¨Ò»£¬½¨ÒéÓë·þÎñÃû¶ÔÓ¦ - uri: lb://MICROSERVICECLOUDPROVIDERDEPT #¶¯Ì¬Â·ÓÉ£¬Ê¹Ó÷þÎñÃû´úÌæÉÏÃæµÄ¾ßÌå´ø¶Ë¿Ú http://eureka7001.com:9527/dept/list + #å°† micro-service-cloud-provider-dept-8001 æ��供的æœ�务éš�è—�èµ·æ�¥ï¼Œä¸�暴露给客户端,å�ªç»™å®¢æˆ·ç«¯æš´éœ² API 网关的地å�€ 9527 + - id: provider_dept_list_routh #路由 id,没有固定规则,但唯一,建议与æœ�务å��对应 + uri: lb://MICROSERVICECLOUDPROVIDERDEPT #动æ€�路由,使用æœ�务å��代替上é�¢çš„具体带端å�£ http://eureka7001.com:9527/dept/list predicates: - #ÒÔÏÂÊǶÏÑÔÌõ¼þ£¬±ØÑ¡È«²¿·ûºÏÌõ¼þ - - Path=/dept/list/** #¶ÏÑÔ£¬Â·¾¶Æ¥Åä ×¢Ò⣺Path ÖÐ P Ϊ´óд - - Method=GET #Ö»ÄÜʱ GET ÇëÇóʱ£¬²ÅÄÜ·ÃÎÊ + #以下是断言æ�¡ä»¶ï¼Œå¿…选全部符å�ˆæ�¡ä»¶ + - Path=/dept/list/** #断言,路径匹é…� 注æ„�:Path 中 P 为大写 + - Method=GET #å�ªèƒ½æ—¶ GET 请求时,æ‰�能访问 eureka: instance: @@ -331,38 +331,38 @@ eureka: -2\. ÒÀ´ÎÆô¶¯ Eureka ·þÎñ×¢²áÖÐÐÄ£¨¼¯Èº£©¡¢·þÎñÌṩÕß¼¯Èº£¨micro-service-cloud-provider-dept-8001/8002/8003£©ÒÔ¼°```micro-service-cloud-gateway-9527¡£ +2\. ä¾�次å�¯åЍ Eureka æœ�务注册中心(集群)ã€�æœ�务æ��供者集群(micro-service-cloud-provider-dept-8001/8002/8003)以å�Š```micro-service-cloud-gateway-9527。 -3\. ÔÚä¯ÀÀÆ÷ÖзÃÎÊ¡°http://localhost:9527/dept/list¡±£¬½á¹ûÈçÏÂͼ¡£ +3\. 在æµ�览器中访问“http://localhost:9527/dept/listâ€�,结果如下图。 -![Gateway ¶¯Ì¬Â·ÓÉ](http://c.biancheng.net/uploads/allimg/211210/101P46240-4.gif) -ͼ5£ºSpring Cloud ʵÏÖ¶¯Ì¬Â·ÓÉ +![Gateway 动æ€�路由](http://c.biancheng.net/uploads/allimg/211210/101P46240-4.gif) +图5:Spring Cloud 实现动æ€�路由 -## Filter ¹ýÂËÆ÷ +## Filter 过滤器 -ͨ³£Çé¿öÏ£¬³öÓÚ°²È«·½ÃæµÄ¿¼ÂÇ£¬·þÎñ¶ËÌṩµÄ·þÎñÍùÍù¶¼»áÓÐÒ»¶¨µÄУÑéÂß¼­£¬ÀýÈçÓû§µÇ½״̬УÑ顢ǩÃûУÑéµÈ¡£ +通常情况下,出于安全方é�¢çš„考虑,æœ�务端æ��供的æœ�务往往都会有一定的校验逻辑,例如用户登陆状æ€�校验ã€�ç­¾å��校验等。 -ÔÚ΢·þÎñ¼Ü¹¹ÖУ¬ÏµÍ³Óɶà¸ö΢·þÎñ×é³É£¬ËùÓÐÕâЩ·þÎñ¶¼ÐèÒªÕâЩУÑéÂß¼­£¬´ËʱÎÒÃǾͿÉÒÔ½«ÕâЩУÑéÂß¼­Ð´µ½ Spring Cloud Gateway µÄ Filter ¹ýÂËÆ÷ÖС£ +在微æœ�务架构中,系统由多个微æœ�务组æˆ�,所有这些æœ�务都需è¦�这些校验逻辑,此时我们就å�¯ä»¥å°†è¿™äº›æ ¡éªŒé€»è¾‘写到 Spring Cloud Gateway çš„ Filter 过滤器中。 -#### Filter µÄ·ÖÀà +#### Filter 的分类 -Spring Cloud Gateway ÌṩÁËÒÔÏÂÁ½ÖÖÀàÐ͵ĹýÂËÆ÷£¬¿ÉÒÔ¶ÔÇëÇóºÍÏìÓ¦½øÐо«Ï¸»¯¿ØÖÆ¡£ +Spring Cloud Gateway æ��供了以下两ç§�类型的过滤器,å�¯ä»¥å¯¹è¯·æ±‚å’Œå“�应进行精细化控制。 -| ¹ýÂËÆ÷ÀàÐÍ | ˵Ã÷ | +| 过滤器类型 | 说明 | | --- | --- | -| Pre ÀàÐÍ | ÕâÖÖ¹ýÂËÆ÷ÔÚÇëÇó±»×ª·¢µ½Î¢·þÎñ֮ǰ¿ÉÒÔ¶ÔÇëÇó½øÐÐÀ¹½ØºÍÐ޸ģ¬ÀýÈç²ÎÊýУÑ顢ȨÏÞУÑé¡¢Á÷Á¿¼à¿Ø¡¢ÈÕÖ¾Êä³öÒÔ¼°Ð­Òéת»»µÈ²Ù×÷¡£ | -| Post ÀàÐÍ | ÕâÖÖ¹ýÂËÆ÷ÔÚ΢·þÎñ¶ÔÇëÇó×ö³öÏìÓ¦ºó¿ÉÒÔ¶ÔÏìÓ¦½øÐÐÀ¹½ØºÍÔÙ´¦Àí£¬ÀýÈçÐÞ¸ÄÏìÓ¦ÄÚÈÝ»òÏìӦͷ¡¢ÈÕÖ¾Êä³ö¡¢Á÷Á¿¼à¿ØµÈ¡£ | +| Pre 类型 | è¿™ç§�过滤器在请求被转å�‘到微æœ�务之å‰�å�¯ä»¥å¯¹è¯·æ±‚进行拦截和修改,例如å�‚数校验ã€�æ�ƒé™�校验ã€�æµ�é‡�监控ã€�日志输出以å�Šå��议转æ�¢ç­‰æ“�作。 | +| Post 类型 | è¿™ç§�过滤器在微æœ�务对请求å�šå‡ºå“�应å�Žå�¯ä»¥å¯¹å“�应进行拦截和å†�处ç�†ï¼Œä¾‹å¦‚修改å“�应内容或å“�应头ã€�日志输出ã€�æµ�é‡�监控等。 | -°´ÕÕ×÷Ó÷¶Î§»®·Ö£¬Spring Cloud gateway µÄ Filter ¿ÉÒÔ·ÖΪ 2 Àࣺ +按照作用范围划分,Spring Cloud gateway çš„ Filter å�¯ä»¥åˆ†ä¸º 2 类: -* GatewayFilter£ºÓ¦ÓÃÔÚµ¥¸ö·ÓÉ»òÕßÒ»×é·ÓÉÉϵĹýÂËÆ÷¡£ -* GlobalFilter£ºÓ¦ÓÃÔÚËùÓеÄ·ÓÉÉϵĹýÂËÆ÷¡£ +* GatewayFilter:应用在å�•个路由或者一组路由上的过滤器。 +* GlobalFilter:应用在所有的路由上的过滤器。 -#### GatewayFilter Íø¹Ø¹ýÂËÆ÷ +#### GatewayFilter 网关过滤器 -GatewayFilter ÊÇ Spring Cloud Gateway Íø¹ØÖÐÌṩµÄÒ»ÖÖÓ¦ÓÃÔÚµ¥¸ö»òÒ»×é·ÓÉÉϵĹýÂËÆ÷¡£Ëü¿ÉÒÔ¶Ôµ¥¸ö·ÓÉ»òÕßÒ»×é·ÓÉÉÏ´«ÈëµÄÇëÇóºÍ´«³öÏìÓ¦½øÐÐÀ¹½Ø£¬²¢ÊµÏÖһЩÓëÒµÎñÎ޹صŦÄÜ£¬±ÈÈçµÇ½״̬УÑ顢ǩÃûУÑ顢ȨÏÞУÑé¡¢ÈÕÖ¾Êä³ö¡¢Á÷Á¿¼à¿ØµÈ¡£ +GatewayFilter 是 Spring Cloud Gateway 网关中æ��供的一ç§�应用在å�•个或一组路由上的过滤器。它å�¯ä»¥å¯¹å�•个路由或者一组路由上传入的请求和传出å“�应进行拦截,并实现一些与业务无关的功能,比如登陆状æ€�校验ã€�ç­¾å��校验ã€�æ�ƒé™�校验ã€�日志输出ã€�æµ�é‡�监控等。 -GatewayFilter ÔÚÅäÖÃÎļþ£¨ÀýÈç application.yml£©ÖеÄд·¨Óë Predicate ÀàËÆ£¬¸ñʽÈçÏ¡£ +GatewayFilter 在é…�置文件(例如 application.yml)中的写法与 Predicate 类似,格å¼�如下。 @@ -379,34 +379,34 @@ spring: predicates: - Path=xxxx filters: - - AddRequestParameter=X-Request-Id,1024 #¹ýÂËÆ÷¹¤³§»áÔÚÆ¥ÅäµÄÇëÇóÍ·¼ÓÉÏÒ»¶ÔÇëÇóÍ·£¬Ãû³ÆÎª X-Request-Id ֵΪ 1024 - - PrefixPath=/dept #ÔÚÇëÇó·¾¶Ç°Ãæ¼ÓÉÏ /dept - ¡­¡­ + - AddRequestParameter=X-Request-Id,1024 #过滤器工厂会在匹é…�的请求头加上一对请求头,å��称为 X-Request-Id 值为 1024 + - PrefixPath=/dept #在请求路径å‰�é�¢åŠ ä¸Š /dept + …… ``` -Spring Cloud Gateway ÄÚÖÃÁ˶à´ï 31 ÖÖ GatewayFilter£¬Ï±íÖÐÁоÙÁ˼¸ÖÖ³£ÓõÄÍø¹Ø¹ýÂËÆ÷¼°ÆäʹÓÃʾÀý¡£ +Spring Cloud Gateway 内置了多达 31 ç§� GatewayFilter,下表中列举了几ç§�常用的网关过滤器å�Šå…¶ä½¿ç”¨ç¤ºä¾‹ã€‚ -| ·ÓɹýÂËÆ÷ | ÃèÊö | ²ÎÊý | ʹÓÃʾÀý | +| 路由过滤器 | æ��è¿° | å�‚æ•° | 使用示例 | | --- | --- | --- | --- | -| AddRequestHeader | ```À¹½Ø´«ÈëµÄÇëÇ󣬲¢ÔÚÇëÇóÉÏÌí¼ÓÒ»¸öÖ¸¶¨µÄÇëÇóÍ·²ÎÊý¡£ | name£ºÐèÒªÌí¼ÓµÄÇëÇóÍ·²ÎÊýµÄ key£»value£ºÐèÒªÌí¼ÓµÄÇëÇóÍ·²ÎÊýµÄ value¡£ | - AddRequestHeader=my-request-header,1024 | -| AddRequestParameter | À¹½Ø´«ÈëµÄÇëÇ󣬲¢ÔÚÇëÇóÉÏÌí¼ÓÒ»¸öÖ¸¶¨µÄÇëÇó²ÎÊý¡£ | name£ºÐèÒªÌí¼ÓµÄÇëÇó²ÎÊýµÄ key£»value£ºÐèÒªÌí¼ÓµÄÇëÇó²ÎÊýµÄ value¡£ | - AddRequestParameter=my-request-param,c.biancheng.net | -| AddResponseHeader | À¹½ØÏìÓ¦£¬²¢ÔÚÏìÓ¦ÉÏÌí¼ÓÒ»¸öÖ¸¶¨µÄÏìӦͷ²ÎÊý¡£ | name£ºÐèÒªÌí¼ÓµÄÏìӦͷµÄ key£»value£ºÐèÒªÌí¼ÓµÄÏìӦͷµÄ value¡£ | - AddResponseHeader=my-response-header,c.biancheng.net | -| PrefixPath | À¹½Ø´«ÈëµÄÇëÇ󣬲¢ÔÚÇëÇó·¾¶Ôö¼ÓÒ»¸öÖ¸¶¨µÄǰ׺¡£ | ```prefix£ºÐèÒªÔö¼ÓµÄ·¾¶Ç°×º¡£ | - PrefixPath=/consumer | -| PreserveHostHeader | ת·¢ÇëÇóʱ£¬±£³Ö¿Í»§¶ËµÄ Host ÐÅÏ¢²»±ä£¬È»ºó½«Ëü´«µÝµ½Ìṩ¾ßÌå·þÎñµÄ΢·þÎñÖС£ | ÎÞ | - PreserveHostHeader | -| RemoveRequestHeader | ÒÆ³ýÇëÇóÍ·ÖÐÖ¸¶¨µÄ²ÎÊý¡£ | name£ºÐèÒªÒÆ³ýµÄÇëÇóÍ·µÄ key¡£ | - RemoveRequestHeader=my-request-header | -| RemoveResponseHeader | ÒÆ³ýÏìӦͷÖÐÖ¸¶¨µÄ²ÎÊý¡£ | name£ºÐèÒªÒÆ³ýµÄÏìӦͷ¡£ | - RemoveResponseHeader=my-response-header | -| RemoveRequestParameter | ÒÆ³ýÖ¸¶¨µÄÇëÇó²ÎÊý¡£ | name£ºÐèÒªÒÆ³ýµÄÇëÇó²ÎÊý¡£ | - RemoveRequestParameter=my-request-param | -| RequestSize | ÅäÖÃÇëÇóÌåµÄ´óС£¬µ±ÇëÇóÌå¹ý´óʱ£¬½«»á·µ»Ø 413 Payload Too Large¡£ | maxSize£ºÇëÇóÌåµÄ´óС¡£ | - name: RequestSize`````````args:```````````````maxSize: 5000000 | +| AddRequestHeader | ```拦截传入的请求,并在请求上添加一个指定的请求头å�‚数。 | name:需è¦�添加的请求头å�‚æ•°çš„ keyï¼›value:需è¦�添加的请求头å�‚æ•°çš„ value。 | - AddRequestHeader=my-request-header,1024 | +| AddRequestParameter | 拦截传入的请求,并在请求上添加一个指定的请求å�‚数。 | name:需è¦�添加的请求å�‚æ•°çš„ keyï¼›value:需è¦�添加的请求å�‚æ•°çš„ value。 | - AddRequestParameter=my-request-param,c.biancheng.net | +| AddResponseHeader | 拦截å“�应,并在å“�应上添加一个指定的å“�应头å�‚数。 | name:需è¦�添加的å“�应头的 keyï¼›value:需è¦�添加的å“�应头的 value。 | - AddResponseHeader=my-response-header,c.biancheng.net | +| PrefixPath | 拦截传入的请求,并在请求路径增加一个指定的å‰�缀。 | ```prefix:需è¦�增加的路径å‰�缀。 | - PrefixPath=/consumer | +| PreserveHostHeader | 转å�‘请求时,ä¿�æŒ�客户端的 Host ä¿¡æ�¯ä¸�å�˜ï¼Œç„¶å�Žå°†å®ƒä¼ é€’到æ��供具体æœ�务的微æœ�务中。 | æ—  | - PreserveHostHeader | +| RemoveRequestHeader | 移除请求头中指定的å�‚数。 | name:需è¦�移除的请求头的 key。 | - RemoveRequestHeader=my-request-header | +| RemoveResponseHeader | 移除å“�应头中指定的å�‚数。 | name:需è¦�移除的å“�应头。 | - RemoveResponseHeader=my-response-header | +| RemoveRequestParameter | 移除指定的请求å�‚数。 | name:需è¦�移除的请求å�‚数。 | - RemoveRequestParameter=my-request-param | +| RequestSize | é…�置请求体的大å°�,当请求体过大时,将会返回 413 Payload Too Large。 | maxSize:请求体的大å°�。 | - name: RequestSize`````````args:```````````````maxSize: 5000000 | -#### ʾÀý +#### 示例 -ÏÂÃæÎÒÃÇͨ¹ýÒ»¸öʵÀýÀ´ÑÝʾ GatewayFilter µÄÅäÖ㬲½ÖèÈçÏ¡£ +下é�¢æˆ‘们通过一个实例æ�¥æ¼”示 GatewayFilter çš„é…�置,步骤如下。 -1\. ÔÚ```micro-service-cloud-gateway-9527 µÄ application.yml ÖÐÔÚÌí¼ÓÒ»¸ö¶¯Ì¬Â·ÓÉ£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +1\. 在```micro-service-cloud-gateway-9527 çš„ application.yml 中在添加一个动æ€�路由,é…�置内容如下。 @@ -422,9 +422,9 @@ spring: predicates: - Path=xxxx filters: - - AddRequestParameter=X-Request-Id,1024 #¹ýÂËÆ÷¹¤³§»áÔÚÆ¥ÅäµÄÇëÇóÍ·¼ÓÉÏÒ»¶ÔÇëÇóÍ·£¬Ãû³ÆÎª X-Request-Id ֵΪ 1024 - - PrefixPath=/dept #ÔÚÇëÇó·¾¶Ç°Ãæ¼ÓÉÏ /dept - ¡­¡­ + - AddRequestParameter=X-Request-Id,1024 #过滤器工厂会在匹é…�的请求头加上一对请求头,å��称为 X-Request-Id 值为 1024 + - PrefixPath=/dept #在请求路径å‰�é�¢åŠ ä¸Š /dept + …… ``` @@ -432,22 +432,22 @@ spring: -2\. ÖØÆô```micro-service-cloud-gateway-9527£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:9527/get/1¡±£¬½á¹ûÈçÏÂͼ¡£ +2\. é‡�å�¯```micro-service-cloud-gateway-9527,使用æµ�览器访问“http://eureka7001.com:9527/get/1â€�,结果如下图。 -![Gateway ·ÓɹýÂËÆ÷](http://c.biancheng.net/uploads/allimg/211210/101P4J58-5.png) -ͼ6£ºÂ·ÓɹýÂËÆ÷ʾÀý +![Gateway 路由过滤器](http://c.biancheng.net/uploads/allimg/211210/101P4J58-5.png) +图6:路由过滤器示例 -#### GlobalFilter È«¾Ö¹ýÂËÆ÷ +#### GlobalFilter 全局过滤器 -GlobalFilter ÊÇÒ»ÖÖ×÷ÓÃÓÚËùÓеÄ·ÓÉÉϵÄÈ«¾Ö¹ýÂËÆ÷£¬Í¨¹ýËü£¬ÎÒÃÇ¿ÉÒÔʵÏÖһЩͳһ»¯µÄÒµÎñ¹¦ÄÜ£¬ÀýÈçȨÏÞÈÏÖ¤¡¢IP ·ÃÎÊÏÞÖÆµÈ¡£µ±Ä³¸öÇëÇó±»Â·ÓÉÆ¥Åäʱ£¬ÄÇôËùÓÐµÄ GlobalFilter »áºÍ¸Ã·ÓÉ×ÔÉíÅäÖÃµÄ GatewayFilter ×éºÏ³ÉÒ»¸ö¹ýÂËÆ÷Á´¡£ +GlobalFilter 是一ç§�作用于所有的路由上的全局过滤器,通过它,我们å�¯ä»¥å®žçŽ°ä¸€äº›ç»Ÿä¸€åŒ–çš„ä¸šåŠ¡åŠŸèƒ½ï¼Œä¾‹å¦‚æ�ƒé™�认è¯�ã€�IP 访问é™�制等。当æŸ�个请求被路由匹é…�时,那么所有的 GlobalFilter 会和该路由自身é…�置的 GatewayFilter 组å�ˆæˆ�一个过滤器链。 -Spring Cloud Gateway ΪÎÒÃÇÌṩÁ˶àÖÖĬÈ쵀 GlobalFilter£¬ÀýÈçÓëת·¢¡¢Â·ÓÉ¡¢¸ºÔؾùºâµÈÏà¹ØµÄÈ«¾Ö¹ýÂËÆ÷¡£µ«ÔÚʵ¼ÊµÄÏîÄ¿¿ª·¢ÖУ¬Í¨³£ÎÒÃǶ¼»á×Ô¶¨ÒåһЩ×Ô¼ºµÄ GlobalFilter È«¾Ö¹ýÂËÆ÷ÒÔÂú×ãÎÒÃÇ×ÔÉíµÄÒµÎñÐèÇ󣬶øºÜÉÙÖ±½ÓʹÓà Spring Cloud``` Config ÌṩÕâЩĬÈ쵀 GlobalFilter¡£ +Spring Cloud Gateway 为我们æ��供了多ç§�默认的 GlobalFilter,例如与转å�‘ã€�路由ã€�è´Ÿè½½å�‡è¡¡ç­‰ç›¸å…³çš„全局过滤器。但在实际的项目开å�‘中,通常我们都会自定义一些自己的 GlobalFilter 全局过滤器以满足我们自身的业务需求,而很少直接使用 Spring Cloud``` Config æ��供这些默认的 GlobalFilter。 -> ¹ØÓÚĬÈϵÄÈ«¾Ö¹ýÂËÆ÷µÄÏêϸÄÚÈÝ£¬Çë²Î¿¼```[Spring Cloud ¹ÙÍø](https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters)¡£ +> 关于默认的全局过滤器的详细内容,请å�‚考```[Spring Cloud 官网](https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters)。 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀýÀ´ÑÝʾÏ£¬ÈçºÎ×Ô¶¨Òå GlobalFilter È«¾Ö¹ýÂËÆ÷¡£ +下é�¢æˆ‘们就通过一个实例æ�¥æ¼”示下,如何自定义 GlobalFilter 全局过滤器。 -1\. ÔÚ```net.biancheng.c.filter °üÏ£¬Ð½¨Ò»¸öÃûΪ```MyGlobalFilter È«¾Ö¹ýÂËÆ÷ÅäÖÃÀ࣬´úÂëÈçÏ¡£ +1\. 在```net.biancheng.c.filter 包下,新建一个å��为```MyGlobalFilter 全局过滤器é…�置类,代ç �如下。 @@ -455,27 +455,27 @@ Spring Cloud Gateway Ϊ ``` server: - port: 9527 #¶Ë¿ÚºÅ + port: 9527 #端å�£å�· spring: application: - name: microServiceCloudGateway #·þÎñ×¢²áÖÐÐÄ×¢²áµÄ·þÎñÃû + name: microServiceCloudGateway #æœ�务注册中心注册的æœ�务å�� cloud: - gateway: #Íø¹ØÂ·ÓÉÅäÖà + gateway: #网关路由é…�ç½® discovery: locator: - enabled: true #ĬÈÏֵΪ true£¬¼´Ä¬ÈÏ¿ªÆô´Ó×¢²áÖÐÐĶ¯Ì¬´´½¨Â·ÓɵŦÄÜ£¬ÀûÓÃ΢·þÎñÃû½øÐзÓÉ + enabled: true #默认值为 true,å�³é»˜è®¤å¼€å�¯ä»Žæ³¨å†Œä¸­å¿ƒåЍæ€�创建路由的功能,利用微æœ�务å��进行路由 routes: - #½« micro-service-cloud-provider-dept-8001 ÌṩµÄ·þÎñÒþ²ØÆðÀ´£¬²»±©Â¶¸ø¿Í»§¶Ë£¬Ö»¸ø¿Í»§¶Ë±©Â¶ API Íø¹ØµÄµØÖ· 9527 - - id: provider_dept_list_routh #·ÓÉ id,ûÓй̶¨¹æÔò£¬µ«Î¨Ò»£¬½¨ÒéÓë·þÎñÃû¶ÔÓ¦ - uri: lb://MICROSERVICECLOUDPROVIDERDEPT #¶¯Ì¬Â·ÓÉ£¬Ê¹Ó÷þÎñÃû´úÌæÉÏÃæµÄ¾ßÌå´ø¶Ë¿Ú http://eureka7001.com:9527/dept/list + #å°† micro-service-cloud-provider-dept-8001 æ��供的æœ�务éš�è—�èµ·æ�¥ï¼Œä¸�暴露给客户端,å�ªç»™å®¢æˆ·ç«¯æš´éœ² API 网关的地å�€ 9527 + - id: provider_dept_list_routh #路由 id,没有固定规则,但唯一,建议与æœ�务å��对应 + uri: lb://MICROSERVICECLOUDPROVIDERDEPT #动æ€�路由,使用æœ�务å��代替上é�¢çš„具体带端å�£ http://eureka7001.com:9527/dept/list predicates: - #ÒÔÏÂÊǶÏÑÔÌõ¼þ£¬±ØÑ¡È«²¿·ûºÏÌõ¼þ - - Path=/dept/list/** #¶ÏÑÔ£¬Â·¾¶Æ¥Åä ×¢Ò⣺Path ÖÐ P Ϊ´óд - - Method=GET #Ö»ÄÜʱ GET ÇëÇóʱ£¬²ÅÄÜ·ÃÎÊ + #以下是断言æ�¡ä»¶ï¼Œå¿…选全部符å�ˆæ�¡ä»¶ + - Path=/dept/list/** #断言,路径匹é…� 注æ„�:Path 中 P 为大写 + - Method=GET #å�ªèƒ½æ—¶ GET 请求时,æ‰�能访问 eureka: instance: @@ -493,18 +493,18 @@ eureka: -2\. ÖØÆô```micro-service-cloud-gateway-9527£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:9527/dept/list¡±£¬ÎÒÃǻᷢÏÖ·ÃÎʱ¨ 406 ´íÎ󣬿ØÖÆÌ¨Êä³öÈçÏ¡£ +2\. é‡�å�¯```micro-service-cloud-gateway-9527,使用æµ�览器访问“http://eureka7001.com:9527/dept/listâ€�,我们会å�‘现访问报 406 错误,控制å�°è¾“出如下。 -```2021-10-21 16:25:39.450 INFO 19116 --- [ctor-http-nio-4] net.biancheng.c.filter.MyGlobalFilter : Thu Oct 21 16:25:39 CST 2021½øÈë×Ô¶¨ÒåµÄÈ«¾Ö¹ýÂËÆ÷ MyGlobalFilter -2021-10-21 16:25:39.451 INFO 19116 --- [ctor-http-nio-4] net.biancheng.c.filter.MyGlobalFilter : ²ÎÊý uname ²»ÄÜΪ null£¡ +```2021-10-21 16:25:39.450 INFO 19116 --- [ctor-http-nio-4] net.biancheng.c.filter.MyGlobalFilter : Thu Oct 21 16:25:39 CST 2021进入自定义的全局过滤器 MyGlobalFilter +2021-10-21 16:25:39.451 INFO 19116 --- [ctor-http-nio-4] net.biancheng.c.filter.MyGlobalFilter : å�‚æ•° uname ä¸�能为 nullï¼� ``` -3\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:9527/dept/list?uname=123¡±,½á¹ûÈçÏÂͼ¡£ +3\. 使用æµ�览器访问“http://eureka7001.com:9527/dept/list?uname=123â€�,结果如下图。 -![×Ô¶¨ÒåÈ«¾ÖÍø¹Ø¹ýÂËÆ÷](http://c.biancheng.net/uploads/allimg/211210/101P43096-6.png) -ͼ7£º×Ô¶¨ÒåÈ«¾ÖÍø¹Ø¹ýÂËÆ÷ +![自定义全局网关过滤器](http://c.biancheng.net/uploads/allimg/211210/101P43096-6.png) +图7:自定义全局网关过滤器 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudHystrix.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudHystrix.md" index 1a26d68..e222a42 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudHystrix.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudHystrix.md" @@ -1,70 +1,70 @@ -ÔÚ΢·þÎñ¼Ü¹¹ÖУ¬Ò»¸öÓ¦ÓÃÍùÍùÓɶà¸ö·þÎñ×é³É£¬ÕâЩ·þÎñÖ®¼äÏ໥ÒÀÀµ£¬ÒÀÀµ¹ØÏµ´í×Û¸´ÔÓ¡£ +在微æœ�务架构中,一个应用往往由多个æœ�务组æˆ�,这些æœ�务之间相互ä¾�赖,ä¾�赖关系错综å¤�æ�‚。 -ÀýÈçÒ»¸ö΢·þÎñϵͳÖдæÔÚ A¡¢B¡¢C¡¢D¡¢E¡¢F µÈ¶à¸ö·þÎñ£¬ËüÃǵÄÒÀÀµ¹ØÏµÈçÏÂͼ¡£ +例如一个微æœ�务系统中存在 Aã€�Bã€�Cã€�Dã€�Eã€�F 等多个æœ�务,它们的ä¾�赖关系如下图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623H11-0.png) -ͼ1£º·þÎñÒÀÀµ¹ØÏµ +图1:æœ�务ä¾�赖关系 -ͨ³£Çé¿öÏ£¬Ò»¸öÓû§ÇëÇóÍùÍùÐèÒª¶à¸ö·þÎñÅäºÏ²ÅÄÜÍê³É¡£Èçͼ 1 Ëùʾ£¬ÔÚËùÓзþÎñ¶¼´¦ÓÚ¿ÉÓÃ״̬ʱ£¬ÇëÇó 1 ÐèÒªµ÷Óà A¡¢D¡¢E¡¢F Ëĸö·þÎñ²ÅÄÜÍê³É£¬ÇëÇó 2 ÐèÒªµ÷Óà B¡¢E¡¢D Èý¸ö·þÎñ²ÅÄÜÍê³É£¬ÇëÇó 3 ÐèÒªµ÷Ó÷þÎñ C¡¢F¡¢E¡¢D Ëĸö·þÎñ²ÅÄÜÍê³É¡£ +通常情况下,一个用户请求往往需è¦�多个æœ�务é…�å�ˆæ‰�能完æˆ�。如图 1 所示,在所有æœ�务都处于å�¯ç”¨çжæ€�时,请求 1 需è¦�调用 Aã€�Dã€�Eã€�F 四个æœ�务æ‰�能完æˆ�,请求 2 需è¦�调用 Bã€�Eã€�D 三个æœ�务æ‰�能完æˆ�,请求 3 需è¦�调用æœ�务 Cã€�Fã€�Eã€�D 四个æœ�务æ‰�能完æˆ�。 -µ±·þÎñ E ·¢Éú¹ÊÕÏ»òÍøÂçÑÓ³Ùʱ£¬»á³öÏÖÒÔÏÂÇé¿ö£º +当æœ�务 E å�‘生故障或网络延迟时,会出现以下情况: -1. ¼´Ê¹ÆäËûËùÓзþÎñ¶¼¿ÉÓã¬ÓÉÓÚ·þÎñ E µÄ²»¿ÉÓã¬ÄÇôÓû§ÇëÇó 1¡¢2¡¢3 ¶¼»á´¦ÓÚ×èÈû״̬£¬µÈ´ý·þÎñ E µÄÏìÓ¦¡£Ôڸ߲¢·¢µÄ³¡¾°Ï£¬»áµ¼ÖÂÕû¸ö·þÎñÆ÷µÄÏß³Ì×ÊÔ´ÔÚ¶Ìʱ¼äÄÚѸËÙÏûºÄ´ù¾¡¡£ -2. ËùÓÐÒÀÀµÓÚ·þÎñ E µÄÆäËû·þÎñ£¬ÀýÈç·þÎñ B¡¢D ÒÔ¼° F Ò²¶¼»á´¦ÓÚÏß³Ì×èÈû״̬£¬µÈ´ý·þÎñ E µÄÏìÓ¦£¬µ¼ÖÂÕâЩ·þÎñµÄ²»¿ÉÓᣠ-3. ËùÓÐÒÀÀµ·þÎñB¡¢D ºÍ F µÄ·þÎñ£¬ÀýÈç·þÎñ A ºÍ·þÎñ C Ò²»á´¦ÓÚÏß³Ì×èÈû״̬£¬ÒԵȴý·þÎñ D ºÍ·þÎñ F µÄÏìÓ¦£¬µ¼Ö·þÎñ A ºÍ·þÎñ C Ò²²»¿ÉÓᣠ+1. å�³ä½¿å…¶ä»–所有æœ�务都å�¯ç”¨ï¼Œç”±äºŽæœ�务 E çš„ä¸�å�¯ç”¨ï¼Œé‚£ä¹ˆç”¨æˆ·è¯·æ±‚ 1ã€�2ã€�3 都会处于阻塞状æ€�,等待æœ�务 E çš„å“�应。在高并å�‘的场景下,会导致整个æœ�务器的线程资æº�在短时间内迅速消耗殆尽。 +2. 所有ä¾�赖于æœ�务 E 的其他æœ�务,例如æœ�务 Bã€�D 以å�Š F 也都会处于线程阻塞状æ€�,等待æœ�务 E çš„å“�应,导致这些æœ�务的ä¸�å�¯ç”¨ã€‚ +3. 所有ä¾�èµ–æœ�务Bã€�D å’Œ F çš„æœ�务,例如æœ�务 A å’Œæœ�务 C 也会处于线程阻塞状æ€�,以等待æœ�务 D å’Œæœ�务 F çš„å“�应,导致æœ�务 A å’Œæœ�务 C 也ä¸�å�¯ç”¨ã€‚ -´ÓÒÔÉϹý³Ì¿ÉÒÔ¿´³ö£¬µ±Î¢·þÎñϵͳµÄÒ»¸ö·þÎñ³öÏÖ¹ÊÕÏʱ£¬¹ÊÕÏ»áÑØ×Å·þÎñµÄµ÷ÓÃÁ´Â·ÔÚϵͳÖзè¿ñÂûÑÓ£¬×îÖÕµ¼ÖÂÕû¸ö΢·þÎñϵͳµÄ̱»¾£¬Õâ¾ÍÊÇ¡°Ñ©±ÀЧӦ¡±¡£ÎªÁË·ÀÖ¹´ËÀàʼþµÄ·¢Éú£¬Î¢·þÎñ¼Ü¹¹ÒýÈëÁË¡°ÈÛ¶ÏÆ÷¡±µÄһϵÁзþÎñÈÝ´íºÍ±£»¤»úÖÆ¡£ +从以上过程å�¯ä»¥çœ‹å‡ºï¼Œå½“å¾®æœ�务系统的一个æœ�务出现故障时,故障会沿ç�€æœ�务的调用链路在系统中疯狂蔓延,最终导致整个微æœ�务系统的瘫痪,这就是“雪崩效应â€�。为了防止此类事件的å�‘生,微æœ�务架构引入了“熔断器â€�的一系列æœ�务容错和ä¿�护机制。 -## ÈÛ¶ÏÆ÷ +## 熔断器 -ÈÛ¶ÏÆ÷£¨Circuit Breaker£©Ò»´ÊÀ´Ô´ÎïÀíѧÖеĵç·֪ʶ£¬ËüµÄ×÷ÓÃÊǵ±Ïß·³öÏÖ¹ÊÕÏʱ£¬Ñ¸ËÙÇжϵçÔ´ÒÔ±£»¤µç·µÄ°²È«¡£ +熔断器(Circuit Breaker)一è¯�æ�¥æº�物ç�†å­¦ä¸­çš„电路知识,它的作用是当线路出现故障时,迅速切断电æº�以ä¿�护电路的安全。 -ÔÚ΢·þÎñÁìÓò£¬ÈÛ¶ÏÆ÷×îÔçÊÇÓÉ Martin Fowler ÔÚËû·¢±íµÄ ¡¶[Circuit Breake](https://martinfowler.com/bliki/CircuitBreaker.html)r¡·Ò»ÎÄÖÐÌá³ö¡£ÓëÎïÀíѧÖеÄÈÛ¶ÏÆ÷×÷ÓÃÏàËÆ£¬Î¢·þÎñ¼Ü¹¹ÖеÄÈÛ¶ÏÆ÷Äܹ»ÔÚij¸ö·þÎñ·¢Éú¹ÊÕϺó£¬Ïò·þÎñµ÷Ó÷½·µ»ØÒ»¸ö·ûºÏÔ¤ÆÚµÄ¡¢¿É´¦ÀíµÄ½µ¼¶ÏìÓ¦£¨FallBack£©£¬¶ø²»Êdz¤Ê±¼äµÄµÈ´ý»òÕßÅ׳öµ÷Ó÷½ÎÞ·¨´¦ÀíµÄÒì³£¡£ÕâÑù¾Í±£Ö¤ÁË·þÎñµ÷Ó÷½µÄÏ̲߳»»á±»³¤Ê±¼ä¡¢²»±ØÒªµØÕ¼Ó㬱ÜÃâ¹ÊÕÏÔÚ΢·þÎñϵͳÖеÄÂûÑÓ£¬·Àֹϵͳѩ±ÀЧӦµÄ·¢Éú¡£ +在微æœ�务领域,熔断器最早是由 Martin Fowler 在他å�‘表的 《[Circuit Breake](https://martinfowler.com/bliki/CircuitBreaker.html)r》一文中æ��出。与物ç�†å­¦ä¸­çš„熔断器作用相似,微æœ�务架构中的熔断器能够在æŸ�个æœ�务å�‘生故障å�Žï¼Œå�‘æœ�务调用方返回一个符å�ˆé¢„期的ã€�å�¯å¤„ç�†çš„é™�级å“�应(FallBack),而ä¸�是长时间的等待或者抛出调用方无法处ç�†çš„异常。这样就ä¿�è¯�了æœ�务调用方的线程ä¸�会被长时间ã€�ä¸�å¿…è¦�地å� ç”¨ï¼Œé�¿å…�故障在微æœ�务系统中的蔓延,防止系统雪崩效应的å�‘生。 ## Spring Cloud Hystrix -Spring Cloud Hystrix ÊÇÒ»¿îÓÅÐãµÄ·þÎñÈÝ´íÓë±£»¤×é¼þ£¬Ò²ÊÇ Spring Cloud ÖÐ×îÖØÒªµÄ×é¼þÖ®Ò»¡£ +Spring Cloud Hystrix 是一款优秀的æœ�务容错与ä¿�护组件,也是 Spring Cloud 中最é‡�è¦�的组件之一。 -Spring Cloud Hystrix ÊÇ»ùÓÚ Netflix ¹«Ë¾µÄ¿ªÔ´×é¼þ Hystrix ʵÏֵģ¬ËüÌṩÁËÈÛ¶ÏÆ÷¹¦ÄÜ£¬Äܹ»ÓÐЧµØ×èÖ¹·Ö²¼Ê½Î¢·þÎñϵͳÖгöÏÖÁª¶¯¹ÊÕÏ£¬ÒÔÌá¸ß΢·þÎñϵͳµÄµ¯ÐÔ¡£Spring Cloud Hystrix ¾ßÓзþÎñ½µ¼¶¡¢·þÎñÈÛ¶Ï¡¢Ï̸߳ôÀë¡¢ÇëÇ󻺴桢ÇëÇóºÏ²¢ÒÔ¼°ÊµÊ±¹ÊÕÏ¼à¿ØµÈÇ¿´ó¹¦ÄÜ¡£ +Spring Cloud Hystrix 是基于 Netflix å…¬å�¸çš„å¼€æº�组件 Hystrix 实现的,它æ��供了熔断器功能,能够有效地阻止分布å¼�å¾®æœ�务系统中出现è�”动故障,以æ��高微æœ�务系统的弹性。Spring Cloud Hystrix 具有æœ�务é™�级ã€�æœ�务熔断ã€�线程隔离ã€�请求缓存ã€�请求å�ˆå¹¶ä»¥å�Šå®žæ—¶æ•…障监控等强大功能。 -> Hystrix [h?st'r?ks]£¬ÖÐÎĺ¬ÒåÊǺÀÖí£¬ºÀÖíµÄ±³Éϳ¤ÂúÁ˼¬´Ì£¬Ê¹ËüÓµÓÐÁËÇ¿´óµÄ×ÔÎÒ±£»¤ÄÜÁ¦¡£¶ø Spring Cloud Hystrix ×÷Ϊһ¸ö·þÎñÈÝ´íÓë±£»¤×é¼þ£¬Ò²¿ÉÒÔÈ÷þÎñÓµÓÐ×ÔÎÒ±£»¤µÄÄÜÁ¦£¬Òò´ËÒ²ÓÐÈ˽«ÆäÏ·³ÆÎª¡°ºÀÖí¸ç¡±¡£ +> Hystrix [h?st'r?ks],中文å�«ä¹‰æ˜¯è±ªçŒªï¼Œè±ªçŒªçš„背上长满了棘刺,使它拥有了强大的自我ä¿�护能力。而 Spring Cloud Hystrix 作为一个æœ�务容错与ä¿�护组件,也å�¯ä»¥è®©æœ�务拥有自我ä¿�护的能力,因此也有人将其æˆ�称为“豪猪哥â€�。 -ÔÚ΢·þÎñϵͳÖУ¬Hystrix Äܹ»°ïÖúÎÒÃÇʵÏÖÒÔÏÂÄ¿±ê£º +在微æœ�务系统中,Hystrix 能够帮助我们实现以下目标: -* **±£»¤Ïß³Ì×ÊÔ´**£º·ÀÖ¹µ¥¸ö·þÎñµÄ¹ÊÕϺľ¡ÏµÍ³ÖеÄËùÓÐÏß³Ì×ÊÔ´¡£ -* **¿ìËÙʧ°Ü»úÖÆ**£ºµ±Ä³¸ö·þÎñ·¢ÉúÁ˹ÊÕÏ£¬²»È÷þÎñµ÷Ó÷½Ò»Ö±µÈ´ý£¬¶øÊÇÖ±½Ó·µ»ØÇëÇóʧ°Ü¡£ -* **Ìṩ½µ¼¶£¨FallBack£©·½°¸**£ºÔÚÇëÇóʧ°Üºó£¬Ìṩһ¸öÉè¼ÆºÃµÄ½µ¼¶·½°¸£¬Í¨³£ÊÇÒ»¸ö¶µµ×·½·¨£¬µ±ÇëÇóʧ°Üºó¼´µ÷Óø÷½·¨¡£ -* **·ÀÖ¹¹ÊÕÏÀ©É¢**£ºÊ¹ÓÃÈÛ¶Ï»úÖÆ£¬·ÀÖ¹¹ÊÕÏÀ©É¢µ½ÆäËû·þÎñ¡£ -* **¼à¿Ø¹¦ÄÜ**£ºÌṩÈÛ¶ÏÆ÷¹ÊÕÏ¼à¿Ø×é¼þ Hystrix Dashboard£¬ËæÊ±¼à¿ØÈÛ¶ÏÆ÷µÄ״̬¡£ +* **ä¿�护线程资æº�**:防止å�•个æœ�务的故障耗尽系统中的所有线程资æº�。 +* **快速失败机制**:当æŸ�个æœ�务å�‘生了故障,ä¸�让æœ�务调用方一直等待,而是直接返回请求失败。 +* **æ��ä¾›é™�级(FallBack)方案**:在请求失败å�Žï¼Œæ��供一个设计好的é™�级方案,通常是一个兜底方法,当请求失败å�Žå�³è°ƒç”¨è¯¥æ–¹æ³•。 +* **防止故障扩散**:使用熔断机制,防止故障扩散到其他æœ�务。 +* **监控功能**:æ��供熔断器故障监控组件 Hystrix Dashboard,éš�时监控熔断器的状æ€�。 -## Hystrix ·þÎñ½µ¼¶ +## Hystrix æœ�务é™�级 -Hystrix ÌṩÁË·þÎñ½µ¼¶¹¦ÄÜ£¬Äܹ»±£Ö¤µ±Ç°·þÎñ²»ÊÜÆäËû·þÎñ¹ÊÕϵÄÓ°Ï죬Ìá¸ß·þÎñµÄ½¡×³ÐÔ¡£ +Hystrix æ��供了æœ�务é™�级功能,能够ä¿�è¯�当å‰�æœ�务ä¸�å�—å…¶ä»–æœ�务故障的影å“�,æ��高æœ�务的å�¥å£®æ€§ã€‚ -·þÎñ½µ¼¶µÄʹÓó¡¾°ÓÐÒÔÏ 2 ÖÖ£º +æœ�务é™�级的使用场景有以下 2 ç§�: -* ÔÚ·þÎñÆ÷ѹÁ¦¾çÔöʱ£¬¸ù¾Ýʵ¼ÊÒµÎñÇé¿ö¼°Á÷Á¿£¬¶ÔһЩ²»ÖØÒª¡¢²»½ô¼±µÄ·þÎñ½øÐÐÓвßÂԵز»´¦Àí»ò¼òµ¥´¦Àí£¬´Ó¶øÊÍ·Å·þÎñÆ÷×ÊÔ´ÒÔ±£Ö¤ºËÐÄ·þÎñÕý³£ÔË×÷¡£ -* µ±Ä³Ð©·þÎñ²»¿ÉÓÃʱ£¬ÎªÁ˱ÜÃⳤʱ¼äµÈ´ýÔì³É·þÎñ¿¨¶Ù»òÑ©±ÀЧӦ£¬¶øÖ÷¶¯Ö´Ðб¸ÓõĽµ¼¶Âß¼­Á¢¿Ì·µ»ØÒ»¸öÓѺõÄÌáʾ£¬ÒÔ±£ÕÏÖ÷ÌåÒµÎñ²»ÊÜÓ°Ïì¡£ +* 在æœ�务器压力剧增时,根æ�®å®žé™…业务情况å�Šæµ�é‡�,对一些ä¸�é‡�è¦�ã€�ä¸�紧急的æœ�务进行有策略地ä¸�处ç�†æˆ–简å�•处ç�†ï¼Œä»Žè€Œé‡Šæ”¾æœ�务器资æº�以ä¿�è¯�核心æœ�务正常è¿�作。 +* 当æŸ�些æœ�务ä¸�å�¯ç”¨æ—¶ï¼Œä¸ºäº†é�¿å…�长时间等待造æˆ�æœ�务å�¡é¡¿æˆ–雪崩效应,而主动执行备用的é™�级逻辑立刻返回一个å�‹å¥½çš„æ��示,以ä¿�障主体业务ä¸�å�—å½±å“�。 -ÎÒÃÇ¿ÉÒÔͨ¹ýÖØÐ´ HystrixCommand µÄ getFallBack() ·½·¨»ò HystrixObservableCommand µÄ resumeWithFallback() ·½·¨£¬Ê¹·þÎñÖ§³Ö·þÎñ½µ¼¶¡£ +我们å�¯ä»¥é€šè¿‡é‡�写 HystrixCommand çš„ getFallBack() 方法或 HystrixObservableCommand çš„ resumeWithFallback() 方法,使æœ�务支æŒ�æœ�务é™�级。 -Hystrix ·þÎñ½µ¼¶ FallBack ¼È¿ÉÒÔ·ÅÔÚ·þÎñ¶Ë½øÐУ¬Ò²¿ÉÒÔ·ÅÔÚ¿Í»§¶Ë½øÐС£ +Hystrix æœ�务é™�级 FallBack æ—¢å�¯ä»¥æ”¾åœ¨æœ�务端进行,也å�¯ä»¥æ”¾åœ¨å®¢æˆ·ç«¯è¿›è¡Œã€‚ -Hystrix »áÔÚÒÔϳ¡¾°Ï½øÐзþÎñ½µ¼¶´¦Àí£º +Hystrix 会在以下场景下进行æœ�务é™�级处ç�†ï¼š -* ³ÌÐòÔËÐÐÒì³£ -* ·þÎñ³¬Ê± -* ÈÛ¶ÏÆ÷´¦ÓÚ´ò¿ª×´Ì¬ -* Ï̳߳Ø×ÊÔ´ºÄ¾¡ +* 程åº�è¿�行异常 +* æœ�务超时 +* 熔断器处于打开状æ€� +* 线程池资æº�耗尽 -## ʾÀý1 +## 示例1 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸ö°¸Àý£¬·Ö±ðÑÝʾÏ Hystrix ·þÎñ¶Ë·þÎñ½µ¼¶ºÍ¿Í»§¶Ë·þÎñ½µ¼¶¡£ +下é�¢æˆ‘们就通过一个案例,分别演示下 Hystrix æœ�务端æœ�务é™�级和客户端æœ�务é™�级。 -#### ·þÎñ¶Ë·þÎñ½µ¼¶ +#### æœ�务端æœ�务é™�级 -1\. ÔÚÖ÷¹¤³Ì spring-cloud-demo2 Ï´´½¨Ò»¸öÃûΪ micro-service-cloud-provider-dept-hystrix-8004 µÄ·þÎñÌṩÕߣ¬²¢ÔÚÆä pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ¡£ +1\. 在主工程 spring-cloud-demo2 下创建一个å��为 micro-service-cloud-provider-dept-hystrix-8004 çš„æœ�务æ��供者,并在其 pom.xml 中添加以下ä¾�赖。 @@ -76,7 +76,7 @@ Hystrix 4.0.0 - + spring-cloud-demo2 net.biancheng.c @@ -113,17 +113,17 @@ Hystrix spring-boot-starter-test test - + org.springframework.boot spring-boot-starter-actuator - + org.springframework.cloud spring-cloud-starter-netflix-eureka-client - + org.springframework.cloud spring-cloud-starter-netflix-hystrix @@ -154,7 +154,7 @@ Hystrix -2\. ÔÚÀà·¾¶£¨¼´ /resources Ŀ¼£©ÏÂÌí¼ÓÒ»¸öÅäÖÃÎļþ application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2\. 在类路径(å�³ /resources 目录)下添加一个é…�置文件 application.yml,é…�置内容如下。 @@ -164,26 +164,26 @@ Hystrix spring: application: - name: microServiceCloudProviderDeptHystrix #΢·þÎñÃû³Æ£¬¶ÔÍⱩ©µÄ΢·þÎñÃû³Æ£¬Ê®·ÖÖØÒª + name: microServiceCloudProviderDeptHystrix #å¾®æœ�务å��称,对外暴æ¼�的微æœ�务å��称,å��分é‡�è¦� server: port: 8004 -########################################### Spring cloud ×Ô¶¨Òå·þÎñÃû³ÆºÍ ip µØÖ·############################################### +########################################### Spring cloud 自定义æœ�务å��ç§°å’Œ ip 地å�€############################################### eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - #defaultZone: http://eureka7001:7001/eureka #Õâ¸öµØÖ·ÊÇ 7001×¢²áÖÐÐÄÔÚ application.yml Öб©Â¶³öÀ´¶î×¢²áµØÖ· £¨µ¥»ú°æ£© - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka ¼¯Èº + #defaultZone: http://eureka7001:7001/eureka #这个地å�€æ˜¯ 7001注册中心在 application.yml 中暴露出æ�¥é¢�注册地å�€ (å�•机版) + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka 集群 instance: - instance-id: spring-cloud-provider-8004 #×Ô¶¨Òå·þÎñÃû³ÆÐÅÏ¢ - prefer-ip-address: true #ÏÔʾ·ÃÎÊ·¾¶µÄ ip µØÖ· -#####################spring cloud ʹÓà Spring Boot actuator ¼à¿ØÍêÉÆÐÅÏ¢########################################### -# Spring Boot 2.50¶Ô actuator ¼à¿ØÆÁ±ÎÁË´ó¶àÊýµÄ½Úµã£¬Ö»±©Â¶ÁË heath ½Úµã£¬±¾¶ÎÅäÖã¨*£©¾ÍÊÇΪÁË¿ªÆôËùÓеĽڵã + instance-id: spring-cloud-provider-8004 #自定义æœ�务å��ç§°ä¿¡æ�¯ + prefer-ip-address: true #显示访问路径的 ip 地å�€ +#####################spring cloud 使用 Spring Boot actuator 监控完善信æ�¯########################################### +# Spring Boot 2.50对 actuator 监控å±�蔽了大多数的节点,å�ªæš´éœ²äº† heath 节点,本段é…�置(*)就是为了开å�¯æ‰€æœ‰çš„节点 management: endpoints: web: exposure: - include: "*" # * ÔÚyaml ÎļþÊôÓڹؼü×Ö£¬ËùÒÔÐèÒª¼ÓÒýºÅ + include: "*" # * 在yaml 文件属于关键字,所以需è¦�加引å�· info: app.name: micro-service-cloud-provider-dept-hystrix company.name: c.biancheng.net @@ -196,7 +196,7 @@ info: -3\. ÔÚ net.biancheng.c.service °üÏ´´½¨Ò»¸öÃûΪ DeptService µÄ½Ó¿Ú£¬´úÂëÈçÏ¡£ +3\. 在 net.biancheng.c.service 包下创建一个å��为 DeptService 的接å�£ï¼Œä»£ç �如下。 @@ -208,10 +208,10 @@ package net.biancheng.c.service; public interface DeptService { - // hystrix ÈÛ¶ÏÆ÷ʾÀý ok + // hystrix 熔断器示例 ok public String deptInfo_Ok(Integer id); - //hystrix ÈÛ¶ÏÆ÷³¬Ê±°¸Àý + //hystrix 熔断器超时案例 public String deptInfo_Timeout(Integer id); } @@ -221,7 +221,7 @@ public interface DeptService { -4\. ÔÚ net.biancheng.c.service.impl °üÏ£¬´´½¨ DeptService ½Ó¿ÚµÄʵÏÖÀà DeptServiceImpl£¬´úÂëÈçÏ¡£ +4\. 在 net.biancheng.c.service.impl 包下,创建 DeptService 接å�£çš„实现类 DeptServiceImpl,代ç �如下。 @@ -242,13 +242,13 @@ public class DeptServiceImpl implements DeptService { @Override public String deptInfo_Ok(Integer id) { - return "Ï̳߳أº" + Thread.currentThread().getName() + " deptInfo_Ok,id: " + id; + return "线程池:" + Thread.currentThread().getName() + " deptInfo_Ok,id: " + id; } - //Ò»µ©¸Ã·½·¨Ê§°Ü²¢Å׳öÁËÒì³£ÐÅÏ¢ºó£¬»á×Ô¶¯µ÷Óà @HystrixCommand ×¢½â±ê×¢µÄ fallbackMethod Ö¸¶¨µÄ·½·¨ + //一旦该方法失败并抛出了异常信æ�¯å�Žï¼Œä¼šè‡ªåŠ¨è°ƒç”¨ @HystrixCommand 注解标注的 fallbackMethod 指定的方法 @HystrixCommand(fallbackMethod = "dept_TimeoutHandler", commandProperties = - //¹æ¶¨ 5 ÃëÖÓÒÔÄھͲ»±¨´í£¬Õý³£ÔËÐУ¬³¬¹ý 5 Ãë¾Í±¨´í£¬µ÷ÓÃÖ¸¶¨µÄ·½·¨ + //规定 5 秒钟以内就ä¸�报错,正常è¿�行,超过 5 秒就报错,调用指定的方法 {@HystrixProperty(name = "execution.isolation.thread.timeoutInMilliseconds", value = "5000")}) @Override public String deptInfo_Timeout(Integer id) { @@ -258,12 +258,12 @@ public class DeptServiceImpl implements DeptService { } catch (InterruptedException e) { e.printStackTrace(); } - return "Ï̳߳أº" + Thread.currentThread().getName() + " deptInfo_Timeout,id: " + id + " ºÄʱ: " + outTime; + return "线程池:" + Thread.currentThread().getName() + " deptInfo_Timeout,id: " + id + " 耗时: " + outTime; } - // µ±·þÎñ³öÏÖ¹ÊÕϺ󣬵÷Óø÷½·¨¸ø³öÓѺÃÌáʾ + // 当æœ�务出现故障å�Žï¼Œè°ƒç”¨è¯¥æ–¹æ³•给出å�‹å¥½æ��示 public String dept_TimeoutHandler(Integer id) { - return "CÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬ÏµÍ³·±Ã¦ÇëÉÔºóÔÙÊÔ£¡"+"Ï̳߳أº" + Thread.currentThread().getName() + " deptInfo_Timeout,id: " + id; + return "C语言中文网æ��醒您,系统ç¹�忙请ç¨�å�Žå†�试ï¼�"+"线程池:" + Thread.currentThread().getName() + " deptInfo_Timeout,id: " + id; } } @@ -273,12 +273,12 @@ public class DeptServiceImpl implements DeptService { -ÎÒÃÇ¿ÉÒÔ¿´µ½ deptInfo_Timeout() ·½·¨ÉÏʹÓà @HystrixCommand ×¢½â£¬¸Ã×¢½â˵Ã÷ÈçÏ£º +我们å�¯ä»¥çœ‹åˆ° deptInfo_Timeout() 方法上使用 @HystrixCommand 注解,该注解说明如下: -* ²ÎÊý fallbackMethod ÊôÐÔÓÃÓÚÖ¸¶¨½µ¼¶·½·¨¡£ -* ²ÎÊý execution.isolation.thread.timeoutInMilliseconds ÓÃÓÚÉèÖÃ×ÔÉíµ÷Óó¬Ê±Ê±¼äµÄ·åÖµ£¬·åÖµÄÚ¿ÉÒÔÕý³£ÔËÐУ¬·ñÔòÖ´Ðнµ¼¶·½·¨ +* å�‚æ•° fallbackMethod 属性用于指定é™�级方法。 +* å�‚æ•° execution.isolation.thread.timeoutInMilliseconds 用于设置自身调用超时时间的峰值,峰值内å�¯ä»¥æ­£å¸¸è¿�行,å�¦åˆ™æ‰§è¡Œé™�级方法 -5. ÔÚ net.biancheng.c.controller °üÏ´´½¨Ò»¸öÃûΪ DeptController µÄ Controller À࣬´úÂëÈçÏ¡£ +5. 在 net.biancheng.c.controller 包下创建一个å��为 DeptController çš„ Controller 类,代ç �如下。 @@ -305,16 +305,16 @@ public class DeptController { @RequestMapping(value = "/dept/hystrix/ok/{id}") public String deptInfo_Ok(@PathVariable("id") Integer id) { String result = deptService.deptInfo_Ok(id); - log.info("¶Ë¿ÚºÅ£º" + serverPort + " result:" + result); - return result + "£¬ ¶Ë¿ÚºÅ£º" + serverPort; + log.info("端å�£å�·ï¼š" + serverPort + " result:" + result); + return result + ", 端å�£å�·ï¼š" + serverPort; } - // Hystrix ·þÎñ³¬Ê±½µ¼¶ + // Hystrix æœ�务超时é™�级 @RequestMapping(value = "/dept/hystrix/timeout/{id}") public String deptInfo_Timeout(@PathVariable("id") Integer id) { String result = deptService.deptInfo_Timeout(id); - log.info("¶Ë¿ÚºÅ£º" + serverPort + " result:" + result); - return result + "£¬ ¶Ë¿ÚºÅ£º" + serverPort; + log.info("端å�£å�·ï¼š" + serverPort + " result:" + result); + return result + ", 端å�£å�·ï¼š" + serverPort; } } @@ -325,7 +325,7 @@ public class DeptController { -6\. ÔÚ micro-service-cloud-provider-dept-hystrix-8004 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableCircuitBreaker ×¢½â¿ªÆôÈÛ¶ÏÆ÷¹¦ÄÜ£¬´úÂëÈçÏ¡£ +6\. 在 micro-service-cloud-provider-dept-hystrix-8004 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableCircuitBreaker 注解开å�¯ç†”断器功能,代ç �如下。 @@ -341,8 +341,8 @@ import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker; import org.springframework.cloud.netflix.eureka.EnableEurekaClient; @SpringBootApplication -@EnableEurekaClient //¿ªÆô Eureka ¿Í»§¶Ë¹¦ÄÜ -@EnableCircuitBreaker //¼¤»îÈÛ¶ÏÆ÷¹¦ÄÜ +@EnableEurekaClient //å¼€å�¯ Eureka 客户端功能 +@EnableCircuitBreaker //激活熔断器功能 public class MicroServiceCloudProviderDeptHystrix8004Application { public static void main(String[] args) { @@ -356,23 +356,23 @@ public class MicroServiceCloudProviderDeptHystrix8004Application { -7\. ÒÀ´ÎÆô¶¯·þÎñ×¢²áÖÐÐÄ£¨Eureka Server£©¼¯ÈººÍ micro-service-cloud-provider-dept-hystrix-8004£¬²¢Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/ok/1¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. ä¾�次å�¯åЍæœ�务注册中心(Eureka Server)集群和 micro-service-cloud-provider-dept-hystrix-8004,并使用æµ�览器访问“http://eureka7001.com:8004/dept/hystrix/ok/1â€�,结果如下图。 ![Hystrix ok](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016234615-1.png) -ͼ2£ºHystrix Õý³£·þÎñ°¸Àý +图2:Hystrix 正常æœ�务案例 -8\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/timeout/1¡±£¬½á¹ûÈçÏÂͼ¡£ +8\. 使用æµ�览器访问“http://eureka7001.com:8004/dept/hystrix/timeout/1â€�,结果如下图。 -![Hystrix ·þÎñ½µ¼¶](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623FR-2.png) -ͼ3£ºHystrix ·þÎñ¶Ë·þÎñ½µ¼¶ +![Hystrix æœ�务é™�级](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623FR-2.png) +图3:Hystrix æœ�务端æœ�务é™�级 -#### ¿Í»§¶Ë·þÎñ½µ¼¶ +#### 客户端æœ�务é™�级 -ͨ³£Çé¿öÏ£¬ÎÒÃǶ¼»áÔÚ¿Í»§¶Ë½øÐзþÎñ½µ¼¶£¬µ±¿Í»§¶Ëµ÷ÓõķþÎñ¶ËµÄ·þÎñ²»¿ÉÓÃʱ£¬¿Í»§¶ËÖ±½Ó½øÐзþÎñ½µ¼¶´¦Àí£¬±ÜÃâÆäÏ̱߳»³¤Ê±¼ä¡¢²»±ØÒªµØÕ¼Óᣠ+通常情况下,我们都会在客户端进行æœ�务é™�级,当客户端调用的æœ�务端的æœ�务ä¸�å�¯ç”¨æ—¶ï¼Œå®¢æˆ·ç«¯ç›´æŽ¥è¿›è¡Œæœ�务é™�级处ç�†ï¼Œé�¿å…�其线程被长时间ã€�ä¸�å¿…è¦�地å� ç”¨ã€‚ -¿Í»§¶Ë·þÎñ½µ¼¶²½ÖèÈçÏ¡£ +客户端æœ�务é™�级步骤如下。 -1\. ÔÚ micro-service-cloud-consumer-dept-feign µÄ pom.xml ÖÐÌí¼Ó Hystrix µÄÒÀÀµ£¬´úÂëÈçÏ¡£ +1\. 在 micro-service-cloud-consumer-dept-feign çš„ pom.xml 中添加 Hystrix çš„ä¾�赖,代ç �如下。 @@ -381,7 +381,7 @@ public class MicroServiceCloudProviderDeptHystrix8004Application { ``` - + org.springframework.cloud spring-cloud-starter-netflix-hystrix @@ -392,7 +392,7 @@ public class MicroServiceCloudProviderDeptHystrix8004Application { -2. ÔÚ micro-service-cloud-consumer-dept-feign µÄ application.yml ÖÐÌí¼ÓÒÔÏÂÅäÖ㬿ªÆô¿Í»§¶ËµÄ Hystrix ¹¦ÄÜ¡£ +2. 在 micro-service-cloud-consumer-dept-feign çš„ application.yml 中添加以下é…�置,开å�¯å®¢æˆ·ç«¯çš„ Hystrix 功能。 @@ -402,7 +402,7 @@ public class MicroServiceCloudProviderDeptHystrix8004Application { feign: hystrix: - enabled: true #¿ªÆô¿Í»§¶Ë hystrix + enabled: true #å¼€å�¯å®¢æˆ·ç«¯ hystrix ``` @@ -410,7 +410,7 @@ feign: -3\. ÔÚ net.biancheng.c.service °üÏ£¬´´½¨Ò»¸öÃûΪ DeptHystrixService µÄ·þÎñ°ó¶¨½Ó¿Ú£¬Óë micro-service-cloud-provider-dept-hystrix-8004 ÖÐÌṩµÄ·þÎñ½Ó¿Ú½øÐа󶨣¬´úÂëÈçÏ¡£ +3\. 在 net.biancheng.c.service 包下,创建一个å��为 DeptHystrixService çš„æœ�务绑定接å�£ï¼Œä¸Ž micro-service-cloud-provider-dept-hystrix-8004 中æ��供的æœ�务接å�£è¿›è¡Œç»‘定,代ç �如下。 @@ -440,7 +440,7 @@ public interface DeptHystrixService { -4\. ÔÚ net.biancheng.c.controller °üÏ´´½¨Ò»¸öÃûΪ HystrixController_Consumer µÄ Controller £¬´úÂëÈçÏ¡£ +4\. 在 net.biancheng.c.controller 包下创建一个å��为 HystrixController_Consumer çš„ Controller ,代ç �如下。 @@ -471,19 +471,19 @@ public class HystrixController_Consumer { return deptHystrixService.deptInfo_Ok(id); } - //ÔÚ¿Í»§¶Ë½øÐнµ¼¶ + //在客户端进行é™�级 @RequestMapping(value = "/consumer/dept/hystrix/timeout/{id}") - @HystrixCommand(fallbackMethod = "dept_TimeoutHandler") //Ϊ¸ÃÇëÇóÖ¸¶¨×¨ÊôµÄ»ØÍË·½·¨ + @HystrixCommand(fallbackMethod = "dept_TimeoutHandler") //为该请求指定专属的回退方法 public String deptInfo_Timeout(@PathVariable("id") Integer id) { String s = deptHystrixService.deptInfo_Timeout(id); log.info(s); return s; } - // deptInfo_Timeout·½·¨µÄ רÓà fallback ·½·¨ + // deptInfo_Timeout方法的 专用 fallback 方法 public String dept_TimeoutHandler(@PathVariable("id") Integer id) { - log.info("deptInfo_Timeout ³ö´í£¬·þÎñÒѱ»½µ¼¶£¡"); - return "CÓïÑÔÖÐÎÄÍøÌáÐÑÄú£º·þÎñ¶Ëϵͳ·±Ã¦£¬ÇëÉÔºóÔÙÊÔ£¡£¨¿Í»§¶Ë deptInfo_Timeout רÊôµÄ»ØÍË·½·¨´¥·¢£©"; + log.info("deptInfo_Timeout 出错,æœ�务已被é™�级ï¼�"); + return "C语言中文网æ��醒您:æœ�务端系统ç¹�忙,请ç¨�å�Žå†�试ï¼�(客户端 deptInfo_Timeout 专属的回退方法触å�‘)"; } } @@ -493,18 +493,18 @@ public class HystrixController_Consumer { -5\. ÔÚÅäÖÃÎļþ appliction.yml ÖÐÌí¼ÓÒÔÏÂÅäÖã¬ÔÚ¿Í»§¶ËÅäÖÃÇëÇó³¬Ê±µÄʱ¼ä¡£ +5\. 在é…�置文件 appliction.yml 中添加以下é…�置,在客户端é…�置请求超时的时间。 ``` -######################### Ribbon ¿Í»§¶Ë³¬Ê±¿ØÖÆ ################################### +######################### Ribbon 客户端超时控制 ################################### ribbon: - ReadTimeout: 6000 #½¨Á¢Á¬½ÓËùÓõÄʱ¼ä£¬ÊÊÓÃÓÚÍøÂç×´¿öÕý³£µÄÇé¿öÏ£¬Á½¶ËÁ½¶ËÁ¬½ÓËùÓõÄʱ¼ä - ConnectionTimeout: 6000 #½¨Á¢Á¬½Óºó£¬·þÎñÆ÷¶ÁÈ¡µ½¿ÉÓÃ×ÊÔ´µÄʱ¼ä -######################ÅäÖÃÇëÇó³¬Ê±Ê±¼ä########################## + ReadTimeout: 6000 #建立连接所用的时间,适用于网络状况正常的情况下,两端两端连接所用的时间 + ConnectionTimeout: 6000 #建立连接å�Žï¼Œæœ�务器读å�–到å�¯ç”¨èµ„æº�的时间 +######################é…�置请求超时时间########################## hystrix: command: default: @@ -512,7 +512,7 @@ hystrix: isolation: thread: timeoutInMilliseconds: 7000 -####################ÅäÖþßÌå·½·¨³¬Ê±Ê±¼ä Ϊ 3 Ãë######################## +####################é…�置具体方法超时时间 为 3 ç§’######################## DeptHystrixService#deptInfo_Timeout(Integer): execution: isolation: @@ -525,24 +525,24 @@ hystrix: -ÔÚÅäÖÃÎļþÖÐÉè¼ÆÇëÇóµÄ³¬Ê±Ê±¼äʱ£¬ÐèҪעÒâÒÔÏ 2 µã£º +在é…�置文件中设计请求的超时时间时,需è¦�注æ„�以下 2 点: -1£©Hystrix ¿ÉÒÔÀ´ÎªËùÓÐÇëÇ󣨷½·¨£©ÉèÖó¬Ê±Ê±¼ä£¨µ¥Î»ÎªºÁÃ룩£¬ÈôÇëÇó³¬Ê±Ôò´¥·¢È«¾ÖµÄ»ØÍË·½·¨½øÐд¦Àí¡£ +1)Hystrix å�¯ä»¥æ�¥ä¸ºæ‰€æœ‰è¯·æ±‚(方法)设置超时时间(å�•ä½�为毫秒),若请求超时则触å�‘全局的回退方法进行处ç�†ã€‚ ```hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=mmm``` -2£©Hystrix »¹¿ÉÒÔΪij¸öÌØ¶¨µÄ·þÎñÇëÇ󣨷½·¨£©ÉèÖó¬Ê±Ê±¼ä£¬¸ñʽÈçÏ£º +2)Hystrix 还å�¯ä»¥ä¸ºæŸ�个特定的æœ�务请求(方法)设置超时时间,格å¼�如下: ```hystrix.command.xxx#yyy(zzz).execution.isolation.thread.timeoutInMilliseconds=mmm``` -¸ñʽ˵Ã÷ÈçÏ£º +æ ¼å¼�说明如下: -* xxx£ºÎª°üº¬¸Ã·þÎñ·½·¨µÄÀàµÄÃû³Æ£¨Í¨³£Îª·þÎñ°ó¶¨½Ó¿ÚµÄÃû³Æ£©£¬ÀýÈç DeptHystrixService ½Ó¿Ú¡£ -* yyy£º·þÎñ·½·¨Ãû£¬ÀýÈç deptInfo_Timeout() ·½·¨¡£ -* zzz£º·½·¨ÄڵIJÎÊýÀàÐÍ£¬ÀýÈç Integer¡¢String µÈµÈ -* mmm£ºÒªÉèÖõij¬Ê±Ê±¼ä£¬µ¥Î»ÎªºÁÃ루1 Ãë =1000 ºÁÃ룩 +* xxx:为包å�«è¯¥æœ�务方法的类的å��称(通常为æœ�务绑定接å�£çš„å��称),例如 DeptHystrixService 接å�£ã€‚ +* yyy:æœ�务方法å��,例如 deptInfo_Timeout() 方法。 +* zzz:方法内的å�‚数类型,例如 Integerã€�String 等等 +* mmm:è¦�设置的超时时间,å�•ä½�为毫秒(1 ç§’ =1000 毫秒) -6\. ÔÚ micro-service-cloud-consumer-dept-feign µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableHystrix ×¢½â¿ªÆô¿Í»§¶Ë Hystrix ¹¦ÄÜ£¬´úÂëÈçÏ¡£ +6\. 在 micro-service-cloud-consumer-dept-feign 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableHystrix 注解开å�¯å®¢æˆ·ç«¯ Hystrix 功能,代ç �如下。 @@ -558,8 +558,8 @@ import org.springframework.cloud.netflix.hystrix.EnableHystrix; import org.springframework.cloud.openfeign.EnableFeignClients; @SpringBootApplication -@EnableFeignClients //¿ªÆô OpenFeign ¹¦ÄÜ -@EnableHystrix //ÆôÓà Hystrix +@EnableFeignClients //å¼€å�¯ OpenFeign 功能 +@EnableHystrix //å�¯ç”¨ Hystrix public class MicroServiceCloudConsumerDeptFeignApplication { public static void main(String[] args) { @@ -573,17 +573,17 @@ public class MicroServiceCloudConsumerDeptFeignApplication { -7\. ÐÞ¸Ä micro-service-cloud-provider-dept-hystrix-8004 ÖÐ DeptServiceImpl µÄ´úÂ룬½« deptInfo_Timeout() ·½·¨µÄÔËÐÐʱ¼äÐÞ¸ÄΪ 4 Ã루СÓÚ³¬Ê±Ê±¼ä 5 Ã룩£¬ÒÔ±£Ö¤·þÎñ¶ËÇëÇóÕý³£²»±»½µ¼¶£¬´úÂëÈçÏ¡£ +7\. 修改 micro-service-cloud-provider-dept-hystrix-8004 中 DeptServiceImpl 的代ç �,将 deptInfo_Timeout() 方法的è¿�行时间修改为 4 秒(å°�于超时时间 5 秒),以ä¿�è¯�æœ�务端请求正常ä¸�被é™�级,代ç �如下。 ``` -//Ò»µ©¸Ã·½·¨Ê§°Ü²¢Å׳öÁËÒì³£ÐÅÏ¢ºó£¬»á×Ô¶¯µ÷Óà @HystrixCommand ×¢½â±ê×¢µÄ fallbackMethod Ö¸¶¨µÄ·½·¨ +//一旦该方法失败并抛出了异常信æ�¯å�Žï¼Œä¼šè‡ªåŠ¨è°ƒç”¨ @HystrixCommand 注解标注的 fallbackMethod 指定的方法 @HystrixCommand(fallbackMethod = "dept_TimeoutHandler", commandProperties = - //¹æ¶¨ 5 ÃëÖÓÒÔÄھͲ»±¨´í£¬Õý³£ÔËÐУ¬³¬¹ý 5 Ãë¾Í±¨´í£¬µ÷ÓÃÖ¸¶¨µÄ·½·¨ + //规定 5 秒钟以内就ä¸�报错,正常è¿�行,超过 5 秒就报错,调用指定的方法 {@HystrixProperty(name = "execution.isolation.thread.timeoutInMilliseconds", value = "5000")}) @Override public String deptInfo_Timeout(Integer id) { @@ -593,7 +593,7 @@ public String deptInfo_Timeout(Integer id) { } catch (InterruptedException e) { e.printStackTrace(); } - return "Ï̳߳أº" + Thread.currentThread().getName() + " deptInfo_Timeout,id: " + id + " ºÄʱ: " + outTime; + return "线程池:" + Thread.currentThread().getName() + " deptInfo_Timeout,id: " + id + " 耗时: " + outTime; } ``` @@ -602,23 +602,23 @@ public String deptInfo_Timeout(Integer id) { -8\. ÖØÆô micro-service-cloud-provider-dept-hystrix-8004 ºÍ micro-service-cloud-consumer-dept-feign£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/timeout/1¡±£¬Ö±½Óµ÷Ó÷þÎñ¶ËµÄ deptInfo_Timeout() ·½·¨£¬½á¹ûÈçÏÂͼ¡£ +8\. é‡�å�¯ micro-service-cloud-provider-dept-hystrix-8004 å’Œ micro-service-cloud-consumer-dept-feign,使用æµ�览器访问“http://eureka7001.com:8004/dept/hystrix/timeout/1â€�,直接调用æœ�务端的 deptInfo_Timeout() 方法,结果如下图。 -![Hystrix ·þÎñ¶ËÇëÇóÕý³£](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016231059-3.png) -ͼ4£ºHystrix ·þÎñ¶ËÇëÇóÕý³£ +![Hystrix æœ�务端请求正常](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016231059-3.png) +图4:Hystrix æœ�务端请求正常 -9\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/hystrix/timeout/1¡±£¬½á¹ûÈçÏÂͼ¡£ +9\. 使用æµ�览器访问“http://eureka7001.com/consumer/dept/hystrix/timeout/1â€�,结果如下图。 -![Hystrix ¿Í»§¶Ë·þÎñ½µ¼¶](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623C94-4.png) -ͼ5£ºHystrix ¿Í»§¶Ë·þÎñ½µ¼¶ +![Hystrix 客户端æœ�务é™�级](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623C94-4.png) +图5:Hystrix 客户端æœ�务é™�级 -ÓÉͼ 5 ¿ÉÒÔ¿´³ö£¬ÓÉÓÚ·þÎñÇëÇóµÄºÄʱΪ 4 Ã룬³¬¹ýÁ˿ͻ§¶ËΪ¸ÃÇëÇóÖ¸¶¨µÄ³¬Ê±Ê±¼ä £¨3 Ãë £©£¬Òò´Ë¸Ã·þÎñ±»½µ¼¶´¦Àí£¬´¥·¢ÁËÆäÖ¸¶¨µÄ»ØÍË·½·¨¡£ +由图 5 å�¯ä»¥çœ‹å‡ºï¼Œç”±äºŽæœ�务请求的耗时为 4 秒,超过了客户端为该请求指定的超时时间 (3 ç§’ ),因此该æœ�务被é™�级处ç�†ï¼Œè§¦å�‘了其指定的回退方法。 -## È«¾Ö½µ¼¶·½·¨ +## 全局é™�级方法 -ͨ¹ýÉÏÃæµÄ·½Ê½ÊµÏÖ·þÎñ½µ¼¶Ê±£¬ÐèÒªÕë¶ÔËùÓÐÒµÎñ·½·¨¶¼ÅäÖýµ¼¶·½·¨£¬Õ⼫ÓпÉÄÜ»áÔì³É´úÂëµÄ¼±¾çÅòÕÍ¡£ÎªÁ˽â¾ö¸ÃÎÊÌ⣬ÎÒÃÇ»¹¿ÉÒÔΪËùÓÐÒµÎñ·½·¨Ö¸¶¨Ò»¸öÈ«¾ÖµÄ»ØÍË·½·¨£¬¾ßÌå²½ÖèÈçÏ¡£ +通过上é�¢çš„æ–¹å¼�实现æœ�务é™�级时,需è¦�针对所有业务方法都é…�ç½®é™�级方法,这æž�有å�¯èƒ½ä¼šé€ æˆ�代ç �的急剧膨胀。为了解决该问题,我们还å�¯ä»¥ä¸ºæ‰€æœ‰ä¸šåŠ¡æ–¹æ³•æŒ‡å®šä¸€ä¸ªå…¨å±€çš„å›žé€€æ–¹æ³•ï¼Œå…·ä½“æ­¥éª¤å¦‚ä¸‹ã€‚ -1\. ÔÚ HystrixController_Consumer µÄÀàÃûÉϱê×¢ @DefaultProperties ×¢½â£¬²¢Í¨¹ýÆä defaultFallback ÊôÐÔÖ¸¶¨Ò»¸öÈ«¾ÖµÄ½µ¼¶·½·¨£¬´úÂëÈçÏ¡£ +1\. 在 HystrixController_Consumer 的类å��上标注 @DefaultProperties 注解,并通过其 defaultFallback 属性指定一个全局的é™�级方法,代ç �如下。 @@ -629,9 +629,9 @@ public String deptInfo_Timeout(Integer id) { @Slf4j @RestController -@DefaultProperties(defaultFallback = "dept_Global_FallbackMethod") //È«¾ÖµÄ·þÎñ½µ¼¶·½·¨ +@DefaultProperties(defaultFallback = "dept_Global_FallbackMethod") //全局的æœ�务é™�级方法 public class HystrixController_Consumer { -¡­¡­ +…… } ``` @@ -640,7 +640,7 @@ public class HystrixController_Consumer { -2\. ÔÚ HystrixController_Consumer ÖУ¬´´½¨Ò»¸öÃûΪ dept_Global_FallbackMethod µÄÈ«¾Ö»Ø·½·¨£¬´úÂëÈçÏ¡£ +2\. 在 HystrixController_Consumer 中,创建一个å��为 dept_Global_FallbackMethod 的全局回方法,代ç �如下。 @@ -650,12 +650,12 @@ public class HystrixController_Consumer { /** - * È«¾ÖµÄ fallback ·½·¨£¬ - * »ØÍË·½·¨±ØÐëºÍ hystrix µÄÖ´Ðз½·¨ÔÚÏàͬÀàÖÐ - * @DefaultProperties(defaultFallback = "dept_Global_FallbackMethod") ÀàÉÏ×¢½â£¬ÇëÇó·½·¨ÉÏʹÓà @HystrixCommand ×¢½â + * 全局的 fallback 方法, + * 回退方法必须和 hystrix 的执行方法在相å�Œç±»ä¸­ + * @DefaultProperties(defaultFallback = "dept_Global_FallbackMethod") 类上注解,请求方法上使用 @HystrixCommand 注解 */ public String dept_Global_FallbackMethod() { - return "CÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬ÔËÐгö´í»ò·þÎñ¶Ëϵͳ·±Ã¦£¬ÇëÉÔºóÔÙÊÔ£¡£¨¿Í»§¶ËÈ«¾Ö»ØÍË·½·¨´¥·¢,£©"; + return "C语言中文网æ��醒您,è¿�行出错或æœ�务端系统ç¹�忙,请ç¨�å�Žå†�试ï¼�(客户端全局回退方法触å�‘,)"; } ``` @@ -664,9 +664,9 @@ public String dept_Global_FallbackMethod() { -> **×¢Òâ**£º½µ¼¶£¨FallBack£©·½·¨±ØÐëÓëÆä¶ÔÓ¦µÄÒµÎñ·½·¨ÔÚͬһ¸öÀàÖУ¬·ñÔòÎÞ·¨ÉúЧ¡£ +> **注æ„�**:é™�级(FallBack)方法必须与其对应的业务方法在å�Œä¸€ä¸ªç±»ä¸­ï¼Œå�¦åˆ™æ— æ³•生效。 -3\. ÔÚËùÓеÄÒµÎñ·½·¨É϶¼±ê×¢ @HystrixCommand ×¢½â£¬ÕâÀïÎÒÃǽ« deptInfo_Timeout() ·½·¨É쵀 @HystrixCommand(fallbackMethod = "dept_TimeoutHandler") ÐÞ¸ÄΪ @HystrixCommand ¼´¿É£¬´úÂëÈçÏ¡£ +3\. 在所有的业务方法上都标注 @HystrixCommand 注解,这里我们将 deptInfo_Timeout() 方法上的 @HystrixCommand(fallbackMethod = "dept_TimeoutHandler") 修改为 @HystrixCommand å�³å�¯ï¼Œä»£ç �如下。 @@ -675,7 +675,7 @@ public String dept_Global_FallbackMethod() { ``` -//ÔÚ¿Í»§¶Ë½øÐнµ¼¶ +//在客户端进行é™�级 @RequestMapping(value = "/consumer/dept/hystrix/timeout/{id}") @HystrixCommand public String deptInfo_Timeout(@PathVariable("id") Integer id) { @@ -689,20 +689,20 @@ public String deptInfo_Timeout(@PathVariable("id") Integer id) { -> **×¢Òâ**£ºÈ«¾Ö½µ¼¶·½·¨µÄÓÅÏȼ¶½ÏµÍ£¬Ö»ÓÐÒµÎñ·½·¨Ã»ÓÐÖ¸¶¨Æä½µ¼¶·½·¨Ê±£¬·þÎñ½µ¼¶Ê±²Å»á´¥·¢È«¾Ö»ØÍË·½·¨¡£ÈôÒµÎñ·½·¨Ö¸¶¨Ëü×Ô¼ºµÄ»ØÍË·½·¨£¬ÄÇôÔÚ·þÎñ½µ¼¶Ê±£¬¾ÍÖ»»áÖ±½Ó´¥·¢Ëü×Ô¼ºµÄ»ØÍË·½·¨£¬¶ø·ÇÈ«¾Ö»ØÍË·½·¨¡£ +> **注æ„�**:全局é™�级方法的优先级较低,å�ªæœ‰ä¸šåŠ¡æ–¹æ³•æ²¡æœ‰æŒ‡å®šå…¶é™�级方法时,æœ�务é™�级时æ‰�会触å�‘全局回退方法。若业务方法指定它自己的回退方法,那么在æœ�务é™�级时,就å�ªä¼šç›´æŽ¥è§¦å�‘它自己的回退方法,而é�žå…¨å±€å›žé€€æ–¹æ³•。 -4\. ÖØÆô micro-service-cloud-consumer-dept-feign£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/hystrix/timeout/1¡±£¬½á¹ûÈçÏÂͼ¡£ +4\. é‡�å�¯ micro-service-cloud-consumer-dept-feign,使用æµ�览器访问“http://eureka7001.com/consumer/dept/hystrix/timeout/1â€�,结果如下图。 -![Hystrix È«¾Ö»ØÍË·½·¨](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623J11-5.png) -ͼ6£ºÈ«¾Ö»ØÍË·½·¨ +![Hystrix 全局回退方法](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101623J11-5.png) +图6:全局回退方法 -## ½âñî½µ¼¶Âß¼­ +## 解耦é™�级逻辑 -²»¹ÜÊÇÒµÎñ·½·¨Ö¸¶¨µÄ½µ¼¶·½·¨»¹ÊÇÈ«¾Ö½µ¼¶·½·¨£¬ËüÃǶ¼±ØÐëºÍÒµÎñ·½·¨ÔÚͬһ¸öÀàÖвÅÄÜÉúЧ£¬ÒµÎñÂß¼­Óë½µ¼¶Âß¼­ñîºÏ¶È¼«¸ß¡£ +ä¸�管是业务方法指定的é™�级方法还是全局é™�级方法,它们都必须和业务方法在å�Œä¸€ä¸ªç±»ä¸­æ‰�能生效,业务逻辑与é™�级逻辑耦å�ˆåº¦æž�高。 -ÏÂÃæÎÒÃǶÔÒµÎñÂß¼­Óë½µ¼¶Âß¼­½øÐнâñ²Ù×÷²½ÖèÈçÏ¡£ +下é�¢æˆ‘们对业务逻辑与é™�级逻辑进行解耦,æ“�作步骤如下。 -1\. ÔÚ micro-service-cloud-consumer-dept-feign µÄ net.biancheng.c.service °üÏ£¬Ð½¨ DeptHystrixService ½Ó¿ÚµÄʵÏÖÀà DeptHystrixFallBackService£¬Í³Ò»Îª DeptHystrixService Öеķ½·¨Ìṩ·þÎñ½µ¼¶´¦Àí £¬´úÂëÈçÏ¡£ +1\. 在 micro-service-cloud-consumer-dept-feign çš„ net.biancheng.c.service 包下,新建 DeptHystrixService 接å�£çš„实现类 DeptHystrixFallBackService,统一为 DeptHystrixService 中的方法æ��ä¾›æœ�务é™�级处ç�† ,代ç �如下。 @@ -713,18 +713,18 @@ public String deptInfo_Timeout(@PathVariable("id") Integer id) { package net.biancheng.c.service; import org.springframework.stereotype.Component; /** -* Hystrix ·þÎñ½µ¼¶ -* ½âñî»ØÍËÂß¼­ +* Hystrix æœ�务é™�级 +* 解耦回退逻辑 */ @Component public class DeptHystrixFallBackService implements DeptHystrixService { @Override public String deptInfo_Ok(Integer id) { - return "--------------------CÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬ÏµÍ³·±Ã¦£¬ÇëÉÔºóÖØÊÔ£¡£¨½âñî»ØÍË·½·¨´¥·¢£©-----------------------"; + return "--------------------C语言中文网æ��醒您,系统ç¹�忙,请ç¨�å�Žé‡�试ï¼�(解耦回退方法触å�‘)-----------------------"; } @Override public String deptInfo_Timeout(Integer id) { - return "--------------------CÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬ÏµÍ³·±Ã¦£¬ÇëÉÔºóÖØÊÔ£¡£¨½âñî»ØÍË·½·¨´¥·¢£©-----------------------"; + return "--------------------C语言中文网æ��醒您,系统ç¹�忙,请ç¨�å�Žé‡�试ï¼�(解耦回退方法触å�‘)-----------------------"; } } @@ -734,9 +734,9 @@ public class DeptHystrixFallBackService implements DeptHystrixService { -> **×¢Òâ**£º¸ÃÀà±ØÐëÒÔ×é¼þµÄÐÎʽÌí¼Ó Spring ÈÝÆ÷ÖвÅÄÜÉúЧ£¬×î³£Óõķ½Ê½¾ÍÊÇÔÚÀàÉϱê×¢ @Component ×¢½â¡£ +> **注æ„�**:该类必须以组件的形å¼�添加 Spring 容器中æ‰�能生效,最常用的方å¼�就是在类上标注 @Component 注解。 -2\. ÔÚ·þÎñ°ó¶¨½Ó¿Ú DeptHystrixService ±ê×¢µÄ @FeignClient ×¢½âÖÐÌí¼Ó fallback ÊôÐÔ£¬ÊôÐÔֵΪ DeptHystrixFallBackService.class£¬´úÂëÈçÏ¡£ +2\. 在æœ�务绑定接å�£ DeptHystrixService 标注的 @FeignClient 注解中添加 fallback 属性,属性值为 DeptHystrixFallBackService.class,代ç �如下。 @@ -763,47 +763,47 @@ public interface DeptHystrixService { -3\. ÖØÆô micro-service-cloud-consumer-dept-feign£¬È»ºó¹Ø±Õ·þÎñ¶Ë micro-service-cloud-provider-dept-hystrix-8004£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/hystrix/ok/1¡±£¬½á¹ûÈçÏÂͼ¡£ +3\. é‡�å�¯ micro-service-cloud-consumer-dept-feign,然å�Žå…³é—­æœ�务端 micro-service-cloud-provider-dept-hystrix-8004,使用æµ�览器访问“http://eureka7001.com/consumer/dept/hystrix/ok/1â€�,结果如下图。 -![Hystrix ½âñî»ØÍËÂß¼­](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016233063-6.png) -ͼ7£ºHystrix ½âñî»ØÍË·½·¨ +![Hystrix 解耦回退逻辑](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016233063-6.png) +图7:Hystrix 解耦回退方法 -## Hystrix ·þÎñÈÛ¶Ï +## Hystrix æœ�务熔断 -ÈÛ¶Ï»úÖÆÊÇΪÁËÓ¦¶ÔÑ©±ÀЧӦ¶ø³öÏÖµÄÒ»ÖÖ΢·þÎñÁ´Â·±£»¤»úÖÆ¡£ +熔断机制是为了应对雪崩效应而出现的一ç§�å¾®æœ�务链路ä¿�护机制。 -µ±Î¢·þÎñϵͳÖеÄij¸ö΢·þÎñ²»¿ÉÓûòÏìӦʱ¼äÌ«³¤Ê±£¬ÎªÁ˱£»¤ÏµÍ³µÄÕûÌå¿ÉÓÃÐÔ£¬ÈÛ¶ÏÆ÷»áÔÝʱÇжÏÇëÇó¶Ô¸Ã·þÎñµÄµ÷Ó㬲¢¿ìËÙ·µ»ØÒ»¸öÓѺõĴíÎóÏìÓ¦¡£ÕâÖÖÈÛ¶Ï״̬²»ÊÇÓÀ¾ÃµÄ£¬ÔÚ¾­ÀúÁËÒ»¶¨µÄʱ¼äºó£¬ÈÛ¶ÏÆ÷»áÔٴμì²â¸Ã΢·þÎñÊÇ·ñ»Ö¸´Õý³££¬Èô·þÎñ»Ö¸´Õý³£Ôò»Ö¸´Æäµ÷ÓÃÁ´Â·¡£ +当微æœ�务系统中的æŸ�个微æœ�务ä¸�å�¯ç”¨æˆ–å“�应时间太长时,为了ä¿�护系统的整体å�¯ç”¨æ€§ï¼Œç†”断器会暂时切断请求对该æœ�务的调用,并快速返回一个å�‹å¥½çš„错误å“�应。这ç§�熔断状æ€�ä¸�是永久的,在ç»�历了一定的时间å�Žï¼Œç†”断器会å†�次检测该微æœ�务是å�¦æ�¢å¤�正常,若æœ�务æ�¢å¤�正常则æ�¢å¤�其调用链路。 -#### ÈÛ¶Ï״̬ +#### 熔断状æ€� -ÔÚÈÛ¶Ï»úÖÆÖÐÉæ¼°ÁËÈýÖÖÈÛ¶Ï״̬£º +在熔断机制中涉å�Šäº†ä¸‰ç§�熔断状æ€�: -* È۶ϹرÕ״̬£¨Closed£©£ºµ±·þÎñ·ÃÎÊÕý³£Ê±£¬ÈÛ¶ÏÆ÷´¦ÓڹرÕ״̬£¬·þÎñµ÷Ó÷½¿ÉÒÔÕý³£µØ¶Ô·þÎñ½øÐе÷Óᣠ-* ÈÛ¶Ï¿ªÆô״̬£¨Open£©£ºÄ¬ÈÏÇé¿öÏ£¬Ôڹ̶¨Ê±¼äÄÚ½Ó¿Úµ÷Óóö´í±ÈÂÊ´ïµ½Ò»¸öãÐÖµ£¨ÀýÈç 50%£©£¬ÈÛ¶ÏÆ÷»á½øÈëÈÛ¶Ï¿ªÆô״̬¡£½øÈëÈÛ¶Ï״̬ºó£¬ºóÐø¶Ô¸Ã·þÎñµÄµ÷Óö¼»á±»Çжϣ¬ÈÛ¶ÏÆ÷»áÖ´Ðб¾µØµÄ½µ¼¶£¨FallBack£©·½·¨¡£ -* °ëÈÛ¶Ï״̬£¨Half-Open£©£º ÔÚÈÛ¶Ï¿ªÆôÒ»¶Îʱ¼äÖ®ºó£¬ÈÛ¶ÏÆ÷»á½øÈë°ëÈÛ¶Ï״̬¡£ÔÚ°ëÈÛ¶Ï״̬Ï£¬ÈÛ¶ÏÆ÷»á³¢ÊÔ»Ö¸´·þÎñµ÷Ó÷½¶Ô·þÎñµÄµ÷Óã¬ÔÊÐí²¿·ÖÇëÇóµ÷Óø÷þÎñ£¬²¢¼à¿ØÆäµ÷Óóɹ¦ÂÊ¡£Èç¹û³É¹¦ÂÊ´ïµ½Ô¤ÆÚ£¬Ôò˵Ã÷·þÎñÒѻָ´Õý³££¬ÈÛ¶ÏÆ÷½øÈë¹Ø±Õ״̬£»Èç¹û³É¹¦ÂÊÈԾɺܵͣ¬ÔòÖØÐ½øÈëÈÛ¶Ï¿ªÆô״̬¡£ +* 熔断关闭状æ€�(Closed):当æœ�务访问正常时,熔断器处于关闭状æ€�,æœ�务调用方å�¯ä»¥æ­£å¸¸åœ°å¯¹æœ�务进行调用。 +* 熔断开å�¯çжæ€�(Open):默认情况下,在固定时间内接å�£è°ƒç”¨å‡ºé”™æ¯”率达到一个阈值(例如 50%),熔断器会进入熔断开å�¯çжæ€�。进入熔断状æ€�å�Žï¼Œå�Žç»­å¯¹è¯¥æœ�务的调用都会被切断,熔断器会执行本地的é™�级(FallBack)方法。 +* å�Šç†”断状æ€�(Half-Open): 在熔断开å�¯ä¸€æ®µæ—¶é—´ä¹‹å�Žï¼Œç†”断器会进入å�Šç†”断状æ€�。在å�Šç†”断状æ€�下,熔断器会å°�试æ�¢å¤�æœ�务调用方对æœ�务的调用,å…�许部分请求调用该æœ�务,并监控其调用æˆ�功率。如果æˆ�功率达到预期,则说明æœ�务已æ�¢å¤�正常,熔断器进入关闭状æ€�;如果æˆ�功率ä»�旧很低,则é‡�新进入熔断开å�¯çжæ€�。 -ÈýÖÖÈÛ¶Ï״̬֮¼äµÄת»¯¹ØÏµÈçÏÂͼ£º +三ç§�熔断状æ€�之间的转化关系如下图: -![ÈÛ¶Ï״̬ת»»](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10162355X-7.png) -ͼ8£ºÈýÖÖÈÛ¶Ï״̬ת»» +![熔断状æ€�转æ�¢](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10162355X-7.png) +图8:三ç§�熔断状æ€�转æ�¢ -#### Hystrix ʵÏÖÈÛ¶Ï»úÖÆ +#### Hystrix 实现熔断机制 -ÔÚ Spring Cloud ÖУ¬ÈÛ¶Ï»úÖÆÊÇͨ¹ý Hystrix ʵÏֵġ£Hystrix »á¼à¿ØÎ¢·þÎñ¼äµ÷ÓõÄ×´¿ö£¬µ±Ê§°Üµ÷Óõ½Ò»¶¨±ÈÀýʱ£¨ÀýÈç 5 ÃëÄÚʧ°Ü 20 ´Î£©£¬¾Í»áÆô¶¯ÈÛ¶Ï»úÖÆ¡£ +在 Spring Cloud 中,熔断机制是通过 Hystrix 实现的。Hystrix 会监控微æœ�务间调用的状况,当失败调用到一定比例时(例如 5 秒内失败 20 次),就会å�¯åŠ¨ç†”æ–­æœºåˆ¶ã€‚ -Hystrix ʵÏÖ·þÎñÈ۶ϵIJ½ÖèÈçÏ£º +Hystrix 实现æœ�务熔断的步骤如下: -1. µ±·þÎñµÄµ÷Óóö´íÂÊ´ïµ½»ò³¬¹ý Hystix ¹æ¶¨µÄ±ÈÂÊ£¨Ä¬ÈÏΪ 50%£©ºó£¬ÈÛ¶ÏÆ÷½øÈëÈÛ¶Ï¿ªÆô״̬¡£ -2. ÈÛ¶ÏÆ÷½øÈëÈÛ¶Ï¿ªÆô״̬ºó£¬Hystrix »áÆô¶¯Ò»¸öÐÝÃßʱ¼ä´°£¬ÔÚÕâ¸öʱ¼ä´°ÄÚ£¬¸Ã·þÎñµÄ½µ¼¶Âß¼­»áÁÙʱ³äµ±ÒµÎñÖ÷Âß¼­£¬¶øÔ­À´µÄÒµÎñÖ÷Âß¼­²»¿ÉÓᣠ-3. µ±ÓÐÇëÇóÔٴε÷Óø÷þÎñʱ£¬»áÖ±½Óµ÷Óýµ¼¶Âß¼­¿ìËٵطµ»ØÊ§°ÜÏìÓ¦£¬ÒÔ±ÜÃâϵͳѩ±À¡£ -4. µ±ÐÝÃßʱ¼ä´°µ½ÆÚºó£¬Hystrix »á½øÈë°ëÈÛ¶Ïת̬£¬ÔÊÐí²¿·ÖÇëÇó¶Ô·þÎñÔ­À´µÄÖ÷ÒµÎñÂß¼­½øÐе÷Ó㬲¢¼à¿ØÆäµ÷Óóɹ¦ÂÊ¡£ -5. Èç¹ûµ÷Óóɹ¦ÂÊ´ïµ½Ô¤ÆÚ£¬Ôò˵Ã÷·þÎñÒѻָ´Õý³££¬Hystrix ½øÈëÈ۶ϹرÕ״̬£¬·þÎñÔ­À´µÄÖ÷ÒµÎñÂß¼­»Ö¸´£»·ñÔò Hystrix ÖØÐ½øÈëÈÛ¶Ï¿ªÆô״̬£¬ÐÝÃßʱ¼ä´°¿ÚÖØÐ¼ÆÊ±£¬¼ÌÐøÖØ¸´µÚ 2 µ½µÚ 5 ²½¡£ +1. 当æœ�务的调用出错率达到或超过 Hystix 规定的比率(默认为 50%)å�Žï¼Œç†”断器进入熔断开å�¯çжæ€�。 +2. 熔断器进入熔断开å�¯çжæ€�å�Žï¼ŒHystrix 会å�¯åŠ¨ä¸€ä¸ªä¼‘çœ æ—¶é—´çª—ï¼Œåœ¨è¿™ä¸ªæ—¶é—´çª—å†…ï¼Œè¯¥æœ�务的é™�级逻辑会临时充当业务主逻辑,而原æ�¥çš„业务主逻辑ä¸�å�¯ç”¨ã€‚ +3. 当有请求å†�次调用该æœ�务时,会直接调用é™�级逻辑快速地返回失败å“�应,以é�¿å…�系统雪崩。 +4. 当休眠时间窗到期å�Žï¼ŒHystrix 会进入å�Šç†”断转æ€�,å…�许部分请求对æœ�务原æ�¥çš„主业务逻辑进行调用,并监控其调用æˆ�功率。 +5. 如果调用æˆ�功率达到预期,则说明æœ�务已æ�¢å¤�正常,Hystrix 进入熔断关闭状æ€�,æœ�务原æ�¥çš„主业务逻辑æ�¢å¤�ï¼›å�¦åˆ™ Hystrix é‡�新进入熔断开å�¯çжæ€�,休眠时间窗å�£é‡�新计时,继续é‡�å¤�第 2 到第 5 步。 -#### ʾÀý +#### 示例 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀýÀ´Ñé֤ϠHystrix ÊÇÈçºÎʵÏÖÈÛ¶Ï»úÖÆµÄ¡£ +下é�¢æˆ‘们就通过一个实例æ�¥éªŒè¯�下 Hystrix 是如何实现熔断机制的。 -1\. ÔÚ micro-service-cloud-provider-dept-hystrix-8004 ÖÐµÄ DeptService ½Ó¿ÚÖÐÌí¼ÓÒ»¸ö deptCircuitBreaker() ·½·¨£¬´úÂëÈçÏ¡£ +1\. 在 micro-service-cloud-provider-dept-hystrix-8004 中的 DeptService 接å�£ä¸­æ·»åŠ ä¸€ä¸ª deptCircuitBreaker() 方法,代ç �如下。 @@ -813,12 +813,12 @@ Hystrix ʵ package net.biancheng.c.service; public interface DeptService { - // hystrix ÈÛ¶ÏÆ÷ʾÀý ok + // hystrix 熔断器示例 ok public String deptInfo_Ok(Integer id); - //hystrix ÈÛ¶ÏÆ÷³¬Ê±°¸Àý + //hystrix 熔断器超时案例 public String deptInfo_Timeout(Integer id); - // Hystrix ÈÛ¶Ï»úÖÆ°¸Àý + // Hystrix 熔断机制案例 public String deptCircuitBreaker(Integer id); } @@ -828,35 +828,35 @@ public interface DeptService { -2\. ÔÚ DeptService ½Ó¿ÚµÄʵÏÖÀà DeptServiceImpl Ìí¼Ó deptCircuitBreaker() µÄ·½·¨ÊµÏÖ¼°Æä»ØÍË·½·¨£¬´úÂëÈçÏ¡£ +2\. 在 DeptService 接å�£çš„实现类 DeptServiceImpl 添加 deptCircuitBreaker() 的方法实现å�Šå…¶å›žé€€æ–¹æ³•,代ç �如下。 ``` -//Hystrix È۶ϰ¸Àý +//Hystrix 熔断案例 @Override @HystrixCommand(fallbackMethod = "deptCircuitBreaker_fallback", commandProperties = { - //ÒÔϲÎÊýÔÚ HystrixCommandProperties ÀàÖÐÓÐĬÈÏÅäÖà - @HystrixProperty(name = "circuitBreaker.enabled", value = "true"), //ÊÇ·ñ¿ªÆôÈÛ¶ÏÆ÷ - @HystrixProperty(name = "metrics.rollingStats.timeInMilliseconds",value = "1000"), //ͳ¼ÆÊ±¼ä´° - @HystrixProperty(name = "circuitBreaker.requestVolumeThreshold", value = "10"), //ͳ¼ÆÊ±¼ä´°ÄÚÇëÇó´ÎÊý - @HystrixProperty(name = "circuitBreaker.sleepWindowInMilliseconds", value = "10000"), //ÐÝÃßʱ¼ä´°¿ÚÆÚ - @HystrixProperty(name = "circuitBreaker.errorThresholdPercentage", value = "60"), //ÔÚͳ¼ÆÊ±¼ä´°¿ÚÆÚÒÔÄÚ£¬ÇëÇóʧ°ÜÂÊ´ïµ½ 60% ʱ½øÈëÈÛ¶Ï״̬ + //以下å�‚数在 HystrixCommandProperties 类中有默认é…�ç½® + @HystrixProperty(name = "circuitBreaker.enabled", value = "true"), //是å�¦å¼€å�¯ç†”断器 + @HystrixProperty(name = "metrics.rollingStats.timeInMilliseconds",value = "1000"), //统计时间窗 + @HystrixProperty(name = "circuitBreaker.requestVolumeThreshold", value = "10"), //统计时间窗内请求次数 + @HystrixProperty(name = "circuitBreaker.sleepWindowInMilliseconds", value = "10000"), //休眠时间窗å�£æœŸ + @HystrixProperty(name = "circuitBreaker.errorThresholdPercentage", value = "60"), //在统计时间窗å�£æœŸä»¥å†…,请求失败率达到 60% 时进入熔断状æ€� }) public String deptCircuitBreaker(Integer id) { if (id < 0) { - //µ±´«ÈëµÄ id Ϊ¸ºÊýʱ£¬Å׳öÒì³££¬µ÷Óýµ¼¶·½·¨ - throw new RuntimeException("cÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬id ²»ÄÜÊǸºÊý£¡"); + //当传入的 id 为负数时,抛出异常,调用é™�级方法 + throw new RuntimeException("c语言中文网æ��醒您,id ä¸�能是负数ï¼�"); } String serialNum = IdUtil.simpleUUID(); - return Thread.currentThread().getName() + "\t" + "µ÷Óóɹ¦£¬Á÷Ë®ºÅΪ£º" + serialNum; + return Thread.currentThread().getName() + "\t" + "调用æˆ�功,æµ�æ°´å�·ä¸ºï¼š" + serialNum; } -//deptCircuitBreaker µÄ½µ¼¶·½·¨ +//deptCircuitBreaker çš„é™�级方法 public String deptCircuitBreaker_fallback(Integer id) { - return "cÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬id ²»ÄÜÊǸºÊý,ÇëÉÔºóÖØÊÔ!\t id:" + id; + return "c语言中文网æ��醒您,id ä¸�能是负数,请ç¨�å�Žé‡�试!\t id:" + id; } ``` @@ -865,16 +865,16 @@ public String deptCircuitBreaker_fallback(Integer id) { -ÔÚÒÔÉÏ´úÂëÖУ¬¹²Éæ¼°µ½ÁË 4 ¸öÓë Hystrix ÈÛ¶Ï»úÖÆÏà¹ØµÄÖØÒª²ÎÊý£¬Õâ 4 ¸ö²ÎÊýµÄº¬ÒåÈçÏÂ±í¡£ +在以上代ç �中,共涉å�Šåˆ°äº† 4 个与 Hystrix 熔断机制相关的é‡�è¦�å�‚数,这 4 个å�‚æ•°çš„å�«ä¹‰å¦‚下表。 -| ²ÎÊý | ÃèÊö | +| å�‚æ•° | æ��è¿° | | ---------------------------------------- | ------------------------------------------------------------ | -| metrics.rollingStats.timeInMilliseconds | ͳ¼ÆÊ±¼ä´°¡£ | -| circuitBreaker.sleepWindowInMilliseconds | ÐÝÃßʱ¼ä´°£¬ÈÛ¶Ï¿ªÆô״̬³ÖÐøÒ»¶Îʱ¼äºó£¬ÈÛ¶ÏÆ÷»á×Ô¶¯½øÈë°ëÈÛ¶Ï״̬£¬Õâ¶Îʱ¼ä¾Í±»³ÆÎªÐÝÃß´°¿ÚÆÚ¡£ | -| circuitBreaker.requestVolumeThreshold | ÇëÇó×ÜÊý·§Öµ¡£ÔÚͳ¼ÆÊ±¼ä´°ÄÚ£¬ÇëÇó×ÜÊý±ØÐëµ½´ïÒ»¶¨µÄÊýÁ¿¼¶£¬Hystrix ²Å¿ÉÄܻὫÈÛ¶ÏÆ÷´ò¿ª½øÈëÈÛ¶Ï¿ªÆôת̬£¬¶øÕâ¸öÇëÇóÊýÁ¿¼¶¾ÍÊÇ ÇëÇó×ÜÊý·§Öµ¡£Hystrix ÇëÇó×ÜÊýãÐֵĬÈÏΪ 20£¬Õâ¾ÍÒâζ×ÅÔÚͳ¼ÆÊ±¼ä´°ÄÚ£¬Èç¹û·þÎñµ÷ÓôÎÊý²»×ã 20 ´Î£¬¼´Ê¹ËùÓеÄÇëÇó¶¼µ÷Óóö´í£¬ÈÛ¶ÏÆ÷Ò²²»»á´ò¿ª¡£ | -| circuitBreaker.errorThresholdPercentage | ´íÎó°Ù·Ö±ÈãÐÖµ¡£µ±ÇëÇó×ÜÊýÔÚͳ¼ÆÊ±¼ä´°ÄÚ³¬¹ýÁËÇëÇó×ÜÊý·§Öµ£¬ÇÒÇëÇóµ÷Óóö´íÂʳ¬¹ýÒ»¶¨µÄ±ÈÀý£¬ÈÛ¶ÏÆ÷²Å»á´ò¿ª½øÈëÈÛ¶Ï¿ªÆôת̬£¬¶øÕâ¸ö±ÈÀý¾ÍÊÇ´íÎó°Ù·Ö±ÈãÐÖµ¡£´íÎó°Ù·Ö±ÈãÐÖµÉèÖÃΪ 50£¬¾Í±íʾ´íÎó°Ù·Ö±ÈΪ 50%£¬Èç¹û·þÎñ·¢ÉúÁË 30 ´Îµ÷Óã¬ÆäÖÐÓÐ 15 ´Î·¢ÉúÁË´íÎ󣬼´³¬¹ýÁË 50% µÄ´íÎó°Ù·Ö±È£¬Õâʱºò½«ÈÛ¶ÏÆ÷¾Í»á´ò¿ª¡£ | +| metrics.rollingStats.timeInMilliseconds | 统计时间窗。 | +| circuitBreaker.sleepWindowInMilliseconds | 休眠时间窗,熔断开å�¯çжæ€�æŒ�续一段时间å�Žï¼Œç†”断器会自动进入å�Šç†”断状æ€�,这段时间就被称为休眠窗å�£æœŸã€‚ | +| circuitBreaker.requestVolumeThreshold | 请求总数阀值。在统计时间窗内,请求总数必须到达一定的数é‡�级,Hystrix æ‰�å�¯èƒ½ä¼šå°†ç†”断器打开进入熔断开å�¯è½¬æ€�,而这个请求数é‡�级就是 请求总数阀值。Hystrix 请求总数阈值默认为 20,这就æ„�味ç�€åœ¨ç»Ÿè®¡æ—¶é—´çª—内,如果æœ�务调用次数ä¸�è¶³ 20 次,å�³ä½¿æ‰€æœ‰çš„请求都调用出错,熔断器也ä¸�会打开。 | +| circuitBreaker.errorThresholdPercentage | 错误百分比阈值。当请求总数在统计时间窗内超过了请求总数阀值,且请求调用出错率超过一定的比例,熔断器æ‰�会打开进入熔断开å�¯è½¬æ€�,而这个比例就是错误百分比阈值。错误百分比阈值设置为 50,就表示错误百分比为 50%,如果æœ�务å�‘生了 30 次调用,其中有 15 次å�‘生了错误,å�³è¶…过了 50% 的错误百分比,这时候将熔断器就会打开。 | -3\. ÔÚ DeptController ÖÐÌí¼ÓÒ»¸ö deptCircuitBreaker() ·½·¨¶ÔÍâÌṩ·þÎñ£¬´úÂëÈçÏ¡£ +3\. 在 DeptController 中添加一个 deptCircuitBreaker() 方法对外æ��ä¾›æœ�务,代ç �如下。 @@ -882,7 +882,7 @@ public String deptCircuitBreaker_fallback(Integer id) { ``` -// Hystrix ·þÎñÈÛ¶Ï +// Hystrix æœ�务熔断 @RequestMapping(value = "/dept/hystrix/circuit/{id}") public String deptCircuitBreaker(@PathVariable("id") Integer id){ String result = deptService.deptCircuitBreaker(id); @@ -896,37 +896,37 @@ public String deptCircuitBreaker(@PathVariable("id") Integer id){ -4\. ÖØÆô micro-service-cloud-provider-dept-hystrix-8004£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/circuit/1¡±£¬½á¹ûÈçÏÂͼ¡£ +4\. é‡�å�¯ micro-service-cloud-provider-dept-hystrix-8004,使用æµ�览器访问“http://eureka7001.com:8004/dept/hystrix/circuit/1â€�,结果如下图。 -![Hystrix ʵÏÖÈÛ¶Ï»úÖÆ µ÷ÓÃÕýÈ·](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016233Q8-8.png) -ͼ9£ºHystrix ʵÏÖÈÛ¶Ï»úÖÆ µ÷ÓÃÕýȷʾÀý +![Hystrix 实现熔断机制 调用正确](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016233Q8-8.png) +图9:Hystrix 实现熔断机制 调用正确示例 -5\. ä¯ÀÀÆ÷¶à´Î£¨µ÷ÓôÎÊý´óÓÚÇëÇó×ÜÊý·§Öµ£©·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/circuit/-2¡±£¬Ê¹µ÷Óóö´íÂÊ´óÓÚ´íÎó°Ù·Ö±È·§Öµ£¬½á¹ûÏÂͼ¡£ +5\. æµ�览器多次(调用次数大于请求总数阀值)访问“http://eureka7001.com:8004/dept/hystrix/circuit/-2â€�,使调用出错率大于错误百分比阀值,结果下图。 -![Hystrix ʵÏÖÈÛ¶Ï»úÖÆ ´íÎóµ÷ÓÃ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10162332D-9.png) -ͼ10£ºHystrix ʵÏÖÈÛ¶Ï»úÖÆ ´íÎóµ÷Óà +![Hystrix 实现熔断机制 错误调用](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10162332D-9.png) +图10:Hystrix 实现熔断机制 错误调用 -6\. ÖØÐ½«²ÎÊýÐÞ¸ÄΪÕýÊý£¨ÀýÈç²ÎÊýΪ 3£©£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/circuit/3¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. é‡�æ–°å°†å�‚数修改为正数(例如å�‚数为 3),使用æµ�览器访问“http://eureka7001.com:8004/dept/hystrix/circuit/3â€�,结果如下图。 -![Hystrix ÈÛ¶Ï¿ªÆôת̨](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016235592-10.png) -ͼ11£ºHystrix ÈÛ¶Ï¿ªÆô״̬´«ÈëÕýÊý +![Hystrix 熔断开å�¯è½¬å�°](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016235592-10.png) +图11:Hystrix 熔断开å�¯çжæ€�传入正数 -ͨ¹ýͼ 11 ¿ÉÒÔ¿´µ½£¬ÔÚÈÛ¶Ï¿ªÆô״̬Ï£¬¼´Ê¹ÎÒÃÇ´«ÈëµÄ²ÎÊýÒѾ­ÊÇÕýÊý£¬µ÷ÓõÄÒÀÈ»½µ¼¶Âß¼­¡£ +通过图 11 å�¯ä»¥çœ‹åˆ°ï¼Œåœ¨ç†”æ–­å¼€å�¯çжæ€�下,å�³ä½¿æˆ‘们传入的å�‚æ•°å·²ç»�是正数,调用的ä¾�ç„¶é™�级逻辑。 -7\. ¼ÌÐøÁ¬Ðø·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/circuit/3¡±£¬½á¹ûÏÂͼ¡£ +7\. 继续连续访问“http://eureka7001.com:8004/dept/hystrix/circuit/3â€�,结果下图。 -![Hystrix È۶ϹرÕ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016231R0-11.gif) -ͼ12£ºHystrix ½øÈëÈ۶ϹرÕ״̬ +![Hystrix 熔断关闭](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016231R0-11.gif) +图12:Hystrix 进入熔断关闭状æ€� -ͨ¹ýͼ 12 ¿ÉÒÔ¿´³ö£¬µ±·þÎñµ÷ÓÃÕýÈ·ÂÊÉÏÉýµ½Ò»¶¨µÄÀûÂʺó£¬Hystrix ½øÈëÈ۶ϹرÕ״̬¡£ +通过图 12 å�¯ä»¥çœ‹å‡ºï¼Œå½“æœ�务调用正确率上å�‡åˆ°ä¸€å®šçš„利率å�Žï¼ŒHystrix 进入熔断关闭状æ€�。 -## Hystrix ¹ÊÕÏ¼à¿Ø +## Hystrix 故障监控 -Hystrix »¹ÌṩÁË׼ʵʱµÄµ÷ÓÃ¼à¿Ø£¨Hystrix Dashboard£©¹¦ÄÜ£¬Hystrix »á³ÖÐøµØ¼Ç¼ËùÓÐͨ¹ý Hystrix ·¢ÆðµÄÇëÇóµÄÖ´ÐÐÐÅÏ¢£¬²¢ÒÔͳ¼Æ±¨±íµÄÐÎʽչʾ¸øÓû§£¬°üÀ¨Ã¿ÃëÖ´ÐÐÇëÇóµÄÊýÁ¿¡¢³É¹¦ÇëÇóµÄÊýÁ¿ºÍʧ°ÜÇëÇóµÄÊýÁ¿µÈ¡£ +Hystrix 还æ��供了准实时的调用监控(Hystrix Dashboard)功能,Hystrix 会æŒ�续地记录所有通过 Hystrix å�‘起的请求的执行信æ�¯ï¼Œå¹¶ä»¥ç»Ÿè®¡æŠ¥è¡¨çš„å½¢å¼�展示给用户,包括æ¯�秒执行请求的数é‡�ã€�æˆ�功请求的数é‡�和失败请求的数é‡�等。 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀýÀ´´î½¨ Hystrix Dashboard£¬¼à¿Ø micro-service-cloud-provider-dept-hystrix-8004 µÄÔËÐÐÇé¿ö¡£ +下é�¢æˆ‘们就通过一个实例æ�¥æ�­å»º Hystrix Dashboard,监控 micro-service-cloud-provider-dept-hystrix-8004 çš„è¿�行情况。 -1\. ÔÚ¸¸¹¤³ÌÏÂн¨Ò»¸öÃûΪ micro-service-cloud-consumer-dept-hystrix-dashboard-9002 µÄ×ÓÄ£¿é£¬²¢ÔÚÆä pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ¡£ +1\. 在父工程下新建一个å��为 micro-service-cloud-consumer-dept-hystrix-dashboard-9002 çš„å­�模å�—,并在其 pom.xml 中添加以下ä¾�赖。 @@ -956,18 +956,18 @@ Hystrix org.springframework.boot spring-boot-starter - + org.springframework.boot spring-boot-starter-test test - + org.springframework.cloud spring-cloud-starter-netflix-hystrix-dashboard - + org.springframework.boot spring-boot-starter-actuator @@ -998,7 +998,7 @@ Hystrix -2\. ÔÚ micro-service-cloud-consumer-dept-hystrix-dashboard-9002 µÄ application.yml ÖÐÌí¼ÓÒÔÏÂÅäÖᣠ+2\. 在 micro-service-cloud-consumer-dept-hystrix-dashboard-9002 çš„ application.yml 中添加以下é…�置。 @@ -1007,10 +1007,10 @@ Hystrix ``` server: - port: 9002 #¶Ë¿ÚºÅ + port: 9002 #端å�£å�· -#http://eureka7001.com:9002/hystrix ÈÛ¶ÏÆ÷¼à¿ØÒ³Ãæ -# localhost:8004//actuator/hystrix.stream ¼à¿ØµØÖ· +#http://eureka7001.com:9002/hystrix 熔断器监控页é�¢ +# localhost:8004//actuator/hystrix.stream 监控地å�€ hystrix: dashboard: proxy-stream-allow-list: @@ -1022,7 +1022,7 @@ hystrix: -3\. ÔÚ micro-service-cloud-consumer-dept-hystrix-dashboard-9002 µÄÖ÷Æô¶¯ÀàÉÏÌí¼Ó @EnableHystrixDashboard ×¢½â£¬¿ªÆô Hystrix ¼à¿Ø¹¦ÄÜ£¬´úÂëÈçÏ¡£ +3\. 在 micro-service-cloud-consumer-dept-hystrix-dashboard-9002 的主å�¯åŠ¨ç±»ä¸Šæ·»åŠ  @EnableHystrixDashboard 注解,开å�¯ Hystrix 监控功能,代ç �如下。 @@ -1052,7 +1052,7 @@ public class MicroServiceCloudConsumerDeptHystrixDashboard9002Application { -4\. ÔÚ micro-service-cloud-provider-dept-hystrix-8004 µÄ net.biancheng.c.config °üÏ£¬´´½¨Ò»¸öÃûΪ HystrixDashboardConfig µÄÅäÖÃÀ࣬´úÂëÈçÏ¡£ +4\. 在 micro-service-cloud-provider-dept-hystrix-8004 çš„ net.biancheng.c.config 包下,创建一个å��为 HystrixDashboardConfig çš„é…�置类,代ç �如下。 @@ -1070,7 +1070,7 @@ import org.springframework.context.annotation.Configuration; @Configuration public class HystrixDashboardConfig { /** - * Hystrix dashboard ¼à¿Ø½çÃæ±ØÐëÅäÖà + * Hystrix dashboard 监控界é�¢å¿…é¡»é…�ç½® * @return */ @Bean @@ -1078,7 +1078,7 @@ public class HystrixDashboardConfig { HystrixMetricsStreamServlet streamServlet = new HystrixMetricsStreamServlet(); ServletRegistrationBean registrationBean = new ServletRegistrationBean(streamServlet); registrationBean.setLoadOnStartup(1); - registrationBean.addUrlMappings("/actuator/hystrix.stream");//·ÃÎÊ·¾¶ + registrationBean.addUrlMappings("/actuator/hystrix.stream");//访问路径 registrationBean.setName("hystrix.stream"); return registrationBean; } @@ -1091,27 +1091,27 @@ public class HystrixDashboardConfig { -5\. Æô¶¯ micro-service-cloud-consumer-dept-hystrix-dashboard-9002£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:9002/hystrix¡±£¬½á¹ûÈçÏÂͼ¡£ +5\. å�¯åЍ micro-service-cloud-consumer-dept-hystrix-dashboard-9002,使用æµ�览器访问“http://eureka7001.com:9002/hystrixâ€�,结果如下图。 -![Hystrix ¼à¿Ø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016234440-12.png) -ͼ13£ºHystrix ¼à¿ØÒ³Ãæ +![Hystrix 监控](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016234440-12.png) +图13:Hystrix 监控页é�¢ -6\. ÖØÆô micro-service-cloud-provider-dept-hystrix-8004£¬²¢½«ÒÔÏÂÐÅÏ¢Ìîµ½ Hystrix ¼à¿ØÒ³ÃæÖУ¬ÈçÏÂͼ¡£ +6\. é‡�å�¯ micro-service-cloud-provider-dept-hystrix-8004,并将以下信æ�¯å¡«åˆ° Hystrix 监控页é�¢ä¸­ï¼Œå¦‚下图。 -![Hystrix ¼à¿ØÐÅÏ¢](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016232636-13.png) -ͼ14£ºHystrix ¼à¿ØÐÅÏ¢ +![Hystrix 监控信æ�¯](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016232636-13.png) +图14:Hystrix 监控信æ�¯ -7\. µã»÷Ï·½µÄ Monitor Stream °´Å¥£¬Ìø×ªµ½ Hystrix ¶Ô micro-service-cloud-provider-dept-hystrix-8004 µÄ¼à¿ØÒ³Ã棬ÈçÏÂͼ¡£ +7\. 点击下方的 Monitor Stream 按钮,跳转到 Hystrix 对 micro-service-cloud-provider-dept-hystrix-8004 的监控页é�¢ï¼Œå¦‚下图。 -![Hystrix ¼à¿Ø 8004](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016231229-14.png) -ͼ15£ºHystrix ¼à¿ØÎ¢·þÎñÔËÐÐÇé¿ö +![Hystrix 监控 8004](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1016231229-14.png) +图15:Hystrix 监控微æœ�务è¿�行情况 -8\. ʹÓÃä¯ÀÀÆ÷¶à´Î·ÃÎÊ¡°http://eureka7001.com:8004/dept/hystrix/circuit/1¡±ºÍ ¡°http://eureka7001.com:8004/dept/hystrix/circuit/-1¡±£¬²é¿´ Hystrix ¼à¿ØÒ³Ã棬ÈçÏÂͼ¡£ +8\. 使用æµ�览器多次访问“http://eureka7001.com:8004/dept/hystrix/circuit/1â€�å’Œ “http://eureka7001.com:8004/dept/hystrix/circuit/-1â€�,查看 Hystrix 监控页é�¢ï¼Œå¦‚下图。 -![Hystrix ¼à¿Ø 8004 ÔËÐÐÇé¿ö](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10162345J-15.png) -ͼ16£ºHystrix ¼à¿Ø·þÎñÔËÐÐÇé¿ö +![Hystrix 监控 8004 è¿�行情况](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10162345J-15.png) +图16:Hystrix 监控æœ�务è¿�行情况 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudLoadBalancer.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudLoadBalancer.md" index 1a35579..b48ae50 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudLoadBalancer.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudLoadBalancer.md" @@ -1,18 +1,18 @@ -ǰ²»¾Ã£¬ÎÒ°ÑMall΢·þÎñ°æ±¾È«ÃæÉý¼¶ÁË £¬ÔÚͨ¹ýGatewayÍø¹Øµ÷ÓÃÆäËû·þÎñµÄʱºò£¬³öÏÖÁËService UnavailableµÄÎÊÌâ¡£ÅŲéÔ­Òòʱ·¢ÏÖ×÷Ϊ¸ºÔؾùºâ×é¼þµÄRibbon±»ÆúÓÃÁË£¬×÷ΪNetflix¿ªÔ´µÄÒ»¸ö×é¼þ£¬RibbonÔçÒѽøÈëά»¤×´Ì¬¡£ÏÖÔÚÍÆ¼öʹÓõÄÊÇLoadbalancer£¬½ñÌìÎÒÃǾÍÀ´ÁÄÁÄLoadbalancerµÄʹÓã¡ +å‰�ä¸�久,我把Mallå¾®æœ�务版本全é�¢å�‡çº§äº† ,在通过Gateway网关调用其他æœ�务的时候,出现了Service Unavailable的问题。排查原因时å�‘现作为负载å�‡è¡¡ç»„ä»¶çš„Ribbon被弃用了,作为Netflixå¼€æº�的一个组件,Ribbon早已进入维护状æ€�。现在推è��使用的是Loadbalancer,今天我们就æ�¥è�Šè�ŠLoadbalancer的使用ï¼� -# LoadBalancer¼ò½é +# LoadBalancer简介 -LoadBalancerÊÇSpring Cloud¹Ù·½ÌṩµÄ¸ºÔؾùºâ×é¼þ£¬¿ÉÓÃÓÚÌæ´úRibbon¡£ÆäʹÓ÷½Ê½ÓëRibbon»ù±¾¼æÈÝ£¬¿ÉÒÔ´ÓRibbon½øÐÐÆ½»¬¹ý¶É¡£ +LoadBalancer是Spring Cloud官方æ��供的负载å�‡è¡¡ç»„件,å�¯ç”¨äºŽæ›¿ä»£Ribbon。其使用方å¼�与Ribbon基本兼容,å�¯ä»¥ä»ŽRibbon进行平滑过渡。 -# ʹÓà +# 使用 -ÏÂÃæ½éÉÜÏÂLoadBalancerµÄ»ù±¾Ê¹Óã¬ÎÒÃǽ«Ê¹ÓÃNacos×÷Ϊע²áÖÐÐÄ£¬Í¨¹ýnacos-loadbalancer-serviceºÍnacos-user-serviceÁ½¸ö·þÎñ¼äµÄÏ໥µ÷ÓÃÀ´½øÐÐÑÝʾ¡£ +下é�¢ä»‹ç»�下LoadBalancer的基本使用,我们将使用Nacos作为注册中心,通过nacos-loadbalancer-serviceå’Œnacos-user-service两个æœ�务间的相互调用æ�¥è¿›è¡Œæ¼”示。 -# ¸ºÔؾùºâ +# è´Ÿè½½å�‡è¡¡ -ÎÒÃǽ«Ê¹ÓÃRestTemplateÀ´ÑÝʾÏÂLoadBalancerµÄ¸ºÔؾùºâ¹¦ÄÜ¡£ +我们将使用RestTemplateæ�¥æ¼”示下LoadBalancer的负载å�‡è¡¡åŠŸèƒ½ã€‚ -- Ê×ÏÈÔÚnacos-loadbalancer-serviceÄ£¿éµÄpom.xmlÎļþÖÐÌí¼ÓLoadBalancerÏà¹ØÒÀÀµ£» +- 首先在nacos-loadbalancer-service模å�—çš„pom.xml文件中添加LoadBalancer相关ä¾�èµ–ï¼› @@ -25,12 +25,12 @@ LoadBalancer -- È»ºó´´½¨JavaÅäÖÃÀ࣬ÓÃÓÚÅäÖÃRestTemplate£¬Í¬Ê±Ê¹ÓÃ@LoadBalanced×¢½â¸³ÓèÆä¸ºÔؾùºâÄÜÁ¦£» +- ç„¶å�Žåˆ›å»ºJavaé…�置类,用于é…�ç½®RestTemplate,å�Œæ—¶ä½¿ç”¨@LoadBalanced注解赋予其负载å�‡è¡¡èƒ½åŠ›ï¼› /** - * RestTemplateÏà¹ØÅäÖà + * RestTemplate相关é…�ç½® * Created by macro on 2019/8/29. */ @Configuration @@ -53,20 +53,20 @@ LoadBalancer -- ÔÚapplication.ymlÖпÉÒÔʹÓÃ×Ô¶¨ÒåÅäÖöÔRestTemplateµÄµ÷Óó¬Ê±½øÐÐÅäÖã» +- 在application.yml中å�¯ä»¥ä½¿ç”¨è‡ªå®šä¹‰é…�置对RestTemplate的调用超时进行é…�置; rest: template: - config: # RestTemplateµ÷Óó¬Ê±ÅäÖà + config: # RestTemplate调用超时é…�ç½® connectTimeout: 5000 readTimeout: 5000 -- È»ºóÔÚControllerÖÐʹÓÃRestTemplate½øÐÐÔ¶³Ìµ÷Óã» +- ç„¶å�Žåœ¨Controller中使用RestTemplate进行远程调用; @@ -97,7 +97,7 @@ LoadBalancer if (entity.getStatusCode().is2xxSuccessful()) { return entity.getBody(); } else { - return new CommonResult("²Ù×÷ʧ°Ü", 500); + return new CommonResult("æ“�作失败", 500); } } @@ -120,23 +120,23 @@ LoadBalancer -- ÔÚnacos-user-serviceÖÐÎÒÃÇÒѾ­ÊµÏÖÁËÕâЩ½Ó¿Ú£¬¿ÉÒÔÌṩ¸ønacos-loadbalancer-service·þÎñ½øÐÐÔ¶³Ìµ÷Óã» +- 在nacos-user-service中我们已ç»�实现了这些接å�£ï¼Œå�¯ä»¥æ��供给nacos-loadbalancer-serviceæœ�务进行远程调用; -- È»ºóÆô¶¯Ò»¸önacos-loadbalancer-service£¬ºÍÁ½¸önacos-user-service£¬´ËʱNacosÖлáÏÔʾÈçÏ·þÎñ£» +- ç„¶å�Žå�¯åŠ¨ä¸€ä¸ªnacos-loadbalancer-service,和两个nacos-user-service,此时Nacos中会显示如下æœ�务; -- ´Ëʱͨ¹ýnacos-loadbalancer-serviceµ÷ÓýӿڽøÐвâÊÔ£¬»á·¢ÏÖÁ½¸önacos-user-service½»Ìæ´òÓ¡ÈÕÖ¾ÐÅÏ¢£¬Ê¹ÓõÄÊÇÂÖѯ²ßÂÔ£¬·ÃÎʵØÖ·£ºhttp://localhost:8308/user/1 +- 此时通过nacos-loadbalancer-service调用接å�£è¿›è¡Œæµ‹è¯•,会å�‘现两个nacos-user-service交替打å�°æ—¥å¿—ä¿¡æ�¯ï¼Œä½¿ç”¨çš„æ˜¯è½®è¯¢ç­–略,访问地å�€ï¼šhttp://localhost:8308/user/1 -# ÉùÃ÷ʽ·þÎñµ÷Óà +# 声明å¼�æœ�务调用 -µ±È»LoadBalancer³ýÁËʹÓÃRestTemplateÀ´½øÐÐÔ¶³Ìµ÷Ó㬻¹¿ÉÒÔʹÓÃOpenFeignÀ´½øÐÐÉùÃ÷ʽ·þÎñµ÷Óã¬ÏÂÃæÎÒÃǾÍÀ´½éÉÜÏ¡£ +当然LoadBalancer除了使用RestTemplateæ�¥è¿›è¡Œè¿œç¨‹è°ƒç”¨ï¼Œè¿˜å�¯ä»¥ä½¿ç”¨OpenFeignæ�¥è¿›è¡Œå£°æ˜Žå¼�æœ�务调用,下é�¢æˆ‘们就æ�¥ä»‹ç»�下。 -- Ê×ÏÈnacos-loadbalancer-serviceÄ£¿éµÄpom.xmlÎļþÖÐÌí¼ÓOpenFeignµÄÏà¹ØÒÀÀµ£» +- 首先nacos-loadbalancer-service模å�—çš„pom.xml文件中添加OpenFeign的相关ä¾�èµ–ï¼› @@ -149,7 +149,7 @@ LoadBalancer -- È»ºóÔÚOpenFeignµÄ¿Í»§¶Ë½Ó¿ÚÖÐÉùÃ÷ºÃÐèÒªµ÷ÓõķþÎñ½Ó¿ÚÒÔ¼°µ÷Ó÷½Ê½£» +- ç„¶å�Žåœ¨OpenFeign的客户端接å�£ä¸­å£°æ˜Žå¥½éœ€è¦�调用的æœ�务接å�£ä»¥å�Šè°ƒç”¨æ–¹å¼�ï¼› @@ -176,7 +176,7 @@ LoadBalancer -- ÔÙÔÚControllerÖÐʹÓÃOpenFeignµÄ¿Í»§¶Ë½Ó¿ÚÀ´µ÷ÓÃÔ¶³Ì·þÎñ£» +- å†�在Controller中使用OpenFeign的客户端接å�£æ�¥è°ƒç”¨è¿œç¨‹æœ�务; @@ -219,52 +219,52 @@ LoadBalancer -- Èç¹ûÄãÏëÉèÖÃÏÂOpenFeignµÄ³¬Ê±ÅäÖõϰ£¬¿ÉÒÔÔÚapplication.ymlÖÐÌí¼ÓÈçÏÂÄÚÈÝ£» +- 如果你想设置下OpenFeign的超时é…�置的è¯�,å�¯ä»¥åœ¨application.yml中添加如下内容; feign: client: config: - default: # Feignµ÷Óó¬Ê±ÅäÖà + default: # Feign调用超时é…�ç½® connectTimeout: 5000 readTimeout: 5000 -- ½ÓÏÂÀ´Í¨¹ý²âÊÔ½Ó¿Úµ÷ÓÃÔ¶³Ì·þÎñ£¬·¢ÏÖ¿ÉÒÔÕý³£µ÷Ó㬷ÃÎʵØÖ·£ºhttp://localhost:8308/userFeign/1 +- 接下æ�¥é€šè¿‡æµ‹è¯•接å�£è°ƒç”¨è¿œç¨‹æœ�务,å�‘现å�¯ä»¥æ­£å¸¸è°ƒç”¨ï¼Œè®¿é—®åœ°å�€ï¼šhttp://localhost:8308/userFeign/1 -# ·þÎñʵÀý»º´æ +# æœ�务实例缓存 -LoadBalancerΪÁËÌá¸ßÐÔÄÜ£¬²»»áÔÚÿ´ÎÇëÇóʱȥ»ñȡʵÀýÁÐ±í£¬¶øÊǽ«·þÎñʵÀýÁÐ±í½øÐÐÁ˱¾µØ»º´æ¡£ +LoadBalancer为了æ��高性能,ä¸�会在æ¯�次请求时去获å�–实例列表,而是将æœ�务实例列表进行了本地缓存。 -ĬÈϵĻº´æÊ±¼äΪ35s£¬ÎªÁ˼õÉÙ·þÎñ²»¿ÉÓû¹»á±»Ñ¡ÔñµÄ¿ÉÄÜÐÔ£¬ÎÒÃÇ¿ÉÒÔ½øÐÐÈçÏÂÅäÖᣠ+默认的缓存时间为35s,为了å‡�å°‘æœ�务ä¸�å�¯ç”¨è¿˜ä¼šè¢«é€‰æ‹©çš„å�¯èƒ½æ€§ï¼Œæˆ‘们å�¯ä»¥è¿›è¡Œå¦‚下é…�置。 spring: cloud: loadbalancer: - cache: # ¸ºÔؾùºâ»º´æÅäÖà - enabled: true # ¿ªÆô»º´æ - ttl: 5s # ÉèÖûº´æÊ±¼ä - capacity: 256 # ÉèÖûº´æ´óС + cache: # è´Ÿè½½å�‡è¡¡ç¼“å­˜é…�ç½® + enabled: true # å¼€å�¯ç¼“å­˜ + ttl: 5s # 设置缓存时间 + capacity: 256 # 设置缓存大å°� -# HTTPÇëÇóת»» +# HTTP请求转æ�¢ -Èç¹ûÄãÏëÔÚÿ´ÎÔ¶³Ìµ÷ÓÃÖд«Èë×Ô¶¨ÒåµÄÇëÇóÍ·µÄ»°£¬¿ÉÒÔÊÔÊÔLoadBalancerRequestTransformer£¬Í¨¹ýËü¿ÉÒÔ¶ÔԭʼÇëÇó½øÐÐÒ»¶¨µÄת»»¡£ +如果你想在æ¯�次远程调用中传入自定义的请求头的è¯�,å�¯ä»¥è¯•试LoadBalancerRequestTransformer,通过它å�¯ä»¥å¯¹åŽŸå§‹è¯·æ±‚è¿›è¡Œä¸€å®šçš„è½¬æ�¢ã€‚ -- Ê×ÏÈÎÒÃÇÐèÒªÅäÖúÃLoadBalancerRequestTransformerµÄBeanʵÀý£¬ÕâÀïÎÒÃǽ«ServiceInstanceµÄinstanceId·ÅÈëµ½ÇëÇóÍ·X-InstanceIdÖУ» +- 首先我们需è¦�é…�置好LoadBalancerRequestTransformerçš„Bean实例,这里我们将ServiceInstanceçš„instanceId放入到请求头X-InstanceId中; /** - * LoadBalancerÏà¹ØÅäÖà + * LoadBalancer相关é…�ç½® * Created by macro on 2022/7/26. */ @Configuration @@ -292,7 +292,7 @@ LoadBalancerΪ -- È»ºóÐÞ¸Änacos-user-serviceÖеĴúÂ룬´òÓ¡»ñÈ¡µ½µÄÇëÇóÍ·X-InstanceIdµÄÐÅÏ¢£» +- ç„¶å�Žä¿®æ”¹nacos-user-service中的代ç �,打å�°èŽ·å�–到的请求头X-InstanceId的信æ�¯ï¼› @@ -305,39 +305,39 @@ LoadBalancerΪ @GetMapping("/{id}") public CommonResult getUser(@PathVariable Long id) { User user = userService.getUser(id); - LOGGER.info("¸ù¾Ýid»ñÈ¡Óû§ÐÅÏ¢£¬Óû§Ãû³ÆÎª£º{}", user.getUsername()); + LOGGER.info("æ ¹æ�®id获å�–用户信æ�¯ï¼Œç”¨æˆ·å��称为:{}", user.getUsername()); ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = servletRequestAttributes.getRequest(); String instanceId = request.getHeader("X-InstanceId"); if (StrUtil.isNotEmpty(instanceId)) { - LOGGER.info("»ñÈ¡µ½×Ô¶¨ÒåÇëÇóÍ·:X-InstanceId={}", instanceId); + LOGGER.info("获å�–到自定义请求头:X-InstanceId={}", instanceId); } return new CommonResult<>(user); } } -- ½ÓÏÂÀ´·ÃÎʽӿڽøÐвâÊÔ£¬nacos-user-service¿ØÖÆÌ¨½«´òÓ¡ÈçÏÂÈÕÖ¾£¬·¢ÏÖ×Ô¶¨ÒåÇëÇóÍ·ÒѾ­³É¹¦´«µÝÁË£¬·ÃÎʵØÖ·£ºhttp://localhost:8308/user/1 +- 接下æ�¥è®¿é—®æŽ¥å�£è¿›è¡Œæµ‹è¯•,nacos-user-service控制å�°å°†æ‰“å�°å¦‚下日志,å�‘现自定义请求头已ç»�æˆ�功传递了,访问地å�€ï¼šhttp://localhost:8308/user/1 - 2022-07-26 15:05:19.920 INFO 14344 --- [nio-8206-exec-5] c.macro.cloud.controller.UserController : ¸ù¾Ýid»ñÈ¡Óû§ÐÅÏ¢£¬Óû§Ãû³ÆÎª£ºmacro - 2022-07-26 15:05:19.921 INFO 14344 --- [nio-8206-exec-5] c.macro.cloud.controller.UserController : »ñÈ¡µ½×Ô¶¨ÒåÇëÇóÍ·:X-InstanceId=192.168.3.227#8206#DEFAULT#DEFAULT_GROUP@@nacos-user-service + 2022-07-26 15:05:19.920 INFO 14344 --- [nio-8206-exec-5] c.macro.cloud.controller.UserController : æ ¹æ�®id获å�–用户信æ�¯ï¼Œç”¨æˆ·å��称为:macro + 2022-07-26 15:05:19.921 INFO 14344 --- [nio-8206-exec-5] c.macro.cloud.controller.UserController : 获å�–到自定义请求头:X-InstanceId=192.168.3.227#8206#DEFAULT#DEFAULT_GROUP@@nacos-user-service -# ×ܽá +# 总结 -½ñÌìͨ¹ý¶ÔLoadBalancerµÄÒ»²¨Êµ¼ùÎÒÃÇ¿ÉÒÔ·¢ÏÖ£¬Ê¹ÓÃLoadBalancerºÍRibbonµÄÇø±ðÆäʵ²¢²»´ó£¬Ö÷ÒªÊÇһЩÅäÖ÷½Ê½µÄÏàͬ¡£Èç¹ûÄã֮ǰʹÓùýRibbonµÄ»°£¬»ù±¾ÉÏ¿ÉÒÔÎÞ·ìÇл»µ½LoadBalancer¡£ +今天通过对LoadBalancer的一波实践我们å�¯ä»¥å�‘现,使用LoadBalancerå’ŒRibbon的区别其实并ä¸�大,主è¦�是一些é…�置方å¼�的相å�Œã€‚如果你之å‰�使用过Ribbonçš„è¯�,基本上å�¯ä»¥æ— ç¼�切æ�¢åˆ°LoadBalancer。 -# ²Î¿¼×ÊÁÏ +# å�‚考资料 -¹Ù·½Îĵµ£ºhttps://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#spring-cloud-loadbalancer +官方文档:https://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#spring-cloud-loadbalancer -# ÏîĿԴÂëµØÖ· +# 项目æº�ç �地å�€ https://github.com/macrozheng/springcloud-learning/tree/master/nacos-loadbalancer-service -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudOpenFeign.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudOpenFeign.md" index 50c14d5..4a638f0 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudOpenFeign.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudOpenFeign.md" @@ -1,60 +1,60 @@ -Netflix Feign ÊÇ Netflix ¹«Ë¾·¢²¼µÄÒ»ÖÖʵÏÖ¸ºÔؾùºâºÍ·þÎñµ÷ÓõĿªÔ´×é¼þ¡£Spring Cloud ½«ÆäÓë Netflix ÖÐµÄÆäËû¿ªÔ´·þÎñ×é¼þ£¨ÀýÈç Eureka¡¢Ribbon ÒÔ¼° Hystrix µÈ£©Ò»ÆðÕûºÏ½ø Spring Cloud Netflix Ä£¿éÖУ¬ÕûºÏºóÈ«³ÆÎª Spring Cloud Netflix Feign¡£ +Netflix Feign 是 Netflix å…¬å�¸å�‘布的一ç§�实现负载å�‡è¡¡å’Œæœ�务调用的开æº�组件。Spring Cloud 将其与 Netflix 中的其他开æº�æœ�务组件(例如 Eurekaã€�Ribbon 以å�Š Hystrix 等)一起整å�ˆè¿› Spring Cloud Netflix 模å�—中,整å�ˆå�Žå…¨ç§°ä¸º Spring Cloud Netflix Feign。 -Feign ¶Ô [Ribbon](http://c.biancheng.net/springcloud/ribbon.html) ½øÐÐÁ˼¯³É£¬ÀûÓà Ribbon ά»¤ÁËÒ»·Ý¿ÉÓ÷þÎñÇåµ¥£¬²¢Í¨¹ý Ribbon ʵÏÖÁ˿ͻ§¶ËµÄ¸ºÔؾùºâ¡£ +Feign 对 [Ribbon](http://c.biancheng.net/springcloud/ribbon.html) 进行了集æˆ�,利用 Ribbon 维护了一份å�¯ç”¨æœ�务清å�•,并通过 Ribbon 实现了客户端的负载å�‡è¡¡ã€‚ -Feign ÊÇÒ»ÖÖÉùÃ÷ʽ·þÎñµ÷ÓÃ×é¼þ£¬ËüÔÚ RestTemplate µÄ»ù´¡ÉÏ×öÁ˽øÒ»²½µÄ·â×°¡£Í¨¹ý Feign£¬ÎÒÃÇÖ»ÐèÒªÉùÃ÷Ò»¸ö½Ó¿Ú²¢Í¨¹ý×¢½â½øÐмòµ¥µÄÅäÖã¨ÀàËÆÓÚ Dao ½Ó¿ÚÉÏÃæµÄ Mapper ×¢½âÒ»Ñù£©¼´¿ÉʵÏÖ¶Ô HTTP ½Ó¿ÚµÄ°ó¶¨¡£ +Feign 是一ç§�声明å¼�æœ�务调用组件,它在 RestTemplate 的基础上å�šäº†è¿›ä¸€æ­¥çš„å°�装。通过 Feign,我们å�ªéœ€è¦�声明一个接å�£å¹¶é€šè¿‡æ³¨è§£è¿›è¡Œç®€å�•çš„é…�置(类似于 Dao 接å�£ä¸Šé�¢çš„ Mapper 注解一样)å�³å�¯å®žçް坹 HTTP 接å�£çš„绑定。 -ͨ¹ý Feign£¬ÎÒÃÇ¿ÉÒÔÏñµ÷Óñ¾µØ·½·¨Ò»ÑùÀ´µ÷ÓÃÔ¶³Ì·þÎñ£¬¶øÍêÈ«¸Ð¾õ²»µ½ÕâÊÇÔÚ½øÐÐÔ¶³Ìµ÷Óᣠ+通过 Feign,我们å�¯ä»¥åƒ�调用本地方法一样æ�¥è°ƒç”¨è¿œç¨‹æœ�务,而完全感觉ä¸�到这是在进行远程调用。 -Feign Ö§³Ö¶àÖÖ×¢½â£¬ÀýÈç Feign ×Ô´øµÄ×¢½âÒÔ¼° JAX-RS ×¢½âµÈ£¬µ«Òź¶µÄÊÇ Feign ±¾Éí²¢²»Ö§³Ö Spring MVC ×¢½â£¬ÕâÎÞÒÉ»á¸ø¹ã´ó Spring Óû§´øÀ´²»±ã¡£ +Feign 支æŒ�多ç§�注解,例如 Feign 自带的注解以å�Š JAX-RS 注解等,但é�—憾的是 Feign 本身并ä¸�支æŒ� Spring MVC 注解,这无疑会给广大 Spring 用户带æ�¥ä¸�便。 -2019 Äê Netflix ¹«Ë¾Ðû²¼ Feign ×é¼þÕýʽ½øÈëÍ£¸üά»¤×´Ì¬£¬ÓÚÊÇ Spring ¹Ù·½±ãÍÆ³öÁËÒ»¸öÃûΪ OpenFeign µÄ×é¼þ×÷Ϊ Feign µÄÌæ´ú·½°¸¡£ +2019 å¹´ Netflix å…¬å�¸å®£å¸ƒ Feign 组件正å¼�进入å�œæ›´ç»´æŠ¤çжæ€�,于是 Spring 官方便推出了一个å��为 OpenFeign 的组件作为 Feign 的替代方案。 ## OpenFeign -OpenFeign È«³Æ Spring Cloud OpenFeign£¬ËüÊÇ Spring ¹Ù·½ÍƳöµÄÒ»ÖÖÉùÃ÷ʽ·þÎñµ÷ÓÃÓë¸ºÔØ¾ùºâ×é¼þ£¬ËüµÄ³öÏÖ¾ÍÊÇΪÁËÌæ´ú½øÈëÍ£¸üά»¤×´Ì¬µÄ Feign¡£ +OpenFeign 全称 Spring Cloud OpenFeign,它是 Spring 官方推出的一ç§�声明å¼�æœ�务调用与负载å�‡è¡¡ç»„件,它的出现就是为了替代进入å�œæ›´ç»´æŠ¤çжæ€�çš„ Feign。 -OpenFeign ÊÇ Spring Cloud ¶Ô Feign µÄ¶þ´Î·â×°£¬Ëü¾ßÓÐ Feign µÄËùÓй¦ÄÜ£¬²¢ÔÚ Feign µÄ»ù´¡ÉÏÔö¼ÓÁË¶Ô Spring MVC ×¢½âµÄÖ§³Ö£¬ÀýÈç @RequestMapping¡¢@GetMapping ºÍ @PostMapping µÈ¡£ +OpenFeign 是 Spring Cloud 对 Feign 的二次å°�装,它具有 Feign 的所有功能,并在 Feign 的基础上增加了对 Spring MVC 注解的支æŒ�,例如 @RequestMappingã€�@GetMapping å’Œ @PostMapping 等。 -#### OpenFeign ³£ÓÃ×¢½â +#### OpenFeign 常用注解 -ʹÓà OpenFegin ½øÐÐÔ¶³Ì·þÎñµ÷ÓÃʱ£¬³£ÓÃ×¢½âÈçÏÂ±í¡£ +使用 OpenFegin 进行远程æœ�务调用时,常用注解如下表。 -| ×¢½â | ˵Ã÷ | +| 注解 | 说明 | | ------------------- | ------------------------------------------------------------ | -| @FeignClient | ¸Ã×¢½âÓÃÓÚ֪ͨ OpenFeign ×é¼þ¶Ô @RequestMapping ×¢½âϵĽӿڽøÐнâÎö£¬²¢Í¨¹ý¶¯Ì¬´úÀíµÄ·½Ê½²úÉúʵÏÖÀ࣬ʵÏÖ¸ºÔؾùºâºÍ·þÎñµ÷Óᣠ| -| @EnableFeignClients | ¸Ã×¢½âÓÃÓÚ¿ªÆô OpenFeign ¹¦ÄÜ£¬µ± Spring Cloud Ó¦ÓÃÆô¶¯Ê±£¬OpenFeign »áɨÃè±êÓÐ @FeignClient ×¢½âµÄ½Ó¿Ú£¬Éú³É´úÀí²¢×¢²áµ½ Spring ÈÝÆ÷ÖС£ | -| @RequestMapping | Spring MVC ×¢½â£¬ÔÚ Spring MVC ÖÐʹÓøÃ×¢½âÓ³ÉäÇëÇó£¬Í¨¹ýËüÀ´Ö¸¶¨¿ØÖÆÆ÷£¨Controller£©¿ÉÒÔ´¦ÀíÄÄЩ URL ÇëÇó£¬Ï൱ÓÚ Servlet ÖÐ web.xml µÄÅäÖᣠ| -| @GetMapping | Spring MVC ×¢½â£¬ÓÃÀ´Ó³Éä GET ÇëÇó£¬ËüÊÇÒ»¸ö×éºÏ×¢½â£¬Ï൱ÓÚ @RequestMapping(method = RequestMethod.GET) ¡£ | -| @PostMapping | Spring MVC ×¢½â£¬ÓÃÀ´Ó³Éä POST ÇëÇó£¬ËüÊÇÒ»¸ö×éºÏ×¢½â£¬Ï൱ÓÚ @RequestMapping(method = RequestMethod.POST) ¡£ | +| @FeignClient | 该注解用于通知 OpenFeign 组件对 @RequestMapping 注解下的接å�£è¿›è¡Œè§£æž�,并通过动æ€�代ç�†çš„æ–¹å¼�产生实现类,实现负载å�‡è¡¡å’Œæœ�务调用。 | +| @EnableFeignClients | 该注解用于开å�¯ OpenFeign 功能,当 Spring Cloud 应用å�¯åŠ¨æ—¶ï¼ŒOpenFeign 会扫æ��标有 @FeignClient 注解的接å�£ï¼Œç”Ÿæˆ�代ç�†å¹¶æ³¨å†Œåˆ° Spring 容器中。 | +| @RequestMapping | Spring MVC 注解,在 Spring MVC 中使用该注解映射请求,通过它æ�¥æŒ‡å®šæŽ§åˆ¶å™¨ï¼ˆController)å�¯ä»¥å¤„ç�†å“ªäº› URL 请求,相当于 Servlet 中 web.xml çš„é…�置。 | +| @GetMapping | Spring MVC 注解,用æ�¥æ˜ å°„ GET 请求,它是一个组å�ˆæ³¨è§£ï¼Œç›¸å½“于 @RequestMapping(method = RequestMethod.GET) 。 | +| @PostMapping | Spring MVC 注解,用æ�¥æ˜ å°„ POST 请求,它是一个组å�ˆæ³¨è§£ï¼Œç›¸å½“于 @RequestMapping(method = RequestMethod.POST) 。 | -> Spring Cloud Finchley ¼°ÒÔÉϰ汾һ°ãʹÓà OpenFeign ×÷ΪÆä·þÎñµ÷ÓÃ×é¼þ¡£ÓÉÓÚ OpenFeign ÊÇÔÚ 2019 Äê Feign Í£¸ü½øÈëά»¤ºóÍÆ³öµÄ£¬Òò´Ë´ó¶àÊý 2019 Äê¼°ÒÔºóµÄÐÂÏîĿʹÓõͼÊÇ OpenFeign£¬¶ø 2018 ÄêÒÔǰµÄÏîĿһ°ãʹÓà Feign¡£ +> Spring Cloud Finchley å�Šä»¥ä¸Šç‰ˆæœ¬ä¸€èˆ¬ä½¿ç”¨ OpenFeign 作为其æœ�务调用组件。由于 OpenFeign 是在 2019 å¹´ Feign å�œæ›´è¿›å…¥ç»´æŠ¤å�ŽæŽ¨å‡ºçš„ï¼Œå› æ­¤å¤§å¤šæ•° 2019 å¹´å�Šä»¥å�Žçš„æ–°é¡¹ç›®ä½¿ç”¨çš„都是 OpenFeign,而 2018 年以å‰�的项目一般使用 Feign。 ## Feign VS OpenFeign -ÏÂÃæÎÒÃǾÍÀ´¶Ô±ÈÏ Feign ºÍ OpenFeign µÄÒìͬ¡£ +下é�¢æˆ‘们就æ�¥å¯¹æ¯”下 Feign å’Œ OpenFeign 的异å�Œã€‚ -#### Ïàͬµã +#### 相å�Œç‚¹ -Feign ºÍ OpenFegin ¾ßÓÐÒÔÏÂÏàͬµã£º +Feign å’Œ OpenFegin 具有以下相å�Œç‚¹ï¼š -* Feign ºÍ OpenFeign ¶¼ÊÇ Spring Cloud ϵÄÔ¶³Ìµ÷Óú͸ºÔؾùºâ×é¼þ¡£ -* Feign ºÍ OpenFeign ×÷ÓÃÒ»Ñù£¬¶¼¿ÉÒÔʵÏÖ·þÎñµÄÔ¶³Ìµ÷Óú͸ºÔؾùºâ¡£ -* Feign ºÍ OpenFeign ¶¼¶Ô Ribbon ½øÐÐÁ˼¯³É£¬¶¼ÀûÓà Ribbon ά»¤ÁË¿ÉÓ÷þÎñÇåµ¥£¬²¢Í¨¹ý Ribbon ʵÏÖÁ˿ͻ§¶ËµÄ¸ºÔؾùºâ¡£ -* Feign ºÍ OpenFeign ¶¼ÊÇÔÚ·þÎñÏû·ÑÕߣ¨¿Í»§¶Ë£©¶¨Òå·þÎñ°ó¶¨½Ó¿Ú²¢Í¨¹ý×¢½âµÄ·½Ê½½øÐÐÅäÖã¬ÒÔʵÏÖÔ¶³Ì·þÎñµÄµ÷Óᣠ+* Feign å’Œ OpenFeign 都是 Spring Cloud 下的远程调用和负载å�‡è¡¡ç»„件。 +* Feign å’Œ OpenFeign 作用一样,都å�¯ä»¥å®žçްæœ�务的远程调用和负载å�‡è¡¡ã€‚ +* Feign å’Œ OpenFeign 都对 Ribbon 进行了集æˆ�,都利用 Ribbon 维护了å�¯ç”¨æœ�务清å�•,并通过 Ribbon 实现了客户端的负载å�‡è¡¡ã€‚ +* Feign å’Œ OpenFeign 都是在æœ�务消费者(客户端)定义æœ�务绑定接å�£å¹¶é€šè¿‡æ³¨è§£çš„æ–¹å¼�进行é…�置,以实现远程æœ�务的调用。 -#### ²»Í¬µã +#### ä¸�å�Œç‚¹ -Feign ºÍ OpenFeign ¾ßÓÐÒÔϲ»Í¬£º +Feign å’Œ OpenFeign 具有以下ä¸�å�Œï¼š -* Feign ºÍ OpenFeign µÄÒÀÀµÏͬ£¬Feign µÄÒÀÀµÎª spring-cloud-starter-feign£¬¶ø OpenFeign µÄÒÀÀµÎª spring-cloud-starter-openfeign¡£ -* Feign ºÍ OpenFeign Ö§³ÖµÄ×¢½â²»Í¬£¬Feign Ö§³Ö Feign ×¢½âºÍ JAX-RS ×¢½â£¬µ«²»Ö§³Ö Spring MVC ×¢½â£»OpenFeign ³ýÁËÖ§³Ö Feign ×¢½âºÍ JAX-RS ×¢½âÍ⣬»¹Ö§³Ö Spring MVC ×¢½â¡£ +* Feign å’Œ OpenFeign çš„ä¾�赖项ä¸�å�Œï¼ŒFeign çš„ä¾�赖为 spring-cloud-starter-feign,而 OpenFeign çš„ä¾�赖为 spring-cloud-starter-openfeign。 +* Feign å’Œ OpenFeign 支æŒ�的注解ä¸�å�Œï¼ŒFeign 支æŒ� Feign 注解和 JAX-RS 注解,但ä¸�支æŒ� Spring MVC 注解;OpenFeign 除了支æŒ� Feign 注解和 JAX-RS 注解外,还支æŒ� Spring MVC 注解。 -## OpenFeign ʵÏÖÔ¶³Ì·þÎñµ÷Óà +## OpenFeign 实现远程æœ�务调用 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý£¬À´ÑÝʾÏÂͨ¹ý OpenFeign ÊÇÈçºÎʵÏÖÔ¶³Ì·þÎñµ÷Óõġ£ +下é�¢æˆ‘们就通过一个实例,æ�¥æ¼”示下通过 OpenFeign 是如何实现远程æœ�务调用的。 -1\. ÔÚ spring-cloud-demo2 Ï´´½¨Ò»¸öÃûΪ micro-service-cloud-consumer-dept-feign µÄ Spring Boot Ä£¿é£¬²¢ÔÚ pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ¡£ +1\. 在 spring-cloud-demo2 下创建一个å��为 micro-service-cloud-consumer-dept-feign çš„ Spring Boot 模å�—,并在 pom.xml 中添加以下ä¾�赖。 @@ -99,17 +99,17 @@ Feign spring-boot-starter-test test - + org.springframework.cloud spring-cloud-starter-netflix-eureka-client - + org.springframework.cloud spring-cloud-starter-netflix-ribbon - + org.springframework.cloud spring-cloud-starter-openfeign @@ -140,7 +140,7 @@ Feign -2\. ÔÚ micro-service-cloud-consumer-dept-feign ϵÄÀà·¾¶£¨¼´ /resources Ŀ¼£©Ï£¬Ìí¼ÓÒ»¸ö application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2\. 在 micro-service-cloud-consumer-dept-feign 下的类路径(å�³ /resources 目录)下,添加一个 application.yml,é…�置内容如下。 @@ -152,17 +152,17 @@ server: port: 80 eureka: client: - register-with-eureka: false #·þÎñÏû·ÑÕß¿ÉÒÔ²»Ïò·þÎñ×¢²áÖÐÐÄ×¢²á·þÎñ + register-with-eureka: false #æœ�务消费者å�¯ä»¥ä¸�å�‘æœ�务注册中心注册æœ�务 service-url: defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ - fetch-registry: true #·þÎñÏû·ÑÕ߿ͻ§¶ËÐèҪȥ¼ìË÷·þÎñ + fetch-registry: true #æœ�务消费者客户端需è¦�去检索æœ�务 ``` -3\. ÔÚ net.biancheng.c.service °üÏ´´½¨Ò»¸öÃûΪ DeptFeignService µÄ½Ó¿Ú£¬²¢ÔڸýӿÚÉÏʹÓà @FeignClient ×¢½âʵÏÖ¶Ô·þÎñ½Ó¿ÚµÄ°ó¶¨£¬´úÂëÈçÏ¡£ +3\. 在 net.biancheng.c.service 包下创建一个å��为 DeptFeignService 的接å�£ï¼Œå¹¶åœ¨è¯¥æŽ¥å�£ä¸Šä½¿ç”¨ @FeignClient 注解实现对æœ�务接å�£çš„绑定,代ç �如下。 @@ -180,12 +180,12 @@ import org.springframework.web.bind.annotation.RequestMethod; import java.util.List; -//Ìí¼ÓΪÈÝÆ÷ÄÚµÄÒ»¸ö×é¼þ +//添加为容器内的一个组件 @Component -// ·þÎñÌṩÕßÌṩµÄ·þÎñÃû³Æ£¬¼´ application.name +// æœ�务æ��供者æ��供的æœ�务å��称,å�³ application.name @FeignClient(value = "MICROSERVICECLOUDPROVIDERDEPT") public interface DeptFeignService { - //¶ÔÓ¦·þÎñÌṩÕߣ¨8001¡¢8002¡¢8003£©Controller Öж¨ÒåµÄ·½·¨ + //对应æœ�务æ��供者(8001ã€�8002ã€�8003)Controller 中定义的方法 @RequestMapping(value = "/dept/get/{id}", method = RequestMethod.GET) public Dept get(@PathVariable("id") int id); @@ -199,12 +199,12 @@ public interface DeptFeignService { -ÔÚ±àд·þÎñ°ó¶¨½Ó¿Úʱ£¬ÐèҪעÒâÒÔÏ 2 µã£º +在编写æœ�务绑定接å�£æ—¶ï¼Œéœ€è¦�注æ„�以下 2 点: -* ÔÚ @FeignClient ×¢½âÖУ¬value ÊôÐÔµÄȡֵΪ£º·þÎñÌṩÕߵķþÎñÃû£¬¼´·þÎñÌṩÕßÅäÖÃÎļþ£¨application.yml£©ÖÐ spring.application.name µÄȡֵ¡£ -* ½Ó¿ÚÖж¨ÒåµÄÿ¸ö·½·¨¶¼Óë·þÎñÌṩÕߣ¨¼´ micro-service-cloud-provider-dept-8001 µÈ£©ÖÐ Controller ¶¨ÒåµÄ·þÎñ·½·¨¶ÔÓ¦¡£ +* 在 @FeignClient 注解中,value 属性的å�–值为:æœ�务æ��供者的æœ�务å��,å�³æœ�务æ��供者é…�置文件(application.yml)中 spring.application.name çš„å�–值。 +* 接å�£ä¸­å®šä¹‰çš„æ¯�个方法都与æœ�务æ��供者(å�³ micro-service-cloud-provider-dept-8001 等)中 Controller 定义的æœ�务方法对应。 -4\. ÔÚ net.biancheng.c.controller °üÏ£¬´´½¨Ò»¸öÃûΪ DeptController_Consumer µÄ Controller À࣬´úÂëÈçÏ¡£ +4\. 在 net.biancheng.c.controller 包下,创建一个å��为 DeptController_Consumer çš„ Controller 类,代ç �如下。 @@ -245,7 +245,7 @@ public class DeptController_Consumer { -5\. ÔÚÖ÷Æô¶¯ÀàÉÏÌí¼Ó @EnableFeignClients ×¢½â¿ªÆô OpenFeign ¹¦ÄÜ£¬´úÂëÈçÏ¡£ +5\. 在主å�¯åŠ¨ç±»ä¸Šæ·»åŠ  @EnableFeignClients 注解开å�¯ OpenFeign 功能,代ç �如下。 @@ -260,7 +260,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.openfeign.EnableFeignClients; @SpringBootApplication -@EnableFeignClients //¿ªÆô OpenFeign ¹¦ÄÜ +@EnableFeignClients //å¼€å�¯ OpenFeign 功能 public class MicroServiceCloudConsumerDeptFeignApplication { public static void main(String[] args) { @@ -273,27 +273,27 @@ public class MicroServiceCloudConsumerDeptFeignApplication { -Spring Cloud Ó¦ÓÃÔÚÆô¶¯Ê±£¬OpenFeign »áɨÃè±êÓÐ @FeignClient ×¢½âµÄ½Ó¿ÚÉú³É´úÀí£¬²¢×¢È˵½ Spring ÈÝÆ÷ÖС£ +Spring Cloud 应用在å�¯åŠ¨æ—¶ï¼ŒOpenFeign 会扫æ��标有 @FeignClient 注解的接å�£ç”Ÿæˆ�代ç�†ï¼Œå¹¶æ³¨äººåˆ° Spring 容器中。 -6\. ÒÀ´ÎÆô¶¯·þÎñ×¢²áÖÐÐļ¯Èº¡¢·þÎñÌṩÕßÒÔ¼° micro-service-cloud-consumer-dept-feign£¬Æô¶¯Íê³Éºó£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/list¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. ä¾�次å�¯åЍæœ�务注册中心集群ã€�æœ�务æ��供者以å�Š micro-service-cloud-consumer-dept-feign,å�¯åŠ¨å®Œæˆ�å�Žï¼Œä½¿ç”¨æµ�览器访问“http://eureka7001.com/consumer/dept/listâ€�,结果如下图。 -![OpenFeign ʵÏÖ·þÎñµ÷ÓÃ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1014296212-0.png) -ͼ1£ºOpenFeign ʵÏÖÔ¶³Ì·þÎñµ÷Óà +![OpenFeign 实现æœ�务调用](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1014296212-0.png) +图1:OpenFeign 实现远程æœ�务调用 -7\. Á¬Ðø¶à´Î·ÃÎÊ¡°http://eureka7001.com/consumer/dept/list¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. 连续多次访问“http://eureka7001.com/consumer/dept/listâ€�,结果如下图。 -![OpenFeign ĬÈϸºÔؾùºâ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1014294062-1.gif) -ͼ2£ºOpenFeign ¸ºÔؾùºâ +![OpenFeign 默认负载å�‡è¡¡](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1014294062-1.gif) +图2:OpenFeign è´Ÿè½½å�‡è¡¡ -´Óͼ 2 ¿ÉÒÔ¿´³ö£¬ÓÉÓÚ OpenFeign ¼¯³ÉÁË Ribbon£¬Òò´ËËüҲʵÏÖÁ˿ͻ§¶ËµÄ¸ºÔؾùºâ£¬ÆäĬÈϸºÔؾùºâ²ßÂÔΪÂÖѯ²ßÂÔ¡£ +从图 2 å�¯ä»¥çœ‹å‡ºï¼Œç”±äºŽ OpenFeign 集æˆ�了 Ribbon,因此它也实现了客户端的负载å�‡è¡¡ï¼Œå…¶é»˜è®¤è´Ÿè½½å�‡è¡¡ç­–略为轮询策略。 -## OpenFeign ³¬Ê±¿ØÖÆ +## OpenFeign 超时控制 -OpenFeign ¿Í»§¶ËµÄĬÈϳ¬Ê±Ê±¼äΪ 1 ÃëÖÓ£¬Èç¹û·þÎñ¶Ë´¦ÀíÇëÇóµÄʱ¼ä³¬¹ý 1 Ãë¾Í»á±¨´í¡£ÎªÁ˱ÜÃâÕâÑùµÄÇé¿ö£¬ÎÒÃÇÐèÒª¶Ô OpenFeign ¿Í»§¶ËµÄ³¬Ê±Ê±¼ä½øÐпØÖÆ¡£ +OpenFeign 客户端的默认超时时间为 1 秒钟,如果æœ�务端处ç�†è¯·æ±‚的时间超过 1 秒就会报错。为了é�¿å…�这样的情况,我们需è¦�对 OpenFeign 客户端的超时时间进行控制。 -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý£¬À´ÑÝʾ OpenFeign ÊÇÈçºÎ½øÐг¬Ê±¿ØÖƵġ£ +下é�¢æˆ‘们就通过一个实例,æ�¥æ¼”示 OpenFeign 是如何进行超时控制的。 -1\. ÔÚËùÓеķþÎñÌṩÕߣ¨·þÎñ¶Ë£©µÄ DeptController ÖÐÌí¼ÓÒ»¸öÏìӦʱ¼äΪ 5 ÃëµÄ·þÎñ£¬´úÂëÈçÏ¡£ +1\. 在所有的æœ�务æ��供者(æœ�务端)的 DeptController 中添加一个å“�应时间为 5 ç§’çš„æœ�务,代ç �如下。 @@ -301,10 +301,10 @@ OpenFeign ``` -//³¬Ê±²âÊÔ,¸Ã·þÎñµÄÏìӦʱ¼äΪ 5 Ãë +//超时测试,该æœ�务的å“�应时间为 5 ç§’ @RequestMapping(value = "/dept/feign/timeout") public String DeptFeignTimeout() { - //ÔÝÍ£ 5 Ãë + //æš‚å�œ 5 ç§’ try { TimeUnit.SECONDS.sleep(5); } catch (InterruptedException e) { @@ -319,7 +319,7 @@ public String DeptFeignTimeout() { -2\. ÔÚ micro-service-cloud-consumer-dept-feign µÄ DeptFeignService ½Ó¿ÚÖÐÌí¼ÓÒÔÏ´úÂ룬°ó¶¨·þÎñ¶Ë¸Õ¸ÕÌí¼ÓµÄ³¬Ê±·þÎñ¡£ +2\. 在 micro-service-cloud-consumer-dept-feign çš„ DeptFeignService 接å�£ä¸­æ·»åР以䏋代ç �,绑定æœ�务端刚刚添加的超时æœ�务。 @@ -336,7 +336,7 @@ public String DeptFeignTimeout(); -3\. ÔÚ micro-service-cloud-consumer-dept-feign µÄ DeptController_Consumer Ìí¼ÓÒÔÏ´úÂë¡£ +3\. 在 micro-service-cloud-consumer-dept-feign çš„ DeptController_Consumer 添加以下代ç �。 @@ -346,7 +346,7 @@ public String DeptFeignTimeout(); @RequestMapping(value = "/consumer/dept/feign/timeout") public String DeptFeignTimeout() { - // openFeign-ribbon ¿Í»§¶ËÒ»°ãĬÈϵȴýÒ»ÃëÖÓ£¬³¬¹ý¸Ãʱ¼ä¾Í»á±¨´í + // openFeign-ribbon 客户端一般默认等待一秒钟,超过该时间就会报错 return deptFeignService.DeptFeignTimeout(); } @@ -356,17 +356,17 @@ public String DeptFeignTimeout() { -4\. ÖØÆôËùÓзþÎñÌṩÕߣ¬Ê¹ÓÃä¯ÀÀÆ÷ÒÀ´Î·ÃÎÊ¡°http://eureka7001.com:8001/dept/feign/timeout¡±¡¢¡°http://eureka7001.com:8002/dept/feign/timeout¡±ºÍ¡°http://eureka7001.com:8003/dept/feign/timeout¡±£¬È·±£ËùÓзþÎñÌṩÕßÌṩµÄ³¬Ê±·þÎñ¶¼ÄÜÕý³£Ê¹Óã¬ÈçÏÂͼ¡£ +4\. é‡�å�¯æ‰€æœ‰æœ�务æ��供者,使用æµ�览器ä¾�次访问“http://eureka7001.com:8001/dept/feign/timeoutâ€�ã€�“http://eureka7001.com:8002/dept/feign/timeoutâ€�和“http://eureka7001.com:8003/dept/feign/timeoutâ€�,确ä¿�所有æœ�务æ��供者æ��供的超时æœ�务都能正常使用,如下图。 -![·þÎñÌṩÕß³¬Ê±·þÎñ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10142a102-2.png) -ͼ3£º·þÎñÌṩÕߵij¬Ê±·þÎñ +![æœ�务æ��供者超时æœ�务](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10142a102-2.png) +图3:æœ�务æ��供者的超时æœ�务 -5\. ÖØÆô micro-service-cloud-consumer-dept-feign£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/feign/timeout¡±£¬½á¹ûÈçÏÂͼ¡£ +5\. é‡�å�¯ micro-service-cloud-consumer-dept-feign,使用æµ�览器访问“http://eureka7001.com/consumer/dept/feign/timeoutâ€�,结果如下图。 -![OpenFeign ³¬Ê±±¨´í](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1014293G1-3.png) -ͼ4£ºOpenFeign ³¬Ê±±¨´í +![OpenFeign 超时报错](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1014293G1-3.png) +图4:OpenFeign 超时报错 -6\. ÔÚ micro-service-cloud-consumer-dept-feign µÄ application.yml ÖÐÌí¼ÓÒÔÏÂÅäÖ㬽«³¬Ê±Ê±¼äÉèÖÃΪ 6 Ãë¡£ +6\. 在 micro-service-cloud-consumer-dept-feign çš„ application.yml 中添加以下é…�置,将超时时间设置为 6 秒。 @@ -376,8 +376,8 @@ public String DeptFeignTimeout() { ribbon: - ReadTimeout: 6000 #½¨Á¢Á¬½ÓËùÓõÄʱ¼ä£¬ÊÊÓÃÓÚÍøÂç×´¿öÕý³£µÄÇé¿öÏ£¬Á½¶ËÁ½¶ËÁ¬½ÓËùÓõÄʱ¼ä - ConnectionTimeout: 6000 #½¨Á¢Á¬½Óºó£¬·þÎñÆ÷¶ÁÈ¡µ½¿ÉÓÃ×ÊÔ´µÄʱ¼ä + ReadTimeout: 6000 #建立连接所用的时间,适用于网络状况正常的情况下,两端两端连接所用的时间 + ConnectionTimeout: 6000 #建立连接å�Žï¼Œæœ�务器读å�–到å�¯ç”¨èµ„æº�的时间 ``` @@ -385,22 +385,22 @@ ribbon: -> ×¢£ºÓÉÓÚ OpenFeign ¼¯³ÉÁË Ribbon £¬Æä·þÎñµ÷ÓÃÒÔ¼°¸ºÔؾùºâÔڵײ㶼ÊÇÒÀ¿¿ Ribbon ʵÏֵģ¬Òò´Ë OpenFeign ³¬Ê±¿ØÖÆÒ²ÊÇͨ¹ý Ribbon À´ÊµÏֵġ£ +> 注:由于 OpenFeign 集æˆ�了 Ribbon ,其æœ�务调用以å�Šè´Ÿè½½å�‡è¡¡åœ¨åº•层都是ä¾�é�  Ribbon 实现的,因此 OpenFeign 超时控制也是通过 Ribbon æ�¥å®žçŽ°çš„ã€‚ -7\. ÔÙ´ÎÖØÆô micro-service-cloud-consumer-dept-feign£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/feign/timeout¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. å†�次é‡�å�¯ micro-service-cloud-consumer-dept-feign,使用æµ�览器访问“http://eureka7001.com/consumer/dept/feign/timeoutâ€�,结果如下图。 -![OpenFeign ³¬Ê±¿ØÖÆ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10142942D-4.png) -ͼ5£ºOpenFeign ³¬Ê±¿ØÖÆ +![OpenFeign 超时控制](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10142942D-4.png) +图5:OpenFeign 超时控制 -## OpenFeign ÈÕÖ¾ÔöÇ¿ +## OpenFeign 日志增强 -OpenFeign ÌṩÁËÈÕÖ¾´òÓ¡¹¦ÄÜ£¬ÎÒÃÇ¿ÉÒÔͨ¹ýÅäÖõ÷ÕûÈÕÖ¾¼¶±ð£¬À´Á˽âÇëÇóµÄϸ½Ú¡£ +OpenFeign æ��供了日志打å�°åŠŸèƒ½ï¼Œæˆ‘ä»¬å�¯ä»¥é€šè¿‡é…�置调整日志级别,æ�¥äº†è§£è¯·æ±‚的细节。 -Feign Ϊÿһ¸ö FeignClient ¶¼ÌṩÁËÒ»¸ö feign.Logger ʵÀý£¬Í¨¹ýËü¿ÉÒÔ¶Ô OpenFeign ·þÎñ°ó¶¨½Ó¿ÚµÄµ÷ÓÃÇé¿ö½øÐÐ¼à¿Ø¡£ +Feign 为æ¯�一个 FeignClient 都æ��供了一个 feign.Logger 实例,通过它å�¯ä»¥å¯¹ OpenFeign æœ�务绑定接å�£çš„调用情况进行监控。 -OpenFeign ÈÕÖ¾´òÓ¡¹¦ÄܵĿªÆô·½Ê½±È½Ï¼òµ¥£¬ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý½øÐÐÑÝʾ¡£ +OpenFeign 日志打å�°åŠŸèƒ½çš„å¼€å�¯æ–¹å¼�比较简å�•,下é�¢æˆ‘们就通过一个实例进行演示。 -1\. ÔÚ micro-service-cloud-consumer-dept-feign µÄ application.yml ÖÐÅäÖÃÒÔÏÂÄÚÈÝ¡£ +1\. 在 micro-service-cloud-consumer-dept-feign çš„ application.yml 中é…�置以下内容。 @@ -411,7 +411,7 @@ OpenFeign logging: level: - #feign ÈÕÖ¾ÒÔʲôÑùµÄ¼¶±ð¼à¿Ø¸Ã½Ó¿Ú + #feign 日志以什么样的级别监控该接å�£ net.biancheng.c.service.DeptFeignService: debug ``` @@ -419,14 +419,14 @@ logging: -ÒÔÉÏÅäÖÃ˵Ã÷ÈçÏ£º +以上é…�置说明如下: -* net.biancheng.c.service.DeptFeignService ÊÇ¿ªÆô @FeignClient ×¢½âµÄ½Ó¿Ú£¨¼´·þÎñ°ó¶¨½Ó¿Ú£©µÄÍêÕûÀàÃû¡£Ò²¿ÉÒÔÖ»ÅäÖò¿·Ö·¾¶£¬±íʾ¼à¿Ø¸Ã·¾¶ÏµÄËùÓзþÎñ°ó¶¨½Ó¿Ú -* debug£º±íʾ¼àÌý¸Ã½Ó¿ÚµÄÈÕÖ¾¼¶±ð¡£ +* net.biancheng.c.service.DeptFeignService 是开å�¯ @FeignClient 注解的接å�£ï¼ˆå�³æœ�务绑定接å�£ï¼‰çš„完整类å��。也å�¯ä»¥å�ªé…�置部分路径,表示监控该路径下的所有æœ�务绑定接å�£ +* debug:表示监å�¬è¯¥æŽ¥å�£çš„æ—¥å¿—级别。 -ÒÔÉÏÅäÖõĺ¬Òå¾ÍÊÇ£¬OpenFeign ÒÔ debug ¼¶±ð¼à¿Ø net.biancheng.c.service.DeptFeignService ½Ó¿Ú¡£ +以上é…�置的å�«ä¹‰å°±æ˜¯ï¼ŒOpenFeign 以 debug 级别监控 net.biancheng.c.service.DeptFeignService 接å�£ã€‚ -2. ÔÚ net.biancheng.c. config °üÏ´´½¨Ò»¸öÃûΪ ConfigBean µÄÅäÖÃÀ࣬´úÂëÈçÏ¡£ +2. 在 net.biancheng.c. config 包下创建一个å��为 ConfigBean çš„é…�置类,代ç �如下。 @@ -441,8 +441,8 @@ import org.springframework.context.annotation.Configuration; @Configuration public class ConfigBean { /** - * OpenFeign ÈÕÖ¾ÔöÇ¿ - * ÅäÖà OpenFeign ¼Ç¼ÄÄЩÄÚÈÝ + * OpenFeign 日志增强 + * é…�ç½® OpenFeign 记录哪些内容 */ @Bean Logger.Level feginLoggerLevel() { @@ -456,16 +456,16 @@ public class ConfigBean { -¸ÃÅäÖõÄ×÷ÓÃÊÇͨ¹ýÅäÖÃµÄ Logger.Level ¶ÔÏó¸æËß OpenFeign ¼Ç¼ÄÄЩÈÕÖ¾ÄÚÈÝ¡£ +该é…�置的作用是通过é…�置的 Logger.Level 对象告诉 OpenFeign 记录哪些日志内容。 -Logger.Level µÄ¾ßÌå¼¶±ðÈçÏ£º +Logger.Level 的具体级别如下: -* NONE£º²»¼Ç¼ÈκÎÐÅÏ¢¡£ -* BASIC£º½ö¼Ç¼ÇëÇó·½·¨¡¢URL ÒÔ¼°ÏìӦ״̬ÂëºÍÖ´ÐÐʱ¼ä¡£ -* HEADERS£º³ýÁ˼Ǽ BASIC ¼¶±ðµÄÐÅÏ¢Í⣬»¹»á¼Ç¼ÇëÇóºÍÏìÓ¦µÄÍ·ÐÅÏ¢¡£ -* FULL£º¼Ç¼ËùÓÐÇëÇóÓëÏìÓ¦µÄÃ÷ϸ£¬°üÀ¨Í·ÐÅÏ¢¡¢ÇëÇóÌå¡¢ÔªÊý¾ÝµÈµÈ¡£ +* NONE:ä¸�记录任何信æ�¯ã€‚ +* BASIC:仅记录请求方法ã€�URL 以å�Šå“�应状æ€�ç �和执行时间。 +* HEADERS:除了记录 BASIC 级别的信æ�¯å¤–,还会记录请求和å“�应的头信æ�¯ã€‚ +* FULL:记录所有请求与å“�应的明细,包括头信æ�¯ã€�请求体ã€�元数æ�®ç­‰ç­‰ã€‚ -3\. ÖØÆô micro-service-cloud-consumer-dept-feign£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/list¡±£¬¿ØÖÆÌ¨Êä³öÈçÏ¡£ +3\. é‡�å�¯ micro-service-cloud-consumer-dept-feign,使用æµ�览器访问“http://eureka7001.com/consumer/dept/listâ€�,控制å�°è¾“出如下。 ``` 2021-10-12 14:33:07.408 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] ---> GET http://MICROSERVICECLOUDPROVIDERDEPT/dept/list HTTP/1.1 @@ -477,10 +477,10 @@ Logger.Level 2021-10-12 14:33:07.983 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] keep-alive: timeout=60 2021-10-12 14:33:07.983 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] transfer-encoding: chunked 2021-10-12 14:33:07.983 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] -2021-10-12 14:33:07.991 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] [{"deptNo":1,"deptName":"¿ª·¢²¿","dbSource":"bianchengbang_jdbc"},{"deptNo":2,"deptName":"ÈËʲ¿","dbSource":"bianchengbang_jdbc"},{"deptNo":3,"deptName":"²ÆÎñ²¿","dbSource":"bianchengbang_jdbc"},{"deptNo":4,"deptName":"Êг¡²¿","dbSource":"bianchengbang_jdbc"},{"deptNo":5,"deptName":"ÔËά²¿","dbSource":"bianchengbang_jdbc"}] +2021-10-12 14:33:07.991 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] [{"deptNo":1,"deptName":"å¼€å�‘部","dbSource":"bianchengbang_jdbc"},{"deptNo":2,"deptName":"人事部","dbSource":"bianchengbang_jdbc"},{"deptNo":3,"deptName":"财务部","dbSource":"bianchengbang_jdbc"},{"deptNo":4,"deptName":"市场部","dbSource":"bianchengbang_jdbc"},{"deptNo":5,"deptName":"è¿�维部","dbSource":"bianchengbang_jdbc"}] 2021-10-12 14:33:07.991 DEBUG 13388 --- [p-nio-80-exec-2] n.biancheng.c.service.DeptFeignService : [DeptFeignService#list] <--- END HTTP (341-byte body)``` ``` -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudRibbon.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudRibbon.md" index 74eff0a..61ad360 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudRibbon.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudRibbon.md" @@ -1,87 +1,87 @@ -Spring Cloud Ribbon ÊÇÒ»Ì×»ùÓÚ Netflix Ribbon ʵÏֵĿͻ§¶Ë¸ºÔؾùºâºÍ·þÎñµ÷Óù¤¾ß¡£ +Spring Cloud Ribbon 是一套基于 Netflix Ribbon 实现的客户端负载å�‡è¡¡å’Œæœ�务调用工具。 -Netflix Ribbon ÊÇ Netflix ¹«Ë¾·¢²¼µÄ¿ªÔ´×é¼þ£¬ÆäÖ÷Òª¹¦ÄÜÊÇÌṩ¿Í»§¶ËµÄ¸ºÔؾùºâËã·¨ºÍ·þÎñµ÷Óá£Spring Cloud ½«ÆäÓë Netflix ÖÐµÄÆäËû¿ªÔ´·þÎñ×é¼þ£¨ÀýÈç Eureka¡¢Feign ÒÔ¼° Hystrix µÈ£©Ò»ÆðÕûºÏ½ø Spring Cloud Netflix Ä£¿éÖУ¬ÕûºÏºóÈ«³ÆÎª Spring Cloud Netflix Ribbon¡£ +Netflix Ribbon 是 Netflix å…¬å�¸å�‘布的开æº�组件,其主è¦�功能是æ��供客户端的负载å�‡è¡¡ç®—法和æœ�务调用。Spring Cloud 将其与 Netflix 中的其他开æº�æœ�务组件(例如 Eurekaã€�Feign 以å�Š Hystrix 等)一起整å�ˆè¿› Spring Cloud Netflix 模å�—中,整å�ˆå�Žå…¨ç§°ä¸º Spring Cloud Netflix Ribbon。 -Ribbon ÊÇ Spring Cloud Netflix Ä£¿éµÄ×ÓÄ£¿é£¬ËüÊÇ Spring Cloud ¶Ô Netflix Ribbon µÄ¶þ´Î·â×°¡£Í¨¹ýËü£¬ÎÒÃÇ¿ÉÒÔ½«ÃæÏò·þÎñµÄ REST Ä£°å£¨RestTemplate£©ÇëÇóת»»Îª¿Í»§¶Ë¸ºÔؾùºâµÄ·þÎñµ÷Óᣠ+Ribbon 是 Spring Cloud Netflix 模å�—çš„å­�模å�—,它是 Spring Cloud 对 Netflix Ribbon 的二次å°�装。通过它,我们å�¯ä»¥å°†é�¢å�‘æœ�务的 REST 模æ�¿ï¼ˆRestTemplate)请求转æ�¢ä¸ºå®¢æˆ·ç«¯è´Ÿè½½å�‡è¡¡çš„æœ�务调用。 -Ribbon ÊÇ Spring Cloud ÌåϵÖÐ×îºËÐÄ¡¢×îÖØÒªµÄ×é¼þÖ®Ò»¡£ËüËäȻֻÊÇÒ»¸ö¹¤¾ßÀàÐ͵Ŀò¼Ü£¬²¢²»Ïñ Eureka Server£¨·þÎñ×¢²áÖÐÐÄ£©ÄÇÑùÐèÒª¶ÀÁ¢²¿Ê𣬵«Ëü¼¸ºõ´æÔÚÓÚÿһ¸öʹÓà Spring Cloud ¹¹½¨µÄ΢·þÎñÖС£ +Ribbon 是 Spring Cloud 体系中最核心ã€�最é‡�è¦�的组件之一。它虽然å�ªæ˜¯ä¸€ä¸ªå·¥å…·ç±»åž‹çš„æ¡†æž¶ï¼Œå¹¶ä¸�åƒ� Eureka Server(æœ�务注册中心)那样需è¦�独立部署,但它几乎存在于æ¯�一个使用 Spring Cloud 构建的微æœ�务中。 -Spring Cloud ΢·þÎñÖ®¼äµÄµ÷Óã¬API Íø¹ØµÄÇëÇóת·¢µÈÄÚÈÝ£¬Êµ¼ÊÉ϶¼ÊÇͨ¹ý Spring Cloud Ribbon À´ÊµÏֵ쬰üÀ¨ºóÐøÎÒÃÇÒª½éÉÜµÄ [OpenFeign](http://c.biancheng.net/springcloud/open-feign.html) Ò²ÊÇ»ùÓÚËüʵÏֵġ£ +Spring Cloud å¾®æœ�务之间的调用,API 网关的请求转å�‘等内容,实际上都是通过 Spring Cloud Ribbon æ�¥å®žçŽ°çš„ï¼ŒåŒ…æ‹¬å�Žç»­æˆ‘们è¦�介ç»�çš„ [OpenFeign](http://c.biancheng.net/springcloud/open-feign.html) 也是基于它实现的。 -## ¸ºÔؾùºâ +## è´Ÿè½½å�‡è¡¡ -ÔÚÈκÎÒ»¸öϵͳÖУ¬¸ºÔؾùºâ¶¼ÊÇÒ»¸öÊ®·ÖÖØÒªÇÒ²»µÃ²»È¥ÊµÊ©µÄÄÚÈÝ£¬ËüÊÇϵͳ´¦Àí¸ß²¢·¢¡¢»º½âÍøÂçѹÁ¦ºÍ·þÎñ¶ËÀ©ÈݵÄÖØÒªÊÖ¶ÎÖ®Ò»¡£ +在任何一个系统中,负载å�‡è¡¡éƒ½æ˜¯ä¸€ä¸ªå��分é‡�è¦�且ä¸�å¾—ä¸�去实施的内容,它是系统处ç�†é«˜å¹¶å�‘ã€�缓解网络压力和æœ�务端扩容的é‡�è¦�手段之一。 -¸ºÔؾùºâ£¨Load Balance£© £¬¼òµ¥µã˵¾ÍÊǽ«Óû§µÄÇëÇóƽ̯·ÖÅäµ½¶à¸ö·þÎñÆ÷ÉÏÔËÐУ¬ÒÔ´ïµ½À©Õ¹·þÎñÆ÷´ø¿í¡¢ÔöÇ¿Êý¾Ý´¦ÀíÄÜÁ¦¡¢Ôö¼ÓÍÌÍÂÁ¿¡¢Ìá¸ßÍøÂçµÄ¿ÉÓÃÐÔºÍÁé»îÐÔµÄÄ¿µÄ¡£ +è´Ÿè½½å�‡è¡¡ï¼ˆLoad Balance) ,简å�•点说就是将用户的请求平摊分é…�到多个æœ�务器上è¿�行,以达到扩展æœ�务器带宽ã€�增强数æ�®å¤„ç�†èƒ½åŠ›ã€�增加å�žå��é‡�ã€�æ��高网络的å�¯ç”¨æ€§å’Œç�µæ´»æ€§çš„目的。 -³£¼ûµÄ¸ºÔؾùºâ·½Ê½ÓÐÁ½ÖÖ£º +常è§�的负载å�‡è¡¡æ–¹å¼�有两ç§�: -* ·þÎñ¶Ë¸ºÔؾùºâ -* ¿Í»§¶Ë¸ºÔؾùºâ +* æœ�务端负载å�‡è¡¡ +* 客户端负载å�‡è¡¡ -#### ·þÎñ¶Ë¸ºÔؾùºâ +#### æœ�务端负载å�‡è¡¡ -·þÎñ¶Ë¸ºÔؾùºâÊÇ×î³£¼ûµÄ¸ºÔؾùºâ·½Ê½£¬Æä¹¤×÷Ô­ÀíÈçÏÂͼ¡£ +æœ�务端负载å�‡è¡¡æ˜¯æœ€å¸¸è§�的负载å�‡è¡¡æ–¹å¼�,其工作原ç�†å¦‚下图。 -![·þÎñ¶Ë¸ºÔؾùºâ¹¤×÷Ô­Àí](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10122164F-0.png) -ͼ1£º·þÎñ¶Ë¸ºÔؾùºâ¹¤×÷Ô­Àí +![æœ�务端负载å�‡è¡¡å·¥ä½œåŽŸç�†](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10122164F-0.png) +图1:æœ�务端负载å�‡è¡¡å·¥ä½œåŽŸç�† -·þÎñ¶Ë¸ºÔؾùºâÊÇÔÚ¿Í»§¶ËºÍ·þÎñ¶ËÖ®¼ä½¨Á¢Ò»¸ö¶ÀÁ¢µÄ¸ºÔؾùºâ·þÎñÆ÷£¬¸Ã·þÎñÆ÷¼È¿ÉÒÔÊÇÓ²¼þÉ豸£¨ÀýÈç F5£©£¬Ò²¿ÉÒÔÊÇÈí¼þ£¨ÀýÈç Nginx£©¡£Õâ¸ö¸ºÔؾùºâ·þÎñÆ÷ά»¤ÁËÒ»·Ý¿ÉÓ÷þÎñ¶ËÇåµ¥£¬È»ºóͨ¹ýÐÄÌø»úÖÆÀ´É¾³ý¹ÊÕϵķþÎñ¶Ë½Úµã£¬ÒÔ±£Ö¤Çåµ¥ÖеÄËùÓзþÎñ½Úµã¶¼ÊÇ¿ÉÒÔÕý³£·ÃÎʵġ£ +æœ�务端负载å�‡è¡¡æ˜¯åœ¨å®¢æˆ·ç«¯å’Œæœ�务端之间建立一个独立的负载å�‡è¡¡æœ�务器,该æœ�务器既å�¯ä»¥æ˜¯ç¡¬ä»¶è®¾å¤‡ï¼ˆä¾‹å¦‚ F5),也å�¯ä»¥æ˜¯è½¯ä»¶ï¼ˆä¾‹å¦‚ Nginx)。这个负载å�‡è¡¡æœ�务器维护了一份å�¯ç”¨æœ�务端清å�•,然å�Žé€šè¿‡å¿ƒè·³æœºåˆ¶æ�¥åˆ é™¤æ•…障的æœ�务端节点,以ä¿�è¯�清å�•中的所有æœ�务节点都是å�¯ä»¥æ­£å¸¸è®¿é—®çš„。 -µ±¿Í»§¶Ë·¢ËÍÇëÇóʱ£¬¸ÃÇëÇó²»»áÖ±½Ó·¢Ë͵½·þÎñ¶Ë½øÐд¦Àí£¬¶øÊÇÈ«²¿½»¸ø¸ºÔؾùºâ·þÎñÆ÷£¬ÓɸºÔؾùºâ·þÎñÆ÷°´ÕÕijÖÖËã·¨£¨ÀýÈçÂÖѯ¡¢Ëæ»úµÈ£©£¬´ÓÆäά»¤µÄ¿ÉÓ÷þÎñÇåµ¥ÖÐÑ¡ÔñÒ»¸ö·þÎñ¶Ë£¬È»ºó½øÐÐת·¢¡£ +当客户端å�‘é€�请求时,该请求ä¸�会直接å�‘é€�到æœ�务端进行处ç�†ï¼Œè€Œæ˜¯å…¨éƒ¨äº¤ç»™è´Ÿè½½å�‡è¡¡æœ�务器,由负载å�‡è¡¡æœ�务器按照æŸ�ç§�算法(例如轮询ã€�éš�机等),从其维护的å�¯ç”¨æœ�务清å�•中选择一个æœ�务端,然å�Žè¿›è¡Œè½¬å�‘。 -·þÎñ¶Ë¸ºÔؾùºâ¾ßÓÐÒÔÏÂÌØµã£º +æœ�务端负载å�‡è¡¡å…·æœ‰ä»¥ä¸‹ç‰¹ç‚¹ï¼š -* ÐèÒª½¨Á¢Ò»¸ö¶ÀÁ¢µÄ¸ºÔؾùºâ·þÎñÆ÷¡£ -* ¸ºÔؾùºâÊÇÔÚ¿Í»§¶Ë·¢ËÍÇëÇóºó½øÐеģ¬Òò´Ë¿Í»§¶Ë²¢²»ÖªµÀµ½µ×ÊÇÄĸö·þÎñ¶ËÌṩµÄ·þÎñ¡£ -* ¿ÉÓ÷þÎñ¶ËÇåµ¥´æ´¢ÔÚ¸ºÔؾùºâ·þÎñÆ÷ÉÏ¡£ +* 需è¦�建立一个独立的负载å�‡è¡¡æœ�务器。 +* è´Ÿè½½å�‡è¡¡æ˜¯åœ¨å®¢æˆ·ç«¯å�‘é€�请求å�Žè¿›è¡Œçš„,因此客户端并ä¸�知é�“到底是哪个æœ�务端æ��供的æœ�务。 +* å�¯ç”¨æœ�务端清å�•存储在负载å�‡è¡¡æœ�务器上。 -#### ¿Í»§¶Ë¸ºÔؾùºâ +#### 客户端负载å�‡è¡¡ -Ïà½ÏÓÚ·þÎñ¶Ë¸ºÔؾùºâ£¬¿Í»§¶Ë·þÎñÔÚ¾ùºâÔòÊÇÒ»¸ö±È½ÏСÖڵĸÅÄî¡£ +相较于æœ�务端负载å�‡è¡¡ï¼Œå®¢æˆ·ç«¯æœ�务在å�‡è¡¡åˆ™æ˜¯ä¸€ä¸ªæ¯”较å°�众的概念。 -¿Í»§¶Ë¸ºÔؾùºâµÄ¹¤×÷Ô­ÀíÈçÏÂͼ¡£ +客户端负载å�‡è¡¡çš„工作原ç�†å¦‚下图。 -![¿Í»§¶Ë¸ºÔؾùºâÔ­Àí](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1012212Q4-1.png) +![客户端负载å�‡è¡¡åŽŸç�†](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1012212Q4-1.png) -ͼ2£º¿Í»§¶Ë¸ºÔؾùºâ¹¤×÷Ô­Àí +图2:客户端负载å�‡è¡¡å·¥ä½œåŽŸç�† -¿Í»§¶Ë¸ºÔؾùºâÊǽ«¸ºÔؾùºâÂß¼­ÒÔ´úÂëµÄÐÎʽ·â×°µ½¿Í»§¶ËÉÏ£¬¼´¸ºÔؾùºâÆ÷λÓÚ¿Í»§¶Ë¡£¿Í»§¶Ëͨ¹ý·þÎñ×¢²áÖÐÐÄ£¨ÀýÈç Eureka Server£©»ñÈ¡µ½Ò»·Ý·þÎñ¶ËÌṩµÄ¿ÉÓ÷þÎñÇåµ¥¡£ÓÐÁË·þÎñÇåµ¥ºó£¬¸ºÔؾùºâÆ÷»áÔÚ¿Í»§¶Ë·¢ËÍÇëÇóǰͨ¹ý¸ºÔؾùºâË㷨ѡÔñÒ»¸ö·þÎñ¶ËʵÀýÔÙ½øÐзÃÎÊ£¬ÒÔ´ïµ½¸ºÔؾùºâµÄÄ¿µÄ£» +客户端负载å�‡è¡¡æ˜¯å°†è´Ÿè½½å�‡è¡¡é€»è¾‘以代ç �的形å¼�å°�装到客户端上,å�³è´Ÿè½½å�‡è¡¡å™¨ä½�于客户端。客户端通过æœ�务注册中心(例如 Eureka Server)获å�–到一份æœ�务端æ��供的å�¯ç”¨æœ�务清å�•。有了æœ�务清å�•å�Žï¼Œè´Ÿè½½å�‡è¡¡å™¨ä¼šåœ¨å®¢æˆ·ç«¯å�‘é€�请求å‰�通过负载å�‡è¡¡ç®—法选择一个æœ�务端实例å†�进行访问,以达到负载å�‡è¡¡çš„目的; -¿Í»§¶Ë¸ºÔؾùºâÒ²ÐèÒªÐÄÌø»úÖÆÈ¥Î¬»¤·þÎñ¶ËÇåµ¥µÄÓÐЧÐÔ£¬Õâ¸ö¹ý³ÌÐèÒªÅäºÏ·þÎñ×¢²áÖÐÐÄÒ»ÆðÍê³É¡£ +客户端负载å�‡è¡¡ä¹Ÿéœ€è¦�心跳机制去维护æœ�务端清å�•的有效性,这个过程需è¦�é…�å�ˆæœ�务注册中心一起完æˆ�。 -¿Í»§¶Ë¸ºÔؾùºâ¾ßÓÐÒÔÏÂÌØµã£º +客户端负载å�‡è¡¡å…·æœ‰ä»¥ä¸‹ç‰¹ç‚¹ï¼š -* ¸ºÔؾùºâÆ÷λÓÚ¿Í»§¶Ë£¬²»ÐèÒªµ¥¶À´î½¨Ò»¸ö¸ºÔؾùºâ·þÎñÆ÷¡£ -* ¸ºÔؾùºâÊÇÔÚ¿Í»§¶Ë·¢ËÍÇëÇóǰ½øÐеģ¬Òò´Ë¿Í»§¶ËÇå³þµØÖªµÀÊÇÄĸö·þÎñ¶ËÌṩµÄ·þÎñ¡£ -* ¿Í»§¶Ë¶¼Î¬»¤ÁËÒ»·Ý¿ÉÓ÷þÎñÇåµ¥£¬¶øÕâ·ÝÇåµ¥¶¼ÊÇ´Ó·þÎñ×¢²áÖÐÐÄ»ñÈ¡µÄ¡£ +* è´Ÿè½½å�‡è¡¡å™¨ä½�于客户端,ä¸�需è¦�å�•独æ�­å»ºä¸€ä¸ªè´Ÿè½½å�‡è¡¡æœ�务器。 +* è´Ÿè½½å�‡è¡¡æ˜¯åœ¨å®¢æˆ·ç«¯å�‘é€�请求å‰�进行的,因此客户端清楚地知é�“是哪个æœ�务端æ��供的æœ�务。 +* 客户端都维护了一份å�¯ç”¨æœ�务清å�•,而这份清å�•都是从æœ�务注册中心获å�–的。 -Ribbon ¾ÍÊÇÒ»¸ö»ùÓÚ HTTP ºÍ TCP µÄ¿Í»§¶Ë¸ºÔؾùºâÆ÷£¬µ±ÎÒÃǽ« Ribbon ºÍ Eureka Ò»ÆðʹÓÃʱ£¬Ribbon »á´Ó Eureka Server£¨·þÎñ×¢²áÖÐÐÄ£©ÖлñÈ¡·þÎñ¶ËÁÐ±í£¬È»ºóͨ¹ý¸ºÔؾùºâ²ßÂÔ½«ÇëÇó·Ö̯¸ø¶à¸ö·þÎñÌṩÕߣ¬´Ó¶ø´ïµ½¸ºÔؾùºâµÄÄ¿µÄ¡£ +Ribbon 就是一个基于 HTTP å’Œ TCP 的客户端负载å�‡è¡¡å™¨ï¼Œå½“我们将 Ribbon å’Œ Eureka 一起使用时,Ribbon 会从 Eureka Server(æœ�务注册中心)中获å�–æœ�务端列表,然å�Žé€šè¿‡è´Ÿè½½å�‡è¡¡ç­–略将请求分摊给多个æœ�务æ��供者,从而达到负载å�‡è¡¡çš„目的。 -#### ·þÎñ¶Ë¸ºÔؾùºâ VS ¿Í»§¶Ë¸ºÔؾùºâ +#### æœ�务端负载å�‡è¡¡ VS 客户端负载å�‡è¡¡ -ÏÂÃæÎÒÃǾÍÀ´¶Ô±ÈÏ£¬·þÎñ¶Ë¸ºÔؾùºâºÍ¿Í»§¶Ë¸ºÔؾùºâµ½µ×ÓÐÊ²Ã´Çø±ð£¬ÈçÏÂ±í¡£ +下é�¢æˆ‘们就æ�¥å¯¹æ¯”下,æœ�务端负载å�‡è¡¡å’Œå®¢æˆ·ç«¯è´Ÿè½½å�‡è¡¡åˆ°åº•有什么区别,如下表。 -| ²»Í¬µã | ·þÎñ¶Ë¸ºÔؾùºâ | ¿Í»§¶Ë¸ºÔؾùºâ | +| ä¸�å�Œç‚¹ | æœ�务端负载å�‡è¡¡ | 客户端负载å�‡è¡¡ | | ---------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| ÊÇ·ñÐèÒª½¨Á¢¸ºÔؾùºâ·þÎñÆ÷ | ÐèÒªÔÚ¿Í»§¶ËºÍ·þÎñ¶ËÖ®¼ä½¨Á¢Ò»¸ö¶ÀÁ¢µÄ¸ºÔؾùºâ·þÎñÆ÷¡£ | ½«¸ºÔؾùºâµÄÂß¼­ÒÔ´úÂëµÄÐÎʽ·â×°µ½¿Í»§¶ËÉÏ£¬Òò´Ë²»ÐèÒªµ¥¶À½¨Á¢¸ºÔؾùºâ·þÎñÆ÷¡£ | -| ÊÇ·ñÐèÒª·þÎñ×¢²áÖÐÐÄ | ²»ÐèÒª·þÎñ×¢²áÖÐÐÄ¡£ | ÐèÒª·þÎñ×¢²áÖÐÐÄ¡£ÔÚ¿Í»§¶Ë¸ºÔؾùºâÖУ¬ËùÓеĿͻ§¶ËºÍ·þÎñ¶Ë¶¼ÐèÒª½«ÆäÌṩµÄ·þÎñ×¢²áµ½·þÎñ×¢²áÖÐÐÄÉÏ¡£ | -| ¿ÉÓ÷þÎñÇåµ¥´æ´¢µÄλÖà | ¿ÉÓ÷þÎñÇåµ¥´æ´¢ÔÚλÓÚ¿Í»§¶ËÓë·þÎñÆ÷Ö®¼äµÄ¸ºÔؾùºâ·þÎñÆ÷ÉÏ¡£ | ËùÓеĿͻ§¶Ë¶¼Î¬»¤ÁËÒ»·Ý¿ÉÓ÷þÎñÇåµ¥£¬ÕâЩÇåµ¥¶¼ÊÇ´Ó·þÎñ×¢²áÖÐÐÄ»ñÈ¡µÄ¡£ | -| ¸ºÔؾùºâµÄʱ»ú | ÏȽ«ÇëÇó·¢Ë͵½¸ºÔؾùºâ·þÎñÆ÷£¬È»ºóÓɸºÔؾùºâ·þÎñÆ÷ͨ¹ý¸ºÔؾùºâËã·¨£¬ÔÚ¶à¸ö·þÎñ¶ËÖ®¼äÑ¡ÔñÒ»¸ö½øÐзÃÎÊ£»¼´ÔÚ·þÎñÆ÷¶ËÔÙ½øÐиºÔؾùºâËã·¨·ÖÅä¡£¼òµ¥µã˵¾ÍÊÇ£¬ÏÈ·¢ËÍÇëÇó£¬ÔÙ½øÐиºÔؾùºâ¡£ | ÔÚ·¢ËÍÇëÇóǰ£¬ÓÉλÓÚ¿Í»§¶ËµÄ·þÎñ¸ºÔؾùºâÆ÷£¨ÀýÈç Ribbon£©Í¨¹ý¸ºÔؾùºâË㷨ѡÔñÒ»¸ö·þÎñÆ÷£¬È»ºó½øÐзÃÎÊ¡£¼òµ¥µã˵¾ÍÊÇ£¬ÏȽøÐиºÔؾùºâ£¬ÔÙ·¢ËÍÇëÇó¡£ | -| ¿Í»§¶ËÊÇ·ñÁ˽â·þÎñÌṩ·½ÐÅÏ¢ | ÓÉÓÚ¸ºÔؾùºâÊÇÔÚ¿Í»§¶Ë·¢ËÍÇëÇóºó½øÐеģ¬Òò´Ë¿Í»§¶Ë²¢²»ÖªµÀµ½µ×ÊÇÄĸö·þÎñ¶ËÌṩµÄ·þÎñ¡£ | ¸ºÔؾùºâÊÇÔÚ¿Í»§¶Ë·¢ËÍÇëÇóǰ½øÐеģ¬Òò´Ë¿Í»§¶ËÇå³þµÄÖªµÀÊÇÄĸö·þÎñ¶ËÌṩµÄ·þÎñ¡£ | +| 是å�¦éœ€è¦�建立负载å�‡è¡¡æœ�务器 | 需è¦�在客户端和æœ�务端之间建立一个独立的负载å�‡è¡¡æœ�务器。 | 将负载å�‡è¡¡çš„逻辑以代ç �的形å¼�å°�装到客户端上,因此ä¸�需è¦�å�•独建立负载å�‡è¡¡æœ�务器。 | +| 是å�¦éœ€è¦�æœ�务注册中心 | ä¸�需è¦�æœ�务注册中心。 | 需è¦�æœ�务注册中心。在客户端负载å�‡è¡¡ä¸­ï¼Œæ‰€æœ‰çš„客户端和æœ�务端都需è¦�将其æ��供的æœ�务注册到æœ�务注册中心上。 | +| å�¯ç”¨æœ�务清å�•存储的ä½�ç½® | å�¯ç”¨æœ�务清å�•存储在ä½�于客户端与æœ�务器之间的负载å�‡è¡¡æœ�务器上。 | 所有的客户端都维护了一份å�¯ç”¨æœ�务清å�•,这些清å�•都是从æœ�务注册中心获å�–的。 | +| è´Ÿè½½å�‡è¡¡çš„æ—¶æœº | 先将请求å�‘é€�到负载å�‡è¡¡æœ�务器,然å�Žç”±è´Ÿè½½å�‡è¡¡æœ�务器通过负载å�‡è¡¡ç®—法,在多个æœ�务端之间选择一个进行访问;å�³åœ¨æœ�务器端å†�进行负载å�‡è¡¡ç®—法分é…�。简å�•点说就是,先å�‘é€�请求,å†�进行负载å�‡è¡¡ã€‚ | 在å�‘é€�请求å‰�,由ä½�于客户端的æœ�务负载å�‡è¡¡å™¨ï¼ˆä¾‹å¦‚ Ribbon)通过负载å�‡è¡¡ç®—法选择一个æœ�务器,然å�Žè¿›è¡Œè®¿é—®ã€‚简å�•点说就是,先进行负载å�‡è¡¡ï¼Œå†�å�‘é€�请求。 | +| 客户端是å�¦äº†è§£æœ�务æ��供方信æ�¯ | 由于负载å�‡è¡¡æ˜¯åœ¨å®¢æˆ·ç«¯å�‘é€�请求å�Žè¿›è¡Œçš„,因此客户端并ä¸�知é�“到底是哪个æœ�务端æ��供的æœ�务。 | è´Ÿè½½å�‡è¡¡æ˜¯åœ¨å®¢æˆ·ç«¯å�‘é€�请求å‰�进行的,因此客户端清楚的知é�“是哪个æœ�务端æ��供的æœ�务。 | -## Ribbon ʵÏÖ·þÎñµ÷Óà +## Ribbon 实现æœ�务调用 -Ribbon ¿ÉÒÔÓë RestTemplate£¨Rest Ä£°å£©ÅäºÏʹÓã¬ÒÔʵÏÖ΢·þÎñÖ®¼äµÄµ÷Óᣠ+Ribbon å�¯ä»¥ä¸Ž RestTemplate(Rest 模æ�¿ï¼‰é…�å�ˆä½¿ç”¨ï¼Œä»¥å®žçް微æœ�务之间的调用。 -RestTemplate ÊÇ Spring ¼Ò×åÖеÄÒ»¸öÓÃÓÚÏû·ÑµÚÈý·½ REST ·þÎñµÄÇëÇó¿ò¼Ü¡£RestTemplate ʵÏÖÁË¶Ô HTTP ÇëÇóµÄ·â×°£¬ÌṩÁËÒ»Ì×Ä£°å»¯µÄ·þÎñµ÷Ó÷½·¨¡£Í¨¹ýËü£¬Spring Ó¦ÓÿÉÒԺܷ½±ãµØ¶Ô¸÷ÖÖÀàÐ굀 HTTP ÇëÇó½øÐзÃÎÊ¡£ +RestTemplate 是 Spring å®¶æ—�中的一个用于消费第三方 REST æœ�务的请求框架。RestTemplate 实现了对 HTTP 请求的å°�装,æ��供了一套模æ�¿åŒ–çš„æœ�务调用方法。通过它,Spring 应用å�¯ä»¥å¾ˆæ–¹ä¾¿åœ°å¯¹å�„ç§�类型的 HTTP 请求进行访问。 -RestTemplate Õë¶Ô¸÷ÖÖÀàÐ굀 HTTP ÇëÇó¶¼ÌṩÁËÏàÓ¦µÄ·½·¨½øÐд¦Àí£¬ÀýÈç HEAD¡¢GET¡¢POST¡¢PUT¡¢DELETE µÈÀàÐ굀 HTTP ÇëÇ󣬷ֱð¶ÔÓ¦ RestTemplate ÖÐµÄ headForHeaders()¡¢getForObject()¡¢postForObject()¡¢put() ÒÔ¼° delete() ·½·¨¡£ +RestTemplate 针对å�„ç§�类型的 HTTP 请求都æ��供了相应的方法进行处ç�†ï¼Œä¾‹å¦‚ HEADã€�GETã€�POSTã€�PUTã€�DELETE 等类型的 HTTP 请求,分别对应 RestTemplate 中的 headForHeaders()ã€�getForObject()ã€�postForObject()ã€�put() 以å�Š delete() 方法。 -ÏÂÃæÎÒÃÇͨ¹ýÒ»¸ö¼òµ¥µÄʵÀý£¬À´ÑÝʾ Ribbon ÊÇÈçºÎʵÏÖ·þÎñµ÷Óõġ£ +下é�¢æˆ‘们通过一个简å�•的实例,æ�¥æ¼”示 Ribbon 是如何实现æœ�务调用的。 -1\. ÔÚÖ÷¹¤³Ì spring-cloud-demo2 Ï£¬´´½¨Ò»¸öÃûΪ micro-service-cloud-consumer-dept-80 µÄ΢·þÎñ£¬²¢ÔÚÆä pom.xml ÖÐÒýÈëËùÐèµÄÒÀÀµ£¬´úÂëÈçÏ¡£ +1\. 在主工程 spring-cloud-demo2 下,创建一个å��为 micro-service-cloud-consumer-dept-80 的微æœ�务,并在其 pom.xml 中引入所需的ä¾�赖,代ç �如下。 @@ -92,7 +92,7 @@ RestTemplate 4.0.0 - + spring-cloud-demo2 net.biancheng.c @@ -109,7 +109,7 @@ RestTemplate - + net.biancheng.c micro-service-cloud-api @@ -126,18 +126,18 @@ RestTemplate lombok true - + org.springframework.boot spring-boot-starter-test test - + org.springframework.cloud spring-cloud-starter-netflix-eureka-client - + org.springframework.cloud spring-cloud-starter-netflix-ribbon @@ -168,7 +168,7 @@ RestTemplate -2. ÔÚÀà·¾¶£¨¼´ /resource Ŀ¼£©Ï£¬Ð½¨Ò»¸öÅäÖÃÎļþ application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2. 在类路径(å�³ /resource 目录)下,新建一个é…�置文件 application.yml,é…�置内容如下。 @@ -176,22 +176,22 @@ RestTemplate ``` server: - port: 80 #¶Ë¿ÚºÅ + port: 80 #端å�£å�· -############################################# Spring Cloud Ribbon ¸ºÔؾùºâÅäÖÃ########################## +############################################# Spring Cloud Ribbon è´Ÿè½½å�‡è¡¡é…�ç½®########################## eureka: client: - register-with-eureka: false #±¾Î¢·þÎñΪ·þÎñÏû·ÑÕߣ¬²»ÐèÒª½«×Ô¼º×¢²áµ½·þÎñ×¢²áÖÐÐÄ - fetch-registry: true #±¾Î¢·þÎñΪ·þÎñÏû·ÑÕߣ¬ÐèÒªµ½·þÎñ×¢²áÖÐÐÄËÑË÷·þÎñ + register-with-eureka: false #本微æœ�务为æœ�务消费者,ä¸�需è¦�将自己注册到æœ�务注册中心 + fetch-registry: true #本微æœ�务为æœ�务消费者,需è¦�到æœ�务注册中心æ�œç´¢æœ�务 service-url: - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #·þÎñ×¢²áÖÐÐļ¯Èº + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #æœ�务注册中心集群 ``` -3\. ÔÚ net.biancheng.c.config °üÏ£¬´´½¨Ò»¸öÃûΪ ConfigBean µÄÅäÖÃÀ࣬½« RestTemplate ×¢Èëµ½ÈÝÆ÷ÖУ¬´úÂëÈçÏ¡£ +3\. 在 net.biancheng.c.config 包下,创建一个å��为 ConfigBean çš„é…�置类,将 RestTemplate 注入到容器中,代ç �如下。 @@ -209,12 +209,12 @@ import org.springframework.cloud.client.loadbalancer.LoadBalanced; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.client.RestTemplate; -// ÅäÖÃÀà×¢½â +// é…�置类注解 @Configuration public class ConfigBean { - @Bean //½« RestTemplate ×¢Èëµ½ÈÝÆ÷ÖÐ - @LoadBalanced //ÔÚ¿Í»§¶ËʹÓà RestTemplate ÇëÇó·þÎñ¶Ëʱ£¬¿ªÆô¸ºÔؾùºâ£¨Ribbon£© + @Bean //å°† RestTemplate 注入到容器中 + @LoadBalanced //在客户端使用 RestTemplate 请求æœ�务端时,开å�¯è´Ÿè½½å�‡è¡¡ï¼ˆRibbon) public RestTemplate getRestTemplate() { return new RestTemplate(); } @@ -226,7 +226,7 @@ public class ConfigBean { -4\. ÔÚ net.biancheng.c.controller °üÏ£¬´´½¨Ò»¸öÃûΪ DeptController_Consumer µÄ Controller£¬¸Ã Controller Öж¨ÒåµÄÇëÇóÓÃÓÚµ÷Ó÷þÎñ¶ËÌṩµÄ·þÎñ£¬´úÂëÈçÏ¡£ +4\. 在 net.biancheng.c.controller 包下,创建一个å��为 DeptController_Consumer çš„ Controller,该 Controller 中定义的请求用于调用æœ�务端æ��供的æœ�务,代ç �如下。 @@ -246,20 +246,20 @@ import java.util.List; @RestController public class DeptController_Consumer { - //private static final String REST_URL_PROVIDER_PREFIX = "http://localhost:8001/"; ÕâÖÖ·½Ê½ÊÇÖ±µ÷Ó÷þÎñ·½µÄ·½·¨£¬¸ù±¾Ã»ÓÐÓõ½ Spring Cloud + //private static final String REST_URL_PROVIDER_PREFIX = "http://localhost:8001/"; è¿™ç§�æ–¹å¼�是直调用æœ�务方的方法,根本没有用到 Spring Cloud - //ÃæÏò΢·þÎñ±à³Ì£¬¼´Í¨¹ý΢·þÎñµÄÃû³ÆÀ´»ñÈ¡µ÷ÓõØÖ· - private static final String REST_URL_PROVIDER_PREFIX = "http://MICROSERVICECLOUDPROVIDERDEPT"; // ʹÓÃ×¢²áµ½ Spring Cloud Eureka ·þÎñ×¢²áÖÐÐÄÖеķþÎñ£¬¼´ application.name + //é�¢å�‘å¾®æœ�务编程,å�³é€šè¿‡å¾®æœ�务的å��ç§°æ�¥èŽ·å�–调用地å�€ + private static final String REST_URL_PROVIDER_PREFIX = "http://MICROSERVICECLOUDPROVIDERDEPT"; // 使用注册到 Spring Cloud Eureka æœ�务注册中心中的æœ�务,å�³ application.name @Autowired - private RestTemplate restTemplate; //RestTemplate ÊÇÒ»ÖÖ¼òµ¥±ã½ÝµÄ·ÃÎÊ restful ·þÎñÄ£°åÀ࣬ÊÇ Spring ÌṩµÄÓÃÓÚ·ÃÎÊ Rest ·þÎñµÄ¿Í»§¶ËÄ£°å¹¤¾ß¼¯£¬ÌṩÁ˶àÖÖ±ã½Ý·ÃÎÊÔ¶³Ì HTTP ·þÎñµÄ·½·¨ + private RestTemplate restTemplate; //RestTemplate 是一ç§�简å�•便æ�·çš„访问 restful æœ�务模æ�¿ç±»ï¼Œæ˜¯ Spring æ��供的用于访问 Rest æœ�务的客户端模æ�¿å·¥å…·é›†ï¼Œæ��供了多ç§�便æ�·è®¿é—®è¿œç¨‹ HTTP æœ�务的方法 - //»ñȡָ¶¨²¿ÃÅÐÅÏ¢ + //获å�–指定部门信æ�¯ @RequestMapping(value = "/consumer/dept/get/{id}") public Dept get(@PathVariable("id") Integer id) { return restTemplate.getForObject(REST_URL_PROVIDER_PREFIX + "/dept/get/" + id, Dept.class); } - //»ñÈ¡²¿ÃÅÁбí + //获å�–部门列表 @RequestMapping(value = "/consumer/dept/list") public List list() { return restTemplate.getForObject(REST_URL_PROVIDER_PREFIX + "/dept/list", List.class); @@ -271,7 +271,7 @@ public class DeptController_Consumer { -5\. ÔÚ micro-service-cloud-consumer-dept-80 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableEurekaClient ×¢½âÀ´¿ªÆô Eureka ¿Í»§¶Ë¹¦ÄÜ£¬´úÂëÈçÏ¡£ +5\. 在 micro-service-cloud-consumer-dept-80 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableEurekaClient 注解æ�¥å¼€å�¯ Eureka 客户端功能,代ç �如下。 @@ -300,32 +300,32 @@ public class MicroServiceCloudConsumerDept80Application { -6\. ÒÀ´ÎÆô¶¯·þÎñ×¢²áÖÐÐÄ micro-service-cloud-eureka-7001¡¢·þÎñÌṩÕß micro-service-cloud-provider-dept-8001 ÒÔ¼°·þÎñÏû·ÑÕß micro-service-cloud-consumer-dept-80¡£ +6\. ä¾�次å�¯åЍæœ�务注册中心 micro-service-cloud-eureka-7001ã€�æœ�务æ��供者 micro-service-cloud-provider-dept-8001 以å�Šæœ�务消费者 micro-service-cloud-consumer-dept-80。 -7\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com:80/consumer/dept/list¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. 使用æµ�览器访问“http://eureka7001.com:80/consumer/dept/listâ€�,结果如下图。 -![Ribbon ʵÏÖ·þÎñµ÷ÓÃ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101221CG-2.png) -ͼ3£ºRibbon ʵÏÖ·þÎñµ÷Óà +![Ribbon 实现æœ�务调用](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/101221CG-2.png) +图3:Ribbon 实现æœ�务调用 -## Ribbon ʵÏÖ¸ºÔؾùºâ +## Ribbon 实现负载å�‡è¡¡ -Ribbon ÊÇÒ»¸ö¿Í»§¶ËµÄ¸ºÔؾùºâÆ÷£¬Ëü¿ÉÒÔÓë Eureka ÅäºÏʹÓÃÇáËɵØÊµÏÖ¿Í»§¶ËµÄ¸ºÔؾùºâ¡£Ribbon »áÏÈ´Ó Eureka Server£¨·þÎñ×¢²áÖÐÐÄ£©È¥»ñÈ¡·þÎñ¶ËÁÐ±í£¬È»ºóͨ¹ý¸ºÔؾùºâ²ßÂÔ½«ÇëÇó·Ö̯¸ø¶à¸ö·þÎñ¶Ë£¬´Ó¶ø´ïµ½¸ºÔؾùºâµÄÄ¿µÄ¡£ +Ribbon 是一个客户端的负载å�‡è¡¡å™¨ï¼Œå®ƒå�¯ä»¥ä¸Ž Eureka é…�å�ˆä½¿ç”¨è½»æ�¾åœ°å®žçŽ°å®¢æˆ·ç«¯çš„è´Ÿè½½å�‡è¡¡ã€‚Ribbon 会先从 Eureka Server(æœ�务注册中心)去获å�–æœ�务端列表,然å�Žé€šè¿‡è´Ÿè½½å�‡è¡¡ç­–略将请求分摊给多个æœ�务端,从而达到负载å�‡è¡¡çš„目的。 -Spring Cloud Ribbon ÌṩÁËÒ»¸ö IRule ½Ó¿Ú£¬¸Ã½Ó¿ÚÖ÷ÒªÓÃÀ´¶¨Òå¸ºÔØ¾ùºâ²ßÂÔ£¬ËüÓÐ 7 ¸öĬÈÏʵÏÖÀ࣬ÿһ¸öʵÏÖÀà¶¼ÊÇÒ»ÖÖ¸ºÔؾùºâ²ßÂÔ¡£ +Spring Cloud Ribbon æ��供了一个 IRule 接å�£ï¼Œè¯¥æŽ¥å�£ä¸»è¦�用æ�¥å®šä¹‰è´Ÿè½½å�‡è¡¡ç­–略,它有 7 个默认实现类,æ¯�一个实现类都是一ç§�è´Ÿè½½å�‡è¡¡ç­–略。 -| ÐòºÅ | ʵÏÖÀà | ¸ºÔؾùºâ²ßÂÔ | +| åº�å�· | 实现类 | è´Ÿè½½å�‡è¡¡ç­–ç•¥ | | ---- | ------------------------- | ------------------------------------------------------------ | -| 1 | RoundRobinRule | °´ÕÕÏßÐÔÂÖѯ²ßÂÔ£¬¼´°´ÕÕÒ»¶¨µÄ˳ÐòÒÀ´Îѡȡ·þÎñʵÀý | -| 2 | RandomRule | Ëæ»úѡȡһ¸ö·þÎñʵÀý | -| 3 | RetryRule | °´ÕÕ RoundRobinRule£¨ÂÖѯ£©µÄ²ßÂÔÀ´»ñÈ¡·þÎñ£¬Èç¹û»ñÈ¡µÄ·þÎñʵÀýΪ null »òÒѾ­Ê§Ð§£¬ÔòÔÚÖ¸¶¨µÄʱ¼äÖ®ÄÚ²»¶ÏµØ½øÐÐÖØÊÔ£¨ÖØÊÔʱ»ñÈ¡·þÎñµÄ²ßÂÔ»¹ÊÇ RoundRobinRule Öж¨ÒåµÄ²ßÂÔ£©£¬Èç¹û³¬¹ýÖ¸¶¨Ê±¼äÒÀȻû»ñÈ¡µ½·þÎñʵÀýÔò·µ»Ø null ¡£ | -| 4 | WeightedResponseTimeRule | WeightedResponseTimeRule ÊÇ RoundRobinRule µÄÒ»¸ö×ÓÀ࣬Ëü¶Ô RoundRobinRule µÄ¹¦ÄܽøÐÐÁËÀ©Õ¹¡£¸ù¾Ýƽ¾ùÏìӦʱ¼ä£¬À´¼ÆËãËùÓзþÎñʵÀýµÄÈ¨ÖØ£¬ÏìӦʱ¼äÔ½¶ÌµÄ·þÎñʵÀýÈ¨ÖØÔ½¸ß£¬±»Ñ¡ÖеĸÅÂÊÔ½´ó¡£¸ÕÆô¶¯Ê±£¬Èç¹ûͳ¼ÆÐÅÏ¢²»×㣬ÔòʹÓÃÏßÐÔÂÖѯ²ßÂÔ£¬µÈÐÅÏ¢×㹻ʱ£¬ÔÙÇл»µ½ WeightedResponseTimeRule¡£ | -| 5 | BestAvailableRule | ¼Ì³Ð×Ô ClientConfigEnabledRoundRobinRule¡£ÏȹýÂ˵ã¹ÊÕÏ»òʧЧµÄ·þÎñʵÀý£¬È»ºóÔÙÑ¡Ôñ²¢·¢Á¿×îСµÄ·þÎñʵÀý¡£ | -| 6 | AvailabilityFilteringRule | ÏȹýÂ˵ô¹ÊÕÏ»òʧЧµÄ·þÎñʵÀý£¬È»ºóÔÙÑ¡Ôñ²¢·¢Á¿½ÏСµÄ·þÎñʵÀý¡£ | -| 7 | ZoneAvoidanceRule | ĬÈϵĸºÔؾùºâ²ßÂÔ£¬×ÛºÏÅжϷþÎñËùÔÚÇøÓò£¨zone£©µÄÐÔÄܺͷþÎñ£¨server£©µÄ¿ÉÓÃÐÔ£¬À´Ñ¡Ôñ·þÎñʵÀý¡£ÔÚûÓÐÇøÓòµÄ»·¾³Ï£¬¸Ã²ßÂÔÓëÂÖѯ£¨RandomRule£©²ßÂÔÀàËÆ¡£ | +| 1 | RoundRobinRule | 按照线性轮询策略,å�³æŒ‰ç…§ä¸€å®šçš„顺åº�ä¾�次选å�–æœ�务实例 | +| 2 | RandomRule | éš�机选å�–一个æœ�务实例 | +| 3 | RetryRule | 按照 RoundRobinRule(轮询)的策略æ�¥èŽ·å�–æœ�务,如果获å�–çš„æœ�务实例为 null 或已ç»�失效,则在指定的时间之内ä¸�断地进行é‡�试(é‡�试时获å�–æœ�务的策略还是 RoundRobinRule 中定义的策略),如果超过指定时间ä¾�然没获å�–到æœ�务实例则返回 null 。 | +| 4 | WeightedResponseTimeRule | WeightedResponseTimeRule 是 RoundRobinRule 的一个å­�类,它对 RoundRobinRule 的功能进行了扩展。根æ�®å¹³å�‡å“�应时间,æ�¥è®¡ç®—所有æœ�务实例的æ�ƒé‡�,å“�应时间越短的æœ�务实例æ�ƒé‡�越高,被选中的概率越大。刚å�¯åŠ¨æ—¶ï¼Œå¦‚æžœç»Ÿè®¡ä¿¡æ�¯ä¸�足,则使用线性轮询策略,等信æ�¯è¶³å¤Ÿæ—¶ï¼Œå†�切æ�¢åˆ° WeightedResponseTimeRule。 | +| 5 | BestAvailableRule | 继承自 ClientConfigEnabledRoundRobinRule。先过滤点故障或失效的æœ�务实例,然å�Žå†�选择并å�‘é‡�最å°�çš„æœ�务实例。 | +| 6 | AvailabilityFilteringRule | 先过滤掉故障或失效的æœ�务实例,然å�Žå†�选择并å�‘é‡�较å°�çš„æœ�务实例。 | +| 7 | ZoneAvoidanceRule | 默认的负载å�‡è¡¡ç­–略,综å�ˆåˆ¤æ–­æœ�务所在区域(zone)的性能和æœ�务(server)的å�¯ç”¨æ€§ï¼Œæ�¥é€‰æ‹©æœ�务实例。在没有区域的环境下,该策略与轮询(RandomRule)策略类似。 | -ÏÂÃæÎÒÃǾÍÀ´Í¨¹ýÒ»¸öʵÀýÀ´Ñé֤ϣ¬Ribbon ĬÈÏÊÇʹÓÃʲô²ßÂÔѡȡ·þÎñʵÀýµÄ¡£ +下é�¢æˆ‘们就æ�¥é€šè¿‡ä¸€ä¸ªå®žä¾‹æ�¥éªŒè¯�下,Ribbon 默认是使用什么策略选å�–æœ�务实例的。 -1. ÔÚ MySQL Êý¾Ý¿âÖÐÖ´ÐÐÒÔÏ SQL Óï¾ä£¬×¼±¸²âÊÔÊý¾Ý¡£ +1. 在 MySQL æ•°æ�®åº“中执行以下 SQL 语å�¥ï¼Œå‡†å¤‡æµ‹è¯•æ•°æ�®ã€‚ ``` DROP DATABASE IF EXISTS spring_cloud_db2; @@ -341,11 +341,11 @@ CREATE TABLE `dept` ( PRIMARY KEY (`dept_no`) ) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci; -INSERT INTO `dept` VALUES ('1', '¿ª·¢²¿', DATABASE()); -INSERT INTO `dept` VALUES ('2', 'ÈËʲ¿', DATABASE()); -INSERT INTO `dept` VALUES ('3', '²ÆÎñ²¿', DATABASE()); -INSERT INTO `dept` VALUES ('4', 'Êг¡²¿', DATABASE()); -INSERT INTO `dept` VALUES ('5', 'ÔËά²¿', DATABASE()); +INSERT INTO `dept` VALUES ('1', 'å¼€å�‘部', DATABASE()); +INSERT INTO `dept` VALUES ('2', '人事部', DATABASE()); +INSERT INTO `dept` VALUES ('3', '财务部', DATABASE()); +INSERT INTO `dept` VALUES ('4', '市场部', DATABASE()); +INSERT INTO `dept` VALUES ('5', 'è¿�维部', DATABASE()); ############################################################################################# @@ -363,15 +363,15 @@ CREATE TABLE `dept` ( PRIMARY KEY (`dept_no`) ) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci; -INSERT INTO `dept` VALUES ('1', '¿ª·¢²¿', DATABASE()); -INSERT INTO `dept` VALUES ('2', 'ÈËʲ¿', DATABASE()); -INSERT INTO `dept` VALUES ('3', '²ÆÎñ²¿', DATABASE()); -INSERT INTO `dept` VALUES ('4', 'Êг¡²¿', DATABASE()); -INSERT INTO `dept` VALUES ('5', 'ÔËά²¿', DATABASE());``` +INSERT INTO `dept` VALUES ('1', 'å¼€å�‘部', DATABASE()); +INSERT INTO `dept` VALUES ('2', '人事部', DATABASE()); +INSERT INTO `dept` VALUES ('3', '财务部', DATABASE()); +INSERT INTO `dept` VALUES ('4', '市场部', DATABASE()); +INSERT INTO `dept` VALUES ('5', 'è¿�维部', DATABASE());``` -2\. ²Î¿¼ micro-service-cloud-provider-dept-8001£¬ÔÙ´´½¨Á½¸ö΢·þÎñ Moudle £ºmicro-service-cloud-provider-dept-8002 ºÍ micro-service-cloud-provider-dept-8003¡£ +2\. å�‚考 micro-service-cloud-provider-dept-8001,å†�创建两个微æœ�务 Moudle :micro-service-cloud-provider-dept-8002 å’Œ micro-service-cloud-provider-dept-8003。 -3\. ÔÚ micro-service-cloud-provider-dept-8002 ÖÐ application.yml ÖУ¬Ð޸Ķ˿ںš¢Êý¾Ý¿âÁ¬½ÓÐÅÏ¢ÒÔ¼°×Ô¶¨Òå·þÎñÃû³ÆÐÅÏ¢£¨eureka.instance.instance-id£©£¬Ð޸ĵÄÅäÖÃÈçÏ¡£ +3\. 在 micro-service-cloud-provider-dept-8002 中 application.yml 中,修改端å�£å�·ã€�æ•°æ�®åº“连接信æ�¯ä»¥å�Šè‡ªå®šä¹‰æœ�务å��ç§°ä¿¡æ�¯ï¼ˆeureka.instance.instance-id),修改的é…�置如下。 ``` @@ -380,26 +380,26 @@ INSERT INTO `dept` VALUES ('5', ' ``` server: - port: 8002 #¶Ë¿ÚºÅÐÞ¸ÄΪ 8002 + port: 8002 #端å�£å�·ä¿®æ”¹ä¸º 8002 spring: application: - name: microServiceCloudProviderDept #΢·þÎñÃû³Æ£¬²»×öÐ޸ģ¬Óë micro-service-cloud-provider-dept-8001 µÄÅäÖñ£³ÖÒ»Ö + name: microServiceCloudProviderDept #å¾®æœ�务å��称,ä¸�å�šä¿®æ”¹ï¼Œä¸Ž micro-service-cloud-provider-dept-8001 çš„é…�ç½®ä¿�æŒ�一致 datasource: - username: root #Êý¾Ý¿âµÇ½Óû§Ãû - password: root #Êý¾Ý¿âµÇ½ÃÜÂë - url: jdbc:mysql://127.0.0.1:3306/spring_cloud_db2 #Êý¾Ý¿âurl - driver-class-name: com.mysql.jdbc.Driver #Êý¾Ý¿âÇý¶¯ + username: root #æ•°æ�®åº“登陆用户å�� + password: root #æ•°æ�®åº“登陆密ç � + url: jdbc:mysql://127.0.0.1:3306/spring_cloud_db2 #æ•°æ�®åº“url + driver-class-name: com.mysql.jdbc.Driver #æ•°æ�®åº“驱动 eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - #defaultZone: http://eureka7001:7001/eureka #Õâ¸öµØÖ·ÊÇ 7001×¢²áÖÐÐÄÔÚ application.yml Öб©Â¶³öÀ´¶î×¢²áµØÖ· £¨µ¥»ú°æ£© - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka ¼¯Èº + #defaultZone: http://eureka7001:7001/eureka #这个地å�€æ˜¯ 7001注册中心在 application.yml 中暴露出æ�¥é¢�注册地å�€ (å�•机版) + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka 集群 instance: - instance-id: spring-cloud-provider-8002 #ÐÞ¸Ä×Ô¶¨ÒåµÄ·þÎñÃû³ÆÐÅÏ¢ - prefer-ip-address: true #ÏÔʾ·ÃÎÊ·¾¶µÄ ip µØÖ· + instance-id: spring-cloud-provider-8002 #修改自定义的æœ�务å��ç§°ä¿¡æ�¯ + prefer-ip-address: true #显示访问路径的 ip 地å�€ ``` @@ -407,7 +407,7 @@ eureka: -4\. ÔÚ micro-service-cloud-provider-dept-8003 ÖÐ application.yml ÖУ¬Ð޸Ķ˿ںÅÒÔ¼°Êý¾Ý¿âÁ¬½ÓÐÅÏ¢£¬Ð޸ĵÄÅäÖÃÈçÏ¡£ +4\. 在 micro-service-cloud-provider-dept-8003 中 application.yml 中,修改端å�£å�·ä»¥å�Šæ•°æ�®åº“连接信æ�¯ï¼Œä¿®æ”¹çš„é…�置如下。 @@ -416,26 +416,26 @@ eureka: ``` server: - port: 8003 #¶Ë¿ÚºÅÐÞ¸ÄΪ 8003 + port: 8003 #端å�£å�·ä¿®æ”¹ä¸º 8003 spring: application: - name: microServiceCloudProviderDept #΢·þÎñÃû³Æ£¬²»×öÐ޸ģ¬Óë micro-service-cloud-provider-dept-8001 µÄÅäÖñ£³ÖÒ»Ö + name: microServiceCloudProviderDept #å¾®æœ�务å��称,ä¸�å�šä¿®æ”¹ï¼Œä¸Ž micro-service-cloud-provider-dept-8001 çš„é…�ç½®ä¿�æŒ�一致 datasource: - username: root #Êý¾Ý¿âµÇ½Óû§Ãû - password: root #Êý¾Ý¿âµÇ½ÃÜÂë - url: jdbc:mysql://127.0.0.1:3306/spring_cloud_db3 #Êý¾Ý¿âurl - driver-class-name: com.mysql.jdbc.Driver #Êý¾Ý¿âÇý¶¯ + username: root #æ•°æ�®åº“登陆用户å�� + password: root #æ•°æ�®åº“登陆密ç � + url: jdbc:mysql://127.0.0.1:3306/spring_cloud_db3 #æ•°æ�®åº“url + driver-class-name: com.mysql.jdbc.Driver #æ•°æ�®åº“驱动 eureka: - client: #½«¿Í»§¶Ë×¢²áµ½ eureka ·þÎñÁбíÄÚ + client: #将客户端注册到 eureka æœ�务列表内 service-url: - #defaultZone: http://eureka7001:7001/eureka #Õâ¸öµØÖ·ÊÇ 7001×¢²áÖÐÐÄÔÚ application.yml Öб©Â¶³öÀ´¶î×¢²áµØÖ· £¨µ¥»ú°æ£© - defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #½«·þÎñ×¢²áµ½ Eureka ¼¯Èº + #defaultZone: http://eureka7001:7001/eureka #这个地å�€æ˜¯ 7001注册中心在 application.yml 中暴露出æ�¥é¢�注册地å�€ (å�•机版) + defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/,http://eureka7003.com:7003/eureka/ #å°†æœ�务注册到 Eureka 集群 instance: - instance-id: spring-cloud-provider-8003 #×Ô¶¨Òå·þÎñÃû³ÆÐÅÏ¢ - prefer-ip-address: true #ÏÔʾ·ÃÎÊ·¾¶µÄ ip µØÖ· + instance-id: spring-cloud-provider-8003 #自定义æœ�务å��ç§°ä¿¡æ�¯ + prefer-ip-address: true #显示访问路径的 ip 地å�€ ``` @@ -443,24 +443,24 @@ eureka: -5. ÒÀ´ÎÆô¶¯ micro-service-cloud-eureka-7001/7002/7003£¨·þÎñ×¢²áÖÐÐļ¯Èº£©¡¢micro-service-cloud-provider-dept-8001/8002/8003£¨·þÎñÌṩÕß¼¯Èº£©ÒÔ¼° micro-service-cloud-consumer-dept-80£¨·þÎñÏû·ÑÕߣ©¡£ +5. ä¾�次å�¯åЍ micro-service-cloud-eureka-7001/7002/7003(æœ�务注册中心集群)ã€�micro-service-cloud-provider-dept-8001/8002/8003(æœ�务æ��供者集群)以å�Š micro-service-cloud-consumer-dept-80(æœ�务消费者)。 -6\. ʹÓÃä¯ÀÀÆ÷Á¬Ðø·ÃÎÊ¡°http://eureka7001.com/consumer/dept/get/1¡±,½á¹ûÈçÏÂͼ¡£ +6\. 使用æµ�览器连续访问“http://eureka7001.com/consumer/dept/get/1â€�,结果如下图。 -![Ribbon ĬÈϸºÔؾùºâ²ßÂÔ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1012215133-3.gif) -ͼ4£ºRibbon ĬÈϸºÔؾùºâ²ßÂÔ +![Ribbon 默认负载å�‡è¡¡ç­–ç•¥](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1012215133-3.gif) +图4:Ribbon 默认负载å�‡è¡¡ç­–ç•¥ -ͨ¹ýͼ 4 ÖÐ dbSource ×Ö¶ÎȡֵµÄ±ä»¯¿ÉÒÔ¿´³ö£¬Spring Cloud Ribbon ĬÈÏʹÓÃÂÖѯ²ßÂÔ½øÐиºÔؾùºâ¡£ +通过图 4 中 dbSource 字段å�–值的å�˜åŒ–å�¯ä»¥çœ‹å‡ºï¼ŒSpring Cloud Ribbon 默认使用轮询策略进行负载å�‡è¡¡ã€‚ -## Çл»¸ºÔؾùºâ²ßÂÔ +## 切æ�¢è´Ÿè½½å�‡è¡¡ç­–ç•¥ -Spring Cloud Ribbon ĬÈÏʹÓÃÂÖѯ²ßÂÔѡȡ·þÎñʵÀý£¬ÎÒÃÇÒ²¿ÉÒÔ¸ù¾Ý×ÔÉíµÄÐèÇóÇл»¸ºÔؾùºâ²ßÂÔ¡£ +Spring Cloud Ribbon 默认使用轮询策略选å�–æœ�务实例,我们也å�¯ä»¥æ ¹æ�®è‡ªèº«çš„需求切æ�¢è´Ÿè½½å�‡è¡¡ç­–略。 -Çл»¸ºÔؾùºâ²ßÂԵķ½·¨ºÜ¼òµ¥£¬ÎÒÃÇÖ»ÐèÒªÔÚ·þÎñÏû·ÑÕߣ¨¿Í»§¶Ë£©µÄÅäÖÃÀàÖУ¬½« IRule µÄÆäËûʵÏÖÀà×¢Èëµ½ÈÝÆ÷Öм´¿É¡£ +切æ�¢è´Ÿè½½å�‡è¡¡ç­–略的方法很简å�•,我们å�ªéœ€è¦�在æœ�务消费者(客户端)的é…�置类中,将 IRule 的其他实现类注入到容器中å�³å�¯ã€‚ -ÏÂÃæÎÒÃǾÍͨ¹ýÒ»¸öʵÀý£¬À´ÑÝʾÏÂÈçºÎÇл»¸ºÔؾùºâµÄ²ßÂÔ¡£ +下é�¢æˆ‘们就通过一个实例,æ�¥æ¼”示下如何切æ�¢è´Ÿè½½å�‡è¡¡çš„策略。 -1\. ÔÚ micro-service-cloud-consumer-dept-80 µÄÅäÖÃÀà ConfigBean ÖÐÌí¼ÓÒÔÏ´úÂ룬½«¸ºÔؾùºâ²ßÂÔÇл»Îª RandomRule£¨Ëæ»ú£©¡£ +1\. 在 micro-service-cloud-consumer-dept-80 çš„é…�置类 ConfigBean 中添加以下代ç �,将负载å�‡è¡¡ç­–略切æ�¢ä¸º RandomRule(éš�机)。 @@ -471,7 +471,7 @@ Spring Cloud Ribbon Ĭ @Bean public IRule myRule() { - // RandomRule ÎªËæ»ú²ßÂÔ + // RandomRule 为éš�机策略 return new RandomRule(); } @@ -481,20 +481,20 @@ public IRule myRule() { -2\. ÖØÆô micro-service-cloud-consumer-dept-80£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/get/1¡±£¬½á¹ûÈçÏÂͼ¡£ +2\. é‡�å�¯ micro-service-cloud-consumer-dept-80,使用æµ�览器访问“http://eureka7001.com/consumer/dept/get/1â€�,结果如下图。 -![Çл»¸ºÔؾùºâ²ßÂÔÎªËæ»ú](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1012214B8-4.gif) -ͼ5£ºÇл»¸ºÔؾùºâ²ßÂÔÎªËæ»ú +![切æ�¢è´Ÿè½½å�‡è¡¡ç­–略为éš�机](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1012214B8-4.gif) +图5:切æ�¢è´Ÿè½½å�‡è¡¡ç­–略为éš�机 -ͨ¹ýͼ 5 ÖÐ dbSource ×Ö¶ÎȡֵµÄ±ä»¯¿ÉÒÔ¿´³ö£¬ÎÒÃÇÒѾ­½«¸ºÔؾùºâ²ßÂÔÇл»Îª RandomRule£¨Ëæ»ú£©¡£ +通过图 5 中 dbSource 字段å�–值的å�˜åŒ–å�¯ä»¥çœ‹å‡ºï¼Œæˆ‘们已ç»�将负载å�‡è¡¡ç­–略切æ�¢ä¸º RandomRule(éš�机)。 -## ¶¨ÖƸºÔؾùºâ²ßÂÔ +## 定制负载å�‡è¡¡ç­–ç•¥ -ͨ³£Çé¿öÏ£¬Ribbon ÌṩµÄÕâЩĬÈϸºÔؾùºâ²ßÂÔÊÇ¿ÉÒÔÂú×ãÎÒÃǵÄÐèÇóµÄ£¬Èç¹ûÓÐÌØÊâµÄÒªÇó£¬ÎÒÃÇ»¹¿ÉÒÔ¸ù¾Ý×ÔÉíÐèÇó¶¨ÖƸºÔؾùºâ²ßÂÔ¡£ +通常情况下,Ribbon æ��供的这些默认负载å�‡è¡¡ç­–略是å�¯ä»¥æ»¡è¶³æˆ‘们的需求的,如果有特殊的è¦�求,我们还å�¯ä»¥æ ¹æ�®è‡ªèº«éœ€æ±‚定制负载å�‡è¡¡ç­–略。 -ÏÂÃæÎÒÃǾÍÀ´ÑÝʾÏÂÈçºÎ¶¨ÖƸºÔؾùºâ²ßÂÔ¡£ +下é�¢æˆ‘们就æ�¥æ¼”示下如何定制负载å�‡è¡¡ç­–略。 -1\. ÔÚ micro-service-cloud-consumer-dept-80 ÖÐн¨Ò»¸ö net.biancheng.myrule °ü£¬²¢ÔڸðüÏ´´½¨Ò»¸öÃûΪ MyRandomRule µÄÀ࣬´úÂëÈçÏ¡£ +1\. 在 micro-service-cloud-consumer-dept-80 中新建一个 net.biancheng.myrule 包,并在该包下创建一个å��为 MyRandomRule 的类,代ç �如下。 @@ -512,11 +512,11 @@ import com.netflix.loadbalancer.Server; import java.util.List; /** -* ¶¨ÖÆ Ribbon ¸ºÔؾùºâ²ßÂÔ +* 定制 Ribbon è´Ÿè½½å�‡è¡¡ç­–ç•¥ */ public class MyRandomRule extends AbstractLoadBalancerRule { - private int total = 0; // ×ܹ²±»µ÷ÓõĴÎÊý£¬Ä¿Ç°ÒªÇóÿ̨±»µ÷ÓÃ5´Î - private int currentIndex = 0; // µ±Ç°Ìṩ·þÎñµÄ»úÆ÷ºÅ + private int total = 0; // 总共被调用的次数,目å‰�è¦�求æ¯�å�°è¢«è°ƒç”¨5次 + private int currentIndex = 0; // 当å‰�æ��ä¾›æœ�务的机器å�· public Server choose(ILoadBalancer lb, Object key) { if (lb == null) { @@ -528,17 +528,17 @@ public class MyRandomRule extends AbstractLoadBalancerRule { if (Thread.interrupted()) { return null; } - //»ñÈ¡ËùÓÐÓÐЧµÄ·þÎñʵÀýÁбí + //获å�–所有有效的æœ�务实例列表 List upList = lb.getReachableServers(); - //»ñÈ¡ËùÓеķþÎñʵÀýµÄÁбí + //获å�–所有的æœ�务实例的列表 List allList = lb.getAllServers(); - //Èç¹ûûÓÐÈκεķþÎñʵÀýÔò·µ»Ø null + //如果没有任何的æœ�务实例则返回 null int serverCount = allList.size(); if (serverCount == 0) { return null; } - //ÓëËæ»ú²ßÂÔÏàËÆ£¬µ«Ã¿¸ö·þÎñʵÀýÖ»ÓÐÔÚµ÷Óà 3 ´ÎÖ®ºó£¬²Å»áµ÷ÓÃÆäËûµÄ·þÎñʵÀý + //与éš�机策略相似,但æ¯�个æœ�务实例å�ªæœ‰åœ¨è°ƒç”¨ 3 次之å�Žï¼Œæ‰�会调用其他的æœ�务实例 if (total < 3) { server = upList.get(currentIndex); total++; @@ -579,7 +579,7 @@ public class MyRandomRule extends AbstractLoadBalancerRule { -2\. ÔÚ net.biancheng.myrule °üÏ´´½¨Ò»¸öÃûΪ MySelfRibbonRuleConfig µÄÅäÖÃÀ࣬½«ÎÒÃǶ¨ÖƵĸºÔؾùºâ²ßÂÔʵÏÖÀà×¢Èëµ½ÈÝÆ÷ÖУ¬´úÂëÈçÏ¡£ +2\. 在 net.biancheng.myrule 包下创建一个å��为 MySelfRibbonRuleConfig çš„é…�置类,将我们定制的负载å�‡è¡¡ç­–略实现类注入到容器中,代ç �如下。 @@ -593,16 +593,16 @@ import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** -* ¶¨ÖÆ Ribbon ¸ºÔؾùºâ²ßÂÔµÄÅäÖÃÀà -* ¸Ã×Ô¶¨Òå Ribbon ¸ºÔؾùºâ²ßÂÔÅäÖÃÀà ²»ÄÜÔÚ net.biancheng.c °ü¼°Æä×Ó°üÏ -* ·ñÔòËùÓÐµÄ Ribbon ¿Í»§¶Ë¶¼»á²ÉÓøòßÂÔ£¬ÎÞ·¨´ïµ½ÌØÊ⻯¶¨ÖƵÄÄ¿µÄ +* 定制 Ribbon è´Ÿè½½å�‡è¡¡ç­–略的é…�置类 +* 该自定义 Ribbon è´Ÿè½½å�‡è¡¡ç­–ç•¥é…�置类 ä¸�能在 net.biancheng.c 包å�Šå…¶å­�包下 +* å�¦åˆ™æ‰€æœ‰çš„ Ribbon 客户端都会采用该策略,无法达到特殊化定制的目的 */ @Configuration public class MySelfRibbonRuleConfig { @Bean public IRule myRule() { - //×Ô¶¨Òå Ribbon ¸ºÔؾùºâ²ßÂÔ - return new MyRandomRule(); //×Ô¶¨Òå£¬Ëæ»úÑ¡Ôñijһ¸ö΢·þÎñ£¬Ö´ÐÐÎå´Î + //自定义 Ribbon è´Ÿè½½å�‡è¡¡ç­–ç•¥ + return new MyRandomRule(); //自定义,éš�机选择æŸ�一个微æœ�务,执行五次 } } @@ -612,7 +612,7 @@ public class MySelfRibbonRuleConfig { -3\. ÐÞ¸ÄλÓÚ net.biancheng.c °üϵÄÖ÷Æô¶¯À࣬ÔÚ¸ÃÀàÉÏʹÓà @RibbonClient ×¢½âÈÃÎÒÃǶ¨ÖƵĸºÔؾùºâ²ßÂÔÉúЧ£¬´úÂëÈçÏ¡£ +3\. 修改ä½�于 net.biancheng.c 包下的主å�¯åŠ¨ç±»ï¼Œåœ¨è¯¥ç±»ä¸Šä½¿ç”¨ @RibbonClient 注解让我们定制的负载å�‡è¡¡ç­–略生效,代ç �如下。 @@ -631,10 +631,10 @@ import org.springframework.cloud.netflix.ribbon.RibbonClient; @SpringBootApplication @EnableEurekaClient -//×Ô¶¨Òå Ribbon ¸ºÔؾùºâ²ßÂÔÔÚÖ÷Æô¶¯ÀàÉÏʹÓà RibbonClient ×¢½â£¬ÔÚ¸Ã΢·þÎñÆô¶¯Ê±£¬¾ÍÄÜ×Ô¶¯È¥¼ÓÔØÎÒÃÇ×Ô¶¨ÒåµÄ Ribbon ÅäÖÃÀ࣬´Ó¶øÊÇÅäÖÃÉúЧ -// name ΪÐèÒª¶¨ÖƸºÔؾùºâ²ßÂÔµÄ΢·þÎñÃû³Æ£¨application name£© -// configuration Ϊ¶¨ÖƵĸºÔؾùºâ²ßÂÔµÄÅäÖÃÀ࣬ -// ÇÒ¹Ù·½ÎĵµÖÐÃ÷È·Ìá³ö£¬¸ÃÅäÖÃÀ಻ÄÜÔÚ ComponentScan ×¢½â£¨SpringBootApplication ×¢½âÖаüº¬Á˸Ã×¢½â£©Ïµİü»òÆä×Ó°üÖУ¬¼´×Ô¶¨Òå¸ºÔØ¾ùºâÅäÖÃÀ಻ÄÜÔÚ net.biancheng.c °ü¼°Æä×Ó°üÏ +//自定义 Ribbon è´Ÿè½½å�‡è¡¡ç­–略在主å�¯åŠ¨ç±»ä¸Šä½¿ç”¨ RibbonClient 注解,在该微æœ�务å�¯åŠ¨æ—¶ï¼Œå°±èƒ½è‡ªåŠ¨åŽ»åŠ è½½æˆ‘ä»¬è‡ªå®šä¹‰çš„ Ribbon é…�置类,从而是é…�置生效 +// name 为需è¦�定制负载å�‡è¡¡ç­–略的微æœ�务å��称(application name) +// configuration 为定制的负载å�‡è¡¡ç­–略的é…�置类, +// 且官方文档中明确æ��出,该é…�置类ä¸�能在 ComponentScan 注解(SpringBootApplication 注解中包å�«äº†è¯¥æ³¨è§£ï¼‰ä¸‹çš„包或其å­�包中,å�³è‡ªå®šä¹‰è´Ÿè½½å�‡è¡¡é…�置类ä¸�能在 net.biancheng.c 包å�Šå…¶å­�包下 @RibbonClient(name = "MICROSERVICECLOUDPROVIDERDEPT", configuration = MySelfRibbonRuleConfig.class) public class MicroServiceCloudConsumerDept80Application { @@ -649,14 +649,14 @@ public class MicroServiceCloudConsumerDept80Application { -4\. ÖØÆô micro-service-cloud-consumer-dept-80£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://eureka7001.com/consumer/dept/get/1¡±£¬½á¹ûÈçÏÂͼ¡£ +4\. é‡�å�¯ micro-service-cloud-consumer-dept-80,使用æµ�览器访问“http://eureka7001.com/consumer/dept/get/1â€�,结果如下图。 -![¶¨ÖƸºÔؾùºâ²ßÂÔ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10122152E-5.gif) -ͼ6£º¶¨ÖƸºÔؾùºâ²ßÂÔ +![定制负载å�‡è¡¡ç­–ç•¥](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10122152E-5.gif) +图6:定制负载å�‡è¡¡ç­–ç•¥ -ͨ¹ýͼ 6 ÖÐ dbSource ×Ö¶ÎȡֵµÄ±ä»¯¿ÉÒÔ¿´³ö£¬ÎÒÃǶ¨ÖƵĸºÔؾùºâ²ßÂÔÒѾ­ÉúЧ¡£ +通过图 6 中 dbSource 字段å�–值的å�˜åŒ–å�¯ä»¥çœ‹å‡ºï¼Œæˆ‘们定制的负载å�‡è¡¡ç­–略已ç»�生效。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudSleuth.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudSleuth.md" index 45bc82f..30c7db0 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudSleuth.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudSleuth.md" @@ -1,16 +1,16 @@ -> Spring Cloud Sleuth ÊÇ·Ö²¼Ê½ÏµÍ³Öиú×Ù·þÎñ¼äµ÷ÓõŤ¾ß£¬Ëü¿ÉÒÔÖ±¹ÛµØÕ¹Ê¾³öÒ»´ÎÇëÇóµÄµ÷Óùý³Ì£¬±¾ÎĽ«¶ÔÆäÓ÷¨½øÐÐÏêϸ½éÉÜ¡£ +> Spring Cloud Sleuth 是分布å¼�系统中跟踪æœ�务间调用的工具,它å�¯ä»¥ç›´è§‚地展示出一次请求的调用过程,本文将对其用法进行详细介ç»�。 -## [#](https://www.macrozheng.com/cloud/sleuth.html#spring-cloud-sleuth-%E7%AE%80%E4%BB%8B)Spring Cloud Sleuth ¼ò½é +## [#](https://www.macrozheng.com/cloud/sleuth.html#spring-cloud-sleuth-%E7%AE%80%E4%BB%8B)Spring Cloud Sleuth 简介 -Ëæ×ÅÎÒÃǵÄϵͳԽÀ´Ô½ÅӴ󣬸÷¸ö·þÎñ¼äµÄµ÷ÓùØÏµÒ²±äµÃÔ½À´Ô½¸´ÔÓ¡£µ±¿Í»§¶Ë·¢ÆðÒ»¸öÇëÇóʱ£¬Õâ¸öÇëÇó¾­¹ý¶à¸ö·þÎñºó£¬×îÖÕ·µ»ØÁ˽á¹û£¬¾­¹ýµÄÿһ¸ö·þÎñ¶¼ÓпÉÄÜ·¢ÉúÑÓ³Ù»ò´íÎ󣬴Ӷøµ¼ÖÂÇëÇóʧ°Ü¡£ÕâʱºòÎÒÃǾÍÐèÒªÇëÇóÁ´Â·¸ú×Ù¹¤¾ßÀ´°ïÖúÎÒÃÇ£¬ÀíÇåÇëÇóµ÷ÓõķþÎñÁ´Â·£¬½â¾öÎÊÌâ¡£ +éš�ç�€æˆ‘们的系统越æ�¥è¶Šåºžå¤§ï¼Œå�„个æœ�务间的调用关系也å�˜å¾—è¶Šæ�¥è¶Šå¤�æ�‚。当客户端å�‘起一个请求时,这个请求ç»�过多个æœ�务å�Žï¼Œæœ€ç»ˆè¿”回了结果,ç»�过的æ¯�一个æœ�务都有å�¯èƒ½å�‘生延迟或错误,从而导致请求失败。这时候我们就需è¦�请求链路跟踪工具æ�¥å¸®åŠ©æˆ‘ä»¬ï¼Œç�†æ¸…请求调用的æœ�务链路,解决问题。 -## [#](https://www.macrozheng.com/cloud/sleuth.html#%E7%BB%99%E6%9C%8D%E5%8A%A1%E6%B7%BB%E5%8A%A0%E8%AF%B7%E6%B1%82%E9%93%BE%E8%B7%AF%E8%B7%9F%E8%B8%AA)¸ø·þÎñÌí¼ÓÇëÇóÁ´Â·¸ú×Ù +## [#](https://www.macrozheng.com/cloud/sleuth.html#%E7%BB%99%E6%9C%8D%E5%8A%A1%E6%B7%BB%E5%8A%A0%E8%AF%B7%E6%B1%82%E9%93%BE%E8%B7%AF%E8%B7%9F%E8%B8%AA)ç»™æœ�务添加请求链路跟踪 -> ÎÒÃǽ«Í¨¹ýuser-serviceºÍribbon-serviceÖ®¼äµÄ·þÎñµ÷ÓÃÀ´ÑÝʾ¸Ã¹¦ÄÜ£¬ÕâÀïÎÒÃǵ÷ÓÃribbon-serviceµÄ½Ó¿Úʱ£¬ribbon-service»áͨ¹ýRestTemplateÀ´µ÷ÓÃuser-serviceÌṩµÄ½Ó¿Ú¡£ +> 我们将通过user-serviceå’Œribbon-service之间的æœ�务调用æ�¥æ¼”示该功能,这里我们调用ribbon-service的接å�£æ—¶ï¼Œribbon-service会通过RestTemplateæ�¥è°ƒç”¨user-serviceæ��供的接å�£ã€‚ -* Ê×Ïȸøuser-serviceºÍribbon-serviceÌí¼ÓÇëÇóÁ´Â·¸ú×Ù¹¦ÄܵÄÖ§³Ö£» +* 首先给user-serviceå’Œribbon-service添加请求链路跟踪功能的支æŒ�ï¼› -* ÔÚuser-serviceºÍribbon-serviceÖÐÌí¼ÓÏà¹ØÒÀÀµ£º +* 在user-serviceå’Œribbon-service中添加相关ä¾�赖: @@ -25,7 +25,7 @@ -* ÐÞ¸Äapplication.ymlÎļþ£¬ÅäÖÃÊÕ¼¯ÈÕÖ¾µÄzipkin-server·ÃÎʵØÖ·£º +* 修改application.yml文件,é…�置收集日志的zipkin-server访问地å�€ï¼š @@ -35,19 +35,19 @@ spring: base-url: http://localhost:9411 sleuth: sampler: - probability: 0.1 #ÉèÖÃSleuthµÄ³éÑùÊÕ¼¯¸ÅÂÊ + probability: 0.1 #设置Sleuth的抽样收集概率 ``` -## [#](https://www.macrozheng.com/cloud/sleuth.html#%E6%95%B4%E5%90%88zipkin%E8%8E%B7%E5%8F%96%E5%8F%8A%E5%88%86%E6%9E%90%E6%97%A5%E5%BF%97)ÕûºÏZipkin»ñÈ¡¼°·ÖÎöÈÕÖ¾ +## [#](https://www.macrozheng.com/cloud/sleuth.html#%E6%95%B4%E5%90%88zipkin%E8%8E%B7%E5%8F%96%E5%8F%8A%E5%88%86%E6%9E%90%E6%97%A5%E5%BF%97)æ•´å�ˆZipkin获å�–å�Šåˆ†æž�日志 -> ZipkinÊÇTwitterµÄÒ»¸ö¿ªÔ´ÏîÄ¿£¬¿ÉÒÔÓÃÀ´»ñÈ¡ºÍ·ÖÎöSpring Cloud Sleuth ÖвúÉúµÄÇëÇóÁ´Â·¸ú×ÙÈÕÖ¾£¬ËüÌṩÁËWeb½çÃæÀ´°ïÖúÎÒÃÇÖ±¹ÛµØ²é¿´ÇëÇóÁ´Â·¸ú×ÙÐÅÏ¢¡£ +> Zipkin是Twitter的一个开æº�项目,å�¯ä»¥ç”¨æ�¥èŽ·å�–和分æž�Spring Cloud Sleuth 中产生的请求链路跟踪日志,它æ��供了Web界é�¢æ�¥å¸®åŠ©æˆ‘ä»¬ç›´è§‚åœ°æŸ¥çœ‹è¯·æ±‚é“¾è·¯è·Ÿè¸ªä¿¡æ�¯ã€‚ -* SpringBoot 2.0ÒÔÉϰ汾ÒѾ­²»ÐèÒª×ÔÐдzipkin-server£¬ÎÒÃÇ¿ÉÒԴӸõØÖ·ÏÂÔØzipkin-server£ºhttps://repo1.maven.org/maven2/io/zipkin/java/zipkin-server/2.12.9/zipkin-server-2.12.9-exec.jar +* SpringBoot 2.0以上版本已ç»�ä¸�需è¦�自行æ�­å»ºzipkin-server,我们å�¯ä»¥ä»Žè¯¥åœ°å�€ä¸‹è½½zipkin-server:https://repo1.maven.org/maven2/io/zipkin/java/zipkin-server/2.12.9/zipkin-server-2.12.9-exec.jar -* ÏÂÔØÍê³ÉºóʹÓÃÒÔÏÂÃüÁîÔËÐÐzipkin-server£º +* 下载完æˆ�å�Žä½¿ç”¨ä»¥ä¸‹å‘½ä»¤è¿�行zipkin-server: @@ -61,79 +61,79 @@ java -jar zipkin-server-2.12.9-exec.jar -* ZipkinÒ³Ãæ·ÃÎʵØÖ·£ºhttp://localhost:9411 +* Zipkin页é�¢è®¿é—®åœ°å�€ï¼šhttp://localhost:9411 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springcloud_sleuth_01.625f37c3.png) -* Æô¶¯eureka-sever£¬ribbon-service£¬user-service£º +* å�¯åЍeureka-sever,ribbon-service,user-service: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springcloud_sleuth_02.baf7b77c.png) -* ¶à´Îµ÷Óã¨SleuthΪ³éÑùÊÕ¼¯£©ribbon-serviceµÄ½Ó¿Ú[http://localhost:8301/user/1open in new window](http://localhost:8301/user/1) £¬µ÷ÓÃÍêºó²é¿´ZipkinÊ×Ò³·¢ÏÖÒѾ­ÓÐÇëÇóÁ´Â·¸ú×ÙÐÅÏ¢ÁË£» +* 多次调用(Sleuth为抽样收集)ribbon-service的接å�£[http://localhost:8301/user/1open in new window](http://localhost:8301/user/1) ,调用完å�ŽæŸ¥çœ‹Zipkin首页å�‘现已ç»�有请求链路跟踪信æ�¯äº†ï¼› ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springcloud_sleuth_03.a71d1cf1.png) -* µã»÷²é¿´ÏêÇé¿ÉÒÔÖ±¹ÛµØ¿´µ½ÇëÇóµ÷ÓÃÁ´Â·ºÍͨ¹ýÿ¸ö·þÎñµÄºÄʱ£º +* 点击查看详情å�¯ä»¥ç›´è§‚地看到请求调用链路和通过æ¯�个æœ�务的耗时: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springcloud_sleuth_04.d13e3d99.png) -## [#](https://www.macrozheng.com/cloud/sleuth.html#%E4%BD%BF%E7%94%A8elasticsearch%E5%AD%98%E5%82%A8%E8%B7%9F%E8%B8%AA%E4%BF%A1%E6%81%AF)ʹÓÃElasticsearch´æ´¢¸ú×ÙÐÅÏ¢ +## [#](https://www.macrozheng.com/cloud/sleuth.html#%E4%BD%BF%E7%94%A8elasticsearch%E5%AD%98%E5%82%A8%E8%B7%9F%E8%B8%AA%E4%BF%A1%E6%81%AF)使用Elasticsearch存储跟踪信æ�¯ -> Èç¹ûÎÒÃǰÑzipkin-serverÖØÆôһϾͻᷢÏָոյĴ洢µÄ¸ú×ÙÐÅϢȫ²¿¶ªÊ§ÁË£¬¿É¼ûÆäÊÇ´æ´¢ÔÚÄÚ´æÖеģ¬ÓÐʱºòÎÒÃÇÐèÒª½«ËùÓÐÐÅÏ¢´æ´¢ÏÂÀ´£¬ÕâÀïÒÔ´æ´¢µ½ElasticsearchΪÀý£¬À´ÑÝʾϸù¦ÄÜ¡£ +> 如果我们把zipkin-serveré‡�å�¯ä¸€ä¸‹å°±ä¼šå�‘现刚刚的存储的跟踪信æ�¯å…¨éƒ¨ä¸¢å¤±äº†ï¼Œå�¯è§�其是存储在内存中的,有时候我们需è¦�将所有信æ�¯å­˜å‚¨ä¸‹æ�¥ï¼Œè¿™é‡Œä»¥å­˜å‚¨åˆ°Elasticsearch为例,æ�¥æ¼”示下该功能。 -### [#](https://www.macrozheng.com/cloud/sleuth.html#%E5%AE%89%E8%A3%85elasticsearch)°²×°Elasticsearch +### [#](https://www.macrozheng.com/cloud/sleuth.html#%E5%AE%89%E8%A3%85elasticsearch)安装Elasticsearch -* ÏÂÔØElasticsearch6.2.2µÄzip°ü£¬²¢½âѹµ½Ö¸¶¨Ä¿Â¼£¬ÏÂÔØµØÖ·£º[https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2open in new window](https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2) +* 下载Elasticsearch6.2.2çš„zip包,并解压到指定目录,下载地å�€ï¼š[https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2open in new window](https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-2-2) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/arch_screen_25.48daf958.png) -* ÔËÐÐbinĿ¼ÏµÄelasticsearch.batÆô¶¯Elasticsearch +* è¿�行bin目录下的elasticsearch.batå�¯åЍElasticsearch ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/arch_screen_27.ba3cb8e0.png) -### [#](https://www.macrozheng.com/cloud/sleuth.html#%E4%BF%AE%E6%94%B9%E5%90%AF%E5%8A%A8%E5%8F%82%E6%95%B0%E5%B0%86%E4%BF%A1%E6%81%AF%E5%AD%98%E5%82%A8%E5%88%B0elasticsearch)ÐÞ¸ÄÆô¶¯²ÎÊý½«ÐÅÏ¢´æ´¢µ½Elasticsearch +### [#](https://www.macrozheng.com/cloud/sleuth.html#%E4%BF%AE%E6%94%B9%E5%90%AF%E5%8A%A8%E5%8F%82%E6%95%B0%E5%B0%86%E4%BF%A1%E6%81%AF%E5%AD%98%E5%82%A8%E5%88%B0elasticsearch)修改å�¯åЍå�‚数将信æ�¯å­˜å‚¨åˆ°Elasticsearch -* ʹÓÃÒÔÏÂÃüÁîÔËÐУ¬¾Í¿ÉÒ԰Ѹú×ÙÐÅÏ¢´æ´¢µ½ElasticsearchÀïÃæÈ¥ÁË£¬ÖØÐÂÆô¶¯Ò²²»»á¶ªÊ§£» +* 使用以下命令è¿�行,就å�¯ä»¥æŠŠè·Ÿè¸ªä¿¡æ�¯å­˜å‚¨åˆ°Elasticsearch里é�¢åŽ»äº†ï¼Œé‡�æ–°å�¯åŠ¨ä¹Ÿä¸�会丢失; ``` -# STORAGE_TYPE£º±íʾ´æ´¢ÀàÐÍ ES_HOSTS£º±íʾESµÄ·ÃÎʵØÖ· +# STORAGE_TYPE:表示存储类型 ES_HOSTS:表示ES的访问地å�€ java -jar zipkin-server-2.12.9-exec.jar --STORAGE_TYPE=elasticsearch --ES_HOSTS=localhost:9200 ``` -* Ö®ºóÐèÒªÖØÐÂÆô¶¯user-serviceºÍribbon-service²ÅÄÜÉúЧ£¬ÖØÆôºó¶à´Îµ÷ÓÃribbon-serviceµÄ½Ó¿Ú[http://localhost:8301/user/1open in new window](http://localhost:8301/user/1)£» +* 之å�Žéœ€è¦�é‡�æ–°å�¯åЍuser-serviceå’Œribbon-serviceæ‰�能生效,é‡�å�¯å�Žå¤šæ¬¡è°ƒç”¨ribbon-service的接å�£[http://localhost:8301/user/1open in new window](http://localhost:8301/user/1)ï¼› -* Èç¹û°²×°ÁËElasticsearchµÄ¿ÉÊÓ»¯¹¤¾ßKibanaµÄ»°£¬¿ÉÒÔ¿´µ½ÀïÃæÒѾ­´æ´¢Á˸ú×ÙÐÅÏ¢£º +* 如果安装了Elasticsearchçš„å�¯è§†åŒ–工具Kibanaçš„è¯�,å�¯ä»¥çœ‹åˆ°é‡Œé�¢å·²ç»�存储了跟踪信æ�¯ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springcloud_sleuth_05.9929ce6a.png) -### [#](https://www.macrozheng.com/cloud/sleuth.html#%E6%9B%B4%E5%A4%9A%E5%90%AF%E5%8A%A8%E5%8F%82%E6%95%B0%E5%8F%82%E8%80%83)¸ü¶àÆô¶¯²ÎÊý²Î¿¼ +### [#](https://www.macrozheng.com/cloud/sleuth.html#%E6%9B%B4%E5%A4%9A%E5%90%AF%E5%8A%A8%E5%8F%82%E6%95%B0%E5%8F%82%E8%80%83)更多å�¯åЍå�‚æ•°å�‚考 https://github.com/openzipkin/zipkin/tree/master/zipkin-server#elasticsearch-storage -## [#](https://www.macrozheng.com/cloud/sleuth.html#%E4%BD%BF%E7%94%A8%E5%88%B0%E7%9A%84%E6%A8%A1%E5%9D%97)ʹÓõ½µÄÄ£¿é +## [#](https://www.macrozheng.com/cloud/sleuth.html#%E4%BD%BF%E7%94%A8%E5%88%B0%E7%9A%84%E6%A8%A1%E5%9D%97)使用到的模å�— ``` springcloud-learning -©À©¤©¤ eureka-server -- eureka×¢²áÖÐÐÄ -©À©¤©¤ user-service -- ÌṩUser¶ÔÏóCRUD½Ó¿ÚµÄ·þÎñ -©¸©¤©¤ ribbon-service -- ribbon·þÎñµ÷ÓòâÊÔ·þÎñ +├── eureka-server -- eureka注册中心 +├── user-service -- æ��ä¾›User对象CRUD接å�£çš„æœ�务 +└── ribbon-service -- ribbonæœ�务调用测试æœ�务 ``` -## [#](https://www.macrozheng.com/cloud/sleuth.html#%E9%A1%B9%E7%9B%AE%E6%BA%90%E7%A0%81%E5%9C%B0%E5%9D%80)ÏîĿԴÂëµØÖ· +## [#](https://www.macrozheng.com/cloud/sleuth.html#%E9%A1%B9%E7%9B%AE%E6%BA%90%E7%A0%81%E5%9C%B0%E5%9D%80)项目æº�ç �地å�€ [https://github.com/macrozheng/springcloud-learning](https://github.com/macrozheng/springcloud-learning) -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudZuul.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudZuul.md" index 9040110..8a6ff77 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudZuul.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloudZuul.md" @@ -1,14 +1,14 @@ -Spring Cloud Zuul ÊÇSpring Cloud Netflix ×ÓÏîÄ¿µÄºËÐÄ×é¼þÖ®Ò»£¬¿ÉÒÔ×÷Ϊ΢·þÎñ¼Ü¹¹ÖеÄAPIÍø¹ØÊ¹Óã¬Ö§³Ö¶¯Ì¬Â·ÓÉÓë¹ýÂ˹¦ÄÜ£¬±¾ÎĽ«¶ÔÆäÓ÷¨½øÐÐÏêϸ½éÉÜ¡£ +Spring Cloud Zuul 是Spring Cloud Netflix å­�项目的核心组件之一,å�¯ä»¥ä½œä¸ºå¾®æœ�务架构中的API网关使用,支æŒ�动æ€�路由与过滤功能,本文将对其用法进行详细介ç»�。 -# Zuul¼ò½é +# Zuul简介 -APIÍø¹ØÎªÎ¢·þÎñ¼Ü¹¹ÖеķþÎñÌṩÁËͳһµÄ·ÃÎÊÈë¿Ú£¬¿Í»§¶Ëͨ¹ýAPIÍø¹Ø·ÃÎÊÏà¹Ø·þÎñ¡£APIÍø¹ØµÄ¶¨ÒåÀàËÆÓÚÉè¼ÆÄ£Ê½ÖеÄÃÅÃæÄ£Ê½£¬ËüÏ൱ÓÚÕû¸ö΢·þÎñ¼Ü¹¹ÖеÄÃÅÃæ£¬ËùÓпͻ§¶ËµÄ·ÃÎʶ¼Í¨¹ýËüÀ´½øÐзÓɼ°¹ýÂË¡£ËüʵÏÖÁËÇëÇó·ÓÉ¡¢¸ºÔؾùºâ¡¢Ð£Ñé¹ýÂË¡¢·þÎñÈÝ´í¡¢·þÎñ¾ÛºÏµÈ¹¦ÄÜ¡£ +API网关为微æœ�务架构中的æœ�务æ��供了统一的访问入å�£ï¼Œå®¢æˆ·ç«¯é€šè¿‡API网关访问相关æœ�务。API网关的定义类似于设计模å¼�中的门é�¢æ¨¡å¼�,它相当于整个微æœ�务架构中的门é�¢ï¼Œæ‰€æœ‰å®¢æˆ·ç«¯çš„访问都通过它æ�¥è¿›è¡Œè·¯ç”±å�Šè¿‡æ»¤ã€‚它实现了请求路由ã€�è´Ÿè½½å�‡è¡¡ã€�校验过滤ã€�æœ�务容错ã€�æœ�务è�šå�ˆç­‰åŠŸèƒ½ã€‚ -#´´½¨Ò»¸özuul-proxyÄ£¿é +#创建一个zuul-proxy模å�— -ÕâÀïÎÒÃÇ´´½¨Ò»¸özuul-proxyÄ£¿éÀ´ÑÝʾzuulµÄ³£Óù¦ÄÜ¡£ +这里我们创建一个zuul-proxy模å�—æ�¥æ¼”示zuul的常用功能。 -#ÔÚpom.xmlÖÐÌí¼ÓÏà¹ØÒÀÀµ +#在pom.xml中添加相关ä¾�èµ– @@ -24,7 +24,7 @@ API -# ÔÚapplication.ymlÖнøÐÐÅäÖà +# 在application.yml中进行é…�ç½® @@ -41,7 +41,7 @@ API defaultZone: http://localhost:8001/eureka/ -#ÔÚÆô¶¯ÀàÉÏÌí¼Ó@EnableZuulProxy×¢½âÀ´ÆôÓÃZuulµÄAPIÍø¹Ø¹¦ÄÜ +#在å�¯åŠ¨ç±»ä¸Šæ·»åŠ @EnableZuulProxy注解æ�¥å�¯ç”¨Zuulçš„API网关功能 @@ -58,22 +58,22 @@ API -# ³£Óù¦ÄÜ +# 常用功能 -# Æô¶¯Ïà¹Ø·þÎñ +# å�¯åŠ¨ç›¸å…³æœ�务 -ÕâÀïÎÒÃÇͨ¹ýÆô¶¯eureka-server£¬Á½¸öuser-service£¬feign-serviceºÍzuul-proxyÀ´ÑÝʾZuulµÄ³£Óù¦ÄÜ£¬Æô¶¯ºó×¢²áÖÐÐÄÏÔʾÈçÏ¡£ +这里我们通过å�¯åЍeureka-server,两个user-service,feign-serviceå’Œzuul-proxyæ�¥æ¼”示Zuul的常用功能,å�¯åЍå�Žæ³¨å†Œä¸­å¿ƒæ˜¾ç¤ºå¦‚下。 -# ÅäÖ÷ÓɹæÔò +# é…�置路由规则 -- ÎÒÃÇ¿ÉÒÔͨ¹ýÐÞ¸Äapplication.ymlÖеÄÅäÖÃÀ´ÅäÖ÷ÓɹæÔò£¬ÕâÀïÎÒÃǽ«Æ¥Åä/userService/**µÄÇëÇó·Óɵ½user-service·þÎñÉÏÈ¥£¬Æ¥Åä/feignService/**µÄÇëÇó·Óɵ½feign-serviceÉÏÈ¥¡£ +- 我们å�¯ä»¥é€šè¿‡ä¿®æ”¹application.yml中的é…�ç½®æ�¥é…�置路由规则,这里我们将匹é…�/userService/**的请求路由到user-serviceæœ�务上去,匹é…�/feignService/**的请求路由到feign-service上去。 zuul: - routes: #¸ø·þÎñÅäÖ÷ÓÉ + routes: #ç»™æœ�务é…�置路由 user-service: path: /userService/** feign-service: @@ -81,17 +81,17 @@ API -- ·ÃÎÊhttp://localhost:8801/userService/user/1open in new window¿ÉÒÔ·¢ÏÖÇëÇó·Óɵ½ÁËuser-serviceÉÏÁË£» -- ·ÃÎÊhttp://localhost:8801/feignService/user/1open in new window¿ÉÒÔ·¢ÏÖÇëÇó·Óɵ½ÁËfeign-serviceÉÏÁË¡£ +- 访问http://localhost:8801/userService/user/1open in new windowå�¯ä»¥å�‘现请求路由到了user-service上了; +- 访问http://localhost:8801/feignService/user/1open in new windowå�¯ä»¥å�‘现请求路由到了feign-service上了。 -# ĬÈÏ·ÓɹæÔò +# 默认路由规则 -- ZuulºÍEureka½áºÏʹÓ㬿ÉÒÔʵÏÖ·ÓɵÄ×Ô¶¯ÅäÖã¬×Ô¶¯ÅäÖõÄ·ÓÉÒÔ·þÎñÃû³ÆÎªÆ¥Åä·¾¶£¬Ï൱ÓÚÈçÏÂÅäÖ㺠+- Zuulå’ŒEureka结å�ˆä½¿ç”¨ï¼Œå�¯ä»¥å®žçŽ°è·¯ç”±çš„è‡ªåŠ¨é…�置,自动é…�置的路由以æœ�务å��称为匹é…�路径,相当于如下é…�置: zuul: - routes: #¸ø·þÎñÅäÖ÷ÓÉ + routes: #ç»™æœ�务é…�置路由 user-service: path: /user-service/** feign-service: @@ -99,68 +99,68 @@ API -- ·ÃÎÊhttp://localhost:8801/user-service/user/1open in new windowͬÑù¿ÉÒÔ·Óɵ½ÁËuser-serviceÉÏÁË£» -- ·ÃÎÊhttp://localhost:8801/feign-service/user/1open in new windowͬÑù¿ÉÒÔ·Óɵ½ÁËfeign-serviceÉÏÁË¡£ -- Èç¹û²»ÏëʹÓÃĬÈϵÄ·ÓɹæÔò£¬¿ÉÒÔÌí¼ÓÒÔÏÂÅäÖÃÀ´ºöÂÔĬÈÏ·ÓÉÅäÖ㺠+- 访问http://localhost:8801/user-service/user/1open in new windowå�Œæ ·å�¯ä»¥è·¯ç”±åˆ°äº†user-service上了; +- 访问http://localhost:8801/feign-service/user/1open in new windowå�Œæ ·å�¯ä»¥è·¯ç”±åˆ°äº†feign-service上了。 +- 如果ä¸�想使用默认的路由规则,å�¯ä»¥æ·»åР以䏋é…�ç½®æ�¥å¿½ç•¥é»˜è®¤è·¯ç”±é…�置: zuul: - ignored-services: user-service,feign-service #¹Ø±ÕĬÈÏ·ÓÉÅäÖà + ignored-services: user-service,feign-service #关闭默认路由é…�ç½® -# ¸ºÔؾùºâ¹¦ÄÜ +# è´Ÿè½½å�‡è¡¡åŠŸèƒ½ -¶à´Îµ÷ÓÃhttp://localhost:8801/user-service/user/1open in new window½øÐвâÊÔ£¬¿ÉÒÔ·¢ÏÖÔËÐÐÔÚ8201ºÍ8202µÄuser-service·þÎñ½»Ìæ´òÓ¡ÈçÏÂÐÅÏ¢¡£ +多次调用http://localhost:8801/user-service/user/1open in new window进行测试,å�¯ä»¥å�‘现è¿�行在8201å’Œ8202çš„user-serviceæœ�务交替打å�°å¦‚下信æ�¯ã€‚ - 2019-10-05 10:31:58.738 INFO 11520 --- [nio-8202-exec-5] c.macro.cloud.controller.UserController : ¸ù¾Ýid»ñÈ¡Óû§ÐÅÏ¢£¬Óû§Ãû³ÆÎª£ºmacro - 2019-10-05 10:32:00.356 INFO 11520 --- [nio-8202-exec-6] c.macro.cloud.controller.UserController : ¸ù¾Ýid»ñÈ¡Óû§ÐÅÏ¢£¬Óû§Ãû³ÆÎª£ºmacro + 2019-10-05 10:31:58.738 INFO 11520 --- [nio-8202-exec-5] c.macro.cloud.controller.UserController : æ ¹æ�®id获å�–用户信æ�¯ï¼Œç”¨æˆ·å��称为:macro + 2019-10-05 10:32:00.356 INFO 11520 --- [nio-8202-exec-6] c.macro.cloud.controller.UserController : æ ¹æ�®id获å�–用户信æ�¯ï¼Œç”¨æˆ·å��称为:macro -# ÅäÖ÷ÃÎÊǰ׺ +# é…�置访问å‰�ç¼€ -ÎÒÃÇ¿ÉÒÔͨ¹ýÒÔÏÂÅäÖÃÀ´¸øÍø¹ØÂ·¾¶Ìí¼Óǰ׺£¬´Ë´¦Ìí¼ÓÁË/proxyǰ׺£¬ÕâÑùÎÒÃÇÐèÒª·ÃÎÊhttp://localhost:8801/proxy/user-service/user/1open in new window²ÅÄÜ·ÃÎʵ½user-serviceÖеĽӿڡ£ +我们å�¯ä»¥é€šè¿‡ä»¥ä¸‹é…�ç½®æ�¥ç»™ç½‘关路径添加å‰�缀,此处添加了/proxyå‰�缀,这样我们需è¦�访问http://localhost:8801/proxy/user-service/user/1open in new windowæ‰�能访问到user-service中的接å�£ã€‚ zuul: - prefix: /proxy #¸øÍø¹ØÂ·ÓÉÌí¼Óǰ׺ + prefix: /proxy #给网关路由添加å‰�ç¼€ -# Header¹ýÂ˼°Öض¨ÏòÌí¼ÓHost +# Header过滤å�Šé‡�定å�‘添加Host -- ZuulÔÚÇëÇó·ÓÉʱ£¬Ä¬ÈÏ»á¹ýÂ˵ôһЩÃô¸ÐµÄÍ·ÐÅÏ¢£¬ÒÔÏÂÅäÖÿÉÒÔ·Àֹ·ÓÉʱµÄCookie¼°AuthorizationµÄ¶ªÊ§£º +- Zuul在请求路由时,默认会过滤掉一些æ•�感的头信æ�¯ï¼Œä»¥ä¸‹é…�ç½®å�¯ä»¥é˜²æ­¢è·¯ç”±æ—¶çš„Cookieå�ŠAuthorization的丢失: zuul: - sensitive-headers: Cookie,Set-Cookie,Authorization #ÅäÖùýÂËÃô¸ÐµÄÇëÇóÍ·ÐÅÏ¢£¬ÉèÖÃΪ¿Õ¾Í²»»á¹ýÂË + sensitive-headers: Cookie,Set-Cookie,Authorization #é…�置过滤æ•�感的请求头信æ�¯ï¼Œè®¾ç½®ä¸ºç©ºå°±ä¸�会过滤 -- ZuulÔÚÇëÇó·ÓÉʱ£¬²»»áÉèÖÃ×î³õµÄhostÍ·ÐÅÏ¢£¬ÒÔÏÂÅäÖÿÉÒÔ½â¾ö£º +- Zuul在请求路由时,ä¸�会设置最åˆ�çš„host头信æ�¯ï¼Œä»¥ä¸‹é…�ç½®å�¯ä»¥è§£å†³ï¼š zuul: - add-host-header: true #ÉèÖÃΪtrueÖØ¶¨ÏòÊÇ»áÌí¼ÓhostÇëÇóÍ· + add-host-header: true #设置为trueé‡�定å�‘是会添加host请求头 -# ²é¿´Â·ÓÉÐÅÏ¢ +# 查看路由信æ�¯ -ÎÒÃÇ¿ÉÒÔͨ¹ýSpringBoot ActuatorÀ´²é¿´ZuulÖеÄ·ÓÉÐÅÏ¢¡£ +我们å�¯ä»¥é€šè¿‡SpringBoot Actuatoræ�¥æŸ¥çœ‹Zuul中的路由信æ�¯ã€‚ -- ÔÚpom.xmlÖÐÌí¼ÓÏà¹ØÒÀÀµ£º +- 在pom.xml中添加相关ä¾�赖: @@ -174,7 +174,7 @@ API -- ÐÞ¸Äapplication.yamlÅäÖÃÎļþ£¬¿ªÆô²é¿´Â·ÓɵĶ˵㣺 +- 修改application.yamlé…�置文件,开å�¯æŸ¥çœ‹è·¯ç”±çš„端点: @@ -188,40 +188,40 @@ API -- ͨ¹ý·ÃÎÊhttp://localhost:8801/actuator/routesopen in new window²é¿´¼òµ¥Â·ÓÉÐÅÏ¢£º +- 通过访问http://localhost:8801/actuator/routesopen in new window查看简å�•路由信æ�¯ï¼š -- ͨ¹ý·ÃÎÊhttp://localhost:8801/actuator/routes/detailsopen in new window²é¿´Ïêϸ·ÓÉÐÅÏ¢£º +- 通过访问http://localhost:8801/actuator/routes/detailsopen in new window查看详细路由信æ�¯ï¼š -# ¹ýÂËÆ÷ +# 过滤器 -·ÓÉÓë¹ýÂËÊÇZuulµÄÁ½´óºËÐŦÄÜ£¬Â·Óɹ¦ÄܸºÔð½«ÍⲿÇëÇóת·¢µ½¾ßÌåµÄ·þÎñʵÀýÉÏÈ¥£¬ÊÇʵÏÖͳһ·ÃÎÊÈë¿ÚµÄ»ù´¡£¬¹ýÂ˹¦ÄܸºÔð¶ÔÇëÇó¹ý³Ì½øÐжîÍâµÄ´¦Àí£¬ÊÇÇëÇóУÑé¹ýÂ˼°·þÎñ¾ÛºÏµÄ»ù´¡¡£ +路由与过滤是Zuul的两大核心功能,路由功能负责将外部请求转å�‘到具体的æœ�务实例上去,是实现统一访问入å�£çš„基础,过滤功能负责对请求过程进行é¢�外的处ç�†ï¼Œæ˜¯è¯·æ±‚校验过滤å�Šæœ�务è�šå�ˆçš„基础。 -# ¹ýÂËÆ÷ÀàÐÍ +# 过滤器类型 -ZuulÖÐÓÐÒÔϼ¸ÖÖµäÐ͵ĹýÂËÆ÷ÀàÐÍ¡£ +Zuul中有以下几ç§�典型的过滤器类型。 -- pre£ºÔÚÇëÇó±»Â·Óɵ½Ä¿±ê·þÎñǰִÐУ¬±ÈÈçȨÏÞУÑé¡¢´òÓ¡ÈÕÖ¾µÈ¹¦ÄÜ£» -- routing£ºÔÚÇëÇó±»Â·Óɵ½Ä¿±ê·þÎñʱִÐУ¬ÕâÊÇʹÓÃApache HttpClient»òNetflix Ribbon¹¹½¨ºÍ·¢ËÍԭʼHTTPÇëÇóµÄµØ·½£» -- post£ºÔÚÇëÇó±»Â·Óɵ½Ä¿±ê·þÎñºóÖ´ÐУ¬±ÈÈç¸øÄ¿±ê·þÎñµÄÏìÓ¦Ìí¼ÓÍ·ÐÅÏ¢£¬ÊÕ¼¯Í³¼ÆÊý¾ÝµÈ¹¦ÄÜ£» -- error£ºÇëÇóÔÚÆäËû½×¶Î·¢Éú´íÎóʱִÐС£ +- pre:在请求被路由到目标æœ�务å‰�执行,比如æ�ƒé™�校验ã€�打å�°æ—¥å¿—等功能; +- routing:在请求被路由到目标æœ�务时执行,这是使用Apache HttpClient或Netflix Ribbon构建和å�‘é€�原始HTTP请求的地方; +- post:在请求被路由到目标æœ�务å�Žæ‰§è¡Œï¼Œæ¯”如给目标æœ�务的å“�应添加头信æ�¯ï¼Œæ”¶é›†ç»Ÿè®¡æ•°æ�®ç­‰åŠŸèƒ½ï¼› +- error:请求在其他阶段å�‘生错误时执行。 -# ¹ýÂËÆ÷µÄÉúÃüÖÜÆÚ +# 过滤器的生命周期 -ÏÂͼÃèÊöÁËÒ»¸öHTTPÇëÇóµ½´ïAPIÍø¹Øºó£¬ÈçºÎÔÚ¸÷ÖÖ²»Í¬ÀàÐ͵ĹýÂËÆ÷ÖÐÁ÷תµÄ¹ý³Ì¡£ +下图æ��述了一个HTTP请求到达API网关å�Žï¼Œå¦‚何在å�„ç§�ä¸�å�Œç±»åž‹çš„过滤器中æµ�转的过程。 -# ×Ô¶¨Òå¹ýÂËÆ÷ +# 自定义过滤器 -½ÓÏÂÀ´ÎÒÃÇ×Ô¶¨ÒåÒ»¸ö¹ýÂËÆ÷À´ÑÝʾϹýÂËÆ÷µÄ×÷Óᣠ+接下æ�¥æˆ‘们自定义一个过滤器æ�¥æ¼”示下过滤器的作用。 -# Ìí¼ÓPreLogFilterÀà¼Ì³ÐZuulFilter +# 添加PreLogFilter类继承ZuulFilter -ÕâÊÇÒ»¸öǰÖùýÂËÆ÷£¬ÓÃÓÚÔÚÇëÇó·Óɵ½Ä¿±ê·þÎñǰ´òÓ¡ÇëÇóÈÕÖ¾¡£ +这是一个å‰�置过滤器,用于在请求路由到目标æœ�务å‰�打å�°è¯·æ±‚日志。 @@ -233,7 +233,7 @@ Zuul private Logger LOGGER = LoggerFactory.getLogger(this.getClass()); /** - * ¹ýÂËÆ÷ÀàÐÍ£¬ÓÐpre¡¢routing¡¢post¡¢errorËÄÖÖ¡£ + * 过滤器类型,有preã€�routingã€�postã€�errorå››ç§�。 */ @Override public String filterType() { @@ -241,7 +241,7 @@ Zuul } /** - * ¹ýÂËÆ÷Ö´ÐÐ˳Ðò£¬ÊýֵԽСÓÅÏȼ¶Ô½¸ß¡£ + * 过滤器执行顺åº�,数值越å°�优先级越高。 */ @Override public int filterOrder() { @@ -249,7 +249,7 @@ Zuul } /** - * ÊÇ·ñ½øÐйýÂË£¬·µ»Øtrue»áÖ´ÐйýÂË¡£ + * 是å�¦è¿›è¡Œè¿‡æ»¤ï¼Œè¿”回true会执行过滤。 */ @Override public boolean shouldFilter() { @@ -257,7 +257,7 @@ Zuul } /** - * ×Ô¶¨ÒåµÄ¹ýÂËÆ÷Âß¼­£¬µ±shouldFilter()·µ»Øtrueʱ»áÖ´ÐС£ + * 自定义的过滤器逻辑,当shouldFilter()返回true时会执行。 */ @Override public Object run() throws ZuulException { @@ -273,9 +273,9 @@ Zuul -# ¹ýÂËÆ÷¹¦ÄÜÑÝʾ +# 过滤器功能演示 -Ìí¼Ó¹ýÂËÆ÷ºó£¬ÎÒÃÇ·ÃÎÊhttp://localhost:8801/user-service/user/1open in new window²âÊÔÏ£¬»á´òÓ¡ÈçÏÂÈÕÖ¾¡£ +添加过滤器å�Žï¼Œæˆ‘们访问http://localhost:8801/user-service/user/1open in new window测试下,会打å�°å¦‚下日志。 @@ -286,23 +286,23 @@ Zuul -# ºËÐĹýÂËÆ÷ +# 核心过滤器 - ¹ýÂËÆ÷Ãû³Æ ¹ýÂËÀàÐÍ ÓÅÏȼ¶ ¹ýÂËÆ÷µÄ×÷Óà - ServletDetectionFilter pre -3 ¼ì²âµ±Ç°ÇëÇóÊÇͨ¹ýDispatcherServlet´¦ÀíÔËÐеϹÊÇZuulServletÔËÐд¦ÀíµÄ¡£ - Servlet30WrapperFilter pre -2 ¶ÔԭʼµÄHttpServletRequest½øÐаü×°¡£ - FormBodyWrapperFilter pre -1 ½«Content-TypeΪapplication/x-www-form-urlencoded»òmultipart/form-dataµÄÇëÇó°ü×°³ÉFormBodyRequestWrapper¶ÔÏó¡£ - DebugFilter route 1 ¸ù¾Ýzuul.debug.requestµÄÅäÖÃÀ´¾ö¶¨ÊÇ·ñ´òÓ¡debugÈÕÖ¾¡£ - PreDecorationFilter route 5 ¶Ôµ±Ç°ÇëÇó½øÐÐÔ¤´¦ÀíÒÔ±ãÖ´ÐкóÐø²Ù×÷¡£ - RibbonRoutingFilter route 10 ͨ¹ýRibbonºÍHystrixÀ´Ïò·þÎñʵÀý·¢ÆðÇëÇ󣬲¢½«ÇëÇó½á¹û½øÐзµ»Ø¡£ - SimpleHostRoutingFilter route 100 Ö»¶ÔÇëÇóÉÏÏÂÎÄÖÐÓÐrouteHost²ÎÊýµÄ½øÐд¦Àí£¬Ö±½ÓʹÓÃHttpClientÏòrouteHost¶ÔÓ¦µÄÎïÀíµØÖ·½øÐÐת·¢¡£ - SendForwardFilter route 500 Ö»¶ÔÇëÇóÉÏÏÂÎÄÖÐÓÐforward.to²ÎÊýµÄ½øÐд¦Àí£¬½øÐб¾µØÌø×ª¡£ - SendErrorFilter post 0 µ±ÆäËû¹ýÂËÆ÷ÄÚ²¿·¢ÉúÒ쳣ʱµÄ»áÓÉËüÀ´½øÐд¦Àí£¬²úÉú´íÎóÏìÓ¦¡£ - SendResponseFilter post 1000 ÀûÓÃÇëÇóÉÏÏÂÎĵÄÏìÓ¦ÐÅÏ¢À´×éÖ¯ÇëÇó³É¹¦µÄÏìÓ¦ÄÚÈÝ¡£ + 过滤器å��ç§° 过滤类型 优先级 过滤器的作用 + ServletDetectionFilter pre -3 检测当å‰�请求是通过DispatcherServlet处ç�†è¿�行的还是ZuulServletè¿�行处ç�†çš„。 + Servlet30WrapperFilter pre -2 对原始的HttpServletRequest进行包装。 + FormBodyWrapperFilter pre -1 å°†Content-Type为application/x-www-form-urlencoded或multipart/form-data的请求包装æˆ�FormBodyRequestWrapper对象。 + DebugFilter route 1 æ ¹æ�®zuul.debug.requestçš„é…�ç½®æ�¥å†³å®šæ˜¯å�¦æ‰“å�°debug日志。 + PreDecorationFilter route 5 对当å‰�请求进行预处ç�†ä»¥ä¾¿æ‰§è¡Œå�Žç»­æ“�作。 + RibbonRoutingFilter route 10 通过Ribbonå’ŒHystrixæ�¥å�‘æœ�务实例å�‘起请求,并将请求结果进行返回。 + SimpleHostRoutingFilter route 100 å�ªå¯¹è¯·æ±‚上下文中有routeHostå�‚数的进行处ç�†ï¼Œç›´æŽ¥ä½¿ç”¨HttpClientå�‘routeHost对应的物ç�†åœ°å�€è¿›è¡Œè½¬å�‘。 + SendForwardFilter route 500 å�ªå¯¹è¯·æ±‚上下文中有forward.toå�‚数的进行处ç�†ï¼Œè¿›è¡Œæœ¬åœ°è·³è½¬ã€‚ + SendErrorFilter post 0 当其他过滤器内部å�‘生异常时的会由它æ�¥è¿›è¡Œå¤„ç�†ï¼Œäº§ç”Ÿé”™è¯¯å“�应。 + SendResponseFilter post 1000 利用请求上下文的å“�应信æ�¯æ�¥ç»„织请求æˆ�功的å“�应内容。 -# ½ûÓùýÂËÆ÷ +# ç¦�用过滤器 -- ÎÒÃÇ¿ÉÒÔ¶Ô¹ýÂËÆ÷½øÐнûÓõÄÅäÖã¬ÅäÖøñʽÈçÏ£º +- 我们å�¯ä»¥å¯¹è¿‡æ»¤å™¨è¿›è¡Œç¦�用的é…�置,é…�置格å¼�如下: @@ -313,7 +313,7 @@ Zuul -- ÒÔÏÂÊǽûÓÃPreLogFilterµÄʾÀýÅäÖ㺠+- 以下是ç¦�用PreLogFilter的示例é…�置: @@ -324,67 +324,67 @@ Zuul -#RibbonºÍHystrixµÄÖ§³Ö +#Ribbonå’ŒHystrix的支æŒ� -ÓÉÓÚZuul×Ô¶¯¼¯³ÉÁËRibbonºÍHystrix£¬ËùÒÔZuulÌìÉú¾ÍÓиºÔؾùºâºÍ·þÎñÈÝ´íÄÜÁ¦£¬ÎÒÃÇ¿ÉÒÔͨ¹ýRibbonºÍHystrixµÄÅäÖÃÀ´ÅäÖÃZuulÖеÄÏàÓ¦¹¦ÄÜ¡£ +由于Zuul自动集æˆ�了Ribbonå’ŒHystrix,所以Zuul天生就有负载å�‡è¡¡å’Œæœ�务容错能力,我们å�¯ä»¥é€šè¿‡Ribbonå’ŒHystrixçš„é…�ç½®æ�¥é…�ç½®Zuul中的相应功能。 -- ¿ÉÒÔʹÓÃHystrixµÄÅäÖÃÀ´ÉèÖ÷ÓÉת·¢Ê±HystrixCommandµÄÖ´Ðг¬Ê±Ê±¼ä£º +- å�¯ä»¥ä½¿ç”¨Hystrixçš„é…�ç½®æ�¥è®¾ç½®è·¯ç”±è½¬å�‘æ—¶HystrixCommand的执行超时时间: hystrix: - command: #ÓÃÓÚ¿ØÖÆHystrixCommandµÄÐÐΪ + command: #用于控制HystrixCommand的行为 default: execution: isolation: thread: - timeoutInMilliseconds: 1000 #ÅäÖÃHystrixCommandÖ´Ðеij¬Ê±Ê±¼ä£¬Ö´Ðг¬¹ý¸Ãʱ¼ä»á½øÐзþÎñ½µ¼¶´¦Àí + timeoutInMilliseconds: 1000 #é…�ç½®HystrixCommand执行的超时时间,执行超过该时间会进行æœ�务é™�级处ç�† -- ¿ÉÒÔʹÓÃRibbonµÄÅäÖÃÀ´ÉèÖ÷ÓÉת·¢Ê±ÇëÇóÁ¬½Ó¼°´¦ÀíµÄ³¬Ê±Ê±¼ä£º +- å�¯ä»¥ä½¿ç”¨Ribbonçš„é…�ç½®æ�¥è®¾ç½®è·¯ç”±è½¬å�‘时请求连接å�Šå¤„ç�†çš„超时时间: - ribbon: #È«¾ÖÅäÖà - ConnectTimeout: 1000 #·þÎñÇëÇóÁ¬½Ó³¬Ê±Ê±¼ä£¨ºÁÃ룩 - ReadTimeout: 3000 #·þÎñÇëÇó´¦Àí³¬Ê±Ê±¼ä£¨ºÁÃ룩 + ribbon: #全局é…�ç½® + ConnectTimeout: 1000 #æœ�务请求连接超时时间(毫秒) + ReadTimeout: 3000 #æœ�务请求处ç�†è¶…时时间(毫秒) -#³£ÓÃÅäÖà +#常用é…�ç½® zuul: - routes: #¸ø·þÎñÅäÖ÷ÓÉ + routes: #ç»™æœ�务é…�置路由 user-service: path: /userService/** feign-service: path: /feignService/** - ignored-services: user-service,feign-service #¹Ø±ÕĬÈÏ·ÓÉÅäÖà - prefix: /proxy #¸øÍø¹ØÂ·ÓÉÌí¼Óǰ׺ - sensitive-headers: Cookie,Set-Cookie,Authorization #ÅäÖùýÂËÃô¸ÐµÄÇëÇóÍ·ÐÅÏ¢£¬ÉèÖÃΪ¿Õ¾Í²»»á¹ýÂË - add-host-header: true #ÉèÖÃΪtrueÖØ¶¨ÏòÊÇ»áÌí¼ÓhostÇëÇóÍ· - retryable: true # ¹Ø±ÕÖØÊÔ»úÖÆ + ignored-services: user-service,feign-service #关闭默认路由é…�ç½® + prefix: /proxy #给网关路由添加å‰�ç¼€ + sensitive-headers: Cookie,Set-Cookie,Authorization #é…�置过滤æ•�感的请求头信æ�¯ï¼Œè®¾ç½®ä¸ºç©ºå°±ä¸�会过滤 + add-host-header: true #设置为trueé‡�定å�‘是会添加host请求头 + retryable: true # 关闭é‡�试机制 PreLogFilter: pre: - disable: false #¿ØÖÆÊÇ·ñÆôÓùýÂËÆ÷ + disable: false #控制是å�¦å�¯ç”¨è¿‡æ»¤å™¨ -#ʹÓõ½µÄÄ£¿é +#使用到的模å�— springcloud-learning - ©À©¤©¤ eureka-server -- eureka×¢²áÖÐÐÄ - ©À©¤©¤ user-service -- ÌṩUser¶ÔÏóCRUD½Ó¿ÚµÄ·þÎñ - ©À©¤©¤ feign-service -- feign·þÎñµ÷ÓòâÊÔ·þÎñ - ©¸©¤©¤ zuul-proxy -- zuul×÷ÎªÍø¹ØµÄ²âÊÔ·þÎñ + ├── eureka-server -- eureka注册中心 + ├── user-service -- æ��ä¾›User对象CRUD接å�£çš„æœ�务 + ├── feign-service -- feignæœ�务调用测试æœ�务 + └── zuul-proxy -- zuul作为网关的测试æœ�务 -#ÏîĿԴÂëµØÖ· +#项目æº�ç �地å�€ https://github.com/macrozheng/springcloud-learning -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloud\346\246\202\350\277\260.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloud\346\246\202\350\277\260.md" index a525595..cbcff11 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloud\346\246\202\350\277\260.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud/SpringCloud\346\246\202\350\277\260.md" @@ -1,111 +1,111 @@ -Spring Cloud ÊÇÒ»¿î»ùÓÚ Spring Boot ʵÏÖµÄ΢·þÎñ¿ò¼Ü¡£Spring Cloud Ô´×Ô Spring ÉçÇø£¬Ö÷ÒªÓÉ Pivotal ºÍ Netflix Á½´ó¹«Ë¾Ìṩ¼¼Êõµü´úºÍά»¤¡£ +Spring Cloud 是一款基于 Spring Boot 实现的微æœ�务框架。Spring Cloud æº�自 Spring 社区,主è¦�ç”± Pivotal å’Œ Netflix 两大公å�¸æ��供技术迭代和维护。 -Ëæ×Å΢·þÎñµÄ»ð±¬Á÷ÐУ¬¹úÄÚÍâ¸÷´ó»¥ÁªÍø¹«Ë¾¶¼Ïà¼Ì·ÖÏíÁËËûÃÇÔÚ΢·þÎñ¼Ü¹¹ÖУ¬Õë¶Ô²»Í¬³¡¾°³öÏֵĸ÷ÖÖÎÊÌâµÄ½â¾ö·½°¸ºÍ¿ªÔ´¿ò¼Ü¡£ +éš�ç�€å¾®æœ�务的ç�«çˆ†æµ�行,国内外å�„大互è�”网公å�¸éƒ½ç›¸ç»§åˆ†äº«äº†ä»–们在微æœ�务架构中,针对ä¸�å�Œåœºæ™¯å‡ºçŽ°çš„å�„ç§�问题的解决方案和开æº�框架。 -* **·þÎñÖÎÀí**£º°¢Àï°Í°Í¿ªÔ´µÄ Dubbo ºÍµ±µ±ÍøÔÚÆä»ù´¡ÉÏÀ©Õ¹³öÀ´µÄ DubboX¡¢Netflix µÄ Eureka ÒÔ¼° Apache µÄ Consul µÈ¡£ -* **·Ö²¼Ê½ÅäÖùÜÀí**£º°Ù¶ÈµÄ Disconf¡¢Netflix µÄ Archaius¡¢360 µÄ QConf¡¢Ð¯³ÌµÄ Apollo ÒÔ¼° Spring Cloud µÄ Config µÈ¡£ -* **ÅúÁ¿ÈÎÎñ**£ºµ±µ±ÍøµÄ Elastic-Job¡¢LinkedIn µÄ Azkaban ÒÔ¼° Spring Cloud µÄ Task µÈ¡£ -* **·þÎñ¸ú×Ù**£º¾©¶«µÄ Hydra¡¢Spring Cloud µÄ Sleuth ÒÔ¼° Twitter µÄ Zipkin µÈ¡£ -* **¡­¡­** +* **æœ�务治ç�†**:阿里巴巴开æº�çš„ Dubbo 和当当网在其基础上扩展出æ�¥çš„ DubboXã€�Netflix çš„ Eureka 以å�Š Apache çš„ Consul 等。 +* **分布å¼�é…�置管ç�†**:百度的 Disconfã€�Netflix çš„ Archaiusã€�360 çš„ QConfã€�æ�ºç¨‹çš„ Apollo 以å�Š Spring Cloud çš„ Config 等。 +* **批é‡�任务**:当当网的 Elastic-Jobã€�LinkedIn çš„ Azkaban 以å�Š Spring Cloud çš„ Task 等。 +* **æœ�务跟踪**:京东的 Hydraã€�Spring Cloud çš„ Sleuth 以å�Š Twitter çš„ Zipkin 等。 +* **……** -ÒÔÉÏÕâЩ΢·þÎñ¿ò¼Ü»ò½â¾ö·½°¸¶¼¾ßÓÐÒÔÏ 2 ¸öÌØµã£º +以上这些微æœ�务框架或解决方案都具有以下 2 个特点: -* ¶ÔÓÚͬһ¸ö΢·þÎñÎÊÌ⣬¸÷»¥ÁªÍø¹«Ë¾¸ø³öµÄ½â¾ö·½°¸¸÷²»Ïàͬ¡£ -* Ò»¸ö΢·þÎñ¿ò¼Ü»ò½â¾ö·½°¸¶¼Ö»Äܽâ¾ö΢·þÎñÖеÄijһ¸ö»òij¼¸¸öÎÊÌ⣬¶ÔÓÚÆäËûÎÊÌâÔòÎÞÄÜΪÁ¦¡£ +* 对于å�Œä¸€ä¸ªå¾®æœ�务问题,å�„互è�”网公å�¸ç»™å‡ºçš„解决方案å�„ä¸�相å�Œã€‚ +* 一个微æœ�务框架或解决方案都å�ªèƒ½è§£å†³å¾®æœ�务中的æŸ�一个或æŸ�几个问题,对于其他问题则无能为力。 -ÕâÖÖÇé¿öÏ£¬´î½¨Ò»Ì×΢·Ö²¼Ê½Î¢·þÎñϵͳ£¬¾ÍÐèÒªÕë¶ÔÕâЩÎÊÌâ´ÓÖî¶àµÄ½â¾ö·½°¸ÖÐ×ö³öÑ¡Ôñ£¬ÕâʹµÃÎÒÃDz»µÃ²»½«´óÁ¿µÄ¾«Á¦»¨·ÑÔÚǰÆÚµÄµ÷ÑС¢·ÖÎöÒÔ¼°ÊµÑéÉÏ¡£ +è¿™ç§�情况下,æ�­å»ºä¸€å¥—微分布å¼�å¾®æœ�务系统,就需è¦�针对这些问题从诸多的解决方案中å�šå‡ºé€‰æ‹©ï¼Œè¿™ä½¿å¾—我们ä¸�å¾—ä¸�将大é‡�的精力花费在å‰�期的调研ã€�分æž�以å�Šå®žéªŒä¸Šã€‚ -Spring Cloud ±»³ÆÎª¹¹½¨·Ö²¼Ê½Î¢·þÎñϵͳµÄ¡°È«¼ÒͰ¡±£¬Ëü²¢²»ÊÇijһÃż¼Êõ£¬¶øÊÇһϵÁÐ΢·þÎñ½â¾ö·½°¸»ò¿ò¼ÜµÄÓÐÐò¼¯ºÏ¡£Ëü½«ÊÐÃæÉϳÉÊìµÄ¡¢¾­¹ýÑéÖ¤µÄ΢·þÎñ¿ò¼ÜÕûºÏÆðÀ´£¬²¢Í¨¹ý Spring Boot µÄ˼Ïë½øÐÐÔÙ·â×°£¬ÆÁ±Îµ÷ÆäÖи´ÔÓµÄÅäÖúÍʵÏÖÔ­Àí£¬×îÖÕΪ¿ª·¢ÈËÔ±ÌṩÁËÒ»Ì×¼òµ¥Ò×¶®¡¢Òײ¿ÊðºÍÒ×ά»¤µÄ·Ö²¼Ê½ÏµÍ³¿ª·¢¹¤¾ß°ü¡£ +Spring Cloud 被称为构建分布å¼�å¾®æœ�务系统的“全家桶â€�,它并ä¸�是æŸ�一门技术,而是一系列微æœ�务解决方案或框架的有åº�集å�ˆã€‚它将市é�¢ä¸Šæˆ�熟的ã€�ç»�过验è¯�的微æœ�务框架整å�ˆèµ·æ�¥ï¼Œå¹¶é€šè¿‡ Spring Boot çš„æ€�想进行å†�å°�装,å±�蔽调其中å¤�æ�‚çš„é…�置和实现原ç�†ï¼Œæœ€ç»ˆä¸ºå¼€å�‘人员æ��供了一套简å�•易懂ã€�易部署和易维护的分布å¼�系统开å�‘工具包。 -Spring Cloud Öаüº¬ÁË spring-cloud-config¡¢spring-cloud-bus µÈ½ü 20 ¸ö×ÓÏîÄ¿£¬ÌṩÁË·þÎñÖÎÀí¡¢·þÎñÍø¹Ø¡¢ÖÇÄÜ·ÓÉ¡¢¸ºÔؾùºâ¡¢¶Ï·Æ÷¡¢¼à¿Ø¸ú×Ù¡¢·Ö²¼Ê½ÏûÏ¢¶ÓÁС¢ÅäÖùÜÀíµÈÁìÓòµÄ½â¾ö·½°¸¡£ +Spring Cloud 中包å�«äº† spring-cloud-configã€�spring-cloud-bus 等近 20 个å­�项目,æ��供了æœ�务治ç�†ã€�æœ�务网关ã€�智能路由ã€�è´Ÿè½½å�‡è¡¡ã€�断路器ã€�监控跟踪ã€�分布å¼�消æ�¯é˜Ÿåˆ—ã€�é…�置管ç�†ç­‰é¢†åŸŸçš„解决方案。 -Spring Cloud ²¢²»ÊÇÒ»¸öÄÃÀ´¼´¿ÉÓõĿò¼Ü£¬ËüÊÇÒ»ÖÖ΢·þÎñ¹æ·¶£¬¹²ÓÐÒÔÏ 2 ´úʵÏÖ£º +Spring Cloud å¹¶ä¸�是一个拿æ�¥å�³å�¯ç”¨çš„æ¡†æž¶ï¼Œå®ƒæ˜¯ä¸€ç§�å¾®æœ�务规范,共有以下 2 代实现: -* µÚÒ»´úʵÏÖ£ºSpring Cloud Netflix -* µÚ¶þ´úʵÏÖ£ºSpring Cloud Alibaba +* 第一代实现:Spring Cloud Netflix +* 第二代实现:Spring Cloud Alibaba -ÕâÀïÎÒÃǽéÉÜµÄ Spring Cloud ÌØÖ¸ Spring Cloud µÄµÚÒ»´úʵÏÖ¡£ +这里我们介ç»�çš„ Spring Cloud 特指 Spring Cloud 的第一代实现。 -## Spring Cloud ³£ÓÃ×é¼þ +## Spring Cloud 常用组件 -Spring Cloud °üÀ¨ Spring Cloud Gateway¡¢Spring Cloud Config¡¢Spring Cloud Bus µÈ½ü 20 ¸ö·þÎñ×é¼þ£¬ÕâЩ×é¼þÌṩÁË·þÎñÖÎÀí¡¢·þÎñÍø¹Ø¡¢ÖÇÄÜ·ÓÉ¡¢¸ºÔؾùºâ¡¢ÈÛ¶ÏÆ÷¡¢¼à¿Ø¸ú×Ù¡¢·Ö²¼Ê½ÏûÏ¢¶ÓÁС¢ÅäÖùÜÀíµÈÁìÓòµÄ½â¾ö·½°¸¡£ +Spring Cloud 包括 Spring Cloud Gatewayã€�Spring Cloud Configã€�Spring Cloud Bus 等近 20 个æœ�务组件,这些组件æ��供了æœ�务治ç�†ã€�æœ�务网关ã€�智能路由ã€�è´Ÿè½½å�‡è¡¡ã€�熔断器ã€�监控跟踪ã€�分布å¼�消æ�¯é˜Ÿåˆ—ã€�é…�置管ç�†ç­‰é¢†åŸŸçš„解决方案。 -Spring Cloud µÄ³£ÓÃ×é¼þÈçϱíËùʾ¡£ +Spring Cloud 的常用组件如下表所示。 -| Spring Cloud ×é¼þ | ÃèÊö | +| Spring Cloud 组件 | æ��è¿° | | ---------------------------- | ------------------------------------------------------------ | -| Spring Cloud Netflix Eureka | Spring Cloud Netflix ÖеķþÎñÖÎÀí×é¼þ£¬°üº¬·þÎñ×¢²áÖÐÐÄ¡¢·þÎñ×¢²áÓë·¢ÏÖ»úÖÆµÄʵÏÖ¡£ | -| Spring Cloud Netflix Ribbon | Spring Cloud Netflix ÖеķþÎñµ÷ÓúͿͻ§¶Ë¸ºÔؾùºâ×é¼þ¡£ | -| Spring Cloud Netflix Hystrix | È˳ơ°ºÀÖí¸ç¡±£¬Spring Cloud Netflix µÄÈÝ´í¹ÜÀí×é¼þ£¬Îª·þÎñÖгöÏÖµÄÑӳٺ͹ÊÕÏÌṩǿ´óµÄÈÝ´íÄÜÁ¦¡£ | -| Spring Cloud Netflix Feign | »ùÓÚ Ribbon ºÍ Hystrix µÄÉùÃ÷ʽ·þÎñµ÷ÓÃ×é¼þ¡£ | -| Spring Cloud Netflix Zuul | Spring Cloud Netflix ÖеÄÍø¹Ø×é¼þ£¬ÌṩÁËÖÇÄÜ·ÓÉ¡¢·ÃÎʹýÂ˵ȹ¦ÄÜ¡£ | -| Spring Cloud Gateway | Ò»¸ö»ùÓÚ Spring 5.0£¬Spring Boot 2.0 ºÍ Project Reactor µÈ¼¼Êõ¿ª·¢µÄÍø¹Ø¿ò¼Ü£¬ËüʹÓà Filter Á´µÄ·½Ê½ÌṩÁËÍø¹ØµÄ»ù±¾¹¦ÄÜ£¬ÀýÈ簲ȫ¡¢¼à¿Ø/Ö¸±êºÍÏÞÁ÷µÈ¡£ | -| Spring Cloud Config | Spring Cloud µÄÅäÖùÜÀí¹¤¾ß£¬Ö§³ÖʹÓà Git ´æ´¢ÅäÖÃÄÚÈÝ£¬ÊµÏÖÓ¦ÓÃÅäÖõÄÍⲿ»¯´æ´¢£¬²¢Ö§³ÖÔÚ¿Í»§¶Ë¶ÔÅäÖýøÐÐˢС¢¼ÓÃÜ¡¢½âÃܵȲÙ×÷¡£ | -| Spring Cloud Bus | Spring Cloud µÄʼþºÍÏûÏ¢×ÜÏߣ¬Ö÷ÒªÓÃÓÚÔÚ¼¯ÈºÖд«²¥Ê¼þ»ò״̬±ä»¯£¬ÒÔ´¥·¢ºóÐøµÄ´¦Àí£¬ÀýÈ綯̬ˢÐÂÅäÖᣠ| -| Spring Cloud Stream | Spring Cloud µÄÏûÏ¢Öмä¼þ×é¼þ£¬Ëü¼¯³ÉÁË Apache Kafka ºÍ RabbitMQ µÈÏûÏ¢Öмä¼þ£¬²¢Í¨¹ý¶¨Òå°ó¶¨Æ÷×÷ΪÖмä²ã£¬ÍêÃÀµØÊµÏÖÁËÓ¦ÓóÌÐòÓëÏûÏ¢Öмä¼þÖ®¼äµÄ¸ôÀ롣ͨ¹ýÏòÓ¦ÓóÌÐò±©Â¶Í³Ò»µÄ Channel ͨµÀ£¬Ê¹µÃÓ¦ÓóÌÐò²»ÐèÒªÔÙ¿¼ÂǸ÷ÖÖ²»Í¬µÄÏûÏ¢Öмä¼þʵÏÖ£¬¾ÍÄÜÇáËɵط¢ËͺͽÓÊÕÏûÏ¢¡£ | -| Spring Cloud Sleuth | Spring Cloud ·Ö²¼Ê½Á´Â·¸ú×Ù×é¼þ£¬Äܹ»ÍêÃÀµÄÕûºÏ Twitter µÄ Zipkin¡£ | +| Spring Cloud Netflix Eureka | Spring Cloud Netflix 中的æœ�务治ç�†ç»„件,包å�«æœ�务注册中心ã€�æœ�务注册与å�‘现机制的实现。 | +| Spring Cloud Netflix Ribbon | Spring Cloud Netflix 中的æœ�务调用和客户端负载å�‡è¡¡ç»„件。 | +| Spring Cloud Netflix Hystrix | 人称“豪猪哥â€�,Spring Cloud Netflix 的容错管ç�†ç»„件,为æœ�务中出现的延迟和故障æ��供强大的容错能力。 | +| Spring Cloud Netflix Feign | 基于 Ribbon å’Œ Hystrix 的声明å¼�æœ�务调用组件。 | +| Spring Cloud Netflix Zuul | Spring Cloud Netflix 中的网关组件,æ��供了智能路由ã€�访问过滤等功能。 | +| Spring Cloud Gateway | 一个基于 Spring 5.0,Spring Boot 2.0 å’Œ Project Reactor 等技术开å�‘的网关框架,它使用 Filter 链的方å¼�æ��供了网关的基本功能,例如安全ã€�监控/指标和é™�æµ�等。 | +| Spring Cloud Config | Spring Cloud çš„é…�置管ç�†å·¥å…·ï¼Œæ”¯æŒ�使用 Git 存储é…�置内容,实现应用é…�置的外部化存储,并支æŒ�在客户端对é…�置进行刷新ã€�加密ã€�解密等æ“�作。 | +| Spring Cloud Bus | Spring Cloud 的事件和消æ�¯æ€»çº¿ï¼Œä¸»è¦�用于在集群中传播事件或状æ€�å�˜åŒ–,以触å�‘å�Žç»­çš„处ç�†ï¼Œä¾‹å¦‚动æ€�刷新é…�置。 | +| Spring Cloud Stream | Spring Cloud 的消æ�¯ä¸­é—´ä»¶ç»„件,它集æˆ�了 Apache Kafka å’Œ RabbitMQ 等消æ�¯ä¸­é—´ä»¶ï¼Œå¹¶é€šè¿‡å®šä¹‰ç»‘定器作为中间层,完美地实现了应用程åº�与消æ�¯ä¸­é—´ä»¶ä¹‹é—´çš„隔离。通过å�‘应用程åº�暴露统一的 Channel 通é�“,使得应用程åº�ä¸�需è¦�å†�考虑å�„ç§�ä¸�å�Œçš„æ¶ˆæ�¯ä¸­é—´ä»¶å®žçŽ°ï¼Œå°±èƒ½è½»æ�¾åœ°å�‘é€�和接收消æ�¯ã€‚ | +| Spring Cloud Sleuth | Spring Cloud 分布å¼�链路跟踪组件,能够完美的整å�ˆ Twitter çš„ Zipkin。 | -> ×¢£ºNetflix ÊÇÃÀ¹úµÄÒ»¸öÔÚÏßÊÓÆµÍøÕ¾£¬ËüÊǹ«ÈϵĴó¹æÄ£Éú²ú¼¶Î¢·þÎñµÄ½Ü³öʵ¼ùÕߣ¬Î¢·þÎñ½çµÄÇ̳þ¡£Netflix µÄ¿ªÔ´×é¼þÒѾ­ÔÚÆä´ó¹æÄ£·Ö²¼Ê½Î¢·þÎñ»·¾³Öо­¹ýÁ˶àÄêµÄÉú²úʵսÑéÖ¤£¬³ÉÊìÇÒ¿É¿¿¡£ +> 注:Netflix 是美国的一个在线视频网站,它是公认的大规模生产级微æœ�务的æ�°å‡ºå®žè·µè€…,微æœ�务界的翘楚。Netflix 的开æº�组件已ç»�在其大规模分布å¼�å¾®æœ�务环境中ç»�过了多年的生产实战验è¯�,æˆ�熟且å�¯é� ã€‚ -## Spring Boot ºÍ Spring Cloud µÄÇø±ðÓëÁªÏµ +## Spring Boot å’Œ Spring Cloud 的区别与è�”ç³» -Spring Boot ºÍ Spring Cloud ¶¼ÊÇ Spring ´ó¼Ò×åµÄÒ»Ô±£¬ËüÃÇÔÚ΢·þÎñ¿ª·¢Öж¼°çÑÝ×ÅÊ®·ÖÖØÒªµÄ½ÇÉ«£¬Á½ÕßÖ®¼ä¼È´æÔÚÇø±ðÒ²´æÔÚÁªÏµ¡£ +Spring Boot å’Œ Spring Cloud 都是 Spring 大家æ—�的一员,它们在微æœ�务开å�‘中都扮演ç�€å��分é‡�è¦�的角色,两者之间既存在区别也存在è�”系。 -#### 1\. Spring Boot ºÍ Spring Cloud ·Ö¹¤²»Í¬ +#### 1\. Spring Boot å’Œ Spring Cloud 分工ä¸�å�Œ -Spring Boot ÊÇÒ»¸ö»ùÓÚ Spring µÄ¿ìËÙ¿ª·¢¿ò¼Ü£¬ËüÄܹ»°ïÖú¿ª·¢ÕßѸËÙ´î Web ¹¤³Ì¡£ÔÚ΢·þÎñ¿ª·¢ÖУ¬Spring Boot רעÓÚ¿ìËÙ¡¢·½±ãµØ¿ª·¢µ¥¸ö΢·þÎñ¡£ +Spring Boot 是一个基于 Spring 的快速开å�‘框架,它能够帮助开å�‘者迅速æ�­ Web 工程。在微æœ�务开å�‘中,Spring Boot 专注于快速ã€�方便地开å�‘å�•个微æœ�务。 -Spring Cloud ÊÇ΢·þÎñ¼Ü¹¹ÏµÄһվʽ½â¾ö·½°¸¡£Spring Cloud רעÓÚÈ«¾Ö΢·þÎñµÄЭµ÷ºÍÖÎÀí¹¤×÷¡£»»¾ä»°Ëµ£¬Spring Cloud Ï൱ÓÚ΢·þÎñµÄ´ó¹Ü¼Ò£¬¸ºÔ𽫠Spring Boot ¿ª·¢µÄÒ»¸ö¸ö΢·þÎñ¹ÜÀíÆðÀ´£¬²¢ÎªËüÃÇÌṩÅäÖùÜÀí¡¢·þÎñ·¢ÏÖ¡¢¶Ï·Æ÷¡¢Â·ÓÉ¡¢Î¢´úÀí¡¢Ê¼þ×ÜÏß¡¢¾ö²ß¾ºÑ¡ÒÔ¼°·Ö²¼Ê½»á»°µÈ·þÎñ¡£ +Spring Cloud 是微æœ�务架构下的一站å¼�解决方案。Spring Cloud 专注于全局微æœ�务的å��调和治ç�†å·¥ä½œã€‚æ�¢å�¥è¯�说,Spring Cloud 相当于微æœ�务的大管家,负责将 Spring Boot å¼€å�‘的一个个微æœ�务管ç�†èµ·æ�¥ï¼Œå¹¶ä¸ºå®ƒä»¬æ��ä¾›é…�置管ç�†ã€�æœ�务å�‘现ã€�断路器ã€�路由ã€�微代ç�†ã€�事件总线ã€�决策竞选以å�Šåˆ†å¸ƒå¼�会è¯�ç­‰æœ�务。 -#### 2\. Spring Cloud ÊÇ»ùÓÚ Spring Boot ʵÏÖµÄ +#### 2\. Spring Cloud 是基于 Spring Boot 实现的 -Spring Cloud ÊÇ»ùÓÚ Spring Boot ʵÏֵġ£Óë Spring Boot ÀàËÆ£¬Spring Cloud ҲΪÌṩÁËһϵÁÐ Starter£¬ÕâЩ Starter ÊÇ Spring Cloud ʹÓà Spring Boot ˼Ïë¶Ô¸÷¸ö΢·þÎñ¿ò¼Ü½øÐÐÔÙ·â×°µÄ²úÎï¡£ËüÃÇÆÁ±ÎÁËÕâЩ΢·þÎñ¿ò¼ÜÖи´ÔÓµÄÅäÖúÍʵÏÖÔ­Àí£¬Ê¹¿ª·¢ÈËÔ±Äܹ»¿ìËÙ¡¢·½±ãµØÊ¹Óà Spring Cloud ´î½¨Ò»Ì×·Ö²¼Ê½Î¢·þÎñϵͳ¡£ +Spring Cloud 是基于 Spring Boot 实现的。与 Spring Boot 类似,Spring Cloud 也为æ��供了一系列 Starter,这些 Starter 是 Spring Cloud 使用 Spring Boot æ€�想对å�„个微æœ�务框架进行å†�å°�装的产物。它们å±�蔽了这些微æœ�务框架中å¤�æ�‚çš„é…�置和实现原ç�†ï¼Œä½¿å¼€å�‘人员能够快速ã€�方便地使用 Spring Cloud æ�­å»ºä¸€å¥—分布å¼�å¾®æœ�务系统。 -#### 3\. Spring Boot ºÍ Spring Cloud ÒÀÀµÏîÊýÁ¿²»Í¬ +#### 3\. Spring Boot å’Œ Spring Cloud ä¾�赖项数é‡�ä¸�å�Œ -Spring Boot ÊôÓÚÒ»ÖÖÇáÁ¿¼¶µÄ¿ò¼Ü£¬¹¹½¨ Spring Boot ¹¤³ÌËùÐèµÄÒÀÀµ½ÏÉÙ¡£ +Spring Boot 属于一ç§�è½»é‡�级的框架,构建 Spring Boot 工程所需的ä¾�赖较少。 -Spring Cloud ÊÇһϵÁÐ΢·þÎñ¿ò¼Ü¼¼ÊõµÄ¼¯ºÏÌ壬ËüµÄÿ¸ö×é¼þ¶¼ÐèÒªÒ»¸ö¶ÀÁ¢µÄÒÀÀµÏStarter POM£©£¬Òò´ËÏëÒª¹¹½¨Ò»Ì×ÍêÕûµÄ Spring Cloud ¹¤³ÌÍùÍùÐèÒª´óÁ¿µÄÒÀÀµÏî¡£ +Spring Cloud 是一系列微æœ�务框架技术的集å�ˆä½“,它的æ¯�个组件都需è¦�一个独立的ä¾�赖项(Starter POM),因此想è¦�构建一套完整的 Spring Cloud 工程往往需è¦�大é‡�çš„ä¾�赖项。 -#### 4\. Spring Cloud ²»ÄÜÍÑÀë Spring Boot µ¥¶ÀÔËÐÐ +#### 4\. Spring Cloud ä¸�能脱离 Spring Boot å�•独è¿�行 -Spring Boot ²»ÐèÒª Spring Cloud£¬¾ÍÄÜÖ±½Ó´´½¨¿É¶ÀÁ¢ÔËÐеŤ³Ì»òÄ£¿é¡£ +Spring Boot ä¸�需è¦� Spring Cloud,就能直接创建å�¯ç‹¬ç«‹è¿�行的工程或模å�—。 -Spring Cloud ÊÇ»ùÓÚ Spring Boot ʵÏֵģ¬Ëü²»ÄܶÀÁ¢´´½¨¹¤³Ì»òÄ£¿é£¬¸ü²»ÄÜÍÑÀë Spring Boot ¶ÀÁ¢ÔËÐС£ +Spring Cloud 是基于 Spring Boot 实现的,它ä¸�能独立创建工程或模å�—,更ä¸�能脱离 Spring Boot 独立è¿�行。 -> ×¢Ò⣺ËäÈ» Spring Boot Äܹ»ÓÃÓÚ¿ª·¢µ¥¸ö΢·þÎñ£¬µ«Ëü²¢²»¾ß±¸¹ÜÀíºÍЭµ÷΢·þÎñµÄÄÜÁ¦£¬Òò´ËËüÖ»ÄÜËãÊÇÒ»¸ö΢·þÎñ¿ìËÙ¿ª·¢¿ò¼Ü£¬¶ø·Ç΢·þÎñ¿ò¼Ü¡£ +> 注æ„�:虽然 Spring Boot 能够用于开å�‘å�•个微æœ�务,但它并ä¸�具备管ç�†å’Œå��调微æœ�务的能力,因此它å�ªèƒ½ç®—是一个微æœ�务快速开å�‘框架,而é�žå¾®æœ�务框架。 -## Spring Cloud °æ±¾ +## Spring Cloud 版本 -Spring Cloud °üº¬ÁËÐí¶à×ÓÏîÄ¿£¨×é¼þ£©£¬ÕâЩ×ÓÏîÄ¿¶¼ÊǶÀÁ¢½øÐÐÄÚÈݸüк͵ü´úµÄ£¬¸÷×Ô¶¼Î¬»¤×Å×Ô¼ºµÄ·¢²¼°æ±¾ºÅ¡£ +Spring Cloud 包å�«äº†è®¸å¤šå­�项目(组件),这些å­�项目都是独立进行内容更新和迭代的,å�„自都维护ç�€è‡ªå·±çš„å�‘布版本å�·ã€‚ -ΪÁ˱ÜÃâ Spring Cloud µÄ°æ±¾ºÅÓëÆä×ÓÏîÄ¿µÄ°æ±¾ºÅ»ìÏý£¬Spring Cloud ûÓвÉÓó£¼ûµÄÊý×Ö°æ±¾ºÅ£¬¶øÊÇͨ¹ýÒÔÏ·½Ê½¶¨Òå°æ±¾ÐÅÏ¢¡£ +为了é�¿å…� Spring Cloud 的版本å�·ä¸Žå…¶å­�项目的版本å�·æ··æ·†ï¼ŒSpring Cloud 没有采用常è§�的数字版本å�·ï¼Œè€Œæ˜¯é€šè¿‡ä»¥ä¸‹æ–¹å¼�定义版本信æ�¯ã€‚
{version.name} .{version.number}
-Spring Cloud °æ±¾ÐÅϢ˵Ã÷ÈçÏ£º +Spring Cloud 版本信æ�¯è¯´æ˜Žå¦‚下: -* **version.name**£º°æ±¾Ãû£¬²ÉÓÃÓ¢¹úÂ׶صØÌúÕ¾µÄÕ¾ÃûÀ´ÃüÃû£¬²¢°´ÕÕ×Öĸ±íµÄ˳Ðò£¨¼´´Ó A µ½ Z£©À´¶ÔÓ¦ Spring Cloud µÄ°æ±¾·¢²¼Ë³Ðò£¬ÀýÈçµÚÒ»¸ö°æ±¾Îª Angel£¬µÚ¶þ¸ö°æ±¾Îª Brixton£¨Ó¢¹úµØÃû£©£¬È»ºóÒÀ´ÎÊÇ Camden¡¢Dalston¡¢Edgware¡¢Finchley¡¢Greenwich¡¢Hoxton µÈ¡£ -* **version.number**£º°æ±¾ºÅ£¬Ã¿Ò»¸ö°æ±¾µÄ Spring Cloud ÔÚ¸üÐÂÄÚÈÝ»ýÀÛµ½Ò»¶¨µÄÁ¿¼¶»òÓÐÖØ´ó BUG ÐÞ¸´Ê±£¬¾Í»á·¢²¼Ò»¸ö¡°service releases¡±°æ±¾£¬¼ò³Æ SRX °æ±¾£¬ÆäÖÐ X Ϊһ¸öµÝÔöµÄÊý×Ö£¬ÀýÈç Hoxton.SR8 ¾Í±íʾ Hoxton µÄµÚ 8 ¸ö Release °æ±¾¡£ +* **version.name**:版本å��,采用英国伦敦地é“�站的站å��æ�¥å‘½å��,并按照字æ¯�表的顺åº�(å�³ä»Ž A 到 Z)æ�¥å¯¹åº” Spring Cloud 的版本å�‘布顺åº�,例如第一个版本为 Angel,第二个版本为 Brixton(英国地å��),然å�Žä¾�次是 Camdenã€�Dalstonã€�Edgwareã€�Finchleyã€�Greenwichã€�Hoxton 等。 +* **version.number**:版本å�·ï¼Œæ¯�一个版本的 Spring Cloud 在更新内容积累到一定的é‡�级或有é‡�大 BUG ä¿®å¤�时,就会å�‘布一个“service releasesâ€�版本,简称 SRX 版本,其中 X 为一个递增的数字,例如 Hoxton.SR8 就表示 Hoxton 的第 8 个 Release 版本。 -## Spring Cloud °æ±¾Ñ¡Ôñ +## Spring Cloud 版本选择 -ÔÚʹÓà Spring Boot + Spring Cloud ½øÐÐ΢·þÎñ¿ª·¢Ê±£¬ÎÒÃÇÐèÒª¸ù¾ÝÏîÄ¿ÖÐ Spring Boot µÄ°æ±¾À´¾ö¶¨ Spring Cloud °æ±¾£¬·ñÔò»á³öÏÖÐí¶àÒâÏë²»µ½µÄ´íÎó¡£ +在使用 Spring Boot + Spring Cloud 进行微æœ�务开å�‘时,我们需è¦�æ ¹æ�®é¡¹ç›®ä¸­ Spring Boot 的版本æ�¥å†³å®š Spring Cloud 版本,å�¦åˆ™ä¼šå‡ºçŽ°è®¸å¤šæ„�想ä¸�到的错误。 -Spring Boot Óë Spring Cloud µÄ°æ±¾¶ÔÓ¦¹ØÏµÈçÏÂ±í£¨²Î¿¼×Ô[ ](https://spring.io/projects/spring-cloud)[Spring Cloud ¹ÙÍø](http://spring.io/projects/spring-cloud)£©¡£ +Spring Boot 与 Spring Cloud 的版本对应关系如下表(å�‚考自[ ](https://spring.io/projects/spring-cloud)[Spring Cloud 官网](http://spring.io/projects/spring-cloud))。 | Spring Cloud | Spring Boot | | ------------------- | ---------------------------------------------- | -| 2020.0.x £¨Ilford£© | 2.4.x, 2.5.x £¨´Ó Spring Cloud 2020.0.3 ¿ªÊ¼£© | -| Hoxton | 2.2.x, 2.3.x £¨´Ó Spring Cloud SR5 ¿ªÊ¼£© | +| 2020.0.x (Ilford) | 2.4.x, 2.5.x (从 Spring Cloud 2020.0.3 开始) | +| Hoxton | 2.2.x, 2.3.x (从 Spring Cloud SR5 开始) | | Greenwich | 2.1.x | | Finchley | 2.0.x | | Edgware | 1.5.x | | Dalston | 1.5.x | -> ×¢Ò⣺Spring Cloud ¹Ù·½ÒѾ­Í£Ö¹¶Ô Dalston¡¢Edgware¡¢Finchley ºÍ Greenwich µÄ°æ±¾¸üС£ +> 注æ„�:Spring Cloud 官方已ç»�å�œæ­¢å¯¹ Dalstonã€�Edgwareã€�Finchley å’Œ Greenwich 的版本更新。 -³ýÁËÉϱíÖÐչʾµÄ°æ±¾¶ÔÓ¦¹ØÏµÖ®Í⣬ÎÒÃÇ»¹¿ÉÒÔʹÓÃä¯ÀÀÆ÷·ÃÎÊ [https://start.spring.io/actuator/info](https://start.spring.io/actuator/info)£¬»ñÈ¡ Spring Cloud Óë Spring Boot µÄ°æ±¾¶ÔÓ¦¹ØÏµ£¨JSON °æ£©¡£ +除了上表中展示的版本对应关系之外,我们还å�¯ä»¥ä½¿ç”¨æµ�览器访问 [https://start.spring.io/actuator/info](https://start.spring.io/actuator/info),获å�– Spring Cloud 与 Spring Boot 的版本对应关系(JSON 版)。 @@ -119,9 +119,9 @@ Spring Boot ```` { - ¡­¡­ + …… "bom-ranges":{ - ¡­¡­ + …… "spring-cloud":{ "Hoxton.SR12":"Spring Boot >=2.2.0.RELEASE and <2.4.0.M1", "2020.0.4":"Spring Boot >=2.4.0.M1 and <2.5.6-SNAPSHOT", @@ -129,13 +129,13 @@ Spring Boot "2021.0.0-M1":"Spring Boot >=2.6.0.M1 and <2.6.0-SNAPSHOT", "2021.0.0-SNAPSHOT":"Spring Boot >=2.6.0-SNAPSHOT" }, - ¡­¡­ + …… }, - ¡­¡­ + …… } ```` -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaNacos.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaNacos.md" index 4fc0f7b..7d52b86 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaNacos.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaNacos.md" @@ -1,115 +1,115 @@ -Nacos Ó¢ÎÄÈ«³ÆÎª Dynamic Naming and Configuration Service£¬ÊÇÒ»¸öÓɰ¢Àï°Í°ÍÍŶÓʹÓà Java ÓïÑÔ¿ª·¢µÄ¿ªÔ´ÏîÄ¿¡£ +Nacos 英文全称为 Dynamic Naming and Configuration Service,是一个由阿里巴巴团队使用 Java 语言开å�‘的开æº�项目。 -Nacos ÊÇÒ»¸ö¸üÒ×ÓÚ°ïÖú¹¹½¨ÔÆÔ­ÉúÓ¦ÓõĶ¯Ì¬·þÎñ·¢ÏÖ¡¢ÅäÖúͷþÎñ¹ÜÀíÆ½Ì¨£¨²Î¿¼×Ô [Nacos ¹ÙÍø](https://nacos.io/zh-cn/index.html)£©¡£ +Nacos 是一个更易于帮助构建云原生应用的动æ€�æœ�务å�‘现ã€�é…�置和æœ�务管ç�†å¹³å�°ï¼ˆå�‚考自 [Nacos 官网](https://nacos.io/zh-cn/index.html))。 -Nacos µÄÃüÃûÊÇÓÉ 3 ²¿·Ö×é³É£º +Nacos 的命å��是由 3 部分组æˆ�: -| ×é³É²¿·Ö | È«³Æ | ÃèÊö | +| 组æˆ�部分 | 全称 | æ��è¿° | | -------- | ----------------- | ------------------------------------------------------------ | -| Na | naming/nameServer | ¼´·þÎñ×¢²áÖÐÐÄ£¬Óë Spring Cloud Eureka µÄ¹¦ÄÜÀàËÆ¡£ | -| co | configuration | ¼´ÅäÖÃÖÐÐÄ£¬Óë Spring Cloud Config+Spring Cloud Bus µÄ¹¦ÄÜÀàËÆ¡£ | -| s | service | ¼´·þÎñ£¬±íʾ Nacos ʵÏֵķþÎñ×¢²áÖÐÐĺÍÅäÖÃÖÐÐͼÊÇÒÔ·þÎñΪºËÐĵġ£ | +| Na | naming/nameServer | å�³æœ�务注册中心,与 Spring Cloud Eureka 的功能类似。 | +| co | configuration | å�³é…�置中心,与 Spring Cloud Config+Spring Cloud Bus 的功能类似。 | +| s | service | å�³æœ�务,表示 Nacos 实现的æœ�务注册中心和é…�置中心都是以æœ�务为核心的。 | -ÎÒÃÇ¿ÉÒÔ½« Nacos Àí½â³É·þÎñ×¢²áÖÐÐĺÍÅäÖÃÖÐÐĵÄ×éºÏÌ壬Ëü¿ÉÒÔÌæ»» [Eureka](http://c.biancheng.net/springcloud/eureka.html) ×÷Ϊ·þÎñ×¢²áÖÐÐÄ£¬ÊµÏÖ·þÎñµÄ×¢²áÓë·¢ÏÖ£»»¹¿ÉÒÔÌæ»» [Spring Cloud Config](http://c.biancheng.net/springcloud/config.html) ×÷ΪÅäÖÃÖÐÐÄ£¬ÊµÏÖÅäÖõĶ¯Ì¬Ë¢Ð¡£ +我们å�¯ä»¥å°† Nacos ç�†è§£æˆ�æœ�务注册中心和é…�置中心的组å�ˆä½“,它å�¯ä»¥æ›¿æ�¢ [Eureka](http://c.biancheng.net/springcloud/eureka.html) 作为æœ�务注册中心,实现æœ�务的注册与å�‘现;还å�¯ä»¥æ›¿æ�¢ [Spring Cloud Config](http://c.biancheng.net/springcloud/config.html) 作为é…�置中心,实现é…�置的动æ€�刷新。 -Nacos ×÷Ϊ·þÎñ×¢²áÖÐÐľ­ÀúÁËÊ®Äꡰ˫ʮһ¡±µÄºé·å¿¼Ñ飬¾ßÓмòµ¥Ò×Óá¢Îȶ¨¿É¿¿¡¢ÐÔÄÜ׿ԽµÈÓŵ㣬¿ÉÒÔ°ïÖúÓû§¸üÃô½Ý¡¢ÈÝÒ׵ع¹½¨ºÍ¹ÜÀí΢·þÎñÓ¦Óᣠ+Nacos 作为æœ�务注册中心ç»�历了å��年“å�Œå��一â€�的洪峰考验,具有简å�•易用ã€�稳定å�¯é� ã€�性能å�“越等优点,å�¯ä»¥å¸®åŠ©ç”¨æˆ·æ›´æ•�æ�·ã€�容易地构建和管ç�†å¾®æœ�务应用。 -Nacos Ö§³Ö¼¸ºõËùÓÐÖ÷Á÷ÀàÐÍ¡°·þÎñ¡±µÄ·¢ÏÖ¡¢ÅäÖú͹ÜÀí£º +Nacos 支æŒ�几乎所有主æµ�类型“æœ�务â€�çš„å�‘现ã€�é…�置和管ç�†ï¼š * [Kubernetes Service](https://kubernetes.io/docs/concepts/services-networking/service/) * [gRPC ](https://grpc.io/docs/what-is-grpc/core-concepts#service-definition)& [Dubbo RPC Service](https://dubbo.apache.org/zh/) * Spring Cloud RESTful Service -## Nacos µÄÌØÐÔ +## Nacos 的特性 -Nacos ÌṩÁËһϵÁмòµ¥Ò×ÓõÄÌØÐÔ£¬Äܹ»°ïÖúÎÒÃÇ¿ìËÙµØÊµÏÖ¶¯Ì¬·þÎñ·¢ÏÖ¡¢·þÎñÅäÖõȹ¦ÄÜ¡£ +Nacos æ��供了一系列简å�•易用的特性,能够帮助我们快速地实现动æ€�æœ�务å�‘现ã€�æœ�务é…�置等功能。 -#### ·þÎñ·¢ÏÖ +#### æœ�务å�‘现 -Nacos Ö§³Ö»ùÓÚ DNS ºÍ RPC µÄ·þÎñ·¢ÏÖ¡£µ±·þÎñÌṩÕßʹÓÃÔ­Éú SDK¡¢OpenAPI »òÒ»¸ö¶ÀÁ¢µÄ Agent TODO Ïò Nacos ×¢²á·þÎñºó£¬·þÎñÏû·ÑÕß¿ÉÒÔÔÚ Nacos ÉÏͨ¹ý DNS TODO »ò HTTP&API ²éÕÒ¡¢·¢ÏÖ·þÎñ¡£ +Nacos 支æŒ�基于 DNS å’Œ RPC çš„æœ�务å�‘现。当æœ�务æ��供者使用原生 SDKã€�OpenAPI 或一个独立的 Agent TODO å�‘ Nacos 注册æœ�务å�Žï¼Œæœ�务消费者å�¯ä»¥åœ¨ Nacos 上通过 DNS TODO 或 HTTP&API 查找ã€�å�‘现æœ�务。 -#### ·þÎñ½¡¿µ¼à²â +#### æœ�务å�¥åº·ç›‘测 -Nacos Ìṩ¶Ô·þÎñµÄʵʱ½¡¿µ¼ì²é£¬Äܹ»×èÖ¹ÇëÇó·¢Ë͵½²»½¡¿µÖ÷»ú»ò·þÎñʵÀýÉÏ¡£Nacos »¹ÌṩÁËÒ»¸ö½¡¿µ¼ì²éÒDZíÅÌ£¬Äܹ»°ïÖúÎÒÃǸù¾Ý½¡¿µ×´Ì¬¹ÜÀí·þÎñµÄ¿ÉÓÃÐÔ¼°Á÷Á¿¡£ +Nacos æ��供对æœ�务的实时å�¥åº·æ£€æŸ¥ï¼Œèƒ½å¤Ÿé˜»æ­¢è¯·æ±‚å�‘é€�到ä¸�å�¥åº·ä¸»æœºæˆ–æœ�务实例上。Nacos 还æ��供了一个å�¥åº·æ£€æŸ¥ä»ªè¡¨ç›˜ï¼Œèƒ½å¤Ÿå¸®åŠ©æˆ‘ä»¬æ ¹æ�®å�¥åº·çжæ€�管ç�†æœ�务的å�¯ç”¨æ€§å�Šæµ�é‡�。 -#### ¶¯Ì¬ÅäÖ÷þÎñ +#### 动æ€�é…�ç½®æœ�务 -¶¯Ì¬ÅäÖ÷þÎñ¿ÉÒÔÈÃÎÒÃÇÒÔÖÐÐÄ»¯¡¢Íⲿ»¯ºÍ¶¯Ì¬»¯µÄ·½Ê½£¬¹ÜÀíËùÓл·¾³µÄÓ¦ÓÃÅäÖúͷþÎñÅäÖᣠ+动æ€�é…�ç½®æœ�务å�¯ä»¥è®©æˆ‘们以中心化ã€�外部化和动æ€�化的方å¼�,管ç�†æ‰€æœ‰çŽ¯å¢ƒçš„åº”ç”¨é…�置和æœ�务é…�置。 -¶¯Ì¬ÅäÖÃÏû³ýÁËÅäÖñä¸üÊ±ÖØÐ²¿ÊðÓ¦ÓúͷþÎñµÄÐèÒª£¬ÈÃÅäÖùÜÀí±äµÃ¸ü¼Ó¸ßЧ¡¢Ãô½Ý¡£ +动æ€�é…�置消除了é…�ç½®å�˜æ›´æ—¶é‡�新部署应用和æœ�务的需è¦�,让é…�置管ç�†å�˜å¾—更加高效ã€�æ•�æ�·ã€‚ -ÅäÖÃÖÐÐÄ»¯¹ÜÀíÈÃʵÏÖÎÞ״̬·þÎñ±äµÃ¸ü¼òµ¥£¬È÷þÎñ°´Ð赯ÐÔÀ©Õ¹±äµÃ¸üÈÝÒס£ +é…�置中心化管ç�†è®©å®žçŽ°æ— çŠ¶æ€�æœ�务å�˜å¾—更简å�•,让æœ�务按需弹性扩展å�˜å¾—更容易。 -Nacos ÌṩÁËÒ»¸ö¼ò½àÒ×ÓÃµÄ UI °ïÖúÎÒÃǹÜÀíËùÓзþÎñºÍÓ¦ÓõÄÅäÖá£Nacos »¹Ìṩ°üÀ¨ÅäÖð汾¸ú×Ù¡¢½ð˿ȸ·¢²¼¡¢Ò»¼ü»Ø¹öÅäÖÃÒÔ¼°¿Í»§¶ËÅäÖøüÐÂ״̬¸ú×ÙÔÚÄÚµÄһϵÁпªÏä¼´ÓõÄÅäÖùÜÀíÌØÐÔ£¬°ïÖúÎÒÃǸü°²È«µØÔÚÉú²ú»·¾³ÖйÜÀíÅäÖñä¸üºÍ½µµÍÅäÖñä¸ü´øÀ´µÄ·çÏÕ¡£ +Nacos æ��供了一个简æ´�易用的 UI 帮助我们管ç�†æ‰€æœ‰æœ�务和应用的é…�置。Nacos 还æ��供包括é…�置版本跟踪ã€�金ä¸�雀å�‘布ã€�一键回滚é…�置以å�Šå®¢æˆ·ç«¯é…�置更新状æ€�跟踪在内的一系列开箱å�³ç”¨çš„é…�置管ç�†ç‰¹æ€§ï¼Œå¸®åŠ©æˆ‘ä»¬æ›´å®‰å…¨åœ°åœ¨ç”Ÿäº§çŽ¯å¢ƒä¸­ç®¡ç�†é…�ç½®å�˜æ›´å’Œé™�低é…�ç½®å�˜æ›´å¸¦æ�¥çš„风险。 -#### ¶¯Ì¬ DNS ·þÎñ +#### 动æ€� DNS æœ�务 -Nacos ÌṩÁ˶¯Ì¬ DNS ·þÎñ£¬Äܹ»ÈÃÎÒÃǸüÈÝÒ×µØÊµÏÖ¸ºÔؾùºâ¡¢Á÷Á¿¿ØÖÆÒÔ¼°Êý¾ÝÖÐÐÄÄÚÍøµÄ¼òµ¥ DNS ½âÎö·þÎñ¡£ +Nacos æ��供了动æ€� DNS æœ�务,能够让我们更容易地实现负载å�‡è¡¡ã€�æµ�é‡�控制以å�Šæ•°æ�®ä¸­å¿ƒå†…网的简å�• DNS è§£æž�æœ�务。 -Nacos ÌṩÁËһЩ¼òµ¥µÄ DNS APIs TODO£¬¿ÉÒÔ°ïÖúÎÒÃǹÜÀí·þÎñµÄ¹ØÁªÓòÃûºÍ¿ÉÓÃµÄ IP:PORT ÁÐ±í¡£ +Nacos æ��供了一些简å�•çš„ DNS APIs TODO,å�¯ä»¥å¸®åŠ©æˆ‘ä»¬ç®¡ç�†æœ�务的关è�”域å��å’Œå�¯ç”¨çš„ IP:PORT 列表。 -#### ·þÎñ¼°ÆäÔªÊý¾Ý¹ÜÀí +#### æœ�务å�Šå…¶å…ƒæ•°æ�®ç®¡ç�† -Nacos ÄÜÈÃÎÒÃÇ´Ó΢·þÎñƽ̨½¨ÉèµÄÊӽǹÜÀíÊý¾ÝÖÐÐĵÄËùÓзþÎñ¼°ÔªÊý¾Ý£¬°üÀ¨¹ÜÀí·þÎñµÄÃèÊö¡¢ÉúÃüÖÜÆÚ¡¢·þÎñµÄ¾²Ì¬ÒÀÀµ·ÖÎö¡¢·þÎñµÄ½¡¿µ×´Ì¬¡¢·þÎñµÄÁ÷Á¿¹ÜÀí¡¢Â·Óɼ°°²È«²ßÂÔ¡¢·þÎñµÄ SLA ÒÔ¼° metrics ͳ¼ÆÊý¾Ý¡£ +Nacos 能让我们从微æœ�务平å�°å»ºè®¾çš„视角管ç�†æ•°æ�®ä¸­å¿ƒçš„æ‰€æœ‰æœ�务å�Šå…ƒæ•°æ�®ï¼ŒåŒ…括管ç�†æœ�务的æ��è¿°ã€�生命周期ã€�æœ�务的é�™æ€�ä¾�赖分æž�ã€�æœ�务的å�¥åº·çжæ€�ã€�æœ�务的æµ�é‡�管ç�†ã€�路由å�Šå®‰å…¨ç­–ç•¥ã€�æœ�务的 SLA 以å�Š metrics 统计数æ�®ã€‚ -## Nacos Á½´ó×é¼þ +## Nacos 两大组件 -Óë Eureka ÀàËÆ£¬Nacos Ò²²ÉÓà CS£¨Client/Server£¬¿Í»§¶Ë/·þÎñÆ÷£©¼Ü¹¹£¬Ëü°üº¬Á½´ó×é¼þ£¬ÈçÏÂ±í¡£ -¡¢ +与 Eureka 类似,Nacos 也采用 CS(Client/Server,客户端/æœ�务器)架构,它包å�«ä¸¤å¤§ç»„件,如下表。 +ã€� -| ×é¼þ | ÃèÊö | ¹¦ÄÜ | +| 组件 | æ��è¿° | 功能 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| Nacos Server | Nacos ·þÎñ¶Ë£¬Óë Eureka Server ²»Í¬£¬Nacos Server Óɰ¢Àï°Í°ÍÍŶÓʹÓà Java ÓïÑÔ±àд²¢½« Nacos Server µÄÏÂÔØµØÖ·¸øÓû§£¬Óû§Ö»ÐèÒªÖ±½ÓÏÂÔØ²¢ÔËÐм´¿É¡£ | Nacos Server ¿ÉÒÔ×÷Ϊ·þÎñ×¢²áÖÐÐÄ£¬°ïÖú Nacos Client ʵÏÖ·þÎñµÄ×¢²áÓë·¢ÏÖ¡£ | -| Nacos Server ¿ÉÒÔ×÷ΪÅäÖÃÖÐÐÄ£¬°ïÖú Nacos Client ÔÚ²»ÖØÆôµÄÇé¿öÏ£¬ÊµÏÖÅäÖõĶ¯Ì¬Ë¢Ð¡£ | | | -| Nacos Client | Nacos ¿Í»§¶Ë£¬Í¨³£Ö¸µÄÊÇ΢·þÎñ¼Ü¹¹Öеĸ÷¸ö·þÎñ£¬ÓÉÓû§×Ô¼º´î½¨£¬¿ÉÒÔʹÓöàÖÖÓïÑÔ±àд¡£ | Nacos Client ͨ¹ýÌí¼ÓÒÀÀµ spring-cloud-starter-alibaba-nacos-discovery£¬ÔÚ·þÎñ×¢²áÖÐÐÄ£¨Nacos Server£©ÖÐʵÏÖ·þÎñµÄ×¢²áÓë·¢ÏÖ¡£ | -| Nacos Client ͨ¹ýÌí¼ÓÒÀÀµ spring-cloud-starter-alibaba-nacos-config£¬ÔÚÅäÖÃÖÐÐÄ£¨Nacos Server£©ÖÐʵÏÖÅäÖõĶ¯Ì¬Ë¢Ð¡£ | | | +| Nacos Server | Nacos æœ�务端,与 Eureka Server ä¸�å�Œï¼ŒNacos Server 由阿里巴巴团队使用 Java 语言编写并将 Nacos Server 的下载地å�€ç»™ç”¨æˆ·ï¼Œç”¨æˆ·å�ªéœ€è¦�直接下载并è¿�行å�³å�¯ã€‚ | Nacos Server å�¯ä»¥ä½œä¸ºæœ�务注册中心,帮助 Nacos Client 实现æœ�务的注册与å�‘现。 | +| Nacos Server å�¯ä»¥ä½œä¸ºé…�置中心,帮助 Nacos Client 在ä¸�é‡�å�¯çš„æƒ…况下,实现é…�置的动æ€�刷新。 | | | +| Nacos Client | Nacos 客户端,通常指的是微æœ�务架构中的å�„个æœ�务,由用户自己æ�­å»ºï¼Œå�¯ä»¥ä½¿ç”¨å¤šç§�语言编写。 | Nacos Client 通过添加ä¾�èµ– spring-cloud-starter-alibaba-nacos-discovery,在æœ�务注册中心(Nacos Server)中实现æœ�务的注册与å�‘现。 | +| Nacos Client 通过添加ä¾�èµ– spring-cloud-starter-alibaba-nacos-config,在é…�置中心(Nacos Server)中实现é…�置的动æ€�刷新。 | | | -## Nacos ·þÎñ×¢²áÖÐÐÄ +## Nacos æœ�务注册中心 -Nacos ×÷Ϊ·þÎñ×¢²áÖÐÐÄ¿ÉÒÔʵÏÖ·þÎñµÄ×¢²áÓë·¢ÏÖ£¬Á÷³ÌÈçÏÂͼ¡£ +Nacos 作为æœ�务注册中心å�¯ä»¥å®žçްæœ�务的注册与å�‘现,æµ�程如下图。 -![Nacos ·þÎñ×¢²áÓë·¢ÏÖ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022563360-0.png) -ͼ1£ºNacos ·þÎñ×¢²áÓë·¢ÏÖ +![Nacos æœ�务注册与å�‘现](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022563360-0.png) +图1:Nacos æœ�务注册与å�‘现 -ÔÚͼ 1 Öй²Éæ¼°µ½ÒÔÏ 3 ¸ö½ÇÉ«£º +在图 1 中共涉å�Šåˆ°ä»¥ä¸‹ 3 个角色: -* ·þÎñ×¢²áÖÐÐÄ£¨Register Service£©£ºËüÊÇÒ»¸ö Nacos Server£¬¿ÉÒÔΪ·þÎñÌṩÕߺͷþÎñÏû·ÑÕßÌṩ·þÎñ×¢²áºÍ·¢ÏÖ¹¦ÄÜ¡£ -* ·þÎñÌṩÕߣ¨Provider Service£©£ºËüÊÇÒ»¸ö Nacos Client£¬ÓÃÓÚ¶ÔÍâ·þÎñ¡£Ëü½«×Ô¼ºÌṩµÄ·þÎñ×¢²áµ½·þÎñ×¢²áÖÐÐÄ£¬ÒÔ¹©·þÎñÏû·ÑÕß·¢Ïֺ͵÷Óᣠ-* ·þÎñÏû·ÑÕߣ¨Consumer Service£©£ºËüÊÇÒ»¸ö Nacos Client£¬ÓÃÓÚÏû·Ñ·þÎñ¡£Ëü¿ÉÒÔ´Ó·þÎñ×¢²áÖÐÐÄ»ñÈ¡·þÎñÁÐ±í£¬µ÷ÓÃËùÐèµÄ·þÎñ¡£ +* æœ�务注册中心(Register Service):它是一个 Nacos Server,å�¯ä»¥ä¸ºæœ�务æ��供者和æœ�务消费者æ��ä¾›æœ�务注册和å�‘现功能。 +* æœ�务æ��供者(Provider Service):它是一个 Nacos Client,用于对外æœ�务。它将自己æ��供的æœ�务注册到æœ�务注册中心,以供æœ�务消费者å�‘现和调用。 +* æœ�务消费者(Consumer Service):它是一个 Nacos Client,用于消费æœ�务。它å�¯ä»¥ä»Žæœ�务注册中心获å�–æœ�务列表,调用所需的æœ�务。 -Nacos ʵÏÖ·þÎñ×¢²áÓë·¢ÏÖµÄÁ÷³ÌÈçÏ£º +Nacos 实现æœ�务注册与å�‘现的æµ�程如下: -1. ´Ó Nacos ¹Ù·½ÌṩµÄÏÂÔØÒ³ÃæÖУ¬ÏÂÔØ Nacos Server ²¢ÔËÐС£ -2. ·þÎñÌṩÕß Nacos Client Æô¶¯Ê±£¬»á°Ñ·þÎñÒÔ·þÎñÃû£¨spring.application.name£©µÄ·½Ê½×¢²áµ½·þÎñ×¢²áÖÐÐÄ£¨Nacos Server£©£» -3. ·þÎñÏû·ÑÕß Nacos Client Æô¶¯Ê±£¬Ò²»á½«×Ô¼ºµÄ·þÎñ×¢²áµ½·þÎñ×¢²áÖÐÐÄ£» -4. ·þÎñÏû·ÑÕßÔÚ×¢²á·þÎñµÄͬʱ£¬Ëü»¹»á´Ó·þÎñ×¢²áÖÐÐÄ»ñȡһ·Ý·þÎñ×¢²áÁбíÐÅÏ¢£¬¸ÃÁбíÖаüº¬ÁËËùÓÐ×¢²áµ½·þÎñ×¢²áÖÐÐÄÉϵķþÎñµÄÐÅÏ¢£¨°üÀ¨·þÎñÌṩÕߺÍ×ÔÉíµÄÐÅÏ¢£©£» -5. ÔÚ»ñÈ¡ÁË·þÎñÌṩÕßµÄÐÅÏ¢ºó£¬·þÎñÏû·ÑÕßͨ¹ý HTTP »òÏûÏ¢Öмä¼þÔ¶³Ìµ÷Ó÷þÎñÌṩÕßÌṩµÄ·þÎñ¡£ +1. 从 Nacos 官方æ��供的下载页é�¢ä¸­ï¼Œä¸‹è½½ Nacos Server å¹¶è¿�行。 +2. æœ�务æ��供者 Nacos Client å�¯åŠ¨æ—¶ï¼Œä¼šæŠŠæœ�务以æœ�务å��(spring.application.name)的方å¼�注册到æœ�务注册中心(Nacos Server); +3. æœ�务消费者 Nacos Client å�¯åŠ¨æ—¶ï¼Œä¹Ÿä¼šå°†è‡ªå·±çš„æœ�务注册到æœ�务注册中心; +4. æœ�务消费者在注册æœ�务的å�Œæ—¶ï¼Œå®ƒè¿˜ä¼šä»Žæœ�务注册中心获å�–一份æœ�务注册列表信æ�¯ï¼Œè¯¥åˆ—表中包å�«äº†æ‰€æœ‰æ³¨å†Œåˆ°æœ�务注册中心上的æœ�务的信æ�¯ï¼ˆåŒ…括æœ�务æ��供者和自身的信æ�¯ï¼‰ï¼› +5. 在获å�–了æœ�务æ��供者的信æ�¯å�Žï¼Œæœ�务消费者通过 HTTP 或消æ�¯ä¸­é—´ä»¶è¿œç¨‹è°ƒç”¨æœ�务æ��供者æ��供的æœ�务。 -#### °²×°ºÍÔËÐÐ Nacos Server +#### 安装和è¿�行 Nacos Server -ÏÂÃæÎÒÃÇÒÔ Nacos 2.0.3 ΪÀý£¬ÑÝʾÏÂÈçºÎ°²×°ºÍÔËÐÐ Nacos Server£¬²½ÖèÈçÏ¡£ +下é�¢æˆ‘们以 Nacos 2.0.3 为例,演示下如何安装和è¿�行 Nacos Server,步骤如下。 -1\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ [Nacos Server ÏÂÔØÒ³Ãæ](https://github.com/alibaba/nacos/releases/tag/2.0.3)£¬²¢ÔÚÒ³Ãæ×îÏ·½µã»÷Á´½Ó nacos-server-2.0.3.zip£¬ÈçÏÂͼ¡£ +1\. 使用æµ�览器访问 [Nacos Server 下载页é�¢](https://github.com/alibaba/nacos/releases/tag/2.0.3),并在页é�¢æœ€ä¸‹æ–¹ç‚¹å‡»é“¾æŽ¥ nacos-server-2.0.3.zip,如下图。 -![Nacos ÏÂÔØ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022562c6-1.png) -ͼ2£ºNacos Server ÏÂÔØ +![Nacos 下载](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022562c6-1.png) +图2:Nacos Server 下载 -2\. ÏÂÔØÍê³Éºó£¬½âѹ nacos-server-2.0.3.zip£¬Ä¿Â¼½á¹¹ÈçÏ¡£ +2\. 下载完æˆ�å�Žï¼Œè§£åŽ‹ nacos-server-2.0.3.zip,目录结构如下。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022563922-2.png) -ͼ3£ºNacos Server Ŀ¼½á¹¹ +图3:Nacos Server 目录结构 -Nacos Server ϸ÷Ŀ¼˵Ã÷ÈçÏ£º +Nacos Server 下å�„目录说明如下: -* bin£ºÓÃÓÚ´æ·Å Nacos µÄ¿ÉÖ´ÐÐÃüÁî¡£ -* conf£ºÓÃÓÚ´æ·Å Nacos ÅäÖÃÎļþ¡£ -* target£ºÓÃÓÚ´æ·Å Nacos Ó¦ÓÃµÄ jar °ü¡£ +* bin:用于存放 Nacos çš„å�¯æ‰§è¡Œå‘½ä»¤ã€‚ +* conf:用于存放 Nacos é…�置文件。 +* target:用于存放 Nacos 应用的 jar 包。 -3\. ´ò¿ªÃüÁîÐд°¿Ú£¬Ìø×ªµ½ Nacos Server °²×°Ä¿Â¼µÄ bin Ï£¬Ö´ÐÐÒÔÏÂÃüÁÒÔµ¥»úģʽÆô¶¯ Nacos Server¡£ +3\. 打开命令行窗å�£ï¼Œè·³è½¬åˆ° Nacos Server 安装目录的 bin 下,执行以下命令,以å�•机模å¼�å�¯åЍ Nacos Server。 startup.cmd -m standalone -4\. Nacos Server Æô¶¯ÈÕÖ¾ÈçÏ¡£ +4\. Nacos Server å�¯åŠ¨æ—¥å¿—å¦‚ä¸‹ã€‚ "nacos is starting with standalone" @@ -149,23 +149,23 @@ ramework.security.web.access.ExceptionTranslationFilter@3727f0ee] 2021-11-08 16:16:55,309 INFO Tomcat started on port(s): 8848 (http) with context path '/nacos' 2021-11-08 16:16:55,319 INFO Nacos started successfully in stand alone mode. use embedded storage ```` -5\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:8848/nacos¡±£¬Ìø×ªµ½ Nacos Server µÇÂ½Ò³Ãæ£¬ÈçÏÂͼ¡£ +5\. 使用æµ�览器访问“http://localhost:8848/nacosâ€�,跳转到 Nacos Server 登陆页é�¢ï¼Œå¦‚下图。 -![Nacos µÇÂ½Ò³Ãæ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022562045-3.png) -ͼ4£ºNacos Server µÇÂ½Ò³Ãæ +![Nacos 登陆页é�¢](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022562045-3.png) +图4:Nacos Server 登陆页é�¢ -6\. ÔڵǽҳÊäÈëµÇ¼ÃûºÍÃÜÂ루ĬÈ϶¼ÊÇ nacos£©£¬µã»÷Ìá½»°´Å¥£¬Ìø×ªµ½ Nacos Server ¿ØÖÆÌ¨Ö÷Ò³£¬ÈçÏÂͼ¡£ +6\. 在登陆页输入登录å��和密ç �(默认都是 nacos),点击æ��交按钮,跳转到 Nacos Server 控制å�°ä¸»é¡µï¼Œå¦‚下图。 -![Nacos Server Ö÷Ò³](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225633C-4.png) -ͼ5£ºNacos Server ¿ØÖÆÌ¨ +![Nacos Server 主页](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225633C-4.png) +图5:Nacos Server 控制å�° -×Ô´Ë£¬ÎÒÃǾÍÍê³ÉÁË Nacos Server µÄÏÂÔØ¡¢°²×°ºÍÔËÐй¤×÷¡£ +自此,我们就完æˆ�了 Nacos Server 的下载ã€�安装和è¿�行工作。 -#### ´î½¨·þÎñÌṩÕß +#### æ�­å»ºæœ�务æ��供者 -½ÓÏÂÀ´£¬ÎÒÃÇÀ´´î½¨Ò»¸ö·þÎñÌṩÕߣ¬²½ÖèÈçÏ¡£ +接下æ�¥ï¼Œæˆ‘们æ�¥æ�­å»ºä¸€ä¸ªæœ�务æ��供者,步骤如下。 -1. ´´½¨Ò»¸öÃûΪ spring-cloud-alibaba-demo µÄ Maven ¹¤³Ì £¬¸Ã¹¤³ÌµÄ pom.xml ÄÚÈÝÈçÏ¡£ +1. 创建一个å��为 spring-cloud-alibaba-demo çš„ Maven 工程 ,该工程的 pom.xml 内容如下。 @@ -201,7 +201,7 @@ ramework.security.web.access.ExceptionTranslationFilter@3727f0ee] - + com.alibaba.cloud spring-cloud-alibaba-dependencies @@ -209,7 +209,7 @@ ramework.security.web.access.ExceptionTranslationFilter@3727f0ee] pom import - + org.springframework.cloud spring-cloud-dependencies @@ -226,9 +226,9 @@ ramework.security.web.access.ExceptionTranslationFilter@3727f0ee] -> Ôڸù¤³ÌµÄ pom.xml ÖУ¬ÎÒÃÇͨ¹ý dependencyManagement ¶Ô Spring Cloud Alibaba µÄ°æ±¾ÐÅÏ¢½øÐйÜÀí£¬¸Ã¹¤³Ìϵĸ÷¸ö×ÓÄ£¿éÔÚÒýÈë Spring Cloud Alibaba µÄ¸÷¸ö×é¼þʱ¾Í²»Òªµ¥¶ÀÖ¸¶¨°æ±¾ºÅÁË¡£ +> 在该工程的 pom.xml 中,我们通过 dependencyManagement 对 Spring Cloud Alibaba 的版本信æ�¯è¿›è¡Œç®¡ç�†ï¼Œè¯¥å·¥ç¨‹ä¸‹çš„å�„个å­�模å�—在引入 Spring Cloud Alibaba çš„å�„个组件时就ä¸�è¦�å�•独指定版本å�·äº†ã€‚ -2\. ÔÚ spring-cloud-alibaba-demo Ï£¬´´½¨Ò»¸öÃûΪ spring-cloud-alibaba-provider-8001 µÄ Spring Boot Ä£¿é£¬²¢ÔÚÆä pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ£¬ÄÚÈÝÈçÏ¡£ +2\. 在 spring-cloud-alibaba-demo 下,创建一个å��为 spring-cloud-alibaba-provider-8001 çš„ Spring Boot 模å�—,并在其 pom.xml 中添加以下ä¾�赖,内容如下。 @@ -238,7 +238,7 @@ ramework.security.web.access.ExceptionTranslationFilter@3727f0ee] 4.0.0 - + net.biancheng.c 1.0-SNAPSHOT @@ -305,18 +305,18 @@ ramework.security.web.access.ExceptionTranslationFilter@3727f0ee] -3\. ÔÚ spring-cloud-alibaba-provider-8001 µÄÅäÖÃÎļþ application.properties ÖÐÌí¼ÓÒÔÏÂÅäÖã¬ÄÚÈÝÈçÏ¡£ +3\. 在 spring-cloud-alibaba-provider-8001 çš„é…�置文件 application.properties 中添加以下é…�置,内容如下。 ```` -#¶Ë¿ÚºÅ +#端å�£å�· server.port=8001 -#·þÎñÃû +#æœ�务å�� spring.application.name=spring-cloud-alibaba-provider -#Nacos Server µÄµØÖ· +#Nacos Server 的地å�€ spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 management.endpoints.web.exposure.include=* ```` -4\. ÔÚ net.biacheng.c.controller °üÏ£¬´´½¨Ò»¸öÃûΪ DeptController µÄ Controller À࣬´úÂëÈçÏ¡£ +4\. 在 net.biacheng.c.controller 包下,创建一个å��为 DeptController çš„ Controller 类,代ç �如下。 @@ -339,7 +339,7 @@ public class DeptController { @GetMapping(value = "/dept/nacos/{id}") public String getPayment(@PathVariable("id") Integer id) { - return "

cÓïÑÔÖÐÎÄÍøÌáÐÑÄú£¬·þÎñ·ÃÎʳɹ¦£¡

·þÎñÃû£ºspring-cloud-alibaba-provider
¶Ë¿ÚºÅ£º " + serverPort + "
´«ÈëµÄ²ÎÊý£º" + id; + return "

c语言中文网�醒您,�务访问�功�

�务�:spring-cloud-alibaba-provider
端��: " + serverPort + "
传入的å�‚数:" + id; } } @@ -348,7 +348,7 @@ public class DeptController { -5\. ÔÚ spring-cloud-alibaba-provider-8001 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableDiscoveryClient ×¢½â¿ªÆô Nacos ·þÎñ·¢ÏÖ¹¦ÄÜ£¬´úÂëÈçÏ¡£ +5\. 在 spring-cloud-alibaba-provider-8001 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableDiscoveryClient 注解开å�¯ Nacos æœ�务å�‘现功能,代ç �如下。 @@ -362,7 +362,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; @SpringBootApplication -@EnableDiscoveryClient //¿ªÆô·þÎñ·¢ÏÖ¹¦ÄÜ +@EnableDiscoveryClient //å¼€å�¯æœ�务å�‘现功能 public class SpringCloudAlibabaProvider8001Application { public static void main(String[] args) { @@ -375,23 +375,23 @@ public class SpringCloudAlibabaProvider8001Application { -6\. Æô¶¯ spring-cloud-alibaba-provider-8001£¬Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:8001/dept/nacos/1¡±£¬½á¹ûÈçÏÂͼ¡£ +6\. å�¯åЍ spring-cloud-alibaba-provider-8001,使用æµ�览器访问“http://localhost:8001/dept/nacos/1â€�,结果如下图。 -![·ÃÎÊ·þÎñÌṩÕߵķþÎñ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225C033-5.png) -ͼ6£º·þÎñÌṩÕß +![访问æœ�务æ��供者的æœ�务](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225C033-5.png) +图6:æœ�务æ��供者 -7\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:8848/nacos¡±£¬²é¿´¡°·þÎñ¹ÜÀí¡±Ïµġ°·þÎñÁÐ±í¡±£¬ÈçÏÂͼ¡£ +7\. 使用æµ�览器访问“http://localhost:8848/nacosâ€�,查看“æœ�务管ç�†â€�下的“æœ�务列表â€�,如下图。 -[![Nacos ·þÎñÁбí](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225Ab5-6.png)](http://new-local.weixueyuan.net/uploads/allimg/211108/6-21110QJ12b02.png) -ͼ7£º·þÎñ×¢²áÁбí +[![Nacos æœ�务列表](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225Ab5-6.png)](http://new-local.weixueyuan.net/uploads/allimg/211108/6-21110QJ12b02.png) +图7:æœ�务注册列表 -´Óͼ 7 ¿ÉÒÔ¿´µ½£¬ÎÒÃǴµÄ·þÎñÌṩÕß spring-cloud-alibaba-provider-8001 ËùÌṩµÄ·þÎñÒѾ­±»×¢²áµ½ÁË Nacos Server ÉÏÁË¡£ +从图 7 å�¯ä»¥çœ‹åˆ°ï¼Œæˆ‘们æ�­å»ºçš„æœ�务æ��供者 spring-cloud-alibaba-provider-8001 所æ��供的æœ�务已ç»�被注册到了 Nacos Server 上了。 -#### ´î½¨·þÎñÏû·ÑÕß +#### æ�­å»ºæœ�务消费者 -ÏÂÃæ£¬ÎÒÃǾÍÀ´´î½¨Ò»¸ö·þÎñÏû·ÑÕßÀ´Ïû·Ñ spring-cloud-alibaba-provider-8001 ÌṩµÄ·þÎñ£¬²½ÖèÈçÏ¡£ +下é�¢ï¼Œæˆ‘们就æ�¥æ�­å»ºä¸€ä¸ªæœ�务消费者æ�¥æ¶ˆè´¹ spring-cloud-alibaba-provider-8001 æ��供的æœ�务,步骤如下。 -1\. ÔÚÖ÷¹¤³Ì spring-cloud-alibaba-demo Ï£¬´´½¨Ò»¸öÃûΪ spring-cloud-alibaba-consumer-nacos-8801 µÄ Spring Boot Ä£¿é£¬²¢ÔÚÆä pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ¡£ +1\. 在主工程 spring-cloud-alibaba-demo 下,创建一个å��为 spring-cloud-alibaba-consumer-nacos-8801 çš„ Spring Boot 模å�—,并在其 pom.xml 中添加以下ä¾�赖。 @@ -420,7 +420,7 @@ public class SpringCloudAlibabaProvider8001Application { com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery
- + org.springframework.cloud spring-cloud-loadbalancer @@ -473,35 +473,35 @@ public class SpringCloudAlibabaProvider8001Application { -> ×¢Ò⣺ÓÉÓÚ Netflix Ribbon ÒѾ­½øÈëÍ£¸üά»¤×´Ì¬£¬Nacos Discovery ÒѾ­Í£ÁË¶Ô Ribbon µÄÖ§³Ö£¬Òò´ËÎÒÃÇÐèÒªÔÚ·þÎñÏû·ÑÕßµÄ pom.xml ÖÐÒýÈë spring-cloud-loadbalancer ²ÅÄܵ÷Ó÷þÎñÌṩÕßÌṩµÄ·þÎñ¡£ +> 注æ„�:由于 Netflix Ribbon å·²ç»�进入å�œæ›´ç»´æŠ¤çжæ€�,Nacos Discovery å·²ç»�å�œäº†å¯¹ Ribbon 的支æŒ�,因此我们需è¦�在æœ�务消费者的 pom.xml 中引入 spring-cloud-loadbalancer æ‰�能调用æœ�务æ��供者æ��供的æœ�务。 -2\. ÔÚ spring-cloud-alibaba-consumer-nacos-8801 µÄÅäÖÃÎļþ application.yml ÖУ¬Ìí¼ÓÒÔÏÂÅäÖᣠ+2\. 在 spring-cloud-alibaba-consumer-nacos-8801 çš„é…�置文件 application.yml 中,添加以下é…�置。 ```` server: - port: 8801 #¶Ë¿ÚºÅ + port: 8801 #端å�£å�· spring: application: - name: spring-cloud-alibaba-consumer #·þÎñÃû + name: spring-cloud-alibaba-consumer #æœ�务å�� cloud: nacos: discovery: - server-addr: localhost:8848 #Nacos server µÄµØÖ· + server-addr: localhost:8848 #Nacos server 的地å�€ ```` -#ÒÔÏÂÅäÖÃÐÅÏ¢²¢²»ÊÇĬÈÏÅäÖ㬶øÊÇÎÒÃÇ×Ô¶¨ÒåµÄÅäÖã¬Ä¿µÄÊDz»ÔÚ Controller ÄÚÓ²±àÂë·þÎñÌṩÕߵķþÎñÃû +#以下é…�置信æ�¯å¹¶ä¸�是默认é…�置,而是我们自定义的é…�置,目的是ä¸�在 Controller 内硬编ç �æœ�务æ��供者的æœ�务å�� ```` service-url: - nacos-user-service: http://spring-cloud-alibaba-provider #·þÎñÌṩÕߵķþÎñÃû + nacos-user-service: http://spring-cloud-alibaba-provider #æœ�务æ��供者的æœ�务å�� ```` -3\. ÔÚ spring-cloud-alibaba-consumer-nacos-8801 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableDiscoveryClient ×¢½â¿ªÆô·þÎñ·¢ÏÖ¹¦ÄÜ£¬´úÂëÈçÏ¡£ +3\. 在 spring-cloud-alibaba-consumer-nacos-8801 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableDiscoveryClient 注解开å�¯æœ�务å�‘现功能,代ç �如下。 @@ -515,7 +515,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; @SpringBootApplication -@EnableDiscoveryClient // ¿ªÆô·þÎñ×¢²áÓë·¢ÏÖ¹¦ÄÜ +@EnableDiscoveryClient // å¼€å�¯æœ�务注册与å�‘现功能 public class SpringCloudAlibabaConsumerNacos8801Application { public static void main(String[] args) { @@ -528,7 +528,7 @@ public class SpringCloudAlibabaConsumerNacos8801Application { -4\. ÔÚ net.biancheng.c.config °üÏ´´½¨Ò»¸öÃûΪ ApplicationContextBean µÄÅäÖÃÀ࣬²¢Ê¹Óà @LoadBalanced ×¢½âÓë Ribbon ½øÐм¯³É¿ªÆô¸ºÔؾùºâ¹¦ÄÜ£¬´úÂëÈçÏ¡£ +4\. 在 net.biancheng.c.config 包下创建一个å��为 ApplicationContextBean çš„é…�置类,并使用 @LoadBalanced 注解与 Ribbon 进行集æˆ�å¼€å�¯è´Ÿè½½å�‡è¡¡åŠŸèƒ½ï¼Œä»£ç �如下。 @@ -546,7 +546,7 @@ import org.springframework.web.client.RestTemplate; public class ApplicationContextBean { @Bean - @LoadBalanced //Óë Ribbon ¼¯³É£¬²¢¿ªÆô¸ºÔؾùºâ¹¦ÄÜ + @LoadBalanced //与 Ribbon 集æˆ�,并开å�¯è´Ÿè½½å�‡è¡¡åŠŸèƒ½ public RestTemplate getRestTemplate() { return new RestTemplate(); } @@ -557,7 +557,7 @@ public class ApplicationContextBean { -5\. ÔÚ net.biancheng.c.controller °üÏ£¬´´½¨Ò»¸öÃûΪ DeptController_Consumer µÄ Controller À࣬´úÂëÈçÏ¡£ +5\. 在 net.biancheng.c.controller 包下,创建一个å��为 DeptController_Consumer çš„ Controller 类,代ç �如下。 @@ -583,7 +583,7 @@ public class DeptController_Consumer { private RestTemplate restTemplate; @Value("${service-url.nacos-user-service}") - private String serverURL; //·þÎñÌṩÕߵķþÎñÃû + private String serverURL; //æœ�务æ��供者的æœ�务å�� @GetMapping("/consumer/dept/nacos/{id}") public String paymentInfo(@PathVariable("id") Long id) { @@ -596,25 +596,25 @@ public class DeptController_Consumer { -6\. Æô¶¯ spring-cloud-alibaba-consumer-nacos-8801£¬²é¿´ Nacos Server µÄ·þÎñÁÐ±í£¬ÈçÏÂͼ¡£ +6\. å�¯åЍ spring-cloud-alibaba-consumer-nacos-8801,查看 Nacos Server çš„æœ�务列表,如下图。 -[![·þÎñÏû·ÑÕßÕâ Nacos Server ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225621N-7.png)](http://new-local.weixueyuan.net/uploads/allimg/211109/6-21110Z91435H1.png) -ͼ8£º·þÎñÏû·ÑÕß +[![æœ�务消费者这 Nacos Server ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225621N-7.png)](http://new-local.weixueyuan.net/uploads/allimg/211109/6-21110Z91435H1.png) +图8:æœ�务消费者 -7\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:8801/consumer/dept/nacos/1¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. 使用æµ�览器访问“http://localhost:8801/consumer/dept/nacos/1â€�,结果如下图。 -![Nacos ·þÎñÏû·ÑÕßÏû·Ñ·þÎñ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225B156-8.png) -ͼ9£º·þÎñÏû·ÑÕßµ÷Ó÷þÎñ +![Nacos æœ�务消费者消费æœ�务](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225B156-8.png) +图9:æœ�务消费者调用æœ�务 -## Nacos ÅäÖÃÖÐÐÄ +## Nacos é…�置中心 -Nacos Server »¹¿ÉÒÔ×÷ΪÅäÖÃÖÐÐÄ£¬¶Ô Spring Cloud Ó¦ÓõÄÍⲿÅäÖýøÐÐͳһµØ¼¯Öл¯¹ÜÀí¡£¶øÎÒÃÇÖ»ÐèÒªÔÚÓ¦ÓÃµÄ POM ÎļþÖÐÒýÈë spring-cloud-starter-alibaba-nacos-config ¼´¿ÉʵÏÖÅäÖõĻñÈ¡Ó붯̬ˢС£ +Nacos Server 还å�¯ä»¥ä½œä¸ºé…�置中心,对 Spring Cloud 应用的外部é…�置进行统一地集中化管ç�†ã€‚而我们å�ªéœ€è¦�在应用的 POM 文件中引入 spring-cloud-starter-alibaba-nacos-config å�³å�¯å®žçްé…�置的获å�–与动æ€�刷新。 -´ÓÅäÖùÜÀíµÄ½Ç¶È¿´£¬Nacos ¿ÉÒÔ˵ÊÇ Spring Cloud Config µÄÌæ´ú·½°¸£¬µ«Ïà±ÈºóÕß Nacos µÄʹÓøü¼òµ¥£¬²Ù×÷²½ÖèÒ²¸üÉÙ¡£ +从é…�置管ç�†çš„角度看,Nacos å�¯ä»¥è¯´æ˜¯ Spring Cloud Config 的替代方案,但相比å�Žè€… Nacos 的使用更简å�•,æ“�作步骤也更少。 -½ÓÏÂÀ´£¬ÎÒÃÇͨ¹ýÒ»¸öʵÀýÀ´ÑÝʾÏ Nacos ÊÇÈçºÎʵÏÖÅäÖõÄͳһ¹ÜÀíºÍ¶¯Ì¬Ë¢Ðµġ£ +接下æ�¥ï¼Œæˆ‘们通过一个实例æ�¥æ¼”示下 Nacos 是如何实现é…�置的统一管ç�†å’ŒåЍæ€�刷新的。 -1\. ÔÚÖ÷¹¤³Ì spring-cloud-alibaba-demo Ï£¬´´½¨Ò»¸öÃûΪ spring-cloud-alibaba-config-client-3377 µÄ Spring Boot Ä£¿é£¬²¢ÔÚÆä pom.xml ÖÐÌí¼ÓÒÔÏÂÒÀÀµ¡£ +1\. 在主工程 spring-cloud-alibaba-demo 下,创建一个å��为 spring-cloud-alibaba-config-client-3377 çš„ Spring Boot 模å�—,并在其 pom.xml 中添加以下ä¾�赖。 @@ -642,7 +642,7 @@ Nacos Server org.springframework.boot spring-boot-starter-web - + org.springframework.cloud spring-cloud-starter-bootstrap @@ -665,17 +665,17 @@ Nacos Server spring-boot-starter-test test - + com.alibaba.cloud spring-cloud-starter-alibaba-nacos-config - + com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery - + org.springframework.boot spring-boot-starter-actuator @@ -705,34 +705,34 @@ Nacos Server -> ×¢Ò⣺ÎÒÃÇʹÓÃµÄ Spring Cloud 2020 °æ±¾Ä¬Èϲ»ÆôÓà bootstrap£¬ÈôÏëÒªÔÚÓ¦ÓÃÆô¶¯Ê±¼ÓÔØ bootstrap ÅäÖã¨ÀýÈç bootstrap.yml »ò bootstrap.properties£©£¬¾ÍÐèÒªÎÒÃÇÔÚ pom.xml ÖÐÏÔʽµÄÒýÈë spring-cloud-starter-bootstrap ÒÀÀµ¡£ +> 注æ„�:我们使用的 Spring Cloud 2020 版本默认ä¸�å�¯ç”¨ bootstrap,若想è¦�在应用å�¯åŠ¨æ—¶åŠ è½½ bootstrap é…�置(例如 bootstrap.yml 或 bootstrap.properties),就需è¦�我们在 pom.xml 中显å¼�的引入 spring-cloud-starter-bootstrap ä¾�赖。 -2\. ÔÚ spring-cloud-alibaba-config-client-3377 µÄÀà·¾¶£¨ÀýÈç /resources Ŀ¼£©Ï£¬Ìí¼ÓÒ»¸ö bootstrap.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +2\. 在 spring-cloud-alibaba-config-client-3377 的类路径(例如 /resources 目录)下,添加一个 bootstrap.yml,é…�置内容如下。 ```` server: - port: 3377 #¶Ë¿ÚºÅ + port: 3377 #端å�£å�· spring: application: - name: config-client #·þÎñÃû + name: config-client #æœ�务å�� cloud: nacos: discovery: - server-addr: 127.0.0.1:8848 #Nacos·þÎñ×¢²áÖÐÐĵØÖ· + server-addr: 127.0.0.1:8848 #Nacosæœ�务注册中心地å�€ config: - server-addr: 127.0.0.1:8848 #Nacos×÷ΪÅäÖÃÖÐÐĵØÖ· - file-extension: yaml #Ö¸¶¨yaml¸ñʽµÄÅäÖà + server-addr: 127.0.0.1:8848 #Nacos作为é…�置中心地å�€ + file-extension: yaml #指定yamlæ ¼å¼�çš„é…�ç½® ```` -3\. ÔÚ spring-cloud-alibaba-config-client-3377 µÄÀà·¾¶£¨ÀýÈç /resources Ŀ¼£©Ï£¬Ìí¼ÓÒ»¸ö application.yml£¬ÅäÖÃÄÚÈÝÈçÏ¡£ +3\. 在 spring-cloud-alibaba-config-client-3377 的类路径(例如 /resources 目录)下,添加一个 application.yml,é…�置内容如下。 @@ -740,14 +740,14 @@ spring: ```` spring: profiles: - active: dev #¼¤»î dev µÄÅäÖà + active: dev #激活 dev çš„é…�ç½® ```` -4\. ÔÚ net.biancheng.c.controller °üÏ£¬´´½¨Ò»¸öÃûΪ ConfigClientController µÄ Controller À࣬²¢ÔÚ¸ÃÀàÉÏʹÓà @RefreshScope ×¢½âʵÏÖÅäÖõÄ×Ô¶¯¸üУ¬´úÂëÈçÏ¡£ +4\. 在 net.biancheng.c.controller 包下,创建一个å��为 ConfigClientController çš„ Controller 类,并在该类上使用 @RefreshScope 注解实现é…�置的自动更新,代ç �如下。 @@ -779,7 +779,7 @@ public class ConfigClientController { -5\. ÔÚ spring-cloud-alibaba-config-client-3377 µÄÖ÷Æô¶¯ÀàÉÏ£¬Ê¹Óà @EnableDiscoveryClient ×¢½â¿ªÆô·þÎñ·¢ÏÖ¹¦ÄÜ£¬´úÂëÈçÏ¡£ +5\. 在 spring-cloud-alibaba-config-client-3377 的主å�¯åŠ¨ç±»ä¸Šï¼Œä½¿ç”¨ @EnableDiscoveryClient 注解开å�¯æœ�务å�‘现功能,代ç �如下。 @@ -806,62 +806,62 @@ public class SpringCloudAlibabaNacosConfigClient3377Application { -6\. Æô¶¯ Nacos Server£¬²¢ÔÚ Nacos Server ¿ØÖÆÌ¨µÄ¡°ÅäÖùÜÀí¡±Ïµġ°ÅäÖÃÁÐ±í¡±ÖУ¬µã»÷¡°+¡±°´Å¥£¬Ð½¨ÈçÏÂÅäÖᣠ+6\. å�¯åЍ Nacos Server,并在 Nacos Server 控制å�°çš„“é…�置管ç�†â€�下的“é…�置列表â€�中,点击“+â€�按钮,新建如下é…�置。 ```` Data ID: config-client-dev.yaml Group : DEFAULT_GROUP -ÅäÖøñʽ: YAML +é…�置格å¼�: YAML -ÅäÖÃÄÚÈÝ: config: +é…�置内容: config: info: c.biancheng.net ```` -ÔÚ Nacos Server ÖУ¬ÅäÖÃµÄ dataId£¨¼´ Data ID£©µÄÍêÕû¸ñʽÈçÏ£º +在 Nacos Server 中,é…�置的 dataId(å�³ Data ID)的完整格å¼�如下: ```` ${prefix}-${spring.profiles.active}.${file-extension} ```` -dataId ¸ñʽÖи÷²ÎÊý˵Ã÷ÈçÏ£º +dataId æ ¼å¼�中å�„å�‚数说明如下: -* ${prefix}£ºÄ¬ÈÏȡֵΪ΢·þÎñµÄ·þÎñÃû£¬¼´ÅäÖÃÎļþÖÐ spring.application.name µÄÖµ£¬ÎÒÃÇ¿ÉÒÔÔÚÅäÖÃÎļþÖÐͨ¹ýÅäÖà spring.cloud.nacos.config.prefix À´Ö¸¶¨¡£ -* ${spring.profiles.active}£º±íʾµ±Ç°»·¾³¶ÔÓ¦µÄ Profile£¬ÀýÈç dev¡¢test¡¢prod µÈ¡£µ±Ã»ÓÐÖ¸¶¨»·¾³µÄ Profile ʱ£¬Æä¶ÔÓ¦µÄÁ¬½Ó·ûÒ²½«²»´æÔÚ£¬ dataId µÄ¸ñʽ±ä³É ${prefix}.${file-extension}¡£ -* ${file-extension}£º±íʾÅäÖÃÄÚÈݵÄÊý¾Ý¸ñʽ£¬ÎÒÃÇ¿ÉÒÔÔÚÅäÖÃÎļþÖÐͨ¹ýÅäÖÃÏî spring.cloud.nacos.config.file-extension À´ÅäÖã¬ÀýÈç properties ºÍ yaml¡£ +* ${prefix}:默认å�–值为微æœ�务的æœ�务å��,å�³é…�置文件中 spring.application.name 的值,我们å�¯ä»¥åœ¨é…�置文件中通过é…�ç½® spring.cloud.nacos.config.prefix æ�¥æŒ‡å®šã€‚ +* ${spring.profiles.active}:表示当å‰�环境对应的 Profile,例如 devã€�testã€�prod 等。当没有指定环境的 Profile 时,其对应的连接符也将ä¸�存在, dataId 的格å¼�å�˜æˆ� ${prefix}.${file-extension}。 +* ${file-extension}:表示é…�置内容的数æ�®æ ¼å¼�,我们å�¯ä»¥åœ¨é…�置文件中通过é…�置项 spring.cloud.nacos.config.file-extension æ�¥é…�置,例如 properties å’Œ yaml。 -7\. Æô¶¯ spring-cloud-alibaba-config-client-3377£¬²¢Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:3377/config/info¡±£¬½á¹ûÈçÏÂͼ¡£ +7\. å�¯åЍ spring-cloud-alibaba-config-client-3377,并使用æµ�览器访问“http://localhost:3377/config/infoâ€�,结果如下图。 ![Nacos Config](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225B3C-9.png) -ͼ10£ºNacos Config +图10:Nacos Config -8\. ÔÚ Nacos Server ÖУ¬½« config-client-dev.yaml ÖеÄÅäÖÃÐ޸ijÉÈçÏÂÄÚÈÝ¡£ +8\. 在 Nacos Server 中,将 config-client-dev.yaml 中的é…�置修改æˆ�如下内容。 ```` config: info: this is c.biancheng.net ```` -9\. ÔÚ²»ÖØÆô spring-cloud-alibaba-config-client-3377 µÄÇé¿öÏ£¬Ê¹ÓÃä¯ÀÀÆ÷ÔٴηÃÎÊ¡°http://localhost:3377/config/info¡±£¬½á¹ûÈçÏÂͼ¡£ +9\. 在ä¸�é‡�å�¯ spring-cloud-alibaba-config-client-3377 的情况下,使用æµ�览器å†�次访问“http://localhost:3377/config/infoâ€�,结果如下图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022563A7-10.png) -ͼ11£ºNacos Cofig +图11:Nacos Cofig -## Nacos Server ¼¯Èº»¯²¿Êð +## Nacos Server 集群化部署 -ÔÚʵ¼ÊµÄÏîÄ¿¿ª·¢ÖУ¬Ò»¸ö΢·þÎñϵͳÍùÍùÓÉÊ®¼¸£¬¼¸Ê®¸öÉõÖÁ¼¸°Ù¸ö΢·þÎñ×é³É¡£ ÕâЩ·þÎñÈôÈ«²¿×¢²áµ½Í¬Ò»Ì¨ Nacos Server£¬¾Í¼«ÓпÉÄܵ¼Ö Nacos Server ÒòΪ²»¿°Öظº¶ø±ÀÀ££¬×îÖÕµ¼ÖÂÕû¸ö΢·þÎñϵͳ̱»¾¡£½â¾öÕâ¸öÎÊÌâ×îÖ±½ÓµÄ°ì·¨¾ÍÊÇʹÓà Nacos Server ¼¯Èº¡£ +在实际的项目开å�‘中,一个微æœ�务系统往往由å��几,几å��个甚至几百个微æœ�务组æˆ�。 这些æœ�务若全部注册到å�Œä¸€å�° Nacos Server,就æž�有å�¯èƒ½å¯¼è‡´ Nacos Server 因为ä¸�å ªé‡�负而崩溃,最终导致整个微æœ�务系统瘫痪。解决这个问题最直接的办法就是使用 Nacos Server 集群。 -Nacos Server µÄ¼¯Èº»¯²¿ÊðÓÐÒ»¸öÊ®·ÖÃ÷ÏÔµÄÓŵ㣬ÄǾÍÊÇ¿ÉÒÔ±£ÕÏϵͳµÄ¸ß¿ÉÓÃÐÔ¡£ÔÚ¼¯Èº»¯²¿ÊðÖУ¬Ö»Òª²»ÊÇËùÓÐµÄ Nacos Server ¶¼Í£Ö¹¹¤×÷£¬Nacos Client ¾Í»¹¿ÉÒÔ´Ó¼¯ÈºÖÐÕý³£µÄ Nacos Server ÉÏ»ñÈ¡·þÎñÐÅÏ¢¼°ÅäÖ㬶ø²»»áµ¼ÖÂϵͳµÄÕûÌå̱»¾£¬Õâ¾ÍÊÇ Nacos Server ¼¯Èº»¯²¿ÊðµÄ¸ß¿ÉÓÃÐÔ¡£ +Nacos Server 的集群化部署有一个å��分明显的优点,那就是å�¯ä»¥ä¿�障系统的高å�¯ç”¨æ€§ã€‚在集群化部署中,å�ªè¦�ä¸�是所有的 Nacos Server 都å�œæ­¢å·¥ä½œï¼ŒNacos Client 就还å�¯ä»¥ä»Žé›†ç¾¤ä¸­æ­£å¸¸çš„ Nacos Server 上获å�–æœ�务信æ�¯å�Šé…�置,而ä¸�会导致系统的整体瘫痪,这就是 Nacos Server 集群化部署的高å�¯ç”¨æ€§ã€‚ -ÏÂͼչʾÁË Nacos Server ¼¯Èº»¯²¿ÊðµÄ»ù±¾¼Ü¹¹¡£ +下图展示了 Nacos Server 集群化部署的基本架构。 -![Nacos Server ¼¯Èº¼Ü¹¹](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022563543-11.png) -ͼ12£ºNacos Server ¼¯Èº¼Ü¹¹ +![Nacos Server 集群架构](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1022563543-11.png) +图12:Nacos Server 集群架构 -ÏÂÃæÎÒÃÇÒÔ Windows ϵͳΪÀý£¬ÑÝʾÈçºÎ²¿Êð Nacos Server ¼¯Èº¡£ +下é�¢æˆ‘们以 Windows 系统为例,演示如何部署 Nacos Server 集群。 -1\. ÔÚ MySQL ÖУ¬Ð½¨Ò»¸öÃûΪ nacos_config µÄÊý¾Ý¿âʵÀý£¬²¢ÔÚ¸ÃÊý¾Ý¿âÏÂÖ´ÐÐÒÔÏ SQL Óï¾ä¡£ +1\. 在 MySQL 中,新建一个å��为 nacos_config 的数æ�®åº“实例,并在该数æ�®åº“下执行以下 SQL 语å�¥ã€‚ ```` /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = config_info */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = config_info */ /******************************************/ CREATE TABLE `config_info` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id', @@ -869,12 +869,12 @@ CREATE TABLE `config_info` ( `group_id` varchar(255) DEFAULT NULL, `content` longtext NOT NULL COMMENT 'content', `md5` varchar(32) DEFAULT NULL COMMENT 'md5', - `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '´´½¨Ê±¼ä', - `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'ÐÞ¸Äʱ¼ä', + `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', + `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间', `src_user` text COMMENT 'source user', `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip', `app_name` varchar(128) DEFAULT NULL, - `tenant_id` varchar(128) DEFAULT '' COMMENT '×â»§×Ö¶Î', + `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段', `c_desc` varchar(256) DEFAULT NULL, `c_use` varchar(64) DEFAULT NULL, `effect` varchar(64) DEFAULT NULL, @@ -886,25 +886,25 @@ CREATE TABLE `config_info` ( /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = config_info_aggr */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = config_info_aggr */ /******************************************/ CREATE TABLE `config_info_aggr` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id', `data_id` varchar(255) NOT NULL COMMENT 'data_id', `group_id` varchar(255) NOT NULL COMMENT 'group_id', `datum_id` varchar(255) NOT NULL COMMENT 'datum_id', - `content` longtext NOT NULL COMMENT 'ÄÚÈÝ', - `gmt_modified` datetime NOT NULL COMMENT 'ÐÞ¸Äʱ¼ä', + `content` longtext NOT NULL COMMENT '内容', + `gmt_modified` datetime NOT NULL COMMENT '修改时间', `app_name` varchar(128) DEFAULT NULL, - `tenant_id` varchar(128) DEFAULT '' COMMENT '×â»§×Ö¶Î', + `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段', PRIMARY KEY (`id`), UNIQUE KEY `uk_configinfoaggr_datagrouptenantdatum` (`data_id`,`group_id`,`tenant_id`,`datum_id`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='Ôö¼Ó×â»§×Ö¶Î'; +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='增加租户字段'; /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = config_info_beta */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = config_info_beta */ /******************************************/ CREATE TABLE `config_info_beta` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id', @@ -914,18 +914,18 @@ CREATE TABLE `config_info_beta` ( `content` longtext NOT NULL COMMENT 'content', `beta_ips` varchar(1024) DEFAULT NULL COMMENT 'betaIps', `md5` varchar(32) DEFAULT NULL COMMENT 'md5', - `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '´´½¨Ê±¼ä', - `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'ÐÞ¸Äʱ¼ä', + `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', + `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间', `src_user` text COMMENT 'source user', `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip', - `tenant_id` varchar(128) DEFAULT '' COMMENT '×â»§×Ö¶Î', + `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段', PRIMARY KEY (`id`), UNIQUE KEY `uk_configinfobeta_datagrouptenant` (`data_id`,`group_id`,`tenant_id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_beta'; /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = config_info_tag */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = config_info_tag */ /******************************************/ CREATE TABLE `config_info_tag` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id', @@ -936,8 +936,8 @@ CREATE TABLE `config_info_tag` ( `app_name` varchar(128) DEFAULT NULL COMMENT 'app_name', `content` longtext NOT NULL COMMENT 'content', `md5` varchar(32) DEFAULT NULL COMMENT 'md5', - `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '´´½¨Ê±¼ä', - `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'ÐÞ¸Äʱ¼ä', + `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', + `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间', `src_user` text COMMENT 'source user', `src_ip` varchar(50) DEFAULT NULL COMMENT 'source ip', PRIMARY KEY (`id`), @@ -945,8 +945,8 @@ CREATE TABLE `config_info_tag` ( ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_info_tag'; /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = config_tags_relation */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = config_tags_relation */ /******************************************/ CREATE TABLE `config_tags_relation` ( `id` bigint(20) NOT NULL COMMENT 'id', @@ -962,27 +962,27 @@ CREATE TABLE `config_tags_relation` ( ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='config_tag_relation'; /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = group_capacity */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = group_capacity */ /******************************************/ CREATE TABLE `group_capacity` ( - `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'Ö÷¼üID', - `group_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Group ID£¬¿Õ×Ö·û±íʾÕû¸ö¼¯Èº', - `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'Åä¶î£¬0±íʾʹÓÃĬÈÏÖµ', - `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'ʹÓÃÁ¿', - `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'µ¥¸öÅäÖôóСÉÏÏÞ£¬µ¥Î»Îª×Ö½Ú£¬0±íʾʹÓÃĬÈÏÖµ', - `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '¾ÛºÏ×ÓÅäÖÃ×î´ó¸öÊý£¬£¬0±íʾʹÓÃĬÈÏÖµ', - `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'µ¥¸ö¾ÛºÏÊý¾ÝµÄ×ÓÅäÖôóСÉÏÏÞ£¬µ¥Î»Îª×Ö½Ú£¬0±íʾʹÓÃĬÈÏÖµ', - `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '×î´ó±ä¸üÀúÊ·ÊýÁ¿', - `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '´´½¨Ê±¼ä', - `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'ÐÞ¸Äʱ¼ä', + `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID', + `group_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Group ID,空字符表示整个集群', + `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'é…�é¢�,0表示使用默认值', + `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用é‡�', + `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'å�•个é…�置大å°�上é™�,å�•ä½�为字节,0表示使用默认值', + `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'è�šå�ˆå­�é…�置最大个数,,0表示使用默认值', + `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'å�•个è�šå�ˆæ•°æ�®çš„å­�é…�置大å°�上é™�,å�•ä½�为字节,0表示使用默认值', + `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大å�˜æ›´åކå�²æ•°é‡�', + `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', + `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间', PRIMARY KEY (`id`), UNIQUE KEY `uk_group_id` (`group_id`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='¼¯Èº¡¢¸÷GroupÈÝÁ¿ÐÅÏ¢±í'; +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='集群ã€�å�„Group容é‡�ä¿¡æ�¯è¡¨'; /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = his_config_info */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = his_config_info */ /******************************************/ CREATE TABLE `his_config_info` ( `id` bigint(64) unsigned NOT NULL, @@ -997,31 +997,31 @@ CREATE TABLE `his_config_info` ( `src_user` text, `src_ip` varchar(50) DEFAULT NULL, `op_type` char(10) DEFAULT NULL, - `tenant_id` varchar(128) DEFAULT '' COMMENT '×â»§×Ö¶Î', + `tenant_id` varchar(128) DEFAULT '' COMMENT '租户字段', PRIMARY KEY (`nid`), KEY `idx_gmt_create` (`gmt_create`), KEY `idx_gmt_modified` (`gmt_modified`), KEY `idx_did` (`data_id`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='¶à×â»§¸ÄÔì'; +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='多租户改造'; /******************************************/ -/* Êý¾Ý¿âÈ«Ãû = nacos_config */ -/* ±íÃû³Æ = tenant_capacity */ +/* æ•°æ�®åº“å…¨å�� = nacos_config */ +/* 表å��ç§° = tenant_capacity */ /******************************************/ CREATE TABLE `tenant_capacity` ( - `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'Ö÷¼üID', + `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键ID', `tenant_id` varchar(128) NOT NULL DEFAULT '' COMMENT 'Tenant ID', - `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'Åä¶î£¬0±íʾʹÓÃĬÈÏÖµ', - `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'ʹÓÃÁ¿', - `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'µ¥¸öÅäÖôóСÉÏÏÞ£¬µ¥Î»Îª×Ö½Ú£¬0±íʾʹÓÃĬÈÏÖµ', - `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '¾ÛºÏ×ÓÅäÖÃ×î´ó¸öÊý', - `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'µ¥¸ö¾ÛºÏÊý¾ÝµÄ×ÓÅäÖôóСÉÏÏÞ£¬µ¥Î»Îª×Ö½Ú£¬0±íʾʹÓÃĬÈÏÖµ', - `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '×î´ó±ä¸üÀúÊ·ÊýÁ¿', - `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '´´½¨Ê±¼ä', - `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'ÐÞ¸Äʱ¼ä', + `quota` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'é…�é¢�,0表示使用默认值', + `usage` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '使用é‡�', + `max_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'å�•个é…�置大å°�上é™�,å�•ä½�为字节,0表示使用默认值', + `max_aggr_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'è�šå�ˆå­�é…�置最大个数', + `max_aggr_size` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'å�•个è�šå�ˆæ•°æ�®çš„å­�é…�置大å°�上é™�,å�•ä½�为字节,0表示使用默认值', + `max_history_count` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '最大å�˜æ›´åކå�²æ•°é‡�', + `gmt_create` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', + `gmt_modified` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '修改时间', PRIMARY KEY (`id`), UNIQUE KEY `uk_tenant_id` (`tenant_id`) -) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='×â»§ÈÝÁ¿ÐÅÏ¢±í'; +) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='租户容é‡�ä¿¡æ�¯è¡¨'; CREATE TABLE `tenant_info` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id', @@ -1030,8 +1030,8 @@ CREATE TABLE `tenant_info` ( `tenant_name` varchar(128) default '' COMMENT 'tenant_name', `tenant_desc` varchar(256) DEFAULT NULL COMMENT 'tenant_desc', `create_source` varchar(32) DEFAULT NULL COMMENT 'create_source', - `gmt_create` bigint(20) NOT NULL COMMENT '´´½¨Ê±¼ä', - `gmt_modified` bigint(20) NOT NULL COMMENT 'ÐÞ¸Äʱ¼ä', + `gmt_create` bigint(20) NOT NULL COMMENT '创建时间', + `gmt_modified` bigint(20) NOT NULL COMMENT '修改时间', PRIMARY KEY (`id`), UNIQUE KEY `uk_tenant_info_kptenantid` (`kp`,`tenant_id`), KEY `idx_tenant_id` (`tenant_id`) @@ -1060,22 +1060,22 @@ INSERT INTO users (username, password, enabled) VALUES ('nacos', '$2a$10$EuWPZHz INSERT INTO roles (username, role) VALUES ('nacos', 'ROLE_ADMIN'); ```` -2\. ÔÚ Nacos Server °²×°Ä¿Â¼Ï嵀 conf Îļþ¼ÐÖУ¬½« cluster.conf.example ÖØÃüÃûΪ cluster.conf£¬È»ºóÔÚ¸ÃÎļþÖÐÌí¼ÓÒÔÏÂÄÚÈÝ¡£ +2\. 在 Nacos Server 安装目录下的 conf 文件夹中,将 cluster.conf.example é‡�命å��为 cluster.conf,然å�Žåœ¨è¯¥æ–‡ä»¶ä¸­æ·»åŠ ä»¥ä¸‹å†…å®¹ã€‚ 192.168.3.138:3333 192.168.3.138:4444 192.168.3.138:5555 -ÅäÖÃ˵Ã÷ÈçÏ£º +é…�置说明如下: -* 192.168.138 Ϊ±¾µØµçÄÔÖ÷»úµÄ IP µØÖ·£¬ÕâÀï×îºÃ²»ÒªÐ´³É localhost »ò 127.0.0.1£¬·ñÔò Nacos Server ¼¯Èº¿ÉÄÜ»á´î½¨Ê§°Ü£¡ -* ±¾´Î´î½¨µÄ Nacos Server ¼¯ÈºµÄ¶Ë¿Ú·Ö±ðΪ£º3333¡¢4444¡¢5555¡£ +* 192.168.138 为本地电脑主机的 IP 地å�€ï¼Œè¿™é‡Œæœ€å¥½ä¸�è¦�写æˆ� localhost 或 127.0.0.1,å�¦åˆ™ Nacos Server 集群å�¯èƒ½ä¼šæ�­å»ºå¤±è´¥ï¼� +* 本次æ�­å»ºçš„ Nacos Server 集群的端å�£åˆ†åˆ«ä¸ºï¼š3333ã€�4444ã€�5555。 -3\. ÔÚ config Ŀ¼Ï嵀 application.properties ÖУ¬½« server.port£¨¶Ë¿ÚºÅ£©ÐÞ¸ÄΪ 3333£¬²¢ÔÚ¸ÃÎļþÖÐÌí¼Ó MySQL Êý¾Ý¿âÅäÖ㬾ßÌåÐÞ¸ÄÄÚÈÝÈçÏ¡£ +3\. 在 config 目录下的 application.properties 中,将 server.port(端å�£å�·ï¼‰ä¿®æ”¹ä¸º 3333,并在该文件中添加 MySQL æ•°æ�®åº“é…�置,具体修改内容如下。 ```` server.port=3333 -################ MySQL Êý¾Ý¿âÅäÖÃ################## +################ MySQL æ•°æ�®åº“é…�ç½®################## spring.datasource.platform=mysql @@ -1084,9 +1084,9 @@ db.url.0=jdbc:mysql://127.0.0.1:3306/nacos_config?characterEncoding=utf8&connect db.user=root db.password=root ```` -4\. ½«¸Ã Nacos Server Ŀ¼¸´ÖƵ½ÁíÍâÁ½Ì¨»úÆ÷ÉÏ£¬²¢½«ËüÃǵĶ˿ںŷֱðÐÞ¸ÄΪ£º 4444 ºÍ 5555¡£ +4\. 将该 Nacos Server 目录å¤�制到å�¦å¤–两å�°æœºå™¨ä¸Šï¼Œå¹¶å°†å®ƒä»¬çš„端å�£å�·åˆ†åˆ«ä¿®æ”¹ä¸ºï¼š 4444 å’Œ 5555。 -5\. ÏÂÔØ Nginx£¬²¢ÐÞ¸Ä Nginx ÖÐ conf Ŀ¼Ï嵀 nginx.conf µÄÅäÖã¬ÄÚÈÝÈçÏ¡£ +5\. 下载 Nginx,并修改 Nginx 中 conf 目录下的 nginx.conf çš„é…�置,内容如下。 ```` #user nobody; worker_processes 1; @@ -1129,7 +1129,7 @@ http { } ```` -6\. Æô¶¯¼¯ÈºÖÐËùÓÐµÄ Nacos Server£¬µ±³öÏÖÒÔÏÂÄÚÈÝʱ£¬±íʾ Nacos Server Æô¶¯³É¹¦¡£ +6\. å�¯åŠ¨é›†ç¾¤ä¸­æ‰€æœ‰çš„ Nacos Server,当出现以下内容时,表示 Nacos Server å�¯åЍæˆ�功。 ```` "nacos is starting with cluster" @@ -1162,49 +1162,49 @@ http { 2021-11-09 16:27:10,742 INFO Nacos started successfully in cluster mode. use external storage ```` -7\. µ±¼¯ÈºÖеÄËùÓÐ Nacos Server ¶¼Æô¶¯³É¹¦ºó£¬Ë«»÷ Nignx °²×°Ä¿Â¼Ï嵀 nginx.exe£¬Æô¶¯ Nginx¡£ +7\. 当集群中的所有 Nacos Server 都å�¯åЍæˆ�功å�Žï¼Œå�Œå‡» Nignx 安装目录下的 nginx.exe,å�¯åЍ Nginx。 ![Nginx ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225BO0-12.png) -ͼ13£ºNginx Æô¶¯½Å±¾ +图13:Nginx å�¯åŠ¨è„šæœ¬ -8\. ʹÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:1111/nacos/¡±£¬Èô³É¹¦·ÃÎÊ Nacos Server µÄ¿ØÖÆÌ¨£¬Ôò˵Ã÷ Nacos ¼¯Èº²¿Êð³É¹¦£¬ÈçÏÂͼ¡£ +8\. 使用æµ�览器访问“http://localhost:1111/nacos/â€�,若æˆ�功访问 Nacos Server 的控制å�°ï¼Œåˆ™è¯´æ˜Ž Nacos 集群部署æˆ�功,如下图。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225C554-13.png) -ͼ14£ºNacos ¼¯Èº +图14:Nacos 集群 -9\. ½«Ö÷¹¤³Ì spring-cloud-alibaba-demo ÏÂËùÓÐ×ÓÄ£¿éÅäÖÃÎļþÖÐµÄ Nacos Server µØÖ·Í³Ò»ÐÞ¸ÄΪ£ºlocalhost:1111¡£ÎÒÃÇÒÔ spring-cloud-alibaba-consumer-nacos-8801 ΪÀý£¬ÅäÖÃÎļþ application.yml µÄÅäÖÃÄÚÈÝÈçÏ¡£ +9\. 将主工程 spring-cloud-alibaba-demo 下所有å­�模å�—é…�置文件中的 Nacos Server 地å�€ç»Ÿä¸€ä¿®æ”¹ä¸ºï¼šlocalhost:1111。我们以 spring-cloud-alibaba-consumer-nacos-8801 为例,é…�置文件 application.yml çš„é…�置内容如下。 ```` server: - port: 8801 #¶Ë¿ÚºÅ + port: 8801 #端å�£å�· spring: application: - name: spring-cloud-alibaba-consumer #·þÎñÃû + name: spring-cloud-alibaba-consumer #æœ�务å�� cloud: nacos: discovery: - #server-addr: localhost:8848 #µ¥»ú°æ Nacos Server µÄµØÖ· - server-addr: localhost:1111 #¼¯Èº°æ Nacos Server µÄµØÖ· + #server-addr: localhost:8848 #å�•机版 Nacos Server 的地å�€ + server-addr: localhost:1111 #集群版 Nacos Server 的地å�€ ```` -#ÒÔÏÂÅäÖÃÐÅÏ¢²¢²»ÊÇĬÈÏÅäÖ㬶øÊÇÎÒÃÇ×Ô¶¨ÒåµÄÅäÖã¬Ä¿µÄÊDz»ÔÚ Controller ÄÚÓ²±àÂë·þÎñÌṩÕߵķþÎñÃû +#以下é…�置信æ�¯å¹¶ä¸�是默认é…�置,而是我们自定义的é…�置,目的是ä¸�在 Controller 内硬编ç �æœ�务æ��供者的æœ�务å�� ```` service-url: - nacos-user-service: http://spring-cloud-alibaba-provider #·þÎñÌṩÕߵķþÎñÃû + nacos-user-service: http://spring-cloud-alibaba-provider #æœ�务æ��供者的æœ�务å�� ```` -10\. ÖØÆô spring-cloud-alibaba-consumer-nacos-8801£¬²¢Ê¹ÓÃä¯ÀÀÆ÷·ÃÎÊ¡°http://localhost:1111/nacos¡±£¬²é¿´¡°·þÎñ¹ÜÀí¡±Ïµġ°·þÎñÁÐ±í¡±£¬½á¹ûÈçÏÂͼ¡£ +10\. é‡�å�¯ spring-cloud-alibaba-consumer-nacos-8801,并使用æµ�览器访问“http://localhost:1111/nacosâ€�,查看“æœ�务管ç�†â€�下的“æœ�务列表â€�,结果如下图。 -[![Nacos ¼¯Èº 2](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225A913-14.png)](http://new-local.weixueyuan.net/uploads/allimg/211109/6-2111091H412N8.png) -ͼ15£º·þÎñ×¢²áµ½ Nacos Server ¼¯ÈºÉÏ +[![Nacos 集群 2](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/10225A913-14.png)](http://new-local.weixueyuan.net/uploads/allimg/211109/6-2111091H412N8.png) +图15:æœ�务注册到 Nacos Server 集群上 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaRocketMQ.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaRocketMQ.md" index 6cb2d45..8db90c6 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaRocketMQ.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaRocketMQ.md" @@ -1,75 +1,75 @@ -1. RocketMQ ¼ò½é +1. RocketMQ 简介 -RocketMQ Êǰ¢Àï°Í°Í¿ªÔ´µÄ·Ö²¼Ê½ÏûÏ¢Öмä¼þ¡£Ö§³ÖÊÂÎñÏûÏ¢¡¢Ë³ÐòÏûÏ¢¡¢ÅúÁ¿ÏûÏ¢¡¢¶¨Ê±ÏûÏ¢¡¢ÏûÏ¢»ØËݵȡ£ËüÀïÃæÓм¸¸öÇø±ðÓÚ±ê×¼ÏûÏ¢Öмþ¼äµÄ¸ÅÄÈçGroup¡¢Topic¡¢QueueµÈ¡£ÏµÍ³×é³ÉÔòÓÉProducer¡¢Consumer¡¢Broker¡¢NameServerµÈ¡£ +RocketMQ 是阿里巴巴开æº�的分布å¼�消æ�¯ä¸­é—´ä»¶ã€‚支æŒ�事务消æ�¯ã€�顺åº�消æ�¯ã€�批é‡�消æ�¯ã€�定时消æ�¯ã€�消æ�¯å›žæº¯ç­‰ã€‚它里é�¢æœ‰å‡ ä¸ªåŒºåˆ«äºŽæ ‡å‡†æ¶ˆæ�¯ä¸­ä»¶é—´çš„æ¦‚念,如Groupã€�Topicã€�Queue等。系统组æˆ�则由Producerã€�Consumerã€�Brokerã€�NameServer等。 -RocketMQ ÌØµã +RocketMQ 特点 -- Ö§³Ö·¢²¼/¶©ÔÄ£¨Pub/Sub£©ºÍµã¶Ôµã£¨P2P£©ÏûϢģÐÍ£» -- ÔÚÒ»¸ö¶ÓÁÐÖпɿ¿µÄÏȽøÏȳö£¨FIFO£©ºÍÑϸñµÄ˳Ðò´«µÝ£¬RocketMQ ¿ÉÒÔ±£Ö¤ÑϸñµÄÏûϢ˳Ðò£¬¶øActiveMQ ÎÞ·¨±£Ö¤£» -- Ö§³ÖÀ­£¨Pull£©ºÍÍÆ£¨Push£©Á½ÖÖÏûϢģʽ£»Push ºÃÀí½â£¬±ÈÈçÔÚÏû·ÑÕß¶ËÉèÖà Listener »Øµ÷£»¶ø Pull£¬¿ØÖÆÈ¨ÔÚÓÚÓ¦Ó㬼´Ó¦ÓÃÐèÒªÖ÷¶¯µÄµ÷ÓÃÀ­ÏûÏ¢·½·¨´Ó Broker »ñÈ¡ÏûÏ¢£¬ÕâÀïÃæ´æÔÚÒ»¸öÏû·ÑλÖüǼµÄÎÊÌ⣨Èç¹û²»¼Ç¼£¬»áµ¼ÖÂÏûÏ¢ÖØ¸´Ïû·Ñ£©£» -- µ¥Ò»¶ÓÁаÙÍòÏûÏ¢µÄ¶Ñ»ýÄÜÁ¦£»RocketMQ ÌṩÒÚ¼¶ÏûÏ¢µÄ¶Ñ»ýÄÜÁ¦£¬Õâ²»ÊÇÖØµã£¬ÖصãÊǶѻýÁËÒÚ¼¶µÄÏûÏ¢ºó£¬ÒÀÈ»±£³ÖдÈëµÍÑÓ³Ù£» -- Ö§³Ö¶àÖÖÏûϢЭÒ飬Èç JMS¡¢MQTT µÈ£» -- ·Ö²¼Ê½¸ß¿ÉÓõIJ¿Êð¼Ü¹¹£¬Âú×ãÖÁÉÙÒ»´ÎÏûÏ¢´«µÝÓïÒ壻RocketMQ Ô­Éú¾ÍÊÇÖ§³Ö·Ö²¼Ê½µÄ£¬¶øActiveMQ Ô­Éú´æÔÚµ¥µãÐÔ£» -- Ìṩ docker ¾µÏñÓÃÓÚ¸ôÀë²âÊÔºÍÔÆ¼¯Èº²¿Ê𣻠-- ÌṩÅäÖá¢Ö¸±êºÍ¼à¿ØµÈ¹¦ÄܷḻµÄ Dashboard¡£ +- 支æŒ�å�‘布/订阅(Pub/Sub)和点对点(P2P)消æ�¯æ¨¡åž‹ï¼› +- 在一个队列中å�¯é� çš„先进先出(FIFO)和严格的顺åº�传递,RocketMQ å�¯ä»¥ä¿�è¯�严格的消æ�¯é¡ºåº�,而ActiveMQ 无法ä¿�è¯�ï¼› +- 支æŒ�拉(Pull)和推(Push)两ç§�消æ�¯æ¨¡å¼�ï¼›Push 好ç�†è§£ï¼Œæ¯”如在消费者端设置 Listener 回调;而 Pull,控制æ�ƒåœ¨äºŽåº”用,å�³åº”用需è¦�主动的调用拉消æ�¯æ–¹æ³•从 Broker 获å�–消æ�¯ï¼Œè¿™é‡Œé�¢å­˜åœ¨ä¸€ä¸ªæ¶ˆè´¹ä½�置记录的问题(如果ä¸�记录,会导致消æ�¯é‡�å¤�消费); +- å�•一队列百万消æ�¯çš„堆积能力;RocketMQ æ��供亿级消æ�¯çš„堆积能力,这ä¸�是é‡�点,é‡�点是堆积了亿级的消æ�¯å�Žï¼Œä¾�ç„¶ä¿�æŒ�写入低延迟; +- 支æŒ�多ç§�消æ�¯å��议,如 JMSã€�MQTT 等; +- 分布å¼�高å�¯ç”¨çš„部署架构,满足至少一次消æ�¯ä¼ é€’语义;RocketMQ 原生就是支æŒ�分布å¼�的,而ActiveMQ 原生存在å�•点性; +- æ��ä¾› docker 镜åƒ�用于隔离测试和云集群部署; +- æ��ä¾›é…�ç½®ã€�指标和监控等功能丰富的 Dashboard。 Broker -Broker Æäʵ¾ÍÊÇ RocketMQ ·þÎñÆ÷£¬¸ºÔð´æ´¢ÏûÏ¢¡¢×ª·¢ÏûÏ¢¡£Broker ÔÚ RocketMQ ϵͳÖиºÔð½ÓÊÕ´ÓÉú²úÕß·¢ËÍÀ´µÄÏûÏ¢²¢´æ´¢¡¢Í¬Ê±ÎªÏû·ÑÕßµÄÀ­È¡ÇëÇó×÷×¼±¸¡£Broker Ò²´æ´¢ÏûÏ¢Ïà¹ØµÄÔªÊý¾Ý£¬°üÀ¨Ïû·ÑÕß×é¡¢Ïû·Ñ½ø¶ÈÆ«ÒÆºÍÖ÷ÌâºÍ¶ÓÁÐÏûÏ¢µÈ¡£ +Broker 其实就是 RocketMQ æœ�务器,负责存储消æ�¯ã€�转å�‘消æ�¯ã€‚Broker 在 RocketMQ 系统中负责接收从生产者å�‘é€�æ�¥çš„æ¶ˆæ�¯å¹¶å­˜å‚¨ã€�å�Œæ—¶ä¸ºæ¶ˆè´¹è€…的拉å�–请求作准备。Broker 也存储消æ�¯ç›¸å…³çš„元数æ�®ï¼ŒåŒ…括消费者组ã€�消费进度å��移和主题和队列消æ�¯ç­‰ã€‚ -Broker Server ÊÇ RocketMQ ÕæÕýµÄÒµÎñºËÐÄ£¬°üº¬Á˶à¸öÖØÒªµÄ×ÓÄ£¿é£º +Broker Server 是 RocketMQ 真正的业务核心,包å�«äº†å¤šä¸ªé‡�è¦�çš„å­�模å�—: -- ·ÓÉÄ£¿é£ºÕû¸ö Broker µÄʵÌ壬¸ºÔð´¦ÀíÀ´×Ô clients ¶ËµÄÇëÇó¡£ -- ¿Í»§¶Ë¹ÜÀí£º¸ºÔð¹ÜÀí¿Í»§¶Ë(Producer/Consumer)ºÍά»¤ Consumer µÄ Topic ¶©ÔÄÐÅÏ¢ -- ´æ´¢·þÎñ£ºÌṩ·½±ã¼òµ¥µÄ API ½Ó¿Ú´¦ÀíÏûÏ¢´æ´¢µ½ÎïÀíÓ²Å̺Ͳéѯ¹¦ÄÜ¡£ -- ¸ß¿ÉÓ÷þÎñ£º¸ß¿ÉÓ÷þÎñ£¬Ìṩ Master Broker ºÍ Slave Broker Ö®¼äµÄÊý¾Ýͬ²½¹¦ÄÜ¡£ -- ÏûÏ¢Ë÷Òý·þÎñ£º¸ù¾ÝÌØ¶¨µÄ Message key ¶ÔͶµÝµ½ Broker µÄÏûÏ¢½øÐÐË÷Òý·þÎñ£¬ÒÔÌṩÏûÏ¢µÄ¿ìËÙ²éѯ¡£ +- 路由模å�—:整个 Broker 的实体,负责处ç�†æ�¥è‡ª clients 端的请求。 +- 客户端管ç�†ï¼šè´Ÿè´£ç®¡ç�†å®¢æˆ·ç«¯(Producer/Consumer)和维护 Consumer çš„ Topic 订阅信æ�¯ +- 存储æœ�务:æ��供方便简å�•çš„ API 接å�£å¤„ç�†æ¶ˆæ�¯å­˜å‚¨åˆ°ç‰©ç�†ç¡¬ç›˜å’ŒæŸ¥è¯¢åŠŸèƒ½ã€‚ +- 高å�¯ç”¨æœ�务:高å�¯ç”¨æœ�务,æ��ä¾› Master Broker å’Œ Slave Broker 之间的数æ�®å�Œæ­¥åŠŸèƒ½ã€‚ +- 消æ�¯ç´¢å¼•æœ�务:根æ�®ç‰¹å®šçš„ Message key 对投递到 Broker 的消æ�¯è¿›è¡Œç´¢å¼•æœ�务,以æ��供消æ�¯çš„快速查询。 NameServer -NameServer ÊÇÒ»¸ö·Ç³£¼òµ¥µÄ Topic ·ÓÉ×¢²áÖÐÐÄ£¬Æä½ÇÉ«ÀàËÆ Dubbo ÖÐµÄ zookeeper£¬Ö§³Ö Broker µÄ¶¯Ì¬×¢²áÓë·¢ÏÖ¡£ +NameServer 是一个é�žå¸¸ç®€å�•çš„ Topic 路由注册中心,其角色类似 Dubbo 中的 zookeeper,支æŒ� Broker 的动æ€�注册与å�‘现。 -Ö÷Òª°üÀ¨Á½¸ö¹¦ÄÜ£º +主è¦�包括两个功能: -- Broker ¹ÜÀí£ºNameServer ½ÓÊÜ Broker ¼¯ÈºµÄ×¢²áÐÅÏ¢²¢ÇÒ±£´æÏÂÀ´×÷Ϊ·ÓÉÐÅÏ¢µÄ»ù±¾Êý¾Ý¡£È»ºóÌṩÐÄÌø¼ì²â»úÖÆ£¬¼ì²é Broker ÊÇ·ñ»¹´æ»î£» -- ·ÓÉÐÅÏ¢¹ÜÀí£º¸ø Producer ºÍ Consumer Ìṩ·þÎñ»ñÈ¡ Broker ÁÐ±í¡£Ã¿¸ö NameServer ½«±£´æ¹ØÓÚ Broker ¼¯ÈºµÄÕû¸ö·ÓÉÐÅÏ¢ºÍÓÃÓÚ¿Í»§¶Ë²éѯµÄ¶ÓÁÐÐÅÏ¢¡£È»ºó Producer ºÍ Conumser ͨ¹ý NameServer ¾Í¿ÉÒÔÖªµÀÕû¸ö Broker ¼¯ÈºµÄ·ÓÉÐÅÏ¢£¬´Ó¶ø½øÐÐÏûÏ¢µÄͶµÝºÍÏû·Ñ¡£ +- Broker 管ç�†ï¼šNameServer 接å�— Broker 集群的注册信æ�¯å¹¶ä¸”ä¿�存下æ�¥ä½œä¸ºè·¯ç”±ä¿¡æ�¯çš„基本数æ�®ã€‚ç„¶å�Žæ��供心跳检测机制,检查 Broker 是å�¦è¿˜å­˜æ´»ï¼› +- 路由信æ�¯ç®¡ç�†ï¼šç»™ Producer å’Œ Consumer æ��ä¾›æœ�务获å�– Broker 列表。æ¯�个 NameServer å°†ä¿�存关于 Broker 集群的整个路由信æ�¯å’Œç”¨äºŽå®¢æˆ·ç«¯æŸ¥è¯¢çš„队列信æ�¯ã€‚ç„¶å�Ž Producer å’Œ Conumser 通过 NameServer å°±å�¯ä»¥çŸ¥é�“整个 Broker 集群的路由信æ�¯ï¼Œä»Žè€Œè¿›è¡Œæ¶ˆæ�¯çš„æŠ•递和消费。 -2. ʹÓà Docker ¿ìËٴ RocketMQ 4.4 +2. 使用 Docker 快速æ�­å»º RocketMQ 4.4 -rocketmq ÐèÒª²¿Êð broker Óë nameserver £¬¿¼Âǵ½·Ö¿ª²¿Êð±È½ÏÂé·³£¬ÕâÀォ»áʹÓà docker-compose¡£ÁíÍ⣬»¹ÐèÒª´î½¨Ò»¸ö web ¿ÉÊÓ»¯¿ØÖÆÌ¨£¬¿ÉÒÔ¼à¿Ø mq ·þÎñ״̬£¬ÒÔ¼°ÏûÏ¢Ïû·ÑÇé¿ö£¬ÕâÀïʹÓà rocketmq-console£¬Í¬Ñù¸Ã³ÌÐòÒ²½«Ê¹Óà docker °²×°¡£ +rocketmq 需è¦�部署 broker 与 nameserver ,考虑到分开部署比较麻烦,这里将会使用 docker-compose。å�¦å¤–,还需è¦�æ�­å»ºä¸€ä¸ª web å�¯è§†åŒ–控制å�°ï¼Œå�¯ä»¥ç›‘控 mq æœ�务状æ€�,以å�Šæ¶ˆæ�¯æ¶ˆè´¹æƒ…况,这里使用 rocketmq-console,å�Œæ ·è¯¥ç¨‹åº�也将使用 docker 安装。 -1. ÔÚ linux ·þÎñÆ÷ÉÏÑ¡Ôñ²¢½¨Á¢Ä¿Â¼£» +1. 在 linux æœ�务器上选择并建立目录; mkdir rocketmq-docker - ¸´ÖÆ´úÂë + å¤�制代ç � -1. ½øÈë rocketmq-docker Ŀ¼£¬½¨Á¢Ò»¸öÃûΪ broker.conf µÄÅäÖÃÎļþ£¬ÄÚÈÝÈçÏ£º +1. 进入 rocketmq-docker 目录,建立一个å��为 broker.conf çš„é…�置文件,内容如下: - # ËùÊô¼¯ÈºÃû³Æ£¬Èç¹û½Úµã½Ï¶à¿ÉÒÔÅäÖöà¸ö + # 所属集群å��称,如果节点较多å�¯ä»¥é…�置多个 brokerClusterName = DefaultCluster - # brokerÃû³Æ£¬masterºÍslaveʹÓÃÏàͬµÄÃû³Æ£¬±íÃ÷ËûÃǵÄÖ÷´Ó¹ØÏµ + # brokerå��称,masterå’Œslave使用相å�Œçš„å��称,表明他们的主从关系 brokerName = broker-a - # 0±íʾMaster£¬´óÓÚ0±íʾ²»Í¬µÄslave + # 0表示Master,大于0表示ä¸�å�Œçš„slave brokerId = 0 - # ±íʾ¼¸µã×öÏûϢɾ³ý¶¯×÷£¬Ä¬ÈÏÊÇÁ賿4µã + # 表示几点å�šæ¶ˆæ�¯åˆ é™¤åŠ¨ä½œï¼Œé»˜è®¤æ˜¯å‡Œæ™¨4点 deleteWhen = 04 - # ÔÚ´ÅÅÌÉϱ£ÁôÏûÏ¢µÄʱ³¤£¬µ¥Î»ÊÇСʱ + # 在ç£�盘上ä¿�留消æ�¯çš„æ—¶é•¿ï¼Œå�•ä½�是å°�æ—¶ fileReservedTime = 48 - # ÓÐÈý¸öÖµ£ºSYNC_MASTER£¬ASYNC_MASTER£¬SLAVE£»Í¬²½ºÍÒì²½±íʾMasterºÍSlaveÖ®¼äͬ²½Êý¾ÝµÄ»úÖÆ£» + # 有三个值:SYNC_MASTER,ASYNC_MASTER,SLAVEï¼›å�Œæ­¥å’Œå¼‚步表示Masterå’ŒSlave之间å�Œæ­¥æ•°æ�®çš„æœºåˆ¶ï¼› brokerRole = ASYNC_MASTER - # Ë¢Å̲ßÂÔ£¬È¡ÖµÎª£ºASYNC_FLUSH£¬SYNC_FLUSH±íʾͬ²½Ë¢Å̺ÍÒ첽ˢÅÌ£»SYNC_FLUSHÏûϢдÈë´ÅÅ̺ó²Å·µ»Ø³É¹¦×´Ì¬£¬ASYNC_FLUSH²»ÐèÒª£» + # 刷盘策略,å�–值为:ASYNC_FLUSH,SYNC_FLUSH表示å�Œæ­¥åˆ·ç›˜å’Œå¼‚步刷盘;SYNC_FLUSH消æ�¯å†™å…¥ç£�盘å�Žæ‰�返回æˆ�功状æ€�,ASYNC_FLUSHä¸�需è¦�ï¼› flushDiskType = ASYNC_FLUSH - # ÉèÖÃbroker½ÚµãËùÔÚ·þÎñÆ÷µÄipµØÖ· + # 设置broker节点所在æœ�务器的ip地å�€ # brokerIP1 = 192.168.138.131 - ¸´ÖÆ´úÂë + å¤�制代ç � -×¢Ò⣺ÕâÀïµÄ brokerIP1 ÇëÎñ±ØÉèÖ㬷ñÔòĬÈÏ»á³ÉΪ docker ÈÝÆ÷ÄÚ²¿IPµ¼ÖÂÍâÍøÁ´½Ó²»ÉÏ¡£ +注æ„�:这里的 brokerIP1 请务必设置,å�¦åˆ™é»˜è®¤ä¼šæˆ�为 docker 容器内部IP导致外网链接ä¸�上。 -1. »¹ÊÇÔÚ rocketmq-docker Ŀ¼£¬½¨Á¢Ò»¸öÃûΪ rocketmq.yaml µÄ½Å±¾Îļþ£» +1. 还是在 rocketmq-docker 目录,建立一个å��为 rocketmq.yaml 的脚本文件; -rocketmq.yaml ÄÚÈÝÈçÏÂ: +rocketmq.yaml 内容如下: version: '2' services: @@ -108,58 +108,58 @@ rocketmq.yaml environment: - JAVA_OPTS= -Dlogging.level.root=info -Drocketmq.namesrv.addr=rmqnamesrv:9876 - Dcom.rocketmq.sendMessageWithVIPChannel=false - ¸´ÖÆ´úÂë + å¤�制代ç � -1. ¿ªÆô broker Óõ½µÄ·À»ðǽ¶Ë¿Ú£¬·½±ãºóÐøÊ¹Ó㺠+1. å¼€å�¯ broker 用到的防ç�«å¢™ç«¯å�£ï¼Œæ–¹ä¾¿å�Žç»­ä½¿ç”¨ï¼š firewall-cmd --zone=public --add-port=10909-10912/tcp --permanent - ¸´ÖÆ´úÂë + å¤�制代ç � -1. Ö´ÐÐ sentinel-dashboard.yaml ½Å±¾Æô¶¯ÈÝÆ÷£º +1. 执行 sentinel-dashboard.yaml 脚本å�¯åŠ¨å®¹å™¨ï¼š docker-compose -f rocketmq.yaml up - ¸´ÖÆ´úÂë + å¤�制代ç � -1. ½øÈë rocketmq ¿ØÖÆÌ¨£¬ÎÒÃǻᷢÏÖÀàËÆµÄͼ±í£¨µ±È»¿ªÊ¼¿Ï¶¨Êǿյģ©£º +1. 进入 rocketmq 控制å�°ï¼Œæˆ‘们会å�‘现类似的图表(当然开始肯定是空的): - http://(°²×°RocketMQ»úÆ÷µÄIP):8087 - ¸´ÖÆ´úÂë + http://(安装RocketMQ机器的IP):8087 + å¤�制代ç � -1. ÎÒÃÇÑ¡Ôñ ¡°¼¯Èº¡± ÕâÒ»À¸£¬½øÈë¾ÍÄÜ¿´¼ûÎÒÃÇÉèÖÃµÄ broker µÄÍâÍøIPÁË£» +1. 我们选择 “集群â€� 这一æ �,进入就能看è§�我们设置的 broker 的外网IP了; -µ½ÕâÀïÎÒÃÇÀíÂÛÉÏÒѾ­Íê³É RocketMQ ·þÎñ¶ËµÄ²¿Êð£¬ÏÖÔھͿÉÒÔÈ¥ Spring ÏîÄ¿ÖÐʹÓÿͻ§¶ËÁË¡£ +到这里我们ç�†è®ºä¸Šå·²ç»�完æˆ� RocketMQ æœ�务端的部署,现在就å�¯ä»¥åŽ» Spring 项目中使用客户端了。 -3. ÔÚ Spring ÏîÄ¿ÖÐÒýÈë RocketMQ ¿Í»§¶Ë +3. 在 Spring 项目中引入 RocketMQ 客户端 -1. Ìí¼Ó pom ÎļþÒÀÀµ£º +1. 添加 pom 文件ä¾�赖: org.apache.rocketmq rocketmq-spring-boot-starter 2.0.4 - ¸´ÖÆ´úÂë + å¤�制代ç � -1. ÔÚ application.yml Ìí¼ÓÅäÖ㺠+1. 在 application.yml 添加é…�置: server: port: 10801 spring: application: - name: (ÏîÄ¿Ãû³Æ)-service + name: (项目å��ç§°)-service rocketmq: - name-server: (°²×°RocketMQ»úÆ÷µÄIP):9876 + name-server: (安装RocketMQ机器的IP):9876 producer: - group: (ÏîÄ¿Ãû³Æ)-group - ¸´ÖÆ´úÂë + group: (项目å��ç§°)-group + å¤�制代ç � -1. н¨Ò»¸öÏûÏ¢·¢ËÍÀà MessageProducer ×÷ΪÏûÏ¢µÄ Éú²úÕߣº +1. 新建一个消æ�¯å�‘é€�ç±» MessageProducer 作为消æ�¯çš„ 生产者: @Service public class MessageProducer implements CommandLineRunner { @@ -173,9 +173,9 @@ rocketmq.yaml } } - ¸´ÖÆ´úÂë + å¤�制代ç � -1. н¨Ò»¸öÏûÏ¢½ÓÊÕÀà MessageListener ×÷ΪÏûÏ¢µÄ Ïû·ÑÕߣº +1. 新建一个消æ�¯æŽ¥æ”¶ç±» MessageListener 作为消æ�¯çš„ æ¶ˆè´¹è€…: @Slf4j @Service @@ -188,9 +188,9 @@ rocketmq.yaml } } - ¸´ÖÆ´úÂë + å¤�制代ç � -1. н¨Ò»¸ö MessageProducer µÄµ÷ÓÿØÖÆÆ÷Àࣺ +1. 新建一个 MessageProducer 的调用控制器类: @RestController @RequestMapping @@ -203,39 +203,39 @@ rocketmq.yaml public void message() throws Exception { messageProducer.run(""); } - ¸´ÖÆ´úÂë + å¤�制代ç � -1. Æô¶¯ Spring ÏîÄ¿£¬ÎÒÃÇÀ´²âÊÔÒ»ÏÂ×î¼òµ¥µÄÏûÏ¢·¢ËÍ: +1. å�¯åЍ Spring 项目,我们æ�¥æµ‹è¯•一下最简å�•的消æ�¯å�‘é€�: GET http://localhost:10801/message Accept: */* Cache-Control: no-cache - ¸´ÖÆ´úÂë + å¤�制代ç � -ÎÒÃÇÒ²ÄÜÔÚ RocketMQ µÄ¹ÜÀí¿ØÖÆÌ¨£¬´óÖ¿´µ½ÏûÏ¢µÄÏû·ÑÇé¿ö£º +我们也能在 RocketMQ 的管ç�†æŽ§åˆ¶å�°ï¼Œå¤§è‡´çœ‹åˆ°æ¶ˆæ�¯çš„æ¶ˆè´¹æƒ…况: -ʵսµ½ÁËÕâÀﲢûÓнâÊÍһЩ¸ÅÄ¿ÉÄÜ´ó¼Ò»áÓе㷸ÃÔºý¡£ +实战到了这里并没有解释一些概念,å�¯èƒ½å¤§å®¶ä¼šæœ‰ç‚¹çŠ¯è¿·ç³Šã€‚ -Topic£¨Ö÷Ì⣩Ï൱ÓÚÒ»ÖÖÀàÐ͵ÄÏûÏ¢£¬±ÈÈç¿ÉÒÔÉèÖà Topic1 רÃÅÊÇ·ÖÏúµÄÒµÎñ£¬ Topic2 רÃÅÊÇÓÅ»ÝȯµÄÒµÎñ£»¶ø Group£¨·Ö×飩Ï൱ÓÚ¶ÔÉú²úÕߺÍÏû·ÑÕߵķÖ×飬ÄÇÎÒÃǵÄ΢·þÎñ¼ÈÄÜ×öÉú²úÕßÒ²ÄÜ×öÏû·ÑÕߣ¬±ÈÈç¿ÉÒÔÉèÖà Group1 ÊÇÉÌÆ·µÄ΢·þÎñ£¬Group2 ÊǶ©µ¥µÄ΢·þÎñ£¬µ±È»»¹ÒªÇø·ÖÏÂÊÇÉú²úÕß·Ö×黹ÊÇÏû·ÑÕß·Ö×é¡£ +Topic(主题)相当于一ç§�类型的消æ�¯ï¼Œæ¯”如å�¯ä»¥è®¾ç½® Topic1 专门是分销的业务, Topic2 专门是优惠券的业务;而 Group(分组)相当于对生产者和消费者的分组,那我们的微æœ�务既能å�šç”Ÿäº§è€…也能å�šæ¶ˆè´¹è€…ï¼Œæ¯”å¦‚å�¯ä»¥è®¾ç½® Group1 是商å“�的微æœ�务,Group2 是订å�•的微æœ�务,当然还è¦�区分下是生产者分组还是消费者分组。 -- Group£º·ÖΪProducerGroup ºÍ ConsumerGroup, ´ú±íijһÀàµÄÉú²úÕߺÍÏû·ÑÕߣ¬Ò»°ãÀ´ËµÍ¬Ò»¸ö·þÎñ¿ÉÒÔ×÷Ϊ Group£¬Í¬Ò»¸ö Group Ò»°ãÀ´Ëµ·¢ËͺÍÏû·ÑµÄÏûÏ¢¶¼ÊÇÒ»ÑùµÄ¡£ -- Topic£ºÏûÏ¢Ö÷Ì⣬һ¼¶ÏûÏ¢ÀàÐÍ£¬Éú²úÕßÏòÆä·¢ËÍÏûÏ¢£¬Ïû·ÑÕß¶ÁÈ¡ÆäÏûÏ¢¡£ -- Queue: ·ÖΪ¶ÁºÍдÁ½ÖÖ¶ÓÁУ¬Ò»°ãÀ´Ëµ¶Áд¶ÓÁÐÊýÁ¿Ò»Ö£¬Èç¹û²»Ò»Ö¾ͻá³öÏֺܶàÎÊÌâ¡£ +- Group:分为ProducerGroup å’Œ ConsumerGroup, 代表æŸ�一类的生产者和消费者,一般æ�¥è¯´å�Œä¸€ä¸ªæœ�务å�¯ä»¥ä½œä¸º Group,å�Œä¸€ä¸ª Group 一般æ�¥è¯´å�‘é€�和消费的消æ�¯éƒ½æ˜¯ä¸€æ ·çš„。 +- Topic:消æ�¯ä¸»é¢˜ï¼Œä¸€çº§æ¶ˆæ�¯ç±»åž‹ï¼Œç”Ÿäº§è€…å�‘å…¶å�‘é€�消æ�¯ï¼Œæ¶ˆè´¹è€…读å�–其消æ�¯ã€‚ +- Queue: 分为读和写两ç§�队列,一般æ�¥è¯´è¯»å†™é˜Ÿåˆ—æ•°é‡�一致,如果ä¸�一致就会出现很多问题。 -Topic ÖÐÓзÖΪÁ˶à¸ö Queue£¬ÕâÆäʵÊÇÎÒÃÇ·¢ËÍ/¶ÁÈ¡ÏûϢͨµÀµÄ×îСµ¥Î»¡£ÎÒÃÇ·¢ËÍÏûÏ¢¶¼ÐèÒªÖ¸¶¨Ä³¸öдÈëij¸ö Queue£¬À­È¡ÏûÏ¢µÄʱºòÒ²ÐèÒªÖ¸¶¨À­È¡Ä³¸ö Queue£¬ËùÒÔÎÒÃǵÄ˳ÐòÏûÏ¢¿ÉÒÔ»ùÓÚÎÒÃÇµÄ Queue ά¶È±£³Ö¶ÓÁÐÓÐÐò£¬Èç¹ûÏë×öµ½È«¾ÖÓÐÐòÄÇôÐèÒª½« Queue ´óСÉèÖÃΪ1£¬ÕâÑùËùÓеÄÊý¾Ý¶¼»áÔÚ Queue ÖÐÓÐÐò¡£ +Topic 中有分为了多个 Queue,这其实是我们å�‘é€�/读å�–消æ�¯é€šé�“的最å°�å�•ä½�。我们å�‘é€�消æ�¯éƒ½éœ€è¦�指定æŸ�个写入æŸ�个 Queue,拉å�–消æ�¯çš„æ—¶å€™ä¹Ÿéœ€è¦�指定拉å�–æŸ�个 Queue,所以我们的顺åº�消æ�¯å�¯ä»¥åŸºäºŽæˆ‘们的 Queue 维度ä¿�æŒ�队列有åº�,如果想å�šåˆ°å…¨å±€æœ‰åº�那么需è¦�å°† Queue 大å°�设置为1,这样所有的数æ�®éƒ½ä¼šåœ¨ Queue 中有åº�。 -×÷Õߣº°×²Ë˵¼¼Êõ -Á´½Ó£ºhttps://juejin.cn/post/6930869079217717256 -À´Ô´£ºÏ¡ÍÁ¾ò½ð -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +作者:白è�œè¯´æŠ€æœ¯ +链接:https://juejin.cn/post/6930869079217717256 +æ�¥æº�:稀土掘金 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSeata.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSeata.md" index 1264b0e..0080124 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSeata.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSeata.md" @@ -1,288 +1,288 @@ -## ¼ò½é +## 简介 -ÎÒÃǶ¼ÖªµÀ Seata ÊÇÒ»¸ö·Ö²¼Ê½ÊÂÎñµÄ½â¾ö·½°¸£¬½ñÌìÎÒÃǾÍÀ´´ø´ó¼ÒÁ˽âÒ»ÏÂʲôÊÇ·Ö²¼Ê½ÊÂÎñ£¬Ê×ÏÈÎÒÃÇÏÈÀ´Á˽âһϻù´¡µÄ֪ʶ¡ª¡ªÊÂÎñ£¬ÎÒÃÇÏÈÀ´Á˽âÒ»ÏÂÊÂÎñµÄ¸ÅÄîÊÇʲô¡£ +我们都知é�“ Seata 是一个分布å¼�事务的解决方案,今天我们就æ�¥å¸¦å¤§å®¶äº†è§£ä¸€ä¸‹ä»€ä¹ˆæ˜¯åˆ†å¸ƒå¼�事务,首先我们先æ�¥äº†è§£ä¸€ä¸‹åŸºç¡€çš„知识——事务,我们先æ�¥äº†è§£ä¸€ä¸‹äº‹åŠ¡çš„æ¦‚å¿µæ˜¯ä»€ä¹ˆã€‚ -### »ù±¾¸ÅÄî +### 基本概念 -ÊÂÎñËIJ¿·Ö¹¹³É¡ª ACID£º +事务四部分构æˆ�— ACID: -* A(Atomic)£ºÔ­×ÓÐÔ£¬¹¹³ÉÊÂÎñµÄËùÓвÙ×÷£¬ÒªÃ´È«²¿Ö´Ðгɹ¦£¬ÒªÃ´È«²¿Ö´ÐÐʧ°Ü£¬²»»á³öÏÖ²¿·Ö³É¹¦»òÕß²¿·Öʧ°ÜµÄÇé¿ö¡£ -* C(Consistency)£ºÒ»ÖÂÐÔ£¬ÔÚÊÂÎñÖ´ÐÐǰºó£¬Êý¾Ý¿âµÄÒ»ÖÂÐÔÔ¼ÊøÃ»Óб»ÆÆ»µ£¬±ÈÈ磬СÓÂÈ¥ÒøÐÐÈ¡100¿éÇ®£¬È¡Ö®Ç°ÊÇ600£¬È¡Ö®ºóÓ¦¸ÃÊÇ400£¬È¡Ö®Ç°ºÍȡ֮ºóµÄÊý¾ÝΪÕýÈ·ÊýֵΪһÖÂÐÔ£¬Èç¹ûÈ¡³ö100£¬¶øÒøÐÐÀïÃæµÄǮûÓмõÉÙ£¬ÒªÃ´Ð¡ÓÂҪЦÐÑÁË£¬Õâ¸ö¾ÍûÓдﵽһÖÂÐÔµÄÒªÇó¡£ -* I(Isolation):¸ôÀëÐÔ£¬Êý¾Ý¿âÖеÄÊÂÎñÒ»°ã¶¼ÊDz¢·¢µÄ£¬¸ôÀëÐÔÊÇÖ»ÔÚ²¢·¢µÄÁ½¸öÊÂÎñÖ´Ðйý³Ì»¥²»¸ÉÈÅ£¬Ò»¸öÊÂÎñÔÚÖ´Ðйý³ÌÖв»ÄÜ¿´µ½ÆäËûÊÂÎñÔËÐйý³ÌµÄÖмä״̬£¬Í¨¹ýÅäÖÃÊÂÎñ¸ôÀë¼¶±ð¿ÉÒÔ±ÜÃâÔà¶Á£¬Öظ´¶ÁµÈÎÊÌâ¡£ -* D(Durability)£º³Ö¾ÃÐÔ£¬µ±ÊÂÎñÍê³ÉÖ®ºó£¬ÊÂÎñ¶ÔÊý¾ÝµÄ¸ü¸Ä»á±»³Ö¾Ã»¯µ½Êý¾Ý¿â£¬ÇÒ²»»á»Ø¹ö¡£ +* A(Atomic):原å­�性,构æˆ�事务的所有æ“�作,è¦�么全部执行æˆ�功,è¦�么全部执行失败,ä¸�会出现部分æˆ�功或者部分失败的情况。 +* C(Consistency):一致性,在事务执行å‰�å�Žï¼Œæ•°æ�®åº“的一致性约æ�Ÿæ²¡æœ‰è¢«ç ´å��,比如,å°�勇去银行å�–100å�—钱,å�–之å‰�是600,å�–之å�Žåº”该是400,å�–之å‰�å’Œå�–之å�Žçš„æ•°æ�®ä¸ºæ­£ç¡®æ•°å€¼ä¸ºä¸€è‡´æ€§ï¼Œå¦‚æžœå�–出100,而银行里é�¢çš„钱没有å‡�少,è¦�么å°�勇è¦�笑醒了,这个就没有达到一致性的è¦�求。 +* I(Isolation):隔离性,数æ�®åº“中的事务一般都是并å�‘的,隔离性是å�ªåœ¨å¹¶å�‘的两个事务执行过程互ä¸�干扰,一个事务在执行过程中ä¸�能看到其他事务è¿�行过程的中间状æ€�,通过é…�置事务隔离级别å�¯ä»¥é�¿å…�è„�读,é‡�å¤�读等问题。 +* D(Durability):æŒ�久性,当事务完æˆ�之å�Žï¼Œäº‹åŠ¡å¯¹æ•°æ�®çš„æ›´æ”¹ä¼šè¢«æŒ�久化到数æ�®åº“,且ä¸�会回滚。 -ÊÂÎñ·ÖΪÁ½²¿·Ö£º±¾µØÊÂÎñºÍ·Ö²¼Ê½ÊÂÎñ¡£ +事务分为两部分:本地事务和分布å¼�事务。 -#### ±¾µØÊÂÎñ£º +#### 本地事务: -ÔÚ¼ÆËã»úϵͳÖУ¬±È½Ï¶àµÄÊÇͨ¹ý¹ØÏµÐÍÊý¾Ý¿âÀ´¿ØÖÆÊÂÎñ£¬ÕâÊÇÀûÓÃÊý¾Ý¿â±¾ÉíµÄÊÂÎñÌØÐÔ½øÐÐʵÏֵģ¬ÒòΪӦÓÃÖ÷Òª¿¿¹ØÏµÐÍÊý¾Ý¿âÀ´Î¬³ÖÊÂÎñ£¬¼ÓÉÏÊý¾Ý¿âºÍÓ¦Óö¼ÔÚͬһ¸ö·þÎñÆ÷£¬ËùÒÔ»ùÓÚ¹ØÏµÐÍÊý¾ÝµÄÊÂÎñÓÖ±»³ÆÎª±¾µØÊÂÎñ¡£ +在计算机系统中,比较多的是通过关系型数æ�®åº“æ�¥æŽ§åˆ¶äº‹åŠ¡ï¼Œè¿™æ˜¯åˆ©ç”¨æ•°æ�®åº“本身的事务特性进行实现的,因为应用主è¦�é� å…³ç³»åž‹æ•°æ�®åº“æ�¥ç»´æŒ�事务,加上数æ�®åº“和应用都在å�Œä¸€ä¸ªæœ�务器,所以基于关系型数æ�®çš„事务å�ˆè¢«ç§°ä¸ºæœ¬åœ°äº‹åŠ¡ã€‚ -#### ·Ö²¼Ê½ÊÂÎñ£º +#### 分布å¼�事务: -·Ö²¼Ê½ÊÂÎñÊÇÖ¸ÊÂÎñµÄ²ÎÓëÕß¡¢Ö§³ÖÊÂÎñµÄ·þÎñÆ÷¡¢×ÊÔ´·þÎñÆ÷ÒÔ¼°ÊÂÎñ¹ÜÀíÕß·Ö±ðλÓÚ²»Í¬µÄ·Ö²¼Ê½ÏµÍ³µÄ²»Í¬½ÚµãÖ®ÉÏ£¬ÇÒÊôÓÚ²»Í¬µÄÓ¦Ó㬷ֲ¼Ê½ÊÂÎñÐèÒª±£Ö¤ÕâЩ²Ù×÷Ҫôȫ²¿³É¹¦£¬ÒªÃ´È«²¿Ê§°Ü£¬·Ö²¼Ê½ÊÂÎñ¾ÍÊÇΪÁ˱£Ö¤ÔÚ²»Í¬·þÎñÆ÷ÉÏÊý¾Ý¿âÊý¾ÝµÄÒ»ÖÂÐÔ¡£ +分布å¼�事务是指事务的å�‚与者ã€�支æŒ�事务的æœ�务器ã€�资æº�æœ�务器以å�Šäº‹åŠ¡ç®¡ç�†è€…分别ä½�于ä¸�å�Œçš„分布å¼�系统的ä¸�å�ŒèŠ‚ç‚¹ä¹‹ä¸Šï¼Œä¸”å±žäºŽä¸�å�Œçš„应用,分布å¼�事务需è¦�ä¿�è¯�这些æ“�作è¦�么全部æˆ�功,è¦�么全部失败,分布å¼�事务就是为了ä¿�è¯�在ä¸�å�Œæœ�务器上数æ�®åº“æ•°æ�®çš„一致性。 -Seata µÄÉè¼ÆË¼Â·Êǽ«¶à¸ö·þÎñÆ÷µÄ±¾µØÊÂÎñ×é³ÉÒ»¸öÈ«¾ÖÊÂÎñ£¬ÏÂÃæÈô¸É¸ö±¾µØÊÂÎñ£¬¶¼ÄÜÂú×ãACID£¬×îºÃÐγÉÒ»¸öÕûµÄ·Ö²¼Ê½ÊÂÎñ£¬²Ù×÷·Ö²¼Ê½ÊÂÎñ¾ÍÏñÊDzÙ×÷±¾µØÊÂÎñÒ»Ñù¡£ +Seata 的设计æ€�路是将多个æœ�务器的本地事务组æˆ�一个全局事务,下é�¢è‹¥å¹²ä¸ªæœ¬åœ°äº‹åŠ¡ï¼Œéƒ½èƒ½æ»¡è¶³ACID,最好形æˆ�一个整的分布å¼�事务,æ“�作分布å¼�事务就åƒ�是æ“�作本地事务一样。 -·Ö²¼Ê½ÏµÍ³»á°ÑÒ»¸öÓ¦Óòð·ÖΪ¶à¸ö¿É¶ÀÁ¢²¿ÊðµÄ·þÎñ£¬·þÎñÓÚ·þÎñÖ®¼äͨ³£ÐèÒªÔ¶³ÌЭ×÷²ÅÄÜÍê³ÉÊÂÎñµÄ²Ù×÷£¬ÕâÖÖ·Ö²¼Ê½ÏµÍ³»·¾³ÏÂÓÉÓÚ²»Í¬µÄ·þÎñÖ®¼äͨ¹ýÍøÂçÔ¶³ÌЭ×÷Íê³ÉµÄÊÂÎñ±»³ÆÎª·Ö²¼Ê½ÊÂÎñ£¬ÀýÈ繩ӦÁ´ÏµÍ³ÖУ¬¶©µ¥´´½¨£¨Éú³É¶©µ¥¡¢¿Û¼õ¿â´æ¡¢ÂÄԼ֪ͨ·¢»õ£©µÈ¡£ +分布å¼�系统会把一个应用拆分为多个å�¯ç‹¬ç«‹éƒ¨ç½²çš„æœ�务,æœ�务于æœ�务之间通常需è¦�远程å��作æ‰�能完æˆ�事务的æ“�作,这ç§�分布å¼�系统环境下由于ä¸�å�Œçš„æœ�务之间通过网络远程å��作完æˆ�的事务被称为分布å¼�事务,例如供应链系统中,订å�•创建(生æˆ�订å�•ã€�扣å‡�库存ã€�履约通知å�‘货)等。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/6471b8f38c5920f6ace85580abd1567bc0f021.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/6471b8f38c5920f6ace85580abd1567bc0f021.png "图片") -ÔÚÉÏͼÖÐÎÒÃÇ¿ÉÒÔ¿´³ö£¬Ö»ÒªÉæ¼°µ½²Ù×÷¶à¸öÊý¾ÝÔ´£¬¾Í»á²úÉúÊÂÎñµÄÎÊÌ⣬ÎÒÃÇÔÚʵ¼Ê¿ª·¢ÖÐÓ¦¸ÃÒª±ÜÃâÕâÕâ¸öÄãÎÊÌâµÄ³öÏÖ£¬µ«ÊÇËäȻϵͳµÄÍØÕ¹£¬Ó¦ÓúÍÓ¦ÓÃÖ®¼ä±ØÈ»»á²úÉúÓ¦ÓÃÖ®¼äÊÂÎñµÄ·ÖÀ룬µ±Î¢·þÎñ¼Ü¹¹ÖУ¬Ö÷ÒªÓÐMQºÍSeata£¬ÔÚÁ˽âËûÃÇ֮ǰ£¬ÎÒÃÇÏÈÀ´Á˽âһϷֲ¼Ê½ÊÂÎñÊÇÔõÑù×é³É£¬ÒÔ¼°ÈçºÎʵÏֵġ£ +在上图中我们å�¯ä»¥çœ‹å‡ºï¼Œå�ªè¦�涉å�Šåˆ°æ“�作多个数æ�®æº�,就会产生事务的问题,我们在实际开å�‘中应该è¦�é�¿å…�这这个你问题的出现,但是虽然系统的拓展,应用和应用之间必然会产生应用之间事务的分离,当微æœ�务架构中,主è¦�有MQå’ŒSeata,在了解他们之å‰�,我们先æ�¥äº†è§£ä¸€ä¸‹åˆ†å¸ƒå¼�事务是怎样组æˆ�,以å�Šå¦‚何实现的。 -## ·Ö²¼Ê½ÊÂÎñ +## 分布å¼�事务 -#### ·Ö²¼Ê½ÊÂÎñÊÇʲô£¿ +#### 分布å¼�事务是什么? -·Ö²¼Ê½ÊÂÎñÖ¸µÄÊÇÊÂÎñµÄ²ÎÓëÕߣ¬Ö§³ÖÊÂÎñµÄ·þÎñÆ÷£¬×ÊÔ´·þÎñÆ÷·Ö±ðλÓÚ·Ö²¼Ê½ÏµÍ³µÄ²»Í¬½ÚµãÖ®ÉÏ£¬Í¨³£Ò»¸ö·Ö²¼Ê½ÊÂÎïÖлáÉæ¼°µ½¶Ô¶à¸öÊý¾ÝÔ´»òÒµÎñϵͳµÄ²Ù×÷¡£ +分布å¼�事务指的是事务的å�‚与者,支æŒ�事务的æœ�务器,资æº�æœ�务器分别ä½�于分布å¼�系统的ä¸�å�ŒèŠ‚ç‚¹ä¹‹ä¸Šï¼Œé€šå¸¸ä¸€ä¸ªåˆ†å¸ƒå¼�事物中会涉å�Šåˆ°å¯¹å¤šä¸ªæ•°æ�®æº�或业务系统的æ“�作。 -Ëæ×Å»¥ÁªÍøµÄ·¢Õ¹£¬´Ó֮ǰµÄµ¥Ò»ÏîÄ¿Öð½¥Ïò·Ö²¼Ê½·þÎñ×öת»»£¬ÏÖÈç½ñ΢·þÎñÔÚ¸÷¸ö¹«Ë¾ÒѾ­ÆÕ±é´æÔÚ£¬¶øµ±Ê±µÄ±¾µØÊÂÎñÒѾ­ÎÞ·¨Âú×ã·Ö²¼Ê½Ó¦ÓõÄÒªÇó£¬Òò´Ë·Ö²¼Ê½·þÎñÖ®¼äÊÂÎñµÄЭµ÷¾Í²úÉúÁËÎÊÌ⣬Èç¹û×öµ½¶à¸ö·þÎñÖ®¼äÊÂÎñµÄ²Ù×÷£¬Äܹ»Ïñ±¾µØÊÂÎñÒ»Ñù×ñÑ­ACIDÔ­Ôò£¬³ÉΪһ¸öÄÑÌ⣬µ«ÊÇÔÚ´óÅ£ÃDz»¶ÏµÄ̽Ë÷Ï£¬ÖÕÓÚÕÒµ½ÁË·Ö²¼Ê½ÊÂÎñ´æÔÚÁ½´óÀíÂÛÒÀ¾Ý£ºCAP¶¨ÂɺÍBASEÀíÂÛ¡£ +éš�ç�€äº’è�”网的å�‘展,从之å‰�çš„å�•一项目é€�æ¸�å�‘分布å¼�æœ�务å�šè½¬æ�¢ï¼ŒçŽ°å¦‚ä»Šå¾®æœ�务在å�„个公å�¸å·²ç»�æ™®é��存在,而当时的本地事务已ç»�无法满足分布å¼�应用的è¦�求,因此分布å¼�æœ�务之间事务的å��调就产生了问题,如果å�šåˆ°å¤šä¸ªæœ�务之间事务的æ“�作,能够åƒ�本地事务一样é�µå¾ªACID原则,æˆ�为一个难题,但是在大牛们ä¸�断的探索下,终于找到了分布å¼�事务存在两大ç�†è®ºä¾�æ�®ï¼šCAP定律和BASEç�†è®ºã€‚ -### CAP¶¨ÂÉ +### CAP定律 -CAP¶¨ÂÉÓÉÒ»ÖÂÐÔ(C)¡¢¿ÉÓÃÐÔ(A)¡¢·ÖÇøÈÝ´íÐÔ(P)×é³É£¬ÔÚ·Ö²¼Ê½ÏµÍ³ÖУ¬²»¿ÉÄÜͬʱÂú×ãConsistency(Ò»ÖÂÐÔ)/Availability(¿ÉÓÃÐÔ)/Partition tolerance(·ÖÇøÈÝ´íÐÔ) Èý¸öÌØÐÔ£¬×î¶àÖ»ÄÜͬʱÂú×ãÆäÖÐÁ½Ïî¡£ +CAP定律由一致性(C)ã€�å�¯ç”¨æ€§(A)ã€�分区容错性(P)组æˆ�,在分布å¼�系统中,ä¸�å�¯èƒ½å�Œæ—¶æ»¡è¶³Consistency(一致性)/Availability(å�¯ç”¨æ€§)/Partition tolerance(分区容错性) 三个特性,最多å�ªèƒ½å�Œæ—¶æ»¡è¶³å…¶ä¸­ä¸¤é¡¹ã€‚ -* Ò»ÖÂÐÔ(C)£ºÔÚ·Ö²¼Ê½ÏµÍ³ÖÐËùÓеÄÊý¾Ý±¸·Ý£¬ÔÚͬһʱ¿Ì±£³ÖÒ»ÖµÄÌØÐÔ£¬ËùÓеÄÓ¦Óýڵã·ÃÎʵͼÊÇͬһ·Ý×îеÄÊý¾Ý¸±±¾¡£ -* ¿ÉÓÃÐÔ(A): µ±¼¯ÈºÖÐÒ»²¿·Ö½Úµã¹ÊÕÏÒԺ󣬼¯ÈºÕûÌåÄܹ»ÏìÓ¦¿Í»§¶ËµÄ¶ÁдÇëÇ󣬶ÔÊý¾Ý¸üо߱¸¸ß¿ÉÓÃÐÔ¡£ -* ·ÖÇøÈÝ´íÐÔ(P): Èç¹ûϵͳÔڹ涨ʱ¼äÏÞÖÆÄÚ²»ÄÜ´ï³ÉÊý¾ÝµÄÒ»ÖÂÐÔ£¬¾Í±íʾҪ·¢Éú·ÖÇøµÄÇé¿ö£¬µ±Ç°²Ù×÷ÐèÒªÔÚCºÍAÖ®¼ä×ö³öÑ¡Ôñ£¬ÈÃϵͳÄܹ»ÔÚÓöµ½ÍøÂç¹ÊÕϵÈÇé¿öµÄʱºò£¬ÈÎÈ»Äܹ»±£Ö¤¶ÔÍâÌṩÂú×ãÒ»ÖÂÐÔ»òÕß¿ÉÓÃÐԵķþÎñ¡£ +* 一致性(C):在分布å¼�系统中所有的数æ�®å¤‡ä»½ï¼Œåœ¨å�Œä¸€æ—¶åˆ»ä¿�æŒ�一致的特性,所有的应用节点访问的都是å�Œä¸€ä»½æœ€æ–°çš„æ•°æ�®å‰¯æœ¬ã€‚ +* å�¯ç”¨æ€§(A): 当集群中一部分节点故障以å�Žï¼Œé›†ç¾¤æ•´ä½“能够å“�应客户端的读写请求,对数æ�®æ›´æ–°å…·å¤‡é«˜å�¯ç”¨æ€§ã€‚ +* 分区容错性(P): 如果系统在规定时间é™�制内ä¸�能达æˆ�æ•°æ�®çš„一致性,就表示è¦�å�‘生分区的情况,当å‰�æ“�作需è¦�在Cå’ŒA之间å�šå‡ºé€‰æ‹©ï¼Œè®©ç³»ç»Ÿèƒ½å¤Ÿåœ¨é�‡åˆ°ç½‘络故障等情况的时候,任然能够ä¿�è¯�对外æ��供满足一致性或者å�¯ç”¨æ€§çš„æœ�务。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a5ec7fb950052bd1116452eb0ca9f52fd4e5a5.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a5ec7fb950052bd1116452eb0ca9f52fd4e5a5.png "图片") -ÔÚÉÏͼÖÐÎÒÃÇ¿ÉÒÔ¿´µ½£¬µ±ÎÒÃÇÓû§È¥¹ºÎï³µÀïÃæµã»÷ϵ¥½áËãµÄʱºò£¬Ê×ÏȻᾭ¹ýÎÒÃÇ¿â´æ·þÎñ£¬ÅÐ¶Ï¿â´æÊÇ·ñ×ã¹»£¬µ±¿â´æÂú×㣬¿Û¼õ¿â´æÒÔºó£¬ÎÒÃÇÐèÒª½«Êý¾Ýͬ²½µ½ÆäËû·þÎñÆ÷ÉÏ£¬ÕâÒ»²½ÊÇΪÁ˱£Ö¤Êý¾ÝµÄ½á¹ûµÄÒ»ÖÂÐÔ£¬Õâ¸öʱºòÈç¹ûÍøÂç²úÉú²¨¶¯ÁË£¬ÎÒÃǵÄϵͳÐèÒª±£Ö¤·ÖÇøÈÝ´íÐÔ£¬Ò²¾ÍÊÇÎÒÃDZØÐëÈÝÈÌÍøÂçËù´øÀ´µÄһЩÎÊÌ⣬´ËʱÏë±£Ö¤Ò»ÖÂÐÔ£¬¾ÍÐèÒªÉáÆú¿ÉÓÃÐÔ¡£ +在上图中我们å�¯ä»¥çœ‹åˆ°ï¼Œå½“我们用户去购物车里é�¢ç‚¹å‡»ä¸‹å�•结算的时候,首先会ç»�过我们库存æœ�务,判断库存是å�¦è¶³å¤Ÿï¼Œå½“库存满足,扣å‡�库存以å�Žï¼Œæˆ‘们需è¦�将数æ�®å�Œæ­¥åˆ°å…¶ä»–æœ�务器上,这一步是为了ä¿�è¯�æ•°æ�®çš„结果的一致性,这个时候如果网络产生波动了,我们的系统需è¦�ä¿�è¯�分区容错性,也就是我们必须容å¿�网络所带æ�¥çš„一些问题,此时想ä¿�è¯�一致性,就需è¦�èˆ�弃å�¯ç”¨æ€§ã€‚ -µ«ÊÇÈç¹ûΪÁ˱£Ö¤¸ß¿ÉÓÃÐÔ£¬ÄÇôÔڸ߲¢·¢µÄÇé¿öÏ£¬ÊÇÎÞ·¨±£Ö¤ÔÚÏÞ¶¨Ê±¼äÄÚ¸ø³öÏìÓ¦£¬ÓÉÓÚÍøÂçµÄ²»¿É¿¿£¬ÎÒÃǵĶ©µ¥·þÎñ¿ÉÄÜÎÞ·¨Äõ½×îеÄÊý¾Ý£¬µ«ÊÇÎÒÃÇÒª¸øÓû§×ö³öÏìÓ¦£¬ÄÇôҲÎÞ·¨±£Ö¤Ò»ÖÂÐÔ£¬ËùÒÔAPÊÇÎÞ·¨±£Ö¤Ç¿Ò»ÖÂÐԵġ£ +但是如果为了ä¿�è¯�高å�¯ç”¨æ€§ï¼Œé‚£ä¹ˆåœ¨é«˜å¹¶å�‘的情况下,是无法ä¿�è¯�在é™�定时间内给出å“�应,由于网络的ä¸�å�¯é� ï¼Œæˆ‘们的订å�•æœ�务å�¯èƒ½æ— æ³•拿到最新的数æ�®ï¼Œä½†æ˜¯æˆ‘们è¦�给用户å�šå‡ºå“�应,那么也无法ä¿�è¯�一致性,所以AP是无法ä¿�è¯�强一致性的。 -Èç¹û¼ÈÏëÒª±£Ö¤¸ß¿ÉÓÃÓÖÏëÒª±£Ö¤Ò»ÖÂÐÔ£¬±ØÐëÔÚÍøÂçÁ¼ºÃµÄÇé¿öϲÅÄÜʵÏÖ£¬ÄÇô½â¾ö·½·¨Ö»ÓÐÒ»¸ö£¬ÄǾÍÊÇÐèÒª½«¿â´æ¡¢¶©µ¥¡¢ÂÄÔ¼·Åµ½Ò»Æð£¬µ«ÊÇÕâ¸ö¾ÍÉÏÈ¥ÁËÎÒÃÇ΢·þÎñµÄ×÷Óã¬Ò²¾Í²»ÔÙÊÇ·Ö²¼Ê½ÏµÍ³ÁË¡£ +如果既想è¦�ä¿�è¯�高å�¯ç”¨å�ˆæƒ³è¦�ä¿�è¯�一致性,必须在网络良好的情况下æ‰�能实现,那么解决方法å�ªæœ‰ä¸€ä¸ªï¼Œé‚£å°±æ˜¯éœ€è¦�将库存ã€�订å�•ã€�履约放到一起,但是这个就上去了我们微æœ�务的作用,也就ä¸�å†�是分布å¼�系统了。 -ÔÚ·Ö²¼Ê½ÏµÍ³ÖУ¬·ÖÇøÈÝ´íÐÔÊDZØÐë´æÔڵģ¬ÎÒÃÇÖ»ÄÜÔÚÒ»ÖÂÐԺͿÉÓÃÐÔÉÏÈ¡ÉᣬÔÚÕâÖÖÌõ¼þϾ͵®ÉúÁËBASEÀíÂÛ¡£ +在分布å¼�系统中,分区容错性是必须存在的,我们å�ªèƒ½åœ¨ä¸€è‡´æ€§å’Œå�¯ç”¨æ€§ä¸Šå�–èˆ�,在这ç§�æ�¡ä»¶ä¸‹å°±è¯žç”Ÿäº†BASEç�†è®ºã€‚ -### BASEÀíÂÛ +### BASEç�†è®º -BASEÓÉ »ù±¾¿ÉÓà (Basically Available)¡¢Èí״̬ (Soft state)ºÍ ×îÖÕÒ»ÖÂÐÔ (Eventually consistent) Èý¸ö¹¹½¨¶ø³É£¬ÊǶÔCAPÖÐÒ»ÖÂÐԺͿÉÓÃÐÔȨºâµÄ½á¹û£¬À´Ô´ÓÚ¶Ô»¥ÁªÍøÏµÍ³·Ö²¼Ê½Êµ¼ùµÄ×ܽᣬÊÇ»ùÓÚCAP¶¨ÀíÖð²½ÑÝ»¯¶øÀ´µÄ£¬ºËÐÄËÄϵÄǸöÊǼ°Ê±ÎÞ·¨×öµ½Ç¿Ò»ÖÂÐÔ£¬µ«ÊÇÿ¸öÓ¦Óö¼¿ÉÒÔ¸ù¾Ý×ÔÉíµÄÒµÎñÌØµã£¬²ÉÓÃÊʵ±µÄ·½Ê½À´Ê¹ÏµÍ³´ïµ½×îÖÕÒ»ÖÂÐÔ¡£ +BASEç”± 基本å�¯ç”¨ (Basically Available)ã€�软状æ€� (Soft state)å’Œ 最终一致性 (Eventually consistent) 三个构建而æˆ�,是对CAP中一致性和å�¯ç”¨æ€§æ�ƒè¡¡çš„结果,æ�¥æº�于对互è�”网系统分布å¼�实践的总结,是基于CAP定ç�†é€�步演化而æ�¥çš„,核心四系那个是å�Šæ—¶æ— æ³•å�šåˆ°å¼ºä¸€è‡´æ€§ï¼Œä½†æ˜¯æ¯�个应用都å�¯ä»¥æ ¹æ�®è‡ªèº«çš„业务特点,采用适当的方å¼�æ�¥ä½¿ç³»ç»Ÿè¾¾åˆ°æœ€ç»ˆä¸€è‡´æ€§ã€‚ -1. »ù±¾¿ÉÓ㺻ù±¾¿ÉÓÃÊÇÖ¸µ±·Ö²¼Ê½ÏµÍ³³öÏÖ²»¿ÉÔ¤Öª¹ÊÕϵÄʱºò£¬ÔÊÐíËðʧ²¿·Ö¿ÉÓÃÐÔ£¬µ«ÊÇÕâÀï²¢²»ÊÇ˵±íʾϵͳ²»¿ÉÒÔÓã¬Ö÷ÒªÌåÏÖΪÒÔϼ¸µã: +1. 基本å�¯ç”¨ï¼šåŸºæœ¬å�¯ç”¨æ˜¯æŒ‡å½“分布å¼�系统出现ä¸�å�¯é¢„知故障的时候,å…�许æ�Ÿå¤±éƒ¨åˆ†å�¯ç”¨æ€§ï¼Œä½†æ˜¯è¿™é‡Œå¹¶ä¸�是说表示系统ä¸�å�¯ä»¥ç”¨ï¼Œä¸»è¦�体现为以下几点: -* ÏìӦʱ¼äÉϵÄËðʧ£¬ÔÚÕý³£Çé¿öÏ£¬Ò»¸öÔÚÏßËÑË÷ÒýÇæÐèÒªÔÚ0.5ÃëÖ®ÄÚ·µ»Ø¸øÓû§ÏìÓ¦µÄ²éѯ½á¹û£¬µ«ÊÇÓÉÓÚ³öÏÖ¹ÊÕÏ£¬²éѯ½á¹ûµÄÏìӦʱ¼äÔö¼ÓÁË1-2Ãë¡£ -* ϵͳ¹¦ÄÜÉϵÄËðʧ£¬ÔÚÕý³£Çé¿öÏ£¬Ò»¸öµç×ÓÉÌÎñÍøÕ¾ÉϽøÐйºÎÏû·ÑÕß¼¸ºõÄܹ»Ë³ÀûµÄÍê³Éÿһµ¥²Ù×÷£¬µ«ÊÇÔÚһЩ½ÚÈÕ´ó´ÙÏú¹ºÎï¸ß·åÆÚµÄʱºò£¬ÓÉÓÚÍøÕ¾ÉϹºÂòÁ¿µÄÃÍÔö£¬ÎªÁ˱£Ö¤ÏµÍ³µÄÎȶ¨ÐÔ£¬²¿·ÖÏû·ÑÕß¿ÉÄÜ»áÒýµ¼µ½Ò»¸öÁÙʱ½µ¼¶´¦ÀíµÄÒ³Ãæ»òÕßÌáʾ¡£ +* å“�应时间上的æ�Ÿå¤±ï¼Œåœ¨æ­£å¸¸æƒ…况下,一个在线æ�œç´¢å¼•擎需è¦�在0.5秒之内返回给用户å“�应的查询结果,但是由于出现故障,查询结果的å“�应时间增加了1-2秒。 +* 系统功能上的æ�Ÿå¤±ï¼Œåœ¨æ­£å¸¸æƒ…况下,一个电å­�商务网站上进行购物,消费者几乎能够顺利的完æˆ�æ¯�一å�•æ“�作,但是在一些节日大促销购物高峰期的时候,由于网站上购买é‡�的猛增,为了ä¿�è¯�系统的稳定性,部分消费者å�¯èƒ½ä¼šå¼•导到一个临时é™�级处ç�†çš„页é�¢æˆ–者æ��示。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a7dac0d93bc82c6c6c7076b77061ed1ebed415.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a7dac0d93bc82c6c6c7076b77061ed1ebed415.png "图片") -»ù±¾¿ÉÓõÄÒâ˼ÊÇ£¬¶ÔÓÚÎÒÃǵĺËÐÄ·þÎñÊÇ¿ÉÒÔʹÓõ쬯äËûµÄ·þÎñ¿ÉÒÔÊʵ±µÄ½µµÍÏìӦʱ¼ä£¬ÉõÖÁÊǽøÐзþÎñ½µ¼¶´¦Àí£¬ÔÚµ±Ç°ÖУ¬¿â´æºÍ¶©µ¥¿Ï¶¨ÊǺËÐÄ·þÎñ£¬ÖÁÓÚÎÒÃǵķ¢»õϵͳÔÚµ±Ê±Ö»Òª±£Ö¤»ù±¾¿ÉÓþÍÐУ¬ËüµÄͬ²½¿ÉÒÔÂýÒ»µã»òÕßÑÓ³Ù¸ü¸ß£¬µÈ´ýÁ÷Á¿¸ß·å¹ýÈ¥ÒÔºó£¬ÔÚ½øÐлָ´¡£ +基本å�¯ç”¨çš„æ„�æ€�是,对于我们的核心æœ�务是å�¯ä»¥ä½¿ç”¨çš„,其他的æœ�务å�¯ä»¥é€‚当的é™�低å“�应时间,甚至是进行æœ�务é™�级处ç�†ï¼Œåœ¨å½“å‰�中,库存和订å�•肯定是核心æœ�务,至于我们的å�‘货系统在当时å�ªè¦�ä¿�è¯�基本å�¯ç”¨å°±è¡Œï¼Œå®ƒçš„å�Œæ­¥å�¯ä»¥æ…¢ä¸€ç‚¹æˆ–者延迟更高,等待æµ�é‡�高峰过去以å�Žï¼Œåœ¨è¿›è¡Œæ�¢å¤�。 -1. Èí״̬£ºÈí״̬ÊÇÖ¸ÔÊÐíϵͳÖеÄÊý¾Ý´æÔÚÖмä״̬£¬²¢ÈÏΪ¸ÃÖмä״̬µÄ´æÔÚ²»»áÓ°ÏìϵͳµÄÕûÌå¿ÉÓÃÐÔ£¬¼´ÔÊÐíϵͳ²»ÓýڵãµÄÊý¾Ý¸±±¾Ö®¼ä½øÐÐÊý¾Ýͬ²½µÄ¹ý³Ì´æÔÚÑÓʱ¡£ +1. 软状æ€�:软状æ€�是指å…�许系统中的数æ�®å­˜åœ¨ä¸­é—´çжæ€�,并认为该中间状æ€�的存在ä¸�会影å“�系统的整体å�¯ç”¨æ€§ï¼Œå�³å…�许系统ä¸�用节点的数æ�®å‰¯æœ¬ä¹‹é—´è¿›è¡Œæ•°æ�®å�Œæ­¥çš„过程存在延时。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/610c63492ee5e0f1d30493958b54430c85a9f3.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/610c63492ee5e0f1d30493958b54430c85a9f3.png "图片") -Èí״̬µÄÒâ˼ÊÇ˵£¬µ±ÎÒÃÇ´óÁ¿Ïµ¥µÄʱºò£¬¿Û¼õ¿â´æÊ±£¬Á÷Á¿¼¤Ôö£¬Õâ¸öʱºòÈç¹û´óÁ¿·ÃÎʵ½¿â´æ»òÕß¶©µ¥ÖУ¬¿ÉÄܻὫϵͳŪ¿å£¬Õâ¸ö¹ý³ÌÖÐÎÒÃÇ¿ÉÒÔÔÊÐíÊý¾ÝµÄͬ²½´æÔÚÑÓ³Ù£¬²»Ó°ÏìÕûÌåϵͳµÄʹÓᣠ+软状æ€�çš„æ„�æ€�是说,当我们大é‡�下å�•的时候,扣å‡�库存时,æµ�é‡�激增,这个时候如果大é‡�访问到库存或者订å�•中,å�¯èƒ½ä¼šå°†ç³»ç»Ÿå¼„垮,这个过程中我们å�¯ä»¥å…�许数æ�®çš„å�Œæ­¥å­˜åœ¨å»¶è¿Ÿï¼Œä¸�å½±å“�整体系统的使用。 -1. ×îÖÕÒ»ÖÂÐÔ£º×îÖÕÒ»ÖÂÐÔÇ¿µ÷µÄÊÇËùÓÐÊý¾Ý¸±±¾£¬ÔÚ¾­¹ýÒ»¶Îʱ¼äµÄͬ²½Ö®ºó£¬×îÖÕ¶¼Äܹ»´ïµ½Ò»¸öÒ»ÖµÄ״̬£¬Òò´Ë£¬×îÖÕÒ»ÖÂÐԵı¾ÖÊÊÇÐèҪϵͳ±£Ö¤×îÖÕÊý¾ÝÄܹ»´ïµ½Ò»Ö£¬¶ø²»ÊÇÐèҪʵʱ±£Ö¤ÏµÍ³µÄǿһÖÂÐÔ¡£ +1. 最终一致性:最终一致性强调的是所有数æ�®å‰¯æœ¬ï¼Œåœ¨ç»�过一段时间的å�Œæ­¥ä¹‹å�Žï¼Œæœ€ç»ˆéƒ½èƒ½å¤Ÿè¾¾åˆ°ä¸€ä¸ªä¸€è‡´çš„状æ€�,因此,最终一致性的本质是需è¦�系统ä¿�è¯�最终数æ�®èƒ½å¤Ÿè¾¾åˆ°ä¸€è‡´ï¼Œè€Œä¸�是需è¦�实时ä¿�è¯�系统的强一致性。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a23602e9776d2c7bd3d507582538c32a471c8c.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a23602e9776d2c7bd3d507582538c32a471c8c.png "图片") -¾­¹ýÁ÷Á¿¸ß·åÆÚÒԺ󣬾­¹ýÒ»¶Îʱ¼äµÄͬ²½£¬´ÓÖмä״̬×îºó±ä³ÉÊý¾Ý×îÖÕÒ»ÖÂÐÔ£¬±£Ö¤¸÷¸ö·þÎñÊý¾ÝµÄÒ»ÖÂÐÔ¡£ +ç»�过æµ�é‡�高峰期以å�Žï¼Œç»�过一段时间的å�Œæ­¥ï¼Œä»Žä¸­é—´çжæ€�最å�Žå�˜æˆ�æ•°æ�®æœ€ç»ˆä¸€è‡´æ€§ï¼Œä¿�è¯�å�„个æœ�务数æ�®çš„一致性。 -### ¶þ½×¶ÎÌá½»(2PC) +### 二阶段æ��交(2PC) -2PC¼´Á½½×¶ÎÌύЭÒ飬Êǽ«Õû¸öÊÂÎñÁ÷³Ì·ÖΪÁ½¸ö½×¶Î£¬PÊÇָ׼±¸½×¶Î£¬CÊÇÖ¸Ìá½»½×¶Î¡£ +2PCå�³ä¸¤é˜¶æ®µæ��交å��议,是将整个事务æµ�程分为两个阶段,P是指准备阶段,C是指æ��交阶段。 -¾ÍºÃ±ÈÎÒÃÇÈ¥KCCÂò±ùä¿Áܳԣ¬ÄǸպÃÓл£¬µÚ¶þ±­°ë¼Û£¬µ«ÊÇÄãÊÇÒ»¸öÈË£¬Õâ¸öʱºò¸ÕºÃÓиöС½ã½ã¹ýÀ´£¬ÕýÔÚ¿¼ÂÇÂò²»Âò±ùä¿Áܳԣ¬Õâ¸öʱºòÄãºÍËýÌá³öÁËAA£¬Ò²¾Í»á˵ֻÓе±ÄãºÍËý¶¼Í¬ÒâÂòÕâ¸öµÄʱºò£¬²ÅÄܹºÂòµ½£¬Èç¹ûÁ½¸öÈËÖÐÓÐÒ»¸ö²»Í¬ÒâÄÇô¾Í²»ÄÜÂòÕâ¸ö±ùä¿Áܳԡ£ +就好比我们去KCC买冰淇淋å�ƒï¼Œé‚£åˆšå¥½æœ‰æ´»åŠ¨ï¼Œç¬¬äºŒæ�¯å�Šä»·ï¼Œä½†æ˜¯ä½ æ˜¯ä¸€ä¸ªäººï¼Œè¿™ä¸ªæ—¶å€™åˆšå¥½æœ‰ä¸ªå°�å§�å§�过æ�¥ï¼Œæ­£åœ¨è€ƒè™‘ä¹°ä¸�买冰淇淋å�ƒï¼Œè¿™ä¸ªæ—¶å€™ä½ å’Œå¥¹æ��出了AA,也就会说å�ªæœ‰å½“你和她都å�Œæ„�买这个的时候,æ‰�能购买到,如果两个人中有一个ä¸�å�Œæ„�那么就ä¸�能买这个冰淇淋å�ƒã€‚ -**½×¶ÎÒ»£º**×¼±¸½×¶Î ÀϰåÒªÇóÄãÏȽøÐи¶¿î£¬ÄãͬÒ⸶¿îÍê³Éºó£¬ÔÙÒªÇóÅ®·½¸¶¿î£¬Å®·½Í¬Ò⸶¿îÍê³É¡£ +**阶段一:**准备阶段 è€�æ�¿è¦�求你先进行付款,你å�Œæ„�付款完æˆ�å�Žï¼Œå†�è¦�求女方付款,女方å�Œæ„�付款完æˆ�。 -**½×¶Î¶þ£º**Ìá½»½×¶Î ¶¼¸¶¿îÍê³É£¬Àϰå³ö²Í£¬Á½¸öÈ˶¼³Ôµ½±ùä¿ÁÜ¡£ +**阶段二:**æ��交阶段 都付款完æˆ�,è€�æ�¿å‡ºé¤�,两个人都å�ƒåˆ°å†°æ·‡æ·‹ã€‚ -Õâ¸öÀý×Ó¾Í×é³ÉÁËÒ»¸öÊÂÎñ¡£Èç¹ûÄÐŮ˫·½ÓÐÒ»¸öÈ˾ܾø¸¶¿î£¬ÄÇôÀϰå¾Í²»»á³ö²Í£¬²¢ÇÒ»á°ÑÒÑÊÕÈ¡µÄǮԭ·Í˻ء£ +这个例å­�就组æˆ�了一个事务。如果男女å�Œæ–¹æœ‰ä¸€ä¸ªäººæ‹’ç»�付款,那么è€�æ�¿å°±ä¸�会出é¤�,并且会把已收å�–的钱原路退回。 -Õû¸öÊÂÎñ¹ý³ÌÊÇÓÉÊÂÎñ¹ÜÀíÆ÷ºÍ²ÎÓëÕß×é³ÉµÄ£¬µêÀϰå¾ÍÊÇÊÂÎñ¹ÜÀíÆ÷£¬ÄãºÍÄǸöÅ®º¢¾ÍÊDzÎÓëÕߣ¬ÊÂÎñ¹ÜÀíÆ÷¾ö²ßÕû¸ö·Ö²¼Ê½ÊÂÎñÔÚ¼ÆËã»úÖйØÏµÊý¾ÝÖ§³ÖÁ½½×¶ÎÌύЭÒ飺 +整个事务过程是由事务管ç�†å™¨å’Œå�‚与者组æˆ�的,店è€�æ�¿å°±æ˜¯äº‹åŠ¡ç®¡ç�†å™¨ï¼Œä½ å’Œé‚£ä¸ªå¥³å­©å°±æ˜¯å�‚与者,事务管ç�†å™¨å†³ç­–整个分布å¼�事务在计算机中关系数æ�®æ”¯æŒ�两阶段æ��交å��议: -* ×¼±¸½×¶Î(Prepare phase)£ºÊÂÎñ¹ÜÀíÆ÷¸øÃ¿¸ö²ÎÓëÕß·¢ËÍPrepare ÏûÏ¢£¬Ã¿¸öÊý¾Ý¿â²ÎÓëÕßÔÚ±¾µØÖ´ÐÐÊÂÎñ£¬²¢Ð´±¾µØµÄUndo/Redo ÈÕÖ¾£¬´ËʱÊÂÎñûÓÐÌá½»¡£ +* 准备阶段(Prepare phase):事务管ç�†å™¨ç»™æ¯�个å�‚与者å�‘é€�Prepare 消æ�¯ï¼Œæ¯�个数æ�®åº“å�‚与者在本地执行事务,并写本地的Undo/Redo 日志,此时事务没有æ��交。 -> undoÈÕÖ¾ÊǼǼÐÞ¸ÄǰµÄÊý¾Ý£¬ÓÃÓÚÊý¾Ý¿â»Ø¹ö¡£ +> undo日志是记录修改å‰�的数æ�®ï¼Œç”¨äºŽæ•°æ�®åº“回滚。 > -> Redo ÈÕÖ¾ÊǼǼÐ޸ĺóµÄÊý¾Ý£¬ÓÃÓÚÌá½»ÊÂÎñдÈëÊý¾ÝÎļþ¡£ +> Redo 日志是记录修改å�Žçš„æ•°æ�®ï¼Œç”¨äºŽæ��交事务写入数æ�®æ–‡ä»¶ã€‚ -* Ìá½»½×¶Î(commit phase)£ºÈç¹ûÊÂÎñ¹ÜÀíÆ÷ÊÕµ½Á˲ÎÓëÕßµÄÖ´ÐÐʧ°Ü»òÕß³¬Ê±ÏûϢʱ£¬Ö±½Ó¸øÃ¿¸ö²ÎÓëÕß·¢ËÍ(Rollback) ÏûÏ¢£¬Èç¹ûÊÕµ½²ÎÓëÕß¶¼³É¹¦£¬·¢ËÍ(Commit) ²ÎÓëÕ߸ù¾ÝÊÂÎñ¹ÜÀíÆ÷µÄÖ¸ÁîÖ´ÐÐÌá½»»òÕ߻عö²Ù×÷£¬²¢ÊÍ·ÅÊÂÎñ´¦Àí¹ý³ÌÖÐʹÓõÄ×ÊÔ´¡£ +* æ��交阶段(commit phase):如果事务管ç�†å™¨æ”¶åˆ°äº†å�‚与者的执行失败或者超时消æ�¯æ—¶ï¼Œç›´æŽ¥ç»™æ¯�个å�‚与者å�‘é€�(Rollback) 消æ�¯ï¼Œå¦‚果收到å�‚与者都æˆ�功,å�‘é€�(Commit) å�‚与者根æ�®äº‹åŠ¡ç®¡ç�†å™¨çš„æŒ‡ä»¤æ‰§è¡Œæ��交或者回滚æ“�作,并释放事务处ç�†è¿‡ç¨‹ä¸­ä½¿ç”¨çš„资æº�。 -#### ³É¹¦Ìá½»£º +#### æˆ�功æ��交: -ÊÂÎñ¹ÜÀíÆ÷ÏòËùÓвÎÓëÕß·¢ËÍÊÂÎñÄÚÈÝ£¬Ñ¯ÎÊÊÇ·ñ×¼±¸ºÃÁË£¬µÈ´ý²ÎÓëÕßµÄÏìÓ¦£¬¸÷¸ö²ÎÓëÕßÊÂÎñ½ÚµãÖ´ÐÐÊÂÎñ²Ù×÷£¬²¢½« UndoºÍRedo ÐÅÏ¢¼ÇÈëÊÂÎñÈÕÖ¾ÖС£Èç¹û²ÎÓëÕ߳ɹ¦Ö´ÐÐÊÂÎñ²Ù×÷£¬·´À¡ÊÂÎñ¹ÜÀíÆ÷YES²Ù×÷£¬±íʾÊÂÎñ¿ÉÒÔÖ´ÐУ¬¼ÙÈçЭµ÷Õß´ÓËùÓеIJÎÓëÕß»òµÃ·´À¡¶¼ÊÇYesÏìÓ¦£¬ÄÇô¾Í»áÖ´ÐÐÊÂÎñÌá½»¡£ +事务管ç�†å™¨å�‘所有å�‚与者å�‘é€�事务内容,询问是å�¦å‡†å¤‡å¥½äº†ï¼Œç­‰å¾…å�‚与者的å“�应,å�„个å�‚与者事务节点执行事务æ“�作,并将 Undoå’ŒRedo ä¿¡æ�¯è®°å…¥äº‹åŠ¡æ—¥å¿—ä¸­ã€‚å¦‚æžœå�‚与者æˆ�功执行事务æ“�作,å��馈事务管ç�†å™¨YESæ“�作,表示事务å�¯ä»¥æ‰§è¡Œï¼Œå�‡å¦‚å��调者从所有的å�‚与者或得å��馈都是Yeså“�应,那么就会执行事务æ��交。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/48e1a2907174a1ed035541e548755d39490441.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/48e1a2907174a1ed035541e548755d39490441.png "图片") -#### ʧ°Ü£º +#### 失败: -¼ÙÈçÈκÎÒ»¸ö²ÎÓëÕßÏòÊÂÎñ¹ÜÀíÆ÷·´À¡ÁËNoÖ¸Á»òÕߵȴý³¬Ê±Ö®ºó£¬ÊÂÎñ¹ÜÀíÆ÷ÎÞ·¨½ÓÊÕµ½ËùÓвÎÓëÕߵķ´À¡ÏìÓ¦£¬ÄÇôÖжÏÊÂÎñ£¬·¢ËͻعöÇëÇó£¬ÊÂÎñ¹ÜÀíÆ÷ÏòËùÓвÎÓëÕ߽ڵ㷢ËÍ RollBack ÇëÇ󣬲ÎÓëÕß½ÓÊÕµ½ RollBack ÇëÇóºó£¬»áÀûÓÃÔÚ½×¶ÎÒ»¼Ç¼µÄUndoÐÅÏ¢Ö´ÐÐÊÂÎñµÄ»Ø¹ö²Ù×÷£¬ÔÚÍê³É»Ø¹öÖ®ºóÊÍ·ÅÊÂÎñÖ´ÐÐÆÚ¼äÕ¼ÓõÄ×ÊÔ´£¬²ÎÓëÕßÔÚÍê³ÉÊÂÎñ»Ø¹öÖ®ºó£¬ÏòЭµ÷Õß·¢ËÍACKÏûÏ¢£¬ÊÂÎñ¹ÜÀíÆ÷ÔÚ½ÓÊܵ½ËùÓвÎÓëÕß·´À¡µÄACKÏûÏ¢Ö®ºó£¬Íê³ÉÊÂÎñÖжϡ£ +å�‡å¦‚任何一个å�‚与者å�‘事务管ç�†å™¨å��馈了No指令,或者等待超时之å�Žï¼Œäº‹åŠ¡ç®¡ç�†å™¨æ— æ³•接收到所有å�‚与者的å��馈å“�应,那么中断事务,å�‘é€�回滚请求,事务管ç�†å™¨å�‘所有å�‚与者节点å�‘é€� RollBack 请求,å�‚与者接收到 RollBack 请求å�Žï¼Œä¼šåˆ©ç”¨åœ¨é˜¶æ®µä¸€è®°å½•çš„Undoä¿¡æ�¯æ‰§è¡Œäº‹åŠ¡çš„å›žæ»šæ“�作,在完æˆ�回滚之å�Žé‡Šæ”¾äº‹åŠ¡æ‰§è¡ŒæœŸé—´å� ç”¨çš„资æº�,å�‚与者在完æˆ�事务回滚之å�Žï¼Œå�‘å��调者å�‘é€�ACK消æ�¯ï¼Œäº‹åŠ¡ç®¡ç�†å™¨åœ¨æŽ¥å�—到所有å�‚与者å��馈的ACK消æ�¯ä¹‹å�Žï¼Œå®Œæˆ�事务中断。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0928e8933a69a75eff4968f6989ca78ceaeb47.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0928e8933a69a75eff4968f6989ca78ceaeb47.png "图片") -### Èý½×¶ÎÌá½»(3PC) +### 三阶段æ��交(3PC) -3PC Ö÷ÒªÊÇΪÁ˽â¾öÁ½½×¶ÎÌύЭÒéµÄµ¥µã¹ÊÕÏÎÊÌâºÍËõС²ÎÓëÕß×èÈû·¶Î§¡£ÊǶþ½×¶ÎÌá½»£¨2PC£©µÄ¸Ä½ø°æ±¾£¬ÒýÈë²ÎÓë½ÚµãµÄ³¬Ê±»úÖÆÖ®Í⣬3PC°Ñ2PCµÄ×¼±¸½×¶Î·Ö³ÉÊÂÎñѯÎÊ£¨¸Ã½×¶Î²»»á×èÈû£©ºÍÊÂÎñÔ¤Ìá½»,ÔòÈý¸ö½×¶Î·Ö±ðΪ CanCommit¡¢PreCommit¡¢DoCommit¡£ +3PC 主è¦�是为了解决两阶段æ��交å��议的å�•点故障问题和缩å°�å�‚与者阻塞范围。是二阶段æ��交(2PC)的改进版本,引入å�‚与节点的超时机制之外,3PC把2PC的准备阶段分æˆ�事务询问(该阶段ä¸�会阻塞)和事务预æ��交,则三个阶段分别为 CanCommitã€�PreCommitã€�DoCommit。 -#### CanCommit ѯÎÊ״̬ +#### CanCommit 询问状æ€� -CanCommit½×¶Î Эµ÷Õß(Coordinator)»áÏò²ÎÓëÕß(Participant) ·¢ËÍCanCommitÏûÏ¢£¬Ñ¯ÎÊÊÇ·ñ¿ÉÒÔÖ´ÐвÙ×÷£¬²ÎÓëÕßÊÕµ½ÏûÏ¢ºó£¬±íʾÄܹ»Ö´ÐУ¬»á·µ»Ø¸øÐ­µ÷ÕßÄܹ»Ö´ÐеÄ(yes)ÃüÁî¡£ +CanCommit阶段 å��调者(Coordinator)会å�‘å�‚与者(Participant) å�‘é€�CanCommit消æ�¯ï¼Œè¯¢é—®æ˜¯å�¦å�¯ä»¥æ‰§è¡Œæ“�作,å�‚与者收到消æ�¯å�Žï¼Œè¡¨ç¤ºèƒ½å¤Ÿæ‰§è¡Œï¼Œä¼šè¿”回给å��调者能够执行的(yes)命令。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c9cc9e8959b9a5393cb59672bc05a9121825ff.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c9cc9e8959b9a5393cb59672bc05a9121825ff.png "图片") -Èç¹û²ÎÓëÕß²»ÄÜÖ´ÐУ¬»á·µ»ØNoÃüÁî,ÊÍ·Å×ÊÔ´£¬½áÊøÊÂÎñ¡£ +如果å�‚与者ä¸�能执行,会返回No命令,释放资æº�,结æ�Ÿäº‹åŠ¡ã€‚ -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/61bf61d800a42fb1583689ccbc1b1e862fec29.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/61bf61d800a42fb1583689ccbc1b1e862fec29.png "图片") -#### PreCommit Ô¤Ìá½» +#### PreCommit 预æ��交 -PreCommit ½×¶ÎÈç¹ûЭµ÷ÕßÊÕµ½²ÎÓëÕß·µ»ØµÄ״ֵ̬ΪYES£¬ÄÇô¾ÍÖ¤Ã÷ËüÃǶ¼ÓÐÄÜÁ¦È¥Ö´ÐÐÕâ¸ö²Ù×÷£¬ÄÇôЭµ÷Õ߾ͻáÏòËùÓвÎÓëÕß ·¢ËÍ PreCommit ÏûÏ¢£¬Ð­µ÷ÕßÊÕµ½ PreCommitÏûÏ¢ºó£¬»ØÈ¥Ö´Ðб¾µØÊÂÎñ£¬Èç¹ûÖ´Ðгɹ¦»á½«±¾µØÊÂÎñ±£´æµ½ undoºÍredo ºó£¬ÔÙ·µ»Ø¸øÐ­µ÷ÕßYESÖ¸ÁÈç¹ûÖ´Ðб¾µØÊÂÎñʧ°Ü£¬·µ»ØÐ­µ÷ÕßNo,ֻҪЭµ÷ÕßÊÕµ½Ò»¸öÖ´ÐÐʧ°Ü£¬¸øËùÓвÎÓëÕß·¢ËÍÖжÏÊÂÎñÏûÏ¢£¬²ÎÓëÕßÊÕµ½ÏûÏ¢ºó£¬¶ÔÊÂÎñ½øÐлعö²Ù×÷¡£ +PreCommit 阶段如果å��调者收到å�‚与者返回的状æ€�值为YES,那么就è¯�明它们都有能力去执行这个æ“�作,那么å��调者就会å�‘所有å�‚与者 å�‘é€� PreCommit 消æ�¯ï¼Œå��调者收到 PreCommit消æ�¯å�Žï¼Œå›žåŽ»æ‰§è¡Œæœ¬åœ°äº‹åŠ¡ï¼Œå¦‚æžœæ‰§è¡Œæˆ�功会将本地事务ä¿�存到 undoå’Œredo å�Žï¼Œå†�返回给å��调者YES指令,如果执行本地事务失败,返回å��调者No,å�ªè¦�å��调者收到一个执行失败,给所有å�‚与者å�‘é€�中断事务消æ�¯ï¼Œå�‚与者收到消æ�¯å�Žï¼Œå¯¹äº‹åŠ¡è¿›è¡Œå›žæ»šæ“�作。 -ÔÚÕâ¸ö½×¶Î²ÎÓëÕߺÍЭµ÷Õß¶¼ÒýÈëÁ˳¬Ê±»úÖÆ£¬Èç¹û²ÎÓëÕßûÓÐÊÕµ½£¬Ð­µ÷ÕßµÄÏûÏ¢£¬»òÕßЭµ÷ÕßûÓÐÊÕµ½²ÎÓëÕß·µ»ØµÄÔ¤Ö´Ðнá¹û״̬£¬Ôڵȴý³¬Ê±Ö®ºó£¬ÊÂÎñ»áÖжϣ¬±ÜÃâÁËÊÂÎñµÄ×èÈû¡£ +在这个阶段å�‚与者和å��调者都引入了超时机制,如果å�‚与者没有收到,å��调者的消æ�¯ï¼Œæˆ–者å��调者没有收到å�‚与者返回的预执行结果状æ€�,在等待超时之å�Žï¼Œäº‹åŠ¡ä¼šä¸­æ–­ï¼Œé�¿å…�了事务的阻塞。 -Эµ÷ÕßÏò²ÎÓëÕß·¢ËÍPreCommit£¬Èç¹û²ÎÓëÕßÖ´Ðгɹ¦£¬·µ»Øyes![ͼƬ](https://s2.51cto.com/oss/202206/18/91b004f982c531b8a641821cf1a49be547f9b3.gif "ͼƬ")¡£ +å��调者å�‘å�‚与者å�‘é€�PreCommit,如果å�‚与者执行æˆ�功,返回yes![图片](https://s2.51cto.com/oss/202206/18/91b004f982c531b8a641821cf1a49be547f9b3.gif "图片")。 -Èç¹û²ÎÓëÕßÖ´ÐÐʧ°Ü£¬Ö»ÓÐÓÐÒ»¸ö·µ»ØNoµ½Ð­µ÷Õߣ¬Ð­µ÷Õß»áÏò²ÎÓëÕß·¢ËÍÖжÏÊÂÎñµÄÏûÏ¢£¬²ÎÓëÕ߻عöÊÂÎñ¡£ +如果å�‚与者执行失败,å�ªæœ‰æœ‰ä¸€ä¸ªè¿”回No到å��调者,å��调者会å�‘å�‚与者å�‘é€�中断事务的消æ�¯ï¼Œå�‚与者回滚事务。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/996ca048361577f6ba066998a6b3ed9ac0450b.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/996ca048361577f6ba066998a6b3ed9ac0450b.png "图片") -#### DoCommit Ìá½» +#### DoCommit æ��交 -Эµ÷ÕßÊÕµ½ËùÓвÎÓëÕß·µ»ØµÄ״̬¶¼ÊÇYES£¬ÕâʱЭµ÷Õß»áÏòËùÓеIJÎÓëÕß¶¼·¢ËÍ DoCommit £¬²ÎÓëÕßÊÕµ½ DoCommit ºó£¬»áÕæÕýµÄÌá½»ÊÂÎñ£¬µ±ÊÂÎñÌá½»³É¹¦ºó£¬·µ»ØÐ­µ÷ÕßYES״̬£¬±íʾÎÒÒѾ­Íê³ÉÊÂÎñµÄÌá½»ÁË£¬Ð­µ÷ÕßÊÕµ½ËùÓвÎÓëÕß¶¼·µ»ØYES״̬ºó£¬ÄÇô¾ÍÍê³ÉÁ˱¾´ÎÊÂÎñ¡£ +å��调者收到所有å�‚与者返回的状æ€�都是YES,这时å��调者会å�‘所有的å�‚与者都å�‘é€� DoCommit ,å�‚与者收到 DoCommit å�Žï¼Œä¼šçœŸæ­£çš„æ��交事务,当事务æ��交æˆ�功å�Žï¼Œè¿”回å��调者YES状æ€�,表示我已ç»�完æˆ�事务的æ��交了,å��调者收到所有å�‚与者都返回YES状æ€�å�Žï¼Œé‚£ä¹ˆå°±å®Œæˆ�了本次事务。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f4ab1eb14668202d8be313dc1b754833689c37.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f4ab1eb14668202d8be313dc1b754833689c37.png "图片") -Èç¹ûij¸ö²ÎÓëÕß·µ»ØNoÏûÏ¢£¬Ð­µ÷Õß·¢ËÍÖжÏÊÂÎñÏûÏ¢(abort)£¬¸ø²ÎÓëÕßÃÇ£¬²ÎÓëÕ߻عöÊÂÎñ¡£ +如果æŸ�个å�‚与者返回No消æ�¯ï¼Œå��调者å�‘é€�中断事务消æ�¯(abort),给å�‚与者们,å�‚与者回滚事务。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/42ab62f59f9e71c66f7213a6833c2c7e436193.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/42ab62f59f9e71c66f7213a6833c2c7e436193.png "图片") -3PCÊÇ2PCµÄÉý¼¶°æ£¬ÒýÈëÁ˳¬Ê±»úÖÆ£¬½â¾öÁ˵¥µã¹ÊÕÏÒýÆðµÄÊÂÎñ×èÈûÎÊÌ⣬µ«ÊÇ3PCÒÀÈ»²»Äܽâ¾öÊÂÎñÒ»ÖÂÐÔµÄÎÊÌ⣬ÒòΪÔÚDoCommit½×¶Î£¬Èç¹ûÓÉÓÚÍøÂç»òÕß³¬Ê±µÈÔ­Ôòµ¼Ö²ÎÓëÕßÊÕ²»µ½Ð­µ÷Õß·¢Ë͹ýÀ´µÄ ÖжÏÊÂÎñÏûÏ¢(abort) £¬¹ýÁËÕâ¸öʱ¼äºó£¬²ÎÓëÕß»áÌá½»ÊÂÎñ£¬±¾À´ÊÇÓ¦¸Ã½øÐлعö£¬Ìá½»ÊÂÎñºó£¬»áµ¼ÖÂÊý¾Ý²»Ò»ÖµÄÎÊÌâ³öÏÖ£¬2PCËäÈ»ÔÚÍøÂç¹ÊÕÏÇé¿öÏ´æÔÚǿһÖÂÐÔ±»ÆÆ»µµÄÎÊÌ⣬µ«ÊǹÊÕϻָ´ÒÔºóÄܱ£Ö¤×îÖÕÒ»ÖÂÐÔ£¬3PCËäÈ»Óг¬Ê±Ê±¼ä£¬½â¾öÁË×èÈû£¬Ìá¸ßÁË¿ÉÓÃÐÔ£¬µ«ÊÇÎþÉüÁËÒ»ÖÂÐÔ£¬Èç¹ûÕë¶ÔÍøÂ粨¶¯ÎÊÌâµ¼ÖÂÊý¾ÝÎÊÌâÕâÒ»µãÉÏ£¬2PCÊÇÓÅÓÚ3PCµÄ¡£ +3PC是2PCçš„å�‡çº§ç‰ˆï¼Œå¼•入了超时机制,解决了å�•点故障引起的事务阻塞问题,但是3PCä¾�ç„¶ä¸�能解决事务一致性的问题,因为在DoCommit阶段,如果由于网络或者超时等原则导致å�‚与者收ä¸�到å��调者å�‘é€�过æ�¥çš„ 中断事务消æ�¯(abort) ,过了这个时间å�Žï¼Œå�‚与者会æ��交事务,本æ�¥æ˜¯åº”该进行回滚,æ��交事务å�Žï¼Œä¼šå¯¼è‡´æ•°æ�®ä¸�一致的问题出现,2PC虽然在网络故障情况下存在强一致性被破å��的问题,但是故障æ�¢å¤�以å�Žèƒ½ä¿�è¯�最终一致性,3PC虽然有超时时间,解决了阻塞,æ��高了å�¯ç”¨æ€§ï¼Œä½†æ˜¯ç‰ºç‰²äº†ä¸€è‡´æ€§ï¼Œå¦‚果针对网络波动问题导致数æ�®é—®é¢˜è¿™ä¸€ç‚¹ä¸Šï¼Œ2PC是优于3PC的。 ## Seata -¹ÙÍø£ºhttps://seata.io/zh-cn/docs/overview/what-is-seata.html¡£ +官网:https://seata.io/zh-cn/docs/overview/what-is-seata.html。 -Seata ÊÇÒ»¿î¿ªÔ´µÄ·Ö²¼Ê½ÊÂÎñ½â¾ö·½°¸£¬ÖÂÁ¦ÓÚÌṩ¸ßÐÔÄܺͼòµ¥Ò×Óõķֲ¼Ê½ÊÂÎñ·þÎñ¡£Seata ½«ÎªÓû§ÌṩÁË AT¡¢TCC¡¢SAGA ºÍ XA ÊÂÎñģʽ£¬ÎªÓû§´òÔìһվʽµÄ·Ö²¼Ê½½â¾ö·½°¸¡£ +Seata 是一款开æº�的分布å¼�事务解决方案,致力于æ��供高性能和简å�•易用的分布å¼�事务æœ�务。Seata 将为用户æ��供了 ATã€�TCCã€�SAGA å’Œ XA 事务模å¼�,为用户打造一站å¼�的分布å¼�解决方案。 -![ͼƬ](https://s6.51cto.com/oss/202206/18/22906d30493df9861728958921200a254ef5d5.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e335a42151fa17eb25e848defd449317e036d3.png "ͼƬ") +![图片](https://s6.51cto.com/oss/202206/18/22906d30493df9861728958921200a254ef5d5.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e335a42151fa17eb25e848defd449317e036d3.png "图片") -ÔÚ΢·þÎñϵͳÖУ¬Ò»°ãÒµÎñ»á±»²ð·Ö³É¶ÀÁ¢µÄÄ£¿é£¬ÔÚ¹Ù·½ÌṩµÄ½á¹¹Í¼ÖУ¬ÎÒÃÇ¿ÉÒÔ¿´µ½µ±Ç°Ö÷Òª·ÖΪÈý¸öÄ£¿é¡£ +在微æœ�务系统中,一般业务会被拆分æˆ�独立的模å�—,在官方æ��供的结构图中,我们å�¯ä»¥çœ‹åˆ°å½“å‰�主è¦�分为三个模å�—。 -* ¿â´æ·þÎñ£º¶ÔÓÚÉÌÆ·¿â´æÐÅÏ¢½øÐÐÔö¼Ó»òÕß¼õÉÙ²Ù×÷¡£ -* ¶©µ¥·þÎñ£º¸ù¾ÝÓû§Ö¸¶¨ÉÌÆ·Éú³É¶©µ¥¡£ -* ÕË»§·þÎñ£º´ÓÓû§ÕË»§Öп۳ýÓà¶î£¬Ôö¼Ó»ý·Ö£¬Î¬»¤µØÖ·ÐÅÏ¢µÈµÈ¡£ +* 库存æœ�务:对于商å“�库存信æ�¯è¿›è¡Œå¢žåŠ æˆ–è€…å‡�å°‘æ“�作。 +* 订å�•æœ�务:根æ�®ç”¨æˆ·æŒ‡å®šå•†å“�生æˆ�订å�•。 +* 账户æœ�务:从用户账户中扣除余é¢�,增加积分,维护地å�€ä¿¡æ�¯ç­‰ç­‰ã€‚ -ÔÚµ±Ç°¼Ü¹¹ÖУ¬Óû§ÌôÑ¡ÐÄÒǵÄÉÌÆ·Ïµ¥ºó£¬ÐèÒªÈý¸ö·þÎñÀ´Íê³É²Ù×÷£¬Ã¿Ò»¸ö·þÎñµÄÄÚ²¿¶¼ÓµÓÐÒ»¸ö¶ÀÁ¢µÄ±¾µØÊÂÎñÀ´±£Ö¤µ±Ç°·þÎñÊý¾ÝµÄǿһÖÂÐÔ£¬µ«ÊÇÈý¸ö·þÎñ×é³ÉµÄÈ«¾ÖÊÂÎñÒ»ÖÂÐÔ¾Íû°ì·¨½øÐб£Ö¤£¬ÄÇôSeata¾ÍÊÇÀ´½â¾öÕâ¸öÎÊÌâµÄ¡£ +在当å‰�架构中,用户挑选心仪的商å“�下å�•å�Žï¼Œéœ€è¦�三个æœ�务æ�¥å®Œæˆ�æ“�作,æ¯�一个æœ�务的内部都拥有一个独立的本地事务æ�¥ä¿�è¯�当å‰�æœ�务数æ�®çš„强一致性,但是三个æœ�务组æˆ�的全局事务一致性就没办法进行ä¿�è¯�,那么Seata就是æ�¥è§£å†³è¿™ä¸ªé—®é¢˜çš„。 -### SeataÊõÓï +### Seata术语 -¹ÙÍøµØÖ·£ºhttps://seata.io/zh-cn/docs/overview/terminology.html¡£ +官网地å�€ï¼šhttps://seata.io/zh-cn/docs/overview/terminology.html。 -ÔÚÁ˽âSeata֮ǰ£¬ÎÒÃÇÏÈÀ´Á˽âһϠSeata ¼¸¸ö¹Ø¼üµÄ¸ÅÄ +在了解Seata之å‰�,我们先æ�¥äº†è§£ä¸€ä¸‹ Seata 几个关键的概念: -1. TC(Transaction Coordinator)ÊÂÎñЭµ÷ÕߣºÎ¬»¤È«¾ÖºÍ·ÖÖ§ÊÂÎñµÄ״̬£¬Çý¶¯È«¾ÖÊÂÎñÌá½»»òÕ߻عö¡£ -2. TM(Transaction Manager) ÊÂÎñ¹ÜÀíÕߣº ·¢ÆðÕߣ¬Í¬Ê±Ò»¸öRMµÄÒ»ÖÖ£¬¶¨ÒåÈ«¾ÖÊÂÎñµÄ·¶Î§£¬¿ªÊ¼È«¾ÖÊÂÎñ£¬Ìá½»»ò»Ø¹öÈ«¾ÖÊÂÎñ¡£ -3. RM(Resource Manager) ×ÊÔ´¹ÜÀíÆ÷£º ²ÎÓëÊÂÎñµÄ΢·þÎñ£¬¹ÜÀí·ÖÖ§ÊÂÎñ´¦ÀíµÄ×ÊÔ´£¬ÓëTC½»Ì¸ÒÔ×¢²á·ÖÖ§ÊÂÎñºÍ±¨¸æ·ÖÖ§ÊÂÎñµÄ״̬£¬²¢Çý¶¯·ÖÖ§ÊÂÎñÌá½»»ò»Ø¹ö¡£ +1. TC(Transaction Coordinator)事务å��调者:维护全局和分支事务的状æ€�,驱动全局事务æ��交或者回滚。 +2. TM(Transaction Manager) 事务管ç�†è€…: å�‘起者,å�Œæ—¶ä¸€ä¸ªRM的一ç§�,定义全局事务的范围,开始全局事务,æ��交或回滚全局事务。 +3. RM(Resource Manager) 资æº�管ç�†å™¨ï¼š å�‚与事务的微æœ�务,管ç�†åˆ†æ”¯äº‹åС处ç�†çš„资æº�,与TC交谈以注册分支事务和报告分支事务的状æ€�,并驱动分支事务æ��交或回滚。 ### Seata 2PC -**Ò»½×¶Î£º** ÒµÎñÊý¾ÝºÍ»Ø¹öÈÕÖ¾¼Ç¼ÔÚͬһ¸ö±¾µØÊÂÎñÖÐÌá½»£¬Êͷű¾µØËøºÍÁ¬½Ó×ÊÔ´¡£ +**一阶段:** 业务数æ�®å’Œå›žæ»šæ—¥å¿—记录在å�Œä¸€ä¸ªæœ¬åœ°äº‹åС䏭æ��交,释放本地é”�和连接资æº�。 -**¶þ½×¶Î£º** Ìá½»Òì²½»¯£¬·Ç³£¿ìËÙµØÍê³É¡£»Ø¹öͨ¹ýÒ»½×¶ÎµÄ»Ø¹öÈÕÖ¾½øÐз´Ïò²¹³¥¡£ +**二阶段:** æ��交异步化,é�žå¸¸å¿«é€Ÿåœ°å®Œæˆ�。回滚通过一阶段的回滚日志进行å��å�‘è¡¥å�¿ã€‚ -Ò»½×¶Î±¾µØÊÂÎñÌύǰ£¬ÐèҪȷ±£ÏÈÄõ½ È«¾ÖËø ¡£Äò»µ½È«¾ÖËø £¬²»ÄÜÌá½»±¾µØÊÂÎñ¡£ÄÃÈ«¾ÖËøµÄ³¢ÊÔ±»ÏÞÖÆÔÚÒ»¶¨·¶Î§ÄÚ£¬³¬³ö·¶Î§½«·ÅÆú£¬²¢»Ø¹ö±¾µØÊÂÎñ£¬Êͷű¾µØËø¡£ +一阶段本地事务æ��交å‰�,需è¦�ç¡®ä¿�先拿到 全局é”� 。拿ä¸�到全局é”� ,ä¸�能æ��交本地事务。拿全局é”�çš„å°�试被é™�制在一定范围内,超出范围将放弃,并回滚本地事务,释放本地é”�。 -ÔÚÊý¾Ý¿â±¾µØÊÂÎñ¸ôÀë¼¶±ð¶ÁÒÑÌá½»»òÒÔÉϵĻù´¡ÉÏ£¬Seata£¨AT ģʽ£©µÄĬÈÏÈ«¾Ö¸ôÀë¼¶±ðÊÇ ¶ÁδÌá½»¡£ +在数æ�®åº“本地事务隔离级别读已æ��交或以上的基础上,Seata(AT 模å¼�)的默认全局隔离级别是 读未æ��交。 -Èç¹ûÓ¦ÓÃÔÚÌØ¶¨³¡¾°Ï£¬±ØÐèÒªÇóÈ«¾ÖµÄ ¶ÁÒÑÌá½» £¬Ä¿Ç° Seata µÄ·½Ê½ÊÇͨ¹ý SELECT FOR UPDATE Óï¾äµÄ´úÀí¡£ +如果应用在特定场景下,必需è¦�求全局的 读已æ��交 ,目å‰� Seata 的方å¼�是通过 SELECT FOR UPDATE 语å�¥çš„代ç�†ã€‚ -SeataÖ´ÐÐÁ÷³Ì·ÖÎö£º +Seata执行æµ�程分æž�: -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c7e10e315ebb9d8effa798730cebde46ec741a.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c7e10e315ebb9d8effa798730cebde46ec741a.png "图片") -ÿ¸öRM ʹÓà DataSourceProxy Á´½ÓÊý¾Ý·£¬Ä¿µÄÊÇʹÓà ConnectionProxy £¬Ê¹ÓÃÊý¾ÝÔ´ºÍÊý¾Ý´úÀíµÄÄ¿µÄÊÇÔÚµÚÒ»½×¶Î½« undoºÍÒµÎñÊý¾Ý·ÅÔÚÒ»¸ö±¾µØÊÂÎñÖÐÌá½»£¬ÕâÑù¾Í±£´æÁËÖ»ÒªÓÐÒµÎñ²Ù×÷¾ÍÒ»¶¨»áÓÐdudoÈÕÖ¾¡£ +æ¯�个RM 使用 DataSourceProxy 链接数æ�®è·¯ï¼Œç›®çš„æ˜¯ä½¿ç”¨ ConnectionProxy ,使用数æ�®æº�和数æ�®ä»£ç�†çš„目的是在第一阶段将 undo和业务数æ�®æ”¾åœ¨ä¸€ä¸ªæœ¬åœ°äº‹åС䏭æ��交,这样就ä¿�存了å�ªè¦�有业务æ“�作就一定会有dudo日志。 -ÔÚµÚÒ»½×¶ÎÖУ¬undo´æ·ÅÁËÊý¾ÝÐÞ¸ÄǰºóÐ޸ĵÄÖµ£¬ÊÇΪÁËÊÂÎñ»Ø¹ö×öºÃ×¼±¸£¬ÔÚµÚÒ»½×¶ÎÍê³É¾ÍÒѾ­½«·ÖÖ§ÊÂÎñÌá½»ÁË£¬Ò²¾ÍÊÍ·ÅÁËËø×ÊÔ´¡£ +在第一阶段中,undo存放了数æ�®ä¿®æ”¹å‰�å�Žä¿®æ”¹çš„值,是为了事务回滚å�šå¥½å‡†å¤‡ï¼Œåœ¨ç¬¬ä¸€é˜¶æ®µå®Œæˆ�就已ç»�将分支事务æ��交了,也就释放了é”�资æº�。 -TM¿ªÆôÈ«¾ÖÊÂÎñ¿ªÊ¼£¬½«XIDÈ«¾ÖÊÂÎñID·ÅÔÚÊÂÎñÉÏÏÂÎÄÖУ¬Í¨¹ýfeignµ÷Óý«XID´«ÈëÏÂÓηþÎñÆ÷ÖУ¬Ã¿¸ö·ÖÖ§ÊÂÎñ½«×Ô¼ºµÄ Branch ID·ÖÖ§ÊÂÎñIDºÍXID½øÐйØÁª¡£ +TMå¼€å�¯å…¨å±€äº‹åŠ¡å¼€å§‹ï¼Œå°†XID全局事务ID放在事务上下文中,通过feign调用将XID传入下游æœ�务器中,æ¯�个分支事务将自己的 Branch ID分支事务IDå’ŒXID进行关è�”。 -ÔÚµÚ¶þ½×¶ÎÈ«¾ÖÊÂÎñÌá½»£¬TC»á֪ͨ¸÷¸ö·ÖÖ§²ÎÓëÕßÌá½»·ÖÖ§ÊÂÎñ£¬ÔÚµÚÒ»½×¶ÎÒѾ­Ìá½»ÁË·ÖÖ§ÊÂÎñ£¬ÔÚÕâÀï¸÷²ÎÓëÕßÖ»ÐèҪɾ³ýundo¼´¿É£¬²¢ÇÒ¿ÉÒÔÒì²½Ö´ÐС£ +在第二阶段全局事务æ��交,TC会通知å�„个分支å�‚与者æ��交分支事务,在第一阶段已ç»�æ��交了分支事务,在这里å�„å�‚与者å�ªéœ€è¦�删除undoå�³å�¯ï¼Œå¹¶ä¸”å�¯ä»¥å¼‚步执行。 -Èç¹ûijһ¸ö·ÖÖ§ÊÂÎñÒì³£ÁË£¬µÚ¶þ½×¶ÎÈ«¾ÖÊÂÎñ»Ø¹ö²Ù×÷£¬TC»á֪ͨ¸÷¸ö·ÖÖ§²ÎÓëÕ߻عö·ÖÖ§ÊÂÎñ£¬Í¨¹ýXIDºÍBranch-IDÕÒµ½¶ÔÓ¦µÄ»Ø¹öÈÕÖ¾£¬Í¨¹ý»Ø¹öÈÕÖ¾Éú³ÉµÄ·´ÏòSQLÖ´ÐУ¬Íê³É·ÖÖ§ÊÂÎñ»Ø¹öµ½Ö®Ç°µÄ״̬¡£ +如果æŸ�一个分支事务异常了,第二阶段全局事务回滚æ“�作,TC会通知å�„个分支å�‚与者回滚分支事务,通过XIDå’ŒBranch-ID找到对应的回滚日志,通过回滚日志生æˆ�çš„å��å�‘SQL执行,完æˆ�分支事务回滚到之å‰�的状æ€�。 -### Seata ÏÂÔØ°²×° +### Seata 下载安装 -ÏÂÔØµØÖ·£ºhttps://github.com/seata/seata/releases¡£ +下载地å�€ï¼šhttps://github.com/seata/seata/releases。 -![ͼƬ](https://s7.51cto.com/oss/202206/18/97b6c0b520c17b43b883003d10ef8e22d933a2.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/019d53972f031fdf1767425abf92f907f0f1c8.png "ͼƬ") +![图片](https://s7.51cto.com/oss/202206/18/97b6c0b520c17b43b883003d10ef8e22d933a2.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/019d53972f031fdf1767425abf92f907f0f1c8.png "图片") -½âѹºóÕÒµ½confĿ¼¡£ +解压å�Žæ‰¾åˆ°conf目录。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/88a3fa94605fb2567a64954540711876f4a6df.png "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/6998821822b0d8ed7a44318b8b3390bc421303.png "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d157544494550bb1c865815e31ae990fbac40b.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/88a3fa94605fb2567a64954540711876f4a6df.png "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/6998821822b0d8ed7a44318b8b3390bc421303.png "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d157544494550bb1c865815e31ae990fbac40b.png "图片") -ÎÒÃÇÔÚÆô¶¯seata֮ǰ£¬Ê×ÏÈÒªÆô¶¯nacos£¬ÆäʵҲºÜ¼òµ¥£¬Ö»ÐèÒªÏÂÔØnacosºóÆô¶¯¾ÍÐУ¬²»ÖªµÀnacosÔõô²Ù×÷µÄ¿´ÕâÀïµÄ½éÉÜnacos»ù´¡½éÉÜ£¬Æô¶¯ºÃÖ®ºó£¬ÎÒÃÇÔÙÀ´Æô¶¯seata£¬binĿ¼ÏÂseata-server.bat![ͼƬ](https://s5.51cto.com/oss/202206/18/b8605b968056145dc6c740b5c95f346a98eaae.gif "ͼƬ")¡£ +我们在å�¯åЍseata之å‰�,首先è¦�å�¯åЍnacos,其实也很简å�•,å�ªéœ€è¦�下载nacoså�Žå�¯åŠ¨å°±è¡Œï¼Œä¸�知é�“nacos怎么æ“�作的看这里的介ç»�nacos基础介ç»�,å�¯åЍ好之å�Žï¼Œæˆ‘们å†�æ�¥å�¯åЍseata,bin目录下seata-server.bat![图片](https://s5.51cto.com/oss/202206/18/b8605b968056145dc6c740b5c95f346a98eaae.gif "图片")。 -Èç¹ûÎÒÃÇ¿´µ½8091¶Ë¿ÚÔÚ¼àÌý£¬²¢ÇÒÔÚnacos¿´µ½·þÎñ×¢²áÉÏÈ¥ÁË£¬¾Í±íʾÎÒÃÇseataÆô¶¯³É¹¦ÁË¡£ +如果我们看到8091端å�£åœ¨ç›‘å�¬ï¼Œå¹¶ä¸”在nacos看到æœ�务注册上去了,就表示我们seataå�¯åЍæˆ�功了。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/96829da176e4fcca80a0230d5c14b601ac549b.png "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c253ebd69820f7d2daa259c97f27cdc70fd160.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/96829da176e4fcca80a0230d5c14b601ac549b.png "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c253ebd69820f7d2daa259c97f27cdc70fd160.png "图片") -## ×ܽá +## 总结 -µ½ÕâÀïÎÒÃǹØÓÚ·Ö²¼Ê½ÊÂÎñµÄºÍseataµÄ½éÉܾͽ²ÍêÁË£¬Æäʵ¹ØÓÚ·Ö²¼Ê½»¹ÓÐMQʵÏÖ¿É¿¿ÏûÏ¢×îÖÕÒ»ÖÂÐÔ£¬MQÖ÷Òª½â¾öÁËÁ½¸ö¹¦ÄÜ£º±¾µØÊÂÎñÓëÏûÏ¢·¢Ë͵ÄÔ­×ÓÐÔÎÊÌâ¡£ÊÂÎñ²ÎÓë·½½ÓÊÕÏûÏ¢µÄ¿É¿¿ÐÔ¡£ +到这里我们关于分布å¼�事务的和seata的介ç»�就讲完了,其实关于分布å¼�还有MQ实现å�¯é� æ¶ˆæ�¯æœ€ç»ˆä¸€è‡´æ€§ï¼ŒMQ主è¦�解决了两个功能:本地事务与消æ�¯å�‘é€�的原å­�性问题。事务å�‚与方接收消æ�¯çš„å�¯é� æ€§ã€‚ -## ǰÑÔ +## å‰�言 -ÔÚÉÏÒ»½ÚÖÐÎÒÃǽ²½âÁË£¬¹ØÓÚ·Ö²¼Ê½ÊÂÎñºÍseataµÄ»ù±¾½éÉܺÍʹÓ㬸ÐÐËȤµÄС»ï°é¿ÉÒԻعËÒ»ÏÂ[¡¶±ðÔÙ˵Äã²»ÖªµÀ·Ö²¼Ê½ÊÂÎñÁË!¡·](https://developer.51cto.com/article/711909.html) ×îºóСũҲ˵ÁË£¬ÏÂÆÚ»á´ø¸ø´ó¼Ò¹ØÓÚSeataÖйØÓÚseataÖÐAT¡¢TCC¡¢SAGA ºÍ XA ģʽµÄ½éÉܺÍʹÓ㬽ñÌì¾ÍÀ´½²½â¹ØÓÚSeataÖзֲ¼Ê½ËÄÖÖÄ£Ð͵ĽéÉÜ¡£ +在上一节中我们讲解了,关于分布å¼�事务和seata的基本介ç»�和使用,感兴趣的å°�伙伴å�¯ä»¥å›žé¡¾ä¸€ä¸‹[《别å†�说你ä¸�知é�“分布å¼�事务了!》](https://developer.51cto.com/article/711909.html) 最å�Žå°�农也说了,下期会带给大家关于Seata中关于seata中ATã€�TCCã€�SAGA å’Œ XA 模å¼�的介ç»�和使用,今天就æ�¥è®²è§£å…³äºŽSeata中分布å¼�å››ç§�模型的介ç»�。 -Seata·ÖΪÈý´óÄ£¿é£¬·Ö±ðÊÇ TM¡¢RM ºÍ TC¡£ +Seata分为三大模å�—,分别是 TMã€�RM å’Œ TC。 -**TC (Transaction Coordinator) - ÊÂÎñЭµ÷Õߣº**ά»¤È«¾ÖºÍ·ÖÖ§ÊÂÎñµÄ״̬£¬Çý¶¯È«¾ÖÊÂÎñÌá½»»ò»Ø¹ö¡£ +**TC (Transaction Coordinator) - 事务å��调者:**维护全局和分支事务的状æ€�,驱动全局事务æ��交或回滚。 -**TM (Transaction Manager) - ÊÂÎñ¹ÜÀíÆ÷£º**¶¨ÒåÈ«¾ÖÊÂÎñµÄ·¶Î§£º¿ªÊ¼È«¾ÖÊÂÎñ¡¢Ìá½»»ò»Ø¹öÈ«¾ÖÊÂÎñ¡£ +**TM (Transaction Manager) - 事务管ç�†å™¨ï¼š**定义全局事务的范围:开始全局事务ã€�æ��交或回滚全局事务。 -**RM (Resource Manager) - ×ÊÔ´¹ÜÀíÆ÷£º**¹ÜÀí·ÖÖ§ÊÂÎñ´¦ÀíµÄ×ÊÔ´£¬ÓëTC½»Ì¸ÒÔ×¢²á·ÖÖ§ÊÂÎñºÍ±¨¸æ·ÖÖ§ÊÂÎñµÄ״̬£¬²¢Çý¶¯·ÖÖ§ÊÂÎñÌá½»»ò»Ø¹ö¡£ +**RM (Resource Manager) - 资æº�管ç�†å™¨ï¼š**管ç�†åˆ†æ”¯äº‹åС处ç�†çš„资æº�,与TC交谈以注册分支事务和报告分支事务的状æ€�,并驱动分支事务æ��交或回滚。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c1ba09f1965be00dd7b817c1942fccfa2d7d25.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c1ba09f1965be00dd7b817c1942fccfa2d7d25.png "图片") -ÔÚ Seata ÖУ¬·Ö²¼Ê½ÊÂÎñµÄÖ´ÐÐÁ÷³Ì£º +在 Seata 中,分布å¼�事务的执行æµ�程: -* TM ¿ªÆô·Ö²¼Ê½ÊÂÎñ£¨TM Ïò TC ×¢²áÈ«¾ÖÊÂÎñ¼Ç¼£©¡£ -* °´ÒµÎñ³¡¾°£¬±àÅÅÊý¾Ý¿â¡¢·þÎñµÈÊÂÎñÄÚ×ÊÔ´£¨RM Ïò TC »ã±¨×ÊÔ´×¼±¸×´Ì¬ £©¡£ -* TM ½áÊø·Ö²¼Ê½ÊÂÎñ£¬ÊÂÎñÒ»½×¶Î½áÊø£¨TM ֪ͨ TC Ìá½»/»Ø¹ö·Ö²¼Ê½ÊÂÎñ£©¡£ -* TC »ã×ÜÊÂÎñÐÅÏ¢£¬¾ö¶¨·Ö²¼Ê½ÊÂÎñÊÇÌá½»»¹Êǻعö¡£ -* TC ֪ͨËùÓÐ RM Ìá½»/»Ø¹ö ×ÊÔ´£¬ÊÂÎñ¶þ½×¶Î½áÊø¡£ +* TM å¼€å�¯åˆ†å¸ƒå¼�事务(TM å�‘ TC 注册全局事务记录)。 +* 按业务场景,编排数æ�®åº“ã€�æœ�务等事务内资æº�(RM å�‘ TC 汇报资æº�准备状æ€� )。 +* TM 结æ�Ÿåˆ†å¸ƒå¼�事务,事务一阶段结æ�Ÿï¼ˆTM 通知 TC æ��交/回滚分布å¼�事务)。 +* TC 汇总事务信æ�¯ï¼Œå†³å®šåˆ†å¸ƒå¼�事务是æ��交还是回滚。 +* TC 通知所有 RM æ��交/回滚 资æº�,事务二阶段结æ�Ÿã€‚ -TM ºÍ RM ÊÇ×÷Ϊ Seata µÄ¿Í»§¶ËÓëÒµÎñϵͳ¼¯³ÉÔÚÒ»Æð£¬TC ×÷Ϊ Seata µÄ·þÎñ¶Ë¶ÀÁ¢²¿Êð¡£ +TM å’Œ RM 是作为 Seata 的客户端与业务系统集æˆ�在一起,TC 作为 Seata çš„æœ�务端独立部署。 -·þÎñ¶Ë´æ´¢Ä£Ê½Ö§³ÖÈýÖÖ£º +æœ�务端存储模å¼�支æŒ�三ç§�: -**file£º** µ¥»úģʽ£¬È«¾ÖÊÂÎñ»á»°ÐÅÏ¢ÄÚ´æÖжÁд²¢³Ö¾Ã»¯±¾µØÎļþroot.data£¬ÐÔÄܽϸߣ¨Ä¬ÈÏ£©¡£ +**file:** å�•机模å¼�,全局事务会è¯�ä¿¡æ�¯å†…存中读写并æŒ�久化本地文件root.data,性能较高(默认)。 -**DB:** ¸ß¿ÉÓÃģʽ£¬È«¾ÖÊÂÎñ»á»°ÐÅϢͨ¹ýDB¹²Ïí£¬Ïà¶ÔÐÔÄܲîһЩ¡£ +**DB:** 高å�¯ç”¨æ¨¡å¼�,全局事务会è¯�ä¿¡æ�¯é€šè¿‡DB共享,相对性能差一些。 -**redis£º** Seata-Server1.3¼°ÒÔÉϰ汾֧³Ö£¬ÐÔÄܽϸߣ¬´æÔÚÊÂÎñÐÅÏ¢¶ªÊ§·çÏÕ£¬ÐèÒªÅäºÏʵ¼Ê³¡¾°Ê¹Óᣠ+**redis:** Seata-Server1.3å�Šä»¥ä¸Šç‰ˆæœ¬æ”¯æŒ�,性能较高,存在事务信æ�¯ä¸¢å¤±é£Žé™©ï¼Œéœ€è¦�é…�å�ˆå®žé™…场景使用。 -### TC»·¾³´î½¨Ïê½â +### TC环境æ�­å»ºè¯¦è§£ -ÕâÀïÎÒÃÇʹÓÃDB¸ß¿ÉÓÃģʽ£¬ÕÒµ½conf/file.confÎļþ¡£ +这里我们使用DB高å�¯ç”¨æ¨¡å¼�,找到conf/file.conf文件。 -![ͼƬ](https://s9.51cto.com/oss/202207/03/84e02c1536f8c1431cc833b98958c1168f8658.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d9e1e2d06e2f4e53344238a2806fbc9bdbaf7b.png "ͼƬ") +![图片](https://s9.51cto.com/oss/202207/03/84e02c1536f8c1431cc833b98958c1168f8658.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d9e1e2d06e2f4e53344238a2806fbc9bdbaf7b.png "图片") -ÐÞ¸ÄÒÔÉÏÖеÄÐÅÏ¢£¬ÕÒµ½¶ÔÓ¦µÄdbÅäÖã¬ÐÞ¸ÄÆäÖеÄjdbcÁ¬½Ó£¬Òª×¢ÒâÆäÖÐÉæ¼°µ½Èý¸ö±í£¨global_table£¬branch_table£¬lock_table£©£¬Í¬Ê± mysql5ºÍmysql8µÄÇý¶¯ÊDz»Ò»ÑùµÄ¡£ +修改以上中的信æ�¯ï¼Œæ‰¾åˆ°å¯¹åº”çš„dbé…�置,修改其中的jdbc连接,è¦�注æ„�其中涉å�Šåˆ°ä¸‰ä¸ªè¡¨ï¼ˆglobal_table,branch_table,lock_table),å�Œæ—¶ mysql5å’Œmysql8的驱动是ä¸�一样的。 -> mysql5£ºcom.mysql.jdbc.Driver¡£ +> mysql5:com.mysql.jdbc.Driver。 > -> mysql8£ºcom.mysql.cj.jdbc.Driver¡£ +> mysql8:com.mysql.cj.jdbc.Driver。 -½¨±íÓï¾äµØÖ·£ºhttps://github.com/seata/seata/blob/develop/script/server/db/mysql.sql¡£ +建表语å�¥åœ°å�€ï¼šhttps://github.com/seata/seata/blob/develop/script/server/db/mysql.sql。 -**global_table£º** È«¾ÖÊÂÎñ±í£¬Ã¿µ±ÓÐÒ»¸öÈ«¾ÖÊÂÎñ·¢Æðºó£¬¾Í»áÔڸñíÖмǼȫ¾ÖÊÂÎñµÄID¡£ +**global_table:** 全局事务表,æ¯�当有一个全局事务å�‘èµ·å�Žï¼Œå°±ä¼šåœ¨è¯¥è¡¨ä¸­è®°å½•全局事务的ID。 -**branch_table£º** ·ÖÖ§ÊÂÎñ±í£¬¼Ç¼ÿһ¸ö·ÖÖ§ÊÂÎñµÄ ID£¬·ÖÖ§ÊÂÎñ²Ù×÷µÄÄĸöÊý¾Ý¿âµÈÐÅÏ¢¡£ +**branch_table:** 分支事务表,记录æ¯�一个分支事务的 ID,分支事务æ“�作的哪个数æ�®åº“等信æ�¯ã€‚ -**lock_table£º** È«¾ÖËø¡£ +**lock_table:** 全局é”�。 -µ±ÉÏÊöÅäÖúÃÒÔºó£¬ÖØÆôSeata¼´¿ÉÉúЧ¡£ +当上述é…�置好以å�Žï¼Œé‡�å�¯Seataå�³å�¯ç”Ÿæ•ˆã€‚ -### Seata ÅäÖà Nacos +### Seata é…�ç½® Nacos -SeataÖ§³Ö×¢²á·þÎñµ½Nacos£¬ÒÔ¼°Ö§³ÖSeataËùÓÐÅäÖ÷ŵ½NacosÅäÖÃÖÐÐÄ£¬ÔÚNacosÖÐͳһά»¤£»ÔÚ ¸ß¿ÉÓÃģʽϾÍÐèÒªÅäºÏNacosÀ´Íê³É +Seata支æŒ�注册æœ�务到Nacos,以å�Šæ”¯æŒ�Seata所有é…�置放到Nacosé…�置中心,在Nacos中统一维护;在 高å�¯ç”¨æ¨¡å¼�下就需è¦�é…�å�ˆNacosæ�¥å®Œæˆ� -Ê×ÏÈÕÒµ½ conf/registry.conf£¬ÐÞ¸ÄregistryÐÅÏ¢¡£ +首先找到 conf/registry.conf,修改registryä¿¡æ�¯ã€‚ @@ -294,19 +294,19 @@ SeataÖ§ ``` registry { - # file ¡¢nacos ¡¢eureka¡¢redis¡¢zk¡¢consul¡¢etcd3¡¢sofa + # file ã€�nacos ã€�eurekaã€�redisã€�zkã€�consulã€�etcd3ã€�sofa type = "nacos" nacos { - application = "seata-server" # ÕâÀïµÄÅäÖÃÒªºÍ¿Í»§¶Ë±£³ÖÒ»Ö + application = "seata-server" # 这里的é…�ç½®è¦�和客户端ä¿�æŒ�一致 serverAddr = "127.0.0.1:8848" - group = "SEATA_GROUP" # ÕâÀïµÄÅäÖÃÒªºÍ¿Í»§¶Ë±£³ÖÒ»Ö + group = "SEATA_GROUP" # 这里的é…�ç½®è¦�和客户端ä¿�æŒ�一致 namespace = "" cluster = "default" username = "nacos" password = "nacos" } config { - # file¡¢nacos ¡¢apollo¡¢zk¡¢consul¡¢etcd3 + # fileã€�nacos ã€�apolloã€�zkã€�consulã€�etcd3 type = "nacos" nacos { serverAddr = "127.0.0.1:8848" @@ -330,11 +330,11 @@ registry { -Ð޸ĺú󣬽«seataÖеÄһЩÅäÖÃÉÏ´«µ½NacosÖУ¬ÒòΪÅäÖÃÏî±È½Ï¶à£¬ËùÒÔ¹Ù·½ÌṩÁËÒ»¸öconfig.txt£¬Ö»ÏÂÔØ²¢ÇÒÐÞ¸ÄÆäÖÐijЩ²ÎÊýºó£¬ÉÏ´«µ½NacosÖм´¿É¡£ +修改好å�Žï¼Œå°†seata中的一些é…�置上传到Nacos中,因为é…�置项比较多,所以官方æ��供了一个config.txt,å�ªä¸‹è½½å¹¶ä¸”修改其中æŸ�些å�‚æ•°å�Žï¼Œä¸Šä¼ åˆ°Nacos中å�³å�¯ã€‚ -**ÏÂÔØµØÖ·£º**https://github.com/seata/seata/tree/develop/script/config-center¡£ +**下载地å�€ï¼š**https://github.com/seata/seata/tree/develop/script/config-center。 -ÐÞ¸ÄÏîÈçÏ£º +修改项如下: @@ -347,7 +347,7 @@ registry { ``` -service.vgroupMapping.mygroup=default # ÊÂÎñ·Ö×é +service.vgroupMapping.mygroup=default # 事务分组 store.mode=db store.db.driverClassName=com.mysql.cj.jdbc.Driver store.db.url=jdbc:mysql://127.0.0.1:3306/seata?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai @@ -365,168 +365,168 @@ store.db.password=123456 -Ð޸ĺÃÕâ¸öÎļþÒԺ󣬰ÑÕâ¸öÎļþ·Åµ½seataĿ¼Ï£º +修改好这个文件以å�Žï¼ŒæŠŠè¿™ä¸ªæ–‡ä»¶æ”¾åˆ°seata目录下: -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b42aeca797a2bcb8fb5791e836d0f6011e9848.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b42aeca797a2bcb8fb5791e836d0f6011e9848.png "图片") -°ÑÕâЩÅäÖö¼¼ÓÈëµ½NacosÅäÖÃÖУ¬Òª½èÖúÒ»¸ö½Å±¾À´½øÐÐÖ´ÐУ¬¹Ù·½ÒѾ­ÌṩºÃ¡£ +把这些é…�置都加入到Nacosé…�置中,è¦�借助一个脚本æ�¥è¿›è¡Œæ‰§è¡Œï¼Œå®˜æ–¹å·²ç»�æ��供好。 -**µØÖ·Îª£º**https://github.com/seata/seata/blob/develop/script/config-center/nacos/nacos-config.sh¡£ +**地å�€ä¸ºï¼š**https://github.com/seata/seata/blob/develop/script/config-center/nacos/nacos-config.sh。 -н¨Ò»¸önacos-config.shÎļþ£¬½«½Å±¾ÄÚÈݸ´ÖƽøÈ¥£¬ÐÞ¸Äcongfig.txtµÄ·¾¶¡£ +新建一个nacos-config.sh文件,将脚本内容å¤�制进去,修改congfig.txt的路径。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b876340233c7ac1623731359ea33164becafc1.png "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f563db6014ec0cb7f5a13952c63552c916da05.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b876340233c7ac1623731359ea33164becafc1.png "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f563db6014ec0cb7f5a13952c63552c916da05.png "图片") -ÉÏÊöÎļþÐ޸ĺú󣬴ò¿ªgit¹¤¾ß£¬½«nacos-config.sh¹¤¾ßÍÏ×§µ½´°ÌåÖм´¿É»òÕßʹÓÃÃüÁî¡£ +上述文件修改好å�Žï¼Œæ‰“å¼€git工具,将nacos-config.sh工具拖拽到窗体中å�³å�¯æˆ–者使用命令。 -> sh nacos-config.sh -h 127.0.0.1 -p 8848 -g SEATA_GROUP -t 88b8f583-43f9-4272-bd46-78a9f89c56e8 -u nacos -w nacos¡£ +> sh nacos-config.sh -h 127.0.0.1 -p 8848 -g SEATA_GROUP -t 88b8f583-43f9-4272-bd46-78a9f89c56e8 -u nacos -w nacos。 > -> -h£ºnacosµØÖ·¡£ +> -h:nacos地å�€ã€‚ > -> -p£º¶Ë¿Ú£¬Ä¬ÈÏ8848¡£ +> -p:端å�£ï¼Œé»˜è®¤8848。 > -> -g£ºseataµÄ·þÎñÁбí·Ö×éÃû³Æ¡£ +> -g:seataçš„æœ�务列表分组å��称。 > -> -t£ºnacosÃüÃû¿Õ¼äid¡£ +> -t:nacos命å��空间id。 > -> -uºÍ-w£ºnacosµÄÓû§ÃûºÍÃÜÂë¡£ +> -uå’Œ-w:nacos的用户å��和密ç �。 -![ͼƬ](https://s3.51cto.com/oss/202207/03/b685868586971f9c3b1490e3fcf50041fc2f6b.gif "ͼƬ")![ͼƬ](https://s4.51cto.com/oss/202207/03/965180d92863b00defe5550f051ade40ac60e8.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/764bfaf385a67b25f732035cde02cc76bbcd20.png "ͼƬ") +![图片](https://s3.51cto.com/oss/202207/03/b685868586971f9c3b1490e3fcf50041fc2f6b.gif "图片")![图片](https://s4.51cto.com/oss/202207/03/965180d92863b00defe5550f051ade40ac60e8.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/764bfaf385a67b25f732035cde02cc76bbcd20.png "图片") -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/110a73f54f3f0e565cd21630cf0e0cf4b80ee2.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/110a73f54f3f0e565cd21630cf0e0cf4b80ee2.png "图片") -×îºó»áÓÐËĸöÖ´ÐÐʧ°Ü£¬ÊÇÒòΪredis±¨´íµÄ¹ØÏµ£¬Õâ¸ö¿ÉÒÔºöÂÔ£¬²»Ó°ÏìÕý³£Ê¹Óá£×îºó¿ÉÒÔ¿´µ½ÔÚNacosÖÐÓкܶàµÄÅäÖÃÏ˵Ã÷µ¼Èë³É¹¦¡£ÔÙÖØÐÂÆäÖÐseata£¬³É¹¦¼àÌýµ½8091¶Ë¿Ú£¬±íʾǰÖù¤×÷¶¼ÒѾ­×¼±¸Íê³É¡£ +最å�Žä¼šæœ‰å››ä¸ªæ‰§è¡Œå¤±è´¥ï¼Œæ˜¯å› ä¸ºredis报错的关系,这个å�¯ä»¥å¿½ç•¥ï¼Œä¸�å½±å“�正常使用。最å�Žå�¯ä»¥çœ‹åˆ°åœ¨Nacos中有很多的é…�置项,说明导入æˆ�功。å†�é‡�新其中seata,æˆ�功监å�¬åˆ°8091端å�£ï¼Œè¡¨ç¤ºå‰�置工作都已ç»�准备完æˆ�。 -![ͼƬ](https://s7.51cto.com/oss/202207/03/573560212aa718ea82c317737eefc492908086.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f71535950882c017bbd05116c54c16ccb20f0e.png "ͼƬ") +![图片](https://s7.51cto.com/oss/202207/03/573560212aa718ea82c317737eefc492908086.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f71535950882c017bbd05116c54c16ccb20f0e.png "图片") -### SeataµÄÊÂÎñģʽ +### Seata的事务模å¼� -Seata ¶¨ÒåÁËÈ«¾ÖÊÂÎñµÄ¿ò¼Ü£¬Ö÷Òª·ÖΪÒÔϼ¸²½£º +Seata 定义了全局事务的框架,主è¦�分为以下几步: -1. TM Ïò TCÇëÇó ·¢Æð(Begin)¡¢Ìá½»(Commit)¡¢»Ø¹ö(Rollback)µÈÈ«¾ÖÊÂÎñ¡£ -2. TM°Ñ´ú±íÈ«¾ÖÊÂÎñµÄXID°ó¶¨µ½·ÖÖ§ÊÂÎñÉÏ¡£ -3. RMÏòTC×¢²á£¬°Ñ·ÖÖ§ÊÂÎñ¹ØÁªµ½XID´ú±íµÄÈ«¾ÖÊÂÎñÖС£ -4. RM°Ñ·ÖÖ§ÊÂÎñµÄÖ´Ðнá¹ûÉϱ¨¸øTC¡£ -5. TC·¢ËÍ·ÖÖ§Ìá½»£¨Branch Commit£©»ò·ÖÖ§»Ø¹ö£¨Branch Rollback£©ÃüÁî¸øRM¡£ +1. TM å�‘ TC请求 å�‘èµ·(Begin)ã€�æ��交(Commit)ã€�回滚(Rollback)等全局事务。 +2. TM把代表全局事务的XID绑定到分支事务上。 +3. RMå�‘TC注册,把分支事务关è�”到XID代表的全局事务中。 +4. RM把分支事务的执行结果上报给TC。 +5. TCå�‘é€�分支æ��交(Branch Commit)或分支回滚(Branch Rollback)命令给RM。 -![ͼƬ](https://s9.51cto.com/oss/202207/03/410c3b93872ba8a55a9532876f3afbe1853d88.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a30dd41045c8db4e0c5757095c6d1ab52fd57e.png "ͼƬ") +![图片](https://s9.51cto.com/oss/202207/03/410c3b93872ba8a55a9532876f3afbe1853d88.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a30dd41045c8db4e0c5757095c6d1ab52fd57e.png "图片") -Seata µÄ È«¾ÖÊÂÎñ ´¦Àí¹ý³Ì£¬·ÖΪÁ½¸ö½×¶Î£º +Seata çš„ 全局事务 处ç�†è¿‡ç¨‹ï¼Œåˆ†ä¸ºä¸¤ä¸ªé˜¶æ®µï¼š -* Ö´Ðн׶Π£ºÖ´ÐзÖÖ§ÊÂÎñ£¬²¢±£Ö¤Ö´Ðнá¹ûÂú×ãÊÇ_¿É»Ø¹öµÄ£¨Rollbackable£©_ºÍ_³Ö¾Ã»¯µÄ£¨Durable£©_¡£ -* Íê³É½×¶Î£º¸ù¾Ý Ö´Ðн׶Π½á¹ûÐγɵľöÒ飬ӦÓÃͨ¹ý TM ·¢³öµÄÈ«¾ÖÌá½»»ò»Ø¹öµÄÇëÇó¸ø TC£¬TC ÃüÁî RM Çý¶¯ ·ÖÖ§ÊÂÎñ ½øÐÐ Commit »ò Rollback¡£ +* 执行阶段 :执行分支事务,并ä¿�è¯�执行结果满足是_å�¯å›žæ»šçš„(Rollbackable)_å’Œ_æŒ�久化的(Durable)_。 +* 完æˆ�阶段:根æ�® 执行阶段 结果形æˆ�的决议,应用通过 TM å�‘出的全局æ��交或回滚的请求给 TC,TC 命令 RM 驱动 分支事务 进行 Commit 或 Rollback。 -Seata µÄËùνÊÂÎñģʽÊÇÖ¸£ºÔËÐÐÔÚ Seata È«¾ÖÊÂÎñ¿ò¼ÜÏ嵀 ·ÖÖ§ÊÂÎñ µÄÐÐΪģʽ¡£×¼È·µØ½²£¬Ó¦¸Ã½Ð×÷ ·ÖÖ§ÊÂÎñģʽ¡£ +Seata 的所谓事务模å¼�是指:è¿�行在 Seata 全局事务框架下的 分支事务 的行为模å¼�。准确地讲,应该å�«ä½œ 分支事务模å¼�。 -²»Í¬µÄ ÊÂÎñģʽ Çø±ðÔÚÓÚ ·ÖÖ§ÊÂÎñ ʹÓò»Í¬µÄ·½Ê½´ïµ½È«¾ÖÊÂÎñÁ½¸ö½×¶ÎµÄÄ¿±ê¡£¼´£¬»Ø´ðÒÔÏÂÁ½¸öÎÊÌ⣺ +ä¸�å�Œçš„ 事务模å¼� 区别在于 分支事务 使用ä¸�å�Œçš„æ–¹å¼�达到全局事务两个阶段的目标。å�³ï¼Œå›žç­”以下两个问题: -* Ö´Ðн׶Π£ºÈçºÎÖ´Ðв¢ ±£Ö¤ Ö´Ðнá¹ûÂú×ãÊÇ_¿É»Ø¹öµÄ£¨Rollbackable£©_ºÍ_³Ö¾Ã»¯µÄ£¨Durable£©_¡£ -* Íê³É½×¶Î£ºÊÕµ½ TC µÄÃüÁîºó£¬ÈçºÎ×öµ½·ÖÖ§µÄÌá½»»ò»Ø¹ö£¿ +* 执行阶段 :如何执行并 ä¿�è¯� 执行结果满足是_å�¯å›žæ»šçš„(Rollbackable)_å’Œ_æŒ�久化的(Durable)_。 +* 完æˆ�阶段:收到 TC 的命令å�Žï¼Œå¦‚何å�šåˆ°åˆ†æ”¯çš„æ��交或回滚? -ÎÒÃÇÒÔATģʽΪÀý£º +我们以AT模å¼�为例: -* Ö´Ðн׶Σº +* 执行阶段: -* ¿É»Ø¹ö£º¸ù¾Ý SQL ½âÎö½á¹û£¬¼Ç¼»Ø¹öÈÕÖ¾ -* ³Ö¾Ã»¯£º»Ø¹öÈÕÖ¾ºÍÒµÎñ SQL ÔÚͬһ¸ö±¾µØÊÂÎñÖÐÌá½»µ½Êý¾Ý¿â +* å�¯å›žæ»šï¼šæ ¹æ�® SQL è§£æž�结果,记录回滚日志 +* æŒ�久化:回滚日志和业务 SQL 在å�Œä¸€ä¸ªæœ¬åœ°äº‹åС䏭æ��交到数æ�®åº“ -* Íê³É½×¶Î£º -* ·ÖÖ§Ìá½»£ºÒ첽ɾ³ý»Ø¹öÈÕÖ¾¼Ç¼ -* ·ÖÖ§»Ø¹ö£ºÒÀ¾Ý»Ø¹öÈÕÖ¾½øÐз´Ïò²¹³¥¸üР+* 完æˆ�阶段: +* 分支æ��交:异步删除回滚日志记录 +* 分支回滚:ä¾�æ�®å›žæ»šæ—¥å¿—进行å��å�‘è¡¥å�¿æ›´æ–° -½ÓÏÂÀ´¾Í½øÈëÖØÍ·Ï·£¬SeataËÄ´óģʽµÄ½éÉÜ¡£ +接下æ�¥å°±è¿›å…¥é‡�头æˆ�,Seata四大模å¼�的介ç»�。 -## Seata-XAģʽ +## Seata-XA模å¼� -Seata 1.2.0 °æ±¾·¢²¼ÁËеÄÊÂÎñÄ£ÐÍ£ºXAģʽ£¬ÊµÏÖÁ˶ÔXAЭÒéµÄÖ§³Ö¡£¶ÔÓÚXAģʽÎÒÃÇÐèÒª´ÓÈý¸öµãÈ¥½âÎöËü¡£ +Seata 1.2.0 版本å�‘布了新的事务模型:XA模å¼�,实现了对XAå��议的支æŒ�。对于XA模å¼�我们需è¦�从三个点去解æž�它。 -* XAģʽÊÇʲô¡£ -* Ϊʲô֧³ÖXA¡£ -* XAģʽÈçºÎʵÏÖºÍʹÓᣠ+* XA模å¼�是什么。 +* 为什么支æŒ�XA。 +* XA模å¼�如何实现和使用。 -### XAģʽ¼ò½é +### XA模å¼�简介 -Ê×ÏÈÐèÒªÖªµÀXAÄ£ÐÍÊÇʲô£¬XA ¹æ·¶ÔçÔÚÉÏÊÀ¼Í 90 Äê´ú³õ¾Í±»Ìá³ö£¬ÓÃÓÚ½â¾ö·Ö²¼Ê½ÊÂÎñÁìÓòµÄÎÊÌ⣬ËûÒ²ÊÇ×îÔçµÄ·Ö²¼Ê½ÊÂÎñ´¦Àí·½°¸£¬ÒòΪÐèÒªÊý¾Ý¿âÄÚ²¿Ò²ÊÇÖ§³ÖXAģʽµÄ£¬±ÈÈçMYSQL£¬XAģʽ¾ßÓÐǿһÖÂÐÔµÄÌØµã£¬Òò´ËËû¶ÔÊý¾Ý¿âÕ¼ÓÃʱ¼ä±È½Ï³¤£¬ËùÒÔÐÔÄܱȽϵ͡£ +首先需è¦�知é�“XA模型是什么,XA 规范早在上世纪 90 年代åˆ�就被æ��出,用于解决分布å¼�事务领域的问题,他也是最早的分布å¼�事务处ç�†æ–¹æ¡ˆï¼Œå› ä¸ºéœ€è¦�æ•°æ�®åº“内部也是支æŒ�XA模å¼�的,比如MYSQL,XA模å¼�具有强一致性的特点,因此他对数æ�®åº“å� ç”¨æ—¶é—´æ¯”较长,所以性能比较低。 -XAģʽÊôÓÚÁ½½×¶ÎÌá½»¡£ +XA模å¼�属于两阶段æ��交。 -1. µÚÒ»½×¶Î½øÐÐÊÂÎñ×¢²á£¬½«ÊÂÎñ×¢²áµ½TCÖУ¬Ö´ÐÐSQLÓï¾ä¡£ -2. µÚ¶þ½×¶ÎTCÅжÏÎÞÊÂÎñ³ö´í£¬Í¨ÖªËùÓÐÊÂÎñÌá½»£¬·ñÔò»Ø¹ö¡£ -3. ÔÚµÚÒ»µ½µÚ¶þ½×¶Î¹ý³ÌÖУ¬ÊÂÎñÒ»Ö±Õ¼ÓÐÊý¾Ý¿âËø£¬Òò´ËÐÔÄܱȽϵͣ¬µ«ÊÇËùÓÐÊÂÎñҪôһÆðÌá½»£¬ÒªÃ´Ò»Æð»Ø¹ö£¬ËùÒÔÄÜʵÏÖǿһÖÂÐÔ¡£ +1. 第一阶段进行事务注册,将事务注册到TC中,执行SQL语å�¥ã€‚ +2. 第二阶段TC判断无事务出错,通知所有事务æ��交,å�¦åˆ™å›žæ»šã€‚ +3. 在第一到第二阶段过程中,事务一直å� æœ‰æ•°æ�®åº“é”�,因此性能比较低,但是所有事务è¦�么一起æ��交,è¦�么一起回滚,所以能实现强一致性。 -ÎÞÂÛÊÇATģʽ¡¢TCC»¹ÊÇSAGA£¬ÕâЩģʽµÄÌá³ö£¬¶¼ÊÇÔ´ÓÚXA¹æ·¶¶ÔijЩҵÎñ³¡¾°ÎÞ·¨Âú×ã¡£ +无论是AT模å¼�ã€�TCC还是SAGA,这些模å¼�çš„æ��出,都是æº�于XA规范对æŸ�些业务场景无法满足。 -### ʲôÊÇXAЭÒé +### 什么是XAå��è®® -XA¹æ·¶ÊÇX/OPEN×éÖ¯¶¨ÒåµÄ·Ö²¼Ê½ÊÂÎñ´¦Àí£¨DTP£¬Distributed Transaction Processing£©±ê×¼£¬XA¹æ·¶ÃèÊöÁËÈ«¾ÖÊÂÎñ¹ÜÀíÆ÷ºÍ¾Ö²¿×ÊÔ´¹ÜÀíÆ÷Ö®¼äµÄ½Ó¿Ú£¬XA¹æ·¶µÄÄ¿µÄÊÇÔÊÐí¶à¸ö×ÊÔ´(ÈçÊý¾Ý¿â£¬Ó¦Ó÷þÎñÆ÷£¬ÏûÏ¢¶ÓÁеȣ©ÔÚͬһÊÂÎñÖзÃÎÊ£¬ÕâÑù¿ÉÒÔʹ ACID ÊôÐÔ¿çÔ½Ó¦ÓóÌÐò¶ø±£³ÖÓÐЧ¡£ +XA规范是X/OPEN组织定义的分布å¼�事务处ç�†ï¼ˆDTP,Distributed Transaction Processing)标准,XA规范æ��述了全局事务管ç�†å™¨å’Œå±€éƒ¨èµ„æº�管ç�†å™¨ä¹‹é—´çš„æŽ¥å�£ï¼ŒXA规范的目的是å…�许多个资æº�(如数æ�®åº“,应用æœ�务器,消æ�¯é˜Ÿåˆ—等)在å�Œä¸€äº‹åŠ¡ä¸­è®¿é—®ï¼Œè¿™æ ·å�¯ä»¥ä½¿ ACID 属性跨越应用程åº�而ä¿�æŒ�有效。 -XA ¹æ·¶ ʹÓÃÁ½½×¶ÎÌá½»£¨2PC£¬Two-Phase Commit£©À´±£Ö¤ËùÓÐ×ÊԴͬʱÌá½»»ò»Ø¹öÈκÎÌØ¶¨µÄÊÂÎñ¡£ÒòΪXA¹æ·¶×îÔç±»Ìá³ö£¬ËùÒÔ¼¸ºõËùÓеÄÖ÷Á÷Êý¾Ý¿â¶¼±£ÓжÔXA¹æ·¶µÄÖ§³Ö¡£ +XA 规范 使用两阶段æ��交(2PC,Two-Phase Commit)æ�¥ä¿�è¯�所有资æº�å�Œæ—¶æ��交或回滚任何特定的事务。因为XA规范最早被æ��出,所以几乎所有的主æµ�æ•°æ�®åº“都ä¿�有对XA规范的支æŒ�。 -·Ö²¼Ê½ÊÂÎñDTPÄ£ÐͶ¨ÒåµÄ½ÇÉ«ÈçÏ£º +分布å¼�事务DTP模型定义的角色如下: -* AP£º¼´Ó¦ÓóÌÐò£¬¿ÉÒÔÀí½âΪʹÓÃDTP·Ö²¼Ê½ÊÂÎñµÄ³ÌÐò£¬ÀýÈç¶©µ¥·þÎñ¡¢¿â´æ·þÎñ¡£ -* RM£º×ÊÔ´¹ÜÀíÆ÷£¬¿ÉÒÔÀí½âΪÊÂÎñµÄ²ÎÓëÕߣ¬Ò»°ãÇé¿öÏÂÊÇÖ¸Ò»¸öÊý¾Ý¿âµÄʵÀý£¨MySql£©£¬Í¨¹ý×ÊÔ´¹ÜÀíÆ÷¶Ô¸ÃÊý¾Ý¿â½øÐпØÖÆ£¬×ÊÔ´¹ÜÀíÆ÷¿ØÖÆ×Å·ÖÖ§ÊÂÎñ¡£ -* TM£ºÊÂÎñ¹ÜÀíÆ÷£¬¸ºÔðЭµ÷ºÍ¹ÜÀíÊÂÎñ£¬ÊÂÎñ¹ÜÀíÆ÷¿ØÖÆ×ÅÈ«¾ÖÊÂÎñ£¬¹ÜÀíʵÎñÉúÃüÖÜÆÚ£¬²¢Ð­µ÷¸÷¸öRM¡£È«¾ÖÊÂÎñÊÇÖ¸·Ö²¼Ê½ÊÂÎñ´¦Àí»·¾³ÖУ¬ÐèÒª²Ù×÷¶à¸öÊý¾Ý¿â¹²Í¬Íê³ÉÒ»¸ö¹¤×÷£¬Õâ¸ö¹¤×÷¼´ÊÇÒ»¸öÈ«¾ÖÊÂÎñ¡£ +* AP:å�³åº”用程åº�,å�¯ä»¥ç�†è§£ä¸ºä½¿ç”¨DTP分布å¼�事务的程åº�,例如订å�•æœ�务ã€�库存æœ�务。 +* RM:资æº�管ç�†å™¨ï¼Œå�¯ä»¥ç�†è§£ä¸ºäº‹åŠ¡çš„å�‚与者,一般情况下是指一个数æ�®åº“的实例(MySql),通过资æº�管ç�†å™¨å¯¹è¯¥æ•°æ�®åº“进行控制,资æº�管ç�†å™¨æŽ§åˆ¶ç�€åˆ†æ”¯äº‹åŠ¡ã€‚ +* TM:事务管ç�†å™¨ï¼Œè´Ÿè´£å��调和管ç�†äº‹åŠ¡ï¼Œäº‹åŠ¡ç®¡ç�†å™¨æŽ§åˆ¶ç�€å…¨å±€äº‹åŠ¡ï¼Œç®¡ç�†å®žåŠ¡ç”Ÿå‘½å‘¨æœŸï¼Œå¹¶å��è°ƒå�„个RM。全局事务是指分布å¼�事务处ç�†çŽ¯å¢ƒä¸­ï¼Œéœ€è¦�æ“�作多个数æ�®åº“å…±å�Œå®Œæˆ�一个工作,这个工作å�³æ˜¯ä¸€ä¸ªå…¨å±€äº‹åŠ¡ã€‚ -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/85cb437444a4debfdbb835519a1b2fdd16ee7b.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/85cb437444a4debfdbb835519a1b2fdd16ee7b.png "图片") -DTPģʽ¶¨ÒåTMºÍRMÖ®¼äͨѶµÄ½Ó¿Ú¹æ·¶½ÐXA£¬¼òµ¥Àí½âΪÊý¾Ý¿âÌṩµÄ2PC½Ó¿ÚЭÒ飬»ùÓÚÊý¾Ý¿âµÄXAЭÒéÀ´ÊµÏÖµÄ2PCÓÖ³ÆÎªXA·½°¸¡£ +DTP模å¼�定义TMå’ŒRM之间通讯的接å�£è§„范å�«XA,简å�•ç�†è§£ä¸ºæ•°æ�®åº“æ��供的2PC接å�£å��议,基于数æ�®åº“çš„XAå��è®®æ�¥å®žçŽ°çš„2PCå�ˆç§°ä¸ºXA方案。 -ÏÖÔÚÓÐÓ¦ÓóÌÐò(AP)³ÖÓж©µ¥¿âºÍ¿â´æ¿â£¬Ó¦ÓóÌÐò(AP)ͨ¹ýTM֪ͨ¶©µ¥¿â(RM)ºÍ¿â´æ¿â(RM)£¬½øÐпۼõ¿â´æºÍÉú³É¶©µ¥£¬Õâ¸öʱºòRM²¢Ã»ÓÐÌá½»ÊÂÎñ£¬¶øÇÒËø¶¨×ÊÔ´¡£ +现在有应用程åº�(AP)æŒ�有订å�•库和库存库,应用程åº�(AP)通过TM通知订å�•库(RM)和库存库(RM),进行扣å‡�库存和生æˆ�订å�•,这个时候RM并没有æ��交事务,而且é”�定资æº�。 -µ±TMÊÕµ½Ö´ÐÐÏûÏ¢£¬Èç¹ûÓÐÒ»·½RMÖ´ÐÐʧ°Ü£¬·Ö±ðÏòÆäËûRMÒ²·¢ËͻعöÊÂÎñ£¬»Ø¹öÍê±Ï£¬ÊÍ·ÅËø×ÊÔ´¡£ +当TM收到执行消æ�¯ï¼Œå¦‚果有一方RM执行失败,分别å�‘å…¶ä»–RM也å�‘é€�回滚事务,回滚完毕,释放é”�资æº�。 -µ±TMÊÕµ½Ö´ÐÐÏûÏ¢£¬RMÈ«²¿³É¹¦£¬ÏòËùÓÐRM·¢ÆðÌá½»ÊÂÎñ£¬Ìá½»Íê±Ï£¬ÊÍ·ÅËø×ÊÔ´¡£ +当TM收到执行消æ�¯ï¼ŒRM全部æˆ�功,å�‘所有RMå�‘èµ·æ��交事务,æ��交完毕,释放é”�资æº�。 -![ͼƬ](https://s7.51cto.com/oss/202207/03/d264d0e03f64cdd85f1600518e2db31ee0b8a5.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/8298749403719fbb05d917a501c3dd3b1cc449.png "ͼƬ") +![图片](https://s7.51cto.com/oss/202207/03/d264d0e03f64cdd85f1600518e2db31ee0b8a5.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/8298749403719fbb05d917a501c3dd3b1cc449.png "图片") -·Ö²¼Ê½Í¨ÐÅЭÒéXA¹æ·¶£¬¾ßÌåÖ´ÐÐÁ÷³ÌÈçÏÂËùʾ£º +分布å¼�通信å��è®®XA规范,具体执行æµ�程如下所示: -![ͼƬ](https://s7.51cto.com/oss/202207/03/3609cd043edf05941832252b7e7ce838b95837.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/9235cb212a65d21b72549719fdc8b7e4cdd340.png "ͼƬ") +![图片](https://s7.51cto.com/oss/202207/03/3609cd043edf05941832252b7e7ce838b95837.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/9235cb212a65d21b72549719fdc8b7e4cdd340.png "图片") -µÚÒ»²½£ºAP´´½¨ÁËRM1,RM2µÄJDBCÁ¬½Ó¡£ +第一步:AP创建了RM1,RM2çš„JDBC连接。 -µÚ¶þ²½£ºAP֪ͨÉú³ÉÈ«¾ÖÊÂÎïID£¬²¢°ÑRM1£¬RM2×¢²áµ½È«¾ÖÊÂÎñID¡£ +第二步:AP通知生æˆ�全局事物ID,并把RM1,RM2注册到全局事务ID。 -µÚÈý²½£ºÖ´Ðжþ½×¶ÎЭÒéÖеĵÚÒ»½×¶Îprepare¡£ +第三步:执行二阶段å��议中的第一阶段prepare。 -µÚËIJ½£º¸ù¾ÝprepareÇëÇ󣬾ö¶¨ÕûÌåÌá½»»ò»Ø¹ö¡£ +第四步:根æ�®prepare请求,决定整体æ��交或回滚。 -µ«ÊǶÔÓÚXA¶øÑÔ£¬Èç¹ûÒ»¸ö²ÎÓëÈ«¾ÖÊÂÎñµÄ×ÊÔ´¡°Ê§Áª¡±ÁË£¬ÄÇô¾ÍÒâζ×ÅTMÊÕ²»µ½·ÖÖ§ÊÂÎñ½áÊøµÄÃüÁÄÇôËüËø¶¨µÄÊý¾Ý£¬½«»áÒ»Ö±±»Ëø¶¨£¬´Ó¶ø²úÉúËÀËø£¬Õâ¸öÒ²ÊÇSeataÐèÒªÖØµã½â¾öµÄÎÊÌâ¡£ +但是对于XA而言,如果一个å�‚与全局事务的资æº�“失è�”â€�了,那么就æ„�味ç�€TMæ”¶ä¸�到分支事务结æ�Ÿçš„命令,那么它é”�定的数æ�®ï¼Œå°†ä¼šä¸€ç›´è¢«é”�定,从而产生死é”�,这个也是Seata需è¦�é‡�点解决的问题。 -ÔÚSeata¶¨ÒåµÄ·Ö²¼Ê½ÊÂÎñ¼Ü¹¹ÖУ¬ÀûÓÃÊÂÎñ×ÊÔ´(Êý¾Ý¾Ö¡¢ÏûÏ¢)µÈ¶ÔXAЭÒé½øÐÐÖ§³Ö£¬ÓÃXAЭÒéµÄ»úÖÆÀ´¹ÜÀí·ÖÖ§ÊÂÎñ¡£ +在Seata定义的分布å¼�事务架构中,利用事务资æº�(æ•°æ�®å±€ã€�消æ�¯)等对XAå��议进行支æŒ�,用XAå��议的机制æ�¥ç®¡ç�†åˆ†æ”¯äº‹åŠ¡ã€‚ -![ͼƬ](https://s2.51cto.com/oss/202207/03/a93391c180ce2293be8525a483594c701ebcbd.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/52b22c57810685deea7412204aa069e494f863.png "ͼƬ") +![图片](https://s2.51cto.com/oss/202207/03/a93391c180ce2293be8525a483594c701ebcbd.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/52b22c57810685deea7412204aa069e494f863.png "图片") -* Ö´Ðн׶Σº +* 执行阶段: -* ¿É»Ø¹ö£ºÒµÎñSQL²Ù×÷ÔÚXA·ÖÖ§ÖнøÐУ¬ÓÐ×ÊÔ´¹ÜÀíÆ÷¶ÔXAЭÒéµÄÖ§³ÖÀ´±£Ö¤¿É»Ø¹ö¡£ -* ³Ö¾Ã»¯£ºZA·ÖÖ§Íê³ÉÒÔºó£¬Ö´ÐÐ XA prepare£¬Í¬Ñù£¬ÓÉ×ÊÔ´¶ÔXAЭÒéµÄÖ§³ÖÀ´±£Ö¤³Ö¾Ã»¯¡£ +* å�¯å›žæ»šï¼šä¸šåŠ¡SQLæ“�作在XA分支中进行,有资æº�管ç�†å™¨å¯¹XAå��议的支æŒ�æ�¥ä¿�è¯�å�¯å›žæ»šã€‚ +* æŒ�久化:ZA分支完æˆ�以å�Žï¼Œæ‰§è¡Œ XA prepare,å�Œæ ·ï¼Œç”±èµ„æº�对XAå��议的支æŒ�æ�¥ä¿�è¯�æŒ�久化。 -* Íê³É½×¶Î£º +* 完æˆ�阶段: -### XA´æÔÚµÄÒâÒå +### XA存在的æ„�义 -* ·ÖÖ§Ìá½»£ºÖ´ÐÐXA·ÖÖ§µÄcommit¡£ -* ·ÖÖ§»Ø¹ö£ºÖ´ÐÐXA·ÖÖ§µÄrollback¡£ +* 分支æ��交:执行XA分支的commit。 +* 分支回滚:执行XA分支的rollback。 -Seata ÒѾ­Ö§³ÖÁËÈý´óÊÂÎñģʽ£ºAT\TCC\SAGA£¬ÕâÈý¸ö¶¼ÊDz¹³¥ÐÍÊÂÎñ£¬²¹³¥ÐÍÊÂÎñ´¦ÀíÄã»úÖÆ¹¹½¨ÔÚ ÊÂÎñ×ÊÔ´ Ö®ÉÏ(ҪôÖмä¼þ²ãÃæ£¬ÒªÃ´Ó¦Óòã)£¬ÊÂÎñ×ÊÔ´±¾Éí¶ÔÓÚ·Ö²¼Ê½µÄÊÂÎñÊÇÎÞ¸ÐÖªµÄ£¬ÕâÖÖ¶ÔÓÚ·Ö²¼Ê½ÊÂÎñµÄÎÞ¸ÐÖª´æÔÚÓÐÒ»¸ö¸ù±¾ÐÔµÄÎÊÌ⣬ÎÞ·¨×öµ½ÕæÕýµÄÈ«¾ÖÒ»ÖÂÐÔ¡£ +Seata å·²ç»�支æŒ�了三大事务模å¼�:AT\TCC\SAGA,这三个都是补å�¿åž‹äº‹åŠ¡ï¼Œè¡¥å�¿åž‹äº‹åС处ç�†ä½ æœºåˆ¶æž„建在 事务资æº� 之上(è¦�么中间件层é�¢ï¼Œè¦�么应用层),事务资æº�本身对于分布å¼�的事务是无感知的,这ç§�对于分布å¼�事务的无感知存在有一个根本性的问题,无法å�šåˆ°çœŸæ­£çš„全局一致性。 -ÀýÈçÒ»¸ö¿â´æ¼Ç¼£¬ÔÚ²¹³¥ÐÍÊÂÎñ´¦Àí¹ý³ÌÖУ¬ÓÃ80¿Û¼õΪ60£¬Õâ¸öʱºò²Ö¿â¹ÜÀíÔ±²éѯÊý¾Ý½á¹û£¬¿´µ½µÄÊÇ60£¬Ö®ºóÒòΪÒì³£»Ø¹ö£¬¿â´æ»Ø¹öµ½Ô­À´µÄ80£¬ÄÇôÕâ¸öʱºò¿â´æ¹ÜÀíÔ±¿´µ½µÄ60£¬Æäʵ¾ÍÊÇÔàÊý¾Ý£¬¶øÕâ¸öÖмä״̬¾ÍÊDz¹³¥ÐÍÊÂÎñ´æÔÚµÄÔàÊý¾Ý¡£ +例如一个库存记录,在补å�¿åž‹äº‹åС处ç�†è¿‡ç¨‹ä¸­ï¼Œç”¨80扣å‡�为60,这个时候仓库管ç�†å‘˜æŸ¥è¯¢æ•°æ�®ç»“果,看到的是60,之å�Žå› ä¸ºå¼‚常回滚,库存回滚到原æ�¥çš„80,那么这个时候库存管ç�†å‘˜çœ‹åˆ°çš„60,其实就是è„�æ•°æ�®ï¼Œè€Œè¿™ä¸ªä¸­é—´çжæ€�就是补å�¿åž‹äº‹åŠ¡å­˜åœ¨çš„è„�æ•°æ�®ã€‚ -ºÍ²¹³¥ÐÍÊÂÎñ²»Í¬£¬XAЭÒéÒªÇóÊÂÎñ×ÊÔ´ ±¾ÉíÌṩ¶Ô¹æ·¶ºÍЭÒéµÄÖ§³Ö£¬ÒòΪÊÂÎñ×ÊÔ´¸ÐÖª²¢²ÎÓë·Ö²¼Ê½ÊÂÎñ´¦Àí¹ý³ÌÖУ¬ËùÒÔÊÂÎñ×ÊÔ´¿ÉÒÔ±£Ö¤´ÓÈÎÒâÊӽǶÔÊý¾ÝµÄ·ÃÎÊÓÐЧ¸ôÀëÐÔ£¬Âú×ãÈ«¾ÖÊý¾ÝµÄÒ»ÖÂÐÔ¡£ +和补å�¿åž‹äº‹åŠ¡ä¸�å�Œï¼ŒXAå��è®®è¦�求事务资æº� 本身æ��供对规范和å��议的支æŒ�,因为事务资æº�感知并å�‚与分布å¼�事务处ç�†è¿‡ç¨‹ä¸­ï¼Œæ‰€ä»¥äº‹åŠ¡èµ„æº�å�¯ä»¥ä¿�è¯�从任æ„�视角对数æ�®çš„访问有效隔离性,满足全局数æ�®çš„一致性。 -### XAģʽµÄʹÓà +### XA模å¼�的使用 -**¹Ù·½°¸Àý£º**https://github.com/seata/seata-samples¡£ +**官方案例:**https://github.com/seata/seata-samples。 -**ÏîÄ¿Ãû£º**seata-samples¡£ +**项目å��:**seata-samples。 -**ÒµÎñ¿ªÊ¼£º**business-xa¿â´æ·þÎñ£ºstock-xa¶©µ¥·þÎñ£ºorder-xaÕ˺ŷþÎñ£ºaccount-xa¡£ +**业务开始:**business-xa库存æœ�务:stock-xa订å�•æœ�务:order-xaè´¦å�·æœ�务:account-xa。 -°ÑÕâ¸öÏîÄ¿°¸ÀýÏÂÔØÏÂÀ´ÒÔºó£¬ÕÒµ½ÏîÄ¿ÃûΪseata-xaµÄĿ¼£¬ÀïÃæÓвâÊÔÊý¾Ý¿âµÄÁ´½Ó£¬Èç¹û²»ÏëÓòâÊÔÊý¾Ý¿â£¬Ö»ÐèÒªÐ޸Ĺٷ½ÎĵµÖÐÊý¾Ý¿âÅäÖÃÐÅÏ¢¼´¿É¡£ +把这个项目案例下载下æ�¥ä»¥å�Žï¼Œæ‰¾åˆ°é¡¹ç›®å��为seata-xa的目录,里é�¢æœ‰æµ‹è¯•æ•°æ�®åº“的链接,如果ä¸�想用测试数æ�®åº“,å�ªéœ€è¦�修改官方文档中数æ�®åº“é…�置信æ�¯å�³å�¯ã€‚ -Ê×ÏȹØ×¢µÄÊÇ business-xaÏîÄ¿£¬¸ü¶àµÄ¹Ø×¢BusinessService.purchase()·½·¨¡£ +首先关注的是 business-xa项目,更多的关注BusinessService.purchase()方法。 @@ -542,15 +542,15 @@ Seata public void purchase(String userId, String commodityCode, int orderCount, boolean rollback) { String xid = RootContext.getXID(); LOGGER.info("New Transaction Begins: " + xid); - //µ÷ÓÃ¿â´æ¼õ¿â´æ + //调用库存å‡�库存 String result = stockFeignClient.deduct(commodityCode, orderCount); if (!SUCCESS.equals(result)) { - throw new RuntimeException("¿â´æ·þÎñµ÷ÓÃʧ°Ü,ÊÂÎñ»Ø¹ö!"); + throw new RuntimeException("库存æœ�务调用失败,事务回滚!"); } - //Éú³É¶©µ¥ + //生æˆ�订å�• result = orderFeignClient.create(userId, commodityCode, orderCount); if (!SUCCESS.equals(result)) { - throw new RuntimeException("¶©µ¥·þÎñµ÷ÓÃʧ°Ü,ÊÂÎñ»Ø¹ö!"); + throw new RuntimeException("订å�•æœ�务调用失败,事务回滚!"); } if (rollback) { throw new RuntimeException("Force rollback ... "); @@ -568,7 +568,7 @@ Seata -ÆäʵÏÖ·½·¨½Ï֮ǰ²î²»¶à£¬ÎÒÃÇÖ»ÐèÒªÔÚorder-xaÀïÃæ(OrderService.create)£¬Ìí¼ÓÈËΪ´íÎó(int i = 1/0;)¡£ +其实现方法较之å‰�å·®ä¸�多,我们å�ªéœ€è¦�在order-xa里é�¢(OrderService.create),添加人为错误(int i = 1/0;)。 @@ -585,12 +585,12 @@ public void create(String userId, String commodityCode, Integer count) { String xid = RootContext.getXID(); LOGGER.info("create order in transaction: " + xid); int i = 1/0; - // ¶¨µ¥×Ü¼Û = ¶©¹ºÊýÁ¿(count) * ÉÌÆ·µ¥¼Û(100) + // 定å�•总价 = 订购数é‡�(count) * 商å“�å�•ä»·(100) int orderMoney = count * 100; - // Éú³É¶©µ¥ + // 生æˆ�订å�• jdbcTemplate.update("insert order_tbl(user_id,commodity_code,count,money) values(?,?,?,?)", new Object[] {userId, commodityCode, count, orderMoney}); - // µ÷ÓÃÕË»§Óà¶î¿Û¼õ + // 调用账户余é¢�扣å‡� String result = accountFeignClient.reduce(userId, orderMoney); if (!SUCCESS.equals(result)) { throw new RuntimeException("Failed to call Account Service. "); @@ -609,7 +609,7 @@ public void create(String userId, String commodityCode, Integer count) { -ÀïÃæÓÐÒ»¸ö·½·¨¿ÉÒÔ½øÐÐXAģʽºÍATģʽµÄת»»OrderXADataSourceConfiguration.dataSource¡£ +里é�¢æœ‰ä¸€ä¸ªæ–¹æ³•å�¯ä»¥è¿›è¡ŒXA模å¼�å’ŒAT模å¼�的转æ�¢OrderXADataSourceConfiguration.dataSource。 @@ -640,62 +640,62 @@ public void create(String userId, String commodityCode, Integer count) { -ÎÒÃÇÆô¶¯ÕâËĸö·þÎñ£¬·ÃÎʵØÖ· http://localhost:8084/purchase¡£ +我们å�¯åŠ¨è¿™å››ä¸ªæœ�务,访问地å�€ http://localhost:8084/purchase。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d82378852259a962ae041377e8433a31eb8602.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d82378852259a962ae041377e8433a31eb8602.png "图片") -ÎÒÃÇ¿ÉÒÔÆäÖб¨´í£¬È»ºóÔÙÈ¥¿´¶ÔÓ¦Êý¾Ý¿âµÄÊý¾Ý£¬Ã»Óз¢Éú¸ü¸Ä£¬ËµÃ÷ÎÒÃǵÄXAģʽÉúЧÁË£¬µ±ÄãdubugÈ¥¿´ÀïÃæµÄ¿â´æ·þÎñµÄʱºò£¬µ±²Ù×÷Êý¾Ý¸ü¸ÄµÄʱºò£¬Êý¾Ý¿âÀïÃæÆäʵҲÊÇûÓмǼµÄ£¬ÒòΪXAÊÇǿһÖÂÐÔ£¬Ö»Óе±ÊÂÎñ½áÊøÍê³ÉÒԺ󣬲Żá¸ü¸ÄÆäÖеÄÊý¾Ý¡£ +我们å�¯ä»¥å…¶ä¸­æŠ¥é”™ï¼Œç„¶å�Žå†�去看对应数æ�®åº“的数æ�®ï¼Œæ²¡æœ‰å�‘生更改,说明我们的XA模å¼�生效了,当你dubug去看里é�¢çš„库存æœ�务的时候,当æ“�作数æ�®æ›´æ”¹çš„æ—¶å€™ï¼Œæ•°æ�®åº“里é�¢å…¶å®žä¹Ÿæ˜¯æ²¡æœ‰è®°å½•的,因为XA是强一致性,å�ªæœ‰å½“事务结æ�Ÿå®Œæˆ�以å�Žï¼Œæ‰�会更改其中的数æ�®ã€‚ -XAģʽµÄ¼ÓÈ룬²¹ÆëÁËSeataÔÚÈ«¾ÖÒ»ÖÂÐÔ³¡¾°ÏµÄȱ¿Ú£¬ÐγÉÁËAT¡¢TCC¡¢Saga¡¢XA ËÄ´óÊÂÎñģʽµÄ°æÍ¼£¬»ù±¾Âú×ãÁËËùÓг¡¾°·Ö²¼Ê½ÊÂÎñ´¦ÀíµÄÐèÇó¡£ +XA模å¼�的加入,补é½�了Seata在全局一致性场景下的缺å�£ï¼Œå½¢æˆ�了ATã€�TCCã€�Sagaã€�XA 四大事务模å¼�的版图,基本满足了所有场景分布å¼�事务处ç�†çš„需求。 -ÆäÖÐXAºÍATÊÇÎÞÒµÎñÇÖÈëµÄ£¬¶øTCCºÍSagaÊÇÓÐÒ»¶¨ÒµÎñÇÖÈëµÄ¡£ +其中XAå’ŒAT是无业务侵入的,而TCCå’ŒSaga是有一定业务侵入的。 -## Seata-ATģʽ +## Seata-AT模å¼� -ÏÈÀ´½éÉÜÒ»ÏÂATģʽ£¬ATģʽÊÇÒ»ÖÖûÓÐÇÖÈëµÄ·Ö²¼Ê½ÊÂÎñµÄ½â¾ö·½°¸£¬ÔÚATģʽÏ£¬Óû§Ö»Ðè¹Ø×¢×Ô¼ºµÄÒµÎñSQL£¬Óû§µÄÒµÎñSQL×÷Ϊһ½×¶Î£¬Seata¿ò¼Ü»á×Ô¶¯Éú³ÉÊÂÎñ½øÐжþ½×¶ÎÌá½»ºÍ»Ø¹ö²Ù×÷¡£ +å…ˆæ�¥ä»‹ç»�一下AT模å¼�,AT模å¼�是一ç§�没有侵入的分布å¼�事务的解决方案,在AT模å¼�下,用户å�ªéœ€å…³æ³¨è‡ªå·±çš„业务SQL,用户的业务SQL作为一阶段,Seata框架会自动生æˆ�事务进行二阶段æ��交和回滚æ“�作。 -**Á½½×¶ÎÌύЭÒéµÄÑݱ䣺** +**两阶段æ��交å��议的演å�˜ï¼š** -* Ò»½×¶Î£ºÒµÎñÊý¾ÝºÍ»Ø¹öÈÕÖ¾¼Ç¼ÔÚͬһ¸ö±¾µØÊÂÎñÖÐÌá½»£¬Êͷű¾µØËøºÍÁ¬½Ó×ÊÔ´¡£ -* ¶þ½×¶Î£º - Ìá½»Òì²½»¯£¬·Ç³£¿ìËÙµØÍê³É¡£ - »Ø¹öͨ¹ýÒ»½×¶ÎµÄ»Ø¹öÈÕÖ¾½øÐз´Ïò²¹³¥¡£ +* 一阶段:业务数æ�®å’Œå›žæ»šæ—¥å¿—记录在å�Œä¸€ä¸ªæœ¬åœ°äº‹åС䏭æ��交,释放本地é”�和连接资æº�。 +* 二阶段: + æ��交异步化,é�žå¸¸å¿«é€Ÿåœ°å®Œæˆ�。 + 回滚通过一阶段的回滚日志进行å��å�‘è¡¥å�¿ã€‚ -#### ATģʽÖ÷ÒªÌØµã +#### AT模å¼�主è¦�特点 -1. ×îÖÕÒ»ÖÂÐÔ¡£ -2. ÐÔÄܽÏXA¸ß¡£ -3. Ö»ÔÚµÚÒ»½×¶Î»ñÈ¡Ëø£¬ÔÚµÚÒ»½×¶Î½øÐÐÌá½»ºóÊÍ·ÅËø¡£ +1. 最终一致性。 +2. 性能较XA高。 +3. å�ªåœ¨ç¬¬ä¸€é˜¶æ®µèŽ·å�–é”�,在第一阶段进行æ��交å�Žé‡Šæ”¾é”�。 -ÔÚÒ»½×¶ÎÖУ¬Seata»áÀ¹½Ø ÒµÎñSQL £¬Ê×ÏȽâÎöSQLÓïÒ壬ÕÒµ½Òª²Ù×÷µÄÒµÎñÊý¾Ý£¬ÔÚÊý¾Ý±»²Ù×÷ǰ£¬±£´æÏÂÀ´¼Ç¼ undo log£¬È»ºóÖ´ÐÐ ÒµÎñSQL ¸üÐÂÊý¾Ý£¬¸üÐÂÖ®ºóÔٴα£´æÊý¾Ý redo log£¬×îºóÉú³ÉÐÐËø£¬ÕâЩ²Ù×÷¶¼ÔÚ±¾µØÊý¾Ý¿âÊÂÎñÄÚÍê³É£¬ÕâÑù±£Ö¤ÁËÒ»½×¶ÎµÄÔ­×ÓÐÔ¡£ +在一阶段中,Seata会拦截 业务SQL ,首先解æž�SQL语义,找到è¦�æ“�作的业务数æ�®ï¼Œåœ¨æ•°æ�®è¢«æ“�作å‰�,ä¿�存下æ�¥è®°å½• undo log,然å�Žæ‰§è¡Œ 业务SQL æ›´æ–°æ•°æ�®ï¼Œæ›´æ–°ä¹‹å�Žå†�次ä¿�存数æ�® redo log,最å�Žç”Ÿæˆ�行é”�,这些æ“�作都在本地数æ�®åº“事务内完æˆ�,这样ä¿�è¯�了一阶段的原å­�性。 -Ïà¶ÔÒ»½×¶Î£¬¶þ½×¶Î±È½Ï¼òµ¥£¬¸ºÔðÕûÌåµÄ»Ø¹öºÍÌá½»£¬Èç¹û֮ǰµÄÒ»½×¶ÎÖÐÓб¾µØÊÂÎñûÓÐͨ¹ý£¬ÄÇô¾ÍÖ´ÐÐÈ«¾Ö»Ø¹ö£¬·ñÔÚÖ´ÐÐÈ«¾ÖÌá½»£¬»Ø¹öÓõ½µÄ¾ÍÊÇÒ»½×¶Î¼Ç¼µÄ undo Log £¬Í¨¹ý»Ø¹ö¼Ç¼Éú³É·´Ïò¸üÐÂSQL²¢Ö´ÐУ¬ÒÔÍê³É·ÖÖ§µÄ»Ø¹ö¡£µ±È»ÊÂÎñÍê³Éºó»áÊÍ·ÅËùÓÐ×ÊÔ´ºÍɾ³ýËùÓÐÈÕÖ¾¡£ +相对一阶段,二阶段比较简å�•,负责整体的回滚和æ��交,如果之å‰�的一阶段中有本地事务没有通过,那么就执行全局回滚,å�¦åœ¨æ‰§è¡Œå…¨å±€æ��交,回滚用到的就是一阶段记录的 undo Log ,通过回滚记录生æˆ�å��å�‘æ›´æ–°SQL并执行,以完æˆ�分支的回滚。当然事务完æˆ�å�Žä¼šé‡Šæ”¾æ‰€æœ‰èµ„æº�和删除所有日志。 -ATÁ÷³Ì·ÖΪÁ½½×¶Î£¬Ö÷ÒªÂß¼­È«²¿ÔÚµÚÒ»½×¶Î£¬µÚ¶þ½×¶ÎÖ÷Òª×ö»Ø¹ö»òÈÕÖ¾ÇåÀíµÄ¹¤×÷¡£Á÷³ÌÈçÏ£º +ATæµ�程分为两阶段,主è¦�逻辑全部在第一阶段,第二阶段主è¦�å�šå›žæ»šæˆ–日志清ç�†çš„工作。æµ�程如下: -![ͼƬ](https://s9.51cto.com/oss/202207/03/c7d9f9e7001e9fca3d8309b146f3014ecfbf06.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/02880c46589d54a3f12449afa76a44e9b8e73a.png "ͼƬ") +![图片](https://s9.51cto.com/oss/202207/03/c7d9f9e7001e9fca3d8309b146f3014ecfbf06.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/02880c46589d54a3f12449afa76a44e9b8e73a.png "图片") -´ÓÉÏͼÖÐÎÒÃÇ¿ÉÒÔ¿´µ½£¬¶©µ¥·þÎñÖÐTMÏòTCÉêÇ뿪ÆôÒ»¸öÈ«¾ÖÊÂÎñ£¬Ò»°ãͨ¹ý@GlobalTransactional±ê×¢¿ªÆô£¬TC»á·µ»ØÒ»¸öÈ«¾ÖÊÂÎñID(XID)£¬¶©µ¥·þÎñÔÚÖ´Ðб¾µØÊÂÎñ֮ǰ£¬RM»áÏÈÏòTC×¢²áÒ»¸ö·ÖÖ§ÊÂÎñ£¬ ¶©µ¥·þÎñÒÀ´ÎÉú³Éundo log Ö´Ðб¾µØÊÂÎñ£¬Éú³Éredo log Ìá½»±¾µØÊÂÎñ£¬ÏòTC»ã±¨£¬ÊÂÎñÖ´ÐÐOK¡£ +从上图中我们å�¯ä»¥çœ‹åˆ°ï¼Œè®¢å�•æœ�务中TMå�‘TC申请开å�¯ä¸€ä¸ªå…¨å±€äº‹åŠ¡ï¼Œä¸€èˆ¬é€šè¿‡@GlobalTransactional标注开å�¯ï¼ŒTC会返回一个全局事务ID(XID),订å�•æœ�务在执行本地事务之å‰�,RM会先å�‘TC注册一个分支事务, 订å�•æœ�务ä¾�次生æˆ�undo log 执行本地事务,生æˆ�redo log æ��交本地事务,å�‘TC汇报,事务执行OK。 -¶©µ¥·þÎñ·¢ÆðÔ¶³Ìµ÷Ó㬽«ÊÂÎñID´«µÝ¸ø¿â´æ·þÎñ£¬¿â´æ·þÎñÔÚÖ´Ðб¾µØÊÂÎñ֮ǰ£¬ÏÈÏòTC×¢²á·ÖÖ§ÊÂÎñ£¬¿â´æ·þÎñͬÑùÉú³Éundo LogºÍredo Log£¬ÏòTC»ã±¨£¬ÊÂÎñ״̬³É¹¦¡£ +订å�•æœ�务å�‘起远程调用,将事务ID传递给库存æœ�务,库存æœ�务在执行本地事务之å‰�,先å�‘TC注册分支事务,库存æœ�务å�Œæ ·ç”Ÿæˆ�undo Logå’Œredo Log,å�‘TC汇报,事务状æ€�æˆ�功。 -Èç¹ûÕý³£È«¾ÖÌá½»£¬TC֪ͨRMÒ»²½ÇåÀíµô±¾µØundoºÍredoÈÕÖ¾£¬Èç¹û´æÔÚÒ»¸ö·þÎñÖ´ÐÐʧ°Ü£¬ÄÇô·¢Æð»Ø¹öÇëÇó¡£Í¨¹ýundo log½øÐлعö¡£ +如果正常全局æ��交,TC通知RM一步清ç�†æŽ‰æœ¬åœ°undoå’Œredo日志,如果存在一个æœ�务执行失败,那么å�‘起回滚请求。通过undo log进行回滚。 -ÔÚÕâÀﻹ»á´æÔÚÒ»¸öÎÊÌ⣬ÒòΪÿ¸öÊÂÎñ´Ó±¾µØÌá½»µ½Í¨Öª»Ø¹öÕâ¶Îʱ¼äÀïÃæ£¬¿ÉÄÜÕâÌõÊý¾ÝÒѾ­±»ÆäËûÊÂÎñ½øÐÐÐ޸ģ¬Èç¹ûÖ±½ÓÓÃundo log½øÐлعö£¬¿ÉÄܻᵼÖÂÊý¾Ý²»Ò»ÖµÄÇé¿ö£¬ +在这里还会存在一个问题,因为æ¯�个事务从本地æ��交到通知回滚这段时间里é�¢ï¼Œå�¯èƒ½è¿™æ�¡æ•°æ�®å·²ç»�被其他事务进行修改,如果直接用undo log进行回滚,å�¯èƒ½ä¼šå¯¼è‡´æ•°æ�®ä¸�一致的情况, -Õâ¸öʱºò RM»áÓà redo log½øÐÐÑéÖ¤£¬¶Ô±ÈÊý¾ÝÊÇ·ñÒ»Ñù£¬´Ó¶øµÃÖªÊý¾ÝÊÇ·ñÓбðµÄÊÂÎñ½øÐÐÐ޸Ĺý£¬undo logÊÇÓÃÓÚ±»ÐÞ¸ÄǰµÄÊý¾Ý£¬¿ÉÒÔÓÃÀ´»Ø¹ö£¬redologÊÇÓÃÓÚ±»Ð޸ĺóµÄÊý¾Ý£¬ÓÃÓڻعöУÑé¡£ +这个时候 RM会用 redo log进行验è¯�,对比数æ�®æ˜¯å�¦ä¸€æ ·ï¼Œä»Žè€Œå¾—知数æ�®æ˜¯å�¦æœ‰åˆ«çš„事务进行修改过,undo log是用于被修改å‰�的数æ�®ï¼Œå�¯ä»¥ç”¨æ�¥å›žæ»šï¼Œredolog是用于被修改å�Žçš„æ•°æ�®ï¼Œç”¨äºŽå›žæ»šæ ¡éªŒã€‚ -Èç¹ûÊý¾ÝûÓб»ÆäËûÊÂÎñÐ޸Ĺý£¬¿ÉÒÔÖ±½Ó½øÐлعö£¬Èç¹ûÊÇÔàÊý¾Ý£¬redologУÑéºó½øÐд¦Àí¡£ +如果数æ�®æ²¡æœ‰è¢«å…¶ä»–事务修改过,å�¯ä»¥ç›´æŽ¥è¿›è¡Œå›žæ»šï¼Œå¦‚果是è„�æ•°æ�®ï¼Œredolog校验å�Žè¿›è¡Œå¤„ç�†ã€‚ -### ʵս +### 实战 -Á˽âÁËATÄ£Ð͵Ļù±¾²Ù×÷£¬½ÓÏÂÀ´¾ÍÀ´ÊµÕ½²Ù×÷һϣ¬¹ØÓÚATÄ£Ð;ßÌåÊÇÈçºÎʵÏֵġ£Ê×ÏÈÉè¼ÆÁ½¸ö·þÎñ cloud-alibaba-seata-order ºÍ cloud-alibaba-seata-stock¡£ +了解了AT模型的基本æ“�作,接下æ�¥å°±æ�¥å®žæˆ˜æ“�作一下,关于AT模型具体是如何实现的。首先设计两个æœ�务 cloud-alibaba-seata-order å’Œ cloud-alibaba-seata-stock。 -±í½á¹¹t_order¡¢t_stockºÍundo_logÈýÕÅ±í£¬ÏîĿԴÂëºÍ±í½á¹¹£¬¼ÓÉÏundo_log±í£¬´Ë±íÓÃÓÚÊý¾ÝµÄ»Ø¹ö£¬ÎÄÄ©ÓÐÁ´½Ó¡£ +表结构t_orderã€�t_stockå’Œundo_log三张表,项目æº�ç �和表结构,加上undo_log表,此表用于数æ�®çš„回滚,文末有链接。 -cloud-alibaba-seata-orderºËÐÄ´úÂëÈçÏ£º +cloud-alibaba-seata-order核心代ç �如下: -controller£º +controller: @@ -712,10 +712,10 @@ public class OrderController { @Autowired private OrderService orderService; @GetMapping("order/create") - @GlobalTransactional //¿ªÆô·Ö²¼Ê½ÊÂÎñ + @GlobalTransactional //å¼€å�¯åˆ†å¸ƒå¼�事务 public String create(){ orderService.create(); - return "¶©µ¥´´½¨³É¹¦£¡"; + return "订å�•创建æˆ�功ï¼�"; } } ``` @@ -730,7 +730,7 @@ public class OrderController { -OrderService£º +OrderService: @@ -757,7 +757,7 @@ public interface OrderService { -StockClient£º +StockClient: @@ -787,7 +787,7 @@ public interface StockClient { -OrderServiceImpl£º +OrderServiceImpl: @@ -807,15 +807,15 @@ public class OrderServiceImpl implements OrderService{ private StockClient stockClient; @Override public void create() { - //¿Û¼õ¿â´æ + //扣å‡�库存 stockClient.reduce(); - System.out.println("¿Û¼õ¿â´æ³É¹¦£¡"); - //ÊÖ¹¤Òì³£ ÓÃÓڻعö¿â´æÐÅÏ¢ + System.out.println("扣å‡�库存æˆ�功ï¼�"); + //手工异常 用于回滚库存信æ�¯ int i = 1/0; - System.err.println("Òì³££¡"); - //´´½¨¶©µ¥ + System.err.println("异常ï¼�"); + //创建订å�• orderMapper.createOrder(); - System.out.println("´´½¨¶©µ¥³É¹¦£¡"); + System.out.println("创建订å�•æˆ�功ï¼�"); } } ``` @@ -830,7 +830,7 @@ public class OrderServiceImpl implements OrderService{ -OrderMapper£º +OrderMapper: @@ -859,7 +859,7 @@ public interface OrderMapper { -cloud-alibaba-seata-stockºËÐÄ´úÂëÈçÏ£º +cloud-alibaba-seata-stock核心代ç �如下: @@ -878,7 +878,7 @@ public class StockController { @GetMapping("stock/reduce") public String reduce(){ stockService.reduce(); - return "¿â´æÊýÁ¿Òѿۼõ£º"+ new Date(); + return "库存数é‡�已扣å‡�:"+ new Date(); } } ``` @@ -978,95 +978,95 @@ public interface StockMapper { -´úÂë¶¼±È½Ï¼òµ¥£¬ÎÒÃǾͲ»×ö¹ý¶àµÄÃèÊö£¬»ù±¾×¢ÊÍÒ²¶¼ÓУ¬£¬Ê×ÏÈÎÒÃÇÐèÒª½«orderºÍstock·þÎñ¶¼ÅÜÆðÀ´£¬ÔÚ֮ǰÎÒÃǵÄNacosºÍSeata¶¼ÒªÆô¶¯ÆðÀ´£¬Õâ¸öʱºòÎÒÃÇ·ÃÎÊorderµÄRest½Ó¿Ú£¬http://localhost:8087/order/create,ΪÁËÑéÖ¤undo_logµÄ±íÊÇÓÃÓÚ´æ´¢»Ø¹öÊý¾Ý£¬ÎÒÃÇÔÚOrderServiceImpl.create()ÖÐÌí¼Ó¶Ïµã£¬ÓÃdebugµÄ·½Ê½Æô¶¯¡£ +代ç �都比较简å�•,我们就ä¸�å�šè¿‡å¤šçš„æ��述,基本注释也都有,,首先我们需è¦�å°†orderå’Œstockæœ�务都跑起æ�¥ï¼Œåœ¨ä¹‹å‰�我们的Nacoså’ŒSeata都è¦�å�¯åŠ¨èµ·æ�¥ï¼Œè¿™ä¸ªæ—¶å€™æˆ‘们访问orderçš„Rest接å�£ï¼Œhttp://localhost:8087/order/create,为了验è¯�undo_log的表是用于存储回滚数æ�®ï¼Œæˆ‘们在OrderServiceImpl.create()中添加断点,用debug的方å¼�å�¯åŠ¨ã€‚ -![ͼƬ](https://s5.51cto.com/oss/202207/03/e9df0649789b2ad3b0a9120c1992f9a7e55cb9.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/64e370d42b8375a8f7a1285cc1bc47b1437bff.png "ͼƬ") +![图片](https://s5.51cto.com/oss/202207/03/e9df0649789b2ad3b0a9120c1992f9a7e55cb9.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/64e370d42b8375a8f7a1285cc1bc47b1437bff.png "图片") -È»ºó·ÃÎÊhttp://localhost:8087/order/create£¬µ±³ÌÐò¿¨ÔÚÕâ¸ö½ÚµãµÄʱ¼ä£¬ÎÒÃÇÈ¥¿´undo_logºÍ¿â´æ±í£¬»á·¢ÏÖ£¬¿â´æÈ·Êµ¼õÉÙÁË£¬¶øÇÒundo_logÒ²³öÏÖÁ˶ÔÓ¦µÄ¿ìÕռǼÐ޸ĵ±Ç°µÄÊý¾ÝÐÅÏ¢£¬Õâ¸öÊý¾Ý¾ÍÊÇÓÃÀ´»Ø¹öµÄÊý¾Ý¡£ +ç„¶å�Žè®¿é—®http://localhost:8087/order/create,当程åº�å�¡åœ¨è¿™ä¸ªèŠ‚ç‚¹çš„æ—¶é—´ï¼Œæˆ‘ä»¬åŽ»çœ‹undo_log和库存表,会å�‘现,库存确实å‡�少了,而且undo_log也出现了对应的快照记录修改当å‰�的数æ�®ä¿¡æ�¯ï¼Œè¿™ä¸ªæ•°æ�®å°±æ˜¯ç”¨æ�¥å›žæ»šçš„æ•°æ�®ã€‚ -![ͼƬ](https://s8.51cto.com/oss/202207/03/9361fc3173dcb931a615608893af1f48fbeed0.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/567b564906d2c473d3d770087b745a5218587f.png "ͼƬ") +![图片](https://s8.51cto.com/oss/202207/03/9361fc3173dcb931a615608893af1f48fbeed0.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/567b564906d2c473d3d770087b745a5218587f.png "图片") -µ«Êǵ±ÎÒÃÇF9ͨ¹ýÒÔºó£¬¿â´æÊýÁ¿»Ö¸´£¬²¢ÇÒundo_log±íµÄÊý¾ÝÐÐҲûÓÐÁË£¬Õâ¸öʱºòÖ¤Ã÷ÎÒÃǵÄSeataÊÂÎñÉúЧ£¬»Ø¹ö³É¹¦¡£ +但是当我们F9通过以å�Žï¼Œåº“存数é‡�æ�¢å¤�,并且undo_log表的数æ�®è¡Œä¹Ÿæ²¡æœ‰äº†ï¼Œè¿™ä¸ªæ—¶å€™è¯�明我们的Seata事务生效,回滚æˆ�功。 -![ͼƬ](https://s8.51cto.com/oss/202207/03/66c11ca96212ce62540349442f14ccff8b87a4.gif "ͼƬ")![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/75cd0d103bd57d300e5194f66aa826f8494b94.png "ͼƬ") +![图片](https://s8.51cto.com/oss/202207/03/66c11ca96212ce62540349442f14ccff8b87a4.gif "图片")![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/75cd0d103bd57d300e5194f66aa826f8494b94.png "图片") -µ½ÕâÀïÎÒÃǾÍÑéÖ¤ÁËATÊÂÎñµÄÖ´Ðйý³Ì£¬Ïà±ÈÓÚXAºÍTCCµÈÊÂÎñÄ£ÐÍ£¬SeataµÄATÄ£ÐÍ¿ÉÒÔÓ¦¶Ô´ó¶àÊýµÄÒµÎñ³¡¾°£¬²¢ÇÒ¿ÉÒÔ×öµ½ÎÞÒµÎñÇÖÈ룬¿ª·¢ÕßÎÞ¸ÐÖª£¬¶ÔÓÚÕû¸öÊÂÎñµÄЭµ÷¡¢Ìá½»»òÕ߻عö²Ù×÷£¬¶¼¿ÉÒÔͨ¹ýAOPÍê³É£¬¿ª·¢ÕßÖ»ÐèÒª¹Ø×¢ÒµÎñ¼´¿É¡£ +到这里我们就验è¯�了AT事务的执行过程,相比于XAå’ŒTCC等事务模型,Seataçš„AT模型å�¯ä»¥åº”对大多数的业务场景,并且å�¯ä»¥å�šåˆ°æ— ä¸šåŠ¡ä¾µå…¥ï¼Œå¼€å�‘者无感知,对于整个事务的å��è°ƒã€�æ��交或者回滚æ“�作,都å�¯ä»¥é€šè¿‡AOP完æˆ�,开å�‘者å�ªéœ€è¦�关注业务å�³å�¯ã€‚ -ÓÉÓÚSeataÐèÒªÔÚ²»Í¬µÄ·þÎñÖ®¼ä´«µÝÈ«¾ÖΨһµÄÊÂÎñID£¬ºÍDubboµÈ¿ò¼Ü¼¯³É»á±È½ÏÓѺã¬ÀýÈçDubbo¿ÉÒÔÓùýÒþÊ¿´«²ÎÀ´½øÐÐÊÂÎñIDµÄ´«µÝ£¬Õû¸öÊÂÎñIDµÄ´«²¥¹ý³Ì¶Ô¿ª·¢ÕßÒ²¿ÉÒÔ×öµ½ÎÞ¸ÐÖª¡£ +由于Seata需è¦�在ä¸�å�Œçš„æœ�务之间传递全局唯一的事务ID,和Dubbo等框架集æˆ�会比较å�‹å¥½ï¼Œä¾‹å¦‚Dubboå�¯ä»¥ç”¨è¿‡éš�士传å�‚æ�¥è¿›è¡Œäº‹åŠ¡ID的传递,整个事务ID的传播过程对开å�‘者也å�¯ä»¥å�šåˆ°æ— æ„ŸçŸ¥ã€‚ -## Seata-TCCģʽ +## Seata-TCC模å¼� -¾ßÌåʹÓð¸Àý£ºhttps://seata.io/zh-cn/blog/integrate-seata-tcc-mode-with-spring-cloud.html¡£ +具体使用案例:https://seata.io/zh-cn/blog/integrate-seata-tcc-mode-with-spring-cloud.html。 -### ʲôÊÇTCC +### 什么是TCC -TCC ÊÇ·Ö²¼Ê½ÊÂÎñÖеĶþ½×¶ÎÌύЭÒ飬ËüµÄÈ«³ÆÎª Try-Confirm-Cancel£¬¼´×ÊÔ´Ô¤Áô£¨Try£©¡¢È·ÈϲÙ×÷£¨Confirm£©¡¢È¡Ïû²Ù×÷£¨Cancel£©£¬ËûÃǵľßÌ庬ÒåÈçÏ£º +TCC 是分布å¼�事务中的二阶段æ��交å��议,它的全称为 Try-Confirm-Cancel,å�³èµ„æº�预留(Try)ã€�确认æ“�作(Confirm)ã€�å�–消æ“�作(Cancel),他们的具体å�«ä¹‰å¦‚下: -1. Try£º¶ÔÒµÎñ×ÊÔ´µÄ¼ì²é²¢Ô¤Áô¡£ -2. Confirm£º¶ÔÒµÎñ´¦Àí½øÐÐÌá½»£¬¼´ commit ²Ù×÷£¬Ö»Òª Try ³É¹¦£¬ÄÇô¸Ã²½ÖèÒ»¶¨³É¹¦¡£ -3. Cancel£º¶ÔÒµÎñ´¦Àí½øÐÐÈ¡Ïû£¬¼´»Ø¹ö²Ù×÷£¬¸Ã²½Öè»Ø¶Ô Try Ô¤ÁôµÄ×ÊÔ´½øÐÐÊÍ·Å¡£ +1. Try:对业务资æº�的检查并预留。 +2. Confirm:对业务处ç�†è¿›è¡Œæ��交,å�³ commit æ“�作,å�ªè¦� Try æˆ�功,那么该步骤一定æˆ�功。 +3. Cancel:对业务处ç�†è¿›è¡Œå�–消,å�³å›žæ»šæ“�作,该步骤回对 Try 预留的资æº�进行释放。 -TCC ÊÇÒ»ÖÖÇÖÈëʽµÄ·Ö²¼Ê½ÊÂÎñ½â¾ö·½°¸£¬ÒÔÉÏÈý¸ö²Ù×÷¶¼ÐèÒªÒµÎñϵͳ×ÔÐÐʵÏÖ£¬¶ÔÒµÎñϵͳÓÐ×ŷdz£´óµÄÈëÇÖÐÔ£¬Éè¼ÆÏà¶Ô¸´ÔÓ£¬µ«ÓŵãÊÇ TCC ÍêÈ«²»ÒÀÀµÊý¾Ý¿â£¬Äܹ»ÊµÏÖ¿çÊý¾Ý¿â¡¢¿çÓ¦ÓÃ×ÊÔ´¹ÜÀí£¬¶ÔÕâЩ²»Í¬Êý¾Ý·ÃÎÊͨ¹ýÇÖÈëʽµÄ±àÂ뷽ʽʵÏÖÒ»¸öÔ­×Ó²Ù×÷£¬¸üºÃµØ½â¾öÁËÔÚ¸÷ÖÖ¸´ÔÓÒµÎñ³¡¾°Ïµķֲ¼Ê½ÊÂÎñÎÊÌâ¡£ +TCC 是一ç§�侵入å¼�的分布å¼�事务解决方案,以上三个æ“�作都需è¦�业务系统自行实现,对业务系统有ç�€é�žå¸¸å¤§çš„入侵性,设计相对å¤�æ�‚,但优点是 TCC 完全ä¸�ä¾�èµ–æ•°æ�®åº“,能够实现跨数æ�®åº“ã€�跨应用资æº�管ç�†ï¼Œå¯¹è¿™äº›ä¸�å�Œæ•°æ�®è®¿é—®é€šè¿‡ä¾µå…¥å¼�的编ç �æ–¹å¼�实现一个原å­�æ“�作,更好地解决了在å�„ç§�å¤�æ�‚业务场景下的分布å¼�事务问题。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1431eaa67529de68d4f9506ae25dc17c3882b8.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1431eaa67529de68d4f9506ae25dc17c3882b8.png "图片") -### TCCºÍATÇø±ð +### TCCå’ŒAT区别 -AT ģʽ»ùÓÚ Ö§³Ö±¾µØ ACID ÊÂÎñ µÄ ¹ØÏµÐÍÊý¾Ý¿â£º +AT 模å¼�基于 支æŒ�本地 ACID 事务 çš„ 关系型数æ�®åº“: -* Ò»½×¶Î prepare ÐÐΪ£ºÔÚ±¾µØÊÂÎñÖУ¬Ò»²¢Ìá½»ÒµÎñÊý¾Ý¸üкÍÏàÓ¦»Ø¹öÈÕÖ¾¼Ç¼¡£ -* ¶þ½×¶Î commit ÐÐΪ£ºÂíÉϳɹ¦½áÊø£¬**×Ô¶¯**Òì²½ÅúÁ¿ÇåÀí»Ø¹öÈÕÖ¾¡£ -* ¶þ½×¶Î rollback ÐÐΪ£ºÍ¨¹ý»Ø¹öÈÕÖ¾£¬**×Ô¶¯**Éú³É²¹³¥²Ù×÷£¬Íê³ÉÊý¾Ý»Ø¹ö¡£ +* 一阶段 prepare 行为:在本地事务中,一并æ��交业务数æ�®æ›´æ–°å’Œç›¸åº”回滚日志记录。 +* 二阶段 commit 行为:马上æˆ�功结æ�Ÿï¼Œ**自动**异步批é‡�清ç�†å›žæ»šæ—¥å¿—。 +* 二阶段 rollback 行为:通过回滚日志,**自动**生æˆ�è¡¥å�¿æ“�作,完æˆ�æ•°æ�®å›žæ»šã€‚ -ÏàÓ¦µÄ£¬TCC ģʽ£¬²»ÒÀÀµÓڵײãÊý¾Ý×ÊÔ´µÄÊÂÎñÖ§³Ö£º +相应的,TCC 模å¼�,ä¸�ä¾�赖于底层数æ�®èµ„æº�的事务支æŒ�: -* Ò»½×¶Î prepare ÐÐΪ£ºµ÷ÓÃ**×Ô¶¨Òå**µÄ prepare Âß¼­¡£ -* ¶þ½×¶Î commit ÐÐΪ£ºµ÷ÓÃ**×Ô¶¨Òå**µÄ commit Âß¼­¡£ -* ¶þ½×¶Î rollback ÐÐΪ£ºµ÷ÓÃ**×Ô¶¨Òå**µÄ rollback Âß¼­¡£ +* 一阶段 prepare 行为:调用**自定义**çš„ prepare 逻辑。 +* 二阶段 commit 行为:调用**自定义**çš„ commit 逻辑。 +* 二阶段 rollback 行为:调用**自定义**çš„ rollback 逻辑。 -Ëùν TCC ģʽ£¬ÊÇÖ¸Ö§³Ö°Ñ **×Ô¶¨Òå** µÄ·ÖÖ§ÊÂÎñÄÉÈ뵽ȫ¾ÖÊÂÎñµÄ¹ÜÀíÖС£ +所谓 TCC 模å¼�,是指支æŒ�把 **自定义** 的分支事务纳入到全局事务的管ç�†ä¸­ã€‚ -#### ÌØµã£º +#### 特点: -1. ÇÖÈëÐԱȽÏÇ¿£¬²¢ÇÒÐèÒª×Ô¼ºÊµÏÖÏà¹ØÊÂÎñ¿ØÖÆÂß¼­ -2. ÔÚÕû¸ö¹ý³Ì»ù±¾Ã»ÓÐËø£¬ÐÔÄܽÏÇ¿ +1. 侵入性比较强,并且需è¦�自己实现相关事务控制逻辑 +2. 在整个过程基本没有é”�,性能较强 -## Seata-Sagaģʽ +## Seata-Saga模å¼� -SagaģʽÊÇSEATAÌṩµÄ³¤ÊÂÎñ½â¾ö·½°¸£¬ÔÚSagaģʽÖУ¬ÒµÎñÁ÷³ÌÖÐÿ¸ö²ÎÓëÕß¶¼Ìá½»±¾µØÊÂÎñ£¬µ±³öÏÖijһ¸ö²ÎÓëÕßʧ°ÜÔò²¹³¥Ç°ÃæÒѾ­³É¹¦µÄ²ÎÓëÕߣ¬Ò»½×¶ÎÕýÏò·þÎñºÍ¶þ½×¶Î²¹³¥·þÎñ£¨Ö´Ðд¦Àíʱºò³ö´íÁË£¬¸øÒ»¸öÐÞ¸´µÄ»ú»á£©¶¼ÓÉÒµÎñ¿ª·¢ÊµÏÖ¡£ +Saga模å¼�是SEATAæ��供的长事务解决方案,在Saga模å¼�中,业务æµ�程中æ¯�个å�‚与者都æ��交本地事务,当出现æŸ�一个å�‚与者失败则补å�¿å‰�é�¢å·²ç»�æˆ�功的å�‚与者,一阶段正å�‘æœ�务和二阶段补å�¿æœ�务(执行处ç�†æ—¶å€™å‡ºé”™äº†ï¼Œç»™ä¸€ä¸ªä¿®å¤�的机会)都由业务开å�‘实现。 -Saga ģʽÏ·ֲ¼Ê½ÊÂÎñͨ³£ÊÇÓÉʼþÇý¶¯µÄ£¬¸÷¸ö²ÎÓëÕßÖ®¼äÊÇÒì²½Ö´Ðеģ¬Saga ģʽÊÇÒ»ÖÖ³¤ÊÂÎñ½â¾ö·½°¸¡£ +Saga 模å¼�下分布å¼�事务通常是由事件驱动的,å�„个å�‚与者之间是异步执行的,Saga 模å¼�是一ç§�长事务解决方案。 -֮ǰÎÒÃÇѧϰµÄSeata·Ö²¼Ê½ÈýÖÖ²Ù×÷Ä£ÐÍÖÐËùʹÓõĵÄ΢·þÎñÈ«²¿¿ÉÒÔ¸ù¾Ý¿ª·¢ÕßµÄÐèÇó½øÐÐÐ޸쬵«ÊÇÔÚÒ»Ð©ÌØÊâ»·¾³Ï£¬±ÈÈçÀÏϵͳ£¬·â±ÕµÄϵͳ£¨ÎÞ·¨Ð޸ģ¬Í¬Ê±Ã»ÓÐÈκηֲ¼Ê½ÊÂÎñÒýÈ룩£¬ÄÇôAT¡¢XA¡¢TCCÄ£Ðͽ«È«²¿²»ÄÜʹÓã¬ÎªÁ˽â¾öÕâÑùµÄÎÊÌ⣬²ÅÒýÓÃÁËSagaÄ£ÐÍ¡£ +之å‰�我们学习的Seata分布å¼�三ç§�æ“�作模型中所使用的的微æœ�务全部å�¯ä»¥æ ¹æ�®å¼€å�‘者的需求进行修改,但是在一些特殊环境下,比如è€�系统,å°�闭的系统(无法修改,å�Œæ—¶æ²¡æœ‰ä»»ä½•分布å¼�事务引入),那么ATã€�XAã€�TCC模型将全部ä¸�能使用,为了解决这样的问题,æ‰�引用了Saga模型。 -±ÈÈ磺ÊÂÎñ²ÎÓëÕß¿ÉÄÜÊÇÆäËû¹«Ë¾µÄ·þÎñ»òÕßÊÇÒÅÁôϵͳ£¬ÎÞ·¨¸ÄÔ죬¿ÉÒÔʹÓÃSagaģʽ¡£ +比如:事务å�‚与者å�¯èƒ½æ˜¯å…¶ä»–å…¬å�¸çš„æœ�务或者是é�—留系统,无法改造,å�¯ä»¥ä½¿ç”¨Saga模å¼�。 -![ͼƬ](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e923ef663d8c0a9de06072d96c6debbac49795.png "ͼƬ") +![图片](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e923ef663d8c0a9de06072d96c6debbac49795.png "图片") -SagaģʽÊÇSeataÌṩµÄ³¤ÊÂÎñ½â¾ö·½°¸£¬ÌṩÁËÒ칹ϵͳµÄÊÂÎñͳһ´¦ÀíÄ£ÐÍ¡£ÔÚSagaģʽÖУ¬ËùÓеÄ×ÓÒµÎñ¶¼²»ÔÚÖ±½Ó²ÎÓëÕûÌåÊÂÎñµÄ´¦Àí£¨Ö»¸ºÔð±¾µØÊÂÎñµÄ´¦Àí£©£¬¶øÊÇÈ«²¿½»ÓÉÁË×îÖÕµ÷ÓöËÀ´¸ºÔðʵÏÖ£¬¶øÔÚ½øÐÐ×ÜÒµÎñÂß¼­´¦Àíʱ£¬ÔÚijһ¸ö×ÓÒµÎñ³öÏÖÎÊÌâʱ£¬Ôò×Ô¶¯²¹³¥È«ÃæÒѾ­³É¹¦µÄÆäËû²ÎÓëÕߣ¬ÕâÑùÒ»½×¶ÎµÄÕýÏò·þÎñµ÷ÓúͶþ½×¶ÎµÄ·þÎñ²¹³¥´¦ÀíÈ«²¿ÓÉ×ÜÒµÎñ¿ª·¢ÊµÏÖ¡£ +Saga模å¼�是Seataæ��供的长事务解决方案,æ��供了异构系统的事务统一处ç�†æ¨¡åž‹ã€‚在Saga模å¼�中,所有的å­�业务都ä¸�在直接å�‚与整体事务的处ç�†ï¼ˆå�ªè´Ÿè´£æœ¬åœ°äº‹åŠ¡çš„å¤„ç�†ï¼‰ï¼Œè€Œæ˜¯å…¨éƒ¨äº¤ç”±äº†æœ€ç»ˆè°ƒç”¨ç«¯æ�¥è´Ÿè´£å®žçŽ°ï¼Œè€Œåœ¨è¿›è¡Œæ€»ä¸šåŠ¡é€»è¾‘å¤„ç�†æ—¶ï¼Œåœ¨æŸ�一个å­�业务出现问题时,则自动补å�¿å…¨é�¢å·²ç»�æˆ�功的其他å�‚与者,这样一阶段的正å�‘æœ�务调用和二阶段的æœ�务补å�¿å¤„ç�†å…¨éƒ¨ç”±æ€»ä¸šåС开å�‘实现。 -### Saga״̬»ú +### Saga状æ€�机 -ĿǰSeataÌṩµÄSagaģʽֻÄÜͨ¹ý״̬»úÒýÇæÀ´ÊµÏÖ£¬ÐèÒª¿ª·¢ÕßÊÖ¹¤µÄ½øÐÐSagaÒµÎñÁ÷³Ì»æÖÆ£¬²¢ÇÒ½«Æäת»»ÎªJsonÅäÖÃÎļþ£¬¶øºóÔÚ³ÌÐòÔËÐÐʱ£¬½«ÒÀ¾Ý×ÓÅäÖÃÎļþʵÏÖÒµÎñ´¦ÀíÒÔ¼°·þÎñ²¹³¥´¦Àí£¬¶øÒªÏë½øÐÐSaga״̬ͼµÄ»æÖÆ£¬Ò»°ãÐèҪͨ¹ýSaga״̬»úÀ´ÊµÏÖ¡£ +ç›®å‰�Seataæ��供的Saga模å¼�å�ªèƒ½é€šè¿‡çжæ€�机引擎æ�¥å®žçŽ°ï¼Œéœ€è¦�å¼€å�‘者手工的进行Saga业务æµ�程绘制,并且将其转æ�¢ä¸ºJsoné…�置文件,而å�Žåœ¨ç¨‹åº�è¿�行时,将ä¾�æ�®å­�é…�置文件实现业务处ç�†ä»¥å�Šæœ�务补å�¿å¤„ç�†ï¼Œè€Œè¦�想进行Saga状æ€�图的绘制,一般需è¦�通过Saga状æ€�机æ�¥å®žçŽ°ã€‚ -#### »ù±¾Ô­Àí£º +#### 基本原ç�†ï¼š -* ͨ¹ý״̬ͼÀ´¶¨Òå·þÎñµ÷ÓõÄÁ÷³Ì²¢Éú³Éjson¶¨ÒåÎļþ¡£ -* ״̬ͼÖÐÒ»¸ö½Úµã¿ÉÒÔµ÷ÓÃÒ»¸ö·þÎñ£¬½Úµã¿ÉÒÔÅäÖÃËüµÄ²¹³¥½Úµã¡£ -* ״̬ͼ json ÓÉ״̬»úÒýÇæÇý¶¯Ö´ÐУ¬µ±³öÏÖÒ쳣ʱ״̬ÒýÇæ·´ÏòÖ´ÐÐÒѳɹ¦½Úµã¶ÔÓ¦µÄ²¹³¥½Úµã½«ÊÂÎñ»Ø¹ö¡£ -* ¿ÉÒÔʵÏÖ·þÎñ±àÅÅÐèÇó£¬Ö§³Öµ¥ÏîÑ¡Ôñ¡¢²¢·¢¡¢×ÓÁ÷³Ì¡¢²ÎÊýת»»¡¢²ÎÊýÓ³Éä¡¢·þÎñÖ´ÐÐ״̬Åжϡ¢Òì³£²¶»ñµÈ¹¦ÄÜ¡£ +* 通过状æ€�图æ�¥å®šä¹‰æœ�务调用的æµ�程并生æˆ�json定义文件。 +* 状æ€�图中一个节点å�¯ä»¥è°ƒç”¨ä¸€ä¸ªæœ�务,节点å�¯ä»¥é…�置它的补å�¿èŠ‚ç‚¹ã€‚ +* 状æ€�图 json 由状æ€�机引擎驱动执行,当出现异常时状æ€�引擎å��å�‘执行已æˆ�功节点对应的补å�¿èŠ‚ç‚¹å°†äº‹åŠ¡å›žæ»šã€‚ +* å�¯ä»¥å®žçްæœ�务编排需求,支æŒ�å�•项选择ã€�å¹¶å�‘ã€�å­�æµ�程ã€�å�‚数转æ�¢ã€�å�‚数映射ã€�æœ�务执行状æ€�判断ã€�异常æ�•获等功能。 -#### Saga״̬»úµÄÓ¦Óà +#### Saga状æ€�机的应用 -**¹Ù·½ÎĵµµØÖ·£º**https://seata.io/zh-cn/docs/user/saga.html¡£ +**官方文档地å�€ï¼š**https://seata.io/zh-cn/docs/user/saga.html。 -Seata Safa״̬»ú¿ÉÊÓ»¯Í¼ÐÎÉè¼ÆÆ÷ʹÓõØÖ·£ºhttps://github.com/seata/seata/blob/develop/saga/seata-saga-statemachine-designer/README.zh-CN.md¡£ +Seata Safa状æ€�机å�¯è§†åŒ–图形设计器使用地å�€ï¼šhttps://github.com/seata/seata/blob/develop/saga/seata-saga-statemachine-designer/README.zh-CN.md。 -## ×ܽá +## 总结 -×ܵÄÀ´ËµÔÚSeataµÄÖÐATģʽ»ù±¾¿ÉÒÔÂú×ã°Ù·ÖÖ®80µÄ·Ö²¼Ê½ÊÂÎñµÄÒµÎñÐèÇó£¬ATģʽʵÏÖµÄÊÇ×îÖÕÒ»ÖÂÐÔ£¬ËùÒÔ¿ÉÄÜ´æÔÚÖмä״̬£¬¶øXAģʽʵÏÖµÄǿһÖÂÐÔ£¬ËùÒÔЧÂʽϵÍÒ»µã£¬¶øSaga¿ÉÒÔÓÃÀ´´¦Àí²»Í¬¿ª·¢ÓïÑÔÖ®¼äµÄ·Ö²¼Ê½ÊÂÎñ£¬ËùÒÔ¹ØÓÚ·Ö²¼Ê½ÊÂÎñµÄËÄ´óÄ£ÐÍ£¬»ù±¾¿ÉÒÔÂú×ãËùÓеÄÒµÎñ³¡¾°£¬ÆäÖÐXAºÍATûÓÐÒµÎñÇÖÈëÐÔ£¬¶øSagaºÍTCC¾ßÓÐÒ»¶¨µÄÒµÎñÇÖÈë¡£ +总的æ�¥è¯´åœ¨Seata的中AT模å¼�基本å�¯ä»¥æ»¡è¶³ç™¾åˆ†ä¹‹80的分布å¼�事务的业务需求,AT模å¼�实现的是最终一致性,所以å�¯èƒ½å­˜åœ¨ä¸­é—´çжæ€�,而XA模å¼�实现的强一致性,所以效率较低一点,而Sagaå�¯ä»¥ç”¨æ�¥å¤„ç�†ä¸�å�Œå¼€å�‘语言之间的分布å¼�事务,所以关于分布å¼�事务的四大模型,基本å�¯ä»¥æ»¡è¶³æ‰€æœ‰çš„业务场景,其中XAå’ŒAT没有业务侵入性,而Sagaå’ŒTCC具有一定的业务侵入。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.51cto.com/article/713007.html https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSentinel.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSentinel.md" index e476038..2413f96 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSentinel.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSentinel.md" @@ -1,32 +1,32 @@ -## ÕªÒª +## 摘è¦� -Spring Cloud Alibaba ÖÂÁ¦ÓÚÌṩ΢·þÎñ¿ª·¢µÄһվʽ½â¾ö·½°¸£¬Sentinel ×÷ΪÆäºËÐÄ×é¼þÖ®Ò»£¬¾ßÓÐÈÛ¶ÏÓëÏÞÁ÷µÈһϵÁзþÎñ±£»¤¹¦ÄÜ£¬±¾ÎĽ«¶ÔÆäÓ÷¨½øÐÐÏêϸ½éÉÜ¡£ +Spring Cloud Alibaba 致力于æ��供微æœ�务开å�‘的一站å¼�解决方案,Sentinel 作为其核心组件之一,具有熔断与é™�æµ�等一系列æœ�务ä¿�护功能,本文将对其用法进行详细介ç»�。 -## Sentinel¼ò½é +## Sentinel简介 -Ëæ×Å΢·þÎñµÄÁ÷ÐУ¬·þÎñºÍ·þÎñÖ®¼äµÄÎȶ¨ÐÔ±äµÃÔ½À´Ô½ÖØÒª¡£ Sentinel ÒÔÁ÷Á¿ÎªÇÐÈëµã£¬´ÓÁ÷Á¿¿ØÖÆ¡¢È۶Ͻµ¼¶¡¢ÏµÍ³¸ºÔر£»¤µÈ¶à¸öά¶È±£»¤·þÎñµÄÎȶ¨ÐÔ¡£ +éš�ç�€å¾®æœ�务的æµ�行,æœ�务和æœ�务之间的稳定性å�˜å¾—è¶Šæ�¥è¶Šé‡�è¦�。 Sentinel 以æµ�é‡�为切入点,从æµ�é‡�控制ã€�熔断é™�级ã€�系统负载ä¿�护等多个维度ä¿�护æœ�务的稳定性。 -Sentinel¾ßÓÐÈçÏÂÌØÐÔ: +Sentinel具有如下特性: -* ·á¸»µÄÓ¦Óó¡¾°£º³Ð½ÓÁ˰¢Àï°Í°Í½ü 10 ÄêµÄ˫ʮһ´ó´ÙÁ÷Á¿µÄºËÐij¡¾°£¬ÀýÈçÃëɱ£¬¿ÉÒÔʵʱÈÛ¶ÏÏÂÓβ»¿ÉÓÃÓ¦Óã» -* Í걸µÄʵʱ¼à¿Ø£ºÍ¬Ê±ÌṩʵʱµÄ¼à¿Ø¹¦ÄÜ¡£¿ÉÒÔÔÚ¿ØÖÆÌ¨Öп´µ½½ÓÈëÓ¦Óõĵ¥Ì¨»úÆ÷Ãë¼¶Êý¾Ý£¬ÉõÖÁ 500 ̨ÒÔϹæÄ£µÄ¼¯ÈºµÄ»ã×ÜÔËÐÐÇé¿ö£» -* ¹ã·ºµÄ¿ªÔ´Éú̬£ºÌṩ¿ªÏä¼´ÓõÄÓëÆäËü¿ªÔ´¿ò¼Ü/¿âµÄÕûºÏÄ£¿é£¬ÀýÈçÓë Spring Cloud¡¢Dubbo¡¢gRPC µÄÕûºÏ£» -* ÍêÉÆµÄ SPI À©Õ¹µã£ºÌṩ¼òµ¥Ò×Óá¢ÍêÉÆµÄ SPI À©Õ¹µã¡£Äú¿ÉÒÔͨ¹ýʵÏÖÀ©Õ¹µã£¬¿ìËٵ͍֯Âß¼­¡£ +* 丰富的应用场景:承接了阿里巴巴近 10 å¹´çš„å�Œå��一大促æµ�é‡�的核心场景,例如秒æ�€ï¼Œå�¯ä»¥å®žæ—¶ç†”断下游ä¸�å�¯ç”¨åº”用; +* 完备的实时监控:å�Œæ—¶æ��供实时的监控功能。å�¯ä»¥åœ¨æŽ§åˆ¶å�°ä¸­çœ‹åˆ°æŽ¥å…¥åº”用的å�•å�°æœºå™¨ç§’级数æ�®ï¼Œç”šè‡³ 500 å�°ä»¥ä¸‹è§„模的集群的汇总è¿�行情况; +* 广泛的开æº�生æ€�:æ��供开箱å�³ç”¨çš„与其它开æº�框架/库的整å�ˆæ¨¡å�—,例如与 Spring Cloudã€�Dubboã€�gRPC 的整å�ˆï¼› +* 完善的 SPI 扩展点:æ��供简å�•易用ã€�完善的 SPI 扩展点。您å�¯ä»¥é€šè¿‡å®žçŽ°æ‰©å±•ç‚¹ï¼Œå¿«é€Ÿçš„å®šåˆ¶é€»è¾‘ã€‚ -## °²×°Sentinel¿ØÖÆÌ¨ +## 安装Sentinel控制å�° -> Sentinel¿ØÖÆÌ¨ÊÇÒ»¸öÇáÁ¿¼¶µÄ¿ØÖÆÌ¨Ó¦Óã¬Ëü¿ÉÓÃÓÚʵʱ²é¿´µ¥»ú×ÊÔ´¼à¿Ø¼°¼¯Èº×ÊÔ´»ã×Ü£¬²¢ÌṩÁËһϵÁеĹæÔò¹ÜÀí¹¦ÄÜ£¬ÈçÁ÷¿Ø¹æÔò¡¢½µ¼¶¹æÔò¡¢ÈÈµã¹æÔòµÈ¡£ +> Sentinel控制å�°æ˜¯ä¸€ä¸ªè½»é‡�级的控制å�°åº”用,它å�¯ç”¨äºŽå®žæ—¶æŸ¥çœ‹å�•机资æº�监控å�Šé›†ç¾¤èµ„æº�汇总,并æ��供了一系列的规则管ç�†åŠŸèƒ½ï¼Œå¦‚æµ�控规则ã€�é™�级规则ã€�热点规则等。 -* ÎÒÃÇÏÈ´Ó¹ÙÍøÏÂÔØSentinel£¬ÕâÀïÏÂÔØµÄÊÇ`sentinel-dashboard-1.6.3.jar`Îļþ£¬ÏÂÔØµØÖ·£º[github.com/alibaba/Sen¡­](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2FSentinel%2Freleases "https://github.com/alibaba/Sentinel/releases") +* 我们先从官网下载Sentinel,这里下载的是`sentinel-dashboard-1.6.3.jar`文件,下载地å�€ï¼š[github.com/alibaba/Sen…](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2FSentinel%2Freleases "https://github.com/alibaba/Sentinel/releases") -* ÏÂÔØÍê³ÉºóÔÚÃüÁîÐÐÊäÈëÈçÏÂÃüÁîÔËÐÐSentinel¿ØÖÆÌ¨£º +* 下载完æˆ�å�Žåœ¨å‘½ä»¤è¡Œè¾“入如下命令è¿�行Sentinel控制å�°ï¼š ``` java -jar sentinel-dashboard-1.6.3.jar -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* Sentinel¿ØÖÆÌ¨Ä¬ÈÏÔËÐÐÔÚ8080¶Ë¿ÚÉÏ£¬µÇ¼Õ˺ÅÃÜÂë¾ùΪ`sentinel`£¬Í¨¹ýÈçϵØÖ·¿ÉÒÔ½øÐзÃÎÊ£º[http://localhost:8080](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8080 "http://localhost:8080") +* Sentinel控制å�°é»˜è®¤è¿�行在8080端å�£ä¸Šï¼Œç™»å½•è´¦å�·å¯†ç �å�‡ä¸º`sentinel`,通过如下地å�€å�¯ä»¥è¿›è¡Œè®¿é—®ï¼š[http://localhost:8080](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8080 "http://localhost:8080") ![image-20230423173003900](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173003900.png) @@ -35,7 +35,7 @@ java -jar sentinel-dashboard-1.6.3.jar -* Sentinel¿ØÖÆÌ¨¿ÉÒԲ鿴µ¥Ì¨»úÆ÷µÄʵʱ¼à¿ØÊý¾Ý¡£ +* Sentinel控制å�°å�¯ä»¥æŸ¥çœ‹å�•å�°æœºå™¨çš„实时监控数æ�®ã€‚ ![image-20230423173019956](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173019956.png) @@ -44,11 +44,11 @@ java -jar sentinel-dashboard-1.6.3.jar -## ´´½¨sentinel-serviceÄ£¿é +## 创建sentinel-service模å�— -> ÕâÀïÎÒÃÇ´´½¨Ò»¸ösentinel-serviceÄ£¿é£¬ÓÃÓÚÑÝʾSentinelµÄÈÛ¶ÏÓëÏÞÁ÷¹¦ÄÜ¡£ +> 这里我们创建一个sentinel-service模å�—,用于演示Sentinel的熔断与é™�æµ�功能。 -* ÔÚpom.xmlÖÐÌí¼ÓÏà¹ØÒÀÀµ£¬ÕâÀïÎÒÃÇʹÓÃNacos×÷Ϊע²áÖÐÐÄ£¬ËùÒÔÐèҪͬʱÌí¼ÓNacosµÄÒÀÀµ£º +* 在pom.xml中添加相关ä¾�赖,这里我们使用Nacos作为注册中心,所以需è¦�å�Œæ—¶æ·»åŠ Nacosçš„ä¾�赖: ``` @@ -59,10 +59,10 @@ java -jar sentinel-dashboard-1.6.3.jar com.alibaba.cloud spring-cloud-starter-alibaba-sentinel -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÔÚapplication.ymlÖÐÌí¼ÓÏà¹ØÅäÖã¬Ö÷ÒªÊÇÅäÖÃÁËNacosºÍSentinel¿ØÖÆÌ¨µÄµØÖ·£º +* 在application.yml中添加相关é…�置,主è¦�是é…�置了Nacoså’ŒSentinel控制å�°çš„地å�€ï¼š ``` server: @@ -73,10 +73,10 @@ spring: cloud: nacos: discovery: - server-addr: localhost:8848 #ÅäÖÃNacosµØÖ· + server-addr: localhost:8848 #é…�ç½®Nacos地å�€ sentinel: transport: - dashboard: localhost:8080 #ÅäÖÃsentinel dashboardµØÖ· + dashboard: localhost:8080 #é…�ç½®sentinel dashboard地å�€ port: 8719 service-url: user-service: http://nacos-user-service @@ -85,20 +85,20 @@ management: web: exposure: include: '*' -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## ÏÞÁ÷¹¦ÄÜ +## é™�æµ�功能 -> Sentinel Starter ĬÈÏΪËùÓÐµÄ HTTP ·þÎñÌṩÁËÏÞÁ÷Âñµã£¬ÎÒÃÇÒ²¿ÉÒÔͨ¹ýʹÓÃ@SentinelResourceÀ´×Ô¶¨ÒåһЩÏÞÁ÷ÐÐΪ¡£ +> Sentinel Starter 默认为所有的 HTTP æœ�务æ��供了é™�æµ�埋点,我们也å�¯ä»¥é€šè¿‡ä½¿ç”¨@SentinelResourceæ�¥è‡ªå®šä¹‰ä¸€äº›é™�æµ�行为。 -### ´´½¨RateLimitControllerÀà +### 创建RateLimitControllerç±» -> ÓÃÓÚ²âÊÔÈ۶ϺÍÏÞÁ÷¹¦ÄÜ¡£ +> 用于测试熔断和é™�æµ�功能。 ``` /** - * ÏÞÁ÷¹¦ÄÜ + * é™�æµ�功能 * Created by macro on 2019/11/7. */ @RestController @@ -106,21 +106,21 @@ management: public class RateLimitController { /** - * °´×ÊÔ´Ãû³ÆÏÞÁ÷£¬ÐèÒªÖ¸¶¨ÏÞÁ÷´¦ÀíÂß¼­ + * 按资æº�å��ç§°é™�æµ�,需è¦�指定é™�æµ�处ç�†é€»è¾‘ */ @GetMapping("/byResource") @SentinelResource(value = "byResource",blockHandler = "handleException") public CommonResult byResource() { - return new CommonResult("°´×ÊÔ´Ãû³ÆÏÞÁ÷", 200); + return new CommonResult("按资æº�å��ç§°é™�æµ�", 200); } /** - * °´URLÏÞÁ÷£¬ÓÐĬÈϵÄÏÞÁ÷´¦ÀíÂß¼­ + * 按URLé™�æµ�,有默认的é™�æµ�处ç�†é€»è¾‘ */ @GetMapping("/byUrl") @SentinelResource(value = "byUrl",blockHandler = "handleException") public CommonResult byUrl() { - return new CommonResult("°´urlÏÞÁ÷", 200); + return new CommonResult("按urlé™�æµ�", 200); } public CommonResult handleException(BlockException exception){ @@ -128,18 +128,18 @@ public class RateLimitController { } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -### ¸ù¾Ý×ÊÔ´Ãû³ÆÏÞÁ÷ +### æ ¹æ�®èµ„æº�å��ç§°é™�æµ� -> ÎÒÃÇ¿ÉÒÔ¸ù¾Ý@SentinelResource×¢½âÖж¨ÒåµÄvalue£¨×ÊÔ´Ãû³Æ£©À´½øÐÐÏÞÁ÷²Ù×÷£¬µ«ÊÇÐèÒªÖ¸¶¨ÏÞÁ÷´¦ÀíÂß¼­¡£ +> 我们å�¯ä»¥æ ¹æ�®@SentinelResource注解中定义的value(资æº�å��称)æ�¥è¿›è¡Œé™�æµ�æ“�作,但是需è¦�指定é™�æµ�处ç�†é€»è¾‘。 -* Á÷¿Ø¹æÔò¿ÉÒÔÔÚSentinel¿ØÖÆÌ¨½øÐÐÅäÖã¬ÓÉÓÚÎÒÃÇʹÓÃÁËNacos×¢²áÖÐÐÄ£¬ÎÒÃÇÏÈÆô¶¯NacosºÍsentinel-service£» +* æµ�控规则å�¯ä»¥åœ¨Sentinel控制å�°è¿›è¡Œé…�置,由于我们使用了Nacos注册中心,我们先å�¯åЍNacoså’Œsentinel-serviceï¼› -* ÓÉÓÚSentinel²ÉÓõÄÀÁ¼ÓÔØ¹æÔò£¬ÐèÒªÎÒÃÇÏÈ·ÃÎÊϽӿڣ¬Sentinel¿ØÖÆÌ¨ÖвŻáÓжÔÓ¦·þÎñÐÅÏ¢£¬ÎÒÃÇÏÈ·ÃÎÊϸýӿڣº[http://localhost:8401/rateLimit/byResource](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2FrateLimit%2FbyResource "http://localhost:8401/rateLimit/byResource") +* 由于Sentinel采用的懒加载规则,需è¦�我们先访问下接å�£ï¼ŒSentinel控制å�°ä¸­æ‰�会有对应æœ�务信æ�¯ï¼Œæˆ‘们先访问下该接å�£ï¼š[http://localhost:8401/rateLimit/byResource](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2FrateLimit%2FbyResource "http://localhost:8401/rateLimit/byResource") -* ÔÚSentinel¿ØÖÆÌ¨ÅäÖÃÁ÷¿Ø¹æÔò£¬¸ù¾Ý@SentinelResource×¢½âµÄvalueÖµ£º +* 在Sentinel控制å�°é…�ç½®æµ�控规则,根æ�®@SentinelResource注解的value值: ![image-20230423173034164](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173034164.png) @@ -148,7 +148,7 @@ public class RateLimitController { -* ¿ìËÙ·ÃÎÊÉÏÃæµÄ½Ó¿Ú£¬¿ÉÒÔ·¢ÏÖ·µ»ØÁË×Ô¼º¶¨ÒåµÄÏÞÁ÷´¦ÀíÐÅÏ¢£º +* 快速访问上é�¢çš„æŽ¥å�£ï¼Œå�¯ä»¥å�‘现返回了自己定义的é™�æµ�处ç�†ä¿¡æ�¯ï¼š ![image-20230423173044930](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173044930.png) @@ -157,11 +157,11 @@ public class RateLimitController { -### ¸ù¾ÝURLÏÞÁ÷ +### æ ¹æ�®URLé™�æµ� -> ÎÒÃÇ»¹¿ÉÒÔͨ¹ý·ÃÎʵÄURLÀ´ÏÞÁ÷£¬»á·µ»ØÄ¬ÈϵÄÏÞÁ÷´¦ÀíÐÅÏ¢¡£ +> 我们还å�¯ä»¥é€šè¿‡è®¿é—®çš„URLæ�¥é™�æµ�,会返回默认的é™�æµ�处ç�†ä¿¡æ�¯ã€‚ -* ÔÚSentinel¿ØÖÆÌ¨ÅäÖÃÁ÷¿Ø¹æÔò£¬Ê¹Ó÷ÃÎʵÄURL£º +* 在Sentinel控制å�°é…�ç½®æµ�控规则,使用访问的URL: ![image-20230423173055243](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173055243.png) @@ -170,7 +170,7 @@ public class RateLimitController { -* ¶à´Î·ÃÎʸýӿڣ¬»á·µ»ØÄ¬ÈϵÄÏÞÁ÷´¦Àí½á¹û£º[http://localhost:8401/rateLimit/byUrl](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2FrateLimit%2FbyUrl "http://localhost:8401/rateLimit/byUrl") +* 多次访问该接å�£ï¼Œä¼šè¿”回默认的é™�æµ�处ç�†ç»“果:[http://localhost:8401/rateLimit/byUrl](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2FrateLimit%2FbyUrl "http://localhost:8401/rateLimit/byUrl") ![image-20230423173105426](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173105426.png) @@ -179,11 +179,11 @@ public class RateLimitController { -### ×Ô¶¨ÒåÏÞÁ÷´¦ÀíÂß¼­ +### 自定义é™�æµ�处ç�†é€»è¾‘ -> ÎÒÃÇ¿ÉÒÔ×Ô¶¨ÒåͨÓõÄÏÞÁ÷´¦ÀíÂß¼­£¬È»ºóÔÚ@SentinelResourceÖÐÖ¸¶¨¡£ +> 我们å�¯ä»¥è‡ªå®šä¹‰é€šç”¨çš„é™�æµ�处ç�†é€»è¾‘,然å�Žåœ¨@SentinelResource中指定。 -* ´´½¨CustomBlockHandlerÀàÓÃÓÚ×Ô¶¨ÒåÏÞÁ÷´¦ÀíÂß¼­£º +* 创建CustomBlockHandler类用于自定义é™�æµ�处ç�†é€»è¾‘: ``` /** @@ -192,17 +192,17 @@ public class RateLimitController { public class CustomBlockHandler { public CommonResult handleException(BlockException exception){ - return new CommonResult("×Ô¶¨ÒåÏÞÁ÷ÐÅÏ¢",200); + return new CommonResult("自定义é™�æµ�ä¿¡æ�¯",200); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÔÚRateLimitControllerÖÐʹÓÃ×Ô¶¨ÒåÏÞÁ÷´¦ÀíÂß¼­£º +* 在RateLimitController中使用自定义é™�æµ�处ç�†é€»è¾‘: ``` /** - * ÏÞÁ÷¹¦ÄÜ + * é™�æµ�功能 * Created by macro on 2019/11/7. */ @RestController @@ -210,23 +210,23 @@ public class CustomBlockHandler { public class RateLimitController { /** - * ×Ô¶¨ÒåͨÓõÄÏÞÁ÷´¦ÀíÂß¼­ + * 自定义通用的é™�æµ�处ç�†é€»è¾‘ */ @GetMapping("/customBlockHandler") @SentinelResource(value = "customBlockHandler", blockHandler = "handleException",blockHandlerClass = CustomBlockHandler.class) public CommonResult blockHandler() { - return new CommonResult("ÏÞÁ÷³É¹¦", 200); + return new CommonResult("é™�æµ�æˆ�功", 200); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## È۶Ϲ¦ÄÜ +## 熔断功能 -> Sentinel Ö§³Ö¶Ô·þÎñ¼äµ÷ÓýøÐб£»¤£¬¶Ô¹ÊÕÏÓ¦ÓýøÐÐÈ۶ϲÙ×÷£¬ÕâÀïÎÒÃÇʹÓÃRestTemplateÀ´µ÷ÓÃnacos-user-service·þÎñËùÌṩµÄ½Ó¿ÚÀ´ÑÝʾϸù¦ÄÜ¡£ +> Sentinel 支æŒ�对æœ�务间调用进行ä¿�护,对故障应用进行熔断æ“�作,这里我们使用RestTemplateæ�¥è°ƒç”¨nacos-user-serviceæœ�务所æ��供的接å�£æ�¥æ¼”示下该功能。 -* Ê×ÏÈÎÒÃÇÐèҪʹÓÃ@SentinelRestTemplateÀ´°ü×°ÏÂRestTemplateʵÀý£º +* 首先我们需è¦�使用@SentinelRestTemplateæ�¥åŒ…装下RestTemplate实例: ``` /** @@ -241,14 +241,14 @@ public class RibbonConfig { return new RestTemplate(); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* Ìí¼ÓCircleBreakerControllerÀ࣬¶¨Òå¶Ônacos-user-serviceÌṩ½Ó¿ÚµÄµ÷Ó㺠+* 添加CircleBreakerController类,定义对nacos-user-serviceæ��供接å�£çš„调用: ``` /** - * È۶Ϲ¦ÄÜ + * 熔断功能 * Created by macro on 2019/11/7. */ @RestController @@ -280,21 +280,21 @@ public class CircleBreakerController { public CommonResult handleFallback(Long id) { User defaultUser = new User(-1L, "defaultUser", "123456"); - return new CommonResult<>(defaultUser,"·þÎñ½µ¼¶·µ»Ø",200); + return new CommonResult<>(defaultUser,"æœ�务é™�级返回",200); } public CommonResult handleFallback2(@PathVariable Long id, Throwable e) { LOGGER.error("handleFallback2 id:{},throwable class:{}", id, e.getClass()); User defaultUser = new User(-2L, "defaultUser2", "123456"); - return new CommonResult<>(defaultUser,"·þÎñ½µ¼¶·µ»Ø",200); + return new CommonResult<>(defaultUser,"æœ�务é™�级返回",200); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* Æô¶¯nacos-user-serviceºÍsentinel-service·þÎñ£º +* å�¯åЍnacos-user-serviceå’Œsentinel-serviceæœ�务: -* ÓÉÓÚÎÒÃDz¢Ã»ÓÐÔÚnacos-user-serviceÖж¨ÒåidΪ4µÄÓû§£¬ËùÓзÃÎÊÈçϽӿڻ᷵»Ø·þÎñ½µ¼¶½á¹û£º[http://localhost:8401/breaker/fallback/4](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2Fbreaker%2Ffallback%2F4 "http://localhost:8401/breaker/fallback/4") +* 由于我们并没有在nacos-user-service中定义id为4的用户,所有访问如下接å�£ä¼šè¿”回æœ�务é™�级结果:[http://localhost:8401/breaker/fallback/4](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2Fbreaker%2Ffallback%2F4 "http://localhost:8401/breaker/fallback/4") ``` { @@ -303,13 +303,13 @@ public class CircleBreakerController { "username": "defaultUser", "password": "123456" }, - "message": "·þÎñ½µ¼¶·µ»Ø", + "message": "æœ�务é™�级返回", "code": 200 } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÓÉÓÚÎÒÃÇʹÓÃÁËexceptionsToIgnore²ÎÊýºöÂÔÁËNullPointerException£¬ËùÒÔÎÒÃÇ·ÃÎʽӿڱ¨¿ÕÖ¸Õëʱ²»»á·¢Éú·þÎñ½µ¼¶£º[http://localhost:8401/breaker/fallbackException/2](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2Fbreaker%2FfallbackException%2F2 "http://localhost:8401/breaker/fallbackException/2") +* 由于我们使用了exceptionsToIgnoreå�‚数忽略了NullPointerException,所以我们访问接å�£æŠ¥ç©ºæŒ‡é’ˆæ—¶ä¸�会å�‘生æœ�务é™�级:[http://localhost:8401/breaker/fallbackException/2](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2Fbreaker%2FfallbackException%2F2 "http://localhost:8401/breaker/fallbackException/2") ![](https://p1-jj.byteimg.com/tos-cn-i-t2oaga2asx/gold-user-assets/2019/11/18/16e7eb0fb3df7c01~tplv-t2oaga2asx-zoom-in-crop-mark:4536:0:0:0.awebp) @@ -318,32 +318,32 @@ public class CircleBreakerController { -## ÓëFeign½áºÏʹÓà +## 与Feign结å�ˆä½¿ç”¨ -> SentinelÒ²ÊÊÅäÁËFeign×é¼þ£¬ÎÒÃÇʹÓÃFeignÀ´½øÐзþÎñ¼äµ÷ÓÃʱ£¬Ò²¿ÉÒÔʹÓÃËüÀ´½øÐÐÈÛ¶Ï¡£ +> Sentinel也适é…�了Feign组件,我们使用Feignæ�¥è¿›è¡Œæœ�务间调用时,也å�¯ä»¥ä½¿ç”¨å®ƒæ�¥è¿›è¡Œç†”断。 -* Ê×ÏÈÎÒÃÇÐèÒªÔÚpom.xmlÖÐÌí¼ÓFeignÏà¹ØÒÀÀµ£º +* 首先我们需è¦�在pom.xml中添加Feign相关ä¾�赖: ``` org.springframework.cloud spring-cloud-starter-openfeign -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÔÚapplication.ymlÖдò¿ªSentinel¶ÔFeignµÄÖ§³Ö£º +* 在application.yml中打开Sentinel对Feign的支æŒ�: ``` feign: sentinel: - enabled: true #´ò¿ªsentinel¶ÔfeignµÄÖ§³Ö -¸´ÖÆ´úÂë + enabled: true #打开sentinel对feign的支æŒ� +å¤�制代ç � ``` -* ÔÚÓ¦ÓÃÆô¶¯ÀàÉÏÌí¼Ó@EnableFeignClientsÆô¶¯FeignµÄ¹¦ÄÜ£» +* 在应用å�¯åŠ¨ç±»ä¸Šæ·»åŠ @EnableFeignClientså�¯åЍFeign的功能; -* ´´½¨Ò»¸öUserService½Ó¿Ú£¬ÓÃÓÚ¶¨Òå¶Ônacos-user-service·þÎñµÄµ÷Ó㺠+* 创建一个UserService接å�£ï¼Œç”¨äºŽå®šä¹‰å¯¹nacos-user-serviceæœ�务的调用: ``` /** @@ -366,10 +366,10 @@ public interface UserService { @PostMapping("/user/delete/{id}") CommonResult delete(@PathVariable Long id); } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ´´½¨UserFallbackServiceÀàʵÏÖUserService½Ó¿Ú£¬ÓÃÓÚ´¦Àí·þÎñ½µ¼¶Âß¼­£º +* 创建UserFallbackService类实现UserService接å�£ï¼Œç”¨äºŽå¤„ç�†æœ�务é™�级逻辑: ``` /** @@ -380,35 +380,35 @@ public class UserFallbackService implements UserService { @Override public CommonResult create(User user) { User defaultUser = new User(-1L, "defaultUser", "123456"); - return new CommonResult<>(defaultUser,"·þÎñ½µ¼¶·µ»Ø",200); + return new CommonResult<>(defaultUser,"æœ�务é™�级返回",200); } @Override public CommonResult getUser(Long id) { User defaultUser = new User(-1L, "defaultUser", "123456"); - return new CommonResult<>(defaultUser,"·þÎñ½µ¼¶·µ»Ø",200); + return new CommonResult<>(defaultUser,"æœ�务é™�级返回",200); } @Override public CommonResult getByUsername(String username) { User defaultUser = new User(-1L, "defaultUser", "123456"); - return new CommonResult<>(defaultUser,"·þÎñ½µ¼¶·µ»Ø",200); + return new CommonResult<>(defaultUser,"æœ�务é™�级返回",200); } @Override public CommonResult update(User user) { - return new CommonResult("µ÷ÓÃʧ°Ü£¬·þÎñ±»½µ¼¶",500); + return new CommonResult("调用失败,æœ�务被é™�级",500); } @Override public CommonResult delete(Long id) { - return new CommonResult("µ÷ÓÃʧ°Ü£¬·þÎñ±»½µ¼¶",500); + return new CommonResult("调用失败,æœ�务被é™�级",500); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÔÚUserFeignControllerÖÐʹÓÃUserServiceͨ¹ýFeignµ÷ÓÃnacos-user-service·þÎñÖеĽӿڣº +* 在UserFeignController中使用UserService通过Feign调用nacos-user-serviceæœ�务中的接å�£ï¼š ``` /** @@ -445,10 +445,10 @@ public class UserFeignController { return userService.delete(id); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* µ÷ÓÃÈçϽӿڻᷢÉú·þÎñ½µ¼¶£¬·µ»Ø·þÎñ½µ¼¶´¦ÀíÐÅÏ¢£º[http://localhost:8401/user/4](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2Fuser%2F4 "http://localhost:8401/user/4") +* 调用如下接å�£ä¼šå�‘生æœ�务é™�级,返回æœ�务é™�级处ç�†ä¿¡æ�¯ï¼š[http://localhost:8401/user/4](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8401%2Fuser%2F4 "http://localhost:8401/user/4") ``` { @@ -457,17 +457,17 @@ public class UserFeignController { "username": "defaultUser", "password": "123456" }, - "message": "·þÎñ½µ¼¶·µ»Ø", + "message": "æœ�务é™�级返回", "code": 200 } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## ʹÓÃNacos´æ´¢¹æÔò +## 使用Nacos存储规则 -> ĬÈÏÇé¿öÏ£¬µ±ÎÒÃÇÔÚSentinel¿ØÖÆÌ¨ÖÐÅäÖùæÔòʱ£¬¿ØÖÆÌ¨ÍÆË͹æÔò·½Ê½ÊÇͨ¹ýAPI½«¹æÔòÍÆËÍÖÁ¿Í»§¶Ë²¢Ö±½Ó¸üе½ÄÚ´æÖС£Ò»µ©ÎÒÃÇÖØÆôÓ¦Ó㬹æÔò½«Ïûʧ¡£ÏÂÃæÎÒÃǽéÉÜÏÂÈçºÎ½«ÅäÖùæÔò½øÐг־û¯£¬ÒÔ´æ´¢µ½NacosΪÀý¡£ +> 默认情况下,当我们在Sentinel控制å�°ä¸­é…�置规则时,控制å�°æŽ¨é€�规则方å¼�是通过API将规则推é€�至客户端并直接更新到内存中。一旦我们é‡�å�¯åº”用,规则将消失。下é�¢æˆ‘们介ç»�下如何将é…�置规则进行æŒ�久化,以存储到Nacos为例。 -### Ô­ÀíʾÒâͼ +### 原ç�†ç¤ºæ„�图 ![image-20230423173120010](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173120010.png) @@ -476,23 +476,23 @@ public class UserFeignController { -* Ê×ÏÈÎÒÃÇÖ±½ÓÔÚÅäÖÃÖÐÐÄ´´½¨¹æÔò£¬ÅäÖÃÖÐÐĽ«¹æÔòÍÆË͵½¿Í»§¶Ë£» +* 首先我们直接在é…�置中心创建规则,é…�置中心将规则推é€�到客户端; -* Sentinel¿ØÖÆÌ¨Ò²´ÓÅäÖÃÖÐÐÄÈ¥»ñÈ¡ÅäÖÃÐÅÏ¢¡£ +* Sentinel控制å�°ä¹Ÿä»Žé…�置中心去获å�–é…�置信æ�¯ã€‚ -### ¹¦ÄÜÑÝʾ +### 功能演示 -* ÏÈÔÚpom.xmlÖÐÌí¼ÓÏà¹ØÒÀÀµ£º +* 先在pom.xml中添加相关ä¾�赖: ``` com.alibaba.csp sentinel-datasource-nacos -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÐÞ¸Äapplication.ymlÅäÖÃÎļþ£¬Ìí¼ÓNacosÊý¾ÝÔ´ÅäÖ㺠+* 修改application.ymlé…�置文件,添加Nacosæ•°æ�®æº�é…�置: ``` spring: @@ -506,10 +506,10 @@ spring: groupId: DEFAULT_GROUP data-type: json rule-type: flow -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* ÔÚNacosÖÐÌí¼ÓÅäÖ㺠+* 在Nacos中添加é…�置: ![image-20230423173137516](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173137516.png) @@ -518,7 +518,7 @@ spring: -* Ìí¼ÓÅäÖÃÐÅÏ¢ÈçÏ£º +* 添加é…�置信æ�¯å¦‚下: ``` [ @@ -532,19 +532,19 @@ spring: "clusterMode": false } ] -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* Ïà¹Ø²ÎÊý½âÊÍ£º +* 相关å�‚数解释: - * resource£º×ÊÔ´Ãû³Æ£» - * limitApp£ºÀ´Ô´Ó¦Óã» - * grade£ºãÐÖµÀàÐÍ£¬0±íʾÏß³ÌÊý£¬1±íʾQPS£» - * count£ºµ¥»úãÐÖµ£» - * strategy£ºÁ÷¿ØÄ£Ê½£¬0±íʾֱ½Ó£¬1±íʾ¹ØÁª£¬2±íʾÁ´Â·£» - * controlBehavior£ºÁ÷¿ØÐ§¹û£¬0±íʾ¿ìËÙʧ°Ü£¬1±íʾWarm Up£¬2±íʾÅŶӵȴý£» - * clusterMode£ºÊÇ·ñ¼¯Èº¡£ -* ·¢ÏÖSentinel¿ØÖÆÌ¨ÒѾ­ÓÐÁËÈçÏÂÏÞÁ÷¹æÔò£º + * resource:资æº�å��ç§°ï¼› + * limitApp:æ�¥æº�应用; + * grade:阈值类型,0表示线程数,1表示QPSï¼› + * count:å�•机阈值; + * strategy:æµ�控模å¼�,0表示直接,1表示关è�”,2表示链路; + * controlBehavior:æµ�控效果,0表示快速失败,1表示Warm Up,2表示排队等待; + * clusterMode:是å�¦é›†ç¾¤ã€‚ +* å�‘现Sentinel控制å�°å·²ç»�有了如下é™�æµ�规则: ![image-20230423173152487](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173152487.png) @@ -553,7 +553,7 @@ spring: -* ¿ìËÙ·ÃÎʲâÊÔ½Ó¿Ú£¬¿ÉÒÔ·¢ÏÖ·µ»ØÁËÏÞÁ÷´¦ÀíÐÅÏ¢£º +* 快速访问测试接å�£ï¼Œå�¯ä»¥å�‘现返回了é™�æµ�处ç�†ä¿¡æ�¯ï¼š ![image-20230423173203461](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423173203461.png) @@ -562,31 +562,31 @@ spring: -## ²Î¿¼×ÊÁÏ +## å�‚考资料 -Spring Cloud Alibaba ¹Ù·½Îĵµ£º[github.com/alibaba/spr¡­](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fspring-cloud-alibaba%2Fwiki "https://github.com/alibaba/spring-cloud-alibaba/wiki") +Spring Cloud Alibaba 官方文档:[github.com/alibaba/spr…](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fspring-cloud-alibaba%2Fwiki "https://github.com/alibaba/spring-cloud-alibaba/wiki") -## ʹÓõ½µÄÄ£¿é +## 使用到的模å�— ``` springcloud-learning -©À©¤©¤ nacos-user-service -- ×¢²áµ½nacosµÄÌṩUser¶ÔÏóCRUD½Ó¿ÚµÄ·þÎñ -©¸©¤©¤ sentinel-service -- sentinel¹¦ÄܲâÊÔ·þÎñ -¸´ÖÆ´úÂë +├── nacos-user-service -- 注册到nacosçš„æ��ä¾›User对象CRUD接å�£çš„æœ�务 +└── sentinel-service -- sentinel功能测试æœ�务 +å¤�制代ç � ``` -## ÏîĿԴÂëµØÖ· +## 项目æº�ç �地å�€ -[github.com/macrozheng/¡­](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fmacrozheng%2Fspringcloud-learning "https://github.com/macrozheng/springcloud-learning") +[github.com/macrozheng/…](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fmacrozheng%2Fspringcloud-learning "https://github.com/macrozheng/springcloud-learning") -×÷ÕߣºMacroZheng -Á´½Ó£ºhttps://juejin.cn/post/6844903999876022279 -À´Ô´£ºÏ¡ÍÁ¾ò½ð -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +作者:MacroZheng +链接:https://juejin.cn/post/6844903999876022279 +æ�¥æº�:稀土掘金 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSkywalking.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSkywalking.md" index 3bce54d..2353b1d 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSkywalking.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibabaSkywalking.md" @@ -1,30 +1,30 @@ -# 1\. SkyWalking ¼ò½é +# 1\. SkyWalking 简介 -> Skywalking ÊÇÓɹúÄÚ¿ªÔ´°®ºÃÕßÎâêÉ£¨Ô­ OneAPM ¹¤³Ìʦ£¬Ä¿Ç°ÔÚ»ªÎª£©¿ªÔ´²¢Ìá½»µ½ Apache ·õ»¯Æ÷µÄ²úÆ·£¬ËüͬʱÎüÊÕÁË Zipkin/Pinpoint/CAT µÄÉè¼ÆË¼Â·£¬Ö§³Ö·ÇÇÖÈëʽÂñµã¡£ÊÇÒ»¿î»ùÓÚ·Ö²¼Ê½¸ú×ÙµÄÓ¦ÓóÌÐòÐÔÄÜ¼à¿ØÏµÍ³¡£ÁíÍâÉçÇø»¹·¢Õ¹³öÁËÒ»¸ö½Ð OpenTracing µÄ×éÖ¯£¬Ö¼ÔÚÍÆ½øµ÷ÓÃÁ´¼à¿ØµÄһЩ¹æ·¶ºÍ±ê×¼¹¤×÷¡£ +> Skywalking 是由国内开æº�爱好者å�´æ™Ÿï¼ˆåŽŸ OneAPM 工程师,目å‰�在å�Žä¸ºï¼‰å¼€æº�å¹¶æ��交到 Apache 孵化器的产å“�,它å�Œæ—¶å�¸æ”¶äº† Zipkin/Pinpoint/CAT 的设计æ€�路,支æŒ�é�žä¾µå…¥å¼�埋点。是一款基于分布å¼�跟踪的应用程åº�性能监控系统。å�¦å¤–社区还å�‘展出了一个å�« OpenTracing 的组织,旨在推进调用链监控的一些规范和标准工作。 -* SkyWalking ÊÇÒ»¸ö¿ªÔ´¼à¿ØÆ½Ì¨£¬ÓÃÓÚ´Ó·þÎñºÍÔÆÔ­Éú»ù´¡ÉèÊ©ÊÕ¼¯¡¢·ÖÎö¡¢¾ÛºÏºÍ¿ÉÊÓ»¯Êý¾Ý¡£ -* SkyWalking ÌṩÁËÒ»ÖÖ¼òµ¥µÄ·½·¨À´Î¬»¤·Ö²¼Ê½ÏµÍ³µÄÇåÎúÊÓͼ£¬ÉõÖÁ¿ÉÒÔ¿çÔÆ²é¿´¡£ËüÊÇÒ»ÖÖÏÖ´úAPM£¬×¨ÃÅÎªÔÆÔ­Éú¡¢»ùÓÚÈÝÆ÷µÄ·Ö²¼Ê½ÏµÍ³Éè¼Æ¡£ -* SkyWalking ´ÓÈý¸öά¶È¶ÔÓ¦ÓýøÐмàÊÓ£ºservice£¨·þÎñ£©, service instance£¨ÊµÀý£©, endpoint£¨¶Ëµã£©¡£·þÎñºÍʵÀý¾Í²»¶à˵ÁË£¬¶ËµãÊÇ·þÎñÖеÄij¸ö·¾¶»òÕß˵URI¡£ -* SkyWalking ÔÊÐíÓû§Á˽â·þÎñºÍ¶ËµãÖ®¼äµÄÍØÆË¹ØÏµ£¬²é¿´Ã¿¸ö·þÎñ/·þÎñʵÀý/¶ËµãµÄ¶ÈÁ¿£¬²¢ÉèÖþ¯±¨¹æÔò¡£ +* SkyWalking 是一个开æº�监控平å�°ï¼Œç”¨äºŽä»Žæœ�务和云原生基础设施收集ã€�分æž�ã€�è�šå�ˆå’Œå�¯è§†åŒ–æ•°æ�®ã€‚ +* SkyWalking æ��供了一ç§�简å�•的方法æ�¥ç»´æŠ¤åˆ†å¸ƒå¼�系统的清晰视图,甚至å�¯ä»¥è·¨äº‘查看。它是一ç§�现代APM,专门为云原生ã€�基于容器的分布å¼�系统设计。 +* SkyWalking 从三个维度对应用进行监视:service(æœ�务), service instance(实例), endpoint(端点)。æœ�务和实例就ä¸�多说了,端点是æœ�务中的æŸ�个路径或者说URI。 +* SkyWalking å…�许用户了解æœ�务和端点之间的拓扑关系,查看æ¯�个æœ�务/æœ�务实例/端点的度é‡�,并设置警报规则。 -## SkyWalkingµÄ×é³É +## SkyWalking的组æˆ� -SkyWalkingÖ÷ÒªµÄ¼¸¸ö×é³ÉÄ£¿é: +SkyWalking主è¦�的几个组æˆ�模å�—: -1. Agent Ö÷Òª¸ºÔð´ÓϵͳÖвɼ¯¸÷ÖÖÖ¸±ê£¬Á´Â·Êý¾Ý£¬·¢Ë͸ø oap ·þÎñ¡£ -2. oap ·þÎñ½ÓÊÕ Agent ·¢Ë͹ýÀ´µÄÊý¾Ý£¬´æ´¢£¬Ö´ÐзÖÎö£¬Ìṩ²éѯºÍ±¨¾¯¹¦ÄÜ¡£ -3. Storage ºÍ UI ¸ºÔð´æ´¢Êý¾ÝÒÔ¼°²é¿´Êý¾Ý¡£ +1. Agent 主è¦�负责从系统中采集å�„ç§�指标,链路数æ�®ï¼Œå�‘é€�ç»™ oap æœ�务。 +2. oap æœ�务接收 Agent å�‘é€�过æ�¥çš„æ•°æ�®ï¼Œå­˜å‚¨ï¼Œæ‰§è¡Œåˆ†æž�,æ��供查询和报警功能。 +3. Storage å’Œ UI 负责存储数æ�®ä»¥å�ŠæŸ¥çœ‹æ•°æ�®ã€‚ -# 2\. ʹÓà Docker ¿ìËٴ SkyWalking 8.0 +# 2\. 使用 Docker 快速æ�­å»º SkyWalking 8.0 -1. **ÔÚ linux ·þÎñÆ÷ÉÏÑ¡Ôñ²¢½¨Á¢Ä¿Â¼**£» +1. **在 linux æœ�务器上选择并建立目录**ï¼› ``` mkdir skywalking-docker -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. **½øÈë skywalking-docker Ŀ¼£¬½¨Á¢Ò»¸öÃûΪ skywalking.yaml µÄ½Å±¾Îļþ£¬ÄÚÈÝÈçÏÂ**£º +1. **进入 skywalking-docker 目录,建立一个å��为 skywalking.yaml 的脚本文件,内容如下**: ``` version: '3' @@ -85,34 +85,34 @@ networks: volumes: elasticsearch7: driver: local -¸´ÖÆ´úÂë +å¤�制代ç � ``` -**×¢Òâ**£ºÈç¹ûÎÒÃÇÏ븲¸Ç oap ¾µÏñÖÐµÄ /skywalking/config Ŀ¼ÏµÄÅäÖÃÎļþ£¬ÎÒÃÇ¿ÉÒÔÔÚ docker ÖйÒÔØÒ»¸ö /skywalking/ext-config Ŀ¼£¬½«ÅäÖÃÎļþ¶ªµ½´ËĿ¼Öм´¿É¡£ +**注æ„�**:如果我们想覆盖 oap 镜åƒ�中的 /skywalking/config 目录下的é…�置文件,我们å�¯ä»¥åœ¨ docker 中挂载一个 /skywalking/ext-config 目录,将é…�置文件丢到此目录中å�³å�¯ã€‚ ![image-20230423174422281](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174422281.png) -1. **Ö´ÐÐ skywalking.yaml ½Å±¾Æô¶¯ÈÝÆ÷**£º +1. **执行 skywalking.yaml 脚本å�¯åЍ容噍**: ``` docker-compose -f skywalking.yaml up -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. **½øÈë skywalking µÄ¿ØÖÆÌ¨£¬·¢ÏÖ¸÷ÖÖÒDZíÅÌ£¬¿ªÊ¼µ±È»ÊǿյÄ**£º +1. **进入 skywalking 的控制å�°ï¼Œå�‘现å�„ç§�仪表盘,开始当然是空的**: ``` -http://(°²×°SkyWalking»úÆ÷µÄIP):9020 -¸´ÖÆ´úÂë +http://(安装SkyWalking机器的IP):9020 +å¤�制代ç � ``` ![image-20230423174444272](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174444272.png) -# 3\. ÔÚ Spring ÏîÄ¿ÖÐÒýÈë SkyWalking ¿Í»§¶Ë +# 3\. 在 Spring 项目中引入 SkyWalking 客户端 -È«¾ÖÈÕÖ¾×·×Ù traceId µÄʹÓ㺠+全局日志追踪 traceId 的使用: -1. **Ìí¼Ó pom ÎļþÒÀÀµ**£º +1. **添加 pom 文件ä¾�èµ–**: ``` @@ -125,28 +125,28 @@ http://( apm-toolkit-trace 8.0.1 -¸´ÖÆ´úÂë +å¤�制代ç � ``` -1. **ÔÚ resources Ŀ¼Ï Ìí¼Ó logback-spring.xml Îļþ£¬ÄÚÈÝÈçÏÂ**: +1. **在 resources 目录下 添加 logback-spring.xml 文件,内容如下**: ``` - - + + - + - + info @@ -157,7 +157,7 @@ http://( - + @@ -167,26 +167,26 @@ http://( - - + + - + - + ${logger.path}/log_info.log - + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 - + - + ${logger.path}/info/log-info-%d{yyyy-MM-dd}.%i.log 100MB - + 15 - + info ACCEPT @@ -221,25 +221,25 @@ http://( - + - + - + ${logger.path}/log_error.log - + %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n - UTF-8 + UTF-8 - + ${logger.path}/error/log-error-%d{yyyy-MM-dd}.%i.log 100MB - + 15 - + ERROR ACCEPT @@ -274,10 +274,10 @@ http://( @@ -289,60 +289,60 @@ http://( -¸´ÖÆ´úÂë +å¤�制代ç � ``` -**×¢Òâ**£ºÆäËû¶¼ÊÇÈÕÖ¾³£¹æÅäÖã¬Ö÷ÒªÊÇÕⲿ·Ö `` µÄÅäÖᣠ+**注æ„�**:其他都是日志常规é…�置,主è¦�是这部分 `` çš„é…�置。 -1. **½øÈë skywalking ¹ÙÍøÏÂÔØ SkyWalking APM£¬Ö÷ÒªÊÇÒªÓõ½ agent**£º +1. **进入 skywalking 官网下载 SkyWalking APM,主è¦�是è¦�用到 agent**: -skywalking ¹ÙÍøÏÂÔØµØÖ·£º[skywalking.apache.org/downloads/](https://link.juejin.cn?target=http%3A%2F%2Fskywalking.apache.org%2Fdownloads%2F "http://skywalking.apache.org/downloads/") +skywalking 官网下载地å�€ï¼š[skywalking.apache.org/downloads/](https://link.juejin.cn?target=http%3A%2F%2Fskywalking.apache.org%2Fdownloads%2F "http://skywalking.apache.org/downloads/") ![image-20230423174506711](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174506711.png) -1. **½âѹÏÂÔØµÄ apache-skywalking-apm-es7-8.0.1.tar.gz °ü£¬Ä¿Â¼½á¹¹Èçͼ**£º +1. **解压下载的 apache-skywalking-apm-es7-8.0.1.tar.gz 包,目录结构如图**: ![image-20230423174522153](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174522153.png) -ÎÒÃÇÖ»ÒªÆäÖÐµÄ agent Ŀ¼¾ÍÐУ¬agent ÀïµÄ¶«Î÷´ó¸ÅÓÐÕâЩ£º +我们å�ªè¦�其中的 agent 目录就行,agent 里的东西大概有这些: ![image-20230423174533023](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174533023.png) -°Ñ agent Ŀ¼¸´ÖƵ½Ò»¸öÍ×ÉÆµÄĿ¼Ï£¬Ò»»á¶ùÐèÒªÅäÖà JVM Æô¶¯²ÎÊýĿ¼£¬µ±È»×÷ÕßÖ±½Ó·Åµ½ÁËÏîÄ¿À +把 agent 目录å¤�制到一个妥善的目录下,一会儿需è¦�é…�ç½® JVM å�¯åЍå�‚数目录,当然作者直接放到了项目里: ![](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8deaee160419423e9a71e710d3b2c3dd~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp) -1. **ÔÚ idea ³ÌÐòÆô¶¯ÃüÁîÔö¼ÓÈçÏ JVM Æô¶¯²ÎÊý**£º +1. **在 idea 程åº�å�¯åŠ¨å‘½ä»¤å¢žåŠ å¦‚ä¸‹ JVM å�¯åЍå�‚æ•°**: ``` --javaagent:(agentÎļþ¼ÐËùÔÚµÄĿ¼)\agent\skywalking-agent.jar -Dskywalking.agent.service_name=(·þÎñÃû)-service -Dskywalking.agent.instance_name=(·þÎñÃû)-instance -Dskywalking.collector.backend_service=(°²×°SkyWalking»úÆ÷µÄIP):9022 -¸´ÖÆ´úÂë +-javaagent:(agent文件夹所在的目录)\agent\skywalking-agent.jar -Dskywalking.agent.service_name=(æœ�务å��)-service -Dskywalking.agent.instance_name=(æœ�务å��)-instance -Dskywalking.collector.backend_service=(安装SkyWalking机器的IP):9022 +å¤�制代ç � ``` ![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/96e9d5a3aa5c44c3b0b948929609ae1f~tplv-k3u1fbpfcp-zoom-in-crop-mark:1512:0:0:0.awebp) -ÒòΪ skywalking ÊÇ·ÇÇÖÈëʽÂñµãʵÏÖ·Ö²¼Ê½Á´Â·¸ú×ÙºÍÐÔÄÜ¼à¿Ø£¬ËùÒÔÒ»°ã²ÉÓà javaagent µÄ·½Ê½¡£ +因为 skywalking 是é�žä¾µå…¥å¼�埋点实现分布å¼�链路跟踪和性能监控,所以一般采用 javaagent 的方å¼�。 -> **Javaagent ÊÇʲô**£¨JVM Æô¶¯Ç°¾²Ì¬ Instrument£©£¿ +> **Javaagent 是什么**(JVM å�¯åЍå‰�é�™æ€� Instrument)? > -> Javaagent ÊÇ java ÃüÁîµÄÒ»¸ö²ÎÊý¡£²ÎÊý javaagent ¿ÉÒÔÓÃÓÚÖ¸¶¨Ò»¸ö jar °ü£¬²¢ÇҶԸà java °üÓÐÁ½¸öÒªÇó£º +> Javaagent 是 java 命令的一个å�‚数。å�‚æ•° javaagent å�¯ä»¥ç”¨äºŽæŒ‡å®šä¸€ä¸ª jar 包,并且对该 java 包有两个è¦�求: > -> 1. Õâ¸ö jar °üµÄ MANIFEST.MF Îļþ±ØÐëÖ¸¶¨ Premain-Class Ïî¡£ -> 2. Premain-Class Ö¸¶¨µÄÄǸöÀà±ØÐëʵÏÖ premain() ·½·¨¡£ +> 1. 这个 jar 包的 MANIFEST.MF 文件必须指定 Premain-Class 项。 +> 2. Premain-Class 指定的那个类必须实现 premain() 方法。 > -> premain() ·½·¨£¬´Ó×ÖÃæÉÏÀí½â£¬¾ÍÊÇÔËÐÐÔÚ main() º¯Êý֮ǰµÄµÄÀà¡£µ± Java ÐéÄâ»úÆô¶¯Ê±£¬ÔÚÖ´ÐÐ main() º¯Êý֮ǰ£¬jvm »áÏÈÔËÐÐ -javaagent ËùÖ¸¶¨ jar °üÄÚ Premain-Class Õâ¸öÀàµÄ premain() ·½·¨ ¡£ +> premain() 方法,从字é�¢ä¸Šç�†è§£ï¼Œå°±æ˜¯è¿�行在 main() 函数之å‰�的的类。当 Java 虚拟机å�¯åŠ¨æ—¶ï¼Œåœ¨æ‰§è¡Œ main() 函数之å‰�,jvm 会先è¿�行 -javaagent 所指定 jar 包内 Premain-Class 这个类的 premain() 方法 。 -1. **ÎÒÃÇǰ¼¸ÆªÎÄÕÂÖдÁËÍêÕûµÄÏîÄ¿£¬ÔÚÕâЩÏîÄ¿ÖÐÈ«²¿°´ÕÕÉϱߵÄÅäÖÃÒ»±é£¬Æô¶¯¿´ÏÂЧ¹û**£º +1. **我们å‰�几篇文章中æ�­å»ºäº†å®Œæ•´çš„项目,在这些项目中全部按照上边的é…�置一é��,å�¯åŠ¨çœ‹ä¸‹æ•ˆæžœ**: -* Íø¹Ø·þÎñ£ºherring-gateway£¬zuul Í³Ò»Íø¹ØÎ¢·þÎñ¡£ -* ÈÏÖ¤·þÎñ£ºherring-oauth2£¬oauth2 ÈÏÖ¤ÖÐÐÄ΢·þÎñ¡£ -* »áÔ±·þÎñ£ºherring-member-service£¬Î¢·þÎñÖ®Ò»£¬½ÓÊÕµ½ÇëÇóºó»áµ½ÈÏÖ¤ÖÐÐÄÑéÖ¤¡£ -* ¶©µ¥·þÎñ£ºherring-orders-service£¬Î¢·þÎñÖ®¶þ£¬½ÓÊÕµ½ÇëÇóºó»áµ½ÈÏÖ¤ÖÐÐÄÑéÖ¤¡£ -* ÉÌÆ··þÎñ£ºherring-product-service£¬Î¢·þÎñÖ®Èý£¬½ÓÊÕµ½ÇëÇóºó»áµ½ÈÏÖ¤ÖÐÐÄÑéÖ¤¡£ +* 网关æœ�务:herring-gateway,zuul 统一网关微æœ�务。 +* 认è¯�æœ�务:herring-oauth2,oauth2 认è¯�中心微æœ�务。 +* 会员æœ�务:herring-member-service,微æœ�务之一,接收到请求å�Žä¼šåˆ°è®¤è¯�中心验è¯�。 +* 订å�•æœ�务:herring-orders-service,微æœ�务之二,接收到请求å�Žä¼šåˆ°è®¤è¯�中心验è¯�。 +* 商å“�æœ�务:herring-product-service,微æœ�务之三,接收到请求å�Žä¼šåˆ°è®¤è¯�中心验è¯�。 ![image-20230423174600279](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174600279.png) -1. **ÎÒÃÇÀ´²âÊÔһϣ¬ÏÈÇëÇóÏ token£¬È»ºóÔÙÇëÇó /api/member/update**£º +1. **我们æ�¥æµ‹è¯•一下,先请求下 token,然å�Žå†�请求 /api/member/update**: ``` #### @@ -350,10 +350,10 @@ skywalking POST http://localhost:8080/oauth2-service/oauth/token?grant_type=password&username=admin&password=123456&client_id=app-client&client_secret=client-secret-8888&scope=all Accept: */* Cache-Control: no-cache -¸´ÖÆ´úÂë +å¤�制代ç � ``` -µÃµ½·µ»Ø½á¹û token£º +得到返回结果 token: ``` { @@ -362,13 +362,13 @@ Cache-Control: no-cache "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiZ2F0ZXdheS1zZXJ2aWNlIl0sInVzZXJfbmFtZSI6ImFkbWluIiwiand0LWV4dCI6IkpXVCDmianlsZXkv6Hmga8iLCJzY29wZSI6WyJhbGwiXSwiYXRpIjoiNTgwNjk4OWEtZTI0NC00ZDIzLThhNTktMGM4NGJjMTRiOTk5IiwiZXhwIjoxNjE0MDM0ODk2LCJhdXRob3JpdGllcyI6WyJST0xFX0FETUlOIl0sImp0aSI6IjQxZGM1ZDc1LTZmZDgtNDU3My04YmRjLWI4ZTMwNWEzMThmMyIsImNsaWVudF9pZCI6ImFwcC1jbGllbnQifQ.CGmGx_msqJBHxa95bBROY2SAO14RyeRklVPYrRxZ7pQ", "expires_in": 7199, "scope": "all", - "jwt-ext": "JWT À©Õ¹ÐÅÏ¢", + "jwt-ext": "JWT 扩展信æ�¯", "jti": "5806989a-e244-4d23-8a59-0c84bc14b999" } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -ÇëÇóÖ´ÐÐ /api/member/update +请求执行 /api/member/update ``` #### @@ -377,10 +377,10 @@ GET http://localhost:8080/member-service/api/member/update Accept: */* Cache-Control: no-cache Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiZ2F0ZXdheS1zZXJ2aWNlIl0sInVzZXJfbmFtZSI6ImFkbWluIiwiand0LWV4dCI6IkpXVCDmianlsZXkv6Hmga8iLCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjEzOTcwMDk2LCJhdXRob3JpdGllcyI6WyJST0xFX0FETUlOIl0sImp0aSI6IjU4MDY5ODlhLWUyNDQtNGQyMy04YTU5LTBjODRiYzE0Yjk5OSIsImNsaWVudF9pZCI6ImFwcC1jbGllbnQifQ.EP4acam0tkJQ9kSGRGk_mQsfi1y4M_hhiBL0H931v60 -¸´ÖÆ´úÂë +å¤�制代ç � ``` -**ÒDZíÅ̽á¹ûչʾ**: +**仪表盘结果展示**: ![image-20230423174639471](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174639471.png) @@ -388,24 +388,24 @@ Authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsiZ2F0ZXdhe ![image-20230423174742703](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174742703.png) -**ÍØÆËͼ½á¹ûչʾ**£º +**拓扑图结果展示**: ![image-20230423174809108](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174809108.png) ![image-20230423174831290](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174831290.png) -**Á´Â·×·×Ù½á¹ûչʾ**£º +**链路追踪结果展示**: ![image-20230423174845526](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423174845526.png) -×÷Õߣº°×²Ë˵¼¼Êõ -Á´½Ó£ºhttps://juejin.cn/post/6931922457741770760 -À´Ô´£ºÏ¡ÍÁ¾ò½ð -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +作者:白è�œè¯´æŠ€æœ¯ +链接:https://juejin.cn/post/6931922457741770760 +æ�¥æº�:稀土掘金 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibaba\346\246\202\350\247\210.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibaba\346\246\202\350\247\210.md" index 6fa981f..34474e1 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibaba\346\246\202\350\247\210.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba/SpringCloudAlibaba\346\246\202\350\247\210.md" @@ -1,164 +1,164 @@ -Spring Cloud AlibabaÖÂÁ¦ÓÚÌṩ΢·þÎñ¿ª·¢µÄһվʽ½â¾ö·½°¸£¬ËüÊÇSpring Cloud×é¼þ±»Ö²ÈëAlibabaÔªËØÖ®ºóµÄ²úÎï¡£ÀûÓÃSpring Cloud Alibaba£¬¿ÉÒÔ¿ìËٴ΢·þÎñ¼Ü¹¹²¢Íê³É¼¼ÊõÉý¼¶¡£ÖÐСÆóÒµÈç¹ûÐèÒª¿ìËÙÂäµØÒµÎñÖÐ̨ºÍ¼¼ÊõÖÐ̨£¬²¢ÏòÊý×Ö»¯ÒµÎñתÐÍ£¬ÄÇSpring Cloud Alibaba¾ø¶ÔÊÇÒ»¸ö¡°ÉñÆ÷¡±¡£ +Spring Cloud Alibaba致力于æ��供微æœ�务开å�‘的一站å¼�解决方案,它是Spring Cloud组件被æ¤�å…¥Alibaba元素之å�Žçš„产物。利用Spring Cloud Alibaba,å�¯ä»¥å¿«é€Ÿæ�­å»ºå¾®æœ�务架构并完æˆ�技术å�‡çº§ã€‚中å°�ä¼�业如果需è¦�快速è�½åœ°ä¸šåС䏭å�°å’ŒæŠ€æœ¯ä¸­å�°ï¼Œå¹¶å�‘数字化业务转型,那Spring Cloud Alibabaç»�对是一个“神器â€�。 -# ʲôÊÇSpring Cloud Alibaba +# 什么是Spring Cloud Alibaba -ºÃ°ÉÎÒÃÇÏÈ¿´¿´Spring Cloud AlibabaµÄ¹ÙÍø£¬ÈçÏÂͼËùʾ¡£ +好å�§æˆ‘们先看看Spring Cloud Alibaba的官网,如下图所示。 ![image-20230423165959115](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423165959115.png) -´ÓͼÖоͿÉÒÔ¿´³ö£¬Spring Cloud AlibabaÊÇSpring CloudµÄ×ÓÏîÄ¿£¬ºÃ°É£¬ÕâÁ½ÏîĿһ¿ªÊ¼µÄ¶¨Î»¾ÍÊǸ¸×Ó¹ØÏµ¡£ +从图中就å�¯ä»¥çœ‹å‡ºï¼ŒSpring Cloud Alibaba是Spring Cloudçš„å­�项目,好å�§ï¼Œè¿™ä¸¤é¡¹ç›®ä¸€å¼€å§‹çš„定ä½�就是父å­�关系。 -¿´À´¹Ù·½»¹ÊÇû´òËãµß¸²Spring CloudµÄ¼Ü¹¹Ë¼Ï룬ֻÊÇÏë×öÒ»´ÎÄÜÁ¦µÄÔöÇ¿ºÍÀ©Õ¹¡£ +看æ�¥å®˜æ–¹è¿˜æ˜¯æ²¡æ‰“算颠覆Spring Cloud的架构æ€�想,å�ªæ˜¯æƒ³å�šä¸€æ¬¡èƒ½åŠ›çš„å¢žå¼ºå’Œæ‰©å±•ã€‚ -# ΪʲôҪÓÐSpring Cloud Alibaba +# 为什么è¦�有Spring Cloud Alibaba -ÎÒÃÇÏÈ¿´¿´Spring Cloud AlibabaÓÐÄÄЩÄÜÁ¦£¿ +我们先看看Spring Cloud Alibaba有哪些能力? -Spring Cloud Alibaba µÄ×é¼þ¹¦ÄܼÈÓÐÃâ·Ñ°æ±¾£¬Ò²ÓÐÊշѰ汾¡£ +Spring Cloud Alibaba 的组件功能既有å…�费版本,也有收费版本。 -Sentinel£ºÒÔ¡°Á÷¡±ÎªÇÐÈëµã£¬ÔÚÁ÷Á¿¿ØÖÆ¡¢²¢·¢ÐÔ¡¢ÈÝ´í½µ¼¶ºÍ¸ºÔر£»¤µÈ·½ÃæÌṩ½â¾ö·½°¸£¬ÒÔ±£»¤·þÎñµÄÎȶ¨ÐÔ¡£ +Sentinel:以“æµ�â€�为切入点,在æµ�é‡�控制ã€�å¹¶å�‘性ã€�容错é™�级和负载ä¿�护等方é�¢æ��供解决方案,以ä¿�护æœ�务的稳定性。 -Nacos£ºÒ»¸ö¾ß±¸¶¯Ì¬·þÎñ·¢Ïֺͷֲ¼Ê½ÅäÖõȹ¦ÄܵĹÜÀíÆ½Ì¨£¬Ö÷ÒªÓÃÓÚ¹¹½¨ÔÆÔ­ÉúÓ¦ÓóÌÐò¡£ +Nacos:一个具备动æ€�æœ�务å�‘现和分布å¼�é…�置等功能的管ç�†å¹³å�°ï¼Œä¸»è¦�用于构建云原生应用程åº�。 -RocketMQ£ºÒ»¸ö¸ßÐÔÄÜ¡¢¸ß¿ÉÓᢸßÍÌÍÂÁ¿µÄ½ðÈÚ¼¶ÏûÏ¢Öмä¼þ¡£Spring Cloud Alibaba ½«RocketMQ ¶¨ÖÆ»¯·â×°£¬¿ª·¢ÈËÔ±¿É¡°¿ªÏä¼´Óᱡ£ +RocketMQ:一个高性能ã€�高å�¯ç”¨ã€�高å�žå��é‡�的金èž�级消æ�¯ä¸­é—´ä»¶ã€‚Spring Cloud Alibaba å°†RocketMQ 定制化å°�装,开å�‘人员å�¯â€œå¼€ç®±å�³ç”¨â€�。 -Dubbo£ºÒ»¸ö»ùÓÚJavaµÄ¸ßÐÔÄÜ¿ªÔ´RPC¿ò¼Ü¡£ +Dubbo:一个基于Java的高性能开æº�RPC框架。 -Seata£ºÒ»¸ö¸ßÐÔÄÜÇÒÒ×ÓÚʹÓõķֲ¼Ê½ÊÂÎñ½â¾ö·½°¸£¬¿ÉÓÃÓÚ΢·þÎñ¼Ü¹¹¡£ +Seata:一个高性能且易于使用的分布å¼�事务解决方案,å�¯ç”¨äºŽå¾®æœ�务架构。 -°¢ÀïÔÆOSS£¨°¢ÀïÔÆ¶ÔÏó´æ´¢·þÎñ£©£ºÒ»ÖÖ¼ÓÃܵİ²È«ÔÆ´æ´¢·þÎñ£¬¿ÉÒÔ´æ´¢¡¢´¦ÀíºÍ·ÃÎÊÀ´×ÔÊÀ½çÈκεط½µÄ´óÁ¿Êý¾Ý¡£ +阿里云OSS(阿里云对象存储æœ�务):一ç§�加密的安全云存储æœ�务,å�¯ä»¥å­˜å‚¨ã€�处ç�†å’Œè®¿é—®æ�¥è‡ªä¸–界任何地方的大é‡�æ•°æ�®ã€‚ -°¢ÀïÔÆSchedulerX£ºÒ»¿î·Ö²¼Ê½ÈÎÎñµ÷¶È²úÆ·£¬Ö§³Ö¶¨ÆÚÈÎÎñºÍÔÚÖ¸¶¨Ê±¼äµã´¥·¢ÈÎÎñ¡£ +阿里云SchedulerX:一款分布å¼�任务调度产å“�,支æŒ�定期任务和在指定时间点触å�‘任务。 -°¢ÀïÔÆSMS£ºÒ»ÖÖ¸²¸ÇÈ«ÇòµÄÏûÏ¢·þÎñ£¬Ìṩ±ã½Ý¡¢¸ßЧºÍÖÇÄܵÄͨÐŹ¦ÄÜ£¬¿É°ïÖúÆóÒµ¿ìËÙÁªÏµÆä¿Í»§¡£ +阿里云SMS:一ç§�覆盖全ç�ƒçš„æ¶ˆæ�¯æœ�务,æ��供便æ�·ã€�高效和智能的通信功能,å�¯å¸®åŠ©ä¼�业快速è�”系其客户。 -ÎÒÃÇÔÙÀ´¿´¿´Spring Cloud AlibabaµÄ¸÷¸ö°æ±¾µÄ¶Ô±È£¬ÈçÏÂͼËùʾ¡£ +我们å†�æ�¥çœ‹çœ‹Spring Cloud Alibabaçš„å�„个版本的对比,如下图所示。 ![image-20230423170034102](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423170034102.png) -ÎÒÃÇÔÙÀ´¿´¿´£¬Ã»ÓÐSpring Cloud Alibaba֮ǰ£¬ÎÒÃÇÈçºÎʹÓÃSpring Cloud½øÐÐ΢·þÎñ¿ª·¢¡£ +我们å†�æ�¥çœ‹çœ‹ï¼Œæ²¡æœ‰Spring Cloud Alibaba之å‰�,我们如何使用Spring Cloud进行微æœ�务开å�‘。 -Spring CloudÖ§³Ö¶àÖÖ×¢²áÖÐÐÄ£¬±ÈÈçEureka¡¢ZooKeeper¡¢ConsulµÈ¡£ +Spring Cloud支æŒ�多ç§�注册中心,比如Eurekaã€�ZooKeeperã€�Consul等。 -Èç¹ûÈí¼þ¿ª·¢ÈËÔ±ÐèÒª²ÉÓÃEureka×÷Ϊע²áÖÐÐÄ£¬ÔòÐèÒª´î½¨Ò»¸öEureka Server¼¯Èº£¬ÓÃÓÚ¹ÜÀí×¢²áÖÐÐÄ·þÎñµÄÔªÊý¾Ý£¬È»ºóÓ¦Ó÷þÎñÐèÒª½ÓÈëEureka£¬¾ÍÐèҪʹÓöÔÓ¦µÄ×¢½â½«·þÎñÌṩÕßÒÔ¼°·þÎñ¶©ÔÄÕß×¢²áµ½Eureka×¢²áÖÐÐÄ¡£Í¬ÀíZooKeeperºÍConsulÒ²ÊDzÉÓÃͬÑùµÄ·½Ê½£¬Ê¹ÓöÔӦע²áÖÐÐĵÄ×¢½âÍê³É·þÎñµÄ×¢²áºÍ¶©ÔÄ¡£ +如果软件开å�‘人员需è¦�采用Eureka作为注册中心,则需è¦�æ�­å»ºä¸€ä¸ªEureka Server集群,用于管ç�†æ³¨å†Œä¸­å¿ƒæœ�务的元数æ�®ï¼Œç„¶å�Žåº”用æœ�务需è¦�接入Eureka,就需è¦�使用对应的注解将æœ�务æ��供者以å�Šæœ�务订阅者注册到Eureka注册中心。å�Œç�†ZooKeeperå’ŒConsul也是采用å�Œæ ·çš„æ–¹å¼�,使用对应注册中心的注解完æˆ�æœ�务的注册和订阅。 -Spring CloudΪÁË·½±ãÈí¼þ¿ª·¢ÈËÔ±¿ìËٵĽÓÈ벻ͬµÄ×¢²áÖÐÐÄ£¬Í³Ò»Ê¹ÓÃ×¢½â@EnableDiscoveryClient+¶ÔӦע²áÖÐÐĵÄStarter×é¼þ¡£µ±È»Eureka»¹ÊÇÑØÓÃÀϵÄʹÓ÷½Ê½@EnableEurekaClient+¶ÔӦע²áÖÐÐĵÄStarter×é¼þ£¬Ö÷ÒªÊÇÓÉÓÚSpring CloudÒѾ­Í£Ö¹Á˶ÔEurekaµÄά»¤¡£ +Spring Cloud为了方便软件开å�‘人员快速的接入ä¸�å�Œçš„æ³¨å†Œä¸­å¿ƒï¼Œç»Ÿä¸€ä½¿ç”¨æ³¨è§£@EnableDiscoveryClient+对应注册中心的Starter组件。当然Eureka还是沿用è€�的使用方å¼�@EnableEurekaClient+对应注册中心的Starter组件,主è¦�是由于Spring Cloudå·²ç»�å�œæ­¢äº†å¯¹Eureka的维护。 -ºÃ°ÉÎÊÌâÀ´ÁË£¬Spring CloudÒѾ­½«ZooKeeperºÍConsulµÄʹÓ÷½Ê½Í³Ò»ÆðÀ´£¬Èí¼þ¿ª·¢ÈËÔ±·Ç³£Óä¿ìµÄ½«Ó¦ÓýÓÈëSpring Cloud£¬µ«ÊÇĿǰÊÐÃæÉÏÓÖ³öÁËÒ»¸öеÄ×¢²áÖÐÐÄ£¬±ÈÈçNacos£¬ËüµÄÐÔÄܷdz£¸ß£¬²¢ÇÒÖ§³ÖCPºÍAPģʽ£¬µ«ÊÇSpring Cloud²»Ö§³Ö¡£ +好å�§é—®é¢˜æ�¥äº†ï¼ŒSpring Cloudå·²ç»�å°†ZooKeeperå’ŒConsul的使用方å¼�统一起æ�¥ï¼Œè½¯ä»¶å¼€å�‘人员é�žå¸¸æ„‰å¿«çš„将应用接入Spring Cloud,但是目å‰�市é�¢ä¸Šå�ˆå‡ºäº†ä¸€ä¸ªæ–°çš„æ³¨å†Œä¸­å¿ƒï¼Œæ¯”如Nacos,它的性能é�žå¸¸é«˜ï¼Œå¹¶ä¸”支æŒ�CPå’ŒAP模å¼�,但是Spring Cloudä¸�支æŒ�。 -ÎÒÃÇÔÙÀ´¿´¿´ÔÚûÓÐSpring Cloud Alibaba֮ǰ£¬ÎÒÃÇÈçºÎʹÓÃNacos¡£ +我们å†�æ�¥çœ‹çœ‹åœ¨æ²¡æœ‰Spring Cloud Alibaba之å‰�,我们如何使用Nacos。 -ºÃ°É£¬NacosÊÇÒ»¿î¼ÈÖ§³Ö·Ö²¼Ê½×¢²áÖÐÐĺͷֲ¼Ê½ÅäÖÃÖÐÐĵÄÉñÆ÷¡£Nacos¹Ù·½ÌṩÁ˺ܶà½ÓÈëģʽ£¬±ÈÈçSpring Framework¡¢Spring BootµÈ£¬µ«ÊÇÆäµ×²ã±¾ÖÊÉÏÊÇÒÀÀµNacosÌṩµÄSDK,±ÈÈçNacos Client¡£ +好å�§ï¼ŒNacos是一款既支æŒ�分布å¼�注册中心和分布å¼�é…�置中心的神器。Nacos官方æ��供了很多接入模å¼�,比如Spring Frameworkã€�Spring Boot等,但是其底层本质上是ä¾�èµ–Nacosæ��供的SDK,比如Nacos Client。 -Èç¹û²ÉÓÃSpring Framework+Nacos Client£¨±ÈÈçnacos-spring-context£©£¬ÔòÐèÒª¿ª·¢ÈËÔ±×Ô¼ºÎ¬»¤NacosNamingServceºÍNacosConfigServiceʵÀý¶ÔÏó£¬Ò²¾ÍÊÇ˵¿ª·¢ÈËÔ±ÐèÒª×Ô¼ºÒÀÀµNacos Client×ö¶þ´Î¿ª·¢£¬³É±¾·Ç³£´ó¡£ +如果采用Spring Framework+Nacos Client(比如nacos-spring-context),则需è¦�å¼€å�‘人员自己维护NacosNamingServceå’ŒNacosConfigService实例对象,也就是说开å�‘人员需è¦�自己ä¾�èµ–Nacos Clientå�šäºŒæ¬¡å¼€å�‘,æˆ�本é�žå¸¸å¤§ã€‚ -Èç¹û²ÉÓÃSpring Boot+Nacos Starter×é¼þ£¨±ÈÈçnacos-discovery-spring-boot-starter£©£¬Ôò¿ª·¢ÈËÔ±¿ÉÒÔ¸ßЧµÄ½ÓÈëNacosÅäÖÃÖÐÐÄ£¬²¢ÇÒ¿ÉÒÔʹÓÃSpring BootÌṩµÄ¸÷ÖÖStarter×é¼þ¡£ +如果采用Spring Boot+Nacos Starter组件(比如nacos-discovery-spring-boot-starter),则开å�‘人员å�¯ä»¥é«˜æ•ˆçš„æŽ¥å…¥Nacosé…�置中心,并且å�¯ä»¥ä½¿ç”¨Spring Bootæ��供的å�„ç§�Starter组件。 -Èç¹û´¿Ëé²ÉÓÃSpring Cloud×÷Ϊ»ù´¡¿ò¼Ü£¬Ôò²»ÄÜʹÓÃNacos×÷Ϊע²áÖÐÐÄ£¬ºÃ¾À½á°¡¡£ +如果纯碎采用Spring Cloud作为基础框架,则ä¸�能使用Nacos作为注册中心,好纠结啊。 -ÄÇôÓÐûÓÐÒ»¸ö¿ò¼Ü¼È¿ÉÒÔʹÓÃSpring Cloud£¬ÓÖ¿ÉÒÔʹÓÃSpring Boot£¬»¹ÄܼæÈݸ÷ÖÖ×¢²áÖÐÐÄÄØ£¬ºÜ¸ßÐ˵ĸæËß´ó¼Ò£¬Spring Cloud Alibaba¾ÍÊÇÕâ¸öÉñÆ÷£¬ÍêÃÀµÄ½â¾öÁË¿ª·¢ÈËԱ΢·þÎñ¼Ü¹¹¿ò¼ÜÑ¡Ð͵ÄÎÊÌ⣬ÓÃËü¾ÍÊÇÁË¡£ +那么有没有一个框架既å�¯ä»¥ä½¿ç”¨Spring Cloud,å�ˆå�¯ä»¥ä½¿ç”¨Spring Boot,还能兼容å�„ç§�注册中心呢,很高兴的告诉大家,Spring Cloud Alibaba就是这个神器,完美的解决了开å�‘人员微æœ�务架构框架选型的问题,用它就是了。 -# Spring Cloud AlibabaµÄºËÐļܹ¹Ë¼Ïë +# Spring Cloud Alibaba的核心架构æ€�想 -Spring Cloud AlibabaÕûÌå¼Ü¹¹£¬ÈçÏÂͼ¡£ +Spring Cloud Alibaba整体架构,如下图。 ![image-20230423170108696](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230423170108696.png) -Spring Cloud Alibaba¼Ü¹¹µÄľĿ±êÊǽ«¿ªÔ´²úÆ·ºÍÔÆ³§ÉÌÈںϣ¬×öµ½ÒµÎñÔÆÉϺÍÔÆÏµÄÎÞ·ì¼æÈÝ£¬ÒµÎñ¿ª·¢ÈËÔ±Ö»ÐèÒª¹ØÐÄÒµÎñÏîÄ¿¿ª·¢£¬µ×²ã¼¼Êõϸ½Ú¾Í½»¸øSpring Cloud Alibaba¡£ +Spring Cloud Alibaba架构的木目标是将开æº�产å“�和云厂商èž�å�ˆï¼Œå�šåˆ°ä¸šåŠ¡äº‘ä¸Šå’Œäº‘ä¸‹çš„æ— ç¼�兼容,业务开å�‘人员å�ªéœ€è¦�关心业务项目开å�‘,底层技术细节就交给Spring Cloud Alibaba。 -ÈçºÎ¿ìËÙÉÏÊÖ²¢Ê¹Óà +如何快速上手并使用 -ºÃ°É£¬ËµÁËÄÇô¶àÎÒÃÇÈí¼þ¿ª·¢ÈËÔ±Ôõô¿ìËÙÉÏÊÖSpring Cloud AlibabaÄØ£¿ +好å�§ï¼Œè¯´äº†é‚£ä¹ˆå¤šæˆ‘们软件开å�‘人员怎么快速上手Spring Cloud Alibaba呢? -Æäʵ×î¼òµ¥µÄ·½Ê½ÊÇÓÃÎÊÌâÇý¶¯£¬È»ºó×Ô¼ºÇ××Ô¶¯ÊÖʹÓÃSpring Cloud AlibabaµÄ¹¦ÄÜ£¬ÔÙÈ¥·ÖÎöÔ´ÂëÕâÑù²ÅÄܸü¼ÓÉî¿ÌµÄÊìϤԭÀí¡£ +其实最简å�•的方å¼�是用问题驱动,然å�Žè‡ªå·±äº²è‡ªåŠ¨æ‰‹ä½¿ç”¨Spring Cloud Alibaba的功能,å†�去分æž�æº�ç �这样æ‰�能更加深刻的熟悉原ç�†ã€‚ -Ò²Ðí»áÓÐһЩÈË»áÈÏΪ£¬ÎÒ¿´ÁËÔ´Âë¾ÍËãÊÇÎÒÏÖÔÚÊìϤÁË£¬¹ýÁËÒ»¸öÔÂÖ®ºó¾ÍÍü¼ÇÁË£¬ÓÐʲôÓÃÄØ¡£µ«ÊÇÄãÕâÑùÏ룬¾ÍËãÊDz»¿´Ô´Â룬Äã×öÆäËûµÄÊÂÇ飬һ¸öÔÂÖ®ºóÒ²»áÍü¼ÇµÄ¡£Ö»ÓÐͨ¹ýÀíÂÛºÍʵս½áºÏ£¬Äã²Å»á³¤ÆÚµÄ±£³Öϰ¹ßÈ¥Á·Ï°£¬×öµ½Î¹ʶøÖªÐ¡£ +也许会有一些人会认为,我看了æº�ç �就算是我现在熟悉了,过了一个月之å�Žå°±å¿˜è®°äº†ï¼Œæœ‰ä»€ä¹ˆç”¨å‘¢ã€‚但是你这样想,就算是ä¸�看æº�ç �,你å�šå…¶ä»–的事情,一个月之å�Žä¹Ÿä¼šå¿˜è®°çš„。å�ªæœ‰é€šè¿‡ç�†è®ºå’Œå®žæˆ˜ç»“å�ˆï¼Œä½ æ‰�会长期的ä¿�æŒ�习惯去练习,å�šåˆ°æ¸©æ•…而知新。 -ÔÛÃÇÏÖÔÚÈí¼þ¿ª·¢ÈËÔ±£¬ÓÈÆäÊÇJava¿ª·¢ÈËÔ±£¬Ó¦¸Ã¶¼ÓÃIDEAÀ´×öÏîÄ¿¿ª·¢£¬ÎÒ¾õµÃ¾Í¿ÉÒÔÀûÓÃËüÀ´¿ìËÙµÄÉú³ÉÒ»¸öSpring Cloud AlibabaÏîÄ¿£¬»òÕßÀûÓÃSpring Framework¹Ù·½µÄ½ÅÊÖ¼ÜÏîÄ¿Spring InitializrµÈ¡£ +咱们现在软件开å�‘人员,尤其是Javaå¼€å�‘人员,应该都用IDEAæ�¥å�šé¡¹ç›®å¼€å�‘,我觉得就å�¯ä»¥åˆ©ç”¨å®ƒæ�¥å¿«é€Ÿçš„生æˆ�一个Spring Cloud Alibaba项目,或者利用Spring Framework官方的脚手架项目Spring Initializr等。 -»¹ÓоÍÊÇÒª¶à×ܽáһЩ×î¼Ñʵ¼ù£¬±ÈÈçÒª´ÓSpring Cloud AlibabaµÄÅäÖÃÎļþ¿ªÊ¼£¬·´ß£Ò»Ð©ÅäÖõÄÒµÎñ³¡¾°£¬ÕâÑù²ÅÄܸü¼ÓÉî¿ÌµÄÁ˽âSpring Cloud AlibabaµÄÉè¼ÆË¼Ïë¡£ +还有就是è¦�多总结一些最佳实践,比如è¦�从Spring Cloud Alibabaçš„é…�置文件开始,å��撸一些é…�置的业务场景,这样æ‰�能更加深刻的了解Spring Cloud Alibaba的设计æ€�想。 -Copyright ? ¿¡ÒÝ Link: [https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html](https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html) +Copyright ? 俊逸 Link: [https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html](https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html) -Õâ¿éÏñ¹Ù·½ÎĵµÒ»Ñù£¬¼òµ¥µÄ½éÉÜSpring Cloud Alibaba°üº¬ÁËÄÇЩÖ÷Òª²¿·Ö£¬¼òµ¥Óиö¸ÅÄîºÍÓ¡Ï󣬺óÃæµ±È»»áÏêϸµÄ½éÉÜ£¬ÔÙÈ¥ÉîÈëÀí½â¡£ +è¿™å�—åƒ�官方文档一样,简å�•的介ç»�Spring Cloud Alibaba包å�«äº†é‚£äº›ä¸»è¦�部分,简å�•有个概念和å�°è±¡ï¼Œå�Žé�¢å½“然会详细的介ç»�,å†�去深入ç�†è§£ã€‚ -- **·þÎñÏÞÁ÷ºÍ½µ¼¶**£ºÖ§³Ö`WebServlet`¡¢`WebFlux`¡¢`OpenFeign`¡¢`RestTemplate`¡¢`Dubbo`·ÃÎÊÏÞÁ÷ºÍ½µ¼¶£¬¿ÉÒÔͨ¹ý`console`ʵʱÐÞ¸ÄÏÞÁ÷½µ¼¶²ßÂÔ£¬Ö§³Ö¼à¿ØÏÞÁ÷½µ¼¶Ö¸±ê -- **·þÎñ×¢²áºÍ·¢ÏÖ**£º¿ÉÒÔ×¢²á·þÎñ£¬clients¿ÉÒÔͨ¹ýSpring¹ÜÀíµÄbean·¢ÏÖʵÀý£¬²¢ÈÚºÏÁËRibbon -- **·Ö²¼Ê½ÅäÖÃ**£ºÖ§³Ö·Ö²¼Ê½ÏµÍ³µÄÅäÖÃÀ©Õ¹£¬ÅäÖøıäʱ×Ô¶¯Ë¢Ð -- **Rpc ·þÎñ**£ºÀ©Õ¹Spring CloudµÄRestTemplateºÍOpenFeignÖ§³Öµ÷ÓÃDubbo RPC·þÎñ -- **ʼþÇý¶¯**£ºÖ§³Ö¹¹½¨Í¨¹ý¹²ÏíÏûϢϵͳÁ¬½ÓµÄ¸ß¶È¿ÉÉìËõµÄʼþÇý¶¯µÄ΢·þÎñ -- **·Ö²¼Ê½ÊÂÎñ**£ºÖ§³Ö¸ßÐÔÄÜ¡¢ÈÝÒ×ʹÓõķֲ¼Ê½ÊÂÎñ½â¾ö·½°¸ -- °¢ÀïÔÆ¶ÔÏó´æ´¢¡¢°¢ÀïÔÆÈÎÎñµ÷¶È¡¢°¢ÀïÔÆ¶ÌÐÅ·þÎñ +- **æœ�务é™�æµ�å’Œé™�级**:支æŒ�`WebServlet`ã€�`WebFlux`ã€�`OpenFeign`ã€�`RestTemplate`ã€�`Dubbo`访问é™�æµ�å’Œé™�级,å�¯ä»¥é€šè¿‡`console`实时修改é™�æµ�é™�级策略,支æŒ�监控é™�æµ�é™�级指标 +- **æœ�务注册和å�‘现**:å�¯ä»¥æ³¨å†Œæœ�务,clientså�¯ä»¥é€šè¿‡Spring管ç�†çš„beanå�‘现实例,并èž�å�ˆäº†Ribbon +- **分布å¼�é…�ç½®**:支æŒ�分布å¼�系统的é…�置扩展,é…�置改å�˜æ—¶è‡ªåŠ¨åˆ·æ–° +- **Rpc æœ�务**:扩展Spring Cloudçš„RestTemplateå’ŒOpenFeign支æŒ�调用Dubbo RPCæœ�务 +- **事件驱动**:支æŒ�构建通过共享消æ�¯ç³»ç»Ÿè¿žæŽ¥çš„高度å�¯ä¼¸ç¼©çš„事件驱动的微æœ�务 +- **分布å¼�事务**:支æŒ�高性能ã€�容易使用的分布å¼�事务解决方案 +- 阿里云对象存储ã€�阿里云任务调度ã€�阿里云短信æœ�务 -ÉÏÃæ»ù±¾ÉÏÊǰѹٷ½Îĵµ·­Òë¹ýÀ´µÄ£¬¿ÉÒÔ·¢ÏÖSpring Cloud Alibaba·Ç³£Ç¿´ó£¬»¹²»Ð͝µÄÍùÏ¿´~ +上é�¢åŸºæœ¬ä¸Šæ˜¯æŠŠå®˜æ–¹æ–‡æ¡£ç¿»è¯‘过æ�¥çš„,å�¯ä»¥å�‘现Spring Cloud Alibabaé�žå¸¸å¼ºå¤§ï¼Œè¿˜ä¸�心动的往下看~ -# ÕûÌå´ó¸Ù +# 整体大纲 -## ![springCloud-Alibaba-1](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springCloud-Alibaba-1.png)[#](#°æ±¾¹ØÏµ) °æ±¾¹ØÏµ +## ![springCloud-Alibaba-1](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/springCloud-Alibaba-1.png)[#](#版本关系) 版本关系 -[¹Ù·½°æ±¾ËµÃ÷(opens new window)](https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E) +[官方版本说明(opens new window)](https://github.com/alibaba/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E) -### 2021.x ·ÖÖ§ +### 2021.x 分支 | Spring Cloud Alibaba Version | Spring Cloud Version | Spring Boot Version | | ---------------------------- | --------------------- | ------------------- | | 2021.0.1.0* | Spring Cloud 2021.0.1 | 2.6.3 | | 2021.1 | Spring Cloud 2020.0.1 | 2.4.2 | -### 2.2.x ·ÖÖ§ +### 2.2.x 分支 | Spring Cloud Alibaba Version | Spring Cloud Version | Spring Boot Version | | --------------------------------- | --------------------------- | ------------------- | @@ -169,10 +169,10 @@ Copyright ? | 2.2.1.RELEASE | Spring Cloud Hoxton.SR3 | 2.2.5.RELEASE | | 2.2.0.RELEASE | Spring Cloud Hoxton.RELEASE | 2.2.X.RELEASE | | 2.1.2.RELEASE | Spring Cloud Greenwich | 2.1.X.RELEASE | -| 2.0.4.RELEASE(ֹͣά»¤£¬½¨ÒéÉý¼¶) | Spring Cloud Finchley | 2.0.X.RELEASE | -| 1.5.1.RELEASE(ֹͣά»¤£¬½¨ÒéÉý¼¶) | Spring Cloud Edgware | 1.5.X.RELEASE | +| 2.0.4.RELEASE(å�œæ­¢ç»´æŠ¤ï¼Œå»ºè®®å�‡çº§) | Spring Cloud Finchley | 2.0.X.RELEASE | +| 1.5.1.RELEASE(å�œæ­¢ç»´æŠ¤ï¼Œå»ºè®®å�‡çº§) | Spring Cloud Edgware | 1.5.X.RELEASE | -### ×é¼þ°æ±¾¹ØÏµ +### 组件版本关系 | Spring Cloud Alibaba Version | Sentinel Version | Nacos Version | RocketMQ Version | Dubbo Version | Seata Version | | --------------------------------------------------------- | ---------------- | ------------- | ---------------- | ------------- | ------------- | @@ -187,14 +187,14 @@ Copyright ? | 2.1.1.RELEASE or 2.0.1.RELEASE or 1.5.1.RELEASE | 1.7.0 | 1.1.4 | 4.4.0 | 2.7.3 | 0.9.0 | | 2.1.0.RELEASE or 2.0.0.RELEASE or 1.5.0.RELEASE | 1.6.3 | 1.1.1 | 4.4.0 | 2.7.3 | 0.7.1 | -# ×ܽá +# 总结 -±¾ÎľÍÊÇ´ÓÈ«¾ÖÁÄÁËһЩSpring Cloud AlibabaµÄһЩ¼Ü¹¹Ë¼Ï룬µ«ÊÇûÓдÓϸ½ÚÁÄ£¬¾ßÌåϸ½Ú¿ÉÒԲο¼¡°Spring Cloud AlibabaϵÁС±¡£ +本文就是从全局è�Šäº†ä¸€äº›Spring Cloud Alibaba的一些架构æ€�想,但是没有从细节è�Šï¼Œå…·ä½“细节å�¯ä»¥å�‚考“Spring Cloud Alibaba系列â€�。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\345\217\221\347\216\260.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\345\217\221\347\216\260.md" index af691d6..c48a70f 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\345\217\221\347\216\260.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\345\217\221\347\216\260.md" @@ -1,28 +1,28 @@ -# Ò»¡¢Nacos·þÎñ·¢ÏÖÁ÷³Ìͼ +# 一ã€�Nacosæœ�务å�‘现æµ�程图 -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b5b4ef0330dc4882b0fc2f73994face7.png "ÔÚÕâÀï²åÈëͼƬÃèÊö") +![在这里æ�’入图片æ��è¿°](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b5b4ef0330dc4882b0fc2f73994face7.png "在这里æ�’入图片æ��è¿°") -½¨Òé´ó¼Ò×Ô¼ºÊáÀíÒ»ÏÂÁ÷³Ì£¬Ò²¿ÉÒԲο¼£º[Nacos·þÎñ×¢²áÔ´Âë·ÖÎöÁ÷³Ìͼ](https://blog.csdn.net/Saintmm/article/details/121981184) +建议大家自己梳ç�†ä¸€ä¸‹æµ�程,也å�¯ä»¥å�‚考:[Nacosæœ�务注册æº�ç �分æž�æµ�程图](https://blog.csdn.net/Saintmm/article/details/121981184) -# ¶þ¡¢ÕÒÔ´ÂëÈë¿Ú +# 二ã€�找æº�ç �å…¥å�£ -spring-cloud-commons°üÖж¨ÒåÁËÒ»Ì×·þÎñ·¢ÏֵĹ淶£¬ºËÐÄÂß¼­ÔÚ`DiscoveryClient`½Ó¿ÚÖУ» -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/75ebfd400023456faaafd95e7d9cdbf7.png "ÔÚÕâÀï²åÈëͼƬÃèÊö") -¼¯³ÉSpring CloudʵÏÖ·þÎñ·¢ÏÖµÄ×é¼þ¶¼»áʵÏÖ`DiscoveryClient`½Ó¿Ú£»nacos-discovery°üϵÄ`NacosDiscoveryClient`ÀàʵÏÖ`DiscoveryClient`½Ó¿Ú¡£ -![ÔÚÕâÀï²åÈëͼƬÃèÊö](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0c330a7ce5c744c4a2b25dc024b2430f.png "ÔÚÕâÀï²åÈëͼƬÃèÊö") +spring-cloud-commons包中定义了一套æœ�务å�‘现的规范,核心逻辑在`DiscoveryClient`接å�£ä¸­ï¼› +![在这里æ�’入图片æ��è¿°](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/75ebfd400023456faaafd95e7d9cdbf7.png "在这里æ�’入图片æ��è¿°") +集æˆ�Spring Cloud实现æœ�务å�‘现的组件都会实现`DiscoveryClient`接å�£ï¼›nacos-discovery包下的`NacosDiscoveryClient`类实现`DiscoveryClient`接å�£ã€‚ +![在这里æ�’入图片æ��è¿°](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0c330a7ce5c744c4a2b25dc024b2430f.png "在这里æ�’入图片æ��è¿°") -# Èý¡¢¿Í»§¶Ë·þÎñ·¢ÏÖ +# 三ã€�客户端æœ�务å�‘现 -> 1¡¢µ±nacos¿Í»§¶ËÔË?ÆðÀ´Ö®ºó£¬ËüÖ»ÊÇÈ¥×ö·þÎñ×¢²á¡¢ÅäÖûñÈ¡µÈ²Ù×÷£»²¢²»»áÁ¢¼´È¥ÇëÇó·þÎñÐÅÏ¢£» -> 2¡¢µ±µÚÒ»´ÎÇëÇóʱºò£¬²Å»áÈ¥»ñÈ¡·þÎñ£¬¼´`ÀÁ¼ÓÔØ»úÖÆ`£» +> 1ã€�当nacos客户端è¿�?èµ·æ�¥ä¹‹å�Žï¼Œå®ƒå�ªæ˜¯åŽ»å�šæœ�务注册ã€�é…�置获å�–ç­‰æ“�作;并ä¸�会立å�³åŽ»è¯·æ±‚æœ�务信æ�¯ï¼› +> 2ã€�当第一次请求时候,æ‰�会去获å�–æœ�务,å�³`懒加载机制`ï¼› -#### 1£©ÏÈ´Ó±¾µØ»º´æserviceInfoMapÖлñÈ¡·þÎñʵÀýÐÅÏ¢£¬»ñÈ¡²»µ½Ôòͨ¹ý`NamingProxy`µ÷ÓÃNacos ·þÎñ¶Ë»ñÈ¡·þÎñʵÀýÐÅÏ¢£»×îºó¿ªÆô¶¨Ê±ÈÎÎñÿÃëÇëÇó·þÎñ¶Ë »ñȡʵÀýÐÅÏ¢ÁÐ±í½ø¶ø¸üб¾µØ»º´æserviceInfoMap£» +#### 1)先从本地缓存serviceInfoMap中获å�–æœ�务实例信æ�¯ï¼ŒèŽ·å�–ä¸�到则通过`NamingProxy`调用Nacos æœ�务端获å�–æœ�务实例信æ�¯ï¼›æœ€å�Žå¼€å�¯å®šæ—¶ä»»åŠ¡æ¯�秒请求æœ�务端 获å�–实例信æ�¯åˆ—表进而更新本地缓存serviceInfoMapï¼› ``` // NacosDiscoveryClient#getInstances() public List getInstances(String serviceId) { try { - // ͨ¹ýNacosNamingService»ñÈ¡·þÎñ¶ÔÓ¦µÄʵÀýÐÅÏ¢£»µã½øÈ¥ + // 通过NacosNamingService获å�–æœ�务对应的实例信æ�¯ï¼›ç‚¹è¿›åŽ» List instances = discoveryProperties.namingServiceInstance() .selectInstances(serviceId, true); return hostToServiceInstanceList(instances, serviceId); @@ -38,18 +38,18 @@ public List selectInstances(String serviceName, boolean healthy) throw } public List selectInstances(String serviceName, List clusters, boolean healthy) throws NacosException { - // ĬÈÏ×ß¶©ÔÄģʽ + // 默认走订阅模å¼� return selectInstances(serviceName, clusters, healthy, true); } public List selectInstances(String serviceName, List clusters, boolean healthy, boolean subscribe) throws NacosException { - // ĬÈϲéѯDEFAULT_GROUPϵķþÎñʵÀýÐÅÏ¢ + // 默认查询DEFAULT_GROUP下的æœ�务实例信æ�¯ return selectInstances(serviceName, Constants.DEFAULT_GROUP, clusters, healthy, subscribe); } public List selectInstances(String serviceName, String groupName, List clusters, boolean healthy, boolean subscribe) throws NacosException { ServiceInfo serviceInfo; - // ĬÈÏ×ß¶©ÔÄģʽ£¬¼´subscribeΪTRUE + // 默认走订阅模å¼�,å�³subscribe为TRUE if (subscribe) { serviceInfo = hostReactor.getServiceInfo(NamingUtils.getGroupedName(serviceName, groupName), StringUtils.join(clusters, ",")); } else { @@ -59,7 +59,7 @@ public List selectInstances(String serviceName, String groupName, List } ``` -`HostReactor#getServiceInfo()`·½·¨ÊÇÕæÕý»ñÈ¡·þÎñʵÀýÐÅÏ¢µÄµØ·½£º +`HostReactor#getServiceInfo()`方法是真正获å�–æœ�务实例信æ�¯çš„地方: ``` public ServiceInfo getServiceInfo(final String serviceName, final String clusters) { @@ -70,10 +70,10 @@ public ServiceInfo getServiceInfo(final String serviceName, final String cluster return failoverReactor.getService(key); } - // 1¡¢´Ó±¾µØ»º´æserviceInfoMapÖлñȡʵÀýÐÅÏ¢ + // 1ã€�从本地缓存serviceInfoMap中获å�–实例信æ�¯ ServiceInfo serviceObj = getServiceInfo0(serviceName, clusters); - // 2¡¢Èç¹û±¾µØ»º´æÖÐûÓУ¬Ôò×ßHTTPµ÷ÓôÓNacos·þÎñ¶Ë»ñÈ¡ + // 2ã€�如果本地缓存中没有,则走HTTP调用从Nacosæœ�务端获å�– if (null == serviceObj) { serviceObj = new ServiceInfo(serviceName, clusters); @@ -97,15 +97,15 @@ public ServiceInfo getServiceInfo(final String serviceName, final String cluster } } - // 3¡¢¿ªÆôÒ»¸ö¶¨Ê±ÈÎÎñ£¬Ã¿¸ôÒ»Ãë´ÓNacos·þÎñ¶Ë»ñÈ¡×îеķþÎñʵÀýÐÅÏ¢£¬¸üе½±¾µØ»º´æseriveInfoMapÖÐ + // 3ã€�å¼€å�¯ä¸€ä¸ªå®šæ—¶ä»»åŠ¡ï¼Œæ¯�隔一秒从Nacosæœ�务端获å�–最新的æœ�务实例信æ�¯ï¼Œæ›´æ–°åˆ°æœ¬åœ°ç¼“å­˜seriveInfoMap中 scheduleUpdateIfAbsent(serviceName, clusters); - // 4¡¢ ´Ó±¾µØ»º´æserviceInfoMapÖлñÈ¡·þÎñʵÀýÐÅÏ¢ + // 4ã€� 从本地缓存serviceInfoMap中获å�–æœ�务实例信æ�¯ return serviceInfoMap.get(serviceObj.getKey()); } ``` -1¡¢´Ó±¾µØ»º´æÖлñÈ¡·þÎñʵÀýÐÅÏ¢£º +1ã€�从本地缓存中获å�–æœ�务实例信æ�¯ï¼š ``` private ServiceInfo getServiceInfo0(String serviceName, String clusters) { @@ -116,17 +116,17 @@ private ServiceInfo getServiceInfo0(String serviceName, String clusters) { } ``` -2¡¢Ôò×ßHTTPµ÷ÓôÓNacos·þÎñ¶Ë»ñÈ¡·þÎñʵÀýÐÅÏ¢£º +2ã€�则走HTTP调用从Nacosæœ�务端获å�–æœ�务实例信æ�¯ï¼š ``` public void updateServiceNow(String serviceName, String clusters) { ServiceInfo oldService = getServiceInfo0(serviceName, clusters); try { - // ͨ¹ýNamingProxy×ßHTTP½Ó¿Úµ÷Ó㬻ñÈ¡·þÎñʵÀýÐÅÏ¢ + // 通过NamingProxyèµ°HTTP接å�£è°ƒç”¨ï¼ŒèŽ·å�–æœ�务实例信æ�¯ String result = serverProxy.queryList(serviceName, clusters, pushReceiver.getUDPPort(), false); if (StringUtils.isNotEmpty(result)) { - // ¸üб¾µØ»º´æserviceInfoMap + // 更新本地缓存serviceInfoMap processServiceJSON(result); } } catch (Exception e) { @@ -141,7 +141,7 @@ public void updateServiceNow(String serviceName, String clusters) { } ``` -3¡¢¿ªÆôÒ»¸ö¶¨Ê±ÈÎÎñ£¬Ã¿¸ôÒ»Ãë´ÓNacos·þÎñ¶Ë»ñÈ¡×îеķþÎñʵÀýÐÅÏ¢£¬¸üе½±¾µØ»º´æseriveInfoMapÖУº +3ã€�å¼€å�¯ä¸€ä¸ªå®šæ—¶ä»»åŠ¡ï¼Œæ¯�隔一秒从Nacosæœ�务端获å�–最新的æœ�务实例信æ�¯ï¼Œæ›´æ–°åˆ°æœ¬åœ°ç¼“å­˜seriveInfoMap中: ``` public void scheduleUpdateIfAbsent(String serviceName, String clusters) { @@ -154,13 +154,13 @@ public void scheduleUpdateIfAbsent(String serviceName, String clusters) { return; } - // Æô¶¯¶¨Ê±ÈÎÎñ + // å�¯åŠ¨å®šæ—¶ä»»åŠ¡ ScheduledFuture future = addTask(new UpdateTask(serviceName, clusters)); futureMap.put(ServiceInfo.getKey(serviceName, clusters), future); } } -// ¶¨Ê±ÈÎÎñÖ´ÐÐÂß¼­£¬UpdateTask#run() +// 定时任务执行逻辑,UpdateTask#run() public void run() { try { ServiceInfo serviceObj = serviceInfoMap.get(ServiceInfo.getKey(serviceName, clusters)); @@ -180,7 +180,7 @@ public void run() { refreshOnly(serviceName, clusters); } - // ¿ªÆôÒ»¸ö¶¨Ê±ÈÎÎñ£¬1sÖ®ºóÖ´ÐÐ + // å¼€å�¯ä¸€ä¸ªå®šæ—¶ä»»åŠ¡ï¼Œ1s之å�Žæ‰§è¡Œ executor.schedule(this, serviceObj.getCacheMillis(), TimeUnit.MILLISECONDS); lastRefTime = serviceObj.getLastRefTime(); @@ -191,7 +191,7 @@ public void run() { } ``` -²éѯ·þÎñʵÀýÁÐ±í£º +查询æœ�务实例列表: ``` public String queryList(String serviceName, String clusters, int udpPort, boolean healthyOnly) @@ -209,7 +209,7 @@ public String queryList(String serviceName, String clusters, int udpPort, boolea } ``` -#### 2£©ÔÚHostReactorʵÀý»¯µÄʱºò»áʵÀý»¯PushReceiver£¬½ø¶ø¿ªÆôÒ»¸öÏß³ÌËÀÑ­»·Í¨¹ý`DatagramSocket#receive()`¼àÌýNacos·þÎñ¶ËÖзþÎñʵÀýÐÅÏ¢·¢Éú±ä¸üºóµÄUDP֪ͨ¡£ +#### 2)在HostReactor实例化的时候会实例化PushReceiver,进而开å�¯ä¸€ä¸ªçº¿ç¨‹æ­»å¾ªçŽ¯é€šè¿‡`DatagramSocket#receive()`监å�¬Nacosæœ�务端中æœ�务实例信æ�¯å�‘生å�˜æ›´å�Žçš„UDP通知。 ``` public class PushReceiver implements Runnable { @@ -219,7 +219,7 @@ public class PushReceiver implements Runnable { try { this.hostReactor = hostReactor; udpSocket = new DatagramSocket(); - // Æô¶¯Ò»¸öÏß³Ì + // å�¯åŠ¨ä¸€ä¸ªçº¿ç¨‹ executorService = new ScheduledThreadPoolExecutor(1, new ThreadFactory() { @Override public Thread newThread(Runnable r) { @@ -243,7 +243,7 @@ public class PushReceiver implements Runnable { byte[] buffer = new byte[UDP_MSS]; DatagramPacket packet = new DatagramPacket(buffer, buffer.length); - // ¼àÌýNacos·þÎñ¶Ë·þÎñʵÀýÐÅÏ¢±ä¸üºóµÄ֪ͨ + // 监å�¬Nacosæœ�务端æœ�务实例信æ�¯å�˜æ›´å�Žçš„通知 udpSocket.receive(packet); String json = new String(IoUtils.tryDecompress(packet.getData()), "UTF-8").trim(); @@ -283,16 +283,16 @@ public class PushReceiver implements Runnable { } ``` -# ËÄ¡¢·þÎñ¶Ë·þÎñ·¢ÏÖ +# å››ã€�æœ�务端æœ�务å�‘现 -Nacos·þÎñ¶ËµÄ·þÎñ·¢ÏÖÖ÷Òª×öÁ½¼þÊ£º +Nacosæœ�务端的æœ�务å�‘现主è¦�å�šä¸¤ä»¶äº‹ï¼š -> 1¡¢²éѯ·þÎñʵÀýÁÐ±í£»ÏÈ´Ó»º´æserviceMapÖÐÕÒµ½service¶ÔÓ¦µÄCluster£¬ÔÙ´ÓClusterµÄÁ½¸öSet£º`persistentInstances`¡¢`ephemeralInstances`»ñȡȫÁ¿µÄʵÀýÐÅÏ¢£» -> 2¡¢½«¿Í»§¶Ë´«À´µÄip¡¢udp¶Ë¿ÚºÅ¼ÓÌí¼Óµ½`clientMap`£¬½ø¶ø×ö·þÎñÍÆËÍ£»clientMapÊôÓÚ`NamingSubscriberService`µÄʵÏÖÀà`NamingSubscriberServiceV1Impl`£¬ÆäkeyÊÇservice name£¬valueÊǶ©ÔÄÁ˸÷þÎñµÄ¿Í»§¶ËÁбí(ip+¶Ë¿ÚºÅ)¡£ +> 1ã€�查询æœ�务实例列表;先从缓存serviceMap中找到service对应的Cluster,å†�从Cluster的两个Set:`persistentInstances`ã€�`ephemeralInstances`获å�–å…¨é‡�的实例信æ�¯ï¼› +> 2ã€�将客户端传æ�¥çš„ipã€�udp端å�£å�·åŠ æ·»åŠ åˆ°`clientMap`,进而å�šæœ�务推é€�ï¼›clientMap属于`NamingSubscriberService`的实现类`NamingSubscriberServiceV1Impl`,其key是service name,value是订阅了该æœ�务的客户端列表(ip+端å�£å�·)。 -¼ûnamingÏîÄ¿Ï嵀 InstanceControllerÀàµÄlist()·½·¨£º +è§�naming项目下的 InstanceController类的list()方法: -#### 1£©»ñÈ¡·þÎñʵÀýÁбí +#### 1)获å�–æœ�务实例列表 ``` @GetMapping("/list") @@ -317,7 +317,7 @@ public Object list(HttpServletRequest request) throws Exception { Subscriber subscriber = new Subscriber(clientIP + ":" + udpPort, agent, app, clientIP, namespaceId, serviceName, udpPort, clusters); - // ½øÈ¥InstanceOperatorServiceImpl#listInstance()·½·¨»ñÈ¡·þÎñʵÀýÁбí + // 进去InstanceOperatorServiceImpl#listInstance()方法获å�–æœ�务实例列表 return getInstanceOperator().listInstance(namespaceId, serviceName, subscriber, clusters, healthyOnly); } @@ -332,7 +332,7 @@ public ServiceInfo listInstance(String namespaceId, String serviceName, Subscrib // now try to enable the push try { - // ³¢ÊÔÆôÓÃÍÆËÍ·þÎñUdpPushService£¬¼´·þÎñʵÀýÐÅÏ¢·¢Éú±ä¸üʱͨ¹ýUDPµÄ·½Ê½Í¨ÖªNacos Client + // å°�试å�¯ç”¨æŽ¨é€�æœ�务UdpPushService,å�³æœ�务实例信æ�¯å�‘生å�˜æ›´æ—¶é€šè¿‡UDP的方å¼�通知Nacos Client if (subscriber.getPort() > 0 && pushService.canEnablePush(subscriber.getAgent())) { subscriberServiceV1.addClient(namespaceId, serviceName, cluster, subscriber.getAgent(), new InetSocketAddress(clientIP, subscriber.getPort()), pushDataSource, StringUtils.EMPTY, @@ -353,19 +353,19 @@ public ServiceInfo listInstance(String namespaceId, String serviceName, Subscrib return result; } - // ¼ì²é·þÎñÊÇ·ñ½ûÓà + // 检查æœ�务是å�¦ç¦�用 checkIfDisabled(service); - // ÕâÀïÊÇ»ñÈ¡·þÎñ×¢²áÐÅÏ¢µÄ¹Ø¼ü´úÂ룬»ñÈ¡ËùÓÐÓÀ¾ÃºÍÁÙʱ·þÎñʵÀý + // 这里是获å�–æœ�务注册信æ�¯çš„关键代ç �,获å�–所有永久和临时æœ�务实例 List srvedIps = service .srvIPs(Arrays.asList(StringUtils.split(cluster, StringUtils.COMMA))); - // filter ips using selector£¬Ñ¡ÔñÆ÷¹ýÂË·þÎñ + // filter ips using selector,选择器过滤æœ�务 if (service.getSelector() != null && StringUtils.isNotBlank(clientIP)) { srvedIps = selectorManager.select(service.getSelector(), clientIP, srvedIps); } - // Èç¹ûÕÒ²»µ½·þÎñÔò·µ»Øµ±Ç°·þÎñ + // 如果找ä¸�到æœ�务则返回当å‰�æœ�务 if (CollectionUtils.isEmpty(srvedIps)) { ....... return result; @@ -384,7 +384,7 @@ public List srvIPs(List clusters) { public List allIPs(List clusters) { List result = new ArrayList<>(); for (String cluster : clusters) { - // ·þÎñ×¢²áµÄʱºò£¬»á½«ÊµÀýÐÅϢдµ½clusterMapÖУ¬ÏÖÔÚ´ÓÆäÖÐÈ¡ + // æœ�务注册的时候,会将实例信æ�¯å†™åˆ°clusterMap中,现在从其中å�– Cluster clusterObj = clusterMap.get(cluster); if (clusterObj == null) { continue; @@ -398,47 +398,47 @@ public List allIPs(List clusters) { // Cluster#allIPs() public List allIPs() { List allInstances = new ArrayList<>(); - // »ñÈ¡·þÎñÏÂËùÓеij־û¯ÊµÀý + // 获å�–æœ�务下所有的æŒ�久化实例 allInstances.addAll(persistentInstances); - // »ñÈ¡·þÎñÏÂËùÓеÄÁÙʱʵÀý + // 获å�–æœ�务下所有的临时实例 allInstances.addAll(ephemeralInstances); return allInstances; } ``` -#### 2£©²ÉÓÃUDP·½Ê½×ö·þÎñʵÀýÍÆËÍ +#### 2)采用UDPæ–¹å¼�å�šæœ�务实例推é€� -NamingSubscriberServiceV1Impl#addClient()£º +NamingSubscriberServiceV1Impl#addClient(): ``` public void addClient(String namespaceId, String serviceName, String clusters, String agent, InetSocketAddress socketAddr, DataSource dataSource, String tenant, String app) { - // ³õʼ»¯ÍÆËͿͻ§¶ËʵÀýPushClient + // åˆ�始化推é€�客户端实例PushClient PushClient client = new PushClient(namespaceId, serviceName, clusters, agent, socketAddr, dataSource, tenant, app); - // Ìí¼ÓÍÆËÍÄ¿±ê¿Í»§¶Ë + // 添加推é€�目标客户端 addClient(client); } -// ÖØÔØ·½·¨addClient() +// é‡�载方法addClient() public void addClient(PushClient client) { // client is stored by key 'serviceName' because notify event is driven by serviceName change - // ¿Í»§¶ËÓɼü¡° serviceName¡±´æ´¢£¬ÒòΪ֪ͨʼþÓÉserviceName¸ü¸ÄÇý¶¯ + // 客户端由键“ serviceNameâ€�存储,因为通知事件由serviceName更改驱动 String serviceKey = UtilsAndCommons.assembleFullServiceName(client.getNamespaceId(), client.getServiceName()); ConcurrentMap clients = clientMap.get(serviceKey); - // Èç¹û»ñÈ¡²»µ½¿Í»§¶ËÏëµ÷ÓõÄServiceName¶ÔÓ¦µÄÍÆËͿͻ§¶Ë£¬Ôòн¨ÍÆËͿͻ§¶Ë£¬²¢»º´æ + // 如果获å�–ä¸�到客户端想调用的ServiceName对应的推é€�客户端,则新建推é€�客户端,并缓存 if (clients == null) { clientMap.putIfAbsent(serviceKey, new ConcurrentHashMap<>(1024)); clients = clientMap.get(serviceKey); } PushClient oldClient = clients.get(client.toString()); - // ´æÔÚÀϵÄPushClient£¬ÔòˢР+ // 存在è€�çš„PushClient,则刷新 if (oldClient != null) { oldClient.refresh(); } else { - // ·ñÔò»º´æPushClient + // å�¦åˆ™ç¼“å­˜PushClient PushClient res = clients.putIfAbsent(client.toString(), client); if (res != null) { Loggers.PUSH.warn("client: {} already associated with key {}", res.getAddrStr(), res); @@ -448,20 +448,20 @@ public void addClient(PushClient client) { } ``` -# Îå¡¢×ܽá +# 五ã€�总结 -¿Í»§¶Ë£º +客户端: -> 1¡¢ÓÅÏÈ´Ó±¾µØ»º´æÖлñÈ¡·þÎñʵÀýÐÅÏ¢£» -> 2¡¢Î¬»¤¶¨Ê±ÈÎÎñ¶¨Ê±´ÓNacos·þÎñ¶Ë»ñÈ¡·þÎñʵÀýÐÅÏ¢£» +> 1ã€�优先从本地缓存中获å�–æœ�务实例信æ�¯ï¼› +> 2ã€�维护定时任务定时从Nacosæœ�务端获å�–æœ�务实例信æ�¯ï¼› -·þÎñ¶Ë£º +æœ�务端: -> 1¡¢·µ»ØÖ¸¶¨ÃüÃû¿Õ¼äÏÂÄÚ´æ×¢²á±íÖÐËùÓеÄÓÀ¾ÃʵÀýºÍÁÙʱʵÀý¸ø¿Í»§¶Ë£» -> 2¡¢¿ªÆôÒ»¸öUDP·þÎñʵÀýÐÅÏ¢±ä¸üÍÆËÍ·þÎñ£» +> 1ã€�返回指定命å��空间下内存注册表中所有的永久实例和临时实例给客户端; +> 2ã€�å¼€å�¯ä¸€ä¸ªUDPæœ�务实例信æ�¯å�˜æ›´æŽ¨é€�æœ�务; -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://developer.aliyun.com/article/1058262 https://ost.51cto.com/posts/14835 https://developer.aliyun.com/article/1048465 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\346\263\250\345\206\214.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\346\263\250\345\206\214.md" index 1a59865..f25549f 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\346\263\250\345\206\214.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\234\215\345\212\241\346\263\250\345\206\214.md" @@ -1,4 +1,4 @@ -# Ò»¡¢ Nacos·þÎñ×¢²áÔ´Âë½âÎö +# 一ã€� Nacosæœ�务注册æº�ç �è§£æž� @@ -6,7 +6,7 @@ -## 1.1 Ô´Â뷽ʽ´ò°ü +## 1.1 æº�ç �æ–¹å¼�打包 @@ -14,7 +14,7 @@ -¿Í»§¶ËÔ´ÂëÖÐÔö¼Ó´ò°ü·½Ê½£¬½«Ô´Âë´òÈë°üÖÐ +客户端æº�ç �中增加打包方å¼�,将æº�ç �打入包中 @@ -30,7 +30,7 @@ -È»ºó´ò°ü£º +ç„¶å�Žæ‰“包: @@ -46,7 +46,7 @@ -## 1.2 Èë¿Ú +## 1.2 å…¥å�£ @@ -54,33 +54,33 @@ -[github.com/alibaba/nac¡­](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fnacos%2Ftree%2F1.4.1) +[github.com/alibaba/nac…](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fnacos%2Ftree%2F1.4.1) -Ê×ÏÈÎÒÃÇ»á°ÑÔ´ÂëÏÂÔØÏÂÀ´£¬ÎÒÃÇ»áͨ¹ýÔ´ÂëµÄ·½Ê½½øÐÐÆô¶¯£¬ Äã¿ÉÒÔͨ¹ýdebugµÄ·½Ê½½øÐÐÔËÐÐÀ´ÅжÏËûµÄÔËÐйý³Ì¡£ +首先我们会把æº�ç �下载下æ�¥ï¼Œæˆ‘们会通过æº�ç �的方å¼�进行å�¯åŠ¨ï¼Œ ä½ å�¯ä»¥é€šè¿‡debug的方å¼�进行è¿�行æ�¥åˆ¤æ–­ä»–çš„è¿�行过程。 -ÎÒÃÇ´ÓÔ´ÂëµÄ½Ç¶ÈÀ´·ÖÎöһϣº·þÎñÆô¶¯ºóËû»áÉϱ¨µ½×¢²áÖÐÐÄ£º +我们从æº�ç �的角度æ�¥åˆ†æž�一下:æœ�务å�¯åЍå�Žä»–会上报到注册中心: -NacosNamingService ¾ÍÊÇ·þÎñ×¢²áºÍ·¢ÏÖÏà¹ØµÄÀ࣬Ëû¾ÍÊÇÔÚÕâÀォµ±Ç°Æô¶¯µÄ·þÎñµ÷ÓÃ×¢²áʵÀýµÄ·½·¨£¬ÎÒÃÇ¿´Ò»ÏÂÕâ¸ö·½·¨¸ÉʲôÁË£¿ +NacosNamingService 就是æœ�务注册和å�‘现相关的类,他就是在这里将当å‰�å�¯åŠ¨çš„æœ�务调用注册实例的方法,我们看一下这个方法干什么了? ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/fc004433c7304147905c088dd3227005.png "image.png") ![image-20211221124947544](E:\BaiduNetdiskWorkspace\springcloud alibaba\img\image-20211221124947544.png) -Ëû¾ÍÊÇÆ´½ÓÁËһЩ²ÎÊý·¢ËÍhttpÇëÇ󣬵½´ï·þÎñ×¢²áÖÐÐĽøÐз¢ÏÖ£¬ÇëÇóµÄ¾ÍÊÇÕâ¸ö·¾¶£º +他就是拼接了一些å�‚æ•°å�‘é€�http请求,到达æœ�务注册中心进行å�‘现,请求的就是这个路径: ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/51f5b45b70ef4a7dbe1258e05314fa61.png "image.png") -ºÃÕâ¾ÍÊǶÔÓ¦µÄ·¾¶£¬ÎÒÃǻص½¹Ù·½ÎĵµµÄÖ¸Äϵ±ÖÐ +好这就是对应的路径,我们回到官方文档的指å�—当中 -[nacos.io/zh-cn/docs/¡­](https://link.juejin.cn?target=https%3A%2F%2Fnacos.io%2Fzh-cn%2Fdocs%2Fopen-api.html) +[nacos.io/zh-cn/docs/…](https://link.juejin.cn?target=https%3A%2F%2Fnacos.io%2Fzh-cn%2Fdocs%2Fopen-api.html) ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d3b30ba715ab4363b3ee8b4e21a2f3a2.png "image.png") -ºÃ£¬°´ÕÕÎÒÃǽ²µ½ÕâÀï¾Í²»ÓÃÔÙÍùÀïÃæ¿´ÁË£¬ÎÒÃÇ¿ÉÒÔµã½øÈ¥¿´Ò»Ï£¬ +好,按照我们讲到这里就ä¸�用å†�往里é�¢çœ‹äº†ï¼Œæˆ‘们å�¯ä»¥ç‚¹è¿›åŽ»çœ‹ä¸€ä¸‹ï¼Œ ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/9f4bbf69cc1746e79545831252796e55.png "image.png") -ËûÕæÕýµÄµ÷ÓøøÄãÊÇÔÚÕâÀï¡£ +他真正的调用给你是在这里。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b06c94937d374ddb9fc2c224e5932205.png "image.png") @@ -90,39 +90,39 @@ NacosNamingService ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/527d2af9bb0c4206b090d3410238a576.png "image.png") -ÔÚÕâÀï½øÐе÷Óà +在这里进行调用 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/3f3f39de5aaa4ad2b3ac7dccc33aa574.png "image.png") -ºÃÄÄÓÐͬѧÎÊÄãÔõô֪µÀ¶Ïµã¾Í´ïµ½ÕâÀÄÇÎÒÃÇ¿´Ò»ÏÂÔõÑù²é¿´Ô´ÂëµÄÆô¶¯µÄ·¾¶£¬ÎÒÃÇ¿´Ò»ÏÂÎÒÃǶ©µ¥Î¢·þÎñµÄ·¾¶£¬ÎÒÃÇÒª¼¯³ÉnacosµÄ·þÎñ·¢ÏÖ¹¦ÄÜ£¬ÎÒÃÇÒªÒýÈëÎÒÃǵÄdiscoveryµÄ°ü£¬ËûÊÇÒ»¸östarter£¬Ç°ÃæÎÒÃÇѧ¹ýspringbootÎÒÃÇÖªµÀÈκÎstarterÀïÃæÒ»¶¨Óиöspring.factories£¬×÷Ϊһ¸öÈë¿Ú +好哪有å�Œå­¦é—®ä½ æ€Žä¹ˆçŸ¥é�“断点就达到这里,那我们看一下怎样查看æº�ç �çš„å�¯åŠ¨çš„è·¯å¾„ï¼Œæˆ‘ä»¬çœ‹ä¸€ä¸‹æˆ‘ä»¬è®¢å�•å¾®æœ�务的路径,我们è¦�集æˆ�nacosçš„æœ�务å�‘现功能,我们è¦�引入我们的discovery的包,他是一个starter,å‰�é�¢æˆ‘们学过springboot我们知é�“任何starter里é�¢ä¸€å®šæœ‰ä¸ªspring.factories,作为一个入å�£ ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/be47c62f16f94507a1af84d0169ebf53.png "image.png") -ÕâÀïÃæ¶¯Ì¬¼ÓÔØµÄÀàºÜ¶à£¬NacosServiceRegistryAutoConfiguration ´ÓÕâÃû×ÖÎÒÃÇÄÜ·¢ÏÖËûÊÇÒ»¸önacos·þÎñ×¢²áµÄ×Ô¶¯ÅäÖÃÀ࣬ +这里é�¢åЍæ€�加载的类很多,NacosServiceRegistryAutoConfiguration 从这å��字我们能å�‘现他是一个nacosæœ�务注册的自动é…�置类, ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/84017587439846a4b21a696f12775b6c.png "image.png") -ÕâÀïÃæÊµÏÖÁËÈý¸öÀ࣬ÎÒÃÇ¿´Ò»ÏÂÕâ¸öÀàNacosAUtoServiceRegistration +这里é�¢å®žçŽ°äº†ä¸‰ä¸ªç±»ï¼Œæˆ‘ä»¬çœ‹ä¸€ä¸‹è¿™ä¸ªç±»NacosAUtoServiceRegistration ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/fe7ee87e88944b689835432c833972c2.png "image.png") -×Ô¶¯×¢²áÀ࣬ÎÒÃÇ¿ÉÒÔ¿´Ò»ÏÂËûµÄ¼¯³É¹ØÏµ£¬ÊÇÒ»¸öApplicationListener springÆô¶¯Íê³Éºó¶¼»á·¢ËÍÒ»¸öÏûÏ¢£¬applicaitonListener¾ÍÊÇͨ¹ý¼àÌýÕâ¸öÏûϢȻºó½øÐÐÖ´Ðеġ£ËùÒÔÎÒÃÇÖªµÀÏÂÒ»²½ÎÒÃÇÓ¦¸ÃÔõô¿´£º +自动注册类,我们å�¯ä»¥çœ‹ä¸€ä¸‹ä»–的集æˆ�关系,是一个ApplicationListener springå�¯åŠ¨å®Œæˆ�å�Žéƒ½ä¼šå�‘é€�一个消æ�¯ï¼ŒapplicaitonListener就是通过监å�¬è¿™ä¸ªæ¶ˆæ�¯ç„¶å�Žè¿›è¡Œæ‰§è¡Œçš„。所以我们知é�“下一步我们应该怎么看: ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/2a12ba62dae24aa092f97b0cff5dfaaa.png "image.png") -ËùÒԲ鿴ËûµÄ³éÏóÀà¡£ +所以查看他的抽象类。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1f9253dbbbd349ffb6d0e60d0761b3ec.png "image.png") -²é¿´onApplicationEvent·½·¨£ºÕâÑùÔÚ·þÎñ·¢ËÍÍê¾Í»á·¢ËÍÕâÑùÒ»¸öÏûÏ¢£¬ÊÕµ½Õâ¸öÏûÏ¢¾Í»áµ÷ÓÃÕâ¸öbind·½·¨ +查看onApplicationEvent方法:这样在æœ�务å�‘é€�完就会å�‘é€�这样一个消æ�¯ï¼Œæ”¶åˆ°è¿™ä¸ªæ¶ˆæ�¯å°±ä¼šè°ƒç”¨è¿™ä¸ªbind方法 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/41a7323a2e2c49d19aaf5768e66af7d8.png "image.png") -ÕâÀïÓиöif return ÎÒÃǾÍÖ±½ÓÌø¹ý£¬ÕâÒ»¶¨ÊÇ·ÖÖ§´úÂ룬ÏñÕâÑùµÄ·ÖÖ§´úÂëÎÒÃǾͲ»Òª¿´£¬µÚÒ» ´ÎÒª¿´Ö÷Ïߣ¬ËùÒÔÎÒÃÇÖ±½Ó¿´ÕâÀïµÄstart·½·¨£¬Èç¹ûºóÃæÕâÀïûÓжÔÓ¦µÄ´úÂëÂß¼­ÎÒÃÇ¿ÉÒÔ½øÈëÕâ¸ö·ÖÖ§À´¿´¡£ ºÃ£¬ÏñÕâÑùstart, begin£¬init£¬register·½·¨¶¼ÊǺÜÖØÒªµÄ·½·¨£¬ÎÒÃÇÒ»¶¨Òª½øÈ¥¿´ +这里有个if return 我们就直接跳过,这一定是分支代ç �,åƒ�这样的分支代ç �我们就ä¸�è¦�看,第一 次è¦�看主线,所以我们直接看这里的start方法,如果å�Žé�¢è¿™é‡Œæ²¡æœ‰å¯¹åº”的代ç �逻辑我们å�¯ä»¥è¿›å…¥è¿™ä¸ªåˆ†æ”¯æ�¥çœ‹ã€‚ 好,åƒ�这样start, begin,init,register方法都是很é‡�è¦�的方法,我们一定è¦�进去看 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/3923ffd589e9488eb1143811a50d28c0.png "image.png") -µÚÒ»¸öif¾Í²»Óÿ´£¬µÚ¶þ¸öifÐèÒª¿´£¬ÒòΪºóÃæ¾ÍûÓÐÂß¼­ÁËÄã¿´Õâ¸öregister()£¬Ó¦¸Ã¾ÍÊÇÕâ¸ö·½·¨£¬ÒòΪÄã¾ÍÊDz鿴ע²áµÄÁ÷³Ì¡£ +第一个ifå°±ä¸�用看,第二个if需è¦�看,因为å�Žé�¢å°±æ²¡æœ‰é€»è¾‘了你看这个register(),应该就是这个方法,因为你就是查看注册的æµ�程。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d5b527e0900a4f1b9abcd76db4bfc138.png "image.png") @@ -132,9 +132,9 @@ NacosNamingService ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0ca3ab1a98f248a0aa3854730eba85fb.png "image.png") -ÕâÀïÐèÒªÄãÖªµÀSpringBoot×Ô¶¯×°ÅäµÄ»ù±¾ÖªÊ¶£¬Æä´ÎÒªÖªµÀSpringÆô¶¯·¢ÏÖµÄ »ù±¾ÖªÊ¶¡£ +这里需è¦�你知é�“SpringBoot自动装é…�的基本知识,其次è¦�知é�“Springå�¯åЍå�‘现的 基本知识。 -## 1.3 ·þÎñ×¢²á +## 1.3 æœ�务注册 @@ -142,21 +142,21 @@ NacosNamingService -Nacos¸ß²¢·¢Ö§³ÅÒì²½ÈÎÎñÓëÄÚ´æ¶ÓÁÐÆÊÎö +Nacos高并å�‘支撑异步任务与内存队列剖æž� -¸Õ²ÅÊÇÔÚ·þÎñÌṩÕßÉÏÃæ½²µÄÄÚÈÝ£¬ÏÖÔÚÎÒÃÇ·þÎñ×¢²áÖÐÐÄÀ´¿´Ò»Ï +刚æ‰�是在æœ�务æ��供者上é�¢è®²çš„内容,现在我们æœ�务注册中心æ�¥çœ‹ä¸€ä¸‹ -ÇëÇóµÄÊÇinstanceʵÀý£ºÕâ¾ÍÊÇÒ»¸öspringmvcµÄcontroller£¬ËùÓÐÎÒÃÇ¿ÉÒÔÈ«ÎÄËÑË÷ Controller£¬ÎÒÃÇÊÇinstanceʵÀý°É£¬ËùÒÔÎÒÃÇÕâÀïInstanceController +请求的是instance实例:这就是一个springmvcçš„controller,所有我们å�¯ä»¥å…¨æ–‡æ�œç´¢ Controller,我们是instance实例å�§ï¼Œæ‰€ä»¥æˆ‘们这里InstanceController ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4e02f16787a84704add5aa41f9d7662a.png "image.png") -ÄÇ֮ǰÎÒÃÇÓõÄÊÇpostÇëÇóËùÒÔÎÒÃDz鿴post·½·¨£¬ÕâÀïÓÐdelete,update...,ËûÕâÀïÊÇʲô·ç¸ñ£¿ restFul +那之å‰�我们用的是post请求所以我们查看post方法,这里有delete,update...,他这里是什么风格? restFul -ÎÒÃÇ·¢ÏÖÀïÃæÃ»ÓжÔÓ¦µÄDefaultGroup£¬ÔÚ·þÎñ×¢²áºÍ·¢ÏÖµÄÇé¿öÏÂÕâ¸ögroupÊDz»¾­³£Óõġ£ÄãÓõϰֻÊÇ×Ô¼ºµÄ¹æ·¶ºÍ·½±ã¹ÜÀíµÄ¡£ÔÚ·þÎñ×¢²áºÍ·¢ÏÖÖÐÔ´ÂëÖж¼Ã»ÓÐÓᣣ¬ÃüÃû¿Õ¼ä£¬·þÎñÃû£¬È»ºó½«ÎÒÃDzÎÊýת»¯ÎªÊµÀý¡£Õâ¾ÍÎÒÃÇ·þÎñÄ£ÐÍÖеÄÈý²ãÄ£ÐÍ¡£ +我们å�‘现里é�¢æ²¡æœ‰å¯¹åº”çš„DefaultGroup,在æœ�务注册和å�‘现的情况下这个group是ä¸�ç»�常用的。你用的è¯�å�ªæ˜¯è‡ªå·±çš„规范和方便管ç�†çš„。在æœ�务注册和å�‘现中æº�ç �中都没有用。,命å��空间,æœ�务å��,然å�Žå°†æˆ‘们å�‚数转化为实例。这就我们æœ�务模型中的三层模型。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/09f059ba31a7444a88a24b03399d502d.png "image.png") -ÄÇÎÒÃÇ¿´Ò»ÏÂËûµÄ×¢²áʵÀýÀïÃæ×öÁËʲô£¿ ÕâÀïÃæÎÒÃÇ×¢ÒâÎÒÃÇÊÇ×¢²áinstance£¬ÎÒÃǾÍÎ§ÈÆ×ÅËû£¬½øÐзÖÎö£¬ÊDz»ÊǾÍÀ´µ½addInstanceÁË +那我们看一下他的注册实例里é�¢å�šäº†ä»€ä¹ˆï¼Ÿ 这里é�¢æˆ‘们注æ„�我们是注册instance,我们就围绕ç�€ä»–,进行分æž�,是ä¸�是就æ�¥åˆ°addInstance了 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4b69913abe6f40288a08dee89ecb0772.png "image.png") @@ -164,61 +164,61 @@ createEmptyService ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b8a3063b3c924ee195af64d5d8efa647.png "image.png") -1¡¢»ñÈ¡service ³õ´Î»ñȡһ¶¨Îª¿Õ£¬ÎÒÃÇ¿ÉÒÔ½øÈ¥·ÖÎöһϠ+1ã€�获å�–service åˆ�次获å�–一定为空,我们å�¯ä»¥è¿›åŽ»åˆ†æž�一下 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/fdf453ebadee486c9def86560bc3b8de.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/7025fb4edcc247b3aca0f1f851d26203.png "image.png") -ÕâÀï¾ÍÊÇ×¢²á±í£¬ÎÒÃÇÇ°ÃæËµ¹ýnacos·þÎñÁìÓòÄ£ÐÍ¡¾¿ÉÒԲο¼Í¼¡¿£¬Õâ¸ömap¾ÍÊǶÔÓ¦µÄ×¢²á±í +这里就是注册表,我们å‰�é�¢è¯´è¿‡nacosæœ�务领域模型ã€�å�¯ä»¥å�‚考图】,这个map就是对应的注册表 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4f1db03d3fcc4f93aaa17cc485fb59c2.png "image.png") -ÕâÀïÃæÉèÖ÷þÎñºÍ³õʼ»¯ +这里é�¢è®¾ç½®æœ�务和åˆ�始化 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1af3a9015b2c4e1ab06da283e4dc5332.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/cb795dd33b114f84bc51cdbdca5af202.png "image.png") -·þÎñ³õʼ»¯£ºÐÄÌø +æœ�务åˆ�始化:心跳 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0d0583abf0184ed49bf5fd93c9effafe.png "image.png") -¿´ÕâÀïÊǸöscheduleNamingHealthÊÇÒ»¸ö¶¨Ê±ÈÎÎñ£¬ÎÒÃÇÖ»ÐèÒª¿´Ò»ÏÂtaskÈÎÎñ¾Í¿ÉÒÔ +看这里是个scheduleNamingHealth是一个定时任务,我们å�ªéœ€è¦�看一下task任务就å�¯ä»¥ ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/51ba8120a9954389b9e2f44d49532a14.png "image.png") -taskÈÎÎñÎÒÃÇÐèÒª¿´Ò»ÏÂrun·½·¨£º +task任务我们需è¦�看一下run方法: -ÔÚÕâÀïÎÒÃÇ¿´ÊÇ»ñÈ¡ËùÓеÄʵÀý¡¾¿ÉÒÔµã½øÈ¥¿´Ò»Ï¡¿ +在这里我们看是获å�–所有的实例ã€�å�¯ä»¥ç‚¹è¿›åŽ»çœ‹ä¸€ä¸‹ã€‘ -µ±Ç°Ê±¼ä - ÉÏ´ÎÐÄÌøÊ±¼ä ¼ä¸ô³¬¹ý15Ãë Ôò½«ÊµÀýÉèÖÃΪ·Ç½¡¿µ£¬ µ±³¬¹ý30ÃëûÓÐÊÕµ½ÐÄÌø¾ÍÖ±½ÓÌÞ³ý +当å‰�æ—¶é—´ - 上次心跳时间 间隔超过15ç§’ 则将实例设置为é�žå�¥åº·ï¼Œ 当超过30秒没有收到心跳就直接剔除 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f9131eea860e410685d8c4cd5beea69e.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/586fd2fcb489414590295ce2dfafd91d.png "image.png") -ºÃ£¬ÎÒÃÇ»ØÀ´£¬ÕâÀïÃû×ÖÆðµÄÌØ±ðºÃ£¬createEmtyService£¬ÊÇ´´½¨Ò»¸ö¿Õ·þÎñ£¬ºóÃæÎÒÃǵÄʵÀý£¬ÊDz»ÊÇ»¹»á×¢²áµ½ÀïÃæ£¬ +好,我们回æ�¥ï¼Œè¿™é‡Œå��字起的特别好,createEmtyService,是创建一个空æœ�务,å�Žé�¢æˆ‘们的实例,是ä¸�是还会注册到里é�¢ï¼Œ ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/9518406856b642298d3ee2f16e36bed0.png "image.png") -> ÎÒÃÇ¿ÉÒÔ¿´Ò»Ï·þÎñÄ£ÐÍ£¬ºÍÎÒÃÇÒÔǰ˵¹ýµÄÒ»Ñù +> 我们å�¯ä»¥çœ‹ä¸€ä¸‹æœ�务模型,和我们以å‰�说过的一样 > -> ÃüÃû¿Õ¼ä £¬cluster ¼¯Èº¸ÅÄî +> 命å��空间 ,cluster 集群概念 > > ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0323827c8249417b8ab3fd6c4bd3e61e.png "image.png") > > ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/044d8f58dc5b4c7e83dab05c62397566.png "image.png") > -> ¼¯ÈºÖжÔÓ¦µÄʵÀý¡£ +> 集群中对应的实例。 > > ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/da6adcbf25f44992b08f919988f81b62.png "image.png") -ÎÒÃÇ¿´Ò»ÏÂaddinstance +我们看一下addinstance ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/cb9d4cb8fd4d4f0aa75e5d95c4923aae.png "image.png") -¹¹½¨¶ÔÓ¦µÄkey: +构建对应的key: @@ -242,7 +242,7 @@ task -```//»ñȡע²áʵÀýµÄIP¶Ë¿ÚÁбí List instanceList = addIpAddresses(service, ephemeral, ips); ``` +```//获å�–注册实例的IP端å�£åˆ—表 List instanceList = addIpAddresses(service, ephemeral, ips); ``` @@ -250,11 +250,11 @@ task -ÎÒÃǽøÈë¼òµ¥µÄ¿´Ò»Ï£¬ÎÒÃÇ·¢ÏÖÕâ¸öadd,remove£¬ÕâÀï¾ÍÊÇÐÂÔöºÍÒÆ³ýʵÀý +我们进入简å�•的看一下,我们å�‘现这个add,remove,这里就是新增和移除实例 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/bebd689b54d04e0dab0e64ac552e965e.png "image.png") -ÎÒÃÇÖ÷Òª³öÀïÕâдע²á½øÀ´µÄips£¬ÄÇÎÒÃǾ͵ã»÷ips£¬¸ßÁÁÀ´ÏÔʾ¿´¿´£¬È»ºóËû»á½øÐÐÑ­»·instance£¬ÕâÀïÎÒÃÇ¿ÉÒÔ¿´µ½Èç¹ûËûÊÇÒÆ³ý¾Í´ÓmapÀïÃæÒÆ³ý³öÈ¥£¬Èç¹ûÊÇÐÂÔö¾ÍÔÚinstanceMapÖÐÐÂÔöһϣ¬×îºó½«ÆÚ·µ»Ø¡£ +我们主è¦�出里这写注册进æ�¥çš„ips,那我们就点击ips,高亮æ�¥æ˜¾ç¤ºçœ‹çœ‹ï¼Œç„¶å�Žä»–会进行循环instance,这里我们å�¯ä»¥çœ‹åˆ°å¦‚果他是移除就从map里é�¢ç§»é™¤å‡ºåŽ»ï¼Œå¦‚æžœæ˜¯æ–°å¢žå°±åœ¨instanceMap中新增一下,最å�Žå°†æœŸè¿”回。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4d797c90012b4c22ac6e999bdfad8d63.png "image.png") @@ -264,91 +264,91 @@ task ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/86453757688743df89df30752bbbe0e5.png "image.png") -ÏÖÀ࣬ÎÒÃÇ¿ÉÒԲ²âһϣ¬»òÕßdebug½øÈ¥£¬µ±È»Õâ¸öÀ࣬ÎÒÃǵã»÷һϣ¬ÔÚÉùÃ÷µÄµØ·½ +现类,我们å�¯ä»¥çŒœæµ‹ä¸€ä¸‹ï¼Œæˆ–者debug进去,当然这个类,我们点击一下,在声明的地方 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f7a189074e00495da10119f2a5de7bc5.png "image.png") -ËüÖ¸¶¨ÁËÃû³Æ£º +它指定了å��称: ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c54ca72e12e04d80b189d587a535d834.png "image.png") -ºÃ£¬ÎÒÃÇÈ«ÎÄËÑË÷¿´Ò»Ï£º +好,我们全文æ�œç´¢çœ‹ä¸€ä¸‹ï¼š ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/2b24cf84302c42669bed76d19a11e301.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/fcf6ffab779548a694a68c443a90a214.png "image.png") -ÎÒÃÇÖªµÀÇ°ÃæËµ¹ýephemeralÊÇtrueËùÒÔÑ¡ÔñµÚÒ»¸ö£º ÓÐÒÉÎÊ£º +我们知é�“å‰�é�¢è¯´è¿‡ephemeral是true所以选择第一个: 有疑问: ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4adb989d26cf46f98c943a114e047679.png "image.png") -ÎÒÃÇÓ¦¸Ãµ÷ÓÃEphemeralConsistencyService¶ÔÓ¦µÄput·½·¨¡£µ«ÊÇEphemeralConsistencyServiceÖ»ÊÇÒ»¸ö½Ó¿Ú£¬ÎÒÃÇÓ¦¸Ãµ÷ÓöÔÓ¦µÄʵÏÖʵÀý¡£ +我们应该调用EphemeralConsistencyService对应的put方法。但是EphemeralConsistencyServiceå�ªæ˜¯ä¸€ä¸ªæŽ¥å�£ï¼Œæˆ‘们应该调用对应的实现实例。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/87869280d709441fbb8ceec818d67a97.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/3764ecf8f5904315af85482f3c3ee71d.png "image.png") -ÎÒÃÇ¿´Ò»ÏÂËûµÄonput·½·¨¡£ +我们看一下他的onput方法。 -ÏÖÔڷŵ½¶ÓÁÐÖУº +现在放到队列中: ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/02a34386b7444f0e8a6e35e57ceedf84.png "image.png") -ÕâÀïÃæ¾ÍÊǰѺËÐĵÄÇëÇó·Åµ½blockqueneÀïÃæ£¬Ò²¾ÍÊÇÒ»¸ö×èÈû¶ÓÁÐÖÐ +这里é�¢å°±æ˜¯æŠŠæ ¸å¿ƒçš„请求放到blockquene里é�¢ï¼Œä¹Ÿå°±æ˜¯ä¸€ä¸ªé˜»å¡žé˜Ÿåˆ—中 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/81b1c141753c492493eb095ead9e34da.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/252863f614a24c2da64713af52669ce5.png "image.png") -Õû¸ö×¢²áµÄ¹ý³Ì¾ÍÕâô¼òµ¥£¬Ò»¸öÇëÇó¹ýÀ´£¬×îÖÕ½«·þÎñ×¢²áµÄÇëÇ󣬷ŵ½ÎÒÃǵÄ×èÈû¶ÓÁе±ÖУ¬·Åµ½ÔòÉ«¶ÓÁÐÖ®ºó£¬Õû¸ö×èÈû¶ÓÁоͷµ»ØÁË¡£ÄǷŵ½×èÈû¶ÓÁÐÖ®ºó£¬ÄÄÀïÓзÃÎÊÕâ¸ö×èÈû¶ÓÁС£ +整个注册的过程就这么简å�•,一个请求过æ�¥ï¼Œæœ€ç»ˆå°†æœ�务注册的请求,放到我们的阻塞队列当中,放到则色队列之å�Žï¼Œæ•´ä¸ªé˜»å¡žé˜Ÿåˆ—就返回了。那放到阻塞队列之å�Žï¼Œå“ªé‡Œæœ‰è®¿é—®è¿™ä¸ªé˜»å¡žé˜Ÿåˆ—。 -´ó¼Ò×¢ÒâÕâ¸öNotifierÊÇÒ»¸öỊ̈߳¬ÀÏʦ½»´ó¼ÒÒ»¸ö¼¼ÇÉ£ºÈç¹ûÓöµ½Ò»¸öÏ߳̾ÍÐèÒª¿´ËûµÄrun·½·¨ÒòΪrun·½·¨²ÅÊÇËû ÕæÕýÖ´ÐдúÂëµÄµØ·½¡£ +大家注æ„�这个Notifier是一个线程,è€�师交大家一个技巧:如果é�‡åˆ°ä¸€ä¸ªçº¿ç¨‹å°±éœ€è¦�看他的run方法因为run方法æ‰�是他 真正执行代ç �的地方。 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/659d96fac1d445859a6ea6086ab8277c.png "image.png") -ÔÚÕâÀï½øÐÐËÀÑ­»·½øÐÐÊý¾Ý´¦Àí£¬²»¶ÏµÄ´¦Àí¿Í»§¶Ë×¢²áµÄÐÅÏ¢£¬¶ª½øÀ´¾ÍʵÏÖºóÃæµÄÒì²½×¢²áÐÅÏ¢£¬ +在这里进行死循环进行数æ�®å¤„ç�†ï¼Œä¸�断的处ç�†å®¢æˆ·ç«¯æ³¨å†Œçš„ä¿¡æ�¯ï¼Œä¸¢è¿›æ�¥å°±å®žçްå�Žé�¢çš„异步注册信æ�¯ï¼Œ -Õâ¸öÏ̻߳áÒ»Ö±ÔÚת£¬Ò»Ö±ÔËÐУ¬Èç¹ûËû¹ÒÁËÄÇ˵Ã÷Õû¸ö·þÎñ¾Í¹ÒµôÁË£¬ºÃ£¬Äã¿´×ÅÀïÃæµÄÒì³£Ò²³ÔµôÁË£¬ËùÒÔÒ»Ö±»áÔËÐУ¬Èç¹ûûÓÐÊý¾ÝËû»á×èÈû£¬×èÈû»áÈóöcpu +这个线程会一直在转,一直è¿�行,如果他挂了那说明整个æœ�务就挂掉了,好,你看ç�€é‡Œé�¢çš„异常也å�ƒæŽ‰äº†ï¼Œæ‰€ä»¥ä¸€ç›´ä¼šè¿�行,如果没有数æ�®ä»–会阻塞,阻塞会让出cpu ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/487a2e6d15f642549fe0d145447cc5cf.png "image.png") -×¢²á±í½á¹¹µÄ·ÖÎö£º +注册表结构的分æž�: ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/3eab037db7e2480ba4a9b439b18567da.png "image.png") -Ê×Ïȵ±ËûÊǸöchangeµÄʱºò£¬ÎÒÃǾͽøÈëonChange£¬ËûÊǸö·þÎñËùÒÔÎÒÃǽøÈëËûµÄserviceÀïÃæÈ¥¿´£º +首先当他是个change的时候,我们就进入onChange,他是个æœ�务所以我们进入他的service里é�¢åŽ»çœ‹ï¼š ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4adf69d76188430d860f2003b6c508d6.png "image.png") -ÕâÀïÃæ¾Í²»Óÿ´ÁË£¬ÏÈ¿´È¨ÖØ£¬È¨ÖØ´óÓÚ¶àÉÙµÄʱºòÉèÖÃ×î´óÖµ£¬È¨ÖØÐ¡ÓÚ¶àÉÙµÄʱºòÉèÖÃÒ»¸ö×îСֵ¡£È»ºó¾ÍÊǺËÐĵķ½·¨updateIP +这里é�¢å°±ä¸�用看了,先看æ�ƒé‡�,æ�ƒé‡�大于多少的时候设置最大值,æ�ƒé‡�å°�于多少的时候设置一个最å°�值。然å�Žå°±æ˜¯æ ¸å¿ƒçš„æ–¹æ³•updateIP ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/887332bfdcb64c2f9ad871ee55961b59.png "image.png") -ÄÇÕâ¸öupdateIPsÊÇ×öÊ²Ã´ÄØ£¿ ×öµÄ¾ÍÊÇÎÒ±éÀúÎÒËùÓÐҪע²áµÄʵÀý£¬È»ºó¾Í·Åµ½ÎÒÃǵÄclusterMapÀïÃæ +那这个updateIPs是å�šä»€ä¹ˆå‘¢ï¼Ÿ å�šçš„就是我é��历我所有è¦�注册的实例,然å�Žå°±æ”¾åˆ°æˆ‘们的clusterMap里é�¢ ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/87df4508357847f1ab49a785ab464e5b.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b31cf0150533469ebd4fbc462c6a0952.png "image.png") -Äǵ½ÕâÀï´ó¼Ò¿ÉÄܾÍÓÐÒÉÎÊÁË£¬ÄÇʲôʱºòÆô¶¯Õâ¸öỊ̈߳¬À´ÊµÊ±¼àÌýÎÒÃÇÏûÏ¢µÄ×èÈû¶ÓÁÐÄØ£¿ ½Ì´ó¼ÒÈçºÎÕÒÒ»ÏÂÕâ¸ö·½·¨£¬ÎÒÃÇÏÖÔÚ¿´×ŸöÀà½ÐNotifier£¬ÒòΪËû±¾Éí¾ÍÊÇÒ»¸öỊ̈߳¬Ëû»á¶ªµ½Ò»¸öÏ̳߳ØÖнøÐÐÔËÐУ¬ÎÒÃÇ¿´Ò»ÏÂËû¾¿¾¹ÊÇÔÚÄÄÀïʵÀý»¯µÄ£¬ +那到这里大家å�¯èƒ½å°±æœ‰ç–‘问了,那什么时候å�¯åŠ¨è¿™ä¸ªçº¿ç¨‹ï¼Œæ�¥å®žæ—¶ç›‘å�¬æˆ‘们消æ�¯çš„阻塞队列呢? 教大家如何找一下这个方法,我们现在看ç�€ä¸ªç±»å�«Notifier,因为他本身就是一个线程,他会丢到一个线程池中进行è¿�行,我们看一下他究竟是在哪里实例化的, ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/16223a5f9aab4fdaa004d0698e6cb0a6.png "image.png") -ÎÒÃÇ¿´µ½Õâ¸ö·½·¨£ºÕâ¸ö×¢½â¾ÍÊǵ±ÄãµÄspringµÄÒ»¸öÀà½øÐгõʼ»¯Ö®ºó½øÐе÷Óõģ¬ÄÇÎÒÃÇ¿´Ò»ÏÂÕâ¸öinit·½·¨µ½µ×ÊÇ×öÁËʲô +我们看到这个方法:这个注解就是当你的spring的一个类进行åˆ�始化之å�Žè¿›è¡Œè°ƒç”¨çš„,那我们看一下这个init方法到底是å�šäº†ä»€ä¹ˆ ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b9d2a25274834d73ab8f939006e9b075.png "image.png") ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/64f25704efac43a7ae6ee5afda46cdf7.png "image.png") -ÊÇÒ»¸öScheduledÏ̳߳أº +是一个Scheduled线程池: ![image-20211222222903941](E:\BaiduNetdiskWorkspace\springcloud alibaba\img\image-20211222222903941.png) -Ò²¾ÍÊÇÔÚ¶ÔÏó³õʼ»¯µÄʱºò¾Í½øÐÐÆô¶¯Ò»¸öÏ̳߳أ¬È¥ÔËÐÐnotifier¶ÔÓ¦µÄ·½·¨¡£Õâ¸örun·½·¨¾ÍÊÇÕâÑùrunµÄ¡£Æô¶¯ºó¾Í»áʵʱ¼àÌýÒì²½¶ÓÁС£ÕâÑùдµÄºÃ´¦£¬¾ÍÊǽ«Ð´ºÍ´¦ÀíÍêÈ«¸ôÀëÁË¡£Í¨¹ý¼àÌý¸ßÐÔÄܵÄÄÚ´æ¶ÓÁУ¬À´´¦ÀíÕâ¸öÊÂÇ飬ËûÕâÑùµÄºÃ´¦£¬1¡¢Ìá¸ßÐÔÄÜ +也就是在对象åˆ�始化的时候就进行å�¯åŠ¨ä¸€ä¸ªçº¿ç¨‹æ± ï¼ŒåŽ»è¿�行notifier对应的方法。这个run方法就是这样run的。å�¯åЍå�Žå°±ä¼šå®žæ—¶ç›‘å�¬å¼‚步队列。这样写的好处,就是将写和处ç�†å®Œå…¨éš”离了。通过监å�¬é«˜æ€§èƒ½çš„内存队列,æ�¥å¤„ç�†è¿™ä¸ªäº‹æƒ…,他这样的好处,1ã€�æ��高性能 ![image.png](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e27c8e72b30845c3ab9346b89932fb42.png "image.png") -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\246\202\350\247\210.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\246\202\350\247\210.md" index dc517a0..24de931 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\246\202\350\247\210.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\346\246\202\350\247\210.md" @@ -1,19 +1,19 @@ -ÔÚ¿´ÕâÆªÎÄÕÂ֮ǰ£¬×îºÃ¶ÔNACOSÏà¹Ø¹¦ÄÜÓÐËùÁË½â£¬ÍÆ¼ö¿´Íê[Spring Cloud Alibaba Nacos£¨¹¦ÄÜÆª£©](https://zhuanlan.zhihu.com/p/68700978)¡£ +在看这篇文章之å‰�,最好对NACOS相关功能有所了解,推è��看完[Spring Cloud Alibaba Nacos(功能篇)](https://zhuanlan.zhihu.com/p/68700978)。 -Õë¶Ô¹¦ÄÜ£¬ÓÐÄ¿µÄµÄÈ¥ÕÒÏà¶ÔÓ¦µÄÔ´´úÂ룬½øÒ»²½Á˽⹦ÄÜÊÇÈçºÎ±»ÊµÏÖ³öÀ´µÄ¡£ +针对功能,有目的的去找相对应的æº�代ç �,进一步了解功能是如何被实现出æ�¥çš„。 -±¾ÎÄÕë¶ÔÓÐÒ»¶¨Ô´´úÂëÔĶÁ¾­ÑéµÄÈËȺ£¬²»»áÉîÈëÌ«¶àµÄϸ½Ú£¬»¹ÐèÒª¶ÁÕß´ò¿ªÔ´Âë¸ú×Ù£¬×ÔÐÐÁì»á¡£ +本文针对有一定æº�代ç �阅读ç»�验的人群,ä¸�会深入太多的细节,还需è¦�读者打开æº�ç �跟踪,自行领会。 -## Ò»¡¢Òý×Ó +## 一ã€�引å­� -½øÈëGitHub¶ÔÓ¦µÄ[Ò³Ãæ](https://link.zhihu.com/?target=https%3A//github.com/alibaba/nacos)£¬½«NACOS¹¤³ÌcloneÏÂÀ´¡£Ä¿Â¼ºÍÎļþ¿´ÆðÀ´ºÜÈß³¤£¬µ«ÊǶÔÓÚ¿´Ô´´úÂëÕæÕýÓаïÖúµÄ²¿·Ö²¢²»¶à¡£ +进入GitHub对应的[页é�¢](https://link.zhihu.com/?target=https%3A//github.com/alibaba/nacos),将NACOS工程clone下æ�¥ã€‚目录和文件看起æ�¥å¾ˆå†—长,但是对于看æº�代ç �真正有帮助的部分并ä¸�多。
![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-e9966f158af7cfac39baf5bba456fd17_720w.webp) -
nacos¹¤³ÌĿ¼½á¹¹
+
nacos工程目录结构
@@ -22,7 +22,7 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-9195cfddde4e94b16f239bc101825a5a_720w.webp) -
Ä£¿éÒÀÀµÍ¼
+
模��赖图
@@ -31,19 +31,19 @@ ![](https://pic4.zhimg.com/80/v2-6b30d0fc994745002ee7dcc7b04154d3_720w.webp) -
nacosÇëÇóÄ£ÐÍ
+
nacos请求模型
-ÓÐÁËÕâÈýÕÅͼ£¬¾ÍÄÜ˳ÀûÕÒµ½Í»ÆÆ¿ÚÁË£¬ºËÐÄÄÚÈݾͼ¯ÖÐÔÚnacos-console£¬nacos-naming£¬nacos-config£¬Ë³ÌÙÃþ¹Ï£¬¾ÍÄÜ¿´µ½²»ÉÙÄÚÈÝÁË¡£ +有了这三张图,就能顺利找到çª�ç ´å�£äº†ï¼Œæ ¸å¿ƒå†…容就集中在nacos-console,nacos-naming,nacos-config,顺藤摸瓜,就能看到ä¸�少内容了。 -Èç¹û»¹ÊǸоõÎÞ´ÓÏÂÊֵϰ£¬ÄǾÍÒÆ²½nacos-example£¬ÀïÃæÓÐÖ÷ÒªÒµÎñµÄµ÷ÓÃÈë¿Ú£¬Ò»¿´±ãÖª¡£ +如果还是感觉无从下手的è¯�,那就移步nacos-example,里é�¢æœ‰ä¸»è¦�业务的调用入å�£ï¼Œä¸€çœ‹ä¾¿çŸ¥ã€‚ -## ¶þ¡¢ÅäÖ÷þÎñ +## 二ã€�é…�ç½®æœ�务 -Ê×ÏÈ´ÓÒ»¸ö¹¤³§Àà˵Æð£ºcom.alibaba.nacos.api.NacosFactory¡£ +首先从一个工厂类说起:com.alibaba.nacos.api.NacosFactory。 -ÀïÃæµÄ¾²Ì¬·½·¨ÓÃÓÚ´´½¨ConfigServiceºÍNamingService£¬´úÂëÀàËÆ£¬ÒÔ´´½¨ConfigServiceΪÀý£º +里é�¢çš„é�™æ€�方法用于创建ConfigServiceå’ŒNamingService,代ç �类似,以创建ConfigService为例: @@ -62,9 +62,9 @@ public static ConfigService createConfigService(Properties properties) throws Na -ûÓÐʲô¸´ÔÓµÄÂß¼­£¬Ê¹ÓõÄÊÇ»ù±¾µÄ·´ÉäÔ­Àí¡£¹¹Ôì²ÎÊý´«ÈëÁËproperties£¬ÕâЩÊôÐÔ¿ÉÒÔͨ¹ýbootstrap.ymlÖÐÖ¸¶¨£¬¶ÔÓ¦µÄÊÇNacosConfigProperties¡£ +没有什么å¤�æ�‚的逻辑,使用的是基本的å��射原ç�†ã€‚构造å�‚数传入了properties,这些属性å�¯ä»¥é€šè¿‡bootstrap.yml中指定,对应的是NacosConfigProperties。 -ÐèҪϸ¿´µÄÊǹ¹Ô캯ÊýÖжÔÓÚnamespace³õʼ»¯µÄÄDz¿·ÖÄÚÈÝ¡£ +需è¦�细看的是构造函数中对于namespaceåˆ�始化的那部分内容。 @@ -104,21 +104,21 @@ private void initNamespace(Properties properties) { -´«ÈëµÄproperties»áÖ¸¶¨ÊÇ·ñ½âÎöÔÆ»·¾³ÖеÄnamespace²ÎÊý£¬Èç¹ûÊǵ쬾ÍÊÇÈ¥¶ÁÈ¡°¢ÀïÔÆ»·¾³µÄϵͳ±äÁ¿£»Èç¹û²»ÊÇ£¬ÄÇô¾Í¶ÁÈ¡propertiesÖÐÖ¸¶¨µÄnamespace£¬Ã»ÓÐÖ¸¶¨µÄ»°£¬×îÖÕ½âÎö³öÀ´µÄÊÇ¿Õ×Ö·û´®¡£´Ó´úÂëÉÏ¿´³öÀ´£¬»ñÈ¡ÔÆ»·¾³µÄnamespace×ö³ÉÁËÒì²½»¯µÄÐÎʽ£¬µ«ÊÇĿǰ°æ±¾»¹ÊÇʹÓõÄͬ²½µ÷Óᣠ+传入的properties会指定是å�¦è§£æž�云环境中的namespaceå�‚数,如果是的,就是去读å�–阿里云环境的系统å�˜é‡�;如果ä¸�是,那么就读å�–properties中指定的namespace,没有指定的è¯�,最终解æž�出æ�¥çš„æ˜¯ç©ºå­—符串。从代ç �上看出æ�¥ï¼ŒèŽ·å�–云环境的namespaceå�šæˆ�了异步化的形å¼�,但是目å‰�版本还是使用的å�Œæ­¥è°ƒç”¨ã€‚ -¼ÌÐø¸ú×ÙConfigService£¬ÀïÃæ¶¨ÒåÁËһϵÁнӿڷ½·¨£¬ÕýÊÇÎÒÃÇËùÒª¿´µÄ¡£ +继续跟踪ConfigService,里é�¢å®šä¹‰äº†ä¸€ç³»åˆ—接å�£æ–¹æ³•,正是我们所è¦�看的。 -ÿ¸öÒµÎñʵÏÖ×îÖÕ¶¼¹é½áΪHttpÇëÇ󣬾ÍÊÇÅäÖõÄserverAddr£¬¶à¸öµØÖ·»áÒÀ´ÎÂÖתʹÓ㬵±È»ÊÇÔÚÒ»¶¨³¬Ê±Ê±¼äÄÚÒÀ´ÎÇëÇ󣬶¼ÇëÇ󲻳ɹ¦ÁË£¬ÄǾͻáÅ׳öÒì³£¡£ +æ¯�个业务实现最终都归结为Http请求,就是é…�置的serverAddr,多个地å�€ä¼šä¾�次轮转使用,当然是在一定超时时间内ä¾�次请求,都请求ä¸�æˆ�功了,那就会抛出异常。 -ÇëÇó·½ÊÇnacos-client£¬½ÓÊÕ·½×îÖÕ¶¼ÊÇÂäµ½nacos-config·þÎñÉÏ£¬×îºóʹÓÃJdbcTemplate½øÐÐÊý¾Ý³Ö¾Ã»¯¡£ +请求方是nacos-client,接收方最终都是è�½åˆ°nacos-configæœ�务上,最å�Žä½¿ç”¨JdbcTemplate进行数æ�®æŒ�久化。 -ÕâÒ»²¿·ÖµÄ´úÂëÒ»¿´¾ÍÃ÷°×£¬·¢²¼ÅäÖ㬻ñÈ¡ÅäÖúÍɾ³ýÅäÖö¼ÓÐËùÌåÏÖ£¬¾Í²»Õ¹¿ª²ûÊöÁË¡£ +这一部分的代ç �一看就明白,å�‘布é…�置,获å�–é…�置和删除é…�置都有所体现,就ä¸�展开é˜�述了。 -ÖØµã½âÎöÒ»ÏÂÅäÖüàÌý²¿·ÖµÄÔ´´úÂë¡£ +é‡�点解æž�一下é…�置监å�¬éƒ¨åˆ†çš„æº�代ç �。 -ÏȽ«×¢ÒâÁ¦·ÅÔÚcom.alibaba.nacos.client.config.impl.CacheDataÕâ¸öÊý¾Ý½á¹¹ÉÏ£¬ÊǸöµäÐ͵ijäѪģÐÍ£¬Ö÷ÒªÊdz䵱listener¹ÜÀíÕߵĽÇÉ«£¬ÕâÑù¿´À´£¬ÀàÃûÈ¡µÃ²¢²»ÊÇÄÇôÓѺÃÁË¡£ +先将注æ„�力放在com.alibaba.nacos.client.config.impl.CacheData这个数æ�®ç»“构上,是个典型的充血模型,主è¦�是充当listener管ç�†è€…的角色,这样看æ�¥ï¼Œç±»å��å�–å¾—å¹¶ä¸�是那么å�‹å¥½äº†ã€‚ -ʵ¼ÊÉÏ£¬¿ÉÒÔ¿´³öCacheData½«ÅäÖÃÐÅÏ¢£¨namespace, content£©ºÍlistener¾ÛºÏÔÚÒ»ÆðÁË£¬¿ÉÒÔÈÏΪһÏîÅäÖÿÉÒÔ¸½¼Ó¶àÖÖlistenerʵʩ¼àÌý£¨ÒòΪlistener½Ó¿Ú¿ÉÄÜÓжàÖÖʵÏÖ£©£¬Ã¿ÖÖlistenerÖ»»áÓÐÒ»¸öʵÀý¸½¼ÓÔÚÅäÖÃÉÏ¡£ +实际上,å�¯ä»¥çœ‹å‡ºCacheDataå°†é…�置信æ�¯ï¼ˆnamespace, content)和listenerè�šå�ˆåœ¨ä¸€èµ·äº†ï¼Œå�¯ä»¥è®¤ä¸ºä¸€é¡¹é…�ç½®å�¯ä»¥é™„加多ç§�listener实施监å�¬ï¼ˆå› ä¸ºlistener接å�£å�¯èƒ½æœ‰å¤šç§�实现),æ¯�ç§�listenerå�ªä¼šæœ‰ä¸€ä¸ªå®žä¾‹é™„加在é…�置上。 @@ -137,7 +137,7 @@ public void addListener(Listener listener) { -ʹÓÃÁËCopyOnWriteArrayList.addIfAbsent·½·¨£¬Õâ¸ö·½·¨×îÖØÒª¾ÍÊÇequals·½·¨£¬ManagerListenerWrapÊǶÔlistenerµÄÁíÍâÒ»ÖÖÐÎʽµÄ°ü¹ü£¬ÆäʵÏÖÁËequals·½·¨£º +使用了CopyOnWriteArrayList.addIfAbsent方法,这个方法最é‡�è¦�就是equals方法,ManagerListenerWrap是对listenerçš„å�¦å¤–一ç§�å½¢å¼�的包裹,其实现了equals方法: @@ -157,9 +157,9 @@ public boolean equals(Object obj) { -ÔÙÍùÉϲ㷭£¬¿ÉÒÔÕÒµ½¶ÔÓÚlistener¸ü¸ß²ãµÄ¹ÜÀíAPI£ºcom.alibaba.nacos.client.config.impl.ClientWorker¡£ +å†�往上层翻,å�¯ä»¥æ‰¾åˆ°å¯¹äºŽlistener更高层的管ç�†API:com.alibaba.nacos.client.config.impl.ClientWorker。 -ͬÑùÊǶÔlistenerµÄ¹ÜÀí£¬µ«ÊÇÔö¼ÓÁËÖØ¸´Ð£Ñ飬ÆäÖÐcacheMapÊǹؼü£¬Èç϶¨Ò壺 +å�Œæ ·æ˜¯å¯¹listener的管ç�†ï¼Œä½†æ˜¯å¢žåŠ äº†é‡�å¤�校验,其中cacheMap是关键,如下定义: @@ -169,7 +169,7 @@ private final AtomicReference> cacheMap = new AtomicRefer -ʹÓÃÁ˾ßÓÐÔ­×ÓÐÔ²Ù×÷ÌØÐÔµÄAtomicReference£¬¿ÉÒÔ±ÜÃâ²¢·¢´øÀ´µÄÊý¾Ý²»Ò»ÖµÄÎÊÌ⣬ÀïÃæ°ü¹üµÄÊÇÒ»¸öHashMap£¬valueÊÇCacheData¶ÔÏ󣬶økeyÊÇÓÐÒ»¶¨Éú³É¹æÔòµÄ£¬ÔÚGroupKeyÕâ¸öÀàÖпÉÒÔÕÒµ½£º +使用了具有原å­�性æ“�作特性的AtomicReference,å�¯ä»¥é�¿å…�å¹¶å�‘带æ�¥çš„æ•°æ�®ä¸�一致的问题,里é�¢åŒ…裹的是一个HashMap,value是CacheData对象,而key是有一定生æˆ�规则的,在GroupKey这个类中å�¯ä»¥æ‰¾åˆ°ï¼š @@ -189,13 +189,13 @@ static public String getKeyTenant(String dataId, String group, String tenant) { -ʵ¼ÊÉÏÊǽ«ÅäÖÃÐÅÏ¢Óá°+¡±ºÅ½øÐÐÆ´½Ó£¬Èç¹ûÅäÖÃÐÅÏ¢Öб¾Éí´æÔÚÁË¡°+¡±ºÍ¡°%¡±£¬»áʹÓÃurlEncode·½·¨½øÐбàÂëתÒå¡£µ±È»£¬Ò²ÓÐÅäÌ׵ĽâÎö·½·¨£¬ÕâÀï¾Í²»ÔÙÕ¹¿ª½²½âÁË¡£ +实际上是将é…�置信æ�¯ç”¨â€œ+â€�å�·è¿›è¡Œæ‹¼æŽ¥ï¼Œå¦‚æžœé…�置信æ�¯ä¸­æœ¬èº«å­˜åœ¨äº†â€œ+â€�和“%â€�,会使用urlEncode方法进行编ç �转义。当然,也有é…�套的解æž�方法,这里就ä¸�å†�展开讲解了。 -½ÓÏÂÀ´µÄÎ޷ǾÍÊǾÍcacheMapµÄһϵÁÐgetºÍset²Ù×÷£¬ÓÃÒÔά»¤listener¡£Ìرð×¢ÒâµÄÊÇ£¬Ã¿´Î¸üвÙ×÷¶¼ÊÇÏÈÉú³ÉÒ»¸öcopy¶ÔÏ󣬲Ù×÷´Ë¶ÔÏóÖ®ºó£¬ÔÙÕû¸öset£¨¸²¸Ç£©µ½cacheMapÖС£ +接下æ�¥çš„æ— é�žå°±æ˜¯å°±cacheMap的一系列getå’Œsetæ“�作,用以维护listener。特别注æ„�的是,æ¯�次更新æ“�作都是先生æˆ�一个copy对象,æ“�作此对象之å�Žï¼Œå†�整个set(覆盖)到cacheMap中。 -×îºó˵һÏÂlistenerÊÇÈçºÎÔËÐÐÆðÀ´µÄ¡£ +最å�Žè¯´ä¸€ä¸‹listener是如何è¿�行起æ�¥çš„。 -ÈÔÈ»ÊÇÔÚClientWorkerµ±ÖпÉÒÔÕÒµ½£¬½«×¢ÒâÁ¦×ªÒƵ½¹¹Ô캯ÊýÖС£ÆäÖУ¬¿ÉÒÔ×¢Òâµ½£¬³õʼ»¯ÁËÁ½¸öÏ̳߳أº +ä»�然是在ClientWorker当中å�¯ä»¥æ‰¾åˆ°ï¼Œå°†æ³¨æ„�力转移到构造函数中。其中,å�¯ä»¥æ³¨æ„�到,åˆ�始化了两个线程池: @@ -234,23 +234,23 @@ static public String getKeyTenant(String dataId, String group, String tenant) { -Á½¸öÓÃÓÚÖ´Ðж¨Ê±ÈÎÎñµÄscheduledThreadPool£¬¶øÕâÁ½¸öÏ̳߳صķֹ¤Ò²ÊÇǶÌ׵ģºexecutorÓÃÓÚ·¢²¼ÅäÖüì²éµÄÈÎÎñ£¬¶øexecutorServiceÔòÊÇÈÎÎñµÄ½ÓÊÕÕߣ¬ÊÇÕæÕýÖ´ÐÐÈÎÎñµÄ½ÇÉ«¡£ +两个用于执行定时任务的scheduledThreadPool,而这两个线程池的分工也是嵌套的:executor用于å�‘布é…�置检查的任务,而executorService则是任务的接收者,是真正执行任务的角色。 -ËùÒÔ·¢²¼ÈÎÎñµÄÏ̳߳ØÖ»·ÖÅäÁË1¸öºËÐÄÏß³ÌÊý£¬¶øÖ´ÐÐÈÎÎñµÄÏ̳߳صĺËÐÄÏß³ÌÊÇCPUºËÊý¡£ +所以å�‘布任务的线程池å�ªåˆ†é…�了1个核心线程数,而执行任务的线程池的核心线程是CPU核数。 -ÒòΪÅäÖüì²éÊÇÒ»¸ö³¤ÂÖѯµÄ¹ý³Ì£¬Ò»¸öÈÎÎñÖ´ÐÐÕßÄܼà²âµÄÅäÖÃÊýÁ¿ÐèÒªµÃµ½¿ØÖÆ£¬ËùÒÔNACOSĿǰʹÓÃÁËÒ»¸ö±È½Ï¼òµ¥µÄ·ÖÈÎÎñ¹æÔò£º +因为é…�置检查是一个长轮询的过程,一个任务执行者能监测的é…�置数é‡�需è¦�得到控制,所以NACOSç›®å‰�使用了一个比较简å�•的分任务规则: ``` public void checkConfigInfo() { - // ·ÖÈÎÎñ + // 分任务 int listenerSize = cacheMap.get().size(); - // ÏòÉÏÈ¡ÕûΪÅúÊý + // å�‘上å�–整为批数 int longingTaskCount = (int) Math.ceil(listenerSize / ParamUtil.getPerTaskConfigSize()); if (longingTaskCount > currentLongingTaskCount) { for (int i = (int) currentLongingTaskCount; i < longingTaskCount; i++) { - // ÒªÅжÏÈÎÎñÊÇ·ñÔÚÖ´ÐÐ Õâ¿éÐèÒªºÃºÃÏëÏë¡£ ÈÎÎñÁбíÏÖÔÚÊÇÎÞÐòµÄ¡£±ä»¯¹ý³Ì¿ÉÄÜÓÐÎÊÌâ + // è¦�判断任务是å�¦åœ¨æ‰§è¡Œ è¿™å�—需è¦�好好想想。 任务列表现在是无åº�的。å�˜åŒ–过程å�¯èƒ½æœ‰é—®é¢˜ executorService.execute(new LongPollingRunnable(i)); } currentLongingTaskCount = longingTaskCount; @@ -260,24 +260,24 @@ public void checkConfigInfo() { -ÔÚParamUtil.getPerTaskConfigSize()Öзµ»ØµÄÊÇÿ¸öÈÎÎñÄܼà²âµÄÅäÖÃÊýÁ¿ÉÏÏÞ£¬Ä¬ÈÏÊÇ3000Ìõ£¬¿ÉÒÔͨ¹ýϵͳ±äÁ¿PER_TASK_CONFIG_SIZE¸ü¸ÄÕâ¸öÉÏÏÞ¡£ +在ParamUtil.getPerTaskConfigSize()中返回的是æ¯�个任务能监测的é…�置数é‡�上é™�,默认是3000æ�¡ï¼Œå�¯ä»¥é€šè¿‡ç³»ç»Ÿå�˜é‡�PER_TASK_CONFIG_SIZE更改这个上é™�。 -´Ó´úÂëÉÏ¿ÉÒÔ¿´³ö£¬Èç¹ûµ±Ç°listenerµÄÊýÁ¿Ã»Óг¬¹ý3000¸ö£¬ÅäÖüà²âµÄÏ̳߳ػ¹ÔËת²»ÆðÀ´¡£Èç¹ûϸ¿´Õâ¸ö²¿·ÖµÄ´úÂ룬»¹ÊǻᷢÏÖһЩÎÊÌâµÄ£¬Ö÷ÒªÊÇÎ§ÈÆ×ÅÈÎÎñ¹ÜÀíÑÜÉú³öÀ´µÄһϵÁÐÎÊÌâ¡£ +从代ç �上å�¯ä»¥çœ‹å‡ºï¼Œå¦‚果当å‰�listener的数é‡�没有超过3000个,é…�置监测的线程池还è¿�转ä¸�èµ·æ�¥ã€‚如果细看这个部分的代ç �,还是会å�‘现一些问题的,主è¦�是围绕ç�€ä»»åŠ¡ç®¡ç�†è¡�生出æ�¥çš„一系列问题。 -³¤ÂÖѯÀïÃæÖ÷ÒªÓÐÁ½²¿·ÖÂß¼­£º +长轮询里é�¢ä¸»è¦�有两部分逻辑: -* ¼ì²é±¾µØÅäÖã¬ÓëCacheData´æ´¢µÄÐÅÏ¢±£³ÖÒ»Ö£» -* ¼ì²éserver¶ËÅäÖ㬸üÐÂCacheData´æ´¢µÄÐÅÏ¢¡£ +* 检查本地é…�置,与CacheData存储的信æ�¯ä¿�æŒ�一致; +* 检查server端é…�置,更新CacheData存储的信æ�¯ã€‚ -## Èý¡¢·þÎñ×¢²áÓë·¢ÏÖ +## 三ã€�æœ�务注册与å�‘现 -ÓÐÁËÉÏÊöµÄ»ù´¡£¬Õⲿ·Ö´úÂë¿´ÆðÀ´»á±È½ÏÇáËÉÁË£¬½á¹¹ÉÏ»ù±¾ÏàËÆ¡£ +有了上述的基础,这部分代ç �看起æ�¥ä¼šæ¯”较轻æ�¾äº†ï¼Œç»“构上基本相似。 -Ö±½Ó½øÈëcom.alibaba.nacos.api.naming.NamingService£¬ÀïÃæÓжà¸öregisterInstanceÖØ¹¹·½·¨£¬ÓÃÓÚ·þÎñ×¢²á¡£ +直接进入com.alibaba.nacos.api.naming.NamingService,里é�¢æœ‰å¤šä¸ªregisterInstanceé‡�构方法,用于æœ�务注册。 -ÏÈ¿´¿´InstanceʵÌåÀà°üº¬µÄÄÚÈÝ£ºid£¬ip£¬port£¬serviceName£¬clusterName£¨ËùÔÚ¼¯Èº£©£¬weight£¨È¨ÖØ£©£¬healthy£¨ÊÇ·ñÕý³££©£¬enabled£¨ÊÇ·ñÆôÓã©£¬ephemeral£¨ÊÇ·ñÊÇÁÙʱµÄ£©£¬Õâ9¸öÊôÐÔÈ«²¿¶¼¿ÉÒÔÔÚConsoleÖÐÓÐËùÌåÏÖ¡£ +先看看Instance实体类包å�«çš„内容:id,ip,port,serviceName,clusterName(所在集群),weight(æ�ƒé‡�),healthy(是å�¦æ­£å¸¸ï¼‰ï¼Œenabled(是å�¦å�¯ç”¨ï¼‰ï¼Œephemeral(是å�¦æ˜¯ä¸´æ—¶çš„),这9个属性全部都å�¯ä»¥åœ¨Console中有所体现。 -È»ºó£¬Ö±½Ó¿´×¢²á·þÎñµÄ·½·¨£º +ç„¶å�Žï¼Œç›´æŽ¥çœ‹æ³¨å†Œæœ�务的方法: @@ -302,11 +302,11 @@ public void checkConfigInfo() { -Ç°ÃæÒ»´ó¶Î´úÂëÊǶÔÁÙʱ·þÎñʵÀýµÄ´¦Àí£¬¾ÍÊÇÔÚ¹¹ÔìÒ»¸öÐÄÌø°ü·¢Ë͸øNACOS·þÎñ¡£ +å‰�é�¢ä¸€å¤§æ®µä»£ç �是对临时æœ�务实例的处ç�†ï¼Œå°±æ˜¯åœ¨æž„造一个心跳包å�‘é€�ç»™NACOSæœ�务。 -registerService·½·¨¾ÍÊÇ·â×°ÁËHTTPÇëÇó£¬×îÖÕÔÚInstanceControllerÖд¦ÀíÇëÇó¡£ +registerService方法就是å°�装了HTTP请求,最终在InstanceController中处ç�†è¯·æ±‚。 -Èç¹ûÏîÄ¿¼¯³ÉÁËspring-cloud-starter-alibaba-nacos-discovery£¬·þÎñÆô¶¯ºóĬÈÏÊÇ×Ô¶¯×¢²áµÄ¡£Èç¹ûÏë¿´×Ô¶¯×¢²áµÄ¹ý³Ì£¬¿ÉÒÔ´ÓAbstractAutoServiceRegistration¿ªÊ¼×ÅÊÖ£¬µ±ÖÐÓÐÒ»¶Î´úÂ룺 +如果项目集æˆ�了spring-cloud-starter-alibaba-nacos-discovery,æœ�务å�¯åЍå�Žé»˜è®¤æ˜¯è‡ªåŠ¨æ³¨å†Œçš„ã€‚å¦‚æžœæƒ³çœ‹è‡ªåŠ¨æ³¨å†Œçš„è¿‡ç¨‹ï¼Œå�¯ä»¥ä»ŽAbstractAutoServiceRegistration开始ç�€æ‰‹ï¼Œå½“中有一段代ç �: @@ -327,7 +327,7 @@ registerService -¼àÌýÁËWeb·þÎñ³õʼ»¯Íê³ÉµÄʼþ£¬×îÖÕ»áÖ´ÐÐstart·½·¨£º +监å�¬äº†Webæœ�务åˆ�始化完æˆ�的事件,最终会执行start方法: @@ -355,7 +355,7 @@ registerService -ÆäÖУ¬register·½·¨¾ÍÊÇ×îºËÐĵIJ¿·ÖÁË£¬À´Ô´ÓÚNacosServiceRegistryµÄʵÏÖ£º +其中,register方法就是最核心的部分了,æ�¥æº�于NacosServiceRegistry的实现: @@ -391,7 +391,7 @@ registerService -Õâ¶Î´úÂë¾Í·Ç³£ÊìϤÁË£¬×îÖվͻص½ÁËÉÏÊöµÄnamingService.registerInstance·½·¨¡£ +这段代ç �å°±é�žå¸¸ç†Ÿæ‚‰äº†ï¼Œæœ€ç»ˆå°±å›žåˆ°äº†ä¸Šè¿°çš„namingService.registerInstance方法。 @@ -404,24 +404,24 @@ registerService -ÒÔÉϳöÏÖÁËÁíÍâÒ»¸öʵÌåÀࣺcom.alibaba.nacos.naming.core.Service£¬ServiceÊǰüº¬ÁËInstance£¬Ò»¸öServiceÏÂÓжà¸öInstance£¬¼´¿É×é³ÉÒ»¸öCluster¡£ +以上出现了å�¦å¤–一个实体类:com.alibaba.nacos.naming.core.Service,Service是包å�«äº†Instance,一个Service下有多个Instance,å�³å�¯ç»„æˆ�一个Cluster。
![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-21ca2c51d56d6401dee0db0444df8ddf_720w.webp) -
¶àʵÀý¼¯Èº
+
多实例集群
-ÔÚµ÷ÓÃregisterInstance×¢²áʵÀýµÄʱºò£¬Èç¹û·¢ÏÖ¶ÔÓ¦µÄServiceûÓб»×¢²á£¬ÄÇô»áregisterService£¬²¢ÇÒ»á³õʼ»¯¶ÔÓ¦µÄCluster£¬Æô¶¯½¡¿µ¼ì²éµÄ¶¨Ê±Æ÷¡£ +在调用registerInstance注册实例的时候,如果å�‘现对应的Service没有被注册,那么会registerService,并且会åˆ�始化对应的Cluster,å�¯åЍå�¥åº·æ£€æŸ¥çš„定时器。 -ºÍregisterInstanceÏà·´µÄÊÇderegisterInstance£¬¼´ÎªÈ¡Ïû×¢²á£¬Ò²¿ÉÒÔÈÏΪÊÇ·þÎñʵÀýÏÂÏß¡£ +å’ŒregisterInstance相å��的是deregisterInstance,å�³ä¸ºå�–消注册,也å�¯ä»¥è®¤ä¸ºæ˜¯æœ�务实例下线。 -×îºóÀ´¿´¿´NACOSÈçºÎʵÏÖ·þÎñ·¢ÏÖ¹¦ÄÜ¡£ +最å�Žæ�¥çœ‹çœ‹NACOS如何实现æœ�务å�‘现功能。 -´ÓÏû·ÑÕߣ¨µ÷Ó÷½£©µÄ½Ç¶ÈÀ´¿´£¬¼¯³ÉµÄstarterÏîÄ¿ÖÐÓиöÀࣺNacosServerList£¬×îÖØÒªµÄÊǼ̳ÐÁËAbstractServerList£¬ÊµÏÖÁËÁ½¸ö¹Ø¼üµÄ½Ó¿Ú·½·¨£¬Ï൱ÓÚÊÇNACOSÓëRibbonµÄ¶Ô½Óµã¡£ +从消费者(调用方)的角度æ�¥çœ‹ï¼Œé›†æˆ�çš„starter项目中有个类:NacosServerList,最é‡�è¦�的是继承了AbstractServerList,实现了两个关键的接å�£æ–¹æ³•,相当于是NACOS与Ribbon的对接点。 @@ -442,9 +442,9 @@ public interface ServerList { -NACOS¶ÔÓÚÕâ¸öÁ½¸ö½Ó¿ÚµÄʵÏÖ£¬¶¼Ê¹ÓÃÁËgetServers·½·¨£¬¶ø½øÈëµ½getServers·½·¨ÌåÀïÃæ£¬Æäʵ¾ÍÊÇÀûÓÃÁËÉÏÊöËù˵µÄNacosNamingService.selectInstances·½·¨£¬Í¨¹ýserviceId»ñÈ¡µ½ServiceInfo¶ÔÏó£¬È»ºó»ñÈ¡µ½ServiceÏÂÃæµÄËùÓÐÓÐЧµÄInstance¡£ +NACOS对于这个两个接å�£çš„实现,都使用了getServers方法,而进入到getServers方法体里é�¢ï¼Œå…¶å®žå°±æ˜¯åˆ©ç”¨äº†ä¸Šè¿°æ‰€è¯´çš„NacosNamingService.selectInstances方法,通过serviceId获å�–到ServiceInfo对象,然å�ŽèŽ·å�–到Service下é�¢çš„æ‰€æœ‰æœ‰æ•ˆçš„Instance。 -´ÓÌṩÕߣ¨±»µ÷Ó÷½£©µÄ½Ç¶È¿´£¬NACOSÊÇͨ¹ý¶¨Ê±Æ÷À´ÊµÊ±¸üÐÂServiceInfo£¬Ö÷ÒªÒµÎñÂß¼­ÊÇÔÚHostReactorÖÐʵÏֵġ£ÓëǰÊöµÄserviceMap²»Ò»Ñù£¬HostReactorÖÐά»¤µÄÊÇserviceInfoMap¡£ +从æ��供者(被调用方)的角度看,NACOS是通过定时器æ�¥å®žæ—¶æ›´æ–°ServiceInfo,主è¦�业务逻辑是在HostReactor中实现的。与å‰�è¿°çš„serviceMapä¸�一样,HostReactor中维护的是serviceInfoMap。 @@ -454,7 +454,7 @@ private Map serviceInfoMap; -HostReactor½èÖúÁËFailoverReactor¶ÔServiceInfo×öÁË´ÅÅÌ»º´æ£¬ÈÔÈ»ÊÇÆô¶¯Á˶¨Ê±ÈÎÎñ£¬ÔÚÖ¸¶¨µÄĿ¼ÏÂÐòÁл¯ServiceInfo£¬ÒÔ´ËʵÏÖÁËFailover»úÖÆ¡£¶øÆô¶¯failover-modeÒ²ÊÇÓпª¹ØµÄ£¬Æäʵ¾ÍÊÇÒ»¸öÌØ¶¨ÎļþµÄÒ»²¿·ÖÄÚÈÝ£¬ÕâЩÅäÖõļà²âÒ²ÊÇͨ¹ý¶¨Ê±ÈÎÎñÀ´ÊµÏֵġ£ +HostReactor借助了FailoverReactor对ServiceInfoå�šäº†ç£�盘缓存,ä»�然是å�¯åŠ¨äº†å®šæ—¶ä»»åŠ¡ï¼Œåœ¨æŒ‡å®šçš„ç›®å½•ä¸‹åº�列化ServiceInfo,以此实现了Failover机制。而å�¯åЍfailover-mode也是有开关的,其实就是一个特定文件的一部分内容,这些é…�置的监测也是通过定时任务æ�¥å®žçŽ°çš„ã€‚ @@ -464,35 +464,35 @@ File switchFile = new File(failoverDir + UtilAndComs.FAILOVER_SWITCH); -Õû¸ö¹ý³ÌÈçÏÂͼËùʾ£º +整个过程如下图所示:
![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-d16112ec6ff6dda0b029b019c313177c_720w.webp) -
·þÎñ·¢ÏÖ¸ú×Ùͼ
+
�务�现跟踪图
-## ËÄ¡¢¹ÜÀí¿ØÖÆÌ¨(Console) +## å››ã€�管ç�†æŽ§åˆ¶å�°(Console) -ÕâÒ»²¿·ÖÊǹÜÀí¿ØÖÆÌ¨µÄʵÏÖ£¬ÆäʵÊÇÒ»¸ö·Ç³£µäÐ͵ÄWEBÏîÄ¿¡£ +这一部分是管ç�†æŽ§åˆ¶å�°çš„实现,其实是一个é�žå¸¸å…¸åž‹çš„WEB项目。 -ʹÓÃÁËSpring Security + JWT½øÐа²È«¿ØÖÆ£¬Ç°¶Ë¼¼ÊõÊÇReactJs£¬ÀûÓÃJdbcTemplate½øÐÐÊý¾Ý¿â³Ö¾Ã»¯¡£ +使用了Spring Security + JWT进行安全控制,å‰�端技术是ReactJs,利用JdbcTemplate进行数æ�®åº“æŒ�久化。 -ÐèҪעÒâµÄÊÇ£¬¿ØÖÆÌ¨ÌṩµÄ¹¦Äܲ¢²»¶¼ÊÇ´Ónacos-consoleÕâ¸ö·þÎñÖлñÈ¡µÄÊý¾Ý£¬¶øÊÇ·ÖÉ¢ÔÚÁ˸÷¸ö·þÎñÖС£ +需è¦�注æ„�的是,控制å�°æ��供的功能并ä¸�都是从nacos-console这个æœ�务中获å�–的数æ�®ï¼Œè€Œæ˜¯åˆ†æ•£åœ¨äº†å�„个æœ�务中。 -nacos-consoleÌṩÁË¿ØÖÆÌ¨µÇ¼£¬namespace¹ÜÀí£¬¿ØÖÆÌ¨·þÎñ״̬ÕâÈý²¿·ÖÄÜÁ¦£¬¶øÅäÖùÜÀíºÍ·þÎñ¹ÜÀí·Ö±ðÇëÇóµÄÊÇnacos-configºÍnacos-namingËùÌṩµÄAPI£¬¶øÕâЩAPI¾ÍÊǹÙÍøËùÌáµ½µÄOpen-API¡£ +nacos-consoleæ��供了控制å�°ç™»å½•,namespace管ç�†ï¼ŒæŽ§åˆ¶å�°æœ�务状æ€�这三部分能力,而é…�置管ç�†å’Œæœ�务管ç�†åˆ†åˆ«è¯·æ±‚的是nacos-configå’Œnacos-naming所æ��供的API,而这些API就是官网所æ��到的Open-API。 -## Îå¡¢×ܽá +## 五ã€�总结 -NACOSÏà¹ØÔ´ÂëͨË×Ò×¶®£¬Ã»ÓÐʲô¸ßÉîµÄÀíÄҲûÓнøÐвã²ã·â×°ºÍ°ü¹ü£¬ÓÐÒ»¶¨±à³Ì¾­ÑéµÄ³ÌÐòÔ±ÄÜÔÚ°ëСʱ֮ÄÚ°ÑÎÕÕû¸öÏîÄ¿µÄÂöÂç¡£ +NACOS相关æº�ç �通俗易懂,没有什么高深的ç�†å¿µï¼Œä¹Ÿæ²¡æœ‰è¿›è¡Œå±‚层å°�装和包裹,有一定编程ç»�验的程åº�员能在å�Šå°�时之内把æ�¡æ•´ä¸ªé¡¹ç›®çš„脉络。 -µ±È»£¬Ò²»á´æÔÚһЩ²»¿ÉºöÊÓµÄȱµã£¬±ÈÈ磬עÊ͹ýÉÙ£¬´úÂ뻹ÓкܴóµÄÖØ¹¹¿Õ¼ä£¬tenantºÍnamespaceÁ½¸ö¸ÅÄî»ìÏýʹÓᣠ+当然,也会存在一些ä¸�å�¯å¿½è§†çš„缺点,比如,注释过少,代ç �还有很大的é‡�构空间,tenantå’Œnamespace两个概念混淆使用。 -¹ØÓÚSpring Cloud Alibaba NacosµÄ½éÉܵ½´Ë¾Í½áÊøÁË£¬Ï£Íû¶ÔÄãÓÐËù°ïÖú¡£ -# ²Î¿¼ÎÄÕ +关于Spring Cloud Alibaba Nacos的介ç»�到此就结æ�Ÿäº†ï¼Œå¸Œæœ›å¯¹ä½ æœ‰æ‰€å¸®åŠ©ã€‚ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\351\205\215\347\275\256\344\270\255\345\277\203.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\351\205\215\347\275\256\344\270\255\345\277\203.md" index 7515d8b..1149f5f 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\351\205\215\347\275\256\344\270\255\345\277\203.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudAlibabaNacos\346\272\220\347\240\201\345\210\206\346\236\220\357\274\232\351\205\215\347\275\256\344\270\255\345\277\203.md" @@ -1,18 +1,18 @@ -# NacosÅäÖÃÖÐÐÄ +# Nacosé…�置中心 -## NacosÅäÖÃÖÐÐĵÄʹÓà +## Nacosé…�置中心的使用 -²Î¿¼¹Ù·½£º[github.com/alibaba/spr¡­](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fspring-cloud-alibaba%2Fwiki%2FNacos-config "https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config") +å�‚考官方:[github.com/alibaba/spr…](https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fspring-cloud-alibaba%2Fwiki%2FNacos-config "https://github.com/alibaba/spring-cloud-alibaba/wiki/Nacos-config") -## ConfigÏà¹ØÅäÖà +## Config相关é…�ç½® - Nacos Êý¾ÝÄ£ÐÍ Key ÓÉÈýÔª×éΨһȷ¶¨, NamespaceĬÈÏÊǿմ®£¬¹«¹²ÃüÃû¿Õ¼ä£¨public£©£¬·Ö×éĬÈÏÊÇ DEFAULT_GROUP + Nacos æ•°æ�®æ¨¡åž‹ Key 由三元组唯一确定, Namespace默认是空串,公共命å��空间(public),分组默认是 DEFAULT_GROUP ![image-20230429084711954](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084711954.png) -* **Ö§³ÖÅäÖõĶ¯Ì¬¸üÐÂ** +* **支æŒ�é…�置的动æ€�æ›´æ–°** - µ±¶¯Ì¬ÅäÖÃË¢ÐÂʱ£¬»á¸üе½ EnviromentÖУ¬Òò´ËÕâÀïÿ¸ôÒ»ÃëÖдÓEnviromentÖлñÈ¡ÅäÖà + 当动æ€�é…�置刷新时,会更新到 Enviroment中,因此这里æ¯�隔一秒中从Enviroment中获å�–é…�ç½® ``` @SpringBootApplication @@ -22,7 +22,7 @@ public class NacosConfigApplication { ConfigurableApplicationContext applicationContext = SpringApplication.run(NacosConfigApplication.class, args); while(true) { - //µ±¶¯Ì¬ÅäÖÃË¢ÐÂʱ£¬»á¸üе½ EnviromentÖУ¬Òò´ËÕâÀïÿ¸ôÒ»ÃëÖдÓEnviromentÖлñÈ¡ÅäÖà + //当动æ€�é…�置刷新时,会更新到 Enviroment中,因此这里æ¯�隔一秒中从Enviroment中获å�–é…�ç½® String userName = applicationContext.getEnvironment().getProperty("common.name"); String userAge = applicationContext.getEnvironment().getProperty("common.age"); System.err.println("common name :" + userName + "; age: " + userAge); @@ -30,91 +30,91 @@ public class NacosConfigApplication { } } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* **Ö§³ÖprofileÁ£¶ÈµÄÅäÖÃ** +* **支æŒ�profile粒度的é…�ç½®** - spring-cloud-starter-alibaba-nacos-config ÔÚ¼ÓÔØÅäÖõÄʱºò£¬²»½ö½ö¼ÓÔØÁËÒÔ dataid Ϊ spring.application.name.{spring.application.name}.spring.application.name.{file-extension:properties} Ϊǰ׺µÄ»ù´¡ÅäÖ㬻¹¼ÓÔØÁËdataidΪ spring.application.name?{spring.application.name}-spring.application.name?{profile}.file?extension:propertiesµÄ»ù´¡ÅäÖᣠ+ spring-cloud-starter-alibaba-nacos-config 在加载é…�置的时候,ä¸�仅仅加载了以 dataid 为 spring.application.name.{spring.application.name}.spring.application.name.{file-extension:properties} 为å‰�缀的基础é…�置,还加载了dataid为 spring.application.name?{spring.application.name}-spring.application.name?{profile}.file?extension:properties的基础é…�置。 - ÔÚÈÕ³£¿ª·¢ÖÐÈç¹ûÓöµ½¶àÌ×»·¾³ÏµIJ»Í¬ÅäÖ㬿ÉÒÔͨ¹ýSpringÌṩµÄ{file-extension:properties} µÄ»ù´¡ÅäÖá£ÔÚÈÕ³£¿ª·¢ÖÐÈç¹ûÓöµ½¶àÌ×»·¾³ÏµIJ»Í¬ÅäÖ㬿ÉÒÔͨ¹ýSpring ÌṩµÄ file?extension:propertiesµÄ»ù´¡ÅäÖá£ÔÚÈÕ³£¿ª·¢ÖÐÈç¹ûÓöµ½¶àÌ×»·¾³ÏµIJ»Í¬ÅäÖ㬿ÉÒÔͨ¹ýSpringÌṩµÄ{spring.profiles.active} Õâ¸öÅäÖÃÏîÀ´ÅäÖᣠ+ 在日常开å�‘中如果é�‡åˆ°å¤šå¥—环境下的ä¸�å�Œé…�置,å�¯ä»¥é€šè¿‡Springæ��供的{file-extension:properties} 的基础é…�置。在日常开å�‘中如果é�‡åˆ°å¤šå¥—环境下的ä¸�å�Œé…�置,å�¯ä»¥é€šè¿‡Spring æ��供的 file?extension:properties的基础é…�置。在日常开å�‘中如果é�‡åˆ°å¤šå¥—环境下的ä¸�å�Œé…�置,å�¯ä»¥é€šè¿‡Springæ��供的{spring.profiles.active} 这个é…�置项æ�¥é…�置。 ``` spring.profiles.active=dev -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* **Ö§³Ö×Ô¶¨Òå namespace µÄÅäÖÃ** +* **支æŒ�自定义 namespace çš„é…�ç½®** - ÓÃÓÚ½øÐÐ×â»§Á£¶ÈµÄÅäÖøôÀë¡£²»Í¬µÄÃüÃû¿Õ¼äÏ£¬¿ÉÒÔ´æÔÚÏàͬµÄ Group »ò Data ID µÄÅäÖá£Namespace µÄ³£Óó¡¾°Ö®Ò»ÊDz»Í¬»·¾³µÄÅäÖõÄÇø·Ö¸ôÀ룬ÀýÈ翪·¢²âÊÔ»·¾³ºÍÉú²ú»·¾³µÄ×Ê£¨ÈçÅäÖᢷþÎñ£©¸ôÀëµÈ¡£ + 用于进行租户粒度的é…�置隔离。ä¸�å�Œçš„命å��空间下,å�¯ä»¥å­˜åœ¨ç›¸å�Œçš„ Group 或 Data ID çš„é…�置。Namespace 的常用场景之一是ä¸�å�ŒçŽ¯å¢ƒçš„é…�置的区分隔离,例如开å�‘测试环境和生产环境的资(如é…�ç½®ã€�æœ�务)隔离等。 - ÔÚûÓÐÃ÷È·Ö¸¶¨ ${spring.cloud.nacos.config.namespace} ÅäÖõÄÇé¿öÏ£¬ ĬÈÏʹÓõÄÊÇ Nacos ÉÏ Public Õâ¸önamespace¡£Èç¹ûÐèҪʹÓÃ×Ô¶¨ÒåµÄÃüÃû¿Õ¼ä£¬¿ÉÒÔͨ¹ýÒÔÏÂÅäÖÃÀ´ÊµÏÖ£º + 在没有明确指定 ${spring.cloud.nacos.config.namespace} é…�置的情况下, 默认使用的是 Nacos 上 Public 这个namespace。如果需è¦�使用自定义的命å��空间,å�¯ä»¥é€šè¿‡ä»¥ä¸‹é…�ç½®æ�¥å®žçŽ°ï¼š ``` spring.cloud.nacos.config.namespace=71bb9785-231f-4eca-b4dc-6be446e12ff8 -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* **Ö§³Ö×Ô¶¨Òå Group µÄÅäÖÃ** +* **支æŒ�自定义 Group çš„é…�ç½®** - GroupÊÇ×éÖ¯ÅäÖõÄά¶ÈÖ®Ò»¡£Í¨¹ýÒ»¸öÓÐÒâÒåµÄ×Ö·û´®£¨Èç Buy »ò Trade £©¶ÔÅäÖü¯½øÐзÖ×飬´Ó¶øÇø·Ö Data ID ÏàͬµÄÅäÖü¯¡£µ±ÄúÔÚ Nacos ÉÏ´´½¨Ò»¸öÅäÖÃʱ£¬Èç¹ûδÌîдÅäÖ÷Ö×éµÄÃû³Æ£¬ÔòÅäÖ÷Ö×éµÄÃû³ÆÄ¬ÈϲÉÓà DEFAULT_GROUP ¡£ÅäÖ÷Ö×éµÄ³£¼û³¡¾°£º²»Í¬µÄÓ¦Óûò×é¼þʹÓÃÁËÏàͬµÄÅäÖÃÀàÐÍ£¬Èç database_url ÅäÖÃºÍ MQ_topic ÅäÖᣠ+ Group是组织é…�置的维度之一。通过一个有æ„�义的字符串(如 Buy 或 Trade )对é…�置集进行分组,从而区分 Data ID 相å�Œçš„é…�置集。当您在 Nacos 上创建一个é…�置时,如果未填写é…�置分组的å��称,则é…�置分组的å��称默认采用 DEFAULT_GROUP 。é…�置分组的常è§�场景:ä¸�å�Œçš„应用或组件使用了相å�Œçš„é…�置类型,如 database_url é…�置和 MQ_topic é…�置。 -ÔÚûÓÐÃ÷È·Ö¸¶¨ ${spring.cloud.nacos.config.group} ÅäÖõÄÇé¿öÏ£¬Ä¬ÈÏÊÇDEFAULT_GROUP ¡£Èç¹ûÐèÒª×Ô¶¨Òå×Ô¼ºµÄ Group£¬¿ÉÒÔͨ¹ýÒÔÏÂÅäÖÃÀ´ÊµÏÖ£º +在没有明确指定 ${spring.cloud.nacos.config.group} é…�置的情况下,默认是DEFAULT_GROUP 。如果需è¦�自定义自己的 Group,å�¯ä»¥é€šè¿‡ä»¥ä¸‹é…�ç½®æ�¥å®žçŽ°ï¼š ``` spring.cloud.nacos.config.group=DEVELOP_GROUP -¸´ÖÆ´úÂë +å¤�制代ç � ``` -* **Ö§³Ö×Ô¶¨ÒåÀ©Õ¹µÄ Data Id ÅäÖÃ** +* **支æŒ�自定义扩展的 Data Id é…�ç½®** - Data ID ÊÇ×éÖ¯»®·ÖÅäÖõÄά¶ÈÖ®Ò»¡£Data ID ͨ³£ÓÃÓÚ×éÖ¯»®·ÖϵͳµÄÅäÖü¯¡£Ò»¸öϵͳ»òÕßÓ¦ÓÿÉÒÔ°üº¬¶à¸öÅäÖü¯£¬Ã¿¸öÅäÖü¯¶¼¿ÉÒÔ±»Ò»¸öÓÐÒâÒåµÄÃû³Æ±êʶ¡£Data ID ͨ³£²ÉÓÃÀà Java °ü£¨Èç com.taobao.tc.refund.log.level£©µÄÃüÃû¹æÔò±£Ö¤È«¾ÖΨһÐÔ¡£´ËÃüÃû¹æÔò·ÇÇ¿ÖÆ¡£ + Data ID 是组织划分é…�置的维度之一。Data ID 通常用于组织划分系统的é…�置集。一个系统或者应用å�¯ä»¥åŒ…å�«å¤šä¸ªé…�置集,æ¯�个é…�置集都å�¯ä»¥è¢«ä¸€ä¸ªæœ‰æ„�义的å��称标识。Data ID 通常采用类 Java 包(如 com.taobao.tc.refund.log.level)的命å��规则ä¿�è¯�全局唯一性。此命å��规则é�žå¼ºåˆ¶ã€‚ -ͨ¹ý×Ô¶¨ÒåÀ©Õ¹µÄ Data Id ÅäÖ㬼ȿÉÒÔ½â¾ö¶à¸öÓ¦ÓüäÅäÖù²ÏíµÄÎÊÌ⣬ÓÖ¿ÉÒÔÖ§³ÖÒ»¸öÓ¦ÓÃÓжà¸öÅäÖÃÎļþ¡£ +通过自定义扩展的 Data Id é…�置,既å�¯ä»¥è§£å†³å¤šä¸ªåº”用间é…�置共享的问题,å�ˆå�¯ä»¥æ”¯æŒ�一个应用有多个é…�置文件。 ``` -# ×Ô¶¨Òå Data Id µÄÅäÖà -#²»Í¬¹¤³ÌµÄͨÓÃÅäÖà ֧³Ö¹²ÏíµÄ DataId +# 自定义 Data Id çš„é…�ç½® +#ä¸�å�Œå·¥ç¨‹çš„通用é…�ç½® 支æŒ�共享的 DataId spring.cloud.nacos.config.sharedConfigs[0].data-id= common.yaml spring.cloud.nacos.config.sharedConfigs[0].group=REFRESH_GROUP spring.cloud.nacos.config.sharedConfigs[0].refresh=true # config external configuration -# Ö§³ÖÒ»¸öÓ¦Óöà¸ö DataId µÄÅäÖà +# 支æŒ�一个应用多个 DataId çš„é…�ç½® spring.cloud.nacos.config.extensionConfigs[0].data-id=ext-config-common01.properties spring.cloud.nacos.config.extensionConfigs[0].group=REFRESH_GROUP spring.cloud.nacos.config.extensionConfigs[0].refresh=true spring.cloud.nacos.config.extensionConfigs[1].data-id=ext-config-common02.properties spring.cloud.nacos.config.extensionConfigs[1].group=REFRESH_GROUP -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## ÅäÖõÄÓÅÏȼ¶ +## é…�置的优先级 -Spring Cloud Alibaba Nacos Config ĿǰÌṩÁËÈýÖÖÅäÖÃÄÜÁ¦´Ó Nacos À­È¡Ïà¹ØµÄÅäÖᣠ+Spring Cloud Alibaba Nacos Config ç›®å‰�æ��供了三ç§�é…�置能力从 Nacos 拉å�–相关的é…�置。 -* A: ͨ¹ý spring.cloud.nacos.config.shared-configs Ö§³Ö¶à¸ö¹²Ïí Data Id µÄÅäÖà +* A: 通过 spring.cloud.nacos.config.shared-configs 支æŒ�多个共享 Data Id çš„é…�ç½® -* B: ͨ¹ý spring.cloud.nacos.config.ext-config[n].data-id µÄ·½Ê½Ö§³Ö¶à¸öÀ©Õ¹ Data Id µÄÅäÖà +* B: 通过 spring.cloud.nacos.config.ext-config[n].data-id 的方å¼�支æŒ�多个扩展 Data Id çš„é…�ç½® -* C: ͨ¹ýÄÚ²¿Ïà¹Ø¹æÔò(Ó¦ÓÃÃû¡¢Ó¦ÓÃÃû+ Profile )×Ô¶¯Éú³ÉÏà¹ØµÄ Data Id ÅäÖà +* C: 通过内部相关规则(应用å��ã€�应用å��+ Profile )自动生æˆ�相关的 Data Id é…�ç½® -µ±ÈýÖÖ·½Ê½¹²Í¬Ê¹ÓÃʱ£¬ËûÃǵÄÒ»¸öÓÅÏȼ¶¹ØÏµÊÇ:A < B < C +当三ç§�æ–¹å¼�å…±å�Œä½¿ç”¨æ—¶ï¼Œä»–们的一个优先级关系是:A < B < C -ÓÅÏȼ¶´Ó¸ßµ½µÍ£º +优先级从高到低: -1. nacos-config-product.yaml ¾«×¼ÅäÖà +1. nacos-config-product.yaml 精准é…�ç½® -2. nacos-config.yaml ͬ¹¤³Ì²»Í¬»·¾³µÄͨÓÃÅäÖà +2. nacos-config.yaml å�Œå·¥ç¨‹ä¸�å�ŒçŽ¯å¢ƒçš„é€šç”¨é…�ç½® -3. ext-config: ²»Í¬¹¤³Ì À©Õ¹ÅäÖà +3. ext-config: ä¸�å�Œå·¥ç¨‹ 扩展é…�ç½® -4. shared-dataids ²»Í¬¹¤³ÌͨÓÃÅäÖà +4. shared-dataids ä¸�å�Œå·¥ç¨‹é€šç”¨é…�ç½® ## @RefreshScope -@Value×¢½â¿ÉÒÔ»ñÈ¡µ½ÅäÖÃÖÐÐĵÄÖµ£¬µ«ÊÇÎÞ·¨¶¯Ì¬¸ÐÖªÐ޸ĺóµÄÖµ£¬ÐèÒªÀûÓÃ@RefreshScope×¢½â +@Value注解å�¯ä»¥èŽ·å�–到é…�置中心的值,但是无法动æ€�感知修改å�Žçš„值,需è¦�利用@RefreshScope注解 ``` @RestController @@ -129,20 +129,20 @@ public class TestController { return age; } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## NacosÅäÖÃÖÐÐÄÔ´Âë·ÖÎö +## Nacosé…�置中心æº�ç �分æž� -**ÏêϸԴÂëÁ÷³Ìͼ£º** +**详细æº�ç �æµ�程图:** -[www.processon.com/view/link/6¡­](https://link.juejin.cn?target=https%3A%2F%2Fwww.processon.com%2Fview%2Flink%2F60f78ddbf346fb761bbac19d "https://www.processon.com/view/link/60f78ddbf346fb761bbac19d") +[www.processon.com/view/link/6…](https://link.juejin.cn?target=https%3A%2F%2Fwww.processon.com%2Fview%2Flink%2F60f78ddbf346fb761bbac19d "https://www.processon.com/view/link/60f78ddbf346fb761bbac19d") -### ÅäÖÃÖÐÐļܹ¹ +### é…�置中心架构 ![image-20230429084840636](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084840636.png) -ÅäÖÃÖÐÐÄʹÓÃdemo +é…�置中心使用demo ``` public class ConfigServerDemo { @@ -153,12 +153,12 @@ public class ConfigServerDemo { String group = "DEFAULT_GROUP"; Properties properties = new Properties(); properties.put(PropertyKeyConst.SERVER_ADDR, serverAddr); - //»ñÈ¡ÅäÖ÷þÎñ + //获å�–é…�ç½®æœ�务 ConfigService configService = NacosFactory.createConfigService(properties); - //»ñÈ¡ÅäÖà + //获å�–é…�ç½® String content = configService.getConfig(dataId, group, 5000); System.out.println(content); - //×¢²á¼àÌýÆ÷ + //注册监å�¬å™¨ configService.addListener(dataId, group, new Listener() { @Override public void receiveConfigInfo(String configInfo) { @@ -171,10 +171,10 @@ public class ConfigServerDemo { } }); - //·¢²¼ÅäÖà + //å�‘布é…�ç½® //boolean isPublishOk = configService.publishConfig(dataId, group, "content"); //System.out.println(isPublishOk); - //·¢ËÍproperties¸ñʽ + //å�‘é€�propertiesæ ¼å¼� configService.publishConfig(dataId,group,"common.age=30", ConfigType.PROPERTIES.getType()); Thread.sleep(3000); @@ -190,58 +190,58 @@ public class ConfigServerDemo { // Thread.sleep(300000); } } -¸´ÖÆ´úÂë +å¤�制代ç � ``` -## nacos config clientÔ´Âë +## nacos config clientæº�ç � -ÅäÖÃÖÐÐĺËÐĽӿÚConfigService +é…�置中心核心接å�£ConfigService ![image-20230429084850542](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084850542.png) -### »ñÈ¡ÅäÖà +### 获å�–é…�ç½® - »ñÈ¡ÅäÖõÄÖ÷Òª·½·¨ÊÇ NacosConfigService ÀàµÄ getConfig ·½·¨£¬Í¨³£Çé¿öϸ÷½·¨Ö±½Ó´Ó±¾µØÎļþÖÐÈ¡µÃÅäÖõÄÖµ£¬Èç¹û±¾µØÎļþ²»´æÔÚ»òÕßÄÚÈÝΪ¿Õ£¬ÔòÔÙͨ¹ý HTTP GET ·½·¨´ÓÔ¶¶ËÀ­È¡ÅäÖ㬲¢±£´æµ½±¾µØ¿ìÕÕÖС£µ±Í¨¹ý HTTP »ñȡԶ¶ËÅäÖÃʱ£¬Nacos ÌṩÁËÁ½ÖÖÈ۶ϲßÂÔ£¬Ò»Êdz¬Ê±Ê±¼ä£¬¶þÊÇ×î´óÖØÊÔ´ÎÊý£¬Ä¬ÈÏÖØÊÔÈý´Î¡£ + 获å�–é…�置的主è¦�方法是 NacosConfigService 类的 getConfig 方法,通常情况下该方法直接从本地文件中å�–å¾—é…�置的值,如果本地文件ä¸�存在或者内容为空,则å†�通过 HTTP GET 方法从远端拉å�–é…�置,并ä¿�存到本地快照中。当通过 HTTP 获å�–远端é…�置时,Nacos æ��供了两ç§�熔断策略,一是超时时间,二是最大é‡�试次数,默认é‡�试三次。 ![image-20230429084858759](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084858759.png) -### ×¢²á¼àÌýÆ÷ +### 注册监å�¬å™¨ -ÅäÖÃÖÐÐĿͻ§¶Ë»áͨ¹ý¶ÔÅäÖÃÏî×¢²á¼àÌýÆ÷´ïµ½ÔÚÅäÖÃÏî±ä¸üµÄʱºòÖ´Ðлص÷µÄ¹¦ÄÜ +é…�置中心客户端会通过对é…�置项注册监å�¬å™¨è¾¾åˆ°åœ¨é…�置项å�˜æ›´çš„æ—¶å€™æ‰§è¡Œå›žè°ƒçš„功能 * NacosConfigService#getConfigAndSignListener * ConfigService#addListener - Nacos ¿ÉÒÔͨ¹ýÒÔÉÏ·½Ê½×¢²á¼àÌýÆ÷£¬ËüÃÇÄÚ²¿µÄʵÏÖ¾ùÊǵ÷Óà ClientWorker ÀàµÄ addCacheDataIfAbsent¡£ÆäÖÐ CacheData ÊÇÒ»¸öά»¤ÅäÖÃÏîºÍÆäÏÂ×¢²áµÄËùÓмàÌýÆ÷µÄʵÀý£¬ËùÓÐµÄ CacheData ¶¼±£´æÔÚ ClientWorker ÀàÖеÄÔ­×Ó cacheMap ÖУ¬ÆäÄÚ²¿µÄºËÐijÉÔ±ÓУº + Nacos å�¯ä»¥é€šè¿‡ä»¥ä¸Šæ–¹å¼�注册监å�¬å™¨ï¼Œå®ƒä»¬å†…部的实现å�‡æ˜¯è°ƒç”¨ ClientWorker 类的 addCacheDataIfAbsent。其中 CacheData 是一个维护é…�置项和其下注册的所有监å�¬å™¨çš„实例,所有的 CacheData 都ä¿�存在 ClientWorker 类中的原å­� cacheMap 中,其内部的核心æˆ�员有: ![image-20230429084908207](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084908207.png) ![](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f14749bd9b614b21a55a261187cd5521~tplv-k3u1fbpfcp-zoom-in-crop-mark:4536:0:0:0.awebp) -### ÅäÖó¤ÂÖѯ +### é…�置长轮询 - ClientWorker ͨ¹ýÆäϵÄÁ½¸öÏ̳߳ØÍê³ÉÅäÖó¤ÂÖѯµÄ¹¤×÷£¬Ò»¸öÊǵ¥Ïß³ÌµÄ executor£¬Ã¿¸ô 10ms °´ÕÕÿ 3000 ¸öÅäÖÃÏîΪһÅú´ÎÀÌÈ¡´ýÂÖѯµÄ cacheData ʵÀý£¬½«Æä°ü×°³ÉΪһ¸ö LongPollingTask Ìá½»½øÈëµÚ¶þ¸öÏß³Ì³Ø executorService ´¦Àí¡£ + ClientWorker 通过其下的两个线程池完æˆ�é…�置长轮询的工作,一个是å�•线程的 executor,æ¯�éš” 10ms 按照æ¯� 3000 个é…�置项为一批次æ�žå�–待轮询的 cacheData 实例,将其包装æˆ�为一个 LongPollingTask æ��交进入第二个线程池 executorService 处ç�†ã€‚ ![image-20230429084917535](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084917535.png) -## nacos config serverÔ´Âë·ÖÎö +## nacos config serveræº�ç �分æž� -### ÅäÖÃdump +### é…�ç½®dump ![image-20230429084926987](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084926987.png) - ·þÎñ¶ËÆô¶¯Ê±¾Í»áÒÀÀµ DumpService µÄ init ·½·¨£¬´ÓÊý¾Ý¿âÖÐ load ÅäÖô洢ÔÚ±¾µØ´ÅÅÌÉÏ£¬²¢½«Ò»Ð©ÖØÒªµÄÔªÐÅÏ¢ÀýÈç MD5 Öµ»º´æÔÚÄÚ´æÖС£·þÎñ¶Ë»á¸ù¾ÝÐÄÌøÎļþÖб£´æµÄ×îºóÒ»´ÎÐÄÌøÊ±¼ä£¬À´Åжϵ½µ×ÊÇ´ÓÊý¾Ý¿â dump È«Á¿ÅäÖÃÊý¾Ý»¹ÊDz¿·ÖÔöÁ¿ÅäÖÃÊý¾Ý£¨Èç¹û»úÆ÷ÉÏ´ÎÐÄÌø¼ä¸ôÊÇ 6h ÒÔÄڵϰ£©¡£ + æœ�务端å�¯åŠ¨æ—¶å°±ä¼šä¾�èµ– DumpService çš„ init 方法,从数æ�®åº“中 load é…�置存储在本地ç£�盘上,并将一些é‡�è¦�的元信æ�¯ä¾‹å¦‚ MD5 值缓存在内存中。æœ�务端会根æ�®å¿ƒè·³æ–‡ä»¶ä¸­ä¿�存的最å�Žä¸€æ¬¡å¿ƒè·³æ—¶é—´ï¼Œæ�¥åˆ¤æ–­åˆ°åº•是从数æ�®åº“ dump å…¨é‡�é…�置数æ�®è¿˜æ˜¯éƒ¨åˆ†å¢žé‡�é…�置数æ�®ï¼ˆå¦‚果机器上次心跳间隔是 6h 以内的è¯�)。 -È«Á¿ dump µ±È»ÏÈÇå¿Õ´ÅÅÌ»º´æ£¬È»ºó¸ù¾ÝÖ÷¼ü ID ÿ´ÎÀÌȡһǧÌõÅäÖÃË¢½ø´ÅÅ̺ÍÄÚ´æ¡£ÔöÁ¿ dump ¾ÍÊÇÀÌÈ¡×î½üÁùСʱµÄÐÂÔöÅäÖ㨰üÀ¨¸üеĺÍɾ³ýµÄ£©£¬ÏȰ´ÕÕÕâÅúÊý¾ÝË¢ÐÂÒ»±éÄÚ´æºÍÎļþ£¬ÔÙ¸ù¾ÝÄÚ´æÀïËùÓеÄÊý¾ÝÈ«Á¿È¥±È¶ÔÒ»±éÊý¾Ý¿â£¬Èç¹ûÓиıäµÄÔÙͬ²½Ò»´Î£¬Ïà±ÈÓÚÈ«Á¿ dump µÄ»°»á¼õÉÙÒ»¶¨µÄÊý¾Ý¿â IO ºÍ´ÅÅÌ IO ´ÎÊý¡£ +å…¨é‡� dump 当然先清空ç£�盘缓存,然å�Žæ ¹æ�®ä¸»é”® ID æ¯�次æ�žå�–一å�ƒæ�¡é…�置刷进ç£�盘和内存。增é‡� dump 就是æ�žå�–最近六å°�时的新增é…�置(包括更新的和删除的),先按照这批数æ�®åˆ·æ–°ä¸€é��内存和文件,å†�æ ¹æ�®å†…存里所有的数æ�®å…¨é‡�去比对一é��æ•°æ�®åº“,如果有改å�˜çš„å†�å�Œæ­¥ä¸€æ¬¡ï¼Œç›¸æ¯”于全é‡� dump çš„è¯�会å‡�少一定的数æ�®åº“ IO å’Œç£�盘 IO 次数。 -### ÅäÖ÷¢²¼ +### é…�ç½®å�‘布 - ·¢²¼ÅäÖõĴúÂëλÓÚ ConfigController#publishConfigÖС£¼¯Èº²¿Êð£¬ÇëÇóÒ»¿ªÊ¼Ò²Ö»»á´òµ½Ò»Ì¨»úÆ÷£¬Õą̂»úÆ÷½«ÅäÖòåÈëMysqlÖнøÐг־û¯¡£·þÎñ¶Ë²¢²»ÊÇÕë¶Ôÿ´ÎÅäÖòéѯ¶¼È¥·ÃÎÊ MySQL £¬¶øÊÇ»áÒÀÀµ dump ¹¦ÄÜÔÚ±¾µØÎļþÖн«ÅäÖûº´æÆðÀ´¡£Òò´Ëµ±µ¥Ì¨»úÆ÷±£´æÍê±ÏÅäÖÃÖ®ºó£¬ÐèҪ֪ͨÆäËû»úÆ÷Ë¢ÐÂÄÚ´æºÍ±¾µØ´ÅÅÌÖеÄÎļþÄÚÈÝ£¬Òò´ËËü»á·¢²¼Ò»¸öÃûΪ ConfigDataChangeEvent µÄʼþ£¬Õâ¸öʼþ»áͨ¹ý HTTP µ÷ÓÃ֪ͨËùÓм¯Èº½Úµã£¨°üÀ¨×ÔÉí£©£¬´¥·¢±¾µØÎļþºÍÄÚ´æµÄˢС£ + å�‘布é…�置的代ç �ä½�于 ConfigController#publishConfig中。集群部署,请求一开始也å�ªä¼šæ‰“到一å�°æœºå™¨ï¼Œè¿™å�°æœºå™¨å°†é…�ç½®æ�’å…¥Mysql中进行æŒ�久化。æœ�务端并ä¸�是针对æ¯�次é…�置查询都去访问 MySQL ,而是会ä¾�èµ– dump 功能在本地文件中将é…�置缓存起æ�¥ã€‚因此当å�•å�°æœºå™¨ä¿�存完毕é…�置之å�Žï¼Œéœ€è¦�通知其他机器刷新内存和本地ç£�盘中的文件内容,因此它会å�‘布一个å��为 ConfigDataChangeEvent 的事件,这个事件会通过 HTTP 调用通知所有集群节点(包括自身),触å�‘本地文件和内存的刷新。 -### ´¦Àí³¤ÂÖѯ +### 处ç�†é•¿è½®è¯¢ - ¿Í»§¶Ë»áÓÐÒ»¸ö³¤ÂÖѯÈÎÎñ£¬À­È¡·þÎñ¶ËµÄÅäÖñä¸ü£¬·þÎñ¶Ë´¦ÀíÂß¼­ÔÚLongPollingServiceÀàÖУ¬ÆäÖÐÓÐÒ»¸ö Runnable ÈÎÎñÃûΪClientLongPolling£¬·þÎñ¶Ë»á½«Êܵ½µÄÂÖѯÇëÇó°ü×°³ÉÒ»¸ö ClientLongPolling ÈÎÎñ£¬¸ÃÈÎÎñ³ÖÓÐÒ»¸ö AsyncContext ÏìÓ¦¶ÔÏó£¬Í¨¹ý¶¨Ê±Ï̳߳ØÑÓºó 29.5s Ö´ÐС£±È¿Í»§¶Ë 30s µÄ³¬Ê±Ê±¼äÌáǰ 500ms ·µ»ØÊÇΪÁË×î´ó³Ì¶ÈÉϱ£Ö¤¿Í»§¶Ë²»»áÒòÎªÍøÂçÑÓʱÔì³É³¬Ê±. + 客户端会有一个长轮询任务,拉å�–æœ�务端的é…�ç½®å�˜æ›´ï¼Œæœ�务端处ç�†é€»è¾‘在LongPollingService类中,其中有一个 Runnable 任务å��为ClientLongPolling,æœ�务端会将å�—到的轮询请求包装æˆ�一个 ClientLongPolling 任务,该任务æŒ�有一个 AsyncContext å“�应对象,通过定时线程池延å�Ž 29.5s 执行。比客户端 30s 的超时时间æ��å‰� 500ms 返回是为了最大程度上ä¿�è¯�客户端ä¸�会因为网络延时造æˆ�è¶…æ—¶. ![image-20230429084934117](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230429084934117.png) @@ -253,11 +253,11 @@ public class ConfigServerDemo { -×÷ÕߣºÕþ²ÉÔÆµç×ÓÂô³¡ÍÅ¶Ó -Á´½Ó£ºhttps://juejin.cn/post/6999814668390760484 -À´Ô´£ºÏ¡ÍÁ¾ò½ð -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ -# ²Î¿¼ÎÄÕ +作者:政采云电å­�å�–场团队 +链接:https://juejin.cn/post/6999814668390760484 +æ�¥æº�:稀土掘金 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRocketMQ\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRocketMQ\346\272\220\347\240\201\345\210\206\346\236\220.md" index 9be0e22..230b5bb 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRocketMQ\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRocketMQ\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,31 +1,31 @@ -### Ò»¡¢NameServerÆô¶¯ +### 一ã€�NameServerå�¯åЍ -Ô´ÂëÈë¿Ú£ºNamesrvStartup#main +æº�ç �å…¥å�£ï¼šNamesrvStartup#main ##### 1.NamesrvController controller = createNamesrvController(args); -* ¼ì²âÃüÁîÐвÎÊý -* ´´½¨ºËÐÄÅäÖöÔÏó£¬NamesrvConfig¡¢NettyServerConfig -* ½âÎö -c ¡¢-p²ÎÊý -* ¼ì²éRocketMQ_HOME»·¾³±äÁ¿ -* final NamesrvController controller = new NamesrvController(namesrvConfig, nettyServerConfig);´´½¨controller -* controller.getConfiguration().registerConfig(properties); ×¢²áËùÓÐÅäÖÃÐÅÏ¢ +* 检测命令行å�‚æ•° +* 创建核心é…�置对象,NamesrvConfigã€�NettyServerConfig +* è§£æž� -c ã€�-på�‚æ•° +* 检查RocketMQ_HOME环境å�˜é‡� +* final NamesrvController controller = new NamesrvController(namesrvConfig, nettyServerConfig);创建controller +* controller.getConfiguration().registerConfig(properties); 注册所有é…�置信æ�¯ ##### 2.start(controller); -* controller.initialize()£» Ö´Ðгõʼ»¯ - ¡ð this.kvConfigManager.load(); ¼ÓÔØKVÅäÖà - ¡ð this.remotingServer = new NettyRemotingServer(this.nettyServerConfig, this.brokerHousekeepingService);´´½¨NettyServerÍøÂç´¦Àí¶ÔÏó - ¡ð this.remotingExecutor =Executors.newFixedThreadPool(nettyServerConfig.getServerWorkerThreads(), new ThreadFactoryImpl("RemotingExecutorThread_")); ´´½¨Netty·þÎñÆ÷¹¤×÷Ïß³Ì³Ø - ¡ð this.registerProcessor(); ×¢²áNameServerµÄProcessor ×¢²áµ½RemotingServerÖÐ - ¡ð NamesrvController.this.routeInfoManager.scanNotActiveBroker() Æô¶¯¶¨Ê±ÈÎÎñ£¬ÒƳý²»»îÔ¾µÄBroker - ¡ð NamesrvController.this.kvConfigManager.printAllPeriodically() ¶¨Ê±´òÓ¡KVÅäÖÃÐÅÏ¢ -* Runtime.getRuntime().addShutdownHook ×¢²á¹Ø±Õ¹³×Ó£¬ÔڹرշþÎñʱÊÍ·Å×ÊÔ´ -* controller.start()£» Æô¶¯controller +* controller.initialize()ï¼› 执行åˆ�始化 + â—‹ this.kvConfigManager.load(); 加载KVé…�ç½® + â—‹ this.remotingServer = new NettyRemotingServer(this.nettyServerConfig, this.brokerHousekeepingService);创建NettyServer网络处ç�†å¯¹è±¡ + â—‹ this.remotingExecutor =Executors.newFixedThreadPool(nettyServerConfig.getServerWorkerThreads(), new ThreadFactoryImpl("RemotingExecutorThread_")); 创建Nettyæœ�务器工作线程池 + â—‹ this.registerProcessor(); 注册NameServerçš„Processor 注册到RemotingServer中 + â—‹ NamesrvController.this.routeInfoManager.scanNotActiveBroker() å�¯åŠ¨å®šæ—¶ä»»åŠ¡ï¼Œç§»é™¤ä¸�活跃的Broker + â—‹ NamesrvController.this.kvConfigManager.printAllPeriodically() 定时打å�°KVé…�置信æ�¯ +* Runtime.getRuntime().addShutdownHook 注册关闭钩å­�,在关闭æœ�务时释放资æº� +* controller.start()ï¼› å�¯åЍcontroller -NameServerµÄ×÷ÓÃÖ÷ÒªÓÐÁ½¸ö£º -1.ά»¤brokerµÄ·þÎñµØÖ·ÐÅÏ¢£¬²¢½øÐиüР-2.¸øProducer¡¢consumerÌṩBrokerµÄ·þÎñÁбí +NameServer的作用主è¦�有两个: +1.维护brokerçš„æœ�务地å�€ä¿¡æ�¯ï¼Œå¹¶è¿›è¡Œæ›´æ–° +2.ç»™Producerã€�consumeræ��ä¾›Brokerçš„æœ�务列表 @@ -39,49 +39,49 @@ image.png -### ¶þ¡¢BrokerÆô¶¯ +### 二ã€�Brokerå�¯åЍ -Ô´ÂëÈë¿Ú£ºBrokerstartup#main +æº�ç �å…¥å�£ï¼šBrokerstartup#main ##### 1.createBrokerController(args) -* ¹¹½¨ËĸöºËÐÄÅäÖöÔÏó£ºBrokerConfig¡¢NettyServerConfig¡¢NettyClientConfig¡¢MessageStoreConfig -* BrokerConfigÖ»½âÎö -c²ÎÊý -* RocketMq_HOME»·¾³±äÁ¿¼ì²é -* RemotingUtil.string2SocketAddress(addr) ½«namesrvAddrµØÖ·½øÐвð·Ö -* messageStoreConfig.getBrokerRole() ͨ¹ýBrokerIdÅжÏÖ÷´Ó£ºmasterId=0£¬Deldger¼¯ÈºµÄËùÓÐBroker½ÚµãID¶¼ÊÇ-1 -* ½âÎö -p¡¢-m²ÎÊý£¬²¢½«½âÎöµÄ²ÎÊýÌí¼Óµ½ËĸöºËÐÄÅäÖöÔÏóÖÐ -* BrokerController controller = new BrokerController ´´½¨brokerController£¬½«ËĸöºËÐÄÅäÖÃÀà´«Èë -* controller.getConfiguration().registerConfig(properties); ÖØÐÂ×¢²á£¨¸üУ©ÅäÖà -* controller.initialize(); ³õʼ»¯controller - ¡ð ¼ÓÔØ´ÅÅÌÉϵÄÅäÖÃÎļþ£ºtopicConfigManager¡¢consumerOffsetManager¡¢subscriptionGroupManager¡¢consumerFilterManager - ¡ð this.messageStore =new DefaultMessageStore() ¹¹½¨ÏûÏ¢´æ´¢×é¼þ - ¡ð this.messageStore.load() ¼ÓÔØ´ÅÅÌÎļþ - ¡ð this.remotingServer = new NettyRemotingServer ¹¹½¨NettyÍøÂç×é¼þ - ¡ð this.fastRemotingServer = new NettyRemotingServer Õâ¸öfastRemotingServerÓëRemotingServer¹¦ÄÜ»ù±¾²î²»¶à£¬´¦ÀíVIP¶Ë¿ÚÇëÇó - ¡ð ºóÃæ¾ÍÊdzõʼ»¯Ò»Ð©Ïß³Ì³Ø - ¡ð this.registerProcessor(); broker×¢²áһЩProcessor´¦Àí·½·¨ -* Runtime.getRuntime().addShutdownHook ×¢²á¹Ø±Õ¹³×Ó +* 构建四个核心é…�置对象:BrokerConfigã€�NettyServerConfigã€�NettyClientConfigã€�MessageStoreConfig +* BrokerConfigå�ªè§£æž� -cå�‚æ•° +* RocketMq_HOME环境å�˜é‡�检查 +* RemotingUtil.string2SocketAddress(addr) å°†namesrvAddr地å�€è¿›è¡Œæ‹†åˆ† +* messageStoreConfig.getBrokerRole() 通过BrokerId判断主从:masterId=0,Deldger集群的所有Broker节点ID都是-1 +* è§£æž� -pã€�-må�‚数,并将解æž�çš„å�‚数添加到四个核心é…�置对象中 +* BrokerController controller = new BrokerController 创建brokerController,将四个核心é…�置类传入 +* controller.getConfiguration().registerConfig(properties); é‡�新注册(更新)é…�ç½® +* controller.initialize(); åˆ�始化controller + â—‹ 加载ç£�盘上的é…�置文件:topicConfigManagerã€�consumerOffsetManagerã€�subscriptionGroupManagerã€�consumerFilterManager + â—‹ this.messageStore =new DefaultMessageStore() 构建消æ�¯å­˜å‚¨ç»„ä»¶ + â—‹ this.messageStore.load() 加载ç£�盘文件 + â—‹ this.remotingServer = new NettyRemotingServer 构建Netty网络组件 + â—‹ this.fastRemotingServer = new NettyRemotingServer 这个fastRemotingServer与RemotingServer功能基本差ä¸�多,处ç�†VIP端å�£è¯·æ±‚ + â—‹ å�Žé�¢å°±æ˜¯åˆ�始化一些线程池 + â—‹ this.registerProcessor(); broker注册一些Processor处ç�†æ–¹æ³• +* Runtime.getRuntime().addShutdownHook 注册关闭钩å­� ##### 2.start(BrokerController controller) -* this.messageStore.start(); ÕâÀïÆô¶¯·þÎñÖ÷ÒªÊÇΪÁ˽«CommitLogµÄдÈëʼþ·Ö·¢¸øComsumeQueueºÍIndexFile -* Æô¶¯Á½¸öNetty·þÎñ£ºremotingServer¡¢fastRemotingServer -* this.fileWatchService.start(); Îļþ¼àÌý·þÎñ -* this.brokerOuterAPI.start(); brokerOuterAPI¿ÉÒÔÀí½âΪһ¸öNetty¿Í»§¶Ë£¬ÍùÍâ·¢ÇëÇóµÄ×é¼þ£¬ÀýÈç·¢ËÍÐÄÌø -* this.pullRequestHoldService.start(); ³¤ÂÖѯÇëÇóÔÝÍ£·þÎñ -* this.filterServerManager.start(); ʹÓÃfilter½øÐйýÂË -* BrokerController.this.registerBrokerAll() BrokerºËÐĵÄÐÄÌø×¢²áÈÎÎñ,Ö÷Òª×÷ÓþÍÊǽ«broker×¢²áµ½NamesrvÖÐ +* this.messageStore.start(); 这里å�¯åЍæœ�务主è¦�是为了将CommitLog的写入事件分å�‘ç»™ComsumeQueueå’ŒIndexFile +* å�¯åŠ¨ä¸¤ä¸ªNettyæœ�务:remotingServerã€�fastRemotingServer +* this.fileWatchService.start(); 文件监å�¬æœ�务 +* this.brokerOuterAPI.start(); brokerOuterAPIå�¯ä»¥ç�†è§£ä¸ºä¸€ä¸ªNetty客户端,往外å�‘请求的组件,例如å�‘é€�心跳 +* this.pullRequestHoldService.start(); 长轮询请求暂å�œæœ�务 +* this.filterServerManager.start(); 使用filter进行过滤 +* BrokerController.this.registerBrokerAll() Broker核心的心跳注册任务,主è¦�作用就是将broker注册到Namesrv中 -brokerµÄºËÐÄ×÷Ó㺠-**1.×÷Ϊclientʱ£¬ÏònameServer·¢ËÍÐÄÌøÐÅÏ¢¡¢·¢ÆðÊÂÎñµÄ״̬¼ì²é** -**2.×÷Ϊ·þÎñ¶Ëʱ£¬ÓÃÓÚ´æ´¢ÏûÏ¢¡¢ÏìÓ¦consumer¶ËµÄÇëÇó** +broker的核心作用: +**1.作为client时,å�‘nameServerå�‘é€�心跳信æ�¯ã€�å�‘起事务的状æ€�检查** +**2.作为æœ�务端时,用于存储消æ�¯ã€�å“�应consumer端的请求** -### Èý¡¢Netty·þÎñ×¢²á¿ò¼Ü +### 三ã€�Nettyæœ�务注册框架 -### ËÄ¡¢BrokerÐÄÌø×¢²á¹ý³Ì +### å››ã€�Broker心跳注册过程 -Ô´ÂëÈë¿Ú£ºBrokerController.this.registerBrokerAll(true, false, brokerConfig.isForceRegister()) +æº�ç �å…¥å�£ï¼šBrokerController.this.registerBrokerAll(true, false, brokerConfig.isForceRegister()) @@ -100,7 +100,7 @@ public synchronized void registerBrokerAll(final boolean checkOrderConfig, boole } topicConfigWrapper.setTopicConfigTable(topicConfigTable); } - //ÕâÀï²ÅÊDZȽϹؼüµÄµØ·½¡£ÏÈÅжÏÊÇ·ñÐèҪע²á£¬È»ºóµ÷ÓÃdoRegisterBrokerAll·½·¨ÕæÕýÈ¥×¢²á¡£ + //这里æ‰�是比较关键的地方。先判断是å�¦éœ€è¦�注册,然å�Žè°ƒç”¨doRegisterBrokerAll方法真正去注册。 if (forceRegister || needRegister(this.brokerConfig.getBrokerClusterName(), this.getBrokerAddr(), this.brokerConfig.getBrokerName(), @@ -117,10 +117,10 @@ public synchronized void registerBrokerAll(final boolean checkOrderConfig, boole ``` -// Broker×¢²á×îºËÐĵIJ¿·Ö +// Broker注册最核心的部分 private void doRegisterBrokerAll(boolean checkOrderConfig, boolean oneway, TopicConfigSerializeWrapper topicConfigWrapper) { - // ×¢²ábroker·½·¨ + // 注册broker方法 List registerBrokerResultList = this.brokerOuterAPI.registerBrokerAll( this.brokerConfig.getBrokerClusterName(), this.getBrokerAddr(), @@ -136,7 +136,7 @@ private void doRegisterBrokerAll(boolean checkOrderConfig, boolean oneway, if (registerBrokerResultList.size() > 0) { RegisterBrokerResult registerBrokerResult = registerBrokerResultList.get(0); if (registerBrokerResult != null) { - //×¢²áÍê±£´æÖ÷´Ó½ÚµãµÄµØÖ· + //注册完ä¿�存主从节点的地å�€ if (this.updateMasterHAServerAddrPeriodically && registerBrokerResult.getHaServerAddr() != null) { this.messageStore.updateHaMasterAddress(registerBrokerResult.getHaServerAddr()); } @@ -168,9 +168,9 @@ public List registerBrokerAll( final boolean oneway, final int timeoutMills, final boolean compressed) { - //ʹÓÃCopyOnWriteArrayListÌáÉý²¢·¢°²È«ÐÔ + //使用CopyOnWriteArrayListæ��å�‡å¹¶å�‘安全性 final List registerBrokerResultList = new CopyOnWriteArrayList<>(); - // »ñÈ¡ËùÓÐnameServerµÄµØÖ·ÐÅÏ¢ + // 获å�–所有nameServer的地å�€ä¿¡æ�¯ List nameServerAddressList = this.remotingClient.getNameServerAddressList(); if (nameServerAddressList != null && nameServerAddressList.size() > 0) { @@ -188,7 +188,7 @@ public List registerBrokerAll( final byte[] body = requestBody.encode(compressed); final int bodyCrc32 = UtilAll.crc32(body); requestHeader.setBodyCrc32(bodyCrc32); - //ͨ¹ýCountDownLatch£¬±£Ö¤ÔÚËùÓÐNameServerÉÏÍê³É×¢²áºóÔÙÒ»Æð½áÊø¡£ + //通过CountDownLatch,ä¿�è¯�在所有NameServer上完æˆ�注册å�Žå†�一起结æ�Ÿã€‚ final CountDownLatch countDownLatch = new CountDownLatch(nameServerAddressList.size()); for (final String namesrvAddr : nameServerAddressList) { brokerOuterExecutor.execute(new Runnable() { @@ -223,12 +223,12 @@ public List registerBrokerAll( -NameServer´¦ÀíÇëÇó£º +NameServer处ç�†è¯·æ±‚: ``` -//NameServer´¦ÀíÇëÇóµÄºËÐÄ´úÂë +//NameServer处ç�†è¯·æ±‚的核心代ç � @Override public RemotingCommand processRequest(ChannelHandlerContext ctx, RemotingCommand request) throws RemotingCommandException { @@ -249,10 +249,10 @@ NameServer return this.deleteKVConfig(ctx, request); case RequestCode.QUERY_DATA_VERSION: return queryBrokerTopicConfig(ctx, request); - case RequestCode.REGISTER_BROKER: //Broker×¢²áÇëÇó´¦Àí¡£°æ±¾Ä¬ÈÏÊǵ±Ç°¿ò¼Ü°æ±¾ + case RequestCode.REGISTER_BROKER: //Broker注册请求处ç�†ã€‚版本默认是当å‰�框架版本 Version brokerVersion = MQVersion.value2Version(request.getVersion()); if (brokerVersion.ordinal() >= MQVersion.Version.V3_0_11.ordinal()) { - return this.registerBrokerWithFilterServer(ctx, request); //µ±Ç°°æ±¾ + return this.registerBrokerWithFilterServer(ctx, request); //当å‰�版本 } else { return this.registerBroker(ctx, request); } @@ -294,7 +294,7 @@ NameServer -ʵ¼Ê¾ÍÊǽ«brokerÐÅÏ¢×¢²áµ½routeInfoÖУº +实际就是将brokerä¿¡æ�¯æ³¨å†Œåˆ°routeInfo中: @@ -324,7 +324,7 @@ public RemotingCommand registerBrokerWithFilterServer(ChannelHandlerContext ctx, registerBrokerBody.getTopicConfigSerializeWrapper().getDataVersion().setCounter(new AtomicLong(0)); registerBrokerBody.getTopicConfigSerializeWrapper().getDataVersion().setTimestamp(0); } - //routeInfoManager¾ÍÊǹÜÀí·ÓÉÐÅÏ¢µÄºËÐÄ×é¼þ¡£ + //routeInfoManager就是管ç�†è·¯ç”±ä¿¡æ�¯çš„æ ¸å¿ƒç»„件。 RegisterBrokerResult result = this.namesrvController.getRouteInfoManager().registerBroker( requestHeader.getClusterName(), requestHeader.getBrokerAddr(), @@ -350,10 +350,10 @@ public RemotingCommand registerBrokerWithFilterServer(ChannelHandlerContext ctx, -### Îå¡¢Producer·¢ËÍÏûÏ¢ +### 五ã€�Producerå�‘é€�消æ�¯ -Ô´ÂëÈë¿Ú£ºDefaultMQProducer#start -1.this.defaultMQProducerImpl.start(); Éú²ú¶ËÆô¶¯ +æº�ç �å…¥å�£ï¼šDefaultMQProducer#start +1.this.defaultMQProducerImpl.start(); 生产端å�¯åЍ @@ -361,17 +361,17 @@ public RemotingCommand registerBrokerWithFilterServer(ChannelHandlerContext ctx, public void start(final boolean startFactory) throws MQClientException { switch (this.serviceState) { case CREATE_JUST: - // ĬÈϾÍÊÇCREATE_JUST + // 默认就是CREATE_JUST this.serviceState = ServiceState.START_FAILED; this.checkConfig(); - //Ð޸ĵ±Ç°µÄinstanceNameΪµ±Ç°½ø³ÌID + //修改当å‰�çš„instanceName为当å‰�进程ID if (!this.defaultMQProducer.getProducerGroup().equals(MixAll.CLIENT_INNER_PRODUCER_GROUP)) { this.defaultMQProducer.changeInstanceNameToPID(); } - //¿Í»§¶ËºËÐĵÄMQ¿Í»§¶Ë¹¤³§ ¶ÔÓÚÊÂÎñÏûÏ¢·¢ËÍÕߣ¬ÔÚÕâÀïÃæ»áÍê³ÉÊÂÎñÏûÏ¢µÄ·¢ËÍÕߵķþÎñ×¢²á + //客户端核心的MQ客户端工厂 对于事务消æ�¯å�‘é€�者,在这里é�¢ä¼šå®Œæˆ�事务消æ�¯çš„å�‘é€�者的æœ�务注册 this.mQClientFactory = MQClientManager.getInstance().getOrCreateMQClientInstance(this.defaultMQProducer, rpcHook); - //×¢²áMQ¿Í»§¶Ë¹¤³§Ê¾Àý + //注册MQ客户端工厂示例 boolean registerOK = mQClientFactory.registerProducer(this.defaultMQProducer.getProducerGroup(), this); if (!registerOK) { this.serviceState = ServiceState.CREATE_JUST; @@ -381,7 +381,7 @@ public void start(final boolean startFactory) throws MQClientException { } this.topicPublishInfoTable.put(this.defaultMQProducer.getCreateTopicKey(), new TopicPublishInfo()); - //Æô¶¯Ê¾Àý --ËùÓпͻ§¶Ë×é¼þ¶¼½»ÓÉmQClientFactoryÆô¶¯ + //å�¯åŠ¨ç¤ºä¾‹ --所有客户端组件都交由mQClientFactoryå�¯åЍ if (startFactory) { mQClientFactory.start(); } @@ -400,7 +400,7 @@ public void start(final boolean startFactory) throws MQClientException { default: break; } - // ÏòËùÓеÄbroker·¢ËÍÐÄÌø + // å�‘所有的brokerå�‘é€�心跳 this.mQClientFactory.sendHeartbeatToAllBrokerWithLock(); this.startScheduledTask(); @@ -411,9 +411,9 @@ public void start(final boolean startFactory) throws MQClientException { -### Áù¡¢ConsumerÏû·ÑÏûÏ¢ +### å…­ã€�Consumer消费消æ�¯ -Ïû·Ñ¶ËÈë¿Ú£ºDefaultMQPushConsumer#start +消费端入å�£ï¼šDefaultMQPushConsumer#start this.defaultMQPushConsumerImpl.start(); @@ -433,9 +433,9 @@ public synchronized void start() throws MQClientException { if (this.defaultMQPushConsumer.getMessageModel() == MessageModel.CLUSTERING) { this.defaultMQPushConsumer.changeInstanceNameToPID(); } - //¿Í»§¶ËʾÀý¹¤³§£¬Éú²úÕßÒ²Êǽ»ÓÉÕâ¸ö¹¤³§Æô¶¯µÄ¡£ + //客户端示例工厂,生产者也是交由这个工厂å�¯åŠ¨çš„ã€‚ this.mQClientFactory = MQClientManager.getInstance().getOrCreateMQClientInstance(this.defaultMQPushConsumer, this.rpcHook); - //¸ºÔؾùºâ²ßÂÔ + //è´Ÿè½½å�‡è¡¡ç­–ç•¥ this.rebalanceImpl.setConsumerGroup(this.defaultMQPushConsumer.getConsumerGroup()); this.rebalanceImpl.setMessageModel(this.defaultMQPushConsumer.getMessageModel()); this.rebalanceImpl.setAllocateMessageQueueStrategy(this.defaultMQPushConsumer.getAllocateMessageQueueStrategy()); @@ -449,13 +449,13 @@ public synchronized void start() throws MQClientException { if (this.defaultMQPushConsumer.getOffsetStore() != null) { this.offsetStore = this.defaultMQPushConsumer.getOffsetStore(); } else { - //´ÓÕâÀï¿ÉÒÔ¿´³ö£¬¹ã²¥Ä£Ê½Ó뼯ȺģʽµÄ×î±¾ÖÊÇø±ð¾ÍÊÇoffset´æ´¢µÄµØ·½²»Ò»Ñù¡£ + //从这里å�¯ä»¥çœ‹å‡ºï¼Œå¹¿æ’­æ¨¡å¼�与集群模å¼�的最本质区别就是offset存储的地方ä¸�一样。 switch (this.defaultMQPushConsumer.getMessageModel()) { - //¹ã²¥Ä£Ê½ÊÇÔÚÏû·ÑÕß±¾µØ´æ´¢offset + //广播模å¼�是在消费者本地存储offset case BROADCASTING: this.offsetStore = new LocalFileOffsetStore(this.mQClientFactory, this.defaultMQPushConsumer.getConsumerGroup()); break; - //¼¯ÈºÄ£Ê½ÊÇÔÚBrokerÔ¶¶Ë´æ´¢offset + //集群模å¼�是在Broker远端存储offset case CLUSTERING: this.offsetStore = new RemoteBrokerOffsetStore(this.mQClientFactory, this.defaultMQPushConsumer.getConsumerGroup()); break; @@ -465,12 +465,12 @@ public synchronized void start() throws MQClientException { this.defaultMQPushConsumer.setOffsetStore(this.offsetStore); } this.offsetStore.load(); - //˳ÐòÏû·Ñ¼àÌý´´½¨ConsumeMessageOrderlyService + //顺åº�消费监å�¬åˆ›å»ºConsumeMessageOrderlyService if (this.getMessageListenerInner() instanceof MessageListenerOrderly) { this.consumeOrderly = true; this.consumeMessageService = new ConsumeMessageOrderlyService(this, (MessageListenerOrderly) this.getMessageListenerInner()); - //²¢·¢Ïû·Ñ¼àÌý´´½¨ConsumeMessageConcurrentlyService + //å¹¶å�‘消费监å�¬åˆ›å»ºConsumeMessageConcurrentlyService } else if (this.getMessageListenerInner() instanceof MessageListenerConcurrently) { this.consumeOrderly = false; this.consumeMessageService = @@ -478,7 +478,7 @@ public synchronized void start() throws MQClientException { } this.consumeMessageService.start(); - //×¢²áÏû·ÑÕß¡£ÓëÉú²úÕßÀàËÆ£¬¿Í»§¶ËÖ»Òª°´ÒªÇó×¢²á¼´¿É£¬ºóÐø»áËæmQClientFactoryÒ»ÆðÆô¶¯¡£ + //注册消费者。与生产者类似,客户端å�ªè¦�按è¦�求注册å�³å�¯ï¼Œå�Žç»­ä¼šéš�mQClientFactory一起å�¯åŠ¨ã€‚ boolean registerOK = mQClientFactory.registerConsumer(this.defaultMQPushConsumer.getConsumerGroup(), this); if (!registerOK) { this.serviceState = ServiceState.CREATE_JUST; @@ -512,20 +512,20 @@ public synchronized void start() throws MQClientException { -**1¡¢consumer¶ËµÄÏû·Ñģʽ£º** -¡ñ ¼¯ÈºÄ£Ê½£º¼¯ÈºÄ£Ê½ÏÂÿ¸öconsumer¶¼»á·ÖÅ䲻ͬµÄÏûÏ¢ -¡ñ ¹ã²¥Ä£Ê½£º¹ã²¥Ä£Ê½ÏÂÿ¸öÏûÏ¢¶¼ÍÆË͸øËùÓÐconsumer -**2¡¢¹ØÓÚoffset´æ´¢£º** -¡ñ ¹ã²¥Ä£Ê½£ºthis.offsetStore = new LocalFileOffsetStore(); ´æ´¢ÔÚÿ¸öconsumerÖÐ -¡ñ ¼¯ÈºÄ£Ê½£ºthis.offsetStore = new RemoteBrokerOffsetStore(); ´æ´¢ÔÚbroker¶Ë +**1ã€�consumer端的消费模å¼�:** +â—� 集群模å¼�:集群模å¼�下æ¯�个consumer都会分é…�ä¸�å�Œçš„æ¶ˆæ�¯ +â—� 广播模å¼�:广播模å¼�下æ¯�个消æ�¯éƒ½æŽ¨é€�给所有consumer +**2ã€�关于offset存储:** +â—� 广播模å¼�:this.offsetStore = new LocalFileOffsetStore(); 存储在æ¯�个consumer中 +â—� 集群模å¼�:this.offsetStore = new RemoteBrokerOffsetStore(); 存储在broker端 -×÷Õߣº·ãÒ¶ºì»¨ -Á´½Ó£ºhttps://www.jianshu.com/p/8dd4cfeae39d -À´Ô´£º¼òÊé -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ -# ²Î¿¼ÎÄÕ +作者:枫å�¶çº¢èб +链接:https://www.jianshu.com/p/8dd4cfeae39d +æ�¥æº�:简书 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSeata\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSeata\346\272\220\347\240\201\345\210\206\346\236\220.md" index 19ce963..bcd63f5 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSeata\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSeata\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,20 +1,20 @@ -×÷Õß | Ò»ÆðߣJava -À´Ô´ |½ñÈÕÍ·Ìõ +作者 | 一起撸Java +æ�¥æº� |今日头æ�¡ -**ѧϰĿ±ê** +**学习目标** -* Seata ATģʽԴÂëÁ÷³Ì - **µÚ1Õ ATģʽÁ÷³Ì** - **1.1 ˼άÁ÷³ÌÍÆµ¼** - ÉÏÎÄÖÐÒѾ­½²ÁËATģʽµÄ´óÌåÔ­Àí£¬ÔÚÔ´ÂëÖУ¬Í¨¹ýREADMEÒ²ÄÜ¿´³öÀ´ATģʽµÄʹÓã¬ÄDZ¾ÎĽ«´Óµ×²ãÔ´Âë²ãÃæÈ¥·ÖÎöATģʽµÄÔ­Àí£¬ÔÚ·ÖÎöÔ­Àí֮ǰÔÛÃÇÏÈÀ´¿´Èý·ùͼ£¬Àí½âÒ»ÏÂËûµÄ¹¤×÷˼·ºÍģʽ£º +* Seata AT模å¼�æº�ç �æµ�程 + **第1ç«  AT模å¼�æµ�程** + **1.1 æ€�ç»´æµ�程推导** + 上文中已ç»�讲了AT模å¼�的大体原ç�†ï¼Œåœ¨æº�ç �中,通过README也能看出æ�¥AT模å¼�的使用,那本文将从底层æº�ç �层é�¢åŽ»åˆ†æž�AT模å¼�的原ç�†ï¼Œåœ¨åˆ†æž�原ç�†ä¹‹å‰�咱们先æ�¥çœ‹ä¸‰å¹…图,ç�†è§£ä¸€ä¸‹ä»–的工作æ€�路和模å¼�: -ÏÈ¿´¿´Ë¼Î¬ÍƵ¼Í¼![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0388859932ccee17ed32246e2e5f4e0a88dee6.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")1.2 ³õʼ»¯Á÷³ÌÍÆµ¼ -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f24e8bd05e84b683e3f3227490146155bf5b17.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")1.3 Ö´ÐÐÁ÷³ÌÍÆµ¼ -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/93dea0538eba8be5778699ea2af8f71c0e396c.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")**µÚ2Õ ԴÂë·ÖÎö** +先看看æ€�维推导图![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0388859932ccee17ed32246e2e5f4e0a88dee6.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")1.2 åˆ�始化æµ�程推导 +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f24e8bd05e84b683e3f3227490146155bf5b17.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")1.3 执行æµ�程推导 +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/93dea0538eba8be5778699ea2af8f71c0e396c.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")**第2ç«  æº�ç �分æž�** **2.1 SeataAutoConfiguration** -¶ÔÓÚseataÔ´ÂëµÄÑо¿Ö÷Òª¿´seataÈçºÎÀ¹½ØÒµÎñSQLÉú³Éundo_logÊý¾Ý£¬ÈçºÎÔÚÒ»½×¶ÎÍê³ÉºóÌύȫ¾ÖÊÂÎñ£¬ÈçºÎÔÚÒ»½×¶ÎÒµÎñʧ°Üºóͨ¹ýundo_log»Ø¹öÊÂÎñ£¬½øÐÐÊÂÎñ²¹³¥¡£ +对于seataæº�ç �的研究主è¦�看seata如何拦截业务SQL生æˆ�undo_logæ•°æ�®ï¼Œå¦‚何在一阶段完æˆ�å�Žæ��交全局事务,如何在一阶段业务失败å�Žé€šè¿‡undo_log回滚事务,进行事务补å�¿ã€‚ -seataÒ²ÊÇÓëspringÕûºÏʹÓõ쬽áºÏSpringBoot£¬seataÒ²ÊÇ×öÁËһЩ×Ô¶¯ÅäÖÃ![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/719ef4a775ece0688c929227415e97f68f1c58.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")seataµÄ×Ô¶¯ÅäÖÃÀàÃüÃû·Ç³£µÄÖ±½Ó£¬¾Í½Ð×ö£ºSeataAutoConfiguration£¬ÎÒÃÇ´ò¿ªÕâ¸öÀà +seata也是与springæ•´å�ˆä½¿ç”¨çš„,结å�ˆSpringBoot,seata也是å�šäº†ä¸€äº›è‡ªåЍé…�ç½®![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/719ef4a775ece0688c929227415e97f68f1c58.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")seata的自动é…�置类命å��é�žå¸¸çš„直接,就å�«å�šï¼šSeataAutoConfiguration,我们打开这个类 @@ -30,15 +30,15 @@ seataÒ² -Ê×ÏÈ£¬@ComponentScanɨÃèÁËÒ»ÏÂproperties°ü£¬¼ÓÔØÁËÒ»´ó¶ÑÀàËÆSeataPropertiesµÄBean¶ÔÏó¡£ +首先,@ComponentScan扫æ��了一下properties包,加载了一大堆类似SeataPropertiesçš„Bean对象。 -@ConditionalOnProperty½«ÅäÖÃÀàÉúЧÌõ¼þÉèÖÃΪseata.enabled=true£¬Ä¬ÈÏÖµÊÇtrue£¬ËùÒÔ¿ÉÒÔ¿ª¹Ø·Ö²¼Ê½ÊÂÎñ¹¦ÄÜ£¨ÔÚclient¶ËµÄfile.confÀïÃæ¿ÉÒÔÅäÖã©¡£ +@ConditionalOnPropertyå°†é…�置类生效æ�¡ä»¶è®¾ç½®ä¸ºseata.enabled=true,默认值是true,所以å�¯ä»¥å¼€å…³åˆ†å¸ƒå¼�事务功能(在client端的file.conf里é�¢å�¯ä»¥é…�置)。 -@Configuration±íÃ÷£¬SeataAutoConfiguration±»¶¨ÒåΪÁËspringµÄÅäÖÃÀà¡£ +@Configuration表明,SeataAutoConfiguration被定义为了springçš„é…�置类。 -@EnableConfigurationProperties½«ÅäÖðüת³ÉÁËÒ»¸öSeataPropertiesµÄBean¶ÔÏóÀ´Ê¹Óᣠ+@EnableConfigurationPropertieså°†é…�置包转æˆ�了一个SeataPropertiesçš„Bean对象æ�¥ä½¿ç”¨ã€‚ -½ÓÏÂÀ´ÔĶÁSeataAutoConfigurationµÄÄÚ²¿´úÂë +接下æ�¥é˜…读SeataAutoConfiguration的内部代ç � @@ -54,31 +54,31 @@ seataÒ² -×Ô¶¯ÅäÖõĺËÐĵãÂäÔÚÁËÏÂÃæµÄÒ»¸öBean£¬GlobalTransactionScanner¡£ +自动é…�置的核心点è�½åœ¨äº†ä¸‹é�¢çš„一个Bean,GlobalTransactionScanner。 -ÎÒÃÇ¿´µ½¹¹ÔìÕâ¸öBean·Ç³£µÄ¼òµ¥£¬¹¹Ôì·½·¨Ö»ÐèÒªÒ»¸öapplicationIdºÍtxServiceGroup¡£ +我们看到构造这个Beané�žå¸¸çš„简å�•,构造方法å�ªéœ€è¦�一个applicationIdå’ŒtxServiceGroup。 -applicationId: ¾ÍÊÇspring.application.name=Ä㶨ÒåµÄµ±Ç°Ó¦ÓõÄÃû×Ö£¬ÀýÈ磺userService +applicationId: 就是spring.application.name=你定义的当å‰�应用的å��字,例如:userService -txServiceGroup: ¾ÍÊÇÒÔapplicationId ¼ÓÉÏ -seata-service-groupÃüÃûµÄ£¬ÀýÈ磺 -userService-seata-service-group¡£Èç¹û°æ±¾½ÏµÍµÄ»°£¬ÄÇʱºò¿ÉÄÜ»¹²»½Ðseata¶øÊÇfescar£¬Òò´ËĬÈÏÃüÃû¾ÍÊÇÒÔfescarΪºó׺¡£ +txServiceGroup: 就是以applicationId 加上 -seata-service-group命å��的,例如: +userService-seata-service-group。如果版本较低的è¯�,那时候å�¯èƒ½è¿˜ä¸�å�«seata而是fescar,因此默认命å��就是以fescar为å�Žç¼€ã€‚ -newÁËÒ»¸öGlobalTransactionScanner¶ÔÏó£¬SeataAutoConfigurationÕâ¸ö×Ô¶¯ÅäÖÃÀàµÄ×÷ÓþͽáÊøÁË¡£SeataAutoConfigurationÖ»ÊÇ×öÁËÒ»¸öÆô¶¯Òýµ¼µÄ×÷Óᣠ+new了一个GlobalTransactionScanner对象,SeataAutoConfiguration这个自动é…�置类的作用就结æ�Ÿäº†ã€‚SeataAutoConfigurationå�ªæ˜¯å�šäº†ä¸€ä¸ªå�¯åŠ¨å¼•å¯¼çš„ä½œç”¨ã€‚ **2.2 GlobalTransactionScanner** -¼ÈÈ»ºËÐĵãÂäÔÚGlobalTransactionScannerÕâ¸öÀ࣬ÎÒÃǼÌÐø¹Ø×¢Ëü¡£¿´Õâ¸öÃû×ÖÆäʵ¾Í¿ÉÒԲ²⵽һµãËüµÄ×÷Óã¬É¨Ãè@GlobalTransactionalÕâ¸ö×¢½â£¬²¢¶Ô´úÀí·½·¨½øÐÐÀ¹½ØÔöÇ¿ÊÂÎñµÄ¹¦ÄÜ¡£ +既然核心点è�½åœ¨GlobalTransactionScanner这个类,我们继续关注它。看这个å��字其实就å�¯ä»¥çŒœæµ‹åˆ°ä¸€ç‚¹å®ƒçš„作用,扫æ��@GlobalTransactional这个注解,并对代ç�†æ–¹æ³•进行拦截增强事务的功能。 -ÒªÁ˽âÕâ¸öÀ࣬²»µÃ²»ÏÈÔĶÁÒ»ÏÂËüµÄUMLͼ![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/83cb3ed76073a33cb19242ffe542b615346d16.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")¿ÉÒÔ¿´µ½£¬GlobalTransactionScannerÖ÷ÒªÓÐ4¸öµãÖµµÃ¹Ø×¢£º +è¦�了解这个类,ä¸�å¾—ä¸�先阅读一下它的UML图![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/83cb3ed76073a33cb19242ffe542b615346d16.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")å�¯ä»¥çœ‹åˆ°ï¼ŒGlobalTransactionScanner主è¦�有4个点值得关注: -1£©ApplicationContextAware±íʾ¿ÉÒÔÄõ½springÈÝÆ÷ +1)ApplicationContextAware表示å�¯ä»¥æ‹¿åˆ°spring容器 -2£©InitializingBean½Ó¿Ú£¬±í´ïÁ˳õʼ»¯µÄʱºò»á½øÐÐһЩ²Ù×÷ +2)InitializingBean接å�£ï¼Œè¡¨è¾¾äº†åˆ�始化的时候会进行一些æ“�作 -3£©AbstractAutoProxyCreator±íʾËü»á¶ÔspringÈÝÆ÷ÖеÄBean½øÐÐÇÐÃæÔöÇ¿£¬Ò²¾ÍÊÇÎÒÃÇÉÏÃæµÄÀ¹½ØÊÂÎñÔöÇ¿µÄ²Â²â¡£ +3)AbstractAutoProxyCreator表示它会对spring容器中的Bean进行切é�¢å¢žå¼ºï¼Œä¹Ÿå°±æ˜¯æˆ‘们上é�¢çš„æ‹¦æˆªäº‹åŠ¡å¢žå¼ºçš„çŒœæµ‹ã€‚ -4£©Disposable½Ó¿Ú£¬±í´ïÁËspringÈÝÆ÷Ïú»ÙµÄʱºò»á½øÐÐһЩ²Ù×÷ +4)Disposable接å�£ï¼Œè¡¨è¾¾äº†spring容器销æ¯�的时候会进行一些æ“�作 -ÕâÀïÎÒÃÇÉÔ΢¹Ø×¢Ò»ÏÂÕâ4¸öµÄÖ´ÐÐ˳Ðò£º +这里我们ç¨�微关注一下这4个的执行顺åº�: ApplicationContextAware -> InitializingBean -> AbstractAutoProxyCreator -> DisposableBean @@ -98,9 +98,9 @@ ApplicationContextAware -> InitializingBean -> AbstractAutoProxyCreator -> Dispo -³õʼ»¯SeataµÄClient¶ËµÄ¶«Î÷£¬Client¶ËÖ÷Òª°üÀ¨TransactionManagerºÍResourceManager¡£»òÐíÊÇΪÁ˼ò»¯°É£¬²¢Ã»ÓаÑinitClientÕâ¼þÊ´ÓGlobalTransactionScannerÀïÃæ¶ÀÁ¢³öÀ´Ò»¸öÀà¡£ +åˆ�始化Seataçš„Client端的东西,Client端主è¦�包括TransactionManagerå’ŒResourceManager。或许是为了简化å�§ï¼Œå¹¶æ²¡æœ‰æŠŠinitClient这件事从GlobalTransactionScanner里é�¢ç‹¬ç«‹å‡ºæ�¥ä¸€ä¸ªç±»ã€‚ -¸ú½øinitClient·½·¨ +è·Ÿè¿›initClient方法 @@ -116,9 +116,9 @@ private void initClient() { //init TM TMClient.init(applicationId, txServi -initClientÂß¼­²¢²»¸´ÔÓ£¬µ¥´¿µ÷ÓÃTMClient.init³õʼ»¯TransactionManagerµÄRPC¿Í»§¶Ë£¬RMClient.init³õʼ»¯ResourceManagerµÄRPC¿Í»§¶Ë¡£seataµÄRPC²ÉÓÃnettyÀ´ÊµÏÖ£¬seata·â×°¼ò»¯ÁËÒ»ÏÂʹÓᣲ¢×¢²áÁËÒ»¸öSpringµÄShutdownHook¹³×Óº¯Êý +initClient逻辑并ä¸�å¤�æ�‚,å�•纯调用TMClient.initåˆ�始化TransactionManagerçš„RPC客户端,RMClient.initåˆ�始化ResourceManagerçš„RPC客户端。seataçš„RPC采用nettyæ�¥å®žçŽ°ï¼Œseataå°�装简化了一下使用。并注册了一个Springçš„ShutdownHooké’©å­�函数 -**2.3.1 TMClient³õʼ»¯** +**2.3.1 TMClientåˆ�始化** @@ -134,8 +134,8 @@ initClient -Æô¶¯ÁËÒ»¸ö¶¨Ê±Æ÷²»¶Ï½øÐÐÖØÁ¬²Ù×÷£¬µ÷Óà -clientChannelManager.reconnect·½·¨½øÐÐÖØÁ¬ +å�¯åŠ¨äº†ä¸€ä¸ªå®šæ—¶å™¨ä¸�断进行é‡�连æ“�作,调用 +clientChannelManager.reconnect方法进行é‡�连 @@ -151,7 +151,7 @@ void reconnect(String transactionServiceGroup) { List availList = nul -¸ù¾ÝtransactionServiceGroup»ñÈ¡seata-serverµÄipµØÖ·ÁÐ±í£¬È»ºó½øÐÐÖØÁ¬ +æ ¹æ�®transactionServiceGroup获å�–seata-serverçš„ip地å�€åˆ—表,然å�Žè¿›è¡Œé‡�连 @@ -167,7 +167,7 @@ private List getAvailServerList(String transactionServiceGroup) throws E -RegistryFactory.getInstance().lookup(transactionServiceGroup);ÊǶԲ»Í¬×¢²áÖÐÐÄ×öÁËÊÊÅäµÄ£¬Ä¬ÈÏ¿´ÏÂNacosÐÎʽµÄʵÏÖ![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/745b802128d80980a6e082f91406451526cbb3.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")Ïȸù¾ÝÊÂÎñ·Ö×éÕÒµ½·Ö×éËùÊôµÄserver¼¯ÈºÃû³Æ£¬ÕâÀïÊÇdefault£¬È»ºó¸ù¾Ý¼¯ÈºÃû³ÆÕÒµ½server¶ÔÓ¦ip¶Ë¿ÚµØÖ· +RegistryFactory.getInstance().lookup(transactionServiceGroup);是对ä¸�å�Œæ³¨å†Œä¸­å¿ƒå�šäº†é€‚é…�的,默认看下Nacoså½¢å¼�的实现![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/745b802128d80980a6e082f91406451526cbb3.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")先根æ�®äº‹åŠ¡åˆ†ç»„æ‰¾åˆ°åˆ†ç»„æ‰€å±žçš„server集群å��称,这里是default,然å�Žæ ¹æ�®é›†ç¾¤å��称找到server对应ip端å�£åœ°å�€ @@ -183,7 +183,7 @@ RegistryFactory.getInstance().lookup(transactionServiceGroup); -Seata-serverµÄIPµØÖ·ÒÑ»ñÈ¡µ½,È»ºóµ÷ÓÃacquireChannel +Seata-serverçš„IP地å�€å·²èŽ·å�–到,ç„¶å�Žè°ƒç”¨acquireChannel @@ -199,20 +199,20 @@ Channel acquireChannel(String serverAddress) { Channel channelToServer = chan -×îºó½«»ñÈ¡µ½µÄseata-serverµÄIPµØÖ··Åµ½NettyÖзâ×°£¬TmClient¾Í³õʼ»¯Íê±Ï +最å�Žå°†èŽ·å�–到的seata-serverçš„IP地å�€æ”¾åˆ°Netty中å°�装,TmClientå°±åˆ�始化完毕 -TmClient³õʼ»¯×ܽ᣺ +TmClientåˆ�始化总结: -* Æô¶¯¶¨Ê±Æ÷£¬³¢ÊÔ½øÐÐÒ»´ÎÖØÁ¬seata-server -* ÖØÁ¬Ê±£¬ÏÈ´Ónacos£¨»òÔòÆäËûÅäÖã©Öиù¾Ý·Ö×éÃû³Æ(service_group)ÕÒµ½¼¯ÈºÃû³Æ(cluster_name) -* ÔÙ¸ù¾Ý¼¯ÈºÃû³ÆÕÒµ½¼¯Èºip¶Ë¿ÚÁбí -* ´ÓipÁбíÖÐÑ¡ÔñÒ»¸öÓÃnetty½øÐÐÁ¬½Ó - **2.3.2 RMClient³õʼ»¯** +* å�¯åŠ¨å®šæ—¶å™¨ï¼Œå°�试进行一次é‡�连seata-server +* é‡�连时,先从nacos(或则其他é…�置)中根æ�®åˆ†ç»„å��ç§°(service_group)找到集群å��ç§°(cluster_name) +* å†�æ ¹æ�®é›†ç¾¤å��称找到集群ip端å�£åˆ—表 +* 从ip列表中选择一个用netty进行连接 + **2.3.2 RMClientåˆ�始化** ``` -public static void init(String applicationId, String transactionServiceGroup) { // »ñÈ¡µ¥Àý¶ÔÏó RmRpcClient rmRpcClient = RmRpcClient.getInstance(applicationId, transactionServiceGroup); // ÉèÖÃResourceManagerµÄµ¥Àý¶ÔÏó rmRpcClient.setResourceManager(DefaultResourceManager.get()); // Ìí¼Ó¼àÌýÆ÷£¬¼àÌýServer¶ËµÄÏûÏ¢ÍÆËÍ rmRpcClient.setClientMessageListener(new RmMessageListener(DefaultRMHandler.get())); // ³õʼ»¯RPC rmRpcClient.init();} +public static void init(String applicationId, String transactionServiceGroup) { // 获å�–å�•例对象 RmRpcClient rmRpcClient = RmRpcClient.getInstance(applicationId, transactionServiceGroup); // 设置ResourceManagerçš„å�•例对象 rmRpcClient.setResourceManager(DefaultResourceManager.get()); // 添加监å�¬å™¨ï¼Œç›‘å�¬Server端的消æ�¯æŽ¨é€� rmRpcClient.setClientMessageListener(new RmMessageListener(DefaultRMHandler.get())); // åˆ�始化RPC rmRpcClient.init();} ``` @@ -223,11 +223,11 @@ public static void init(String applicationId, String transactionServiceGroup) { -ºÍTMClientÏë±È£¬RMClient¶à³öÁËÒ»¸ö¼àÌýServer¶ËÏûÏ¢²¢´¦ÀíµÄ»úÖÆ¡£Ò²¾ÍÊÇ˵TMµÄÖ°Ôð¸ü¶àµÄÊÇÖ÷¶¯ÓëServer¶ËͨÐÅ£¬±ÈÈ磺ȫ¾ÖÊÂÎñµÄbegin¡¢commit¡¢rollbackµÈ¡£ +å’ŒTMClient想比,RMClient多出了一个监å�¬Server端消æ�¯å¹¶å¤„ç�†çš„æœºåˆ¶ã€‚也就是说TMçš„è�Œè´£æ›´å¤šçš„æ˜¯ä¸»åŠ¨ä¸ŽServer端通信,比如:全局事务的beginã€�commitã€�rollback等。 -¶øRM³ýÁËÖ÷¶¯²Ù×÷±¾µØ×ÊÔ´Í⣬»¹»áÒòΪȫ¾ÖÊÂÎñµÄcommit¡¢rollbackµÈµÄÏûÏ¢ÍÆËÍ£¬´Ó¶ø¶Ô±¾µØ×ÊÔ´½øÐÐÏà¹Ø²Ù×÷¡£ +而RM除了主动æ“�作本地资æº�外,还会因为全局事务的commitã€�rollback等的消æ�¯æŽ¨é€�,从而对本地资æº�进行相关æ“�作。 -ÉèÖÃ×ÊÔ´¹ÜÀíÆ÷resourceManager£¬ÉèÖÃÏûÏ¢»Øµ÷¼àÌýÆ÷ÓÃÓÚ½ÓÊÕTCÔÚ¶þ½×¶Î·¢³öµÄÌá½»»òÕ߻عöÇëÇó£¬SeataÖжÔResourceManager£¬AbstractRMHandler×öÁËSPIÊÊÅ䣬ÒÔResouceManagerΪÀý£º +设置资æº�管ç�†å™¨resourceManager,设置消æ�¯å›žè°ƒç›‘å�¬å™¨ç”¨äºŽæŽ¥æ”¶TC在二阶段å�‘出的æ��交或者回滚请求,Seata中对ResourceManager,AbstractRMHandlerå�šäº†SPI适é…�,以ResouceManager为例: @@ -243,35 +243,35 @@ public class DefaultResourceManager implements ResourceManager { protected vo -¿ÉÒÔ¿´µ½³õʼ»¯DefaultResouceManagerʱ»áʹÓÃClassLoaderÈ¥¼ÓÔØ¶ÔÓ¦JarϵÄʵÏÖ£¬¶øÄ¬ÈÏATģʽʹÓõÄʵÏÖÊÇÊý¾Ý¿â£¬Ò²¾ÍÊÇrm-datasource°üϵÄʵÏÖ£¬ÕÒʵÏÖÀà·¾¶ÐèÒª¶¨Î»µ½/resources/META-INF/À©Õ¹½Ó¿Úȫ·¾¶È¥ÕÒ£¬¾Í»áÕÒµ½¶ÔÓ¦µÄʵÏÖÀà ![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/84399f558194f3dce18275c72cb9a92219db25.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨ÉÏ£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")ResourceManager¶ÔӦʵÏÖÀàȫ·¾¶ -io.seata.rm.datasource.DataSourceManager£¬¸ÃÀàÖÐÖ¸¶¨ÁËÁËÌá½»ºÍ»Ø¹öµÄ·½·¨£¬DefaultRMHandler¶ÔӦʵÏÖÀàȫ·¾¶io.seata.rm.RMHandlerAT£¬ÊǸö½ÓÊÕserverÏûÏ¢²¢×ö¶ÔÓ¦Ìá½»»òÕ߻عö²Ù×÷µÄ»Øµ÷´¦ÀíÀà¡£ +å�¯ä»¥çœ‹åˆ°åˆ�始化DefaultResouceManager时会使用ClassLoader去加载对应Jar下的实现,而默认AT模å¼�使用的实现是数æ�®åº“,也就是rm-datasource包下的实现,找实现类路径需è¦�定ä½�到/resources/META-INF/扩展接å�£å…¨è·¯å¾„去找,就会找到对应的实现类 ![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/84399f558194f3dce18275c72cb9a92219db25.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(上)-å¼€æº�基础软件社区")ResourceManager对应实现类全路径 +io.seata.rm.datasource.DataSourceManager,该类中指定了了æ��交和回滚的方法,DefaultRMHandler对应实现类全路径io.seata.rm.RMHandlerAT,是个接收server消æ�¯å¹¶å�šå¯¹åº”æ��交或者回滚æ“�作的回调处ç�†ç±»ã€‚ -RMClinetµÄinit()·½·¨ÓëTMClient»ù±¾Ò»Ö +RMClinetçš„init()方法与TMClient基本一致 -**2.3.3 ×ܽá** +**2.3.3 总结** -* SpringÆô¶¯Ê±£¬³õʼ»¯ÁË2¸ö¿Í»§¶ËTmClient¡¢RmClient -* TmClientÓëseata-serverͨ¹ýNetty½¨Á¢Á¬½Ó²¢·¢ËÍÏûÏ¢ -* RmClientÓëseata-serverͨ¹ýNetty½¨Á¢Á¬½Ó£¬¸ºÔð½ÓÊÕ¶þ½×¶ÎÌá½»¡¢»Ø¹öÏûÏ¢²¢Ôڻص÷Æ÷(RmHandler)ÖÐ×ö´¦Àí +* Springå�¯åŠ¨æ—¶ï¼Œåˆ�始化了2个客户端TmClientã€�RmClient +* TmClient与seata-server通过Netty建立连接并å�‘é€�消æ�¯ +* RmClient与seata-server通过Netty建立连接,负责接收二阶段æ��交ã€�回滚消æ�¯å¹¶åœ¨å›žè°ƒå™¨(RmHandler)中å�šå¤„ç�† -×÷Õß | Ò»ÆðߣJava -À´Ô´ |½ñÈÕÍ·Ìõ +作者 | 一起撸Java +æ�¥æº� |今日头æ�¡ **2.4 AbstractAutoProxyCreator** -GlobalTransactionScanner³õʼ»¯ÍêÁËTMºÍRMÒÔºó£¬ÎÒÃÇÔÙ¹Ø×¢Ò»ÏÂAbstractAutoProxyCreator£¬×Ô¶¯´úÀí¡£ +GlobalTransactionScanneråˆ�始化完了TMå’ŒRM以å�Žï¼Œæˆ‘们å†�关注一下AbstractAutoProxyCreator,自动代ç�†ã€‚ -×Ô¶¯´úÀí£¬Ëü´úÀíɶ¶«Î÷ÄØ£¿»òÕß˵Ëü¸øspringÖеÄBeanÔöÇ¿ÁËʲô¹¦ÄÜ£¿ +自动代ç�†ï¼Œå®ƒä»£ç�†å•¥ä¸œè¥¿å‘¢ï¼Ÿæˆ–者说它给spring中的Bean增强了什么功能? -GlobalTransactionScannerÖ÷ÒªÀ©Õ¹ÁËAbstractAutoProxyCreatorµÄwrapIfNecessary +GlobalTransactionScanner主è¦�扩展了AbstractAutoProxyCreatorçš„wrapIfNecessary -´úÀíÔöÇ¿µÄǰÖÃÅжϴ¦Àí£¬±íʾÊÇ·ñ¸ÃBeanÐèÒªÔöÇ¿£¬Èç¹ûÔöÇ¿µÄ»°´´½¨´úÀíÀà +代ç�†å¢žå¼ºçš„å‰�置判断处ç�†ï¼Œè¡¨ç¤ºæ˜¯å�¦è¯¥Bean需è¦�增强,如果增强的è¯�创建代ç�†ç±» **2.4.1 wrapIfNecessary** ``` -@Overrideprotected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) { if (disableGlobalTransaction) { return bean; } try { synchronized (PROXYED_SET) { // ÏàͬBeanÅÅÖØ if (PROXYED_SET.contains(beanName)) { return bean; } interceptor = null; // ÅжÏÊÇ·ñ¿ªÆôTCCģʽ if (TCCBeanParserUtils.isTccAutoProxy(bean, beanName, applicationContext)) { // TCCʵÏÖµÄÀ¹½ØÆ÷ interceptor = new TccActionInterceptor(TCCBeanParserUtils.getRemotingDesc(beanName)); } else { Class serviceInterface = SpringProxyUtils.findTargetClass(bean); Class[] interfacesIfJdk = SpringProxyUtils.findInterfaces(bean); // ÅжÏÊÇ·ñ´æÔÚ@GlobalTransactional»òÕß@GlobalLock×¢½â if (!existsAnnotation(new Class[]{serviceInterface}) && !existsAnnotation(interfacesIfJdk)) { return bean; } if (interceptor == null) { // ·ÇTCCµÄÀ¹½ØÆ÷ if (globalTransactionalInterceptor == null) { globalTransactionalInterceptor = new GlobalTransactionalInterceptor(failureHandlerHook); ConfigurationCache.addConfigListener( ConfigurationKeys.DISABLE_GLOBAL_TRANSACTION, (ConfigurationChangeListener)globalTransactionalInterceptor); } interceptor = globalTransactionalInterceptor; } } // Åжϵ±Ç°BeanÊÇ·ñÒѾ­ÊÇspringµÄ´úÀíÀàÁË if (!AopUtils.isAopProxy(bean)) { // Èç¹û»¹²»ÊÇ£¬ÄÇô×ßÒ»ÂÖspringµÄ´úÀí¹ý³Ì¼´¿É bean = super.wrapIfNecessary(bean, beanName, cacheKey); } else { // Èç¹ûÊÇÒ»¸öspringµÄ´úÀíÀ࣬ÄÇô·´Éä»ñÈ¡´úÀíÀàÖÐÒѾ­´æÔÚµÄÀ¹½ØÆ÷¼¯ºÏ£¬È»ºóÌí¼Óµ½¸Ã¼¯ºÏµ±ÖÐ AdvisedSupport advised = SpringProxyUtils.getAdvisedSupport(bean); Advisor[] advisor = buildAdvisors(beanName, getAdvicesAndAdvisorsForBean(null, null, null)); for (Advisor avr : advisor) { advised.addAdvisor(0, avr); } } PROXYED_SET.add(beanName); return bean; } } catch (Exception exx) {}} +@Overrideprotected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) { if (disableGlobalTransaction) { return bean; } try { synchronized (PROXYED_SET) { // 相å�ŒBean排é‡� if (PROXYED_SET.contains(beanName)) { return bean; } interceptor = null; // 判断是å�¦å¼€å�¯TCC模å¼� if (TCCBeanParserUtils.isTccAutoProxy(bean, beanName, applicationContext)) { // TCC实现的拦截器 interceptor = new TccActionInterceptor(TCCBeanParserUtils.getRemotingDesc(beanName)); } else { Class serviceInterface = SpringProxyUtils.findTargetClass(bean); Class[] interfacesIfJdk = SpringProxyUtils.findInterfaces(bean); // 判断是å�¦å­˜åœ¨@GlobalTransactional或者@GlobalLock注解 if (!existsAnnotation(new Class[]{serviceInterface}) && !existsAnnotation(interfacesIfJdk)) { return bean; } if (interceptor == null) { // é�žTCC的拦截器 if (globalTransactionalInterceptor == null) { globalTransactionalInterceptor = new GlobalTransactionalInterceptor(failureHandlerHook); ConfigurationCache.addConfigListener( ConfigurationKeys.DISABLE_GLOBAL_TRANSACTION, (ConfigurationChangeListener)globalTransactionalInterceptor); } interceptor = globalTransactionalInterceptor; } } // 判断当å‰�Bean是å�¦å·²ç»�是spring的代ç�†ç±»äº† if (!AopUtils.isAopProxy(bean)) { // 如果还ä¸�是,那么走一轮spring的代ç�†è¿‡ç¨‹å�³å�¯ bean = super.wrapIfNecessary(bean, beanName, cacheKey); } else { // 如果是一个spring的代ç�†ç±»ï¼Œé‚£ä¹ˆå��射获å�–代ç�†ç±»ä¸­å·²ç»�存在的拦截器集å�ˆï¼Œç„¶å�Žæ·»åŠ åˆ°è¯¥é›†å�ˆå½“中 AdvisedSupport advised = SpringProxyUtils.getAdvisedSupport(bean); Advisor[] advisor = buildAdvisors(beanName, getAdvicesAndAdvisorsForBean(null, null, null)); for (Advisor avr : advisor) { advised.addAdvisor(0, avr); } } PROXYED_SET.add(beanName); return bean; } } catch (Exception exx) {}} ``` @@ -282,25 +282,25 @@ GlobalTransactionScanner -wrapIfNecessary·½·¨½Ï³¤ÎÒÃÇ·Ö²½Öè¿´¿´ +wrapIfNecessary方法较长我们分步骤看看 -1£©isTccAutoProxyÅжÏÊÇ·ñ¿ªÆôtccģʽ£¬¿ªÆôµÄ»°Ñ¡ÔñÁËTccActionInterceptorÀ¹½ØÆ÷£¬·ÇtccģʽѡÔñ -GlobalTransactionalInterceptorÀ¹½ØÆ÷£¬Ä¬Èϲ»¿ªÆô +1)isTccAutoProxy判断是å�¦å¼€å�¯tcc模å¼�,开å�¯çš„è¯�选择了TccActionInterceptor拦截器,é�žtcc模å¼�选择 +GlobalTransactionalInterceptor拦截器,默认ä¸�å¼€å�¯ -2£©existAnnotationÅжϵ±Ç°BeanÊÇ·ñÓÐÀà»òÕ߽ӿڵķ½·¨´æÔÚ@GlobalTransactional»òÕß@GlobalLock×¢½â£¬Èç¹ûûÓÐÔòÖ±½Ó·µ»Ø +2)existAnnotation判断当å‰�Bean是å�¦æœ‰ç±»æˆ–者接å�£çš„æ–¹æ³•存在@GlobalTransactional或者@GlobalLock注解,如果没有则直接返回 -3£©isAopProxy·½·¨ÊÇÅжϵ±Ç°µÄBeanÊÇ·ñÒѾ­ÊÇspringµÄ´úÀíÀàÁË£¬ÎÞÂÛÊÇJDK¶¯Ì¬´úÀí»¹ÊÇCglibÀà´úÀí¡£Èç¹ûÊÇÆÕͨµÄBean£¬×ßÔ­ÓеÄÉú³É´úÀíÂß¼­¼´¿É£¬Èç¹ûÒѾ­ÊÇ´úÀíÀ࣬ÄÇôҪͨ¹ý·´Éä»ñÈ¡´úÀí¶ÔÏóÄÚµÄÀ¹½ØÆ÷¼¯ºÏÒ²½Ð×öAdvisor£¬Ö±½ÓÌí¼Óµ½¸Ã¼¯ºÏµ±ÖС£ +3)isAopProxy方法是判断当å‰�çš„Bean是å�¦å·²ç»�是spring的代ç�†ç±»äº†ï¼Œæ— è®ºæ˜¯JDK动æ€�代ç�†è¿˜æ˜¯Cglib类代ç�†ã€‚如果是普通的Bean,走原有的生æˆ�代ç�†é€»è¾‘å�³å�¯ï¼Œå¦‚果已ç»�是代ç�†ç±»ï¼Œé‚£ä¹ˆè¦�通过å��射获å�–代ç�†å¯¹è±¡å†…的拦截器集å�ˆä¹Ÿå�«å�šAdvisor,直接添加到该集å�ˆå½“中。 -wrapIfNecessaryµÄ·½·¨²¢²»¸´ÔÓ£¬µ«ÊÇÈç¹û¶Ô´úÀí²»ÊǺÜÊìϤ»òÐí¶Ôϸ½Úµã»áÓÐЩÀ§»ó¡£ +wrapIfNecessary的方法并ä¸�å¤�æ�‚,但是如果对代ç�†ä¸�是很熟悉或许对细节点会有些困惑。 -**2.4.1.1 ATÒ»½×¶Î¿ªÆôÈ«¾ÖÊÂÎñ** -ÔÚÐèÒª½øÐÐÈ«¾ÖÊÂÎñ¹ÜÀíµÄ½Ó¿ÚÉÏ£¬»á¼Ó@GlobalTransactional×¢½â£¬Õâ¸ö×¢½â»áÓÖÒ»¸ö¶ÔÓ¦µÄÀ¹½ØÆ÷½øÐÐÀ¹½Ø -GlobalTransactionalInterceptor£¬invoke¾ÍÊÇÀ¹½Ø·½·¨ +**2.4.1.1 AT一阶段开å�¯å…¨å±€äº‹åŠ¡** +在需è¦�进行全局事务管ç�†çš„æŽ¥å�£ä¸Šï¼Œä¼šåŠ @GlobalTransactional注解,这个注解会å�ˆä¸€ä¸ªå¯¹åº”的拦截器进行拦截 +GlobalTransactionalInterceptor,invoke就是拦截方法 ``` -@Overridepublic Object invoke(final MethodInvocation methodInvocation) throws Throwable { Class targetClass = methodInvocation.getThis() != null ? AopUtils.getTargetClass(methodInvocation.getThis()) : null; Method specificMethod = ClassUtils.getMostSpecificMethod(methodInvocation.getMethod(), targetClass); if (specificMethod != null && !specificMethod.getDeclaringClass().equals(Object.class)) { final Method method = BridgeMethodResolver.findBridgedMethod(specificMethod); //»ñÈ¡·½·¨ÉϵÄÈ«¾ÖÊÂÎñ×¢½â final GlobalTransactional globalTransactionalAnnotation = getAnnotation(method, targetClass, GlobalTransactional.class); //»ñÈ¡·½·¨ÉϵÄÈ«¾ÖËø×¢½â final GlobalLock globalLockAnnotation = getAnnotation(method, targetClass, GlobalLock.class); boolean localDisable = disable || (degradeCheck && degradeNum >= degradeCheckAllowTimes); if (!localDisable) { //Èç¹û·½·¨ÉÏÓÐÈ«¾ÖÊÂÎñ×¢½â£¬µ÷ÓÃhandleGlobalTransaction¿ªÆôÈ«¾ÖÊÂÎñ if (globalTransactionalAnnotation != null) { return handleGlobalTransaction(methodInvocation, globalTransactionalAnnotation); //Èç¹û·½·¨ÉÏÓÐÈ«¾ÖËø×¢½â£¬µ÷ÓÃhandleGlobalLock¿ªÆôÈ«¾ÖËø } else if (globalLockAnnotation != null) { return handleGlobalLock(methodInvocation); } } } //Èç¹ûɶ¶¼Ã»ÓУ¬°´ÆÕͨ·½·¨Ö´ÐУ¬ÌáÉýÐÔÄÜ return methodInvocation.proceed();} +@Overridepublic Object invoke(final MethodInvocation methodInvocation) throws Throwable { Class targetClass = methodInvocation.getThis() != null ? AopUtils.getTargetClass(methodInvocation.getThis()) : null; Method specificMethod = ClassUtils.getMostSpecificMethod(methodInvocation.getMethod(), targetClass); if (specificMethod != null && !specificMethod.getDeclaringClass().equals(Object.class)) { final Method method = BridgeMethodResolver.findBridgedMethod(specificMethod); //获å�–方法上的全局事务注解 final GlobalTransactional globalTransactionalAnnotation = getAnnotation(method, targetClass, GlobalTransactional.class); //获å�–方法上的全局é”�注解 final GlobalLock globalLockAnnotation = getAnnotation(method, targetClass, GlobalLock.class); boolean localDisable = disable || (degradeCheck && degradeNum >= degradeCheckAllowTimes); if (!localDisable) { //如果方法上有全局事务注解,调用handleGlobalTransactionå¼€å�¯å…¨å±€äº‹åŠ¡ if (globalTransactionalAnnotation != null) { return handleGlobalTransaction(methodInvocation, globalTransactionalAnnotation); //如果方法上有全局é”�注解,调用handleGlobalLockå¼€å�¯å…¨å±€é”� } else if (globalLockAnnotation != null) { return handleGlobalLock(methodInvocation); } } } //如果啥都没有,按普通方法执行,æ��å�‡æ€§èƒ½ return methodInvocation.proceed();} ``` @@ -311,13 +311,13 @@ GlobalTransactionalInterceptor -ÔÚhandleGlobalTransaction·½·¨Öе÷ÓÃÁË -transactionalTemplate.execute·½·¨ +在handleGlobalTransaction方法中调用了 +transactionalTemplate.execute方法 ``` -// 2\. ¿ªÆôÈ«¾ÖÊÂÎñbeginTransactionbeginTransaction(txInfo, tx); Object rs = null;try { // Ö´ÐÐÒµÎñ·½·¨business.execute() rs = business.execute(); } catch (Throwable ex) { // 3.³öÏÖÒì³£Ö´ÐÐcompleteTransactionAfterThrowing»Ø¹ö completeTransactionAfterThrowing(txInfo, tx, ex); throw ex;} // 4\. ûÓÐÒì³£Ìá½»ÊÂÎñcommitTransactioncommitTransaction(tx); +// 2\. å¼€å�¯å…¨å±€äº‹åŠ¡beginTransactionbeginTransaction(txInfo, tx); Object rs = null;try { // 执行业务方法business.execute() rs = business.execute(); } catch (Throwable ex) { // 3.出现异常执行completeTransactionAfterThrowing回滚 completeTransactionAfterThrowing(txInfo, tx, ex); throw ex;} // 4\. 没有异常æ��交事务commitTransactioncommitTransaction(tx); ``` @@ -328,13 +328,13 @@ transactionalTemplate.execute -¿ªÆôÈ«¾ÖÊÂÎñ×îÖÕµ÷Óà -io.seata.tm.api.DefaultGlobalTransaction#begin(int, java.lang.String)·½·¨ +å¼€å�¯å…¨å±€äº‹åŠ¡æœ€ç»ˆè°ƒç”¨ +io.seata.tm.api.DefaultGlobalTransaction#begin(int, java.lang.String)方法 ``` -@Overridepublic void begin(int timeout, String name) throws TransactionException { //´Ë´¦µÄ½ÇÉ«ÅжÏÓйؼüµÄ×÷ÓÃ//±íÃ÷µ±Ç°ÊÇÈ«¾ÖÊÂÎñµÄ·¢ÆðÕߣ¨Launcher£©»¹ÊDzÎÓëÕߣ¨Participant£©//Èç¹ûÔÚ·Ö²¼Ê½ÊÂÎñµÄÏÂÓÎϵͳ·½·¨ÖÐÒ²¼ÓÉÏGlobalTransactional×¢½â//ÄÇôËüµÄ½ÇÉ«¾ÍÊÇParticipant£¬¼´»áºöÂÔºóÃæµÄbegin¾ÍÍ˳öÁË //¶øÅжÏÊÇ·¢ÆðÕߣ¨Launcher£©»¹ÊDzÎÓëÕߣ¨Participant£©ÊǸù¾Ýµ±Ç°ÉÏÏÂÎÄÊÇ·ñÒÑ´æÔÚXIDÀ´ÅÐ¶Ï //ûÓÐXIDµÄ¾ÍÊÇLauncher£¬ÒѾ­´æÔÚXIDµÄ¾ÍÊÇParticipant if (role != GlobalTransactionRole.Launcher) { assertXIDNotNull(); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Ignore Begin(): just involved in global transaction [{}]", xid); } return; } assertXIDNull(); if (RootContext.getXID() != null) { throw new IllegalStateException(); } xid = transactionManager.begin(null, null, name, timeout); status = GlobalStatus.Begin; RootContext.bind(xid); if (LOGGER.isInfoEnabled()) { LOGGER.info("Begin new global transaction [{}]", xid); } } +@Overridepublic void begin(int timeout, String name) throws TransactionException { //此处的角色判断有关键的作用//表明当å‰�是全局事务的å�‘起者(Launcher)还是å�‚与者(Participant)//如果在分布å¼�事务的下游系统方法中也加上GlobalTransactional注解//那么它的角色就是Participant,å�³ä¼šå¿½ç•¥å�Žé�¢çš„begin就退出了 //而判断是å�‘起者(Launcher)还是å�‚与者(Participant)是根æ�®å½“å‰�上下文是å�¦å·²å­˜åœ¨XIDæ�¥åˆ¤æ–­ //没有XID的就是Launcher,已ç»�存在XID的就是Participant if (role != GlobalTransactionRole.Launcher) { assertXIDNotNull(); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Ignore Begin(): just involved in global transaction [{}]", xid); } return; } assertXIDNull(); if (RootContext.getXID() != null) { throw new IllegalStateException(); } xid = transactionManager.begin(null, null, name, timeout); status = GlobalStatus.Begin; RootContext.bind(xid); if (LOGGER.isInfoEnabled()) { LOGGER.info("Begin new global transaction [{}]", xid); } } ``` @@ -345,13 +345,13 @@ io.seata.tm.api.DefaultGlobalTransaction#begin(int, java.lang.String) -ÇëÇóseata-server»ñȡȫ¾ÖÊÂÎñXID +请求seata-server获å�–全局事务XID ``` -@Overridepublic String begin(String applicationId, String transactionServiceGroup, String name, int timeout) throws TransactionException { GlobalBeginRequest request = new GlobalBeginRequest(); request.setTransactionName(name); request.setTimeout(timeout); //¸ú½ø GlobalBeginResponse response = (GlobalBeginResponse) syncCall(request); if (response.getResultCode() == ResultCode.Failed) { throw new TmTransactionException(TransactionExceptionCode.BeginFailed, response.getMsg()); } return response.getXid();} -private AbstractTransactionResponse syncCall(AbstractTransactionRequest request) throws TransactionException { try { //TMClient·â×°µÄNetty¶ÔÏó return (AbstractTransactionResponse) TmNettyRemotingClient.getInstance().sendSyncRequest(request); } catch (TimeoutException toe) { throw new TmTransactionException(TransactionExceptionCode.IO, "RPC timeout", toe); }} +@Overridepublic String begin(String applicationId, String transactionServiceGroup, String name, int timeout) throws TransactionException { GlobalBeginRequest request = new GlobalBeginRequest(); request.setTransactionName(name); request.setTimeout(timeout); //è·Ÿè¿› GlobalBeginResponse response = (GlobalBeginResponse) syncCall(request); if (response.getResultCode() == ResultCode.Failed) { throw new TmTransactionException(TransactionExceptionCode.BeginFailed, response.getMsg()); } return response.getXid();} +private AbstractTransactionResponse syncCall(AbstractTransactionRequest request) throws TransactionException { try { //TMClientå°�装的Netty对象 return (AbstractTransactionResponse) TmNettyRemotingClient.getInstance().sendSyncRequest(request); } catch (TimeoutException toe) { throw new TmTransactionException(TransactionExceptionCode.IO, "RPC timeout", toe); }} ``` @@ -362,12 +362,12 @@ private AbstractTransactionResponse syncCall(AbstractTransactionRequest request) -½«XID°ó¶¨ÔÚRootContextÖУ¬ÓÉ´Ë¿ÉÒÔ¿´³öÈ«¾ÖÊÂÎñÊÇÓÉTM·¢ÆðµÄ£¬TM·¢ÆðÈ«¾ÖÊÂÎñÇëÇó¸øseata-server·þÎñ£¬seata-server·þÎñ½ÓÊܵ½ÇëÇóºó´¦Àí£¨ÒÔÏÂÊÇseata·þÎñ´úÂ룩£º +å°†XID绑定在RootContext中,由此å�¯ä»¥çœ‹å‡ºå…¨å±€äº‹åŠ¡æ˜¯ç”±TMå�‘起的,TMå�‘起全局事务请求给seata-serveræœ�务,seata-serveræœ�务接å�—到请求å�Žå¤„ç�†ï¼ˆä»¥ä¸‹æ˜¯seataæœ�务代ç �): ``` -@Overrideprotected void doGlobalBegin(GlobalBeginRequest request, GlobalBeginResponse response, RpcContext rpcContext) throws TransactionException { //½øÈëbegin response.setXid(core.begin(rpcContext.getApplicationId(), rpcContext.getTransactionServiceGroup(), request.getTransactionName(), request.getTimeout())); if (LOGGER.isInfoEnabled()) { LOGGER.info("Begin new global transaction applicationId: {},transactionServiceGroup: {}, transactionName: {},timeout:{},xid:{}", rpcContext.getApplicationId(), rpcContext.getTransactionServiceGroup(), request.getTransactionName(), request.getTimeout(), response.getXid()); }} +@Overrideprotected void doGlobalBegin(GlobalBeginRequest request, GlobalBeginResponse response, RpcContext rpcContext) throws TransactionException { //进入begin response.setXid(core.begin(rpcContext.getApplicationId(), rpcContext.getTransactionServiceGroup(), request.getTransactionName(), request.getTimeout())); if (LOGGER.isInfoEnabled()) { LOGGER.info("Begin new global transaction applicationId: {},transactionServiceGroup: {}, transactionName: {},timeout:{},xid:{}", rpcContext.getApplicationId(), rpcContext.getTransactionServiceGroup(), request.getTransactionName(), request.getTimeout(), response.getXid()); }} ``` @@ -378,12 +378,12 @@ private AbstractTransactionResponse syncCall(AbstractTransactionRequest request) -io.seata.server.coordinator.DefaultCoordinator#doGlobalBegin·½·¨½ÓÊܿͻ§¶Ë¿ªÆôÈ«¾ÖÊÂÎñµÄÇëÇ󣬵÷ÓÃio.seata.server.coordinator.DefaultCore#begin¿ªÆôÈ«¾ÖÊÂÎñ +io.seata.server.coordinator.DefaultCoordinator#doGlobalBegin方法接å�—客户端开å�¯å…¨å±€äº‹åŠ¡çš„è¯·æ±‚ï¼Œè°ƒç”¨io.seata.server.coordinator.DefaultCore#beginå¼€å�¯å…¨å±€äº‹åŠ¡ ``` -@Overridepublic String begin(String applicationId, String transactionServiceGroup, String name, int timeout) throws TransactionException { GlobalSession session = GlobalSession.createGlobalSession(applicationId, transactionServiceGroup, name, timeout); MDC.put(RootContext.MDC_KEY_XID, session.getXid()); session.addSessionLifecycleListener(SessionHolder.getRootSessionManager());//¿ªÆô»á»° session.begin(); // transaction start event eventBus.post(new GlobalTransactionEvent(session.getTransactionId(), GlobalTransactionEvent.ROLE_TC, session.getTransactionName(), applicationId, transactionServiceGroup, session.getBeginTime(), null, session.getStatus())); return session.getXid();} +@Overridepublic String begin(String applicationId, String transactionServiceGroup, String name, int timeout) throws TransactionException { GlobalSession session = GlobalSession.createGlobalSession(applicationId, transactionServiceGroup, name, timeout); MDC.put(RootContext.MDC_KEY_XID, session.getXid()); session.addSessionLifecycleListener(SessionHolder.getRootSessionManager());//å¼€å�¯ä¼šè¯� session.begin(); // transaction start event eventBus.post(new GlobalTransactionEvent(session.getTransactionId(), GlobalTransactionEvent.ROLE_TC, session.getTransactionName(), applicationId, transactionServiceGroup, session.getBeginTime(), null, session.getStatus())); return session.getXid();} ``` @@ -394,7 +394,7 @@ io.seata.server.coordinator.DefaultCoordinator#doGlobalBegin -ͨ¹ýµ±Ç°»á»°¿ªÆô +通过当å‰�会è¯�å¼€å�¯ @@ -410,15 +410,15 @@ io.seata.server.coordinator.DefaultCoordinator#doGlobalBegin -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e7c784186f75581eba83325a0fc4708602dadf.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø") +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e7c784186f75581eba83325a0fc4708602dadf.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区") -µ÷Óà -io.seata.server.session.AbstractSessionManager#onBegin·½·¨£¬ÓÖµ÷ÓÃio.seata.server.storage.db.session.DataBaseSessionManager#addGlobalSession·½·¨ +调用 +io.seata.server.session.AbstractSessionManager#onBegin方法,å�ˆè°ƒç”¨io.seata.server.storage.db.session.DataBaseSessionManager#addGlobalSession方法 ``` -@Overridepublic void addGlobalSession(GlobalSession session) throws TransactionException { if (StringUtils.isBlank(taskName)) { //½øÈë boolean ret = transactionStoreManager.writeSession(LogOperation.GLOBAL_ADD, session); if (!ret) { throw new StoreException("addGlobalSession failed."); } } else { boolean ret = transactionStoreManager.writeSession(LogOperation.GLOBAL_UPDATE, session); if (!ret) { throw new StoreException("addGlobalSession failed."); } }} +@Overridepublic void addGlobalSession(GlobalSession session) throws TransactionException { if (StringUtils.isBlank(taskName)) { //进入 boolean ret = transactionStoreManager.writeSession(LogOperation.GLOBAL_ADD, session); if (!ret) { throw new StoreException("addGlobalSession failed."); } } else { boolean ret = transactionStoreManager.writeSession(LogOperation.GLOBAL_UPDATE, session); if (!ret) { throw new StoreException("addGlobalSession failed."); } }} ``` @@ -429,7 +429,7 @@ io.seata.server.session.AbstractSessionManager#onBegin -ÕâÀïÍùÊý¾Ý¿âÀïдÈëÊý¾Ý +这里往数æ�®åº“里写入数æ�® @@ -445,15 +445,15 @@ io.seata.server.session.AbstractSessionManager#onBegin -ÕâÀïÏòseata¿âglobal_tab²åÈëÊý¾Ý£¬µ½´ËÈ«¾ÖÊÂÎñÒÑ¿ªÆô +这里å�‘seata库global_tabæ�’入数æ�®ï¼Œåˆ°æ­¤å…¨å±€äº‹åС已开å�¯ -**2.4.1.2 ATÒ»½×¶ÎÖ´ÐÐÒµÎñSQL** -È«¾ÖÊÂÎñÒÑ¿ªÆô£¬ÏÂÃæÐèÒªÖ´ÐÐÒµÎñSQL£¬Éú³Éundo_logÊý¾Ý£¬È«¾ÖÊÂÎñÀ¹½Ø³É¹¦ºó×îÖÕ»¹ÊÇÖ´ÐÐÁËÒµÎñ·½·¨µÄ£¬µ«ÊÇÓÉÓÚSeata¶ÔÊý¾ÝÔ´×öÁË´úÀí£¬ËùÒÔsql½âÎöÓëundo_logÈë¿â²Ù×÷ÊÇÔÚÊý¾ÝÔ´´úÀíÖÐÖ´Ðе쬴úÀí¾ÍÊÇSeata¶ÔDataSource£¬Connection£¬Statement×öµÄ´úÀí·â×°Àà +**2.4.1.2 AT一阶段执行业务SQL** +全局事务已开å�¯ï¼Œä¸‹é�¢éœ€è¦�执行业务SQL,生æˆ�undo_logæ•°æ�®ï¼Œå…¨å±€äº‹åŠ¡æ‹¦æˆªæˆ�功å�Žæœ€ç»ˆè¿˜æ˜¯æ‰§è¡Œäº†ä¸šåŠ¡æ–¹æ³•çš„ï¼Œä½†æ˜¯ç”±äºŽSeata对数æ�®æº�å�šäº†ä»£ç�†ï¼Œæ‰€ä»¥sqlè§£æž�与undo_log入库æ“�作是在数æ�®æº�代ç�†ä¸­æ‰§è¡Œçš„,代ç�†å°±æ˜¯Seata对DataSource,Connection,Statementå�šçš„代ç�†å°�装类 ``` -/*** ¹¹Ôìdatasource´úÀí¶ÔÏó£¬Ìæ»»Ô­À´µÄµÄdatasource*/@Primary@Bean("dataSource")public DataSourceProxy dataSourceProxy(DataSource druidDataSource){ return new DataSourceProxy(druidDataSource);} +/*** 构造datasource代ç�†å¯¹è±¡ï¼Œæ›¿æ�¢åŽŸæ�¥çš„çš„datasource*/@Primary@Bean("dataSource")public DataSourceProxy dataSourceProxy(DataSource druidDataSource){ return new DataSourceProxy(druidDataSource);} ``` @@ -464,7 +464,7 @@ io.seata.server.session.AbstractSessionManager#onBegin -ÏîÄ¿ÖÐʹÓõÄÊý¾ÝÔ´¾ùÓÃseataµÄDataSourceProxy´úÌæ![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c8a7a189816e282015a950bfd3c13b7d859974.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")×îÖÕ¶ÔSql½øÐнâÎö²Ù×÷£¬·¢ÉúÔÚStatementProxyÀàÖÐ +项目中使用的数æ�®æº�å�‡ç”¨seataçš„DataSourceProxy代替![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c8a7a189816e282015a950bfd3c13b7d859974.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")最终对Sql进行解æž�æ“�作,å�‘生在StatementProxy类中 @@ -483,7 +483,7 @@ io.seata.server.session.AbstractSessionManager#onBegin ``` -public static T execute(List sqlRecognizers, StatementProxy statementProxy, StatementCallback statementCallback, Object... args) throws SQLException { if (!RootContext.requireGlobalLock() && !StringUtils.equals(BranchType.AT.name(), RootContext.getBranchType())) { //²»ÊÇÈ«¾ÖÊÂÎñµÄÖ±½ÓÖ´ÐУ¬ÌáÉýÐÔÄÜ return statementCallback.execute(statementProxy.getTargetStatement(), args); } String dbType = statementProxy.getConnectionProxy().getDbType(); if (CollectionUtils.isEmpty(sqlRecognizers)) { sqlRecognizers = SQLVisitorFactory.get( statementProxy.getTargetSQL(), dbType); } Executor executor; if (CollectionUtils.isEmpty(sqlRecognizers)) { executor = new PlainExecutor<>(statementProxy, statementCallback); } else { if (sqlRecognizers.size() == 1) { SQLRecognizer sqlRecognizer = sqlRecognizers.get(0); //²»Í¬SQLÀàÐÍ£¬²»Í¬´¦Àí switch (sqlRecognizer.getSQLType()) { case INSERT: executor = EnhancedServiceLoader.load(InsertExecutor.class, dbType, new Class[]{StatementProxy.class, StatementCallback.class, SQLRecognizer.class}, new Object[]{statementProxy, statementCallback, sqlRecognizer}); break; case UPDATE: executor = new UpdateExecutor<>(statementProxy, statementCallback, sqlRecognizer); break; case DELETE: executor = new DeleteExecutor<>(statementProxy, statementCallback, sqlRecognizer); break; case SELECT_FOR_UPDATE: executor = new SelectForUpdateExecutor<>(statementProxy, statementCallback, sqlRecognizer); break; default: executor = new PlainExecutor<>(statementProxy, statementCallback); break; } } else { executor = new MultiExecutor<>(statementProxy, statementCallback, sqlRecognizers); } } T rs; try { //Ö´ÐÐSQL rs = executor.execute(args); } catch (Throwable ex) { if (!(ex instanceof SQLException)) { // Turn other exception into SQLException ex = new SQLException(ex); } throw (SQLException) ex; } return rs; } +public static T execute(List sqlRecognizers, StatementProxy statementProxy, StatementCallback statementCallback, Object... args) throws SQLException { if (!RootContext.requireGlobalLock() && !StringUtils.equals(BranchType.AT.name(), RootContext.getBranchType())) { //ä¸�是全局事务的直接执行,æ��å�‡æ€§èƒ½ return statementCallback.execute(statementProxy.getTargetStatement(), args); } String dbType = statementProxy.getConnectionProxy().getDbType(); if (CollectionUtils.isEmpty(sqlRecognizers)) { sqlRecognizers = SQLVisitorFactory.get( statementProxy.getTargetSQL(), dbType); } Executor executor; if (CollectionUtils.isEmpty(sqlRecognizers)) { executor = new PlainExecutor<>(statementProxy, statementCallback); } else { if (sqlRecognizers.size() == 1) { SQLRecognizer sqlRecognizer = sqlRecognizers.get(0); //ä¸�å�ŒSQL类型,ä¸�å�Œå¤„ç�† switch (sqlRecognizer.getSQLType()) { case INSERT: executor = EnhancedServiceLoader.load(InsertExecutor.class, dbType, new Class[]{StatementProxy.class, StatementCallback.class, SQLRecognizer.class}, new Object[]{statementProxy, statementCallback, sqlRecognizer}); break; case UPDATE: executor = new UpdateExecutor<>(statementProxy, statementCallback, sqlRecognizer); break; case DELETE: executor = new DeleteExecutor<>(statementProxy, statementCallback, sqlRecognizer); break; case SELECT_FOR_UPDATE: executor = new SelectForUpdateExecutor<>(statementProxy, statementCallback, sqlRecognizer); break; default: executor = new PlainExecutor<>(statementProxy, statementCallback); break; } } else { executor = new MultiExecutor<>(statementProxy, statementCallback, sqlRecognizers); } } T rs; try { //执行SQL rs = executor.execute(args); } catch (Throwable ex) { if (!(ex instanceof SQLException)) { // Turn other exception into SQLException ex = new SQLException(ex); } throw (SQLException) ex; } return rs; } ``` @@ -494,14 +494,14 @@ public static T execute(List sqlRecogniz -* ÏÈÅжÏÊÇ·ñ¿ªÆôÁËÈ«¾ÖÊÂÎñ£¬Èç¹ûûÓУ¬²»×ß´úÀí£¬²»½âÎösql£¬ÌáÉýÐÔÄÜ -* µ÷ÓÃSQLVisitorFactory¶ÔÄ¿±êsql½øÐнâÎö -* Õë¶ÔÌØ¶¨ÀàÐÍsql²Ù×÷(INSERT,UPDATE,DELETE,SELECT_FOR_UPDATE)µÈ½øÐÐÌØÊâ½âÎö -* Ö´ÐÐsql²¢·µ»Ø½á¹û - ²»Í¬ÀàÐ͵ÄSQL´¦Àí·½·¨²»Ò»Ñù£¬ÕâÀïÒÔinsertΪÀý +* 先判断是å�¦å¼€å�¯äº†å…¨å±€äº‹åŠ¡ï¼Œå¦‚æžœæ²¡æœ‰ï¼Œä¸�走代ç�†ï¼Œä¸�è§£æž�sql,æ��å�‡æ€§èƒ½ +* 调用SQLVisitorFactory对目标sql进行解æž� +* 针对特定类型sqlæ“�作(INSERT,UPDATE,DELETE,SELECT_FOR_UPDATE)等进行特殊解æž� +* 执行sql并返回结果 + ä¸�å�Œç±»åž‹çš„SQL处ç�†æ–¹æ³•ä¸�一样,这里以insert为例 -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b1eb1b610beb647b230995f19ecbb4bbc98602.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")insertʹÓõÄÊÇInsertExecutor.execute·½·¨£¬µ«Æäʵ×îÖÕ»¹ÊÇʹÓà -io.seata.rm.datasource.exec.BaseTransactionalExecutor#execute·½·¨ +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b1eb1b610beb647b230995f19ecbb4bbc98602.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")insert使用的是InsertExecutor.execute方法,但其实最终还是使用 +io.seata.rm.datasource.exec.BaseTransactionalExecutor#execute方法 @@ -517,7 +517,7 @@ io.seata.rm.datasource.exec.BaseTransactionalExecutor#execute -½«ÉÏÏÂÎÄÖеÄxid°ó¶¨µ½ÁËstatementProxyÖУ¬²¢µ÷ÓÃÁËdoExecute·½·¨£¬¿´ÏÂAbstractDMLBaseExecutorÖеÄdoExecute·½·¨ +将上下文中的xid绑定到了statementProxy中,并调用了doExecute方法,看下AbstractDMLBaseExecutor中的doExecute方法 @@ -533,7 +533,7 @@ io.seata.rm.datasource.exec.BaseTransactionalExecutor#execute -·½·¨Öе÷ÓÃÁË +方法中调用了 executeAutoCommitTrue/executeAutoCommitFalse @@ -550,12 +550,12 @@ protected T executeAutoCommitTrue(Object[] args) throws Throwable { Connectio -µ«×Ðϸ·¢ÏÖ£¬×îÖÕ¶¼Êǵ÷ÓÃexecuteAutoCommitFalse·½·¨ +但仔细å�‘现,最终都是调用executeAutoCommitFalse方法 ``` -protected T executeAutoCommitFalse(Object[] args) throws Exception { //¸úÈëgetTableMeta·½·¨ if (!JdbcConstants.MYSQL.equalsIgnoreCase(getDbType()) && getTableMeta().getPrimaryKeyOnlyName().size() > 1) { throw new NotSupportYetException("multi pk only support mysql!"); } //»ñÈ¡beforeImage TableRecords beforeImage = beforeImage(); //Ö´ÐÐÒµÎñsql T result = statementCallback.execute(statementProxy.getTargetStatement(), args); //»ñÈ¡afterImage TableRecords afterImage = afterImage(beforeImage); //±£´æimage prepareUndoLog(beforeImage, afterImage); return result;} +protected T executeAutoCommitFalse(Object[] args) throws Exception { //è·Ÿå…¥getTableMeta方法 if (!JdbcConstants.MYSQL.equalsIgnoreCase(getDbType()) && getTableMeta().getPrimaryKeyOnlyName().size() > 1) { throw new NotSupportYetException("multi pk only support mysql!"); } //获å�–beforeImage TableRecords beforeImage = beforeImage(); //执行业务sql T result = statementCallback.execute(statementProxy.getTargetStatement(), args); //获å�–afterImage TableRecords afterImage = afterImage(beforeImage); //ä¿�å­˜image prepareUndoLog(beforeImage, afterImage); return result;} ``` @@ -566,12 +566,12 @@ protected T executeAutoCommitFalse(Object[] args) throws Exception { // -»ñÈ¡beforeImage +获å�–beforeImage ``` -//tableMetaÀïÃæ°üº¬±íÃû¡¢ÁС¢Ë÷ÒýµÈÊý¾Ýprotected TableMeta getTableMeta(String tableName) { if (tableMeta != null) { return tableMeta; } ConnectionProxy connectionProxy = statementProxy.getConnectionProxy(); tableMeta = TableMetaCacheFactory.getTableMetaCache(connectionProxy.getDbType()) .getTableMeta(connectionProxy.getTargetConnection(), tableName, connectionProxy.getDataSourceProxy().getResourceId()); return tableMeta;} +//tableMeta里é�¢åŒ…å�«è¡¨å��ã€�列ã€�索引等数æ�®protected TableMeta getTableMeta(String tableName) { if (tableMeta != null) { return tableMeta; } ConnectionProxy connectionProxy = statementProxy.getConnectionProxy(); tableMeta = TableMetaCacheFactory.getTableMetaCache(connectionProxy.getDbType()) .getTableMeta(connectionProxy.getTargetConnection(), tableName, connectionProxy.getDataSourceProxy().getResourceId()); return tableMeta;} ``` @@ -582,15 +582,15 @@ protected T executeAutoCommitFalse(Object[] args) throws Exception { // -Ö´ÐÐÒµÎñsql»¹ÊÇʹÓà -com.alibaba.druid.pool.DruidPooledPreparedStatement#execute·½·¨Ö´ÐÐ +执行业务sql还是使用 +com.alibaba.druid.pool.DruidPooledPreparedStatement#execute方法执行 -»ñÈ¡afterImage![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/540ff5c254dde029bed208247025e97bd1f497.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÔÚÌá½»ÊÂÎñʱ£¬²åÈëundo_logÈÕÖ¾ +获å�–afterImage![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/540ff5c254dde029bed208247025e97bd1f497.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")在æ��交事务时,æ�’å…¥undo_log日志 ``` -protected T executeAutoCommitTrue(Object[] args) throws Throwable { ConnectionProxy connectionProxy = statementProxy.getConnectionProxy(); try { connectionProxy.setAutoCommit(false); return new LockRetryPolicy(connectionProxy).execute(() -> { T result = executeAutoCommitFalse(args); //¸úÈë connectionProxy.commit(); return result; }); } catch (Exception e) { ... } finally { connectionProxy.getContext().reset(); connectionProxy.setAutoCommit(true); }} +protected T executeAutoCommitTrue(Object[] args) throws Throwable { ConnectionProxy connectionProxy = statementProxy.getConnectionProxy(); try { connectionProxy.setAutoCommit(false); return new LockRetryPolicy(connectionProxy).execute(() -> { T result = executeAutoCommitFalse(args); //è·Ÿå…¥ connectionProxy.commit(); return result; }); } catch (Exception e) { ... } finally { connectionProxy.getContext().reset(); connectionProxy.setAutoCommit(true); }} ``` @@ -604,7 +604,7 @@ protected T executeAutoCommitTrue(Object[] args) throws Throwable { Connectio ``` -public void commit() throws SQLException { try { LOCK_RETRY_POLICY.execute(() -> { //¸úÈë doCommit(); return null; }); } catch (SQLException e) { throw e; } catch (Exception e) { throw new SQLException(e); }} +public void commit() throws SQLException { try { LOCK_RETRY_POLICY.execute(() -> { //è·Ÿå…¥ doCommit(); return null; }); } catch (SQLException e) { throw e; } catch (Exception e) { throw new SQLException(e); }} ``` @@ -618,7 +618,7 @@ public void commit() throws SQLException { try { LOCK_RETRY_POLICY.exe ``` -private void doCommit() throws SQLException { if (context.inGlobalTransaction()) { //¸úÈë processGlobalTransactionCommit(); } else if (context.isGlobalLockRequire()) { processLocalCommitWithGlobalLocks(); } else { targetConnection.commit(); }} +private void doCommit() throws SQLException { if (context.inGlobalTransaction()) { //è·Ÿå…¥ processGlobalTransactionCommit(); } else if (context.isGlobalLockRequire()) { processLocalCommitWithGlobalLocks(); } else { targetConnection.commit(); }} ``` @@ -632,7 +632,7 @@ private void doCommit() throws SQLException { if (context.inGlobalTransaction ``` -private void processGlobalTransactionCommit() throws SQLException { try { //Ïòseata-server×¢²á·ÖÖ§ÐÅÏ¢ register(); } catch (TransactionException e) { recognizeLockKeyConflictException(e, context.buildLockKeys()); } try { //Ìá½»ÊÂÎñ֮ǰ£¬²åÈëundo_log,¸úÈëflushUndoLogs UndoLogManagerFactory.getUndoLogManager(this.getDbType()).flushUndoLogs(this); targetConnection.commit(); } catch (Throwable ex) { ... } if (IS_REPORT_SUCCESS_ENABLE) { report(true); } context.reset();} +private void processGlobalTransactionCommit() throws SQLException { try { //å�‘seata-server注册分支信æ�¯ register(); } catch (TransactionException e) { recognizeLockKeyConflictException(e, context.buildLockKeys()); } try { //æ��交事务之å‰�,æ�’å…¥undo_log,è·Ÿå…¥flushUndoLogs UndoLogManagerFactory.getUndoLogManager(this.getDbType()).flushUndoLogs(this); targetConnection.commit(); } catch (Throwable ex) { ... } if (IS_REPORT_SUCCESS_ENABLE) { report(true); } context.reset();} ``` @@ -646,7 +646,7 @@ private void processGlobalTransactionCommit() throws SQLException { try { ``` -public void flushUndoLogs(ConnectionProxy cp) throws SQLException { ConnectionContext connectionContext = cp.getContext(); if (!connectionContext.hasUndoLog()) { return; } String xid = connectionContext.getXid(); long branchId = connectionContext.getBranchId(); ...//¸Ã·½·¨²åÈëundo_log insertUndoLogWithNormal(xid, branchId, buildContext(parser.getName()), undoLogContent, cp.getTargetConnection());} +public void flushUndoLogs(ConnectionProxy cp) throws SQLException { ConnectionContext connectionContext = cp.getContext(); if (!connectionContext.hasUndoLog()) { return; } String xid = connectionContext.getXid(); long branchId = connectionContext.getBranchId(); ...//该方法æ�’å…¥undo_log insertUndoLogWithNormal(xid, branchId, buildContext(parser.getName()), undoLogContent, cp.getTargetConnection());} ``` @@ -657,14 +657,14 @@ public void flushUndoLogs(ConnectionProxy cp) throws SQLException { Connectio -Ôڸ÷½·¨ÖÐ×¢²á·ÖÖ§ÊÂÎñ![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/92309a950c73829078a3170c585fc58fb03b0d.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")Ìá½»ÊÂÎñ£¬Ïòseata-server×¢²á·ÖÖ§ÐÅÏ¢£¬seata-server½ÓÊÕµ½ÇëÇó£¨seataÔ´Â룩![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c116df5929a1116e61e683298e14b953450bb7.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø") +在该方法中注册分支事务![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/92309a950c73829078a3170c585fc58fb03b0d.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")æ��交事务,å�‘seata-server注册分支信æ�¯ï¼Œseata-server接收到请求(seataæº�ç �)![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c116df5929a1116e61e683298e14b953450bb7.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区") -io.seata.server.coordinator.DefaultCoordinator#doBranchRegister·½·¨ +io.seata.server.coordinator.DefaultCoordinator#doBranchRegister方法 ``` -public Long branchRegister(BranchType branchType, String resourceId, String clientId, String xid, String applicationData, String lockKeys) throws TransactionException { GlobalSession globalSession = assertGlobalSessionNotNull(xid, false); return SessionHolder.lockAndExecute(globalSession, () -> { ... try { //½øÐÐ×¢²á globalSession.addBranch(branchSession); } catch (RuntimeException ex) { ... } ... return branchSession.getBranchId(); });} +public Long branchRegister(BranchType branchType, String resourceId, String clientId, String xid, String applicationData, String lockKeys) throws TransactionException { GlobalSession globalSession = assertGlobalSessionNotNull(xid, false); return SessionHolder.lockAndExecute(globalSession, () -> { ... try { //进行注册 globalSession.addBranch(branchSession); } catch (RuntimeException ex) { ... } ... return branchSession.getBranchId(); });} ``` @@ -678,7 +678,7 @@ public Long branchRegister(BranchType branchType, String resourceId, String clie ``` -@Overridepublic void addBranch(BranchSession branchSession) throws TransactionException { for (SessionLifecycleListener lifecycleListener : lifecycleListeners) { //¸úÈëonAddBranch£¬Ñ¡ÔñAbstractSessionManager lifecycleListener.onAddBranch(this, branchSession); } branchSession.setStatus(BranchStatus.Registered); add(branchSession);} +@Overridepublic void addBranch(BranchSession branchSession) throws TransactionException { for (SessionLifecycleListener lifecycleListener : lifecycleListeners) { //è·Ÿå…¥onAddBranch,选择AbstractSessionManager lifecycleListener.onAddBranch(this, branchSession); } branchSession.setStatus(BranchStatus.Registered); add(branchSession);} ``` @@ -689,12 +689,12 @@ public Long branchRegister(BranchType branchType, String resourceId, String clie -io.seata.server.storage.db.session.DataBaseSessionManager#addBranchSession·½·¨ +io.seata.server.storage.db.session.DataBaseSessionManager#addBranchSession方法 ``` -@Overridepublic void onAddBranch(GlobalSession globalSession, BranchSession branchSession) throws TransactionException { //¸úÈ룬ѡÔñDataBaseSessionManager addBranchSession(globalSession, branchSession);} +@Overridepublic void onAddBranch(GlobalSession globalSession, BranchSession branchSession) throws TransactionException { //跟入,选择DataBaseSessionManager addBranchSession(globalSession, branchSession);} ``` @@ -708,7 +708,7 @@ io.seata.server.storage.db.session.DataBaseSessionManager#addBranchSession ``` -@Overridepublic void addBranchSession(GlobalSession globalSession, BranchSession session) throws TransactionException { if (StringUtils.isNotBlank(taskName)) { return; } //¸úÈë boolean ret = transactionStoreManager.writeSession(LogOperation.BRANCH_ADD, session); if (!ret) { throw new StoreException("addBranchSession failed."); }} +@Overridepublic void addBranchSession(GlobalSession globalSession, BranchSession session) throws TransactionException { if (StringUtils.isNotBlank(taskName)) { return; } //è·Ÿå…¥ boolean ret = transactionStoreManager.writeSession(LogOperation.BRANCH_ADD, session); if (!ret) { throw new StoreException("addBranchSession failed."); }} ``` @@ -747,16 +747,16 @@ io.seata.server.storage.db.session.DataBaseSessionManager#addBranchSession -Seata-serverÌí¼Ó·ÖÖ§ÐÅÏ¢Íê³É£¬µ½ÕâÀһ½×¶Î½áÊø£¬ÒµÎñÊý¾Ý£¬undo_log£¬·ÖÖ§ÐÅÏ¢¶¼ÒѾ­Ð´ÈëÊý¾Ý¿â +Seata-server添加分支信æ�¯å®Œæˆ�,到这里,一阶段结æ�Ÿï¼Œä¸šåŠ¡æ•°æ�®ï¼Œundo_log,分支信æ�¯éƒ½å·²ç»�写入数æ�®åº“ -**2.4.1.3 AT¶þ½×¶ÎÌá½»** -»Øµ½handleGlobalTransaction·½·¨ÖУ¬µ÷ÓÃÁË -transactionalTemplate.execute·½·¨ +**2.4.1.3 AT二阶段æ��交** +回到handleGlobalTransaction方法中,调用了 +transactionalTemplate.execute方法 ``` -// 2\. ¿ªÆôÈ«¾ÖÊÂÎñbeginTransactionbeginTransaction(txInfo, tx); Object rs = null;try { // Ö´ÐÐÒµÎñ·½·¨business.execute() rs = business.execute(); } catch (Throwable ex) { //ÉÏÃæÊÇÒ»½×¶Î //ÏÂÃæÊǶþ½×¶Î // 3.³öÏÖÒì³£Ö´ÐÐcompleteTransactionAfterThrowing»Ø¹ö completeTransactionAfterThrowing(txInfo, tx, ex); throw ex;} // 4\. ûÓÐÒì³£Ìá½»ÊÂÎñcommitTransactioncommitTransaction(tx); +// 2\. å¼€å�¯å…¨å±€äº‹åŠ¡beginTransactionbeginTransaction(txInfo, tx); Object rs = null;try { // 执行业务方法business.execute() rs = business.execute(); } catch (Throwable ex) { //上é�¢æ˜¯ä¸€é˜¶æ®µ //下é�¢æ˜¯äºŒé˜¶æ®µ // 3.出现异常执行completeTransactionAfterThrowing回滚 completeTransactionAfterThrowing(txInfo, tx, ex); throw ex;} // 4\. 没有异常æ��交事务commitTransactioncommitTransaction(tx); ``` @@ -767,14 +767,14 @@ transactionalTemplate.execute -¶þ½×¶ÎÌá½» +二阶段æ��交 -commitTransaction(tx);¸ú½ø +commitTransaction(tx);è·Ÿè¿› ``` -private void commitTransaction(GlobalTransaction tx) throws TransactionalExecutor.ExecutionException { try { triggerBeforeCommit(); //¸úÈë tx.commit(); triggerAfterCommit(); } catch (TransactionException txe) { // 4.1 Failed to commit throw new TransactionalExecutor.ExecutionException(tx, txe, TransactionalExecutor.Code.CommitFailure); }} +private void commitTransaction(GlobalTransaction tx) throws TransactionalExecutor.ExecutionException { try { triggerBeforeCommit(); //è·Ÿå…¥ tx.commit(); triggerAfterCommit(); } catch (TransactionException txe) { // 4.1 Failed to commit throw new TransactionalExecutor.ExecutionException(tx, txe, TransactionalExecutor.Code.CommitFailure); }} ``` @@ -785,12 +785,12 @@ private void commitTransaction(GlobalTransaction tx) throws TransactionalExecuto -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/61b35980530bd17bff9025f1112baa9e3e93e5.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø") +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/61b35980530bd17bff9025f1112baa9e3e93e5.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区") ``` -@Overridepublic GlobalStatus commit(String xid) throws TransactionException { GlobalCommitRequest globalCommit = new GlobalCommitRequest(); globalCommit.setXid(xid); //¸úÈësyncCall GlobalCommitResponse response = (GlobalCommitResponse) syncCall(globalCommit); return response.getGlobalStatus();} +@Overridepublic GlobalStatus commit(String xid) throws TransactionException { GlobalCommitRequest globalCommit = new GlobalCommitRequest(); globalCommit.setXid(xid); //è·Ÿå…¥syncCall GlobalCommitResponse response = (GlobalCommitResponse) syncCall(globalCommit); return response.getGlobalStatus();} ``` @@ -815,14 +815,14 @@ private AbstractTransactionResponse syncCall(AbstractTransactionRequest request) -×îÖÕͨ¹ýTMÇëÇóseata-server£¬Seata-server½ÓÊÕµ½È«¾ÖÌá½»ÇëÇó£¨seataÔ´Â룩 +最终通过TM请求seata-server,Seata-server接收到全局æ��交请求(seataæº�ç �) -DefaultCoordinatorÖÐ +DefaultCoordinator中 ``` -@Overrideprotected void doGlobalCommit(GlobalCommitRequest request, GlobalCommitResponse response, RpcContext rpcContext) throws TransactionException { MDC.put(RootContext.MDC_KEY_XID, request.getXid()); //¸úÈëcommit response.setGlobalStatus(core.commit(request.getXid()));} +@Overrideprotected void doGlobalCommit(GlobalCommitRequest request, GlobalCommitResponse response, RpcContext rpcContext) throws TransactionException { MDC.put(RootContext.MDC_KEY_XID, request.getXid()); //è·Ÿå…¥commit response.setGlobalStatus(core.commit(request.getXid()));} ``` @@ -833,15 +833,15 @@ DefaultCoordinator -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/185262d74acd3a723a7770d5771c19fa9fa5cf.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/51249f8944b29b9ffc82897a818cb4c33ed06a.png "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/14a2f2b58ad3f11be518376d5e6f68cc678af9.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø") -Seata-server½ÓÊÕµ½¿Í»§¶ËÈ«¾ÖÌá½»ÇëÇóºó£¬ÏȻص÷¿Í»§¶Ë£¬É¾³ýundo_log£¬seataÔÚɾ³ý·ÖÖ§¼°È«¾ÖÊÂÎñ +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/185262d74acd3a723a7770d5771c19fa9fa5cf.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/51249f8944b29b9ffc82897a818cb4c33ed06a.png "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/14a2f2b58ad3f11be518376d5e6f68cc678af9.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区") +Seata-server接收到客户端全局æ��交请求å�Žï¼Œå…ˆå›žè°ƒå®¢æˆ·ç«¯ï¼Œåˆ é™¤undo_log,seata在删除分支å�Šå…¨å±€äº‹åŠ¡ -֮ǰ˵¹ýRMClientÔÚ³õʼ»¯Ê±£¬ÉèÖÃ×ÊÔ´¹ÜÀíÆ÷resourceManager£¬ÉèÖÃÏûÏ¢»Øµ÷¼àÌýÆ÷ÓÃÓÚ½ÓÊÕTCÔÚ¶þ½×¶Î·¢³öµÄÌá½»»òÕ߻عöÇëÇó![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/884c07085b1230a1aab1883d691532ccf6b79c.png "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")Seata-serverɾ³ý·ÖÖ§Êý¾Ý¼°È«¾ÖÊÂÎñÊý¾Ý +之å‰�说过RMClient在åˆ�始化时,设置资æº�管ç�†å™¨resourceManager,设置消æ�¯å›žè°ƒç›‘å�¬å™¨ç”¨äºŽæŽ¥æ”¶TC在二阶段å�‘出的æ��交或者回滚请求![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/884c07085b1230a1aab1883d691532ccf6b79c.png "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")Seata-server删除分支数æ�®å�Šå…¨å±€äº‹åŠ¡æ•°æ�® ``` -@Overridepublic void removeBranch(BranchSession branchSession) throws TransactionException { // do not unlock if global status in (Committing, CommitRetrying, AsyncCommitting), // because it's already unlocked in 'DefaultCore.commit()' if (status != Committing && status != CommitRetrying && status != AsyncCommitting) { if (!branchSession.unlock()) { throw new TransactionException("Unlock branch lock failed, xid = " + this.xid + ", branchId = " + branchSession.getBranchId()); } } for (SessionLifecycleListener lifecycleListener : lifecycleListeners) { //¸úÈë lifecycleListener.onRemoveBranch(this, branchSession); } remove(branchSession);} +@Overridepublic void removeBranch(BranchSession branchSession) throws TransactionException { // do not unlock if global status in (Committing, CommitRetrying, AsyncCommitting), // because it's already unlocked in 'DefaultCore.commit()' if (status != Committing && status != CommitRetrying && status != AsyncCommitting) { if (!branchSession.unlock()) { throw new TransactionException("Unlock branch lock failed, xid = " + this.xid + ", branchId = " + branchSession.getBranchId()); } } for (SessionLifecycleListener lifecycleListener : lifecycleListeners) { //è·Ÿå…¥ lifecycleListener.onRemoveBranch(this, branchSession); } remove(branchSession);} ``` @@ -869,7 +869,7 @@ private void writeSession(LogOperation logOperation, SessionStorable sessionStor ``` -public static void endCommitted(GlobalSession globalSession) throws TransactionException { globalSession.changeStatus(GlobalStatus.Committed); //ɾ³ýÈ«¾ÖÊÂÎñ globalSession.end();} +public static void endCommitted(GlobalSession globalSession) throws TransactionException { globalSession.changeStatus(GlobalStatus.Committed); //删除全局事务 globalSession.end();} ``` @@ -880,14 +880,14 @@ public static void endCommitted(GlobalSession globalSession) throws TransactionE -¿Í»§¶Ëɾ³ýundo_logÊý¾Ý +客户端删除undo_logæ•°æ�® -ÔÚ½ÓÊÕÌá½»ÀïÃæ +在接收æ��交里é�¢ ``` -protected void doBranchCommit(BranchCommitRequest request, BranchCommitResponse response) throws TransactionException { String xid = request.getXid(); long branchId = request.getBranchId(); String resourceId = request.getResourceId(); String applicationData = request.getApplicationData(); if (LOGGER.isInfoEnabled()) { LOGGER.info("Branch committing: " + xid + " " + branchId + " " + resourceId + " " + applicationData); } //¸úÈë BranchStatus status = getResourceManager().branchCommit(request.getBranchType(), xid, branchId, resourceId, applicationData); response.setXid(xid); response.setBranchId(branchId); response.setBranchStatus(status); if (LOGGER.isInfoEnabled()) { LOGGER.info("Branch commit result: " + status); } } +protected void doBranchCommit(BranchCommitRequest request, BranchCommitResponse response) throws TransactionException { String xid = request.getXid(); long branchId = request.getBranchId(); String resourceId = request.getResourceId(); String applicationData = request.getApplicationData(); if (LOGGER.isInfoEnabled()) { LOGGER.info("Branch committing: " + xid + " " + branchId + " " + resourceId + " " + applicationData); } //è·Ÿå…¥ BranchStatus status = getResourceManager().branchCommit(request.getBranchType(), xid, branchId, resourceId, applicationData); response.setXid(xid); response.setBranchId(branchId); response.setBranchStatus(status); if (LOGGER.isInfoEnabled()) { LOGGER.info("Branch commit result: " + status); } } ``` @@ -898,7 +898,7 @@ protected void doBranchCommit(BranchCommitRequest request, BranchCommitResponse -getResourceManager»ñÈ¡µÄ¾ÍÊÇRMClient³õʼ»¯Ê±ÉèÖõÄ×ÊÔ´¹ÜÀíÆ÷DataSourceManager +getResourceManager获å�–的就是RMClientåˆ�始化时设置的资æº�管ç�†å™¨DataSourceManager @@ -928,12 +928,12 @@ public BranchStatus branchCommit(BranchType branchType, String xid, long branchI -Õâ±ßÖ»ÊÇÍùÒ»¸öASYNC_COMMIT_BUFFER»º³åListÖÐÐÂÔöÁËÒ»¸ö¶þ½×¶ÎÌá½»µÄcontext£¬µ«ÕæÕýÌá½»ÔÚAsyncWorkerµÄinit()·½·¨ +这边å�ªæ˜¯å¾€ä¸€ä¸ªASYNC_COMMIT_BUFFER缓冲List中新增了一个二阶段æ��交的context,但真正æ��交在AsyncWorkerçš„init()方法 ``` -public synchronized void init() { LOGGER.info("Async Commit Buffer Limit: {}", ASYNC_COMMIT_BUFFER_LIMIT); ScheduledExecutorService timerExecutor = new ScheduledThreadPoolExecutor(1, new NamedThreadFactory("AsyncWorker", 1, true)); timerExecutor.scheduleAtFixedRate(() -> { try {//¸úÈë doBranchCommits(); } catch (Throwable e) { LOGGER.info("Failed at async committing ... {}", e.getMessage()); } }, 10, 1000 * 1, TimeUnit.MILLISECONDS);} +public synchronized void init() { LOGGER.info("Async Commit Buffer Limit: {}", ASYNC_COMMIT_BUFFER_LIMIT); ScheduledExecutorService timerExecutor = new ScheduledThreadPoolExecutor(1, new NamedThreadFactory("AsyncWorker", 1, true)); timerExecutor.scheduleAtFixedRate(() -> { try {//è·Ÿå…¥ doBranchCommits(); } catch (Throwable e) { LOGGER.info("Failed at async committing ... {}", e.getMessage()); } }, 10, 1000 * 1, TimeUnit.MILLISECONDS);} ``` @@ -944,16 +944,16 @@ public synchronized void init() { LOGGER.info("Async Commit Buffer Limit: {}" -![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a730eb7781ec4bd3ad2578fb7855aa02d45fbc.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")ɾ³ýUndo_log +![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a730eb7781ec4bd3ad2578fb7855aa02d45fbc.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")删除Undo_log -**¶þ½×¶Î»Ø¹ö** +**二阶段回滚** -¶þ½×¶Î»Ø¹öseata-server¶Ë´úÂëÓë¶þ½×¶ÎÌá½»ÀàËÆ£¬ÕâÀïÊ¡ÂÔ +二阶段回滚seata-server端代ç �与二阶段æ��交类似,这里çœ�ç•¥ ``` -protected void doGlobalRollback(GlobalRollbackRequest request, GlobalRollbackResponse response, RpcContext rpcContext) throws TransactionException { MDC.put(RootContext.MDC_KEY_XID, request.getXid()); //È«¾Ö»Ø¹öseaËû½ÓÊÕÇëÇó response.setGlobalStatus(core.rollback(request.getXid()));} +protected void doGlobalRollback(GlobalRollbackRequest request, GlobalRollbackResponse response, RpcContext rpcContext) throws TransactionException { MDC.put(RootContext.MDC_KEY_XID, request.getXid()); //全局回滚sea他接收请求 response.setGlobalStatus(core.rollback(request.getXid()));} ``` @@ -964,12 +964,12 @@ protected void doGlobalRollback(GlobalRollbackRequest request, GlobalRollbackRes -Ö÷Òª¿´»Ø¹ö¿Í»§¶ËÈçºÎ½øÐÐÊÂÎñ²¹³¥ +主è¦�看回滚客户端如何进行事务补å�¿ ``` -@Overridepublic BranchRollbackResponse handle(BranchRollbackRequest request) { BranchRollbackResponse response = new BranchRollbackResponse(); exceptionHandleTemplate(new AbstractCallback() { @Override public void execute(BranchRollbackRequest request, BranchRollbackResponse response) throws TransactionException { //¸úÈë doBranchRollback(request, response); } }, request, response); return response;} +@Overridepublic BranchRollbackResponse handle(BranchRollbackRequest request) { BranchRollbackResponse response = new BranchRollbackResponse(); exceptionHandleTemplate(new AbstractCallback() { @Override public void execute(BranchRollbackRequest request, BranchRollbackResponse response) throws TransactionException { //è·Ÿå…¥ doBranchRollback(request, response); } }, request, response); return response;} ``` @@ -994,9 +994,9 @@ public BranchStatus branchRollback(BranchType branchType, String xid, long branc -×îÖջعö·½·¨µ÷ÓõÄÊÇUndoLogManager.undo(dataSourceProxy, xid, branchId);![SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4842a0701546824cf2720855d8310a1274c576.jpg "SpringCloud AlibabaϵÁСª¡ª17Seata ATģʽԴÂë·ÖÎö£¨Ï£©-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÅжÏundologÊÇ·ñ´æÔÚ£¬´æÔÚÔòɾ³ý¶ÔÓ¦undolog£¬²¢Ò»ÆðÌá½»£¬µ½´ËseataµÄATģʽԴÂë½âÎöÍê±Ï¡£ +最终回滚方法调用的是UndoLogManager.undo(dataSourceProxy, xid, branchId);![SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4842a0701546824cf2720855d8310a1274c576.jpg "SpringCloud Alibaba系列——17Seata AT模å¼�æº�ç �分æž�(下)-å¼€æº�基础软件社区")判断undolog是å�¦å­˜åœ¨ï¼Œå­˜åœ¨åˆ™åˆ é™¤å¯¹åº”undolog,并一起æ��交,到此seataçš„AT模å¼�æº�ç �è§£æž�完毕。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSentinel\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSentinel\346\272\220\347\240\201\345\210\206\346\236\220.md" index 9fc4976..7a5a0de 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSentinel\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloudAlibaba\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudSentinel\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,31 +1,31 @@ -×÷Õß | Ò»ÆðߣJava -À´Ô´ |½ñÈÕÍ·Ìõ - -**ѧϰĿ±ê** - -* SentinelµÄ¹¤×÷Ô­Àí - **µÚ1Õ ÏÞÁ÷Ô­Àí** - ÔÚSentinelÖУ¬ËùÓеÄ×ÊÔ´¶¼¶ÔÓ¦Ò»¸ö×ÊÔ´Ãû³ÆÒÔ¼°Ò»¸öEntry¡£Ã¿Ò»¸öentry¿ÉÒÔ±íʾһ¸öÇëÇó¡£¶øSentinelÖУ¬»áÕë¶Ôµ±Ç°ÇëÇó»ùÓÚ¹æÔòµÄÅжÏÀ´ÊµÏÖÁ÷¿ØµÄ¿ØÖÆ£¬Ô­ÀíÈçÏÂͼËùʾ¡£ - -![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1296c955070646bbc74310e726679bbabfe585.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÉÏͼ½ö×÷ΪÉè¼ÆË¼ÏëµÄչʾ£¬Í¼ÖÐ Slot µÄ˳ÐòÒѺÍ×îаæ Sentinel Slot Chain ˳Ðò²»Ò»Ö -µ±Ò»¸öÍⲿÇëÇó¹ýÀ´Ö®ºó£¬»á´´½¨Ò»¸öEntry£¬¶ø´´½¨EntryµÄͬʱ£¬Ò²»á´´½¨Ò»ÏµÁеÄslot ×é³ÉÒ»¸öÔðÈÎÁ´£¬Ã¿¸öslotÓв»Í¬µÄ¹¤×÷Ö°Ôð¡£ - -* NodeSelectorSlot ¸ºÔðÊÕ¼¯×ÊÔ´µÄ·¾¶£¬²¢½«ÕâЩ×ÊÔ´µÄµ÷Ó÷¾¶£¬ÒÔÊ÷×´½á¹¹´æ´¢ÆðÀ´£¬ÓÃÓÚ¸ù¾Ýµ÷Ó÷¾¶À´ÏÞÁ÷½µ¼¶£» -* ClusterBuilderSlot ÔòÓÃÓÚ´æ´¢×ÊÔ´µÄͳ¼ÆÐÅÏ¢ÒÔ¼°µ÷ÓÃÕßÐÅÏ¢£¬ÀýÈç¸Ã×ÊÔ´µÄ RT, QPS,thread count µÈµÈ£¬ÕâЩÐÅÏ¢½«ÓÃ×÷Ϊ¶àά¶ÈÏÞÁ÷£¬½µ¼¶µÄÒÀ¾Ý£» -* StatisticSlot ÔòÓÃÓڼǼ¡¢Í³¼Æ²»Í¬Î³¶ÈµÄ runtime Ö¸±ê¼à¿ØÐÅÏ¢£» -* FlowSlot ÔòÓÃÓÚ¸ù¾ÝÔ¤ÉèµÄÏÞÁ÷¹æÔòÒÔ¼°Ç°Ãæ slot ͳ¼ÆµÄ״̬£¬À´½øÐÐÁ÷Á¿¿ØÖÆ£» -* AuthoritySlot Ôò¸ù¾ÝÅäÖõĺڰ×Ãûµ¥ºÍµ÷ÓÃÀ´Ô´ÐÅÏ¢£¬À´×öºÚ°×Ãûµ¥¿ØÖÆ£» -* DegradeSlot Ôòͨ¹ýͳ¼ÆÐÅÏ¢ÒÔ¼°Ô¤ÉèµÄ¹æÔò£¬À´×öÈ۶Ͻµ¼¶£» -* SystemSlot Ôòͨ¹ýϵͳµÄ״̬£¬ÀýÈç load1 µÈ£¬À´¿ØÖÆ×ܵÄÈë¿ÚÁ÷Á¿£» -* LogSlot ÔÚ³öÏÖÏÞÁ÷¡¢ÈÛ¶Ï¡¢ÏµÍ³±£»¤Ê±¸ºÔð¼Ç¼ÈÕÖ¾ +作者 | 一起撸Java +æ�¥æº� |今日头æ�¡ + +**学习目标** + +* Sentinel的工作原ç�† + **第1ç«  é™�æµ�原ç�†** + 在Sentinel中,所有的资æº�都对应一个资æº�å��称以å�Šä¸€ä¸ªEntry。æ¯�一个entryå�¯ä»¥è¡¨ç¤ºä¸€ä¸ªè¯·æ±‚。而Sentinel中,会针对当å‰�请求基于规则的判断æ�¥å®žçްæµ�控的控制,原ç�†å¦‚下图所示。 + +![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1296c955070646bbc74310e726679bbabfe585.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")上图仅作为设计æ€�想的展示,图中 Slot 的顺åº�已和最新版 Sentinel Slot Chain 顺åº�ä¸�一致 +当一个外部请求过æ�¥ä¹‹å�Žï¼Œä¼šåˆ›å»ºä¸€ä¸ªEntry,而创建Entryçš„å�Œæ—¶ï¼Œä¹Ÿä¼šåˆ›å»ºä¸€ç³»åˆ—çš„slot 组æˆ�一个责任链,æ¯�个slot有ä¸�å�Œçš„工作è�Œè´£ã€‚ + +* NodeSelectorSlot 负责收集资æº�的路径,并将这些资æº�的调用路径,以树状结构存储起æ�¥ï¼Œç”¨äºŽæ ¹æ�®è°ƒç”¨è·¯å¾„æ�¥é™�æµ�é™�级; +* ClusterBuilderSlot 则用于存储资æº�的统计信æ�¯ä»¥å�Šè°ƒç”¨è€…ä¿¡æ�¯ï¼Œä¾‹å¦‚该资æº�çš„ RT, QPS,thread count 等等,这些信æ�¯å°†ç”¨ä½œä¸ºå¤šç»´åº¦é™�æµ�,é™�级的ä¾�æ�®ï¼› +* StatisticSlot 则用于记录ã€�统计ä¸�å�Œçº¬åº¦çš„ runtime 指标监控信æ�¯ï¼› +* FlowSlot 则用于根æ�®é¢„设的é™�æµ�规则以å�Šå‰�é�¢ slot 统计的状æ€�,æ�¥è¿›è¡Œæµ�é‡�控制; +* AuthoritySlot 则根æ�®é…�置的黑白å��å�•和调用æ�¥æº�ä¿¡æ�¯ï¼Œæ�¥å�šé»‘白å��å�•控制; +* DegradeSlot 则通过统计信æ�¯ä»¥å�Šé¢„设的规则,æ�¥å�šç†”æ–­é™�级; +* SystemSlot 则通过系统的状æ€�,例如 load1 等,æ�¥æŽ§åˆ¶æ€»çš„å…¥å�£æµ�é‡�ï¼› +* LogSlot 在出现é™�æµ�ã€�熔断ã€�系统ä¿�护时负责记录日志 * ... - Sentinel ½« ProcessorSlot ×÷Ϊ SPI ½Ó¿Ú½øÐÐÀ©Õ¹£¨1.7.2 °æ±¾ÒÔǰ SlotChainBuilder ×÷ΪSPI£©£¬Ê¹µÃ Slot Chain ¾ß±¸ÁËÀ©Õ¹µÄÄÜÁ¦¡£Äú¿ÉÒÔ×ÔÐмÓÈë×Ô¶¨ÒåµÄ slot ²¢±àÅÅ slot ¼äµÄ˳Ðò£¬´Ó¶ø¿ÉÒÔ¸ø Sentinel Ìí¼Ó×Ô¶¨ÒåµÄ¹¦ÄÜ¡£ + Sentinel å°† ProcessorSlot 作为 SPI 接å�£è¿›è¡Œæ‰©å±•(1.7.2 版本以å‰� SlotChainBuilder 作为SPI),使得 Slot Chain 具备了扩展的能力。您å�¯ä»¥è‡ªè¡ŒåŠ å…¥è‡ªå®šä¹‰çš„ slot 并编排 slot 间的顺åº�,从而å�¯ä»¥ç»™ Sentinel 添加自定义的功能。 -![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d65c2688084bf5be06d3687ce8663cb1b7167b.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")**Spring Cloud ¼¯³ÉSentinelµÄÔ­Àí** +![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d65c2688084bf5be06d3687ce8663cb1b7167b.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")**Spring Cloud 集æˆ�Sentinel的原ç�†** -Spring Cloud Öм¯³ÉSentinelÏÞÁ÷£¬ÊÇ»ùÓÚÀ¹½ØÆ÷À´ÊµÏÖ£¬¾ßÌåµÄʵÏÖ·¾¶ÈçÏ¡£ +Spring Cloud 中集æˆ�Sentinelé™�æµ�,是基于拦截器æ�¥å®žçŽ°ï¼Œå…·ä½“çš„å®žçŽ°è·¯å¾„å¦‚ä¸‹ã€‚ -SentinelWebAutoConfiguration¡ª¡ª>addInterceptors¡ª¡ª>SentinelWebInterceptor->AbstractSentinelInterceptor +SentinelWebAutoConfiguration——>addInterceptors——>SentinelWebInterceptor->AbstractSentinelInterceptor @@ -41,17 +41,17 @@ public boolean preHandle(HttpServletRequest request, HttpServletResponseresponse -> ×ÊÔ´µ÷ÓõÄÁ÷Á¿ÀàÐÍ£¬ÊÇÈë¿ÚÁ÷Á¿£¨ EntryType.IN £©»¹Êdzö¿ÚÁ÷Á¿£¨ EntryType.OUT £©£¬×¢Òâϵͳ¹æÔòÖ»¶Ô IN ÉúЧ +> 资æº�调用的æµ�é‡�类型,是入å�£æµ�é‡�( EntryType.IN )还是出å�£æµ�é‡�( EntryType.OUT ),注æ„�系统规则å�ªå¯¹ IN 生效 -**µÚ2Õ SphU.entry** -²»¹ÜÊǼ¯³ÉdubboÒ²ºÃ£¬»¹ÊǼ¯³Éµ½spring cloudÖÐÒ²ºÃ£¬×îÖÕ¶¼Êǵ÷ÓÃSphU.entryÕâ¸ö·½·¨À´½øÐÐÏÞÁ÷Åжϵ쬽ÓÏÂÀ´ÎÒÃÇ´ÓSphU.entryÕâ¸ö·½·¨ÖÐÈ¥Á˽âËüµÄʵÏÖÔ­Àí¡£ +**第2ç«  SphU.entry** +ä¸�管是集æˆ�dubbo也好,还是集æˆ�到spring cloud中也好,最终都是调用SphU.entry这个方法æ�¥è¿›è¡Œé™�æµ�判断的,接下æ�¥æˆ‘们从SphU.entry这个方法中去了解它的实现原ç�†ã€‚ -´úÂëÖÐÎÒÃÇ¿ÉÄÜΨһÒÉ»óµÄ£¬Ò²ÊÇ×î¹Ø¼üµÄÒ»²½ÊÇ SphU.entry(resource) £¬ ÎÒÃÇ´«½øÈ¥ÁËÒ»¸ö×ÊÔ´£¬Õâ¸ö×ÊÔ´¿ÉÓÃÊÇ·½·¨Ãû£¬¿ÉÒÔÊǽӿڣ¬ÄÇôËû¾ßÌå×öÁËÊ²Ã´ÄØ£¿ÈÃÎÒÃÇÀ´Ò»²½²½½Ò¿ªËûµÄÉñÃØÃæÉ´£º +代ç �中我们å�¯èƒ½å”¯ä¸€ç–‘惑的,也是最关键的一步是 SphU.entry(resource) , 我们传进去了一个资æº�,这个资æº�å�¯ç”¨æ˜¯æ–¹æ³•å��,å�¯ä»¥æ˜¯æŽ¥å�£ï¼Œé‚£ä¹ˆä»–具体å�šäº†ä»€ä¹ˆå‘¢ï¼Ÿè®©æˆ‘们æ�¥ä¸€æ­¥æ­¥æ�­å¼€ä»–的神秘é�¢çº±ï¼š ``` -public static Entry entry(String name) throws BlockException { return Env.sph.entry(name, EntryType.OUT, 1, OBJECTS0);}public class Env { public static final Sph sph = new CtSph(); ......//Ê¡ÂÔ²¿·Ö´úÂë} +public static Entry entry(String name) throws BlockException { return Env.sph.entry(name, EntryType.OUT, 1, OBJECTS0);}public class Env { public static final Sph sph = new CtSph(); ......//çœ�略部分代ç �} ``` @@ -62,12 +62,12 @@ public static Entry entry(String name) throws BlockException { return Env.sph -´Ó SphU.entry() ·½·¨ÍùÏÂÖ´ÐÐ»á½øÈëµ½ Sph.entry() £¬SphµÄĬÈÏʵÏÖÀàÊÇ CtSph,¶ø×îÖÕ»á½øÈëCtSph µÄentry ·½·¨£º +从 SphU.entry() 方法往下执行会进入到 Sph.entry() ,Sph的默认实现类是 CtSph,而最终会进入CtSph çš„entry 方法: ``` -@Overridepublic Entry entry(String name, EntryType type, int count, Object... args) throws BlockException {¡¡¡¡ //·â×°ÁËÒ»¸ö×ÊÔ´¶ÔÏó StringResourceWrapper resource = new StringResourceWrapper(name, type); return entry(resource, count, args);} +@Overridepublic Entry entry(String name, EntryType type, int count, Object... args) throws BlockException {   //å°�装了一个资æº�对象 StringResourceWrapper resource = new StringResourceWrapper(name, type); return entry(resource, count, args);} ``` @@ -78,16 +78,16 @@ public static Entry entry(String name) throws BlockException { return Env.sph -ÕâÀïµÄÖ÷Òª²½ÖèÊÇͨ¹ýÎÒÃǸø¶¨µÄ×ÊÔ´È¥·â×°ÁËÒ»¸ö StringResourceWrapper £¬È»ºó´«Èë×Ô¼ºµÄÖØÔØ·½·¨£¬¼Ì¶øµ÷Óà entryWithPriority(resourceWrapper, count, false, args)£º +这里的主è¦�步骤是通过我们给定的资æº�去å°�装了一个 StringResourceWrapper ,然å�Žä¼ å…¥è‡ªå·±çš„é‡�载方法,继而调用 entryWithPriority(resourceWrapper, count, false, args): -* ResourceWrapper ±íʾsentinelµÄ×ÊÔ´£¬×öÁË·â×° -* count±íʾ±¾´ÎÇëÇóµÄÕ¼ÓõIJ¢·¢ÊýÁ¿£¬Ä¬ÈÏÊÇ1 -* prioritized£¬ÓÅÏȼ¶ +* ResourceWrapper 表示sentinel的资æº�,å�šäº†å°�装 +* count表示本次请求的å� ç”¨çš„å¹¶å�‘æ•°é‡�,默认是1 +* prioritized,优先级 ``` -private Entry entryWithPriority(ResourceWrapper resourceWrapper, int count,boolean prioritized, Object... args) throws BlockException { //»ñÈ¡ÉÏÏÂÎÄ»·¾³£¬´æ´¢ÔÚThreadLocalÖУ¬contextÖÐ»á´æ´¢Õû¸öµ÷ÓÃÁ´ Context context = ContextUtil.getContext(); //Èç¹ûÊÇ NullContext£¬ÄÇô˵Ã÷ context name ³¬¹ýÁË 2000 ¸ö£¬²Î¼û ContextUtil#trueEnter //Õâ¸öʱºò£¬Sentinel ²»ÔÙ½ÓÊÜ´¦ÀíÐ嵀 context ÅäÖã¬Ò²¾ÍÊDz»×öÕâЩеĽӿڵÄͳ¼Æ¡¢ÏÞÁ÷ÈÛ¶ÏµÈ if (context instanceof NullContext) { // The {@link NullContext} indicates that the amount of context has exceeded the threshold, // so here init the entry only. No rule checking will be done. return new CtEntry(resourceWrapper, null, context); } if (context == null) {//ʹÓÃĬÈÏcontext // Éú³ÉContextµÄ²¿·Ö context = InternalContextUtil.internalEnter(Constants.CONTEXT_DEFAULT_NAME); } // Global switch is close, no rule checking will do. if (!Constants.ON) {//È«¾ÖÏÞÁ÷¿ª¹ØÊÇ·ñÒѾ­¿ªÆô£¬Èç¹û¹Ø±ÕÁË£¬¾Í²»½øÐÐÏÞÁ÷¹æÔò¼ì²é return new CtEntry(resourceWrapper, null, context); } //Éè¼ÆÄ£Ê½ÖеÄÔðÈÎÁ´Ä£Ê½¡£ //¹¹½¨Ò»¸öslotÁ´±í ProcessorSlot chain = lookProcessChain(resourceWrapper); //¸ù¾Ý lookProcessChain ·½·¨£¬ÎÒÃÇÖªµÀ£¬µ± resource ³¬¹ý Constants.MAX_SLOT_CHAIN_SIZE£¬ // Ò²¾ÍÊÇ 6000 µÄʱºò£¬Sentinel ¿ªÊ¼²»´¦ÀíеÄÇëÇó£¬Õâô×öÖ÷ÒªÊÇΪÁË Sentinel µÄÐÔÄÜ¿¼ÂÇ if (chain == null) { return new CtEntry(resourceWrapper, null, context); } //ÏÂÃæÕâÀï²ÅÕæÕý¿ªÊ¼£¬Éú³É¸öentry Entry e = new CtEntry(resourceWrapper, chain, context); try { //¿ªÊ¼¼ì²âÏÞÁ÷¹æÔò chain.entry(context, resourceWrapper, null, count, prioritized, args); } catch (BlockException e1) { e.exit(count, args); //±»ÏÞÁ÷£¬Å׳öÒì³£¡£ throw e1; } catch (Throwable e1) { // This should not happen, unless there are errors existing in Sentinel internal. RecordLog.info("Sentinel unexpected exception", e1); } return e;//·µ»ØÕý³£µÄ½á¹û} +private Entry entryWithPriority(ResourceWrapper resourceWrapper, int count,boolean prioritized, Object... args) throws BlockException { //获å�–上下文环境,存储在ThreadLocal中,context中会存储整个调用链 Context context = ContextUtil.getContext(); //如果是 NullContext,那么说明 context name 超过了 2000 个,å�‚è§� ContextUtil#trueEnter //这个时候,Sentinel ä¸�å†�接å�—处ç�†æ–°çš„ context é…�置,也就是ä¸�å�šè¿™äº›æ–°çš„æŽ¥å�£çš„统计ã€�é™�æµ�熔断等 if (context instanceof NullContext) { // The {@link NullContext} indicates that the amount of context has exceeded the threshold, // so here init the entry only. No rule checking will be done. return new CtEntry(resourceWrapper, null, context); } if (context == null) {//使用默认context // 生æˆ�Context的部分 context = InternalContextUtil.internalEnter(Constants.CONTEXT_DEFAULT_NAME); } // Global switch is close, no rule checking will do. if (!Constants.ON) {//全局é™�æµ�开关是å�¦å·²ç»�å¼€å�¯ï¼Œå¦‚果关闭了,就ä¸�进行é™�æµ�规则检查 return new CtEntry(resourceWrapper, null, context); } //设计模å¼�中的责任链模å¼�。 //构建一个slot链表 ProcessorSlot chain = lookProcessChain(resourceWrapper); //æ ¹æ�® lookProcessChain 方法,我们知é�“,当 resource 超过 Constants.MAX_SLOT_CHAIN_SIZE, // 也就是 6000 的时候,Sentinel 开始ä¸�处ç�†æ–°çš„请求,这么å�šä¸»è¦�是为了 Sentinel 的性能考虑 if (chain == null) { return new CtEntry(resourceWrapper, null, context); } //下é�¢è¿™é‡Œæ‰�真正开始,生æˆ�个entry Entry e = new CtEntry(resourceWrapper, chain, context); try { //开始检测é™�æµ�规则 chain.entry(context, resourceWrapper, null, count, prioritized, args); } catch (BlockException e1) { e.exit(count, args); //被é™�æµ�,抛出异常。 throw e1; } catch (Throwable e1) { // This should not happen, unless there are errors existing in Sentinel internal. RecordLog.info("Sentinel unexpected exception", e1); } return e;//返回正常的结果} ``` @@ -98,18 +98,18 @@ private Entry entryWithPriority(ResourceWrapper resourceWrapper, int count,boole -´ÓÉÏÃæµÄ´úÂëÎÒÃÇ¿ÉÒÔÖªµÀ£¬¸Ã·½·¨ÖÐÖ÷ÒªÊÇ»ñÈ¡µ½Á˱¾×ÊÔ´Ëù¶ÔÓ¦µÄ×ÊÔ´´¦ÀíÁ´£¬´ÓÆðÃüÃû lookProcessChain Öз¢ÏÖ£¬¾ÍÊÇÈ¥»ñÈ¡µ½Ò»Ìõ´¦ÀíÁ´£¬È¥Ö´ÐÐ×ÊÔ´µÄÕûºÏ´¦Àí£¬µ±È»£¬ÕâÀï´¦ÓÚÏÞÁ÷µÄ»·¾³Ï£¬ÄÇôÕâ¸ö´¦ÀíÁ´¿Ï¶¨ÊǶÔÓÚµ±Ç°»·¾³ÏÂÇëÇóµÄÁ÷Á¿ÕûºÏÏÞÁ÷Ïà¹ØµÄ´¦Àí¡£¿ÉÒÔ·ÖΪÒÔϼ¸¸ö²¿·Ö£º +从上é�¢çš„代ç �我们å�¯ä»¥çŸ¥é�“,该方法中主è¦�是获å�–到了本资æº�所对应的资æº�处ç�†é“¾ï¼Œä»Žèµ·å‘½å�� lookProcessChain 中å�‘现,就是去获å�–到一æ�¡å¤„ç�†é“¾ï¼ŒåŽ»æ‰§è¡Œèµ„æº�的整å�ˆå¤„ç�†ï¼Œå½“然,这里处于é™�æµ�的环境下,那么这个处ç�†é“¾è‚¯å®šæ˜¯å¯¹äºŽå½“å‰�环境下请求的æµ�é‡�æ•´å�ˆé™�æµ�相关的处ç�†ã€‚å�¯ä»¥åˆ†ä¸ºä»¥ä¸‹å‡ ä¸ªéƒ¨åˆ†ï¼š -* ¶Ô²ÎÈ«¾ÖÅäÖÃÏî×ö¼ì²â£¬Èç¹û²»·ûºÏÒªÇó¾ÍÖ±½Ó·µ»ØÁËÒ»¸öCtEntry¶ÔÏ󣬲»»áÔÙ½øÐкóÃæµÄÏÞÁ÷¼ì²â£¬·ñÔò½øÈëÏÂÃæµÄ¼ì²âÁ÷³Ì¡£¸ù¾Ý°ü×°¹ýµÄ×ÊÔ´¶ÔÏó»ñÈ¡¶ÔÓ¦µÄSlotChain -* Ö´ÐÐSlotChainµÄentry·½·¨£¬Èç¹ûSlotChainµÄentry·½·¨Å׳öÁËBlockException£¬Ôò½«¸ÃÒì³£¼ÌÐøÏòÉÏÅ׳ö£¬Èç¹ûSlotChainµÄentry·½·¨Õý³£Ö´ÐÐÁË£¬Ôò×îºó»á½«¸Ãentry¶ÔÏó·µ»Ø -* Èç¹ûÉϲ㷽·¨²¶»ñÁËBlockException£¬Ôò˵Ã÷ÇëÇó±»ÏÞÁ÷ÁË£¬·ñÔòÇëÇóÄÜÕý³£Ö´ÐÐ - **2.1 ´´½¨Context** +* 对å�‚全局é…�置项å�šæ£€æµ‹ï¼Œå¦‚æžœä¸�符å�ˆè¦�求就直接返回了一个CtEntry对象,ä¸�会å†�进行å�Žé�¢çš„é™�æµ�检测,å�¦åˆ™è¿›å…¥ä¸‹é�¢çš„æ£€æµ‹æµ�程。根æ�®åŒ…装过的资æº�对象获å�–对应的SlotChain +* 执行SlotChainçš„entry方法,如果SlotChainçš„entry方法抛出了BlockException,则将该异常继续å�‘上抛出,如果SlotChainçš„entry方法正常执行了,则最å�Žä¼šå°†è¯¥entry对象返回 +* 如果上层方法æ�•获了BlockException,则说明请求被é™�æµ�了,å�¦åˆ™è¯·æ±‚能正常执行 + **2.1 创建Context** InternalContextUtil.internalEnter--->trueEnter ``` -protected static Context trueEnter(String name, String origin) { //´ÓThreadLocalÖлñÈ¡£¬µÚÒ»´Î¿Ï¶¨ÊÇnull Context context = contextHolder.get(); if (context == null) { //ÕâÀïÊǸù¾ÝContextµÄÃû×Ö»ñÈ¡Node Map localCacheNameMap = contextNameNodeMap; DefaultNode node = localCacheNameMap.get(name); if (node == null) { if (localCacheNameMap.size() > Constants.MAX_CONTEXT_NAME_SIZE) { setNullContext(); return NULL_CONTEXT; } else { LOCK.lock(); try { node = contextNameNodeMap.get(name); if (node == null) { if (contextNameNodeMap.size() > Constants.MAX_CONTEXT_NAME_SIZE) { setNullContext(); return NULL_CONTEXT; } else { //´´½¨¸öEntranceNode node = new EntranceNode(new StringResourceWrapper(name, EntryType.IN), null); //¼ÓÈëÈ«¾ÖµÄ½Úµã // Add entrance node. Constants.ROOT.addChild(node);//¼ÓÈëmapÖÐ Map newMap = new HashMap<>(contextNameNodeMap.size() + 1); newMap.putAll(contextNameNodeMap); newMap.put(name, node); contextNameNodeMap = newMap; } } } finally { LOCK.unlock(); } } } context = new Context(node, name); context.setOrigin(origin); //·ÅÈëThreadLocalÖÐ contextHolder.set(context); } return context;} +protected static Context trueEnter(String name, String origin) { //从ThreadLocal中获å�–,第一次肯定是null Context context = contextHolder.get(); if (context == null) { //这里是根æ�®Contextçš„å��字获å�–Node Map localCacheNameMap = contextNameNodeMap; DefaultNode node = localCacheNameMap.get(name); if (node == null) { if (localCacheNameMap.size() > Constants.MAX_CONTEXT_NAME_SIZE) { setNullContext(); return NULL_CONTEXT; } else { LOCK.lock(); try { node = contextNameNodeMap.get(name); if (node == null) { if (contextNameNodeMap.size() > Constants.MAX_CONTEXT_NAME_SIZE) { setNullContext(); return NULL_CONTEXT; } else { //创建个EntranceNode node = new EntranceNode(new StringResourceWrapper(name, EntryType.IN), null); //加入全局的节点 // Add entrance node. Constants.ROOT.addChild(node);//加入map中 Map newMap = new HashMap<>(contextNameNodeMap.size() + 1); newMap.putAll(contextNameNodeMap); newMap.put(name, node); contextNameNodeMap = newMap; } } } finally { LOCK.unlock(); } } } context = new Context(node, name); context.setOrigin(origin); //放入ThreadLocal中 contextHolder.set(context); } return context;} ``` @@ -120,23 +120,23 @@ protected static Context trueEnter(String name, String origin) { // -ÕâÀïµÄÂß¼­»¹ÊDZȽϼòµ¥µÄ +这里的逻辑还是比较简å�•çš„ -* Ê×ÏÈÔÚThreadLocal»ñÈ¡£¬»ñÈ¡²»µ½¾Í´´½¨£¬²»È»¾Í·µ»Ø -* È»ºóÔÙMapÖиù¾ÝContextNameÕÒÒ»¸öNode -* ûÓÐÕÒµ½Node¾Í¼ÓËøµÄ·½Ê½£¬´´½¨Ò»¸öEntranceNode£¬È»ºó·ÅÈëMapÖÐ -* ´´½¨Context£¬ÉèÖÃnode£¬name£¬origin£¬ÔÙ·ÅÈëThreadLocalÖÐ - µ½´ËContext¾Í´´½¨Íê³É +* 首先在ThreadLocal获å�–,获å�–ä¸�到就创建,ä¸�然就返回 +* ç„¶å�Žå†�Map中根æ�®ContextName找一个Node +* 没有找到Node就加é”�的方å¼�,创建一个EntranceNode,然å�Žæ”¾å…¥Map中 +* 创建Context,设置node,name,origin,å†�放入ThreadLocal中 + 到此Context就创建完æˆ� -ĿǰContext¶ÔÏóµÄ״̬ÈçÏÂͼ![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a114ee154527b7fcf24169d5291c7bac87ac93.png "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")**2.2 ¹¹½¨slotÁ´** -¹¹½¨Ò»¸öslotÁ´£¬Á´Â·µÄ×é³ÉΪ +ç›®å‰�Context对象的状æ€�如下图![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a114ee154527b7fcf24169d5291c7bac87ac93.png "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")**2.2 构建slot链** +构建一个slot链,链路的组æˆ�为 > DefaultProcessorSlotChain -> NodeSelectorSlot -> ClusterBuilderSlot -> LogSlot ->StatisticSlot -> AuthoritySlot -> SystemSlot -> ParamFlowSlot -> FlowSlot -> DegradeSlot ``` -ProcessorSlot lookProcessChain(ResourceWrapper resourceWrapper) { //¿ÉÒÔ¿´³ö£¬chainÁ´¸ù¾Ý×ÊÔ´À´×÷Ϊkey£¬²»Í¬µÄ×ÊÔ´¿Ï¶¨ÊDz»Í¬chainÁ´ ProcessorSlotChain chain = chainMap.get(resourceWrapper); if (chain == null) {////ÕâÀïÓëspring(»º´æbean) dubbo(Ë«ÖØ¼ì²éËø)ÖÐÈç³öÒ»ÕÞ£¬²ÉÓûº´æ»úÖÆ synchronized (LOCK) { chain = chainMap.get(resourceWrapper); if (chain == null) { //chainMap´óС´óÓÚÒ»¸öÖµ£¬Ò²¾ÍÊÇentryÊýÁ¿´óСÏÞÖÆÁË£¬Ò»¸öchain¶ÔÓ¦Ò»¸öentry if (chainMap.size() >= Constants.MAX_SLOT_CHAIN_SIZE) { return null; } //¹¹½¨Ò»¸öslot chain chain = SlotChainProvider.newSlotChain(); //ÕâÀïµÄÂß¼­ÊÇ£¬Ð½¨Ò»¸öMap´óСÊÇoldMap+1 Map newMap = new HashMap( chainMap.size() + 1); //È»ºóÏÈÕûÌå·ÅÈëoldMap£¬ÔÙ·Åн¨µÄchain newMap.putAll(chainMap); newMap.put(resourceWrapper, chain); //Ìí¼Óµ½newMap£¬ ÕâÀïÓ¦¸ÃÊÇ¿¼ÂDZÜÃâÆµ·±À©ÈÝ chainMap = newMap; } } } return chain;} +ProcessorSlot lookProcessChain(ResourceWrapper resourceWrapper) { //å�¯ä»¥çœ‹å‡ºï¼Œchain链根æ�®èµ„æº�æ�¥ä½œä¸ºkey,ä¸�å�Œçš„资æº�肯定是ä¸�å�Œchain链 ProcessorSlotChain chain = chainMap.get(resourceWrapper); if (chain == null) {////这里与spring(缓存bean) dubbo(å�Œé‡�检查é”�)中如出一辙,采用缓存机制 synchronized (LOCK) { chain = chainMap.get(resourceWrapper); if (chain == null) { //chainMap大å°�大于一个值,也就是entryæ•°é‡�大å°�é™�制了,一个chain对应一个entry if (chainMap.size() >= Constants.MAX_SLOT_CHAIN_SIZE) { return null; } //构建一个slot chain chain = SlotChainProvider.newSlotChain(); //这里的逻辑是,新建一个Map大å°�是oldMap+1 Map newMap = new HashMap( chainMap.size() + 1); //ç„¶å�Žå…ˆæ•´ä½“放入oldMap,å†�放新建的chain newMap.putAll(chainMap); newMap.put(resourceWrapper, chain); //添加到newMap, 这里应该是考虑é�¿å…�频ç¹�扩容 chainMap = newMap; } } } return chain;} ``` @@ -147,12 +147,12 @@ ProcessorSlot lookProcessChain(ResourceWrapper resourceWrapper) { // -ÕâÀïµÄ´úÂëºÜÇåÎú¿ÉÒÔ·¢ÏÖ£¬Ê×ÏÈ´Ó»º´æÖлñÈ¡¸Ã´¦ÀíÁ´£¬¶øµÚÒ»´Î½øÀ´¿Ï¶¨ÊÇûÓеģ¬ËùÒÔÕâÀï»á×ß SlotChainProvider È¥¹¹Ôì´¦ÀíÁ´£¬¹¹ÔìÍê³Éºó½«Æð·ÅÈ뻺´æÒÔ±¸Ï´ÎʹÓ㺠+这里的代ç �很清晰å�¯ä»¥å�‘现,首先从缓存中获å�–该处ç�†é“¾ï¼Œè€Œç¬¬ä¸€æ¬¡è¿›æ�¥è‚¯å®šæ˜¯æ²¡æœ‰çš„,所以这里会走 SlotChainProvider 去构造处ç�†é“¾ï¼Œæž„造完æˆ�å�Žå°†èµ·æ”¾å…¥ç¼“存以备下次使用: ``` -public static ProcessorSlotChain newSlotChain() { if (slotChainBuilder != null) { return slotChainBuilder.build(); } // ÕâÀïͨ¹ýspi»úÖÆÈ¥´´½¨´¦ÀíÁ´£¬Èç¹ûÏë×Ô¼º´´½¨slotµÄ»°Ö»ÐèÒª°´ÕÕSPI»úÖÆÊµÏÖSlotChainBuilder½Ó¿Ú¾ÍºÃ //SentinelĬÈϵÄÁ´ÔÚsentinel-core°üϵÄMETA-INF.servicesÏ slotChainBuilder = SpiLoader.loadFirstInstanceOrDefault(SlotChainBuilder.class, DefaultSlotChainBuilder.class); if (slotChainBuilder == null) { // Should not go through here. RecordLog.warn("[SlotChainProvider] Wrong state when resolving slot chain builder, using default"); slotChainBuilder = new DefaultSlotChainBuilder(); } else { RecordLog.info("[SlotChainProvider] Global slot chain builder resolved: " + slotChainBuilder.getClass().getCanonicalName()); } return slotChainBuilder.build();} +public static ProcessorSlotChain newSlotChain() { if (slotChainBuilder != null) { return slotChainBuilder.build(); } // 这里通过spi机制去创建处ç�†é“¾ï¼Œå¦‚果想自己创建slotçš„è¯�å�ªéœ€è¦�按照SPI机制实现SlotChainBuilder接å�£å°±å¥½ //Sentinel默认的链在sentinel-core包下的META-INF.services下 slotChainBuilder = SpiLoader.loadFirstInstanceOrDefault(SlotChainBuilder.class, DefaultSlotChainBuilder.class); if (slotChainBuilder == null) { // Should not go through here. RecordLog.warn("[SlotChainProvider] Wrong state when resolving slot chain builder, using default"); slotChainBuilder = new DefaultSlotChainBuilder(); } else { RecordLog.info("[SlotChainProvider] Global slot chain builder resolved: " + slotChainBuilder.getClass().getCanonicalName()); } return slotChainBuilder.build();} ``` @@ -163,7 +163,7 @@ public static ProcessorSlotChain newSlotChain() { if (slotChainBuilder != nul -Õâ¸ö·½·¨½øÐÐÁ˶à´ÎµÄУÑ飬ȷ±£builder ²»Îª¿Õ£¬È»ºóͨ¹ýÆäÈ¥¹¹ÔìÕâ¸ö´¦ÀíÁ´£º +这个方法进行了多次的校验,确ä¿�builder ä¸�为空,然å�Žé€šè¿‡å…¶åŽ»æž„é€ è¿™ä¸ªå¤„ç�†é“¾ï¼š @@ -179,30 +179,30 @@ public class DefaultSlotChainBuilder implements SlotChainBuilder { @Override -µ½ÁËÕâÀïÎÒÃÇÖÕÓÚ·¢ÏÖÁËÕâ¸ö´¦ÀíÁ´µÄ×é³ÉÇé¿ö£¬¹ÙÍøÒ²ÓÐ¶ÔÆä½øÐÐ˵Ã÷£¬±Ï¾¹ÊÇSentinelµÄÏÞÁ÷ºËÐÄËã·¨µÄʵÏÖ¸¹µØ£¬ÎÒÃÇ¿´Ò»Ï¹ÙÍøµÄ½éÉÜ£º +到了这里我们终于å�‘现了这个处ç�†é“¾çš„组æˆ�情况,官网也有对其进行说明,毕竟是Sentinelçš„é™�æµ�核心算法的实现腹地,我们看一下官网的介ç»�: -ÔÚ Sentinel ÀïÃæ£¬ËùÓеÄ×ÊÔ´¶¼¶ÔÓ¦Ò»¸ö×ÊÔ´Ãû³Æ£¨resourceName£©£¬Ã¿´Î×ÊÔ´µ÷Óö¼»á´´½¨Ò»¸ö Entry ¶ÔÏó¡£Entry ¿ÉÒÔͨ¹ý¶ÔÖ÷Á÷¿ò¼ÜµÄÊÊÅä×Ô¶¯´´½¨£¬Ò²¿ÉÒÔͨ¹ý×¢½âµÄ·½Ê½»òµ÷Óà SphU API ÏÔʽ´´½¨¡£Entry ´´½¨µÄʱºò£¬Í¬Ê±Ò²»á´´½¨Ò»ÏµÁй¦Äܲå²Û£¨slot chain£©£¬ÕâЩ²å²ÛÓв»Í¬µÄÖ°Ôð¡£¾ßÌåÖ°ÔðÔÚÉÏÃæÒѾ­Ìáµ½ÁË¡£ +在 Sentinel 里é�¢ï¼Œæ‰€æœ‰çš„资æº�都对应一个资æº�å��称(resourceName),æ¯�次资æº�调用都会创建一个 Entry 对象。Entry å�¯ä»¥é€šè¿‡å¯¹ä¸»æµ�框架的适é…�自动创建,也å�¯ä»¥é€šè¿‡æ³¨è§£çš„æ–¹å¼�或调用 SphU API 显å¼�创建。Entry 创建的时候,å�Œæ—¶ä¹Ÿä¼šåˆ›å»ºä¸€ç³»åˆ—功能æ�’槽(slot chain),这些æ�’槽有ä¸�å�Œçš„è�Œè´£ã€‚具体è�Œè´£åœ¨ä¸Šé�¢å·²ç»�æ��到了。 -**ÕûÌåÁ÷³Ì** +**整体æµ�程** -ÕûÌåµÄÖ´ÐÐÁ÷³ÌÈçÏ¡£ +整体的执行æµ�程如下。 -* NodeSelectorSlot£ºÖ÷ÒªÓÃÓÚ¹¹½¨µ÷ÓÃÁ´¡£ +* NodeSelectorSlot:主è¦�用于构建调用链。 -* ClusterBuilderSlot£ºÓÃÓÚ¼¯ÈºÏÞÁ÷¡¢ÈÛ¶Ï¡£ +* ClusterBuilderSlot:用于集群é™�æµ�ã€�熔断。 -* LogSlot£ºÓÃÓڼǼÈÕÖ¾¡£ +* LogSlot:用于记录日志。 -* StatisticSlot£ºÓÃÓÚʵʱÊÕ¼¯ÊµÊ±ÏûÏ¢¡£ +* StatisticSlot:用于实时收集实时消æ�¯ã€‚ -* AuthoritySlot£ºÓÃÓÚȨÏÞУÑéµÄ¡£ +* AuthoritySlot:用于æ�ƒé™�校验的。 -* SystemSlot£ºÓÃÓÚÑé֤ϵͳ¼¶±ðµÄ¹æÔò¡£ +* SystemSlot:用于验è¯�系统级别的规则。 -* FlowSlot£ºÊµÏÖÏÞÁ÷»úÖÆ¡£ +* FlowSlot:实现é™�æµ�机制。 -* DegradeSlot£ºÊµÏÖÈÛ¶Ï»úÖÆ¡£ - **2.3 ´´½¨Entry** +* DegradeSlot:实现熔断机制。 + **2.3 创建Entry** > Entry e = new CtEntry(resourceWrapper, chain, context); @@ -221,19 +221,19 @@ CtEntry(ResourceWrapper resourceWrapper, ProcessorSlot chain, Context co -µ±µÚÒ»´ÎEntryÉú³ÉµÄʱºò£¬context.getCurEntry±Ø¶¨ÊÇNULL£¬ÄÇôֱ½ÓÖ´ÐÐContext.setCurEntry·½·¨ +当第一次Entry生æˆ�的时候,context.getCurEntry必定是NULL,那么直接执行Context.setCurEntry方法 -È»ºóÕâ¸öContextµÄ״̬ÈçÏÂͼ ![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/57273a794d51cfc587c923de97943491e9da0b.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÔÙÖ´ÐÐÒ»´ÎеÄSphu.entryºó»áÔÙ´Îн¨Ò»¸öEntry£¬Õâ¸öʱºòcurEntry²»ÊÇnull£¬ÄÇôִÐÐ((CtEntry)parent).child = this; +ç„¶å�Žè¿™ä¸ªContext的状æ€�如下图 ![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/57273a794d51cfc587c923de97943491e9da0b.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")å†�执行一次新的Sphu.entryå�Žä¼šå†�次新建一个Entry,这个时候curEntryä¸�是null,那么执行((CtEntry)parent).child = this; -½á¹ûÈçÏÂͼ![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c3c36f101ef031102dd270287bf7635e715229.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")¿ÉÒÔ¿´³ö£¬Ô­À´µÄCtEntry±»ÒƳöContext£¬Ð½¨µÄCtEntryºÍ¾ÉCtEntryͨ¹ýÄÚ²¿µÄparentºÍchildÒýÓÃÏàÁ¬ +结果如下图![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c3c36f101ef031102dd270287bf7635e715229.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")å�¯ä»¥çœ‹å‡ºï¼ŒåŽŸæ�¥çš„CtEntry被移出Context,新建的CtEntry和旧CtEntry通过内部的parentå’Œchild引用相连 **2.4 NodeSelectorSlot** -Õâ¸öÀàÖ÷ÒªÓÃÓÚ¹¹½¨µ÷ÓÃÁ´£¬Õâ¸öÐèÒª½²½âһϣ¬ÔÚºóÐø¹ý³ÌÖлá±È½Ï¹Ø¼ü£¬´úÂëÈçÏ¡£ +这个类主è¦�用于构建调用链,这个需è¦�讲解一下,在å�Žç»­è¿‡ç¨‹ä¸­ä¼šæ¯”较关键,代ç �如下。 ``` -@Overridepublic void entry(Context context, ResourceWrapper resourceWrapper, Object obj, int count, boolean prioritized, Object... args) throws Throwable { //ÕâÀïÓиö»º´æ£¬¸ù¾ÝcontextµÄÃû×Ö»º´ænode DefaultNode node = map.get(context.getName()); //Ë«ÖØ¼ì²â£¬Ḭ̈߳²È« if (node == null) { synchronized (this) { node = map.get(context.getName()); if (node == null) { //ÕâÀïÉú³ÉµÄÊÇDefaultNode½Úµã node = new DefaultNode(resourceWrapper, null); //ÏÂÃæÕâЩÂß¼­ÊÇ·ÅÈëmapµÄÂß¼­£¬ÒòΪºóÆÚmap±È½Ï´ó£¬ËùÒÔÕâÑù·ÅÈ룬ÐÔÄÜ»á¸ßһЩ HashMap cacheMap = new HashMap(map.size()); cacheMap.putAll(map); cacheMap.put(context.getName(), node); map = cacheMap; // ¹Ø¼üÔÚÕ⣬ÕâÊÇÐ޸ĵ÷ÓÃÁ´Ê÷µÄµØ·½ ((DefaultNode) context.getLastNode()).addChild(node); } } } //Ìæ»»contextÖеÄcurEntryÖеÄcurNode context.setCurNode(node); fireEntry(context, resourceWrapper, node, count, prioritized, args);} +@Overridepublic void entry(Context context, ResourceWrapper resourceWrapper, Object obj, int count, boolean prioritized, Object... args) throws Throwable { //这里有个缓存,根æ�®contextçš„å��字缓存node DefaultNode node = map.get(context.getName()); //å�Œé‡�检测,线程安全 if (node == null) { synchronized (this) { node = map.get(context.getName()); if (node == null) { //这里生æˆ�的是DefaultNode节点 node = new DefaultNode(resourceWrapper, null); //下é�¢è¿™äº›é€»è¾‘是放入map的逻辑,因为å�ŽæœŸmap比较大,所以这样放入,性能会高一些 HashMap cacheMap = new HashMap(map.size()); cacheMap.putAll(map); cacheMap.put(context.getName(), node); map = cacheMap; // 关键在这,这是修改调用链树的地方 ((DefaultNode) context.getLastNode()).addChild(node); } } } //替æ�¢context中的curEntry中的curNode context.setCurNode(node); fireEntry(context, resourceWrapper, node, count, prioritized, args);} ``` @@ -244,40 +244,40 @@ CtEntry(ResourceWrapper resourceWrapper, ProcessorSlot chain, Context co -²éѯ»º´æÖÐÊÇ·ñÓÐÕâ¸önodeÕâÀïµÄÂß¼­Ò²ºÜ¼òµ¥ +查询缓存中是å�¦æœ‰è¿™ä¸ªnode这里的逻辑也很简å�• -* ¸ù¾ÝContextName²éѯ»º´æÊÇ·ñÓÐÕâ¸öNode -* ûÓоÍÉú³ÉÕâ¸öDefaultNode£¬·ÅÈ뻺´æ£¬È»ºó¹¹Ôìµ÷ÓÃÊ÷Á´ -* ContextµÄcurEntryÖеÄcurnodeÉèÖÃΪÕâ¸önode - ÕâÀïÓм¸¸ö¶ÔÏóÒªµ¥¶À˵Ã÷£º +* æ ¹æ�®ContextName查询缓存是å�¦æœ‰è¿™ä¸ªNode +* 没有就生æˆ�这个DefaultNode,放入缓存,然å�Žæž„造调用树链 +* Contextçš„curEntry中的curnode设置为这个node + 这里有几个对象è¦�å�•独说明: -1¡¢context£º±íʾÉÏÏÂÎÄ£¬Ò»¸öÏ̶߳ÔÓ¦Ò»¸öcontext£¬ÆäÖаüº¬Ò»Ð©ÊôÐÔÈçÏ +1ã€�context:表示上下文,一个线程对应一个context,其中包å�«ä¸€äº›å±žæ€§å¦‚下 -* name£ºÃû×Ö -* entranceNode£ºµ÷ÓÃÁ´Èë¿Ú -* curEntry£ºµ±Ç°entry -* origin£ºµ÷ÓÃÕßÀ´Ô´ -* async£ºÒì²½ - 2¡¢Node£º ±íʾһ¸ö½Úµã£¬Õâ¸ö½Úµã»á±£´æÄ³¸ö×ÊÔ´µÄ¸÷¸öʵʱͳ¼ÆÊý¾Ý£¬Í¨¹ý·ÃÎÊij¸ö½Úµã£¬¾Í¿ÉÒÔ»ñµÃ¶ÔÓ¦×ÊÔ´µÄʵʱ״̬£¬¸ù¾ÝÕâ¸öÐÅÏ¢À´½øÐÐÏÞÁ÷ºÍ½µ¼¶£¬ËüÓм¸ÖÖ½ÚµãÀàÐÍ -* StatisticNode£ºÊµÏÖÁËNode½Ó¿Ú£¬·â×°ÁË»ù´¡µÄÁ÷Á¿Í³¼ÆºÍ»ñÈ¡·½·¨ -* DefaultNode£ºÄ¬ÈϽڵ㣬NodeSelectorSlotÖд´½¨µÄ¾ÍÊÇÕâ¸ö½Úµã£»´ú±íͬ¸ö×ÊÔ´ÔÚ²»Í¬ÉÏÏÂÎÄÖи÷×ÔµÄÁ÷Á¿Çé¿ö -* ClusterNode£º¼¯Èº½Úµã£¬´ú±íͬ¸ö×ÊÔ´ÔÚ²»Í¬ÉÏÏÂÎÄÖÐ×ÜÌåµÄÁ÷Á¿Çé¿ö -* EntranceNode£º¸Ã½Úµã±íʾһ¿Ãµ÷ÓÃÁ´Ê÷µÄÈë¿Ú½Úµã£¬Í¨¹ýËû¿ÉÒÔ»ñÈ¡µ÷ÓÃÁ´Ê÷ÖÐËùÓеÄ×ӽڵ㣻ÿ¸öÉÏÏÂÎͼ»áÓÐÒ»¸öÈë¿Ú½Úµã£¬ÓÃÀ´Í³¼Æµ±Ç°ÉÏÏÂÎĵÄ×ÜÌåÁ÷Á¿Çé¿ö -* OriginNode£ºÊÇÒ»¸öStatisticNodeÀàÐ͵Ľڵ㣬´ú±íÁËͬ¸ö×ÊÔ´ÇëÇóÀ´Ô´µÄÁ÷Á¿Çé¿ö +* name:å��å­— +* entranceNode:调用链入å�£ +* curEntry:当å‰�entry +* origin:调用者æ�¥æº� +* async:异步 + 2ã€�Node: 表示一个节点,这个节点会ä¿�å­˜æŸ�个资æº�çš„å�„个实时统计数æ�®ï¼Œé€šè¿‡è®¿é—®æŸ�个节点,就å�¯ä»¥èŽ·å¾—å¯¹åº”èµ„æº�的实时状æ€�,根æ�®è¿™ä¸ªä¿¡æ�¯æ�¥è¿›è¡Œé™�æµ�å’Œé™�级,它有几ç§�节点类型 +* StatisticNode:实现了Node接å�£ï¼Œå°�装了基础的æµ�é‡�统计和获å�–方法 +* DefaultNode:默认节点,NodeSelectorSlot中创建的就是这个节点;代表å�Œä¸ªèµ„æº�在ä¸�å�Œä¸Šä¸‹æ–‡ä¸­å�„自的æµ�é‡�情况 +* ClusterNode:集群节点,代表å�Œä¸ªèµ„æº�在ä¸�å�Œä¸Šä¸‹æ–‡ä¸­æ€»ä½“çš„æµ�é‡�情况 +* EntranceNode:该节点表示一棵调用链树的入å�£èŠ‚ç‚¹ï¼Œé€šè¿‡ä»–å�¯ä»¥èŽ·å�–调用链树中所有的å­�节点;æ¯�个上下文都会有一个入å�£èŠ‚ç‚¹ï¼Œç”¨æ�¥ç»Ÿè®¡å½“å‰�上下文的总体æµ�é‡�情况 +* OriginNode:是一个StatisticNode类型的节点,代表了å�Œä¸ªèµ„æº�请求æ�¥æº�çš„æµ�é‡�情况 **2.5 StatisticSlot** - ÔÚÕû¸öslotÁ´Â·ÖУ¬±È½ÏÖØÒªµÄ£¬¾ÍÊÇÁ÷Á¿Êý¾Ýͳ¼ÆÒÔ¼°Á÷Á¿¹æÔò¼ì²âÕâÁ½¸öslot£¬ÎÒÃÇÏÈÀ´·ÖÎöÒ»ÏÂStatisticSlotÕâ¸ö¶ÔÏó¡£ + 在整个slot链路中,比较é‡�è¦�的,就是æµ�é‡�æ•°æ�®ç»Ÿè®¡ä»¥å�Šæµ�é‡�规则检测这两个slot,我们先æ�¥åˆ†æž�一下StatisticSlot这个对象。 -StatisticSlotÊÇ Sentinel µÄºËÐŦÄܲå²ÛÖ®Ò»£¬ÓÃÓÚͳ¼ÆÊµÊ±µÄµ÷ÓÃÊý¾Ý¡£ +StatisticSlot是 Sentinel 的核心功能æ�’槽之一,用于统计实时的调用数æ�®ã€‚ -* clusterNode£º×ÊԴΨһ±êʶµÄ ClusterNode µÄ runtime ͳ¼Æ -* origin£º¸ù¾ÝÀ´×Ô²»Í¬µ÷ÓÃÕßµÄͳ¼ÆÐÅÏ¢ -* defaultnode: ¸ù¾ÝÉÏÏÂÎÄÌõÄ¿Ãû³ÆºÍ×ÊÔ´ ID µÄ runtime ͳ¼Æ -* Èë¿ÚµÄͳ¼Æ +* clusterNode:资æº�唯一标识的 ClusterNode çš„ runtime 统计 +* origin:根æ�®æ�¥è‡ªä¸�å�Œè°ƒç”¨è€…的统计信æ�¯ +* defaultnode: æ ¹æ�®ä¸Šä¸‹æ–‡æ�¡ç›®å��称和资æº� ID çš„ runtime 统计 +* å…¥å�£çš„统计 ``` -public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode node, int count, boolean prioritized, Object... args) throws Throwable { try { // ÏȽ»ÓɺóÐøµÄÏÞÁ÷&½µ¼¶µÈprocessorSlot´¦Àí£¬È»ºó¸ù¾Ý´¦Àí½á¹û½øÐÐͳ¼Æ // SentinelÔðÈÎÁ´µÄ¾«»ª£¨²»Ê¹Óà for Ñ­»·±éÀúµ÷Óà ProcessorSlot µÄÔ­Òò£© fireEntry(context, resourceWrapper, node, count, prioritized, args); //Ö´Ðе½ÕâÀï±íʾͨ¹ý¼ì²é£¬²»±»ÏÞÁ÷ // Request passed, add thread count and pass count. node.increaseThreadNum(); //µ±Ç°½ÚµãµÄÇëÇóÏß³ÌÊý¼Ó1 node.addPassRequest(count); //Õë¶Ô²»Í¬ÀàÐ͵Änode¼Ç¼Ïß³ÌÊýÁ¿ºÍÇëÇóͨ¹ýÊýÁ¿µÄͳ¼Æ¡£ if (context.getCurEntry().getOriginNode() != null) { // Add count for origin node. context.getCurEntry().getOriginNode().increaseThreadNum(); context.getCurEntry().getOriginNode().addPassRequest(count); } if (resourceWrapper.getEntryType() == EntryType.IN) { // Add count for global inbound entry node for global statistics. Constants.ENTRY_NODE.increaseThreadNum(); Constants.ENTRY_NODE.addPassRequest(count); } //¿Éµ÷Óà StatisticSlotCallbackRegistry#addEntryCallback ¾²Ì¬·½·¨×¢²áProcessorSlotEntryCallback for (ProcessorSlotEntryCallback handler : StatisticSlotCallbackRegistry.getEntryCallbacks()) { handler.onPass(context, resourceWrapper, node, count, args); } //ÓÅÏȼ¶µÈ´ýÒì³££¬Õâ¸öÔÚFlowRuleÖлáÓÐÉæ¼°µ½¡£ } catch (PriorityWaitException ex) {//Ôö¼ÓÏß³Ìͳ¼Æ node.increaseThreadNum(); if (context.getCurEntry().getOriginNode() != null) { // Add count for origin node. context.getCurEntry().getOriginNode().increaseThreadNum(); } if (resourceWrapper.getEntryType() == EntryType.IN) { // Add count for global inbound entry node for global statistics. Constants.ENTRY_NODE.increaseThreadNum(); } // Handle pass event with registered entry callback handlers. for (ProcessorSlotEntryCallback handler : StatisticSlotCallbackRegistry.getEntryCallbacks()) { handler.onPass(context, resourceWrapper, node, count, args); } } catch (BlockException e) { // Blocked, set block exception to current entry. context.getCurEntry().setBlockError(e); //ÉèÖÃÏÞÁ÷Òì³£µ½µ±Ç°entryÖÐ // Add block count. node.increaseBlockQps(count); //Ôö¼Ó±»ÏÞÁ÷µÄÊýÁ¿ //¸ù¾Ý²»Í¬NodeÀàÐÍÔö¼Ó×èÈûÏÞÁ÷µÄ´ÎÊý if (context.getCurEntry().getOriginNode() != null) { context.getCurEntry().getOriginNode().increaseBlockQps(count); } if (resourceWrapper.getEntryType() == EntryType.IN) { // Add count for global inbound entry node for global statistics. Constants.ENTRY_NODE.increaseBlockQps(count); } // Handle block event with registered entry callback handlers. for (ProcessorSlotEntryCallback handler : StatisticSlotCallbackRegistry.getEntryCallbacks()) { handler.onBlocked(e, context, resourceWrapper, node, count, args); } throw e; } catch (Throwable e) { // Unexpected internal error, set error to current entry. context.getCurEntry().setError(e); throw e; }} +public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode node, int count, boolean prioritized, Object... args) throws Throwable { try { // 先交由å�Žç»­çš„é™�æµ�&é™�级等processorSlot处ç�†ï¼Œç„¶å�Žæ ¹æ�®å¤„ç�†ç»“果进行统计 // Sentinel责任链的精å�Žï¼ˆä¸�使用 for 循环é��历调用 ProcessorSlot 的原因) fireEntry(context, resourceWrapper, node, count, prioritized, args); //执行到这里表示通过检查,ä¸�被é™�æµ� // Request passed, add thread count and pass count. node.increaseThreadNum(); //当å‰�节点的请求线程数加1 node.addPassRequest(count); //针对ä¸�å�Œç±»åž‹çš„node记录线程数é‡�和请求通过数é‡�的统计。 if (context.getCurEntry().getOriginNode() != null) { // Add count for origin node. context.getCurEntry().getOriginNode().increaseThreadNum(); context.getCurEntry().getOriginNode().addPassRequest(count); } if (resourceWrapper.getEntryType() == EntryType.IN) { // Add count for global inbound entry node for global statistics. Constants.ENTRY_NODE.increaseThreadNum(); Constants.ENTRY_NODE.addPassRequest(count); } //å�¯è°ƒç”¨ StatisticSlotCallbackRegistry#addEntryCallback é�™æ€�方法注册ProcessorSlotEntryCallback for (ProcessorSlotEntryCallback handler : StatisticSlotCallbackRegistry.getEntryCallbacks()) { handler.onPass(context, resourceWrapper, node, count, args); } //优先级等待异常,这个在FlowRule中会有涉å�Šåˆ°ã€‚ } catch (PriorityWaitException ex) {//增加线程统计 node.increaseThreadNum(); if (context.getCurEntry().getOriginNode() != null) { // Add count for origin node. context.getCurEntry().getOriginNode().increaseThreadNum(); } if (resourceWrapper.getEntryType() == EntryType.IN) { // Add count for global inbound entry node for global statistics. Constants.ENTRY_NODE.increaseThreadNum(); } // Handle pass event with registered entry callback handlers. for (ProcessorSlotEntryCallback handler : StatisticSlotCallbackRegistry.getEntryCallbacks()) { handler.onPass(context, resourceWrapper, node, count, args); } } catch (BlockException e) { // Blocked, set block exception to current entry. context.getCurEntry().setBlockError(e); //设置é™�æµ�异常到当å‰�entry中 // Add block count. node.increaseBlockQps(count); //增加被é™�æµ�的数é‡� //æ ¹æ�®ä¸�å�ŒNode类型增加阻塞é™�æµ�的次数 if (context.getCurEntry().getOriginNode() != null) { context.getCurEntry().getOriginNode().increaseBlockQps(count); } if (resourceWrapper.getEntryType() == EntryType.IN) { // Add count for global inbound entry node for global statistics. Constants.ENTRY_NODE.increaseBlockQps(count); } // Handle block event with registered entry callback handlers. for (ProcessorSlotEntryCallback handler : StatisticSlotCallbackRegistry.getEntryCallbacks()) { handler.onBlocked(e, context, resourceWrapper, node, count, args); } throw e; } catch (Throwable e) { // Unexpected internal error, set error to current entry. context.getCurEntry().setError(e); throw e; }} ``` @@ -288,24 +288,24 @@ public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode -´úÂë·Ö³ÉÁËÁ½²¿·Ö£¬µÚÒ»²¿·ÖÊÇentry·½·¨£¬¸Ã·½·¨Ê×ÏȻᴥ·¢ºóÐøslotµÄentry·½·¨£¬¼´SystemSlot¡¢FlowSlot¡¢DegradeSlotµÈµÄ¹æÔò£¬Èç¹û¹æÔò²»Í¨¹ý£¬¾Í»áÅ׳öBlockException£¬Ôò»áÔÚnodeÖÐͳ¼Æ±»blockµÄÊýÁ¿¡£·´Ö®»áÔÚnodeÖÐͳ¼ÆÍ¨¹ýµÄÇëÇóÊýºÍÏß³ÌÊýµÈÐÅÏ¢¡£µÚ¶þ²¿·ÖÊÇÔÚexit·½·¨ÖУ¬µ±Í˳ö¸ÃEntryÈë¿Úʱ£¬»áͳ¼ÆrtµÄʱ¼ä£¬²¢¼õÉÙÏß³ÌÊý¡£ +代ç �分æˆ�了两部分,第一部分是entry方法,该方法首先会触å�‘å�Žç»­slotçš„entry方法,å�³SystemSlotã€�FlowSlotã€�DegradeSlot等的规则,如果规则ä¸�通过,就会抛出BlockException,则会在node中统计被block的数é‡�。å��之会在node中统计通过的请求数和线程数等信æ�¯ã€‚第二部分是在exit方法中,当退出该Entryå…¥å�£æ—¶ï¼Œä¼šç»Ÿè®¡rt的时间,并å‡�少线程数。 -ÎÒÃÇ¿ÉÒÔ¿´µ½ node.addPassRequest() Õâ¶Î´úÂëÊÇÔÚfireEntryÖ´ÐÐÖ®ºóÖ´Ðеģ¬ÕâÒâζ×Å£¬µ±Ç°ÇëÇóͨ¹ýÁËsentinelµÄÁ÷¿ØµÈ¹æÔò£¬´ËʱÐèÒª½«µ±´ÎÇëÇó¼Ç¼ÏÂÀ´£¬Ò²¾ÍÊÇÖ´ÐÐ node.addPassRequest()ÕâÐдúÂ룬ÎÒÃǸú½øÈ¥¿´¿´£º +我们å�¯ä»¥çœ‹åˆ° node.addPassRequest() 这段代ç �是在fireEntry执行之å�Žæ‰§è¡Œçš„,这æ„�味ç�€ï¼Œå½“å‰�请求通过了sentinelçš„æµ�控等规则,此时需è¦�将当次请求记录下æ�¥ï¼Œä¹Ÿå°±æ˜¯æ‰§è¡Œ node.addPassRequest()这行代ç �,我们跟进去看看: **2.5.1 addPassRequest** -@Overridepublic void addPassRequest(int count) { // µ÷Óø¸ÀࣨStatisticNode£©À´½øÐÐͳ¼Æ super.addPassRequest(count); // ¸ù¾ÝclusterNode »ã×Üͳ¼Æ£¨±³ºóÒ²Êǵ÷Óø¸ÀàStatisticNode£© this.clusterNode.addPassRequest(count);} -Ê×ÏÈÎÒÃÇÖªµÀÕâÀïµÄnodeÊÇÒ»¸ö DefaultNode ʵÀý£¬ÔÚµÚÒ»¸öNodeSelectorSlot µÄentry·½·¨ÖжÔ×ÊÔ´½øÐÐÁË·â×°£¬·â×°³ÉÁËÒ»¸öDefaultNode¡£ +@Overridepublic void addPassRequest(int count) { // 调用父类(StatisticNode)æ�¥è¿›è¡Œç»Ÿè®¡ super.addPassRequest(count); // æ ¹æ�®clusterNode 汇总统计(背å�Žä¹Ÿæ˜¯è°ƒç”¨çˆ¶ç±»StatisticNode) this.clusterNode.addPassRequest(count);} +首先我们知é�“这里的node是一个 DefaultNode 实例,在第一个NodeSelectorSlot çš„entry方法中对资æº�进行了å°�装,å°�装æˆ�了一个DefaultNode。 -* DefaultNode£º±£´æ×Åij¸öresourceÔÚij¸öcontextÖеÄʵʱָ±ê£¬Ã¿¸öDefaultNode¶¼Ö¸ÏòÒ»¸öClusterNode -* ClusterNode£º±£´æ×Åij¸öresourceÔÚËùÓеÄcontextÖÐʵʱָ±êµÄ×ܺͣ¬Í¬ÑùµÄresource»á¹²Ïíͬһ¸öClusterNode£¬²»¹ÜËûÔÚÄĸöcontextÖÐ - ·Ö±ðµ÷ÓÃÁ½¸öʱ¼ä´°¿ÚÀ´µÝÔöÇëÇóÊýÁ¿¡£ +* DefaultNode:ä¿�å­˜ç�€æŸ�个resource在æŸ�个context中的实时指标,æ¯�个DefaultNode都指å�‘一个ClusterNode +* ClusterNode:ä¿�å­˜ç�€æŸ�个resource在所有的context中实时指标的总和,å�Œæ ·çš„resource会共享å�Œä¸€ä¸ªClusterNode,ä¸�管他在哪个context中 + 分别调用两个时间窗å�£æ�¥é€’增请求数é‡�。 -ÄÚ²¿Êµ¼Êµ÷ÓõÄÊÇArrayMetricÀ´½øÐÐÇëÇóÊýÁ¿µÄͳ¼Æ +内部实际调用的是ArrayMetricæ�¥è¿›è¡Œè¯·æ±‚æ•°é‡�的统计 ``` -//°´ÕÕÃëÀ´Í³¼Æ£¬·Ö³ÉÁ½¸ö´°¿Ú£¬Ã¿¸ö´°¿Ú500ms£¬ÓÃÀ´Í³¼ÆQPSprivate transient volatile Metric rollingCounterInSecond = new ArrayMetric(SampleCountProperty.SAMPLE_COUNT, IntervalProperty.INTERVAL);//°´ÕÕ·ÖÖÓͳ¼Æ£¬Éú³É60¸ö´°¿Ú£¬Ã¿¸ö´°¿Ú1000msprivate transient Metric rollingCounterInMinute = new ArrayMetric(60, 60 * 1000, false);public void addPassRequest(int count) { rollingCounterInSecond.addPass(count); rollingCounterInMinute.addPass(count);} +//按照秒æ�¥ç»Ÿè®¡ï¼Œåˆ†æˆ�两个窗å�£ï¼Œæ¯�个窗å�£500ms,用æ�¥ç»Ÿè®¡QPSprivate transient volatile Metric rollingCounterInSecond = new ArrayMetric(SampleCountProperty.SAMPLE_COUNT, IntervalProperty.INTERVAL);//按照分钟统计,生æˆ�60个窗å�£ï¼Œæ¯�个窗å�£1000msprivate transient Metric rollingCounterInMinute = new ArrayMetric(60, 60 * 1000, false);public void addPassRequest(int count) { rollingCounterInSecond.addPass(count); rollingCounterInMinute.addPass(count);} ``` @@ -316,25 +316,25 @@ public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode -ÕâÀï²ÉÓõÄÊÇ»¬¶¯´°¿ÚµÄ·½Ê½À´¼Ç¼ÇëÇóµÄ´ÎÊý¡£![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e4624bb214fd8020d1447098c8cde98a554e59.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")Õû¸öÀàµÄ¹ØÏµÍ¼Êµ¼ÊÉÏÊDZȽÏÇåÎúµÄ£¬ArrayMetricʵ¼ÊÉÏÊÇÒ»¸ö°ü×°À࣬ÄÚ²¿Í¨¹ýLeapArrayÀ´ÊµÏÖ¾ßÌåµÄͳ¼ÆÂß¼­£¬¶øLeapArrayÖÐά»¤Á˶à¸öWindowWrap£¨»¬¶¯´°¿Ú£©£¬¶øWindowWrapÖвÉÓÃÁËMetricBucketÀ´½øÐÐÖ¸±êÊý¾ÝµÄͳ¼Æ¡£ +这里采用的是滑动窗å�£çš„æ–¹å¼�æ�¥è®°å½•请求的次数。![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/e4624bb214fd8020d1447098c8cde98a554e59.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")整个类的关系图实际上是比较清晰的,ArrayMetric实际上是一个包装类,内部通过LeapArrayæ�¥å®žçŽ°å…·ä½“çš„ç»Ÿè®¡é€»è¾‘ï¼Œè€ŒLeapArray中维护了多个WindowWrap(滑动窗å�£ï¼‰ï¼Œè€ŒWindowWrap中采用了MetricBucketæ�¥è¿›è¡ŒæŒ‡æ ‡æ•°æ�®çš„统计。 -* Metric: Ö¸±êÊÕ¼¯µÄ½Ó¿Ú£¬¶¨Ò廬¶¯´°¿ÚÖгɹ¦ÊýÁ¿¡¢Òì³£ÊýÁ¿¡¢×èÈûÊýÁ¿¡¢TPS¡¢ÏìӦʱ¼äµÈÊý¾Ý -* ArrayMetric »¬¶¯´°¿ÚºËÐÄʵÏÖÀà +* Metric: 指标收集的接å�£ï¼Œå®šä¹‰æ»‘动窗å�£ä¸­æˆ�功数é‡�ã€�异常数é‡�ã€�阻塞数é‡�ã€�TPSã€�å“�应时间等数æ�® +* ArrayMetric 滑动窗å�£æ ¸å¿ƒå®žçŽ°ç±» * LeapArray -* WindowWrap ÿһ¸ö»¬¶¯´°¿ÚµÄ°ü×°À࣬ÄÚ²¿µÄÊý¾Ý½á¹¹²ÉÓÃMetricBucket -* MetricBucket£¬ ±íʾָ±êͰ£¬°üº¬×èÈûÊýÁ¿¡¢Òì³£ÊýÁ¿¡¢³É¹¦Êý¡¢ÏìӦʱ¼äµÈ -* MetricEvent Ö¸±êÀàÐÍ£¬Í¨¹ýÊý¡¢×èÈûÊý¡¢Òì³£Êý¡¢³É¹¦ÊýµÈ +* WindowWrap æ¯�一个滑动窗å�£çš„包装类,内部的数æ�®ç»“构采用MetricBucket +* MetricBucket, 表示指标桶,包å�«é˜»å¡žæ•°é‡�ã€�异常数é‡�ã€�æˆ�功数ã€�å“�应时间等 +* MetricEvent 指标类型,通过数ã€�阻塞数ã€�异常数ã€�æˆ�功数等 **2.5.2 ArrayMetric.addPass** - ¼ÌÐøÑØ×Å´úÂëÍùÏ¿´£¬½øÈëµ½ArrayMetric.addPass·½·¨¡£ -* ´ÓLeapArrayÖиù¾Ýµ±Ç°Ê±¼äµãµÃµ½¶ÔÓ¦µÄ´°¿Ú -* µ÷ÓÃMetricBucketÖеÄaddPass·½·¨£¬Ôö¼Óµ±Ç°´°¿ÚÖеÄͳ¼Æ´ÎÊý + 继续沿ç�€ä»£ç �往下看,进入到ArrayMetric.addPass方法。 +* 从LeapArray中根æ�®å½“å‰�时间点得到对应的窗å�£ +* 调用MetricBucket中的addPass方法,增加当å‰�窗å�£ä¸­çš„统计次数 -´Ó´úÂëÖÐÎÒÃÇ¿ÉÒÔ¿´µ½£¬Ôö¼ÓÖ¸±êµ÷Óà addPass ÊÇͨ¹ýÒ»¸ö½Ð ArrayMetric µÄÀ࣬ÏÖÔÚÎÒÃÇÔÚ½øÈë ArrayMetric Öп´Ò»Ï¡£¾ßÌåµÄ´úÂëÈçÏÂËùʾ£º +从代ç �中我们å�¯ä»¥çœ‹åˆ°ï¼Œå¢žåŠ æŒ‡æ ‡è°ƒç”¨ addPass 是通过一个å�« ArrayMetric 的类,现在我们在进入 ArrayMetric 中看一下。具体的代ç �如下所示: ``` -private final LeapArray data;// SAMPLE_COUNT=2 INTERVAL=1000public ArrayMetric(int sampleCount, int intervalInMs) { //ÕâÁ½¸ö²ÎÊý±íʾ£¬»¬¶¯´°¿ÚµÄ´óСÊÇ2¸ö£¬Ã¿Ò»¸ö»¬¶¯´°¿ÚµÄʱ¼äµ¥Î»ÊÇ500ms this.data = new OccupiableBucketLeapArray(sampleCount, intervalInMs);}public void addPass(int count) { WindowWrap wrap = data.currentWindow(); wrap.value().addPass(count);} +private final LeapArray data;// SAMPLE_COUNT=2 INTERVAL=1000public ArrayMetric(int sampleCount, int intervalInMs) { //这两个å�‚数表示,滑动窗å�£çš„大å°�是2个,æ¯�一个滑动窗å�£çš„æ—¶é—´å�•ä½�是500ms this.data = new OccupiableBucketLeapArray(sampleCount, intervalInMs);}public void addPass(int count) { WindowWrap wrap = data.currentWindow(); wrap.value().addPass(count);} ``` @@ -345,12 +345,12 @@ private final LeapArray data;// SAMPLE_COUNT=2 INTERVAL=1000publi -ÕâÀïÖÕÓÚ³öÏÖÁËÓ뻬¶¯´°¿ÚÓÐÄÇôµã¹ØÁªµÄ windowÁË£¬window²»¾ÍÊÇ´°»§ÂÕâÀïͨ¹ý data À´»ñÈ¡µ±Ç°´°¿Ú¡£¶øÕâÀïµÄ´°¿Ú´óСΪ sampleCount=2.ÎÒÃÇ¿ÉÒÔ¿´µ½£¬ÕâÀïÊÇͨ¹ý MetricBucket À´±£´æ¸÷ÏîÖ¸±ê£¬ÆäÖÐά»¤ÁËÒ»¸öͳ¼ÆÊÇÊý×éLongAdder[] counters À´±£´æ£¬¶ø WindowWrap£¬ÎÒÃÇ¿ÉÒÔ¿´µ½Ã¿Ò»¸ö WindowWrap¶ÔÏóÓÉÈý¸ö²¿·Ö×é³É£º +这里终于出现了与滑动窗å�£æœ‰é‚£ä¹ˆç‚¹å…³è�”çš„ window了,windowä¸�就是窗户嘛,这里通过 data æ�¥èŽ·å�–当å‰�窗å�£ã€‚而这里的窗å�£å¤§å°�为 sampleCount=2.我们å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œæ˜¯é€šè¿‡ MetricBucket æ�¥ä¿�å­˜å�„项指标,其中维护了一个统计是数组LongAdder[] counters æ�¥ä¿�存,而 WindowWrap,我们å�¯ä»¥çœ‹åˆ°æ¯�一个 WindowWrap对象由三个部分组æˆ�: ``` -public class WindowWrap {¡¡¡¡// ʱ¼ä´°¿ÚµÄ³¤¶È private final long windowLengthInMs;¡¡¡¡// ʱ¼ä´°¿ÚµÄ¿ªÊ¼Ê±¼ä£¬µ¥Î»ÊǺÁÃë private long windowStart;¡¡¡¡ //ʱ¼ä´°¿ÚµÄÄÚÈÝ£¬ÔÚ WindowWrap ÖÐÊÇÓ÷ºÐͱíʾÕâ¸öÖµµÄ£¬µ«Êµ¼ÊÉϾÍÊÇ MetricBucket Àà private T value; //......Ê¡ÂÔ²¿·Ö´úÂë} +public class WindowWrap {  // 时间窗å�£çš„长度 private final long windowLengthInMs;  // 时间窗å�£çš„开始时间,å�•ä½�是毫秒 private long windowStart;   //时间窗å�£çš„内容,在 WindowWrap 中是用泛型表示这个值的,但实际上就是 MetricBucket ç±» private T value; //......çœ�略部分代ç �} ``` @@ -361,12 +361,12 @@ public class WindowWrap { -ÔÙ¿´ LeapArray Õâ¸öÀࣺ +å†�看 LeapArray 这个类: ``` -public abstract class LeapArray { // ʱ¼ä´°¿ÚµÄ³¤¶È protected int windowLength; // ²ÉÑù´°¿ÚµÄ¸öÊý protected int sampleCount; // ÒÔºÁÃëΪµ¥Î»µÄʱ¼ä¼ä¸ô protected int intervalInMs; // ²ÉÑùµÄʱ¼ä´°¿ÚÊý×é protected AtomicReferenceArray> array; /** * LeapArray¶ÔÏó * @param windowLength ʱ¼ä´°¿ÚµÄ³¤¶È£¬µ¥Î»£ººÁÃë * @param intervalInSec ͳ¼ÆµÄ¼ä¸ô£¬µ¥Î»£ºÃë */ public LeapArray(int windowLength, int intervalInSec) { this.windowLength = windowLength; // ʱ¼ä´°¿ÚµÄ²ÉÑù¸öÊý£¬Ä¬ÈÏΪ2¸ö²ÉÑù´°¿Ú this.sampleCount = intervalInSec * 1000 / windowLength; this.intervalInMs = intervalInSec * 1000;//ÔÚÒÔÃëΪµ¥Î»µÄʱ¼ä´°¿ÚÖУ¬»á³õʼ»¯Á½¸ö³¤¶ÈµÄÊý×飺`AtomicReferenceArray>array`£¬Õâ¸öÊý×é±íʾ»¬¶¯´°¿ÚµÄ´óС¡£ÆäÖУ¬Ã¿¸ö´°¿Ú»áÕ¼ÓÃ500msµÄʱ¼ä¡£ this.array = new AtomicReferenceArray>(sampleCount); }} +public abstract class LeapArray { // 时间窗å�£çš„长度 protected int windowLength; // 采样窗å�£çš„个数 protected int sampleCount; // 以毫秒为å�•ä½�的时间间隔 protected int intervalInMs; // 采样的时间窗å�£æ•°ç»„ protected AtomicReferenceArray> array; /** * LeapArray对象 * @param windowLength 时间窗å�£çš„长度,å�•ä½�:毫秒 * @param intervalInSec 统计的间隔,å�•ä½�:秒 */ public LeapArray(int windowLength, int intervalInSec) { this.windowLength = windowLength; // 时间窗å�£çš„采样个数,默认为2个采样窗å�£ this.sampleCount = intervalInSec * 1000 / windowLength; this.intervalInMs = intervalInSec * 1000;//在以秒为å�•ä½�的时间窗å�£ä¸­ï¼Œä¼šåˆ�始化两个长度的数组:`AtomicReferenceArray>array`,这个数组表示滑动窗å�£çš„大å°�。其中,æ¯�个窗å�£ä¼šå� ç”¨500ms的时间。 this.array = new AtomicReferenceArray>(sampleCount); }} ``` @@ -377,7 +377,7 @@ public abstract class LeapArray { // ʱ -¿ÉÒÔºÜÇåÎúµÄ¿´³öÀ´ÔÚ LeapArray Öд´½¨ÁËÒ»¸ö AtomicReferenceArray Êý×飬ÓÃÀ´¶Ôʱ¼ä´°¿ÚÖеÄͳ¼ÆÖµ½øÐвÉÑù¡£Í¨¹ý²ÉÑùµÄͳ¼ÆÖµÔÙ¼ÆËã³öƽ¾ùÖµ£¬¾ÍÊÇÎÒÃÇÐèÒªµÄ×îÖÕµÄʵʱָ±êµÄÖµÁË¡£¿ÉÒÔ¿´µ½ÎÒÔÚÉÏÃæµÄ´úÂëÖÐͨ¹ý×¢ÊÍ£¬±êÃ÷ÁËĬÈϲÉÑùµÄʱ¼ä´°¿ÚµÄ¸öÊýÊÇ2¸ö£¬Õâ¸öÖµÊÇÔõôµÃµ½µÄÄØ£¿ÎÒÃÇ»ØÒäһϠLeapArray ¶ÔÏó´´½¨£¬ÊÇͨ¹ýÔÚ StatisticNode ÖУ¬newÁËÒ»¸ö ArrayMetric£¬È»ºó½«²ÎÊýһ·ÍùÉÏ´«µÝºó´´½¨µÄ£º +å�¯ä»¥å¾ˆæ¸…晰的看出æ�¥åœ¨ LeapArray 中创建了一个 AtomicReferenceArray 数组,用æ�¥å¯¹æ—¶é—´çª—å�£ä¸­çš„统计值进行采样。通过采样的统计值å†�计算出平å�‡å€¼ï¼Œå°±æ˜¯æˆ‘们需è¦�的最终的实时指标的值了。å�¯ä»¥çœ‹åˆ°æˆ‘在上é�¢çš„代ç �中通过注释,标明了默认采样的时间窗å�£çš„个数是2个,这个值是怎么得到的呢?我们回忆一下 LeapArray 对象创建,是通过在 StatisticNode 中,new了一个 ArrayMetric,然å�Žå°†å�‚数一路往上传递å�Žåˆ›å»ºçš„: @@ -394,12 +394,12 @@ private transient volatile Metric rollingCounterInSecond = new ArrayMetric(Sampl **2.5.3 currentWindow** -ÎÒÃǸú½ø»ñÈ¡µ±Ç°´°¿ÚµÄ·½·¨ data.currentWindow() ÖУº +我们跟进获å�–当å‰�窗å�£çš„æ–¹æ³• data.currentWindow() 中: ``` -@Overridepublic WindowWrap currentWindow(long time) { .....//Ê¡ÂÔ²¿·Ö´úÂë //¼ÆË㵱ǰʱ¼äÔÚ»¬¶¯´°¿ÚÖеÄË÷Òý£¬¼ÆË㷽ʽ±È½Ï¼òµ¥£¬µ±Ç°Ê±¼ä³ýÒÔµ¥¸öʱ¼ä´°¿ÚµÄʱ¼ä³¤¶È£¬ÔÙ´ÓÕû¸öʱ¼ä´°¿Ú³¤¶È½øÐÐȡģ¡¡¡¡ int idx = calculateTimeIdx(timeMillis); //¼ÆË㵱ǰʱ¼äÔÚʱ¼ä´°¿ÚÖеĿªÊ¼Ê±¼ä long windowStart = calculateWindowStart(timeMillis); // timeÿÔö¼ÓÒ»¸öwindowLengthµÄ³¤¶È£¬timeId¾Í»áÔö¼Ó1£¬Ê±¼ä´°¿Ú¾Í»áÍùǰ»¬¶¯Ò»¸ö while (true) { // ´Ó²ÉÑùÊý×éÖиù¾ÝË÷Òý»ñÈ¡»º´æµÄʱ¼ä´°¿Ú WindowWrap old = array.get(idx); // arrayÊý×鳤¶È²»Ò˹ý´ó£¬·ñÔòoldºÜ¶àÇé¿ö϶¼ÃüÖв»ÁË£¬¾Í»á´´½¨ºÜ¶à¸öWindowWrap¶ÔÏó //Èç¹ûΪ¿Õ£¬ËµÃ÷´Ë´¦»¹Î´³õʼ»¯ if (old == null) { // Èç¹ûûÓлñÈ¡µ½£¬Ôò´´½¨Ò»¸öÐ嵀 WindowWrap window = new WindowWrap(windowLength, currentWindowStart, new Window()); // ͨ¹ýCAS½«Ð´°¿ÚÉèÖõ½Êý×éÖÐÈ¥ if (array.compareAndSet(idx, null, window)) { // Èç¹ûÄÜÉèÖóɹ¦£¬Ôò½«¸Ã´°¿Ú·µ»Ø return window; } else { // ·ñÔòµ±Ç°Ïß³ÌÈóöʱ¼äƬ£¬µÈ´ý Thread.yield(); } // Èç¹ûµ±Ç°´°¿ÚµÄ¿ªÊ¼Ê±¼äÓëoldµÄ¿ªÊ¼Ê±¼äÏàµÈ£¬ÔòÖ±½Ó·µ»Øold´°¿Ú } else if (currentWindowStart == old.windowStart()) { return old; // Èç¹ûµ±Ç°Ê±¼ä´°¿ÚµÄ¿ªÊ¼Ê±¼äÒѾ­³¬¹ýÁËold´°¿ÚµÄ¿ªÊ¼Ê±¼ä£¬Ôò·ÅÆúold´°¿Ú // ²¢½«timeÉèÖÃΪеÄʱ¼ä´°¿ÚµÄ¿ªÊ¼Ê±¼ä£¬´Ëʱ´°¿ÚÏòǰ»¬¶¯ } else if (currentWindowStart > old.windowStart()) { if (addLock.tryLock()) { try { // if (old is deprecated) then [LOCK] resetTo currentTime. return resetWindowTo(old, currentWindowStart); } finally { addLock.unlock(); } } else { Thread.yield(); } // Õâ¸öÌõ¼þ²»¿ÉÄÜ´æÔÚ } else if (currentWindowStart < old.windowStart()) { // Cannot go through here. return new WindowWrap(windowLength, currentWindowStart, new Window()); } }} +@Overridepublic WindowWrap currentWindow(long time) { .....//çœ�略部分代ç � //计算当å‰�时间在滑动窗å�£ä¸­çš„索引,计算方å¼�比较简å�•,当å‰�时间除以å�•个时间窗å�£çš„æ—¶é—´é•¿åº¦ï¼Œå†�从整个时间窗å�£é•¿åº¦è¿›è¡Œå�–模   int idx = calculateTimeIdx(timeMillis); //计算当å‰�时间在时间窗å�£ä¸­çš„开始时间 long windowStart = calculateWindowStart(timeMillis); // timeæ¯�增加一个windowLength的长度,timeId就会增加1,时间窗å�£å°±ä¼šå¾€å‰�滑动一个 while (true) { // 从采样数组中根æ�®ç´¢å¼•获å�–缓存的时间窗å�£ WindowWrap old = array.get(idx); // array数组长度ä¸�宜过大,å�¦åˆ™old很多情况下都命中ä¸�了,就会创建很多个WindowWrap对象 //如果为空,说明此处还未åˆ�始化 if (old == null) { // 如果没有获å�–到,则创建一个新的 WindowWrap window = new WindowWrap(windowLength, currentWindowStart, new Window()); // 通过CAS将新窗å�£è®¾ç½®åˆ°æ•°ç»„中去 if (array.compareAndSet(idx, null, window)) { // 如果能设置æˆ�功,则将该窗å�£è¿”回 return window; } else { // å�¦åˆ™å½“å‰�线程让出时间片,等待 Thread.yield(); } // 如果当å‰�窗å�£çš„开始时间与old的开始时间相等,则直接返回old窗å�£ } else if (currentWindowStart == old.windowStart()) { return old; // 如果当å‰�时间窗å�£çš„开始时间已ç»�超过了old窗å�£çš„开始时间,则放弃old窗å�£ // å¹¶å°†time设置为新的时间窗å�£çš„开始时间,此时窗å�£å�‘å‰�滑动 } else if (currentWindowStart > old.windowStart()) { if (addLock.tryLock()) { try { // if (old is deprecated) then [LOCK] resetTo currentTime. return resetWindowTo(old, currentWindowStart); } finally { addLock.unlock(); } } else { Thread.yield(); } // 这个æ�¡ä»¶ä¸�å�¯èƒ½å­˜åœ¨ } else if (currentWindowStart < old.windowStart()) { // Cannot go through here. return new WindowWrap(windowLength, currentWindowStart, new Window()); } }} ``` @@ -410,23 +410,23 @@ private transient volatile Metric rollingCounterInSecond = new ArrayMetric(Sampl -´úÂëºÜ³¤£¬ÎÒÃÇÖð²½½«Æä·Ö½â£¬ÎÒÃÇʵ¼Ê¿ÉÒÔ°ÑËû·Ö³ÉÒÔϼ¸²½£º +代ç �很长,我们é€�步将其分解,我们实际å�¯ä»¥æŠŠä»–分æˆ�以下几步: -1. ¸ù¾Ýµ±Ç°Ê±¼ä£¬Ëã³ö¸Ãʱ¼äµÄtimeId£¬²¢¸ù¾ÝtimeIdËã³öµ±Ç°´°¿ÚÔÚ²ÉÑù´°¿ÚÊý×éÖеÄË÷Òýidx¡£ -2. ¸ù¾Ýµ±Ç°Ê±¼äËã³öµ±Ç°´°¿ÚµÄÓ¦¸Ã¶ÔÓ¦µÄ¿ªÊ¼Ê±¼ätime£¬ÒÔºÁÃëΪµ¥Î»¡£ -3. ¸ù¾ÝË÷Òýidx£¬ÔÚ²ÉÑù´°¿ÚÊý×éÖÐÈ¡µÃÒ»¸öʱ¼ä´°¿Ú¡£ -4. Ñ­»·ÅжÏÖ±µ½»ñÈ¡µ½Ò»¸öµ±Ç°Ê±¼ä´°¿Ú old ¡£ +1. æ ¹æ�®å½“å‰�时间,算出该时间的timeId,并根æ�®timeId算出当å‰�窗å�£åœ¨é‡‡æ ·çª—å�£æ•°ç»„中的索引idx。 +2. æ ¹æ�®å½“å‰�时间算出当å‰�窗å�£çš„应该对应的开始时间time,以毫秒为å�•ä½�。 +3. æ ¹æ�®ç´¢å¼•idx,在采样窗å�£æ•°ç»„中å�–得一个时间窗å�£ã€‚ +4. 循环判断直到获å�–到一个当å‰�时间窗å�£ old 。 -* Èç¹ûoldΪ¿Õ£¬Ôò´´½¨Ò»¸öʱ¼ä´°¿Ú£¬²¢½«Ëü²åÈëµ½arrayµÄµÚidx¸öλÖã¬arrayÉÏÃæÒѾ­·ÖÎö¹ýÁË£¬ÊÇÒ»¸ö AtomicReferenceArray¡£ -* Èç¹ûµ±Ç°´°¿ÚµÄ¿ªÊ¼Ê±¼ätimeÓëoldµÄ¿ªÊ¼Ê±¼äÏàµÈ£¬ÄÇô˵Ã÷old¾ÍÊǵ±Ç°Ê±¼ä´°¿Ú£¬Ö±½Ó·µ»Øold¡£ -* Èç¹ûµ±Ç°´°¿ÚµÄ¿ªÊ¼Ê±¼ätime´óÓÚoldµÄ¿ªÊ¼Ê±¼ä£¬Ôò˵Ã÷old´°¿ÚÒѾ­¹ýʱÁË£¬½«oldµÄ¿ªÊ¼Ê±¼ä¸üÐÂΪ×îÐÂÖµ£ºtime£¬½øÈëÏÂÒ»´ÎµÃÑ­»·ÔÙÅжϵ±Ç°´°¿ÚµÄ¿ªÊ¼Ê±¼ätimeÓëoldµÄ¿ªÊ¼Ê±¼äÏàµÈµÄʱºò·µ»Ø¡£ -* Èç¹ûµ±Ç°´°¿ÚµÄ¿ªÊ¼Ê±¼ätimeСÓÚoldµÄ¿ªÊ¼Ê±¼ä£¬Êµ¼ÊÉÏÕâÖÖÇé¿öÊDz»¿ÉÄÜ´æÔڵģ¬ÒòΪtimeÊǵ±Ç°Ê±¼ä£¬oldÊǹýÈ¥µÄÒ»¸öʱ¼ä¡£ - ÁíÍâtimeIdÊÇ»áËæ×Åʱ¼äµÄÔö³¤¶øÔö¼Ó£¬µ±Ç°Ê±¼äÿÔö³¤Ò»¸öwindowLengthµÄ³¤¶È£¬timeId¾Í¼Ó1¡£µ«ÊÇidx²»»áÔö³¤£¬Ö»»áÔÚ0ºÍ1Ö®¼ä±ä»»£¬ÒòΪarrayÊý×éµÄ³¤¶ÈÊÇ2£¬Ö»ÓÐÁ½¸ö²ÉÑùʱ¼ä´°¿Ú¡£ÖÁÓÚΪʲôĬÈÏÖ»ÓÐÁ½¸ö²ÉÑù´°¿Ú£¬¸öÈ˾õµÃÒòΪsentinelÊDZȽÏÇáÁ¿µÄ¿ò¼Ü¡£Ê±¼ä´°¿ÚÖб£´æ×źܶàͳ¼ÆÊý¾Ý£¬Èç¹ûʱ¼ä´°¿Ú¹ý¶àµÄ»°£¬Ò»·½Ãæ»áÕ¼Óùý¶àÄڴ棬ÁíÒ»·½ÃæÊ±¼ä´°¿Ú¹ý¶à¾ÍÒâζ×Åʱ¼ä´°¿ÚµÄ³¤¶È»á±äС£¬Èç¹ûʱ¼ä´°¿Ú³¤¶È±äС£¬¾Í»áµ¼ÖÂʱ¼ä´°¿Ú¹ýÓÚÆµ·±µÄ»¬¶¯¡£ÏÈÀ´¿´Ò»ÏÂÆäÖеĵÚÒ»²½¼°µÚ¶þ²½£º +* 如果old为空,则创建一个时间窗å�£ï¼Œå¹¶å°†å®ƒæ�’入到array的第idx个ä½�置,array上é�¢å·²ç»�分æž�过了,是一个 AtomicReferenceArray。 +* 如果当å‰�窗å�£çš„开始时间time与old的开始时间相等,那么说明old就是当å‰�时间窗å�£ï¼Œç›´æŽ¥è¿”回old。 +* 如果当å‰�窗å�£çš„开始时间time大于old的开始时间,则说明old窗å�£å·²ç»�过时了,将old的开始时间更新为最新值:time,进入下一次得循环å†�判断当å‰�窗å�£çš„开始时间time与old的开始时间相等的时候返回。 +* 如果当å‰�窗å�£çš„开始时间timeå°�于old的开始时间,实际上这ç§�情况是ä¸�å�¯èƒ½å­˜åœ¨çš„,因为time是当å‰�时间,old是过去的一个时间。 + å�¦å¤–timeId是会éš�ç�€æ—¶é—´çš„增长而增加,当å‰�æ—¶é—´æ¯�增长一个windowLength的长度,timeId就加1。但是idxä¸�会增长,å�ªä¼šåœ¨0å’Œ1之间å�˜æ�¢ï¼Œå› ä¸ºarray数组的长度是2,å�ªæœ‰ä¸¤ä¸ªé‡‡æ ·æ—¶é—´çª—å�£ã€‚至于为什么默认å�ªæœ‰ä¸¤ä¸ªé‡‡æ ·çª—å�£ï¼Œä¸ªäººè§‰å¾—因为sentinel是比较轻é‡�的框架。时间窗å�£ä¸­ä¿�å­˜ç�€å¾ˆå¤šç»Ÿè®¡æ•°æ�®ï¼Œå¦‚果时间窗å�£è¿‡å¤šçš„è¯�,一方é�¢ä¼šå� ç”¨è¿‡å¤šå†…存,å�¦ä¸€æ–¹é�¢æ—¶é—´çª—å�£è¿‡å¤šå°±æ„�味ç�€æ—¶é—´çª—å�£çš„长度会å�˜å°�,如果时间窗å�£é•¿åº¦å�˜å°�,就会导致时间窗å�£è¿‡äºŽé¢‘ç¹�的滑动。先æ�¥çœ‹ä¸€ä¸‹å…¶ä¸­çš„第一步å�Šç¬¬äºŒæ­¥ï¼š ``` -private int calculateTimeIdx(/*@Valid*/ long timeMillis) { // timeÿÔö¼ÓÒ»¸öwindowLengthµÄ³¤¶È£¬timeId¾Í»áÔö¼Ó1£¬Ê±¼ä´°¿Ú¾Í»áÍùǰ»¬¶¯Ò»¸ö long timeId = timeMillis / windowLengthInMs; // idx±»·Ö³É[0,arrayLength-1]ÖеÄijһ¸öÊý£¬×÷ΪarrayÊý×éÖеÄË÷Òý return (int)(timeId % array.length());}protected long calculateWindowStart(/*@Valid*/ long timeMillis) { return timeMillis - timeMillis % windowLengthInMs;} +private int calculateTimeIdx(/*@Valid*/ long timeMillis) { // timeæ¯�增加一个windowLength的长度,timeId就会增加1,时间窗å�£å°±ä¼šå¾€å‰�滑动一个 long timeId = timeMillis / windowLengthInMs; // idx被分æˆ�[0,arrayLength-1]中的æŸ�一个数,作为array数组中的索引 return (int)(timeId % array.length());}protected long calculateWindowStart(/*@Valid*/ long timeMillis) { return timeMillis - timeMillis % windowLengthInMs;} ``` @@ -437,16 +437,16 @@ private int calculateTimeIdx(/*@Valid*/ long timeMillis) { // timeÿ -¸ù¾Ýµ±Ç°Ê±¼ä³ýÓÚ windowLength µÃµ½Ò»¸ö timeId(Ïà²î500ms¼ÆËã³öÀ´µÄÖµ½«ÊÇÒ»ÖµÄ),ÔÙÓÃtimeId¸úÈ¡Ñù´°¿ÚµÄ³¤¶È½øÐÐÒ»¸öȡ죬ÄÇôËýÒ»¶¨»áÂäÔÚ 0£¬1Á½¸öλÖÃµÄÆäÖÐÒ»¸ö¡£È»ºó¸ù¾Ýµ±Ç°Ê±¼äËã³öµ±Ç°´°¿ÚµÄÓ¦¸Ã¶ÔÓ¦µÄ¿ªÊ¼Ê±¼ätime¡£ÓÉÓÚ¸Õ¸Õ¿ªÊ¼µÄʱºò array Êǿյģ¬ÄÇôËý»ñÈ¡µ½µÄoldÓ¦µ±ÊÇnull£¬ÄÇôËû»á´´½¨Ò»¸öеÄʵÀý£¬ÎÒÃÇÓÃͼ¿´Ò»Ï³õʼ»¯µÄ LeapArray£º +æ ¹æ�®å½“å‰�时间除于 windowLength 得到一个 timeId(相差500ms计算出æ�¥çš„值将是一致的),å†�用timeIdè·Ÿå�–样窗å�£çš„长度进行一个å�–模,那么她一定会è�½åœ¨ 0,1两个ä½�置的其中一个。然å�Žæ ¹æ�®å½“å‰�时间算出当å‰�窗å�£çš„应该对应的开始时间time。由于刚刚开始的时候 array 是空的,那么她获å�–到的old应当是null,那么他会创建一个新的实例,我们用图看一下åˆ�始化的 LeapArray: -¶ÔÓ¦ÉÏÃæ currentWindow ·½·¨µÄ 4.1 ²½Öè(¼ÙÉèidx=0)£º![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/95b0b64926eae4d2753986af9c978da9980da0.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")µ±»ñÈ¡µ½µÄÊÇnull,ÄÇô³õʼµÄʱºòarraysÊý×éÖÐÖ»ÓÐÒ»¸ö´°¿Ú(¿ÉÄÜÊǵÚÒ»¸ö(idx=0)£¬Ò²¿ÉÄÜÊǵڶþ¸ö(idx=1))£¬Ã¿¸öʱ¼ä´°¿ÚµÄ³¤¶ÈÊÇ500ms£¬Õâ¾ÍÒâζ×ÅÖ»Òªµ±Ç°Ê±¼äÓëʱ¼ä´°¿ÚµÄ²îÖµÔÚ500msÖ®ÄÚ£¬Ê±¼ä´°¿Ú¾Í²»»áÏòǰ»¬¶¯¡£ÀýÈ磬¼ÙÈ統ǰʱ¼ä×ßµ½300»òÕß500ʱ£¬µ±Ç°Ê±¼ä´°¿ÚÈÔÈ»ÊÇÏàͬµÄÄǸö£º +对应上é�¢ currentWindow 方法的 4.1 步骤(å�‡è®¾idx=0):![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/95b0b64926eae4d2753986af9c978da9980da0.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")当获å�–到的是null,那么åˆ�始的时候arrays数组中å�ªæœ‰ä¸€ä¸ªçª—å�£(å�¯èƒ½æ˜¯ç¬¬ä¸€ä¸ª(idx=0),也å�¯èƒ½æ˜¯ç¬¬äºŒä¸ª(idx=1)),æ¯�个时间窗å�£çš„长度是500ms,这就æ„�味ç�€å�ªè¦�当å‰�时间与时间窗å�£çš„差值在500ms之内,时间窗å�£å°±ä¸�会å�‘å‰�滑动。例如,å�‡å¦‚当å‰�时间走到300或者500时,当å‰�时间窗å�£ä»�然是相å�Œçš„那个: -¶ÔÓ¦ÉÏÃæ currentWindow ·½·¨µÄ 4.2 ²½Ö裺![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/85c047336a2c2186bcc7737a4c28da852cb603.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ʱ¼ä¼ÌÐøÍùǰ×ߣ¬µ±³¬¹ý500msʱ£¬Ê±¼ä´°¿Ú¾Í»áÏòǰ»¬¶¯µ½ÏÂÒ»¸ö£¬Õâʱ¾Í»á¸üе±Ç°´°¿ÚµÄ¿ªÊ¼Ê±¼ä,ʱ¼ä¼ÌÐøÍùǰ×ߣ¬Ö»Òª²»³¬¹ý1000ms£¬Ôòµ±Ç°´°¿Ú²»»á·¢Éú±ä»¯£¬ÆäÖдúÂëʵÏÖÊÇ resetWindowTo ·½·¨£º +对应上é�¢ currentWindow 方法的 4.2 步骤:![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/85c047336a2c2186bcc7737a4c28da852cb603.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")æ—¶é—´ç»§ç»­å¾€å‰�走,当超过500ms时,时间窗å�£å°±ä¼šå�‘å‰�滑动到下一个,这时就会更新当å‰�窗å�£çš„开始时间,æ—¶é—´ç»§ç»­å¾€å‰�走,å�ªè¦�ä¸�超过1000ms,则当å‰�窗å�£ä¸�会å�‘生å�˜åŒ–,其中代ç �实现是 resetWindowTo 方法: ``` -protected WindowWrap resetWindowTo(WindowWrap w, long time) { // Update the start time and reset value. // ÖØÖÃwindowStart w.resetTo(time); MetricBucket borrowBucket = borrowArray.getWindowValue(time); if (borrowBucket != null) { w.value().reset(); w.value().addPass((int)borrowBucket.pass()); } else { w.value().reset(); } return w;} +protected WindowWrap resetWindowTo(WindowWrap w, long time) { // Update the start time and reset value. // é‡�ç½®windowStart w.resetTo(time); MetricBucket borrowBucket = borrowArray.getWindowValue(time); if (borrowBucket != null) { w.value().reset(); w.value().addPass((int)borrowBucket.pass()); } else { w.value().reset(); } return w;} ``` @@ -457,7 +457,7 @@ protected WindowWrap resetWindowTo(WindowWrap w, lon -¶ÔÓ¦ÉÏÃæ currentWindow ·½·¨µÄ 4.3 ²½Öè![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/03d6e3886f95f5768e05969d7eb8307c26f381.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")µ±Ê±¼ä¼ÌÐøÍùǰ×ߣ¬µ±Ç°Ê±¼ä³¬¹ý1000msʱ£¬¾Í»áÔٴνøÈëÏÂÒ»¸öʱ¼ä´°¿Ú£¬´ËʱarraysÊý×éÖеĴ°¿Ú½«»áÓÐÒ»¸öʧЧ£¬»áÓÐÁíÒ»¸öеĴ°¿Ú½øÐÐÌæ»»£º![SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/241926a53c2a5b06938844199046d31e593d62.jpg "SpringCloud AlibabaϵÁСª¡ª15SentinelÔ­Àí·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÒÔ´ËÀàÍÆËæ×Åʱ¼äµÄÁ÷ÊÅ£¬Ê±¼ä´°¿ÚÒ²ÔÚ·¢Éú±ä»¯£¬ÔÚµ±Ç°Ê±¼äµãÖнøÈëµÄÇëÇ󣬻ᱻͳ¼Æµ½µ±Ç°Ê±¼ä¶ÔÓ¦µÄʱ¼ä´°¿ÚÖУ¬»Øµ½addpass ·½·¨ÖУº +对应上é�¢ currentWindow 方法的 4.3 步骤![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/03d6e3886f95f5768e05969d7eb8307c26f381.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")当时间继续往å‰�走,当å‰�时间超过1000ms时,就会å†�次进入下一个时间窗å�£ï¼Œæ­¤æ—¶arrays数组中的窗å�£å°†ä¼šæœ‰ä¸€ä¸ªå¤±æ•ˆï¼Œä¼šæœ‰å�¦ä¸€ä¸ªæ–°çš„窗å�£è¿›è¡Œæ›¿æ�¢ï¼š![SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/241926a53c2a5b06938844199046d31e593d62.jpg "SpringCloud Alibaba系列——15Sentinel原ç�†åˆ†æž�-å¼€æº�基础软件社区")以此类推éš�ç�€æ—¶é—´çš„æµ�é€�,时间窗å�£ä¹Ÿåœ¨å�‘生å�˜åŒ–,在当å‰�时间点中进入的请求,会被统计到当å‰�时间对应的时间窗å�£ä¸­ï¼Œå›žåˆ°addpass 方法中: @@ -473,7 +473,7 @@ public void addPass(int count) { WindowWrap wrap = data.current -»ñÈ¡µ½´°¿ÚÒÔºó»á½øÈëµ½ wrap.value().addPass(count); QPSµÄÔö¼Ó¡£¶øÕâÀïµÄ wrap.value() µÃµ½µÄÊÇ֮ǰÌáµ½µÄ MetricBucket £¬ÔÚ Sentinel ÖÐQPSÏà¹ØÊý¾ÝµÄͳ¼Æ½á¹ûÊÇά»¤ÔÚÕâ¸öÀàµÄ LongAdder[] ÖУ¬×îÖÕÓÉÕâ¸öÖ¸±êÀ´ÓëÎÒÃÇʵÏÖÉèÖúõĹæÔò½øÐÐÆ¥Å䣬²é¿´ÊÇ·ñÏÞÁ÷£¬Ò²¾ÍÊÇ StatisticSlotµÄentry ·½·¨ÖÐµÄ fireEntry(context, resourceWrapper, node, count, prioritized, args); ¶¼ÒªÏȽøÈëµ½ FlowSlotµÄentry·½·¨½øÐÐÏÞÁ÷¹ýÂË£º +获å�–到窗å�£ä»¥å�Žä¼šè¿›å…¥åˆ° wrap.value().addPass(count); QPS的增加。而这里的 wrap.value() 得到的是之å‰�æ��到的 MetricBucket ,在 Sentinel 中QPS相关数æ�®çš„统计结果是维护在这个类的 LongAdder[] 中,最终由这个指标æ�¥ä¸Žæˆ‘们实现设置好的规则进行匹é…�,查看是å�¦é™�æµ�,也就是 StatisticSlotçš„entry 方法中的 fireEntry(context, resourceWrapper, node, count, prioritized, args); 都è¦�先进入到 FlowSlotçš„entry方法进行é™�æµ�过滤: @@ -489,7 +489,7 @@ public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode -¿ÉÒÔ¿´µ½ÕâÀïÓиöºÜÖØÒªµÄ·½·¨ checkFlow £¬½øÈ¥¿´¿´£º +å�¯ä»¥çœ‹åˆ°è¿™é‡Œæœ‰ä¸ªå¾ˆé‡�è¦�的方法 checkFlow ,进去看看: @@ -505,14 +505,14 @@ public void checkFlow(Function> ruleProvider, Resou -µ½ÕâÀïÒ»Çж¼Ó¦¸ÃÇåÎúÁË£¬ÕâÀïÄõ½ÁËÎÒÃÇÉèÖÃµÄ FlowRule Ñ­»·Æ¥Åä×ÊÔ´½øÐÐÏÞÁ÷¹ýÂË¡£Õâ¾ÍÊÇSentinel ÄÜ×öµ½ÏÞÁ÷µÄÔ­Òò¡£ +到这里一切都应该清晰了,这里拿到了我们设置的 FlowRule 循环匹é…�资æº�进行é™�æµ�过滤。这就是Sentinel 能å�šåˆ°é™�æµ�的原因。 **2.6 FlowRuleSlot** -Õâ¸ö slot Ö÷Òª¸ù¾ÝÔ¤ÉèµÄ×ÊÔ´µÄͳ¼ÆÐÅÏ¢£¬°´Õչ̶¨µÄ´ÎÐò£¬ÒÀ´ÎÉúЧ¡£Èç¹ûÒ»¸ö×ÊÔ´¶ÔÓ¦Á½Ìõ»òÕß¶àÌõÁ÷¿Ø¹æÔò£¬Ôò»á¸ù¾ÝÈçÏ´ÎÐòÒÀ´Î¼ìÑ飬ֱµ½È«²¿Í¨¹ý»òÕßÓÐÒ»¸ö¹æÔòÉúЧΪֹ: +这个 slot 主è¦�æ ¹æ�®é¢„设的资æº�的统计信æ�¯ï¼ŒæŒ‰ç…§å›ºå®šçš„æ¬¡åº�,ä¾�次生效。如果一个资æº�对应两æ�¡æˆ–者多æ�¡æµ�控规则,则会根æ�®å¦‚下次åº�ä¾�次检验,直到全部通过或者有一个规则生效为止: -* Ö¸¶¨Ó¦ÓÃÉúЧµÄ¹æÔò£¬¼´Õë¶Ôµ÷Ó÷½ÏÞÁ÷µÄ£» -* µ÷Ó÷½Îª other µÄ¹æÔò£» -* µ÷Ó÷½Îª default µÄ¹æÔò¡£ +* 指定应用生效的规则,å�³é’ˆå¯¹è°ƒç”¨æ–¹é™�æµ�的; +* 调用方为 other 的规则; +* 调用方为 default 的规则。 @@ -529,10 +529,10 @@ public void checkFlow(Function> ruleProvider, Resou **2.6.1 checkFlow** -½øÈëµ½FlowRuleChecker.checkFlow·½·¨ÖС£ +进入到FlowRuleChecker.checkFlow方法中。 -* ¸ù¾Ý×ÊÔ´Ãû³Æ£¬ÕÒµ½ÏÞÁ÷¹æÔòÁбí -* Èç¹ûÏÞÁ÷¹æÔò²»Îª¿Õ£¬Ôò±éÀú¹æÔò£¬µ÷ÓÃcanPassCheck·½·¨½øÐÐУÑé¡£ +* æ ¹æ�®èµ„æº�å��称,找到é™�æµ�规则列表 +* 如果é™�æµ�规则ä¸�为空,则é��历规则,调用canPassCheck方法进行校验。 @@ -549,7 +549,7 @@ public void checkFlow(Function> ruleProvider,Resour **2.6.2 canPassCheck** -ÅжÏÊÇ·ñÊǼ¯ÈºÏÞÁ÷ģʽ£¬Èç¹ûÊÇ£¬Ôò×ßpassClusterCheck£¬·ñÔò£¬µ÷ÓÃpassLocalCheck·½·¨¡£ +判断是å�¦æ˜¯é›†ç¾¤é™�æµ�模å¼�,如果是,则走passClusterCheck,å�¦åˆ™ï¼Œè°ƒç”¨passLocalCheck方法。 @@ -567,8 +567,8 @@ public boolean canPassCheck(/*@NonNull*/ FlowRule rule, Context context,DefaultN **2.6.3 passLocalCheck** -* selectNodeByRequesterAndStrategy£¬¸ù¾ÝÇëÇóºÍ²ßÂÔÀ´»ñµÃNode -* rule.getRater(), ¸ù¾Ý²»Í¬µÄÏÞÁ÷¿ØÖÆÐÐΪÀ´£¬µ÷ÓÃcanPass½øÐÐУÑé¡£ +* selectNodeByRequesterAndStrategy,根æ�®è¯·æ±‚和策略æ�¥èŽ·å¾—Node +* rule.getRater(), æ ¹æ�®ä¸�å�Œçš„é™�æµ�控制行为æ�¥ï¼Œè°ƒç”¨canPass进行校验。 @@ -585,12 +585,12 @@ private static boolean passLocalCheck(FlowRule rule, Context context,DefaultNode **2.6.4 DefaultController.canPass** -ͨ¹ýĬÈϵÄÏÞÁ÷ÐÐΪ£¨Ö±½Ó¾Ü¾ø£©£¬½øÐÐÏÞÁ÷Åжϡ£ +通过默认的é™�æµ�行为(直接拒ç»�),进行é™�æµ�判断。 ``` -@Overridepublic boolean canPass(Node node, int acquireCount, boolean prioritized) { //Ïȸù¾Ýnode»ñÈ¡×ÊÔ´µ±Ç°µÄʹÓÃÊýÁ¿£¬ÕâÀï»á¸ù¾Ýqps»òÕß²¢·¢Êý²ßÂÔÀ´»ñµÃÏà¹ØµÄÖµ int curCount = avgUsedTokens(node); //µ±Ç°ÒÑʹÓõÄÇëÇóÊý¼ÓÉϱ¾´ÎÇëÇóµÄÊýÁ¿ÊÇ·ñ´óÓÚãÐÖµ if (curCount + acquireCount > count) {//Èç¹ûΪtrue£¬ËµÃ÷Ó¦¸Ã±»ÏÞÁ÷ // Èç¹û´ËÇëÇóÊÇÒ»¸ö¸ßÓÅÏȼ¶ÇëÇ󣬲¢ÇÒÏÞÁ÷ÀàÐÍΪqps£¬Ôò²»»áÁ¢¼´Ê§°Ü£¬¶øÊÇÈ¥Õ¼ÓÃδÀ´µÄʱ¼ä´°¿Ú£¬µÈµ½ÏÂÒ»¸öʱ¼ä´°¿Úͨ¹ýÇëÇó¡£ if (prioritized && grade == RuleConstant.FLOW_GRADE_QPS) { // long currentTime; long waitInMs; currentTime = TimeUtil.currentTimeMillis(); waitInMs = node.tryOccupyNext(currentTime, acquireCount, count); if (waitInMs < OccupyTimeoutProperty.getOccupyTimeout()) { node.addWaitingRequest(currentTime + waitInMs, acquireCount); node.addOccupiedPass(acquireCount); sleep(waitInMs); // PriorityWaitException indicates that the request will pass after waiting for {@link @waitInMs}. throw new PriorityWaitException(waitInMs); } } return false; } return true;} +@Overridepublic boolean canPass(Node node, int acquireCount, boolean prioritized) { //先根æ�®node获å�–资æº�当å‰�的使用数é‡�,这里会根æ�®qps或者并å�‘æ•°ç­–ç•¥æ�¥èŽ·å¾—ç›¸å…³çš„å€¼ int curCount = avgUsedTokens(node); //当å‰�已使用的请求数加上本次请求的数é‡�是å�¦å¤§äºŽé˜ˆå€¼ if (curCount + acquireCount > count) {//如果为true,说明应该被é™�æµ� // 如果此请求是一个高优先级请求,并且é™�æµ�类型为qps,则ä¸�会立å�³å¤±è´¥ï¼Œè€Œæ˜¯åŽ»å� ç”¨æœªæ�¥çš„æ—¶é—´çª—å�£ï¼Œç­‰åˆ°ä¸‹ä¸€ä¸ªæ—¶é—´çª—å�£é€šè¿‡è¯·æ±‚。 if (prioritized && grade == RuleConstant.FLOW_GRADE_QPS) { // long currentTime; long waitInMs; currentTime = TimeUtil.currentTimeMillis(); waitInMs = node.tryOccupyNext(currentTime, acquireCount, count); if (waitInMs < OccupyTimeoutProperty.getOccupyTimeout()) { node.addWaitingRequest(currentTime + waitInMs, acquireCount); node.addOccupiedPass(acquireCount); sleep(waitInMs); // PriorityWaitException indicates that the request will pass after waiting for {@link @waitInMs}. throw new PriorityWaitException(waitInMs); } } return false; } return true;} ``` @@ -601,10 +601,10 @@ private static boolean passLocalCheck(FlowRule rule, Context context,DefaultNode -Ò»µ©±»¾Ü¾ø£¬ÔòÅ׳ö FlowException Òì³£¡£ +一旦被拒ç»�,则抛出 FlowException 异常。 **2.7 PriorityWait** -ÔÚDefaultController.canPassÖУ¬µ÷ÓÃÈçÏ´úÂëÈ¥½èºóÐøµÄ´°¿Ú +在DefaultController.canPass中,调用如下代ç �去借å�Žç»­çš„窗å�£ @@ -622,7 +622,7 @@ node.addWaitingRequest(currentTime + waitInMs, acquireCount);node.addOccupiedPas > addWaitingRequest -> ArrayMetric.addWaiting->OccupiableBucketLeapArray.addWaiting -borrowArray£¬ËüÊÇÒ»¸öFutureBucketLeapArray¶ÔÏó£¬ÕâÀﶨÒåµÄÊÇδÀ´µÄʱ¼ä´°¿Ú£¬È»ºó»ñµÃδÀ´Ê±¼äµÄ´°¿ÚÈ¥Ôö¼Ó¼ÆÊý +borrowArray,它是一个FutureBucketLeapArray对象,这里定义的是未æ�¥çš„æ—¶é—´çª—å�£ï¼Œç„¶å�ŽèŽ·å¾—æœªæ�¥æ—¶é—´çš„窗å�£åŽ»å¢žåŠ è®¡æ•° @@ -638,9 +638,9 @@ borrowArray -×îÖÕ£¬ÔÚStatisticSlot.entryÖУ¬²¶»ñÒì³£ +最终,在StatisticSlot.entry中,æ�•获异常 -Èç¹û´æÔÚÓÅÏȼ¶±È½Ï¸ßµÄÈÎÎñ£¬²¢ÇÒµ±Ç°µÄÇëÇóÒѾ­´ïµ½ãÐÖµ£¬Å׳öÕâ¸öÒì³££¬Êµ¼ÊÉÏÊÇÈ¥Õ¼ÓÃδÀ´µÄÒ»¸öʱ¼ä´°¿ÚÈ¥½øÐмÆÊý£¬Å׳öÕâ¸öÒì³£Ö®ºó£¬»á½øÈëµ½StatisticSlotÖнøÐв¶»ñ¡£È»ºóÖ±½Óͨ¹ý +如果存在优先级比较高的任务,并且当å‰�的请求已ç»�达到阈值,抛出这个异常,实际上是去å� ç”¨æœªæ�¥çš„一个时间窗å�£åŽ»è¿›è¡Œè®¡æ•°ï¼ŒæŠ›å‡ºè¿™ä¸ªå¼‚å¸¸ä¹‹å�Žï¼Œä¼šè¿›å…¥åˆ°StatisticSlot中进行æ�•获。然å�Žç›´æŽ¥é€šè¿‡ @@ -650,7 +650,7 @@ public void entry(Context context, ResourceWrapper resourceWrapper, DefaultNode -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudConfig\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudConfig\346\272\220\347\240\201\345\210\206\346\236\220.md" index 4ae8cc8..ead8a98 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudConfig\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudConfig\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,4 +1,4 @@ -ÒªÏëÁ˽âspring cloud config£¬ÎÒÃǾͱØÐëÁ˽âspringbootÖÐenvironment»·¾³µÄ¼ÓÔØ¹ý³Ì¡£ +è¦�想了解spring cloud config,我们就必须了解springboot中environment环境的加载过程。 @@ -14,7 +14,7 @@ public static ConfigurableApplicationContext run(Class[] primarySources, -ÔÚ`SpringApplicationµÄ¹¹Ôì·½·¨ÖÐ`£¬ÓÐÕâôһ¶Î´úÂë +在`SpringApplication的构造方法中`,有这么一段代ç � @@ -37,8 +37,8 @@ Set names = new LinkedHashSet<>( -Õâ¶Î´úÂëÖоÍÊÇ´ÓMETA-INFĿ¼ÏÂÃæ»ñÈ¡`ApplicationListenerºÍApplicationContextInitializer`ÀàÐ͵ÄËùÓÐÀà¡£ -ÔÚspring-boot.jarÏÂÃæspring.factoriesÖÐÅäÖÃÁË`ConfigFileApplicationListener`Õâ¸öÀ࣬ÅäÖû·¾³Ò²¾ÍÊÇapplicationÎļþµÄ¼ÓÔØ¶¼»áͨ¹ýÕâ¸öÀà +这段代ç �中就是从META-INF目录下é�¢èŽ·å�–`ApplicationListenerå’ŒApplicationContextInitializer`类型的所有类。 +在spring-boot.jar下é�¢spring.factories中é…�置了`ConfigFileApplicationListener`这个类,é…�置环境也就是application文件的加载都会通过这个类 @@ -55,7 +55,7 @@ org.springframework.boot.context.event.EventPublishingRunListener -¼ÌÐø½øÈëspringbootÆô¶¯½×¶Î +继续进入springbootå�¯åŠ¨é˜¶æ®µ @@ -122,8 +122,8 @@ prepareContext(context, environment, listeners, applicationArguments, -ÉÏÃæÕâÁ½¶Î´úÂë¾ÍÊÇ×°ÔØ»·¾³µÄ´úÂë -ÔÚ`prepareEnvironment`·½·¨Öгõʼ»¯ÁË`environment`¡£ +上é�¢è¿™ä¸¤æ®µä»£ç �就是装载环境的代ç � +在`prepareEnvironment`方法中åˆ�始化了`environment`。 @@ -146,7 +146,7 @@ prepareContext(context, environment, listeners, applicationArguments, -ÒòΪÎÒÃÇservlet·þÎñ£¬ËùÒÔ`Environment`Ϊ`StandardServletEnvironment`£¬²¢ÇÒÔÚ¸¸ÀàµÄµÄ¹¹ÔìÆäÖÐÖ´ÐÐÁË`customizePropertySources`·½·¨ +因为我们servletæœ�务,所以`Environment`为`StandardServletEnvironment`,并且在父类的的构造其中执行了`customizePropertySources`方法 @@ -191,7 +191,7 @@ prepareContext(context, environment, listeners, applicationArguments, -µ½ÕâÀï,ÎÒÃǵõ½ÁË`StandardServletEnvironment`²¢ÇÒ¼ÓÔØµÄÅäÖÃ˳ÐòÊÇ +到这里,我们得到了`StandardServletEnvironment`并且加载的é…�置顺åº�是 1. servletConfigInitParams 2. servletContextInitParams @@ -235,9 +235,9 @@ prepareContext(context, environment, listeners, applicationArguments, -¶øÕâÀïÎÒÃÇ¿ÉÒÔ¿´µ½ÓÖ¼ÓÈëÁË`defaultProperties`ÅäÖÃÔÚ×îºóÃæÒÔ¼°`SimpleCommandLinePropertySource`ÃüÁîÐвÎÊýÔÚ×îÇ°Ãæ¡£Òò´Ë£¬ÏÖÔÚµÄ˳ÐòÊÇ +而这里我们å�¯ä»¥çœ‹åˆ°å�ˆåŠ å…¥äº†`defaultProperties`é…�置在最å�Žé�¢ä»¥å�Š`SimpleCommandLinePropertySource`命令行å�‚数在最å‰�é�¢ã€‚因此,现在的顺åº�是 -1. SimpleCommandLinePropertySourcemÃüÁîÐÐÅäÖà +1. SimpleCommandLinePropertySourcem命令行é…�ç½® 2. servletConfigInitParams 3. servletContextInitParams 4. jndiProperties @@ -264,7 +264,7 @@ prepareContext(context, environment, listeners, applicationArguments, -ÔÚÕâÀï`SpringApplicationRunListener`Ϊ`EventPublishingRunListener`,À´×ÔÓÚÇ°ÃæµÄ`getRunListeners` +在这里`SpringApplicationRunListener`为`EventPublishingRunListener`,æ�¥è‡ªäºŽå‰�é�¢çš„`getRunListeners` @@ -279,7 +279,7 @@ prepareContext(context, environment, listeners, applicationArguments, -¶øÍ¨¹ý¹¹Ôì·½·¨³õʼ»¯µÄʱºò´«ÈëÁËthis£¬ËùÒÔ×îÖÕ`initialMulticaster`ÖеÄlistenerΪapplicationÖеÄlistener +而通过构造方法åˆ�始化的时候传入了this,所以最终`initialMulticaster`中的listener为application中的listener @@ -297,7 +297,7 @@ prepareContext(context, environment, listeners, applicationArguments, -ËùÒÔÕâÀï»á·¢Ë͸öʼþ֪ͨ£¬À´µ½ÁË`ConfigFileApplicationListener` +所以这里会å�‘é€�个事件通知,æ�¥åˆ°äº†`ConfigFileApplicationListener` @@ -340,7 +340,7 @@ prepareContext(context, environment, listeners, applicationArguments, -ÔÚÕâÀïÓÐÓиöÀ©Õ¹µã£¬Í¨¹ý»ñÈ¡`spring.factories`ÎļþÖÐÅäÖõÄ`EnvironmentPostProcessor`Ààµ÷ÓÃ`postProcessEnvironment`·½·¨£¬×Ô¼º±¾ÉíÒ²¼ÓÈëµ½ÁË`postProcessors`¼¯ºÏÖУ¬ËùÒÔ×îÖÕÓÖ»á×ßµ½`postProcessors`·½·¨ +在这里有有个扩展点,通过获å�–`spring.factories`文件中é…�置的`EnvironmentPostProcessor`类调用`postProcessEnvironment`方法,自己本身也加入到了`postProcessors`集å�ˆä¸­ï¼Œæ‰€ä»¥æœ€ç»ˆå�ˆä¼šèµ°åˆ°`postProcessors`方法 @@ -396,10 +396,10 @@ prepareContext(context, environment, listeners, applicationArguments, -ÔÚÕâÀÓÖ½«randomÅäÖüÓÈëµ½systemEnvironmentÖ®ºó£¬ËùÒÔÎÒÃǵÄÅäÖüÓÔØË³Ðò³ÉÁË +在这里,å�ˆå°†randomé…�置加入到systemEnvironment之å�Žï¼Œæ‰€ä»¥æˆ‘们的é…�置加载顺åº�æˆ�了 defaultProperties -1. SimpleCommandLinePropertySourcemÃüÁîÐÐÅäÖà +1. SimpleCommandLinePropertySourcem命令行é…�ç½® 2. servletConfigInitParams 3. servletContextInitParams 4. jndiProperties @@ -408,18 +408,18 @@ defaultProperties 7. RandomValuePropertySource 8. defaultProperties -·¾¶ +路径 > classpath:/,classpath:/config/,file:./,file:./config/ > spring.config.location= > spring.config.additional-location= -ÎļþÃûĬÈÏΪapplication +文件å��默认为application -> Èç¹ûÅäÖÃÁËspring.config.name= -> ÎļþÃûÔòΪspring.config.nameÅäÖõÄÃû³Æ +> 如果é…�置了spring.config.name= +> 文件å��则为spring.config.nameé…�置的å��ç§° -²¢ÇÒͨ¹ý`load`·½·¨½«ÉÏÊö·¾¶ºÍÎļþÃûµÄÎļþ¼ÓÈëµ½`environmentÖÐ`£¬Èç¹ûÅäÖÃÁË`spring.profiles.active`£¬²¢ÇÒ¼ÓÔØprefix + "-" + profile + fileExtensionÎļþ£¬Ò²¾ÍÊÇ`application-.properties`ºÍ`y`Îļþ +并且通过`load`方法将上述路径和文件å��的文件加入到`environment中`,如果é…�置了`spring.profiles.active`,并且加载prefix + "-" + profile + fileExtension文件,也就是`application-.properties`å’Œ`y`文件 @@ -460,7 +460,7 @@ defaultProperties -ÔÚÕâÀïͨ¹ý`this.propertySourceLoaders`±éÀúÅжÏÊÇ·ñ·ûºÏ¸ÃSourceLoaderµÄºó׺£¬Èç¹û·ûºÏ£¬¾Í½«×ÊÔ´¼ÓÔØ½øÀ´,¶ø`propertySourceLoaders`À´×ÔÓÚ`Loader`¹¹Ôì·½·¨ +在这里通过`this.propertySourceLoaders`é��历判断是å�¦ç¬¦å�ˆè¯¥SourceLoaderçš„å�Žç¼€ï¼Œå¦‚果符å�ˆï¼Œå°±å°†èµ„æº�加载进æ�¥,而`propertySourceLoaders`æ�¥è‡ªäºŽ`Loader`构造方法 @@ -489,7 +489,7 @@ org.springframework.boot.env.YamlPropertySourceLoader -Òò´Ë¿ÉÒÔ¼ÓÔØ`yml`ÎļþºÍ`properties`Îļþ +å› æ­¤å�¯ä»¥åŠ è½½`yml`文件和`properties`文件 @@ -514,13 +514,13 @@ org.springframework.boot.env.YamlPropertySourceLoader -×îÖÕ·ÅÈëµ½ÁË`environment` +最终放入到了`environment` -½ÓÏÂÀ´ÎÒÃǾÍÀ´¿´ÏÂSpring cloud config +接下æ�¥æˆ‘们就æ�¥çœ‹ä¸‹Spring cloud config -ÔÚ`spring-cloud-context`µÄjarÖУ¬`spring.factories`ÖÐÒýÈëÁ˸ö`BootstrapApplicationListener` -²¢ÇÒ¸ÃÅäÖÃÓÅÏÈÓÚ`ConfigFileApplicationListener`£¬Òò´ËÈç¹ûÎÒÃÇÒýÈëÁËspringcloud×é¼þ£¬ÄÇô -ʼþ¼àÌý»áÓÅÏÈ×ß`BootstrapApplicationListener` +在`spring-cloud-context`çš„jar中,`spring.factories`中引入了个`BootstrapApplicationListener` +并且该é…�置优先于`ConfigFileApplicationListener`,因此如果我们引入了springcloud组件,那么 +事件监å�¬ä¼šä¼˜å…ˆèµ°`BootstrapApplicationListener` @@ -666,10 +666,10 @@ org.springframework.cloud.bootstrap.BootstrapApplicationListener,\ -ÕâÀïÖ÷Òª×öµÄÊÂÇéÓÐÁ½µã +这里主è¦�å�šçš„事情有两点 -1. ´´½¨Environment¶ÔÏó£¬ÉèÖÃspring.config.name=bootstrap -2. ´´½¨Ò»¸öеÄSpringApplicationÆô¶¯Æ÷£¬²¢ÇÒÉèÖÃsourcesΪÀ©Õ¹µãϵÄBootstrapConfigurationÅäÖÃÀà +1. 创建Environment对象,设置spring.config.name=bootstrap +2. 创建一个新的SpringApplicationå�¯åŠ¨å™¨ï¼Œå¹¶ä¸”è®¾ç½®sources为扩展点下的BootstrapConfigurationé…�置类 @@ -681,7 +681,7 @@ List names = new ArrayList<>(SpringFactoriesLoader -¼òµ¥µÄ¾ÍÊÇ¿ÉÒÔÀí½âΪ´´½¨ÁËÒ»¸öÐÂµÄÆô¶¯Æ÷£¬Æô¶¯ÀàΪBootstrapConfigurationÅäÖõÄÀà¡£²¢ÇÒͨ¹ýrun·½·¨µÃµ½Á˳õʼ»¯ºóµÄBeanFactoryÈÝÆ÷²¢ÇÒ½«contenxt·â×°³ÉAncestorInitializer¼ÓÈëµ½ÁËÎÒÃÇ×Ô¼ºµÄSpringApplicationÖÐ +简å�•的就是å�¯ä»¥ç�†è§£ä¸ºåˆ›å»ºäº†ä¸€ä¸ªæ–°çš„å�¯åŠ¨å™¨ï¼Œå�¯åŠ¨ç±»ä¸ºBootstrapConfigurationé…�置的类。并且通过run方法得到了åˆ�始化å�Žçš„BeanFactory容器并且将contenxtå°�装æˆ�AncestorInitializer加入到了我们自己的SpringApplication中 @@ -692,7 +692,7 @@ application.addInitializers(new AncestorInitializer(context)); -¶øÔÚ`apply`·½·¨ÖÐ,»ñÈ¡ÁË`ApplicationContextInitializer`ÀàÐ͵ÄËùÓжÔÏó¼ÓÈëµ½ÁËÎÒÃǵ±Ç°µÄ`SpringApplication`ÖÐ +而在`apply`方法中,获å�–了`ApplicationContextInitializer`类型的所有对象加入到了我们当å‰�çš„`SpringApplication`中 @@ -711,7 +711,7 @@ application.addInitializers(new AncestorInitializer(context)); -ÔÚ`spring-cloud-context`°üÖУ¬`spring.factories`ÅäÖÃÏÂÃæÕâ¸öÀà +在`spring-cloud-context`包中,`spring.factories`é…�置下é�¢è¿™ä¸ªç±» @@ -723,9 +723,9 @@ org.springframework.cloud.bootstrap.config.PropertySourceBootstrapConfiguration, -µ½ÕâÀïÎÒÃÇÆô¶¯Àà`SpringApplication`ÖÐÒѾ­ÓÐÁË`AncestorInitializer,PropertySourceBootstrapConfiguration`Á½¸öApplicationContextInitializer +到这里我们å�¯åŠ¨ç±»`SpringApplication`中已ç»�有了`AncestorInitializer,PropertySourceBootstrapConfiguration`两个ApplicationContextInitializer -·µ»Øµ½ÎÒÃÇÆô¶¯Àà +返回到我们å�¯åŠ¨ç±» @@ -776,8 +776,8 @@ org.springframework.cloud.bootstrap.config.PropertySourceBootstrapConfiguration, -ÔÚÕâÀï¾Í»áµ÷Óõ½`ApplicationContextInitializer.initialize`·½·¨ -¾Í»áÏÈÀ´µ½`AncestorInitializer` +在这里就会调用到`ApplicationContextInitializer.initialize`方法 +就会先æ�¥åˆ°`AncestorInitializer` @@ -804,7 +804,7 @@ org.springframework.cloud.bootstrap.config.PropertySourceBootstrapConfiguration, -¿ÉÒÔ¿´µ½ÕâÀォBootStrap´´½¨µÄÈÝÆ÷×÷ΪÎÒÃǵ±Ç°ÈÝÆ÷µÄ¸¸ÈÝÆ÷£¬²¢ÇÒ¸¸ÈÝÆ÷ÖеĶÔÏó¶¼³õʼ»¯ºÃÁË£¬`PropertySourceBootstrapConfiguration`µÄÒ²³õʼ»¯ºÃÁË,²¢ÇÒ¸Ã`ApplicationContextInitializer`¼ÓÈëµ½ÁËÎÒÃÇ×Ô¼ºµÄÆô¶¯ÀàÀïÃæ£¬Òò´Ë»áµ÷Óóõʼ»¯ºÃÁ˵Ä`PropertySourceBootstrapConfiguration.initialize`,¶ø`PropertySourceLocator`ÊÇ×¢Èë½øÀ´µÄ +å�¯ä»¥çœ‹åˆ°è¿™é‡Œå°†BootStrap创建的容器作为我们当å‰�容器的父容器,并且父容器中的对象都åˆ�始化好了,`PropertySourceBootstrapConfiguration`的也åˆ�始化好了,并且该`ApplicationContextInitializer`加入到了我们自己的å�¯åŠ¨ç±»é‡Œé�¢ï¼Œå› æ­¤ä¼šè°ƒç”¨åˆ�始化好了的`PropertySourceBootstrapConfiguration.initialize`,而`PropertySourceLocator`是注入进æ�¥çš„ @@ -874,7 +874,7 @@ org.springframework.cloud.config.client.ConfigServiceBootstrapConfiguration,\ -Òò´Ë×îÖÕ»áÀ´µ½`ConfigServicePropertySourceLocator`ÖÐ +因此最终会æ�¥åˆ°`ConfigServicePropertySourceLocator`中 @@ -951,8 +951,8 @@ org.springframework.cloud.config.client.ConfigServiceBootstrapConfiguration,\ -¿ÉÒÔ¿´µ½×îºó¾ÍÊǵ÷Ó÷þÎñ¶ËµÄ½Ó¿Ú»ñÈ¡×îеÄÅäÖᣠ-¶øÕâ¸öÍⲿÅäÖÃ×îºó»á·Åµ½systemEnvironment֮ǰ£¬Òò´Ë¾Í»á¸²¸Ç±¾µØÅäÖ㬵«ÊÇ¿ÉÒÔͨ¹ý²ÎÊý¿ØÖÆ +å�¯ä»¥çœ‹åˆ°æœ€å�Žå°±æ˜¯è°ƒç”¨æœ�务端的接å�£èŽ·å�–最新的é…�置。 +而这个外部é…�置最å�Žä¼šæ”¾åˆ°systemEnvironment之å‰�,因此就会覆盖本地é…�置,但是å�¯ä»¥é€šè¿‡å�‚数控制 @@ -1017,30 +1017,30 @@ if (!remoteProperties.isAllowOverride() || (!remoteProperties.isOverrideNone() -**×ܽá** +**总结** -1. À©Õ¹µã +1. 扩展点 1.1 `EnvironmentPostProcessor` - ¶Ô»·¾³×ö´¦Àí + 对环境å�šå¤„ç�† 1.2 `PropertySourceLoader` - ½âÎö²»Í¬µÄ¸ñʽµÄÎļþ + è§£æž�ä¸�å�Œçš„æ ¼å¼�的文件 1.2 `ApplicationListener` - spring-cloud°üÖÐͨ¹ýÐÂÔöÀ©Õ¹BootstrapApplicationListener + spring-cloud包中通过新增扩展BootstrapApplicationListener 1.3 `BootstrapConfiguration` - ͨ¹ýÀ©Õ¹µã¼ÓÔØÆô¶¯Àà + 通过扩展点加载å�¯åŠ¨ç±» -2. Îļþ¼ÓÔØ¹ý³Ì - ͨ¹ýApplicationListenerʼþ´´½¨Ò»¸öеÄSpringAplictionÆô¶¯ÀཫBootstrapConfigurationÀ©Õ¹Àà×÷ΪÆô¶¯ÅäÖÃÀ࣬Ȼºó»ñµÃÁËÒ»¸ö³õʼ»¯Á˵ÄBootStrapÈÝÆ÷£¬½«¸ÃÈÝÆ÷·â×°³ÉAncestorInitializerÀà¼ÓÈëµ½ÎÒÃÇ×Ô¼ºµÄÆô¶¯ÀàÖУ¬×÷ÓþÍÊǽ«ÎÒÃÇ×Ô¼ºÈÝÆ÷µÄ¸¸ÈÝÆ÷ÉèÖÃΪBootStrapÈÝÆ÷¡£Í¨¹ýBootStrapÈÝÆ÷»ñµÃ³õʼ»¯ºÃºóµÄApplicationContextInitializerÀàÐͶÔÏ󣬶ø¸ÃÀàÀ´×ÔÓÚPropertySourceBootstrapConfigurationÆô¶¯ÅäÖÃÀ࣬¸ÃÀàÖÐÓÖ×¢ÈëÁËPropertySourceLocatorÀ࣬¶øÔÚConfigServiceBootstrapConfigurationÆô¶¯ÅäÖÃÀàÖÐÅäÖÃbean¶ÔÏó - ConfigServicePropertySourceLocator£¬ËùÒÔ×îÖջὫBootStrapÖгõʼºÃµÄPropertySourceBootstrapConfiguration¼ÓÈëµ½ÎÒÃÇ×Ô¼ºµÄÆô¶¯ÀàÖе÷Óã¬×îÖÕµ÷ÓÃinitialize·½·¨È»ºóµ÷ÓÃConfigServicePropertySourceLocator.locate·½·¨È¥Config server·þÎñ»ñÈ¡ÅäÖᣠ+2. 文件加载过程 + 通过ApplicationListener事件创建一个新的SpringAplictionå�¯åŠ¨ç±»å°†BootstrapConfiguration扩展类作为å�¯åЍé…�置类,然å�ŽèŽ·å¾—äº†ä¸€ä¸ªåˆ�始化了的BootStrap容器,将该容器å°�装æˆ�AncestorInitializer类加入到我们自己的å�¯åŠ¨ç±»ä¸­ï¼Œä½œç”¨å°±æ˜¯å°†æˆ‘ä»¬è‡ªå·±å®¹å™¨çš„çˆ¶å®¹å™¨è®¾ç½®ä¸ºBootStrap容器。通过BootStrap容器获得åˆ�始化好å�Žçš„ApplicationContextInitializer类型对象,而该类æ�¥è‡ªäºŽPropertySourceBootstrapConfigurationå�¯åЍé…�置类,该类中å�ˆæ³¨å…¥äº†PropertySourceLocator类,而在ConfigServiceBootstrapConfigurationå�¯åЍé…�置类中é…�ç½®bean对象 + ConfigServicePropertySourceLocator,所以最终会将BootStrap中åˆ�始好的PropertySourceBootstrapConfiguration加入到我们自己的å�¯åŠ¨ç±»ä¸­è°ƒç”¨ï¼Œæœ€ç»ˆè°ƒç”¨initialize方法然å�Žè°ƒç”¨ConfigServicePropertySourceLocator.locate方法去Config serveræœ�务获å�–é…�置。 -×÷ÕߣºÓµ±§¹Â¶À_to -Á´½Ó£ºhttps://www.jianshu.com/p/60c6ab0e79d5 -À´Ô´£º¼òÊé -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +作者:拥抱孤独_to +链接:https://www.jianshu.com/p/60c6ab0e79d5 +æ�¥æº�:简书 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudEureka\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudEureka\346\272\220\347\240\201\345\210\206\346\236\220.md" index 0236a13..1c0bb87 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudEureka\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudEureka\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,52 +1,52 @@ -EurekaÔ´Âë·ÖÎö +Eurekaæº�ç �分æž� -**µÚ1Õ ºËÐÄÁ÷³Ì** -**1.1 Eureka×öÁËʲôÊÂ** +**第1ç«  核心æµ�程** +**1.1 Eurekaå�šäº†ä»€ä¹ˆäº‹** -Ê×ÏÈÎÒÃǶ¼Ã÷°×£¬EurekaÊÇÓÃÔÚ×ö·þÎñ×¢²áµÄ£¬¶ø×¢²áÖÐÐÄҪʵÏÖʲô¹¦ÄÜÄØ£¿Õâ¸ö±ØÐëÃ÷È·ÁË¡£ +首先我们都明白,Eureka是用在å�šæœ�务注册的,而注册中心è¦�实现什么功能呢?这个必须明确了。 -1. ¼ÈÈ»ÊÇ×¢²áÖÐÐÄ£¬ÄÇÊ×ÏÈÒªÄܱ£´æ·þÎñµÄip¡¢portµÈÐÅÏ¢°É£¬ÕâÊÇEureka-server±ØÐëÌṩµÄ»ù´¡¹¦ÄÜ¡£ -2. µ±ÎÒ×¢²áÉÏÀ´Ö®ºó£¬»¹ÒªÌṩһЩ¶¯Ì¬¸ÐÖª·þÎñÉÏÏÂÏߵŦÄܰɣ¬Èç¹ûÒ»¸ö·þÎñÉÏÏÂÏߣ¬Eureka-server¶¼²»ÖªµÀ£¬ÄÇÕâ¸öÍæÒâ¶ù¾ÍÒ»ÎIJ»ÖµÁË¡£ -3. µ±Eureka-server¶Ë¸ÐÖªµ½·þÎñµÄ±ä»¯Ö®ºó×ܵÃ֪ͨÏû·Ñ¶Ë°É£¬ÕâÀï¾ÍÇ£³¶µ½Ê±server¶ËÖ÷¶¯Í¨Öªclient¶ËÄØ»¹ÊÇclient¶Ë×Ô¼ºÈ¥À­È¡ÐÅÏ¢ÄØ£¿Õâ¸öÏÖÔÚ²»ÖªµÀ£¬µÈ»áÈ¥¿´Ô´ÂëÑéÖ¤¡£ -4. OK£¬ÉÏÃæµÄ¹¦Äܶ¼ÊµÏÖÁË£¬Eureka»ù±¾ºÏ¸ñÁË£¬ÄÇ»¹ÓÐÒ»²½£¬¼ÈÈ»·þÎñµÄipºÍ¶Ë¿Ú¶¼ÔÚEureka-serverÉÏÃæ£¬ÄÇÎÒÏû·Ñ¶Ëµ÷Ó÷þÎñ¶ËµÄʱºò£¬Í¨ÐÅÊÇÓõÄOpenFeign£¬ÄÇOpenFeignÊÇÔõô֪µÀµ÷ÓÃÄĸö·þÎñµÄ£¿Ö®Ç°¶¼ÊÇдËÀÔÚapplication.propertiesÀïÃæµÄ.ribbon.listOfServersÖУ¬ÏÖÔÚEurekaÔõô×Ô¶¯Ð´½øÈ¥µÄÄØ£¿ -5. ÉÏÃæ4¸ö¹¦ÄÜ»ù±¾ÉÏÍê³ÉÁË×¢²áÖÐÐĸÃÓеŦÄÜ£¬ÄÇÕâ¸öʱºòÎÒÃÇÔÙÀ´Ë¼¿¼Ò»Ï£¬×¢²áÖÐÐÄÓÃÓÚ΢·þÎñÏîÄ¿ÖУ¬ÄÇ×¢²áÖÐÐÄÒ²×÷Ϊһ¸ö·þÎñ£¬ËüÒ²ÐèÒª×ö¼¯ÈºµÄ£¬Õâ¸öʱºòÎÒÃǾÍÒªÏëһϣ¬×ö¼¯ÈºÔõô±£Ö¤Êý¾ÝÒ»ÖÂÐÔ£¬¸Ã»ùÓÚʲôÀíÂÛ£¿ - ÉÏÃæÊÇEurekaҪʵÏÖµÄ×îºËÐĵŦÄÜ£¬ÄÇÕâЩ¹¦ÄÜÌṩ³öÀ´ÁË£¬ÎÒÏîÄ¿Ôõôȥµ÷ÓÃÄØ£¿²»ÄÜÖ±½ÓÈ¥µ÷API°É£¬Õâ¶àÂé·³£¬»¹µÃȥѧһ±éEurekaµÄapi£¬Íê¶¿×ÓÁË¡£ +1. 既然是注册中心,那首先è¦�能ä¿�å­˜æœ�务的ipã€�port等信æ�¯å�§ï¼Œè¿™æ˜¯Eureka-serverå¿…é¡»æ��供的基础功能。 +2. 当我注册上æ�¥ä¹‹å�Žï¼Œè¿˜è¦�æ��供一些动æ€�感知æœ�务上下线的功能å�§ï¼Œå¦‚果一个æœ�务上下线,Eureka-server都ä¸�知é�“,那这个玩æ„�儿就一文ä¸�值了。 +3. 当Eureka-server端感知到æœ�务的å�˜åŒ–之å�Žæ€»å¾—通知消费端å�§ï¼Œè¿™é‡Œå°±ç‰µæ‰¯åˆ°æ—¶server端主动通知client端呢还是client端自己去拉å�–ä¿¡æ�¯å‘¢ï¼Ÿè¿™ä¸ªçŽ°åœ¨ä¸�知é�“,等会去看æº�ç �验è¯�。 +4. OK,上é�¢çš„功能都实现了,Eureka基本å�ˆæ ¼äº†ï¼Œé‚£è¿˜æœ‰ä¸€æ­¥ï¼Œæ—¢ç„¶æœ�务的ip和端å�£éƒ½åœ¨Eureka-server上é�¢ï¼Œé‚£æˆ‘消费端调用æœ�务端的时候,通信是用的OpenFeign,那OpenFeign是怎么知é�“调用哪个æœ�务的?之å‰�都是写死在application.properties里é�¢çš„.ribbon.listOfServers中,现在Eureka怎么自动写进去的呢? +5. 上é�¢4个功能基本上完æˆ�了注册中心该有的功能,那这个时候我们å†�æ�¥æ€�考一下,注册中心用于微æœ�务项目中,那注册中心也作为一个æœ�务,它也需è¦�å�šé›†ç¾¤çš„,这个时候我们就è¦�想一下,å�šé›†ç¾¤æ€Žä¹ˆä¿�è¯�æ•°æ�®ä¸€è‡´æ€§ï¼Œè¯¥åŸºäºŽä»€ä¹ˆç�†è®ºï¼Ÿ + 上é�¢æ˜¯Eurekaè¦�实现的最核心的功能,那这些功能æ��供出æ�¥äº†ï¼Œæˆ‘项目怎么去调用呢?ä¸�能直接去调APIå�§ï¼Œè¿™å¤šéº»çƒ¦ï¼Œè¿˜å¾—去学一é��Eurekaçš„api,完犊å­�了。 -Õâ¸öʱºòÎÒÃǾͻáÁªÏëµ½SpringBootµÄ×Ô¶¯×°ÅäºÍStarter×é¼þ¡£ÕâÁ½¸öÍæÒâ¶ù°ïÎÒÃÇÍê³ÉÁ˺ËÐÄbeanµÄ×Ô¶¯×¢È룬µ×²ã¿ÉÒÔÖ±½ÓÄõ½bean£¬È»ºóÔÚStarter×é¼þÖÐÓ¦¸Ã×Ô¶¯°ïÎÒÃǵ÷ÓÃÁËAPIµÄ£»OK£¬ÄǻعýÍ·À´ÎÒ·¢ÏÖ£¬ÎÒµÄEureka-client¾ÍÊÇÒ»¸östarter×é¼þ£¬ºÙºÙ£¬Óе㶫Î÷ÁË¡£Õâ¸öclient¶ËºËÐÄÂß¼­¿Ï¶¨ÊǰïÎÒÃÇ·â×°Á˸÷ÖÖbean£¬È»ºó°ïÎÒÃǵ÷ÓÃÁ˺ËÐÄapiÁË¡£ +这个时候我们就会è�”想到SpringBoot的自动装é…�å’ŒStarter组件。这两个玩æ„�儿帮我们完æˆ�了核心bean的自动注入,底层å�¯ä»¥ç›´æŽ¥æ‹¿åˆ°bean,然å�Žåœ¨Starter组件中应该自动帮我们调用了API的;OK,那回过头æ�¥æˆ‘å�‘现,我的Eureka-client就是一个starter组件,嘿嘿,有点东西了。这个client端核心逻辑肯定是帮我们å°�装了å�„ç§�bean,然å�Žå¸®æˆ‘们调用了核心api了。 -ÕâÀïÕë¶ÔEurekaµÄºËÐŦÄÜÎÒÃÇÔÚ×öÒ»¸ö¸ü¼ò±ãµÄ×ܽ᣺ +这里针对Eureka的核心功能我们在å�šä¸€ä¸ªæ›´ç®€ä¾¿çš„æ€»ç»“: -1. ʵÏÖ×¢²á£¬²¢´æÔÚÄÚ´æÖÐ -2. ¶¯Ì¬¸ÐÖª·þÎñµÄ½¡¿µ×´Ì¬ -3. ·þÎñµÄ·¢ÏÖ£¬¼°¶¯Ì¬¸ÐÖª·þÎñµÄ±ä»¯ - **1.2 ºËÐÄÁ÷³ÌÍÆµ¼** - Ã÷È·Á˺ËÐŦÄÜ£¬ÒÔ¼°ÈçºÎµ÷Óõ쬽ÓÏÂÀ´ÎÒÃÇÀ´´óµ¨µØÍƵ¼Ò»ÏºËÐÄÁ÷³Ìͼ£º +1. 实现注册,并存在内存中 +2. 动æ€�感知æœ�务的å�¥åº·çжæ€� +3. æœ�务的å�‘现,å�ŠåЍæ€�感知æœ�务的å�˜åŒ– + **1.2 核心æµ�程推导** + 明确了核心功能,以å�Šå¦‚何调用的,接下æ�¥æˆ‘们æ�¥å¤§èƒ†åœ°æŽ¨å¯¼ä¸€ä¸‹æ ¸å¿ƒæµ�程图: -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f15564313c2406546821713bcaf3eb0e9ac73d.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø")´óÌåÁ÷³ÌÍÆµ¼³öÀ´Ö®ºó£¬ÎÒÃÇÔÙÀ´Í¨¹ýÔ´Âë×öÒ»¸öÑéÖ¤¡£ +![SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f15564313c2406546821713bcaf3eb0e9ac73d.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区")大体æµ�程推导出æ�¥ä¹‹å�Žï¼Œæˆ‘们å†�æ�¥é€šè¿‡æº�ç �å�šä¸€ä¸ªéªŒè¯�。 -**µÚ2Õ ԴÂë·ÖÎö** -**2.1 ·þÎñ×¢²áµÄÈë¿Ú** -·þÎñ×¢²áÊÇÔÚspring bootÓ¦ÓÃÆô¶¯µÄʱºò·¢ÆðµÄ¡£¾ßÌåµÄÖ´Ðз¾¶ÎÒÃÇÔÝÇÒ²»¿´£¬ÏȻعËÒ»ÏÂÇ°ÃæÔÛÃǽ²¹ýµÄ֪ʶ¡£ +**第2ç«  æº�ç �分æž�** +**2.1 æœ�务注册的入å�£** +æœ�务注册是在spring boot应用å�¯åŠ¨çš„æ—¶å€™å�‘起的。具体的执行路径我们暂且ä¸�看,先回顾一下å‰�é�¢å’±ä»¬è®²è¿‡çš„知识。 -ÎÒÃÇ˵spring cloudÊÇÒ»¸öÉú̬£¬ËüÌṩÁËÒ»Ì×±ê×¼£¬ÕâÌ×±ê×¼¿ÉÒÔͨ¹ý²»Í¬µÄ×é¼þÀ´ÊµÏÖ£¬ÆäÖоͰüº¬·þÎñ×¢²á/·¢ÏÖ¡¢ÈÛ¶Ï¡¢¸ºÔؾùºâµÈ£¬ÔÚspring-cloud-commonÕâ¸ö°üÖУ¬ -org.springframework.cloud.client.serviceregistry ·¾¶Ï£¬¿ÉÒÔ¿´µ½Ò»¸ö·þÎñ×¢²áµÄ½Ó¿Ú¶¨ Òå ServiceRegistry ¡£Ëü¾ÍÊǶ¨ÒåÁËspring cloudÖзþÎñ×¢²áµÄÒ»¸ö½Ó¿Ú¡£ +我们说spring cloud是一个生æ€�,它æ��供了一套标准,这套标准å�¯ä»¥é€šè¿‡ä¸�å�Œçš„组件æ�¥å®žçŽ°ï¼Œå…¶ä¸­å°±åŒ…å�«æœ�务注册/å�‘现ã€�熔断ã€�è´Ÿè½½å�‡è¡¡ç­‰ï¼Œåœ¨spring-cloud-common这个包中, +org.springframework.cloud.client.serviceregistry 路径下,å�¯ä»¥çœ‹åˆ°ä¸€ä¸ªæœ�务注册的接å�£å®š 义 ServiceRegistry 。它就是定义了spring cloud中æœ�务注册的一个接å�£ã€‚ -ÎÒÃÇ¿´Ò»ÏÂËüµÄÀà¹ØÏµÍ¼£¬Õâ¸ö½Ó¿ÚÓÐÒ»¸öΨһµÄʵÏÖ EurekaServiceRegistry ¡£±íʾ²ÉÓõÄÊÇEureka Server×÷Ϊ·þÎñ×¢²áÖÐÐÄ¡£ +我们看一下它的类关系图,这个接å�£æœ‰ä¸€ä¸ªå”¯ä¸€çš„实现 EurekaServiceRegistry 。表示采用的是Eureka Server作为æœ�务注册中心。 -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/49d085328febfffcbae4030dac151db2d0bfcb.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø")**2.1.1 ×¢²áµÄʱ»ú** -·þÎñ×¢²áµÄ·¢Æð£¬ÎÒÃÇ¿ÉÒԲ²âÒ»ÏÂÓ¦¸ÃÊÇʲôʱºòÍê³É£¿´ó¼Ò×ÔÒªÏëÏëÆäʵӦ¸Ã²»ÄѲ²⵽£¬·þÎñµÄ×¢²áÈ¡¾öÓÚ·þÎñÊÇ·ñÒѾ­Æô¶¯ºÃÁË¡£¶øÔÚspring bootÖУ¬»áµÈµ½spring ÈÝÆ÷Æô¶¯²¢ÇÒËùÓеÄÅäÖö¼Íê³ÉÖ®ºóÀ´½øÐÐ×¢²á¡£¶øÕâ¸ö¶¯×÷ÔÚspring bootµÄÆô¶¯·½·¨ÖеÄrefreshContextÖÐÍê³É¡£ +![SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/49d085328febfffcbae4030dac151db2d0bfcb.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区")**2.1.1 注册的时机** +æœ�务注册的å�‘起,我们å�¯ä»¥çŒœæµ‹ä¸€ä¸‹åº”该是什么时候完æˆ�?大家自è¦�想想其实应该ä¸�难猜测到,æœ�务的注册å�–决于æœ�务是å�¦å·²ç»�å�¯åŠ¨å¥½äº†ã€‚è€Œåœ¨spring boot中,会等到spring 容器å�¯åŠ¨å¹¶ä¸”æ‰€æœ‰çš„é…�置都完æˆ�之å�Žæ�¥è¿›è¡Œæ³¨å†Œã€‚而这个动作在spring bootçš„å�¯åŠ¨æ–¹æ³•ä¸­çš„refreshContext中完æˆ�。 -ÎÒÃǹ۲ìÒ»ÏÂfinishRefreshÕâ¸ö·½·¨£¬´ÓÃû×ÖÉÏ¿ÉÒÔ¿´µ½ËüÊÇÓÃÀ´ÌåÏÖÍê³ÉˢеIJÙ×÷£¬Ò²¾ÍÊÇË¢ÐÂÍê³ÉÖ®ºóÒª×öµÄºóÖõIJÙ×÷¡£ËüÖ÷Òª×ö¼¸¸öÊÂÇé +我们观察一下finishRefresh这个方法,从å��字上å�¯ä»¥çœ‹åˆ°å®ƒæ˜¯ç”¨æ�¥ä½“现完æˆ�刷新的æ“�作,也就是刷新完æˆ�之å�Žè¦�å�šçš„å�Žç½®çš„æ“�作。它主è¦�å�šå‡ ä¸ªäº‹æƒ… -* Çå¿Õ»º´æ +* 清空缓存 -* ³õʼ»¯Ò»¸öLifecycleProcessor£¬ÔÚSpringÆô¶¯µÄʱºòÆô¶¯bean£¬ÔÚspring½áÊøµÄʱºòÏú»Ùbean +* åˆ�始化一个LifecycleProcessor,在Springå�¯åŠ¨çš„æ—¶å€™å�¯åЍbean,在spring结æ�Ÿçš„æ—¶å€™é”€æ¯�bean -* µ÷ÓÃLifecycleProcessorµÄonRefresh·½·¨£¬Æô¶¯ÊµÏÖÁËLifecycle½Ó¿ÚµÄbean +* 调用LifecycleProcessorçš„onRefresh方法,å�¯åŠ¨å®žçŽ°äº†Lifecycle接å�£çš„bean -* ·¢²¼ContextRefreshedEvent +* å�‘布ContextRefreshedEvent -* ×¢²áBean£¬Í¨¹ýJMX½øÐÐ¼à¿ØºÍ¹ÜÀí +* 注册Bean,通过JMX进行监控和管ç�† @@ -73,12 +73,12 @@ org.springframework.cloud.client.serviceregistry · -ÔÚÕâ¸ö·½·¨ÖУ¬ÎÒÃÇÖØµã¹Ø×¢ getLifecycleProcessor().onRefresh() £¬ËüÊǵ÷ÓÃÉúÃüÖÜÆÚ´¦ÀíÆ÷µÄonrefresh·½·¨£¬ÕÒµ½SmartLifecycle½Ó¿ÚµÄËùÓÐʵÏÖÀಢµ÷ÓÃstart·½·¨¡£ +在这个方法中,我们é‡�点关注 getLifecycleProcessor().onRefresh() ,它是调用生命周期处ç�†å™¨çš„onrefresh方法,找到SmartLifecycle接å�£çš„æ‰€æœ‰å®žçŽ°ç±»å¹¶è°ƒç”¨start方法。 **2.1.2 SmartLifeCycle** -ÎÒÍØÕ¹Ò»ÏÂSmartLifeCycleÕâ¿éµÄ֪ʶ£¬ SmartLifeCycleÊÇÒ»¸ö½Ó¿Ú£¬µ±SpringÈÝÆ÷¼ÓÔØÍêËùÓеÄBean²¢ÇÒ³õʼ»¯Ö®ºó£¬»á¼ÌÐø»Øµ÷ʵÏÖÁËSmartLifeCycle½Ó¿ÚµÄÀàÖжÔÓ¦µÄ·½·¨£¬±ÈÈ磨start£©¡£ +我拓展一下SmartLifeCycleè¿™å�—的知识, SmartLifeCycle是一个接å�£ï¼Œå½“Spring容器加载完所有的Bean并且åˆ�始化之å�Žï¼Œä¼šç»§ç»­å›žè°ƒå®žçŽ°äº†SmartLifeCycle接å�£çš„类中对应的方法,比如(start)。 -ʵ¼ÊÉÏÎÒÃÇ×Ô¼ºÒ²¿ÉÒÔÍØÕ¹£¬±ÈÈçÔÚspringboot¹¤³ÌµÄmain·½·¨Í¬¼¶Ä¿Â¼Ï£¬Ð´Ò»¸ö²âÊÔÀ࣬ʵÏÖSmartLifeCycle½Ó¿Ú£¬²¢ÇÒͨ¹ý @Service ÉùÃ÷Ϊһ¸öbean£¬ÒòΪҪ±»springÈ¥¼ÓÔØ£¬Ê×ÏȵÃÊÇbean¡£ +实际上我们自己也å�¯ä»¥æ‹“展,比如在springboot工程的main方法å�Œçº§ç›®å½•下,写一个测试类,实现SmartLifeCycle接å�£ï¼Œå¹¶ä¸”通过 @Service 声明为一个bean,因为è¦�被spring去加载,首先得是bean。 @@ -86,23 +86,23 @@ org.springframework.cloud.client.serviceregistry · @Service public class TestSmartLifeCycle implements SmartLifecycle { /** - * ·þÎñÆô¶¯ºóÖ´ÐÐ.ÎÞÐèÏÔʾµ÷ÓÃstart·½·¨. - * µ«ÊÇÒÀÀµisAutoStartup()·µ»ØÖµ,Ö»ÓÐisAutoStartup()·µ»ØtrueµÄʱºò,start()²Å»á±»Ö´ÐÐ + * æœ�务å�¯åЍå�Žæ‰§è¡Œ.无需显示调用start方法. + * 但是ä¾�èµ–isAutoStartup()返回值,å�ªæœ‰isAutoStartup()返回true的时候,start()æ‰�会被执行 */ @Override public void start() { System.out.println("----------start-----------"); } /** - * ·þÎñֹͣǰִÐз½·¨ - * ǰÌáÌõ¼þ: isRunning()·µ»Øtrue²Å»á±»Ö´ÐÐ + * æœ�务å�œæ­¢å‰�执行方法 + * å‰�æ��æ�¡ä»¶: isRunning()返回trueæ‰�会被执行 */ @Override public void stop() { System.out.println("----------stop-----------"); } /** - * ·µ»Ø·þÎñÔËÐÐ״̬,Ó°Ïìµ½·þÎñÊÇ·ñµ÷ÓÃstop·½·¨ + * 返回æœ�务è¿�行状æ€�,å½±å“�到æœ�务是å�¦è°ƒç”¨stop方法 * @return */ @Override @@ -110,8 +110,8 @@ public class TestSmartLifeCycle implements SmartLifecycle { return false; } /** - * ÊÇ·ñµ÷ÓÃstart·½·¨,ÐèҪעÒâ - * µ±Ç°·½·¨·µ»ØfalseÊDz»»áÖ´ÐÐstart() + * 是å�¦è°ƒç”¨start方法,需è¦�注æ„� + * 当å‰�方法返回false是ä¸�会执行start() * @return */ @Override @@ -124,8 +124,8 @@ public class TestSmartLifeCycle implements SmartLifecycle { runnable.run(); } /** - * Ö¸¶¨Ö´ÐÐ˳Ðò - * µ±Ç°ÈÝÆ÷Èç¹ûÓжà¸öÀàʵÏÖÁËSmartLifecycle,Ôò°´´Ë·¨·½·¨·µ»ØÖµÅÅÐòÖ´ÐÐ + * 指定执行顺åº� + * 当å‰�容器如果有多个类实现了SmartLifecycle,则按此法方法返回值排åº�执行 * @return */ @Override @@ -143,9 +143,9 @@ public class TestSmartLifeCycle implements SmartLifecycle { -½Ó×Å£¬ÎÒÃÇÆô¶¯spring bootÓ¦Óú󣬿ÉÒÔ¿´µ½¿ØÖÆÌ¨Êä³öÁË start ×Ö·û´®¡£ +接ç�€ï¼Œæˆ‘们å�¯åЍspring boot应用å�Žï¼Œå�¯ä»¥çœ‹åˆ°æŽ§åˆ¶å�°è¾“出了 start 字符串。 -ÎÒÃÇÔÚDefaultLifecycleProcessor.startBeans·½·¨ÉϼÓÒ»¸ödebug£¬¿ÉÒÔºÜÃ÷ÏԵĿ´µ½ÎÒÃÇ×Ô¼º¶¨ÒåµÄTestSmartLifeCycle±»É¨Ãèµ½ÁË£¬²¢ÇÒ×îºó»áµ÷ÓøÃbeanµÄstart·½·¨¡£![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/75b18e528ba1879148c106d9bd3fb61ab9b5bb.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÔÚstartBeans·½·¨ÖУ¬ÎÒÃÇ¿ÉÒÔ¿´µ½ËüÊ×ÏÈ»á»ñµÃËùÓÐʵÏÖÁËSmartLifeCycleµÄBean£¬È»ºó»áÑ­»·µ÷ÓÃʵÏÖÁËSmartLifeCycleµÄbeanµÄstart·½·¨£¬´úÂëÈçÏ¡£ +我们在DefaultLifecycleProcessor.startBeans方法上加一个debug,å�¯ä»¥å¾ˆæ˜Žæ˜¾çš„看到我们自己定义的TestSmartLifeCycle被扫æ��到了,并且最å�Žä¼šè°ƒç”¨è¯¥beançš„start方法。![SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/75b18e528ba1879148c106d9bd3fb61ab9b5bb.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区")在startBeans方法中,我们å�¯ä»¥çœ‹åˆ°å®ƒé¦–先会获得所有实现了SmartLifeCycleçš„Bean,然å�Žä¼šå¾ªçŽ¯è°ƒç”¨å®žçŽ°äº†SmartLifeCycleçš„beançš„start方法,代ç �如下。 @@ -206,7 +206,7 @@ private void doStart(Map lifecycleBeans, String bea this.logger.trace("Starting bean '" + beanName + "' of type [" + bean.getClass().getName() + "]"); } try { - bean.start(); //´Ëʱ BeanµÄʵÀýÓ¦¸ÃÊÇEurekaAutoServiceRegistration + bean.start(); //此时 Bean的实例应该是EurekaAutoServiceRegistration } catch (Throwable var10) { throw new ApplicationContextException("Failed to start bean '" + beanName + "'", var10); } @@ -226,8 +226,8 @@ private void doStart(Map lifecycleBeans, String bea -´Ëʱ£¬bean.start()£¬µ÷ÓõĿÉÄÜÊÇ -EurekaAutoServiceRegistrationÖеÄstart·½·¨£¬ÒòΪºÜÏÔÈ»£¬ËüʵÏÖÁËSmartLifeCycle½Ó¿Ú¡£ +此时,bean.start(),调用的å�¯èƒ½æ˜¯ +EurekaAutoServiceRegistration中的start方法,因为很显然,它实现了SmartLifeCycle接å�£ã€‚ @@ -265,11 +265,11 @@ public class EurekaAutoServiceRegistration implements AutoServiceRegistration,Sm -ÔÚstart·½·¨ÖУ¬ÎÒÃÇ¿ÉÒÔ¿´µ½ -this.serviceRegistry.register Õâ¸ö·½·¨£¬Ëüʵ¼ÊÉϾÍÊÇ·¢Æð·þÎñ×¢²áµÄ»úÖÆ¡£ +在start方法中,我们å�¯ä»¥çœ‹åˆ° +this.serviceRegistry.register 这个方法,它实际上就是å�‘èµ·æœ�务注册的机制。 -´Ëʱthis.serviceRegistryµÄʵÀý£¬Ó¦¸ÃÊÇ EurekaServiceRegistry £¬ Ô­ÒòÊÇ -EurekaAutoServiceRegistrationµÄ¹¹Ôì·½·¨ÖУ¬»áÓÐÒ»¸ö¸³Öµ²Ù×÷£¬¶øÕâ¸ö¹¹Ôì·½·¨ÊÇÔÚEurekaClientAutoConfiguration Õâ¸ö×Ô¶¯×°ÅäÀàÖб»×°ÅäºÍ³õʼ»¯µÄ£¬´úÂëÈçÏ¡£ +此时this.serviceRegistry的实例,应该是 EurekaServiceRegistry , 原因是 +EurekaAutoServiceRegistration的构造方法中,会有一个赋值æ“�作,而这个构造方法是在EurekaClientAutoConfiguration 这个自动装é…�类中被装é…�å’Œåˆ�始化的,代ç �如下。 @@ -292,8 +292,8 @@ public EurekaAutoServiceRegistration eurekaAutoServiceRegistration( -**2.2 ·þÎñµÄ×¢²áÁ÷³Ì** -½ÓÏÂÀ´ÎÒÃÇ·ÖÎö·þÎñ×¢²áµÄÁ÷³Ì +**2.2 æœ�务的注册æµ�程** +接下æ�¥æˆ‘们分æž�æœ�务注册的æµ�程 @@ -302,7 +302,7 @@ public class EurekaAutoServiceRegistration implements AutoServiceRegistration, SmartLifecycle, Ordered, SmartApplicationListener { @Override public void start() { - //Ê¡ÂÔ... + //çœ�ç•¥... this.serviceRegistry.register(this.registration); this.context.publishEvent(new InstanceRegisteredEvent<> this,this.registration.getInstanceConfig())); } @@ -317,9 +317,9 @@ SmartLifecycle, Ordered, SmartApplicationListener { -this.serviceRegistry.register(this.registration); ·½·¨×îÖÕ»áµ÷Óà +this.serviceRegistry.register(this.registration); 方法最终会调用 -EurekaServiceRegistry ÀàÖÐµÄ register ·½·¨À´ÊµÏÖ·þÎñ×¢²á +EurekaServiceRegistry 类中的 register 方法æ�¥å®žçްæœ�务注册 **2.2.1 register** @@ -335,9 +335,9 @@ public void register(EurekaRegistration reg) { + " with eureka with status " + reg.getInstanceConfig().getInitialStatus()); } - //ÉèÖõ±Ç°ÊµÀýµÄ״̬£¬Ò»µ©Õâ¸öʵÀýµÄ״̬·¢Éú±ä»¯£¬Ö»Òª×´Ì¬²»ÊÇDOWN£¬ÄÇô¾Í»á±»¼àÌýÆ÷¼àÌý²¢ÇÒÖ´ÐзþÎñ×¢²á¡£ + //设置当å‰�实例的状æ€�,一旦这个实例的状æ€�å�‘生å�˜åŒ–,å�ªè¦�状æ€�ä¸�是DOWN,那么就会被监å�¬å™¨ç›‘å�¬å¹¶ä¸”执行æœ�务注册。 reg.getApplicationInfoManager().setInstanceStatus(reg.getInstanceConfig().getInitialStatus()); - //ÉèÖý¡¿µ¼ì²éµÄ´¦Àí + //设置å�¥åº·æ£€æŸ¥çš„处ç�† reg.getHealthCheckHandler().ifAvailable(healthCheckHandler -> reg.getEurekaClient().registerHealthCheck(healthCheckHandler)); } ``` @@ -350,8 +350,8 @@ public void register(EurekaRegistration reg) { -´ÓÉÏÊö´úÂëÀ´¿´£¬×¢²á·½·¨Öв¢Ã»ÓÐÕæÕýµ÷ÓÃEurekaµÄ·½·¨È¥Ö´ÐÐ×¢²á£¬¶øÊǽö½öÉèÖÃÁËÒ»¸ö״̬ÒÔ¼°ÉèÖý¡¿µ¼ì²é´¦ÀíÆ÷¡£ÎÒÃǼÌÐø¿´Ò»Ï -reg.getApplicationInfoManager().setInstanceStatus·½·¨¡£ +从上述代ç �æ�¥çœ‹ï¼Œæ³¨å†Œæ–¹æ³•中并没有真正调用Eureka的方法去执行注册,而是仅仅设置了一个状æ€�以å�Šè®¾ç½®å�¥åº·æ£€æŸ¥å¤„ç�†å™¨ã€‚我们继续看一下 +reg.getApplicationInfoManager().setInstanceStatus方法。 @@ -382,12 +382,12 @@ public synchronized void setInstanceStatus(InstanceStatus status) { -ÔÚÕâ¸ö·½·¨ÖУ¬Ëü»áͨ¹ý¼àÌýÆ÷À´·¢²¼Ò»¸ö״̬±ä¸üʼþ¡£ok£¬´ËʱlistenerµÄʵÀýÊÇStatusChangeListener £¬Ò²¾ÍÊǵ÷Óà StatusChangeListener µÄnotify·½·¨¡£Õâ¸öʼþÊÇ´¥·¢Ò»¸ö·þÎñ״̬±ä¸ü£¬Ó¦¸ÃÊÇÓеط½»á¼àÌýÕâ¸öʼþ£¬È»ºó»ùÓÚÕâ¸öʼþ½øÐÐ×¢²á¡£ +在这个方法中,它会通过监å�¬å™¨æ�¥å�‘布一个状æ€�å�˜æ›´äº‹ä»¶ã€‚ok,此时listener的实例是StatusChangeListener ,也就是调用 StatusChangeListener çš„notify方法。这个事件是触å�‘一个æœ�务状æ€�å�˜æ›´ï¼Œåº”该是有地方会监å�¬è¿™ä¸ªäº‹ä»¶ï¼Œç„¶å�ŽåŸºäºŽè¿™ä¸ªäº‹ä»¶è¿›è¡Œæ³¨å†Œã€‚ -Õâ¸öʱºòÎÒÃÇÒÔΪÕÒµ½ÁË·½Ïò£¬È»ºóµã»÷½øÈ¥Ò»¿´£¬·¢ÏÖËüÊÇÒ»¸ö½Ó¿Ú¡£¶øÇÒÎÒÃÇ·¢ÏÖËüÊǾ²Ì¬µÄÄÚ²¿½Ó¿Ú£¬»¹ÎÞ·¨Ö±½Ó¿´µ½ËüµÄʵÏÖÀà¡£ +这个时候我们以为找到了方å�‘,然å�Žç‚¹å‡»è¿›åŽ»ä¸€çœ‹ï¼Œå�‘现它是一个接å�£ã€‚而且我们å�‘现它是é�™æ€�的内部接å�£ï¼Œè¿˜æ— æ³•直接看到它的实现类。 -ÒÀÎÒ¶àÄêÔ´ÂëÔĶÁ¾­Ñ飬ÓÚÊÇÓÖÍù»ØÕÒ£¬ÒòΪÎÒ»ù±¾ÉÏÄܲ²⵽һ¶¨ÊÇÔÚij¸öµØ·½×öÁ˳õʼ»¯µÄ¹¤×÷£¬ÓÚÊÇ£¬ÎÒÏëÕÒµ½ -EurekaServiceRegistry.register·½·¨ÖÐµÄ reg.getApplicationInfoManager Õâ¸öʵÀýÊÇʲô£¬¶øÇÒÎÒÃÇ·¢ÏÖApplicationInfoManagerÊÇÀ´×ÔÓÚEurekaRegistrationÕâ¸öÀàÖеÄÊôÐÔ¡£¶øEurekaRegistrationÓÖÊÇÔÚEurekaAutoServiceRegistrationÕâ¸öÀàÖÐʵÀý»¯µÄ¡£ÄÇÎÒÔÚÏ룬ÊDz»ÊÇÔÚ×Ô¶¯×°ÅäÖÐ×öÁËʲô¶«Î÷¡£ÓÚÊÇÕÒµ½EurekaClientAutoConfigurationÕâ¸öÀ࣬¹ûÈ»¿´µ½ÁËBeanµÄһЩ×Ô¶¯×°Å䣬ÆäÖаüº¬ EurekaClient ¡¢ ApplicationInfoMangager ¡¢ EurekaRegistration µÈ¡£ +ä¾�我多年æº�ç �阅读ç»�验,于是å�ˆå¾€å›žæ‰¾ï¼Œå› ä¸ºæˆ‘基本上能猜测到一定是在æŸ�个地方å�šäº†åˆ�始化的工作,于是,我想找到 +EurekaServiceRegistry.register方法中的 reg.getApplicationInfoManager 这个实例是什么,而且我们å�‘现ApplicationInfoManager是æ�¥è‡ªäºŽEurekaRegistration这个类中的属性。而EurekaRegistrationå�ˆæ˜¯åœ¨EurekaAutoServiceRegistration这个类中实例化的。那我在想,是ä¸�是在自动装é…�中å�šäº†ä»€ä¹ˆä¸œè¥¿ã€‚于是找到EurekaClientAutoConfiguration这个类,果然看到了Bean的一些自动装é…�,其中包å�« EurekaClient ã€� ApplicationInfoMangager ã€� EurekaRegistration 等。 **2.2.2 EurekaClientConfiguration** @@ -434,10 +434,10 @@ protected static class EurekaClientConfiguration { -²»ÄÑ·¢ÏÖ£¬ÎÒÃÇËÆºõ¿´µ½ÁËÒ»¸öºÜÖØÒªµÄBeanÔÚÆô¶¯µÄʱºò×öÁË×Ô¶¯×°Å䣬Ҳ¾ÍÊÇCloudEurekaClient ¡£´ÓÃû×ÖÉÏÀ´¿´£¬ÎÒ¿ÉÒÔºÜÈÝÒ×µÄʶ±ð²¢²Â²â³öËüÊÇEureka¿Í»§¶ËµÄÒ»¸ö¹¤¾ßÀ࣬ÓÃÀ´ÊµÏֺͷþÎñ¶ËµÄͨÐÅÒÔ¼°´¦Àí¡£Õâ¸öÊǺܶàÔ´ÂëÒ»¹áµÄÌ×·£¬ÒªÃ´ÔÚ¹¹Ôì·½·¨ÀïÃæÈ¥×öºÜ¶àµÄ³õʼ»¯ºÍһЩºǫִ́ÐеijÌÐò²Ù×÷£¬ÒªÃ´¾ÍÊÇͨ¹ýÒ첽ʼþµÄ·½Ê½À´´¦Àí¡£½Ó×Å£¬ÎÒÃÇ¿´Ò»ÏÂCloudEurekaClientµÄ³õʼ»¯¹ý³Ì£¬ËüµÄ¹¹Ôì·½·¨Öлáͨ¹ý super µ÷Óø¸ÀàµÄ¹¹Ôì·½·¨¡£Ò²¾ÍÊÇDiscoveryClientµÄ¹¹Ôì¡£ +ä¸�éš¾å�‘现,我们似乎看到了一个很é‡�è¦�çš„Bean在å�¯åŠ¨çš„æ—¶å€™å�šäº†è‡ªåŠ¨è£…é…�,也就是CloudEurekaClient 。从å��字上æ�¥çœ‹ï¼Œæˆ‘å�¯ä»¥å¾ˆå®¹æ˜“的识别并猜测出它是Eureka客户端的一个工具类,用æ�¥å®žçŽ°å’Œæœ�务端的通信以å�Šå¤„ç�†ã€‚这个是很多æº�ç �一贯的套路,è¦�么在构造方法里é�¢åŽ»å�šå¾ˆå¤šçš„åˆ�始化和一些å�Žå�°æ‰§è¡Œçš„程åº�æ“�作,è¦�么就是通过异步事件的方å¼�æ�¥å¤„ç�†ã€‚接ç�€ï¼Œæˆ‘们看一下CloudEurekaClientçš„åˆ�始化过程,它的构造方法中会通过 super 调用父类的构造方法。也就是DiscoveryClient的构造。 **2.2.3 CloudEurekaClient** -super(applicationInfoManager, config, args);µ÷Óø¸ÀàµÄ¹¹Ôì·½·¨£¬¶øCloudEurekaClientµÄ¸¸ÀàÊÇDiscoveryClient. +super(applicationInfoManager, config, args);调用父类的构造方法,而CloudEurekaClient的父类是DiscoveryClient. @@ -459,33 +459,33 @@ public CloudEurekaClient(ApplicationInfoManager applicationInfoManager,EurekaCli -**2.2.4 DiscoveryClient¹¹Ôì** -ÎÒÃÇ¿ÉÒÔ¿´µ½ÔÚ×îÖÕµÄDiscoveryClient¹¹Ôì·½·¨ÖУ¬Óзdz£³¤µÄ´úÂë¡£ÆäʵºÜ¶à´úÂë¿ÉÒÔ²»ÐèÒª¹ØÐÄ£¬´ó²¿·Ö¶¼ÊÇһЩ³õʼ»¯¹¤×÷£¬±ÈÈç³õʼ»¯Á˼¸¸ö¶¨Ê±ÈÎÎñ +**2.2.4 DiscoveryClient构造** +我们å�¯ä»¥çœ‹åˆ°åœ¨æœ€ç»ˆçš„DiscoveryClient构造方法中,有é�žå¸¸é•¿çš„代ç �。其实很多代ç �å�¯ä»¥ä¸�需è¦�关心,大部分都是一些åˆ�始化工作,比如åˆ�始化了几个定时任务 * scheduler -* heartbeatExecutor ÐÄÌø¶¨Ê±ÈÎÎñ +* heartbeatExecutor 心跳定时任务 -* cacheRefreshExecutor ¶¨Ê±È¥Í¬²½·þÎñ¶ËµÄʵÀýÁбí +* cacheRefreshExecutor 定时去å�Œæ­¥æœ�务端的实例列表 ``` DiscoveryClient(ApplicationInfoManager applicationInfoManager,EurekaClientConfig config, AbstractDiscoveryClientOptionalArgs args,Provider backupRegistryProvider,EndpointRandomizer endpointRandomizer) { - //Ê¡ÂÔ²¿·Ö´úÂë... - //ÊÇ·ñÒª´Óeureka serverÉÏ»ñÈ¡·þÎñµØÖ·ÐÅÏ¢ + //çœ�略部分代ç �... + //是å�¦è¦�从eureka server上获å�–æœ�务地å�€ä¿¡æ�¯ if (config.shouldFetchRegistry()) { this.registryStalenessMonitor = new ThresholdLevelsMetric(this,METRIC_REGISTRY_PREFIX + "lastUpdateSec_", new long[]{15L, 30L, 60L, 120L, 240L,480L}); } else { this.registryStalenessMonitor = ThresholdLevelsMetric.NO_OP_METRIC; } - //ÊÇ·ñҪע²áµ½eureka serverÉÏ + //是å�¦è¦�注册到eureka server上 if (config.shouldRegisterWithEureka()) { this.heartbeatStalenessMonitor = new ThresholdLevelsMetric(this,METRIC_REGISTRATION_PREFIX + "lastHeartbeatSec_", new long[]{15L, 30L, 60L,120L, 240L, 480L}); } else { this.heartbeatStalenessMonitor = ThresholdLevelsMetric.NO_OP_METRIC; } - //Èç¹û²»ÐèҪע²á²¢ÇÒ²»ÐèÒª¸üзþÎñµØÖ· + //如果ä¸�需è¦�注册并且ä¸�需è¦�æ›´æ–°æœ�务地å�€ if (!config.shouldRegisterWithEureka() && !config.shouldFetchRegistry()) { return; // no need to setup up an network tasks and we are done @@ -529,7 +529,7 @@ public CloudEurekaClient(ApplicationInfoManager applicationInfoManager,EurekaCli } catch (Throwable e) { throw new RuntimeException("Failed to initialize DiscoveryClient!", e); } - //Èç¹ûÐèҪע²áµ½Eureka server²¢ÇÒÊÇ¿ªÆôÁ˳õʼ»¯µÄʱºòÇ¿ÖÆ×¢²á£¬Ôòµ÷ÓÃregister()·¢Æð·þÎñ×¢²á + //如果需è¦�注册到Eureka server并且是开å�¯äº†åˆ�始化的时候强制注册,则调用register()å�‘èµ·æœ�务注册 if (clientConfig.shouldRegisterWithEureka() && clientConfig.shouldEnforceRegistrationAtInit()) { try { @@ -555,20 +555,20 @@ public CloudEurekaClient(ApplicationInfoManager applicationInfoManager,EurekaCli **2.2.5 initScheduledTasks** -initScheduledTasks È¥Æô¶¯Ò»¸ö¶¨Ê±ÈÎÎñ¡£ +initScheduledTasks 去å�¯åŠ¨ä¸€ä¸ªå®šæ—¶ä»»åŠ¡ã€‚ -* Èç¹ûÅäÖÃÁË¿ªÆô´Ó×¢²áÖÐÐÄˢзþÎñÁÐ±í£¬Ôò»á¿ªÆôcacheRefreshExecutorÕâ¸ö¶¨Ê±ÈÎÎñ -* Èç¹û¿ªÆôÁË·þÎñ×¢²áµ½Eureka£¬Ôòͨ¹ýÐèÒª×ö¼¸¸öÊÂÇé. +* 如果é…�置了开å�¯ä»Žæ³¨å†Œä¸­å¿ƒåˆ·æ–°æœ�务列表,则会开å�¯cacheRefreshExecutor这个定时任务 +* 如果开å�¯äº†æœ�务注册到Eureka,则通过需è¦�å�šå‡ ä¸ªäº‹æƒ…. -1. ½¨Á¢ÐÄÌø¼ì²â»úÖÆ +1. 建立心跳检测机制 -ͨ¹ýÄÚ²¿ÀàÀ´ÊµÀý»¯StatusChangeListener ʵÀý״̬¼à¿Ø½Ó¿Ú£¬Õâ¸ö¾ÍÊÇÇ°ÃæÎÒÃÇÔÚ·ÖÎöÆô¶¯¹ý³ÌÖÐËù¿´µ½µÄ£¬µ÷ÓÃnotifyµÄ·½·¨£¬Êµ¼ÊÉÏ»áÔÚÕâÀïÌåÏÖ¡£ +通过内部类æ�¥å®žä¾‹åŒ–StatusChangeListener 实例状æ€�监控接å�£ï¼Œè¿™ä¸ªå°±æ˜¯å‰�é�¢æˆ‘们在分æž�å�¯åŠ¨è¿‡ç¨‹ä¸­æ‰€çœ‹åˆ°çš„ï¼Œè°ƒç”¨notify的方法,实际上会在这里体现。 ``` private void initScheduledTasks() { - //Èç¹ûÅäÖÃÁË¿ªÆô´Ó×¢²áÖÐÐÄˢзþÎñÁÐ±í£¬Ôò»á¿ªÆôcacheRefreshExecutorÕâ¸ö¶¨Ê±ÈÎÎñ + //如果é…�置了开å�¯ä»Žæ³¨å†Œä¸­å¿ƒåˆ·æ–°æœ�务列表,则会开å�¯cacheRefreshExecutor这个定时任务 if (clientConfig.shouldFetchRegistry()) { // registry cache refresh timer int registryFetchIntervalSeconds = @@ -587,7 +587,7 @@ private void initScheduledTasks() { ), registryFetchIntervalSeconds, TimeUnit.SECONDS); } - //Èç¹û¿ªÆôÁË·þÎñ×¢²áµ½Eureka£¬Ôòͨ¹ýÐèÒª×ö¼¸¸öÊÂÇé + //如果开å�¯äº†æœ�务注册到Eureka,则通过需è¦�å�šå‡ ä¸ªäº‹æƒ… if (clientConfig.shouldRegisterWithEureka()) { int renewalIntervalInSecs = instanceInfo.getLeaseInfo().getRenewalIntervalInSecs(); @@ -607,7 +607,7 @@ private void initScheduledTasks() { new HeartbeatThread() ), renewalIntervalInSecs, TimeUnit.SECONDS); - // InstanceInfo replicator ³õʼ»¯Ò»¸ö:instanceInfoReplicator + // InstanceInfo replicator åˆ�始化一个:instanceInfoReplicator instanceInfoReplicator = new InstanceInfoReplicator( this, instanceInfo, @@ -634,11 +634,11 @@ private void initScheduledTasks() { instanceInfoReplicator.onDemandUpdate(); } }; - //×¢²áʵÀý״̬±ä»¯µÄ¼àÌý + //注册实例状æ€�å�˜åŒ–的监å�¬ if (clientConfig.shouldOnDemandUpdateStatusChange()) { applicationInfoManager.registerStatusChangeListener(statusChangeListener); } - //Æô¶¯Ò»¸öʵÀýÐÅÏ¢¸´ÖÆÆ÷£¬Ö÷Òª¾ÍÊÇΪÁË¿ªÆôÒ»¸ö¶¨Ê±Ị̈߳¬Ã¿40ÃëÅжÏʵÀýÐÅÏ¢ÊÇ·ñ±ä¸ü£¬Èç¹û±ä¸üÁËÔòÖØÐÂ×¢²á + //å�¯åŠ¨ä¸€ä¸ªå®žä¾‹ä¿¡æ�¯å¤�制器,主è¦�就是为了开å�¯ä¸€ä¸ªå®šæ—¶çº¿ç¨‹ï¼Œæ¯�40秒判断实例信æ�¯æ˜¯å�¦å�˜æ›´ï¼Œå¦‚æžœå�˜æ›´äº†åˆ™é‡�新注册 instanceInfoReplicator.start(clientConfig.getInitialInstanceInfoReplicationInte rvalSeconds()); } else { @@ -656,27 +656,27 @@ private void initScheduledTasks() { **2.2.6 onDemandUpdate** -Õâ¸ö·½·¨µÄÖ÷Òª×÷ÓÃÊǸù¾ÝʵÀýÊý¾ÝÊÇ·ñ·¢Éú±ä»¯£¬À´´¥·¢·þÎñ×¢²áÖÐÐĵÄÊý¾Ý¡£ +这个方法的主è¦�作用是根æ�®å®žä¾‹æ•°æ�®æ˜¯å�¦å�‘生å�˜åŒ–,æ�¥è§¦å�‘æœ�务注册中心的数æ�®ã€‚ ``` public boolean onDemandUpdate() { - //ÏÞÁ÷ÅÐ¶Ï + //é™�æµ�判断 if (rateLimiter.acquire(burstSize, allowedRatePerMinute)) { if (!scheduler.isShutdown()) { - //Ìá½»Ò»¸öÈÎÎñ + //æ��交一个任务 scheduler.submit(new Runnable() { @Override public void run() { logger.debug("Executing on-demand update of local InstanceInfo"); - //È¡³ö֮ǰÒѾ­Ìá½»µÄÈÎÎñ£¬Ò²¾ÍÊÇÔÚstart·½·¨ÖÐÌá½»µÄ¸üÐÂÈÎÎñ£¬Èç¹ûÈÎÎñ»¹Ã»ÓÐÖ´ÐÐÍê³É£¬ÔòÈ¡Ïû֮ǰµÄÈÎÎñ¡£ + //å�–出之å‰�å·²ç»�æ��交的任务,也就是在start方法中æ��交的更新任务,如果任务还没有执行完æˆ�,则å�–消之å‰�的任务。 Future latestPeriodic = scheduledPeriodicRef.get(); if (latestPeriodic != null && !latestPeriodic.isDone()) { logger.debug("Canceling the latest scheduled update, it will be rescheduled at the end of on demand update"); - latestPeriodic.cancel(false);//Èç¹û´ËÈÎÎñδÍê³É£¬¾ÍÁ¢¼´È¡Ïû + latestPeriodic.cancel(false);//如果此任务未完æˆ�,就立å�³å�–消 } - //ͨ¹ýµ÷ÓÃrun·½·¨£¬ÁîÈÎÎñÔÚÑÓʱºóÖ´ÐУ¬Ï൱ÓÚÖÜÆÚÐÔÈÎÎñÖеÄÒ»´Î + //通过调用run方法,令任务在延时å�Žæ‰§è¡Œï¼Œç›¸å½“于周期性任务中的一次 InstanceInfoReplicator.this.run(); } }); @@ -701,7 +701,7 @@ public boolean onDemandUpdate() { **2.2.7 run** -run·½·¨Êµ¼ÊÉϺÍÇ°Ãæ×Ô¶¯×°ÅäËùÖ´ÐеķþÎñ×¢²á·½·¨ÊÇÒ»ÑùµÄ£¬Ò²¾ÍÊǵ÷Óà register ·½·¨½øÐзþÎñ×¢²á£¬²¢ÇÒÔÚfinallyÖУ¬Ã¿30s»á¶¨Ê±Ö´ÐÐһϵ±Ç°µÄrun ·½·¨½øÐмì²é¡£ +run方法实际上和å‰�é�¢è‡ªåŠ¨è£…é…�所执行的æœ�务注册方法是一样的,也就是调用 register 方法进行æœ�务注册,并且在finally中,æ¯�30s会定时执行一下当å‰�çš„run 方法进行检查。 @@ -733,8 +733,8 @@ public void run() { **2.2.8 register** -×îÖÕ£¬ÎÒÃÇÖÕÓÚÕÒµ½·þÎñ×¢²áµÄÈë¿ÚÁË£¬ -eurekaTransport.registrationClient.register ×îÖÕµ÷ÓõÄÊÇ AbstractJerseyEurekaHttpClient#register(...)`£¬ µ±È»´ó¼ÒÈç¹û×Ô¼ºÈ¥¿´´úÂ룬¾Í»á·¢ÏÖÈ¥µ÷ÓÃ֮ǰÓкܶàÈÆÀ´ÈÆÈ¥µÄ´úÂ룬±ÈÈ繤³§Ä£Ê½¡¢×°ÊÎÆ÷ģʽµÈ¡£ +最终,我们终于找到æœ�务注册的入å�£äº†ï¼Œ +eurekaTransport.registrationClient.register 最终调用的是 AbstractJerseyEurekaHttpClient#register(...)`, 当然大家如果自己去看代ç �,就会å�‘现去调用之å‰�有很多绕æ�¥ç»•去的代ç �,比如工厂模å¼�ã€�装饰器模å¼�等。 @@ -763,9 +763,9 @@ boolean register() throws Throwable { -ºÜÏÔÈ»£¬ÕâÀïÊÇ·¢ÆðÁËÒ»´ÎhttpÇëÇ󣬷ÃÎÊEureka-ServerµÄapps/${APP_NAME}½Ó¿Ú£¬½«µ±Ç°·þÎñʵÀýµÄÐÅÏ¢·¢Ë͵½Eureka Server½øÐб£´æ¡£ +很显然,这里是å�‘起了一次http请求,访问Eureka-Serverçš„apps/${APP_NAME}接å�£ï¼Œå°†å½“å‰�æœ�务实例的信æ�¯å�‘é€�到Eureka Server进行ä¿�存。 -ÖÁ´Ë£¬ÎÒÃÇ»ù±¾ÉÏÒѾ­ÖªµÀSpring Cloud Eureka ÊÇÈçºÎÔÚÆô¶¯µÄʱºò°Ñ·þÎñÐÅÏ¢×¢²áµ½Eureka ServerÉϵÄÁË¡£ +至此,我们基本上已ç»�知é�“Spring Cloud Eureka 是如何在å�¯åŠ¨çš„æ—¶å€™æŠŠæœ�务信æ�¯æ³¨å†Œåˆ°Eureka Server上的了。 @@ -804,27 +804,27 @@ public EurekaHttpResponse register(InstanceInfo info) { -µ«ÊÇ£¬Ëƺõ×ʼµÄÎÊÌ⻹ûÓнâ¾ö£¬Ò²¾ÍÊÇSpring BootÓ¦ÓÃÔÚÆô¶¯Ê±£¬»áµ÷ÓÃstart·½·¨£¬×îÖÕµ÷Óà -StatusChangeListener.notify È¥¸üзþÎñµÄÒ»¸ö״̬£¬²¢Ã»ÓÐÖ±½Óµ÷ÓÃregister·½·¨×¢²á¡£ËùÒÔÎÒÃǼÌÐøÈ¥¿´Ò»Ï statusChangeListener.notify ·½·¨¡£ +但是,似乎最开始的问题还没有解决,也就是Spring Boot应用在å�¯åŠ¨æ—¶ï¼Œä¼šè°ƒç”¨start方法,最终调用 +StatusChangeListener.notify 去更新æœ�务的一个状æ€�,并没有直接调用register方法注册。所以我们继续去看一下 statusChangeListener.notify 方法。 -**2.2.9 ·þÎñ×ܽá** -ÖÁ´Ë£¬ÎÒÃÇÖªµÀEureka Client·¢Æð·þÎñ×¢²áʱ£¬ÓÐÁ½¸öµØ·½»áÖ´ÐзþÎñ×¢²áµÄÈÎÎñ +**2.2.9 æœ�务总结** +至此,我们知é�“Eureka Clientå�‘èµ·æœ�务注册时,有两个地方会执行æœ�务注册的任务 -1. ÔÚSpring BootÆô¶¯Ê±£¬ÓÉÓÚ×Ô¶¯×°Åä»úÖÆ½«CloudEurekaClient×¢Èëµ½ÁËÈÝÆ÷£¬²¢ÇÒÖ´ÐÐÁ˹¹Ôì·½·¨£¬¶øÔÚ¹¹Ôì·½·¨ÖÐÓÐÒ»¸ö¶¨Ê±ÈÎÎñÿ40s»áÖ´ÐÐÒ»´ÎÅжϣ¬ÅжÏʵÀýÐÅÏ¢ÊÇ·ñ·¢ÉúÁ˱仯£¬Èç¹ûÊÇÔò»á·¢Æð·þÎñ×¢²áµÄÁ÷³Ì -2. ÔÚSpring BootÆô¶¯Ê±£¬Í¨¹ýrefresh·½·¨£¬×îÖÕµ÷ÓÃStatusChangeListener.notify½øÐзþÎñ״̬±ä¸üµÄ¼àÌý£¬¶øÕâ¸ö¼àÌýµÄ·½·¨Êܵ½Ê¼þÖ®ºó»áÈ¥Ö´ÐзþÎñ×¢²á¡£ - **2.3 Server¶ËÂß¼­** - ÔÚû·ÖÎöÔ´ÂëʵÏÖ֮ǰ£¬ÎÒÃÇÒ»¶¨ÖªµÀËü¿Ï¶¨¶ÔÇëÇó¹ýÀ´µÄ·þÎñʵÀýÊý¾Ý½øÐÐÁË´æ´¢¡£ÄÇôÎÒÃÇÈ¥Eureka Server¶Ë¿´Ò»Ï´¦ÀíÁ÷³Ì¡£ +1. 在Spring Bootå�¯åŠ¨æ—¶ï¼Œç”±äºŽè‡ªåŠ¨è£…é…�机制将CloudEurekaClient注入到了容器,并且执行了构造方法,而在构造方法中有一个定时任务æ¯�40s会执行一次判断,判断实例信æ�¯æ˜¯å�¦å�‘生了å�˜åŒ–,如果是则会å�‘èµ·æœ�务注册的æµ�程 +2. 在Spring Bootå�¯åŠ¨æ—¶ï¼Œé€šè¿‡refresh方法,最终调用StatusChangeListener.notify进行æœ�务状æ€�å�˜æ›´çš„监å�¬ï¼Œè€Œè¿™ä¸ªç›‘å�¬çš„æ–¹æ³•å�—到事件之å�Žä¼šåŽ»æ‰§è¡Œæœ�务注册。 + **2.3 Server端逻辑** + 在没分æž�æº�ç �实现之å‰�,我们一定知é�“它肯定对请求过æ�¥çš„æœ�务实例数æ�®è¿›è¡Œäº†å­˜å‚¨ã€‚那么我们去Eureka Server端看一下处ç�†æµ�程。 -ÇëÇóÈë¿ÚÔÚ£º -com.netflix.eureka.resources.ApplicationResource.addInstance() ¡£ +请求入å�£åœ¨ï¼š +com.netflix.eureka.resources.ApplicationResource.addInstance() 。 -´ó¼Ò¿ÉÒÔ·¢ÏÖ£¬ÕâÀïËùÌṩµÄREST·þÎñ£¬²ÉÓõÄÊÇjerseyÀ´ÊµÏֵġ£JerseyÊÇ»ùÓÚJAX-RS±ê×¼£¬ÌṩRESTµÄʵÏÖµÄÖ§³Ö£¬ÕâÀï¾Í²»Õ¹¿ª·ÖÎöÁË¡£ +大家å�¯ä»¥å�‘现,这里所æ��供的RESTæœ�务,采用的是jerseyæ�¥å®žçŽ°çš„ã€‚Jersey是基于JAX-RS标准,æ��ä¾›REST的实现的支æŒ�,这里就ä¸�展开分æž�了。 **2.3.1 addInstance()** -µ±EurekaClientµ÷ÓÃregister·½·¨·¢Æð×¢²áʱ£¬»áµ÷Óà -ApplicationResource.addInstance·½·¨¡£ +当EurekaClient调用register方法å�‘起注册时,会调用 +ApplicationResource.addInstance方法。 -·þÎñ×¢²á¾ÍÊÇ·¢ËÍÒ»¸öPOSTÇëÇó´øÉϵ±Ç°ÊµÀýÐÅÏ¢µ½Àà ApplicationResource µÄ addInstance·½·¨½øÐзþÎñ×¢²á¡£ +æœ�务注册就是å�‘é€�一个POST请求带上当å‰�实例信æ�¯åˆ°ç±» ApplicationResource çš„ addInstance方法进行æœ�务注册。 @@ -871,20 +871,20 @@ public Response addInstance(InstanceInfo info, @HeaderParam("x-netflix-discovery **2.3.2 register** -ÎÒÃÇÏÈÀ´¿´ -PeerAwareInstanceRegistryImplµÄÀà¹ØÏµÍ¼£¬´ÓÀà¹ØÏµÍ¼¿ÉÒÔ¿´³ö£¬PeerAwareInstanceRegistryµÄ×î¶¥²ã½Ó¿ÚΪLeaseManagerÓëLookupService, +我们先æ�¥çœ‹ +PeerAwareInstanceRegistryImpl的类关系图,从类关系图å�¯ä»¥çœ‹å‡ºï¼ŒPeerAwareInstanceRegistry的最顶层接å�£ä¸ºLeaseManager与LookupService, -* ÆäÖÐLookupService¶¨ÒåÁË×î»ù±¾µÄ·¢ÏÖʾÀýµÄÐÐΪ -* LeaseManager¶¨ÒåÁË´¦Àí¿Í»§¶Ë×¢²á£¬ÐøÔ¼£¬×¢ÏúµÈ²Ù×÷ +* 其中LookupService定义了最基本的å�‘现示例的行为 +* LeaseManager定义了处ç�†å®¢æˆ·ç«¯æ³¨å†Œï¼Œç»­çº¦ï¼Œæ³¨é”€ç­‰æ“�作 -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/897d97d444664479bda0430417ec683f1f079a.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®Eureka-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÔÚ addInstance ·½·¨ÖУ¬×îÖÕµ÷ÓõÄÊÇ -PeerAwareInstanceRegistryImpl.register ·½·¨¡£ +![SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/897d97d444664479bda0430417ec683f1f079a.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之Eureka-å¼€æº�基础软件社区")在 addInstance 方法中,最终调用的是 +PeerAwareInstanceRegistryImpl.register 方法。 -* leaseDuration ±íʾ×âÔ¼¹ýÆÚʱ¼ä£¬Ä¬ÈÏÊÇ90s£¬Ò²¾ÍÊǵ±·þÎñ¶Ë³¬¹ý90sûÓÐÊÕµ½¿Í»§¶ËµÄÐÄÌø£¬ÔòÖ÷¶¯ÌÞ³ý¸Ã½Úµã +* leaseDuration 表示租约过期时间,默认是90s,也就是当æœ�务端超过90s没有收到客户端的心跳,则主动剔除该节点 -* µ÷ÓÃsuper.register·¢Æð½Úµã×¢²á +* 调用super.registerå�‘起节点注册 -* ½«ÐÅÏ¢¸´ÖƵ½Eureka Server¼¯ÈºÖÐµÄÆäËû»úÆ÷ÉÏ£¬Í¬²½µÄʵÏÖÒ²ºÜ¼òµ¥£¬¾ÍÊÇ»ñµÃ¼¯ÈºÖеÄËùÓнڵ㣬ȻºóÖð¸ö·¢Æð×¢²á +* 将信æ�¯å¤�制到Eureka Server集群中的其他机器上,å�Œæ­¥çš„实现也很简å�•,就是获得集群中的所有节点,然å�Žé€�个å�‘起注册 @@ -892,10 +892,10 @@ PeerAwareInstanceRegistryImpl.register public void register(final InstanceInfo info, final boolean isReplication) { int leaseDuration = Lease.DEFAULT_DURATION_IN_SECS; if (info.getLeaseInfo() != null && info.getLeaseInfo().getDurationInSecs() >0) { - leaseDuration = info.getLeaseInfo().getDurationInSecs(); //Èç¹û¿Í»§¶ËÓÐ×Ô¼º¶¨ÒåÐÄÌø³¬Ê±Ê±¼ä£¬Ôò²ÉÓÿͻ§¶ËµÄʱ¼ä + leaseDuration = info.getLeaseInfo().getDurationInSecs(); //如果客户端有自己定义心跳超时时间,则采用客户端的时间 } - super.register(info, leaseDuration, isReplication); //½Úµã×¢²á - //¸´ÖƵ½Eureka Server¼¯ÈºÖÐµÄÆäËû½Úµã + super.register(info, leaseDuration, isReplication); //节点注册 + //å¤�制到Eureka Server集群中的其他节点 replicateToPeers(Action.Register, info.getAppName(), info.getId(), info, null, isReplication); } @@ -910,7 +910,7 @@ PeerAwareInstanceRegistryImpl.register **2.3.3 AbstractInstanceRegistry.register** -¼òµ¥À´Ëµ£¬Eureka-ServerµÄ·þÎñ×¢²á£¬Êµ¼ÊÉÏÊǽ«¿Í»§¶Ë´«µÝ¹ýÀ´µÄʵÀýÊý¾Ý±£´æµ½Eureka-ServerÖеÄConcurrentHashMapÖС£ +简å�•æ�¥è¯´ï¼ŒEureka-Serverçš„æœ�务注册,实际上是将客户端传递过æ�¥çš„实例数æ�®ä¿�存到Eureka-Server中的ConcurrentHashMap中。 @@ -919,11 +919,11 @@ public void register(InstanceInfo registrant, int leaseDuration, boolean isReplication) { try { read.lock(); - //´ÓregistryÖлñµÃµ±Ç°ÊµÀýÐÅÏ¢£¬¸ù¾ÝappName + //从registry中获得当å‰�实例信æ�¯ï¼Œæ ¹æ�®appName Map> gMap = registry.get(registrant.getAppName()); - REGISTER.increment(isReplication); //Ôö¼Ó×¢²á´ÎÊýµ½¼à¿ØÐÅÏ¢ÖÐ - if (gMap == null) {//Èç¹ûµ±Ç°appNameÊǵÚÒ»´Î×¢²á£¬Ôò³õʼ»¯Ò»¸öConcurrentHashMap + REGISTER.increment(isReplication); //增加注册次数到监控信æ�¯ä¸­ + if (gMap == null) {//如果当å‰�appName是第一次注册,则åˆ�始化一个ConcurrentHashMap final ConcurrentHashMap> gNewMap = new ConcurrentHashMap>(); gMap = registry.putIfAbsent(registrant.getAppName(), gNewMap); @@ -931,9 +931,9 @@ public void register(InstanceInfo registrant, int leaseDuration, boolean gMap = gNewMap; } } - //´ÓgMapÖвéѯÒѾ­´æÔÚµÄLeaseÐÅÏ¢£¬LeaseÖÐÎÄ·­ÒëΪ×âÔ¼£¬Êµ¼ÊÉÏËü°Ñ·þÎñÌṩÕßµÄʵÀýÐÅÏ¢°ü×°³ÉÁËÒ»¸ölease£¬ÀïÃæÌṩÁ˶ÔÓڸķþÎñʵÀýµÄ×âÔ¼¹ÜÀí + //从gMap中查询已ç»�存在的Leaseä¿¡æ�¯ï¼ŒLease中文翻译为租约,实际上它把æœ�务æ��供者的实例信æ�¯åŒ…装æˆ�了一个lease,里é�¢æ��供了对于改æœ�务实例的租约管ç�† Lease existingLease = gMap.get(registrant.getId()); - // µ±instanceÒѾ­´æÔÚÊÇ£¬ºÍ¿Í»§¶ËµÄinstanceµÄÐÅÏ¢×ö±È½Ï£¬Ê±¼ä×îеÄÄǸö£¬ÎªÓÐЧinstanceÐÅÏ¢ + // 当instanceå·²ç»�存在是,和客户端的instance的信æ�¯å�šæ¯”è¾ƒï¼Œæ—¶é—´æœ€æ–°çš„é‚£ä¸ªï¼Œä¸ºæœ‰æ•ˆinstanceä¿¡æ�¯ if (existingLease != null && (existingLease.getHolder() != null)) { Long existingLastDirtyTimestamp = existingLease.getHolder().getLastDirtyTimestamp(); @@ -951,7 +951,7 @@ public void register(InstanceInfo registrant, int leaseDuration, boolean registrant = existingLease.getHolder(); } } else { - //µ±lease²»´æÔÚʱ£¬½øÈëµ½Õâ¶Î´úÂ룬 + //当leaseä¸�存在时,进入到这段代ç �, synchronized (lock) { if (this.expectedNumberOfClientsSendingRenews > 0) { // Since the client wants to register it, increase the number of clients sending renews @@ -962,20 +962,20 @@ public void register(InstanceInfo registrant, int leaseDuration, boolean } logger.debug("No previous lease information found; it is new registration"); } - //¹¹½¨Ò»¸ölease + //构建一个lease Lease lease = new Lease(registrant, leaseDuration); if (existingLease != null) { - // µ±Ô­À´´æÔÚLeaseµÄÐÅϢʱ£¬ÉèÖÃserviceUpTimestamp, ±£Ö¤·þÎñÆô¶¯µÄʱ¼äÒ»Ö±ÊǵÚÒ»´Î×¢²áµÄÄǸö + // 当原æ�¥å­˜åœ¨Lease的信æ�¯æ—¶ï¼Œè®¾ç½®serviceUpTimestamp, ä¿�è¯�æœ�务å�¯åŠ¨çš„æ—¶é—´ä¸€ç›´æ˜¯ç¬¬ä¸€æ¬¡æ³¨å†Œçš„é‚£ä¸ª lease.setServiceUpTimestamp(existingLease.getServiceUpTimestamp()); } gMap.put(registrant.getId(), lease); - synchronized (recentRegisteredQueue) {//Ìí¼Óµ½×î½ü×¢²áµÄ¶ÓÁÐÖÐ + synchronized (recentRegisteredQueue) {//添加到最近注册的队列中 recentRegisteredQueue.add(new Pair( System.currentTimeMillis(), registrant.getAppName() + "(" + registrant.getId() + ")")); } - // ¼ì²éʵÀý״̬ÊÇ·ñ·¢Éú±ä»¯£¬Èç¹ûÊDz¢ÇÒ´æÔÚ£¬Ôò¸²¸ÇÔ­À´µÄ״̬ + // 检查实例状æ€�是å�¦å�‘生å�˜åŒ–,如果是并且存在,则覆盖原æ�¥çš„状æ€� if (!InstanceStatus.UNKNOWN.equals(registrant.getOverriddenStatus())) { logger.debug("Found overridden status {} for instance {}. Checking to see if needs to be add to the " + "overrides", registrant.getOverriddenStatus(), @@ -998,16 +998,16 @@ public void register(InstanceInfo registrant, int leaseDuration, boolean InstanceStatus overriddenInstanceStatus = getOverriddenInstanceStatus(registrant, existingLease, isReplication); registrant.setStatusWithoutDirty(overriddenInstanceStatus); - // µÃµ½instanceStatus£¬ÅжÏÊÇ·ñÊÇUP״̬£¬ + // 得到instanceStatus,判断是å�¦æ˜¯UP状æ€�, if (InstanceStatus.UP.equals(registrant.getStatus())) { lease.serviceUp(); } - // ÉèÖÃ×¢²áÀàÐÍΪÌí¼Ó + // 设置注册类型为添加 registrant.setActionType(ActionType.ADDED); - // ×âÔ¼±ä¸ü¼Ç¼¶ÓÁУ¬¼Ç¼ÁËʵÀýµÄÿ´Î±ä»¯£¬ ÓÃÓÚ×¢²áÐÅÏ¢µÄÔöÁ¿»ñÈ¡ + // 租约å�˜æ›´è®°å½•队列,记录了实例的æ¯�次å�˜åŒ–, 用于注册信æ�¯çš„增é‡�获å�– recentlyChangedQueue.add(new RecentlyChangedItem(lease)); registrant.setLastUpdatedTimestamp(); - //Èûº´æÊ§Ð§ + //让缓存失效 invalidateCache(registrant.getAppName(), registrant.getVIPAddress(), registrant.getSecureVipAddress()); logger.info("Registered instance {}/{} with status {} (replication={})", @@ -1027,23 +1027,23 @@ public void register(InstanceInfo registrant, int leaseDuration, boolean -**2.3.4 С½á** -ÖÁ´Ë£¬ÎÒÃǾͰѷþÎñ×¢²áÔÚ¿Í»§¶ËºÍ·þÎñ¶ËµÄ´¦Àí¹ý³Ì×öÁËÒ»¸öÏêϸµÄ·ÖÎö£¬Êµ¼ÊÉÏÔÚEureka Server¶Ë£¬»á°Ñ¿Í»§¶ËµÄµØÖ·ÐÅÏ¢±£´æµ½ConcurrentHashMapÖд洢¡£²¢ÇÒ·þÎñÌṩÕߺÍ×¢²áÖÐÐÄÖ®¼ä£¬»á½¨Á¢Ò»¸öÐÄÌø¼ì²â»úÖÆ¡£ÓÃÓÚ¼à¿Ø·þÎñÌṩÕߵĽ¡¿µ×´Ì¬¡£ +**2.3.4 å°�结** +至此,我们就把æœ�务注册在客户端和æœ�务端的处ç�†è¿‡ç¨‹å�šäº†ä¸€ä¸ªè¯¦ç»†çš„分æž�,实际上在Eureka Server端,会把客户端的地å�€ä¿¡æ�¯ä¿�存到ConcurrentHashMap中存储。并且æœ�务æ��供者和注册中心之间,会建立一个心跳检测机制。用于监控æœ�务æ��供者的å�¥åº·çжæ€�。 -**2.4 Eureka µÄ¶à¼¶»º´æÉè¼Æ** -Eureka Server´æÔÚÈý¸ö±äÁ¿£º(registry¡¢readWriteCacheMap¡¢readOnlyCacheMap)±£´æ·þÎñ×¢²áÐÅÏ¢£¬Ä¬ÈÏÇé¿ö϶¨Ê±ÈÎÎñÿ30s½«readWriteCacheMapͬ²½ÖÁreadOnlyCacheMap£¬Ã¿60sÇåÀí³¬¹ý90sÎ´ÐøÔ¼µÄ½Úµã£¬Eureka Clientÿ30s´ÓreadOnlyCacheMap¸üзþÎñ×¢²áÐÅÏ¢£¬¶ø¿Í»§¶Ë·þÎñµÄ×¢²áÔò´Óregistry¸üзþÎñ×¢²áÐÅÏ¢¡£ +**2.4 Eureka 的多级缓存设计** +Eureka Server存在三个å�˜é‡�:(registryã€�readWriteCacheMapã€�readOnlyCacheMap)ä¿�å­˜æœ�务注册信æ�¯ï¼Œé»˜è®¤æƒ…况下定时任务æ¯�30så°†readWriteCacheMapå�Œæ­¥è‡³readOnlyCacheMap,æ¯�60s清ç�†è¶…过90s未续约的节点,Eureka Clientæ¯�30s从readOnlyCacheMapæ›´æ–°æœ�务注册信æ�¯ï¼Œè€Œå®¢æˆ·ç«¯æœ�务的注册则从registryæ›´æ–°æœ�务注册信æ�¯ã€‚ -**2.4.1 ¶à¼¶»º´æµÄÒâÒå** -ÕâÀïΪʲôҪÉè¼Æ¶à¼¶»º´æÄØ£¿Ô­ÒòºÜ¼òµ¥£¬¾ÍÊǵ±´æÔÚ´ó¹æÄ£µÄ·þÎñ×¢²áºÍ¸üÐÂʱ£¬Èç¹ûÖ»ÊÇÐÞ¸ÄÒ»¸öConcurrentHashMapÊý¾Ý£¬ÄÇÃ´ÊÆ±ØÒòÎªËøµÄ´æÔÚµ¼Ö¾ºÕù£¬Ó°ÏìÐÔÄÜ¡£ +**2.4.1 多级缓存的æ„�义** +这里为什么è¦�设计多级缓存呢?原因很简å�•,就是当存在大规模的æœ�务注册和更新时,如果å�ªæ˜¯ä¿®æ”¹ä¸€ä¸ªConcurrentHashMapæ•°æ�®ï¼Œé‚£ä¹ˆåŠ¿å¿…å› ä¸ºé”�的存在导致竞争,影å“�性能。 -¶øEurekaÓÖÊÇAPÄ£ÐÍ£¬Ö»ÐèÒªÂú×ã×îÖÕ¿ÉÓþÍÐС£ËùÒÔËüÔÚÕâÀïÓõ½¶à¼¶»º´æÀ´ÊµÏÖ¶Áд·ÖÀë¡£×¢²á·½·¨Ð´µÄʱºòÖ±½ÓдÄÚ´æ×¢²á±í£¬Ð´Íê±íÖ®ºóÖ÷¶¯Ê§Ð§¶Áд»º´æ¡£ +而Eurekaå�ˆæ˜¯AP模型,å�ªéœ€è¦�满足最终å�¯ç”¨å°±è¡Œã€‚所以它在这里用到多级缓存æ�¥å®žçŽ°è¯»å†™åˆ†ç¦»ã€‚æ³¨å†Œæ–¹æ³•å†™çš„æ—¶å€™ç›´æŽ¥å†™å†…å­˜æ³¨å†Œè¡¨ï¼Œå†™å®Œè¡¨ä¹‹å�Žä¸»åŠ¨å¤±æ•ˆè¯»å†™ç¼“å­˜ã€‚ -»ñȡע²áÐÅÏ¢½Ó¿ÚÏÈ´ÓÖ»¶Á»º´æÈ¡£¬Ö»¶Á»º´æÃ»ÓÐÔÙÈ¥¶Áд»º´æÈ¡£¬¶Áд»º´æÃ»ÓÐÔÙÈ¥ÄÚ´æ×¢²á±íÀïÈ¡£¨²»Ö»ÊÇÈ¡£¬´Ë´¦½Ï¸´ÔÓ£©¡£²¢ÇÒ£¬¶Áд»º´æ»á¸üлØÐ´Ö»¶Á»º´æ +获å�–注册信æ�¯æŽ¥å�£å…ˆä»Žå�ªè¯»ç¼“å­˜å�–,å�ªè¯»ç¼“存没有å†�去读写缓存å�–,读写缓存没有å†�去内存注册表里å�–(ä¸�å�ªæ˜¯å�–,此处较å¤�æ�‚)。并且,读写缓存会更新回写å�ªè¯»ç¼“å­˜ -* responseCacheUpdateIntervalMs £º readOnlyCacheMap »º´æ¸üÐµĶ¨Ê±Æ÷ʱ¼ä¼ä¸ô£¬Ä¬ÈÏΪ30Ãë -* responseCacheAutoExpirationInSeconds : readWriteCacheMap »º´æ¹ýÆÚʱ¼ä£¬Ä¬ÈÏΪ 180 Ãë¡£ - **2.4.2 ·þÎñ×¢²áµÄ»º´æÊ§Ð§** - ÔÚAbstractInstanceRegistry.register·½·¨µÄ×îºó£¬»áµ÷ÓÃinvalidateCache(registrant.getAppName(), registrant.getVIPAddress(),registrant.getSecureVipAddress()); ·½·¨£¬Ê¹µÃ¶Áд»º´æÊ§Ð§¡£ +* responseCacheUpdateIntervalMs : readOnlyCacheMap 缓存更新的定时器时间间隔,默认为30ç§’ +* responseCacheAutoExpirationInSeconds : readWriteCacheMap 缓存过期时间,默认为 180 秒。 + **2.4.2 æœ�务注册的缓存失效** + 在AbstractInstanceRegistry.register方法的最å�Žï¼Œä¼šè°ƒç”¨invalidateCache(registrant.getAppName(), registrant.getVIPAddress(),registrant.getSecureVipAddress()); 方法,使得读写缓存失效。 @@ -1075,8 +1075,8 @@ public void invalidate(Key... keys) { -**2.4.3 ¶¨Ê±Í¬²½»º´æ** -ResponseCacheImplµÄ¹¹Ôì·½·¨ÖУ¬»áÆô¶¯Ò»¸ö¶¨Ê±ÈÎÎñ£¬Õâ¸öÈÎÎñ»á¶¨Ê±¼ì²éд»º´æÖеÄÊý¾Ý±ä»¯£¬½øÐиüкÍͬ²½¡£ +**2.4.3 定时å�Œæ­¥ç¼“å­˜** +ResponseCacheImpl的构造方法中,会å�¯åŠ¨ä¸€ä¸ªå®šæ—¶ä»»åŠ¡ï¼Œè¿™ä¸ªä»»åŠ¡ä¼šå®šæ—¶æ£€æŸ¥å†™ç¼“å­˜ä¸­çš„æ•°æ�®å�˜åŒ–,进行更新和å�Œæ­¥ã€‚ @@ -1118,12 +1118,12 @@ private TimerTask getCacheUpdateTask() { -**2.5 ·þÎñÐøÔ¼** -ËùνµÄ·þÎñÐøÔ¼£¬Æäʵ¾ÍÊÇÒ»ÖÖÐÄÌø¼ì²é»úÖÆ¡£¿Í»§¶Ë»á¶¨ÆÚ·¢ËÍÐÄÌøÀ´ÐøÔ¼¡£ÄÇô¼òµ¥¸ø´ó¼Ò¿´Ò»Ï´úÂëµÄʵÏÖ +**2.5 æœ�务续约** +所谓的æœ�务续约,其实就是一ç§�心跳检查机制。客户端会定期å�‘é€�心跳æ�¥ç»­çº¦ã€‚那么简å�•给大家看一下代ç �的实现 **2.5.1 initScheduledTasks** -¿Í»§¶Ë»áÔÚ -DiscoveryClient.initScheduledTasks ÖУ¬´´½¨Ò»¸öÐÄÌø¼ì²âµÄ¶¨Ê±ÈÎÎñ +客户端会在 +DiscoveryClient.initScheduledTasks 中,创建一个心跳检测的定时任务 @@ -1151,12 +1151,12 @@ scheduler.schedule( **2.5.2 HeartbeatThread** -È»ºóÕâ¸ö¶¨Ê±ÈÎÎñÖУ¬»áÖ´ÐÐÒ»¸ö HearbeatThread µÄỊ̈߳¬Õâ¸öÏ̻߳ᶨʱµ÷ÓÃrenew()À´×öÐøÔ¼¡£ +ç„¶å�Žè¿™ä¸ªå®šæ—¶ä»»åŠ¡ä¸­ï¼Œä¼šæ‰§è¡Œä¸€ä¸ª HearbeatThread 的线程,这个线程会定时调用renew()æ�¥å�šç»­çº¦ã€‚ ``` -//ÿ¸ô30s·¢ËÍÒ»¸öÐÄÌøÇëÇóµ½ +//æ¯�éš”30så�‘é€�一个心跳请求到 private class HeartbeatThread implements Runnable { public void run() { if (renew()) { @@ -1174,8 +1174,8 @@ private class HeartbeatThread implements Runnable { -**2.5.3 ·þÎñ¶ËÊÕµ½ÐÄÌøÇëÇóµÄ´¦Àí** -ÔÚApplicationResource.getInstanceInfoÕâ¸ö½Ó¿ÚÖУ¬»á·µ»ØÒ»¸öInstanceResourceµÄʵÀý£¬ÔÚ¸ÃʵÀýÏ£¬¶¨ÒåÁËÒ»¸östatusUpdateµÄ½Ó¿ÚÀ´¸üÐÂ״̬ +**2.5.3 æœ�务端收到心跳请求的处ç�†** +在ApplicationResource.getInstanceInfo这个接å�£ä¸­ï¼Œä¼šè¿”回一个InstanceResource的实例,在该实例下,定义了一个statusUpdate的接å�£æ�¥æ›´æ–°çжæ€� @@ -1195,8 +1195,8 @@ public InstanceResource getInstanceInfo(@PathParam("id") String id) { **2.5.4 InstanceResource.statusUpdate()** -Ôڸ÷½·¨ÖУ¬ÎÒÃÇÖØµã¹Ø×¢ registry.statusUpdate Õâ¸ö·½·¨£¬Ëü»áµ÷Óà -AbstractInstanceRegistry.statusUpdateÀ´¸üÐÂÖ¸¶¨·þÎñÌṩÕßÔÚ·þÎñ¶Ë´æ´¢µÄÐÅÏ¢Öеı仯¡£ +在该方法中,我们é‡�点关注 registry.statusUpdate 这个方法,它会调用 +AbstractInstanceRegistry.statusUpdateæ�¥æ›´æ–°æŒ‡å®šæœ�务æ��供者在æœ�务端存储的信æ�¯ä¸­çš„å�˜åŒ–。 @@ -1241,7 +1241,7 @@ public Response statusUpdate( **2.5.5 AbstractInstanceRegistry.statusUpdate** -ÔÚÕâ¸ö·½·¨ÖУ¬»áÄõ½Ó¦ÓöÔÓ¦µÄʵÀýÁÐ±í£¬È»ºóµ÷ÓÃLease.renew()È¥½øÐÐÐÄÌøÐøÔ¼¡£ +在这个方法中,会拿到应用对应的实例列表,然å�Žè°ƒç”¨Lease.renew()去进行心跳续约。 @@ -1252,21 +1252,21 @@ public boolean statusUpdate(String appName, String id, boolean isReplication) { try { read.lock(); - // ¸üÐÂ״̬µÄ´ÎÊý ״̬ͳ¼Æ + // 更新状æ€�的次数 状æ€�统计 STATUS_UPDATE.increment(isReplication); - // ´Ó±¾µØÊý¾ÝÀïÃæ»ñȡʵÀýÐÅÏ¢£¬ + // 从本地数æ�®é‡Œé�¢èŽ·å�–实例信æ�¯ï¼Œ Map> gMap = registry.get(appName); Lease lease = null; if (gMap != null) { lease = gMap.get(id); } - // ʵÀý²»´æÔÚ£¬ÔòÖ±½Ó·µ»Ø£¬±íʾʧ°Ü + // 实例ä¸�存在,则直接返回,表示失败 if (lease == null) { return false; } else { - // Ö´ÐÐÒ»ÏÂleaseµÄrenew·½·¨£¬ÀïÃæÖ÷ÒªÊǸüÐÂÁËÕâ¸öinstanceµÄ×îºó¸üÐÂʱ¼ä¡£ + // 执行一下leaseçš„renew方法,里é�¢ä¸»è¦�是更新了这个instance的最å�Žæ›´æ–°æ—¶é—´ã€‚ lease.renew(); - // »ñÈ¡instanceʵÀýÐÅÏ¢ + // 获å�–instance实例信æ�¯ InstanceInfo info = lease.getHolder(); // Lease is always created with its instance info object. // This log statement is provided as a safeguard, in case this invariant is violated. @@ -1274,17 +1274,17 @@ public boolean statusUpdate(String appName, String id, logger.error("Found Lease without a holder for instance id {}", id); } - // µ±instanceÐÅÏ¢²»Îª¿Õʱ£¬²¢ÇÒʵÀý״̬·¢ÉúÁ˱仯 + // 当instanceä¿¡æ�¯ä¸�为空时,并且实例状æ€�å�‘生了å�˜åŒ– if ((info != null) && !(info.getStatus().equals(newStatus))) { - // Èç¹ûÐÂ״̬ÊÇUPµÄ״̬£¬ÄÇôÆô¶¯Ò»ÏÂserviceUp() , Ö÷ÒªÊǸüзþÎñµÄ×¢²áʱ - ¼ä + // 如果新状æ€�是UP的状æ€�,那么å�¯åЍ䏀䏋serviceUp() , 主è¦�是更新æœ�务的注册时 + é—´ if (InstanceStatus.UP.equals(newStatus)) { lease.serviceUp(); } - // ½«instance Id ºÍÕâ¸ö״̬µÄÓ³ÉäÐÅÏ¢·ÅÈ븲¸Ç»º´æMAPÀïÃæÈ¥ + // å°†instance Id 和这个状æ€�的映射信æ�¯æ”¾å…¥è¦†ç›–缓存MAP里é�¢åŽ» overriddenInstanceStatusMap.put(id, newStatus); // Set it for transfer of overridden status to replica on - // ÉèÖø²¸Ç״̬µ½ÊµÀýÐÅÏ¢ÀïÃæÈ¥ + // 设置覆盖状æ€�到实例信æ�¯é‡Œé�¢åŽ» info.setOverriddenStatus(newStatus); long replicaDirtyTimestamp = 0; info.setStatusWithoutDirty(newStatus); @@ -1293,7 +1293,7 @@ public boolean statusUpdate(String appName, String id, } // If the replication's dirty timestamp is more than the existing one, just update // it to the replica's. - // Èç¹ûreplicaDirtyTimestamp µÄʱ¼ä´óÓÚinstanceµÄgetLastDirtyTimestamp() ,Ôò¸üР+ // 如果replicaDirtyTimestamp 的时间大于instanceçš„getLastDirtyTimestamp() ,则更新 if (replicaDirtyTimestamp > info.getLastDirtyTimestamp()) { info.setLastDirtyTimestamp(replicaDirtyTimestamp); @@ -1301,7 +1301,7 @@ public boolean statusUpdate(String appName, String id, info.setActionType(ActionType.MODIFIED); recentlyChangedQueue.add(new RecentlyChangedItem(lease)); info.setLastUpdatedTimestamp(); - //¸üÐÂд»º´æ + //更新写缓存 invalidateCache(appName, info.getVIPAddress(), info.getSecureVipAddress()); } @@ -1321,15 +1321,15 @@ public boolean statusUpdate(String appName, String id, -ÖÁ´Ë£¬ÐÄÌøÐøÔ¼¹¦ÄܾͷÖÎöÍê³ÉÁË¡£ +至此,心跳续约功能就分æž�完æˆ�了。 -**2.6 ·þÎñ·¢ÏÖ** -ÎÒÃǼÌÐøÀ´Ñо¿·þÎñµÄ·¢ÏÖ¹ý³Ì£¬¾ÍÊǿͻ§¶ËÐèÒªÄܹ»Âú×ãÁ½¸ö¹¦ÄÜ +**2.6 æœ�务å�‘现** +我们继续æ�¥ç ”ç©¶æœ�务的å�‘现过程,就是客户端需è¦�能够满足两个功能 -ÔÚÆô¶¯µÄʱºò»ñȡָ¶¨·þÎñÌṩÕߵĵØÖ·Áбí -Eureka server¶ËµØÖ··¢Éú±ä»¯Ê±£¬ÐèÒª¶¯Ì¬¸ÐÖª -**2.6.1 DiscoveryClient¹¹Ôìʱ²éѯ** -¹¹Ôì·½·¨ÖУ¬Èç¹ûµ±Ç°µÄ¿Í»§¶ËĬÈÏ¿ªÆôÁËfetchRegistry£¬Ôò»á´Óeureka-serverÖÐÀ­È¡Êý¾Ý¡£ +在å�¯åŠ¨çš„æ—¶å€™èŽ·å�–指定æœ�务æ��供者的地å�€åˆ—表 +Eureka server端地å�€å�‘生å�˜åŒ–时,需è¦�动æ€�感知 +**2.6.1 DiscoveryClient构造时查询** +构造方法中,如果当å‰�的客户端默认开å�¯äº†fetchRegistry,则会从eureka-server中拉å�–æ•°æ�®ã€‚ @@ -1413,11 +1413,11 @@ private boolean fetchRegistry(boolean forceFullRegistryFetch) { -**2.6.3 ¶¨Ê±Ë¢Ð±¾µØµØÖ·Áбí** -ÈÎÎñÿ¸ô30s¸üÐÂÒ»´Î -ÔÚDiscoveryClient¹¹ÔìµÄʱºò£¬»á³õʼ»¯Ò»Ð©ÈÎÎñ£¬Õâ¸öÔÚÇ°ÃæÔÛÃÇ·ÖÎö¹ýÁË¡£ÆäÖÐÓÐÒ»¸öÈÎÎñ¶¯Ì¬¸üб¾µØ·þÎñµØÖ·ÁÐ±í£¬½Ð cacheRefreshTask ¡£ +**2.6.3 定时刷新本地地å�€åˆ—表** +任务æ¯�éš”30s更新一次 +在DiscoveryClient构造的时候,会åˆ�始化一些任务,这个在å‰�é�¢å’±ä»¬åˆ†æž�过了。其中有一个任务动æ€�更新本地æœ�务地å�€åˆ—表,å�« cacheRefreshTask 。 -Õâ¸öÈÎÎñ×îÖÕÖ´ÐеÄÊÇCacheRefreshThreadÕâ¸öÏ̡߳£ËüÊÇÒ»¸öÖÜÆÚÐÔÖ´ÐеÄÈÎÎñ£¬¾ßÌåÎÒÃÇÀ´¿´Ò»Ï¡£ +这个任务最终执行的是CacheRefreshThread这个线程。它是一个周期性执行的任务,具体我们æ�¥çœ‹ä¸€ä¸‹ã€‚ @@ -1453,7 +1453,7 @@ private void initScheduledTasks() { **2.6.4 TimedSupervisorTask** -´ÓÕûÌåÉÏ¿´£¬TimedSupervisorTaskÊǹ̶¨¼ä¸ôµÄÖÜÆÚÐÔÈÎÎñ£¬Ò»µ©Óöµ½³¬Ê±¾Í»á½«ÏÂÒ»¸öÖÜÆÚµÄ¼ä¸ôʱ¼äµ÷´ó£¬Èç¹ûÁ¬Ðø³¬Ê±£¬ÄÇôÿ´Î¼ä¸ôʱ¼ä¶¼»áÔö´óÒ»±¶£¬Ò»Ö±µ½´ïÍⲿ²ÎÊýÉ趨µÄÉÏÏÞΪֹ£¬Ò»µ©ÐÂÈÎÎñ²»ÔÙ³¬Ê±£¬¼ä¸ôʱ¼äÓÖ»á×Ô¶¯»Ö¸´Îª³õʼֵ¡£ÕâÖÖÉè¼Æ»¹ÊÇÖµµÃѧϰµÄ¡£ +从整体上看,TimedSupervisorTask是固定间隔的周期性任务,一旦é�‡åˆ°è¶…时就会将下一个周期的间隔时间调大,如果连续超时,那么æ¯�次间隔时间都会增大一å€�,一直到达外部å�‚数设定的上é™�为止,一旦新任务ä¸�å†�超时,间隔时间å�ˆä¼šè‡ªåЍæ�¢å¤�为åˆ�始值。这ç§�设计还是值得学习的。 @@ -1461,24 +1461,24 @@ private void initScheduledTasks() { public void run() { Future future = null; try { - //ʹÓÃFuture£¬¿ÉÒÔÉ趨×ÓÏ̵߳ij¬Ê±Ê±¼ä£¬ÕâÑùµ±Ç°Ï߳̾Ͳ»ÓÃÎÞÏ޵ȴýÁË + //使用Future,å�¯ä»¥è®¾å®šå­�线程的超时时间,这样当å‰�线程就ä¸�用无é™�等待了 future = executor.submit(task); threadPoolLevelGauge.set((long) executor.getActiveCount()); - //Ö¸¶¨µÈ´ý×ÓÏ̵߳Ä×ʱ¼ä + //指定等待å­�线程的最长时间 future.get(timeoutMillis, TimeUnit.MILLISECONDS); // block until done or timeout - //delayÊǸöºÜÓÐÓõıäÁ¿£¬ºóÃæ»áÓõ½£¬ÕâÀï¼ÇµÃÿ´ÎÖ´ÐÐÈÎÎñ³É¹¦¶¼»á½«delayÖØÖà + //delay是个很有用的å�˜é‡�,å�Žé�¢ä¼šç”¨åˆ°ï¼Œè¿™é‡Œè®°å¾—æ¯�次执行任务æˆ�功都会将delayé‡�ç½® delay.set(timeoutMillis); threadPoolLevelGauge.set((long) executor.getActiveCount()); } catch (TimeoutException e) { logger.error("task supervisor timed out", e); timeoutCounter.increment(); long currentDelay = delay.get(); - //ÈÎÎñÏ̳߳¬Ê±µÄʱºò£¬¾Í°Ñdelay±äÁ¿·­±¶£¬µ«²»»á³¬¹ýÍⲿµ÷ÓÃʱÉ趨µÄ×î´óÑÓʱʱ¼ä + //任务线程超时的时候,就把delayå�˜é‡�ç¿»å€�,但ä¸�会超过外部调用时设定的最大延时时间 long newDelay = Math.min(maxDelay, currentDelay * 2); - //ÉèÖÃΪ×îеÄÖµ£¬¿¼Âǵ½¶àỊ̈߳¬ËùÒÔÓÃÁËCAS + //设置为最新的值,考虑到多线程,所以用了CAS delay.compareAndSet(currentDelay, newDelay); } catch (RejectedExecutionException e) { - //Ò»µ©Ï̳߳صÄ×èÈû¶ÓÁÐÖзÅÂúÁË´ý´¦ÀíÈÎÎñ£¬´¥·¢Á˾ܾø²ßÂÔ£¬¾Í»á½«µ÷¶ÈÆ÷Í£µô + //一旦线程池的阻塞队列中放满了待处ç�†ä»»åŠ¡ï¼Œè§¦å�‘了拒ç»�策略,就会将调度器å�œæŽ‰ if (executor.isShutdown() || scheduler.isShutdown()) { logger.warn("task supervisor shutting down, reject the task", e); } else { @@ -1486,7 +1486,7 @@ public void run() { } rejectedCounter.increment(); } catch (Throwable e) { - //Ò»µ©³öÏÖδ֪µÄÒì³££¬¾ÍÍ£µôµ÷¶ÈÆ÷ + //一旦出现未知的异常,就å�œæŽ‰è°ƒåº¦å™¨ if (executor.isShutdown() || scheduler.isShutdown()) { logger.warn("task supervisor shutting down, can't accept the task"); } else { @@ -1494,16 +1494,16 @@ public void run() { } throwableCounter.increment(); } finally { - //ÕâÀïÈÎÎñҪôִÐÐÍê±Ï£¬ÒªÃ´·¢ÉúÒì³££¬¶¼ÓÃcancel·½·¨À´ÇåÀíÈÎÎñ£» + //这里任务è¦�么执行完毕,è¦�么å�‘生异常,都用cancel方法æ�¥æ¸…ç�†ä»»åŠ¡ï¼› if (future != null) { future.cancel(true); } - //Ö»Òªµ÷¶ÈÆ÷ûÓÐÍ£Ö¹£¬¾ÍÔÙÖ¸¶¨µÈ´ýʱ¼äÖ®ºóÔÚÖ´ÐÐÒ»´ÎͬÑùµÄÈÎÎñ + //å�ªè¦�调度器没有å�œæ­¢ï¼Œå°±å†�指定等待时间之å�Žåœ¨æ‰§è¡Œä¸€æ¬¡å�Œæ ·çš„任务 if (!scheduler.isShutdown()) { - //ÕâÀï¾ÍÊÇÖÜÆÚÐÔÈÎÎñµÄÔ­Òò£ºÖ»ÒªÃ»ÓÐÍ£Ö¹µ÷¶ÈÆ÷£¬¾ÍÔÙ´´½¨Ò»´ÎÐÔÈÎÎñ£¬Ö´ÐÐʱ¼äʱdealyµÄÖµ£¬ - //¼ÙÉèÍⲿµ÷ÓÃʱ´«ÈëµÄ³¬Ê±Ê±¼äΪ30Ã루¹¹Ôì·½·¨µÄÈë²Îtimeout£©£¬×î´ó¼ä¸ôʱ¼äΪ50Ãë(¹¹Ôì·½·¨µÄÈë²ÎexpBackOffBound) - //Èç¹û×î½üÒ»´ÎÈÎÎñûÓг¬Ê±£¬ÄÇô¾ÍÔÚ30Ãëºó¿ªÊ¼ÐÂÈÎÎñ£¬ - //Èç¹û×î½üÒ»´ÎÈÎÎñ³¬Ê±ÁË£¬ÄÇô¾ÍÔÚ50Ãëºó¿ªÊ¼ÐÂÈÎÎñ£¨Òì³£´¦ÀíÖÐÓиö³ËÒÔ¶þµÄ²Ù×÷£¬³ËÒÔ¶þºóµÄ60Ã볬¹ýÁË×î´ó¼ä¸ô50Ã룩 + //这里就是周期性任务的原因:å�ªè¦�没有å�œæ­¢è°ƒåº¦å™¨ï¼Œå°±å†�创建一次性任务,执行时间时dealy的值, + //å�‡è®¾å¤–部调用时传入的超时时间为30秒(构造方法的入å�‚timeout),最大间隔时间为50ç§’(构造方法的入å�‚expBackOffBound) + //如果最近一次任务没有超时,那么就在30ç§’å�Žå¼€å§‹æ–°ä»»åŠ¡ï¼Œ + //如果最近一次任务超时了,那么就在50ç§’å�Žå¼€å§‹æ–°ä»»åŠ¡ï¼ˆå¼‚å¸¸å¤„ç�†ä¸­æœ‰ä¸ªä¹˜ä»¥äºŒçš„æ“�作,乘以二å�Žçš„60秒超过了最大间隔50秒) scheduler.schedule(this, delay.get(), TimeUnit.MILLISECONDS); } } @@ -1519,11 +1519,11 @@ public void run() { **2.6.5 refreshRegistry** -Õâ¶Î´úÂëÖ÷ÒªÁ½¸öÂß¼­ +这段代ç �主è¦�两个逻辑 -* ÅжÏremoteRegionsÊÇ·ñ·¢ÉúÁ˱仯 +* 判断remoteRegions是å�¦å�‘生了å�˜åŒ– -* µ÷ÓÃfetchRegistry»ñÈ¡±¾µØ·þÎñµØÖ·»º´æ +* 调用fetchRegistry获å�–本地æœ�务地å�€ç¼“å­˜ @@ -1534,13 +1534,13 @@ public void run() { boolean isFetchingRemoteRegionRegistries = isFetchingRemoteRegionRegistries(); boolean remoteRegionsModified = false; - //Èç¹û²¿ÊðÔÚaws»·¾³ÉÏ£¬»áÅжÏ×îºóÒ»´ÎÔ¶³ÌÇøÓò¸üеÄÐÅÏ¢ºÍµ±Ç°Ô¶³ÌÇøÓòÐÅÏ¢½øÐбȽϣ¬Èç¹û²»ÏëµÈ£¬Ôò¸üР+ //如果部署在aws环境上,会判断最å�Žä¸€æ¬¡è¿œç¨‹åŒºåŸŸæ›´æ–°çš„ä¿¡æ�¯å’Œå½“å‰�远程区域信æ�¯è¿›è¡Œæ¯”较,如果ä¸�想等,则更新 String latestRemoteRegions = clientConfig.fetchRegistryForRemoteRegions(); if (null != latestRemoteRegions) { String currentRemoteRegions = remoteRegionsToFetch.get(); if (!latestRemoteRegions.equals(currentRemoteRegions)) { - //ÅжÏ×îºóÒ»´Î + //判断最å�Žä¸€æ¬¡ } boolean success = fetchRegistry(remoteRegionsModified); if (success) { @@ -1548,7 +1548,7 @@ public void run() { lastSuccessfulRegistryFetchTimestamp = System.currentTimeMillis(); } - // Ê¡ÂÔ + // çœ�ç•¥ } catch (Throwable e) { logger.error("Cannot fetch registry from server", e); } @@ -1573,13 +1573,13 @@ public void run() { try { // If the delta is disabled or if it is the first time, get all // applications - // È¡³ö±¾µØ»º´æµÄ·þÎñÁбíÐÅÏ¢ + // å�–出本地缓存的æœ�务列表信æ�¯ Applications applications = getApplications(); - //Åж϶à¸öÌõ¼þ£¬È·¶¨ÊÇ·ñ´¥·¢È«Á¿¸üУ¬ÈçÏÂÈÎÒ»¸öÂú×ã¶¼»áÈ«Á¿¸üУº - //1\. ÊÇ·ñ½ûÓÃÔöÁ¿¸üУ» - //2\. ÊÇ·ñ¶Ôij¸öregionÌØ±ð¹Ø×¢£» - //3\. Íⲿµ÷ÓÃʱÊÇ·ñͨ¹ýÈë²ÎÖ¸¶¨È«Á¿¸üУ» - //4\. ±¾µØ»¹Î´»º´æÓÐЧµÄ·þÎñÁбíÐÅÏ¢£» + //判断多个æ�¡ä»¶ï¼Œç¡®å®šæ˜¯å�¦è§¦å�‘å…¨é‡�更新,如下任一个满足都会全é‡�更新: + //1\. 是å�¦ç¦�用增é‡�æ›´æ–°ï¼› + //2\. 是å�¦å¯¹æŸ�个region特别关注; + //3\. 外部调用时是å�¦é€šè¿‡å…¥å�‚指定全é‡�æ›´æ–°ï¼› + //4\. 本地还未缓存有效的æœ�务列表信æ�¯ï¼› if (clientConfig.shouldDisableDelta() || (!Strings.isNullOrEmpty(clientConfig.getRegistryRefreshSingleVipAddress())) @@ -1589,15 +1589,15 @@ public void run() { || (applications.getVersion() == -1)) //Client application does not have latest library supporting delta { - //µ÷ÓÃÈ«Á¿¸üР+ //调用全é‡�æ›´æ–° getAndStoreFullRegistry(); } else { - //µ÷ÓÃÔöÁ¿¸üР+ //调用增é‡�æ›´æ–° getAndUpdateDelta(applications); } - //ÖØÐ¼ÆËãºÍÉèÖÃÒ»ÖÂÐÔhashÂë + //é‡�新计算和设置一致性hashç � applications.setAppsHashCode(applications.getReconcileHashCode()); - logTotalInstances(); //ÈÕÖ¾´òÓ¡ËùÓÐÓ¦ÓõÄËùÓÐʵÀýÊýÖ®ºÍ + logTotalInstances(); //日志打å�°æ‰€æœ‰åº”用的所有实例数之和 } catch (Throwable e) { logger.error(PREFIX + "{} - was unable to refresh its cache! status = {}", appPathIdentifier, e.getMessage(), e); return false; @@ -1606,12 +1606,12 @@ public void run() { tracer.stop(); } } - //½«±¾µØ»º´æ¸üеÄʼþ¹ã²¥¸øËùÓÐÒÑ×¢²áµÄ¼àÌýÆ÷£¬×¢Òâ¸Ã·½·¨Òѱ»CloudEurekaClientÀàÖØÐ´ + //将本地缓存更新的事件广播给所有已注册的监å�¬å™¨ï¼Œæ³¨æ„�该方法已被CloudEurekaClientç±»é‡�写 onCacheRefreshed(); // Update remote status based on refreshed data held in the cache - //¼ì²é¸Õ¸Õ¸üÐµĻº´æÖУ¬ÓÐÀ´×ÔEureka serverµÄ·þÎñÁÐ±í£¬ÆäÖаüº¬Á˵±Ç°Ó¦ÓõÄ״̬£¬ - //µ±Ç°ÊµÀýµÄ³ÉÔ±±äÁ¿lastRemoteInstanceStatus£¬¼Ç¼µÄÊÇ×îºóÒ»´Î¸üеĵ±Ç°Ó¦ÓÃ״̬£¬ - //ÉÏÊöÁ½ÖÖ״̬ÔÚupdateInstanceRemoteStatus·½·¨ÖÐ×÷±È½Ï £¬Èç¹û²»Ò»Ö£¬¾Í¸üÐÂlastRemoteInstanceStatus£¬²¢Çҹ㲥¶ÔÓ¦µÄʼþ + //检查刚刚更新的缓存中,有æ�¥è‡ªEureka serverçš„æœ�务列表,其中包å�«äº†å½“å‰�应用的状æ€�, + //当å‰�实例的æˆ�员å�˜é‡�lastRemoteInstanceStatus,记录的是最å�Žä¸€æ¬¡æ›´æ–°çš„当å‰�应用状æ€�, + //上述两ç§�状æ€�在updateInstanceRemoteStatus方法中作比较 ,如果ä¸�一致,就更新lastRemoteInstanceStatus,并且广播对应的事件 updateInstanceRemoteStatus(); // registry was fetched successfully, so return true return true; @@ -1627,7 +1627,7 @@ public void run() { **2.6.7 getAndStoreFullRegistry** -´Óeureka server¶Ë»ñÈ¡·þÎñ×¢²áÖÐÐĵĵØÖ·ÐÅÏ¢£¬È»ºó¸üв¢ÉèÖõ½±¾µØ»º´æ localRegionApps ¡£ +从eureka server端获å�–æœ�务注册中心的地å�€ä¿¡æ�¯ï¼Œç„¶å�Žæ›´æ–°å¹¶è®¾ç½®åˆ°æœ¬åœ°ç¼“å­˜ localRegionApps 。 @@ -1667,14 +1667,14 @@ private void getAndStoreFullRegistry() throws Throwable { -**2.6.8 ·þÎñ¶Ë²éѯ·þÎñµØÖ·Á÷³Ì** -Ç°ÃæÎÒÃÇÖªµÀ£¬¿Í»§¶Ë·¢Æð·þÎñµØÖ·µÄ²éѯÓÐÁ½ÖÖ£¬Ò»ÖÖÊÇÈ«Á¿¡¢ÁíÒ»ÖÖÊÇÔöÁ¿¡£¶ÔÓÚÈ«Á¿²éѯµÄÇëÇ󣬻áµ÷ÓÃEureka-serverµÄApplicationsResourceµÄgetContainers·½·¨¡£ +**2.6.8 æœ�务端查询æœ�务地å�€æµ�程** +å‰�é�¢æˆ‘们知é�“,客户端å�‘èµ·æœ�务地å�€çš„æŸ¥è¯¢æœ‰ä¸¤ç§�,一ç§�是全é‡�ã€�å�¦ä¸€ç§�是增é‡�。对于全é‡�查询的请求,会调用Eureka-serverçš„ApplicationsResourceçš„getContainers方法。 -¶ø¶ÔÓÚÔöÁ¿ÇëÇ󣬻áµ÷Óà -ApplicationsResource.getContainerDifferential¡£ +而对于增é‡�请求,会调用 +ApplicationsResource.getContainerDifferential。 **2.6.9 ApplicationsResource.getContainers** -½ÓÊÕ¿Í»§¶Ë·¢Ë͵ĻñȡȫÁ¿×¢²áÐÅÏ¢ÇëÇó¡£ +接收客户端å�‘é€�的获å�–å…¨é‡�注册信æ�¯è¯·æ±‚。 @@ -1699,25 +1699,25 @@ public Response getContainers(@PathParam("version") String version, Arrays.sort(regions); // So we don't have different caches for same regions queried in different order. EurekaMonitors.GET_ALL_WITH_REMOTE_REGIONS.increment(); } - // EurekaServerÎÞ·¨Ìṩ·þÎñ£¬·µ»Ø403 + // EurekaServer无法æ��ä¾›æœ�务,返回403 if (!registry.shouldAllowAccess(isRemoteRegionRequested)) { return Response.status(Status.FORBIDDEN).build(); } CurrentRequestVersion.set(Version.toEnum(version)); - KeyType keyType = Key.KeyType.JSON;// ÉèÖ÷µ»ØÊý¾Ý¸ñʽ£¬Ä¬ÈÏJSON + KeyType keyType = Key.KeyType.JSON;// 设置返回数æ�®æ ¼å¼�,默认JSON String returnMediaType = MediaType.APPLICATION_JSON; if (acceptHeader == null || !acceptHeader.contains(HEADER_JSON_VALUE)) { - // Èç¹û½ÓÊÕµ½µÄÇëÇóÍ·²¿Ã»ÓоßÌå¸ñʽÐÅÏ¢£¬Ôò·µ»Ø¸ñʽΪXML + // 如果接收到的请求头部没有具体格å¼�ä¿¡æ�¯ï¼Œåˆ™è¿”回格å¼�为XML keyType = Key.KeyType.XML; returnMediaType = MediaType.APPLICATION_XML; } - // ¹¹½¨»º´æ¼ü + // 构建缓存键 Key cacheKey = new Key(Key.EntityType.Application, ResponseCacheImpl.ALL_APPS, keyType, CurrentRequestVersion.get(), EurekaAccept.fromString(eurekaAccept), regions ); - // ·µ»Ø²»Í¬µÄ±àÂëÀàÐ͵ÄÊý¾Ý£¬È¥»º´æÖÐÈ¡Êý¾ÝµÄ·½·¨»ù±¾Ò»Ö + // 返回ä¸�å�Œçš„ç¼–ç �类型的数æ�®ï¼ŒåŽ»ç¼“å­˜ä¸­å�–æ•°æ�®çš„æ–¹æ³•基本一致 Response response; if (acceptEncoding != null && acceptEncoding.contains(HEADER_GZIP_VALUE)) { response = Response.ok(responseCache.getGZIP(cacheKey)) @@ -1742,7 +1742,7 @@ public Response getContainers(@PathParam("version") String version, **2.6.10 responseCache.getGZIP** -´Ó»º´æÖжÁÈ¡Êý¾Ý¡£ +从缓存中读å�–æ•°æ�®ã€‚ @@ -1775,7 +1775,7 @@ Value getValue(final Key key, boolean useReadOnlyCache) { } ``` -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudGateway\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudGateway\346\272\220\347\240\201\345\210\206\346\236\220.md" index 80db850..feb06cc 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudGateway\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudGateway\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,18 +1,18 @@ -**ѧϰĿ±ê** +**学习目标** -1. GatewayºËÐÄÔ­Àí·ÖÎö - **µÚ1Õ BeanµÄ×¼±¸** - Ç°ÃæÒ²½²ÁËÕâô¶à×é¼þÁË£¬Õâ»á¶ùÎÒÃǼ¯³É - spring-cloud-starter-gateway×é¼þ·¢ÏÖ£¬ÓÖÊÇÒ»¸östarter×é¼þ£¬¶þ»°²»Ëµ£¬ÏÈÈ¥ÕÒspring.factoriesÎļþ£¬·ÖÎöÒ»ÏÂÓÐÄÄÐ©ÖØÒªµÄbean±»×Ô¶¯×°Åä½øIoCÈÝÆ÷ÀïÃæÁË¡£ +1. Gateway核心原ç�†åˆ†æž� + **第1ç«  Bean的准备** + å‰�é�¢ä¹Ÿè®²äº†è¿™ä¹ˆå¤šç»„件了,这会儿我们集æˆ� + spring-cloud-starter-gateway组件å�‘现,å�ˆæ˜¯ä¸€ä¸ªstarter组件,二è¯�ä¸�说,先去找spring.factories文件,分æž�一下有哪些é‡�è¦�çš„bean被自动装é…�è¿›IoC容器里é�¢äº†ã€‚ -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®GatewayÍø¹Ø-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://dl-harmonyos.51cto.com/images/202207/788f3c1494307a2ad7d935811c9e62bab2c435.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®GatewayÍø¹Ø-¿ªÔ´»ù´¡Èí¼þÉçÇø")1.ÏÈÀ´¿´ -GatewayClassPathWarningAutoConfigurationÕâ¸öÅäÖÃÀà +![SpringCloud系列—Spring Cloud æº�ç �分æž�之Gateway网关-å¼€æº�基础软件社区](https://dl-harmonyos.51cto.com/images/202207/788f3c1494307a2ad7d935811c9e62bab2c435.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之Gateway网关-å¼€æº�基础软件社区")1.å…ˆæ�¥çœ‹ +GatewayClassPathWarningAutoConfiguration这个é…�置类 ``` @Configuration(proxyBeanMethods = false) -//µ±Ç°ÅäÖÃÀàÔÚGatewayAutoConfigurationÕâ¸öºËÐÄÅäÖÃÀà֮ǰ¼ÓÔØ +//当å‰�é…�置类在GatewayAutoConfiguration这个核心é…�置类之å‰�加载 @AutoConfigureBefore(GatewayAutoConfiguration.class) public class GatewayClassPathWarningAutoConfiguration { ... @@ -47,33 +47,33 @@ public class GatewayClassPathWarningAutoConfiguration { -´ÓÕâ¸öÅäÖÃÀàÄÜ¿´³öÀ´£¬Ëüʵ¼ÊÉϾÍͨ¹ýConditionOnClassºÍConditionOnMissingClassÁ½¸ö×öÁËÁ½¸öÈÕÖ¾´òÓ¡µÄ¹¦ÄÜ£»Èç¹ûClassPathÏÂÓÐ -org.springframework.web.servlet.DispatcherServletÀàµÄ»°£¬ÔòʵÀýµÚÒ»¸öBean¶ÔÏó£¬È»ºó´òÓ¡ÈÕÖ¾£º²»ÄÜÒÀÀµspring-boot-starter-webÕâ¸ö°ü¡£È»ºóÔÙ¼ì²éClassPathÏÂÊÇ·ñÓÐÕýÈ·µÄÅäÖÃwebflux£¬Èç¹ûûÓУ¬Ôò´òÓ¡ÈÕÖ¾£º¼Óspring-boot-starter-webfluxÒÀÀµ¡£ +从这个é…�置类能看出æ�¥ï¼Œå®ƒå®žé™…上就通过ConditionOnClasså’ŒConditionOnMissingClass两个å�šäº†ä¸¤ä¸ªæ—¥å¿—打å�°çš„功能;如果ClassPath下有 +org.springframework.web.servlet.DispatcherServlet类的è¯�,则实例第一个Bean对象,然å�Žæ‰“å�°æ—¥å¿—:ä¸�能ä¾�èµ–spring-boot-starter-web这个包。然å�Žå†�检查ClassPath下是å�¦æœ‰æ­£ç¡®çš„é…�ç½®webflux,如果没有,则打å�°æ—¥å¿—:加spring-boot-starter-webfluxä¾�赖。 -2.ºËÐÄÅäÖÃÀàGatewayAutoConfiguration +2.核心é…�置类GatewayAutoConfiguration -ÒòΪ´úÂëÌ«³¤£¬ÕâÀï¾Í²»Õ¹Ê¾ÁË£¬ÕâÀï¾ÍÁоټ¸¸ö±È½ÏÖØÒªµÄ +因为代ç �太长,这里就ä¸�展示了,这里就列举几个比较é‡�è¦�çš„ -* PropertiesRouteDefinitionLocator£ºÓÃÓÚ´ÓÅäÖÃÎļþ£¨yml/properties£©ÖжÁȡ·ÓÉÅäÖÃÐÅÏ¢£¡ -* RouteDefinitionLocator£º°Ñ RouteDefinition ת»¯Îª Route -* RoutePredicateHandlerMapping£ºÀàËÆÓÚ mvc µÄHandlerMapping£¬²»¹ýÕâÀïÊÇ GatewayʵÏֵġ£ÓÃÓÚÆ¥Åä¶ÔÓ¦µÄÇëÇóroute -* GatewayProperties£ºymlÅäÖÃÐÅÏ¢·â×°ÔÚ GatewayProperties ¶ÔÏóÖÐ -* AfterRoutePredicateFactory£º¸÷ÖÖ·ÓɶÏÑÔ¹¤³§£¬ÕýÊÇÕâЩ¶ÏÑÔ¹¤³§ÔÚÆô¶¯Ê±ÒѾ­Éú³É¶ÔÓ¦µÄbean£¬ÎÒÃDzſÉÒÔÔÚ yml ÖÐÅäÖÃһϣ¬¼´¿ÉÉúЧ -* RetryGatewayFilterFactory£º¸÷ÖÖ Gateway ¹ýÂËÆ÷£¬ÕýÊÇÕâЩ¹ýÂËÆ÷ÔÚÆô¶¯Ê±ÒѾ­Éú³É¶ÔÓ¦µÄbean£¬ÎÒÃDzſÉÒÔÔÚ yml ÖÐÅäÖÃһϣ¬¼´¿ÉÉúЧ -* GlobalFilterʵÏÖÀࣺȫ¾Ö¹ýÂËÆ÷ +* PropertiesRouteDefinitionLocator:用于从é…�置文件(yml/properties)中读å�–路由é…�置信æ�¯ï¼� +* RouteDefinitionLocator:把 RouteDefinition 转化为 Route +* RoutePredicateHandlerMapping:类似于 mvc çš„HandlerMapping,ä¸�过这里是 Gateway实现的。用于匹é…�对应的请求route +* GatewayProperties:ymlé…�置信æ�¯å°�装在 GatewayProperties 对象中 +* AfterRoutePredicateFactory:å�„ç§�路由断言工厂,正是这些断言工厂在å�¯åŠ¨æ—¶å·²ç»�生æˆ�对应的bean,我们æ‰�å�¯ä»¥åœ¨ yml 中é…�置一下,å�³å�¯ç”Ÿæ•ˆ +* RetryGatewayFilterFactory:å�„ç§� Gateway 过滤器,正是这些过滤器在å�¯åŠ¨æ—¶å·²ç»�生æˆ�对应的bean,我们æ‰�å�¯ä»¥åœ¨ yml 中é…�置一下,å�³å�¯ç”Ÿæ•ˆ +* GlobalFilter实现类:全局过滤器 -3.HttpHandlerAutoConfigurationºÍWebFluxAutoConfigurationÅäÖÃÀ࣬ÔÚGatewayAutoConfigurationÖ®ºóʵÀý»¯£¬·Ö±ðʵÀý»¯ÁËHttpHandlerºÍWebFluxConfigBean +3.HttpHandlerAutoConfigurationå’ŒWebFluxAutoConfigurationé…�置类,在GatewayAutoConfiguration之å�Žå®žä¾‹åŒ–,分别实例化了HttpHandlerå’ŒWebFluxConfigBean -**µÚ2Õ ִÐÐÁ÷³Ì** -ÉÏÒ»ÎÄÖн²µ½HystrixµÄÔ­Àí£¬ÔÚHystrixÖкËÐÄÒµÎñÂß¼­¶¼ÊÇͨ¹ýÏìӦʽ±à³ÌÍê³ÉµÄ£¬ÊÂʵÉÏ£¬ÔÚGatewayÖÐÒ²¶¼ÊÇ»ùÓÚͬÑùµÄ±à³Ì·ç¸ñ¡£Í¬ÑùµÄ£¬GatewayµÄÁ÷³ÌͬSpringMVCÁ÷³ÌÒ²·Ç³£ÏàËÆ¡£ +**第2ç«  执行æµ�程** +上一文中讲到Hystrix的原ç�†ï¼Œåœ¨Hystrix中核心业务逻辑都是通过å“�应å¼�编程完æˆ�的,事实上,在Gateway中也都是基于å�Œæ ·çš„编程风格。å�Œæ ·çš„,Gatewayçš„æµ�程å�ŒSpringMVCæµ�程也é�žå¸¸ç›¸ä¼¼ã€‚ -µ±Ç°¶ËÓÐÇëÇó½øÀ´µÄʱºò£¬´óÌåµÄÁ÷³ÌÈçÏ£º +当å‰�端有请求进æ�¥çš„æ—¶å€™ï¼Œå¤§ä½“çš„æµ�程如下: -1. Ê×Ïȱ»DispatcherHandler¸ø²¶»ñÀ¹½Ø£¬È»ºó¶ÔÇëÇóµÄURI½øÐнâÎö -2. È»ºó¸ù¾ÝURIÈ¥µ÷ÓÃHandlerMapping£¬»ñÈ¡ÕæÕýÒªÖ´ÐеÄWebHandler -3. È»ºóÑ¡ÔñÒ»¸öºÏÊʵÄÊÊÅäÆ÷HandlerAdapterÖ´ÐÐ -4. Ö´ÐÐWebHandler - µ±ÇëÇógateway·þÎñʱ£¬ËùÓеÄÇëÇó¶¼»á½øÈëµ½DispatcherHandlerÖеÄhandle·½·¨£¬ÏÂÃæÎÒÃÇÒ»Æð¿´¿´Õâ¸ö·½·¨ +1. 首先被DispatcherHandlerç»™æ�•获拦截,然å�Žå¯¹è¯·æ±‚çš„URI进行解æž� +2. ç„¶å�Žæ ¹æ�®URI去调用HandlerMapping,获å�–真正è¦�执行的WebHandler +3. ç„¶å�Žé€‰æ‹©ä¸€ä¸ªå�ˆé€‚的适é…�器HandlerAdapter执行 +4. 执行WebHandler + 当请求gatewayæœ�务时,所有的请求都会进入到DispatcherHandler中的handle方法,下é�¢æˆ‘们一起看看这个方法 @@ -83,17 +83,17 @@ public Mono handle(ServerWebExchange exchange) { if (this.handlerMappings == null) { return createNotFoundError(); } - //ÕâÀï¾ÍÊÇwebFluxµÄÏìӦʽ±à³Ì + //这里就是webFluxçš„å“�应å¼�编程 return Flux - // 1.ÕâÀï¾ÍÊDZéÀúËùÓÐµÄ handlerMapping + // 1.这里就是é��历所有的 handlerMapping .fromIterable(this.handlerMappings) - // 2.»ñÈ¡¶ÔÓ¦µÄhandlerMapping £¬±ÈÈç³£ÓÃµÄ RequestMappingHandlerMapping¡¢RoutePredicateHandlerMapping + // 2.获å�–对应的handlerMapping ,比如常用的 RequestMappingHandlerMappingã€�RoutePredicateHandlerMapping .concatMap(mapping -> mapping.getHandler(exchange)) .next() .switchIfEmpty(createNotFoundError()) - // 3.»ñÈ¡¶ÔÓ¦µÄÊÊÅäÆ÷£¬µ÷ÓöÔÓ¦µÄ´¦ÀíÆ÷ + // 3.获å�–对应的适é…�器,调用对应的处ç�†å™¨ .flatMap(handler -> invokeHandler(exchange, handler)) - // 4.·µ»Ø´¦Àí½á¹û + // 4.返回处ç�†ç»“æžœ .flatMap(result -> handleResult(exchange, result)); } ``` @@ -107,17 +107,17 @@ public Mono handle(ServerWebExchange exchange) { **2.1 getHandler** -ÎÒÃÇÏÈÀ´¿´¿´getHandler·½·¨£¬Ëü¾ÍÊÇGatewayµÄºËÐÄÂß¼­ËùÔÚ£¬ÔÙgetHandlerÖлñÈ¡¶ÔÓ¦µÄHandlerMapping¡£ +我们先æ�¥çœ‹çœ‹getHandler方法,它就是Gateway的核心逻辑所在,å†�getHandler中获å�–对应的HandlerMapping。 -ÏÂÃæÊÇ -AbstractHandlerMapping.getHandlerµÄÔ´Âë +下é�¢æ˜¯ +AbstractHandlerMapping.getHandlerçš„æº�ç � ``` @Override public Mono getHandler(ServerWebExchange exchange) { - //ÕâÒ»²½»á»ñȡ·ÓɵÄʵÏÖÀ࣬»á½øÈëµ½RoutePredicateHandlerMapping + //这一步会获å�–路由的实现类,会进入到RoutePredicateHandlerMapping return getHandlerInternal(exchange).map(handler -> { if (logger.isDebugEnabled()) { logger.debug(exchange.getLogPrefix() + "Mapped to " + handler); @@ -155,19 +155,19 @@ protected Mono getHandlerInternal(ServerWebExchange exchange) { return Mono.empty(); } exchange.getAttributes().put(GATEWAY_HANDLER_MAPPER_ATTR, getSimpleName()); - //ѰÕÒ²¢Æ¥Åä·ÓÉ + //寻找并匹é…�路由 return lookupRoute(exchange) // .log("route-predicate-handler-mapping", Level.FINER) //name this .flatMap((Function>) r -> { - //ÒÆ³ýÉÏÏÂÎÄÖоɵÄÊôÐÔ + //移除上下文中旧的属性 exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR); if (logger.isDebugEnabled()) { logger.debug( "Mapping [" + getExchangeDesc(exchange) + "] to " + r); } - //°Ñ¸Ã·ÓÉÓëÉÏÏÂÎİ󶨣¬ºóÐø¸ºÔؾùºâ»áÓà + //把该路由与上下文绑定,å�Žç»­è´Ÿè½½å�‡è¡¡ä¼šç”¨ exchange.getAttributes().put(GATEWAY_ROUTE_ATTR, r); - //·µ»Ø webHandler + //返回 webHandler return Mono.just(webHandler); }).switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> { exchange.getAttributes().remove(GATEWAY_PREDICATE_ROUTE_ATTR); @@ -187,18 +187,18 @@ protected Mono getHandlerInternal(ServerWebExchange exchange) { -ÆäÖÐlookupRoute·½·¨»áÕÒµ½ymlÖÐÅäÖõÄËùÓеÄ·ÓɶÏÑÔ¹¤³§£¨Before¡¢After¡¢PathµÈµÈ£©£¬²¢Ö´ÐÐapply·½·¨£¬½øÐзÓÉÆ¥Å䣬ÅжÏÊÇ·ñÔÊÐíÇëÇóͨ¹ý£¡Ö´ÐÐ˳ÐòÓÉspringboot×Ô¶¯ÅäÖÃʱ×Ô¼ºÖƶ¨ +其中lookupRoute方法会找到yml中é…�置的所有的路由断言工厂(Beforeã€�Afterã€�Path等等),并执行apply方法,进行路由匹é…�,判断是å�¦å…�许请求通过ï¼�执行顺åº�ç”±springboot自动é…�置时自己制定 ``` protected Mono lookupRoute(ServerWebExchange exchange) { - // getRoutes »ñÈ¡ËùÓеĶÏÑÔ¹¤³§ + // getRoutes 获å�–所有的断言工厂 return this.routeLocator.getRoutes() .concatMap(route -> Mono.just(route).filterWhen(r -> { exchange.getAttributes().put(GATEWAY_PREDICATE_ROUTE_ATTR, r.getId()); - // ÏÈ»ñÈ¡RouteÄÚ²¿µÄpredicateÊôÐÔ - //È»ºóµ÷ÓÃapply·½·¨ Ö´ÐжÏÑÔ£¡ÅжÏÇëÇóÊÇ·ñͨ¹ý + // 先获å�–Route内部的predicate属性 + //ç„¶å�Žè°ƒç”¨apply方法 执行断言ï¼�判断请求是å�¦é€šè¿‡ return r.getPredicate().apply(exchange); }).doOnError(e -> logger.error( "Error applying predicate for route: " + route.getId(), @@ -223,17 +223,17 @@ protected Mono lookupRoute(ServerWebExchange exchange) { -ÆäÖÐgetRoutes()·½·¨¾ÍÊÇͨ¹ý -RouteDefinitionRouteLocator´ÓÅäÖÃÎļþÖлñÈ¡ËùÓзÓɵģ¬È»ºó°ÑÕÒµ½µÄ·ÓÉת»»³ÉRoute +其中getRoutes()方法就是通过 +RouteDefinitionRouteLocator从é…�置文件中获å�–所有路由的,然å�ŽæŠŠæ‰¾åˆ°çš„è·¯ç”±è½¬æ�¢æˆ�Route ``` @Override public Flux getRoutes() { - // getRouteDefinitions() ´ÓÅäÖÃÎļþÖлñÈ¡ËùÓзÓÉ + // getRouteDefinitions() 从é…�置文件中获å�–所有路由 Flux routes = this.routeDefinitionLocator.getRouteDefinitions() - // convertToRoute()£º°ÑÕÒµ½µÄ·ÓÉת»»³ÉRoute + // convertToRoute():把找到的路由转æ�¢æˆ�Route .map(this::convertToRoute); ... } @@ -270,14 +270,14 @@ public class Route implements Ordered { **2.2 invokeHandler** -GatewayÓÉÓÚÔÚÉÏÒ»²½Æ¥Åä·Óɺ󷵻صÄÊÇwebHandlerÀàÐ͵ģ¬ËùÒÔÒ²ÐèÒªÕÒµ½¶ÔÓ¦µÄHandlerAdaptor£¬½øÈë»ñÈ¡¶ÔÓ¦µÄÊÊÅäÆ÷·½·¨ invokeHandler(exchange, handler)ÖÐ +Gateway由于在上一步匹é…�路由å�Žè¿”回的是webHandler类型的,所以也需è¦�找到对应的HandlerAdaptor,进入获å�–对应的适é…�器方法 invokeHandler(exchange, handler)中 ``` private Mono invokeHandler(ServerWebExchange exchange, Object handler) { if (this.handlerAdapters != null) { - //ÕÒµ½ËùÓеÄHandlerAdapterȥƥÅäWebFluxÀàÐÍ + //找到所有的HandlerAdapter去匹é…�WebFlux类型 for (HandlerAdapter handlerAdapter : this.handlerAdapters) { if (handlerAdapter.supports(handler)) { return handlerAdapter.handle(exchange, handler); @@ -296,14 +296,14 @@ private Mono invokeHandler(ServerWebExchange exchange, Object han -SimpleHandlerAdapter ÖеÄhandle·½·¨ÈçÏ +SimpleHandlerAdapter 中的handle方法如下 ``` @Override public Mono handle(ServerWebExchange exchange, Object handler) { - //´¦ÀíWebHandler ÀàÐÍ + //处ç�†WebHandler 类型 WebHandler webHandler = (WebHandler) handler; Mono mono = webHandler.handle(exchange); return mono.then(Mono.empty()); @@ -318,27 +318,27 @@ public Mono handle(ServerWebExchange exchange, Object handler) { -ÆäÖÐwebHandler.handle·½·¨¾ÍÊÇ´¦ÀíËùÓйýÂËÆ÷Á´µÄ·½·¨£¬¸Ã¹ýÂËÆ÷Á´°üÀ¨globalFiltersºÍgatewayFilters +其中webHandler.handle方法就是处ç�†æ‰€æœ‰è¿‡æ»¤å™¨é“¾çš„æ–¹æ³•,该过滤器链包括globalFilterså’ŒgatewayFilters ``` @Override public Mono handle(ServerWebExchange exchange) { - // 1\. ¸ù¾Ý·ÓÉÓëÉÏÏÂÎİ󶨹ØÏµ£¬»ñÈ¡¶ÔÓ¦µÄ·ÓÉRoute + // 1\. æ ¹æ�®è·¯ç”±ä¸Žä¸Šä¸‹æ–‡ç»‘定关系,获å�–对应的路由Route Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR); List gatewayFilters = route.getFilters(); - // 2\. ÊÕ¼¯ËùÓÐµÄ globalFilters ²¢·ÅÈëList - //×¢ÒâÕâÀïʹÓÃÁËÊÊÅäÆ÷ģʽ + // 2\. 收集所有的 globalFilters 并放入List + //注æ„�这里使用了适é…�器模å¼� List combined = new ArrayList<>(this.globalFilters); - // 3\. °Ñ gatewayFilters Ò²·ÅÈëList£¬ÐγÉÒ»Ìõ¹ýÂËÆ÷Á¢°¸ + // 3\. 把 gatewayFilters 也放入List,形æˆ�一æ�¡è¿‡æ»¤å™¨ç«‹æ¡ˆ combined.addAll(gatewayFilters); - // 4\. ¸ù¾ÝorderÅÅÐò + // 4\. æ ¹æ�®order排åº� AnnotationAwareOrderComparator.sort(combined); if (logger.isDebugEnabled()) { logger.debug("Sorted gatewayFilterFactories: " + combined); } - // 5\. Ö´ÐйýÂËÆ÷Á´ÖеÄÿһ¸ö¹ýÂËÆ÷·½·¨£¡ + // 5\. 执行过滤器链中的æ¯�一个过滤器方法ï¼� return new DefaultGatewayFilterChain(combined).filter(exchange); } ``` @@ -351,24 +351,24 @@ public Mono handle(ServerWebExchange exchange) { -×¢Ò⣺ÔÚ×é×°¹ýÂËÆ÷Á´µÄʱºò£¬ÊǰÑglobalFiltersºÍgatewayFiltersÁ½ÖÖ¹ýÂËÆ÷¶¼·Å½øÁËListÖУ¬ÕâÊÇÔõô×öµÄÄØ£¿ +注æ„�:在组装过滤器链的时候,是把globalFilterså’ŒgatewayFilters两ç§�过滤器都放进了List中,这是怎么å�šçš„呢? -ÕâÆäʵÓõ½ÁËÒ»ÖÖ ÊÊÅäÆ÷ µÄÉè¼ÆÄ£Ê½£¡ +这其实用到了一ç§� 适é…�器 的设计模å¼�ï¼� -* Èç¹û·ÅÈëµÄÊÇglobalFilters£¬»áÏȰÑglobalFiltersת»¯³ÉGatewayFilterAdapter¡£ GatewayFilterAdapterÔÚÄÚ²¿¼¯³ÉÁËGlobalFilter£¬Í¬Ê±Ò²ÊµÏÖÁËGatewayFilter£¬Ê¹ globalFiltersºÍgatewayFiltersÔÚ ÊÊÅäÆ÷ ÀàGatewayFilterAdapterÖй²´æ£¡ -* Èç¹û·ÅÈëµÄÊÇgatewayFilters£¬Ö±½Ó·ÅÈë¼´¿É£¡ - **µÚ3Õ ¸ºÔؾùºâÁ÷³Ì** - GatewayµÄ¸ºÔؾùºâÖ»ÐèÒªÔÚymlÖÐÅäÖà uri: lb://user¼´¿ÉʵÏÖ¸ºÔؾùºâ£¬µ×²ãÊÇÓÉÈ«¾Ö¹ýÂËÆ÷LoadBalancerClientFilterµÄfilter·½·¨È¥×öµÄ£¡ +* 如果放入的是globalFilters,会先把globalFilters转化æˆ�GatewayFilterAdapter。 GatewayFilterAdapter在内部集æˆ�了GlobalFilter,å�Œæ—¶ä¹Ÿå®žçŽ°äº†GatewayFilter,使 globalFilterså’ŒgatewayFilters在 适é…�器 ç±»GatewayFilterAdapter中共存ï¼� +* 如果放入的是gatewayFilters,直接放入å�³å�¯ï¼� + **第3ç«  è´Ÿè½½å�‡è¡¡æµ�程** + Gateway的负载å�‡è¡¡å�ªéœ€è¦�在yml中é…�ç½® uri: lb://userå�³å�¯å®žçŽ°è´Ÿè½½å�‡è¡¡ï¼Œåº•层是由全局过滤器LoadBalancerClientFilterçš„filter方法去å�šçš„ï¼� -ÒÔ¶©µ¥·þÎñµÄ -http://localhost:9527/get/3ΪÀý£¡9527ÎªÍø¹ØGatewayµÄ¶Ë¿Ú +以订å�•æœ�务的 +http://localhost:9527/get/3为例ï¼�9527为网关Gateway的端å�£ ``` public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) { - // 1\. ¸ù¾Ý·ÓÉÓëÉÏÏÂÎİ󶨹ØÏµ - // »ñȡԭʼµÄurl£ºhttp://localhost:9527/get/3 + // 1\. æ ¹æ�®è·¯ç”±ä¸Žä¸Šä¸‹æ–‡ç»‘定关系 + // 获å�–原始的url:http://localhost:9527/get/3 URI url = exchange.getAttribute(GATEWAY_REQUEST_URL_ATTR); String schemePrefix = exchange.getAttribute(GATEWAY_SCHEME_PREFIX_ATTR); if (url == null @@ -379,34 +379,34 @@ public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) { if (log.isTraceEnabled()) { log.trace("LoadBalancerClientFilter url before: " + url); } - // 2\. ͨ¹ýribbonµÄ¸ºÔؾùºâËã·¨£¬¸ù¾Ý·þÎñÃûÈ¥nacos»òÕßEurekaÑ¡ÔñÒ»¸öʵÀý£¡ - // ¸ÃʵÀý¾ÍÓÐuser·þÎñÕæÕýµÄ url µØÖ·£ºhttp://localhost:8080/get/3 + // 2\. 通过ribbon的负载å�‡è¡¡ç®—法,根æ�®æœ�务å��去nacos或者Eureka选择一个实例ï¼� + // 该实例就有useræœ�务真正的 url 地å�€ï¼šhttp://localhost:8080/get/3 final ServiceInstance instance = choose(exchange); if (instance == null) { throw NotFoundException.create(properties.isUse404(), "Unable to find instance for " + url.getHost()); } - // 3\. Äõ½Ô­ÉúµÄ uri £ºhttp://localhost:9527/get/3 + // 3\. 拿到原生的 uri :http://localhost:9527/get/3 URI uri = exchange.getRequest().getURI(); String overrideScheme = instance.isSecure() ? "https" : "http"; if (schemePrefix != null) { overrideScheme = url.getScheme(); } - // 4\. Ä÷þÎñʵÀýinstanceµÄuriÌæ»»Ô­ÉúµÄuriµØÖ· µÃµ½ еÄurl - // еÄurl: http://localhost:8080/get/3 + // 4\. æ‹¿æœ�务实例instanceçš„uri替æ�¢åŽŸç”Ÿçš„uri地å�€ 得到 æ–°çš„url + // æ–°çš„url: http://localhost:8080/get/3 URI requestUrl = loadBalancer.reconstructURI( new DelegatingServiceInstance(instance, overrideScheme), uri); if (log.isTraceEnabled()) { log.trace("LoadBalancerClientFilter url chosen: " + requestUrl); } - // 5\. ÔٴμǼÉÏÏÂÎĹØÏµ + // 5\. å†�次记录上下文关系 exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, requestUrl); - // 6\. Ö´ÐйýÂËÆ÷Á´ÖÐµÄÆäËû¹ýÂËÇëÇó + // 6\. 执行过滤器链中的其他过滤请求 return chain.filter(exchange); } ``` -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudHystrix\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudHystrix\346\272\220\347\240\201\345\210\206\346\236\220.md" index 87b59fb..ca9a280 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudHystrix\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudHystrix\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,18 +1,18 @@ -ѧϰĿ±ê +学习目标 -1. ÊÖдMini°æµÄHystrix -2. RxJava֪ʶÊáÀí -3. HystrixµÄºËÐÄÁ÷³Ì·ÖÎö -4. Ô´ÂëÑéÖ¤ - µÚ1Õ ÊÖдMini°æ - ÉÏÎÄÖÐÒѾ­¸ø´ó¼Ò½éÉܹýÁËHystrixµÄºËÐŦÄܺÍʹÓÃÁË£¬ËüÎ޷ǾÍÊÇÌṩÁËÈÛ¶Ï¡¢½µ¼¶¡¢¸ôÀëµÈ¹¦ÄÜ£¬ÆäÖÐÈ۶Ϻ͸ôÀëÊÇÄ¿µÄ£¬½µ¼¶Êǽá¹û¡£ÔÚʹÓùý³ÌÖÐÆäʵ×îºËÐĵÄÓÐÈý¸ö×¢½â£º@EnableHystrix¡¢@HystrixCommandºÍ@HystrixCollapser¡£¿ÉÒÔͨ¹ý×¢½â @HystrixCommand¡¢»òÕ߼̳РHystrixCommand À´ÊµÏÖ½µ¼¶£¬ÒÔ¼°Ò»Ð©ÇëÇóºÏ²¢µÈ²Ù×÷¡£ +1. 手写Mini版的Hystrix +2. RxJava知识梳ç�† +3. Hystrix的核心æµ�程分æž� +4. æº�ç �验è¯� + 第1ç«  手写Mini版 + 上文中已ç»�给大家介ç»�过了Hystrix的核心功能和使用了,它无é�žå°±æ˜¯æ��供了熔断ã€�é™�级ã€�隔离等功能,其中熔断和隔离是目的,é™�级是结果。在使用过程中其实最核心的有三个注解:@EnableHystrixã€�@HystrixCommandå’Œ@HystrixCollapser。å�¯ä»¥é€šè¿‡æ³¨è§£ @HystrixCommandã€�或者继承 HystrixCommand æ�¥å®žçްé™�级,以å�Šä¸€äº›è¯·æ±‚å�ˆå¹¶ç­‰æ“�作。 -ÔÚÕýʽ½²½âÔ­Àí֮ǰ£¬ÎÒÃÇÊ×ÏÈÒªÃ÷È·Ò»¸öµã£¬µ±²ÉÓà @HystrixCommand ×¢½âÀ´ÊµÏÖ·þÎñ½µ¼¶£¬ÔÚHystrix µÄÄÚ²¿ÊDzÉÓÃAOPµÄ·½Ê½½øÐÐÀ¹½Ø´¦ÀíÇëÇóµÄ£¬Õâ¿éÄÚÈÝ£¬ºóÃæÒ²»áÏêϸ·ÖÎö¡£ÎÒÃÇÕâÀï¾ÍÏÈÀ´ÊµÏÖһϼòÒ×°æµÄ Hystrix À´Ìå»áһϣ¬Ö÷Òª·ÖΪÒÔϲ½Öè +在正å¼�讲解原ç�†ä¹‹å‰�,我们首先è¦�明确一个点,当采用 @HystrixCommand 注解æ�¥å®žçްæœ�务é™�级,在Hystrix 的内部是采用AOP的方å¼�进行拦截处ç�†è¯·æ±‚的,这å�—内容,å�Žé�¢ä¹Ÿä¼šè¯¦ç»†åˆ†æž�。我们这里就先æ�¥å®žçŽ°ä¸€ä¸‹ç®€æ˜“ç‰ˆçš„ Hystrix æ�¥ä½“会一下,主è¦�分为以下步骤 -- ¶¨Òå×Ô¼ºµÄ@HystrixCommand ×¢½â¡£ -- ʵÏÖÀ¹½ØÇëÇóµÄ´¦ÀíÂß¼­¡£ -- ²âÊÔµ÷Óᣠ- 1.×Ô¶¨Òå×¢½â +- 定义自己的@HystrixCommand 注解。 +- 实现拦截请求的处ç�†é€»è¾‘。 +- 测试调用。 + 1.自定义注解 @@ -20,9 +20,9 @@ @Retention(RetentionPolicy.RUNTIME) @Documented public @interface MyHystrixCommand { - //ĬÈϳ¬Ê±Ê±¼ä + //默认超时时间 int timeout() default 1000; - //»ØÍË·½·¨ + //回退方法 String fallback() default ""; } @@ -34,27 +34,27 @@ -2.×Ô¶¨ÒåÇÐÃæÀà +2.自定义切é�¢ç±» - @Aspect //¿ªÆôAspectÖ§³Ö²¢ÇÒ±ê¼ÇΪһ¸öÇÐÃæÀà + @Aspect //å¼€å�¯Aspect支æŒ�并且标记为一个切é�¢ç±» @Component public class MyHystrixCommandAspect { ExecutorService executorService= Executors.newFixedThreadPool(10); - //¶¨ÒåÇеã + //定义切点 @Pointcut(value = "@annotation(MyHystrixCommand)") public void pointCut(){ } - //ÔÚÇе㷽·¨Íâ»·ÈÆÖ´ÐÐ @AroundÏ൱ÓÚ@BeforeºÍ@AfterReturning¹¦ÄܵÄ×ÜºÍ + //在切点方法外环绕执行 @Around相当于@Beforeå’Œ@AfterReturning功能的总和 @Around(value = "pointCut()&&@annotation(hystrixCommand)") public Object doPointCut(ProceedingJoinPoint joinPoint, MyHystrixCommand hystrixCommand) throws Exception { int timeout=hystrixCommand.timeout(); Future future=executorService.submit(()->{ try { - //Ö´ÐÐproceed·½·¨µÄ×÷ÓÃÊÇÈÃÄ¿±ê·½·¨Ö´ÐÐ + //执行proceed方法的作用是让目标方法执行 return joinPoint.proceed(); } catch (Throwable throwable) { throwable.printStackTrace(); @@ -63,28 +63,28 @@ }); Object rs; try { - //ͨ¹ýgetµÄÒì²½µÈ´ýÀ´ÊµÏÖ³¬Ê± + //通过get的异步等待æ�¥å®žçŽ°è¶…æ—¶ rs=future.get(timeout, TimeUnit.MILLISECONDS); } catch (InterruptedException | ExecutionException | TimeoutException e) { future.cancel(true); if(StringUtils.isBlank(hystrixCommand.fallback())){ throw new Exception("fallback is null"); } - //µ÷ÓÃfallback + //调用fallback rs=invokeFallback(joinPoint,hystrixCommand.fallback()); } return rs; } private Object invokeFallback(ProceedingJoinPoint joinPoint,String fallback) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException { - //»ñÈ¡±»´úÀíµÄ·½·¨²ÎÊýºÍMethod - MethodSignature signature=(MethodSignature)joinPoint.getSignature(); //»ñÈ¡´úÀíÀàºÍ±»´úÀíÀàµÄÐÅÏ¢ + //获å�–被代ç�†çš„æ–¹æ³•å�‚æ•°å’ŒMethod + MethodSignature signature=(MethodSignature)joinPoint.getSignature(); //获å�–代ç�†ç±»å’Œè¢«ä»£ç�†ç±»çš„ä¿¡æ�¯ Method method=signature.getMethod(); Class[] parameterTypes=method.getParameterTypes(); - //µÃµ½»Øµ÷·½·¨ + //得到回调方法 try { Method fallbackMethod=joinPoint.getTarget().getClass().getMethod(fallback,parameterTypes); method.setAccessible(true); - //ͨ¹ý·´É仨µ÷ + //通过å��射回调 return fallbackMethod.invoke(joinPoint.getTarget(),joinPoint.getArgs()); } catch (Exception e) { throw e; @@ -100,7 +100,7 @@ -3.×Ô¶¨Òå²âÊÔ +3.自定义测试 @@ -114,7 +114,7 @@ return orderServiceClient.orderLists(num); } public String fallback(int num){ - return "×Ô¶¨Òå×¢½â·½·¨±»½µ¼¶"; + return "自定义注解方法被é™�级"; } } @@ -126,21 +126,21 @@ -µ±ÇëÇóhttp://localhost:8080/myhystrix/get/1ʱ»á´¥·¢½µ¼¶£¬ÒòΪÔÚ·þÎñ¶Ë£¬µ±num=1ʱ»áÐÝÃß3s¡£ +当请求http://localhost:8080/myhystrix/get/1时会触å�‘é™�级,因为在æœ�务端,当num=1时会休眠3s。 -OK£¬ÕâÑùÎÒÃǾÍʵÏÖÁËÒ»¸ö¼òÒ×°æµÄHystrixCommand£¬µ«ÊÇÎÒÃÇÖ»ÊÇʵÏÖÁËHystrixµÄµÚÒ»²½£¬¶¨ÒåÁËÒ»¸ö×¢½âºÍÇÐÃæ£¬µ«ÊÇËüµÄµ×²ãÂß¼­Ô¶Ô¶Ã»ÓÐÕâô¼òµ¥£¬ÔÚ½²Ô´Âë֮ǰ£¬ÎÒÃÇÏÈÀ´ÞÛÒ»ÞÛRxJavaÊÇʲô£¬ÒòΪHystrixµ×²ãÂß¼­ÊÇ»ùÓÚÏìӦʽ±à³ÌʵÏֵġ£ +OK,这样我们就实现了一个简易版的HystrixCommand,但是我们å�ªæ˜¯å®žçŽ°äº†Hystrix的第一步,定义了一个注解和切é�¢ï¼Œä½†æ˜¯å®ƒçš„底层逻辑远远没有这么简å�•,在讲æº�ç �之å‰�,我们先æ�¥æ�‹ä¸€æ�‹RxJava是什么,因为Hystrix底层逻辑是基于å“�应å¼�编程实现的。 -µÚ2Õ RxJavaÌåÑé -2.1 RxJava¸ÅÊö -RxJava ÊÇÒ»ÖÖÏìӦʽ±à³Ì£¬À´´´½¨»ùÓÚʼþµÄÒì²½²Ù×÷¿â¡£»ùÓÚʼþÁ÷µÄÁ´Ê½µ÷Óá¢Âß¼­ÇåÎú¼ò½à¡£ +第2ç«  RxJava体验 +2.1 RxJava概述 +RxJava 是一ç§�å“�应å¼�编程,æ�¥åˆ›å»ºåŸºäºŽäº‹ä»¶çš„异步æ“�作库。基于事件æµ�的链å¼�调用ã€�逻辑清晰简æ´�。 -RxJava¹Û²ìÕßģʽµÄ¶Ô±È +RxJava观察者模å¼�的对比 -- ´«Í³¹Û²ìÕßÊÇÒ»¸ö±»¹Û²ìÕß¶à¹ý¹Û²ìÕߣ¬µ±±»¹Û²ìÕß·¢Éú¸Ä±äʱºò¼°Ê±Í¨ÖªËùÓй۲ìÕß -- RxJavaÊÇÒ»¸ö¹Û²ìÕß¶à¸ö±»¹Û²ìÕߣ¬±»¹Û²ìÕßÏñÁ´ÌõÒ»Ñù´®ÆðÀ´£¬Êý¾ÝÔÚ±»¹Û²ìÕßÖ®¼ä³¯×ÅÒ»¸ö·½Ïò´«µÝ£¬Ö±µ½´«µÝ¸ø¹Û²ìÕß ¡£ - Æäʵ˵°×ÁË£¬¾ÍÊÇÔÚRxJavaÖдæÔÚ2ÖÖ¸ÅÄһÖÖÊDZ»¹Û²ìÕߣ¬Ò»ÖÖÊǹ۲ìÕߣ¬µ±¶à¸ö±»¹Û²ìÕß¶©ÔÄÁËͬһ¸ö¹Û²ìÕßµÄʱºò£¬ÄÇÃ´Ëæ×ű»¹Û²ìÕßÍê³Éij¸öʼþµÄʱºò¾Í»áÈ¥»Øµ÷¹Û²ìÕß¡£ +- 传统观察者是一个被观察者多过观察者,当被观察者å�‘生改å�˜æ—¶å€™å�Šæ—¶é€šçŸ¥æ‰€æœ‰è§‚察者 +- RxJava是一个观察者多个被观察者,被观察者åƒ�链æ�¡ä¸€æ ·ä¸²èµ·æ�¥ï¼Œæ•°æ�®åœ¨è¢«è§‚察者之间æœ�ç�€ä¸€ä¸ªæ–¹å�‘传递,直到传递给观察者 。 + 其实说白了,就是在RxJava中存在2ç§�概念,一ç§�是被观察者,一ç§�是观察者,当多个被观察者订阅了å�Œä¸€ä¸ªè§‚察者的时候,那么éš�ç�€è¢«è§‚察者完æˆ�æŸ�个事件的时候就会去回调观察者。 -2.2 ¹Û²ìÕß +2.2 观察者 Observer @@ -149,15 +149,15 @@ Observer Observer observer = new Observer() { @Override public void onCompleted() { - System.out.println("µ±±»¹Û²ìÕßÉú²úCompleteʼþ£¬µ÷Óø÷½·¨"); + System.out.println("当被观察者生产Complete事件,调用该方法"); } @Override public void onError(Throwable throwable) { - System.out.println("¶ÔErrorʼþ×÷³öÏìÓ¦"); + System.out.println("对Error事件作出å“�应"); } @Override public void onNext(Object o) { - System.out.println("¶ÔNextʼþ×÷³öÏìÓ¦:" + o); + System.out.println("对Next事件作出å“�应:" + o); } }; @@ -171,19 +171,19 @@ Observer - //SubscriberÀà = RxJava ÄÚÖõÄÒ»¸öʵÏÖÁË Observer µÄ³éÏóÀ࣬¶Ô Observer ½Ó¿Ú½øÐÐÁËÀ©Õ¹ + //Subscriberç±» = RxJava 内置的一个实现了 Observer 的抽象类,对 Observer 接å�£è¿›è¡Œäº†æ‰©å±• Subscriber subscriber = new Subscriber() { @Override public void onCompleted() { - System.out.println("µ±±»¹Û²ìÕßÉú²úCompleteʼþ£¬µ÷Óø÷½·¨"); + System.out.println("当被观察者生产Complete事件,调用该方法"); } @Override public void onError(Throwable throwable) { - System.out.println("¶ÔErrorʼþ×÷³öÏìÓ¦"); + System.out.println("对Error事件作出å“�应"); } @Override public void onNext(Object o) { - System.out.println("¶ÔNextʼþ×÷³öÏìÓ¦:" + o); + System.out.println("对Next事件作出å“�应:" + o); } }; @@ -195,29 +195,29 @@ Observer -Subscriber ³éÏóÀàÓëObserver ½Ó¿ÚµÄÇø±ð +Subscriber 抽象类与Observer 接å�£çš„区别 -¶þÕß»ù±¾Ê¹Ó÷½Ê½Ò»Ö£¨ÔÚRxJavaµÄsubscribe¹ý³ÌÖУ¬Observer»áÏȱ»×ª»»³ÉSubscriberÔÙʹÓã© -Subscriber³éÏóÀà¶Ô Observer ½Ó¿Ú½øÐÐÁËÀ©Õ¹£¬ÐÂÔöÁËÁ½¸ö·½·¨£º +二者基本使用方å¼�一致(在RxJavaçš„subscribe过程中,Observer会先被转æ�¢æˆ�Subscriberå†�使用) +Subscriber抽象类对 Observer 接å�£è¿›è¡Œäº†æ‰©å±•,新增了两个方法: -- onStart()£ºÔÚ»¹Î´ÏìӦʼþǰµ÷Óã¬ÓÃÓÚ×öһЩ³õʼ»¯¹¤×÷£¬ËûÊÇÔÚsubscribe ËùÔÚµÄÏ̵߳÷Ó㬲»ÄÜÇл»Ị̈߳¬ËùÒÔ²»ÄܽøÐнçÃæUI¸üбÈÈ絯¿òÕâЩ¡£ -- unsubscribe()£ºÓÃÓÚÈ¡Ïû¶©ÔÄ¡£Ôڸ÷½·¨±»µ÷Óú󣬹۲ìÕß½«²»ÔÙ½ÓÊÕÏìӦʼþ£¬±ÈÈçÔÚonStop·½·¨ÖпÉÒÔµ÷Óô˷½·¨½áÊø¶©ÔÄ¡£µ÷Óø÷½·¨Ç°£¬ÏÈʹÓà isUnsubscribed() ÅжÏ״̬£¬È·¶¨±»¹Û²ìÕßObservableÊÇ·ñ»¹³ÖÓй۲ìÕßSubscriberµÄÒýÓᣠ- 2.3 ±»¹Û²ìÕß - RxJava ÌṩÁ˶àÖÖ·½·¨ÓÃÓÚ ´´½¨±»¹Û²ìÕß¶ÔÏóObservable£¬ÕâÀï½éÉÜÁ½ÖÖ +- onStart():在还未å“�应事件å‰�调用,用于å�šä¸€äº›åˆ�始化工作,他是在subscribe 所在的线程调用,ä¸�能切æ�¢çº¿ç¨‹ï¼Œæ‰€ä»¥ä¸�能进行界é�¢UI更新比如弹框这些。 +- unsubscribe():用于å�–消订阅。在该方法被调用å�Žï¼Œè§‚察者将ä¸�å†�接收å“�应事件,比如在onStop方法中å�¯ä»¥è°ƒç”¨æ­¤æ–¹æ³•结æ�Ÿè®¢é˜…。调用该方法å‰�,先使用 isUnsubscribed() 判断状æ€�,确定被观察者Observable是å�¦è¿˜æŒ�有观察者Subscriber的引用。 + 2.3 被观察者 + RxJava æ��供了多ç§�方法用于 创建被观察者对象Observable,这里介ç»�两ç§� - // ·½·¨1£ºjust(T...)£ºÖ±½Ó½«´«ÈëµÄ²ÎÊýÒÀ´Î·¢ËͳöÀ´ + // 方法1:just(T...):直接将传入的å�‚æ•°ä¾�次å�‘é€�出æ�¥ Observable observable = Observable.just("A", "B", "C"); - // ½«»áÒÀ´Îµ÷Ó㺠+ // 将会ä¾�次调用: // onNext("A"); // onNext("B"); // onNext("C"); // onCompleted(); - // ·½·¨2£ºfromArray(T[]) / from(Iterable) : ½«´«ÈëµÄÊý×é / Iterable ²ð·Ö³É¾ßÌå¶ÔÏóºó£¬ÒÀ´Î·¢ËͳöÀ´ + // 方法2:fromArray(T[]) / from(Iterable) : 将传入的数组 / Iterable 拆分æˆ�具体对象å�Žï¼Œä¾�次å�‘é€�出æ�¥ String[] words = {"A", "B", "C"}; Observable observable = Observable.fromArray(words); - // ½«»áÒÀ´Îµ÷Ó㺠+ // 将会ä¾�次调用: // onNext("A"); // onNext("B"); // onNext("C"); @@ -231,11 +231,11 @@ Subscriber -2.4 ¶©ÔÄ +2.4 订阅 - observable.subscribe(observer); //½¨Á¢¶©ÔĹØÏµ + observable.subscribe(observer); //建立订阅关系 @@ -245,25 +245,25 @@ Subscriber -2.5 °¸Àý +2.5 案例 public class RxJavaDemo { - // ReactiveX Java ÏìӦʽ±à³Ì¿ò¼Ü(android£© + // ReactiveX Java å“�应å¼�编程框架(android) // Java stream() java8 - //¹Û²ìÕßģʽ + //观察者模å¼� public static void main(String[] args) throws ExecutionException, InterruptedException { - final String[] datas = new String[]{"ʼþ1"}; - // ÃüÁîÖ´ÐÐÍêµÄ»Øµ÷²Ù×÷ ÖÕÖ¹ÃüÁîÇåÀí - //»áÔÚObservable½áÊøÇ°´¥·¢»Øµ÷¸Ãcall·½·¨£¬ÎÞÂÛÊÇÕý³£»¹ÊÇÒì³£ÖÕÖ¹ + final String[] datas = new String[]{"事件1"}; + // 命令执行完的回调æ“�作 终止命令清ç�† + //会在Observable结æ�Ÿå‰�触å�‘回调该call方法,无论是正常还是异常终止 final Action0 onComplated = new Action0() { @Override public void call() { - System.out.println("±»¹Û²ìÕßÒª½áÊøÁË"); + System.out.println("被观察者è¦�结æ�Ÿäº†"); } }; - //±»¹Û²ìÕß + //被观察者 Observable observable = Observable.defer(new Func0>() { @Override public Observable call() { @@ -271,25 +271,25 @@ Subscriber return observable1.doOnCompleted(onComplated); } }); - // Observable observable = Observable.just("ʼþ1","ʼþ2","½áÊø"); - //¹Û²ìÕß + // Observable observable = Observable.just("事件1","事件2","结æ�Ÿ"); + //观察者 Observer observer = new Observer() { @Override public void onCompleted() { - System.out.println("¶ÔComlateʼþ×ö³öÏìÓ¦"); + System.out.println("对Comlate事件å�šå‡ºå“�应"); } @Override public void onError(Throwable throwable) { - System.out.println("¶ÔErrorʼþ×÷³öÏìÓ¦"); + System.out.println("对Error事件作出å“�应"); } @Override public void onNext(Object o) { - System.out.println("¶ÔNextʼþ×÷³öÏìÓ¦:" + o); + System.out.println("对Next事件作出å“�应:" + o); } }; - observable.subscribe(observer); //½¨Á¢¶©ÔĹØÏµ + observable.subscribe(observer); //建立订阅关系 - // String s = observable.toBlocking().toFuture().get();//Òì²½µÈ´ý½á¹û + // String s = observable.toBlocking().toFuture().get();//异步等待结果 // System.out.println(s); } } @@ -302,17 +302,17 @@ Subscriber -OK£¬´óÌåµÄÖ¸µ¼ÈçºÎʹÓÃRxJava±à³ÌÁË£¬¼ÇÏÂÀ´ÎÒÃÇ¿ªÊ¼ß£Ô´Âë¡£ +OK,大体的指导如何使用RxJava编程了,记下æ�¥æˆ‘们开始撸æº�ç �。 -µÚ3Õ ԴÂë½âÎö -ÏÈÉϹÙÍøÌṩµÄÔ´ÂëÁ÷³Ìͼ£¬´ÓͼÉÏ¿ÉÒÔ¿´³öÀ´£¬Æäʵ¾ÍÊÇÏÈȥɨÃè´øÓÐHystrixCommand×¢½âµÄ·½·¨£¬È»ºó½øÐÐÇÐÃæÀ¹½Ø£¬Ö´ÐÐÇÐÃæµÄÂß¼­¡£Õâ¸öÇÐÃæ¶¨ÒåÁËÁ½¸ö·½·¨£ºexecuteºÍqueue£¬¶þѡһ½øÐе÷Óã¬È»ºó½øÈëÕæÕýµÄÀ¹½ØÂß¼­¡£ËùÒÔÈë¿ÚÊÇHystrixCommand×¢½â£¬¶ø¿ªÆôHystrixÊÇ@EnableHystrix×¢½â¡£ +第3ç«  æº�ç �è§£æž� +先上官网æ��供的æº�ç �æµ�程图,从图上å�¯ä»¥çœ‹å‡ºæ�¥ï¼Œå…¶å®žå°±æ˜¯å…ˆåŽ»æ‰«æ��带有HystrixCommand注解的方法,然å�Žè¿›è¡Œåˆ‡é�¢æ‹¦æˆªï¼Œæ‰§è¡Œåˆ‡é�¢çš„逻辑。这个切é�¢å®šä¹‰äº†ä¸¤ä¸ªæ–¹æ³•:executeå’Œqueue,二选一进行调用,然å�Žè¿›å…¥çœŸæ­£çš„æ‹¦æˆªé€»è¾‘。所以入å�£æ˜¯HystrixCommand注解,而开å�¯Hystrix是@EnableHystrix注解。 @SpringBootApplication @EnableFeignClients("com.example.clients") - //@EnableDiscoveryClient //×¢Ïú±íʾUser·þÎñ²»×¢²á - @EnableHystrix //×¢½â·½Ê½¿ªÆôHystrix + //@EnableDiscoveryClient //注销表示Useræœ�务ä¸�注册 + @EnableHystrix //注解方å¼�å¼€å�¯Hystrix public class HystrixEclipseUserApplication { public static void main(String[] args) { @@ -329,7 +329,7 @@ OK -½øÈëµ½@EnableHystrix×¢½âÖÐ +进入到@EnableHystrix注解中 @@ -340,7 +340,7 @@ OK @EnableCircuitBreaker public @interface EnableHystrix { } - //×îÖÕ@EnableHystrix¼Ì³ÐÁË@EnableCircuitBreaker + //最终@EnableHystrix继承了@EnableCircuitBreaker @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @@ -357,8 +357,8 @@ OK -¿´µ½Õâ²½´úÂ룬ÎÒÏàÐźܶàѧ¹ýspringbootµÄͬѧ¶¼ºÜÊìϤÁË£¬ÕâÀïÓõ½ÁËImport×¢½â£¬Äǿ϶¨ÊÇÒý½øÀ´Ò»Ð©ÅäÖÃÀàÁË£¬È»ºóÎÒÃÇÔÙ½ø -EnableCircuitBreakerImportSelectorÀàÖÐ; +看到这步代ç �,我相信很多学过springbootçš„å�Œå­¦éƒ½å¾ˆç†Ÿæ‚‰äº†ï¼Œè¿™é‡Œç”¨åˆ°äº†Import注解,那肯定是引进æ�¥ä¸€äº›é…�置类了,然å�Žæˆ‘们å†�è¿› +EnableCircuitBreakerImportSelector类中; @@ -380,7 +380,7 @@ EnableCircuitBreakerImportSelector -EnableCircuitBreakerImportSelector¼Ì³ÐÁËSpringFactoryImportSelector£¬½øÈëSpringFactoryImportSelectorÀàºó·¢ÏÖÊÇÎÒÃÇÊìϤµÄ´úÂ룬ËüʵÏÖÁËDeferredImportSelector½Ó¿Ú£¬ÊµÏÖÁËselectImports·½·¨£¬selectImports·½·¨»á´ÓÅäÖÃÎļþspring.factoriesÀï¼ÓÔØ¶ÔÓ¦µÄÀà org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker£¬ÎÒÃÇÀ´¿´¿´spring.facotriesÎļþ¡£ +EnableCircuitBreakerImportSelector继承了SpringFactoryImportSelector,进入SpringFactoryImportSelectorç±»å�Žå�‘现是我们熟悉的代ç �,它实现了DeferredImportSelector接å�£ï¼Œå®žçŽ°äº†selectImports方法,selectImports方法会从é…�置文件spring.factories里加载对应的类 org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker,我们æ�¥çœ‹çœ‹spring.facotries文件。 @@ -400,14 +400,14 @@ EnableCircuitBreakerImportSelector -¶ÔÓ¦EnableAutoConfigurationµÄÕâЩʵÏÖÀàÔÚspringÆô¶¯µÄʱºòͨ¹ý×Ô¶¯×°Åä»úÖÆ»áȥʵÀý»¯²¢ÇÒ×¢Èëµ½IoCÈÝÆ÷ÖУ¬ÕâÀïÎÒÃǺËÐĹØ×¢ -HystrixCircuitBreakerConfigurationÀà¡£ +对应EnableAutoConfiguration的这些实现类在springå�¯åŠ¨çš„æ—¶å€™é€šè¿‡è‡ªåŠ¨è£…é…�机制会去实例化并且注入到IoC容器中,这里我们核心关注 +HystrixCircuitBreakerConfiguration类。 @Configuration(proxyBeanMethods = false) public class HystrixCircuitBreakerConfiguration { - //ÕâÀïÊǺËÐĵÄÇÐÃæbean + //这里是核心的切é�¢bean @Bean public HystrixCommandAspect hystrixCommandAspect() { return new HystrixCommandAspect(); @@ -423,7 +423,7 @@ HystrixCircuitBreakerConfiguration -½øÈëµ½Õâ¸öÇÐÃæÀàÖлᷢÏÖ£¬Õâ¸öÇÐÃæÖ÷ÒªÕë¶ÔÁËÁ½¸ö×¢½â×÷ΪÇÐÈëµã@HystrixCommandºÍ@HystrixCollapser£¬µ±Ö´ÐÐÕâÁ½¸ö×¢½âÐÞÊεķ½·¨Ê±£¬»á±»À¹½ØÖ´ÐÐ +进入到这个切é�¢ç±»ä¸­ä¼šå�‘现,这个切é�¢ä¸»è¦�针对了两个注解作为切入点@HystrixCommandå’Œ@HystrixCollapser,当执行这两个注解修饰的方法时,会被拦截执行 methodsAnnotatedWithHystrixCommand 3.1 HystrixCommandAspect @@ -434,53 +434,53 @@ methodsAnnotatedWithHystrixCommand public class HystrixCommandAspect { private static final Map META_HOLDER_FACTORY_MAP; static { - //ͨ¹ý¾²Ì¬·½·¨½«Á½¸ö×¢½âµÄÁ½¸ö¹¤³§ÊµÀý»¯ + //通过é�™æ€�方法将两个注解的两个工厂实例化 META_HOLDER_FACTORY_MAP = ImmutableMap.builder() .put(HystrixPointcutType.COMMAND, new CommandMetaHolderFactory()) .put(HystrixPointcutType.COLLAPSER, new CollapserMetaHolderFactory()) .build(); } - //¶¨ÒåÇÐÈëµã×¢½âHystrixCommand + //定义切入点注解HystrixCommand @Pointcut("@annotation(com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand)") public void hystrixCommandAnnotationPointcut() { } - //¶¨ÒåÇÐÈëµã×¢½âHystrixCollapser£¨ÇëÇóºÏ²¢£© + //定义切入点注解HystrixCollapser(请求å�ˆå¹¶ï¼‰ @Pointcut("@annotation(com.netflix.hystrix.contrib.javanica.annotation.HystrixCollapser)") public void hystrixCollapserAnnotationPointcut() { } - //»·ÈÆÍ¨Öª + //环绕通知 @Around("hystrixCommandAnnotationPointcut() || hystrixCollapserAnnotationPointcut()") public Object methodsAnnotatedWithHystrixCommand(final ProceedingJoinPoint joinPoint) throws Throwable { - //»ñȡĿ±ê·½·¨ + //获å�–目标方法 Method method = getMethodFromTarget(joinPoint); Validate.notNull(method, "failed to get method from joinPoint: %s", joinPoint); - //Ö»´¦ÀíÕâÁ½ÖÖ×¢½â±ê×¢µÄ·½·¨ + //å�ªå¤„ç�†è¿™ä¸¤ç§�注解标注的方法 if (method.isAnnotationPresent(HystrixCommand.class) && method.isAnnotationPresent(HystrixCollapser.class)) { throw new IllegalStateException("method cannot be annotated with HystrixCommand and HystrixCollapser " + "annotations at the same time"); } - //¸ù¾Ý²»Í¬µÄ×¢½â£¬Ñ¡Ôñ¶ÔÓ¦µÄmetaHolderFactory, ´´½¨MetaHolder, MetaHolder ÀïÃæ°üº¬ÁËËùÓÐÐÅÏ¢ + //æ ¹æ�®ä¸�å�Œçš„æ³¨è§£ï¼Œé€‰æ‹©å¯¹åº”çš„metaHolderFactory, 创建MetaHolder, MetaHolder 里é�¢åŒ…å�«äº†æ‰€æœ‰ä¿¡æ�¯ MetaHolderFactory metaHolderFactory = META_HOLDER_FACTORY_MAP.get(HystrixPointcutType.of(method)); - //»ñȡĿ±ê·½·¨µÄµÄÔªÊý¾Ý£¬·½·¨Ç©Ãû£¬²ÎÊýµÈ + //获å�–目标方法的的元数æ�®ï¼Œæ–¹æ³•ç­¾å��,å�‚æ•°ç­‰ MetaHolder metaHolder = metaHolderFactory.create(joinPoint); /** - * ´´½¨´¦ÀíÆ÷CommandCollapser »ò GenericCommand £¨Í¬²½£© »òGenericObservableCommand£¨Òì²½£© - * GenericCommandÀïÓкܶàsuper£¬×îÖÕͨ¹ýHystrixCommandBuilderFactory.getInstance().create(metaHolder) ¹¹½¨ÁËÒ»¸öHystrixCommandBuilder×÷ΪGenericCommadµÄ²ÎÊý - * new GenericCommand ͨ¹ýsuperµ½AbstractHystrixCommand£¬ - * AbstractHystrixCommand ͨ¹ýsuperµ½HystrixCommand£¬ - * HystrixCommand×îÖÕµ½ÁËAbstractCommand һ·´«µÝ - * Ò»»áÔÚAbstractCommandÖзÖÎöÏ + * 创建处ç�†å™¨CommandCollapser 或 GenericCommand (å�Œæ­¥ï¼‰ 或GenericObservableCommand(异步) + * GenericCommand里有很多super,最终通过HystrixCommandBuilderFactory.getInstance().create(metaHolder) 构建了一个HystrixCommandBuilder作为GenericCommadçš„å�‚æ•° + * new GenericCommand 通过super到AbstractHystrixCommand, + * AbstractHystrixCommand 通过super到HystrixCommand, + * HystrixCommand最终到了AbstractCommand 一路传递 + * 一会在AbstractCommand中分æž�下 */ HystrixInvokable invokable = HystrixCommandFactory.getInstance().create(metaHolder); - //¸ù¾Ý·µ»ØÖµÍƶÏÖ´ÐÐÀàÐÍ + //æ ¹æ�®è¿”回值推断执行类型 ExecutionType executionType = metaHolder.isCollapserAnnotationPresent() ? metaHolder.getCollapserExecutionType() : metaHolder.getExecutionType(); - //¸ù¾Ý²»Í¬µÄÃüÁîÀàÐÍ£¬Ö´ÐÐÃüÁ·µ»Ø½á¹û + //æ ¹æ�®ä¸�å�Œçš„命令类型,执行命令,返回结果 Object result; try { - //ÊÇ·ñÊÇÏìӦʽµÄ£¨ÓÉÓÚÎÒÃÇÕâЩ¶¼ÊÇͬ²½µÄ»á×ßÕâ¸öÂß¼­£© + //是å�¦æ˜¯å“�应å¼�的(由于我们这些都是å�Œæ­¥çš„会走这个逻辑) if (!metaHolder.isObservable()) { - //executeÖ´ÐÐ + //execute执行 result = CommandExecutor.execute(invokable, executionType, metaHolder); } else { result = executeObservable(invokable, executionType, metaHolder); @@ -492,29 +492,29 @@ methodsAnnotatedWithHystrixCommand } return result; } - //HystrixCommandµÄʱºòMetaHolderµÄ´´½¨ + //HystrixCommand的时候MetaHolder的创建 private static class CommandMetaHolderFactory extends MetaHolderFactory { @Override public MetaHolder create(Object proxy, Method method, Object obj, Object[] args, final ProceedingJoinPoint joinPoint) { - //»ñȡע½âHystrixCommand + //获å�–注解HystrixCommand HystrixCommand hystrixCommand = method.getAnnotation(HystrixCommand.class); - //¸ù¾Ý·µ»Ø½á¹ûÍÆ¶ÏÈÎÎñÀàÐÍ£¬¿ÉÒÔÖªµÀÒÔÄÄÖÖ·½Ê½Ö´ÐÐ + //æ ¹æ�®è¿”回结果推断任务类型,å�¯ä»¥çŸ¥é�“以哪ç§�æ–¹å¼�执行 ExecutionType executionType = ExecutionType.getExecutionType(method.getReturnType()); MetaHolder.Builder builder = metaHolderBuilder(proxy, method, obj, args, joinPoint); if (isCompileWeaving()) { builder.ajcMethod(getAjcMethodFromTarget(joinPoint)); } - //ÕâÀïûÓжàÉÙ²ÎÊý£¬×îÖØÒªµÄÒ»¸öhystrixCommand£¬ÄãÔÚ×¢½âÀï¼ÓÁËʲô + //这里没有多少å�‚数,最é‡�è¦�的一个hystrixCommand,你在注解里加了什么 return builder.defaultCommandKey(method.getName()) .hystrixCommand(hystrixCommand) - .observableExecutionMode(hystrixCommand.observableExecutionMode()) //Ö´ÐÐģʽ - .executionType(executionType) //Ö´Ðз½Ê½ + .observableExecutionMode(hystrixCommand.observableExecutionMode()) //执行模å¼� + .executionType(executionType) //执行方å¼� .observable(ExecutionType.OBSERVABLE == executionType) .build(); } } } - //ÔÚö¾ÙExecutionTypeÀàÀï + //在枚举ExecutionType类里 public static ExecutionType getExecutionType(Class type) { if (Future.class.isAssignableFrom(type)) { return ExecutionType.ASYNCHRONOUS; @@ -533,7 +533,7 @@ methodsAnnotatedWithHystrixCommand -ÎÒÃÇÖØµã·ÖÎöÏÂͬ²½´¦Àí£¬Í¨¹ý´úÂëÎÒÃÇ¿ÉÒÔ¿´µ½HystrixInvokable ÊÇ GenericCommand£¬ÎÒÃÇͬ²½ÀïµÄ¿´Ï CommandExecutor.execute(invokable, executionType, metaHolder) +我们é‡�点分æž�下å�Œæ­¥å¤„ç�†ï¼Œé€šè¿‡ä»£ç �我们å�¯ä»¥çœ‹åˆ°HystrixInvokable 是 GenericCommand,我们å�Œæ­¥é‡Œçš„看下 CommandExecutor.execute(invokable, executionType, metaHolder) @@ -544,13 +544,13 @@ methodsAnnotatedWithHystrixCommand switch (executionType) { case SYNCHRONOUS: { - //ÖØµã¿´Í¬²½´¦ÀíÕâ¸ö£¬ÏȰÑGenericCommand ת³ÉHystrixExecutable ÔÙÖ´ÐÐexecute + //é‡�点看å�Œæ­¥å¤„ç�†è¿™ä¸ªï¼Œå…ˆæŠŠGenericCommand 转æˆ�HystrixExecutable å†�执行execute return castToExecutable(invokable, executionType).execute(); } case ASYNCHRONOUS: { - // ǿת³ÉHystrixExecutable Òì²½Ö´ÐÐ + // 强转æˆ�HystrixExecutable 异步执行 HystrixExecutable executable = castToExecutable(invokable, executionType); - // Èç¹ûÓÐ fallback·½·¨£¬ÇÒÊÇÒì²½Ö´ÐУ¬ÔòÖ´Ðв¢·µ»Ø°ü×°½á¹û + // 如果有 fallback方法,且是异步执行,则执行并返回包装结果 if (metaHolder.hasFallbackMethodCommand() && ExecutionType.ASYNCHRONOUS == metaHolder.getFallbackExecutionType()) { return new FutureDecorator(executable.queue()); @@ -558,9 +558,9 @@ methodsAnnotatedWithHystrixCommand return executable.queue(); } case OBSERVABLE: { - // ǿת³É HystrixObservable + // 强转æˆ� HystrixObservable HystrixObservable observable = castToObservable(invokable); - // ÅжÏÖ´ÐÐģʽÊDz»ÊǼ±ÇÐ/ÀÁ¶è£¬À´Ñ¡ÔñģʽִÐÐ + // 判断执行模å¼�是ä¸�是急切/懒惰,æ�¥é€‰æ‹©æ¨¡å¼�执行 return ObservableExecutionMode.EAGER == metaHolder.getObservableExecutionMode() ? observable.observe() : observable.toObservable(); } default: @@ -577,33 +577,33 @@ methodsAnnotatedWithHystrixCommand -Õâ¸ö·½·¨Ö÷ÒªÓÃÀ´Ö´ÐÐÃüÁ´Ó´úÂëÖпÉÒÔ¿´³öÕâÀïÓÐÈý¸öÖ´ÐÐÀàÐÍ£¬·Ö±ðÊÇͬ²½¡¢Òì²½¡¢ÒÔ¼°ÏìӦʽ¡£ÆäÖУ¬ÏìӦʽÓÖ·ÖΪCold Observable£¨observable.toObservable()£© ºÍ HotObservable£¨observable.observe()£©Ä¬ÈϵÄexecutionType=SYNCHRONOUS £¬Í¬²½ÇëÇó¡£ +这个方法主è¦�用æ�¥æ‰§è¡Œå‘½ä»¤ï¼Œä»Žä»£ç �中å�¯ä»¥çœ‹å‡ºè¿™é‡Œæœ‰ä¸‰ä¸ªæ‰§è¡Œç±»åž‹ï¼Œåˆ†åˆ«æ˜¯å�Œæ­¥ã€�异步ã€�以å�Šå“�应å¼�。其中,å“�应å¼�å�ˆåˆ†ä¸ºCold Observable(observable.toObservable()) å’Œ HotObservable(observable.observe())默认的executionType=SYNCHRONOUS ,å�Œæ­¥è¯·æ±‚。 -- execute()£ºÍ¬²½Ö´ÐУ¬·µ»ØÒ»¸öµ¥Ò»µÄ¶ÔÏó½á¹û£¬·¢Éú´íÎóʱÅ׳öÒì³£¡£ -- queue()£ºÒì²½Ö´ÐУ¬·µ»ØÒ»¸ö Future ¶ÔÏ󣬰üº¬×ÅÖ´ÐнáÊøºó·µ»ØµÄµ¥Ò»½á¹û¡£ -- observe()£ºÕâ¸ö·½·¨·µ»ØÒ»¸ö Observable ¶ÔÏó£¬Ëü´ú±í²Ù×÷µÄ¶à¸ö½á¹û£¬µ«ÊÇÒѾ­±»¶©ÔÄÕßÏû·ÑµôÁË¡£ -- toObservable()£ºÕâ¸ö·½·¨·µ»ØÒ»¸ö Observable ¶ÔÏó£¬Ëü´ú±í²Ù×÷µÄ¶à¸ö½á¹û£¬ÐèÒªÔÛÃÇ×Ô¼ºÊÖ¶¯¶©ÔIJ¢Ïû·Ñµô¡£ - Ààͼ¹ØÏµÈçÏ£º +- execute():å�Œæ­¥æ‰§è¡Œï¼Œè¿”回一个å�•一的对象结果,å�‘生错误时抛出异常。 +- queue():异步执行,返回一个 Future 对象,包å�«ç�€æ‰§è¡Œç»“æ�Ÿå�Žè¿”回的å�•一结果。 +- observe():这个方法返回一个 Observable 对象,它代表æ“�作的多个结果,但是已ç»�被订阅者消费掉了。 +- toObservable():这个方法返回一个 Observable 对象,它代表æ“�作的多个结果,需è¦�咱们自己手动订阅并消费掉。 + 类图关系如下: -ͨ¹ýGenericCommandÒ»²ã²ãµÄÍùÉÏ·­£¬×îÖÕ¶¨Î»µ½HystrixCommandÓиöexecute() +通过GenericCommand一层层的往上翻,最终定ä½�到HystrixCommand有个execute() public abstract class HystrixCommand extends AbstractCommand implements HystrixExecutable, HystrixInvokableInfo, HystrixObservable { - //ͬ²½Ö´ÐÐ + //å�Œæ­¥æ‰§è¡Œ public R execute() { try { - //ͨ¹ýqueue().get()À´Í¬²½Ö´ÐУ¨·â×°Òì²½´¦ÀíµÄ½á¹û£© + //通过queue().get()æ�¥å�Œæ­¥æ‰§è¡Œï¼ˆå°�装异步处ç�†çš„结果) return queue().get(); } catch (Exception e) { throw Exceptions.sneakyThrow(decomposeException(e)); } } - //Òì²½Ö´ÐУ¬Ê²Ã´Ê±ºòget()£¬Óɵ÷ÓÃÕß¾ö¶¨£¬get()µÄʱºò»á×èÈû + //异步执行,什么时候get(),由调用者决定,get()的时候会阻塞 public Future queue() { - //ºËÐÄ´¦Àí£¬×îÖÕ¶¨Î»µ½ÁËAbstractCommandÀïµÄtoObservable()Àï - // toObservableת»»ÎªObservable,toBlockingת»»ÎªBlockingObservable, - // toFutureת»»ÎªFuture,Íê³ÉÁËObservableµÄ´´½¨ºÍ¶©ÔÄ + //核心处ç�†ï¼Œæœ€ç»ˆå®šä½�到了AbstractCommand里的toObservable()里 + // toObservable转æ�¢ä¸ºObservable,toBlocking转æ�¢ä¸ºBlockingObservable, + // toFuture转æ�¢ä¸ºFuture,完æˆ�了Observable的创建和订阅 final Future delegate = toObservable().toBlocking().toFuture(); final Future f = new Future() { ..... @@ -616,7 +616,7 @@ methodsAnnotatedWithHystrixCommand return delegate.get(timeout, unit); } }; - //ÌØÊâ´¦ÀíÁËÏ£¬ÒѾ­Ö´ÐÐÍêÁË£¬get()Ò²²»»á×èÈûÁË + //特殊处ç�†äº†ä¸‹ï¼Œå·²ç»�执行完了,get()也ä¸�会阻塞了 if (f.isDone()) { try { f.get(); @@ -637,44 +637,44 @@ methodsAnnotatedWithHystrixCommand -ÔÚÉÏÊö´úÂëÖУ¬ÖصãÀ´ÁË£¬¹¹½¨ÁËÒ»¸ö -java.util.concurrent.Future £¬È»ºóµ÷Óà getµÄʱºòίÅɸø delegate£¬¶ø delegateÀ´×ÔÓÚ toObservable().toBlocking().toFuture(); ÕâÕýÊÇÎÒÃÇÉÏÃæÀý×ÓÀïÃæµÃ´úÂë¡£ËùÒÔÏÖÔÚµÄÖØµãÓ¦¸Ã·ÅÔÚ toObservable() ·½·¨ÖУº +在上述代ç �中,é‡�点æ�¥äº†ï¼Œæž„建了一个 +java.util.concurrent.Future ,然å�Žè°ƒç”¨ get的时候委派给 delegate,而 delegateæ�¥è‡ªäºŽ toObservable().toBlocking().toFuture(); 这正是我们上é�¢ä¾‹å­�里é�¢å¾—代ç �。所以现在的é‡�点应该放在 toObservable() 方法中: 3.2 toObservable -ͨ¹ýObservable¶¨ÒåÒ»¸ö±»¹Û²ìÕߣ¬Õâ¸ö±»¹Û²ìÕ߻ᱻtoObservable().toBlocking().toFuture() £¬Êµ¼ÊÉÏÕâÐдúÂëµÄºËÐĺ¬Òå¾ÍÊÇÈ¥¸ù¾ÝһЩÈÛ¶ÏÂß¼­ÅжÏÊÇÖ´ÐÐÕæÊµµÄÒµÎñÂß¼­»¹ÊÇÖ´ÐÐfallbackµÄ»Øµ÷·½·¨£¬È»ºó½«½á¹û·µ»Ø¸øFuture¡£ÀïÃæµÄ run() ·½·¨¾ÍÊÇÖ´ÐÐÕý³£µÄÒµÎñÂß¼­¡£Õâ¸ö·½·¨Ö÷Òª×öÁËÒÔϼ¸¼þÊ£º +通过Observable定义一个被观察者,这个被观察者会被toObservable().toBlocking().toFuture() ,实际上这行代ç �的核心å�«ä¹‰å°±æ˜¯åŽ»æ ¹æ�®ä¸€äº›ç†”断逻辑判断是执行真实的业务逻辑还是执行fallback的回调方法,然å�Žå°†ç»“果返回给Future。里é�¢çš„ run() 方法就是执行正常的业务逻辑。这个方法主è¦�å�šäº†ä»¥ä¸‹å‡ ä»¶äº‹ï¼š -- ´´½¨Ò»¶ÑµÄ¶¯×÷£¬ÎÒÒ²²»ÖªµÀÕâЩ¶¯×÷ÊǸÉɶµÄ£¬²»ÖØÒª¡£ -- ÅжÏÊÇ·ñ¿ªÆôÁË»º´æ£¬Èç¹û¿ªÁË£¬¶øÇÒÒ²ÃüÖÐÁË£¬¾ÍÈ¥»º´æÀïÃæÒÔObservableÐÎʽ·µ»ØÒ»¸ö»º´æ½á¹û -- ´´½¨Ò»¸ö±»¹Û²ìÕߣ¬Õâ¸ö±»¹Û²ìÕߺóÃæ»áÈ¥»Øµ÷ÕæÊµÒµÎñÂß¼­»òÕßfallback¡£ +- 创建一堆的动作,我也ä¸�知é�“这些动作是干啥的,ä¸�é‡�è¦�。 +- 判断是å�¦å¼€å�¯äº†ç¼“存,如果开了,而且也命中了,就去缓存里é�¢ä»¥Observableå½¢å¼�返回一个缓存结果 +- 创建一个被观察者,这个被观察者å�Žé�¢ä¼šåŽ»å›žè°ƒçœŸå®žä¸šåŠ¡é€»è¾‘æˆ–è€…fallback。 -ºËÐÄÂß¼­ÊÇÕâ¸ö±»¹Û²ìÕß»áÈ¥Ö´ÐÐapplyHystrixSemanticsÀïÃæµÄ¶¯×÷ +核心逻辑是这个被观察者会去执行applyHystrixSemantics里é�¢çš„动作 public Observable toObservable() { final AbstractCommand _cmd = this; - // ÃüÁîÖ´ÐÐÍêµÄ»Øµ÷²Ù×÷ ÖÕÖ¹ÃüÁîÇåÀí - //»áÔÚObservable½áÊøÇ°´¥·¢»Øµ÷¸Ãcall·½·¨£¬ÎÞÂÛÊÇÕý³£»¹ÊÇÒì³£ÖÕÖ¹ + // 命令执行完的回调æ“�作 终止命令清ç�† + //会在Observable结æ�Ÿå‰�触å�‘回调该call方法,无论是正常还是异常终止 final Action0 terminateCommandCleanup = new Action0() { ... }; - // ½«ÃüÁî±ê¼ÇΪÒÑÈ¡Ïû²¢´æ´¢ÑÓ³Ù£¨³ýÁ˱ê×¼ÇåÀí£© - //È¡Ïû¶©ÔÄʱµÄ¼àÌý»á½øÐлص÷¸Ã call·½·¨ + // 将命令标记为已å�–消并存储延迟(除了标准清ç�†ï¼‰ + //å�–消订阅时的监å�¬ä¼šè¿›è¡Œå›žè°ƒè¯¥ call方法 final Action0 unsubscribeCommandCleanup = new Action0() { @Override public void call() { ... } }; - // Ö´ÐÐÃüÁîʱµÄ»Øµ÷ + // 执行命令时的回调 final Func0> applyHystrixSemantics = new Func0>() { @Override public Observable call() { if (commandState.get().equals(CommandState.UNSUBSCRIBED)) { - // Á¢¼´ÖÕÖ¹Õû¸öÁ÷³Ì¡£ + // ç«‹å�³ç»ˆæ­¢æ•´ä¸ªæµ�程。 return Observable.never(); } - //·µ»ØÖ´ÐÐÃüÁîµÄObservable + //返回执行命令的Observable return applyHystrixSemantics(_cmd); } }; @@ -690,30 +690,30 @@ java.util.concurrent.Future ... } }; - // ´´½¨Observable,ÉèÖø÷ÖÖ´¦Àí²Ù×÷ + // 创建Observable,设置å�„ç§�处ç�†æ“�作 return Observable.defer(new Func0>() { @Override public Observable call() { - // ÉèÖÃÒÑÆô¶¯±êÖ¾, CAS±£Ö¤ÃüÁîÖ»Ö´ÐÐÒ»´Î + // 设置已å�¯åŠ¨æ ‡å¿—, CASä¿�è¯�命令å�ªæ‰§è¡Œä¸€æ¬¡ if (!commandState.compareAndSet(CommandState.NOT_STARTED, CommandState.OBSERVABLE_CHAIN_CREATED)) { IllegalStateException ex = new IllegalStateException("This instance can only be executed once. Please instantiate a new instance."); //TODO make a new error type for this throw new HystrixRuntimeException(FailureType.BAD_REQUEST_EXCEPTION, _cmd.getClass(), getLogMessagePrefix() + " command executed multiple times - this is not permitted.", ex, null); } - // ÃüÁʼʱ¼ä´Á + // 命令开始时间戳 commandStartTimestamp = System.currentTimeMillis(); - // ´òÓ¡ÈÕÖ¾ + // 打å�°æ—¥å¿— if (properties.requestLogEnabled().get()) { // log this command execution regardless of what happened if (currentRequestLog != null) { currentRequestLog.addExecutedCommand(_cmd); } } - // »º´æ¿ª¹Ø£¬»º´æKEY£¨Õâ¸öÊÇHystrixÖÐÇëÇ󻺴湦ÄÜ£¬hystrixÖ§³Ö½«Ò»¸öÇëÇó½á¹û»º´æÆðÀ´£¬ - // ÏÂÒ»¸ö¾ßÓÐÏàͬkeyµÄÇëÇó½«Ö±½Ó´Ó»º´æÖÐÈ¡³ö½á¹û£¬¼õÉÙÇëÇó¿ªÏú£© + // 缓存开关,缓存KEY(这个是Hystrix中请求缓存功能,hystrix支æŒ�将一个请求结果缓存起æ�¥ï¼Œ + // 下一个具有相å�Œkey的请求将直接从缓存中å�–出结果,å‡�少请求开销) final boolean requestCacheEnabled = isRequestCachingEnabled(); final String cacheKey = getCacheKey(); - // Èç¹ûÅäÖÃÔÊÐí»º´æ£¬ÏÈÊÔͼ´Ó»º´æ»ñÈ¡£¬Ä¬ÈÏ false + // 如果é…�ç½®å…�许缓存,先试图从缓存获å�–,默认 false if (requestCacheEnabled) { HystrixCommandResponseFromCache fromCache = (HystrixCommandResponseFromCache) requestCache.get(cacheKey); if (fromCache != null) { @@ -721,13 +721,13 @@ java.util.concurrent.Future return handleRequestCacheHitAndEmitValues(fromCache, _cmd); } } - // ÉùÃ÷Ö´ÐÐÃüÁîµÄObservable - // ´´½¨Observable, applyHystrixSemantics() À´Éú³ÉObservable + // 声明执行命令的Observable + // 创建Observable, applyHystrixSemantics() æ�¥ç”Ÿæˆ�Observable Observable hystrixObservable = Observable.defer(applyHystrixSemantics) .map(wrapWithAllOnNextHooks); Observable afterCache; - // put in cache ±£´æÇëÇó½á¹ûµ½»º´æÖÐ + // put in cache ä¿�存请求结果到缓存中 if (requestCacheEnabled && cacheKey != null) { // wrap it for caching HystrixCachedObservable toCache = HystrixCachedObservable.from(hystrixObservable, _cmd); @@ -744,13 +744,13 @@ java.util.concurrent.Future } else { afterCache = hystrixObservable; } - // ÉúÃüÖÜÆÚ»Øµ÷ÉèÖà + // 生命周期回调设置 return afterCache - //»áÔÚObservable½áÊøÇ°´¥·¢»Øµ÷£¬ÎÞÂÛÊÇÕý³£»¹ÊÇÒì³£ÖÕÖ¹ + //会在Observable结æ�Ÿå‰�触å�‘回调,无论是正常还是异常终止 .doOnTerminate(terminateCommandCleanup) - //È¡Ïû¶©ÔÄʱµÄ¼àÌý + //å�–消订阅时的监å�¬ .doOnUnsubscribe(unsubscribeCommandCleanup) - //ObservableÕý³£ÖÕֹʱµÄ¼àÌý + //Observable正常终止时的监å�¬ .doOnCompleted(fireOnCompletedHook); } }); @@ -764,7 +764,7 @@ java.util.concurrent.Future -½ÓÏÂÀ´¿´¿´ºËÐÄÂß¼­applyHystrixSemantics +接下æ�¥çœ‹çœ‹æ ¸å¿ƒé€»è¾‘applyHystrixSemantics @@ -800,15 +800,15 @@ java.util.concurrent.Future -ÕâÀï´«ÈëµÄ_cmdÊÇÒ»¸öGenericCommand£¬×îÖÕ»áÖ´Ðе½Õâ¸öGenericCommandÖеÄrun·½·¨¡£ +这里传入的_cmd是一个GenericCommand,最终会执行到这个GenericCommand中的run方法。 -circuitBreaker.allowRequest() Õâ¸öÊÇÅжÏÊÇ·ñ´¦ÓÚÈÛ¶Ï״̬µÄ£¬true±íʾûÓд¦ÓÚÈÛ¶Ï״̬£¬Õý³£Ö´ÐУ¬·ñÔò£¬µ÷Óà handleShortCircuitViaFallback ʵÏÖ·þÎñ½µ¼¶£¬×îÖÕ»á»Øµ÷µ½ÎÒÃÇ×Ô¶¨ÒåµÄfallback·½·¨ÖС£ +circuitBreaker.allowRequest() 这个是判断是å�¦å¤„于熔断状æ€�的,true表示没有处于熔断状æ€�,正常执行,å�¦åˆ™ï¼Œè°ƒç”¨ handleShortCircuitViaFallback 实现æœ�务é™�级,最终会回调到我们自定义的fallback方法中。 -Èç¹ûµ±Ç°hystrix´¦ÓÚδÈÛ¶Ï״̬£¬Ôò +如果当å‰�hystrix处于未熔断状æ€�,则 -- getExecutionSemaphore Åжϵ±Ç°²ßÂÔÊÇ·ñΪÐźÅÁ¿»¹ÊÇÏ̳߳أ¬ÏÔȻĬÈÏÊÇÏ̳߳أ¬È»ºóÔÙµ÷ÓÃtryAcquireʱдËÀÁËΪtrue¡£ +- getExecutionSemaphore 判断当å‰�策略是å�¦ä¸ºä¿¡å�·é‡�还是线程池,显然默认是线程池,然å�Žå†�调用tryAcquire时写死了为true。 -µ÷ÓÃexecuteCommandAndObserve¡£ +调用executeCommandAndObserve。 @@ -816,13 +816,13 @@ circuitBreaker.allowRequest() executionHook.onStart(_cmd); - // ÊÇ·ñÔÊÐíÇëÇ󣬼´¶Ï·Æ÷ÊÇ·ñ¿ªÆô £¬ÕâÀïÒ²Óкü¸ÖÖÇé¿ö + // 是å�¦å…�许请求,å�³æ–­è·¯å™¨æ˜¯å�¦å¼€å�¯ ,这里也有好几ç§�情况 if (circuitBreaker.allowRequest()) { - // ÐźÅÁ¿»ñÈ¡ + // ä¿¡å�·é‡�获å�– final TryableSemaphore executionSemaphore = getExecutionSemaphore(); final AtomicBoolean semaphoreHasBeenReleased = new AtomicBoolean(false); - // ÐźÅÊͷŻص÷ + // ä¿¡å�·é‡Šæ”¾å›žè°ƒ final Action0 singleSemaphoreRelease = new Action0() { @Override public void call() { @@ -832,7 +832,7 @@ circuitBreaker.allowRequest() } }; - // Òì³£»Øµ÷ + // 异常回调 final Action1 markExceptionThrown = new Action1() { @Override public void call(Throwable t) { @@ -840,12 +840,12 @@ circuitBreaker.allowRequest() } }; - // »ñÈ¡Ðźţ¬²¢·µ»Ø¶ÔÓ¦µÄ Observable - // ÊÇ·ñ¿ªÆôÐźÅÁ¿×ÊÔ´¸ôÀ룬δÅäÖÃ×ß com.netflix.hystrix.AbstractCommand.TryableSemaphoreNoOp#tryAcquire ĬÈÏ·µ»ØÍ¨¹ý + // 获å�–ä¿¡å�·ï¼Œå¹¶è¿”回对应的 Observable + // 是å�¦å¼€å�¯ä¿¡å�·é‡�资æº�隔离,未é…�置走 com.netflix.hystrix.AbstractCommand.TryableSemaphoreNoOp#tryAcquire 默认返回通过 if (executionSemaphore.tryAcquire()) { try { executionResult = executionResult.setInvocationStartTime(System.currentTimeMillis()); - return executeCommandAndObserve(_cmd) // Ö´ÐÐÃüÁÒÔÏÂÈý¸öÊǻص÷£¬¿ÉÒÔ²»¿´ + return executeCommandAndObserve(_cmd) // 执行命令,以下三个是回调,å�¯ä»¥ä¸�看 .doOnError(markExceptionThrown) .doOnTerminate(singleSemaphoreRelease) .doOnUnsubscribe(singleSemaphoreRelease); @@ -853,11 +853,11 @@ circuitBreaker.allowRequest() return Observable.error(e); } } else { - // »ñÈ¡ÐźÅʧ°ÜÔò½µ¼¶ + // 获å�–ä¿¡å�·å¤±è´¥åˆ™é™�级 return handleSemaphoreRejectionViaFallback(); } } else { - // ¶Ï·Æ÷ÒÑ´ò¿ª£¬Ö±½Ó½µ¼¶ + // 断路器已打开,直接é™�级 return handleShortCircuitViaFallback(); } } @@ -870,7 +870,7 @@ circuitBreaker.allowRequest() -ÏÈÀ´¿´Ò»ÏÂÖ´ÐÐʧ°Ü½øÈë½µ¼¶µÄÂß¼­£¬ÕâÀïÎÒÃÇÖ±½Ó½øÈëµ½ HystrixCommand#getFallbackObservable +å…ˆæ�¥çœ‹ä¸€ä¸‹æ‰§è¡Œå¤±è´¥è¿›å…¥é™�级的逻辑,这里我们直接进入到 HystrixCommand#getFallbackObservable @@ -898,21 +898,21 @@ circuitBreaker.allowRequest() -ÕâÀïµÄgetFallback×îÖÕ»á»Øµ÷ÎÒÃÇ×Ô¶¨µÄfallback·½·¨¡£ +这里的getFallback最终会回调我们自定的fallback方法。 -»Øµ½executeCommandAndObserve£¬Õâ¸ö·½·¨Ö÷Òª×öÁËÒÔÏÂÈý¼þÊÂÇé +回到executeCommandAndObserve,这个方法主è¦�å�šäº†ä»¥ä¸‹ä¸‰ä»¶äº‹æƒ… -- ¶¨Ò岻ͬµÄ»Øµ÷£¬doOnNext¡¢doOnCompleted¡¢onErrorResumeNext¡¢doOnEach¡£ -- µ÷ÓÃexecuteCommandWithSpecifiedIsolation¡£ +- 定义ä¸�å�Œçš„回调,doOnNextã€�doOnCompletedã€�onErrorResumeNextã€�doOnEach。 +- 调用executeCommandWithSpecifiedIsolation。 -ÈôÖ´ÐÐÃüÁî³¬Ê±ÌØÐÔ¿ªÆô£¬µ÷Óà Observable.lift·½·¨ÊµÏÖÖ´ÐÐÃüÁʱ¹¦ÄÜ¡£ +若执行命令超时特性开å�¯ï¼Œè°ƒç”¨ Observable.lift方法实现执行命令超时功能。 private Observable executeCommandAndObserve(final AbstractCommand _cmd) { final HystrixRequestContext currentRequestContext = HystrixRequestContext.getContextForCurrentThread(); - // ActionºÍFunc¶¼ÊǶ¨ÒåµÄÒ»¸ö¶¯×÷£¬ActionÊÇÎÞ·µ»ØÖµ£¬FuncÊÇÓзµ»ØÖµ - // doOnNextÖеĻص÷¡£¼´ÃüÁîÖ´ÐÐ֮ǰִÐеIJÙ×÷ + // Actionå’ŒFunc都是定义的一个动作,Action是无返回值,Func是有返回值 + // doOnNext中的回调。å�³å‘½ä»¤æ‰§è¡Œä¹‹å‰�执行的æ“�作 final Action1 markEmits = new Action1() { @Override public void call(R r) { @@ -929,7 +929,7 @@ circuitBreaker.allowRequest() } } }; - // doOnCompletedÖеĻص÷¡£ÃüÁîÖ´ÐÐÍê±ÏºóÖ´ÐеIJÙ×÷ + // doOnCompleted中的回调。命令执行完毕å�Žæ‰§è¡Œçš„æ“�作 final Action0 markOnCompleted = new Action0() { @Override public void call() { @@ -942,49 +942,49 @@ circuitBreaker.allowRequest() } } }; - // onErrorResumeNextÖеĻص÷¡£ÃüÁîÖ´ÐÐʧ°ÜºóµÄ»ØÍËÂß¼­ + // onErrorResumeNext中的回调。命令执行失败å�Žçš„回退逻辑 final Func1> handleFallback = new Func1>() { @Override public Observable call(Throwable t) { Exception e = getExceptionFromThrowable(t); executionResult = executionResult.setExecutionException(e); if (e instanceof RejectedExecutionException) { - // Ï̵߳÷¶Èʧ°Ü»Øµ÷ + // 线程调度失败回调 return handleThreadPoolRejectionViaFallback(e); } else if (t instanceof HystrixTimeoutException) { - // ³¬Ê±»Øµ÷ + // 超时回调 return handleTimeoutViaFallback(); } else if (t instanceof HystrixBadRequestException) { - // HystrixBadRequestException Òì³£»Øµ÷ + // HystrixBadRequestException 异常回调 return handleBadRequestByEmittingError(e); } else { if (e instanceof HystrixBadRequestException) { eventNotifier.markEvent(HystrixEventType.BAD_REQUEST, commandKey); return Observable.error(e); } - // ½µ¼¶´¦Àí + // é™�级处ç�† return handleFailureViaFallback(e); } } }; - // doOnEachÖеĻص÷¡£`Observable`ÿ·¢ÉäÒ»¸öÊý¾Ý¶¼»áÖ´ÐÐÕâ¸ö»Øµ÷£¬ÉèÖÃÇëÇóÉÏÏÂÎÄ + // doOnEach中的回调。`Observable`æ¯�å�‘射一个数æ�®éƒ½ä¼šæ‰§è¡Œè¿™ä¸ªå›žè°ƒï¼Œè®¾ç½®è¯·æ±‚上下文 final Action1> setRequestContext = new Action1>() { @Override public void call(Notification rNotification) { setRequestContextIfNeeded(currentRequestContext); } }; - // ´´½¨¶ÔÓ¦µÄ Observable£¬ÊµÏÖ Ï̸߳ôÀë¡¢ÇëÇó·¢ËÍ µÈ²Ù×÷ + // 创建对应的 Observable,实现 线程隔离ã€�请求å�‘é€� ç­‰æ“�作 Observable execution; - // ÅÐ¶Ï ³¬Ê±¼à¿Ø¹¦ÄÜÊÇ·ñ´ò¿ª + // 判断 超时监控功能是å�¦æ‰“å¼€ if (properties.executionTimeoutEnabled().get()) { - // HystrixObservableTimeoutOperator ת»»¶ÔÓ¦µÄ Observable + // HystrixObservableTimeoutOperator 转æ�¢å¯¹åº”çš„ Observable execution = executeCommandWithSpecifiedIsolation(_cmd) .lift(new HystrixObservableTimeoutOperator(_cmd)); } else { execution = executeCommandWithSpecifiedIsolation(_cmd); } - //ÉèÖûص÷ + //设置回调 return execution.doOnNext(markEmits) .doOnCompleted(markOnCompleted) .onErrorResumeNext(handleFallback) @@ -1000,14 +1000,14 @@ circuitBreaker.allowRequest() 3.3 executeCommandWithSpecifiedIsolation -Õâ¸ö·½·¨Ê×ÏÈÊǸù¾Ýµ±Ç°²»Í¬µÄ×ÊÔ´¸ôÀë²ßÂÔÖ´Ðв»Í¬µÄÂß¼­£¬THREAD¡¢SEMAPHORE¡£ +这个方法首先是根æ�®å½“å‰�ä¸�å�Œçš„资æº�隔离策略执行ä¸�å�Œçš„逻辑,THREADã€�SEMAPHORE。 private Observable executeCommandWithSpecifiedIsolation(final AbstractCommand _cmd) { - // Ï̸߳ôÀë, ÊÇ·ñ¿ªÆô THREAD ×ÊÔ´¸ôÀë½µ¼¶ + // 线程隔离, 是å�¦å¼€å�¯ THREAD 资æº�隔离é™�级 if (properties.executionIsolationStrategy().get() == ExecutionIsolationStrategy.THREAD) { - //´´½¨Ò»¸öObservable + //创建一个Observable return Observable.defer(new Func0>() { @Override public Observable call() { @@ -1018,14 +1018,14 @@ circuitBreaker.allowRequest() metrics.markCommandStart(commandKey, threadPoolKey, ExecutionIsolationStrategy.THREAD); - // ¸ÃÃüÁîÔÚ°ü×°Ïß³ÌÖг¬Ê±£¬½«Á¢¼´·µ»Ø£¬²¢ÇÒ²»»áÔö¼ÓÈκμÆÊýÆ÷»òÆäËû´ËÀàÂß¼­ + // 该命令在包装线程中超时,将立å�³è¿”回,并且ä¸�会增加任何计数器或其他此类逻辑 if (isCommandTimedOut.get() == TimedOutStatus.TIMED_OUT) { // the command timed out in the wrapping thread so we will return immediately // and not increment any of the counters below or other such logic return Observable.error(new RuntimeException("timed out before executing run()")); } - // ÉèÖÃÏß³ÌÆô¶¯ + // 设置线程å�¯åЍ if (threadState.compareAndSet(ThreadState.NOT_USING_THREAD, ThreadState.STARTED)) { //we have not been unsubscribed, so should proceed HystrixCounters.incrementGlobalConcurrentThreads(); @@ -1038,7 +1038,7 @@ circuitBreaker.allowRequest() executionHook.onThreadStart(_cmd); executionHook.onRunStart(_cmd); executionHook.onExecutionStart(_cmd); - //·µ»Ø Observable,Õâ¸öº¯Êý×îÖջ᷵»ØÒ»¸ö·â×°ÁËÎÒÃǵÄrun()Âß¼­µÄObservable + //返回 Observable,这个函数最终会返回一个å°�装了我们的run()逻辑的Observable return getUserExecutionObservable(_cmd); } catch (Throwable ex) { return Observable.error(ex); @@ -1073,7 +1073,7 @@ circuitBreaker.allowRequest() } })); } else { - // ÐźÅÁ¿¸ôÀë + // ä¿¡å�·é‡�隔离 return Observable.defer(new Func0>() { @Override public Observable call() { @@ -1086,7 +1086,7 @@ circuitBreaker.allowRequest() try { executionHook.onRunStart(_cmd); executionHook.onExecutionStart(_cmd); - // ÕæÕýµÄÖ´ÐÐ + // 真正的执行 return getUserExecutionObservable(_cmd); } catch (Throwable ex) { //If the above hooks throw, then use that as the result of the run method @@ -1105,11 +1105,11 @@ circuitBreaker.allowRequest() -- ÅжÏÊÇ·ñÔÊÐí·¢ËÍÇëÇó£¬ÕâÊÇ»ùÓÚ¶Ï·Æ÷ʵÏÖ£¬Èç¹û¶Ï·Æ÷´ò¿ª£¬Ôò½øÐжÔÓ¦»Øµ÷´¦Àí£¨Ê§°Ü»ò½µ¼¶£©¡£ -- Èç¹û ¶Ï·Æ÷ ¹Ø±Õ£¬Ôò½øÐÐÇëÇó£¬ÏÈ»ñÈ¡Ðźţ¬»ñȡʧ°ÜÔò´¦Àí¶ÔÓ¦»Øµ÷¡£ -- »ñÈ¡³É¹¦£¬ÔòÓÉ·½·¨ executeCommandAndObserve ´´½¨¶ÔÓ¦µÄ Observable ʵÏÖ Ï̸߳ôÀë¡¢ÇëÇó·¢ËÍ µÈ²Ù×÷£¬Í¬Ê±×¢²áÁ˶ÔÓ¦µÄ ÉúÃüÖÜÆÚ»Øµ÷¡£ +- 判断是å�¦å…�许å�‘é€�请求,这是基于断路器实现,如果断路器打开,则进行对应回调处ç�†ï¼ˆå¤±è´¥æˆ–é™�级)。 +- 如果 断路器 关闭,则进行请求,先获å�–ä¿¡å�·ï¼ŒèŽ·å�–失败则处ç�†å¯¹åº”回调。 +- 获å�–æˆ�功,则由方法 executeCommandAndObserve 创建对应的 Observable 实现 线程隔离ã€�请求å�‘é€� ç­‰æ“�作,å�Œæ—¶æ³¨å†Œäº†å¯¹åº”çš„ 生命周期回调。 3.4 getUserExecutionObservable - È»ºó»áÖ´ÐÐ HystrixCommand#getExecutionObservable + ç„¶å�Žä¼šæ‰§è¡Œ HystrixCommand#getExecutionObservable @@ -1156,7 +1156,7 @@ circuitBreaker.allowRequest() -Õâ¸ö run() ·½·¨ÔÚÉÏÃæÒѾ­½²¹ýÁË£¬¾ÍÊÇÕæÕýµÄÒµÎñÖ´Ðз½·¨¡£ +这个 run() 方法在上é�¢å·²ç»�讲过了,就是真正的业务执行方法。 @@ -1182,8 +1182,8 @@ circuitBreaker.allowRequest() -×îÖÕµ÷Óõ½ÎÒÃÇ×Ô¼ºµÄÒµÎñÂß¼­¡£ -# ²Î¿¼ÎÄÕ +最终调用到我们自己的业务逻辑。 +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudLoadBalancer\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudLoadBalancer\346\272\220\347\240\201\345\210\206\346\236\220.md" index f66f6ba..219d20c 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudLoadBalancer\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudLoadBalancer\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,22 +1,22 @@ # Spring Cloud LoadBalancer -## ¸ÅÊö +## 概述 -> Spring Cloud LoadBalancerĿǰSpring¹Ù·½ÊÇ·ÅÔÚspring-cloud-commonsÀSpring Cloud×îа汾Ϊ2021.0.2 +> Spring Cloud LoadBalancerç›®å‰�Spring官方是放在spring-cloud-commons里,Spring Cloud最新版本为2021.0.2 > -> [Spring Cloud LoadBalancer ¹ÙÍøÎĵµµØÖ·](https://docs.spring.io/spring-cloud-commons/docs/3.1.2/reference/html/#spring-cloud-loadbalancer) [https://docs.spring.io/spring-cloud-commons/docs/3.1.2/reference/html/#spring-cloud-loadbalancer](https://docs.spring.io/spring-cloud-commons/docs/3.1.2/reference/html/#spring-cloud-loadbalancer) +> [Spring Cloud LoadBalancer 官网文档地å�€](https://docs.spring.io/spring-cloud-commons/docs/3.1.2/reference/html/#spring-cloud-loadbalancer) [https://docs.spring.io/spring-cloud-commons/docs/3.1.2/reference/html/#spring-cloud-loadbalancer](https://docs.spring.io/spring-cloud-commons/docs/3.1.2/reference/html/#spring-cloud-loadbalancer) > -> [Spring Cloud¹ÙÍøÎĵµµØÖ·](https://docs.spring.io/spring-cloud/docs/current/reference/html/) [https://docs.spring.io/spring-cloud/docs/current/reference/html/](https://docs.spring.io/spring-cloud/docs/current/reference/html/) +> [Spring Cloud官网文档地å�€](https://docs.spring.io/spring-cloud/docs/current/reference/html/) [https://docs.spring.io/spring-cloud/docs/current/reference/html/](https://docs.spring.io/spring-cloud/docs/current/reference/html/) -Ò»·½ÃæNetflix RibbonÍ£Ö¹¸üУ¬Spring Cloud LoadBalancerÊÇSpring Cloud¹Ù·½×Ô¼ºÌṩµÄ¿Í»§¶Ë¸ºÔؾùºâÆ÷,³éÏóºÍʵÏÖ£¬ÓÃÀ´Ìæ´úRibbon¡£ +一方é�¢Netflix Ribbonå�œæ­¢æ›´æ–°ï¼ŒSpring Cloud LoadBalancer是Spring Cloud官方自己æ��供的客户端负载å�‡è¡¡å™¨,抽象和实现,用æ�¥æ›¿ä»£Ribbon。 -* ³£¼û¸ºÔؾùºâÆ÷·ÖΪ·þÎñ¶Ë¸ºÔؾùºâÆ÷(ÈçÍø¹Ø²ã¾ùºâ¸ºÔØ)ºÍ¿Í»§¶Ë²ã¾ùºâ¸ºÔØ¡£ - * Íø¹Ø²ãÈçÓ²¼þ²ãÃæµÄF5»òÈí¼þ²ãÃæµÄLVS¡¢»òÕßnginxµÈ¡£ - * ¿Í»§¶Ë²ã¾ÍÈçSpring Cloud LoadBalancer£¬×÷Ϊһ¸ö¿Í»§¶ËÈ¥·¢ÏÖ¸üÐÂά»¤·þÎñÁÐ±í£¬×Ô¶¨Òå·þÎñµÄ¾ùºâ¸ºÔزßÂÔ£¨Ëæ»ú¡¢ÂÖѯ¡¢Ð¡Á÷Á¿µÄ½ð˿ȸµÈµÈ£©¡£ +* 常è§�è´Ÿè½½å�‡è¡¡å™¨åˆ†ä¸ºæœ�务端负载å�‡è¡¡å™¨(如网关层å�‡è¡¡è´Ÿè½½)和客户端层å�‡è¡¡è´Ÿè½½ã€‚ + * 网关层如硬件层é�¢çš„F5或软件层é�¢çš„LVSã€�或者nginx等。 + * 客户端层就如Spring Cloud LoadBalancer,作为一个客户端去å�‘现更新维护æœ�务列表,自定义æœ�务的å�‡è¡¡è´Ÿè½½ç­–略(éš�机ã€�轮询ã€�å°�æµ�é‡�的金ä¸�雀等等)。 -Spring CloudÌṩÁË×Ô¼ºµÄ¿Í»§¶Ë¸ºÔØÆ½ºâÆ÷³éÏóºÍʵÏÖ¡£¶ÔÓÚ¸ºÔؾùºâ»úÖÆ£¬Ôö¼ÓÁËReactiveLoadBalancer½Ó¿Ú£¬²¢ÌṩÁË»ùÓÚround-robinÂÖѯºÍRandomËæ»úµÄʵÏÖ¡£ÎªÁË´ÓÏìӦʽServiceInstanceListSupplierÖÐÑ¡ÔñʵÀý£¬ÐèҪʹÓÃServiceInstanceListSupplier¡£Ä¿Ç°Ö§³ÖServiceInstanceListSupplierµÄ»ùÓÚ·þÎñ·¢ÏÖµÄʵÏÖ£¬¸ÃʵÏÖʹÓÃÀà·¾¶Öеķ¢ÏÖ¿Í»§¶Ë´ÓService DiscoveryÖмìË÷¿ÉÓõÄʵÀý¡£ +Spring Cloudæ��供了自己的客户端负载平衡器抽象和实现。对于负载å�‡è¡¡æœºåˆ¶ï¼Œå¢žåŠ äº†ReactiveLoadBalancer接å�£ï¼Œå¹¶æ��供了基于round-robin轮询和Randoméš�机的实现。为了从å“�应å¼�ServiceInstanceListSupplier中选择实例,需è¦�使用ServiceInstanceListSupplier。目å‰�支æŒ�ServiceInstanceListSupplier的基于æœ�务å�‘现的实现,该实现使用类路径中的å�‘现客户端从Service Discovery中检索å�¯ç”¨çš„实例。 -¿ÉÒÔͨ¹ýÈçÏÂÅäÖÃÀ´½ûÓÃSpring Cloud LoadBalance +å�¯ä»¥é€šè¿‡å¦‚下é…�ç½®æ�¥ç¦�用Spring Cloud LoadBalance ``` spring: @@ -26,13 +26,13 @@ spring: ``` -## ÈëÃÅʾÀý +## 入门示例 -Ç°Ãæsimple-ecommerceÏîÄ¿´´½¨ÒÑÔÚ¸¸PomÒýÈëÈý´ó¸¸ÒÀÀµ£¬Ïêϸ¿ÉÒÔ¿´ÏÂÇ°ÃæµÄÎÄÕÂ<>£¬ÆäÖÐSpring CloudµÄ°æ±¾Îª2021.0.1£¬Ç°ÃæÎÄÕÂÒ²ÒÑ˵¹ý£¬Spring Cloud AlibabaÕûºÏÔÚspring-cloud-starter-alibaba-nacos-discovery±¾Éí¾ÍÒÀÀµspring-cloud-loadbalancer¡£ +å‰�é�¢simple-ecommerce项目创建已在父Pom引入三大父ä¾�赖,详细å�¯ä»¥çœ‹ä¸‹å‰�é�¢çš„æ–‡ç« <>,其中Spring Cloud的版本为2021.0.1,å‰�é�¢æ–‡ç« ä¹Ÿå·²è¯´è¿‡ï¼ŒSpring Cloud Alibabaæ•´å�ˆåœ¨spring-cloud-starter-alibaba-nacos-discovery本身就ä¾�èµ–spring-cloud-loadbalancer。 -> ×¢ÒâÈç¹ûÊÇHoxton֮ǰµÄ°æ±¾£¬Ä¬ÈϸºÔؾùºâÆ÷ΪRibbon£¬ÐèÒªÒÆ³ýRibbonÒýÓúÍÔö¼ÓÅäÖÃspring.cloud.loadbalancer.ribbon.enabled: false¡£ +> 注æ„�如果是Hoxton之å‰�的版本,默认负载å�‡è¡¡å™¨ä¸ºRibbon,需è¦�移除Ribbon引用和增加é…�ç½®spring.cloud.loadbalancer.ribbon.enabled: false。 -Èç¹ûÊÇÔÚSpring BootÏîÄ¿ÖÐÌí¼ÓÏÂÃæµÄÆô¶¯Æ÷ÒÀÀµ£¬¸ÃstarterÒ²°üº¬ÁËSpring Boot Caching and Evictor. +如果是在Spring Boot项目中添加下é�¢çš„å�¯åЍ噍ä¾�赖,该starter也包å�«äº†Spring Boot Caching and Evictor. ``` @@ -42,7 +42,7 @@ spring: ``` -ÎÒÃÇʹÓÃSpring¹Ù·½ÌṩÁ˸ºÔؾùºâµÄ¿Í»§¶ËÖ®Ò»RestTemplate£¬RestTemplateÊÇSpringÌṩµÄÓÃÓÚ·ÃÎÊRest·þÎñµÄ¿Í»§¶Ë£¬RestTemplateÌṩÁ˶àÖÖ±ã½Ý·ÃÎÊÔ¶³ÌHttp·þÎñµÄ·½·¨£¬Äܹ»´ó´óÌá¸ß¿Í»§¶ËµÄ±àдЧÂÊ¡£Ä¬ÈÏÇé¿öÏ£¬RestTemplateĬÈÏÒÀÀµjdkµÄHTTPÁ¬½Ó¹¤¾ß¡£´´½¨RestTemplateConfigÅäÖÃÀ࣬±ê×¢ @LoadBalanced×¢½â£¬Ä¬ÈÏʹÓõÄReactiveLoadBalancerʵÏÖÊÇRoundRobinLoadBalancer¡£ +我们使用Spring官方æ��供了负载å�‡è¡¡çš„客户端之一RestTemplate,RestTemplate是Springæ��供的用于访问Restæœ�务的客户端,RestTemplateæ��供了多ç§�便æ�·è®¿é—®è¿œç¨‹Httpæœ�务的方法,能够大大æ��高客户端的编写效率。默认情况下,RestTemplate默认ä¾�èµ–jdkçš„HTTP连接工具。创建RestTemplateConfigé…�置类,标注 @LoadBalanced注解,默认使用的ReactiveLoadBalancer实现是RoundRobinLoadBalancer。 ``` package cn.itxs.ecom.order.config; @@ -63,7 +63,7 @@ public class RestTemplateConfig { ``` -¶©µ¥Î¢·þÎñÖж©µ¥¿ØÖÆÆ÷Ôö¼ÓdeductRest·½·¨ +订å�•å¾®æœ�务中订å�•控制器增加deductRest方法 ``` package cn.itxs.ecom.order.controller; @@ -76,12 +76,12 @@ import org.springframework.web.bind.annotation.RestController; import org.springframework.web.client.RestTemplate; /** - * @Name £ºOrderController - * @Description £º¶©µ¥¿ØÖÆÆ÷ - * @Author £ºitxs - * @Date £º2022/4/10 20:15 - * @Version £º1.0 - * @History £º + * @Name :OrderController + * @Description :订å�•控制器 + * @Author :itxs + * @Date :2022/4/10 20:15 + * @Version :1.0 + * @History : */ @RestController public class OrderController { @@ -106,7 +106,7 @@ public class OrderController { ``` -Ç°Ãæserver.portÎÒÃÇÊÇ·ÅÔÚNacosÅäÖÃÖÐÐÄÀÕâÀïÎÒÃÇ×¢ÊÍNacosÅäÖÃÖÐÐĵÄÅäÖ÷ÅÔÚ±¾µØÅäÖÃÎļþbootstrap.ymlÀ·Ö±ðÅäÖÃΪ4080¡¢4081¡¢4082Æô¶¯3¸ö¿â´æ·þÎñʵÀý£¬²¢Æô¶¯¶©µ¥Î¢·þÎñ +å‰�é�¢server.port我们是放在Nacosé…�置中心里,这里我们注释Nacosé…�置中心的é…�置放在本地é…�置文件bootstrap.yml里,分别é…�置为4080ã€�4081ã€�4082å�¯åЍ3个库存æœ�务实例,并å�¯åŠ¨è®¢å�•å¾®æœ�务 ``` server: @@ -116,17 +116,17 @@ server: ![image-20220505191143684](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/938570a0b63b56671a862e8bda11577a.png) -²é¿´nacos·þÎñ¹ÜÀí-·þÎñÁбíÀï·þÎñÏêÇ飬¿ÉÒÔ¿´µ½3¸ö½¡¿µµÄ¿â´æÊµÀýºÍ1¸ö¶©µ¥Î¢·þÎñʵÀý +查看nacosæœ�务管ç�†-æœ�务列表里æœ�务详情,å�¯ä»¥çœ‹åˆ°3个å�¥åº·çš„库存实例和1个订å�•å¾®æœ�务实例 ![image-20220505182432182](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/33fa03d937354fe00bb0bb2f3dd5c805.png) -·ÃÎÊ6´Î¶©µ¥dedect½Ó¿Ú£º[http://localhost:4070/deductRest/1001/1](http://localhost:4070/deductRest/1001/1) £¬´Ó²âÊԵĽá¹ûÒ²ÑéÖ¤ÁËLoadBalancerĬÈÏÊÇÂÖѯ¸ºÔؾùºâ²ßÂÔ¡£ +访问6次订å�•dedect接å�£ï¼š[http://localhost:4070/deductRest/1001/1](http://localhost:4070/deductRest/1001/1) ,从测试的结果也验è¯�了LoadBalancer默认是轮询负载å�‡è¡¡ç­–略。 ![image-20220505192217715](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1fc20b1d482d2a4e3924c5707ac2ff19.png) -## ¸ºÔؾùºâËã·¨Çл» +## è´Ÿè½½å�‡è¡¡ç®—法切æ�¢ -´´½¨×Ô¶¨Òå¸ºÔØ¾ùºâÅäÖÃÀàCustomLoadBalancerConfiguration +创建自定义负载å�‡è¡¡é…�置类CustomLoadBalancerConfiguration ``` package cn.itxs.ecom.order.config; @@ -153,7 +153,7 @@ public class CustomLoadBalancerConfiguration { ``` -RestTemplateConfigÅäÖÃÀàLoadBalancerClientÖ¸¶¨Ëæ»úµÄÅäÖÃÀ࣬valueµÄֵΪÌṩÕßÒ²¼´ÊÇ¿â´æÎ¢·þÎñÃû³Æ¡£ +RestTemplateConfigé…�置类LoadBalancerClient指定éš�机的é…�置类,value的值为æ��供者也å�³æ˜¯åº“存微æœ�务å��称。 ``` package cn.itxs.ecom.order.config; @@ -178,15 +178,15 @@ public class RestTemplateConfig { ``` -¶à´Î·ÃÎʶ©µ¥dedect½Ó¿Ú²âÊÔÈ·ÈÏÒÑÇл»ÎªËæ»ú¸ºÔؾùºâ²ßÂÔ¡£ +多次访问订å�•dedect接å�£æµ‹è¯•确认已切æ�¢ä¸ºéš�机负载å�‡è¡¡ç­–略。 -## ¼¯³É·½Ê½ +## 集æˆ�æ–¹å¼� -¹ÙÍøÌṩ3Öм¯³ÉSpring Cloud LoadBalancerµÄ·½Ê½£¬³ýÁ˵ÚÒ»ÖÖÉÏÃæÒÑʹÓùý£¬»¹Ö§³ÖSpring Web FluxÏìӦʽ±à³Ì£¬WebClientÊÇ´ÓSpring WebFlux 5.0°æ±¾¿ªÊ¼ÌṩµÄÒ»¸ö·Ç×èÈûµÄ»ùÓÚÏìӦʽ±à³ÌµÄ½øÐÐHttpÇëÇóµÄ¿Í»§¶Ë¹¤¾ß¡£ËüµÄÏìӦʽ±à³ÌµÄ»ùÓÚReactorµÄ¡£WebClientÖÐÌṩÁ˱ê×¼HttpÇëÇó·½Ê½¶ÔÓ¦µÄget¡¢post¡¢put¡¢deleteµÈ·½·¨£¬¿ÉÒÔÓÃÀ´·¢ÆðÏàÓ¦µÄÇëÇó¡£ +官网æ��ä¾›3中集æˆ�Spring Cloud LoadBalancer的方å¼�,除了第一ç§�上é�¢å·²ä½¿ç”¨è¿‡ï¼Œè¿˜æ”¯æŒ�Spring Web Fluxå“�应å¼�编程,WebClient是从Spring WebFlux 5.0版本开始æ��供的一个é�žé˜»å¡žçš„基于å“�应å¼�编程的进行Http请求的客户端工具。它的å“�应å¼�编程的基于Reactor的。WebClient中æ��供了标准Http请求方å¼�对应的getã€�postã€�putã€�delete等方法,å�¯ä»¥ç”¨æ�¥å�‘起相应的请求。 ![image-20220506233248585](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/ad44f363342f540b1cb1805b20be6ef0.png) -ÔÚ¶©µ¥Î¢·þÎñÖÐÒýÈëspring-boot-starter-webfluxÒÀÀµ +在订å�•å¾®æœ�务中引入spring-boot-starter-webfluxä¾�èµ– ``` @@ -196,7 +196,7 @@ public class RestTemplateConfig { ``` -¶©µ¥Î¢·þÎñÖÐÔö¼ÓWebClientConfigÅäÖÃÀà +订å�•å¾®æœ�务中增加WebClientConfigé…�置类 ``` package cn.itxs.ecom.order.config; @@ -222,7 +222,7 @@ public class WebClientConfig { ``` -¶©µ¥Î¢·þÎñ¶©µ¥¿ØÖÆÆ÷ÖÐÌí¼ÓWebClient½Ó¿ÚʵÏÖ£¬´úÂëÈçÏ +订å�•å¾®æœ�务订å�•控制器中添加WebClient接å�£å®žçŽ°ï¼Œä»£ç �如下 ``` @Autowired @@ -231,7 +231,7 @@ public class WebClientConfig { @RequestMapping(value = "/deductWebClient/{commodityCode}/{count}") public Mono deductWebClient(@PathVariable("commodityCode") String commodityCode, @PathVariable("count") int count) { String url = "http://ecom-storage-service/deduct/"+commodityCode+"/"+count; - // »ùÓÚWebClient + // 基于WebClient Mono result = webClient.get().uri(url) .retrieve().bodyToMono(String.class); return result; @@ -239,17 +239,17 @@ public class WebClientConfig { ``` -ÖØÐÂÆô¶¯¶©µ¥Î¢·þÎñ +é‡�æ–°å�¯åŠ¨è®¢å�•å¾®æœ�务 ![image-20220506234934948](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/ec48e022accfb3298069c96b7e3799e7.png) -·ÃÎʶ©µ¥¿ØÖÆÆ÷Öеļõ¿â´æWebClient½Ó¿Ú£¬[http://localhost:4070/deductWebClient/1001/1](http://localhost:4070/deductWebClient/1001/1) £¬½á¹û·µ»Ø³É¹¦ +访问订å�•控制器中的å‡�库存WebClient接å�£ï¼Œ[http://localhost:4070/deductWebClient/1001/1](http://localhost:4070/deductWebClient/1001/1) ,结果返回æˆ�功 ![image-20220506234627330](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/5f737fc9d8806dc072ce3e1fdf983de6.png) -ÎÒÃÇ»¹¿ÉÒÔÅäÖûùÓÚ¹ýÂËÆ÷µÄ·½Ê½£¬Í¨¹ýWebClientʹÓÃReactiveLoadBalancer¡£Èç¹ûÏîÄ¿ÖÐÌí¼ÓÁËSpring Cloud LoadBalancer starter£¬²¢ÇÒSpring -webfluxÔÚÀà·¾¶ÖУ¬ReactorLoadBalancerExchangeFilterFunctionÔòÊÇ×Ô¶¯ÅäÖõġ£ +我们还å�¯ä»¥é…�置基于过滤器的方å¼�,通过WebClient使用ReactiveLoadBalancer。如果项目中添加了Spring Cloud LoadBalancer starter,并且Spring -webflux在类路径中,ReactorLoadBalancerExchangeFilterFunction则是自动é…�置的。 -¶©µ¥Î¢·þÎñ¶©µ¥¿ØÖÆÆ÷ÖÐÌí¼ÓWebClientʹÓÃReactiveLoadBalancer½Ó¿ÚʵÏÖ£¬´úÂëÈçÏ +订å�•å¾®æœ�务订å�•控制器中添加WebClient使用ReactiveLoadBalancer接å�£å®žçŽ°ï¼Œä»£ç �如下 ``` @Autowired @@ -270,30 +270,30 @@ public class WebClientConfig { ``` -ÖØÐÂÆô¶¯¶©µ¥Î¢·þÎñ +é‡�æ–°å�¯åŠ¨è®¢å�•å¾®æœ�务 ![image-20220507000930179](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/3546b9913f1253a1b23039ad6f7546d1.png) -·ÃÎʶ©µ¥¿ØÖÆÆ÷Öеļõ¿â´æWebClient½Ó¿Ú£¬[http://localhost:4070/deductWebFluxReactor/1001/1](http://localhost:4070/deductWebFluxReactor/1001/1) £¬½á¹û·µ»Ø³É¹¦ +访问订å�•控制器中的å‡�库存WebClient接å�£ï¼Œ[http://localhost:4070/deductWebFluxReactor/1001/1](http://localhost:4070/deductWebFluxReactor/1001/1) ,结果返回æˆ�功 ![image-20220507000746900](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/0bc2b04d23d11bc85009c7e040900b2b.png) -¹ØÓÚLoadBalancer¹ÙÍø»¹ÌṩºÜ¶àÆäËû¹¦ÄÜ£¬ÓÐÐËȤ¿É×ÔÐÐÏêϸ²éÔĺͶ¯ÊÖʵÑé +关于LoadBalancer官网还æ��供很多其他功能,有兴趣å�¯è‡ªè¡Œè¯¦ç»†æŸ¥é˜…和动手实验 ![image-20220507001132987](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1d8f35933945b317a2dd71627fdfa748.png) -## Ô­Àí +## 原ç�† ### RestTemplate -Spring Cloud LoadBalancerÔ´Âë·ÖÎöÎÒÃÇÏÈ´ÓRestTemplate¸ºÔؾùºâµÄ¼òµ¥ÊµÏÖÀ´·ÖÎöÈëÊÖ£¬³ý´ËÖ®ÍâÆäÖ§³ÖSpring Web FluxÏìӦʽ±à³ÌµÄʵÏÖÔ­Àí˼ÏëÒ²ÊÇÏàͬ£¬¶¼ÊÇͨ¹ý¿Í»§¶ËÌí¼ÓÀ¹½ØÆ÷£¬ÔÚÀ¹½ØÆ÷ÖÐʵÏÖ¸ºÔؾùºâ¡£´ÓRestTemplateµÄÔ´ÂëÖпÉÒÔÖªµÀÆä¼Ì³Ð×ÔInterceptingHttpAccessor³éÏóÀà +Spring Cloud LoadBalanceræº�ç �分æž�我们先从RestTemplateè´Ÿè½½å�‡è¡¡çš„简å�•实现æ�¥åˆ†æž�入手,除此之外其支æŒ�Spring Web Fluxå“�应å¼�编程的实现原ç�†æ€�想也是相å�Œï¼Œéƒ½æ˜¯é€šè¿‡å®¢æˆ·ç«¯æ·»åŠ æ‹¦æˆªå™¨ï¼Œåœ¨æ‹¦æˆªå™¨ä¸­å®žçŽ°è´Ÿè½½å�‡è¡¡ã€‚从RestTemplateçš„æº�ç �中å�¯ä»¥çŸ¥é�“其继承自InterceptingHttpAccessor抽象类 ![image-20220508142236428](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c3ee7af69f54aeed5f1026823779fee8.png) -¶øInterceptingHttpAccessor³éÏóÀàÔòÌṩÁËÒ»¸ö·½·¨setInterceptors£¬ÓÃÓÚÉèÖÃÀ¹½ØÆ÷£¬À¹½ØÆ÷ÐèҪʵÏÖClientHttpRequestInterceptor½Ó¿Ú¼´¿É£¬ÔÚʵ¼ÊÔ¶³ÌÇëÇó·þÎñ¶Ë½Ó¿Ú֮ǰ»áÏȵ÷ÓÃÀ¹½ØÆ÷µÄintercept·½·¨¡£ÕâÀïµÄÀ¹½ØÆ÷Ï൱ÓÚServlet¼¼ÊõÖеÄFilter¹¦ÄÜ +而InterceptingHttpAccessor抽象类则æ��供了一个方法setInterceptors,用于设置拦截器,拦截器需è¦�实现ClientHttpRequestInterceptor接å�£å�³å�¯ï¼Œåœ¨å®žé™…远程请求æœ�务端接å�£ä¹‹å‰�会先调用拦截器的intercept方法。这里的拦截器相当于Servlet技术中的Filter功能 ``` - // ´úÂëʵÏÖÔÚ³éÏó¸¸ÀàInterceptingHttpAccessorÀï + // 代ç �实现在抽象父类InterceptingHttpAccessor里 // RestTemplate.InterceptingHttpAccessor#setInterceptors public void setInterceptors(List interceptors) { Assert.noNullElements(interceptors, "'interceptors' must not contain null elements"); @@ -311,27 +311,27 @@ Spring Cloud LoadBalancerÔ´ ### **LoadBalancerAutoConfiguration** -´Ó¹ÙÍø¿ÉÒÔÖªµÀSpring Cloud LoadBalancer·ÅÔÚspring-cloud-commons£¬Òò´ËÒ²×÷ΪÆäºËÐĵÄ@LoadBalanced×¢½âÒ²¾ÍÊÇÓÉspring-cloud-commonsÀ´ÊµÏÖ£¬ÒÀ¾ÝSpringBoot×Ô¶¯×°ÅäµÄÔ­ÀíÏȲ鿴ÒÀÀµ°üµÄʵÏÖÂß¼­£¬²»ÄÑ·¢ÏÖspring-cloud-commonsÒýÈëÁË×Ô¶¯ÅäÖÃÀàLoadBalancerAutoConfigurationºÍReactorLoadBalancerClientAutoConfiguration¡£ +从官网å�¯ä»¥çŸ¥é�“Spring Cloud LoadBalancer放在spring-cloud-commons,因此也作为其核心的@LoadBalanced注解也就是由spring-cloud-commonsæ�¥å®žçŽ°ï¼Œä¾�æ�®SpringBoot自动装é…�的原ç�†å…ˆæŸ¥çœ‹ä¾�赖包的实现逻辑,ä¸�éš¾å�‘现spring-cloud-commons引入了自动é…�置类LoadBalancerAutoConfigurationå’ŒReactorLoadBalancerClientAutoConfiguration。 ![image-20220509001530634](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b5be12e0dd8d515aa07613738efab122.png) -µ±Âú×ãÉÏÊöµÄÌõ¼þʱ£¨@ConditionalΪÌõ¼þ×¢½â£©£¬½«×Ô¶¯´´½¨LoadBalancerInterceptor²¢×¢Èëµ½RestTemplateÖС£ +当满足上述的æ�¡ä»¶æ—¶ï¼ˆ@Conditional为æ�¡ä»¶æ³¨è§£ï¼‰ï¼Œå°†è‡ªåŠ¨åˆ›å»ºLoadBalancerInterceptor并注入到RestTemplate中。 ![image-20220508143752218](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/676f6d81529228511c862c780b0c4532.png) ### **LoadBalancerLnterceptor** -LoadBalancerInterceptorʵÏÖÁËClientHttpRequestInterceptor½Ó¿Ú£¬Òò´ËҲʵÏÖintercept·½·¨£¬ÓÃÓÚʵÏÖ¸ºÔؾùºâµÄÀ¹½Ø´¦Àí¡£ +LoadBalancerInterceptor实现了ClientHttpRequestInterceptor接å�£ï¼Œå› æ­¤ä¹Ÿå®žçްintercept方法,用于实现负载å�‡è¡¡çš„æ‹¦æˆªå¤„ç�†ã€‚ ![image-20220508144048248](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/bb587d8122fee4973eba2fc00ed1af3f.png) ### **LoadBalancerClient** -LoadBalancerClientÓÃÓÚ½øÐиºÔؾùºâÂß¼­£¬¼Ì³Ð×ÔServiceInstanceChooser½Ó¿Ú£¬´Ó·þÎñÁбíÖÐÑ¡Ôñ³öÒ»¸ö·þÎñµØÖ·½øÐе÷Óá£ÔÚLoadBalancerClientÖÖ´æÔÚÁ½¸öexecute()·½·¨£¬¾ùÊÇÓÃÀ´Ö´ÐÐÇëÇóµÄ£¬reconstructURI()ÊÇÓÃÀ´Öع¹URL¡£ +LoadBalancerClient用于进行负载å�‡è¡¡é€»è¾‘,继承自ServiceInstanceChooser接å�£ï¼Œä»Žæœ�务列表中选择出一个æœ�务地å�€è¿›è¡Œè°ƒç”¨ã€‚在LoadBalancerClientç§�存在两个execute()方法,å�‡æ˜¯ç”¨æ�¥æ‰§è¡Œè¯·æ±‚的,reconstructURI()是用æ�¥é‡�æž„URL。 ![image-20220508144435104](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/a3590c0ab24cb5ee04cf1cf513724fc0.png) -¶ÔÓÚLoadBalancerClient½Ó¿ÚSpring Cloud LoadBalancerµÄÌṩĬÈÏʵÏÖΪBlockingLoadBalancerClient +对于LoadBalancerClient接å�£Spring Cloud LoadBalancerçš„æ��供默认实现为BlockingLoadBalancerClient ![image-20220508144750601](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/256e4815a982966d7d6bfb82e0e97f67.png) @@ -363,7 +363,7 @@ public class BlockingLoadBalancerClient implements LoadBalancerClient { Set supportedLifecycleProcessors = getSupportedLifecycleProcessors(serviceId); supportedLifecycleProcessors.forEach(lifecycle -> lifecycle.onStart(lbRequest)); ServiceInstance serviceInstance = choose(serviceId, lbRequest); - // Ñ¡Ôñ·þÎñ + // 选择æœ�务 if (serviceInstance == null) { supportedLifecycleProcessors.forEach(lifecycle -> lifecycle.onComplete( new CompletionContext<>(CompletionContext.Status.DISCARD, lbRequest, new EmptyResponse()))); @@ -432,7 +432,7 @@ public class BlockingLoadBalancerClient implements LoadBalancerClient { return choose(serviceId, REQUEST); } - // ͨ¹ý²»Í¬µÄ¸ºÔؾùºâ¿Í»§¶ËʵÏÖÑ¡Ôñ²»Í¬µÄ·þÎñ + // 通过ä¸�å�Œçš„è´Ÿè½½å�‡è¡¡å®¢æˆ·ç«¯å®žçŽ°é€‰æ‹©ä¸�å�Œçš„æœ�务 @Override public ServiceInstance choose(String serviceId, Request request) { ReactiveLoadBalancer loadBalancer = loadBalancerClientFactory.getInstance(serviceId); @@ -459,22 +459,22 @@ public class BlockingLoadBalancerClient implements LoadBalancerClient { ### **LoadBalancerClientFactory** -BlockingLoadBalancerClientÖгÖÓÐLoadBalancerClientFactoryͨ¹ýµ÷ÓÃÆägetInstance·½·¨»ñÈ¡¾ßÌåµÄ¸ºÔؾùºâ¿Í»§¶Ë¡£Í¨¹ý¹¤³§ÀàLoadBalancerClientFactory»ñÈ¡¾ßÌåµÄ¸ºÔؾùºâÆ÷ʵÀý£¬ºóÃæµÄloadBalancer.choose(request)µ÷ÓÃÆä½Ó¿Úchoose()·½·¨ÊµÏÖ¸ù¾Ý¸ºÔؾùºâË㷨ѡÔñÏÂÒ»¸ö·þÎñÆ÷Íê³É¸ºÔؾùºâ£¬¶øReactiveLoadBalancer getInstance(String serviceId) ÓÐĬÈÏʵÏÖLoadBalancerClientFactory +BlockingLoadBalancerClient中æŒ�有LoadBalancerClientFactory通过调用其getInstance方法获å�–具体的负载å�‡è¡¡å®¢æˆ·ç«¯ã€‚通过工厂类LoadBalancerClientFactory获å�–具体的负载å�‡è¡¡å™¨å®žä¾‹ï¼Œå�Žé�¢çš„loadBalancer.choose(request)调用其接å�£choose()方法实现根æ�®è´Ÿè½½å�‡è¡¡ç®—法选择下一个æœ�务器完æˆ�è´Ÿè½½å�‡è¡¡ï¼Œè€ŒReactiveLoadBalancer getInstance(String serviceId) 有默认实现LoadBalancerClientFactory ![image-20220508190132565](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/4014445b0c2ea7189a232b5d257fb938.png) -LoadBalancerClientFactory¿Í»§¶ËʵÏÖÁ˲»Í¬µÄ¸ºÔؾùºâËã·¨£¬±ÈÈçÂÖѯ¡¢Ëæ»úµÈ¡£LoadBalancerClientFactory¼Ì³Ð×ÔNamedContextFactory£¬NamedContextFactory¼Ì³ÐApplicationContextAware£¬ÊµÏÖSpring ApplicationContextÈÝÆ÷²Ù×÷¡£ +LoadBalancerClientFactory客户端实现了ä¸�å�Œçš„è´Ÿè½½å�‡è¡¡ç®—法,比如轮询ã€�éš�机等。LoadBalancerClientFactory继承自NamedContextFactory,NamedContextFactory继承ApplicationContextAware,实现Spring ApplicationContext容器æ“�作。 ![image-20220508190412076](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/18f62338fdb636327fcdb2d08d33661b.png) ### ReactiveLoadBalancer -ReactiveLoadBalancer¸ºÔؾùºâÆ÷ʵÏÖ·þÎñÑ¡Ôñ£¬Spring Cloud BalancerÖÐʵÏÖÁËÂÖѯRoundRobinLoadBalancer¡¢Ëæ»úRandomLoadBalancer¡¢NacosLoadBalancerËã·¨¡£ +ReactiveLoadBalancerè´Ÿè½½å�‡è¡¡å™¨å®žçްæœ�务选择,Spring Cloud Balancer中实现了轮询RoundRobinLoadBalancerã€�éš�机RandomLoadBalancerã€�NacosLoadBalancer算法。 ![image-20220508235128931](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f19b9fd0d246dbae37b05e67b1a79805.png) ### LoadBalancerClientConfiguration -Èç¹ûûÓÐÏÔʽָ¶¨¸ºÔؾùºâËã·¨£¬Ä¬ÈÏȱʡֵΪRoundRobinLoadBalancer +如果没有显å¼�指定负载å�‡è¡¡ç®—法,默认缺çœ�值为RoundRobinLoadBalancer ``` @Bean @@ -492,21 +492,21 @@ ReactiveLoadBalancer ### **LoadBalancerRequestFactory** -LoadBalancerRequest¹¤³§Ààµ÷ÓÃcreateRequest·½·¨ÓÃÓÚ´´½¨LoadBalancerRequest¡£ÆäÄÚ²¿³ÖÓÐLoadBalancerClient¶ÔÏóÒ²¼´³ÖÓÐBlockingLoadBalancerClient¡£ +LoadBalancerRequest工厂类调用createRequest方法用于创建LoadBalancerRequest。其内部æŒ�有LoadBalancerClient对象也å�³æŒ�有BlockingLoadBalancerClient。 ![image-20220509000049541](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c928dcb312df87a44c33ee77a296ee84.png) -ÔÚÈÕ³£ÏîÄ¿ÖУ¬Ò»°ã¸ºÔؾùºâ¶¼ÊǽáºÏFeignʹÓ㬺óÐøÎÒÃÇÓÐʱ¼äÔÙÀ´·ÖÎöFeignÕûºÏLoadBalancerµÄ×Ô¶¯ÅäÖÃÀàFeignLoadBalancerAutoConfigurationµÄʵÏÖ +在日常项目中,一般负载å�‡è¡¡éƒ½æ˜¯ç»“å�ˆFeign使用,å�Žç»­æˆ‘们有时间å†�æ�¥åˆ†æž�Feignæ•´å�ˆLoadBalancer的自动é…�置类FeignLoadBalancerAutoConfiguration的实现 ### ReactorLoadBalancerClientAutoConfiguration -ÎÒÃÇÒ²Å×һϻùÓÚWebClientµÄ@LoadbalancedµÄÁ÷³ÌµÄÒýÈ룬Ê×ÏÈÉùÃ÷¸ºÔؾùºâ¹ýÂËÆ÷ReactorLoadBalancerClientAutoConfigurationÊÇÒ»¸ö×Ô¶¯×°ÅäÆ÷À࣬ÔÚÏîÄ¿ÖÐÒýÈëÁË WebClient ºÍ ReactiveLoadBalancer ÀàÖ®ºó£¬×Ô¶¯×°ÅäÁ÷³Ì¾Í¿ªÊ¼ÔËÐУ¬Ëü»á³õʼ»¯Ò»¸öʵÏÖÁË ExchangeFilterFunction µÄʵÀý£¬ÔÚºóÃæ¸ÃʵÀý½«×÷Ϊ¹ýÂËÆ÷±»×¢Èëµ½WebClient¡£ºóÐøÁ÷³ÌÓÐÐËȤÔÙ×ÔÐÐÑо¿ +我们也抛一下基于WebClientçš„@Loadbalancedçš„æµ�程的引入,首先声明负载å�‡è¡¡è¿‡æ»¤å™¨ReactorLoadBalancerClientAutoConfiguration是一个自动装é…�器类,在项目中引入了 WebClient å’Œ ReactiveLoadBalancer 类之å�Žï¼Œè‡ªåŠ¨è£…é…�æµ�程就开始è¿�行,它会åˆ�始化一个实现了 ExchangeFilterFunction 的实例,在å�Žé�¢è¯¥å®žä¾‹å°†ä½œä¸ºè¿‡æ»¤å™¨è¢«æ³¨å…¥åˆ°WebClient。å�Žç»­æµ�程有兴趣å†�自行研究 ![image-20220509001650781](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/869a4ea9a6e1409b84c927db08cebea1.png) -## ×Ô¶¨Òå¸ºÔØ¾ùºâÆ÷ +## 自定义负载å�‡è¡¡å™¨ -´ÓÉÏÃæ¿ÉÒÔÖªµÀLoadBalancerClientFactoryÊÇ´´½¨¿Í»§»ú¡¢¸ºÔؾùºâÆ÷ºÍ¿Í»§»úÅäÖÃʵÀýµÄ¹¤³§¡£Ëü¸ù¾Ý¿Í»§¶ËÃû³Æ´´½¨Ò»¸öSpring ApplicationContext£¬²¢´ÓÖÐÌáÈ¡ËùÐèµÄbean¡£Òò´Ë½øÈëµ½LoadBalancerClientFactoryÀàÖУ¬ÐèҪȥʵÏÖËüµÄ×Ó½Ó¿ÚReactorServiceInstanceLoadBalancer£¬ÒòΪȥ»ñÈ¡¸ºÔؾùºâÆ÷ʵÀýµÄʱºò£¬ÊÇͨ¹ýÈ¥ÈÝÆ÷ÖвéÕÒReactorServiceInstanceLoadBalancerÀàÐ͵ÄbeanÀ´ÊµÏֵģ¬¿ÉÒÔ²ÎÕÕRandomLoadBalancerʵÏÖ´úÂë +从上é�¢å�¯ä»¥çŸ¥é�“LoadBalancerClientFactory是创建客户机ã€�è´Ÿè½½å�‡è¡¡å™¨å’Œå®¢æˆ·æœºé…�置实例的工厂。它根æ�®å®¢æˆ·ç«¯å��称创建一个Spring ApplicationContext,并从中æ��å�–所需的bean。因此进入到LoadBalancerClientFactory类中,需è¦�去实现它的å­�接å�£ReactorServiceInstanceLoadBalancer,因为去获å�–è´Ÿè½½å�‡è¡¡å™¨å®žä¾‹çš„æ—¶å€™ï¼Œæ˜¯é€šè¿‡åŽ»å®¹å™¨ä¸­æŸ¥æ‰¾ReactorServiceInstanceLoadBalancer类型的beanæ�¥å®žçŽ°çš„ï¼Œå�¯ä»¥å�‚ç…§RandomLoadBalancer实现代ç � ``` package org.springframework.cloud.loadbalancer.core; @@ -580,7 +580,7 @@ public class RandomLoadBalancer implements ReactorServiceInstanceLoadBalancer { ``` -±£ÁôºËÐÄʵÏÖ½øÐмòµ¥·ÂдÈçÏ +ä¿�留核心实现进行简å�•仿写如下 ``` package cn.itxs.ecom.order.config; @@ -598,7 +598,7 @@ import org.springframework.cloud.client.loadbalancer.Response; import reactor.core.publisher.Mono; public class ItxsRandomLoadBalancerClient implements ReactorServiceInstanceLoadBalancer { - // ·þÎñÁбí + // æœ�务列表 private ObjectProvider serviceInstanceListSupplierProvider; public ItxsRandomLoadBalancerClient(ObjectProvider serviceInstanceListSupplierProvider) { @@ -612,7 +612,7 @@ public class ItxsRandomLoadBalancerClient implements ReactorServiceInstanceLoadB } /** - * ʹÓÃËæ»úÊý»ñÈ¡·þÎñ + * 使用éš�机数获å�–æœ�务 * @param instances * @return */ @@ -624,7 +624,7 @@ public class ItxsRandomLoadBalancerClient implements ReactorServiceInstanceLoadB } System.out.println("ItxsRandomLoadBalancerClient random"); - // Ëæ»úËã·¨ + // éš�机算法 int size = instances.size(); Random random = new Random(); ServiceInstance instance = instances.get(random.nextInt(size)); @@ -635,7 +635,7 @@ public class ItxsRandomLoadBalancerClient implements ReactorServiceInstanceLoadB ``` -½«ÉÏÃæCustomLoadBalancerConfigurationÌæ»»ÎªÈçÏÂÄÚÈÝ +将上é�¢CustomLoadBalancerConfiguration替æ�¢ä¸ºå¦‚下内容 ``` package cn.itxs.ecom.order.config; @@ -655,13 +655,13 @@ public class CustomLoadBalancerConfiguration { ``` -Æô¶¯¿â´æÎ¢·þÎñºÍ¶©µ¥Î¢·þÎñ£¬·ÃÎÊhttp://localhost:4070/deductRest/1001/1 £¬¿ØÖÆÌ¨ÒÑ´òÓ¡×Ô¶¨ÒåItxsRandomLoadBalancerClientÖеÄÈÕÖ¾ºÍ³É¹¦·ÃÎʽá¹û +å�¯åŠ¨åº“å­˜å¾®æœ�务和订å�•å¾®æœ�务,访问http://localhost:4070/deductRest/1001/1 ,控制å�°å·²æ‰“å�°è‡ªå®šä¹‰ItxsRandomLoadBalancerClient中的日志和æˆ�功访问结果 ![image-20220509003807968](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c72e3f02f7e0d5d3343f8ae9c464b69c.png) ![image-20220509003927550](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/59796bbbd6b3524e32759d42b622f1bc.png) -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudOpenFeign\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudOpenFeign\346\272\220\347\240\201\345\210\206\346\236\220.md" index 17db744..b6bd39b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudOpenFeign\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudOpenFeign\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,34 +1,34 @@ -×÷Õß | ÓîľľÙâ -À´Ô´ |½ñÈÕÍ·Ìõ +作者 | 宇木木兮 +æ�¥æº� |今日头æ�¡ -**ѧϰĿ±ê** +**学习目标** -1. Ϊʲô¼ÓÒ»¸ö×¢½â¾ÍÄÜʵÏÖÔ¶³Ì¹ý³Ìµ÷ÓÃÄØ£¿ÍƵ¼Ëüµ×²ãµÄʵÏÖÖ÷Á÷³Ì£¿ -2. OpenFeignÔõôʵÏÖRPCµÄ»ù±¾¹¦ÄÜµÄ -3. ͨ¹ýÔ´ÂëÑéÖ¤ - **µÚ1Õ OpenFeignÖ÷Á÷³ÌÍÆµ¼** - ÒªÃ÷È·OpenFeignµÄÖ÷Á÷³ÌÊ×ÏÈÎÒÃÇ»¹ÊÇÒªÃ÷È·ËüµÄºËÐÄÄ¿±êÊÇʲô£¿ +1. 为什么加一个注解就能实现远程过程调用呢?推导它底层的实现主æµ�程? +2. OpenFeign怎么实现RPC的基本功能的 +3. 通过æº�ç �验è¯� + **第1ç«  OpenFeign主æµ�程推导** + è¦�明确OpenFeign的主æµ�程首先我们还是è¦�明确它的核心目标是什么? -˵°×ÁË£¬OpenFeign×îºËÐĵÄÄ¿±ê¾ÍÊÇÈÿͻ§¶ËÔÚÔ¶³Ìµ÷Óùý³ÌÖв»ÐèÒª×öʲô¶àÓàµÄ²Ù×÷£¬Ö»ÒªÄõ½Ò»¸ö¶ÔÏó£¬È»ºóµ÷ÓøöÔÏóµÄ·½·¨¾ÍºÃÁË£¬Ê£ÏµIJÙ×÷¶¼½»¸øOpenFeignÈ¥°ïÄãÍê³É£¬ÄÇÊ£ÏÂһЩʲô²Ù×÷ÄØ£¿ +说白了,OpenFeign最核心的目标就是让客户端在远程调用过程中ä¸�需è¦�å�šä»€ä¹ˆå¤šä½™çš„æ“�作,å�ªè¦�拿到一个对象,然å�Žè°ƒç”¨è¯¥å¯¹è±¡çš„æ–¹æ³•就好了,剩下的æ“�作都交给OpenFeign去帮你完æˆ�,那剩下一些什么æ“�作呢? -1. Ê×Ïȿ϶¨ÊDZ£Ö¤ÍøÂçͨÐÅ£¬ÄÇÎÒÃǴ󵨵ز²âһϣ¬OpenFeignÆäʵµ×²ã°ïÎÒÃÇ·â×°ÁËÇëÇóµÄµØÖ·¡¢¶Ë¿Ú¡¢ÇëÇó²ÎÊýÒÔ¼°ÏìÓ¦µÄ²ÎÊý¡£ -2. Æä´Î£¬µ±ÎÒÃÇÒªÓöÔÏóÈ¥ÇëÇó·½·¨£¬ÄÇÕâ¸ö¶ÔÏóÊÇÔ¶³ÌµÄ·þÎñ£¬Õâ¸ö¶ÔÏó¿Ï¶¨²»¼òµ¥£¬ÕâÀïÒ²´óµ¨²Â²âһϣ¬¸Ã¶ÔÏóÒ²ÊÇOpenFeign¸øÎÒÃÇ´´½¨µÄ¡£ -3. È»ºóÔÚµ÷Óùý³ÌÖУ¬Èç¹û·þÎñÊÇÓɶą̀·þÎñÆ÷ÌṩµÄ£¬ÄÇÓÖÉæ¼°µ½¸ºÔؾùºâÁË£¬Õâ¿Ï¶¨Ò²ÊÇOpenFeign°ïÎÒÃÇÍê³ÉÁË¡£ -4. ³ýÁËÉÏÃæµÄÎÊÌ⣬ÔÙÁªÏëһϣ¬¼ÈÈ»´æÔÚ·þÎñ¶ËÊǼ¯ÈºµÄÇé¿ö£¬ÄÇ·þÎñ¶ËµÄµØÖ·ºÍ¶Ë¿Ú»¹ÐèÒªÒ»¸ö×¢²áÖÐÐÄÀ´×¢²á£¬Õâ¿Ï¶¨Ò²²»ÄÜÓɿͻ§¶ËÀ´Íê³É£¬ÒòΪ¿Í»§¶ËÖ»¹Ø×¢ÒµÎñ´úÂë¡£ÄÇÏë¶¼²»ÓÃÏ룬ҲÊÇOpenFeignÀ´Íê³ÉÁË¡£ +1. 首先肯定是ä¿�è¯�网络通信,那我们大胆地猜测一下,OpenFeign其实底层帮我们å°�装了请求的地å�€ã€�端å�£ã€�请求å�‚数以å�Šå“�应的å�‚数。 +2. 其次,当我们è¦�用对象去请求方法,那这个对象是远程的æœ�务,这个对象肯定ä¸�简å�•,这里也大胆猜测一下,该对象也是OpenFeign给我们创建的。 +3. ç„¶å�Žåœ¨è°ƒç”¨è¿‡ç¨‹ä¸­ï¼Œå¦‚æžœæœ�务是由多å�°æœ�务器æ��供的,那å�ˆæ¶‰å�Šåˆ°è´Ÿè½½å�‡è¡¡äº†ï¼Œè¿™è‚¯å®šä¹Ÿæ˜¯OpenFeign帮我们完æˆ�了。 +4. 除了上é�¢çš„问题,å†�è�”想一下,既然存在æœ�务端是集群的情况,那æœ�务端的地å�€å’Œç«¯å�£è¿˜éœ€è¦�一个注册中心æ�¥æ³¨å†Œï¼Œè¿™è‚¯å®šä¹Ÿä¸�能由客户端æ�¥å®Œæˆ�,因为客户端å�ªå…³æ³¨ä¸šåС代ç �。那想都ä¸�用想,也是OpenFeignæ�¥å®Œæˆ�了。 -OK£¬ÉÏÃæÍÆµ¼ÁËOpenFeignÓ¦¸ÃÍê³ÉµÄÖ÷ҪĿ±ê£¬½ÓÏÂÀ´ÎÒÃÇÔÙÀ´·ÖÎö·ÖÎöËüÊÇÔõô×öµÄ¡£ -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b45564c706ab4113cc23492cc0796907b851f8.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø")֮ǰµÄÎÄÕÂÓн²¹ýÒ»¸ö¸ÅÄ²»¹ÜÊÇʲô×é¼þ£¬Ö»ÒªÊǼ¯³Éspring»òÕßspringbootµÄ»°£¬ÄÇÒ»¶¨ÊÇÏëͨ¹ýspring»òÕßspringbootÈ¥¹ÜÀíbean¶ÔÏóµÄ´´½¨µÄ£¬µ±Í¨¹ýÈÝÆ÷Äõ½¶ÔÏóÖ®ºóÔÙÈ¥µ÷ÓöÔÏóµÄºËÐÄ·½·¨£¬ÄÇOpenFeignÔÚ¼¯³ÉspringbootµÄʱºòÀíÄîÒ²Ó¦¸ÃÊÇÕâÑù¡£ +OK,上é�¢æŽ¨å¯¼äº†OpenFeign应该完æˆ�的主è¦�目标,接下æ�¥æˆ‘们å†�æ�¥åˆ†æž�分æž�它是怎么å�šçš„。 +![SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b45564c706ab4113cc23492cc0796907b851f8.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区")之å‰�的文章有讲过一个概念,ä¸�管是什么组件,å�ªè¦�是集æˆ�spring或者springbootçš„è¯�,那一定是想通过spring或者springboot去管ç�†bean对象的创建的,当通过容器拿到对象之å�Žå†�去调用对象的核心方法,那OpenFeign在集æˆ�springboot的时候ç�†å¿µä¹Ÿåº”该是这样。 -1. ËùÒÔµÚÒ»²½£¬OpenFeign¼¯³Éspringboot£¬Í¨¹ýspringbootÄõ½ºËÐÄbean¶ÔÏó£¬ÀýÈçÉÏͼÖеÄuserService¶ÔÏó¡£ -2. Õâ¸ö¶ÔÏó¿Ï¶¨²»¼òµ¥£¬²»¿ÉÄÜÖ»ÓÐgetUserµÄ¹¦ÄÜ¡£ÄÇÏëÒ»Ï룬springÖÐ×ö¹¦ÄÜÔöÇ¿¿ÉÒÔÓÃʲôÀ´×öÄØ£¿¡ª¡ª´úÀíÂÄÇÕâ¸ö¶ÔÏóµÄÀàÐ;ͺôÖ®Óû³öÁË£¬´úÀí¶ÔÏó¡£ -3. µ÷ÓôúÀí¶ÔÏóµÄ·½·¨Ê±£¬Á÷³ÌÏȽøÈëµ½invokeÖУ¬ÔÚÕâ¸öinvokeÖУ¬×öµÄÔöÇ¿°üÀ¨Á˸ºÔؾùºâLoadBalance£¬ÒòΪÎÒÔÚÕæÕýµ÷ÓÃgetUserµÄʱºòÒªÖªµÀ¾ßÌåÊǵ÷ÓÃÄĄ̈·þÎñÆ÷µÄ·þÎñ¡£ -4. ¸ºÔؾùºâ×öÍê¾ÍµÃÆ´½Ó¾ßÌåµÄhttpÇëÇó²ÎÊý£¬ÇëÇóÍ·£¬ÇëÇóµØÖ·£¬ÇëÇó¶Ë¿ÚÁË¡£ - OK£¬ÒÔÉÏ·ÖÎöÁËOpenFeignµ×²ãҪʵÏֵľßÌ幦ÄÜ£¬Ò²·ÖÎöÁËËüµÄ´¦ÀíÁ÷³Ì£¬ÄÇô½ÓÏÂÀ´ÎÒÃÇͨ¹ýÔ´ÂëÀ´Ñé֤һϣ¬ËüÊDz»ÊÇÕâÃ´ÍæµÄ¡£ +1. 所以第一步,OpenFeign集æˆ�springboot,通过springboot拿到核心bean对象,例如上图中的userService对象。 +2. 这个对象肯定ä¸�简å�•,ä¸�å�¯èƒ½å�ªæœ‰getUser的功能。那想一想,spring中å�šåŠŸèƒ½å¢žå¼ºå�¯ä»¥ç”¨ä»€ä¹ˆæ�¥å�šå‘¢ï¼Ÿâ€”—代ç�†å˜›ï¼Œé‚£è¿™ä¸ªå¯¹è±¡çš„类型就呼之欲出了,代ç�†å¯¹è±¡ã€‚ +3. 调用代ç�†å¯¹è±¡çš„æ–¹æ³•时,æµ�程先进入到invoke中,在这个invoke中,å�šçš„增强包括了负载å�‡è¡¡LoadBalance,因为我在真正调用getUser的时候è¦�知é�“具体是调用哪å�°æœ�务器的æœ�务。 +4. è´Ÿè½½å�‡è¡¡å�šå®Œå°±å¾—拼接具体的http请求å�‚数,请求头,请求地å�€ï¼Œè¯·æ±‚端å�£äº†ã€‚ + OK,以上分æž�了OpenFeign底层è¦�实现的具体功能,也分æž�了它的处ç�†æµ�程,那么接下æ�¥æˆ‘们通过æº�ç �æ�¥éªŒè¯�一下,它是ä¸�是这么玩的。 -**µÚ2Õ ԴÂëÑéÖ¤** +**第2ç«  æº�ç �验è¯�** -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/93070e354fbacedc2b85274846d2dde7dd170a.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø")**2.1 EnableFeignClients** -ÎÒÃÇ´ÓÏÂÃæÕâ¸ö×¢½â½øÐÐÇÐÈ룬Õâ¸ö×¢½â¿ªÆôÁËFeignClientµÄ½âÎö¹ý³Ì¡£ +![SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/93070e354fbacedc2b85274846d2dde7dd170a.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区")**2.1 EnableFeignClients** +我们从下é�¢è¿™ä¸ªæ³¨è§£è¿›è¡Œåˆ‡å…¥ï¼Œè¿™ä¸ªæ³¨è§£å¼€å�¯äº†FeignClient的解æž�过程。 @@ -44,7 +44,7 @@ OK -Õâ¸ö×¢½âµÄÉùÃ÷ÈçÏ£¬ËüÓõ½ÁËÒ»¸ö@Import×¢½â£¬ÎÒÃÇÖªµÀImportÊÇÓÃÀ´µ¼ÈëÒ»¸öÅäÖÃÀàµÄ£¬½ÓÏÂÀ´È¥¿´Ò»ÏÂFeignClientsRegistrarµÄ¶¨Òå¡£ +这个注解的声明如下,它用到了一个@Import注解,我们知é�“Import是用æ�¥å¯¼å…¥ä¸€ä¸ªé…�置类的,接下æ�¥åŽ»çœ‹ä¸€ä¸‹FeignClientsRegistrar的定义。 @@ -65,8 +65,8 @@ public @interface EnableFeignClients { -FeignClientsRegistrarʵÏÖÁË -ImportBeanDefinitionRegistrar£¬ËüÊÇÒ»¸ö¶¯Ì¬×¢ÈëbeanµÄ½Ó¿Ú£¬Spring BootÆô¶¯µÄʱºò£¬»áÈ¥µ÷ÓÃÕâ¸öÀàÖеÄregisterBeanDefinitionsÀ´ÊµÏÖ¶¯Ì¬BeanµÄ×°ÔØ¡£registerBeanDefinitionsÊÇÔÚspringÈÝÆ÷Æô¶¯Ê±Ö´ÐÐinvokeBeanFactoryPostProcessors·½·¨£¬È»ºó¶ÔÏàÓ¦µÄÀà½øÐнâÎö×¢²á£¬ËüµÄ×÷ÓÃÀàËÆÓÚImportSelector¡£ +FeignClientsRegistrar实现了 +ImportBeanDefinitionRegistrar,它是一个动æ€�注入bean的接å�£ï¼ŒSpring Bootå�¯åŠ¨çš„æ—¶å€™ï¼Œä¼šåŽ»è°ƒç”¨è¿™ä¸ªç±»ä¸­çš„registerBeanDefinitionsæ�¥å®žçŽ°åŠ¨æ€�Bean的装载。registerBeanDefinitions是在spring容器å�¯åŠ¨æ—¶æ‰§è¡ŒinvokeBeanFactoryPostProcessors方法,然å�Žå¯¹ç›¸åº”的类进行解æž�注册,它的作用类似于ImportSelector。 @@ -89,10 +89,10 @@ class FeignClientsRegistrar implements ImportBeanDefinitionRegistrar, ResourceLo **2.1.1 ImportBeanDefinitionRegistrar** -¼òµ¥¸ø´ó¼ÒÑÝʾһÏ -ImportBeanDefinitionRegistrarµÄ×÷Óᣠ+简å�•给大家演示一下 +ImportBeanDefinitionRegistrar的作用。 -* ¶¨ÒåÒ»¸öÐèÒª±»×°Ôص½IOCÈÝÆ÷ÖеÄÀàHelloService +* 定义一个需è¦�被装载到IOC容器中的类HelloService @@ -109,7 +109,7 @@ public class HelloService { -* ¶¨ÒåÒ»¸öRegistrarµÄʵÏÖ£¬¶¨ÒåÒ»¸öbean£¬×°Ôص½IOCÈÝÆ÷ +* 定义一个Registrar的实现,定义一个bean,装载到IOC容器 @@ -132,7 +132,7 @@ public class FeignImportBeanDefinitionRegistrar implements ImportBeanDefinitionR -* ¶¨ÒåÒ»¸ö×¢½âÀà +* 定义一个注解类 @@ -153,7 +153,7 @@ public class FeignImportBeanDefinitionRegistrar implements ImportBeanDefinitionR -* Æô¶¯Àà +* å�¯åŠ¨ç±» @@ -178,23 +178,23 @@ public class OpenfeignUserServiceApplication { -* ͨ¹ý½á¹ûÑÝʾ¿ÉÒÔ·¢ÏÖ£¬HelloServiceÕâ¸öbean ÒѾ­×°Ôص½ÁËIOCÈÝÆ÷¡£ - Õâ¾ÍÊǶ¯Ì¬×°ÔصŦÄÜʵÏÖ£¬ËüÏà±ÈÓÚ@ConfigurationÅäÖÃ×¢È룬»á¶àÁ˺ܶàµÄÁé»îÐÔ¡£ ok£¬Ôٻص½FeignClientµÄ½âÎöÖÐÀ´¡£ +* 通过结果演示å�¯ä»¥å�‘现,HelloService这个bean å·²ç»�装载到了IOC容器。 + 这就是动æ€�装载的功能实现,它相比于@Configurationé…�置注入,会多了很多的ç�µæ´»æ€§ã€‚ ok,å†�回到FeignClient的解æž�中æ�¥ã€‚ **2.1.2 FeignClientsRegistrar** -* registerDefaultConfiguration ·½·¨ÄÚ²¿´Ó SpringBoot Æô¶¯ÀàÉϼì²éÊÇ·ñÓÐ@EnableFeignClients, ÓиÃ×¢½âµÄ»°£¬ ÔòÍê³É Feign ¿ò¼ÜÏà¹ØµÄһЩÅäÖÃÄÚÈÝ×¢²á +* registerDefaultConfiguration 方法内部从 SpringBoot å�¯åŠ¨ç±»ä¸Šæ£€æŸ¥æ˜¯å�¦æœ‰@EnableFeignClients, 有该注解的è¯�, 则完æˆ� Feign 框架相关的一些é…�置内容注册 -* registerFeignClients ·½·¨ÄÚ²¿´Ó classpath ÖУ¬ ɨÃè»ñµÃ @FeignClient ÐÞÊεÄÀ࣬ ½«ÀàµÄÄÚÈݽâÎöΪ BeanDefinition , ×îÖÕͨ¹ýµ÷Óà Spring ¿ò¼ÜÖеÄBeanDefinitionReaderUtils.resgisterBeanDefinition ½«½âÎö´¦Àí¹ýµÄ FeignClientBeanDeifinition Ìí¼Óµ½ spring ÈÝÆ÷ÖÐ. +* registerFeignClients 方法内部从 classpath 中, 扫æ��获得 @FeignClient 修饰的类, 将类的内容解æž�为 BeanDefinition , 最终通过调用 Spring 框架中的BeanDefinitionReaderUtils.resgisterBeanDefinition 将解æž�处ç�†è¿‡çš„ FeignClientBeanDeifinition 添加到 spring 容器中. ``` @Override public void registerBeanDefinitions(AnnotationMetadata metadata,BeanDefinitionRegistry registry) { - //×¢²á@EnableFeignClientsÖж¨ÒådefaultConfigurationÊôÐÔϵÄÀ࣬°ü×°³ÉFeignClientSpecification£¬×¢²áµ½SpringÈÝÆ÷¡£ - //ÔÚ@FeignClientÖÐÓÐÒ»¸öÊôÐÔ£ºconfiguration£¬Õâ¸öÊôÐÔÊDZíʾ¸÷¸öFeignClient×Ô¶¨ÒåµÄÅäÖÃÀ࣬ºóÃæÒ²»áͨ¹ýµ÷ÓÃregisterClientConfiguration·½·¨À´×¢²á³ÉFeignClientSpecificationµ½ÈÝÆ÷¡£ - //ËùÒÔ£¬ÕâÀï¿ÉÒÔÍêÈ«Àí½âÔÚ@EnableFeignClientsÖÐÅäÖõÄÊÇ×öΪ¶µµ×µÄÅäÖã¬ÔÚ¸÷¸ö@FeignClientÅäÖõľÍÊÇ×Ô¶¨ÒåµÄÇé¿ö¡£ + //注册@EnableFeignClients中定义defaultConfiguration属性下的类,包装æˆ�FeignClientSpecification,注册到Spring容器。 + //在@FeignClient中有一个属性:configuration,这个属性是表示å�„个FeignClient自定义的é…�置类,å�Žé�¢ä¹Ÿä¼šé€šè¿‡è°ƒç”¨registerClientConfiguration方法æ�¥æ³¨å†Œæˆ�FeignClientSpecification到容器。 + //所以,这里å�¯ä»¥å®Œå…¨ç�†è§£åœ¨@EnableFeignClients中é…�置的是å�šä¸ºå…œåº•çš„é…�置,在å�„个@FeignClienté…�置的就是自定义的情况。 registerDefaultConfiguration(metadata, registry); registerFeignClients(metadata, registry); } @@ -214,9 +214,9 @@ public class OpenfeignUserServiceApplication { ``` private void registerDefaultConfiguration(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { - // »ñÈ¡µ½metadataÖйØÓÚEnableFeignClientsµÄÊôÐÔÖµ¼üÖµ¶Ô¡£ + // 获å�–到metadata中关于EnableFeignClients的属性值键值对。 Map defaultAttrs = metadata.getAnnotationAttributes(EnableFeignClients.class.getName(), true); - //Èç¹ûÅäÖÃÁËdefaultConfiguration ½øÐÐÅäÖÃ,Èç¹ûûÓÐʹÓÃĬÈϵÄconfiguration + //如果é…�置了defaultConfiguration 进行é…�ç½®,如果没有使用默认的configuration if (defaultAttrs != null && defaultAttrs.containsKey("defaultConfiguration")) { String name; if (metadata.hasEnclosingClass()) { @@ -224,7 +224,7 @@ public class OpenfeignUserServiceApplication { } else { name = "default." + metadata.getClassName(); } - //½øÐÐ×¢²á + //进行注册 this.registerClientConfiguration(registry, name, defaultAttrs.get("defaultConfiguration")); } @@ -243,7 +243,7 @@ public class OpenfeignUserServiceApplication { ``` private void registerClientConfiguration(BeanDefinitionRegistry registry, Object name, Object configuration) { - //ʹÓÃBeanDefinitionBuilderÀ´Éú³ÉBeanDefinition,²¢°ÑËü½øÐÐ×¢²á + //使用BeanDefinitionBuilderæ�¥ç”Ÿæˆ�BeanDefinition,并把它进行注册 BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(FeignClientSpecification.class); builder.addConstructorArgValue(name); builder.addConstructorArgValue(configuration); @@ -259,17 +259,17 @@ private void registerClientConfiguration(BeanDefinitionRegistry registry, Object -·½·¨µÄÈë²ÎBeanDefinitionRegistryÊÇspring¿ò¼ÜÓÃÓÚ¶¯Ì¬×¢²áBeanDefinitionÐÅÏ¢µÄ½Ó¿Ú£¬µ÷ÓÃregisterBeanDefinition·½·¨¿ÉÒÔ½«BeanDefinition×¢²áµ½SpringÈÝÆ÷ÖУ¬ÆäÖÐnameÊôÐÔ¾ÍÊÇ×¢²áµÄBeanDefinitionµÄÃû³Æ£¬ÔÚÕâÀïËü×¢²áÁËÒ»¸öFeignClientSpecificationµÄ¶ÔÏó¡£ +方法的入å�‚BeanDefinitionRegistry是spring框架用于动æ€�注册BeanDefinitionä¿¡æ�¯çš„æŽ¥å�£ï¼Œè°ƒç”¨registerBeanDefinition方法å�¯ä»¥å°†BeanDefinition注册到Spring容器中,其中name属性就是注册的BeanDefinitionçš„å��称,在这里它注册了一个FeignClientSpecification的对象。 -FeignClientSpecificationʵÏÖÁË -NamedContextFactory.Specification½Ó¿Ú£¬ËüÊÇFeignʵÀý»¯µÄÖØÒªÒ»»·£¬ÔÚÉÏÃæµÄ·½·¨ÖУ¬Ëü³ÖÓÐ×Ô¶¨ÒåÅäÖõÄ×é¼þʵÀý£¬SpringCloudʹÓÃNamedContextFactory´´½¨Ò»Ð©ÁеÄÔËÐÐÉÏÏÂÎÄApplicationContextÀ´ÈöÔÓ¦µÄSpecificationÔÚÕâЩÉÏÏÂÎÄÖд´½¨ÊµÀý¶ÔÏó¡£ +FeignClientSpecification实现了 +NamedContextFactory.Specification接å�£ï¼Œå®ƒæ˜¯Feign实例化的é‡�è¦�一环,在上é�¢çš„æ–¹æ³•中,它æŒ�有自定义é…�置的组件实例,SpringCloud使用NamedContextFactory创建一些列的è¿�行上下文ApplicationContextæ�¥è®©å¯¹åº”çš„Specification在这些上下文中创建实例对象。 -NamedContextFactoryÓÐ3¸ö¹¦ÄÜ£º +NamedContextFactory有3个功能: -* ´´½¨AnnotationConfigApplicationContextÉÏÏÂÎÄ¡£ -* ÔÚÉÏÏÂÎÄÖд´½¨²¢»ñÈ¡beanʵÀý¡£ -* µ±ÉÏÏÂÎÄÏú»ÙʱÇå³ýÆäÖеÄfeignʵÀý¡£ - NamedContextFactoryÓиö·Ç³£ÖØÒªµÄ×ÓÀàFeignContext£¬ÓÃÓÚ´æ´¢¸÷ÖÖOpenFeignµÄ×é¼þʵÀý¡£ +* 创建AnnotationConfigApplicationContext上下文。 +* 在上下文中创建并获å�–bean实例。 +* 当上下文销æ¯�时清除其中的feign实例。 + NamedContextFactory有个é�žå¸¸é‡�è¦�çš„å­�ç±»FeignContext,用于存储å�„ç§�OpenFeign的组件实例。 @@ -289,37 +289,37 @@ public class FeignContext extends NamedContextFactory -FeignContextÊÇÄÄÀï¹¹½¨µÄÄØ£¿ +FeignContext是哪里构建的呢? -ÅäÖüû£º -pring-cloud-openfeign-core-2.2.3.RELEASE.jar!\META-INF\spring.factories![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d830f20713aca01438472786f5f84c7058232b.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø")**2.2.1 FeignAutoConfiguration** +é…�ç½®è§�: +pring-cloud-openfeign-core-2.2.3.RELEASE.jar!\META-INF\spring.factories![SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d830f20713aca01438472786f5f84c7058232b.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区")**2.2.1 FeignAutoConfiguration** -![SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/894c73791fbf7215782217d7132bc57f004085.jpg "SpringCloudϵÁСªSpring Cloud Ô´Âë·ÖÎöÖ®OpenFeign-¿ªÔ´»ù´¡Èí¼þÉçÇø") +![SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/894c73791fbf7215782217d7132bc57f004085.jpg "SpringCloud系列—Spring Cloud æº�ç �分æž�之OpenFeign-å¼€æº�基础软件社区") -½«Ä¬ÈϵÄFeignClientsConfiguration×÷Ϊ²ÎÊý´«µÝ¸ø¹¹Ô캯Êý +将默认的FeignClientsConfiguration作为å�‚数传递给构造函数 -FeignContext´´½¨µÄʱºò»á½«Ö®Ç°FeignClientSpecificationͨ¹ýsetConfigurationsÉèÖøøcontextÉÏÏÂÎÄ¡£ +FeignContext创建的时候会将之å‰�FeignClientSpecification通过setConfigurations设置给context上下文。 **2.2.2 createContext** -´úÂëÏê¼û£º -org.springframework.cloud.context.named.NamedContextFactory#createContext·½·¨¡£ +代ç �详è§�: +org.springframework.cloud.context.named.NamedContextFactory#createContext方法。 -FeignContextµÄ¸¸ÀàµÄcreateContext·½·¨»á½«´´½¨ -AnnotationConfigApplicationContextʵÀý£¬ÕâʵÀý½«×÷Ϊµ±Ç°ÉÏÏÂÎĵÄ×ÓÉÏÏÂÎÄ£¬ÓÃÓÚ¹ØÁªfeign×é¼þµÄ²»Í¬ÊµÀý¡£ÔÚµ÷ÓÃFeignClientFactoryBeanµÄgetObject·½·¨Ê±µ÷Óᣣ¨createContextµ÷ÓÃÔÚÏÂÎĻὲ½â£© +FeignContext的父类的createContext方法会将创建 +AnnotationConfigApplicationContext实例,这实例将作为当å‰�上下文的å­�上下文,用于关è�”feign组件的ä¸�å�Œå®žä¾‹ã€‚在调用FeignClientFactoryBeançš„getObject方法时调用。(createContext调用在下文会讲解) ``` protected AnnotationConfigApplicationContext createContext(String name) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); - //»ñÈ¡nameËù¶ÔÓ¦µÄconfiguration,Èç¹ûÓоÍ×¢²áµ½×ÓcontextÖÐ + //获å�–name所对应的configuration,如果有就注册到å­�context中 if (this.configurations.containsKey(name)) { for (Class configuration : this.configurations.get(name) .getConfiguration()) { context.register(configuration); } } - //×¢²ádefaultµÄConfiguration,Ò²¾ÍÊÇ FeignClientsRegistrarÀàÖÐregisterDefaultConfiguration·½·¨ÖÐ×¢²áµÄConfiguration + //注册defaultçš„Configuration,也就是 FeignClientsRegistrar类中registerDefaultConfiguration方法中注册的Configuration for (Map.Entry entry : this.configurations.entrySet()) { if (entry.getKey().startsWith("default.")) { for (Class configuration : entry.getValue().getConfiguration()) { @@ -327,10 +327,10 @@ protected AnnotationConfigApplicationContext createContext(String name) { } } } - //×¢²áPropertyPlaceholderAutoConfiguration + //注册PropertyPlaceholderAutoConfiguration context.register(PropertyPlaceholderAutoConfiguration.class, this.defaultConfigType); - //ÖÃEnvironmentµÄpropertySourcesÊôÐÔÔ´ + //ç½®Environmentçš„propertySources属性æº� context.getEnvironment().getPropertySources().addFirst(new MapPropertySource( this.propertySourceName, Collections.singletonMap(this.propertyName, name))); @@ -355,7 +355,7 @@ protected AnnotationConfigApplicationContext createContext(String name) { -ÓÉÓÚNamedContextFactoryʵÏÖÁËDisposableBean£¬ËùÒÔµ±ÊµÀýÏûÍöµÄʱºò»áµ÷Óà +由于NamedContextFactory实现了DisposableBean,所以当实例消亡的时候会调用 @@ -380,17 +380,17 @@ public void destroy() { -×ܽ᣺NamedContextFactory»á´´½¨³ö -AnnotationConfigApplicationContextʵÀý£¬²¢ÒÔname×÷ΪΨһ±êʶ£¬È»ºóÿ¸öAnnotationConfigApplicationContextʵÀý¶¼»á×¢²á²¿·ÖÅäÖÃÀ࣬´Ó¶ø¿ÉÒÔ¸ø³öһϵÁеĻùÓÚÅäÖÃÀàÉú³ÉµÄ×é¼þʵÀý£¬ÕâÑù¾Í¿ÉÒÔ»ùÓÚnameÀ´¹ÜÀíһϵÁеÄ×é¼þʵÀý£¬Îª²»Í¬µÄFeignClient×¼±¸²»Í¬ÅäÖÃ×é¼þʵÀý¡£ +总结:NamedContextFactory会创建出 +AnnotationConfigApplicationContext实例,并以name作为唯一标识,然å�Žæ¯�个AnnotationConfigApplicationContext实例都会注册部分é…�置类,从而å�¯ä»¥ç»™å‡ºä¸€ç³»åˆ—的基于é…�置类生æˆ�的组件实例,这样就å�¯ä»¥åŸºäºŽnameæ�¥ç®¡ç�†ä¸€ç³»åˆ—的组件实例,为ä¸�å�Œçš„FeignClient准备ä¸�å�Œé…�置组件实例。 **2.3 registerFeignClients** -Õâ¸ö·½·¨Ö÷ÒªÊÇɨÃèÀà·¾¶ÏÂËùÓеÄ@FeignClient×¢½â£¬È»ºó½øÐж¯Ì¬BeanµÄ×¢Èë¡£Ëü×îÖÕ»áµ÷Óà registerFeignClient ·½·¨¡£ +这个方法主è¦�是扫æ��类路径下所有的@FeignClient注解,然å�Žè¿›è¡ŒåЍæ€�Bean的注入。它最终会调用 registerFeignClient 方法。 ``` public void registerFeignClients(AnnotationMetadata metadata,BeanDefinitionRegistry registry) { - //Ê¡ÂÔ´úÂë... + //çœ�略代ç �... registerFeignClient(registry, annotationMetadata, attributes); } ``` @@ -403,7 +403,7 @@ public void registerFeignClients(AnnotationMetadata metadata,BeanDefinitionRegis -ÔÚÕâ¸ö·½·¨ÖУ¬¾ÍÊÇÈ¥×é×°BeanDefinition£¬Ò²¾ÍÊÇBeanµÄ¶¨Ò壬Ȼºó×¢²áµ½Spring IOCÈÝÆ÷¡£ +在这个方法中,就是去组装BeanDefinition,也就是Bean的定义,然å�Žæ³¨å†Œåˆ°Spring IOC容器。 @@ -411,7 +411,7 @@ public void registerFeignClients(AnnotationMetadata metadata,BeanDefinitionRegis private void registerFeignClient(BeanDefinitionRegistry registry,AnnotationMetadata annotationMetadata, Map attributes) { String className = annotationMetadata.getClassName(); BeanDefinitionBuilder definition = BeanDefinitionBuilder.genericBeanDefinition(FeignClientFactoryBean.class); - //Ê¡ÂÔ´úÂë... + //çœ�略代ç �... BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition,className,new String[] { alias }); BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry); } @@ -425,15 +425,15 @@ private void registerFeignClient(BeanDefinitionRegistry registry,AnnotationMetad -ÎÒÃǹØ×¢Ò»Ï£¬BeanDefinitionBuilderÊÇÓÃÀ´¹¹½¨Ò»¸öBeanDefinitionµÄ£¬ËüÊÇͨ¹ýgenericBeanDefinition À´¹¹½¨µÄ£¬²¢ÇÒ´«ÈëÁËÒ»¸öFeignClientFactoryBeanµÄÀà¡£ +我们关注一下,BeanDefinitionBuilder是用æ�¥æž„建一个BeanDefinition的,它是通过genericBeanDefinition æ�¥æž„建的,并且传入了一个FeignClientFactoryBean的类。 -ÎÒÃÇ¿ÉÒÔ·¢ÏÖ£¬FeignClient±»¶¯Ì¬×¢²á³ÉÁËÒ»¸öFactoryBean +我们å�¯ä»¥å�‘现,FeignClient被动æ€�注册æˆ�了一个FactoryBean -> Spring Cloud FengnClientʵ¼ÊÉÏÊÇÀûÓÃSpringµÄ´úÀí¹¤³§À´Éú³É´úÀíÀ࣬ËùÒÔÔÚÕâÀï²Å»á°ÑËùÓеÄFeignClientµÄBeanDefinitionÉèÖÃΪFeignClientFactoryBeanÀàÐÍ£¬¶øFeignClientFactoryBean¼Ì³Ð×ÔFactoryBean£¬ËüÊÇÒ»¸ö¹¤³§Bean¡£ +> Spring Cloud FengnClient实际上是利用Spring的代ç�†å·¥åŽ‚æ�¥ç”Ÿæˆ�代ç�†ç±»ï¼Œæ‰€ä»¥åœ¨è¿™é‡Œæ‰�会把所有的FeignClientçš„BeanDefinition设置为FeignClientFactoryBean类型,而FeignClientFactoryBean继承自FactoryBean,它是一个工厂Bean。 > -> ÔÚSpringÖУ¬FactoryBeanÊÇÒ»¸ö¹¤³§Bean£¬ÓÃÀ´´´½¨´úÀíBean¡£ +> 在Spring中,FactoryBean是一个工厂Bean,用æ�¥åˆ›å»ºä»£ç�†Bean。 > -> ¹¤³§ Bean ÊÇÒ»ÖÖÌØÊâµÄ Bean, ¶ÔÓÚ Bean µÄÏû·ÑÕßÀ´Ëµ£¬ ËûÂß¼­ÉÏÊǸÐÖª²»µ½Õâ¸ö Bean ÊÇÆÕͨµÄ Bean »¹Êǹ¤³§ Bean, Ö»Êǰ´ÕÕÕý³£µÄ»ñÈ¡ Bean ·½Ê½È¥µ÷Ó㬠µ«¹¤³§bean ×îºó·µ»ØµÄʵÀý²»Êǹ¤³§Bean ±¾Éí£¬ ¶øÊÇÖ´Ðй¤³§ Bean µÄ getObject Âß¼­·µ»ØµÄʾÀý¡££¨Ò²¾ÍÊÇÔÚʵÀý»¯¹¤³§BeanµÄʱºò»áÈ¥µ÷ÓÃËüµÄgetObject·½·¨£© +> 工厂 Bean 是一ç§�特殊的 Bean, 对于 Bean 的消费者æ�¥è¯´ï¼Œ 他逻辑上是感知ä¸�到这个 Bean 是普通的 Bean 还是工厂 Bean, å�ªæ˜¯æŒ‰ç…§æ­£å¸¸çš„获å�– Bean æ–¹å¼�去调用, 但工厂bean 最å�Žè¿”回的实例ä¸�是工厂Bean 本身, 而是执行工厂 Bean çš„ getObject 逻辑返回的示例。(也就是在实例化工厂Bean的时候会去调用它的getObject方法) @@ -453,15 +453,15 @@ public static BeanDefinitionBuilder genericBeanDefinition(Class beanClass) { -¼òµ¥À´Ëµ£¬FeignClient±ê×¢µÄÕâ¸ö½Ó¿Ú£¬»áͨ¹ý -FeignClientFactoryBean.getObject()Õâ¸ö·½·¨»ñµÃÒ»¸ö´úÀí¶ÔÏó¡£ +简å�•æ�¥è¯´ï¼ŒFeignClient标注的这个接å�£ï¼Œä¼šé€šè¿‡ +FeignClientFactoryBean.getObject()这个方法获得一个代ç�†å¯¹è±¡ã€‚ **2.3.1 FeignClientFactoryBean.getObject** -getObjectµ÷ÓõÄÊÇgetTarget·½·¨£¬Ëü´ÓapplicationContextÈ¡³öFeignContext£¬FeignContext¼Ì³ÐÁËNamedContextFactory£¬ËüÊÇÓÃÀ´À´Í³Ò»Î¬»¤feignÖи÷¸öfeign¿Í»§¶ËÏ໥¸ôÀëµÄÉÏÏÂÎÄ¡£ +getObject调用的是getTarget方法,它从applicationContextå�–出FeignContext,FeignContext继承了NamedContextFactory,它是用æ�¥æ�¥ç»Ÿä¸€ç»´æŠ¤feign中å�„个feign客户端相互隔离的上下文。 -½Ó×Å£¬¹¹½¨feign.builder£¬ÔÚ¹¹½¨Ê±»áÏòFeignContext»ñÈ¡ÅäÖõÄEncoder£¬DecoderµÈ¸÷ÖÖÐÅÏ¢¡£FeignContextÔÚÉÏÆªÖÐÒѾ­Ìáµ½»áΪÿ¸öFeign¿Í»§¶Ë·ÖÅäÁËÒ»¸öÈÝÆ÷£¬ËüÃǵĸ¸ÈÝÆ÷¾ÍÊÇspringÈÝÆ÷ +接ç�€ï¼Œæž„建feign.builder,在构建时会å�‘FeignContext获å�–é…�置的Encoder,Decoderç­‰å�„ç§�ä¿¡æ�¯ã€‚FeignContext在上篇中已ç»�æ��到会为æ¯�个Feign客户端分é…�了一个容器,它们的父容器就是spring容器 -ÅäÖÃÍêFeign.BuilderÖ®ºó£¬ÔÙÅжÏÊÇ·ñÐèÒªLoadBalance£¬Èç¹ûÐèÒª£¬Ôòͨ¹ýLoadBalanceµÄ·½·¨À´ÉèÖá£Êµ¼ÊÉÏËûÃÇ×îÖÕµ÷ÓõÄÊÇTarget.target()·½·¨¡£ +é…�置完Feign.Builder之å�Žï¼Œå†�判断是å�¦éœ€è¦�LoadBalance,如果需è¦�,则通过LoadBalance的方法æ�¥è®¾ç½®ã€‚实际上他们最终调用的是Target.target()方法。 @@ -471,10 +471,10 @@ public Object getObject() throws Exception { return getTarget(); } T getTarget() { - //ʵÀý»¯FeignÉÏÏÂÎĶÔÏóFeignContext + //实例化Feign上下文对象FeignContext FeignContext context = this.applicationContext.getBean(FeignContext.class); - Feign.Builder builder = feign(context);//¹¹½¨Builder¶ÔÏó - if (!StringUtils.hasText(this.url)) {//Èç¹ûurlΪ¿Õ£¬Ôò×߸ºÔؾùºâ£¬Éú³ÉÓиºÔؾùºâ¹¦ÄܵĴúÀíÀà + Feign.Builder builder = feign(context);//构建Builder对象 + if (!StringUtils.hasText(this.url)) {//如果url为空,则走负载å�‡è¡¡ï¼Œç”Ÿæˆ�有负载å�‡è¡¡åŠŸèƒ½çš„ä»£ç�†ç±» if (!this.name.startsWith("http")) { this.url = "http://" + this.name; } @@ -484,12 +484,12 @@ public Object getObject() throws Exception { this.url += cleanPath(); return (T) loadBalance(builder, context,new HardCodedTarget<>(this.type, this.name,this.url)); } - //Èç¹ûÖ¸¶¨ÁËurl£¬ÔòÉú³ÉĬÈϵĴúÀíÀà + //如果指定了url,则生æˆ�默认的代ç�†ç±» if (StringUtils.hasText(this.url) && !this.url.startsWith("http")) { this.url = "http://" + this.url; } String url = this.url + cleanPath(); - //µ÷ÓÃFeignContextµÄgetInstance·½·¨»ñÈ¡Client¶ÔÏó + //调用FeignContextçš„getInstance方法获å�–Client对象 Client client = getOptional(context, Client.class); if (client != null) { if (client instanceof LoadBalancerFeignClient) { @@ -503,7 +503,7 @@ public Object getObject() throws Exception { client = ((FeignBlockingLoadBalancerClient) client).getDelegate(); } builder.client(client); - }//Éú³ÉĬÈÏ´úÀíÀà + }//生æˆ�默认代ç�†ç±» Targeter targeter = get(context, Targeter.class); return (T) targeter.target(this, builder, context,new HardCodedTarget<>(this.type, this.name,url)); } @@ -518,11 +518,11 @@ public Object getObject() throws Exception { **2.3.2 loadBalance** -Éú³É¾ß±¸¸ºÔؾùºâÄÜÁ¦µÄfeign¿Í»§¶Ë£¬Îªfeign¿Í»§¶Ë¹¹½¨Æð°ó¶¨¸ºÔؾùºâ¿Í»§¶Ë. +生æˆ�具备负载å�‡è¡¡èƒ½åŠ›çš„feign客户端,为feign客户端构建起绑定负载å�‡è¡¡å®¢æˆ·ç«¯. -Client client = (Client)this.getOptional(context, Client.class); ´ÓÉÏÏÂÎÄÖлñȡһ¸öClient£¬Ä¬ÈÏÊÇLoadBalancerFeignClient¡£ +Client client = (Client)this.getOptional(context, Client.class); 从上下文中获å�–一个Client,默认是LoadBalancerFeignClient。 -ËüÊÇÔÚFeignRibbonClientAutoConfigurationÕâ¸ö×Ô¶¯×°ÅäÀàÖУ¬Í¨¹ýImportʵÏÖµÄ +它是在FeignRibbonClientAutoConfiguration这个自动装é…�类中,通过Import实现的 @@ -582,15 +582,15 @@ public T target(FeignClientFactoryBean factory, Feign.Builder feign,FeignCon **2.3.4 ReflectiveFeign.newInstance** -Õâ¸ö·½·¨ÊÇÓÃÀ´´´½¨Ò»¸ö¶¯Ì¬´úÀíµÄ·½·¨£¬ÔÚÉú³É¶¯Ì¬´úÀí֮ǰ£¬»á¸ù¾ÝContractЭÒ飨ЭÒé½âÎö¹æÔò£¬½âÎö½Ó¿ÚÀàµÄ×¢½âÐÅÏ¢£¬½âÎö³ÉÄÚ²¿µÄMethodHandlerµÄ´¦Àí·½Ê½¡£ +这个方法是用æ�¥åˆ›å»ºä¸€ä¸ªåЍæ€�代ç�†çš„æ–¹æ³•,在生æˆ�动æ€�代ç�†ä¹‹å‰�,会根æ�®Contractå��议(å��议解æž�规则,解æž�接å�£ç±»çš„æ³¨è§£ä¿¡æ�¯ï¼Œè§£æž�æˆ�内部的MethodHandler的处ç�†æ–¹å¼�。 -´ÓʵÏֵĴúÂëÖпÉÒÔ¿´µ½ÊìϤµÄProxy.newProxyInstance·½·¨²úÉú´úÀíÀà¡£¶øÕâÀïÐèÒª¶Ôÿ¸ö¶¨ÒåµÄ½Ó¿Ú·½·¨½øÐÐÌØ¶¨µÄ´¦ÀíʵÏÖ£¬ËùÒÔÕâÀï»á³öÏÖÒ»¸öMethodHandlerµÄ¸ÅÄ¾ÍÊǶÔÓ¦·½·¨¼¶±ðµÄInvocationHandler¡£ +从实现的代ç �中å�¯ä»¥çœ‹åˆ°ç†Ÿæ‚‰çš„Proxy.newProxyInstance方法产生代ç�†ç±»ã€‚而这里需è¦�对æ¯�个定义的接å�£æ–¹æ³•进行特定的处ç�†å®žçŽ°ï¼Œæ‰€ä»¥è¿™é‡Œä¼šå‡ºçŽ°ä¸€ä¸ªMethodHandler的概念,就是对应方法级别的InvocationHandler。 ``` public T newInstance(Target target) { - //¸ù¾Ý½Ó¿ÚÀàºÍContractЭÒé½âÎö·½Ê½£¬½âÎö½Ó¿ÚÀàÉϵķ½·¨ºÍ×¢½â£¬×ª»»³ÉÄÚ²¿µÄMethodHandler´¦Àí·½Ê½ + //æ ¹æ�®æŽ¥å�£ç±»å’ŒContractå��议解æž�æ–¹å¼�,解æž�接å�£ç±»ä¸Šçš„æ–¹æ³•和注解,转æ�¢æˆ�内部的MethodHandler处ç�†æ–¹å¼� Map nameToHandler = this.[targetToHandlersByName.apply(target)]; Map methodToHandler = new LinkedHashMap(); List defaultMethodHandlers = new LinkedList(); @@ -609,7 +609,7 @@ public T newInstance(Target target) { } } InvocationHandler handler = this.factory.create(target, methodToHandler); - // »ùÓÚProxy.newProxyInstance Ϊ½Ó¿ÚÀà´´½¨¶¯Ì¬ÊµÏÖ£¬½«ËùÓеÄÇëÇóת»»¸øInvocationHandler ´¦Àí¡£ + // 基于Proxy.newProxyInstance 为接å�£ç±»åˆ›å»ºåЍæ€�实现,将所有的请求转æ�¢ç»™InvocationHandler 处ç�†ã€‚ T proxy = Proxy.newProxyInstance(target.type().getClassLoader(), new Class[]{target.type()}, handler); Iterator var12 = defaultMethodHandlers.iterator(); while(var12.hasNext()) { @@ -628,13 +628,13 @@ public T newInstance(Target target) { -**2.4 ½Ó¿Ú¶¨ÒåµÄ²ÎÊý½âÎö** -¸ù¾ÝFeignClient½Ó¿ÚµÄÃèÊö½âÎö³ö¶ÔÓ¦µÄÇëÇóÊý¾Ý¡£ +**2.4 接å�£å®šä¹‰çš„å�‚æ•°è§£æž�** +æ ¹æ�®FeignClient接å�£çš„æ��è¿°è§£æž�出对应的请求数æ�®ã€‚ **2.4.1 targetToHandlersByName.apply(target)** -¸ù¾ÝContractЭÒ鹿Ôò£¬½âÎö½Ó¿ÚÀàµÄ×¢½âÐÅÏ¢£¬½âÎö³ÉÄÚ²¿±íÏÖ£º +æ ¹æ�®Contractå��议规则,解æž�接å�£ç±»çš„æ³¨è§£ä¿¡æ�¯ï¼Œè§£æž�æˆ�内部表现: -targetToHandlersByName.apply(target);»á½âÎö½Ó¿Ú·½·¨ÉϵÄ×¢½â£¬´Ó¶ø½âÎö³ö·½·¨Á£¶ÈµÄÌØ¶¨µÄÅäÖÃÐÅÏ¢£¬È»ºóÉú²úÒ»¸öSynchronousMethodHandler È»ºóÐèҪά»¤Ò»¸öµÄmap£¬·ÅÈëInvocationHandlerµÄʵÏÖFeignInvocationHandlerÖС£ +targetToHandlersByName.apply(target);会解æž�接å�£æ–¹æ³•上的注解,从而解æž�出方法粒度的特定的é…�置信æ�¯ï¼Œç„¶å�Žç”Ÿäº§ä¸€ä¸ªSynchronousMethodHandler ç„¶å�Žéœ€è¦�维护一个的map,放入InvocationHandler的实现FeignInvocationHandler中。 @@ -674,18 +674,18 @@ public Map apply(Target target) { **2.4.2 SpringMvcContract** -µ±Ç°Spring Cloud ΢·þÎñ½â¾ö·½°¸ÖУ¬ÎªÁ˽µµÍѧϰ³É±¾£¬²ÉÓÃÁËSpring MVCµÄ²¿·Ö×¢½âÀ´Íê³É ÇëÇóÒé½âÎö£¬Ò²¾ÍÊÇ˵ £¬Ð´¿Í»§¶ËÇëÇó½Ó¿ÚºÍÏñд·þÎñ¶Ë´úÂëÒ»Ñù£º¿Í»§¶ËºÍ·þÎñ¶Ë¿ÉÒÔͨ¹ýSDKµÄ·½Ê½½øÐÐÔ¼¶¨£¬¿Í»§¶ËÖ»ÐèÒªÒýÈë·þÎñ¶Ë·¢²¼µÄSDK API£¬¾Í¿ÉÒÔʹÓÃÃæÏò½Ó¿ÚµÄ±àÂ뷽ʽ¶Ô½Ó·þÎñ¡£ +当å‰�Spring Cloud å¾®æœ�务解决方案中,为了é™�低学习æˆ�本,采用了Spring MVC的部分注解æ�¥å®Œæˆ� 请求议解æž�,也就是说 ,写客户端请求接å�£å’Œåƒ�写æœ�务端代ç �一样:客户端和æœ�务端å�¯ä»¥é€šè¿‡SDK的方å¼�进行约定,客户端å�ªéœ€è¦�引入æœ�务端å�‘布的SDK API,就å�¯ä»¥ä½¿ç”¨é�¢å�‘接å�£çš„ç¼–ç �æ–¹å¼�对接æœ�务。 -¸ÃÀà¼Ì³ÐÁËContract.BaseContract²¢ÊµÏÖÁËResourceLoaderAware½Ó¿Ú£¬ +该类继承了Contract.BaseContract并实现了ResourceLoaderAware接å�£ï¼Œ -Æä×÷ÓþÍÊǶÔRequestMapping¡¢RequestParam¡¢RequestHeaderµÈ×¢½â½øÐнâÎöµÄ¡£ +其作用就是对RequestMappingã€�RequestParamã€�RequestHeader等注解进行解æž�的。 -**2.5 OpenFeignµ÷Óùý³Ì** -ÔÚÇ°ÃæµÄ·ÖÎöÖУ¬ÎÒÃÇÖªµÀOpenFeign×îÖÕ·µ»ØµÄÊÇÒ»¸ö# -ReflectiveFeign.FeignInvocationHandlerµÄ¶ÔÏó¡£ +**2.5 OpenFeign调用过程** +在å‰�é�¢çš„分æž�中,我们知é�“OpenFeign最终返回的是一个# +ReflectiveFeign.FeignInvocationHandler的对象。 -ÄÇôµ±¿Í»§¶Ë·¢ÆðÇëÇóʱ£¬»á½øÈëµ½ -FeignInvocationHandler.invoke·½·¨ÖУ¬Õâ¸ö´ó¼Ò¶¼ÖªµÀ£¬ËüÊÇÒ»¸ö¶¯Ì¬´úÀíµÄʵÏÖ¡£ +那么当客户端å�‘起请求时,会进入到 +FeignInvocationHandler.invoke方法中,这个大家都知é�“,它是一个动æ€�代ç�†çš„实现。 @@ -718,9 +718,9 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl -¶ø½Ó×Å£¬ÔÚinvoke·½·¨ÖУ¬»áµ÷Óà this.dispatch.get(method)).invoke(args) ¡£this.dispatch.get(method) »á·µ»ØÒ»¸öSynchronousMethodHandler,½øÐÐÀ¹½Ø´¦Àí¡£ +而接ç�€ï¼Œåœ¨invoke方法中,会调用 this.dispatch.get(method)).invoke(args) 。this.dispatch.get(method) 会返回一个SynchronousMethodHandler,进行拦截处ç�†ã€‚ -Õâ¸ö·½·¨»á¸ù¾Ý²ÎÊýÉú³ÉÍê³ÉµÄRequestTemplate¶ÔÏó£¬Õâ¸ö¶ÔÏóÊÇHttpÇëÇóµÄÄ£°æ£¬´úÂëÈçÏ¡£ +这个方法会根æ�®å�‚数生æˆ�完æˆ�çš„RequestTemplate对象,这个对象是Http请求的模版,代ç �如下。 @@ -761,13 +761,13 @@ public Object invoke(Object[] argv) throws Throwable { **2.5.1 executeAndDecode** -¾­¹ýÉÏÊöµÄ´úÂ룬ÎÒÃÇÒѾ­½«restTemplateÆ´×°Íê³É£¬ÉÏÃæµÄ´úÂëÖÐÓÐÒ»¸ö executeAndDecode() ·½·¨£¬¸Ã·½·¨Í¨¹ýRequestTemplateÉú³ÉRequestÇëÇó¶ÔÏó£¬È»ºóÀûÓÃHttp Client»ñÈ¡response£¬À´»ñÈ¡ÏìÓ¦ÐÅÏ¢¡£ +ç»�过上述的代ç �,我们已ç»�å°†restTemplate拼装完æˆ�,上é�¢çš„代ç �中有一个 executeAndDecode() 方法,该方法通过RequestTemplate生æˆ�Request请求对象,然å�Žåˆ©ç”¨Http Client获å�–response,æ�¥èŽ·å�–å“�应信æ�¯ã€‚ ``` Object executeAndDecode(RequestTemplate template, Options options) throws Throwable { - //ת»¯ÎªHttpÇëÇó±¨ÎÄ + //转化为Http请求报文 Request request = this.targetRequest(template); if (this.logLevel != Level.NONE) { this.logger.logRequest(this.metadata.configKey(), this.logLevel,request); @@ -775,9 +775,9 @@ Object executeAndDecode(RequestTemplate template, Options options) throws Throwa long start = System.nanoTime(); Response response; try { - //·¢ÆðÔ¶³ÌͨÐÅ + //å�‘起远程通信 response = this.client.execute(request, options); - //»ñÈ¡·µ»Ø½á¹û + //获å�–返回结果 response = response.toBuilder().request(request).requestTemplate(template).build(); } catch (IOException var16) { if (this.logLevel != Level.NONE) { @@ -847,7 +847,7 @@ Object executeAndDecode(RequestTemplate template, Options options) throws Throwa **2.5.2 Client.execute** -ĬÈϲÉÓÃJDKµÄ HttpURLConnection ·¢ÆðÔ¶³Ìµ÷Óᣠ+默认采用JDKçš„ HttpURLConnection å�‘起远程调用。 @@ -893,7 +893,7 @@ Response convertResponse(HttpURLConnection connection, Request request) throws I -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRibbon\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRibbon\346\272\220\347\240\201\345\210\206\346\236\220.md" index d06f945..12335dc 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRibbon\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringCloud\346\272\220\347\240\201\345\210\206\346\236\220/SpringCloudRibbon\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,25 +1,25 @@ -**ѧϰĿ±ê** +**学习目标** -1. ÍÆµ¼RibbonµÄºËÐÄÁ÷³Ì -2. ÊÖдһ¸ö¼òÒ×°æµÄRibbon -3. ͨ¹ýÔ´ÂëÑéÖ¤ÍÆµ¼µÄÁ÷³Ì - **µÚ1Õ ºËÐÄÁ÷³ÌÍÆµ¼** - ÆäʵRibbonµÄºËÐÄÁ÷³ÌºÜ¼òµ¥£¬ÎÒÃÇÔÚʹÓùý³ÌÖÐÎ޷ǾÍÊÇÒýÈëÁËÒ»¸öspring-cloud-starter-netflix-ribbonµÄjar°ü£¬È»ºóÔÚ³ÌÐòÆô¶¯µÄʱºò×¢ÈëÁËÒ»¸öRestTemplate¶ÔÏó£¬ÔڸöÔÏóÉÏÃæÔö¼ÓÁËÒ»¸ö@LoadBalanced×¢½â£¬È»ºóÔÚͨ¹ýRestTemplate¶ÔÏóÈ¥µ÷ÓÃURLµÄʱºò¾ÍÄܸù¾Ý²»Í¬µÄ¸ºÔؾùºâ²ßÂÔÈ¥µ÷²»Í¬µÄ·þÎñ£¬ÄÇÕâ¸ö×¢½â£¬»òÕß˵Õâ¸öjar°üµ½µ××öÁËʲôÊÂÇéÄØ£¿ +1. 推导Ribbon的核心æµ�程 +2. 手写一个简易版的Ribbon +3. 通过æº�ç �验è¯�推导的æµ�程 + **第1ç«  核心æµ�程推导** + 其实Ribbon的核心æµ�程很简å�•,我们在使用过程中无é�žå°±æ˜¯å¼•入了一个spring-cloud-starter-netflix-ribbonçš„jar包,然å�Žåœ¨ç¨‹åº�å�¯åŠ¨çš„æ—¶å€™æ³¨å…¥äº†ä¸€ä¸ªRestTemplate对象,在该对象上é�¢å¢žåŠ äº†ä¸€ä¸ª@LoadBalanced注解,然å�Žåœ¨é€šè¿‡RestTemplate对象去调用URL的时候就能根æ�®ä¸�å�Œçš„è´Ÿè½½å�‡è¡¡ç­–略去调ä¸�å�Œçš„æœ�务,那这个注解,或者说这个jar包到底å�šäº†ä»€ä¹ˆäº‹æƒ…呢? -Ê×ÏÈÎÒÃÇÒªÃ÷°×£¬spring-cloud-starter-netflix-ribbonÕâ¸öjar°ü´ÓÃû×ÖÉÏÀ´¿´¾ÍÖªµÀ£¬ËüÊÇ»ùÓÚstarter×é¼þµÄ£¬ÄÇËü¿Ï¶¨ÊÇÒÀ¾ÝspringbootµÄ×Ô¶¯×°ÅäÔ­Àí£¬ÔÚÈÝÆ÷Æô¶¯µÄʱºòÌṩÁËÒ»¸ö×Ô¶¯ÅäÖÃÀ࣬½«ÎÒÃÇËùÐèÒªÓõĶÔÏó×¢Èëµ½IoCÈÝÆ÷ÀïÃæÈ¥ÁË£¬ÕâµãÎãÓ¹ÖÃÒÉ¡£ +首先我们è¦�明白,spring-cloud-starter-netflix-ribbon这个jar包从å��字上æ�¥çœ‹å°±çŸ¥é�“,它是基于starter组件的,那它肯定是ä¾�æ�®springboot的自动装é…�原ç�†ï¼Œåœ¨å®¹å™¨å�¯åŠ¨çš„æ—¶å€™æ��供了一个自动é…�置类,将我们所需è¦�用的对象注入到IoC容器里é�¢åŽ»äº†ï¼Œè¿™ç‚¹æ¯‹åº¸ç½®ç–‘ã€‚ -È»ºóµ±ÒªÓÃRestTemplate¶ÔÏóÈ¥ÇëÇóÄ¿±ê·þÎñµÄʱºò£¬Õâ¸öʱºò£¬ÎÒÃǿ϶¨ÊÇÒªÓÃÕæÊµµÄIPºÍ¶Ë¿ÚÀ´Ìæ»»·þÎñÃû¡£ÕâÒ»²½Æäʵ¾ÍÊǺËÐIJ½Ö裬ËüÒªÔõô×öÄØ£¿ÔõôÔÚÕæÕýÇëÇó֮ǰ½«µØÖ·ºÍ¶Ë¿ÚÀê軻̫×Ó»»³ÉÕæÊµµÄÄØ£¿ +ç„¶å�Žå½“è¦�用RestTemplate对象去请求目标æœ�务的时候,这个时候,我们肯定是è¦�用真实的IP和端å�£æ�¥æ›¿æ�¢æœ�务å��。这一步其实就是核心步骤,它è¦�怎么å�šå‘¢ï¼Ÿæ€Žä¹ˆåœ¨çœŸæ­£è¯·æ±‚之å‰�将地å�€å’Œç«¯å�£ç‹¸çŒ«æ�¢å¤ªå­�æ�¢æˆ�真实的呢? -ÔÚÎÒÃÇÈÕ³£¿ª·¢ÖУ¬ÎÒÃÇÓ¦¸ÃÖªµÀ£¬ÓÐÒ»¸ö¹ýÂËÆ÷ºÍÒ»¸öÀ¹½ØÆ÷Æäʵ¿ÉÒÔ×öµ½Õâ¸ö²Ù×÷£¬¶Ô°É£¬ËùÒÔ£¬Êµ¼ÊÉϾÍÊÇÔÚ»ñÈ¡RestTemplate¶ÔÏóµÄʱºò£¬½«¸Ã¶ÔÏóÀïÃæÌí¼ÓÁËÒ»¸öÀ¹½ØÆ÷£¬µ±RestTemplate¶ÔÏóÖ´ÐÐij¸ö·½·¨µÄʱºò£¬¶¼»áÈ¥À¹½ØÆ÷ÀïÃæÖ´ÐÐÒ»±é¡£È»ºó¾ÍÍêÊÂÁË¡£ +在我们日常开å�‘中,我们应该知é�“,有一个过滤器和一个拦截器其实å�¯ä»¥å�šåˆ°è¿™ä¸ªæ“�作,对å�§ï¼Œæ‰€ä»¥ï¼Œå®žé™…上就是在获å�–RestTemplate对象的时候,将该对象里é�¢æ·»åŠ äº†ä¸€ä¸ªæ‹¦æˆªå™¨ï¼Œå½“RestTemplate对象执行æŸ�个方法的时候,都会去拦截器里é�¢æ‰§è¡Œä¸€é��。然å�Žå°±å®Œäº‹äº†ã€‚ -¾ßÌåµÄÁ÷³ÌÍ¼ÍÆµ¼ÈçÏ£º![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1790fb324161913dd79098940f8102d652cd86.jpg "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")**µÚ2Õ ¼òÒ×°æRibbonʵÏÖ** -¸ù¾ÝÉÏÃæµÄÍÆµ¼¹ý³Ì£¬ÎÒÃǽÓÏÂÀ´À´ÊµÏÖÒ»¸ö¼òÒ×°æµÄRibbon¡£ +具体的æµ�程图推导如下:![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/1790fb324161913dd79098940f8102d652cd86.jpg "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")**第2ç«  简易版Ribbon实现** +æ ¹æ�®ä¸Šé�¢çš„æŽ¨å¯¼è¿‡ç¨‹ï¼Œæˆ‘们接下æ�¥æ�¥å®žçŽ°ä¸€ä¸ªç®€æ˜“ç‰ˆçš„Ribbon。 -¾ßÌåµÄ²½ÖèÎÒÃÇÒªÓÐÇåÎúµÄ˼·£º +具体的步骤我们è¦�有清晰的æ€�路: -1.Ê×ÏÈҪʵÏÖÒ»¸östarter×é¼þ£¬¼¯³ÉÎÒÃÇspringboot£¬ÈÃspringbootÔÚÆô¶¯µÄʱºò¿ÉÒÔÄõ½ÏàÓ¦µÄRestTemplateµÄbean¶ÔÏó¡£´´½¨Ò»¸öMavenµÄquickstartÏîÄ¿ +1.首先è¦�实现一个starter组件,集æˆ�我们springboot,让springboot在å�¯åŠ¨çš„æ—¶å€™å�¯ä»¥æ‹¿åˆ°ç›¸åº”çš„RestTemplateçš„bean对象。创建一个Mavençš„quickstart项目 -2.È»ºóÒý°ü +2.ç„¶å�Žå¼•包 @@ -45,7 +45,7 @@ 2.3.2.RELEASE - + org.springframework.boot @@ -59,7 +59,7 @@ ${spring-boot.version} - + org.springframework.cloud spring-cloud-commons @@ -123,19 +123,19 @@ -3.´´½¨ÅäÖÃÀà +3.创建é…�置类 ``` @Configuration public class MyRibbonAutoConfiguration { - //¼òÒ×°æµÄRibbonÊÇ¿¿Õâ¸öÀàÈ¥Íê³É¸ºÔؾùºâËã·¨ÒÔ¼°ÕæÊµµÄipºÍ¶Ë¿ÚÌæ»»µÄ + //简易版的Ribbon是é� è¿™ä¸ªç±»åŽ»å®Œæˆ�è´Ÿè½½å�‡è¡¡ç®—法以å�ŠçœŸå®žçš„ip和端å�£æ›¿æ�¢çš„ @Bean public LoadBalancerClient loadBalancerClient(){ return new MyLoadBalancerClient(); } - //ÊÕ¼¯ËùÓдøMyLoadBalanced×¢½âµÄRestTemplate¶ÔÏó + //收集所有带MyLoadBalanced注解的RestTemplate对象 @MyLoadBalanced @Autowired(required = false) private List restTemplates = Collections.emptyList(); @@ -145,14 +145,14 @@ public class MyRibbonAutoConfiguration { LoadBalancerClient loadBalancerClient) { return new LoadBalancerRequestFactory(loadBalancerClient); } - //Õâ¾ÍÊǺËÐĵÄÀ¹½ØÆ÷ + //这就是核心的拦截器 @Bean public MyLoadBalancerInterceptor myLoadBalancerInterceptor( LoadBalancerClient loadBalancerClient, LoadBalancerRequestFactory requestFactory){ return new MyLoadBalancerInterceptor(loadBalancerClient,requestFactory); } - //ÊÕ¼¯µ½µÄRestTemplate¶ÔÏó£¬ÔÚÕâÀï¶¼»áÅäÖÃÒ»¸öÀ¹½ØÆ÷ + //收集到的RestTemplate对象,在这里都会é…�置一个拦截器 @Bean public SmartInitializingSingleton smartInitializingSingleton( final MyLoadBalancerInterceptor myLoadBalancerInterceptor){ @@ -176,7 +176,7 @@ public class MyRibbonAutoConfiguration { -4.´´½¨MyLoadBalancerClient +4.创建MyLoadBalancerClient @@ -184,13 +184,13 @@ public class MyRibbonAutoConfiguration { public class MyLoadBalancerClient implements LoadBalancerClient { @Autowired AbstractEnvironment environment; - //1.ÔÚÀ¹½ØÆ÷ÀïÃæ»áµ÷ÓÃÕâ¸ö·½·¨ + //1.在拦截器里é�¢ä¼šè°ƒç”¨è¿™ä¸ªæ–¹æ³• @Override public T execute(String serviceId, LoadBalancerRequest request) throws IOException { ServiceInstance server = this.choose(serviceId); return execute(serviceId, server, request); } - //3.ÕæÕýÖ´ÐÐHttpÇëÇó + //3.真正执行Http请求 @Override public T execute(String serviceId, ServiceInstance serviceInstance, LoadBalancerRequest request) throws IOException { T returnVal = null; @@ -201,7 +201,7 @@ public class MyLoadBalancerClient implements LoadBalancerClient { } return returnVal; } - //4.ÕâÒ»²½¾ÍÊÇÓÃÕæÊµµÄipºÍportÌæ»»·þÎñÃû + //4.这一步就是用真实的ipå’Œport替æ�¢æœ�务å�� @Override public URI reconstructURI(ServiceInstance instance, URI original) { String host = instance.getHost(); @@ -234,7 +234,7 @@ public class MyLoadBalancerClient implements LoadBalancerClient { throw new RuntimeException(e); } } - //2.¸ºÔؾùºâËã·¨ÔÚÕâÒ»²½½øÐзþÎñµÄipºÍ¶Ë¿ÚÑ¡Ôñ£¬ÎÒÕâÀïÓõÄÊÇËæ»úËã·¨ + //2.è´Ÿè½½å�‡è¡¡ç®—法在这一步进行æœ�务的ip和端å�£é€‰æ‹©ï¼Œæˆ‘这里用的是éš�机算法 @Override public ServiceInstance choose(String serviceId) { Server instance = new Server(serviceId,null,"127.0.0.1",8080); @@ -261,7 +261,7 @@ public class MyLoadBalancerClient implements LoadBalancerClient { -5.À¹½ØÆ÷µÄÂß¼­ÆäʵºÜ¼òµ¥£¬¾ÍÊÇÔÚÕæÕý·¢ËÍhttpÇëÇó֮ǰÏÈÀ´Ö´ÐÐÎÒµÄÂß¼­ +5.拦截器的逻辑其实很简å�•,就是在真正å�‘é€�http请求之å‰�å…ˆæ�¥æ‰§è¡Œæˆ‘的逻辑 @@ -292,7 +292,7 @@ public class MyLoadBalancerInterceptor implements ClientHttpRequestInterceptor { -6.¶¨Òå×Ô¼ºµÄ×¢½â +6.定义自己的注解 @@ -314,7 +314,7 @@ public @interface MyLoadBalanced { -7.¶¨ÒåÒ»¸ö×Ô¼ºµÄServerʵÌåÀà +7.定义一个自己的Server实体类 @@ -387,7 +387,7 @@ public class Server implements ServiceInstance { -8.дspring.factoriesÎļþ +8.写spring.factories文件 @@ -404,7 +404,7 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ -9.´ò³Éjar°ü£¬²âÊÔ£¬²âÊÔµÄʱºò£¬ÐèÒª¼ÓÅäÖÃÎļþ +9.打æˆ�jar包,测试,测试的时候,需è¦�加é…�置文件 @@ -420,9 +420,9 @@ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ -**µÚ3Õ ԴÂëÑéÖ¤** +**第3ç«  æº�ç �验è¯�** **3.1 @LoadBalanced** -´ÓÉϽڿεĴúÂë¿´£¬ÎÒÃÇÖ»ÊÇÔÚRestTemplateÉÏÃæ¼ÓÁËÒ»¸ö@LoadBalance,¾Í¿ÉÒÔʵÏÖ¸ºÔؾùºâÁË£¬¿ÉÊÇÎÒÃǵã»÷½øÈë@LoadBalance¿´ÁËһϣ¬ÔÚÕâ¸ö×¢½âÀïÃæÓÐÒ»¸ö@Qualifier×¢½â¡£¸Ã×¢½âÏÞ¶¨ÄĸöbeanÓ¦¸Ã±»×Ô¶¯×¢Èë¡£µ±SpringÎÞ·¨ÅжϳöÄĸöbeanÓ¦¸Ã±»×¢Èëʱ£¬@Qualifier×¢½âÓÐÖúÓÚÏû³ýÆçÒåbeanµÄ×Ô¶¯×¢È룬Àý×Ó¼û´úÂë¡£ +从上节课的代ç �看,我们å�ªæ˜¯åœ¨RestTemplate上é�¢åŠ äº†ä¸€ä¸ª@LoadBalance,å°±å�¯ä»¥å®žçŽ°è´Ÿè½½å�‡è¡¡äº†ï¼Œå�¯æ˜¯æˆ‘们点击进入@LoadBalance看了一下,在这个注解里é�¢æœ‰ä¸€ä¸ª@Qualifier注解。该注解é™�定哪个bean应该被自动注入。当Spring无法判断出哪个bean应该被注入时,@Qualifier注解有助于消除歧义bean的自动注入,例å­�è§�代ç �。 @@ -450,10 +450,10 @@ public @interface LoadBalanced { -´Ó×¢ÊÍÖпÉÒÔÖªµÀ£¬Õâ¸ö×¢½âÊÇÓÃÀ´¸øRestTemplate×ö±ê¼Ç£¬ÒÔʹÓøºÔؾùºâ¿Í»§¶Ë£¨LoadBalancerClient£©À´ÅäÖÃËü¡£ËùÒÔ£¬ÎÒÃÇÔÚÉú³ÉµÄRestTemplateµÄbeanÉÏÌí¼ÓÕâôһ¸ö×¢½â£¬Õâ¸öbean¾Í»áÅäÖÃLoadBalancerClient¡£ +从注释中å�¯ä»¥çŸ¥é�“,这个注解是用æ�¥ç»™RestTemplateå�šæ ‡è®°ï¼Œä»¥ä½¿ç”¨è´Ÿè½½å�‡è¡¡å®¢æˆ·ç«¯ï¼ˆLoadBalancerClient)æ�¥é…�置它。所以,我们在生æˆ�çš„RestTemplateçš„bean上添加这么一个注解,这个bean就会é…�ç½®LoadBalancerClient。 **3.2 LoadBalancerClient** -ÄÇô£¬¾ÍÔÙ¿´ÏÂLoadBalancerClientµÄ´úÂ룺 +那么,就å†�看下LoadBalancerClient的代ç �: @@ -477,14 +477,14 @@ public interface ServiceInstanceChooser { -LoadBalancerClientÊÇÒ»¸ö½Ó¿Ú£¬ÀïÃæÓÐÈý¸ö·½·¨¡£ +LoadBalancerClient是一个接å�£ï¼Œé‡Œé�¢æœ‰ä¸‰ä¸ªæ–¹æ³•。 -ServiceInstance choose(String serviceId);´Ó·½·¨ÃûÉϾͿÉÒÔ¿´³ö£¬ÊǸù¾Ý´«ÈëµÄserviceId£¨·þÎñÃû£©£¬´Ó¸ºÔؾùºâÆ÷ÖÐÑ¡ÔñÒ»¸ö·þÎñʵÀý£¬·þÎñʵÀýͨ¹ýServiceInstanceÀàÀ´±íʾ¡£ -execute·½·¨£¬Ê¹ÓôӸºÔؾùºâÆ÷ÖÐÑ¡ÔñµÄ·þÎñʵÀýÀ´Ö´ÐÐÇëÇóÄÚÈÝ¡£ -URI reconstructURI(ServiceInstance instance, URI original);·½·¨£¬ÊÇÖØÐ¹¹½¨Ò»¸öURIµÄ£¬»¹¼ÇµÃÎÒÃÇÔÚ´úÂëÖУ¬Í¨¹ýRestTemplateÇëÇó·þÎñʱ£¬Ð´µÄÊÇ·þÎñÃû°É£¬Õâ¸ö·½·¨¾Í»á°ÑÕâ¸öÇëÇóµÄURI½øÐÐת»»£¬·µ»Øhost+port£¬Í¨¹ýhost+portµÄÐÎʽȥÇëÇó·þÎñ¡£ -**3.3 ×Ô¶¯×°Åä** -µ±springbootÆô¶¯Ö®ºó£¬»áͨ¹ý×Ô¶¯×°Åä×Ô¶¯È¥ -spring-cloud-netflix-ribbonÕâ¸öjar°üµÄMETA-INFĿ¼ÕÒspring.factoriesÎļþ£¬²¢ÇÒ½«RibbonAutoConfigurationÅäÖÃÀà½øÐÐ×¢Èë¡£¶øÔÚRibbonAutoConfigurationÅäÖÃÀàÖÐÒòΪ´æÔÚ@AutoConfigureBefore×¢½â£¬ËùÒÔÓÖ»á¼ÓÔØLoadBalancerAutoConfigurationÅäÖÃÀà¡£ÔÚLoadBalancerAutoConfigurationÀàÖУ¬springÈÝÆ÷»á½«ËùÓб»@LoadBalance×¢½âÐÞÊεÄbean×¢Èëµ½IOCÈÝÆ÷ÖÐ +ServiceInstance choose(String serviceId);从方法å��上就å�¯ä»¥çœ‹å‡ºï¼Œæ˜¯æ ¹æ�®ä¼ å…¥çš„serviceId(æœ�务å��),从负载å�‡è¡¡å™¨ä¸­é€‰æ‹©ä¸€ä¸ªæœ�务实例,æœ�务实例通过ServiceInstanceç±»æ�¥è¡¨ç¤ºã€‚ +execute方法,使用从负载å�‡è¡¡å™¨ä¸­é€‰æ‹©çš„æœ�务实例æ�¥æ‰§è¡Œè¯·æ±‚内容。 +URI reconstructURI(ServiceInstance instance, URI original);方法,是é‡�新构建一个URI的,还记得我们在代ç �中,通过RestTemplate请求æœ�务时,写的是æœ�务å��å�§ï¼Œè¿™ä¸ªæ–¹æ³•就会把这个请求的URI进行转æ�¢ï¼Œè¿”回host+port,通过host+port的形å¼�去请求æœ�务。 +**3.3 自动装é…�** +当springbootå�¯åЍ之å�Žï¼Œä¼šé€šè¿‡è‡ªåŠ¨è£…é…�自动去 +spring-cloud-netflix-ribbon这个jar包的META-INF目录找spring.factories文件,并且将RibbonAutoConfigurationé…�置类进行注入。而在RibbonAutoConfigurationé…�置类中因为存在@AutoConfigureBefore注解,所以å�ˆä¼šåŠ è½½LoadBalancerAutoConfigurationé…�置类。在LoadBalancerAutoConfiguration类中,spring容器会将所有被@LoadBalance注解修饰的bean注入到IOC容器中 @@ -502,9 +502,9 @@ private List restTemplates = Collections.emptyList(); -ͬʱ£¬ÔÚLoadBalancerAutoConfigurationÅäÖÃÀàÖл¹»áΪÿ¸öRestTemplateʵÀýÌí¼ÓLoadBalancerInterceptorÀ¹½ØÆ÷¡£ +å�Œæ—¶ï¼Œåœ¨LoadBalancerAutoConfigurationé…�置类中还会为æ¯�个RestTemplate实例添加LoadBalancerInterceptor拦截器。 -ÔÚRibbonAutoConfigurationÀàÖÐ×¢ÈëÁËLoadBalancerClient½Ó¿ÚµÄʵÏÖÀàRibbonLoadBalancerClient +在RibbonAutoConfiguration类中注入了LoadBalancerClient接å�£çš„实现类RibbonLoadBalancerClient @@ -524,14 +524,14 @@ public LoadBalancerClient loadBalancerClient() { -**3.4 À¹½ØÆ÷** -ÓÉÓÚÔÚ×Ô¶¯ÅäÖÃÀàÖУ¬¶ÔrestTemplateʵÀýÌí¼ÓÁËLoadBalancerInterceptorÀ¹½ØÆ÷£¬ËùÒÔ£¬µ±ÓÃrestTemplate·¢ËÍhttpÇëÇóʱ£¬¾Í»áÖ´ÐÐÕâ¸öÀ¹½ØÆ÷µÄintercept·½·¨¡£ +**3.4 拦截器** +由于在自动é…�置类中,对restTemplate实例添加了LoadBalancerInterceptor拦截器,所以,当用restTemplateå�‘é€�http请求时,就会执行这个拦截器的intercept方法。 -intercept·½·¨ÖУ¬»á¸ù¾Ýrequest.getURI()£¬»ñÈ¡ÇëÇóµÄuri£¬ÔÙ»ñÈ¡host£¬ÎÒÃÇÔÚ·¢ËÍhttpÇëÇóµÄʱºò£¬ÊÇÓõķþÎñÃû×÷Ϊhost£¬ËùÒÔ£¬ÕâÀï¾Í»áÄõ½·þÎñÃû£¬ÔÙµ÷ÓþßÌåLoadBalancerClientʵÀýµÄexecute·½·¨£¬·¢ËÍÇëÇó¡£ +intercept方法中,会根æ�®request.getURI(),获å�–请求的uri,å†�获å�–host,我们在å�‘é€�http请求的时候,是用的æœ�务å��作为host,所以,这里就会拿到æœ�务å��,å†�调用具体LoadBalancerClient实例的execute方法,å�‘é€�请求。 -LoadBalancerClientµÄʵÏÖÀàΪRibbonLoadBalancerClient£¬×îÖյĸºÔؾùºâÇëÇóÓÉËüÀ´Ö´ÐУ¬ËùÒÔ£¬»¹ÐèÒªÔÙÊáÀíÏÂRibbonLoadBalancerClientµÄÂß¼­¡£ +LoadBalancerClient的实现类为RibbonLoadBalancerClient,最终的负载å�‡è¡¡è¯·æ±‚由它æ�¥æ‰§è¡Œï¼Œæ‰€ä»¥ï¼Œè¿˜éœ€è¦�å†�梳ç�†ä¸‹RibbonLoadBalancerClient的逻辑。 -ÏÈ¿´ÏÂRibbonLoadBalancerClientÖеÄexecute·½·¨£º +先看下RibbonLoadBalancerClient中的execute方法: @@ -590,7 +590,7 @@ public T execute(String serviceId, ServiceInstance serviceInstance, -·þÎñÃû×÷ΪserviceId×ֶδ«½øÀ´£¬ÏÈͨ¹ýgetLoadBalancer»ñÈ¡loadBalancer£¬ÔÙ¸ù¾ÝloadBalancer»ñÈ¡server£¬ÏÂÃæÊÇgetServerµÄ´úÂ룺 +æœ�务å��作为serviceId字段传进æ�¥ï¼Œå…ˆé€šè¿‡getLoadBalancer获å�–loadBalancer,å†�æ ¹æ�®loadBalancer获å�–server,下é�¢æ˜¯getServer的代ç �: @@ -612,9 +612,9 @@ protected Server getServer(ILoadBalancer loadBalancer, Object hint) { -Èç¹ûloadBalancerΪ¿Õ£¬¾ÍÖ±½Ó·µ»Ø¿Õ£¬·ñÔò¾Íµ÷ÓÃloadBalancerµÄchooseServer·½·¨£¬»ñÈ¡ÏàÓ¦µÄserver¡£ +如果loadBalancer为空,就直接返回空,å�¦åˆ™å°±è°ƒç”¨loadBalancerçš„chooseServer方法,获å�–相应的server。 -¿´Ò»ÏÂILoadBalancerÊÇÒ»¸ö½Ó¿Ú£¬ÀïÃæÉùÃ÷ÁËһϵÁиºÔؾùºâʵÏֵķ½·¨£º +看一下ILoadBalancer是一个接å�£ï¼Œé‡Œé�¢å£°æ˜Žäº†ä¸€ç³»åˆ—è´Ÿè½½å�‡è¡¡å®žçŽ°çš„æ–¹æ³•ï¼š @@ -638,8 +638,8 @@ public interface ILoadBalancer { -ÕâЩ·½·¨Ãû±È½ÏÖ±¹Û£¬ºÜÈÝÒ×¾ÍÄܲ³öÊǸÉɶµÄ£¬addServersÊÇÓÃÀ´Ìí¼ÓÒ»¸öserver¼¯ºÏ£¬chooseServerÊÇÑ¡ÔñÒ»¸öserver£¬markServerDownÓÃÀ´±ê¼Çij¸ö·þÎñÏÂÏߣ¬getReachableServers»ñÈ¡¿ÉÓõÄServer¼¯ºÏ£¬getAllServersÊÇ»ñÈ¡ËùÓеÄserver¼¯ºÏ¡£ -ILoadBalancerÓкܶàʵÏÖ£¬ÄǾßÌåÊÇÓõÄÄĸöÀàÄØ£¬ÔÚRibbonAutoConfigurationÀàÖÐ×¢ÈëSpringClientFactory£¬Í¨¹ýRibbonClientConfigurationÀà¿´µ½£¬Õâ¸öÅäÖÃÀàÔÚ³õʼ»¯µÄʱºò£¬·µ»ØÁËZoneAwareLoadBalancer×÷Ϊ¸ºÔؾùºâÆ÷¡£ +这些方法å��比较直观,很容易就能猜出是干啥的,addServers是用æ�¥æ·»åŠ ä¸€ä¸ªserver集å�ˆï¼ŒchooseServer是选择一个server,markServerDown用æ�¥æ ‡è®°æŸ�个æœ�务下线,getReachableServers获å�–å�¯ç”¨çš„Server集å�ˆï¼ŒgetAllServers是获å�–所有的server集å�ˆã€‚ +ILoadBalancer有很多实现,那具体是用的哪个类呢,在RibbonAutoConfiguration类中注入SpringClientFactory,通过RibbonClientConfiguration类看到,这个é…�置类在åˆ�始化的时候,返回了ZoneAwareLoadBalancer作为负载å�‡è¡¡å™¨ã€‚ @@ -666,19 +666,19 @@ public ILoadBalancer ribbonLoadBalancer(IClientConfig config, **3.5 ZoneAwareLoadBalancer** -ZoneAwareLoadBalancer´ÓÃû×ÖÖпÉÒÔ¿´³öÀ´£¬Õâ¸ö¸ºÔؾùºâÆ÷ºÍzoneÊÇÓйØÏµµÄ¡£ÏÂÃæ¿´ÏÂZoneAwareLoadBalancerÖеÄchooseServer·½·¨£º +ZoneAwareLoadBalancer从å��字中å�¯ä»¥çœ‹å‡ºæ�¥ï¼Œè¿™ä¸ªè´Ÿè½½å�‡è¡¡å™¨å’Œzone是有关系的。下é�¢çœ‹ä¸‹ZoneAwareLoadBalancer中的chooseServer方法: -> eurekaÌṩÁËregionºÍzoneÁ½¸ö¸ÅÄîÀ´½øÐзÖÇø£¬ÕâÁ½¸ö¸ÅÄî¾ùÀ´×ÔÓÚÑÇÂíÑ·µÄAWS£º -> region£º¿ÉÒÔ¼òµ¥Àí½âΪµØÀíÉϵķÖÇø£¬±ÈÈçÑÇÖÞµØÇø£¬»òÕß»ª±±µØÇø£¬ÔÙ»òÕß±±¾©µÈµÈ£¬Ã»ÓоßÌå´óСµÄÏÞÖÆ¡£¸ù¾ÝÏîÄ¿¾ßÌåµÄÇé¿ö£¬¿ÉÒÔ×ÔÐкÏÀí»®·Öregion¡£ -> zone£º¿ÉÒÔ¼òµ¥Àí½âΪregionÄڵľßÌå»ú·¿£¬±ÈÈç˵region»®·ÖΪ±±¾©£¬È»ºó±±¾©ÓÐÁ½¸ö»ú·¿£¬¾Í¿ÉÒÔÔÚ´Ëregion֮ϻ®·Ö³özone1,zone2Á½¸özone¡£ +> eurekaæ��供了regionå’Œzone两个概念æ�¥è¿›è¡Œåˆ†åŒºï¼Œè¿™ä¸¤ä¸ªæ¦‚念å�‡æ�¥è‡ªäºŽäºšé©¬é€Šçš„AWS: +> region:å�¯ä»¥ç®€å�•ç�†è§£ä¸ºåœ°ç�†ä¸Šçš„分区,比如亚洲地区,或者å�ŽåŒ—地区,å†�或者北京等等,没有具体大å°�çš„é™�制。根æ�®é¡¹ç›®å…·ä½“的情况,å�¯ä»¥è‡ªè¡Œå�ˆç�†åˆ’分region。 +> zone:å�¯ä»¥ç®€å�•ç�†è§£ä¸ºregion内的具体机房,比如说region划分为北京,然å�ŽåŒ—京有两个机房,就å�¯ä»¥åœ¨æ­¤region之下划分出zone1,zone2两个zone。 ``` @Override public Server chooseServer(Object key) { - //Ö»Óе±¸ºÔؾùºâÆ÷ÖÐά»¤µÄʵÀýËùÊôµÄZoneÇøÓòµÄ¸öÊý´óÓÚ1µÄʱºò²Å»áÖ´ÐÐÑ¡Ôñ²ßÂÔ - //·ñÔò»¹ÊÇʹÓø¸ÀàµÄʵÏÖ + //å�ªæœ‰å½“è´Ÿè½½å�‡è¡¡å™¨ä¸­ç»´æŠ¤çš„实例所属的Zone区域的个数大于1的时候æ‰�会执行选择策略 + //å�¦åˆ™è¿˜æ˜¯ä½¿ç”¨çˆ¶ç±»çš„实现 if (!ENABLED.get() || getLoadBalancerStats().getAvailableZones().size() <= 1) { logger.debug("Zone aware logic disabled or there is only one zone"); return super.chooseServer(key); @@ -686,7 +686,7 @@ public Server chooseServer(Object key) { Server server = null; try { LoadBalancerStats lbStats = getLoadBalancerStats(); - //Ϊµ±Ç°¸ºÔؾùºâÆ÷ÖеÄËùÓÐZoneÇøÓò·Ö±ð´´½¨¿ìÕÕ£¬±£´æÔÚzoneSnapshotÖУ¬ÕâЩ¿ìÕÕÖеÄÊý¾ÝÓÃÓÚºóÐøµÄËã·¨ + //为当å‰�è´Ÿè½½å�‡è¡¡å™¨ä¸­çš„æ‰€æœ‰Zone区域分别创建快照,ä¿�存在zoneSnapshot中,这些快照中的数æ�®ç”¨äºŽå�Žç»­çš„算法 Map zoneSnapshot = ZoneAvoidanceRule.createSnapshot(lbStats); logger.debug("Zone snapshots: {}", zoneSnapshot); if (triggeringLoad == null) { @@ -698,18 +698,18 @@ public Server chooseServer(Object key) { triggeringBlackoutPercentage = DynamicPropertyFactory.getInstance().getDoubleProperty( "ZoneAwareNIWSDiscoveryLoadBalancer." + this.getName() + ".avoidZoneWithBlackoutPercetage", 0.99999d); } - //»ñµÃ¿ÉÓÃZoneÇøÓòµÄ¼¯ºÏ£¬getAvailableZones»áͨ¹ýzoneSnapshotʵÏÖ¿ÉÓÃÇøÓòÌôÑ¡ + //获得å�¯ç”¨Zone区域的集å�ˆï¼ŒgetAvailableZones会通过zoneSnapshot实现å�¯ç”¨åŒºåŸŸæŒ‘选 Set availableZones = ZoneAvoidanceRule.getAvailableZones(zoneSnapshot, triggeringLoad.get(), triggeringBlackoutPercentage.get()); logger.debug("Available zones: {}", availableZones); if (availableZones != null && availableZones.size() < zoneSnapshot.keySet().size()) { - //Ëæ»úÑ¡ÔñÒ»¸öZoneÇøÓò + //éš�机选择一个Zone区域 String zone = ZoneAvoidanceRule.randomChooseZone(zoneSnapshot, availableZones); logger.debug("Zone chosen: {}", zone); if (zone != null) { - //»ñµÃ¶ÔÓ¦ÇøÓòµÄ¸ºÔؾùºâÆ÷ + //获得对应区域的负载å�‡è¡¡å™¨ BaseLoadBalancer zoneLoadBalancer = getLoadBalancer(zone); - //Ñ¡Ôñ¾ßÌåµÄ·þÎñʵÀý - //ÔÚchooseServerÖн«»áʹÓÃIRule½Ó¿ÚµÄchooseº¯ÊýÀ´Ñ¡Ôñ¾ßÌå·þÎñʵÀý¡£ÔÚÕâÀIRule½Ó¿ÚµÄʵÏÖ»áʵÏÖZoneAvoidanceRuleÀ´ÌôÑ¡¾ßÌåµÄ·þÎñʵÀý¡£ + //选择具体的æœ�务实例 + //在chooseServer中将会使用IRule接å�£çš„choose函数æ�¥é€‰æ‹©å…·ä½“æœ�务实例。在这里,IRule接å�£çš„实现会实现ZoneAvoidanceRuleæ�¥æŒ‘选具体的æœ�务实例。 server = zoneLoadBalancer.chooseServer(key); } } @@ -733,69 +733,69 @@ public Server chooseServer(Object key) { -Õâ¸ö·½·¨»á¸ù¾ÝserverµÄzoneºÍ¿ÉÓÃÐÔÀ´Ñ¡Ôñ¾ßÌåµÄʵÀý£¬·µ»ØÒ»¸öServer¶ÔÏó¡£ +这个方法会根æ�®serverçš„zoneå’Œå�¯ç”¨æ€§æ�¥é€‰æ‹©å…·ä½“的实例,返回一个Server对象。 -Õâ¸öÀàÀïÃæµÄ¼¸¸ö·½·¨£º +这个类里é�¢çš„几个方法: -1. setServerListForZones : Õâ¸ö»ùÓÚZone½øÐзþÎñ»®·Ö -2. chooseServerÕâÀïÒ²ÊÇÖ÷Òª¸úzoneÓйصļÆË㣬µ±È»Ä¬ÈϵÄZoneÖ»ÓÐÒ»¸ö£¬ËùÒÔÖ±½ÓÊǵ÷Óõĸ¸ÀàµÄchooseServer£¨key) -3. getLoadBalancer(String zone) »ùÓÚzoneÈ¥»ñÈ¡LoadBalancer -4. setRule(IRule rule) Ϊÿ¸ö¸ºÔؾùºâÆ÷ÉèÖùæÔò¡£ - ÕâÀï¿ÉÒÔ¿´µ½£¬ÆäʵÕâ¸öÖ÷ÒªÊÇÕë¶ÔZone×öÁËһЩ·ÖÀà´¦Àí£¬¾ÍÊǽ«Ô­À´ÊôÓÚͬһ·þÎñµÄ·þÎñʵÀý£¬ÔÙ¸ù¾ÝµØÇø½øÐл®·Ö¡£ÕâÒ²ÊÇΪÁËÄܹ»¿ìËÙÏìÓ¦¶øÉèÖõġ£ +1. setServerListForZones : 这个基于Zone进行æœ�务划分 +2. chooseServer这里也是主è¦�è·Ÿzone有关的计算,当然默认的Zoneå�ªæœ‰ä¸€ä¸ªï¼Œæ‰€ä»¥ç›´æŽ¥æ˜¯è°ƒç”¨çš„父类的chooseServer(key) +3. getLoadBalancer(String zone) 基于zone去获å�–LoadBalancer +4. setRule(IRule rule) 为æ¯�个负载å�‡è¡¡å™¨è®¾ç½®è§„则。 + 这里å�¯ä»¥çœ‹åˆ°ï¼Œå…¶å®žè¿™ä¸ªä¸»è¦�是针对Zoneå�šäº†ä¸€äº›åˆ†ç±»å¤„ç�†ï¼Œå°±æ˜¯å°†åŽŸæ�¥å±žäºŽå�Œä¸€æœ�务的æœ�务实例,å†�æ ¹æ�®åœ°åŒºè¿›è¡Œåˆ’分。这也是为了能够快速å“�应而设置的。 **3.5.1 DynamicServerListLoadBalancer** -> ZoneAwareLoadBalancerµÄ¸¸Àà +> ZoneAwareLoadBalancer的父类 -Õâ¸öÀà°´ÕÕÃû³ÆÀ´Ëµ¾ÍÊǶ¯Ì¬¼ÓÔØ·þÎñÁбíʹÓõġ£ÆäÖÐÓм¸¸ö±È½ÏÖØÒªµÄ·½·¨ +这个类按照å��ç§°æ�¥è¯´å°±æ˜¯åЍæ€�加载æœ�务列表使用的。其中有几个比较é‡�è¦�的方法 -1. updateListOfServers:·þÎñÁÐ±í²¢¸üб¾µØ»º´æµÄ·þÎñÁбí -2. enableAndInitLearnNewServersFeature:¿ªÆô·þÎñÁбí¸üж¨Ê±ÈÎÎñ -3. ¿ªÆô¼àÌý:@Monitor +1. updateListOfServers:æœ�务列表并更新本地缓存的æœ�务列表 +2. enableAndInitLearnNewServersFeature:å¼€å�¯æœ�务列表更新定时任务 +3. å¼€å�¯ç›‘å�¬:@Monitor -DynamicServerListLoadBalancerµÄºËÐľÍÊÇ»ñÈ¡·þÎñÁÐ±í£¬ÔÚEurekaÖÐĬÈÏÊÇͨ¹ýDomainExtractingServerListÀ´»ñÈ¡£¬Õâ¸öÀàÊÇÔÚorg.springframework.cloud.netflix.ribbon.eureka.EurekaRibbonClientConfiguration#ribbonServerList£¬ÕâÀïûÓм¯³ÉEureka£¬ÔÝʱ²»½² +DynamicServerListLoadBalancer的核心就是获å�–æœ�务列表,在Eureka中默认是通过DomainExtractingServerListæ�¥èŽ·å�–,这个类是在org.springframework.cloud.netflix.ribbon.eureka.EurekaRibbonClientConfiguration#ribbonServerList,这里没有集æˆ�Eureka,暂时ä¸�讲 **3.5.2 BaseLoadBalancer** -> DynamicServerListLoadBalancerµÄ¸¸Àà +> DynamicServerListLoadBalancer的父类 -ºËÐÄĬÈÏÖµ +核心默认值 -* ĬÈϵĸºÔؾùºâ²ßÂÔRoundRobinRule -* ĬÈϵÄPing²ßÂÔSerialPingStrategy -* ËùÓзþÎñʵÀýÈÝÆ÷£ºallServerList -* ÔÚÏß·þÎñʵÀýÈÝÆ÷£ºupServerList - ![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b2db0bc66c3045288a762907ff72e01883bf20.jpg "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")´Ó×ÓÀ๹ÔìÖн«¶ÔÓ¦µÄ¸ºÔؾùºâ¹æÔò£¬ping²ßÂÔ£¬pingµÈ´«µÝ¹ýÀ´ +* 默认的负载å�‡è¡¡ç­–ç•¥RoundRobinRule +* 默认的Pingç­–ç•¥SerialPingStrategy +* 所有æœ�务实例容器:allServerList +* 在线æœ�务实例容器:upServerList + ![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/b2db0bc66c3045288a762907ff72e01883bf20.jpg "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")从å­�类构造中将对应的负载å�‡è¡¡è§„则,ping策略,ping等传递过æ�¥ -**ping×öÁËЩʲô£¿** +**pingå�šäº†äº›ä»€ä¹ˆï¼Ÿ** -PingTask×÷Ϊһ¸öÏß³ÌÈÎÎñ£¬¾ÍÊǶ¨ÆÚ¼ì²é·þÎñÊÇ·ñ¶¼´æ»î£¬¸úServerListUpdater·þÎñ¸üлúÖÆ²»³åÍ»¡£ÕâÊÇribbon×Ô¼ºÎ¬»¤µÄÒ»Ì×·þÎñ¼ì²â»úÖÆ£¬Ö÷ÒªÊÇΪÁ˽µµÍ·ÃÎÊʧ°ÜµÄ¸ÅÂÊ¡£Ä¬ÈÏÔÚʹÓÃeurekaʱ£¬pingÊÇʹÓõÄÊÇNIWSDiscoveryPingÀ´Íê³É·þÎñ±£»î¼ì²â¡£ÓÉeureka ºÍ ServerListUpdaterÀ´Ë¢Ð·þÎñÁÐ±í¡£![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/27db4c518aa7c100d427761832a9fa19fa8f04.jpg "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÕâÀïÓиö³£ÓõĶ¨Ê±ÈÎÎñ¿ìËÙÍ˳öµÄ·½·¨£¬ÎÒ¾õµÃÔÚÎÒÃÇ×Ô¼ºÐ´µÄʱºòÒ²¿ÉÒÔʹÓᣠ+PingTask作为一个线程任务,就是定期检查æœ�务是å�¦éƒ½å­˜æ´»ï¼Œè·ŸServerListUpdateræœ�务更新机制ä¸�冲çª�。这是ribbon自己维护的一套æœ�务检测机制,主è¦�是为了é™�低访问失败的概率。默认在使用eureka时,ping是使用的是NIWSDiscoveryPingæ�¥å®Œæˆ�æœ�务ä¿�活检测。由eureka å’Œ ServerListUpdateræ�¥åˆ·æ–°æœ�务列表。![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/27db4c518aa7c100d427761832a9fa19fa8f04.jpg "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")这里有个常用的定时任务快速退出的方法,我觉得在我们自己写的时候也å�¯ä»¥ä½¿ç”¨ã€‚ -¾ÍÊÇÔÚͬһ¸ö¶¨Ê±ÈÎÎñÈç¹ûÖ´ÐÐʱ¼ä³¬¹ýÁ˶¨Ê±ÖÜÆÚ£¬ÄÇôÏÂÒ»¸ö¶¨Ê±ÈÎÎñ·¢ÏÖÉÏÒ»¸ö¶¨Ê±ÈÎÎñ»¹Ã»ÓÐÖ´ÐÐÍêʱ£¬¾ÍÏÈÈ¡Ïû¡£![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f2d669b11f17530d2e62603d45949e934a5931.jpg "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÕâÀïÒ²ÓÃÁ˺ܶàËø»úÖÆ£¬±ÈÈçËùÓзþÎñʵÀýµ½Ò»¸öеĶÔÏóʱʹÓõÄÊǶÁËø£¬¾ÍÊǸæËßallServersÏÖÔÚÖ»ÄܶÁ²»ÄÜд¡£![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/711c81e67b2c1cd3fb91005f53ea1e1352ad9a.png "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÔÚ·¢ËÍpingºó£¬½«¼ì²âͨ¹ýµÄ·þÎñ·ÅÈënewUpListÖУ¬×îºóͨ¹ýÐ´Ëø£¬½«upServerListËø×¡¡£ +就是在å�Œä¸€ä¸ªå®šæ—¶ä»»åŠ¡å¦‚æžœæ‰§è¡Œæ—¶é—´è¶…è¿‡äº†å®šæ—¶å‘¨æœŸï¼Œé‚£ä¹ˆä¸‹ä¸€ä¸ªå®šæ—¶ä»»åŠ¡å�‘现上一个定时任务还没有执行完时,就先å�–消。![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/f2d669b11f17530d2e62603d45949e934a5931.jpg "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")这里也用了很多é”�机制,比如所有æœ�务实例到一个新的对象时使用的是读é”�,就是告诉allServers现在å�ªèƒ½è¯»ä¸�能写。![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/711c81e67b2c1cd3fb91005f53ea1e1352ad9a.png "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")在å�‘é€�pingå�Žï¼Œå°†æ£€æµ‹é€šè¿‡çš„æœ�务放入newUpList中,最å�Žé€šè¿‡å†™é”�,将upServerListé”�ä½�。 -ÕâÀï¾ÍÊÇÖ»ÄÜÓÐÒ»¸öд£¬ÇÒ²»ÄܶÁ¡£![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/047543857174aa1130b0747d1d149ffd6d5632.jpg "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")ÉÏÃæÊÇpingÔÚ¼ì²â¹ý³ÌÖйØÓÚ¶ÁÐ´ËøºÍÔ­×ÓÀàµÄʹÓᣠ+这里就是å�ªèƒ½æœ‰ä¸€ä¸ªå†™ï¼Œä¸”ä¸�能读。![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/047543857174aa1130b0747d1d149ffd6d5632.jpg "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")上é�¢æ˜¯ping在检测过程中关于读写é”�和原å­�类的使用。 -Ö÷ÒªÁ÷³Ì¾ÍÊÇ£º +主è¦�æµ�程就是: -1. ¶Áȡȫ²¿·þÎñʵÀýÁбí -2. ¼ì²â·þÎñʵÀýÊÇ·ñ´æ»îpingServers -3. ½«·þÎñ״̬·¢Éú¸Ä±äµÄ·ÅÈëchangedServers -4. ½«·þÎñÔÚÏߵķÅÈënewUpList -5. ½«newUpList¸³Öµµ½upServerList ÔÚÏß·þÎñʵÀýÁбíÖÐ +1. 读å�–全部æœ�务实例列表 +2. 检测æœ�务实例是å�¦å­˜æ´»pingServers +3. å°†æœ�务状æ€�å�‘生改å�˜çš„æ”¾å…¥changedServers +4. å°†æœ�务在线的放入newUpList +5. å°†newUpList赋值到upServerList 在线æœ�务实例列表中 -ÕâÀïÃæpingServers¾ÍÊǼì²éÐÄÌøµÄ +这里é�¢pingServers就是检查心跳的 -**BaseLoadBalancerµÄÆäËû¹¦ÄܼòÊö** +**BaseLoadBalancer的其他功能简述** -1. ¶ÔallServerListºÍupServerListµÄ¶ÁÐ´Ëø·½·¨ -2. Ìṩ¶ÔallServerListºÍupServerListµÄÔöɾ¸Ä¹¦ÄÜ -3. ÌṩÁËPingTask£¨pingµÄ¶¨Ê±ÈÎÎñ£©£¬Pinger£¨pingµÄÖ´ÐÐÆ÷£© -4. »ùÓÚ¸ºÔؾùºâ²ßÂÔÑ¡Ôñ·þÎñrule.choose(key) -5. ÌṩĬÈϵÄping²ßÂÔSerialPingStrategy +1. 对allServerListå’ŒupServerList的读写é”�方法 +2. æ��供对allServerListå’ŒupServerList的增删改功能 +3. æ��供了PingTask(ping的定时任务),Pinger(ping的执行器) +4. 基于负载å�‡è¡¡ç­–略选择æœ�务rule.choose(key) +5. æ��供默认的pingç­–ç•¥SerialPingStrategy **3.6 LoadBalancerRequest** - ͨ¹ýZoneAwareLoadBalancerÑ¡Ôñ¾ßÌåµÄServerÖ®ºó£¬ÔÙ°ü×°³ÉRibbonServer¶ÔÏó£¬Ö®Ç°·µ»ØµÄserverÊǸöÔÏóÖеÄÒ»¸ö×ֶΣ¬³ý´ËÖ®Í⣬»¹ÓзþÎñÃûserviceId£¬ÊÇ·ñÐèҪʹÓÃhttpsµÈÐÅÏ¢¡£×îºó£¬Í¨¹ýLoadBalancerRequestµÄapply·½·¨£¬Ïò¾ßÌåµÄserver·¢ÇëÇ󣬴ӶøÊµÏÖÁ˸ºÔؾùºâ¡£ + 通过ZoneAwareLoadBalancer选择具体的Server之å�Žï¼Œå†�包装æˆ�RibbonServer对象,之å‰�返回的server是该对象中的一个字段,除此之外,还有æœ�务å��serviceId,是å�¦éœ€è¦�使用https等信æ�¯ã€‚最å�Žï¼Œé€šè¿‡LoadBalancerRequestçš„apply方法,å�‘具体的serverå�‘请求,从而实现了负载å�‡è¡¡ã€‚ -ÏÂÃæÊÇapply·½·¨µÄ¶¨Ò壺 +下é�¢æ˜¯apply方法的定义: @@ -813,24 +813,24 @@ public interface LoadBalancerRequest { -ÔÚÇëÇóʱ£¬´«ÈëµÄribbonServer¶ÔÏ󣬱»µ±³ÉServiceInstanceÀàÐ͵ĶÔÏó½øÐнÓÊÕ¡£ServiceInstanceÊÇÒ»¸ö½Ó¿Ú£¬¶¨ÒåÁË·þÎñÖÎÀíϵͳÖУ¬Ã¿¸öʵÀýÐèÒªÌṩµÄÐÅÏ¢£¬±ÈÈçserviceId£¬host£¬portµÈ¡£ +在请求时,传入的ribbonServer对象,被当æˆ�ServiceInstance类型的对象进行接收。ServiceInstance是一个接å�£ï¼Œå®šä¹‰äº†æœ�务治ç�†ç³»ç»Ÿä¸­ï¼Œæ¯�个实例需è¦�æ��供的信æ�¯ï¼Œæ¯”如serviceId,host,port等。 -LoadBalancerRequestÊÇÒ»¸ö½Ó¿Ú£¬×îÖÕ»áͨ¹ýʵÏÖÀàµÄapply·½·¨È¥Ö´ÐУ¬ÊµÏÖÀàÊÇÔÚLoadBalancerInterceptorÖе÷ÓÃRibbonLoadBalancerClientµÄexecute·½·¨Ê±£¬´«½øÀ´µÄÒ»¸öÄäÃûÀ࣬¿ÉÒÔͨ¹ý²é¿´LoadBalancerInterceptorµÄ´úÂë¿´µ½¡£ +LoadBalancerRequest是一个接å�£ï¼Œæœ€ç»ˆä¼šé€šè¿‡å®žçŽ°ç±»çš„apply方法去执行,实现类是在LoadBalancerInterceptor中调用RibbonLoadBalancerClientçš„execute方法时,传进æ�¥çš„一个匿å��类,å�¯ä»¥é€šè¿‡æŸ¥çœ‹LoadBalancerInterceptor的代ç �看到。 -´´½¨LoadBalancerRequestÄäÃûÀàµÄʱºò£¬¾ÍÖØÐ´ÁËapply·½·¨£¬apply·½·¨ÖУ¬»¹Ð½¨ÁËÒ»¸öServiceRequestWrapperµÄÄÚ²¿À࣬Õâ¸öÀàÖУ¬¾ÍÖØÐ´ÁËgetURI·½·¨£¬getURI·½·¨»áµ÷ÓÃloadBalancerµÄreconstructURI·½·¨À´¹¹½¨uri¡£ +创建LoadBalancerRequest匿å��类的时候,就é‡�写了apply方法,apply方法中,还新建了一个ServiceRequestWrapper的内部类,这个类中,就é‡�写了getURI方法,getURI方法会调用loadBalancerçš„reconstructURI方法æ�¥æž„建uri。 -¿´µ½ÕâÀÒѾ­¿ÉÒÔ´óÌåÖªµÀRibbonʵÏÖ¸ºÔؾùºâµÄÁ÷³ÌÁË£¬ÎÒÃÇÔÚRestTemplateÉÏÌí¼Ó×¢½â£¬¾Í»áÓÐLoadBalancerClientµÄ¶ÔÏóÀ´ÅäÖÃËü£¬Ò²¾ÍÊÇRibbonLoadBalancerClient¡£Í¬Ê±£¬ -LoadBalancerAutoConfiguration»á½øÐÐÅäÖ㬴´½¨Ò»¸öLoadBalancerInterceptor£¬²¢ÇÒÄõ½ÎÒÃÇÉùÃ÷µÄËùÓÐrestTemplate£¬ÔÚÕâЩrestTemplateÖÐÌí¼ÓLoadBalancerInterceptorÀ¹½ØÆ÷¡£ +看到这里,已ç»�å�¯ä»¥å¤§ä½“知é�“Ribbon实现负载å�‡è¡¡çš„æµ�程了,我们在RestTemplate上添加注解,就会有LoadBalancerClient的对象æ�¥é…�置它,也就是RibbonLoadBalancerClient。å�Œæ—¶ï¼Œ +LoadBalancerAutoConfiguration会进行é…�置,创建一个LoadBalancerInterceptor,并且拿到我们声明的所有restTemplate,在这些restTemplate中添加LoadBalancerInterceptor拦截器。 -µ±Í¨¹ýrestTemplate·¢ËÍÇëÇóʱ£¬¾Í»á¾­¹ýÕâ¸öÀ¹½ØÆ÷£¬ÔÚÀ¹½ØÆ÷ÖУ¬¾Í»áµ÷ÓÃRibbonLoadBalancerClientÖеķ½·¨£¬»ñÈ¡µ½¸ù¾Ý·þÎñÃû£¬Í¨¹ý¸ºÔؾùºâ·½·¨»ñÈ¡µ½·þÎñʵÀý£¬È»ºóÈ¥ÇëÇóÕâ¸öʵÀý¡£ +当通过restTemplateå�‘é€�请求时,就会ç»�过这个拦截器,在拦截器中,就会调用RibbonLoadBalancerClient中的方法,获å�–到根æ�®æœ�务å��,通过负载å�‡è¡¡æ–¹æ³•获å�–到æœ�务实例,然å�ŽåŽ»è¯·æ±‚è¿™ä¸ªå®žä¾‹ã€‚ -**3.7 »ñÈ¡·þÎñÁбí** -ÉÏÃæËµµÄÕâЩ£¬ÊÇÈçºÎ¶ÔÇëÇó½øÐиºÔؾùºâµÄ£¬µ«ÊÇ»¹ÓиöÎÊÌ⣬ÎÒÃÇÇëÇóµÄʵÀý£¬ÊÇ´ÓEureka ServerÉÏ»ñÈ¡µ½µÄ£¬ÄÇÕâ¸öʵÀýÁбíÊÇÈçºÎ»ñÈ¡µÄÄØ£¿Ôõô±£Ö¤Õâ¸öʵÀýÁбíÖеÄʵÀýÊÇ¿ÉÓõÄÄØ£¿ +**3.7 获å�–æœ�务列表** +上é�¢è¯´çš„这些,是如何对请求进行负载å�‡è¡¡çš„,但是还有个问题,我们请求的实例,是从Eureka Server上获å�–到的,那这个实例列表是如何获å�–的呢?怎么ä¿�è¯�这个实例列表中的实例是å�¯ç”¨çš„呢? -ÔÚRibbonLoadBalancerClientÑ¡ÔñʵÀýµÄʱºò£¬ÊÇͨ¹ýILoadBalancerµÄʵÏÖÀà¸ù¾Ý¸ºÔؾùºâË㷨ѡÔñ·þÎñʵÀýµÄ£¬Ò²¾ÍÊÇZoneAwareLoadBalancerµÄchooseServerÖеÄÂß¼­£¬ÄǾÍÔÚÕâÀïÕÒÏßË÷¡£²é¿´ZoneAwareLoadBalancerµÄ¼Ì³Ð¹ØÏµ£¬¿ÉÒÔ¿´µ½ÈçÏÂͼËùʾ¡£![SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/425d8ff567d9ac6171f6036dab1726a7da04a3.jpg "SpringCloudϵÁСªRibbonÔ´Âë·ÖÎö-¿ªÔ´»ù´¡Èí¼þÉçÇø")¿ÉÒÔ¿´µ½£¬×îÉÏÃæÊÇILoadBalancer½Ó¿Ú£¬AbstractLoadBalancerÀà¼Ì³ÐÁËÕâ¸ö½Ó¿Ú£¬BaseLoadBalancer¼Ì³ÐÁËAbstractLoadBalancerÀ࣬ -DynamicServerListLoadBalancer¼Ì³ÐÁËBaseLoadBalancer£¬ZoneAwareLoadBalancer¼Ì³ÐÁËDynamicServerListLoadBalancer¡£ +在RibbonLoadBalancerClient选择实例的时候,是通过ILoadBalancer的实现类根æ�®è´Ÿè½½å�‡è¡¡ç®—法选择æœ�务实例的,也就是ZoneAwareLoadBalancerçš„chooseServer中的逻辑,那就在这里找线索。查看ZoneAwareLoadBalancer的继承关系,å�¯ä»¥çœ‹åˆ°å¦‚下图所示。![SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/425d8ff567d9ac6171f6036dab1726a7da04a3.jpg "SpringCloud系列—Ribbonæº�ç �分æž�-å¼€æº�基础软件社区")å�¯ä»¥çœ‹åˆ°ï¼Œæœ€ä¸Šé�¢æ˜¯ILoadBalancer接å�£ï¼ŒAbstractLoadBalancer类继承了这个接å�£ï¼ŒBaseLoadBalancer继承了AbstractLoadBalancer类, +DynamicServerListLoadBalancer继承了BaseLoadBalancer,ZoneAwareLoadBalancer继承了DynamicServerListLoadBalancer。 -ILoadBalancer½Ó¿ÚµÄ´úÂëÒѾ­¿´¹ýÁË£¬ÏÖÔÚ¿´ÏÂAbstractLoadBalancerµÄ´úÂ룺 +ILoadBalancer接å�£çš„代ç �å·²ç»�看过了,现在看下AbstractLoadBalancer的代ç �: @@ -868,9 +868,9 @@ public abstract class AbstractLoadBalancer implements ILoadBalancer { -ÕâÊÇÒ»¸ö³éÏóÀ࣬ÀïÃæ¼ÓÁËÒ»¸öö¾Ù£¬Ôö¼ÓÁËÁ½¸ö³éÏó·½·¨¡£¶¨ÒåµÄchooseServer·½·¨¡£ +这是一个抽象类,里é�¢åŠ äº†ä¸€ä¸ªæžšä¸¾ï¼Œå¢žåŠ äº†ä¸¤ä¸ªæŠ½è±¡æ–¹æ³•ã€‚å®šä¹‰çš„chooseServer方法。 -ÏÂÃæÔÙ¿´BaseLoadBalancerÀ࣬BaseLoadBalancerÀà¾ÍËãÊǸºÔؾùºâÆ÷µÄÒ»¸ö»ù´¡ÊµÏÖÀ࣬ÔÚÀïÃæ¿ÉÒÔ¿´µ½¶¨ÒåÁËÁ½¸ölist£º +下é�¢å†�看BaseLoadBalancer类,BaseLoadBalancer类就算是负载å�‡è¡¡å™¨çš„一个基础实现类,在里é�¢å�¯ä»¥çœ‹åˆ°å®šä¹‰äº†ä¸¤ä¸ªlist: @@ -891,8 +891,8 @@ protected volatile List upServerList = Collections -´ÓÃû×ÖÉÏ¿´£¬Õâ¾ÍÊÇά»¤ËùÓзþÎñµÄʵÀýÁÐ±í£¬ºÍά»¤×´Ì¬ÎªupµÄʵÀýÁÐ±í¡£ -¶øÇÒ»¹¿ÉÒÔ¿´µ½BaseLoadBalancerÖÐʵÏÖµÄILoadBalancer½Ó¿ÚÖеķ½·¨£¬±ÈÈçÏÂÃæÕâÁ½¸ö£¬»ñÈ¡¿ÉÓõķþÎñÁÐ±í£¬¾Í»á°ÑupServerList·µ»Ø£¬»ñÈ¡ËùÓеķþÎñÁÐ±í£¬¾Í»á°ÑallServerList·µ»Ø¡£ +从å��字上看,这就是维护所有æœ�务的实例列表,和维护状æ€�为up的实例列表。 +而且还å�¯ä»¥çœ‹åˆ°BaseLoadBalancer中实现的ILoadBalancer接å�£ä¸­çš„æ–¹æ³•,比如下é�¢è¿™ä¸¤ä¸ªï¼ŒèŽ·å�–å�¯ç”¨çš„æœ�务列表,就会把upServerList返回,获å�–所有的æœ�务列表,就会把allServerList返回。 @@ -915,9 +915,9 @@ public List getAllServers() { -½ÓÏÂÀ´£¬ÔÙ¿´DynamicServerListLoadBalancerÀà¡£´ÓÀàÍ·ÉϵÄ×¢ÊÍ¿ÉÒÔÖªµÀ£¬Õâ¸öÀà¿ÉÒÔ¶¯Ì¬µÄ»ñÈ¡·þÎñÁÐ±í£¬²¢ÇÒÀûÓÃfilter¶Ô·þÎñÁÐ±í½øÐйýÂË¡£ +接下æ�¥ï¼Œå†�看DynamicServerListLoadBalancer类。从类头上的注释å�¯ä»¥çŸ¥é�“,这个类å�¯ä»¥åЍæ€�的获å�–æœ�务列表,并且利用filter对æœ�务列表进行过滤。 -ÔÚDynamicServerListLoadBalancerÀàÖУ¬ÄÜ¿´µ½¶¨ÒåÁËÒ»¸öServerListÀàÐ͵ÄserverListImpl×ֶΣ¬ServerListÊÇÒ»¸ö½Ó¿Ú£¬ÀïÃæÓÐÁ½¸ö·½·¨£º +在DynamicServerListLoadBalancer类中,能看到定义了一个ServerList类型的serverListImpl字段,ServerList是一个接å�£ï¼Œé‡Œé�¢æœ‰ä¸¤ä¸ªæ–¹æ³•: @@ -941,12 +941,12 @@ public interface ServerList { -getInitialListOfServersÊÇ»ñÈ¡³õʼ»¯µÄ·þÎñÁÐ±í¡£ -getUpdatedListOfServersÊÇ»ñÈ¡¸üеķþÎñÁÐ±í¡£ -ServerListÓжà¸öʵÏÖÀ࣬¾ßÌåÓõÄÄĸöÄØ£¬¿ÉÒÔÔÚ -EurekaRibbonClientConfigurationÀàÖÐÕÒµ½£¬ÕâÊÇRibbonºÍEureka½áºÏµÄ×Ô¶¯ÅäÖÃÀ࣬µ«ÊÇĿǰÎÒÃÇûÓÐÕûºÏEureka£¬ÊÇͨ¹ýÅäÖÃÎļþÅäÖã¬ËùÒÔ»á×ßConfigurationBasedServerListÀà¡£ +getInitialListOfServers是获å�–åˆ�始化的æœ�务列表。 +getUpdatedListOfServers是获å�–æ›´æ–°çš„æœ�务列表。 +ServerList有多个实现类,具体用的哪个呢,å�¯ä»¥åœ¨ +EurekaRibbonClientConfiguration类中找到,这是Ribbonå’ŒEureka结å�ˆçš„自动é…�置类,但是目å‰�我们没有整å�ˆEureka,是通过é…�置文件é…�置,所以会走ConfigurationBasedServerList类。 -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://lijunyi.xyz/docs/SpringCloud/SpringCloud.html#_2-2-x-%E5%88%86%E6%94%AF https://mp.weixin.qq.com/s/2jeovmj77O9Ux96v3A0NtA https://juejin.cn/post/6931922457741770760 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\233\275\351\231\205\345\214\226\345\212\237\350\203\275.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\233\275\351\231\205\345\214\226\345\212\237\350\203\275.md" index 374388b..43a4291 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\233\275\351\231\205\345\214\226\345\212\237\350\203\275.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\233\275\351\231\205\345\214\226\345\212\237\350\203\275.md" @@ -1,32 +1,32 @@ -#### ¹ú¼Ê»¯ +#### 国际化 * * * -ÔÚ¿ª·¢Ó¦ÓóÌÐòµÄʱºò£¬¾­³£»áÓöµ½Ö§³Ö¶àÓïÑÔµÄÐèÇó£¬ÕâÖÖÖ§³Ö¶àÓïÑԵŦÄܳÆÖ®Îª¹ú¼Ê»¯£¬Ó¢ÎÄÊÇinternationalization£¬ËõдΪi18n£¨ÒòΪÊ××ÖĸiºÍÄ©×ÖĸnÖмäÓÐ18¸ö×Öĸ£©¡£ +在开å�‘应用程åº�的时候,ç»�常会é�‡åˆ°æ”¯æŒ�多语言的需求,这ç§�支æŒ�多语言的功能称之为国际化,英文是internationalization,缩写为i18n(因为首字æ¯�i和末字æ¯�n中间有18个字æ¯�)。 -»¹ÓÐÕë¶ÔÌØ¶¨µØÇøµÄ±¾µØ»¯¹¦ÄÜ£¬Ó¢ÎÄÊÇlocalization£¬ËõдΪL10n£¬±¾µØ»¯ÊÇÖ¸¸ù¾ÝµØÇøµ÷ÕûÀàËÆÐÕÃû¡¢ÈÕÆÚµÄÏÔʾµÈ¡£ +还有针对特定地区的本地化功能,英文是localization,缩写为L10n,本地化是指根æ�®åœ°åŒºè°ƒæ•´ç±»ä¼¼å§“å��ã€�日期的显示等。 -Ò²ÓаÑÉÏÃæÁ½ÕߺϳÆÎªÈ«Çò»¯£¬Ó¢ÎÄÊÇglobalization£¬ËõдΪg11n¡£ +也有把上é�¢ä¸¤è€…å�ˆç§°ä¸ºå…¨ç�ƒåŒ–,英文是globalization,缩写为g11n。 -ÔÚJavaÖУ¬Ö§³Ö¶àÓïÑԺͱ¾µØ»¯ÊÇͨ¹ý`MessageFormat`ÅäºÏ`Locale`ʵÏֵģº +在Java中,支æŒ�多语言和本地化是通过`MessageFormat`é…�å�ˆ`Locale`实现的: -¶ÔÓÚWebÓ¦ÓóÌÐò£¬ÒªÊµÏÖ¹ú¼Ê»¯¹¦ÄÜ£¬Ö÷ÒªÊÇäÖȾViewµÄʱºò£¬Òª°Ñ¸÷ÖÖÓïÑÔµÄ×ÊÔ´ÎļþÌá³öÀ´£¬ÕâÑù£¬²»Í¬µÄÓû§·ÃÎÊͬһ¸öÒ³ÃæÊ±£¬ÏÔʾµÄÓïÑÔ¾ÍÊDz»Í¬µÄ¡£ +对于Web应用程åº�,è¦�实现国际化功能,主è¦�是渲染View的时候,è¦�把å�„ç§�语言的资æº�文件æ��出æ�¥ï¼Œè¿™æ ·ï¼Œä¸�å�Œçš„用户访问å�Œä¸€ä¸ªé¡µé�¢æ—¶ï¼Œæ˜¾ç¤ºçš„语言就是ä¸�å�Œçš„。 -ÎÒÃÇÀ´¿´¿´ÔÚSpring MVCÓ¦ÓóÌÐòÖÐÈçºÎʵÏÖ¹ú¼Ê»¯¡£ +我们æ�¥çœ‹çœ‹åœ¨Spring MVC应用程åº�中如何实现国际化。 -### »ñÈ¡Locale +### 获å�–Locale -ʵÏÖ¹ú¼Ê»¯µÄµÚÒ»²½ÊÇ»ñÈ¡µ½Óû§µÄ`Locale`¡£ÔÚWebÓ¦ÓóÌÐòÖУ¬HTTP¹æ·¶¹æ¶¨ÁËä¯ÀÀÆ÷»áÔÚÇëÇóÖÐЯ´ø`Accept-Language`Í·£¬ÓÃÀ´Ö¸Ê¾Óû§ä¯ÀÀÆ÷É趨µÄÓïÑÔ˳Ðò£¬È磺 +实现国际化的第一步是获å�–到用户的`Locale`。在Web应用程åº�中,HTTP规范规定了æµ�览器会在请求中æ�ºå¸¦`Accept-Language`头,用æ�¥æŒ‡ç¤ºç”¨æˆ·æµ�览器设定的语言顺åº�,如: ``` Accept-Language: zh-CN,zh;q=0.8,en;q=0.2 ``` -ÉÏÊöHTTPÇëÇóÍ·±íʾÓÅÏÈÑ¡Ôñ¼òÌåÖÐÎÄ£¬Æä´ÎÑ¡ÔñÖÐÎÄ£¬×îºóÑ¡ÔñÓ¢ÎÄ¡£`q`±íÊ¾È¨ÖØ£¬½âÎöºóÎÒÃǿɻñµÃÒ»¸ö¸ù¾ÝÓÅÏȼ¶ÅÅÐòµÄÓïÑÔÁÐ±í£¬°ÑËüת»»ÎªJavaµÄ`Locale`£¬¼´»ñµÃÁËÓû§µÄ`Locale`¡£´ó¶àÊý¿ò¼Üͨ³£Ö»·µ»ØÈ¨ÖØ×î¸ßµÄ`Locale`¡£ +上述HTTP请求头表示优先选择简体中文,其次选择中文,最å�Žé€‰æ‹©è‹±æ–‡ã€‚`q`表示æ�ƒé‡�,解æž�å�Žæˆ‘们å�¯èŽ·å¾—ä¸€ä¸ªæ ¹æ�®ä¼˜å…ˆçº§æŽ’åº�的语言列表,把它转æ�¢ä¸ºJavaçš„`Locale`,å�³èŽ·å¾—äº†ç”¨æˆ·çš„`Locale`。大多数框架通常å�ªè¿”回æ�ƒé‡�最高的`Locale`。 -Spring MVCͨ¹ý`LocaleResolver`À´×Ô¶¯´Ó`HttpServletRequest`ÖлñÈ¡`Locale`¡£ÓжàÖÖ`LocaleResolver`µÄʵÏÖÀ࣬ÆäÖÐ×î³£ÓõÄÊÇ`CookieLocaleResolver`£º +Spring MVC通过`LocaleResolver`æ�¥è‡ªåŠ¨ä»Ž`HttpServletRequest`中获å�–`Locale`。有多ç§�`LocaleResolver`的实现类,其中最常用的是`CookieLocaleResolver`: ``` @Primary @@ -36,20 +36,20 @@ LocaleResolver createLocaleResolver() { ``` -`CookieLocaleResolver`´Ó`HttpServletRequest`ÖлñÈ¡`Locale`ʱ£¬Ê×Ïȸù¾ÝÒ»¸öÌØ¶¨µÄCookieÅжÏÊÇ·ñÖ¸¶¨ÁË`Locale`£¬Èç¹ûûÓУ¬¾Í´ÓHTTPÍ·»ñÈ¡£¬Èç¹û»¹Ã»ÓУ¬¾Í·µ»ØÄ¬ÈϵÄ`Locale`¡£ +`CookieLocaleResolver`从`HttpServletRequest`中获å�–`Locale`时,首先根æ�®ä¸€ä¸ªç‰¹å®šçš„Cookie判断是å�¦æŒ‡å®šäº†`Locale`,如果没有,就从HTTP头获å�–,如果还没有,就返回默认的`Locale`。 -µ±Óû§µÚÒ»´Î·ÃÎÊÍøÕ¾Ê±£¬`CookieLocaleResolver`Ö»ÄÜ´ÓHTTPÍ·»ñÈ¡`Locale`£¬¼´Ê¹ÓÃä¯ÀÀÆ÷µÄĬÈÏÓïÑÔ¡£Í¨³£ÍøÕ¾Ò²ÔÊÐíÓû§×Ô¼ºÑ¡ÔñÓïÑÔ£¬´Ëʱ£¬`CookieLocaleResolver`¾Í»á°ÑÓû§Ñ¡ÔñµÄÓïÑÔ´æ·Åµ½CookieÖУ¬ÏÂÒ»´Î·ÃÎÊʱ£¬¾Í»á·µ»ØÓû§ÉÏ´ÎÑ¡ÔñµÄÓïÑÔ¶ø²»ÊÇä¯ÀÀÆ÷ĬÈÏÓïÑÔ¡£ +当用户第一次访问网站时,`CookieLocaleResolver`å�ªèƒ½ä»ŽHTTP头获å�–`Locale`,å�³ä½¿ç”¨æµ�览器的默认语言。通常网站也å…�许用户自己选择语言,此时,`CookieLocaleResolver`就会把用户选择的语言存放到Cookie中,下一次访问时,就会返回用户上次选择的语言而ä¸�是æµ�览器默认语言。 -### ÌáÈ¡×ÊÔ´Îļþ +### æ��å�–资æº�文件 -µÚ¶þ²½ÊǰÑдËÀÔÚÄ£°åÖеÄ×Ö·û´®ÒÔ×ÊÔ´ÎļþµÄ·½Ê½´æ´¢ÔÚÍⲿ¡£¶ÔÓÚ¶àÓïÑÔ£¬Ö÷ÎļþÃûÈç¹ûÃüÃûΪ`messages`£¬ÄÇô×ÊÔ´Îļþ±ØÐë°´ÈçÏ·½Ê½ÃüÃû²¢·ÅÈëclasspathÖУº +第二步是把写死在模æ�¿ä¸­çš„字符串以资æº�文件的方å¼�存储在外部。对于多语言,主文件å��如果命å��为`messages`,那么资æº�文件必须按如下方å¼�命å��并放入classpath中: -* ĬÈÏÓïÑÔ£¬ÎļþÃû±ØÐëΪ`messages.properties`£» -* ¼òÌåÖÐÎÄ£¬LocaleÊÇ`zh_CN`£¬ÎļþÃû±ØÐëΪ`messages_zh_CN.properties`£» -* ÈÕÎÄ£¬LocaleÊÇ`ja_JP`£¬ÎļþÃû±ØÐëΪ`messages_ja_JP.properties`£» -* ÆäËü¸ü¶àÓïÑÔ¡­¡­ +* 默认语言,文件å��必须为`messages.properties`ï¼› +* 简体中文,Locale是`zh_CN`,文件å��必须为`messages_zh_CN.properties`ï¼› +* 日文,Locale是`ja_JP`,文件å��必须为`messages_ja_JP.properties`ï¼› +* 其它更多语言…… -ÿ¸ö×ÊÔ´Îļþ¶¼ÓÐÏàͬµÄkey£¬ÀýÈ磬ĬÈÏÓïÑÔÊÇÓ¢ÎÄ£¬Îļþ`messages.properties`ÄÚÈÝÈçÏ£º +æ¯�个资æº�文件都有相å�Œçš„key,例如,默认语言是英文,文件`messages.properties`内容如下: ``` language.select=Language @@ -59,19 +59,19 @@ copyright=Copyright?{0,number,#} ``` -Îļþ`messages_zh_CN.properties`ÄÚÈÝÈçÏ£º +文件`messages_zh_CN.properties`内容如下: ``` -language.select=ÓïÑÔ -home=Ê×Ò³ -signin=µÇ¼ -copyright=°æÈ¨ËùÓÐ?{0,number,#} +language.select=语言 +home=首页 +signin=登录 +copyright=版æ�ƒæ‰€æœ‰?{0,number,#} ``` -### ´´½¨MessageSource +### 创建MessageSource -µÚÈý²½ÊÇ´´½¨Ò»¸öSpringÌṩµÄ`MessageSource`ʵÀý£¬Ëü×Ô¶¯¶ÁÈ¡ËùÓеÄ`.properties`Îļþ£¬²¢Ìṩһ¸öͳһ½Ó¿ÚÀ´ÊµÏÖ¡°·­Ò롱£º +第三步是创建一个Springæ��供的`MessageSource`实例,它自动读å�–所有的`.properties`文件,并æ��供一个统一接å�£æ�¥å®žçŽ°â€œç¿»è¯‘â€�: ``` // code, arguments, locale: @@ -79,52 +79,52 @@ String text = messageSource.getMessage("signin", null, locale); ``` -ÆäÖУ¬`signin`ÊÇÎÒÃÇÔÚ`.properties`ÎļþÖж¨ÒåµÄkey£¬µÚ¶þ¸ö²ÎÊýÊÇ`Object[]`Êý×é×÷Ϊ¸ñʽ»¯Ê±´«ÈëµÄ²ÎÊý£¬×îºóÒ»¸ö²ÎÊý¾ÍÊÇ»ñÈ¡µÄÓû§`Locale`ʵÀý¡£ +其中,`signin`是我们在`.properties`文件中定义的key,第二个å�‚数是`Object[]`数组作为格å¼�化时传入的å�‚数,最å�Žä¸€ä¸ªå�‚数就是获å�–的用户`Locale`实例。 -´´½¨`MessageSource`ÈçÏ£º +创建`MessageSource`如下: ``` @Bean("i18n") MessageSource createMessageSource() { - var messageSource = new ResourceBundleMessageSource(); // Ö¸¶¨ÎļþÊÇUTF-8±àÂë: - messageSource.setDefaultEncoding("UTF-8"); // Ö¸¶¨Ö÷ÎļþÃû: + var messageSource = new ResourceBundleMessageSource(); // 指定文件是UTF-8ç¼–ç �: + messageSource.setDefaultEncoding("UTF-8"); // 指定主文件å��: messageSource.setBasename("messages"); return messageSource;} ``` -×¢Òâµ½`ResourceBundleMessageSource`»á×Ô¶¯¸ù¾ÝÖ÷ÎļþÃû×Ô¶¯°ÑËùÓÐÏà¹ØÓïÑÔµÄ×ÊÔ´Îļþ¶¼¶Á½øÀ´¡£ +注æ„�到`ResourceBundleMessageSource`会自动根æ�®ä¸»æ–‡ä»¶å��自动把所有相关语言的资æº�文件都读进æ�¥ã€‚ -ÔÙ×¢Òâµ½SpringÈÝÆ÷»á´´½¨²»Ö»Ò»¸ö`MessageSource`ʵÀý£¬ÎÒÃÇ×Ô¼º´´½¨µÄÕâ¸ö`MessageSource`ÊÇרßøÒ³Ãæ¹ú¼Ê»¯Ê¹Óõģ¬Òò´ËÃüÃûΪ`i18n`£¬²»»áÓëÆäËü`MessageSource`ʵÀý³åÍ»¡£ +å†�注æ„�到Spring容器会创建ä¸�å�ªä¸€ä¸ª`MessageSource`实例,我们自己创建的这个`MessageSource`是专门给页é�¢å›½é™…化使用的,因此命å��为`i18n`,ä¸�会与其它`MessageSource`实例冲çª�。 -### ʵÏÖ¶àÓïÑÔ +### 实现多语言 -ÒªÔÚViewÖÐʹÓÃ`MessageSource`¼ÓÉÏ`Locale`Êä³ö¶àÓïÑÔ£¬ÎÒÃÇͨ¹ý±àдһ¸ö`MvcInterceptor`£¬°ÑÏà¹Ø×ÊÔ´×¢Èëµ½`ModelAndView`ÖУº +è¦�在View中使用`MessageSource`加上`Locale`输出多语言,我们通过编写一个`MvcInterceptor`,把相关资æº�注入到`ModelAndView`中: ``` @Component public class MvcInterceptor implements HandlerInterceptor { @Autowired LocaleResolver localeResolver; - // ×¢Òâ×¢ÈëµÄMessageSourceÃû³ÆÊÇi18n: + // 注æ„�注入的MessageSourceå��称是i18n: @Autowired @Qualifier("i18n") MessageSource messageSource; - public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { if (modelAndView != null) { // ½âÎöÓû§µÄLocale: - Locale locale = localeResolver.resolveLocale(request); // ·ÅÈëModel: + public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { if (modelAndView != null) { // è§£æž�用户的Locale: + Locale locale = localeResolver.resolveLocale(request); // 放入Model: modelAndView.addObject("__messageSource__", messageSource); modelAndView.addObject("__locale__", locale); } }} ``` -²»ÒªÍüÁËÔÚ`WebMvcConfigurer`ÖÐ×¢²á`MvcInterceptor`¡£ÏÖÔÚ£¬¾Í¿ÉÒÔÔÚViewÖе÷ÓÃ`MessageSource.getMessage()`·½·¨À´ÊµÏÖ¶àÓïÑÔ£º +ä¸�è¦�忘了在`WebMvcConfigurer`中注册`MvcInterceptor`。现在,就å�¯ä»¥åœ¨View中调用`MessageSource.getMessage()`方法æ�¥å®žçŽ°å¤šè¯­è¨€ï¼š ``` {{ __messageSource__.getMessage('signin', null, __locale__) }} ``` -ÉÏÊöÕâÖÖд·¨ËäÈ»¿ÉÐУ¬µ«¸ñʽ̫¸´ÔÓÁË¡£Ê¹ÓÃViewʱ£¬Òª¸ù¾Ýÿ¸öÌØ¶¨µÄViewÒýÇæ¶¨Öƹú¼Ê»¯º¯Êý¡£ÔÚPebbleÖУ¬ÎÒÃÇ¿ÉÒÔ·â×°Ò»¸ö¹ú¼Ê»¯º¯Êý£¬Ãû³Æ¾ÍÊÇÏ»®Ïß`_`£¬¸ÄÔìһϴ´½¨`ViewResolver`µÄ´úÂ룺 +上述这ç§�写法虽然å�¯è¡Œï¼Œä½†æ ¼å¼�太å¤�æ�‚了。使用View时,è¦�æ ¹æ�®æ¯�个特定的View引擎定制国际化函数。在Pebble中,我们å�¯ä»¥å°�装一个国际化函数,å��称就是下划线`_`,改造一下创建`ViewResolver`的代ç �: ``` @Bean ViewResolver createViewResolver(@Autowired ServletContext servletContext, @Autowired @Qualifier("i18n") MessageSource messageSource) { - var engine = new PebbleEngine.Builder() .autoEscaping(true) .cacheActive(false) .loader(new Servlet5Loader(servletContext)) // Ìí¼ÓÀ©Õ¹: + var engine = new PebbleEngine.Builder() .autoEscaping(true) .cacheActive(false) .loader(new Servlet5Loader(servletContext)) // 添加扩展: .extension(createExtension(messageSource)) .build(); var viewResolver = new PebbleViewResolver(); viewResolver.setPrefix("/WEB-INF/templates/"); viewResolver.setSuffix(""); viewResolver.setPebbleEngine(engine); return viewResolver;} private Extension createExtension(MessageSource messageSource) { @@ -132,48 +132,48 @@ private Extension createExtension(MessageSource messageSource) { ``` -ÕâÑù£¬ÎÒÃÇ¿ÉÒ԰ѶàÓïÑÔÒ³Ãæ¸ÄдΪ£º +这样,我们å�¯ä»¥æŠŠå¤šè¯­è¨€é¡µé�¢æ”¹å†™ä¸ºï¼š ``` {{ _('signin') }} ``` -Èç¹ûÊÇ´ø²ÎÊýµÄ¶àÓïÑÔ£¬ÐèÒª°Ñ²ÎÊý´«½øÈ¥£º +如果是带å�‚数的多语言,需è¦�把å�‚数传进去: ```
{{ _('copyright', 2020) }}
``` -ʹÓÃÆäËüViewÒýÇæÊ±£¬Ò²Ó¦µ±¸ù¾ÝÒýÇæ½Ó¿ÚʵÏÖ¸ü·½±ãµÄÓï·¨¡£ +使用其它View引擎时,也应当根æ�®å¼•擎接å�£å®žçŽ°æ›´æ–¹ä¾¿çš„è¯­æ³•ã€‚ -### Çл»Locale +### 切æ�¢Locale -×îºó£¬ÎÒÃÇÐèÒªÔÊÐíÓû§ÊÖ¶¯Çл»`Locale`£¬±àдһ¸ö`LocaleController`À´ÊµÏָù¦ÄÜ£º +最å�Žï¼Œæˆ‘们需è¦�å…�许用户手动切æ�¢`Locale`,编写一个`LocaleController`æ�¥å®žçŽ°è¯¥åŠŸèƒ½ï¼š ``` @Controller public class LocaleController { final Logger logger = LoggerFactory.getLogger(getClass()); @Autowired LocaleResolver localeResolver; - @GetMapping("/locale/{lo}") public String setLocale(@PathVariable("lo") String lo, HttpServletRequest request, HttpServletResponse response) { // ¸ù¾Ý´«ÈëµÄlo´´½¨LocaleʵÀý: - Locale locale = null; int pos = lo.indexOf('_'); if (pos > 0) { String lang = lo.substring(0, pos); String country = lo.substring(pos + 1); locale = new Locale(lang, country); } else { locale = new Locale(lo); } // É趨´ËLocale: - localeResolver.setLocale(request, response, locale); logger.info("locale is set to {}.", locale); // Ë¢ÐÂÒ³Ãæ: + @GetMapping("/locale/{lo}") public String setLocale(@PathVariable("lo") String lo, HttpServletRequest request, HttpServletResponse response) { // æ ¹æ�®ä¼ å…¥çš„lo创建Locale实例: + Locale locale = null; int pos = lo.indexOf('_'); if (pos > 0) { String lang = lo.substring(0, pos); String country = lo.substring(pos + 1); locale = new Locale(lang, country); } else { locale = new Locale(lo); } // 设定此Locale: + localeResolver.setLocale(request, response, locale); logger.info("locale is set to {}.", locale); // 刷新页é�¢: String referer = request.getHeader("Referer"); return "redirect:" + (referer == null ? "/" : referer); }} ``` -ÔÚÒ³ÃæÉè¼ÆÖУ¬Í¨³£ÔÚÓÒÉϽǸøÓû§Ìṩһ¸öÓïÑÔÑ¡ÔñÁÐ±í£¬À´¿´¿´Ð§¹û£º +在页é�¢è®¾è®¡ä¸­ï¼Œé€šå¸¸åœ¨å�³ä¸Šè§’给用户æ��供一个语言选择列表,æ�¥çœ‹çœ‹æ•ˆæžœï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416194544.png) -Çл»µ½ÖÐÎÄ£º +切æ�¢åˆ°ä¸­æ–‡ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230416194602.png) -### С½á +### å°�结 -¶àÓïÑÔÖ§³ÖÐèÒª´ÓHTTPÇëÇóÖнâÎöÓû§µÄLocale£¬È»ºóÕë¶Ô²»Í¬LocaleÏÔʾ²»Í¬µÄÓïÑÔ£» +多语言支æŒ�需è¦�从HTTP请求中解æž�用户的Locale,然å�Žé’ˆå¯¹ä¸�å�ŒLocale显示ä¸�å�Œçš„语言; -Spring MVCÓ¦ÓóÌÐòͨ¹ý`MessageSource`ºÍ`LocaleResolver`£¬ÅäºÏViewʵÏÖ¹ú¼Ê»¯¡£ \ No newline at end of file +Spring MVC应用程åº�通过`MessageSource`å’Œ`LocaleResolver`,é…�å�ˆView实现国际化。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\270\270\347\224\250\345\212\237\350\203\275.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\270\270\347\224\250\345\212\237\350\203\275.md" index 6b1c4bb..699ea83 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\270\270\347\224\250\345\212\237\350\203\275.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\270\270\347\224\250\345\212\237\350\203\275.md" @@ -2,11 +2,11 @@ -# Spring MVC ʹÓÃ@Controller×¢½â¶¨ÒåÒ»¸ö¿ØÖÆÆ÷ +# Spring MVC 使用@Controller注解定义一个控制器 -2018-07-26 14:02 ¸üР+2018-07-26 14:02 æ›´æ–° @@ -18,19 +18,19 @@ > [Original] The `@Controller` annotation indicates that a particular class serves the role of a controller. Spring does not require you to extend any controller base class or reference the Servlet API. However, you can still reference Servlet-specific features if you need to. -`@Controller`×¢½â±íÃ÷ÁËÒ»¸öÀàÊÇ×÷Ϊ¿ØÖÆÆ÷µÄ½ÇÉ«¶ø´æÔڵġ£Spring²»ÒªÇóÄãÈ¥¼Ì³ÐÈκοØÖÆÆ÷»ùÀ࣬Ҳ²»ÒªÇóÄãȥʵÏÖServletµÄÄÇÌ×API¡£µ±È»£¬Èç¹ûÄãÐèÒªµÄ»°Ò²¿ÉÒÔȥʹÓÃÈκÎÓëServletÏà¹ØµÄÌØÐÔºÍÉèÊ©¡£ +`@Controller`注解表明了一个类是作为控制器的角色而存在的。Springä¸�è¦�求你去继承任何控制器基类,也ä¸�è¦�求你去实现Servlet的那套API。当然,如果你需è¦�çš„è¯�也å�¯ä»¥åŽ»ä½¿ç”¨ä»»ä½•ä¸ŽServlet相关的特性和设施。 > [Original] The `@Controller` annotation acts as a stereotype for the annotated class, indicating its role. The dispatcher scans such annotated classes for mapped methods and detects `@RequestMapping` annotations (see the next section). -`@Controller`×¢½â¿ÉÒÔÈÏΪÊDZ»±ê×¢ÀàµÄÔ­ÐÍ£¨stereotype£©£¬±íÃ÷ÁËÕâ¸öÀàËù³Ðµ£µÄ½ÇÉ«¡£·ÖÅÉÆ÷£¨`DispatcherServlet`£©»áɨÃèËùÓÐ×¢½âÁË`@Controller`µÄÀ࣬¼ì²âÆäÖÐͨ¹ý`@RequestMapping`×¢½âÅäÖõķ½·¨£¨Ïê¼ûÏÂһС½Ú£©¡£ +`@Controller`注解å�¯ä»¥è®¤ä¸ºæ˜¯è¢«æ ‡æ³¨ç±»çš„原型(stereotype),表明了这个类所承担的角色。分派器(`DispatcherServlet`)会扫æ��所有注解了`@Controller`的类,检测其中通过`@RequestMapping`注解é…�置的方法(详è§�下一å°�节)。 -> [Original] You can define annotated controller beans explicitly, using a standard Spring bean definition in the dispatcher¡¯s context. However, the `@Controller` stereotype also allows for autodetection, aligned with Spring general support for detecting component classes in the classpath and auto-registering bean definitions for them. +> [Original] You can define annotated controller beans explicitly, using a standard Spring bean definition in the dispatcher’s context. However, the `@Controller` stereotype also allows for autodetection, aligned with Spring general support for detecting component classes in the classpath and auto-registering bean definitions for them. -µ±È»£¬ÄãÒ²¿ÉÒÔ²»Ê¹ÓÃ`@Controller`×¢½â¶øÏÔʽµØÈ¥¶¨Òå±»×¢½âµÄbean£¬Õâµãͨ¹ý±ê×¼µÄSpring beanµÄ¶¨Ò巽ʽ£¬ÔÚdispatherµÄÉÏÏÂÎÄÊôÐÔÏÂÅäÖü´¿É×öµ½¡£µ«ÊÇ`@Controller`Ô­ÐÍÊÇ¿ÉÒÔ±»¿ò¼Ü×Ô¶¯¼ì²âµÄ£¬SpringÖ§³Öclasspath·¾¶ÏÂ×é¼þÀàµÄ×Ô¶¯¼ì²â£¬ÒÔ¼°¶ÔÒѶ¨ÒåbeanµÄ×Ô¶¯×¢²á¡£ +当然,你也å�¯ä»¥ä¸�使用`@Controller`注解而显å¼�地去定义被注解的bean,这点通过标准的Spring bean的定义方å¼�,在dispather的上下文属性下é…�ç½®å�³å�¯å�šåˆ°ã€‚但是`@Controller`原型是å�¯ä»¥è¢«æ¡†æž¶è‡ªåŠ¨æ£€æµ‹çš„ï¼ŒSpring支æŒ�classpath路径下组件类的自动检测,以å�Šå¯¹å·²å®šä¹‰bean的自动注册。 > [Original] To enable autodetection of such annotated controllers, you add component scanning to your configuration. Use the spring-context schema as shown in the following XML snippet: -ÄãÐèÒªÔÚÅäÖÃÖмÓÈë×é¼þɨÃèµÄÅäÖôúÂëÀ´¿ªÆô¿ò¼Ü¶Ô×¢½â¿ØÖÆÆ÷µÄ×Ô¶¯¼ì²â¡£ÇëʹÓÃÏÂÃæXML´úÂëËùʾµÄspring-context schema£º +你需è¦�在é…�置中加入组件扫æ��çš„é…�置代ç �æ�¥å¼€å�¯æ¡†æž¶å¯¹æ³¨è§£æŽ§åˆ¶å™¨çš„自动检测。请使用下é�¢XML代ç �所示的spring-context schema: ``` @@ -59,11 +59,11 @@ -# Spring MVC ʹÓÃ@RequestMapping×¢½âÓ³ÉäÇëÇó·¾¶ +# Spring MVC 使用@RequestMapping注解映射请求路径 -2018-07-26 15:29 ¸üР+2018-07-26 15:29 æ›´æ–° @@ -71,11 +71,11 @@ -Äã¿ÉÒÔʹÓÃ`@RequestMapping`×¢½âÀ´½«ÇëÇóURL£¬Èç`/appointments`µÈ£¬Ó³Éäµ½Õû¸öÀàÉÏ»òij¸öÌØ¶¨µÄ´¦ÀíÆ÷·½·¨ÉÏ¡£Ò»°ãÀ´Ëµ£¬À༶±ðµÄ×¢½â¸ºÔð½«Ò»¸öÌØ¶¨£¨»ò·ûºÏijÖÖģʽ£©µÄÇëÇó·¾¶Ó³Éäµ½Ò»¸ö¿ØÖÆÆ÷ÉÏ£¬Í¬Ê±Í¨¹ý·½·¨¼¶±ðµÄ×¢½âÀ´Ï¸»¯Ó³É䣬¼´¸ù¾ÝÌØ¶¨µÄHTTPÇëÇó·½·¨£¨¡°GET¡±¡°POST¡±·½·¨µÈ£©¡¢HTTPÇëÇóÖÐÊÇ·ñЯ´øÌض¨²ÎÊýµÈÌõ¼þ£¬½«ÇëÇóÓ³É䵽ƥÅäµÄ·½·¨ÉÏ¡£ +ä½ å�¯ä»¥ä½¿ç”¨`@RequestMapping`注解æ�¥å°†è¯·æ±‚URL,如`/appointments`等,映射到整个类上或æŸ�个特定的处ç�†å™¨æ–¹æ³•上。一般æ�¥è¯´ï¼Œç±»çº§åˆ«çš„æ³¨è§£è´Ÿè´£å°†ä¸€ä¸ªç‰¹å®šï¼ˆæˆ–符å�ˆæŸ�ç§�模å¼�)的请求路径映射到一个控制器上,å�Œæ—¶é€šè¿‡æ–¹æ³•级别的注解æ�¥ç»†åŒ–映射,å�³æ ¹æ�®ç‰¹å®šçš„HTTP请求方法(“GETâ€�“POSTâ€�方法等)ã€�HTTP请求中是å�¦æ�ºå¸¦ç‰¹å®šå�‚æ•°ç­‰æ�¡ä»¶ï¼Œå°†è¯·æ±‚映射到匹é…�的方法上。
-ÏÂÃæÕâ¶Î´úÂëʾÀýÀ´×ÔPetcare£¬ËüչʾÁËÔÚSpring MVCÖÐÈçºÎÔÚ¿ØÖÆÆ÷ÉÏʹÓÃ`@RequestMapping`×¢½â£º +下é�¢è¿™æ®µä»£ç �示例æ�¥è‡ªPetcare,它展示了在Spring MVC中如何在控制器上使用`@RequestMapping`注解: ``` @Controller @@ -116,11 +116,11 @@ public class AppointmentsController { ``` -ÔÚÉÏÃæµÄʾÀýÖУ¬Ðí¶àµØ·½¶¼Ê¹Óõ½ÁË`@RequestMapping`×¢½â¡£µÚÒ»´ÎʹÓõãÊÇ×÷ÓÃÓÚÀ༶±ðµÄ£¬ËüָʾÁËËùÓÐ`/appointments`¿ªÍ·µÄ·¾¶¶¼»á±»Ó³Éäµ½¿ØÖÆÆ÷Ï¡£`get()`·½·¨ÉϵÄ`@RequestMapping`×¢½â¶ÔÇëÇó·¾¶½øÐÐÁ˽øÒ»²½Ï¸»¯£ºËü½ö½ÓÊÜGET·½·¨µÄÇëÇó¡£ÕâÑù£¬Ò»¸öÇëÇ󷾶Ϊ`/appointments`¡¢HTTP·½·¨ÎªGETµÄÇëÇ󣬽«»á×îÖÕ½øÈëµ½Õâ¸ö·½·¨±»´¦Àí¡£`add()`·½·¨Ò²×öÁËÀàËÆµÄϸ»¯£¬¶ø`getNewForm()`·½·¨Ôòͬʱע½âÁËÄܹ»½ÓÊܵÄÇëÇóµÄHTTP·½·¨ºÍ·¾¶¡£ÕâÖÖÇé¿öÏ£¬Ò»¸ö·¾¶Îª`appointments/new`¡¢HTTP·½·¨ÎªGETµÄÇëÇ󽫻ᱻÕâ¸ö·½·¨Ëù´¦Àí¡£ +在上é�¢çš„示例中,许多地方都使用到了`@RequestMapping`注解。第一次使用点是作用于类级别的,它指示了所有`/appointments`开头的路径都会被映射到控制器下。`get()`方法上的`@RequestMapping`注解对请求路径进行了进一步细化:它仅接å�—GET方法的请求。这样,一个请求路径为`/appointments`ã€�HTTP方法为GET的请求,将会最终进入到这个方法被处ç�†ã€‚`add()`方法也å�šäº†ç±»ä¼¼çš„细化,而`getNewForm()`方法则å�Œæ—¶æ³¨è§£äº†èƒ½å¤ŸæŽ¥å�—的请求的HTTP方法和路径。这ç§�情况下,一个路径为`appointments/new`ã€�HTTP方法为GET的请求将会被这个方法所处ç�†ã€‚ -`getForDay()`·½·¨ÔòչʾÁËʹÓÃ`@RequestMapping`×¢½âµÄÁíÒ»¸ö¼¼ÇÉ£ºURIÄ£°å¡££¨¹ØÓÚURIÄ£°å£¬Çë¼ûÏÂС½Ú£© +`getForDay()`方法则展示了使用`@RequestMapping`注解的å�¦ä¸€ä¸ªæŠ€å·§ï¼šURI模æ�¿ã€‚(关于URI模æ�¿ï¼Œè¯·è§�下å°�节) -À༶±ðµÄ`@RequestMapping`×¢½â²¢²»ÊDZØÐëµÄ¡£²»ÅäÖõϰÔòËùÓеÄ·¾¶¶¼ÊǾø¶Ô·¾¶£¬¶ø·ÇÏà¶Ô·¾¶¡£ÒÔϵĴúÂëʾÀýÀ´×ÔPetClinic£¬ËüչʾÁËÒ»¸ö¾ßÓжà¸ö´¦ÀíÆ÷·½·¨µÄ¿ØÖÆÆ÷£º +类级别的`@RequestMapping`注解并ä¸�是必须的。ä¸�é…�置的è¯�则所有的路径都是ç»�对路径,而é�žç›¸å¯¹è·¯å¾„。以下的代ç �示例æ�¥è‡ªPetClinic,它展示了一个具有多个处ç�†å™¨æ–¹æ³•的控制器: ``` @Controller @@ -145,55 +145,55 @@ public class ClinicController { ``` -ÒÔÉÏ´úÂëûÓÐÖ¸¶¨ÇëÇó±ØÐëÊÇGET·½·¨»¹ÊÇPUT/POST»òÆäËû·½·¨£¬`@RequestMapping`×¢½âĬÈÏ»áÓ³ÉäËùÓеÄHTTPÇëÇó·½·¨¡£Èç¹û½öÏë½ÓÊÕijÖÖÇëÇó·½·¨£¬ÇëÔÚ×¢½âÖÐÖ¸¶¨Ö®`@RequestMapping(method=GET)`ÒÔËõС·¶Î§¡£ +以上代ç �没有指定请求必须是GET方法还是PUT/POST或其他方法,`@RequestMapping`注解默认会映射所有的HTTP请求方法。如果仅想接收æŸ�ç§�请求方法,请在注解中指定之`@RequestMapping(method=GET)`以缩å°�范围。 -## @ControllerºÍÃæÏòÇÐÃæ£¨AOP£©´úÀí +## @Controllerå’Œé�¢å�‘切é�¢ï¼ˆAOP)代ç�† -ÓÐʱ£¬ÎÒÃÇÏ£ÍûÔÚÔËÐÐʱʹÓÃAOP´úÀíÀ´×°ÊοØÖÆÆ÷£¬±ÈÈçµ±ÄãÖ±½ÓÔÚ¿ØÖÆÆ÷ÉÏʹÓÃ`@Transactional`×¢½âʱ¡£ÕâÖÖÇé¿öÏ£¬ÎÒÃÇÍÆ¼öʹÓÃÀ༶±ð£¨ÔÚ¿ØÖÆÆ÷ÉÏʹÓ㩵ĴúÀí·½Ê½¡£ÕâÒ»°ãÊÇ´úÀí¿ØÖÆÆ÷µÄĬÈÏ×ö·¨¡£Èç¹û¿ØÖÆÆ÷±ØÐëʵÏÖһЩ½Ó¿Ú£¬¶ø¸Ã½Ó¿ÚÓÖ²»Ö§³ÖSpring ContextµÄ»Øµ÷£¨±ÈÈç`InitializingBean`, `*Aware`µÈ½Ó¿Ú£©£¬ÄÇÒªÅäÖÃÀ༶±ðµÄ´úÀí¾Í±ØÐëÊÖ¶¯ÅäÖÃÁË¡£±ÈÈ磬ԭÀ´µÄÅäÖÃÎļþ``ÐèÒªÏÔʽÅäÖÃΪ``¡£ +有时,我们希望在è¿�行时使用AOP代ç�†æ�¥è£…饰控制器,比如当你直接在控制器上使用`@Transactional`注解时。这ç§�情况下,我们推è��使用类级别(在控制器上使用)的代ç�†æ–¹å¼�。这一般是代ç�†æŽ§åˆ¶å™¨çš„默认å�šæ³•ã€‚å¦‚æžœæŽ§åˆ¶å™¨å¿…é¡»å®žçŽ°ä¸€äº›æŽ¥å�£ï¼Œè€Œè¯¥æŽ¥å�£å�ˆä¸�支æŒ�Spring Context的回调(比如`InitializingBean`, `*Aware`等接å�£ï¼‰ï¼Œé‚£è¦�é…�置类级别的代ç�†å°±å¿…须手动é…�置了。比如,原æ�¥çš„é…�置文件``需è¦�显å¼�é…�置为``。 -## Spring MVC 3.1ÖÐÐÂÔöÖ§³Ö@RequestMappingµÄһЩÀà +## Spring MVC 3.1中新增支æŒ�@RequestMapping的一些类 > They are recommended for use and even required to take advantage of new features in Spring MVC 3.1 and going forward. -Spring 3.1ÖÐÐÂÔöÁËÒ»×éÀàÓÃÒÔÔöÇ¿`@RequestMapping`£¬·Ö±ðÊÇ`RequestMappingHandlerMapping`ºÍ`RequestMappingHandlerAdapter`¡£ÎÒÃÇÍÆ¼öÄãÓÃÒ»Óá£Óв¿·ÖSpring MVC 3.1Ö®ºóÐÂÔöµÄÌØÐÔ£¬ÕâÁ½¸ö×¢½âÉõÖÁÊDZØÐëµÄ¡£ÔÚMVCÃüÃû¿Õ¼äºÍMVC Java±à³ÌÅäÖ÷½Ê½Ï£¬Õâ×éÀ༰ÆäÐÂÌØÐÔĬÈÏÊÇ¿ªÆôµÄ¡£µ«ÈôÄãʹÓÃÆäËûÅäÖ÷½Ê½£¬Ôò¸ÃÌØÐÔ±ØÐëÊÖ¶¯ÅäÖòÅÄÜʹÓᣱ¾Ð¡½Ú½«¼òÒª½éÉÜһϣ¬ÐÂÀàÏà±È֮ǰµÄÒ»Ð©ÖØÒª±ä»¯¡£ +Spring 3.1中新增了一组类用以增强`@RequestMapping`,分别是`RequestMappingHandlerMapping`å’Œ`RequestMappingHandlerAdapter`。我们推è��你用一用。有部分Spring MVC 3.1之å�Žæ–°å¢žçš„特性,这两个注解甚至是必须的。在MVC命å��空间和MVC Java编程é…�置方å¼�下,这组类å�Šå…¶æ–°ç‰¹æ€§é»˜è®¤æ˜¯å¼€å�¯çš„。但若你使用其他é…�置方å¼�,则该特性必须手动é…�ç½®æ‰�能使用。本å°�节将简è¦�介ç»�一下,新类相比之å‰�的一些é‡�è¦�å�˜åŒ–。 -ÔÚSpring 3.1֮ǰ£¬¿ò¼Ü»áÔÚÁ½¸ö²»Í¬µÄ½×¶Î·Ö±ð¼ì²éÀ༶±ðºÍ·½·¨¼¶±ðµÄÇëÇóÓ³É䡪¡ªÊ×ÏÈ£¬`DefaultAnnotationHanlderMapping`»áÏÈÔÚÀ༶±ðÉÏÑ¡ÖÐÒ»¸ö¿ØÖÆÆ÷£¬È»ºóÔÙͨ¹ý`AnnotationMethodHandlerAdapter`¶¨Î»µ½¾ßÌåÒªµ÷Óõķ½·¨¡£ +在Spring 3.1之å‰�,框架会在两个ä¸�å�Œçš„阶段分别检查类级别和方法级别的请求映射——首先,`DefaultAnnotationHanlderMapping`会先在类级别上选中一个控制器,然å�Žå†�通过`AnnotationMethodHandlerAdapter`定ä½�到具体è¦�调用的方法。 > [Original] With the new support classes in Spring 3.1, the `RequestMappingHandlerMapping` is the only place where a decision is made about which method should process the request. Think of controller methods as a collection of unique endpoints with mappings for each method derived from type and method-level `@RequestMapping` information. -ÏÖÔÚÓÐÁËSpring 3.1ºóÒýÈëµÄÕâ×éÐÂÀ࣬`RequestMappingHandlerMapping`³ÉΪÁËÕâÁ½¸ö¾ö²ßʵ¼Ê·¢ÉúµÄΨһһ¸öµØ·½¡£Äã¿ÉÒÔ°Ñ¿ØÖÆÆ÷ÖеÄһϵÁд¦Àí·½·¨µ±³ÉÊÇһϵÁжÀÁ¢µÄ·þÎñ½Úµã£¬Ã¿¸ö´ÓÀ༶±ðºÍ·½·¨¼¶±ðµÄ`@RequestMapping`×¢½âÖлñÈ¡µ½×ã¹»ÇëÇó1·¾¶Ó³ÉäÐÅÏ¢¡£ +现在有了Spring 3.1å�Žå¼•入的这组新类,`RequestMappingHandlerMapping`æˆ�为了这两个决策实际å�‘生的唯一一个地方。你å�¯ä»¥æŠŠæŽ§åˆ¶å™¨ä¸­çš„一系列处ç�†æ–¹æ³•当æˆ�是一系列独立的æœ�务节点,æ¯�个从类级别和方法级别的`@RequestMapping`注解中获å�–到足够请求1路径映射信æ�¯ã€‚ > [Original] This enables some new possibilities. For once a `HandlerInterceptor` or a `HandlerExceptionResolver` can now expect the Object-based handler to be a `HandlerMethod`, which allows them to examine the exact method, its parameters and associated annotations. The processing for a URL no longer needs to be split across different controllers. -ÕâÖÖеĴ¦Àí·½Ê½´øÀ´ÁËеĿÉÄÜÐÔ¡£Ö®Ç°µÄ`HandlerInterceptor`»ò`HandlerExceptionResolver`ÏÖÔÚ¿ÉÒÔÈ·¶¨Äõ½µÄÕâ¸ö´¦ÀíÆ÷¿Ï¶¨ÊÇÒ»¸ö`HandlerMethod`ÀàÐÍ£¬Òò´ËËüÄܹ»¾«È·µØÁ˽âÕâ¸ö·½·¨µÄËùÓÐÐÅÏ¢£¬°üÀ¨ËüµÄ²ÎÊý¡¢Ó¦ÓÃÓÚÆäÉϵÄ×¢½âµÈ¡£ÕâÑù£¬ÄÚ²¿¶ÔÓÚÒ»¸öURLµÄ´¦ÀíÁ÷³ÌÔÙÒ²²»ÐèÒª·Ö¸ôµ½²»Í¬µÄ¿ØÖÆÆ÷ÀïÃæÈ¥Ö´ÐÐÁË¡£ +è¿™ç§�新的处ç�†æ–¹å¼�带æ�¥äº†æ–°çš„å�¯èƒ½æ€§ã€‚之å‰�çš„`HandlerInterceptor`或`HandlerExceptionResolver`现在å�¯ä»¥ç¡®å®šæ‹¿åˆ°çš„这个处ç�†å™¨è‚¯å®šæ˜¯ä¸€ä¸ª`HandlerMethod`类型,因此它能够精确地了解这个方法的所有信æ�¯ï¼ŒåŒ…括它的å�‚æ•°ã€�应用于其上的注解等。这样,内部对于一个URL的处ç�†æµ�程å†�也ä¸�需è¦�分隔到ä¸�å�Œçš„æŽ§åˆ¶å™¨é‡Œé�¢åŽ»æ‰§è¡Œäº†ã€‚ -> [Original] There are also several things no longer possible: [Original] _Select a controller first with a `SimpleUrlHandlerMapping` or `BeanNameUrlHandlerMapping` and then narrow the method based on `@RequestMapping` annotations. [Original] _Rely on method names as a fall-back mechanism to disambiguate between two `@RequestMapping` methods that don¡¯t have an explicit path mapping URL path but otherwise match equally, e.g. by HTTP method. In the new support classes `@RequestMapping` methods have to be mapped uniquely. [Original] * Have a single default method (without an explicit path mapping) with which requests are processed if no other controller method matches more concretely. In the new support classes if a matching method is not found a 404 error is raised. +> [Original] There are also several things no longer possible: [Original] _Select a controller first with a `SimpleUrlHandlerMapping` or `BeanNameUrlHandlerMapping` and then narrow the method based on `@RequestMapping` annotations. [Original] _Rely on method names as a fall-back mechanism to disambiguate between two `@RequestMapping` methods that don’t have an explicit path mapping URL path but otherwise match equally, e.g. by HTTP method. In the new support classes `@RequestMapping` methods have to be mapped uniquely. [Original] * Have a single default method (without an explicit path mapping) with which requests are processed if no other controller method matches more concretely. In the new support classes if a matching method is not found a 404 error is raised. -ͬʱ£¬Ò²ÓÐÆäËûµÄһЩ±ä»¯£¬±ÈÈçÓÐЩÊÂÇé¾Íû·¨ÕâÃ´Íæ¶ùÁË£º +å�Œæ—¶ï¼Œä¹Ÿæœ‰å…¶ä»–的一些å�˜åŒ–,比如有些事情就没法这么玩儿了: -* ÏÈͨ¹ý`SimpleUrlHandlerMapping`»ò`BeanNameUrlHandlerMapping`À´Äõ½¸ºÔð´¦ÀíÇëÇóµÄ¿ØÖÆÆ÷£¬È»ºóͨ¹ý`@RequestMapping`×¢½âÅäÖõÄÐÅÏ¢À´¶¨Î»µ½¾ßÌåµÄ´¦Àí·½·¨£» -* ÒÀ¿¿·½·¨Ãû³ÆÀ´×÷ΪѡÔñ´¦Àí·½·¨µÄ±ê×¼¡£±ÈÈç˵£¬Á½¸ö×¢½âÁË`@RequestMapping`µÄ·½·¨³ýÁË·½·¨Ãû³ÆÓµÓÐÍêÈ«ÏàͬµÄURLÓ³ÉäºÍHTTPÇëÇó·½·¨¡£ÔÚа汾Ï£¬`@RequestMapping`×¢½âµÄ·½·¨±ØÐë¾ßÓÐΨһµÄÇëÇóÓ³É䣻 -* ¶¨ÒåÒ»¸öĬÈÏ·½·¨£¨¼´Ã»ÓÐÉùÃ÷·¾¶Ó³É䣩£¬ÔÚÇëÇó·¾¶ÎÞ·¨±»Ó³Éäµ½¿ØÖÆÆ÷ϸü¾«È·µÄ·½·¨ÉÏȥʱ£¬Îª¸ÃÇëÇóÌṩĬÈÏ´¦Àí¡£ÔÚа汾ÖУ¬Èç¹ûÎÞ·¨ÎªÒ»¸öÇëÇóÕÒµ½ºÏÊʵĴ¦Àí·½·¨£¬ÄÇôһ¸ö404´íÎ󽫱»Å׳ö£» +* 先通过`SimpleUrlHandlerMapping`或`BeanNameUrlHandlerMapping`æ�¥æ‹¿åˆ°è´Ÿè´£å¤„ç�†è¯·æ±‚的控制器,然å�Žé€šè¿‡`@RequestMapping`注解é…�置的信æ�¯æ�¥å®šä½�到具体的处ç�†æ–¹æ³•ï¼› +* ä¾�é� æ–¹æ³•å��ç§°æ�¥ä½œä¸ºé€‰æ‹©å¤„ç�†æ–¹æ³•的标准。比如说,两个注解了`@RequestMapping`的方法除了方法å��称拥有完全相å�Œçš„URL映射和HTTP请求方法。在新版本下,`@RequestMapping`注解的方法必须具有唯一的请求映射; +* 定义一个默认方法(å�³æ²¡æœ‰å£°æ˜Žè·¯å¾„映射),在请求路径无法被映射到控制器下更精确的方法上去时,为该请求æ��供默认处ç�†ã€‚在新版本中,如果无法为一个请求找到å�ˆé€‚的处ç�†æ–¹æ³•,那么一个404错误将被抛出; -> [Original] The above features are still supported with the existing support classes. However to take advantage of new Spring MVC 3.1 features you¡¯ll need to use the new support classes. +> [Original] The above features are still supported with the existing support classes. However to take advantage of new Spring MVC 3.1 features you’ll need to use the new support classes. -Èç¹ûʹÓÃÔ­À´µÄÀ࣬ÒÔÉϵŦÄÜ»¹ÊÇ¿ÉÒÔ×öµ½¡£µ«ÊÇ£¬Èç¹ûÒªÏíÊÜSpring MVC 3.1°æ±¾´øÀ´µÄ·½±ãÌØÐÔ£¬Äã¾ÍÐèҪȥʹÓÃеÄÀà¡£ +如果使用原æ�¥çš„类,以上的功能还是å�¯ä»¥å�šåˆ°ã€‚但是,如果è¦�享å�—Spring MVC 3.1版本带æ�¥çš„æ–¹ä¾¿ç‰¹æ€§ï¼Œä½ å°±éœ€è¦�去使用新的类。 > [Original] ## URI Template Patterns -## URIÄ£°å +## URI模æ�¿ > [Original] URI templates can be used for convenient access to selected parts of a URL in a `@RequestMapping` method. -URIÄ£°å¿ÉÒÔΪ¿ìËÙ·ÃÎÊ`@RequestMapping`ÖÐÖ¸¶¨µÄURLµÄÒ»¸öÌØ¶¨µÄ²¿·ÖÌṩºÜ´óµÄ±ãÀû¡£ +URI模æ�¿å�¯ä»¥ä¸ºå¿«é€Ÿè®¿é—®`@RequestMapping`中指定的URL的一个特定的部分æ��供很大的便利。 > [Original] A URI Template is a URI-like string, containing one or more variable names. When you substitute values for these variables, the template becomes a URI. The proposed RFC for URI Templates defines how a URI is parameterized. For example, the URI Template `http://www.example.com/users/{userId}` contains the variable userId. Assigning the value fred to the variable yields `http://www.example.com/users/fred`. -URIÄ£°åÊÇÒ»¸öÀàËÆÓÚURIµÄ×Ö·û´®£¬Ö»²»¹ýÆäÖаüº¬ÁËÒ»¸ö»ò¶à¸öµÄ±äÁ¿Ãû¡£µ±ÄãʹÓÃʵ¼ÊµÄֵȥÌî³äÕâЩ±äÁ¿ÃûµÄʱºò£¬Ä£°å¾ÍÍË»¯³ÉÁËÒ»¸öURI¡£ÔÚURIÄ£°åµÄRFCÌáÒéÖж¨ÒåÁËÒ»¸öURIÊÇÈçºÎ½øÐвÎÊý»¯µÄ¡£±ÈÈç˵£¬Ò»¸öÕâ¸öURIÄ£°å`http://www.example.com/users/{userId}`¾Í°üº¬ÁËÒ»¸ö±äÁ¿Ãû_userId_¡£½«Öµ_fred_¸³¸øÕâ¸ö±äÁ¿Ãûºó£¬Ëü¾Í±ä³ÉÁËÒ»¸öURI£º`http://www.example.com/users/fred`¡£ +URI模æ�¿æ˜¯ä¸€ä¸ªç±»ä¼¼äºŽURI的字符串,å�ªä¸�过其中包å�«äº†ä¸€ä¸ªæˆ–多个的å�˜é‡�å��。当你使用实际的值去填充这些å�˜é‡�å��的时候,模æ�¿å°±é€€åŒ–æˆ�了一个URI。在URI模æ�¿çš„RFCæ��议中定义了一个URI是如何进行å�‚数化的。比如说,一个这个URI模æ�¿`http://www.example.com/users/{userId}`就包å�«äº†ä¸€ä¸ªå�˜é‡�å��_userId_。将值_fred_赋给这个å�˜é‡�å��å�Žï¼Œå®ƒå°±å�˜æˆ�了一个URI:`http://www.example.com/users/fred`。 > [Original] In Spring MVC you can use the `@PathVariable` annotation on a method argument to bind it to the value of a URI template variable: -ÔÚSpring MVCÖÐÄã¿ÉÒÔÔÚ·½·¨²ÎÊýÉÏʹÓÃ`@PathVariable`×¢½â£¬½«ÆäÓëURIÄ£°åÖеIJÎÊý°ó¶¨ÆðÀ´£º +在Spring MVC中你å�¯ä»¥åœ¨æ–¹æ³•å�‚数上使用`@PathVariable`注解,将其与URI模æ�¿ä¸­çš„å�‚数绑定起æ�¥ï¼š ``` @RequestMapping(path="/owners/{ownerId}", method=RequestMethod.GET) @@ -207,31 +207,31 @@ public String findOwner(@PathVariable String ownerId, Model model) { > [Original] The URI Template "`/owners/{ownerId}`" specifies the variable name `ownerId`. When the controller handles this request, the value of `ownerId` is set to the value found in the appropriate part of the URI. For example, when a request comes in for `/owners/fred`, the value of `ownerId` is `fred`. -URIÄ£°å"`/owners/{ownerId}`"Ö¸¶¨ÁËÒ»¸ö±äÁ¿£¬ÃûΪ`ownerId`¡£µ±¿ØÖÆÆ÷´¦ÀíÕâ¸öÇëÇóµÄʱºò£¬`ownerId`µÄÖµ¾Í»á±»URIÄ£°åÖжÔÓ¦²¿·ÖµÄÖµËùÌî³ä¡£±ÈÈç˵£¬Èç¹ûÇëÇóµÄURIÊÇ`/owners/fred`£¬´Ëʱ±äÁ¿`ownerId`µÄÖµ¾ÍÊÇ`fred`. ` +URI模æ�¿"`/owners/{ownerId}`"指定了一个å�˜é‡�,å��为`ownerId`。当控制器处ç�†è¿™ä¸ªè¯·æ±‚的时候,`ownerId`的值就会被URI模æ�¿ä¸­å¯¹åº”部分的值所填充。比如说,如果请求的URI是`/owners/fred`,此时å�˜é‡�`ownerId`的值就是`fred`. ` -> ΪÁË´¦Àí`@PathVariables`×¢½â£¬Spring MVC±ØÐëͨ¹ý±äÁ¿ÃûÀ´ÕÒµ½URIÄ£°åÖÐÏà¶ÔÓ¦µÄ±äÁ¿¡£Äã¿ÉÒÔÔÚ×¢½âÖÐÖ±½ÓÉùÃ÷£º +> 为了处ç�†`@PathVariables`注解,Spring MVC必须通过å�˜é‡�å��æ�¥æ‰¾åˆ°URI模æ�¿ä¸­ç›¸å¯¹åº”çš„å�˜é‡�。你å�¯ä»¥åœ¨æ³¨è§£ä¸­ç›´æŽ¥å£°æ˜Žï¼š > > ``` > @RequestMapping(path="/owners/{ownerId}}", method=RequestMethod.GET) > public String findOwner(@PathVariable("ownerId") String theOwner, Model model) { -> // ¾ßÌåµÄ·½·¨´úÂë¡­ +> // 具体的方法代ç �… > } > > ``` > -> »òÕߣ¬Èç¹ûURIÄ£°åÖеıäÁ¿ÃûÓë·½·¨µÄ²ÎÊýÃûÊÇÏàͬµÄ£¬ÔòÄã¿ÉÒÔ²»±ØÔÙÖ¸¶¨Ò»´Î¡£Ö»ÒªÄãÔÚ±àÒëµÄʱºòÁôÏÂdebugÐÅÏ¢£¬Spring MVC¾Í¿ÉÒÔ×Ô¶¯Æ¥ÅäURLÄ£°åÖÐÓë·½·¨²ÎÊýÃûÏàͬµÄ±äÁ¿Ãû¡£ +> 或者,如果URI模æ�¿ä¸­çš„å�˜é‡�å��与方法的å�‚æ•°å��是相å�Œçš„,则你å�¯ä»¥ä¸�å¿…å†�指定一次。å�ªè¦�你在编译的时候留下debugä¿¡æ�¯ï¼ŒSpring MVCå°±å�¯ä»¥è‡ªåŠ¨åŒ¹é…�URL模æ�¿ä¸­ä¸Žæ–¹æ³•å�‚æ•°å��相å�Œçš„å�˜é‡�å��。 > > ``` > @RequestMapping(path="/owners/{ownerId}", method=RequestMethod.GET) > public String findOwner(@PathVariable String ownerId, Model model) { -> // ¾ßÌåµÄ·½·¨´úÂë¡­ +> // 具体的方法代ç �… > } > > ``` > > [Original] A method can have any number of `@PathVariable` annotations: -Ò»¸ö·½·¨¿ÉÒÔÓµÓÐÈÎÒâÊýÁ¿µÄ`@PathVariable`×¢½â£º +一个方法å�¯ä»¥æ‹¥æœ‰ä»»æ„�æ•°é‡�çš„`@PathVariable`注解: ``` @RequestMapping(path="/owners/{ownerId}/pets/{petId}", method=RequestMethod.GET) @@ -246,11 +246,11 @@ public String findPet(@PathVariable String ownerId, @PathVariable String petId, > [Original] When a `@PathVariable` annotation is used on a `Map` argument, the map is populated with all URI template variables. -µ±`@PathVariable`×¢½â±»Ó¦ÓÃÓÚ`Map`ÀàÐ͵IJÎÊýÉÏʱ£¬¿ò¼Ü»áʹÓÃËùÓÐURIÄ£°å±äÁ¿À´Ìî³äÕâ¸ömap¡£ +当`@PathVariable`注解被应用于`Map`类型的å�‚数上时,框架会使用所有URI模æ�¿å�˜é‡�æ�¥å¡«å……这个map。 > [Original] A URI template can be assembled from type and path level _@RequestMapping_ annotations. As a result the `findPet()` method can be invoked with a URL such as `/owners/42/pets/21`. -URIÄ£°å¿ÉÒÔ´ÓÀ༶±ðºÍ·½·¨¼¶±ðµÄ _@RequestMapping_ ×¢½â»ñÈ¡Êý¾Ý¡£Òò´Ë£¬ÏñÕâÑùµÄ`findPet()`·½·¨¿ÉÒÔ±»ÀàËÆÓÚ`/owners/42/pets/21`ÕâÑùµÄURL·Óɲ¢µ÷Óõ½£º +URI模æ�¿å�¯ä»¥ä»Žç±»çº§åˆ«å’Œæ–¹æ³•级别的 _@RequestMapping_ 注解获å�–æ•°æ�®ã€‚因此,åƒ�这样的`findPet()`方法å�¯ä»¥è¢«ç±»ä¼¼äºŽ`/owners/42/pets/21`这样的URL路由并调用到: ``` _@Controller_ @@ -259,7 +259,7 @@ public class RelativePathUriTemplateController { @RequestMapping("/pets/{petId}") public void findPet(_@PathVariable_ String ownerId, _@PathVariable_ String petId, Model model) { - // ·½·¨ÊµÏÖÌåÕâÀïºöÂÔ + // 方法实现体这里忽略 } } @@ -268,105 +268,105 @@ public class RelativePathUriTemplateController { > [Original] A `@PathVariable` argument can be of _any simple type_ such as int, long, Date, etc. Spring automatically converts to the appropriate type or throws a `TypeMismatchException` if it fails to do so. You can also register support for parsing additional data types. See [the section called "Method Parameters And Type Conversion"](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-ann-typeconversion) and [the section called "Customizing WebDataBinder initialization"](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-ann-webdatabinder). -`@PathVariable`¿ÉÒÔ±»Ó¦ÓÃÓÚËùÓÐ _¼òµ¥ÀàÐÍ_ µÄ²ÎÊýÉÏ£¬±ÈÈçint¡¢long¡¢DateµÈÀàÐÍ¡£Spring»á×Ô¶¯µØ°ïÄã°Ñ²ÎÊýת»¯³ÉºÏÊʵÄÀàÐÍ£¬Èç¹ûת»»Ê§°Ü£¬¾ÍÅ׳öÒ»¸ö`TypeMismatchException`¡£Èç¹ûÄãÐèÒª´¦ÀíÆäËûÊý¾ÝÀàÐ͵Äת»»£¬Ò²¿ÉÒÔ×¢²á×Ô¼ºµÄÀà¡£ÈôÐèÒª¸üÏêϸµÄÐÅÏ¢¿ÉÒԲο¼[¡°·½·¨²ÎÊýÓëÀàÐÍת»»¡±Ò»½Ú](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-typeconversion)ºÍ[¡°¶¨ÖÆWebDataBinder³õʼ»¯¹ý³Ì¡±Ò»½Ú](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-webdatabinder) +`@PathVariable`å�¯ä»¥è¢«åº”用于所有 _简å�•类型_ çš„å�‚数上,比如intã€�longã€�Date等类型。Spring会自动地帮你把å�‚数转化æˆ�å�ˆé€‚的类型,如果转æ�¢å¤±è´¥ï¼Œå°±æŠ›å‡ºä¸€ä¸ª`TypeMismatchException`。如果你需è¦�处ç�†å…¶ä»–æ•°æ�®ç±»åž‹çš„转æ�¢ï¼Œä¹Ÿå�¯ä»¥æ³¨å†Œè‡ªå·±çš„类。若需è¦�更详细的信æ�¯å�¯ä»¥å�‚考[“方法å�‚数与类型转æ�¢â€�一节](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-typeconversion)å’Œ[“定制WebDataBinderåˆ�始化过程â€�一节](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/mvc.html#mvc-ann-webdatabinder) -## ´øÕýÔò±í´ïʽµÄURIÄ£°å +## 带正则表达å¼�çš„URI模æ�¿ > [Original] Sometimes you need more precision in defining URI template variables. Consider the URL `"/spring-web/spring-web-3.0.5.jar"`. How do you break it down into multiple parts? -ÓÐʱºòÄã¿ÉÄÜÐèÒª¸ü׼ȷµØÃèÊöÒ»¸öURIÄ£°åµÄ±äÁ¿£¬±ÈÈç˵Õâ¸öURL£º`"/spring-web/spring-web-3.0.5.jar`¡£ÄãÒªÔõô°ÑËü·Ö½â³É¼¸¸öÓÐÒâÒåµÄ²¿·ÖÄØ£¿ +有时候你å�¯èƒ½éœ€è¦�更准确地æ��述一个URI模æ�¿çš„å�˜é‡�,比如说这个URL:`"/spring-web/spring-web-3.0.5.jar`。你è¦�怎么把它分解æˆ�几个有æ„�义的部分呢? > [Original] The `@RequestMapping` annotation supports the use of regular expressions in URI template variables. The syntax is `{varName:regex}` where the first part defines the variable name and the second - the regular expression.For example: -`@RequestMapping`×¢½âÖ§³ÖÄãÔÚURIÄ£°å±äÁ¿ÖÐʹÓÃÕýÔò±í´ïʽ¡£Óï·¨ÊÇ`{varName:regex}`£¬ÆäÖеÚÒ»²¿·Ö¶¨ÒåÁ˱äÁ¿Ãû£¬µÚ¶þ²¿·Ö¾ÍÊÇÄãËùÒªÓ¦ÓõÄÕýÔò±í´ïʽ¡£±ÈÈçÏÂÃæµÄ´úÂëÑùÀý£º +`@RequestMapping`注解支æŒ�你在URI模æ�¿å�˜é‡�中使用正则表达å¼�。语法是`{varName:regex}`,其中第一部分定义了å�˜é‡�å��,第二部分就是你所è¦�应用的正则表达å¼�。比如下é�¢çš„代ç �样例: ``` @RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\\d\\.\\d\\.\\d}{extension:\\.[a-z]+}") public void handle(@PathVariable String version, @PathVariable String extension) { - // ´úÂ벿·ÖÊ¡ÂÔ... + // 代ç �部分çœ�ç•¥... } } ``` -## Path Patterns£¨²»ºÃ·­£¬ÈÝÒ×µôÔÏ棩 +## Path Patterns(ä¸�好翻,容易掉韵味) > [Original] In addition to URI templates, the `@RequestMapping` annotation also supports Ant-style path patterns (for example, `/myPath/*.do`). A combination of URI template variables and Ant-style globs is also supported (e.g. `/owners/*/pets/{petId}`). -³ýÁËURIÄ£°åÍ⣬`@RequestMapping`×¢½â»¹Ö§³ÖAnt·ç¸ñµÄ·¾¶Ä£Ê½£¨Èç`/myPath/*.do`µÈ£©¡£²»½öÈç´Ë£¬»¹¿ÉÒÔ°ÑURIÄ£°å±äÁ¿ºÍAnt·ç¸ñµÄglob×éºÏÆðÀ´Ê¹Ó㨱ÈÈç`/owners/*/pets/{petId}`ÕâÑùµÄÓ÷¨µÈ£©¡£ +除了URI模æ�¿å¤–,`@RequestMapping`注解还支æŒ�Ant风格的路径模å¼�(如`/myPath/*.do`等)。ä¸�仅如此,还å�¯ä»¥æŠŠURI模æ�¿å�˜é‡�å’ŒAnt风格的glob组å�ˆèµ·æ�¥ä½¿ç”¨ï¼ˆæ¯”如`/owners/*/pets/{petId}`这样的用法等)。 -## ·¾¶ÑùʽµÄÆ¥Åä(Path Pattern Comparison) +## 路径样å¼�的匹é…�(Path Pattern Comparison) > [Original] When a URL matches multiple patterns, a sort is used to find the most specific match. -µ±Ò»¸öURLͬʱƥÅä¶à¸öÄ£°å£¨pattern£©Ê±£¬ÎÒÃǽ«ÐèÒªÒ»¸öËã·¨À´¾ö¶¨ÆäÖÐ×îÆ¥ÅäµÄÒ»¸ö¡£ +当一个URLå�Œæ—¶åŒ¹é…�多个模æ�¿ï¼ˆpattern)时,我们将需è¦�一个算法æ�¥å†³å®šå…¶ä¸­æœ€åŒ¹é…�的一个。 > [Original] A pattern with a lower count of URI variables and wild cards is considered more specific. For example `/hotels/{hotel}/*` has 1 URI variable and 1 wild card and is considered more specific than `/hotels/{hotel}/**` which as 1 URI variable and 2 wild cards. -URIÄ£°å±äÁ¿µÄÊýÄ¿ºÍͨÅä·ûÊýÁ¿µÄ×ܺÍ×îÉÙµÄÄǸö·¾¶Ä£°å¸ü׼ȷ¡£¾Ù¸öÀý×Ó£¬`/hotels/{hotel}/*`Õâ¸ö·¾¶ÓµÓÐÒ»¸öURI±äÁ¿ºÍÒ»¸öͨÅä·û£¬¶ø`/hotels/{hotel}/**`Õâ¸ö·¾¶ÔòÓµÓÐÒ»¸öURI±äÁ¿ºÍÁ½¸öͨÅä·û£¬Òò´Ë£¬ÎÒÃÇÈÏΪǰÕßÊǸü׼ȷµÄ·¾¶Ä£°å¡£ +URI模æ�¿å�˜é‡�的数目和通é…�符数é‡�的总和最少的那个路径模æ�¿æ›´å‡†ç¡®ã€‚举个例å­�,`/hotels/{hotel}/*`这个路径拥有一个URIå�˜é‡�和一个通é…�符,而`/hotels/{hotel}/**`这个路径则拥有一个URIå�˜é‡�和两个通é…�符,因此,我们认为å‰�者是更准确的路径模æ�¿ã€‚ > [Original] If two patterns have the same count, the one that is longer is considered more specific. For example `/foo/bar*` is longer and considered more specific than `/foo/*`. -Èç¹ûÁ½¸öÄ£°åµÄURIÄ£°åÊýÁ¿ºÍͨÅä·ûÊýÁ¿×ܺÍÒ»Ö£¬Ôò·¾¶¸ü³¤µÄÄǸöÄ£°å¸ü׼ȷ¡£¾Ù¸öÀý×Ó£¬`/foo/bar*`¾Í±»ÈÏΪ±È`/foo/*`¸ü׼ȷ£¬ÒòΪǰÕߵķ¾¶¸ü³¤¡£ +如果两个模æ�¿çš„URI模æ�¿æ•°é‡�和通é…�符数é‡�总和一致,则路径更长的那个模æ�¿æ›´å‡†ç¡®ã€‚举个例å­�,`/foo/bar*`就被认为比`/foo/*`更准确,因为å‰�者的路径更长。 > [Original] When two patterns have the same count and length, the pattern with fewer wild cards is considered more specific. For example `/hotels/{hotel}` is more specific than `/hotels/*`. -Èç¹ûÁ½¸öÄ£°åµÄÊýÁ¿ºÍ³¤¶È¾ùÒ»Ö£¬ÔòÄǸö¾ßÓиüÉÙͨÅä·ûµÄÄ£°åÊǸü¼Ó׼ȷµÄ¡£±ÈÈ磬`/hotels/{hotel}`¾Í±È`/hotels/*`¸ü¾«È·¡£ +如果两个模æ�¿çš„æ•°é‡�和长度å�‡ä¸€è‡´ï¼Œåˆ™é‚£ä¸ªå…·æœ‰æ›´å°‘通é…�符的模æ�¿æ˜¯æ›´åŠ å‡†ç¡®çš„ã€‚æ¯”å¦‚ï¼Œ`/hotels/{hotel}`就比`/hotels/*`更精确。 > [Original] There are also some additional special rules: -³ý´ËÖ®Í⣬»¹ÓÐһЩÆäËûµÄ¹æÔò£º +除此之外,还有一些其他的规则: > [Original] _The **default mapping pattern** `/*_`is less specific than any other pattern. For example`/api/{a}/{b}/{c}` is more specific. > > [Original] _A **prefix pattern** such as `/public/*_`is less specific than any other pattern that doesn't contain double wildcards. For example`/public/path3/{a}/{b}/{c}` is more specific. -* **ĬÈϵÄͨÅäģʽ**`/**`±ÈÆäËûËùÓеÄģʽ¶¼¸ü¡°²»×¼È·¡±¡£±È·½Ëµ£¬`/api/{a}/{b}/{c}`¾Í±ÈĬÈϵÄͨÅäģʽ`/**`Òª¸ü׼ȷ -* **ǰ׺ͨÅä**£¨±ÈÈç`/public/**`)±»ÈÏΪ±ÈÆäËûÈκβ»°üÀ¨Ë«Í¨Åä·ûµÄģʽ¸ü²»×¼È·¡£±ÈÈç˵£¬`/public/path3/{a}/{b}/{c}`¾Í±È`/public/**`¸ü׼ȷ +* **默认的通é…�模å¼�**`/**`比其他所有的模å¼�都更“ä¸�准确â€�。比方说,`/api/{a}/{b}/{c}`就比默认的通é…�模å¼�`/**`è¦�更准确 +* **å‰�缀通é…�**(比如`/public/**`)被认为比其他任何ä¸�包括å�Œé€šé…�符的模å¼�æ›´ä¸�准确。比如说,`/public/path3/{a}/{b}/{c}`就比`/public/**`更准确 > [Original] For the full details see `AntPatternComparator` in `AntPathMatcher`. Note that the PathMatcher can be customized (see [Section 21.16.11, "Path Matching"](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-config-path-matching) in the section on configuring Spring MVC). -¸ü¶àµÄϸ½ÚÇë²Î¿¼ÕâÁ½¸öÀࣺ`AntPatternComparator`ºÍ`AntPathMatcher`¡£ÖµµÃÒ»ÌáµÄÊÇ£¬PathMatcherÀàÊÇ¿ÉÒÔÅäÖõ썼û¡°ÅäÖÃSpring MVC¡±Ò»½ÚÖеÄ[·¾¶µÄÆ¥Åä](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-cgvo27t2.html)Ò»½Ú)¡£ +更多的细节请å�‚考这两个类:`AntPatternComparator`å’Œ`AntPathMatcher`。值得一æ��的是,PathMatcher类是å�¯ä»¥é…�置的(è§�“é…�ç½®Spring MVCâ€�一节中的[路径的匹é…�](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-cgvo27t2.html)一节)。 -## ´øÕ¼Î»·ûµÄ·¾¶Ä£Ê½£¨path patterns£© +## 带å� ä½�符的路径模å¼�(path patterns) -> [Original] Patterns in `@RequestMapping` annotations support ${¡­} placeholders against local properties and/or system properties and environment variables. This may be useful in cases where the path a controller is mapped to may need to be customized through configuration. For more information on placeholders, see the javadocs of the `PropertyPlaceholderConfigurer` class. +> [Original] Patterns in `@RequestMapping` annotations support ${…} placeholders against local properties and/or system properties and environment variables. This may be useful in cases where the path a controller is mapped to may need to be customized through configuration. For more information on placeholders, see the javadocs of the `PropertyPlaceholderConfigurer` class. -`@RequestMapping`×¢½âÖ§³ÖÔÚ·¾¶ÖÐʹÓÃռλ·û£¬ÒÔÈ¡µÃһЩ±¾µØÅäÖá¢ÏµÍ³ÅäÖᢻ·¾³±äÁ¿µÈ¡£Õâ¸öÌØÐÔÓÐʱºÜÓÐÓ㬱ÈÈç˵¿ØÖÆÆ÷µÄÓ³Éä·¾¶ÐèҪͨ¹ýÅäÖÃÀ´¶¨ÖƵij¡¾°¡£Èç¹ûÏëÁ˽â¸ü¶à¹ØÓÚռλ·ûµÄÐÅÏ¢£¬¿ÉÒԲο¼`PropertyPlaceholderConfigurer`Õâ¸öÀàµÄÎĵµ¡£ +`@RequestMapping`注解支æŒ�在路径中使用å� ä½�符,以å�–得一些本地é…�ç½®ã€�系统é…�ç½®ã€�环境å�˜é‡�等。这个特性有时很有用,比如说控制器的映射路径需è¦�通过é…�ç½®æ�¥å®šåˆ¶çš„场景。如果想了解更多关于å� ä½�符的信æ�¯ï¼Œå�¯ä»¥å�‚考`PropertyPlaceholderConfigurer`这个类的文档。 ## Suffix Pattern Matching -## ºó׺ģʽƥÅä +## å�Žç¼€æ¨¡å¼�匹é…� > [Original] By default Spring MVC performs `".*"` suffix pattern matching so that a controller mapped to `/person` is also implicitly mapped to `/person.*`. This makes it easy to request different representations of a resource through the URL path (e.g. `/person.pdf`, `/person.xml`). -Spring MVCĬÈϲÉÓÃ`".*"`µÄºó׺ģʽƥÅäÀ´½øÐз¾¶Æ¥Å䣬Òò´Ë£¬Ò»¸öÓ³Éäµ½`/person`·¾¶µÄ¿ØÖÆÆ÷Ò²»áÒþʽµØ±»Ó³Éäµ½`/person.*`¡£ÕâʹµÃͨ¹ýURLÀ´ÇëÇóͬһ×ÊÔ´ÎļþµÄ²»Í¬¸ñʽ±äµÃ¸ü¼òµ¥£¨±ÈÈç`/person.pdf`£¬`/person.xml`£©¡£ +Spring MVC默认采用`".*"`çš„å�Žç¼€æ¨¡å¼�匹é…�æ�¥è¿›è¡Œè·¯å¾„匹é…�,因此,一个映射到`/person`路径的控制器也会éš�å¼�地被映射到`/person.*`。这使得通过URLæ�¥è¯·æ±‚å�Œä¸€èµ„æº�文件的ä¸�å�Œæ ¼å¼�å�˜å¾—更简å�•(比如`/person.pdf`,`/person.xml`)。 > [Original] Suffix pattern matching can be turned off or restricted to a set of path extensions explicitly registered for content negotiation purposes. This is generally recommended to minimize ambiguity with common request mappings such as `/person/{id}` where a dot might not represent a file extension, e.g. `/person/joe@email.com` vs `/person/joe@email.com.json)`. Furthermore as explained in the note below suffix pattern matching as well as content negotiation may be used in some circumstances to attempt malicious attacks and there are good reasons to restrict them meaningfully. -Äã¿ÉÒԹرÕĬÈϵĺó׺ģʽƥÅ䣬»òÕßÏÔʽµØ½«Â·¾¶ºó׺ÏÞ¶¨µ½Ò»Ð©Ìض¨¸ñʽÉÏfor content negotiation purpose¡£ÎÒÃÇÍÆ¼öÕâÑù×ö£¬ÕâÑù¿ÉÒÔ¼õÉÙÓ³ÉäÇëÇóʱ¿ÉÒÔ´øÀ´µÄһЩ¶þÒåÐÔ£¬±ÈÈçÇëÇóÒÔÏ·¾¶`/person/{id}`ʱ£¬Â·¾¶ÖеĵãºÅºóÃæ´øµÄ¿ÉÄܲ»ÊÇÃèÊöÄÚÈݸñʽ£¬±ÈÈç`/person/joe@email.com` vs `/person/joe@email.com.json`¡£¶øÇÒÕýÈçÏÂÃæÂíÉÏÒªÌáµ½µÄ£¬ºó׺ģʽͨÅäÒÔ¼°ÄÚÈÝЭÉÌÓÐʱ¿ÉÄܻᱻºÚ¿ÍÓÃÀ´½øÐй¥»÷£¬Òò´Ë£¬¶Ôºó׺ͨÅä½øÐÐÓÐÒâÒåµÄÏÞ¶¨ÊÇÓкô¦µÄ¡£ +ä½ å�¯ä»¥å…³é—­é»˜è®¤çš„å�Žç¼€æ¨¡å¼�匹é…�,或者显å¼�地将路径å�Žç¼€é™�定到一些特定格å¼�上for content negotiation purpose。我们推è��这样å�šï¼Œè¿™æ ·å�¯ä»¥å‡�少映射请求时å�¯ä»¥å¸¦æ�¥çš„一些二义性,比如请求以下路径`/person/{id}`时,路径中的点å�·å�Žé�¢å¸¦çš„å�¯èƒ½ä¸�是æ��述内容格å¼�,比如`/person/joe@email.com` vs `/person/joe@email.com.json`。而且正如下é�¢é©¬ä¸Šè¦�æ��到的,å�Žç¼€æ¨¡å¼�通é…�以å�Šå†…容å��商有时å�¯èƒ½ä¼šè¢«é»‘客用æ�¥è¿›è¡Œæ”»å‡»ï¼Œå› æ­¤ï¼Œå¯¹å�Žç¼€é€šé…�进行有æ„�义的é™�定是有好处的。 > [Original] See [Section 21.16.11, "Path Matching"](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-config-path-matching) for suffix pattern matching configuration and also [Section 21.16.6, "Content Negotiation"](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-config-content-negotiation) for content negotiation configuration. -¹ØÓÚºó׺ģʽƥÅäµÄÅäÖÃÎÊÌ⣬¿ÉÒԲο¼[Spring MVC·¾¶Æ¥ÅäÅäÖÃ](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-cgvo27t2.html)£»¹ØÓÚÄÚÈÝЭÉ̵ÄÅäÖÃÎÊÌ⣬¿ÉÒԲο¼[Spring MVC ÄÚÈÝЭÉÌ"](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-h8br27sx.html)µÄÄÚÈÝ¡£ +关于å�Žç¼€æ¨¡å¼�匹é…�çš„é…�置问题,å�¯ä»¥å�‚考[Spring MVC路径匹é…�é…�ç½®](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-cgvo27t2.html);关于内容å��商的é…�置问题,å�¯ä»¥å�‚考[Spring MVC 内容å��商"](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-h8br27sx.html)的内容。 -## ºó׺ģʽƥÅäÓëRFD +## å�Žç¼€æ¨¡å¼�匹é…�与RFD > [Original] Reflected file download (RFD) attack was first described in a [paper by Trustwave](https://www.trustwave.com/Resources/SpiderLabs-Blog/Reflected-File-Download---A-New-Web-Attack-Vector/) in 2014\. The attack is similar to XSS in that it relies on input (e.g. query parameter, URI variable) being reflected in the response. However instead of inserting JavaScript into HTML, an RFD attack relies on the browser switching to perform a download and treating the response as an executable script if double-clicked based on the file extension (e.g. .bat, .cmd). -RFD(Reflected file download)¹¥»÷×îÏÈÊÇ2014ÄêÔÚ[TrustwaveµÄһƪÂÛÎÄ](https://www.trustwave.com/Resources/SpiderLabs-Blog/Reflected-File-Download---A-New-Web-Attack-Vector/)Öб»Ìá³öµÄ¡£ËüÓëXSS¹¥»÷ÓÐЩÏàËÆ£¬ÒòΪÕâÖÖ¹¥»÷·½Ê½Ò²ÒÀÀµÓÚÄ³Ð©ÌØÕ÷£¬¼´ÐèÒªÄãµÄÊäÈ루±ÈÈç²éѯ²ÎÊý£¬URI±äÁ¿µÈ£©µÈÒ²ÔÚÊä³ö£¨response£©ÖÐÒÔijÖÖÐÎʽ³öÏÖ¡£²»Í¬µÄÊÇ£¬RFD¹¥»÷²¢²»ÊÇͨ¹ýÔÚHTMLÖÐдÈëJavaScript´úÂë½øÐУ¬¶øÊÇÒÀÀµÓÚä¯ÀÀÆ÷À´Ìø×ªµ½ÏÂÔØÒ³Ãæ£¬²¢°ÑÌØ¶¨¸ñʽ£¨±ÈÈç.bat£¬.cmdµÈ£©µÄresponseµ±³ÉÊÇ¿ÉÖ´Ðнű¾£¬Ë«»÷Ëü¾Í»áÖ´ÐС£ +RFD(Reflected file download)攻击最先是2014年在[Trustwave的一篇论文](https://www.trustwave.com/Resources/SpiderLabs-Blog/Reflected-File-Download---A-New-Web-Attack-Vector/)中被æ��出的。它与XSS攻击有些相似,因为这ç§�攻击方å¼�也ä¾�赖于æŸ�些特å¾�,å�³éœ€è¦�你的输入(比如查询å�‚数,URIå�˜é‡�等)等也在输出(response)中以æŸ�ç§�å½¢å¼�出现。ä¸�å�Œçš„æ˜¯ï¼ŒRFD攻击并ä¸�是通过在HTML中写入JavaScript代ç �进行,而是ä¾�赖于æµ�览器æ�¥è·³è½¬åˆ°ä¸‹è½½é¡µé�¢ï¼Œå¹¶æŠŠç‰¹å®šæ ¼å¼�(比如.bat,.cmd等)的response当æˆ�是å�¯æ‰§è¡Œè„šæœ¬ï¼Œå�Œå‡»å®ƒå°±ä¼šæ‰§è¡Œã€‚ > [Original] In Spring MVC `@ResponseBody` and `ResponseEntity` methods are at risk because they can render different content types which clients can request including via URL path extensions. Note however that neither disabling suffix pattern matching nor disabling the use of path extensions for content negotiation purposes alone are effective at preventing RFD attacks. -Spring MVCµÄ`@ResponseBody`ºÍ`ResponseEntity`·½·¨ÊÇÓзçÏյģ¬ÒòΪËüÃÇ»á¸ù¾Ý¿Í»§µÄÇëÇ󡪡ª°üÀ¨URLµÄ·¾¶ºó׺£¬À´äÖȾ²»Í¬µÄÄÚÈÝÀàÐÍ¡£Òò´Ë£¬½ûÓúó׺ģʽƥÅä»òÕß½ûÓýöΪÄÚÈÝЭÉÌ¿ªÆôµÄ·¾¶Îļþºó׺ÃûЯ´ø£¬¶¼ÊÇ·À·¶RFD¹¥»÷µÄÓÐЧ·½Ê½¡£ +Spring MVCçš„`@ResponseBody`å’Œ`ResponseEntity`方法是有风险的,因为它们会根æ�®å®¢æˆ·çš„请求——包括URL的路径å�Žç¼€ï¼Œæ�¥æ¸²æŸ“ä¸�å�Œçš„内容类型。因此,ç¦�用å�Žç¼€æ¨¡å¼�匹é…�或者ç¦�用仅为内容å��商开å�¯çš„路径文件å�Žç¼€å��æ�ºå¸¦ï¼Œéƒ½æ˜¯é˜²èŒƒRFD攻击的有效方å¼�。 > [Original] For comprehensive protection against RFD, prior to rendering the response body Spring MVC adds a `Content-Disposition:inline;filename=f.txt` header to suggest a fixed and safe download file filename. This is done only if the URL path contains a file extension that is neither whitelisted nor explicitly registered for content negotiation purposes. However it may potentially have side effects when URLs are typed directly into a browser. -ÈôÒª¿ªÆô¶ÔRFD¸ü¸ß¼¶µÄ±£»¤Ä£Ê½£¬¿ÉÒÔÔÚSpring MVCäÖȾ¿ªÊ¼ÇëÇóÕýÎÄ֮ǰ£¬ÔÚÇëÇóÍ·ÖÐÔö¼ÓÒ»ÐÐÅäÖÃ`Content-Disposition:inline;filename=f.txt`£¬Ö¸¶¨¹Ì¶¨µÄÏÂÔØÎļþµÄÎļþÃû¡£Õâ½öÔÚURL·¾¶Öаüº¬ÁËÒ»¸öÎļþ·ûºÏÒÔÏÂÌØÕ÷µÄÍØÕ¹ÃûʱÊÊÓ㺸ÃÀ©Õ¹Ãû¼È²»ÔÚÐÅÈÎÁÐ±í£¨°×Ãûµ¥£©ÖУ¬Ò²Ã»Óб»ÏÔʽµØ±»×¢²áÓÚÄÚÈÝЭÉÌʱʹÓᣲ¢ÇÒÕâÖÖ×ö·¨»¹¿ÉÒÔÓÐһЩ¸±×÷Ó㬱ÈÈ磬µ±URLÊÇͨ¹ýä¯ÀÀÆ÷ÊÖ¶¯ÊäÈëµÄʱºò¡£ +è‹¥è¦�å¼€å�¯å¯¹RFD更高级的ä¿�护模å¼�,å�¯ä»¥åœ¨Spring MVC渲染开始请求正文之å‰�,在请求头中增加一行é…�ç½®`Content-Disposition:inline;filename=f.txt`,指定固定的下载文件的文件å��。这仅在URL路径中包å�«äº†ä¸€ä¸ªæ–‡ä»¶ç¬¦å�ˆä»¥ä¸‹ç‰¹å¾�的拓展å��时适用:该扩展å��æ—¢ä¸�在信任列表(白å��å�•)中,也没有被显å¼�地被注册于内容å��商时使用。并且这ç§�å�šæ³•è¿˜å�¯ä»¥æœ‰ä¸€äº›å‰¯ä½œç”¨ï¼Œæ¯”如,当URL是通过æµ�览器手动输入的时候。 > [Original] Many common path extensions are whitelisted by default. Furthermore REST API calls are typically not meant to be used as URLs directly in browsers. Nevertheless applications that use custom `HttpMessageConverter` implementations can explicitly register file extensions for content negotiation and the Content-Disposition header will not be added for such extensions. See [Section 21.16.6, "Content Negotiation"](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-config-content-negotiation). -ºÜ¶à³£ÓõÄ·¾¶Îļþºó׺ĬÈÏÊDZ»ÐÅÈεġ£ÁíÍ⣬RESTµÄAPIÒ»°ãÊDz»Ó¦¸ÃÖ±½ÓÓÃ×öURLµÄ¡£²»¹ý£¬Äã¿ÉÒÔ×Ô¼º¶¨ÖÆ`HttpMessageConverter`µÄʵÏÖ£¬È»ºóÏÔʽµØ×¢²áÓÃÓÚÄÚÈÝЭÉ̵ÄÎļþÀàÐÍ£¬ÕâÖÖÇéÐÎÏÂContent-DispositionÍ·½«²»»á±»¼ÓÈëµ½ÇëÇóÍ·ÖС£Ïê¼û[Spring MVC ÄÚÈÝЭÉÌ](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-h8br27sx.html)¡£ +很多常用的路径文件å�Žç¼€é»˜è®¤æ˜¯è¢«ä¿¡ä»»çš„。å�¦å¤–,RESTçš„API一般是ä¸�应该直接用å�šURL的。ä¸�过,你å�¯ä»¥è‡ªå·±å®šåˆ¶`HttpMessageConverter`的实现,然å�Žæ˜¾å¼�地注册用于内容å��商的文件类型,这ç§�情形下Content-Disposition头将ä¸�会被加入到请求头中。详è§�[Spring MVC 内容å��商](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-h8br27sx.html)。 > [Original] This was originally introduced as part of work for [CVE-2015-5211](http://pivotal.io/security/cve-2015-5211). Below are additional recommendations from the report: > @@ -375,25 +375,25 @@ Spring MVC > * Configure content negotiation with the properties "useJaf" and "ignoreUnknownPathExtensions" set to false which would result in a 406 response for URLs with unknown extensions. Note however that this may not be an option if URLs are naturally expected to have a dot towards the end. > * Add `X-Content-Type-Options: nosniff` header to responses. Spring Security 4 does this by default. -¸Ð¾õÕâ½ÚµÄ·­ÒëÖÊÁ¿»¹ÓÐÏÞ£¬ÐèÒª¼ÌÐøÁ˽âXSS¹¥»÷ºÍRFD¹¥»÷µÄϸ½ÚÔÙ·­¡£ +感觉这节的翻译质é‡�还有é™�,需è¦�继续了解XSS攻击和RFD攻击的细节å†�翻。 -## ¾ØÕó±äÁ¿ +## 矩阵å�˜é‡� > [Original] The URI specification [RFC 3986](http://tools.ietf.org/html/rfc3986#section-3.3) defines the possibility of including name-value pairs within path segments. There is no specific term used in the spec. The general "URI path parameters" could be applied although the more unique ["Matrix URIs"](http://www.w3.org/DesignIssues/MatrixURIs.html), originating from an old post by Tim Berners-Lee, is also frequently used and fairly well known. Within Spring MVC these are referred to as matrix variables. -Ô­À´µÄURI¹æ·¶[RFC 3986](http://tools.ietf.org/html/rfc3986#section-3.3)ÖÐÔÊÐíÔÚ·¾¶¶ÎÂäÖÐЯ´ø¼üÖµ¶Ô£¬µ«¹æ·¶Ã»ÓÐÃ÷È·¸øÕâÑùµÄ¼üÖµ¶Ô¶¨ÒåÊõÓï¡£ÓÐÈ˽С°URI·¾¶²ÎÊý¡±£¬Ò²ÓнÐ[¡°¾ØÕóURI¡±](http://www.w3.org/DesignIssues/MatrixURIs.html)µÄ¡£ºóÕßÊÇTim Berners-LeeÊ×ÏÈÔÚÆä²©¿ÍÖÐÌáµ½µÄÊõÓ±»Ê¹ÓõÃÒª¸ü¼ÓƵ·±Ò»Ð©£¬ÖªÃû¶ÈÒ²¸ü¸ßЩ¡£¶øÔÚSpring MVCÖУ¬ÎÒÃdzÆÕâÑùµÄ¼üÖµ¶ÔΪ¾ØÕó±äÁ¿¡£ +原æ�¥çš„URI规范[RFC 3986](http://tools.ietf.org/html/rfc3986#section-3.3)中å…�许在路径段è�½ä¸­æ�ºå¸¦é”®å€¼å¯¹ï¼Œä½†è§„范没有明确给这样的键值对定义术语。有人å�«â€œURI路径å�‚æ•°â€�,也有å�«[“矩阵URIâ€�](http://www.w3.org/DesignIssues/MatrixURIs.html)的。å�Žè€…是Tim Berners-Lee首先在其å�šå®¢ä¸­æ��到的术语,被使用得è¦�更加频ç¹�一些,知å��度也更高些。而在Spring MVC中,我们称这样的键值对为矩阵å�˜é‡�。 > [Original] Matrix variables can appear in any path segment, each matrix variable separated with a ";" (semicolon). For example: `"/cars;color=red;year=2012"`. Multiple values may be either "," (comma) separated `"color=red,green,blue"` or the variable name may be repeated `"color=red;color=green;color=blue"`. -¾ØÕó±äÁ¿¿ÉÒÔÔÚÈκη¾¶¶ÎÂäÖгöÏÖ£¬Ã¿¶Ô¾ØÕó±äÁ¿Ö®¼äʹÓÃÒ»¸ö·ÖºÅ¡°;¡±¸ô¿ª¡£±ÈÈçÕâÑùµÄURI£º`"/cars;color=red;year=2012"`¡£¶à¸öÖµ¿ÉÒÔÓöººÅ¸ô¿ª`"color=red,green,blue"`£¬»òÕßÖØ¸´±äÁ¿Ãû¶à´Î`"color=red;color=green;color=blue"`¡£ +矩阵å�˜é‡�å�¯ä»¥åœ¨ä»»ä½•路径段è�½ä¸­å‡ºçŽ°ï¼Œæ¯�对矩阵å�˜é‡�之间使用一个分å�·â€œ;â€�隔开。比如这样的URI:`"/cars;color=red;year=2012"`。多个值å�¯ä»¥ç”¨é€—å�·éš”å¼€`"color=red,green,blue"`,或者é‡�å¤�å�˜é‡�å��多次`"color=red;color=green;color=blue"`。 > [Original] If a URL is expected to contain matrix variables, the request mapping pattern must represent them with a URI template. This ensures the request can be matched correctly regardless of whether matrix variables are present or not and in what order they are provided. -Èç¹ûÒ»¸öURLÓпÉÄÜÐèÒª°üº¬¾ØÕó±äÁ¿£¬ÄÇôÔÚÇëÇó·¾¶µÄÓ³ÉäÅäÖÃÉϾÍÐèҪʹÓÃURIÄ£°åÀ´ÌåÏÖÕâÒ»µã¡£ÕâÑù²ÅÄÜÈ·±£ÇëÇó¿ÉÒÔ±»ÕýÈ·µØÓ³É䣬¶ø²»¹Ü¾ØÕó±äÁ¿ÔÚURIÖÐÊÇ·ñ³öÏÖ¡¢³öÏֵĴÎÐòÊÇÔõÑùµÈ¡£ +如果一个URL有å�¯èƒ½éœ€è¦�包å�«çŸ©é˜µå�˜é‡�,那么在请求路径的映射é…�置上就需è¦�使用URI模æ�¿æ�¥ä½“现这一点。这样æ‰�能确ä¿�请求å�¯ä»¥è¢«æ­£ç¡®åœ°æ˜ å°„,而ä¸�管矩阵å�˜é‡�在URI中是å�¦å‡ºçްã€�出现的次åº�是怎样等。 > [Original] Below is an example of extracting the matrix variable "q": -ÏÂÃæÊÇÒ»¸öÀý×Ó£¬Õ¹Ê¾ÁËÎÒÃÇÈçºÎ´Ó¾ØÕó±äÁ¿ÖлñÈ¡µ½±äÁ¿¡°q¡±µÄÖµ£º +下é�¢æ˜¯ä¸€ä¸ªä¾‹å­�,展示了我们如何从矩阵å�˜é‡�中获å�–到å�˜é‡�“qâ€�的值: ``` // GET /pets/42;q=11;r=22 @@ -410,7 +410,7 @@ public void findPet(@PathVariable String petId, @MatrixVariable int q) { > [Original] Since all path segments may contain matrix variables, in some cases you need to be more specific to identify where the variable is expected to be: -ÓÉÓÚÈÎÒâ·¾¶¶ÎÂäÖж¼¿ÉÒÔº¬ÓоØÕó±äÁ¿£¬ÔÚijЩ³¡¾°Ï£¬ÄãÐèÒªÓøü¾«È·µÄÐÅÏ¢À´Ö¸¶¨Ò»¸ö¾ØÕó±äÁ¿µÄλÖ㺠+由于任æ„�路径段è�½ä¸­éƒ½å�¯ä»¥å�«æœ‰çŸ©é˜µå�˜é‡�,在æŸ�些场景下,你需è¦�用更精确的信æ�¯æ�¥æŒ‡å®šä¸€ä¸ªçŸ©é˜µå�˜é‡�çš„ä½�置: ``` // GET /owners/42;q=11/pets/21;q=22 @@ -429,7 +429,7 @@ public void findPet( > [Original] A matrix variable may be defined as optional and a default value specified: -ÄãÒ²¿ÉÒÔÉùÃ÷Ò»¸ö¾ØÕó±äÁ¿²»ÊDZØÐë³öÏֵ쬲¢¸øËü¸³Ò»¸öĬÈÏÖµ£º +你也å�¯ä»¥å£°æ˜Žä¸€ä¸ªçŸ©é˜µå�˜é‡�ä¸�是必须出现的,并给它赋一个默认值: ``` // GET /pets/42 @@ -445,7 +445,7 @@ public void findPet(@MatrixVariable(required=false, defaultValue="1") int q) { > [Original] All matrix variables may be obtained in a Map: -Ò²¿ÉÒÔͨ¹ýÒ»¸öMapÀ´´æ´¢ËùÓеľØÕó±äÁ¿£º +也å�¯ä»¥é€šè¿‡ä¸€ä¸ªMapæ�¥å­˜å‚¨æ‰€æœ‰çš„矩阵å�˜é‡�: ``` // GET /owners/42;q=11;r=12/pets/21;q=22;s=23 @@ -464,19 +464,19 @@ public void findPet( > [Original] Note that to enable the use of matrix variables, you must set the `removeSemicolonContent`property of `RequestMappingHandlerMapping` to `false`. By default it is set to `true`. -Èç¹ûÒªÔÊÐí¾ØÕó±äÁ¿µÄʹÓã¬Äã±ØÐë°Ñ`RequestMappingHandlerMapping`ÀàµÄ`removeSemicolonContent`ÊôÐÔÉèÖÃΪ`false`¡£¸ÃֵĬÈÏÊÇ`true`µÄ¡£ +如果è¦�å…�许矩阵å�˜é‡�的使用,你必须把`RequestMappingHandlerMapping`类的`removeSemicolonContent`属性设置为`false`。该值默认是`true`的。 > [Original] The MVC Java config and the MVC namespace both provide options for enabling the use of matrix variables. > -> MVCµÄJava±à³ÌÅäÖúÍÃüÃû¿Õ¼äÅäÖö¼ÌṩÁËÆôÓþØÕó±äÁ¿µÄ·½Ê½¡£ +> MVCçš„Java编程é…�置和命å��空间é…�置都æ��供了å�¯ç”¨çŸ©é˜µå�˜é‡�的方å¼�。 > > [Original] If you are using Java config, The [Advanced Customizations with MVC Java Config](https://linesh.gitbooks.io/spring-mvc-documentation-linesh-translation/content/publish/21-3/mvc.html#mvc-config-advanced-java) section describes how the `RequestMappingHandlerMapping` can be customized. > -> Èç¹ûÄãÊÇʹÓÃJava±à³ÌµÄ·½Ê½£¬[¡°MVC Java¸ß¼¶¶¨ÖÆ»¯ÅäÖá±Ò»½Ú](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/mvc.html#mvc-config-advanced-java)ÃèÊöÁËÈçºÎ¶Ô`RequestMappingHandlerMapping`½øÐж¨ÖÆ¡£ +> 如果你是使用Java编程的方å¼�,[“MVC Java高级定制化é…�ç½®â€�一节](http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/mvc.html#mvc-config-advanced-java)æ��述了如何对`RequestMappingHandlerMapping`进行定制。 > > [Original] In the MVC namespace, the `` element has an `enable-matrix-variables` attribute that should be set to `true`. By default it is set to `false`. > -> ¶øÊ¹ÓÃMVCµÄÃüÃû¿Õ¼äÅäÖÃʱ£¬Äã¿ÉÒÔ°Ñ``ÔªËØÏµÄ`enable-matrix-variables`ÊôÐÔÉèÖÃΪ`true`¡£¸ÃֵĬÈÏÇé¿öÏÂÊÇÅäÖÃΪ`false`µÄ¡£ +> 而使用MVC的命å��空间é…�置时,你å�¯ä»¥æŠŠ``元素下的`enable-matrix-variables`属性设置为`true`。该值默认情况下是é…�置为`false`的。 ``` @@ -495,62 +495,62 @@ public void findPet( ``` -## ¿ÉÏû·ÑµÄýÌåÀàÐÍ +## å�¯æ¶ˆè´¹çš„媒体类型 > [Original] You can narrow the primary mapping by specifying a list of consumable media types. The request will be matched only if the _Content-Type_ request header matches the specified media type. For example: -Äã¿ÉÒÔÖ¸¶¨Ò»×é¿ÉÏû·ÑµÄýÌåÀàÐÍ£¬ËõСӳÉäµÄ·¶Î§¡£ÕâÑùÖ»Óе±ÇëÇóÍ·ÖÐ _Content-Type_ µÄÖµÓëÖ¸¶¨¿ÉÏû·ÑµÄýÌåÀàÐÍÖÐÓÐÏàͬµÄʱºò£¬ÇëÇó²Å»á±»Æ¥Åä¡£±ÈÈçÏÂÃæÕâ¸öÀý×Ó£º +ä½ å�¯ä»¥æŒ‡å®šä¸€ç»„å�¯æ¶ˆè´¹çš„媒体类型,缩å°�映射的范围。这样å�ªæœ‰å½“请求头中 _Content-Type_ 的值与指定å�¯æ¶ˆè´¹çš„媒体类型中有相å�Œçš„æ—¶å€™ï¼Œè¯·æ±‚æ‰�会被匹é…�。比如下é�¢è¿™ä¸ªä¾‹å­�: ``` @Controller @RequestMapping(path = "/pets", method = RequestMethod.POST, consumes="application/json") public void addPet(@RequestBody Pet pet, Model model) { - // ·½·¨ÊµÏÖÊ¡ÂÔ + // 方法实现çœ�ç•¥ } ``` > [Original] Consumable media type expressions can also be negated as in _!text/plain_ to match to all requests other than those with _Content-Type_ of _text/plain_. Also consider using constants provided in `MediaType` such as `APPLICATION_JSON_VALUE` and `APPLICATION_JSON_UTF8_VALUE`. -Ö¸¶¨¿ÉÏû·ÑýÌåÀàÐ͵ıí´ïʽÖл¹¿ÉÒÔʹÓ÷ñ¶¨£¬±ÈÈ磬¿ÉÒÔʹÓà _!text/plain_ À´Æ¥ÅäËùÓÐÇëÇóÍ· _Content-Type_ Öв»º¬ _text/plain_ µÄÇëÇó¡£Í¬Ê±£¬ÔÚ`MediaType`ÀàÖл¹¶¨ÒåÁËһЩ³£Á¿£¬±ÈÈç`APPLICATION_JSON_VALUE`¡¢`APPLICATION_JSON_UTF8_VALUE`µÈ£¬ÍƼö¸ü¶àµØÊ¹ÓÃËüÃÇ¡£ +指定å�¯æ¶ˆè´¹åª’体类型的表达å¼�中还å�¯ä»¥ä½¿ç”¨å�¦å®šï¼Œæ¯”如,å�¯ä»¥ä½¿ç”¨ _!text/plain_ æ�¥åŒ¹é…�所有请求头 _Content-Type_ 中ä¸�å�« _text/plain_ 的请求。å�Œæ—¶ï¼Œåœ¨`MediaType`类中还定义了一些常é‡�,比如`APPLICATION_JSON_VALUE`ã€�`APPLICATION_JSON_UTF8_VALUE`等,推è��更多地使用它们。 > [Original] The _consumes_ condition is supported on the type and on the method level. Unlike most other conditions, when used at the type level, method-level consumable types override rather than extend type-level consumable types. > -> _consumes_ ÊôÐÔÌṩµÄÊÇ·½·¨¼¶µÄÀàÐÍÖ§³Ö¡£ÓëÆäËûÊôÐÔ²»Í¬£¬µ±ÔÚÀàÐͼ¶Ê¹ÓÃʱ£¬·½·¨¼¶µÄÏû·ÑÀàÐͽ«¸²¸ÇÀàÐͼ¶µÄÅäÖ㬶ø·Ç¼Ì³Ð¹ØÏµ¡£ +> _consumes_ 属性æ��供的是方法级的类型支æŒ�。与其他属性ä¸�å�Œï¼Œå½“在类型级使用时,方法级的消费类型将覆盖类型级的é…�置,而é�žç»§æ‰¿å…³ç³»ã€‚ -## ¿ÉÉú²úµÄýÌåÀàÐÍ +## å�¯ç”Ÿäº§çš„媒体类型 > [Original] You can narrow the primary mapping by specifying a list of producible media types. The request will be matched only if the _Accept_ request header matches one of these values. Furthermore, use of the _produces_ condition ensures the actual content type used to generate the response respects the media types specified in the _produces_ condition. For example: -Äã¿ÉÒÔÖ¸¶¨Ò»×é¿ÉÉú²úµÄýÌåÀàÐÍ£¬ËõСӳÉäµÄ·¶Î§¡£ÕâÑùÖ»Óе±ÇëÇóÍ·ÖÐ _Accept_ µÄÖµÓëÖ¸¶¨¿ÉÉú²úµÄýÌåÀàÐÍÖÐÓÐÏàͬµÄʱºò£¬ÇëÇó²Å»á±»Æ¥Åä¡£¶øÇÒ£¬Ê¹Óà _produces_ Ìõ¼þ¿ÉÒÔÈ·±£ÓÃÓÚÉú³ÉÏìÓ¦£¨response£©µÄÄÚÈÝÓëÖ¸¶¨µÄ¿ÉÉú²úµÄýÌåÀàÐÍÊÇÏàͬµÄ¡£¾Ù¸öÀý×Ó£º +ä½ å�¯ä»¥æŒ‡å®šä¸€ç»„å�¯ç”Ÿäº§çš„媒体类型,缩å°�映射的范围。这样å�ªæœ‰å½“请求头中 _Accept_ 的值与指定å�¯ç”Ÿäº§çš„媒体类型中有相å�Œçš„æ—¶å€™ï¼Œè¯·æ±‚æ‰�会被匹é…�。而且,使用 _produces_ æ�¡ä»¶å�¯ä»¥ç¡®ä¿�用于生æˆ�å“�应(response)的内容与指定的å�¯ç”Ÿäº§çš„媒体类型是相å�Œçš„。举个例å­�: ``` @Controller @RequestMapping(path = "/pets/{petId}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE) @ResponseBody public Pet getPet(@PathVariable String petId, Model model) { - // ·½·¨ÊµÏÖÊ¡ÂÔ + // 方法实现çœ�ç•¥ } ``` > [Original] Be aware that the media type specified in the _produces_ condition can also optionally specify a character set. For example, in the code snippet above we specify the same media type than the default one configured in `MappingJackson2HttpMessageConverter`, including the `UTF-8`charset. > -> ҪעÒâµÄÊÇ£¬Í¨¹ý _condition_ Ìõ¼þÖ¸¶¨µÄýÌåÀàÐÍÒ²¿ÉÒÔÖ¸¶¨×Ö·û¼¯¡£±ÈÈçÔÚÉÏÃæµÄС¶Î´úÂëÖУ¬ÎÒÃÇ»¹ÊǸ²Ð´ÁË`MappingJackson2HttpMessageConverter`ÀàÖÐĬÈÏÅäÖõÄýÌåÀàÐÍ£¬Í¬Ê±£¬»¹Ö¸¶¨ÁËʹÓÃ`UTF-8`µÄ×Ö·û¼¯¡£ +> è¦�注æ„�的是,通过 _condition_ æ�¡ä»¶æŒ‡å®šçš„媒体类型也å�¯ä»¥æŒ‡å®šå­—符集。比如在上é�¢çš„å°�段代ç �中,我们还是覆写了`MappingJackson2HttpMessageConverter`类中默认é…�置的媒体类型,å�Œæ—¶ï¼Œè¿˜æŒ‡å®šäº†ä½¿ç”¨`UTF-8`的字符集。 > > [Original] Just like with _consumes_, producible media type expressions can be negated as in _!text/plain_ to match to all requests other than those with an _Accept_ header value of _text/plain_. Also consider using constants provided in `MediaType` such as `APPLICATION_JSON_VALUE` and `APPLICATION_JSON_UTF8_VALUE`. -Óë _consumes_ Ìõ¼þÀàËÆ£¬¿ÉÉú²úµÄýÌåÀàÐͱí´ïʽҲ¿ÉÒÔʹÓ÷ñ¶¨¡£±ÈÈ磬¿ÉÒÔʹÓà _!text/plain_ À´Æ¥ÅäËùÓÐÇëÇóÍ· _Accept_ Öв»º¬ _text/plain_ µÄÇëÇó¡£Í¬Ê±£¬ÔÚ`MediaType`ÀàÖл¹¶¨ÒåÁËһЩ³£Á¿£¬±ÈÈç`APPLICATION_JSON_VALUE`¡¢`APPLICATION_JSON_UTF8_VALUE`µÈ£¬ÍƼö¸ü¶àµØÊ¹ÓÃËüÃÇ¡£ +与 _consumes_ æ�¡ä»¶ç±»ä¼¼ï¼Œå�¯ç”Ÿäº§çš„媒体类型表达å¼�也å�¯ä»¥ä½¿ç”¨å�¦å®šã€‚比如,å�¯ä»¥ä½¿ç”¨ _!text/plain_ æ�¥åŒ¹é…�所有请求头 _Accept_ 中ä¸�å�« _text/plain_ 的请求。å�Œæ—¶ï¼Œåœ¨`MediaType`类中还定义了一些常é‡�,比如`APPLICATION_JSON_VALUE`ã€�`APPLICATION_JSON_UTF8_VALUE`等,推è��更多地使用它们。 > [Original] The _produces_ condition is supported on the type and on the method level. Unlike most other conditions, when used at the type level, method-level producible types override rather than extend type-level producible types. > -> _produces_ ÊôÐÔÌṩµÄÊÇ·½·¨¼¶µÄÀàÐÍÖ§³Ö¡£ÓëÆäËûÊôÐÔ²»Í¬£¬µ±ÔÚÀàÐͼ¶Ê¹ÓÃʱ£¬·½·¨¼¶µÄÏû·ÑÀàÐͽ«¸²¸ÇÀàÐͼ¶µÄÅäÖ㬶ø·Ç¼Ì³Ð¹ØÏµ¡£ +> _produces_ 属性æ��供的是方法级的类型支æŒ�。与其他属性ä¸�å�Œï¼Œå½“在类型级使用时,方法级的消费类型将覆盖类型级的é…�置,而é�žç»§æ‰¿å…³ç³»ã€‚ -## ÇëÇó²ÎÊýÓëÇëÇóÍ·µÄÖµ +## 请求å�‚数与请求头的值 > [Original] You can narrow request matching through request parameter conditions such as `"myParam"`, `"!myParam"`, or `"myParam=myValue"`. The first two test for request parameter presence/absence and the third for a specific parameter value. Here is an example with a request parameter value condition: -Äã¿ÉÒÔɸѡÇëÇó²ÎÊýµÄÌõ¼þÀ´ËõСÇëÇóÆ¥Å䷶Χ£¬±ÈÈç`"myParam"`¡¢`"!myParam"`¼°`"myParam=myValue"`µÈ¡£Ç°Á½¸öÌõ¼þÓÃÓÚɸѡ´æÔÚ/²»´æÔÚijЩÇëÇó²ÎÊýµÄÇëÇ󣬵ÚÈý¸öÌõ¼þɸѡ¾ßÓÐÌØ¶¨²ÎÊýÖµµÄÇëÇó¡£ÏÂÃæÓиöÀý×Ó£¬Õ¹Ê¾ÁËÈçºÎʹÓÃÇëÇó²ÎÊýÖµµÄɸѡÌõ¼þ£º +ä½ å�¯ä»¥ç­›é€‰è¯·æ±‚å�‚æ•°çš„æ�¡ä»¶æ�¥ç¼©å°�请求匹é…�范围,比如`"myParam"`ã€�`"!myParam"`å�Š`"myParam=myValue"`等。å‰�两个æ�¡ä»¶ç”¨äºŽç­›é€‰å­˜åœ¨/ä¸�存在æŸ�些请求å�‚数的请求,第三个æ�¡ä»¶ç­›é€‰å…·æœ‰ç‰¹å®šå�‚数值的请求。下é�¢æœ‰ä¸ªä¾‹å­�,展示了如何使用请求å�‚数值的筛选æ�¡ä»¶ï¼š ``` @Controller @@ -559,7 +559,7 @@ public class RelativePathUriTemplateController { @RequestMapping(path = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue") public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) { - // ʵ¼ÊʵÏÖÊ¡ÂÔ + // 实际实现çœ�ç•¥ } } @@ -568,7 +568,7 @@ public class RelativePathUriTemplateController { > [Original] The same can be done to test for request header presence/absence or to match based on a specific request header value: -ͬÑù£¬Äã¿ÉÒÔÓÃÏàͬµÄÌõ¼þÀ´É¸Ñ¡ÇëÇóÍ·µÄ³öÏÖÓë·ñ£¬»òÕßɸѡ³öÒ»¸ö¾ßÓÐÌØ¶¨ÖµµÄÇëÇóÍ·£º +å�Œæ ·ï¼Œä½ å�¯ä»¥ç”¨ç›¸å�Œçš„æ�¡ä»¶æ�¥ç­›é€‰è¯·æ±‚头的出现与å�¦ï¼Œæˆ–者筛选出一个具有特定值的请求头: ``` @Controller @@ -577,7 +577,7 @@ public class RelativePathUriTemplateController { @RequestMapping(path = "/pets", method = RequestMethod.GET, headers="myHeader=myValue") public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) { - // ·½·¨ÌåʵÏÖÊ¡ÂÔ + // 方法体实现çœ�ç•¥ } } @@ -586,7 +586,7 @@ public class RelativePathUriTemplateController { > [Original] Although you can match to _Content-Type_ and _Accept_ header values using media type wild cards (for example _"content-type=text/*"_ will match to _"text/plain"_ and _"text/html"_), it is recommended to use the _consumes_ and _produces_ conditions respectively instead. They are intended specifically for that purpose. > -> ¾¡¹Ü£¬Äã¿ÉÒÔʹÓÃýÌåÀàÐ͵ÄͨÅä·û£¨±ÈÈç _"content-type=text/*"_£©À´Æ¥ÅäÇëÇóÍ· _Content-Type_ºÍ _Accept_µÄÖµ£¬µ«ÎÒÃǸüÍÆ¼ö¶ÀÁ¢Ê¹Óà _consumes_ºÍ _produces_Ìõ¼þÀ´É¸Ñ¡¸÷×ÔµÄÇëÇó¡£ÒòΪËüÃǾÍÊÇרÃÅÎªÇø·ÖÕâÁ½ÖÖ²»Í¬µÄ³¡¾°¶øÉúµÄ¡£ +> 尽管,你å�¯ä»¥ä½¿ç”¨åª’体类型的通é…�符(比如 _"content-type=text/*"_)æ�¥åŒ¹é…�请求头 _Content-Type_å’Œ _Accept_的值,但我们更推è��独立使用 _consumes_å’Œ _produces_æ�¡ä»¶æ�¥ç­›é€‰å�„自的请求。因为它们就是专门为区分这两ç§�ä¸�å�Œçš„场景而生的。
diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\274\202\345\270\270\345\244\204\347\220\206\345\231\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\274\202\345\270\270\345\244\204\347\220\206\345\231\250.md" index 604e246..1029f4d 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\274\202\345\270\270\345\244\204\347\220\206\345\231\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\345\274\202\345\270\270\345\244\204\347\220\206\345\231\250.md" @@ -2,11 +2,11 @@ -# Spring MVC ´¦ÀíÆ÷Òì³£½âÎöÆ÷ +# Spring MVC 处ç�†å™¨å¼‚常解æž�器 -2018-07-26 14:32 ¸üР+2018-07-26 14:32 æ›´æ–° @@ -14,11 +14,11 @@ -SpringµÄ´¦ÀíÆ÷Òì³£½âÎöÆ÷`HandlerExceptionResolver`½Ó¿ÚµÄʵÏÖ¸ºÔð´¦Àí¸÷Àà¿ØÖÆÆ÷Ö´Ðйý³ÌÖгöÏÖµÄÒì³£¡£Ä³Ö̶ֳÈÉϽ²£¬`HandlerExceptionResolver`ÓëÄãÔÚwebÓ¦ÓÃÃèÊö·û`web.xml`ÎļþÖÐÄܶ¨ÒåµÄÒì³£Ó³É䣨exception mapping£©ºÜÏàÏñ£¬²»¹ýËü±ÈºóÕßÌṩÁ˸üÁé»îµÄ·½Ê½¡£±ÈÈçËüÄÜÌṩÒì³£±»Å׳öʱÕýÔÚÖ´ÐеÄÊÇÄĸö´¦ÀíÆ÷ÕâÑùµÄÐÅÏ¢¡£²¢ÇÒ£¬Ò»¸ö¸üÁé»î£¨programmatic£©µÄÒì³£´¦Àí·½Ê½¿ÉÒÔΪÄãÌṩ¸ü¶àÑ¡Ôñ£¬Ê¹ÄãÔÚÇëÇó±»Ö±½ÓתÏòµ½ÁíÒ»¸öURL֮ǰ£¨ÓëÄãʹÓÃServlet¹æ·¶µÄÒì³£Ó³ÉäÊÇÒ»ÑùµÄ£©Óиü¶àµÄ·½Ê½À´´¦ÀíÒì³£¡£ +Spring的处ç�†å™¨å¼‚常解æž�器`HandlerExceptionResolver`接å�£çš„实现负责处ç�†å�„类控制器执行过程中出现的异常。æŸ�ç§�程度上讲,`HandlerExceptionResolver`与你在web应用æ��述符`web.xml`文件中能定义的异常映射(exception mapping)很相åƒ�,ä¸�过它比å�Žè€…æ��供了更ç�µæ´»çš„æ–¹å¼�。比如它能æ��供异常被抛出时正在执行的是哪个处ç�†å™¨è¿™æ ·çš„ä¿¡æ�¯ã€‚并且,一个更ç�µæ´»ï¼ˆprogrammatic)的异常处ç�†æ–¹å¼�å�¯ä»¥ä¸ºä½ æ��供更多选择,使你在请求被直接转å�‘到å�¦ä¸€ä¸ªURL之å‰�(与你使用Servlet规范的异常映射是一样的)有更多的方å¼�æ�¥å¤„ç�†å¼‚常。
-ʵÏÖ`HandlerExceptionResolver`½Ó¿Ú²¢·ÇʵÏÖÒì³£´¦ÀíµÄΨһ·½Ê½£¬ËüÖ»ÊÇÌṩÁË`resolveException(Exception, Hanlder)`·½·¨µÄÒ»¸öʵÏÖ¶øÒÑ£¬·½·¨»á·µ»ØÒ»¸ö`ModelAndView`¡£³ý´ËÖ®Í⣬Ä㻹¿ÉÒÔ¿ò¼ÜÌṩµÄ`SimpleMappingExceptionResolver`»òÔÚÒì³£´¦Àí·½·¨ÉÏ×¢½â`@ExceptionHandler`¡£`SimpleMappingExceptionResolver`ÔÊÐíÄã»ñÈ¡¿ÉÄÜÅ׳öµÄÒì³£ÀàµÄÃû×Ö£¬²¢°ÑËüÓ³Éäµ½Ò»¸öÊÓͼÃûÉÏÈ¥¡£ÕâÓëServlet APIÌṩµÄÒì³£Ó³ÉäÌØÐÔÊǹ¦Äܵȼ۵쬵«ÄãÒ²¿ÉÒÔ»ùÓÚ´ËʵÏÖÁ£¶È¸ü¾«Ï¸µÄÒì³£Ó³Éä¡£¶ø`@ExceptionHandler`×¢½âµÄ·½·¨Ôò»áÔÚÒì³£Å׳öʱ±»µ÷ÓÃÒÔ´¦Àí¸ÃÒì³£¡£ÕâÑùµÄ·½·¨¿ÉÒÔ¶¨ÒåÔÚ`@Controller`×¢½âµÄ¿ØÖÆÆ÷ÀàÀҲ¿ÉÒÔ¶¨ÒåÔÚ`@ControllerAdvice`ÀàÖУ¬ºóÕß¿ÉÒÔʹ¸ÃÒì³£´¦Àí·½·¨±»Ó¦Óõ½¸ü¶àµÄ`@Controller`¿ØÖÆÆ÷ÖС£ÏÂһС½Ú½«Ìṩ¸üΪÏêϸµÄÐÅÏ¢¡£ +实现`HandlerExceptionResolver`接å�£å¹¶é�žå®žçް异叏处ç�†çš„唯一方å¼�,它å�ªæ˜¯æ��供了`resolveException(Exception, Hanlder)`方法的一个实现而已,方法会返回一个`ModelAndView`。除此之外,你还å�¯ä»¥æ¡†æž¶æ��供的`SimpleMappingExceptionResolver`或在异常处ç�†æ–¹æ³•上注解`@ExceptionHandler`。`SimpleMappingExceptionResolver`å…�许你获å�–å�¯èƒ½æŠ›å‡ºçš„异常类的å��字,并把它映射到一个视图å��上去。这与Servlet APIæ��供的异常映射特性是功能等价的,但你也å�¯ä»¥åŸºäºŽæ­¤å®žçŽ°ç²’åº¦æ›´ç²¾ç»†çš„å¼‚å¸¸æ˜ å°„ã€‚è€Œ`@ExceptionHandler`注解的方法则会在异常抛出时被调用以处ç�†è¯¥å¼‚常。这样的方法å�¯ä»¥å®šä¹‰åœ¨`@Controller`注解的控制器类里,也å�¯ä»¥å®šä¹‰åœ¨`@ControllerAdvice`类中,å�Žè€…å�¯ä»¥ä½¿è¯¥å¼‚常处ç�†æ–¹æ³•被应用到更多的`@Controller`控制器中。下一å°�节将æ��供更为详细的信æ�¯ã€‚
@@ -28,11 +28,11 @@ Spring -# Spring MVC ʹÓÃ@ExceptionHandler×¢½â +# Spring MVC 使用@ExceptionHandler注解 -2018-07-26 14:33 ¸üР+2018-07-26 14:33 æ›´æ–° @@ -42,9 +42,9 @@ Spring
-`HandlerExceptionResolver`½Ó¿ÚÒÔ¼°`SimpleMappingExceptionResolver`½âÎöÆ÷ÀàµÄʵÏÖʹµÃÄãÄÜÉùÃ÷ʽµØ½«Òì³£Ó³Éäµ½ÌØ¶¨µÄÊÓͼÉÏ£¬»¹¿ÉÒÔÔÚÒì³£±»×ª·¢£¨forward£©µ½¶ÔÓ¦µÄÊÓͼǰʹÓÃJava´úÂë×öЩÅжϺÍÂß¼­¡£²»¹ýÔÚһЩ³¡¾°£¬ÌرðÊÇÒÀ¿¿`@ResponseBody`·µ»ØÏìÓ¦¶ø·ÇÒÀÀµÊÓͼ½âÎö»úÖÆµÄ³¡¾°Ï£¬Ö±½ÓÉèÖÃÏìÓ¦µÄ״̬Âë²¢½«¿Í»§¶ËÐèÒªµÄ´íÎóÐÅÏ¢Ö±½Óд»ØÏìÓ¦ÌåÖУ¬¿ÉÄÜÊǸü·½±ãµÄ·½·¨¡£ +`HandlerExceptionResolver`接å�£ä»¥å�Š`SimpleMappingExceptionResolver`è§£æž�器类的实现使得你能声明å¼�地将异常映射到特定的视图上,还å�¯ä»¥åœ¨å¼‚常被转å�‘(forward)到对应的视图å‰�使用Java代ç �å�šäº›åˆ¤æ–­å’Œé€»è¾‘。ä¸�过在一些场景,特别是ä¾�é� `@ResponseBody`返回å“�应而é�žä¾�赖视图解æž�机制的场景下,直接设置å“�应的状æ€�ç �并将客户端需è¦�的错误信æ�¯ç›´æŽ¥å†™å›žå“�应体中,å�¯èƒ½æ˜¯æ›´æ–¹ä¾¿çš„æ–¹æ³•。 -ÄãÒ²¿ÉÒÔʹÓÃ`@ExceptionHandler`·½·¨À´×öµ½Õâµã¡£Èç¹û`@ExceptionHandler`·½·¨ÊÇÔÚ¿ØÖÆÆ÷ÄÚ²¿¶¨ÒåµÄ£¬ÄÇôËü»á½ÓÊÕ²¢´¦ÀíÓÉ¿ØÖÆÆ÷£¨»òÆäÈκÎ×ÓÀࣩÖеÄ`@RequestMapping`·½·¨Å׳öµÄÒì³£¡£Èç¹ûÄ㽫`@ExceptionHandler`·½·¨¶¨ÒåÔÚ`@ControllerAdvice`ÀàÖУ¬ÄÇôËü»á´¦ÀíÏà¹Ø¿ØÖÆÆ÷ÖÐÅ׳öµÄÒì³£¡£ÏÂÃæµÄ´úÂë¾ÍչʾÁËÒ»¸ö¶¨ÒåÔÚ¿ØÖÆÆ÷ÄÚ²¿µÄ`@ExceptionHandler`·½·¨£º +你也å�¯ä»¥ä½¿ç”¨`@ExceptionHandler`方法æ�¥å�šåˆ°è¿™ç‚¹ã€‚如果`@ExceptionHandler`方法是在控制器内部定义的,那么它会接收并处ç�†ç”±æŽ§åˆ¶å™¨ï¼ˆæˆ–其任何å­�类)中的`@RequestMapping`方法抛出的异常。如果你将`@ExceptionHandler`方法定义在`@ControllerAdvice`类中,那么它会处ç�†ç›¸å…³æŽ§åˆ¶å™¨ä¸­æŠ›å‡ºçš„异常。下é�¢çš„代ç �就展示了一个定义在控制器内部的`@ExceptionHandler`方法: ``` @Controller @@ -62,9 +62,9 @@ public class SimpleController { ``` -´ËÍ⣬`@ExceptionHandler`×¢½â»¹¿ÉÒÔ½ÓÊÜÒ»¸öÒì³£ÀàÐ͵ÄÊý×é×÷Ϊ²ÎÊýÖµ¡£ÈôÅ׳öÁËÒÑÔÚÁбíÖÐÉùÃ÷µÄÒì³££¬ÄÇôÏàÓ¦µÄ`@ExceptionHandler`·½·¨½«»á±»µ÷Óá£Èç¹ûûÓиø×¢½âÈκβÎÊýÖµ£¬ÄÇôĬÈÏ´¦ÀíµÄÒì³£ÀàÐͽ«ÊÇ·½·¨²ÎÊýËùÉùÃ÷µÄÄÇЩÒì³£¡£ +此外,`@ExceptionHandler`注解还å�¯ä»¥æŽ¥å�—一个异常类型的数组作为å�‚数值。若抛出了已在列表中声明的异常,那么相应的`@ExceptionHandler`方法将会被调用。如果没有给注解任何å�‚数值,那么默认处ç�†çš„异常类型将是方法å�‚数所声明的那些异常。 -Óë±ê×¼µÄ¿ØÖÆÆ÷`@RequestMapping`×¢½â´¦Àí·½·¨Ò»Ñù£¬`@ExceptionHandler`·½·¨µÄ·½·¨²ÎÊýºÍ·µ»ØÖµÒ²¿ÉÒÔºÜÁé»î¡£±ÈÈ磬ÔÚServlet»·¾³Ï·½·¨¿ÉÒÔ½ÓÊÕ`HttpServletRequest`²ÎÊý£¬¶øPortlet»·¾³Ï·½·¨¿ÉÒÔ½ÓÊÕ`PortletRequest`²ÎÊý¡£·µ»ØÖµ¿ÉÒÔÊÇ`String`ÀàÐÍ¡ª¡ªÕâÖÖÇé¿öÏ»ᱻ½âÎöΪÊÓͼÃû¡ª¡ª¿ÉÒÔÊÇ`ModelAndView`ÀàÐ͵ĶÔÏó£¬Ò²¿ÉÒÔÊÇ`ResponseEntity`¡£»òÕßÄ㻹¿ÉÒÔÔÚ·½·¨ÉÏÌí¼Ó`@ResponseBody`×¢½âÒÔʹÓÃÏûϢת»»Æ÷»áת»»ÐÅÏ¢ÎªÌØ¶¨ÀàÐ͵ÄÊý¾Ý£¬È»ºó°ÑËüÃÇд»Øµ½ÏìÓ¦Á÷ÖС£ +与标准的控制器`@RequestMapping`注解处ç�†æ–¹æ³•一样,`@ExceptionHandler`方法的方法å�‚数和返回值也å�¯ä»¥å¾ˆç�µæ´»ã€‚比如,在Servlet环境下方法å�¯ä»¥æŽ¥æ”¶`HttpServletRequest`å�‚数,而Portlet环境下方法å�¯ä»¥æŽ¥æ”¶`PortletRequest`å�‚数。返回值å�¯ä»¥æ˜¯`String`类型——这ç§�情况下会被解æž�为视图å��——å�¯ä»¥æ˜¯`ModelAndView`类型的对象,也å�¯ä»¥æ˜¯`ResponseEntity`。或者你还å�¯ä»¥åœ¨æ–¹æ³•上添加`@ResponseBody`注解以使用消æ�¯è½¬æ�¢å™¨ä¼šè½¬æ�¢ä¿¡æ�¯ä¸ºç‰¹å®šç±»åž‹çš„æ•°æ�®ï¼Œç„¶å�ŽæŠŠå®ƒä»¬å†™å›žåˆ°å“�应æµ�中。
@@ -74,11 +74,11 @@ public class SimpleController { -# Spring MVC ´¦ÀíÒ»°ãµÄÒì³£ +# Spring MVC 处ç�†ä¸€èˆ¬çš„异常 -2018-07-26 14:34 ¸üР+2018-07-26 14:34 æ›´æ–° @@ -86,31 +86,31 @@ public class SimpleController { -´¦ÀíÇëÇóµÄ¹ý³ÌÖУ¬Spring MVC¿ÉÄÜ»áÅ׳öһЩµÄÒì³£¡£`SimpleMappingExceptionResolver`¿ÉÒÔ¸ù¾ÝÐèÒªºÜ·½±ãµØ½«ÈκÎÒì³£Ó³Éäµ½Ò»¸öĬÈϵĴíÎóÊÓͼ¡£µ«£¬Èç¹û¿Í»§¶ËÊÇͨ¹ý×Ô¶¯¼ì²âÏìÓ¦µÄ·½Ê½À´·Ö·¢´¦ÀíÒì³£µÄ£¬ÄÇôºó¶Ë¾ÍÐèҪΪÏìÓ¦ÉèÖöÔÓ¦µÄ״̬Âë¡£¸ù¾ÝÅ׳öÒì³£µÄÀàÐͲ»Í¬£¬¿ÉÄÜÐèÒªÉèÖò»Í¬µÄ״̬ÂëÀ´±êʶÊǿͻ§¶Ë´íÎó£¨4xx£©»¹ÊÇ·þÎñÆ÷¶Ë´íÎó£¨5xx£©¡£ +处ç�†è¯·æ±‚的过程中,Spring MVCå�¯èƒ½ä¼šæŠ›å‡ºä¸€äº›çš„异常。`SimpleMappingExceptionResolver`å�¯ä»¥æ ¹æ�®éœ€è¦�很方便地将任何异常映射到一个默认的错误视图。但,如果客户端是通过自动检测å“�应的方å¼�æ�¥åˆ†å�‘处ç�†å¼‚常的,那么å�Žç«¯å°±éœ€è¦�为å“�应设置对应的状æ€�ç �。根æ�®æŠ›å‡ºå¼‚常的类型ä¸�å�Œï¼Œå�¯èƒ½éœ€è¦�设置ä¸�å�Œçš„状æ€�ç �æ�¥æ ‡è¯†æ˜¯å®¢æˆ·ç«¯é”™è¯¯ï¼ˆ4xx)还是æœ�务器端错误(5xx)。
-ĬÈÏ´¦ÀíÆ÷Òì³£½âÎöÆ÷`DefaultHandlerExceptionResolver`»á½«Spring MVCÅ׳öµÄÒ쳣ת»»³É¶ÔÓ¦µÄ´íÎó״̬Âë¡£¸Ã½âÎöÆ÷ÔÚMVCÃüÃû¿Õ¼äÅäÖûòMVC JavaÅäÖõķ½Ê½ÏÂĬÈÏÒѾ­±»×¢²áÁË£¬ÁíÍ⣬ͨ¹ý`DispatcherServlet`×¢²áÒ²ÊÇ¿ÉÐе썼´²»Ê¹ÓÃMVCÃüÃû¿Õ¼ä»òJava±à³Ì·½Ê½½øÐÐÅäÖõÄʱºò£©¡£Ï±íÁгöÁ˸ýâÎöÆ÷ÄÜ´¦ÀíµÄһЩÒì³££¬¼°ËûÃǶÔÓ¦µÄ״̬Âë¡£ +默认处ç�†å™¨å¼‚常解æž�器`DefaultHandlerExceptionResolver`会将Spring MVC抛出的异常转æ�¢æˆ�对应的错误状æ€�ç �。该解æž�器在MVC命å��空间é…�置或MVC Javaé…�置的方å¼�下默认已ç»�被注册了,å�¦å¤–,通过`DispatcherServlet`注册也是å�¯è¡Œçš„(å�³ä¸�使用MVC命å��空间或Java编程方å¼�进行é…�置的时候)。下表列出了该解æž�器能处ç�†çš„一些异常,å�Šä»–们对应的状æ€�ç �。 -| Òì³£ | HTTP״̬Âë | +| 异常 | HTTP状æ€�ç � | | --- | --- | -| `BindException` | 400 (ÎÞЧÇëÇó) | -| `ConversionNotSupportedException` | 500 (·þÎñÆ÷ÄÚ²¿´íÎó) | -| `HttpMediaTypeNotAcceptableException` | 406 (²»½ÓÊÜ) | -| `HttpMediaTypeNotSupportedException` | 415 (²»Ö§³ÖµÄýÌåÀàÐÍ) | -| `HttpMessageNotReadableException` | 400 (ÎÞЧÇëÇó) | -| `HttpMessageNotWritableException` | 500 (·þÎñÆ÷ÄÚ²¿´íÎó) | -| `HttpRequestMethodNotSupportedException` | 405 (²»Ö§³ÖµÄ·½·¨) | -| `MethodArgumentNotValidException` | 400 (ÎÞЧÇëÇó) | -| `MissingServletRequestParameterException` | 400 (ÎÞЧÇëÇó) | -| `MissingServletRequestPartException` | 400 (ÎÞЧÇëÇó) | -| `NoHandlerFoundException` | 404 (ÇëÇóδÕÒµ½) | -| `NoSuchRequestHandlingMethodException` | 404 (ÇëÇóδÕÒµ½) | -| `TypeMismatchException` | 400 (ÎÞЧÇëÇó) | -| `MissingPathVariableException` | 500 (·þÎñÆ÷ÄÚ²¿´íÎó) | -| `NoHandlerFoundException` | 404 (ÇëÇóδÕÒµ½) | - -ÒÔÏ´ý·­Òë¡£ +| `BindException` | 400 (无效请求) | +| `ConversionNotSupportedException` | 500 (æœ�务器内部错误) | +| `HttpMediaTypeNotAcceptableException` | 406 (ä¸�接å�—) | +| `HttpMediaTypeNotSupportedException` | 415 (ä¸�支æŒ�的媒体类型) | +| `HttpMessageNotReadableException` | 400 (无效请求) | +| `HttpMessageNotWritableException` | 500 (æœ�务器内部错误) | +| `HttpRequestMethodNotSupportedException` | 405 (ä¸�支æŒ�的方法) | +| `MethodArgumentNotValidException` | 400 (无效请求) | +| `MissingServletRequestParameterException` | 400 (无效请求) | +| `MissingServletRequestPartException` | 400 (无效请求) | +| `NoHandlerFoundException` | 404 (请求未找到) | +| `NoSuchRequestHandlingMethodException` | 404 (请求未找到) | +| `TypeMismatchException` | 400 (无效请求) | +| `MissingPathVariableException` | 500 (æœ�务器内部错误) | +| `NoHandlerFoundException` | 404 (请求未找到) | + +以下待翻译。 The `DefaultHandlerExceptionResolver` works transparently by setting the status of the response. However, it stops short of writing any error content to the body of the response while your application may need to add developer- friendly content to every error response for example when providing a REST API. You can prepare a `ModelAndView` and render error content through view resolution?--?i.e. by configuring a `ContentNegotiatingViewResolver`, `MappingJackson2JsonView`, and so on. However, you may prefer to use`@ExceptionHandler` methods instead. @@ -124,11 +124,11 @@ If you prefer to write error content via `@ExceptionHandler` methods you can ext -# Spring MVC ʹÓÃ@ResponseStatus×¢½âÒµÎñÒì³£ +# Spring MVC 使用@ResponseStatus注解业务异常 -2020-07-31 10:52 ¸üР+2020-07-31 10:52 æ›´æ–° @@ -136,9 +136,9 @@ If you prefer to write error content via `@ExceptionHandler` methods you can ext -ÒµÎñÒì³£¿ÉÒÔʹÓÃ`@ResponseStatus`À´×¢½â¡£µ±Òì³£±»Å׳öʱ£¬`ResponseStatusExceptionResolver`»áÉèÖÃÏàÓ¦µÄÏìӦ״̬Âë¡£`DispatcherServlet`»áĬÈÏ×¢²áÒ»¸ö`ResponseStatusExceptionResolver` ÒÔ¹©Ê¹Óᣠ+业务异常å�¯ä»¥ä½¿ç”¨`@ResponseStatus`æ�¥æ³¨è§£ã€‚当异常被抛出时,`ResponseStatusExceptionResolver`会设置相应的å“�应状æ€�ç �。`DispatcherServlet`会默认注册一个`ResponseStatusExceptionResolver` 以供使用。 -ResponseStatus×¢½âµÄʹÓ÷dz£¼òµ¥£¬ÎÒÃÇ´´½¨Ò»¸öÒì³£À࣬¼ÓÉÏ×¢½â +ResponseStatus注解的使用é�žå¸¸ç®€å�•,我们创建一个异常类,加上注解 ``` package com.zj.exception; @@ -146,15 +146,15 @@ package com.zj.exception; import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ResponseStatus; -@ResponseStatus(value=HttpStatus.FORBIDDEN,reason="Óû§²»Æ¥Åä") +@ResponseStatus(value=HttpStatus.FORBIDDEN,reason="用户ä¸�匹é…�") public class UserNotMatchException extends RuntimeException{ } ``` -> ResponseStatus×¢½âÊÇÐÞÊÎÀàµÄ -> ËüÓÐÁ½¸öÊôÐÔ£¬valueÊôÐÔÊÇhttp״̬Â룬±ÈÈç404£¬500µÈ¡£reasonÊÇ´íÎóÐÅÏ¢ +> ResponseStatus注解是修饰类的 +> 它有两个属性,value属性是http状æ€�ç �,比如404,500等。reason是错误信æ�¯ -дһ¸öÄ¿±ê·½·¨Å׳ö¸ÃÒì³£ +写一个目标方法抛出该异常 ``` @RequestMapping("/testResponseStatus") @@ -165,7 +165,7 @@ public String testResponseStatus(int i){ } ``` -> ʹÓÃÁËResponseStatus×¢½âÖ®ºó£¬Óû§¿´µ½µÄÒì³£½çÃæÕýÊÇÎÒÃÇ×Ô¼º¶¨ÒåµÄÒì³££¬¶ø²»ÔÙÊÇÒ»´ó¶ÑÓû§¿´²»¶®µÄ´úÂë¡£ +> 使用了ResponseStatus注解之å�Žï¼Œç”¨æˆ·çœ‹åˆ°çš„异常界é�¢æ­£æ˜¯æˆ‘们自己定义的异常,而ä¸�å†�是一大堆用户看ä¸�懂的代ç �。 @@ -173,11 +173,11 @@ public String testResponseStatus(int i){ -# Spring MVC ¶ÔServletĬÈÏÈÝÆ÷´íÎóÒ³ÃæµÄ¶¨ÖÆ»¯ +# Spring MVC 对Servlet默认容器错误页é�¢çš„定制化 -2018-07-26 14:36 ¸üР+2018-07-26 14:36 æ›´æ–° @@ -185,7 +185,7 @@ public String testResponseStatus(int i){ -µ±ÏìÓ¦µÄ״̬Âë±»ÉèÖÃΪ´íÎó״̬Â룬²¢ÇÒÏìÓ¦ÌåÖÐûÓÐÄÚÈÝʱ£¬ServletÈÝÆ÷ͨ³£»áäÖȾһ¸öHTML´íÎóÒ³¡£ÈôÐèÒª¶¨ÖÆÈÝÆ÷ĬÈÏÌṩµÄ´íÎóÒ³£¬Äã¿ÉÒÔÔÚ`web.xml`Öж¨ÒåÒ»¸ö´íÎóÒ³Ãæ``ÔªËØ¡£ÔÚServlet 3¹æ·¶³öÀ´Ö®Ç°£¬¸Ã´íÎóÒ³ÔªËØ±ØÐë±»ÏÔʽָ¶¨Ó³Éäµ½Ò»¸ö¾ßÌåµÄ´íÎóÂë»òÒ»¸öÒì³£ÀàÐÍ¡£´ÓServlet 3¿ªÊ¼£¬´íÎóÒ³²»ÔÙÐèÒªÓ³Éäµ½ÆäËûÐÅÏ¢ÁË£¬ÕâÒâζ×Å£¬ÄãÖ¸¶¨µÄλÖþÍÊǶÔServletÈÝÆ÷ĬÈÏ´íÎóÒ³µÄ×Ô¶¨ÖÆÁË¡£ +当å“�应的状æ€�ç �被设置为错误状æ€�ç �,并且å“�应体中没有内容时,Servlet容器通常会渲染一个HTML错误页。若需è¦�定制容器默认æ��供的错误页,你å�¯ä»¥åœ¨`web.xml`中定义一个错误页é�¢``元素。在Servlet 3规范出æ�¥ä¹‹å‰�,该错误页元素必须被显å¼�指定映射到一个具体的错误ç �或一个异常类型。从Servlet 3开始,错误页ä¸�å†�需è¦�映射到其他信æ�¯äº†ï¼Œè¿™æ„�味ç�€ï¼Œä½ æŒ‡å®šçš„ä½�置就是对Servlet容器默认错误页的自定制了。
@@ -196,9 +196,9 @@ public String testResponseStatus(int i){ ``` -ÕâÀï´íÎóÒ³µÄλÖÃËùÔÚ¿ÉÒÔÊÇÒ»¸öJSPÒ³Ãæ£¬»òÕ߯äËûµÄһЩURL£¬Ö»ÒªËüÖ¸¶¨ÈÝÆ÷ÀïÈÎÒâÒ»¸ö`@Controller`¿ØÖÆÆ÷ϵĴ¦ÀíÆ÷·½·¨£º +这里错误页的ä½�置所在å�¯ä»¥æ˜¯ä¸€ä¸ªJSP页é�¢ï¼Œæˆ–者其他的一些URL,å�ªè¦�它指定容器里任æ„�一个`@Controller`控制器下的处ç�†å™¨æ–¹æ³•: -д»Ø`HttpServletResponse`µÄ´íÎóÐÅÏ¢ºÍ´íÎó״̬Âë¿ÉÒÔÔÚ¿ØÖÆÆ÷ÖÐͨ¹ýÇëÇóÊôÐÔÀ´»ñÈ¡£º +写回`HttpServletResponse`的错误信æ�¯å’Œé”™è¯¯çжæ€�ç �å�¯ä»¥åœ¨æŽ§åˆ¶å™¨ä¸­é€šè¿‡è¯·æ±‚属性æ�¥èŽ·å�–: ``` @Controller @@ -219,7 +219,7 @@ public class ErrorController { ``` -»òÕßÔÚJSPÖÐÕâôʹÓÃ: +或者在JSP中这么使用: ``` <%@ page contentType="application/json" pageEncoding="UTF-8"%> diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\346\213\246\346\210\252\345\231\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\346\213\246\346\210\252\345\231\250.md" index ba66314..d63cf55 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\346\213\246\346\210\252\345\231\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\346\213\246\346\210\252\345\231\250.md" @@ -2,11 +2,11 @@ -# Spring MVC ʹÓÃHandlerInterceptorÀ¹½ØÇëÇó +# Spring MVC 使用HandlerInterceptor拦截请求 -2018-07-26 14:07 ¸üР+2018-07-26 14:07 æ›´æ–° @@ -14,15 +14,15 @@ -SpringµÄ´¦ÀíÆ÷Ó³Éä»úÖÆ°üº¬ÁË´¦ÀíÆ÷À¹½ØÆ÷¡£À¹½ØÆ÷ÔÚÄãÐèÒªÎªÌØ¶¨ÀàÐ͵ÄÇëÇóÓ¦ÓÃһЩ¹¦ÄÜʱ¿ÉÄܺÜÓÐÓ㬱ÈÈ磬¼ì²éÓû§Éí·ÝµÈ¡£ +Spring的处ç�†å™¨æ˜ å°„机制包å�«äº†å¤„ç�†å™¨æ‹¦æˆªå™¨ã€‚拦截器在你需è¦�为特定类型的请求应用一些功能时å�¯èƒ½å¾ˆæœ‰ç”¨ï¼Œæ¯”如,检查用户身份等。
-´¦ÀíÆ÷Ó³Éä´¦Àí¹ý³ÌÅäÖõÄÀ¹½ØÆ÷£¬±ØÐëʵÏÖ `org.springframework.web.servlet`°üÏ嵀 `HandlerInterceptor`½Ó¿Ú¡£Õâ¸ö½Ó¿Ú¶¨ÒåÁËÈý¸ö·½·¨£º `preHandle(..)`£¬ËüÔÚ´¦ÀíÆ÷ʵ¼ÊÖ´ÐÐ _֮ǰ_ »á±»Ö´ÐУ» `postHandle(..)`£¬ËüÔÚ´¦ÀíÆ÷Ö´ÐÐ _Íê±Ï_ ÒÔºó±»Ö´ÐУ» `afterCompletion(..)`£¬ËüÔÚ _Õû¸öÇëÇó´¦ÀíÍê³É_ Ö®ºó±»Ö´ÐС£ÕâÈý¸ö·½·¨Îª¸÷ÖÖÀàÐ͵Äǰ´¦ÀíºÍºó´¦ÀíÐèÇóÌṩÁË×ã¹»µÄÁé»îÐÔ¡£ +处ç�†å™¨æ˜ å°„处ç�†è¿‡ç¨‹é…�置的拦截器,必须实现 `org.springframework.web.servlet`包下的 `HandlerInterceptor`接å�£ã€‚这个接å�£å®šä¹‰äº†ä¸‰ä¸ªæ–¹æ³•: `preHandle(..)`,它在处ç�†å™¨å®žé™…执行 _之å‰�_ 会被执行; `postHandle(..)`,它在处ç�†å™¨æ‰§è¡Œ _完毕_ 以å�Žè¢«æ‰§è¡Œï¼› `afterCompletion(..)`,它在 _整个请求处ç�†å®Œæˆ�_ 之å�Žè¢«æ‰§è¡Œã€‚这三个方法为å�„ç§�类型的å‰�处ç�†å’Œå�Žå¤„ç�†éœ€æ±‚æ��供了足够的ç�µæ´»æ€§ã€‚ -`preHandle(..)`·½·¨·µ»ØÒ»¸öbooleanÖµ¡£Äã¿ÉÒÔͨ¹ýÕâ¸ö·½·¨À´¾ö¶¨ÊÇ·ñ¼ÌÐøÖ´Ðд¦ÀíÁ´ÖеIJ¿¼þ¡£µ±·½·¨·µ»Ø `true`ʱ£¬´¦ÀíÆ÷Á´»á¼ÌÐøÖ´ÐУ»Èô·½·¨·µ»Ø `false`£¬ `DispatcherServlet`¼´ÈÏΪÀ¹½ØÆ÷×ÔÉíÒѾ­Íê³ÉÁ˶ÔÇëÇóµÄ´¦Àí£¨±ÈÈç˵£¬ÒѾ­äÖȾÁËÒ»¸öºÏÊʵÄÊÓͼ£©£¬ÄÇôÆäÓàµÄÀ¹½ØÆ÷ÒÔ¼°Ö´ÐÐÁ´ÖÐµÄÆäËû´¦ÀíÆ÷¾Í²»»áÔÙ±»Ö´ÐÐÁË¡£ +`preHandle(..)`方法返回一个boolean值。你å�¯ä»¥é€šè¿‡è¿™ä¸ªæ–¹æ³•æ�¥å†³å®šæ˜¯å�¦ç»§ç»­æ‰§è¡Œå¤„ç�†é“¾ä¸­çš„部件。当方法返回 `true`时,处ç�†å™¨é“¾ä¼šç»§ç»­æ‰§è¡Œï¼›è‹¥æ–¹æ³•返回 `false`, `DispatcherServlet`å�³è®¤ä¸ºæ‹¦æˆªå™¨è‡ªèº«å·²ç»�完æˆ�了对请求的处ç�†ï¼ˆæ¯”如说,已ç»�渲染了一个å�ˆé€‚的视图),那么其余的拦截器以å�Šæ‰§è¡Œé“¾ä¸­çš„其他处ç�†å™¨å°±ä¸�会å†�被执行了。 -À¹½ØÆ÷¿ÉÒÔͨ¹ý`interceptors`ÊôÐÔÀ´ÅäÖ㬸ÃÑ¡ÏîÔÚËùÓм̳ÐÁË`AbstractHandlerMapping`µÄ´¦ÀíÆ÷Ó³ÉäÀà`HandlerMapping`¶¼ÌṩÁËÅäÖõĽӿڡ£ÈçÏÂÃæ´úÂëÑùÀýËùʾ£º +拦截器å�¯ä»¥é€šè¿‡`interceptors`属性æ�¥é…�置,该选项在所有继承了`AbstractHandlerMapping`的处ç�†å™¨æ˜ å°„ç±»`HandlerMapping`都æ��供了é…�置的接å�£ã€‚如下é�¢ä»£ç �样例所示: ``` @@ -72,15 +72,15 @@ public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter { ``` -ÔÚÉÏÃæµÄÀý×ÓÖУ¬ËùÓб»´Ë´¦ÀíÆ÷´¦ÀíµÄÇëÇ󶼻ᱻ`TimeBasedAccessInterceptor`À¹½ØÆ÷À¹½Ø¡£Èç¹ûµ±Ç°Ê±¼äÔÚ¹¤×÷ʱ¼äÒÔÍ⣬ÄÇôÓû§¾Í»á±»Öض¨Ïòµ½Ò»¸öHTMLÎļþÌáʾÓû§£¬±ÈÈçÏÔʾ¡°ÄãÖ»ÓÐÔÚ¹¤×÷ʱ¼ä²Å¿ÉÒÔ·ÃÎʱ¾ÍøÕ¾¡±Ö®ÀàµÄÐÅÏ¢¡£ +在上é�¢çš„例å­�中,所有被此处ç�†å™¨å¤„ç�†çš„请求都会被`TimeBasedAccessInterceptor`拦截器拦截。如果当å‰�时间在工作时间以外,那么用户就会被é‡�定å�‘到一个HTML文件æ��示用户,比如显示“你å�ªæœ‰åœ¨å·¥ä½œæ—¶é—´æ‰�å�¯ä»¥è®¿é—®æœ¬ç½‘ç«™â€�之类的信æ�¯ã€‚ -> ʹÓÃ`RequestMappingHandlerMapping`ʱ£¬Êµ¼ÊµÄ´¦ÀíÆ÷ÊÇÒ»¸ö´¦ÀíÆ÷·½·¨`HandlerMethod`µÄʵÀý£¬Ëü±êʶÁËÒ»¸ö½«±»ÓÃÓÚ´¦Àí¸ÃÇëÇóµÄ¿ØÖÆÆ÷·½·¨¡£ +> 使用`RequestMappingHandlerMapping`时,实际的处ç�†å™¨æ˜¯ä¸€ä¸ªå¤„ç�†å™¨æ–¹æ³•`HandlerMethod`的实例,它标识了一个将被用于处ç�†è¯¥è¯·æ±‚的控制器方法。 -ÈçÄãËù¼û£¬SpringµÄÀ¹½ØÆ÷ÊÊÅäÆ÷`HandlerInterceptorAdapter`Èü̳Ð`HandlerInterceptor`½Ó¿Ú±äµÃ¸ü¼òµ¥ÁË¡£ +如你所è§�,Spring的拦截器适é…�器`HandlerInterceptorAdapter`让继承`HandlerInterceptor`接å�£å�˜å¾—更简å�•了。 -> ÉÏÃæµÄÀý×ÓÖУ¬ËùÓпØÖÆÆ÷·½·¨´¦ÀíµÄÇëÇ󶼻ᱻÅäÖõÄÀ¹½ØÆ÷ÏÈÀ¹½Øµ½¡£Èç¹ûÄãÏë½øÒ»²½ËõСÀ¹½ØµÄURL·¶Î§£¬Äã¿ÉÒÔͨ¹ýMVCÃüÃû¿Õ¼ä»òMVC Java±à³ÌµÄ·½Ê½À´ÅäÖ㬻òÕߣ¬ÉùÃ÷Ò»¸ö`MappedInterceptor`ÀàÐ͵ÄbeanʵÀýÀ´´¦Àí¡£¾ßÌåÇë¼û [21.16.1 ÆôÓÃMVC Java±à³ÌÅäÖûòMVCÃüÃû¿Õ¼äÅäÖÃ](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-ouxg27ss.html)һС½Ú¡£ +> 上é�¢çš„例å­�中,所有控制器方法处ç�†çš„请求都会被é…�置的拦截器先拦截到。如果你想进一步缩å°�拦截的URL范围,你å�¯ä»¥é€šè¿‡MVC命å��空间或MVC Java编程的方å¼�æ�¥é…�置,或者,声明一个`MappedInterceptor`类型的bean实例æ�¥å¤„ç�†ã€‚具体请è§� [21.16.1 å�¯ç”¨MVC Java编程é…�置或MVC命å��空间é…�ç½®](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-ouxg27ss.html)一å°�节。 -ÐèҪעÒâµÄÊÇ£¬`HandlerInterceptor`µÄºóÀ¹½Ø`postHandle`·½·¨²»Ò»¶¨×ÜÊÇÊÊÓÃÓÚ×¢½âÁË`@ResponseBody`»ò`ResponseEntity`µÄ·½·¨¡£ÕâЩ³¡¾°ÖУ¬`HttpMessageConverter`»áÔÚÀ¹½ØÆ÷µÄ`postHandle`·½·¨±»µ÷֮ǰ¾Í°ÑÐÅϢд»ØÏìÓ¦ÖС£ÕâÑùÀ¹½ØÆ÷¾ÍÎÞ·¨ÔٸıäÏìÓ¦ÁË£¬±ÈÈçÒªÔö¼ÓÒ»¸öÏìӦͷ֮ÀàµÄ¡£Èç¹ûÓÐÕâÖÖÐèÇó£¬ÇëÈÃÄãµÄÓ¦ÓÃʵÏÖ`ResponseBodyAdvice`½Ó¿Ú£¬²¢½«Æä¶¨ÒåΪһ¸ö`@ControllerAdvice`bean»òÖ±½ÓÔÚ`RequestMappingHandlerMapping`ÖÐÅäÖᣠ+需è¦�注æ„�的是,`HandlerInterceptor`çš„å�Žæ‹¦æˆª`postHandle`方法ä¸�一定总是适用于注解了`@ResponseBody`或`ResponseEntity`的方法。这些场景中,`HttpMessageConverter`会在拦截器的`postHandle`方法被调之å‰�就把信æ�¯å†™å›žå“�应中。这样拦截器就无法å†�改å�˜å“�应了,比如è¦�增加一个å“�应头之类的。如果有这ç§�需求,请让你的应用实现`ResponseBodyAdvice`接å�£ï¼Œå¹¶å°†å…¶å®šä¹‰ä¸ºä¸€ä¸ª`@ControllerAdvice`bean或直接在`RequestMappingHandlerMapping`中é…�置。
diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\247\206\345\233\276\350\247\243\346\236\220\345\231\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\247\206\345\233\276\350\247\243\346\236\220\345\231\250.md" index 6537078..face1be 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\247\206\345\233\276\350\247\243\346\236\220\345\231\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\247\206\345\233\276\350\247\243\346\236\220\345\231\250.md" @@ -2,11 +2,11 @@ -# Spring MVC ʹÓÃViewResolver½Ó¿Ú½âÎöÊÓͼ +# Spring MVC 使用ViewResolver接å�£è§£æž�视图 -2018-07-26 15:39 ¸üР+2018-07-26 15:39 æ›´æ–° @@ -14,23 +14,23 @@ -ÕýÈçÔÚ[Spring MVC ¿ØÖÆÆ÷µÄʵÏÖ](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-7z6u27rb.html)Ò»½ÚÖÐËùÌÖÂ۵ģ¬Spring MVCÖÐËùÓпØÖÆÆ÷µÄ´¦ÀíÆ÷·½·¨¶¼±ØÐë·µ»ØÒ»¸öÂß¼­ÊÓͼµÄÃû×Ö£¬ÎÞÂÛÊÇÏÔʽ·µ»Ø£¨±ÈÈç·µ»ØÒ»¸ö`String`¡¢`View`»òÕß`ModelAndView`£©»¹ÊÇÒþʽ·µ»Ø£¨±ÈÈç»ùÓÚÔ¼¶¨µÄ·µ»Ø£©¡£SpringÖеÄÊÓͼÓÉÒ»¸öÊÓͼÃû±êʶ£¬²¢ÓÉÊÓͼ½âÎöÆ÷À´äÖȾ¡£SpringÓзdz£¶àÄÚÖõÄÊÓͼ½âÎöÆ÷¡£Ï±íÁгöÁ˴󲿷֣¬±íºóÒ²¸ø³öÁËһЩÀý×Ó¡£ +正如在[Spring MVC 控制器的实现](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-7z6u27rb.html)一节中所讨论的,Spring MVC中所有控制器的处ç�†å™¨æ–¹æ³•都必须返回一个逻辑视图的å��字,无论是显å¼�返回(比如返回一个`String`ã€�`View`或者`ModelAndView`)还是éš�å¼�返回(比如基于约定的返回)。Spring中的视图由一个视图å��标识,并由视图解æž�器æ�¥æ¸²æŸ“。Spring有é�žå¸¸å¤šå†…置的视图解æž�器。下表列出了大部分,表å�Žä¹Ÿç»™å‡ºäº†ä¸€äº›ä¾‹å­�。
-**±í21.3 ÊÓͼ½âÎöÆ÷** +**表21.3 视图解æž�器** -| ÊÓͼ½âÎöÆ÷ | ÃèÊö | +| 视图解æž�器 | æ��è¿° | | --- | --- | -| `AbstractCachingViewResolver` | Ò»¸ö³éÏóµÄÊÓͼ½âÎöÆ÷À࣬ÌṩÁË»º´æÊÓͼµÄ¹¦ÄÜ¡£Í¨³£ÊÓͼÔÚÄܹ»±»Ê¹ÓÃ֮ǰÐèÒª¾­¹ý×¼±¸¡£¼Ì³ÐÕâ¸ö»ùÀàµÄÊÓͼ½âÎöÆ÷¼´¿ÉÒÔ»ñµÃ»º´æÊÓͼµÄÄÜÁ¦¡£ | -| `XmlViewResolver` | ÊÓͼ½âÎöÆ÷½Ó¿Ú`ViewResolver`µÄÒ»¸öʵÏÖ£¬¸ÃÀà½ÓÊÜÒ»¸öXML¸ñʽµÄÅäÖÃÎļþ¡£¸ÃXMLÎļþ±ØÐëÓëSpring XMLµÄbean¹¤³§ÓÐÏàͬµÄDTD¡£Ä¬ÈϵÄÅäÖÃÎļþÃûÊÇ`/WEB-INF/views.xml`¡£ | -| `ResourceBundleViewResolver` | ÊÓͼ½âÎöÆ÷½Ó¿Ú`ViewResolver`µÄÒ»¸öʵÏÖ£¬²ÉÓÃbundle¸ù·¾¶ËùÖ¸¶¨µÄ`ResourceBundle`ÖеÄbean¶¨Òå×÷ΪÅäÖá£Ò»°ãbundle¶¼¶¨ÒåÔÚclasspath·¾¶ÏµÄÒ»¸öÅäÖÃÎļþÖС£Ä¬ÈϵÄÅäÖÃÎļþÃûΪ`views.properties`¡£ | -| `UrlBasedViewResolver` | `ViewResolver`½Ó¿ÚµÄÒ»¸ö¼òµ¥ÊµÏÖ¡£ËüÖ±½ÓʹÓÃURLÀ´½âÎöµ½Âß¼­ÊÓͼÃû£¬³ý´ËÖ®Íâ²»ÐèÒªÆäËûÈκÎÏÔʽµÄÓ³ÉäÉùÃ÷¡£Èç¹ûÄãµÄÂß¼­ÊÓͼÃûÓëÄãÕæÕýµÄÊÓͼ×ÊÔ´ÃûÊÇÖ±½Ó¶ÔÓ¦µÄ£¬ÄÇôÕâÖÖÖ±½Ó½âÎöµÄ·½Ê½¾ÍºÜ·½±ã£¬²»ÐèÒªÄãÔÙÖ¸¶¨¶îÍâµÄÓ³Éä¡£ | -| `InternalResourceViewResolver` | `UrlBasedViewResolver`µÄÒ»¸öºÃÓõÄ×ÓÀà¡£ËüÖ§³ÖÄÚ²¿×ÊÔ´ÊÓͼ£¨¾ßÌåÀ´Ëµ£¬ServletºÍJSP£©¡¢ÒÔ¼°ÖîÈç`JstlView`ºÍ`TilesView`µÈÀàµÄ×ÓÀà¡£You can specify the view class for all views generated by this resolver by using `setViewClass(..)`¡£¸ü¶àµÄϸ½Ú£¬Çë¼û`UrlBasedViewResolver`ÀàµÄjavaÎĵµ¡£ | -| `VelocityViewResolver` / `FreeMarkerViewResolver` | `UrlBasedViewResolver`ϵÄʵÓÃ×ÓÀ֧࣬³ÖVelocityÊÓͼ`VelocityView`£¨VelocityÄ£°å£©ºÍFreeMarkerÊÓͼ`FreeMarkerView`ÒÔ¼°ËüÃǶÔÓ¦×ÓÀà¡£ | -| `ContentNegotiatingViewResolver` | ÊÓͼ½âÎöÆ÷½Ó¿Ú`ViewResolver`µÄÒ»¸öʵÏÖ£¬Ëü»á¸ù¾ÝËùÇëÇóµÄÎļþÃû»òÇëÇóµÄ`Accept`Í·À´½âÎöÒ»¸öÊÓͼ¡£¸ü¶àϸ½ÚÇë¼û[Spring MVC ÄÚÈÝЭÉÌÊÓͼ½âÎöÆ÷](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-gal927rn.html)һС½Ú¡£ | +| `AbstractCachingViewResolver` | 一个抽象的视图解æž�器类,æ��供了缓存视图的功能。通常视图在能够被使用之å‰�需è¦�ç»�过准备。继承这个基类的视图解æž�器å�³å�¯ä»¥èŽ·å¾—ç¼“å­˜è§†å›¾çš„èƒ½åŠ›ã€‚ | +| `XmlViewResolver` | 视图解æž�器接å�£`ViewResolver`的一个实现,该类接å�—一个XMLæ ¼å¼�çš„é…�置文件。该XML文件必须与Spring XMLçš„bean工厂有相å�Œçš„DTD。默认的é…�置文件å��是`/WEB-INF/views.xml`。 | +| `ResourceBundleViewResolver` | 视图解æž�器接å�£`ViewResolver`的一个实现,采用bundle根路径所指定的`ResourceBundle`中的bean定义作为é…�置。一般bundle都定义在classpath路径下的一个é…�置文件中。默认的é…�置文件å��为`views.properties`。 | +| `UrlBasedViewResolver` | `ViewResolver`接å�£çš„一个简å�•实现。它直接使用URLæ�¥è§£æž�到逻辑视图å��,除此之外ä¸�需è¦�其他任何显å¼�的映射声明。如果你的逻辑视图å��与你真正的视图资æº�å��是直接对应的,那么这ç§�直接解æž�的方å¼�就很方便,ä¸�需è¦�ä½ å†�指定é¢�外的映射。 | +| `InternalResourceViewResolver` | `UrlBasedViewResolver`的一个好用的å­�类。它支æŒ�内部资æº�视图(具体æ�¥è¯´ï¼ŒServletå’ŒJSP)ã€�以å�Šè¯¸å¦‚`JstlView`å’Œ`TilesView`等类的å­�类。You can specify the view class for all views generated by this resolver by using `setViewClass(..)`。更多的细节,请è§�`UrlBasedViewResolver`类的java文档。 | +| `VelocityViewResolver` / `FreeMarkerViewResolver` | `UrlBasedViewResolver`下的实用å­�类,支æŒ�Velocity视图`VelocityView`(Velocity模æ�¿ï¼‰å’ŒFreeMarker视图`FreeMarkerView`以å�Šå®ƒä»¬å¯¹åº”å­�类。 | +| `ContentNegotiatingViewResolver` | 视图解æž�器接å�£`ViewResolver`的一个实现,它会根æ�®æ‰€è¯·æ±‚的文件å��或请求的`Accept`头æ�¥è§£æž�一个视图。更多细节请è§�[Spring MVC 内容å��商视图解æž�器](https://www.w3cschool.cn/spring_mvc_documentation_linesh_translation/spring_mvc_documentation_linesh_translation-gal927rn.html)一å°�节。 | -ÎÒÃÇ¿ÉÒÔ¾Ù¸öÀý×Ó£¬¼ÙÉèÕâÀïʹÓõÄÊÇJSPÊÓͼ¼¼Êõ£¬ÄÇôÎÒÃÇ¿ÉÒÔʹÓÃÒ»¸ö»ùÓÚURLµÄÊÓͼ½âÎöÆ÷`UrlBasedViewResolver`¡£Õâ¸öÊÓͼ½âÎöÆ÷»á½«URL½âÎö³ÉÒ»¸öÊÓͼÃû£¬²¢½«ÇëÇóת½»¸øÇëÇó·Ö·¢Æ÷À´½øÐÐÊÓͼäÖȾ¡£ +我们å�¯ä»¥ä¸¾ä¸ªä¾‹å­�,å�‡è®¾è¿™é‡Œä½¿ç”¨çš„æ˜¯JSP视图技术,那么我们å�¯ä»¥ä½¿ç”¨ä¸€ä¸ªåŸºäºŽURL的视图解æž�器`UrlBasedViewResolver`。这个视图解æž�器会将URLè§£æž�æˆ�一个视图å��,并将请求转交给请求分å�‘器æ�¥è¿›è¡Œè§†å›¾æ¸²æŸ“。 ``` @@ -41,9 +41,9 @@ ``` -Èô·µ»ØÒ»¸ö`test`Âß¼­ÊÓͼÃû£¬ÄÇô¸ÃÊÓͼ½âÎöÆ÷»á½«ÇëÇóת·¢µ½`RequestDispatcher`£¬ºóÕ߻ὫÇëÇ󽻸ø`/WEB-INF/jsp/test.jsp`ÊÓͼȥäÖȾ¡£ +若返回一个`test`逻辑视图å��,那么该视图解æž�器会将请求转å�‘到`RequestDispatcher`,å�Žè€…会将请求交给`/WEB-INF/jsp/test.jsp`视图去渲染。 -Èç¹ûÐèÒªÔÚÓ¦ÓÃÖÐʹÓöàÖÖ²»Í¬µÄÊÓͼ¼¼Êõ£¬Äã¿ÉÒÔʹÓÃ`ResourceBundleViewResolver`£º +如果需è¦�在应用中使用多ç§�ä¸�å�Œçš„视图技术,你å�¯ä»¥ä½¿ç”¨`ResourceBundleViewResolver`: ``` `AbstractCachingViewResolver`µÄ×ÓÀàÄܹ»»º´æÒѾ­½âÎö¹ýµÄÊÓͼʵÀý¡£¹Ø±Õ»º´æÌØÐÔÒ²ÊÇ¿ÉÒԵģ¬Ö»ÐèÒª½«`cache`ÊôÐÔÉèÖÃΪ`false`¼´¿É¡£ÁíÍ⣬Èç¹ûʵÔÚÐèÒªÔÚÔËÐÐʱˢÐÂij¸öÊÓͼ£¨±ÈÈçÐÞ¸ÄÁËVelocityÄ£°åʱ£©£¬Äã¿ÉÒÔʹÓÃ`removeFromCache(String viewName, Locale loc)`·½·¨¡£` +> `AbstractCachingViewResolver`çš„å­�类能够缓存已ç»�è§£æž�过的视图实例。关闭缓存特性也是å�¯ä»¥çš„,å�ªéœ€è¦�å°†`cache`属性设置为`false`å�³å�¯ã€‚å�¦å¤–,如果实在需è¦�在è¿�行时刷新æŸ�个视图(比如修改了Velocity模æ�¿æ—¶ï¼‰ï¼Œä½ å�¯ä»¥ä½¿ç”¨`removeFromCache(String viewName, Locale loc)`方法。`
@@ -66,11 +66,11 @@ -# Spring MVC ÊÓͼÁ´ +# Spring MVC 视图链 -2018-07-26 14:11 ¸üР+2018-07-26 14:11 æ›´æ–° @@ -78,11 +78,11 @@ -SpringÖ§³ÖͬʱʹÓöà¸öÊÓͼ½âÎöÆ÷¡£Òò´Ë£¬Äã¿ÉÒÔÅäÖÃÒ»¸ö½âÎöÆ÷Á´£¬²¢×ö¸ü¶àµÄʱÈÈ磬ÔÚÌØ¶¨Ìõ¼þϸ²Ð´Ò»¸öÊÓͼµÈ¡£Äã¿ÉÒÔͨ¹ý°Ñ¶à¸öÊÓͼ½âÎöÆ÷ÉèÖõ½Ó¦ÓÃÉÏÏÂÎÄ(application context)Öеķ½Ê½À´´®ÁªËüÃÇ¡£Èç¹ûÐèÒªÖ¸¶¨ËüÃǵĴÎÐò£¬ÄÇôÉèÖÃ`order`ÊôÐÔ¼´¿É¡£Çë¼Çס£¬orderÊôÐÔµÄÖµÔ½´ó£¬¸ÃÊÓͼ½âÎöÆ÷ÔÚÁ´ÖеÄλÖþÍÔ½¿¿ºó¡£ +Spring支æŒ�å�Œæ—¶ä½¿ç”¨å¤šä¸ªè§†å›¾è§£æž�器。因此,你å�¯ä»¥é…�置一个解æž�器链,并å�šæ›´å¤šçš„äº‹æ¯”å¦‚ï¼Œåœ¨ç‰¹å®šæ�¡ä»¶ä¸‹è¦†å†™ä¸€ä¸ªè§†å›¾ç­‰ã€‚ä½ å�¯ä»¥é€šè¿‡æŠŠå¤šä¸ªè§†å›¾è§£æž�器设置到应用上下文(application context)中的方å¼�æ�¥ä¸²è�”它们。如果需è¦�指定它们的次åº�,那么设置`order`属性å�³å�¯ã€‚请记ä½�,order属性的值越大,该视图解æž�器在链中的ä½�置就越é� å�Žã€‚
-ÔÚÏÂÃæµÄ´úÂëÀý×ÓÖУ¬ÊÓͼ½âÎöÆ÷Á´Öаüº¬ÁËÁ½¸ö½âÎöÆ÷£ºÒ»¸öÊÇ`InternalResourceViewResolver`£¬Ëü×ÜÊÇ×Ô¶¯±»·ÅÖÃÔÚ½âÎöÆ÷Á´µÄ×îºó£»ÁíÒ»¸öÊÇ`XmlViewResolver`£¬ËüÓÃÀ´Ö¸¶¨ExcelÊÓͼ¡£`InternalResourceViewResolver`²»Ö§³ÖExcelÊÓͼ¡£ +在下é�¢çš„代ç �例å­�中,视图解æž�器链中包å�«äº†ä¸¤ä¸ªè§£æž�器:一个是`InternalResourceViewResolver`,它总是自动被放置在解æž�器链的最å�Žï¼›å�¦ä¸€ä¸ªæ˜¯`XmlViewResolver`,它用æ�¥æŒ‡å®šExcel视图。`InternalResourceViewResolver`ä¸�支æŒ�Excel视图。 ``` @@ -104,9 +104,9 @@ SpringÖ§ ``` -Èç¹ûÒ»¸öÊÓͼ½âÎöÆ÷²»ÄÜ·µ»ØÒ»¸öÊÓͼ£¬ÄÇôSpring»á¼ÌÐø¼ì²éÉÏÏÂÎÄÖÐÆäËûµÄÊÓͼ½âÎöÆ÷¡£´ËʱÈç¹û´æÔÚÆäËûµÄ½âÎöÆ÷£¬Spring»á¼ÌÐøµ÷ÓÃËüÃÇ£¬Ö±µ½²úÉúÒ»¸öÊÓͼ·µ»ØÎªÖ¹¡£Èç¹û×îºóËùÓÐÊÓͼ½âÎöÆ÷¶¼²»ÄÜ·µ»ØÒ»¸öÊÓͼ£¬Spring¾ÍÅ׳öÒ»¸ö`ServletException`¡£ +如果一个视图解æž�器ä¸�能返回一个视图,那么Spring会继续检查上下文中其他的视图解æž�器。此时如果存在其他的解æž�器,Spring会继续调用它们,直到产生一个视图返回为止。如果最å�Žæ‰€æœ‰è§†å›¾è§£æž�器都ä¸�能返回一个视图,Spring就抛出一个`ServletException`。 -ÊÓͼ½âÎöÆ÷µÄ½Ó¿ÚÇå³þÉùÃ÷ÁË£¬Ò»¸öÊÓͼ½âÎöÆ÷ÊÇ_¿ÉÒÔ_·µ»ØnullÖµµÄ£¬Õâ±íʾ²»ÄÜÕÒµ½ÈκκÏÊʵÄÊÓͼ¡£²¢·ÇËùÓеÄÊÓͼ½âÎöÆ÷¶¼Õâô×ö£¬µ«ÊÇÒ²´æÔÚ²»µÃ²»Èç´ËµÄ³¡¾°£¬¼´½âÎöÆ÷ȷʵÎÞ·¨¼ì²â¶ÔÓ¦µÄÊÓͼÊÇ·ñ´æÔÚ¡£±ÈÈ磬`InternalResourceViewResolver`ÔÚÄÚ²¿Ê¹ÓÃÁË`RequestDispatcher`£¬²¢ÇÒ½øÈë·ÖÅɹý³ÌÊǼì²âÒ»¸öJSPÊÓͼÊÇ·ñ´æÔÚµÄΨһ·½·¨£¬µ«Õâ¸ö¹ý³Ì½ö¿ÉÄÜ·¢ÉúΨһһ´Î¡£Í¬ÑùµÄ`VelocityViewResolver`ºÍ²¿·ÖÆäËûµÄÊÓͼ½âÎöÆ÷Ò²´æÔÚÕâÑùµÄÇé¿ö¡£¾ßÌåµÄÇë²éÔÄij¸öÌØ¶¨µÄÊÓͼ½âÎöÆ÷µÄJavaÎĵµ£¬¿´ËüÊÇ·ñ»áreport²»´æÔÚµÄÊÓͼ¡£Òò´Ë£¬Èç¹û²»°Ñ`InternalResourceViewResolver`·ÅÖÃÔÚ½âÎöÆ÷Á´µÄ×îºó£¬½«¿ÉÄܵ¼Ö½âÎöÆ÷Á´ÎÞ·¨ÍêȫִÐУ¬ÒòΪ`InternalResourceViewResolver`_ÓÀÔ¶¶¼»á_ ·µ»ØÒ»¸öÊÓͼ¡£ +视图解æž�器的接å�£æ¸…楚声明了,一个视图解æž�器是_å�¯ä»¥_返回null值的,这表示ä¸�能找到任何å�ˆé€‚的视图。并é�žæ‰€æœ‰çš„视图解æž�器都这么å�šï¼Œä½†æ˜¯ä¹Ÿå­˜åœ¨ä¸�å¾—ä¸�如此的场景,å�³è§£æž�器确实无法检测对应的视图是å�¦å­˜åœ¨ã€‚比如,`InternalResourceViewResolver`在内部使用了`RequestDispatcher`,并且进入分派过程是检测一个JSP视图是å�¦å­˜åœ¨çš„唯一方法,但这个过程仅å�¯èƒ½å�‘生唯一一次。å�Œæ ·çš„`VelocityViewResolver`和部分其他的视图解æž�器也存在这样的情况。具体的请查阅æŸ�个特定的视图解æž�器的Java文档,看它是å�¦ä¼šreportä¸�存在的视图。因此,如果ä¸�把`InternalResourceViewResolver`放置在解æž�器链的最å�Žï¼Œå°†å�¯èƒ½å¯¼è‡´è§£æž�器链无法完全执行,因为`InternalResourceViewResolver`_永远都会_ 返回一个视图。
@@ -116,11 +116,11 @@ SpringÖ§ -# Spring MVC ÊÓÍ¼ÖØ¶¨Ïò +# Spring MVC 视图é‡�定å�‘ -2018-07-26 14:12 ¸üР+2018-07-26 14:12 æ›´æ–° @@ -128,25 +128,25 @@ SpringÖ§ -ÈçǰËùÊö£¬¿ØÖÆÆ÷ͨ³£¶¼»á·µ»ØÒ»¸öÂß¼­ÊÓͼÃû£¬È»ºóÊÓͼ½âÎöÆ÷»á°ÑËü½âÎöµ½Ò»¸ö¾ßÌåµÄÊÓͼ¼¼ÊõÉÏÈ¥äÖȾ¡£¶ÔÓÚһЩ¿ÉÒÔÓÉServlet»òJSPÒýÇæÀ´´¦ÀíµÄÊÓͼ¼¼Êõ£¬±ÈÈçJSPµÈ£¬Õâ¸ö½âÎö¹ý³Ìͨ³£ÊÇÓÉ`InternalResourceViewResolver`ºÍ`InternalResourceView`Э×÷À´Íê³ÉµÄ£¬¶øÕâͨ³£»áµ÷ÓÃServletµÄAPI`RequestDispatcher.forward(..)`·½·¨»ò`RequestDispatcher.include(..)`·½·¨£¬²¢·¢ÉúÒ»´ÎÄÚ²¿µÄת·¢£¨forward£©»òÒýÓã¨include£©¡£¶ø¶ÔÓÚÆäËûµÄÊÓͼ¼¼Êõ£¬±ÈÈçVelocity¡¢XSLTµÈ£¬ÊÓͼ±¾ÉíµÄÄÚÈÝÊÇÖ±½Ó±»Ð´»ØÏìÓ¦Á÷Öеġ£ +如å‰�所述,控制器通常都会返回一个逻辑视图å��,然å�Žè§†å›¾è§£æž�器会把它解æž�到一个具体的视图技术上去渲染。对于一些å�¯ä»¥ç”±Servlet或JSP引擎æ�¥å¤„ç�†çš„视图技术,比如JSP等,这个解æž�过程通常是由`InternalResourceViewResolver`å’Œ`InternalResourceView`å��作æ�¥å®Œæˆ�的,而这通常会调用Servletçš„API`RequestDispatcher.forward(..)`方法或`RequestDispatcher.include(..)`方法,并å�‘生一次内部的转å�‘(forward)或引用(include)。而对于其他的视图技术,比如Velocityã€�XSLT等,视图本身的内容是直接被写回å“�应æµ�中的。
-ÓÐʱ£¬ÎÒÃÇÏëÒªÔÚÊÓͼäÖȾ֮ǰ£¬ÏȰÑÒ»¸öHTTPÖØ¶¨ÏòÇëÇó·¢Ëͻؿͻ§¶Ë¡£±ÈÈ磬µ±Ò»¸ö¿ØÖÆÆ÷³É¹¦µØ½ÓÊܵ½ÁË`POST`¹ýÀ´µÄÊý¾Ý£¬¶øÏìÓ¦½ö½öÊÇίÍÐÁíÒ»¸ö¿ØÖÆÆ÷À´´¦Àí£¨±ÈÈçÒ»´Î³É¹¦µÄ±íµ¥Ìá½»£©Ê±£¬ÎÒÃÇÏ£Íû·¢ÉúÒ»´ÎÖØ¶¨Ïò¡£ÔÚÕâÖÖ³¡¾°Ï£¬Èç¹ûÖ»ÊǼòµ¥µØÊ¹ÓÃÄÚ²¿×ª·¢£¬ÄÇôÒâζ×ÅÏÂÒ»¸ö¿ØÖÆÆ÷Ò²ÄÜ¿´µ½Õâ´Î`POST`ÇëÇóЯ´øµÄÊý¾Ý£¬Õâ¿ÉÄܵ¼ÖÂһЩDZÔÚµÄÎÊÌ⣬±ÈÈç¿ÉÄÜ»áÓëÆäËûÆÚÍûµÄÊý¾Ý»ìÏý£¬µÈ¡£´ËÍ⣬ÁíÒ»ÖÖÔÚäÖȾÊÓͼǰ¶ÔÇëÇó½øÐÐÖØ¶¨ÏòµÄÐèÇóÊÇ£¬·ÀÖ¹Óû§¶à´ÎÌá½»±íµ¥µÄÊý¾Ý¡£´ËʱÈôʹÓÃÖØ¶¨Ïò£¬Ôòä¯ÀÀÆ÷»áÏÈ·¢Ë͵ÚÒ»¸ö`POST`ÇëÇó£»ÇëÇó±»´¦Àíºóä¯ÀÀÆ÷»áÊÕµ½Ò»¸öÖØ¶¨ÏòÏìÓ¦£¬È»ºóä¯ÀÀÆ÷Ö±½Ó±»Öض¨Ïòµ½Ò»¸ö²»Í¬µÄURL£¬×îºóä¯ÀÀÆ÷»áʹÓÃÖØ¶¨ÏòÏìÓ¦ÖÐЯ´øµÄURL·¢ÆðÒ»´Î`GET`ÇëÇó¡£Òò´Ë£¬´Óä¯ÀÀÆ÷µÄ½Ç¶È¿´£¬µ±Ç°Ëù¼ûµÄÒ³Ãæ²¢²»ÊÇ`POST`ÇëÇóµÄ½á¹û£¬¶øÊÇÒ»´Î`GET`ÇëÇóµÄ½á¹û¡£Õâ¾Í·ÀÖ¹ÁËÓû§ÒòˢеÈÔ­ÒòÒâÍâµØÌá½»Á˶à´ÎͬÑùµÄÊý¾Ý¡£´ËʱˢлáÖØÐÂ`GET`Ò»´Î½á¹ûÒ³£¬¶ø²»ÊǰÑͬÑùµÄ`POST`Êý¾ÝÔÙ·¢ËÍÒ»±é¡£ +有时,我们想è¦�在视图渲染之å‰�,先把一个HTTPé‡�定å�‘请求å�‘é€�回客户端。比如,当一个控制器æˆ�功地接å�—到了`POST`过æ�¥çš„æ•°æ�®ï¼Œè€Œå“�应仅仅是委托å�¦ä¸€ä¸ªæŽ§åˆ¶å™¨æ�¥å¤„ç�†ï¼ˆæ¯”如一次æˆ�功的表å�•æ��交)时,我们希望å�‘生一次é‡�定å�‘。在这ç§�场景下,如果å�ªæ˜¯ç®€å�•地使用内部转å�‘,那么æ„�味ç�€ä¸‹ä¸€ä¸ªæŽ§åˆ¶å™¨ä¹Ÿèƒ½çœ‹åˆ°è¿™æ¬¡`POST`请求æ�ºå¸¦çš„æ•°æ�®ï¼Œè¿™å�¯èƒ½å¯¼è‡´ä¸€äº›æ½œåœ¨çš„问题,比如å�¯èƒ½ä¼šä¸Žå…¶ä»–期望的数æ�®æ··æ·†ï¼Œç­‰ã€‚此外,å�¦ä¸€ç§�在渲染视图å‰�对请求进行é‡�定å�‘的需求是,防止用户多次æ��交表å�•的数æ�®ã€‚此时若使用é‡�定å�‘,则æµ�览器会先å�‘é€�第一个`POST`请求;请求被处ç�†å�Žæµ�览器会收到一个é‡�定å�‘å“�应,然å�Žæµ�览器直接被é‡�定å�‘到一个ä¸�å�Œçš„URL,最å�Žæµ�览器会使用é‡�定å�‘å“�应中æ�ºå¸¦çš„URLå�‘起一次`GET`请求。因此,从æµ�览器的角度看,当å‰�所è§�的页é�¢å¹¶ä¸�是`POST`请求的结果,而是一次`GET`请求的结果。这就防止了用户因刷新等原因æ„�外地æ��交了多次å�Œæ ·çš„æ•°æ�®ã€‚此时刷新会é‡�æ–°`GET`一次结果页,而ä¸�是把å�Œæ ·çš„`POST`æ•°æ�®å†�å�‘é€�一é��。 -## ÖØ¶¨ÏòÊÓͼ RedirectView +## é‡�定å�‘视图 RedirectView -Ç¿ÖÆÖØ¶¨ÏòµÄÒ»ÖÖ·½·¨ÊÇ£¬ÔÚ¿ØÖÆÆ÷Öд´½¨²¢·µ»ØÒ»¸öSpringÖØ¶¨ÏòÊÓͼ`RedirectView`µÄʵÀý¡£Ëü»áʹµÃ`DispatcherServlet`·ÅÆúʹÓÃÒ»°ãµÄÊÓͼ½âÎö»úÖÆ£¬ÒòΪÄãÒѾ­·µ»ØÒ»¸ö£¨Öض¨Ïò£©ÊÓͼ¸ø`DispatcherServlet`ÁË£¬ËùÒÔËü»á¹¹ÔìÒ»¸öÊÓͼÀ´Âú×ãäÖȾµÄÐèÇó¡£½ô½Ó×Å`RedirectView`»áµ÷ÓÃ`HttpServletResponse.sendRedirect()`·½·¨£¬·¢ËÍÒ»¸öHTTPÖØ¶¨ÏòÏìÓ¦¸ø¿Í»§¶Ëä¯ÀÀÆ÷¡£ +强制é‡�定å�‘的一ç§�方法是,在控制器中创建并返回一个Springé‡�定å�‘视图`RedirectView`的实例。它会使得`DispatcherServlet`放弃使用一般的视图解æž�机制,因为你已ç»�返回一个(é‡�定å�‘)视图给`DispatcherServlet`了,所以它会构造一个视图æ�¥æ»¡è¶³æ¸²æŸ“的需求。紧接ç�€`RedirectView`会调用`HttpServletResponse.sendRedirect()`方法,å�‘é€�一个HTTPé‡�定å�‘å“�应给客户端æµ�览器。 -Èç¹ûÄã¾ö¶¨·µ»Ø`RedirectView`£¬²¢ÇÒÕâ¸öÊÓͼʵÀýÊÇÓÉ¿ØÖÆÆ÷ÄÚ²¿´´½¨³öÀ´µÄ£¬ÄÇÎÒÃǸüÍÆ¼öÔÚÍⲿÅäÖÃÖØ¶¨ÏòURLÈ»ºó×¢Èëµ½¿ØÖÆÆ÷ÖÐÀ´£¬¶ø²»ÊÇдÔÚ¿ØÖÆÆ÷ÀïÃæ¡£ÕâÑùËü¾Í¿ÉÒÔÓëÊÓͼÃûÒ»ÆðÔÚÅäÖÃÎļþÖÐÅäÖ᣹ØÓÚÈçºÎʵÏÖÕâ¸ö½âñÇë²Î¿¼ [ÖØ¶¨Ïòǰ׺¡ª¡ªredirect:](http://docs.spring.io/spring-framework/docs/4.2.4.RELEASE/spring-framework-reference/html/mvc.html#mvc-redirecting-redirect-prefix)һС½Ú¡£ +如果你决定返回`RedirectView`,并且这个视图实例是由控制器内部创建出æ�¥çš„,那我们更推è��在外部é…�ç½®é‡�定å�‘URLç„¶å�Žæ³¨å…¥åˆ°æŽ§åˆ¶å™¨ä¸­æ�¥ï¼Œè€Œä¸�是写在控制器里é�¢ã€‚这样它就å�¯ä»¥ä¸Žè§†å›¾å��一起在é…�置文件中é…�置。关于如何实现这个解耦,请å�‚考 [é‡�定å�‘å‰�缀——redirect:](http://docs.spring.io/spring-framework/docs/4.2.4.RELEASE/spring-framework-reference/html/mvc.html#mvc-redirecting-redirect-prefix)一å°�节。 -## ÏòÖØ¶¨ÏòÄ¿±ê´«µÝÊý¾Ý +## å�‘é‡�定å�‘目标传递数æ�® -Ä£ÐÍÖеÄËùÓÐÊôÐÔĬÈ϶¼»á¿¼ÂÇ×÷ΪURIÄ£°å±äÁ¿±»Ìí¼Óµ½Öض¨ÏòURLÖС£Ê£ÏÂµÄÆäËûÊôÐÔ£¬Èç¹ûÊÇ»ù±¾ÀàÐÍ»òÕß»ù±¾ÀàÐ͵ļ¯ºÏ»òÊý×飬ÄÇËüÃǽ«±»×Ô¶¯Ìí¼Óµ½URLµÄ²éѯ²ÎÊýÖÐÈ¥¡£Èç¹ûmodelÊÇרÃÅΪ¸ÃÖØ¶¨ÏòËù×¼±¸µÄ£¬ÄÇô°ÑËùÓлù±¾ÀàÐ͵ÄÊôÐÔÌí¼Óµ½²éѯ²ÎÊýÖпÉÄÜÊÇÎÒÃÇÆÚÍûÄǸöµÄ½á¹û¡£µ«ÊÇ£¬ÔÚ°üº¬×¢½âµÄ¿ØÖÆÆ÷ÖУ¬model¿ÉÄܰüº¬ÁËרÃÅ×÷ΪäÖȾÓÃ;µÄÊôÐÔ£¨±ÈÈçÒ»¸öÏÂÀ­ÁбíµÄ×Ö¶ÎÖµµÈ£©¡£ÎªÁ˱ÜÃâ°ÑÕâÑùµÄÊôÐÔÒ²±©Â¶ÔÚURLÖУ¬`@RequestMapping`·½·¨¿ÉÒÔÉùÃ÷Ò»¸ö`RedirectAttributes`ÀàÐ͵ķ½·¨²ÎÊý£¬ÓÃËüÀ´Ö¸¶¨×¨ÃŹ©Öض¨ÏòÊÓͼ`RedirectView`È¡ÓõÄÊôÐÔ¡£Èç¹ûÖØ¶¨Ïò³É¹¦·¢Éú£¬ÄÇô`RedirectAttributes`¶ÔÏóÖеÄÄÚÈݾͻᱻʹÓã»·ñÔòÔòʹÓÃÄ£ÐÍmodelÖеÄÊý¾Ý¡£ +模型中的所有属性默认都会考虑作为URI模æ�¿å�˜é‡�被添加到é‡�定å�‘URL中。剩下的其他属性,如果是基本类型或者基本类型的集å�ˆæˆ–数组,那它们将被自动添加到URL的查询å�‚数中去。如果model是专门为该é‡�定å�‘所准备的,那么把所有基本类型的属性添加到查询å�‚数中å�¯èƒ½æ˜¯æˆ‘们期望那个的结果。但是,在包å�«æ³¨è§£çš„æŽ§åˆ¶å™¨ä¸­ï¼Œmodelå�¯èƒ½åŒ…å�«äº†ä¸“门作为渲染用途的属性(比如一个下拉列表的字段值等)。为了é�¿å…�把这样的属性也暴露在URL中,`@RequestMapping`方法å�¯ä»¥å£°æ˜Žä¸€ä¸ª`RedirectAttributes`类型的方法å�‚数,用它æ�¥æŒ‡å®šä¸“门供é‡�定å�‘视图`RedirectView`å�–用的属性。如果é‡�定å�‘æˆ�功å�‘生,那么`RedirectAttributes`对象中的内容就会被使用;å�¦åˆ™åˆ™ä½¿ç”¨æ¨¡åž‹model中的数æ�®ã€‚ -`RequestMappingHandlerAdapter`ÌṩÁËÒ»¸ö`"ignoreDefaultModelOnRedirect"`±êÖ¾¡£Ëü±»ÓÃÀ´±ê¼ÇĬÈÏ`Model`ÖеÄÊôÐÔÓÀÔ¶²»Ó¦¸Ã±»ÓÃÓÚ¿ØÖÆÆ÷·½·¨µÄÖØ¶¨ÏòÖС£¿ØÖÆÆ÷·½·¨Ó¦¸ÃÉùÃ÷Ò»¸ö`RedirectAttributes`ÀàµÄ²ÎÊý¡£Èç¹û²»ÉùÃ÷£¬ÄǾÍûÓвÎÊý±»´«µÝµ½Öض¨ÏòµÄÊÓͼ`RedirectView`ÖС£ÔÚMVCÃüÃû¿Õ¼ä»òMVC Java±à³ÌÅäÖ÷½Ê½ÖУ¬ÎªÁËά³ÖÏòºóµÄ¼æÈÝÐÔ£¬Õâ¸ö±êÖ¾¶¼ÈÔ±»±£³ÖΪ`false`¡£µ«Èç¹ûÄãµÄÓ¦ÓÃÊÇÒ»¸öеÄÏîÄ¿£¬ÄÇôÎÒÃÇÍÆ¼ö°ÑËüµÄÖµÉèÖóÉ`true`¡£ +`RequestMappingHandlerAdapter`æ��供了一个`"ignoreDefaultModelOnRedirect"`标志。它被用æ�¥æ ‡è®°é»˜è®¤`Model`中的属性永远ä¸�应该被用于控制器方法的é‡�定å�‘中。控制器方法应该声明一个`RedirectAttributes`类的å�‚数。如果ä¸�声明,那就没有å�‚数被传递到é‡�定å�‘的视图`RedirectView`中。在MVC命å��空间或MVC Java编程é…�置方å¼�中,为了维æŒ�å�‘å�Žçš„兼容性,这个标志都ä»�被ä¿�æŒ�为`false`。但如果你的应用是一个新的项目,那么我们推è��把它的值设置æˆ�`true`。 -Çë×¢Ò⣬µ±Ç°ÇëÇóURIÖеÄÄ£°å±äÁ¿»áÔÚÌî³äÖØ¶¨ÏòURLµÄʱºò×Ô¶¯¶ÔÓ¦Óÿɼû£¬¶ø²»ÐèÒªÏÔʽµØÔÚ`Model`»ò`RedirectAttributes`ÖÐÔÙÌí¼ÓÊôÐÔ¡£Çë¿´ÏÂÃæµÄÀý×Ó£º +请注æ„�,当å‰�请求URI中的模æ�¿å�˜é‡�会在填充é‡�定å�‘URL的时候自动对应用å�¯è§�,而ä¸�需è¦�显å¼�地在`Model`或`RedirectAttributes`中å†�添加属性。请看下é�¢çš„例å­�: ``` @RequestMapping(path = "/files/{path}", method = RequestMethod.POST) @@ -157,23 +157,23 @@ public String upload(...) { ``` -ÁíÍâÒ»ÖÖÏòÖØ¶¨ÏòÄ¿±ê´«µÝÊý¾ÝµÄ·½·¨ÊÇͨ¹ý _ÉÁ´æÊôÐÔ£¨Flash Attributes£©_¡£ÓëÆäËûÖØ¶¨ÏòÊôÐÔ²»Í¬£¬flashÊôÐÔÊÇ´æ´¢ÔÚHTTP sessionÖеģ¨Òò´Ë²»»á³öÏÖÔÚURLÖУ©¡£¸ü¶àÄÚÈÝ£¬Çë²Î¿¼ [21.6 ʹÓÃÉÁ´æÊôÐÔ](http://docs.spring.io/spring-framework/docs/4.2.4.RELEASE/spring-framework-reference/html/mvc.html#mvc-flash-attributes)Ò»½Ú¡£ +å�¦å¤–一ç§�å�‘é‡�定å�‘目标传递数æ�®çš„æ–¹æ³•是通过 _闪存属性(Flash Attributes)_。与其他é‡�定å�‘属性ä¸�å�Œï¼Œflash属性是存储在HTTP session中的(因此ä¸�会出现在URL中)。更多内容,请å�‚考 [21.6 使用闪存属性](http://docs.spring.io/spring-framework/docs/4.2.4.RELEASE/spring-framework-reference/html/mvc.html#mvc-flash-attributes)一节。 -## ÖØ¶¨Ïòǰ׺¡ª¡ªredirect: +## é‡�定å�‘å‰�缀——redirect: -¾¡¹ÜʹÓÃ`RedirectView`À´×öÖØ¶¨ÏòÄܹ¤×÷µÃºÜºÃ£¬µ«Èç¹û¿ØÖÆÆ÷×ÔÉí»¹ÊÇÐèÒª´´½¨Ò»¸ö`RedirectView`£¬ÄÇÎÞÒÉ¿ØÖÆÆ÷»¹ÊÇÁ˽âÖØ¶¨ÏòÕâôһ¼þÊÂÇéµÄ·¢Éú¡£Õ⻹ÊÇÓе㲻¾¡ÍêÃÀ£¬²»Í¬·¶³ëµÄñîºÏ»¹ÊÇ̫ǿ¡£¿ØÖÆÆ÷Æäʵ²»Ó¦¸ÃÈ¥¹ØÐÄÏìÓ¦»áÈçºÎ±»äÖȾ¡£In general it should operate only in terms of view names that have been injected into it. +尽管使用`RedirectView`æ�¥å�šé‡�定å�‘能工作得很好,但如果控制器自身还是需è¦�创建一个`RedirectView`,那无疑控制器还是了解é‡�定å�‘这么一件事情的å�‘生。这还是有点ä¸�尽完美,ä¸�å�ŒèŒƒç•´çš„耦å�ˆè¿˜æ˜¯å¤ªå¼ºã€‚控制器其实ä¸�应该去关心å“�应会如何被渲染。In general it should operate only in terms of view names that have been injected into it. -Ò»¸öÌØ±ðµÄÊÓͼÃûǰ׺ÄÜÍê³ÉÕâ¸ö½âñ`redirect:`¡£Èç¹û·µ»ØµÄÊÓͼÃûÖк¬ÓÐ`redirect:`ǰ׺£¬ÄÇô`UrlBasedViewResolver`£¨¼°ËüµÄËùÓÐ×ÓÀࣩ¾Í»á½ÓÊܵ½Õâ¸öÐźţ¬Òâʶµ½ÕâÀïÐèÒª·¢ÉúÖØ¶¨Ïò¡£È»ºóÊÓͼÃûʣϵIJ¿·Ö»á±»½âÎö³ÉÖØ¶¨ÏòURL¡£ +一个特别的视图å��å‰�缀能完æˆ�这个解耦:`redirect:`。如果返回的视图å��中å�«æœ‰`redirect:`å‰�缀,那么`UrlBasedViewResolver`(å�Šå®ƒçš„æ‰€æœ‰å­�类)就会接å�—到这个信å�·ï¼Œæ„�识到这里需è¦�å�‘生é‡�定å�‘。然å�Žè§†å›¾å��剩下的部分会被解æž�æˆ�é‡�定å�‘URL。 -ÕâÖÖ·½Ê½Óëͨ¹ý¿ØÖÆÆ÷·µ»ØÒ»¸öÖØ¶¨ÏòÊÓͼ`RedirectView`Ëù´ïµ½µÄЧ¹ûÊÇÒ»ÑùµÄ£¬²»¹ýÕâÑùÒ»À´¿ØÖÆÆ÷¾Í¿ÉÒÔֻרעÓÚ´¦Àí²¢·µ»ØÂß¼­ÊÓͼÃûÁË¡£Èç¹ûÂß¼­ÊÓͼÃûÊÇÕâÑùµÄÐÎʽ£º`redirect:/myapp/some/resource`£¬ËûÃÇÖØ¶¨Ïò·¾¶½«ÒÔServletÉÏÏÂÎÄ×÷ΪÏà¶Ô·¾¶½øÐвéÕÒ£¬¶øÂß¼­ÊÓͼÃûÈç¹ûÊÇÕâÑùµÄÐÎʽ£º`redirect:http://myhost.com/some/arbitrary/path`£¬ÄÇÃ´ÖØ¶¨ÏòURLʹÓõľÍÊǾø¶Ô·¾¶¡£ +è¿™ç§�æ–¹å¼�与通过控制器返回一个é‡�定å�‘视图`RedirectView`所达到的效果是一样的,ä¸�过这样一æ�¥æŽ§åˆ¶å™¨å°±å�¯ä»¥å�ªä¸“注于处ç�†å¹¶è¿”回逻辑视图å��了。如果逻辑视图å��是这样的形å¼�:`redirect:/myapp/some/resource`,他们é‡�定å�‘路径将以Servlet上下文作为相对路径进行查找,而逻辑视图å��如果是这样的形å¼�:`redirect:http://myhost.com/some/arbitrary/path`,那么é‡�定å�‘URL使用的就是ç»�对路径。 -×¢ÒâµÄÊÇ£¬Èç¹û¿ØÖÆÆ÷·½·¨×¢½âÁË`@ResponseStatus`£¬ÄÇôע½âÉèÖõÄ״̬ÂëÖµ»á¸²¸Ç`RedirectView`ÉèÖõÄÏìӦ״̬ÂëÖµ¡£ +注æ„�的是,如果控制器方法注解了`@ResponseStatus`,那么注解设置的状æ€�ç �值会覆盖`RedirectView`设置的å“�应状æ€�ç �值。 -## ÖØ¶¨Ïòǰ׺¡ª¡ªforward: +## é‡�定å�‘å‰�缀——forward: -¶ÔÓÚ×îÖջᱻ`UrlBasedViewResolver`»òÆä×ÓÀà½âÎöµÄÊÓͼÃû£¬Äã¿ÉÒÔʹÓÃÒ»¸öÌØÊâµÄǰ׺£º`forward:`¡£Õâ»áµ¼ÖÂÒ»¸ö`InternalResourceView`ÊÓͼ¶ÔÏóµÄ´´½¨£¨Ëü×îÖÕ»áµ÷ÓÃ`RequestDispatcher.forward()`·½·¨£©£¬ºóÕß»áÈÏΪÊÓͼÃûʣϵIJ¿·ÖÊÇÒ»¸öURL¡£Òò´Ë£¬Õâ¸öǰ׺ÔÚʹÓÃ`InternalResourceViewResolver`ºÍ`InternalResourceView`ʱ²¢Ã»ÓÐÌØ±ðµÄ×÷Ó㨱ÈÈç¶ÔÓÚJSPÀ´Ëµ£©¡£µ«µ±ÄãÖ÷ҪʹÓõÄÊÇÆäËûµÄÊÓͼ¼¼Êõ£¬¶øÓÖÏëÒªÇ¿ÖÆ°ÑÒ»¸ö×ÊԴת·¢¸øServlet/JSPÒýÇæ½øÐд¦Àíʱ£¬Õâ¸öǰ׺¿ÉÄܾͺÜÓÐÓ㨻òÕߣ¬ÄãÒ²¿ÉÄÜͬʱ´®Áª¶à¸öÊÓͼ½âÎöÆ÷£©¡£ +对于最终会被`UrlBasedViewResolver`或其å­�类解æž�的视图å��,你å�¯ä»¥ä½¿ç”¨ä¸€ä¸ªç‰¹æ®Šçš„å‰�缀:`forward:`。这会导致一个`InternalResourceView`视图对象的创建(它最终会调用`RequestDispatcher.forward()`方法),å�Žè€…会认为视图å��剩下的部分是一个URL。因此,这个å‰�缀在使用`InternalResourceViewResolver`å’Œ`InternalResourceView`时并没有特别的作用(比如对于JSPæ�¥è¯´ï¼‰ã€‚但当你主è¦�使用的是其他的视图技术,而å�ˆæƒ³è¦�强制把一个资æº�转å�‘ç»™Servlet/JSP引擎进行处ç�†æ—¶ï¼Œè¿™ä¸ªå‰�ç¼€å�¯èƒ½å°±å¾ˆæœ‰ç”¨ï¼ˆæˆ–者,你也å�¯èƒ½å�Œæ—¶ä¸²è�”多个视图解æž�器)。 -Óë`redirect:`ǰ׺һÑù£¬Èç¹û¿ØÖÆÆ÷ÖеÄÊÓͼÃûʹÓÃÁË`forward:`ǰ׺£¬¿ØÖÆÆ÷±¾Éí²¢²»»á·¢¾õÈκÎÒì³££¬Ëü¹Ø×¢µÄÈÔȻֻÊÇÈçºÎ´¦ÀíÏìÓ¦µÄÎÊÌâ¡£ +与`redirect:`å‰�缀一样,如果控制器中的视图å��使用了`forward:`å‰�缀,控制器本身并ä¸�会å�‘觉任何异常,它关注的ä»�ç„¶å�ªæ˜¯å¦‚何处ç�†å“�应的问题。
diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\277\207\346\273\244\345\231\250Filter.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\277\207\346\273\244\345\231\250Filter.md" index 440f4d4..3c8a737 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\277\207\346\273\244\345\231\250Filter.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\344\270\255\347\232\204\350\277\207\346\273\244\345\231\250Filter.md" @@ -1,12 +1,12 @@ -¼¯³ÉFilter +集æˆ�Filter -ÔÚSpring MVCÖУ¬DispatcherServletÖ»ÐèÒª¹Ì¶¨ÅäÖõ½web.xmlÖУ¬Ê£ÏµĹ¤×÷Ö÷ÒªÊÇרעÓÚ±àдController¡£ +在Spring MVC中,DispatcherServletå�ªéœ€è¦�固定é…�置到web.xml中,剩下的工作主è¦�是专注于编写Controller。 -µ«ÊÇ£¬ÔÚServlet¹æ·¶ÖУ¬ÎÒÃÇ»¹¿ÉÒÔʹÓÃFilter¡£Èç¹ûÒªÔÚSpring MVCÖÐʹÓÃFilter£¬Ó¦¸ÃÔõô×ö£¿ +但是,在Servlet规范中,我们还å�¯ä»¥ä½¿ç”¨Filter。如果è¦�在Spring MVC中使用Filter,应该怎么å�šï¼Ÿ -ÓеÄͯЬÔÚÉÏÒ»½ÚµÄWebÓ¦ÓÃÖпÉÄÜ·¢ÏÖÁË£¬Èç¹û×¢²áʱÊäÈëÖÐÎĻᵼÖÂÂÒÂ룬ÒòΪServletĬÈϰ´·ÇUTF-8±àÂë¶ÁÈ¡²ÎÊý¡£ÎªÁËÐÞ¸´ÕâÒ»ÎÊÌ⣬ÎÒÃÇ¿ÉÒÔ¼òµ¥µØÊ¹ÓÃÒ»¸öEncodingFilter£¬ÔÚÈ«¾Ö·¶Î§Àà¸øHttpServletRequestºÍHttpServletResponseÇ¿ÖÆÉèÖÃΪUTF-8±àÂë¡£ +有的童鞋在上一节的Web应用中å�¯èƒ½å�‘现了,如果注册时输入中文会导致乱ç �,因为Servlet默认按é�žUTF-8ç¼–ç �读å�–å�‚数。为了修å¤�这一问题,我们å�¯ä»¥ç®€å�•地使用一个EncodingFilter,在全局范围类给HttpServletRequestå’ŒHttpServletResponse强制设置为UTF-8ç¼–ç �。 -¿ÉÒÔ×Ô¼º±àдһ¸öEncodingFilter£¬Ò²¿ÉÒÔÖ±½ÓʹÓÃSpring MVC×Ô´øµÄÒ»¸öCharacterEncodingFilter¡£ÅäÖÃFilterʱ£¬Ö»ÐèÔÚweb.xmlÖÐÉùÃ÷¼´¿É£º +å�¯ä»¥è‡ªå·±ç¼–写一个EncodingFilter,也å�¯ä»¥ç›´æŽ¥ä½¿ç”¨Spring MVC自带的一个CharacterEncodingFilter。é…�ç½®Filter时,å�ªéœ€åœ¨web.xml中声明å�³å�¯ï¼š ```` @@ -29,11 +29,11 @@ ... ```` -ÒòΪÕâÖÖFilterºÍÎÒÃÇÒµÎñ¹ØÏµ²»´ó£¬×¢Òâµ½CharacterEncodingFilterÆäʵºÍSpringµÄIoCÈÝÆ÷ûÓÐÈκιØÏµ£¬Á½Õß¾ù»¥²»ÖªÏþ¶Ô·½µÄ´æÔÚ£¬Òò´Ë£¬ÅäÖÃÕâÖÖFilterÊ®·Ö¼òµ¥¡£ +因为这ç§�Filter和我们业务关系ä¸�大,注æ„�到CharacterEncodingFilter其实和Springçš„IoC容器没有任何关系,两者å�‡äº’ä¸�知晓对方的存在,因此,é…�置这ç§�Filterå��分简å�•。 -ÎÒÃÇÔÙ¿¼ÂÇÕâÑùÒ»¸öÎÊÌ⣺Èç¹ûÔÊÐíÓû§Ê¹ÓÃBasicģʽ½øÐÐÓû§ÑéÖ¤£¬¼´ÔÚHTTPÇëÇóÖÐÌí¼ÓÍ·Authorization: Basic email:password£¬Õâ¸öÐèÇóÈçºÎʵÏÖ£¿ +我们å†�考虑这样一个问题:如果å…�许用户使用Basic模å¼�进行用户验è¯�,å�³åœ¨HTTP请求中添加头Authorization: Basic email:password,这个需求如何实现? -±àдһ¸öAuthFilterÊÇ×î¼òµ¥µÄʵÏÖ·½Ê½£º +编写一个AuthFilter是最简å�•的实现方å¼�: ```` @Component public class AuthFilter implements Filter { @@ -43,27 +43,27 @@ UserService userService; public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletRequest req = (HttpServletRequest) request; - // »ñÈ¡AuthorizationÍ·: + // 获å�–Authorization头: String authHeader = req.getHeader("Authorization"); if (authHeader != null && authHeader.startsWith("Basic ")) { - // ´ÓHeaderÖÐÌáÈ¡emailºÍpassword: + // 从Header中æ��å�–emailå’Œpassword: String email = prefixFrom(authHeader); String password = suffixFrom(authHeader); - // µÇ¼: + // 登录: User user = userService.signin(email, password); - // ·ÅÈëSession: + // 放入Session: req.getSession().setAttribute(UserController.KEY_USER, user); } - // ¼ÌÐø´¦ÀíÇëÇó: + // 继续处ç�†è¯·æ±‚: chain.doFilter(request, response); } } ```` -ÏÖÔÚÎÊÌâÀ´ÁË£ºÔÚSpringÖд´½¨µÄÕâ¸öAuthFilterÊÇÒ»¸öÆÕͨBean£¬ServletÈÝÆ÷²¢²»ÖªµÀ£¬ËùÒÔËü²»»áÆð×÷Óᣠ+现在问题æ�¥äº†ï¼šåœ¨Spring中创建的这个AuthFilter是一个普通Bean,Servlet容器并ä¸�知é�“,所以它ä¸�会起作用。 -Èç¹ûÎÒÃÇÖ±½ÓÔÚweb.xmlÖÐÉùÃ÷Õâ¸öAuthFilter£¬×¢Òâµ½AuthFilterµÄʵÀý½«ÓÉServletÈÝÆ÷¶ø²»ÊÇSpringÈÝÆ÷³õʼ»¯£¬Òò´Ë£¬@Autowire¸ù±¾²»ÉúЧ£¬ÓÃÓڵǼµÄUserService³ÉÔ±±äÁ¿ÓÀÔ¶ÊÇnull¡£ +如果我们直接在web.xml中声明这个AuthFilter,注æ„�到AuthFilter的实例将由Servlet容器而ä¸�是Spring容器åˆ�始化,因此,@Autowire根本ä¸�生效,用于登录的UserServiceæˆ�员å�˜é‡�永远是null。 -ËùÒÔ£¬µÃͨ¹ýÒ»ÖÖ·½Ê½£¬ÈÃServletÈÝÆ÷ʵÀý»¯µÄFilter£¬¼ä½ÓÒýÓÃSpringÈÝÆ÷ʵÀý»¯µÄAuthFilter¡£Spring MVCÌṩÁËÒ»¸öDelegatingFilterProxy£¬×¨ÃÅÀ´¸ÉÕâ¸öÊÂÇ飺 +所以,得通过一ç§�æ–¹å¼�,让Servlet容器实例化的Filter,间接引用Spring容器实例化的AuthFilter。Spring MVCæ��供了一个DelegatingFilterProxy,专门æ�¥å¹²è¿™ä¸ªäº‹æƒ…: ```` @@ -78,13 +78,13 @@ UserService userService; ... ```` -ÎÒÃÇÀ´¿´ÊµÏÖÔ­Àí£º +我们æ�¥çœ‹å®žçŽ°åŽŸç�†ï¼š -ServletÈÝÆ÷´Óweb.xmlÖжÁÈ¡ÅäÖã¬ÊµÀý»¯DelegatingFilterProxy£¬×¢ÒâÃüÃûÊÇauthFilter£» -SpringÈÝÆ÷ͨ¹ýɨÃè@ComponentʵÀý»¯AuthFilter¡£ -µ±DelegatingFilterProxyÉúЧºó£¬Ëü»á×Ô¶¯²éÕÒ×¢²áÔÚServletContextÉϵÄSpringÈÝÆ÷£¬ÔÙÊÔͼ´ÓÈÝÆ÷ÖвéÕÒÃûΪauthFilterµÄBean£¬Ò²¾ÍÊÇÎÒÃÇÓÃ@ComponentÉùÃ÷µÄAuthFilter¡£ +Servlet容器从web.xml中读å�–é…�置,实例化DelegatingFilterProxy,注æ„�命å��是authFilterï¼› +Spring容器通过扫æ��@Component实例化AuthFilter。 +当DelegatingFilterProxy生效å�Žï¼Œå®ƒä¼šè‡ªåŠ¨æŸ¥æ‰¾æ³¨å†Œåœ¨ServletContext上的Spring容器,å†�试图从容器中查找å��为authFilterçš„Bean,也就是我们用@Component声明的AuthFilter。 -DelegatingFilterProxy½«ÇëÇó´úÀí¸øAuthFilter£¬ºËÐÄ´úÂëÈçÏ£º +DelegatingFilterProxy将请求代ç�†ç»™AuthFilter,核心代ç �如下: ```` public class DelegatingFilterProxy implements Filter { private Filter delegate; @@ -96,40 +96,40 @@ public class DelegatingFilterProxy implements Filter { } } ```` -Õâ¾ÍÊÇÒ»¸ö´úÀíģʽµÄ¼òµ¥Ó¦Óá£ÎÒÃÇ»­¸öͼ±íʾËüÃÇÖ®¼äµÄÒýÓùØÏµÈçÏ£º +这就是一个代ç�†æ¨¡å¼�的简å�•应用。我们画个图表示它们之间的引用关系如下: ```` -©° ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©´ ©° ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ -©°©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©´ ©°©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©´ ©¦ -©¦ ©¦DelegatingFilterProxy©¦©¤©¦©¤©¦©¤ ©¤>©¦AuthFilter ©¦ -©¸©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¼ ©¸©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¼ ©¦ -©¦ ©°©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©´ ©¦ ©¦ ©°©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©´ -©¦ DispatcherServlet ©¦©¤ ©¤ ©¤ ©¤>©¦Controllers©¦ ©¦ -©¦ ©¸©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¼ ©¦ ©¦ ©¸©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¤©¼ -©¦ -©¦ Servlet Container ©¦ ©¦ Spring Container -©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¤ ©¼ +┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ â”� ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ +┌─────────────────────â”� ┌───────────â”� │ +│ │DelegatingFilterProxy│─│─│─ ─>│AuthFilter │ +└─────────────────────┘ └───────────┘ │ +│ ┌─────────────────────â”� │ │ ┌───────────â”� +│ DispatcherServlet │─ ─ ─ ─>│Controllers│ │ +│ └─────────────────────┘ │ │ └───────────┘ +│ +│ Servlet Container │ │ Spring Container +─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ ```` -Èç¹ûÔÚweb.xmlÖÐÅäÖõÄFilterÃû×ÖºÍSpringÈÝÆ÷µÄBeanµÄÃû×Ö²»Ò»Ö£¬ÄÇôÐèÒªÖ¸¶¨BeanµÄÃû×Ö£º +如果在web.xml中é…�置的Filterå��å­—å’ŒSpring容器的Beançš„å��å­—ä¸�一致,那么需è¦�指定Beançš„å��字: ```` basicAuthFilter org.springframework.web.filter.DelegatingFilterProxy - + targetBeanName authFilter ```` -ʵ¼ÊÓ¦ÓÃʱ£¬¾¡Á¿±£³ÖÃû×ÖÒ»Ö£¬ÒÔ¼õÉÙ²»±ØÒªµÄÅäÖᣠ+实际应用时,尽é‡�ä¿�æŒ�å��字一致,以å‡�å°‘ä¸�å¿…è¦�çš„é…�置。 -ҪʹÓÃBasicģʽµÄÓû§ÈÏÖ¤£¬ÎÒÃÇ¿ÉÒÔʹÓÃcurlÃüÁî²âÊÔ¡£ÀýÈ磬Óû§µÇ¼ÃûÊÇtom@example.com£¬¿ÚÁîÊÇtomcat£¬ÄÇôÏȹ¹ÔìÒ»¸öʹÓÃURL±àÂëµÄÓû§Ãû:¿ÚÁîµÄ×Ö·û´®£º +è¦�使用Basic模å¼�的用户认è¯�,我们å�¯ä»¥ä½¿ç”¨curl命令测试。例如,用户登录å��是tom@example.com,å�£ä»¤æ˜¯tomcat,那么先构造一个使用URLç¼–ç �的用户å��:å�£ä»¤çš„字符串: tom%40example.com:tomcat -¶ÔÆä½øÐÐBase64±àÂ룬×îÖÕ¹¹Ôì³öµÄHeaderÈçÏ£º +对其进行Base64ç¼–ç �,最终构造出的Header如下: Authorization: Basic dG9tJTQwZXhhbXBsZS5jb206dG9tY2F0 -ʹÓÃÈçϵÄcurlÃüÁî²¢»ñµÃÏìÓ¦ÈçÏ£º +使用如下的curl命令并获得å“�应如下: ```` $ curl -v -H 'Authorization: Basic dG9tJTQwZXhhbXBsZS5jb206dG9tY2F0' http://localhost:8080/profile > GET /profile HTTP/1.1 @@ -147,5 +147,5 @@ $ curl -v -H 'Authorization: Basic dG9tJTQwZXhhbXBsZS5jb206dG9tY2F0' http://loca < ```` -...HTMLÊä³ö... -ÉÏÊöÏìӦ˵Ã÷AuthFilterÒÑÉúЧ¡£ \ No newline at end of file +...HTML输出... +上述å“�应说明AuthFilter已生效。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\237\272\346\234\254\344\273\213\347\273\215\344\270\216\345\277\253\351\200\237\345\205\245\351\227\250.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\237\272\346\234\254\344\273\213\347\273\215\344\270\216\345\277\253\351\200\237\345\205\245\351\227\250.md" index 21a9ea3..2e7f567 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\237\272\346\234\254\344\273\213\347\273\215\344\270\216\345\277\253\351\200\237\345\205\245\351\227\250.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\237\272\346\234\254\344\273\213\347\273\215\344\270\216\345\277\253\351\200\237\345\205\245\351\227\250.md" @@ -2,9 +2,9 @@ -## MVC Éè¼Æ¸ÅÊö +## MVC 设计概述 -ÔÚÔçÆÚ Java Web µÄ¿ª·¢ÖУ¬Í³Ò»°ÑÏÔʾ²ã¡¢¿ØÖƲ㡢Êý¾Ý²ãµÄ²Ù×÷È«²¿½»¸ø JSP »òÕß JavaBean À´½øÐд¦Àí£¬ÎÒÃdzÆÖ®Îª **Model1£º** +在早期 Java Web 的开å�‘中,统一把显示层ã€�控制层ã€�æ•°æ�®å±‚çš„æ“�作全部交给 JSP 或者 JavaBean æ�¥è¿›è¡Œå¤„ç�†ï¼Œæˆ‘们称之为 **Model1:** @@ -16,13 +16,13 @@ -* **³öÏֵı׶ˣº** -* JSP ºÍ Java Bean Ö®¼äÑÏÖØñîºÏ£¬Java ´úÂëºÍ HTML ´úÂëÒ²ñîºÏÔÚÁËÒ»Æð -* ÒªÇ󿪷¢Õß²»½öÒªÕÆÎÕ Java £¬»¹ÒªÓи߳¬µÄǰ¶Ëˮƽ -* ǰ¶ËºÍºó¶ËÏ໥ÒÀÀµ£¬Ç°¶ËÐèÒªµÈ´ýºó¶ËÍê³É£¬ºó¶ËÒ²ÒÀÀµÇ°¶ËÍê³É£¬²ÅÄܽøÐÐÓÐЧµÄ²âÊÔ -* ´úÂëÄÑÒÔ¸´Óà +* **出现的弊端:** +* JSP å’Œ Java Bean 之间严é‡�耦å�ˆï¼ŒJava 代ç �å’Œ HTML 代ç �也耦å�ˆåœ¨äº†ä¸€èµ· +* è¦�求开å�‘者ä¸�ä»…è¦�掌æ�¡ Java ,还è¦�有高超的å‰�端水平 +* å‰�端和å�Žç«¯ç›¸äº’ä¾�赖,å‰�端需è¦�等待å�Žç«¯å®Œæˆ�,å�Žç«¯ä¹Ÿä¾�èµ–å‰�端完æˆ�,æ‰�能进行有效的测试 +* 代ç �难以å¤�用 -ÕýÒòΪÉÏÃæµÄÖÖÖÖ±×¶Ë£¬ËùÒԺܿìÕâÖÖ·½Ê½¾Í±» Servlet + JSP + Java Bean ËùÌæ´úÁË£¬ÔçÆÚµÄ MVC Ä£ÐÍ**£¨Model2£©**¾ÍÏñÏÂͼÕâÑù£º +正因为上é�¢çš„ç§�ç§�弊端,所以很快这ç§�æ–¹å¼�就被 Servlet + JSP + Java Bean 所替代了,早期的 MVC 模型**(Model2)**å°±åƒ�下图这样: @@ -34,20 +34,20 @@ -Ê×ÏÈÓû§µÄÇëÇó»áµ½´ï Servlet£¬È»ºó¸ù¾ÝÇëÇóµ÷ÓÃÏàÓ¦µÄ Java Bean£¬²¢°ÑËùÓеÄÏÔʾ½á¹û½»¸ø JSP È¥Íê³É£¬ÕâÑùµÄģʽÎÒÃǾͳÆÎª MVC ģʽ¡£ +首先用户的请求会到达 Servlet,然å�Žæ ¹æ�®è¯·æ±‚调用相应的 Java Bean,并把所有的显示结果交给 JSP 去完æˆ�,这样的模å¼�我们就称为 MVC 模å¼�。 -* **M ´ú±í Ä£ÐÍ£¨Model£©** - Ä£ÐÍÊÇÊ²Ã´ÄØ£¿ Ä£Ð;ÍÊÇÊý¾Ý£¬¾ÍÊÇ dao,bean -* **V ´ú±í ÊÓͼ£¨View£©** - ÊÓͼÊÇÊ²Ã´ÄØ£¿ ¾ÍÊÇÍøÒ³, JSP£¬ÓÃÀ´Õ¹Ê¾Ä£ÐÍÖеÄÊý¾Ý -* **C ´ú±í ¿ØÖÆÆ÷£¨controller)** - ¿ØÖÆÆ÷ÊÇʲô£¿ ¿ØÖÆÆ÷µÄ×÷ÓþÍÊǰѲ»Í¬µÄÊý¾Ý(Model)£¬ÏÔʾÔÚ²»Í¬µÄÊÓͼ(View)ÉÏ£¬Servlet °çÑݵľÍÊÇÕâÑùµÄ½ÇÉ«¡£ +* **M 代表 模型(Model)** + 模型是什么呢? 模型就是数æ�®ï¼Œå°±æ˜¯ dao,bean +* **V 代表 视图(View)** + 视图是什么呢? 就是网页, JSP,用æ�¥å±•示模型中的数æ�® +* **C 代表 控制器(controller)** + 控制器是什么? 控制器的作用就是把ä¸�å�Œçš„æ•°æ�®(Model),显示在ä¸�å�Œçš„视图(View)上,Servlet 扮演的就是这样的角色。 -> À©Õ¹ÔĶÁ£º[Web¿ª·¢Ä£Ê½](https://mp.weixin.qq.com/s?__biz=MzI4Njg5MDA5NA==&mid=2247483775&idx=1&sn=c9d7ead744c6e0c3ab2fe55c09bbe61f&chksm=ebd7407edca0c9688f3870d895b760836101271b912899821fb35c5704fe215da2fc5daff2f9#rd) +> 扩展阅读:[Webå¼€å�‘模å¼�](https://mp.weixin.qq.com/s?__biz=MzI4Njg5MDA5NA==&mid=2247483775&idx=1&sn=c9d7ead744c6e0c3ab2fe55c09bbe61f&chksm=ebd7407edca0c9688f3870d895b760836101271b912899821fb35c5704fe215da2fc5daff2f9#rd) -#### Spring MVC µÄ¼Ü¹¹ +#### Spring MVC 的架构 -Ϊ½â¾ö³Ö¾Ã²ãÖÐһֱδ´¦ÀíºÃµÄÊý¾Ý¿âÊÂÎñµÄ±à³Ì£¬ÓÖΪÁËÓ­ºÏ NoSQL µÄÇ¿ÊÆáÈÆð£¬Spring MVC ¸ø³öÁË·½°¸£º +为解决æŒ�久层中一直未处ç�†å¥½çš„æ•°æ�®åº“事务的编程,å�ˆä¸ºäº†è¿Žå�ˆ NoSQL 的强势崛起,Spring MVC 给出了方案: @@ -59,20 +59,20 @@ -**´«Í³µÄÄ£ÐͲ㱻²ð·ÖΪÁËÒµÎñ²ã(Service)ºÍÊý¾Ý·ÃÎʲ㣨DAO,Data Access Object£©¡£** ÔÚ Service Ï¿ÉÒÔͨ¹ý Spring µÄÉùÃ÷ʽÊÂÎñ²Ù×÷Êý¾Ý·ÃÎʲ㣬¶øÔÚÒµÎñ²ãÉÏ»¹ÔÊÐíÎÒÃÇ·ÃÎÊ NoSQL £¬ÕâÑù¾ÍÄܹ»Âú×ãÒì¾üÍ»ÆðµÄ NoSQL µÄʹÓÃÁË£¬Ëü¿ÉÒÔ´ó´óÌá¸ß»¥ÁªÍøÏµÍ³µÄÐÔÄÜ¡£ +**传统的模型层被拆分为了业务层(Service)和数æ�®è®¿é—®å±‚(DAO,Data Access Object)。** 在 Service 下å�¯ä»¥é€šè¿‡ Spring 的声明å¼�事务æ“�作数æ�®è®¿é—®å±‚,而在业务层上还å…�许我们访问 NoSQL ,这样就能够满足异军çª�èµ·çš„ NoSQL 的使用了,它å�¯ä»¥å¤§å¤§æ��高互è�”网系统的性能。 -* **ÌØµã£º** - ½á¹¹ËÉÉ¢£¬¼¸ºõ¿ÉÒÔÔÚ Spring MVC ÖÐʹÓø÷ÀàÊÓͼ - ËÉñîºÏ£¬¸÷¸öÄ£¿é·ÖÀë - Óë Spring Î޷켯³É +* **特点:** + 结构æ�¾æ•£ï¼Œå‡ ä¹Žå�¯ä»¥åœ¨ Spring MVC 中使用å�„类视图 + æ�¾è€¦å�ˆï¼Œå�„个模å�—分离 + 与 Spring æ— ç¼�集æˆ� * * * ## Hello Spring MVC -ÈÃÎÒÃÇÀ´Ð´Ò»ÏÂÎÒÃǵĵÚÒ»¸ö Spring MVC ³ÌÐò£º +让我们æ�¥å†™ä¸€ä¸‹æˆ‘们的第一个 Spring MVC 程åº�: -#### µÚÒ»²½£ºÔÚ IDEA ÖÐн¨ Spring MVC ÏîÄ¿ +#### 第一步:在 IDEA 中新建 Spring MVC 项目 @@ -84,7 +84,7 @@ -²¢ÇÒÈ¡ÃûΪ ¡¾HelloSpringMVC¡¿£¬µã»÷¡¾Finish¡¿£º +并且å�–å��为 ã€�HelloSpringMVC】,点击ã€�Finish】: @@ -96,7 +96,7 @@ -IDEA »á×Ô¶¯°ïÎÒÃÇÏÂÔØºÃ±ØÒªµÄ jar °ü£¬²¢ÇÒΪÎÒÃÇ´´½¨ºÃһЩĬÈϵÄĿ¼ºÍÎļþ£¬´´½¨ºÃÒÔºóÏîÄ¿½á¹¹ÈçÏ£º +IDEA 会自动帮我们下载好必è¦�çš„ jar 包,并且为我们创建好一些默认的目录和文件,创建好以å�Žé¡¹ç›®ç»“构如下: @@ -108,9 +108,9 @@ IDEA -#### µÚ¶þ²½£ºÐÞ¸Ä web.xml +#### 第二步:修改 web.xml -ÎÒÃÇ´ò¿ª web.xml £¬°´ÕÕÏÂͼÍê³ÉÐ޸ģº +我们打开 web.xml ,按照下图完æˆ�修改: @@ -122,7 +122,7 @@ IDEA -°Ñ``ÔªËØµÄÖµ¸ÄΪ / £¬±íʾҪÀ¹½ØËùÓеÄÇëÇ󣬲¢½»ÓÉSpring MVCµÄºǫ́¿ØÖÆÆ÷À´´¦Àí£¬¸ÄÍêÖ®ºó£º +把``元素的值改为 / ,表示è¦�拦截所有的请求,并交由Spring MVCçš„å�Žå�°æŽ§åˆ¶å™¨æ�¥å¤„ç�†ï¼Œæ”¹å®Œä¹‹å�Žï¼š @@ -136,9 +136,9 @@ IDEA -#### µÚÈý²½£º±à¼­ dispatcher-servlet.xml +#### 第三步:编辑 dispatcher-servlet.xml -Õâ¸öÎļþÃûµÄ¿ªÍ· dispatcher ÓëÉÏÃæ web.xml ÖÐµÄ `` ÔªËØÅäÖÃµÄ dispatcher ¶ÔÓ¦£¬ÕâÊÇ Spring MVC µÄÓ³ÉäÅäÖÃÎļþ£¨xxx-servlet.xml£©£¬ÎÒÃDZ༭ÈçÏ£º +这个文件å��的开头 dispatcher 与上é�¢ web.xml 中的 `` 元素é…�置的 dispatcher 对应,这是 Spring MVC 的映射é…�置文件(xxx-servlet.xml),我们编辑如下: @@ -152,7 +152,7 @@ IDEA class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping"> - + helloController @@ -164,9 +164,9 @@ IDEA -#### µÚËIJ½£º±àд HelloController +#### 第四步:编写 HelloController -ÔÚ Package¡¾controller¡¿Ï´´½¨ ¡¾HelloController¡¿À࣬²¢ÊµÏÖ org.springframework.web.servlet.mvc.Controller ½Ó¿Ú£º +在 Packageã€�controller】下创建 ã€�HelloController】类,并实现 org.springframework.web.servlet.mvc.Controller 接å�£ï¼š @@ -187,10 +187,10 @@ public class HelloController implements Controller{ -* **³öÏÖÁËÎÊÌ⣺** javax.servlet °üÕÒ²»µ½ -* **½â¾ö£º** ½«±¾µØ Tomcat ·þÎñÆ÷µÄĿ¼Ï¡¾lib¡¿Îļþ¼ÐÏ嵀 servlet-api.jar °ü¿½±´µ½¹¤³Ì¡¾lib¡¿Îļþ¼ÐÏ£¬Ìí¼ÓÒÀÀµ +* **出现了问题:** javax.servlet 包找ä¸�到 +* **解决:** 将本地 Tomcat æœ�务器的目录下ã€�lib】文件夹下的 servlet-api.jar 包拷è´�到工程ã€�lib】文件夹下,添加ä¾�èµ– -Spring MVC ͨ¹ý ModelAndView ¶ÔÏó°ÑÄ£ÐͺÍÊÓͼ½áºÏÔÚÒ»Æð +Spring MVC 通过 ModelAndView 对象把模型和视图结å�ˆåœ¨ä¸€èµ· @@ -202,8 +202,8 @@ mav.addObject("message", "Hello Spring MVC"); -ÕâÀï±íʾÊÓͼµÄÊÇindex.jsp -Ä£ÐÍÊý¾ÝµÄÊÇ message£¬ÄÚÈÝÊÇ ¡°Hello Spring MVC¡± +这里表示视图的是index.jsp +模型数æ�®çš„æ˜¯ message,内容是 “Hello Spring MVCâ€� @@ -226,9 +226,9 @@ public class HelloController implements Controller { -#### µÚÎå²½£º×¼±¸ index.jsp +#### 第五步:准备 index.jsp -½« index.jsp µÄÄÚÈÝÐÞ¸ÄΪ£º +å°† index.jsp 的内容修改为: @@ -242,11 +242,11 @@ public class HelloController implements Controller { -ÄÚÈݺܼòµ¥£¬ÓÃEl±í´ïʽÏÔʾ message µÄÄÚÈÝ¡£ +内容很简å�•,用El表达å¼�显示 message 的内容。 -#### µÚÁù²½£º²¿Êð Tomcat ¼°Ïà¹Ø»·¾³ +#### 第六步:部署 Tomcat å�Šç›¸å…³çŽ¯å¢ƒ -ÔÚ¡¾Run¡¿²Ëµ¥ÏîÏÂÕÒµ½¡¾Edit Configurations¡¿ +在ã€�Run】è�œå�•项下找到ã€�Edit Configurations】 @@ -258,7 +258,7 @@ public class HelloController implements Controller { -ÅäÖà Tomcat »·¾³£º +é…�ç½® Tomcat 环境: @@ -270,7 +270,7 @@ public class HelloController implements Controller { -Ñ¡ÔñºÃ±¾µØµÄ Tomcat ·þÎñÆ÷£¬²¢¸ÄºÃÃû×Ö£º +选择好本地的 Tomcat æœ�务器,并改好å��字: @@ -282,7 +282,7 @@ public class HelloController implements Controller { -ÔÚ Deployment ±êǩҳÏÂÍê³ÉÈçϲÙ×÷£º +在 Deployment 标签页下完æˆ�如下æ“�作: @@ -294,11 +294,11 @@ public class HelloController implements Controller { -µã»÷ OK ¾ÍºÃÁË£¬ÎÒÃǵã»÷ÓÒÉϽǵÄÈý½ÇÐν« Tomcat ·þÎñÆ÷ÔËÐÐÆðÀ´¡£ +点击 OK 就好了,我们点击å�³ä¸Šè§’的三角形将 Tomcat æœ�务器è¿�行起æ�¥ã€‚ -* **³öÏÖµÄÎÊÌ⣺** Tomcat ·þÎñÆ÷ÎÞ·¨Õý³£Æô¶¯ -* **Ô­Òò£º** Tomcat ·þÎñÆ÷ÕÒ²»µ½Ïà¹ØµÄ jar °ü -* **½â¾ö·½·¨£º** ½«¡¾lib¡¿Îļþ¼ÐÕû¸ö¼ôÌùµ½¡¾WEB-INF¡¿Ï£¬²¢ÖØÐ½¨Á¢ÒÀÀµ£º +* **出现的问题:** Tomcat æœ�务器无法正常å�¯åЍ +* **原因:** Tomcat æœ�务器找ä¸�到相关的 jar 包 +* **解决方法:** å°†ã€�lib】文件夹整个剪贴到ã€�WEB-INF】下,并é‡�新建立ä¾�赖: @@ -310,9 +310,9 @@ public class HelloController implements Controller { -#### µÚÆß²½£ºÖØÆô·þÎñÆ÷ +#### 第七步:é‡�å�¯æœ�务器 -ÖØÆô·þÎñÆ÷£¬ÊäÈëµØÖ·£ºlocalhost/hello +é‡�å�¯æœ�务器,输入地å�€ï¼šlocalhost/hello @@ -324,13 +324,13 @@ public class HelloController implements Controller { -> ²Î¿¼×ÊÁÏ£º[Spring MVC ½Ì³Ì(how2j.cn)](http://how2j.cn/k/springmvc/springmvc-springmvc/615.html#step1891) +> å�‚考资料:[Spring MVC 教程(how2j.cn)](http://how2j.cn/k/springmvc/springmvc-springmvc/615.html#step1891) * * * -## ¸ú×Ù Spring MVC µÄÇëÇó +## 跟踪 Spring MVC 的请求 -ÿµ±Óû§ÔÚ Web ä¯ÀÀÆ÷Öеã»÷Á´½Ó»òÕßÌá½»±íµ¥µÄʱºò£¬ÇëÇó¾Í¿ªÊ¼¹¤×÷ÁË£¬ÏñÊÇÓʵÝÔ±Ò»Ñù£¬´ÓÀ뿪ä¯ÀÀÆ÷¿ªÊ¼µ½»ñÈ¡ÏìÓ¦·µ»Ø£¬Ëü»á¾­ÀúºÜ¶àÕ¾µã£¬ÔÚÿһ¸öÕ¾µã¶¼»áÁôÏÂһЩÐÅϢͬʱҲ»á´øÉÏÆäËûÐÅÏ¢£¬ÏÂͼΪ Spring MVC µÄÇëÇóÁ÷³Ì£º +æ¯�当用户在 Web æµ�览器中点击链接或者æ��交表å�•的时候,请求就开始工作了,åƒ�是邮递员一样,从离开æµ�览器开始到获å�–å“�应返回,它会ç»�历很多站点,在æ¯�一个站点都会留下一些信æ�¯å�Œæ—¶ä¹Ÿä¼šå¸¦ä¸Šå…¶ä»–ä¿¡æ�¯ï¼Œä¸‹å›¾ä¸º Spring MVC 的请求æµ�程: @@ -342,9 +342,9 @@ public class HelloController implements Controller { -#### µÚÒ»Õ¾£ºDispatcherServlet +#### 第一站:DispatcherServlet -´ÓÇëÇóÀ뿪ä¯ÀÀÆ÷ÒԺ󣬵ÚÒ»Õ¾µ½´ïµÄ¾ÍÊÇ DispatcherServlet£¬¿´Ãû×ÖÕâÊÇÒ»¸ö Servlet£¬Í¨¹ý J2EE µÄѧϰ£¬ÎÒÃÇÖªµÀ Servlet ¿ÉÒÔÀ¹½Ø²¢´¦Àí HTTP ÇëÇó£¬DispatcherServlet »áÀ¹½ØËùÓеÄÇëÇ󣬲¢ÇÒ½«ÕâЩÇëÇó·¢Ë͸ø Spring MVC ¿ØÖÆÆ÷¡£ +从请求离开æµ�览器以å�Žï¼Œç¬¬ä¸€ç«™åˆ°è¾¾çš„就是 DispatcherServlet,看å��字这是一个 Servlet,通过 J2EE 的学习,我们知é�“ Servlet å�¯ä»¥æ‹¦æˆªå¹¶å¤„ç�† HTTP 请求,DispatcherServlet 会拦截所有的请求,并且将这些请求å�‘é€�ç»™ Spring MVC 控制器。 @@ -356,7 +356,7 @@ public class HelloController implements Controller { dispatcher - + / @@ -364,13 +364,13 @@ public class HelloController implements Controller { -* **DispatcherServlet µÄÈÎÎñ¾ÍÊÇÀ¹½ØÇëÇó·¢Ë͸ø Spring MVC ¿ØÖÆÆ÷¡£** +* **DispatcherServlet 的任务就是拦截请求å�‘é€�ç»™ Spring MVC 控制器。** -#### µÚ¶þÕ¾£º´¦ÀíÆ÷Ó³É䣨HandlerMapping£© +#### 第二站:处ç�†å™¨æ˜ å°„(HandlerMapping) -* **ÎÊÌ⣺** µäÐ͵ÄÓ¦ÓóÌÐòÖпÉÄÜ»áÓжà¸ö¿ØÖÆÆ÷£¬ÕâЩÇëÇóµ½µ×Ó¦¸Ã·¢¸øÄÄÒ»¸ö¿ØÖÆÆ÷ÄØ£¿ +* **问题:** 典型的应用程åº�中å�¯èƒ½ä¼šæœ‰å¤šä¸ªæŽ§åˆ¶å™¨ï¼Œè¿™äº›è¯·æ±‚到底应该å�‘给哪一个控制器呢? -ËùÒÔ DispatcherServlet »á²éѯһ¸ö»ò¶à¸ö´¦ÀíÆ÷Ó³ÉäÀ´È·¶¨ÇëÇóµÄÏÂÒ»Õ¾ÔÚÄÄÀ´¦ÀíÆ÷Ó³Éä»á**¸ù¾ÝÇëÇóËùЯ´øµÄ URL ÐÅÏ¢À´½øÐоö²ß**£¬ÀýÈçÉÏÃæµÄÀý×ÓÖУ¬ÎÒÃÇͨ¹ýÅäÖà simpleUrlHandlerMapping À´½« /hello µØÖ·½»¸ø helloController ´¦Àí£º +所以 DispatcherServlet 会查询一个或多个处ç�†å™¨æ˜ å°„æ�¥ç¡®å®šè¯·æ±‚的下一站在哪里,处ç�†å™¨æ˜ å°„会**æ ¹æ�®è¯·æ±‚所æ�ºå¸¦çš„ URL ä¿¡æ�¯æ�¥è¿›è¡Œå†³ç­–**,例如上é�¢çš„例å­�中,我们通过é…�ç½® simpleUrlHandlerMapping æ�¥å°† /hello 地å�€äº¤ç»™ helloController 处ç�†ï¼š @@ -379,7 +379,7 @@ public class HelloController implements Controller { class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping"> - + helloController @@ -390,15 +390,15 @@ public class HelloController implements Controller { -#### µÚÈýÕ¾£º¿ØÖÆÆ÷ +#### 第三站:控制器 -Ò»µ©Ñ¡ÔñÁ˺ÏÊʵĿØÖÆÆ÷£¬ DispatcherServlet »á½«ÇëÇó·¢Ë͸øÑ¡ÖеĿØÖÆÆ÷£¬µ½ÁË¿ØÖÆÆ÷£¬ÇëÇó»áжÏÂÆä¸ºÔØ£¨Óû§Ìá½»µÄÇëÇ󣩵ȴý¿ØÖÆÆ÷´¦ÀíÍêÕâЩÐÅÏ¢£º +一旦选择了å�ˆé€‚的控制器, DispatcherServlet 会将请求å�‘é€�给选中的控制器,到了控制器,请求会å�¸ä¸‹å…¶è´Ÿè½½ï¼ˆç”¨æˆ·æ��交的请求)等待控制器处ç�†å®Œè¿™äº›ä¿¡æ�¯ï¼š ``` public ModelAndView handleRequest(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws Exception { - // ´¦ÀíÂß¼­ + // 处ç�†é€»è¾‘ .... } @@ -406,19 +406,19 @@ public ModelAndView handleRequest(javax.servlet.http.HttpServletRequest httpServ -#### µÚËÄÕ¾£º·µ»Ø DispatcherServlet +#### 第四站:返回 DispatcherServlet -µ±¿ØÖÆÆ÷ÔÚÍê³ÉÂß¼­´¦Àíºó£¬Í¨³£»á²úÉúһЩÐÅÏ¢£¬ÕâЩÐÅÏ¢¾ÍÊÇÐèÒª·µ»Ø¸øÓû§²¢ÔÚä¯ÀÀÆ÷ÉÏÏÔʾµÄÐÅÏ¢£¬ËüÃDZ»³ÆÎª**Ä£ÐÍ£¨Model£©**¡£½ö½ö·µ»ØÔ­Ê¼µÄÐÅϢʱ²»¹»µÄ¡ª¡ªÕâЩÐÅÏ¢ÐèÒªÒÔÓû§ÓѺõķ½Ê½½øÐиñʽ»¯£¬Ò»°ã»áÊÇ HTML£¬ËùÒÔ£¬ÐÅÏ¢ÐèÒª·¢Ë͸øÒ»¸ö**ÊÓͼ£¨view£©**£¬Í¨³£»áÊÇ JSP¡£ +当控制器在完æˆ�逻辑处ç�†å�Žï¼Œé€šå¸¸ä¼šäº§ç”Ÿä¸€äº›ä¿¡æ�¯ï¼Œè¿™äº›ä¿¡æ�¯å°±æ˜¯éœ€è¦�返回给用户并在æµ�览器上显示的信æ�¯ï¼Œå®ƒä»¬è¢«ç§°ä¸º**模型(Model)**。仅仅返回原始的信æ�¯æ—¶ä¸�够的——这些信æ�¯éœ€è¦�以用户å�‹å¥½çš„æ–¹å¼�进行格å¼�化,一般会是 HTML,所以,信æ�¯éœ€è¦�å�‘é€�给一个**视图(view)**,通常会是 JSP。 -¿ØÖÆÆ÷Ëù×öµÄ×îºóÒ»¼þʾÍÊǽ«Ä£ÐÍÊý¾Ý´ò°ü£¬²¢ÇÒ±íʾ³öÓÃÓÚäÖȾÊä³öµÄÊÓͼÃû**£¨Âß¼­ÊÓͼÃû£©¡£Ëü½ÓÏÂÀ´»á½«ÇëÇóÁ¬Í¬Ä£ÐͺÍÊÓͼÃû·¢ËÍ»Ø DispatcherServlet¡£** +控制器所å�šçš„æœ€å�Žä¸€ä»¶äº‹å°±æ˜¯å°†æ¨¡åž‹æ•°æ�®æ‰“包,并且表示出用于渲染输出的视图å��**(逻辑视图å��)。它接下æ�¥ä¼šå°†è¯·æ±‚连å�Œæ¨¡åž‹å’Œè§†å›¾å��å�‘é€�回 DispatcherServlet。** ``` public ModelAndView handleRequest(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws Exception { - // ´¦ÀíÂß¼­ + // 处ç�†é€»è¾‘ .... - // ·µ»Ø¸ø DispatcherServlet + // 返回给 DispatcherServlet return mav; } @@ -426,19 +426,19 @@ public ModelAndView handleRequest(javax.servlet.http.HttpServletRequest httpServ -#### µÚÎåÕ¾£ºÊÓͼ½âÎöÆ÷ +#### 第五站:视图解æž�器 -ÕâÑùÒÔÀ´£¬¿ØÖÆÆ÷¾Í²»»áºÍÌØ¶¨µÄÊÓͼÏàñîºÏ£¬´«µÝ¸ø DispatcherServlet µÄÊÓͼÃû²¢²»Ö±½Ó±íʾij¸öÌØ¶¨µÄ JSP¡££¨Êµ¼ÊÉÏ£¬ËüÉõÖÁ²»ÄÜÈ·¶¨ÊÓͼ¾ÍÊÇ JSP£©Ïà·´£¬**Ëü´«µÝµÄ½ö½öÊÇÒ»¸öÂß¼­Ãû³Æ£¬Õâ¸öÃû³Æ½«»áÓÃÀ´²éÕÒ²úÉú½á¹ûµÄÕæÕýÊÓͼ¡£** +这样以æ�¥ï¼ŒæŽ§åˆ¶å™¨å°±ä¸�会和特定的视图相耦å�ˆï¼Œä¼ é€’ç»™ DispatcherServlet 的视图å��å¹¶ä¸�直接表示æŸ�个特定的 JSP。(实际上,它甚至ä¸�能确定视图就是 JSP)相å��,**它传递的仅仅是一个逻辑å��称,这个å��称将会用æ�¥æŸ¥æ‰¾äº§ç”Ÿç»“果的真正视图。** -DispatcherServlet ½«»áʹÓÃÊÓͼ½âÎöÆ÷£¨view resolver£©À´½«Âß¼­ÊÓͼÃûÆ¥ÅäΪһ¸öÌØ¶¨µÄÊÓͼʵÏÖ£¬Ëü¿ÉÄÜÊÇÒ²¿ÉÄܲ»ÊÇ JSP +DispatcherServlet 将会使用视图解æž�器(view resolver)æ�¥å°†é€»è¾‘视图å��匹é…�为一个特定的视图实现,它å�¯èƒ½æ˜¯ä¹Ÿå�¯èƒ½ä¸�是 JSP -> ÉÏÃæµÄÀý×ÓÊÇÖ±½Ó°ó¶¨µ½ÁË index.jsp ÊÓͼ +> 上é�¢çš„例å­�是直接绑定到了 index.jsp 视图 -#### µÚÁùÕ¾£ºÊÓͼ +#### 第六站:视图 -¼ÈÈ» DispatcherServlet ÒѾ­ÖªµÀÓÉÄĸöÊÓͼäÖȾ½á¹ûÁË£¬ÄÇÇëÇóµÄÈÎÎñ»ù±¾ÉÏÒ²¾ÍÍê³ÉÁË¡£ +既然 DispatcherServlet å·²ç»�知é�“由哪个视图渲染结果了,那请求的任务基本上也就完æˆ�了。 -ËüµÄ×îºóÒ»Õ¾ÊÇÊÓͼµÄʵÏÖ£¬ÔÚÕâÀïËü½»¸¶Ä£ÐÍÊý¾Ý£¬ÇëÇóµÄÈÎÎñÒ²¾ÍÍê³ÉÁË¡£ÊÓͼʹÓÃÄ£ÐÍÊý¾ÝäÖȾ³ö½á¹û£¬Õâ¸öÊä³ö½á¹û»áͨ¹ýÏìÓ¦¶ÔÏ󴫵ݸø¿Í»§¶Ë¡£ +它的最å�Žä¸€ç«™æ˜¯è§†å›¾çš„实现,在这里它交付模型数æ�®ï¼Œè¯·æ±‚的任务也就完æˆ�了。视图使用模型数æ�®æ¸²æŸ“出结果,这个输出结果会通过å“�应对象传递给客户端。 @@ -454,11 +454,11 @@ DispatcherServlet * * * -## ʹÓÃ×¢½âÅäÖà Spring MVC +## 使用注解é…�ç½® Spring MVC -ÉÏÃæÎÒÃÇÒѾ­¶Ô Spring MVC ÓÐÁËÒ»¶¨µÄÁ˽⣬²¢ÇÒͨ¹ý XML ÅäÖõķ½Ê½´´½¨Á˵ÚÒ»¸ö Spring MVC ³ÌÐò£¬ÎÒÃÇÀ´¿´¿´»ùÓÚ×¢½âÓ¦¸ÃÔõôÍê³ÉÉÏÊö³ÌÐòµÄÅäÖ㺠+上é�¢æˆ‘们已ç»�对 Spring MVC 有了一定的了解,并且通过 XML é…�置的方å¼�创建了第一个 Spring MVC 程åº�,我们æ�¥çœ‹çœ‹åŸºäºŽæ³¨è§£åº”该怎么完æˆ�上述程åº�çš„é…�置: -#### µÚÒ»²½£ºÎª HelloController Ìí¼Ó×¢½â +#### 第一步:为 HelloController 添加注解 @@ -483,17 +483,17 @@ public class HelloController{ -°ÑʵÏֵĽӿÚÒ²¸øÈ¥µô¡£ +把实现的接å�£ä¹Ÿç»™åŽ»æŽ‰ã€‚ -* **¼òµ¥½âÊÍһϣº** -* `@Controller` ×¢½â£º - ºÜÃ÷ÏÔ£¬Õâ¸ö×¢½âÊÇÓÃÀ´ÉùÃ÷¿ØÖÆÆ÷µÄ£¬µ«Êµ¼ÊÉÏÕâ¸ö×¢½â¶Ô Spring MVC ±¾ÉíµÄÓ°Ïì²¢²»´ó¡££¨Spring ʵս˵Ëü½ö½öÊǸ¨ÖúʵÏÖ×é¼þɨÃ裬¿ÉÒÔÓà `@Component` ×¢½â´úÌæ£¬µ«ÎÒ×Ô¼º³¢ÊÔÁËһϲ¢²»ÐУ¬ÒòΪÉÏÊöÀý×ÓûÓÐÅäÖà JSP ÊÓͼ½âÎöÆ÷ÎÒ»¹×Ô¼ºÅäÁËÒ»¸öÈÔûÓгɹ¦...£© -* `@RequestMapping` ×¢½â£º - ºÜÏÔÈ»£¬Õâ¾Í±íʾ·¾¶ `/hello` »áÓ³Éäµ½¸Ã·½·¨ÉÏ +* **简å�•解释一下:** +* `@Controller` 注解: + 很明显,这个注解是用æ�¥å£°æ˜ŽæŽ§åˆ¶å™¨çš„,但实际上这个注解对 Spring MVC 本身的影å“�å¹¶ä¸�大。(Spring 实战说它仅仅是辅助实现组件扫æ��,å�¯ä»¥ç”¨ `@Component` 注解代替,但我自己å°�试了一下并ä¸�行,因为上述例å­�没有é…�ç½® JSP 视图解æž�器我还自己é…�了一个ä»�没有æˆ�功...) +* `@RequestMapping` 注解: + 很显然,这就表示路径 `/hello` 会映射到该方法上 -#### µÚ¶þ²½£ºÈ¡Ïû֮ǰµÄ XML ×¢ÊÍ +#### 第二步:å�–消之å‰�çš„ XML 注释 -ÔÚ dispatcher-servlet.xml ÎļþÖУ¬×¢Ê͵ô֮ǰµÄÅäÖã¬È»ºóÔö¼ÓÒ»¾ä×é¼þɨÃ裺 +在 dispatcher-servlet.xml 文件中,注释掉之å‰�çš„é…�置,然å�Žå¢žåР䏀å�¥ç»„件扫æ��: @@ -508,14 +508,14 @@ public class HelloController{ --> - + - + @@ -523,9 +523,9 @@ public class HelloController{ -#### µÚÈý²½£ºÖØÆô·þÎñÆ÷ +#### 第三步:é‡�å�¯æœ�务器 -µ±ÅäÖÃÍê³É£¬ÖØÐÂÆô¶¯·þÎñÆ÷£¬ÊäÈë `localhost/hello` µØÖ·ÈÔÈ»ÄÜ¿´µ½Ð§¹û£º +当é…�置完æˆ�,é‡�æ–°å�¯åЍæœ�务器,输入 `localhost/hello` 地å�€ä»�然能看到效果: @@ -537,9 +537,9 @@ public class HelloController{ -#### @RequestMapping ×¢½âϸ½Ú +#### @RequestMapping 注解细节 -Èç¹û `@RequestMapping` ×÷ÓÃÔÚÀàÉÏ£¬ÄÇô¾ÍÏ൱ÓÚÊǸø¸ÃÀàËùÓÐÅäÖõÄÓ³ÉäµØÖ·Ç°¼ÓÉÏÁËÒ»¸öµØÖ·£¬ÀýÈ磺 +如果 `@RequestMapping` 作用在类上,那么就相当于是给该类所有é…�置的映射地å�€å‰�加上了一个地å�€ï¼Œä¾‹å¦‚: @@ -557,24 +557,24 @@ public class HelloController { -* Ôò·ÃÎʵØÖ·£º `localhost/wmyskxz/hello` +* 则访问地å�€ï¼š `localhost/wmyskxz/hello` * * * -## ÅäÖÃÊÓͼ½âÎöÆ÷ +## é…�置视图解æž�器 -»¹¼ÇµÃÎÒÃÇ Spring MVC µÄÇëÇóÁ÷³ÌÂð£¬ÊÓͼ½âÎöÆ÷¸ºÔð¶¨Î»ÊÓͼ£¬Ëü½ÓÊÜÒ»¸öÓÉ DispaterServlet ´«µÝ¹ýÀ´µÄÂß¼­ÊÓͼÃûÀ´Æ¥ÅäÒ»¸öÌØ¶¨µÄÊÓͼ¡£ +还记得我们 Spring MVC 的请求æµ�程å�—,视图解æž�器负责定ä½�视图,它接å�—一个由 DispaterServlet 传递过æ�¥çš„逻辑视图å��æ�¥åŒ¹é…�一个特定的视图。 -* **ÐèÇó£º** ÓÐÒ»Ð©Ò³ÃæÎÒÃDz»Ï£ÍûÓû§Óû§Ö±½Ó·ÃÎʵ½£¬ÀýÈçÓÐÖØÒªÊý¾ÝµÄÒ³Ãæ£¬ÀýÈçÓÐÄ£ÐÍÊý¾ÝÖ§³ÅµÄÒ³Ãæ¡£ -* **Ôì³ÉµÄÎÊÌ⣺** - ÎÒÃÇ¿ÉÒÔÔÚ¡¾web¡¿¸ùĿ¼Ï·ÅÖÃÒ»¸ö¡¾test.jsp¡¿Ä£ÄâÒ»¸öÖØÒªÊý¾ÝµÄÒ³Ãæ£¬ÎÒÃÇʲô¶¼²»ÓÃ×ö£¬ÖØÐÂÆô¶¯·þÎñÆ÷£¬ÍøÒ³ÖÐÊäÈë `localhost/test.jsp` ¾ÍÄܹ»Ö±½Ó·ÃÎʵ½ÁË£¬Õâ»áÔì³É**Êý¾Ýй¶**... - ÁíÍâÎÒÃÇ¿ÉÒÔÖ±½ÓÊäÈë `localhost/index.jsp` ÊÔÊÔ£¬¸ù¾ÝÎÒÃÇÉÏÃæµÄ³ÌÐò£¬Õâ»áÊÇÒ»¸ö¿Õ°×µÄÒ³Ãæ£¬ÒòΪ²¢Ã»ÓлñÈ¡µ½ `${message}` ²ÎÊý¾ÍÖ±½Ó·ÃÎÊÁË£¬Õâ»á**Ó°ÏìÓû§ÌåÑé** +* **需求:** 有一些页é�¢æˆ‘们ä¸�希望用户用户直接访问到,例如有é‡�è¦�æ•°æ�®çš„页é�¢ï¼Œä¾‹å¦‚有模型数æ�®æ”¯æ’‘的页é�¢ã€‚ +* **造æˆ�的问题:** + 我们å�¯ä»¥åœ¨ã€�web】根目录下放置一个ã€�test.jsp】模拟一个é‡�è¦�æ•°æ�®çš„页é�¢ï¼Œæˆ‘们什么都ä¸�用å�šï¼Œé‡�æ–°å�¯åЍæœ�务器,网页中输入 `localhost/test.jsp` 就能够直接访问到了,这会造æˆ�**æ•°æ�®æ³„露**... + å�¦å¤–我们å�¯ä»¥ç›´æŽ¥è¾“å…¥ `localhost/index.jsp` 试试,根æ�®æˆ‘们上é�¢çš„程åº�,这会是一个空白的页é�¢ï¼Œå› ä¸ºå¹¶æ²¡æœ‰èŽ·å�–到 `${message}` å�‚数就直接访问了,这会**å½±å“�用户体验** -#### ½â¾ö·½°¸ +#### 解决方案 -ÎÒÃǽ«ÎÒÃÇµÄ JSP ÎļþÅäÖÃÔÚ¡¾WEB-INF¡¿Îļþ¼ÐÖеġ¾page¡¿Îļþ¼ÐÏ£¬¡¾WEB-INF¡¿ÊÇ Java Web ÖÐĬÈϵݲȫĿ¼£¬ÊDz»ÔÊÐíÓû§Ö±½Ó·ÃÎʵÄ_£¨Ò²¾ÍÊÇÄã˵Äãͨ¹ý `localhost/WEB-INF/` ÕâÑùµÄ·½Ê½ÊÇÓÀÔ¶·ÃÎʲ»µ½µÄ£©_ +我们将我们的 JSP 文件é…�置在ã€�WEB-INF】文件夹中的ã€�page】文件夹下,ã€�WEB-INF】是 Java Web 中默认的安全目录,是ä¸�å…�许用户直接访问的_(也就是你说你通过 `localhost/WEB-INF/` 这样的方å¼�是永远访问ä¸�到的)_ -µ«ÊÇÎÒÃÇÐèÒª½«Õâ¸æË߸øÊÓͼ½âÎöÆ÷£¬ÎÒÃÇÔÚ dispatcher-servlet.xml ÎļþÖÐ×öÈçÏÂÅäÖ㺠+但是我们需è¦�将这告诉给视图解æž�器,我们在 dispatcher-servlet.xml 文件中å�šå¦‚下é…�置: @@ -589,11 +589,11 @@ public class HelloController { -ÕâÀïÅäÖÃÁËÒ»¸ö Spring MVC ÄÚÖõÄÒ»¸öÊÓͼ½âÎöÆ÷£¬¸Ã½âÎöÆ÷ÊÇ×ñÑ­×ÅÒ»ÖÖÔ¼¶¨£º»á**ÔÚÊÓͼÃûÉÏÌí¼Óǰ׺ºÍºó׺£¬½ø¶øÈ·¶¨Ò»¸ö Web Ó¦ÓÃÖÐÊÓͼ×ÊÔ´µÄÎïÀí·¾¶µÄ¡£**ÈÃÎÒÃÇʵ¼ÊÀ´¿´¿´Ð§¹û£º +这里é…�置了一个 Spring MVC 内置的一个视图解æž�器,该解æž�器是é�µå¾ªç�€ä¸€ç§�约定:会**在视图å��上添加å‰�缀和å�Žç¼€ï¼Œè¿›è€Œç¡®å®šä¸€ä¸ª Web 应用中视图资æº�的物ç�†è·¯å¾„的。**让我们实际æ�¥çœ‹çœ‹æ•ˆæžœï¼š -#### µÚÒ»²½£ºÐÞ¸Ä HelloController +#### 第一步:修改 HelloController -ÎÒÃǽ«´úÂëÐÞ¸Äһϣº +我们将代ç �修改一下: @@ -605,9 +605,9 @@ public class HelloController { -#### µÚ¶þ²½£ºÅäÖÃÊÓͼ½âÎöÆ÷£º +#### 第二步:é…�置视图解æž�器: -°´ÕÕÉÏÊöµÄÅäÖã¬Íê³É£º +按照上述的é…�置,完æˆ�: @@ -622,14 +622,14 @@ public class HelloController { --> - + - + @@ -642,9 +642,9 @@ public class HelloController { -#### µÚÈý²½£º¼ôÌù index.jsp Îļþ +#### 第三步:剪贴 index.jsp 文件 -ÔÚ¡¾WEB-INF¡¿Îļþ¼ÐÏÂн¨Ò»¸ö¡¾page¡¿Îļþ¼Ð£¬²¢½«¡¾index.jsp¡¿Îļþ¼ôÌùµ½ÀïÃæ£º +在ã€�WEB-INF】文件夹下新建一个ã€�page】文件夹,并将ã€�index.jsp】文件剪贴到里é�¢ï¼š @@ -656,9 +656,9 @@ public class HelloController { -#### µÚËIJ½£º¸üÐÂ×ÊÔ´ÖØÆô·þÎñÆ÷ +#### 第四步:更新资æº�é‡�å�¯æœ�务器 -·ÃÎÊ `localhost/hello` ·¾¶£¬¿´µ½ÕýȷЧ¹û£º +访问 `localhost/hello` 路径,看到正确效果: @@ -670,7 +670,7 @@ public class HelloController { -* **Ô­Àí£º** +* **原ç�†ï¼š** @@ -682,15 +682,15 @@ public class HelloController { -ÎÒÃÇ´«ÈëµÄÂß¼­ÊÓͼÃûΪ index £¬ÔÙ¼ÓÉÏ ¡°`/WEB-INF/page/`¡± ǰ׺ºÍ ¡°`.jsp`¡± ºó׺£¬¾ÍÄÜÈ·¶¨ÎïÀíÊÓͼµÄ·¾¶ÁË£¬ÕâÑùÎÒÃÇÒÔºó¾Í¿ÉÒÔ½«ËùÓеÄÊÓͼ·ÅÈ롾page¡¿Îļþ¼ÐÏÂÁË£¡ +我们传入的逻辑视图å��为 index ,å†�加上 “`/WEB-INF/page/`â€� å‰�缀和 “`.jsp`â€� å�Žç¼€ï¼Œå°±èƒ½ç¡®å®šç‰©ç�†è§†å›¾çš„路径了,这样我们以å�Žå°±å�¯ä»¥å°†æ‰€æœ‰çš„视图放入ã€�page】文件夹下了ï¼� -* **×¢Ò⣺**´ËʱµÄÅäÖýöÊÇ dispatcher-servlet.xml Ï嵀 +* **注æ„�:**此时的é…�置仅是 dispatcher-servlet.xml 下的 * * * -## ¿ØÖÆÆ÷½ÓÊÕÇëÇóÊý¾Ý +## 控制器接收请求数æ�® -ʹÓÿØÖÆÆ÷½ÓÊÕ²ÎÊýÍùÍùÊÇ Spring MVC ¿ª·¢ÒµÎñÂß¼­µÄµÚÒ»²½£¬ÎªÌ½Ë÷ Spring MVC µÄ´«²Î·½Ê½£¬Îª´ËÎÒÃÇÏÈÀ´´´½¨Ò»¸ö¼òµ¥µÄ±íµ¥ÓÃÓÚÌá½»Êý¾Ý£º +使用控制器接收å�‚数往往是 Spring MVC å¼€å�‘业务逻辑的第一步,为探索 Spring MVC 的传å�‚æ–¹å¼�,为此我们先æ�¥åˆ›å»ºä¸€ä¸ªç®€å�•的表å�•用于æ��交数æ�®ï¼š @@ -701,12 +701,12 @@ public class HelloController { - Spring MVC ´«²Î·½Ê½ + Spring MVC ä¼ å�‚æ–¹å¼�
- Óû§Ãû£º
- ÃÜÂ룺
+ 用户�:
+ 密�:
@@ -716,7 +716,7 @@ public class HelloController { -³ó¾Í³óµã¶ù°É£¬ÎÒÃǾÍÊÇÀ´²âÊÔһϣº +丑就丑点儿å�§ï¼Œæˆ‘们就是æ�¥æµ‹è¯•一下: @@ -728,9 +728,9 @@ public class HelloController { -#### ʹÓà Servlet Ô­Éú API ʵÏÖ£º +#### 使用 Servlet 原生 API 实现: -ÎÒÃǺÜÈÝÒ×ÖªµÀ£¬±íµ¥»áÌá½»µ½ `/param` Õâ¸öĿ¼£¬ÎÒÃÇÏÈÀ´Ê¹Óà Servlet Ô­ÉúµÄ API À´¿´¿´Äܲ»ÄÜ»ñÈ¡µ½Êý¾Ý£º +我们很容易知é�“,表å�•会æ��交到 `/param` 这个目录,我们先æ�¥ä½¿ç”¨ Servlet 原生的 API æ�¥çœ‹çœ‹èƒ½ä¸�能获å�–到数æ�®ï¼š @@ -750,7 +750,7 @@ public ModelAndView getParam(HttpServletRequest request, -²âÊԳɹ¦£º +测试æˆ�功: @@ -762,9 +762,9 @@ public ModelAndView getParam(HttpServletRequest request, -#### ʹÓÃͬÃûÆ¥Å乿Ôò +#### 使用å�Œå��匹é…�规则 -ÎÒÃÇ¿ÉÒÔ°Ñ·½·¨¶¨ÒåµÄÐβÎÃû×ÖÉèÖóɺÍǰ̨´«Èë²ÎÊýÃûÒ»ÑùµÄ·½·¨£¬À´»ñÈ¡µ½Êý¾Ý£¨Í¬ÃûÆ¥Å乿Ôò£©£º +我们å�¯ä»¥æŠŠæ–¹æ³•定义的形å�‚å��字设置æˆ�å’Œå‰�å�°ä¼ å…¥å�‚æ•°å��一样的方法,æ�¥èŽ·å�–到数æ�®ï¼ˆå�Œå��匹é…�规则): @@ -781,7 +781,7 @@ public ModelAndView getParam(String userName, -²âÊԳɹ¦£º +测试æˆ�功: @@ -793,8 +793,8 @@ public ModelAndView getParam(String userName, -* **ÎÊÌ⣺** ÕâÑùÓÖ»áºÍǰ̨²úÉúºÜÇ¿µÄñîºÏ£¬ÕâÊÇÎÒÃDz»Ï£ÍûµÄ -* **½â¾ö£º** ʹÓà `@RequestParam("ǰ̨²ÎÊýÃû")` À´×¢È룺 +* **问题:** 这样å�ˆä¼šå’Œå‰�å�°äº§ç”Ÿå¾ˆå¼ºçš„耦å�ˆï¼Œè¿™æ˜¯æˆ‘们ä¸�希望的 +* **解决:** 使用 `@RequestParam("å‰�å�°å�‚æ•°å��")` æ�¥æ³¨å…¥ï¼š @@ -806,17 +806,17 @@ public ModelAndView getParam(String userName, -* **`@RequestParam` ×¢½âϸ½Ú£º** - ¸Ã×¢½âÓÐÈý¸ö±äÁ¿£º`value`¡¢`required`¡¢`defaultvalue` -* `value` £ºÖ¸¶¨ `name` ÊôÐÔµÄÃû³ÆÊÇʲô£¬`value` ÊôÐÔ¶¼¿ÉÒÔĬÈϲ»Ð´ -* `required` £ºÊÇ·ñ±ØÐëÒªÓиòÎÊý£¬¿ÉÒÔÉèÖÃΪ¡¾true¡¿»òÕß¡¾false¡¿ -* `defaultvalue` £ºÉèÖÃĬÈÏÖµ +* **`@RequestParam` 注解细节:** + 该注解有三个å�˜é‡�:`value`ã€�`required`ã€�`defaultvalue` +* `value` :指定 `name` 属性的å��称是什么,`value` 属性都å�¯ä»¥é»˜è®¤ä¸�写 +* `required` :是å�¦å¿…é¡»è¦�有该å�‚数,å�¯ä»¥è®¾ç½®ä¸ºã€�true】或者ã€�false】 +* `defaultvalue` :设置默认值 -#### ʹÓÃÄ£ÐÍ´«²Î +#### 使用模型传å�‚ -* **ÒªÇó£º Ç°Ì¨²ÎÊýÃû×Ö±ØÐëºÍÄ£ÐÍÖеÄ×Ö¶ÎÃûÒ»Ñù** +* **è¦�求: å‰�å�°å�‚æ•°å��字必须和模型中的字段å��一样** -ÈÃÎÒÃÇÏÈÀ´ÎªÎÒÃÇµÄ±íµ¥´´½¨Ò»¸ö User Ä£ÐÍ£º +让我们先æ�¥ä¸ºæˆ‘们的表å�•创建一个 User 模型: @@ -835,7 +835,7 @@ public class User { -È»ºó²âÊÔÈÔÈ»³É¹¦£º +ç„¶å�Žæµ‹è¯•ä»�ç„¶æˆ�功: @@ -847,11 +847,11 @@ public class User { -#### ÖÐÎÄÂÒÂëÎÊÌâ +#### 中文乱ç �问题 -* **×¢Ò⣺** ¸ú Servlet ÖеÄÒ»Ñù£¬¸Ã·½·¨Ö»¶Ô POST ·½·¨ÓÐЧ£¨ÒòΪÊÇÖ±½Ó´¦ÀíµÄ request£© +* **注æ„�:** è·Ÿ Servlet 中的一样,该方法å�ªå¯¹ POST 方法有效(因为是直接处ç�†çš„ request) -ÎÒÃÇ¿ÉÒÔͨ¹ýÅäÖà Spring MVC ×Ö·û±àÂë¹ýÂËÆ÷À´Íê³É£¬ÔÚ web.xml ÖÐÌí¼Ó£º +我们å�¯ä»¥é€šè¿‡é…�ç½® Spring MVC 字符编ç �过滤器æ�¥å®Œæˆ�,在 web.xml 中添加: @@ -861,7 +861,7 @@ public class User { org.springframework.web.filter.CharacterEncodingFilter encoding - + utf-8 @@ -876,9 +876,9 @@ public class User { * * * -## ¿ØÖÆÆ÷»ØÏÔÊý¾Ý +## 控制器回显数æ�® -ͨ¹ýÉÏÃæ£¬ÎÒÃÇÖªµÀÁËÔõô½ÓÊÜÇëÇóÊý¾Ý£¬²¢Äܽâ¾ö POST ÂÒÂëµÄÎÊÌ⣬ÄÇôÎÒÃÇÔõô»ØÏÔÊý¾ÝÄØ£¿Îª´ËÎÒÃÇÔÚ¡¾page¡¿Ï´´½¨Ò»¸ö¡¾test2.jsp¡¿£º +通过上é�¢ï¼Œæˆ‘们知é�“了怎么接å�—请求数æ�®ï¼Œå¹¶èƒ½è§£å†³ POST ä¹±ç �的问题,那么我们怎么回显数æ�®å‘¢ï¼Ÿä¸ºæ­¤æˆ‘们在ã€�page】下创建一个ã€�test2.jsp】: @@ -888,10 +888,10 @@ public class User { pageEncoding="UTF-8" import="java.util.*" isELIgnored="false" %> - Spring MVC Êý¾Ý»ØÏÔ + Spring MVC æ•°æ�®å›žæ˜¾ -

»ØÏÔÊý¾Ý£º${message}

+

回显数�:${message}

@@ -899,9 +899,9 @@ public class User { -#### ʹÓà Servlet Ô­Éú API À´ÊµÏÖ +#### 使用 Servlet 原生 API æ�¥å®žçް -ÎÒÃÇÏÈÀ´²âÊÔһϠServlet Ô­ÉúµÄ API ÊÇ·ñÄÜÍê³ÉÕâ¸öÈÎÎñ£º +我们先æ�¥æµ‹è¯•一下 Servlet 原生的 API 是å�¦èƒ½å®Œæˆ�这个任务: @@ -909,7 +909,7 @@ public class User { @RequestMapping("/value") public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) { - request.setAttribute("message","³É¹¦£¡"); + request.setAttribute("message","æˆ�功ï¼�"); return new ModelAndView("test1"); } @@ -917,7 +917,7 @@ public ModelAndView handleRequest(HttpServletRequest request, -ÔÚä¯ÀÀÆ÷µØÖ·À¸ÖÐÊäÈ룺`localhost/value` ²âÊÔ +在æµ�览器地å�€æ �中输入:`localhost/value` 测试 @@ -929,7 +929,7 @@ public ModelAndView handleRequest(HttpServletRequest request, -#### ʹÓà Spring MVC ËùÌṩµÄ ModelAndView ¶ÔÏó +#### 使用 Spring MVC 所æ��供的 ModelAndView 对象 @@ -941,9 +941,9 @@ public ModelAndView handleRequest(HttpServletRequest request, -#### ʹÓà Model ¶ÔÏó +#### 使用 Model 对象 -ÔÚ Spring MVC ÖУ¬ÎÒÃÇͨ³£¶¼ÊÇʹÓÃÕâÑùµÄ·½Ê½À´°ó¶¨Êý¾Ý£¬ +在 Spring MVC 中,我们通常都是使用这样的方å¼�æ�¥ç»‘定数æ�®ï¼Œ @@ -955,14 +955,14 @@ public ModelAndView handleRequest(HttpServletRequest request, -* **ʹÓà `@ModelAttribute` ×¢½â£º** +* **使用 `@ModelAttribute` 注解:** ``` @ModelAttribute public void model(Model model) { - model.addAttribute("message", "×¢½â³É¹¦"); + model.addAttribute("message", "注解æˆ�功"); } @RequestMapping("/value") @@ -974,15 +974,15 @@ public String handleRequest() { -ÕâÑùд¾Í»áÔÚ·ÃÎÊ¿ØÖÆÆ÷·½·¨ handleRequest() ʱ£¬»áÊ×Ïȵ÷Óà model() ·½·¨½« `message` Ìí¼Ó½øÒ³Ãæ²ÎÊýÖÐÈ¥£¬ÔÚÊÓͼÖпÉÒÔÖ±½Óµ÷Ó㬵«ÊÇÕâÑùд»áµ¼Ö¸ÿØÖÆÆ÷ËùÓеķ½·¨¶¼»áÊ×Ïȵ÷Óà model() ·½·¨£¬µ«Í¬ÑùµÄÒ²ºÜ·½±ã£¬ÒòΪ¿ÉÒÔ¼ÓÈë¸÷ÖÖ¸÷ÑùµÄÊý¾Ý¡£ +这样写就会在访问控制器方法 handleRequest() 时,会首先调用 model() 方法将 `message` 添加进页é�¢å�‚数中去,在视图中å�¯ä»¥ç›´æŽ¥è°ƒç”¨ï¼Œä½†æ˜¯è¿™æ ·å†™ä¼šå¯¼è‡´è¯¥æŽ§åˆ¶å™¨æ‰€æœ‰çš„æ–¹æ³•都会首先调用 model() 方法,但å�Œæ ·çš„也很方便,因为å�¯ä»¥åŠ å…¥å�„ç§�å�„样的数æ�®ã€‚ * * * -## ¿Í»§¶ËÌø×ª +## 客户端跳转 -Ç°Ãæ²»¹ÜÊǵØÖ· `/hello` Ìø×ªµ½ index.jsp »¹ÊÇ `/test` Ìø×ªµ½ test.jsp£¬ÕâЩ¶¼ÊÇ·þÎñ¶ËµÄÌø×ª£¬Ò²¾ÍÊÇ `request.getRequestDispatcher("µØÖ·").forward(request, response);` +å‰�é�¢ä¸�管是地å�€ `/hello` 跳转到 index.jsp 还是 `/test` 跳转到 test.jsp,这些都是æœ�务端的跳转,也就是 `request.getRequestDispatcher("地å�€").forward(request, response);` -ÄÇÎÒÃÇÈçºÎ½øÐпͻ§¶ËÌø×ªÄØ£¿ÎÒÃǼÌÐøÔÚ HelloController Öбàд£º +那我们如何进行客户端跳转呢?我们继续在 HelloController 中编写: @@ -1004,7 +1004,7 @@ public ModelAndView jump() { -ÎÒÃÇʹÓà `redirect:/hello` ¾Í±íʾÎÒÃÇÒªÌø×ªµ½ `/hello` Õâ¸ö·¾¶£¬ÎÒÃÇÖØÆô·þÎñÆ÷£¬ÔÚµØÖ·À¸ÖÐÊäÈ룺`localhost/jump` £¬»á×Ô¶¯Ìø×ªµ½ `/hello` ·¾¶Ï£º +我们使用 `redirect:/hello` 就表示我们è¦�跳转到 `/hello` 这个路径,我们é‡�å�¯æœ�务器,在地å�€æ �中输入:`localhost/jump` ,会自动跳转到 `/hello` 路径下: @@ -1016,7 +1016,7 @@ public ModelAndView jump() { -Ò²¿ÉÒÔÕâÑùÓ㺠+也å�¯ä»¥è¿™æ ·ç”¨ï¼š @@ -1032,17 +1032,17 @@ public String jump() { * * * -## ÎļþÉÏ´« +## 文件上传 -ÎÒÃÇÏÈÀ´»Ø¹Ëһϴ«Í³µÄÎļþÉÏ´«ºÍÏÂÔØ£º[ÕâÀï](https://www.jianshu.com/p/e7837435bf4c) +我们先æ�¥å›žé¡¾ä¸€ä¸‹ä¼ ç»Ÿçš„æ–‡ä»¶ä¸Šä¼ å’Œä¸‹è½½ï¼š[这里](https://www.jianshu.com/p/e7837435bf4c) -ÎÒÃÇÔÙÀ´¿´Ò»ÏÂÔÚ Spring MVC ÖÐÈçºÎʵÏÖÎļþµÄÉÏ´«ºÍÏÂÔØ +我们å†�æ�¥çœ‹ä¸€ä¸‹åœ¨ Spring MVC 中如何实现文件的上传和下载 -* **×¢Ò⣺** ÐèÒªÏȵ¼Èë `commons-io-1.3.2.jar` ºÍ `commons-fileupload-1.2.1.jar` Á½¸ö°ü +* **注æ„�:** 需è¦�先导入 `commons-io-1.3.2.jar` å’Œ `commons-fileupload-1.2.1.jar` 两个包 -#### µÚÒ»²½£ºÅäÖÃÉÏ´«½âÎöÆ÷ +#### 第一步:é…�置上传解æž�器 -ÔÚ dispatcher-servlet.xml ÖÐÐÂÔöÒ»¾ä£º +在 dispatcher-servlet.xml 中新增一å�¥ï¼š @@ -1053,11 +1053,11 @@ public String jump() { -¿ªÆô¶ÔÉÏ´«¹¦ÄܵÄÖ§³Ö +å¼€å�¯å¯¹ä¸Šä¼ åŠŸèƒ½çš„æ”¯æŒ� -#### µÚ¶þ²½£º±àд JSP +#### 第二步:编写 JSP -ÎļþÃûΪ upload.jsp£¬ÈÔ´´½¨ÔÚ¡¾page¡¿Ï£º +文件å��为 upload.jsp,ä»�创建在ã€�page】下: @@ -1065,7 +1065,7 @@ public String jump() { <%@ page contentType="text/html;charset=UTF-8" language="java" %> - ²âÊÔÎļþÉÏ´« + 测试文件上传
@@ -1079,9 +1079,9 @@ public String jump() { -#### µÚÈý²½£º±àд¿ØÖÆÆ÷ +#### 第三步:编写控制器 -ÔÚ Package¡¾controller¡¿ÏÂн¨¡¾UploadController¡¿Àࣺ +在 Packageã€�controller】下新建ã€�UploadController】类: @@ -1113,9 +1113,9 @@ public class UploadController { -#### µÚËIJ½£º²âÊÔ +#### 第四步:测试 -ÔÚä¯ÀÀÆ÷µØÖ·À¸ÖÐÊäÈ룺`localhost/test2` £¬Ñ¡ÔñÎļþµã»÷ÉÏ´«£¬²âÊԳɹ¦£º +在æµ�览器地å�€æ �中输入:`localhost/test2` ,选择文件点击上传,测试æˆ�功: @@ -1129,25 +1129,25 @@ public class UploadController { * * * -#### ²Î¿¼×ÊÁÏ£º +#### å�‚考资料: -* ¡¶Java EE »¥ÁªÍøÇáÁ¿¼¶¿ò¼ÜÕûºÏ¿ª·¢¡· -* ¡¶Spring ʵս¡· -* [How2j Spring MVC ϵÁн̳Ì](http://how2j.cn/k/springmvc/springmvc-springmvc/615.html) -* È«ÄܵİٶȺÍÍòÄܵĴóÄÔ +* 《Java EE 互è�”网轻é‡�级框架整å�ˆå¼€å�‘》 +* 《Spring 实战》 +* [How2j Spring MVC 系列教程](http://how2j.cn/k/springmvc/springmvc-springmvc/615.html) +* 全能的百度和万能的大脑 * * * -> »¶Ó­×ªÔØ£¬×ªÔØÇë×¢Ã÷³ö´¦£¡ -> ¼òÊéID£º[@ÎÒûÓÐÈý¿ÅÐÄÔà](https://www.jianshu.com/u/a40d61a49221) -> github£º[wmyskxz](https://github.com/wmyskxz/) -> »¶Ó­¹Ø×¢¹«ÖÚ΢Ðźţºwmyskxz -> ·ÖÏí×Ô¼ºµÄѧϰ & ѧϰ×ÊÁÏ & Éú»î -> ÏëÒª½»Á÷µÄÅóÓÑÒ²¿ÉÒÔ¼ÓqqȺ£º3382693 +> 欢迎转载,转载请注明出处ï¼� +> 简书ID:[@我没有三颗心è„�](https://www.jianshu.com/u/a40d61a49221) +> github:[wmyskxz](https://github.com/wmyskxz/) +> 欢迎关注公众微信å�·ï¼šwmyskxz +> 分享自己的学习 & 学习资料 & 生活 +> 想è¦�交æµ�的朋å�‹ä¹Ÿå�¯ä»¥åŠ qq群:3382693 -×÷ÕߣºÎÒûÓÐÈý¿ÅÐÄÔà -Á´½Ó£ºhttps://www.jianshu.com/p/91a2d0a1e45a -À´Ô´£º¼òÊé -Öø×÷Ȩ¹é×÷ÕßËùÓС£ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ \ No newline at end of file +作者:我没有三颗心è„� +链接:https://www.jianshu.com/p/91a2d0a1e45a +æ�¥æº�:简书 +著作æ�ƒå½’作者所有。商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\246\202\344\275\225\345\256\236\347\216\260\346\226\207\344\273\266\344\270\212\344\274\240.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\246\202\344\275\225\345\256\236\347\216\260\346\226\207\344\273\266\344\270\212\344\274\240.md" index dd0b576..b1f3081 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\246\202\344\275\225\345\256\236\347\216\260\346\226\207\344\273\266\344\270\212\344\274\240.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\246\202\344\275\225\345\256\236\347\216\260\346\226\207\344\273\266\344\270\212\344\274\240.md" @@ -2,7 +2,7 @@ -# Spring MVC ÎļþÉÏ´«¸ÅÊö +# Spring MVC 文件上传概述 @@ -13,11 +13,11 @@ -SpringÄÚÖöԶà·ÉÏ´«µÄÖ§³Ö£¬×¨ÃÅÓÃÓÚ´¦ÀíwebÓ¦ÓÃÖеÄÎļþÉÏ´«¡£Äã¿ÉÒÔͨ¹ý×¢²áÒ»¸ö¿É²å°ÎµÄ`MultipartResolver`¶ÔÏóÀ´ÆôÓöÔÎļþ¶à·ÉÏ´«µÄÖ§³Ö¡£¸Ã½Ó¿ÚÔÚ¶¨ÒåÓÚ`org.springframework.web.multipart`°üÏ¡£SpringΪ[_Ò»°ãµÄÎļþÉÏ´«_](http://jakarta.apache.org/commons/fileupload)ÌṩÁË`MultipartResolver`½Ó¿ÚµÄÒ»¸öʵÏÖ£¬ÎªServlet 3.0¶à·ÇëÇóµÄת»»ÌṩÁËÁíÒ»¸öʵÏÖ¡£ +Spring内置对多路上传的支æŒ�,专门用于处ç�†web应用中的文件上传。你å�¯ä»¥é€šè¿‡æ³¨å†Œä¸€ä¸ªå�¯æ�’拔的`MultipartResolver`对象æ�¥å�¯ç”¨å¯¹æ–‡ä»¶å¤šè·¯ä¸Šä¼ çš„æ”¯æŒ�。该接å�£åœ¨å®šä¹‰äºŽ`org.springframework.web.multipart`包下。Spring为[_一般的文件上传_](http://jakarta.apache.org/commons/fileupload)æ��供了`MultipartResolver`接å�£çš„一个实现,为Servlet 3.0多路请求的转æ�¢æ��供了å�¦ä¸€ä¸ªå®žçŽ°ã€‚
-ĬÈÏÇé¿öÏ£¬SpringµÄ¶à·ÉÏ´«Ö§³ÖÊDz»¿ªÆôµÄ£¬ÒòΪÓÐЩ¿ª·¢ÕßÏ£ÍûÓÉ×Ô¼ºÀ´´¦Àí¶à·ÇëÇó¡£Èç¹ûÏëÆôÓÃSpringµÄ¶à·ÉÏ´«Ö§³Ö£¬ÄãÐèÒªÔÚwebÓ¦ÓõÄÉÏÏÂÎÄÖÐÌí¼ÓÒ»¸ö¶à·´«Êä½âÎöÆ÷¡£Ã¿¸ö½øÀ´µÄÇëÇ󣬽âÎöÆ÷¶¼»á¼ì²éÊDz»ÊÇÒ»¸ö¶à²¿·ÖÇëÇó¡£Èô·¢ÏÖÇëÇóÊÇÍêÕûµÄ£¬ÔòÇëÇó°´Õý³£Á÷³Ì±»´¦Àí£»Èç¹û·¢ÏÖÇëÇóÊÇÒ»¸ö¶à·ÇëÇó£¬ÔòÄãÔÚÉÏÏÂÎÄÖÐ×¢²áµÄ`MultipartResolver`½âÎöÆ÷»á±»ÓÃÀ´´¦Àí¸ÃÇëÇó¡£Ö®ºó£¬ÇëÇóÖеĶà·ÉÏ´«ÊôÐÔ¾ÍÓëÆäËûÊôÐÔÒ»Ñù±»Õý³£¶Ô´ýÁË¡£¡¾×îºóÒ»¾ä·­µÄ²»ºÃ£¬multipart·­Òë³É¶à·»¹ÊǶಿ·Ö»¹ÔÚÕå×ÃÖС£ÍûÔĶÁÕß×¢Òâ´Ë´¦¡£¡¿ +默认情况下,Spring的多路上传支æŒ�是ä¸�å¼€å�¯çš„,因为有些开å�‘者希望由自己æ�¥å¤„ç�†å¤šè·¯è¯·æ±‚。如果想å�¯ç”¨Spring的多路上传支æŒ�,你需è¦�在web应用的上下文中添加一个多路传输解æž�器。æ¯�个进æ�¥çš„请求,解æž�器都会检查是ä¸�是一个多部分请求。若å�‘现请求是完整的,则请求按正常æµ�程被处ç�†ï¼›å¦‚æžœå�‘现请求是一个多路请求,则你在上下文中注册的`MultipartResolver`è§£æž�器会被用æ�¥å¤„ç�†è¯¥è¯·æ±‚。之å�Žï¼Œè¯·æ±‚中的多路上传属性就与其他属性一样被正常对待了。ã€�最å�Žä¸€å�¥ç¿»çš„ä¸�好,multipart翻译æˆ�多路还是多部分还在斟酌中。望阅读者注æ„�此处。】
@@ -27,11 +27,11 @@ Spring -# Spring MVC ʹÓÃMultipartResolverÓëCommons FileUpload´«ÊäÎļþ +# Spring MVC 使用MultipartResolver与Commons FileUpload传输文件 -2018-07-26 14:28 ¸üР+2018-07-26 14:28 æ›´æ–° @@ -39,23 +39,23 @@ Spring -ÏÂÃæµÄ´úÂëչʾÁËÈçºÎʹÓÃÒ»¸öͨÓõĶà·ÉÏ´«½âÎöÆ÷`CommonsMultipartResolver`£º +下é�¢çš„代ç �展示了如何使用一个通用的多路上传解æž�器`CommonsMultipartResolver`:
``` - + ``` -µ±È»£¬ÒªÈöà·½âÎöÆ÷Õý³£¹¤×÷£¬ÄãÐèÒªÔÚclasspath·¾¶ÏÂ×¼±¸±ØÐëµÄjar°ü¡£Èç¹ûʹÓõÄÊÇͨÓõĶà·ÉÏ´«½âÎöÆ÷`CommonsMultipartResolver`£¬ÄãËùÐèÒªµÄjar°üÊÇ`commons-fileupload.jar`¡£ +当然,è¦�让多路解æž�器正常工作,你需è¦�在classpath路径下准备必须的jar包。如果使用的是通用的多路上传解æž�器`CommonsMultipartResolver`,你所需è¦�çš„jar包是`commons-fileupload.jar`。 -µ±SpringµÄ`DispatcherServlet`¼ì²âµ½Ò»¸ö¶à²¿·ÖÇëÇóʱ£¬Ëü»á¼¤»îÄãÔÚÉÏÏÂÎÄÖÐÉùÃ÷µÄ¶à·½âÎöÆ÷²¢°ÑÇëÇ󽻸øËü¡£½âÎöÆ÷»á°Ñµ±Ç°µÄ`HttpServletRequest`ÇëÇó¶ÔÏó°ü×°³ÉÒ»¸öÖ§³Ö¶à·ÎļþÉÏ´«µÄÇëÇó¶ÔÏó`MultipartHttpServletRequest`¡£ÓÐÁË`MultipartHttpServletRequest`¶ÔÏó£¬Äã²»½ö¿ÉÒÔ»ñÈ¡¸Ã¶à·ÇëÇóÖеÄÐÅÏ¢£¬»¹¿ÉÒÔÔÚÄãµÄ¿ØÖÆÆ÷ÖлñµÃ¸Ã¶à·ÇëÇóµÄÄÚÈݱ¾Éí¡£ +当Springçš„`DispatcherServlet`检测到一个多部分请求时,它会激活你在上下文中声明的多路解æž�器并把请求交给它。解æž�器会把当å‰�çš„`HttpServletRequest`请求对象包装æˆ�一个支æŒ�多路文件上传的请求对象`MultipartHttpServletRequest`。有了`MultipartHttpServletRequest`对象,你ä¸�ä»…å�¯ä»¥èŽ·å�–该多路请求中的信æ�¯ï¼Œè¿˜å�¯ä»¥åœ¨ä½ çš„æŽ§åˆ¶å™¨ä¸­èŽ·å¾—è¯¥å¤šè·¯è¯·æ±‚çš„å†…å®¹æœ¬èº«ã€‚
@@ -65,11 +65,11 @@ Spring -# Spring MVC ´¦ÀíServlet 3.0ϵÄMultipartResolver +# Spring MVC 处ç�†Servlet 3.0下的MultipartResolver -2018-07-26 14:29 ¸üР+2018-07-26 14:29 æ›´æ–° @@ -77,11 +77,11 @@ Spring -ҪʹÓûùÓÚServlet 3.0µÄ¶à·´«Êäת»»¹¦ÄÜ£¬Äã±ØÐëÔÚ`web.xml`ÖÐΪ`DispatcherServlet`Ìí¼ÓÒ»¸ö`multipart-config`ÔªËØ£¬»òÕßͨ¹ýServlet±à³ÌµÄ·½·¨Ê¹ÓÃ`javax.servlet.MultipartConfigElement`½øÐÐ×¢²á£¬»òÄã×Ô¼º¶¨ÖÆÁË×Ô¼ºµÄServletÀ࣬ÄÇÄã±ØÐëʹÓÃ`javax.servlet.annotation.MultipartConfig`¶ÔÆä½øÐÐ×¢½â¡£ÆäËûÖîÈç×î´óÎļþ´óС»ò´æ´¢Î»ÖõÈÅäÖÃÑ¡Ïî¶¼±ØÐëÔÚÕâ¸öServlet¼¶±ð½øÐÐ×¢²á£¬ÒòΪServlet 3.0²»ÔÊÐíÔÚ½âÎöÆ÷MultipartResolverµÄ²ã¼¶ÅäÖÃÕâЩÐÅÏ¢¡£ +è¦�使用基于Servlet 3.0的多路传输转æ�¢åŠŸèƒ½ï¼Œä½ å¿…é¡»åœ¨`web.xml`中为`DispatcherServlet`添加一个`multipart-config`元素,或者通过Servlet编程的方法使用`javax.servlet.MultipartConfigElement`进行注册,或你自己定制了自己的Servlet类,那你必须使用`javax.servlet.annotation.MultipartConfig`对其进行注解。其他诸如最大文件大å°�或存储ä½�置等é…�置选项都必须在这个Servlet级别进行注册,因为Servlet 3.0ä¸�å…�许在解æž�器MultipartResolver的层级é…�置这些信æ�¯ã€‚
-µ±Äãͨ¹ýÒÔÉÏÈÎÒ»ÖÖ·½Ê½ÆôÓÃÁËServlet 3.0¶à·´«Êäת»»¹¦ÄÜ£¬Äã¾Í¿ÉÒÔ°ÑÒ»¸ö`StandardServletMultipartResolver`½âÎöÆ÷Ìí¼Óµ½ÄãµÄSpringÅäÖÃÖÐÈ¥ÁË£º +当你通过以上任一ç§�æ–¹å¼�å�¯ç”¨äº†Servlet 3.0多路传输转æ�¢åŠŸèƒ½ï¼Œä½ å°±å�¯ä»¥æŠŠä¸€ä¸ª`StandardServletMultipartResolver`è§£æž�器添加到你的Springé…�置中去了: ``` @@ -95,11 +95,11 @@ Spring -# Spring MVC ´¦Àí±íµ¥ÖеÄÎļþÉÏ´« +# Spring MVC 处ç�†è¡¨å�•中的文件上传 -2018-07-26 14:30 ¸üР+2018-07-26 14:30 æ›´æ–° @@ -107,7 +107,7 @@ Spring -µ±½âÎöÆ÷`MultipartResolver`Íê³É´¦Àíʱ£¬ÇëÇó±ã»áÏñÆäËûÇëÇóÒ»Ñù±»Õý³£Á÷³Ì´¦Àí¡£Ê×ÏÈ£¬´´½¨Ò»¸ö½ÓÊÜÎļþÉÏ´«µÄ±íµ¥½«ÔÊÐíÓÃÓÚÖ±½ÓÉÏ´«Õû¸ö±íµ¥¡£±àÂëÊôÐÔ£¨`enctype="multipart/form-data"`£©ÄÜÈÃä¯ÀÀÆ÷ÖªµÀÈçºÎ¶Ô¶à·ÉÏ´«ÇëÇóµÄ±íµ¥½øÐбàÂ루encode£©¡£ +当解æž�器`MultipartResolver`完æˆ�处ç�†æ—¶ï¼Œè¯·æ±‚便会åƒ�其他请求一样被正常æµ�程处ç�†ã€‚首先,创建一个接å�—文件上传的表å�•å°†å…�许用于直接上传整个表å�•。编ç �属性(`enctype="multipart/form-data"`)能让æµ�览器知é�“如何对多路上传请求的表å�•进行编ç �(encode)。
@@ -128,7 +128,7 @@ Spring ``` -ÏÂÒ»²½ÊÇ´´½¨Ò»¸öÄÜ´¦ÀíÎļþÉÏ´«µÄ¿ØÖÆÆ÷¡£ÕâÀïÐèÒªµÄ¿ØÖÆÆ÷Óë[Ò»°ã×¢½âÁË`@Controller`µÄ¿ØÖÆÆ÷](http://docs.spring.io/spring-framework/docs/4.2.4.RELEASE/spring-framework-reference/html/mvc.html#mvc-ann-controller)»ù±¾Ò»Ñù£¬³ýÁËËü½ÓÊܵķ½·¨²ÎÊýÀàÐÍÊÇ`MultipartHttpServletRequest`£¬»ò`MultipartFile`¡£ +下一步是创建一个能处ç�†æ–‡ä»¶ä¸Šä¼ çš„æŽ§åˆ¶å™¨ã€‚这里需è¦�的控制器与[一般注解了`@Controller`的控制器](http://docs.spring.io/spring-framework/docs/4.2.4.RELEASE/spring-framework-reference/html/mvc.html#mvc-ann-controller)基本一样,除了它接å�—的方法å�‚数类型是`MultipartHttpServletRequest`,或`MultipartFile`。 ``` @Controller @@ -150,9 +150,9 @@ public class FileUploadController { ``` -ÇëÁôÒâ`@RequestParam`×¢½âÊÇÈçºÎ½«·½·¨²ÎÊý¶ÔÓ¦µ½±íµ¥Öе͍ÒåµÄÊäÈë×ֶεġ£ÔÚÉÏÃæµÄÀý×ÓÖУ¬ÎÒÃÇÄõ½ÁË`byte[]`ÎļþÊý¾Ý£¬Ö»ÊÇû¶ÔËü×öÈκÎÊ¡£ÔÚʵ¼ÊÓ¦ÓÃÖУ¬Äã¿ÉÄܻὫËü±£´æµ½Êý¾Ý¿â¡¢´æ´¢ÔÚÎļþϵͳÉÏ£¬»ò×öÆäËûµÄ´¦Àí¡£ +请留æ„�`@RequestParam`注解是如何将方法å�‚数对应到表å�•中的定义的输入字段的。在上é�¢çš„例å­�中,我们拿到了`byte[]`文件数æ�®ï¼Œå�ªæ˜¯æ²¡å¯¹å®ƒå�šä»»ä½•事。在实际应用中,你å�¯èƒ½ä¼šå°†å®ƒä¿�存到数æ�®åº“ã€�存储在文件系统上,或å�šå…¶ä»–的处ç�†ã€‚ -µ±Ê¹ÓÃServlet 3.0µÄ¶à·´«Êäת»»Ê±£¬ÄãÒ²¿ÉÒÔʹÓÃ`javax.servlet.http.Part`×÷Ϊ·½·¨²ÎÊý£º +当使用Servlet 3.0的多路传输转æ�¢æ—¶ï¼Œä½ ä¹Ÿå�¯ä»¥ä½¿ç”¨`javax.servlet.http.Part`作为方法å�‚数: ``` @Controller @@ -178,11 +178,11 @@ public class FileUploadController { -# Spring MVC ´¦Àí¿Í»§¶Ë·¢ÆðµÄÎļþÉÏ´«ÇëÇó +# Spring MVC 处ç�†å®¢æˆ·ç«¯å�‘起的文件上传请求 -2018-07-26 14:30 ¸üР+2018-07-26 14:30 æ›´æ–° @@ -190,7 +190,7 @@ public class FileUploadController { -ÔÚʹÓÃÁËRESTful·þÎñµÄ³¡¾°Ï£¬·Çä¯ÀÀÆ÷µÄ¿Í»§¶ËÒ²¿ÉÒÔÖ±½ÓÌá½»¶à·ÎļþÇëÇó¡£ÉÏÒ»½Ú½²ÊöµÄËùÓÐÀý×ÓÓëÅäÖÃÔÚÕâÀïÒ²¶¼Í¬ÑùÊÊÓᣵ«Óëä¯ÀÀÆ÷²»Í¬µÄÊÇ£¬Ìá½»µÄÎļþºÍ¼òµ¥µÄ±íµ¥×ֶΣ¬¿Í»§¶Ë·¢Ë͵ÄÊý¾Ý¿ÉÒÔ¸ü¼Ó¸´ÔÓ£¬Êý¾Ý¿ÉÒÔÖ¸¶¨ÎªÄ³ÖÖÌØ¶¨µÄÄÚÈÝÀàÐÍ£¨content type£©¡ª¡ª±ÈÈ磬һ¸ö¶à·ÉÏ´«ÇëÇó¿ÉÄܵÚÒ»²¿·ÖÊǸöÎļþ£¬¶øµÚ¶þ²¿·ÖÊǸöJSON¸ñʽµÄÊý¾Ý£º +在使用了RESTfulæœ�务的场景下,é�žæµ�览器的客户端也å�¯ä»¥ç›´æŽ¥æ��交多路文件请求。上一节讲述的所有例å­�与é…�置在这里也都å�Œæ ·é€‚用。但与æµ�览器ä¸�å�Œçš„æ˜¯ï¼Œæ��交的文件和简å�•的表å�•字段,客户端å�‘é€�的数æ�®å�¯ä»¥æ›´åŠ å¤�æ�‚,数æ�®å�¯ä»¥æŒ‡å®šä¸ºæŸ�ç§�特定的内容类型(content type)——比如,一个多路上传请求å�¯èƒ½ç¬¬ä¸€éƒ¨åˆ†æ˜¯ä¸ªæ–‡ä»¶ï¼Œè€Œç¬¬äºŒéƒ¨åˆ†æ˜¯ä¸ªJSONæ ¼å¼�的数æ�®ï¼š
@@ -214,9 +214,9 @@ public class FileUploadController { ``` -¶ÔÓÚÃû³ÆÎª`meta-data`µÄ²¿·Ö£¬Äã¿ÉÒÔͨ¹ý¿ØÖÆÆ÷·½·¨ÉϵÄ`@RequestParam("meta-data") String metadata`²ÎÊýÀ´»ñµÃ¡£µ«¶ÔÓÚÄDz¿·ÖÇëÇóÌåÖÐΪJSON¸ñʽÊý¾ÝµÄÇëÇó£¬Äã¿ÉÄܸüÏëͨ¹ý½ÓÊÜÒ»¸ö¶ÔÓ¦µÄÇ¿ÀàÐͶÔÏ󣬾ÍÏñ`@RequestBody`ͨ¹ý`HttpMessageConverter`½«Ò»°ãÇëÇóµÄÇëÇóÌåת»»³ÉÒ»¸ö¶ÔÏóÒ»Ñù¡£ +对于å��称为`meta-data`的部分,你å�¯ä»¥é€šè¿‡æŽ§åˆ¶å™¨æ–¹æ³•上的`@RequestParam("meta-data") String metadata`å�‚æ•°æ�¥èŽ·å¾—ã€‚ä½†å¯¹äºŽé‚£éƒ¨åˆ†è¯·æ±‚ä½“ä¸­ä¸ºJSONæ ¼å¼�æ•°æ�®çš„请求,你å�¯èƒ½æ›´æƒ³é€šè¿‡æŽ¥å�—一个对应的强类型对象,就åƒ�`@RequestBody`通过`HttpMessageConverter`将一般请求的请求体转æ�¢æˆ�一个对象一样。 -ÕâÊÇ¿ÉÄܵģ¬Äã¿ÉÒÔʹÓÃ`@RequestPart`×¢½âÀ´ÊµÏÖ£¬¶ø·Ç`@RequestParam`¡£¸Ã×¢½â½«Ê¹µÃÌØ¶¨¶à·ÇëÇóµÄÇëÇóÌå±»´«¸ø`HttpMessageConverter`£¬²¢ÇÒÔÚת»»Ê±¿¼ÂǶà·ÇëÇóÖв»Í¬µÄÄÚÈÝÀàÐͲÎÊý`'Content-Type'`£º +这是å�¯èƒ½çš„,你å�¯ä»¥ä½¿ç”¨`@RequestPart`注解æ�¥å®žçŽ°ï¼Œè€Œé�ž`@RequestParam`。该注解将使得特定多路请求的请求体被传给`HttpMessageConverter`,并且在转æ�¢æ—¶è€ƒè™‘多路请求中ä¸�å�Œçš„内容类型å�‚æ•°`'Content-Type'`: ``` @RequestMapping(path = "/someUrl", method = RequestMethod.POST) @@ -228,7 +228,7 @@ public String onSubmit(@RequestPart("meta-data") MetaData metadata, @RequestPart ``` -Çë×¢Òâ`MultipartFile`·½·¨²ÎÊýÊÇÈçºÎÄܹ»ÔÚ`@RequestParam`»ò`@RequestPart`×¢½âÏ»¥Óõģ¬Á½ÖÖ·½·¨¶¼ÄÜÄõ½Êý¾Ý¡£µ«£¬ÕâÀïµÄ·½·¨²ÎÊý`@RequestPart("meta-data") MetaData`Ôò»áÒòΪÇëÇóÖеÄÄÚÈÝÀàÐÍÇëÇóÍ·`'Content-Type'`±»¶ÁÈë³ÉΪJSONÊý¾Ý£¬È»ºóÔÙͨ¹ý`MappingJackson2HttpMessageConverter`±»×ª»»³ÉÌØ¶¨µÄ¶ÔÏó¡£ +请注æ„�`MultipartFile`方法å�‚数是如何能够在`@RequestParam`或`@RequestPart`注解下互用的,两ç§�方法都能拿到数æ�®ã€‚但,这里的方法å�‚æ•°`@RequestPart("meta-data") MetaData`则会因为请求中的内容类型请求头`'Content-Type'`被读入æˆ�为JSONæ•°æ�®ï¼Œç„¶å�Žå†�通过`MappingJackson2HttpMessageConverter`被转æ�¢æˆ�特定的对象。
diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\270\270\350\247\201\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\270\270\350\247\201\346\263\250\350\247\243.md" index 6bd5272..5a32d9f 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\270\270\350\247\201\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC/SpringMVC\345\270\270\350\247\201\346\263\250\350\247\243.md" @@ -1,17 +1,17 @@ -## 1. ¸ÅÊö - ÔÚ±¾½Ì³ÌÖУ¬ÎÒÃǽ«Ì½Ë÷ org.springframework.web.bind.annotation °üÖÐµÄ Spring Web ×¢ÊÍ¡£ +## 1. 概述 + 在本教程中,我们将探索 org.springframework.web.bind.annotation 包中的 Spring Web 注释。 ## 2. @RequestMapping -¼òµ¥µØËµ£¬@RequestMapping ±ê¼Ç@Controller ÀàÄÚ²¿µÄÇëÇó´¦Àí³ÌÐò·½·¨£» Ëü¿ÉÒÔʹÓÃÅäÖ㺠+简å�•地说,@RequestMapping 标记@Controller 类内部的请求处ç�†ç¨‹åº�方法; 它å�¯ä»¥ä½¿ç”¨é…�置: -·¾¶£¬»òÆä±ðÃû¡¢Ãû³ÆºÍÖµ£º·½·¨Ó³Éäµ½Äĸö URL -·½·¨£º¼æÈÝµÄ HTTP ·½·¨ -params£º¸ù¾Ý HTTP ²ÎÊýµÄ´æÔÚ¡¢²»´æÔÚ»òÖµ¹ýÂËÇëÇó -headers£º¸ù¾Ý HTTP ±êÍ·µÄ´æÔÚ¡¢²»´æÔÚ»òÖµ¹ýÂËÇëÇó -ÏûºÄ£º¸Ã·½·¨¿ÉÒÔÔÚ HTTP ÇëÇóÕýÎÄÖÐÏûºÄÄÄЩýÌåÀàÐÍ -produces£º¸Ã·½·¨¿ÉÒÔÔÚ HTTP ÏìÓ¦ÕýÎÄÖÐÉú³ÉÄÄЩýÌåÀàÐÍ -ÕâÊÇÒ»¸ö¼òµ¥µÄʾÀý£º +路径,或其别å��ã€�å��称和值:方法映射到哪个 URL +方法:兼容的 HTTP 方法 +params:根æ�® HTTP å�‚数的存在ã€�ä¸�存在或值过滤请求 +headers:根æ�® HTTP 标头的存在ã€�ä¸�存在或值过滤请求 +消耗:该方法å�¯ä»¥åœ¨ HTTP 请求正文中消耗哪些媒体类型 +produces:该方法å�¯ä»¥åœ¨ HTTP å“�应正文中生æˆ�哪些媒体类型 +这是一个简å�•的示例: ```` @Controller @@ -23,9 +23,9 @@ class VehicleController { } } ```` -Èç¹ûÎÒÃÇÔÚÀ༶±ðÓ¦ÓôË×¢ÊÍ£¬ÎÒÃÇ¿ÉÒÔΪ @Controller ÀàÖеÄËùÓд¦Àí³ÌÐò·½·¨ÌṩĬÈÏÉèÖᣠΨһµÄÀýÍâÊÇ Spring ²»»áʹÓ÷½·¨¼¶±ðÉèÖø²¸Çµ«»á¸½¼ÓÁ½¸ö·¾¶²¿·ÖµÄ URL¡£ +如果我们在类级别应用此注释,我们å�¯ä»¥ä¸º @Controller 类中的所有处ç�†ç¨‹åº�方法æ��供默认设置。 唯一的例外是 Spring ä¸�会使用方法级别设置覆盖但会附加两个路径部分的 URL。 -ÀýÈ磬ÏÂÃæµÄÅäÖúÍÉÏÃæµÄЧ¹ûÊÇÒ»ÑùµÄ£º +例如,下é�¢çš„é…�置和上é�¢çš„æ•ˆæžœæ˜¯ä¸€æ ·çš„: ```` @Controller @@ -39,13 +39,13 @@ class VehicleController { } ```` -´ËÍ⣬@GetMapping¡¢@PostMapping¡¢@PutMapping¡¢@DeleteMapping ºÍ@PatchMapping ÊÇ@RequestMapping µÄ²»Í¬±äÌ壬ÆäHTTP ·½·¨ÒÑ·Ö±ðÉèÖÃΪGET¡¢POST¡¢PUT¡¢DELETE ºÍPATCH¡£ +此外,@GetMappingã€�@PostMappingã€�@PutMappingã€�@DeleteMapping å’Œ@PatchMapping 是@RequestMapping çš„ä¸�å�Œå�˜ä½“,其HTTP 方法已分别设置为GETã€�POSTã€�PUTã€�DELETE å’ŒPATCH。 -ÕâЩ´Ó Spring 4.3 °æ±¾¿ªÊ¼¿ÉÓᣠ+这些从 Spring 4.3 版本开始å�¯ç”¨ã€‚ ## 3 @RequestBody -ÈÃÎÒÃǼÌÐø@RequestBody¡ª¡ªËü½« HTTP ÇëÇóµÄÖ÷ÌåÓ³Éäµ½Ò»¸ö¶ÔÏó£º +让我们继续@RequestBody——它将 HTTP 请求的主体映射到一个对象: ```` @PostMapping("/save") @@ -53,14 +53,14 @@ void saveVehicle(@RequestBody Vehicle vehicle) { // ... } ```` -·´ÐòÁл¯ÊÇ×Ô¶¯µÄ£¬È¡¾öÓÚÇëÇóµÄÄÚÈÝÀàÐÍ¡£ +å��åº�列化是自动的,å�–决于请求的内容类型。 ## 4 @PathVariable -½ÓÏÂÀ´ËµËµ@PathVariable¡£ +接下æ�¥è¯´è¯´@PathVariable。 -´Ë×¢ÊÍָʾ·½·¨²ÎÊý°ó¶¨µ½ URI Ä£°å±äÁ¿¡£ ÎÒÃÇ¿ÉÒÔʹÓà @RequestMapping ×¢ÊÍÖ¸¶¨ URI Ä£°å£¬²¢Ê¹Óà @PathVariable ½«·½·¨²ÎÊý°ó¶¨µ½Ä£°å²¿·ÖÖ®Ò»¡£ +此注释指示方法å�‚数绑定到 URI 模æ�¿å�˜é‡�。 我们å�¯ä»¥ä½¿ç”¨ @RequestMapping 注释指定 URI 模æ�¿ï¼Œå¹¶ä½¿ç”¨ @PathVariable 将方法å�‚数绑定到模æ�¿éƒ¨åˆ†ä¹‹ä¸€ã€‚ -ÎÒÃÇ¿ÉÒÔʹÓÃÃû³Æ»òÆä±ðÃû£¬¼´Öµ²ÎÊýÀ´ÊµÏÖÕâÒ»µã£º +我们å�¯ä»¥ä½¿ç”¨å��称或其别å��,å�³å€¼å�‚æ•°æ�¥å®žçŽ°è¿™ä¸€ç‚¹ï¼š ```` @RequestMapping("/{id}") @@ -68,7 +68,7 @@ Vehicle getVehicle(@PathVariable("id") long id) { // ... } ```` -Èç¹ûÄ£°åÖв¿·ÖµÄÃû³ÆÓë·½·¨²ÎÊýµÄÃû³ÆÏàÆ¥Å䣬ÎÒÃǾͲ»±ØÔÚ×¢ÊÍÖÐÖ¸¶¨Ëü£º +如果模æ�¿ä¸­éƒ¨åˆ†çš„å��称与方法å�‚æ•°çš„å��称相匹é…�,我们就ä¸�必在注释中指定它: ```` @RequestMapping("/{id}") @@ -76,7 +76,7 @@ Vehicle getVehicle(@PathVariable long id) { // ... } ```` -´ËÍ⣬ÎÒÃÇ¿ÉÒÔͨ¹ý½«ËùÐèµÄ²ÎÊýÉèÖÃΪ false À´½«Â·¾¶±äÁ¿±ê¼ÇΪ¿ÉÑ¡£º +此外,我们å�¯ä»¥é€šè¿‡å°†æ‰€éœ€çš„å�‚数设置为 false æ�¥å°†è·¯å¾„å�˜é‡�标记为å�¯é€‰ï¼š ```` @RequestMapping("/{id}") @@ -92,27 +92,27 @@ Vehicle getVehicleByParam(@RequestParam("id") long id) { // ... } ```` -Ëü¾ßÓÐÓë @PathVariable ×¢ÊÍÏàͬµÄÅäÖÃÑ¡Ïî¡£ +它具有与 @PathVariable 注释相å�Œçš„é…�置选项。 -³ýÁËÕâЩÉèÖÃÖ®Í⣬µ± Spring ÔÚÇëÇóÖз¢ÏÖûÓÐÖµ»òΪ¿Õֵʱ£¬ÎÒÃÇ¿ÉÒÔʹÓà @RequestParam Ö¸¶¨×¢ÈëÖµ¡£ Ϊ´Ë£¬ÎÒÃDZØÐëÉèÖà defaultValue ²ÎÊý¡£ +除了这些设置之外,当 Spring 在请求中å�‘现没有值或为空值时,我们å�¯ä»¥ä½¿ç”¨ @RequestParam 指定注入值。 为此,我们必须设置 defaultValue å�‚数。 -ÌṩĬÈÏÖµÒþʽÉèÖà required Ϊ false£º +æ��供默认值éš�å¼�设置 required 为 false: ```` @RequestMapping("/buy") Car buyCar(@RequestParam(defaultValue = "5") int seatCount) { // ... } ```` -³ýÁ˲ÎÊýÖ®Í⣬ÎÒÃÇ»¹¿ÉÒÔ·ÃÎÊÆäËû HTTP ÇëÇ󲿷֣ºcookie ºÍ±êÍ·¡£ +除了å�‚数之外,我们还å�¯ä»¥è®¿é—®å…¶ä»– HTTP 请求部分:cookie 和标头。 -ÎÒÃÇ¿ÉÒÔ·Ö±ðʹÓÃ×¢½â@CookieValue ºÍ@RequestHeader À´·ÃÎÊËüÃÇ¡£ +我们å�¯ä»¥åˆ†åˆ«ä½¿ç”¨æ³¨è§£@CookieValue å’Œ@RequestHeader æ�¥è®¿é—®å®ƒä»¬ã€‚ ## 6. Response Handling Annotations -ÔÚ½ÓÏÂÀ´µÄ²¿·ÖÖУ¬ÎÒÃǽ«¿´µ½ÔÚ Spring MVC ÖвÙ×÷ HTTP ÏìÓ¦µÄ×î³£¼û×¢ÊÍ¡£ +在接下æ�¥çš„部分中,我们将看到在 Spring MVC 中æ“�作 HTTP å“�应的最常è§�注释。 ### 6.1 @ResponseBody -Èç¹ûÎÒÃÇÓÃ@ResponseBody ±ê¼ÇÇëÇó´¦Àí³ÌÐò·½·¨£¬Spring »á½«·½·¨µÄ½á¹ûÊÓΪÏìÓ¦±¾Éí£º +如果我们用@ResponseBody 标记请求处ç�†ç¨‹åº�方法,Spring 会将方法的结果视为å“�应本身: ```` @ResponseBody @@ -121,13 +121,13 @@ String hello() { return "Hello World!"; } ```` -Èç¹ûÎÒÃÇÓÃÕâ¸ö×¢½âÀ´×¢½â @Controller À࣬ËùÓÐÇëÇó´¦Àí³ÌÐò·½·¨¶¼½«Ê¹ÓÃËü¡£ +如果我们用这个注解æ�¥æ³¨è§£ @Controller 类,所有请求处ç�†ç¨‹åº�方法都将使用它。 ### 6.2 @ExceptionHandler -ʹÓôË×¢ÊÍ£¬ÎÒÃÇ¿ÉÒÔÉùÃ÷Ò»¸ö×Ô¶¨Òå´íÎó´¦Àí³ÌÐò·½·¨¡£ µ±ÇëÇó´¦Àí³ÌÐò·½·¨Å׳öÈκÎÖ¸¶¨µÄÒ쳣ʱ£¬Spring µ÷Óô˷½·¨¡£ +使用此注释,我们å�¯ä»¥å£°æ˜Žä¸€ä¸ªè‡ªå®šä¹‰é”™è¯¯å¤„ç�†ç¨‹åº�方法。 当请求处ç�†ç¨‹åº�方法抛出任何指定的异常时,Spring 调用此方法。 -²¶»ñµÄÒì³£¿ÉÒÔ×÷Ϊ²ÎÊý´«µÝ¸ø·½·¨£º +æ�•获的异常å�¯ä»¥ä½œä¸ºå�‚数传递给方法: ```` @ExceptionHandler(IllegalArgumentException.class) void onIllegalArgumentException(IllegalArgumentException exception) { @@ -136,11 +136,11 @@ void onIllegalArgumentException(IllegalArgumentException exception) { ```` ### 6.3 @ResponseStatus -Èç¹ûÎÒÃÇʹÓôË×¢ÊͶÔÇëÇó´¦Àí³ÌÐò·½·¨½øÐÐ×¢ÊÍ£¬Ôò¿ÉÒÔÖ¸¶¨ÏìÓ¦µÄËùÐè HTTP ״̬¡£ ÎÒÃÇ¿ÉÒÔʹÓà code ²ÎÊý»òÆä±ðÃû value ²ÎÊýÀ´ÉùÃ÷״̬´úÂë¡£ +如果我们使用此注释对请求处ç�†ç¨‹åº�方法进行注释,则å�¯ä»¥æŒ‡å®šå“�应的所需 HTTP 状æ€�。 我们å�¯ä»¥ä½¿ç”¨ code å�‚数或其别å�� value å�‚æ•°æ�¥å£°æ˜Žçжæ€�代ç �。 -´ËÍ⣬ÎÒÃÇ¿ÉÒÔʹÓà reason ²ÎÊýÌṩԭÒò¡£ +此外,我们å�¯ä»¥ä½¿ç”¨ reason å�‚æ•°æ��供原因。 -ÎÒÃÇÒ²¿ÉÒÔ½«ËüÓë@ExceptionHandler Ò»ÆðʹÓ㺠+我们也å�¯ä»¥å°†å®ƒä¸Ž@ExceptionHandler 一起使用: @ExceptionHandler(IllegalArgumentException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) @@ -148,18 +148,18 @@ void onIllegalArgumentException(IllegalArgumentException exception) { // ... } -ÓÐ¹Ø HTTP ÏìӦ״̬µÄ¸ü¶àÐÅÏ¢£¬Çë·ÃÎʱ¾ÎÄ¡£ +有关 HTTP å“�应状æ€�的更多信æ�¯ï¼Œè¯·è®¿é—®æœ¬æ–‡ã€‚ -## 7 ÆäËû Web×¢½â -һЩעÊͲ»Ö±½Ó¹ÜÀí HTTP ÇëÇó»òÏìÓ¦¡£ ÔÚ½ÓÏÂÀ´µÄ²¿·ÖÖУ¬ÎÒÃǽ«½éÉÜ×î³£¼ûµÄ¡£ +## 7 å…¶ä»– Web注解 +一些注释ä¸�直接管ç�† HTTP 请求或å“�应。 在接下æ�¥çš„部分中,我们将介ç»�最常è§�的。 ### 7.1 @Controller -ÎÒÃÇ¿ÉÒÔʹÓÃ@Controller ¶¨ÒåÒ»¸öSpring MVC ¿ØÖÆÆ÷¡£ Óйظü¶àÐÅÏ¢£¬Çë·ÃÎÊÎÒÃǹØÓÚ Spring Bean Annotations µÄÎÄÕ¡£ +我们å�¯ä»¥ä½¿ç”¨@Controller 定义一个Spring MVC 控制器。 有关更多信æ�¯ï¼Œè¯·è®¿é—®æˆ‘们关于 Spring Bean Annotations 的文章。 ### 7.2 @RestController -@RestController ½áºÏÁË@Controller ºÍ@ResponseBody¡£ +@RestController 结å�ˆäº†@Controller å’Œ@ResponseBody。 -Òò´Ë£¬ÒÔÏÂÉùÃ÷ÊǵÈЧµÄ£º +因此,以下声明是等效的: ```` @Controller @@ -176,7 +176,7 @@ class VehicleRestController { } ```` ### 7.3 @ModelAttribute -ͨ¹ýÕâ¸ö×¢½â£¬ÎÒÃÇ¿ÉÒÔͨ¹ýÌṩģÐͼüÀ´·ÃÎÊÒѾ­´æÔÚÓÚ MVC @Controller Ä£ÐÍÖеÄÔªËØ£º +通过这个注解,我们å�¯ä»¥é€šè¿‡æ��供模型键æ�¥è®¿é—®å·²ç»�存在于 MVC @Controller 模型中的元素: ```` @PostMapping("/assemble") @@ -184,7 +184,7 @@ void assembleVehicle(@ModelAttribute("vehicle") Vehicle vehicleInModel) { // ... } ```` -Óë@PathVariable ºÍ@RequestParam Ò»Ñù£¬Èç¹û²ÎÊý¾ßÓÐÏàͬµÄÃû³Æ£¬ÎÒÃDz»±ØÖ¸¶¨Ä£Ðͼü£º +与@PathVariable å’Œ@RequestParam 一样,如果å�‚数具有相å�Œçš„å��称,我们ä¸�必指定模型键: ```` @PostMapping("/assemble") @@ -192,7 +192,7 @@ void assembleVehicle(@ModelAttribute Vehicle vehicle) { // ... } ```` -´ËÍ⣬@ModelAttribute»¹ÓÐÒ»¸öÓÃ;£ºÈç¹ûÎÒÃÇÓÃËü×¢½âÒ»¸ö·½·¨£¬Spring»á×Ô¶¯½«·½·¨µÄ·µ»ØÖµÌí¼Óµ½Ä£ÐÍÖУº +此外,@ModelAttribute还有一个用途:如果我们用它注解一个方法,Spring会自动将方法的返回值添加到模型中: ```` @ModelAttribute("vehicle") @@ -200,19 +200,19 @@ Vehicle getVehicle() { // ... } ```` -ºÍÒÔǰһÑù£¬ÎÒÃDz»±ØÖ¸¶¨Ä£Ðͼü£¬Spring ĬÈÏʹÓ÷½·¨µÄÃû³Æ£º +和以å‰�一样,我们ä¸�必指定模型键,Spring 默认使用方法的å��称: ```` @ModelAttribute Vehicle vehicle() { // ... } ```` -ÔÚ Spring µ÷ÓÃÇëÇó´¦Àí³ÌÐò·½·¨Ö®Ç°£¬Ëü»áµ÷ÓÃÀàÖÐËùÓÐ @ModelAttribute ×¢Ê͵ķ½·¨¡£ +在 Spring 调用请求处ç�†ç¨‹åº�方法之å‰�,它会调用类中所有 @ModelAttribute 注释的方法。 -ÓÐ¹Ø @ModelAttribute µÄ¸ü¶àÐÅÏ¢£¬Çë²ÎÔı¾ÎÄ¡£ +有关 @ModelAttribute 的更多信æ�¯ï¼Œè¯·å�‚阅本文。 ### 7.4 @CrossOrigin -@CrossOrigin Ϊ´ø×¢Ê͵ÄÇëÇó´¦Àí³ÌÐò·½·¨ÆôÓÿçÓòͨÐÅ£º +@CrossOrigin 为带注释的请求处ç�†ç¨‹åº�方法å�¯ç”¨è·¨åŸŸé€šä¿¡ï¼š ```` @CrossOrigin @@ -221,12 +221,12 @@ String hello() { return "Hello World!"; } ```` -Èç¹ûÎÒÃÇÓÃËü±ê¼ÇÒ»¸öÀ࣬ËüÊÊÓÃÓÚÆäÖеÄËùÓÐÇëÇó´¦Àí³ÌÐò·½·¨¡£ +如果我们用它标记一个类,它适用于其中的所有请求处ç�†ç¨‹åº�方法。 -ÎÒÃÇ¿ÉÒÔʹÓôË×¢Ê͵IJÎÊý΢µ÷ CORS ÐÐΪ¡£ +我们å�¯ä»¥ä½¿ç”¨æ­¤æ³¨é‡Šçš„å�‚数微调 CORS 行为。 -ÓйØÏêϸÐÅÏ¢£¬Çë·ÃÎʱ¾ÎÄ¡£ +有关详细信æ�¯ï¼Œè¯·è®¿é—®æœ¬æ–‡ã€‚ -# ²Î¿¼ÎÄÕ +# å�‚考文章 https://www.baeldung.com/spring-annotations diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/DispatcherServlet\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/DispatcherServlet\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" index 4ffcaa6..bf2a807 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/DispatcherServlet\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/DispatcherServlet\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" @@ -1,21 +1,21 @@ -ÔÚ[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4696657 "ÉÏһƪÎÄÕÂ")ÖУ¬ÎÒÃÇͨ¹ýÒ»¸ö¼òµ¥µÄ demo ³É¹¦Æô¶¯ÁË springmvc Ó¦Óã¬ÔÚÌṩµÄ demo ÖУ¬ÎÒÃÇÖªµÀ tomcat ÔÚÆô¶¯Ê±»áµ÷Óà `MyWebApplicationInitializer#onStartup` ·½·¨£¬È»ºóÆô¶¯ spring ÈÝÆ÷¡£ÄÇô tomcat ¾¿¾¹ÊÇÈçºÎÆô¶¯ spring µÄÄØ£¿ +在[上一篇文章](https://my.oschina.net/funcy/blog/4696657 "上一篇文章")中,我们通过一个简å�•çš„ demo æˆ�功å�¯åŠ¨äº† springmvc 应用,在æ��供的 demo 中,我们知é�“ tomcat 在å�¯åŠ¨æ—¶ä¼šè°ƒç”¨ `MyWebApplicationInitializer#onStartup` 方法,然å�Žå�¯åЍ spring 容器。那么 tomcat 究竟是如何å�¯åЍ spring 的呢? -### 1\. servlet ³õʼ»¯£º`DispatcherServlet#init` +### 1\. servlet åˆ�始化:`DispatcherServlet#init` -ÎÒÃÇÔÙ»ØÒäÏ `MyWebApplicationInitializer#onStartup` ·½·¨£º +我们å†�回忆下 `MyWebApplicationInitializer#onStartup` 方法: ``` @Override public void onStartup(ServletContext servletContext) { System.out.println("webApplicationInitializer ..."); - // ´´½¨ spring µÄ applicationContext + // 创建 spring çš„ applicationContext AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext(); context.register(MvcConfig.class); - // ʵÀý»¯ DispatcherServlet + // 实例化 DispatcherServlet DispatcherServlet servlet = new DispatcherServlet(context); - // ½«DispatcherServlet×¢²áµ½servletÈÝÆ÷ + // å°†DispatcherServlet注册到servlet容器 ServletRegistration.Dynamic registration = servletContext.addServlet("app", servlet); registration.setLoadOnStartup(1); registration.addMapping("/*"); @@ -23,15 +23,15 @@ public void onStartup(ServletContext servletContext) { ``` -Õâ¶Î´úÂëÏÈ×¼±¸ÁËÒ»¸ö `AnnotationConfigWebApplicationContext`£¬½«Æä×÷Ϊ²ÎÊý´«Èë `DispatcherServlet` ÖУ¬È»ºóÍù servlet ÈÝÆ÷ÖÐÌí¼Ó `DispatcherServlet`¡£ÕâÑù£¬servlet ÈÝÆ÷ÔÚÆô¶¯Ê±£¬¾Í»áÆô¶¯ spring ÈÝÆ÷ÁË¡£ÕâÀï×îÖØÒªµÄ¾ÍÊÇ `DispatcherServlet`£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÕâ¸ö servlet. +这段代ç �先准备了一个 `AnnotationConfigWebApplicationContext`,将其作为å�‚æ•°ä¼ å…¥ `DispatcherServlet` 中,然å�Žå¾€ servlet 容器中添加 `DispatcherServlet`。这样,servlet 容器在å�¯åŠ¨æ—¶ï¼Œå°±ä¼šå�¯åЍ spring 容器了。这里最é‡�è¦�的就是 `DispatcherServlet`,接下æ�¥æˆ‘们就æ�¥åˆ†æž�这个 servlet. -ÎÒÃÇÏÈÀ´¿´Ï `DispatcherServlet` µÄ¼Ì³Ð½á¹¹£º +我们先æ�¥çœ‹ä¸‹ `DispatcherServlet` 的继承结构: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1df54493011b3fc9cb9cafbb944f1a88256.png) -´ÓÉÏͼ¿ÉÒÔ¿´µ½£¬spring ÌṩµÄ¡¢¸ú servlet Ïà¹ØµÄÀàÓÐÈý¸ö£º`HttpServletBean`¡¢`FrameworkServlet` Óë `DispatcherServlet`¡£×÷Ϊ servlet£¬ÎÒÃÇÖªµÀÆä³õʼ»¯·½·¨Îª `GenericServlet#init()`£¬Ò²¾ÍÊÇ servlet µÄÈë¿Ú·½·¨£¬ÎÒÃǵķÖÎöÒ²½«´ÓÕâÀ↑ʼ¡£ +从上图å�¯ä»¥çœ‹åˆ°ï¼Œspring æ��供的ã€�è·Ÿ servlet 相关的类有三个:`HttpServletBean`ã€�`FrameworkServlet` 与 `DispatcherServlet`。作为 servlet,我们知é�“å…¶åˆ�始化方法为 `GenericServlet#init()`,也就是 servlet 的入å�£æ–¹æ³•,我们的分æž�也将从这里开始。 -ÓÉÓÚ `DispatcherServlet` ʵÏÖÁË `HttpServletBean`¡¢`FrameworkServlet`£¬`DispatcherServlet#init()` ʵ¼ÊÉϼ̳Ð×Ô `HttpServletBean#init`£º +由于 `DispatcherServlet` 实现了 `HttpServletBean`ã€�`FrameworkServlet`,`DispatcherServlet#init()` 实际上继承自 `HttpServletBean#init`: ``` @Override @@ -51,13 +51,13 @@ public final void init() throws ServletException { } } - // ³õʼ»¯ servlet bean£¬springµÄÏà¹ØÅäÖþÍÊÇÔÚÕâÀï½øÐÐµÄ + // åˆ�始化 servlet bean,spring的相关é…�置就是在这里进行的 initServletBean(); } ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½·¨¼ÓÔØÁËһЩÅäÖã¬È»ºó¾Íµ÷ÓÃÁË `initServletBean`£¬²¢Ã»ÓÐ×öһЩ spring ʵÖÊÐÔµÄÄÚÈÝ¡£ÎÒÃǼÌÐø¸ú½ø£¬Ìø¹ýÆäÖв»ÖØÒªµÄ·½·¨£¬µ÷ÓÃÁ´Â·ÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ³•加载了一些é…�置,然å�Žå°±è°ƒç”¨äº† `initServletBean`,并没有å�šä¸€äº› spring 实质性的内容。我们继续跟进,跳过其中ä¸�é‡�è¦�的方法,调用链路如下: ``` -HttpServletBean#init @@ -66,18 +66,18 @@ public final void init() throws ServletException { ``` -Ò»Ö±¸úµ½ `FrameworkServlet#initWebApplicationContext`£º +一直跟到 `FrameworkServlet#initWebApplicationContext`: ``` protected WebApplicationContext initWebApplicationContext() { - // »ñÈ¡ÀàÐÍΪWebServerApplicationContextµÄ¸¸ÈÝÆ÷£¬ÕâÀïµÃµ½µÄ½á¹ûΪnull + // 获å�–类型为WebServerApplicationContext的父容器,这里得到的结果为null WebApplicationContext rootContext = WebApplicationContextUtils.getWebApplicationContext(getServletContext()); WebApplicationContext wac = null; if (this.webApplicationContext != null) { - // Õâ¸öwebApplicationContext£¬¾ÍÊÇÔÚMyWebApplicationInitializer#onStart·½·¨ÖÐ - // ´«ÈëµÄAnnotationConfigWebApplicationContext + // 这个webApplicationContext,就是在MyWebApplicationInitializer#onStart方法中 + // 传入的AnnotationConfigWebApplicationContext wac = this.webApplicationContext; if (wac instanceof ConfigurableWebApplicationContext) { ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac; @@ -85,34 +85,34 @@ protected WebApplicationContext initWebApplicationContext() { if (cwac.getParent() == null) { cwac.setParent(rootContext); } - // ÔÚÕâÀïµ÷Óà AbstractApplicationContext#refresh Æô¶¯ + // 在这里调用 AbstractApplicationContext#refresh å�¯åЍ configureAndRefreshWebApplicationContext(cwac); } } } - // wac²»Îªnull,ÕâÀï²»»áÔËÐÐ + // wacä¸�为null,这里ä¸�会è¿�行 if (wac == null) { wac = findWebApplicationContext(); } - // wac²»Îªnull,ÕâÀï²»»áÔËÐÐ + // wacä¸�为null,这里ä¸�会è¿�行 if (wac == null) { - // ´´½¨WebApplicationContext£¬ÖØÐÂÔËÐÐAbstractApplicationContext#refresh + // 创建WebApplicationContext,é‡�æ–°è¿�行AbstractApplicationContext#refresh wac = createWebApplicationContext(rootContext); } - // ʵ¼ÊÉÏ£¬refreshEventReceivedΪtrue£¬if¿éµÄ´úÂë²¢²»Ö´ÐÐ + // 实际上,refreshEventReceived为true,ifå�—的代ç �å¹¶ä¸�执行 if (!this.refreshEventReceived) { synchronized (this.onRefreshMonitor) { - // Ë¢ÐÂÓ¦ÓÃÉÏÏÂÎÄ£¬springmvcÏà¹Ø´úÂëÔÚÕâÀïÔËÐÐ + // 刷新应用上下文,springmvc相关代ç �在这里è¿�行 onRefresh(wac); } } if (this.publishContext) { - // ½« WebApplicationContextÊÓΪservletContext Ò»¸öÊôÐÔ£¬¼ÓÈëµ½ servletContext ÖÐ - // Ö®ºó¾Í¿ÉÒÔʹÓà + // å°† WebApplicationContext视为servletContext 一个属性,加入到 servletContext 中 + // 之å�Žå°±å�¯ä»¥ä½¿ç”¨ // WebApplicationContextUtils.getWebApplicationContext(ServletContext, String attrName) - // À´»ñÈ¡ + // æ�¥èŽ·å�– String attrName = getServletContextAttributeName(); getServletContext().setAttribute(attrName, wac); } @@ -122,12 +122,12 @@ protected WebApplicationContext initWebApplicationContext() { ``` -Õâ¸ö·½·¨µÄÏà¹Ø²Ù×÷´úÂëÖÐÒÑÓÐ×¢ÊÍ£¬Êµ¼ÊÉÏÕâ¸ö·½·¨×î ÖØÒªµÄ´úÂëΪ +这个方法的相关æ“�作代ç �中已有注释,实际上这个方法最 é‡�è¦�的代ç �为 ``` protected WebApplicationContext initWebApplicationContext() { ... - // ÔÚÕâÀïµ÷Óà AbstractApplicationContext#refresh Æô¶¯ + // 在这里调用 AbstractApplicationContext#refresh å�¯åЍ configureAndRefreshWebApplicationContext(cwac); ... return wac; @@ -135,7 +135,7 @@ protected WebApplicationContext initWebApplicationContext() { ``` -Ïà¹Ø·ÖÎöÈçÏ£º +相关分æž�如下: > FrameworkServlet#configureAndRefreshWebApplicationContext @@ -155,42 +155,42 @@ protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicati wac.setServletContext(getServletContext()); wac.setServletConfig(getServletConfig()); wac.setNamespace(getNamespace()); - // Ìí¼Óʼþ¼àÌýÆ÷£¬¼àÌýspringÆô¶¯Íê³Éʼþ - // Õâ¸ö¼àÌýÆ÷Ê®·ÖÖØÒª£¬ºóÃæ»á·ÖÎö + // 添加事件监å�¬å™¨ï¼Œç›‘å�¬springå�¯åŠ¨å®Œæˆ�事件 + // 这个监å�¬å™¨å��分é‡�è¦�,å�Žé�¢ä¼šåˆ†æž� wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener())); ConfigurableEnvironment env = wac.getEnvironment(); if (env instanceof ConfigurableWebEnvironment) { ((ConfigurableWebEnvironment) env).initPropertySources(getServletContext(), getServletConfig()); } - // À©Õ¹µã£¬Ã»ÓÐʲô¹¦ÄÜ£¬´ýÒÔºóÀ©Õ¹ + // 扩展点,没有什么功能,待以å�Žæ‰©å±• postProcessWebApplicationContext(wac); applyInitializers(wac); - // µ÷ÓþÍÊÇ AbstractApplicationContext.refresh + // 调用就是 AbstractApplicationContext.refresh wac.refresh(); } ``` -Õâ¸ö·½·¨Êµ¼ÊÉÏ»¹ÊÇÅäÖà `ConfigurableWebApplicationContext` µÄһЩÊôÐÔ£¬×îºóµ÷Óà `AbstractApplicationContext#refresh` À´Æô¶¯ spring ÈÝÆ÷¡£¹ØÓÚ `AbstractApplicationContext#refresh` µÄ·ÖÎö£¬¿ÉÒԲο¼ [spring Æô¶¯Á÷³ÌÖ®Æô¶¯Ç°µÄ×¼±¸¹¤×÷](https://my.oschina.net/funcy/blog/4633169 "springÆô¶¯Á÷³ÌÖ®Æô¶¯Ç°µÄ×¼±¸¹¤×÷")¡£ +这个方法实际上还是é…�ç½® `ConfigurableWebApplicationContext` 的一些属性,最å�Žè°ƒç”¨ `AbstractApplicationContext#refresh` æ�¥å�¯åЍ spring 容器。关于 `AbstractApplicationContext#refresh` 的分æž�,å�¯ä»¥å�‚考 [spring å�¯åЍæµ�程之å�¯åЍå‰�的准备工作](https://my.oschina.net/funcy/blog/4633169 "springå�¯åЍæµ�程之å�¯åЍå‰�的准备工作")。 -µ½ÕâÀspring ÈÝÆ÷¾ÍÕæÕýÆô¶¯ÁË¡£ +到这里,spring 容器就真正å�¯åŠ¨äº†ã€‚ -### 2. `SourceFilteringListener`£ºÆô¶¯Ê¼þ¼àÌýÆ÷ +### 2. `SourceFilteringListener`:å�¯åŠ¨äº‹ä»¶ç›‘å�¬å™¨ -ÕâÀïÓиöÎÊÌ⣺ÔÚ springmvc ÖУ¬ÎÒÃÇÖªµÀ spring »áʶ±ð `@Controller`£¬½« `RequestMapping`/`@PostMapping`/`@GetMapping` µÈ×¢½âÖеÄ·¾¶·âװΪһ¸ö uri£¬µÈ´ýÍⲿ·ÃÎÊ£¬µ«ÊÇÎÒÃÇһ·¿´À´£¬Ëƺõ spring ²¢Ã»ÓÐ×öÕâЩ¹¤×÷£¬ÄÇôÕⲿ·ÖµÄ¹¤×÷ÊÇÔÚÄÄÀï½øÐеÄÄØ£¿ +这里有个问题:在 springmvc 中,我们知é�“ spring 会识别 `@Controller`,将 `RequestMapping`/`@PostMapping`/`@GetMapping` 等注解中的路径å°�装为一个 uri,等待外部访问,但是我们一路看æ�¥ï¼Œä¼¼ä¹Ž spring 并没有å�šè¿™äº›å·¥ä½œï¼Œé‚£ä¹ˆè¿™éƒ¨åˆ†çš„工作是在哪里进行的呢? -ʵ¼ÊÉÏ£¬spring Õⲿ·ÖµÄ¹¤×÷ÊÇÔÚÆô¶¯¼àÌýÆ÷ÖÐÍê³ÉµÄ£¬Ò²¾ÍÊÇ +实际上,spring 这部分的工作是在å�¯åŠ¨ç›‘å�¬å™¨ä¸­å®Œæˆ�的,也就是 ``` wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener())); ``` -Õâ¸ö¼àÌýÆ÷¼àÌýµÄÊÇ spring µÄÆô¶¯ ʼþ£¬½«ÔÚ spring ÈÝÆ÷Æô¶¯Íê³Éºóµ÷Óᣠ+这个监å�¬å™¨ç›‘å�¬çš„æ˜¯ spring çš„å�¯åЍ 事件,将在 spring 容器å�¯åŠ¨å®Œæˆ�å�Žè°ƒç”¨ã€‚ -¹ØÓÚ spring µÄʼþÏà¹ØÄÚÈÝ£¬¿ÉÒԲο¼ [spring Ì½ÃØÖ® spring ʼþ»úÖÆ](https://my.oschina.net/funcy/blog/4713339 "springÌ½ÃØÖ®spring ʼþ»úÖÆ")£¬ÕâÀïÖ±½Ó˵½áÂÛ£ºspring ÖÐÌṩÁË `ApplicationEventPublisher#publishEvent(Object)`£¨Ê¼þ·¢²¼Æ÷£©¡¢`ApplicationEvent`£¨Ê¼þ£©Óë `ApplicationListener` £¨Ê¼þ¼àÌýÆ÷£©£¬µ± spring ͨ¹ý `ApplicationEventPublisher#publishEvent(Object)` ·¢²¼ `ApplicationEvent`£¨Ê¼þ£©Ê±£¬`ApplicationListener` £¨Ê¼þ¼àÌýÆ÷£©½«»á¼àÌýµ½¡£ +关于 spring 的事件相关内容,å�¯ä»¥å�‚考 [spring 探秘之 spring 事件机制](https://my.oschina.net/funcy/blog/4713339 "spring探秘之spring 事件机制"),这里直接说结论:spring 中æ��供了 `ApplicationEventPublisher#publishEvent(Object)`(事件å�‘布器)ã€�`ApplicationEvent`(事件)与 `ApplicationListener` (事件监å�¬å™¨ï¼‰ï¼Œå½“ spring 通过 `ApplicationEventPublisher#publishEvent(Object)` å�‘布 `ApplicationEvent`(事件)时,`ApplicationListener` (事件监å�¬å™¨ï¼‰å°†ä¼šç›‘å�¬åˆ°ã€‚ -ÎÒÃÇÀ´¿´¿´ `SourceFilteringListener`£º +我们æ�¥çœ‹çœ‹ `SourceFilteringListener`: ``` public class SourceFilteringListener implements GenericApplicationListener, SmartApplicationListener { @@ -201,7 +201,7 @@ public class SourceFilteringListener implements GenericApplicationListener, Smar private GenericApplicationListener delegate; /** - * ¹¹Ôì·½·¨£¬´«Èë event Óë listener + * 构造方法,传入 event 与 listener */ public SourceFilteringListener(Object source, ApplicationListener delegate) { this.source = source; @@ -210,35 +210,35 @@ public class SourceFilteringListener implements GenericApplicationListener, Smar } /** - * ʼþ¼àÌý·½·¨ + * 事件监å�¬æ–¹æ³• */ @Override public void onApplicationEvent(ApplicationEvent event) { if (event.getSource() == this.source) { - // µ÷ÓÃÕæÕýµÄʼþ´¦Àí + // 调用真正的事件处ç�† onApplicationEventInternal(event); } } /** - * ´¦Àíʼþ + * 处ç�†äº‹ä»¶ */ protected void onApplicationEventInternal(ApplicationEvent event) { if (this.delegate == null) { throw new IllegalStateException(...); } - // ×îÖÕ»¹Êǵ÷Óô«ÈëµÄʼþ¼àÌýÆ÷µÄonApplicationEvent·½·¨ + // 最终还是调用传入的事件监å�¬å™¨çš„onApplicationEvent方法 this.delegate.onApplicationEvent(event); } - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... ``` -¿ÉÒÔ¿´µ½£¬`SourceFilteringListener` ͨ¹ý¹¹Ôì·½·¨´«ÈëÁË `ContextRefreshListener` µÄʵÀý£¬È»ºóÔÚ `SourceFilteringListener#onApplicationEvent` ·½·¨ÖУ¬×îÖÕµ÷ÓõÄÊÇ `ContextRefreshListener#onApplicationEvent` ·½·¨¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`SourceFilteringListener` 通过构造方法传入了 `ContextRefreshListener` 的实例,然å�Žåœ¨ `SourceFilteringListener#onApplicationEvent` 方法中,最终调用的是 `ContextRefreshListener#onApplicationEvent` 方法。 -½ÓÏÂÀ´ÎÒÃÇÔÙÀ´¿´ `ContextRefreshListener`£º +接下æ�¥æˆ‘们å†�æ�¥çœ‹ `ContextRefreshListener`: > FrameworkServlet.ContextRefreshListener @@ -253,22 +253,22 @@ private class ContextRefreshListener implements ApplicationListener DispatcherServlet @@ -350,7 +350,7 @@ private static final Properties defaultStrategies; static { try { - // ÔÚstatic¿éÖмÓÔØDispatcherServlet.propertiesÎļþ + // 在staticå�—中加载DispatcherServlet.properties文件 ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, DispatcherServlet.class); defaultStrategies = PropertiesLoaderUtils.loadProperties(resource); @@ -361,28 +361,28 @@ static { } /** - * handlerMappings ÊôÐÔ + * handlerMappings 属性 */ @Nullable private List handlerMappings; /** - * ³õʼ»¯ HandlerMappings - * 1\. ´Óspring ÈÝÆ÷ÖлñÈ¡ HandlerMapping bean£¬ - * Èç¹û»ñÈ¡³É¹¦£¬Ôò°ÑµÃµ½µÄ½á¹û¸³Öµ¸øhandlerMappings - * 2\. Èç¹ûδ»ñµÃ£¬Ôò»ñȡĬÈ쵀 HandlerMapping bean + * åˆ�始化 HandlerMappings + * 1\. 从spring 容器中获å�– HandlerMapping bean, + * 如果获å�–æˆ�功,则把得到的结果赋值给handlerMappings + * 2\. 如果未获得,则获å�–默认的 HandlerMapping bean */ private void initHandlerMappings(ApplicationContext context) { this.handlerMappings = null; if (this.detectAllHandlerMappings) { - // ¼ÓÔØËùÓÐʵÏÖHandlerMapping½Ó¿ÚµÄbean + // 加载所有实现HandlerMapping接å�£çš„bean Map matchingBeans = BeanFactoryUtils .beansOfTypeIncludingAncestors(context, HandlerMapping.class, true, false); - // ÕâÀﲻΪ¿Õ£¬»áÔËÐÐ + // 这里ä¸�为空,会è¿�行 if (!matchingBeans.isEmpty()) { this.handlerMappings = new ArrayList<>(matchingBeans.values()); - // ÅÅÐò£¬Spring´¦ÀíÇëÇó¾ÍÊǸù¾ÝÕâ¸öÅÅÐòµÄ½á¹û½øÐд¦Àí£¬ - // Èç¹ûµ±Ç°handlerMapping²»¿ÉÒÔ´¦ÀíÔòÅ׸øÏÂÒ»¸ö + // 排åº�,Spring处ç�†è¯·æ±‚就是根æ�®è¿™ä¸ªæŽ’åº�的结果进行处ç�†ï¼Œ + // 如果当å‰�handlerMappingä¸�å�¯ä»¥å¤„ç�†åˆ™æŠ›ç»™ä¸‹ä¸€ä¸ª AnnotationAwareOrderComparator.sort(this.handlerMappings); } } @@ -396,24 +396,24 @@ private void initHandlerMappings(ApplicationContext context) { } } if (this.handlerMappings == null) { - // Èç¹ûδÌí¼ÓhandlerMappings£¬Ôò»ñȡĬÈ쵀 handlerMappings + // 如果未添加handlerMappings,则获å�–默认的 handlerMappings this.handlerMappings = getDefaultStrategies(context, HandlerMapping.class); } } /** - * »ñȡĬÈϵIJßÂÔ + * 获å�–默认的策略 */ protected List getDefaultStrategies(ApplicationContext context, Class strategyInterface) { String key = strategyInterface.getName(); - // »ñÈ¡ÅäÖÃÎļþDispatcherServlet.propertiesÖÐĬÈ쵀 class ÅäÖà + // 获å�–é…�置文件DispatcherServlet.properties中默认的 class é…�ç½® String value = defaultStrategies.getProperty(key); if (value != null) { String[] classNames = StringUtils.commaDelimitedListToStringArray(value); List strategies = new ArrayList<>(classNames.length); for (String className : classNames) { try { - // ʹÓ÷´Éä´´½¨bean + // 使用å��射创建bean Class clazz = ClassUtils.forName(className, DispatcherServlet.class.getClassLoader()); Object strategy = createDefaultStrategy(context, clazz); strategies.add((T) strategy); @@ -434,13 +434,13 @@ protected List getDefaultStrategies(ApplicationContext context, Class ``` -³õʼ»¯ `HandlerMappings` ʱ£¬ +åˆ�始化 `HandlerMappings` 时, -1. ÏÈ´Ó spring ÈÝÆ÷ÖлñÈ¡ `HandlerMapping` bean£¬Èç¹û»ñÈ¡³É¹¦£¨Êµ¼ÊÉÏÕâÀïÒ²ÄÜ»ñµÃ£©£¬Ôò°ÑµÃµ½µÄ½á¹û¸³Öµ¸ø `DispatcherServlet` µÄ `handlerMappings` ÊôÐÔ£» -2. Èç¹ûδʧ°Ü£¬±íÃ÷ spring ÈÝÆ÷ÖÐδ´æÔÚ `HandlerMapping` £¬Ôò»ñȡĬÈ쵀 `HandlerMapping` bean. -3. »ñȡĬÈ쵀 `HandlerMapping` bean ʱ£¬¶ÁÈ¡ `DispatcherServlet.properties` ÅäÖã¬È»ºóʹÓ÷´ÉäʵÀý»¯¡£ +1. 先从 spring 容器中获å�– `HandlerMapping` bean,如果获å�–æˆ�功(实际上这里也能获得),则把得到的结果赋值给 `DispatcherServlet` çš„ `handlerMappings` 属性; +2. 如果未失败,表明 spring 容器中未存在 `HandlerMapping` ,则获å�–默认的 `HandlerMapping` bean. +3. 获å�–默认的 `HandlerMapping` bean 时,读å�– `DispatcherServlet.properties` é…�置,然å�Žä½¿ç”¨å��射实例化。 -ÎÒÃÇÀ´¿´¿´ `DispatcherServlet.properties` Îļþ£¬¸ÃÎļþλÓÚ` spring-webmvc/src/main/resources/org/springframework/web/servlet/DispatcherServlet.properties`£¬²¿·ÖÄÚÈÝÈçÏ£º +我们æ�¥çœ‹çœ‹ `DispatcherServlet.properties` 文件,该文件ä½�于` spring-webmvc/src/main/resources/org/springframework/web/servlet/DispatcherServlet.properties`,部分内容如下: ``` org.springframework.web.servlet.LocaleResolver=org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver @@ -454,24 +454,24 @@ org.springframework.web.servlet.HandlerMapping=org.springframework.web.servlet.h ``` -`DispatcherServlet#initStrategies` ÖÐÆäËû `initXxx()` ÄÚÈÝÀàËÆ£¬ÕâÀï¾Í²»Ò»Ò»·ÖÎöÁË¡£ +`DispatcherServlet#initStrategies` 中其他 `initXxx()` 内容类似,这里就ä¸�一一分æž�了。 -### 4\. ×ܽá +### 4\. 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË springmvc µÄÆô¶¯¹ý³Ì£¬×ܽáÈçÏ£º +本文主è¦�分æž�了 springmvc çš„å�¯åŠ¨è¿‡ç¨‹ï¼Œæ€»ç»“å¦‚ä¸‹ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-7ab3fae1e39f545c1d7c1811351227fa434.png) -1. servlet ÈÝÆ÷£¨ÕâÀïÊÇ tomcat£©Æô¶¯Ê±£¬Í¨¹ý spi »úÖÆÖ´ÐÐ `ServletContainerInitializer#onStartup` ·½·¨£¬¶ø springmvc ¶ÔÌṩµÄ `SpringServletContainerInitializer` ¶ÔÆä½øÐÐÁËʵÏÖ£¬ÓÚÊÇ `SpringServletContainerInitializer#onStartup` ·½·¨»á±»µ÷Óã» -2. `SpringServletContainerInitializer#onStartup` ·½·¨ÖУ¬spring »áµ÷Óà `WebApplicationInitializer#onStartup` ·½·¨£¬¶ø `MyWebApplicationInitializer` ¶ÔÆä½øÐÐÁËʵÏÖ£¬ÓÚÊÇ `MyWebApplicationInitializer#onStartup` »á±»µ÷Óã» -3. ÔÚ `MyWebApplicationInitializer#onStartup` ·½·¨ÖÐ £¬ÎÒÃÇ´´½¨ÁËÒ»¸ö `applicationContext` ¶ÔÏ󣬽«ÆäÓë `DispatcherServlet` °ó¶¨£¬È»ºó½« `DispatcherServlet` ×¢²áµ½ servlet ÈÝÆ÷ÖУ¨ÕâÀïÊÇ tomcat£©£» -4. `DispatcherServlet` ×¢²áµ½ servlet ÈÝÆ÷ÖУ¨ÕâÀïÊÇ tomcat£©ºó£¬¸ù¾Ý servlet ÉúÃüÖÜÆÚ£¬`DispatcherServlet#init` ½«»á±»µ÷Óã» -5. `DispatcherServlet#init` ÖлáÖ´ÐÐ spring ÈÝÆ÷µÄÆô¶¯¹ý³Ì£¬spring ÈÝÆ÷Æô¶¯ºó£¬»á·¢²¼Æô¶¯Íê³Éʼþ£» -6. spring Æô¶¯Íê³Éºó£¬`ContextRefreshListener` ½«»á¼àÌý spring Æô¶¯Íê³Éʼþ£¬`FrameworkServlet.ContextRefreshListener#onApplicationEvent` ·½·¨»á±»µ÷Ó㬵÷Óõ÷Óõ½ `DispatcherServlet#initStrategies`£» -7. spring ×îÖÕÔÚ `DispatcherServlet#initStrategies` Öгõʼ»¯ `MultipartResolver`¡¢`LocaleResolver` µÈ×é¼þ£¬ËùνµÄ³õʼ»¯£¬ÆäʵÊÇ»ñÈ¡»ò´´½¨¶ÔÓ¦µÄ bean£¬È»ºó¸³Öµ¸ø `DispatcherServlet` µÄÊôÐÔ¡£ +1. servlet 容器(这里是 tomcat)å�¯åŠ¨æ—¶ï¼Œé€šè¿‡ spi 机制执行 `ServletContainerInitializer#onStartup` 方法,而 springmvc 对æ��供的 `SpringServletContainerInitializer` 对其进行了实现,于是 `SpringServletContainerInitializer#onStartup` 方法会被调用; +2. `SpringServletContainerInitializer#onStartup` 方法中,spring 会调用 `WebApplicationInitializer#onStartup` 方法,而 `MyWebApplicationInitializer` 对其进行了实现,于是 `MyWebApplicationInitializer#onStartup` 会被调用; +3. 在 `MyWebApplicationInitializer#onStartup` 方法中 ,我们创建了一个 `applicationContext` 对象,将其与 `DispatcherServlet` 绑定,然å�Žå°† `DispatcherServlet` 注册到 servlet 容器中(这里是 tomcat); +4. `DispatcherServlet` 注册到 servlet 容器中(这里是 tomcat)å�Žï¼Œæ ¹æ�® servlet 生命周期,`DispatcherServlet#init` 将会被调用; +5. `DispatcherServlet#init` 中会执行 spring 容器的å�¯åŠ¨è¿‡ç¨‹ï¼Œspring 容器å�¯åЍå�Žï¼Œä¼šå�‘布å�¯åŠ¨å®Œæˆ�事件; +6. spring å�¯åŠ¨å®Œæˆ�å�Žï¼Œ`ContextRefreshListener` 将会监å�¬ spring å�¯åŠ¨å®Œæˆ�事件,`FrameworkServlet.ContextRefreshListener#onApplicationEvent` 方法会被调用,调用调用到 `DispatcherServlet#initStrategies`ï¼› +7. spring 最终在 `DispatcherServlet#initStrategies` 中åˆ�始化 `MultipartResolver`ã€�`LocaleResolver` 等组件,所谓的åˆ�始化,其实是获å�–或创建对应的 bean,然å�Žèµ‹å€¼ç»™ `DispatcherServlet` 的属性。 -µ½´Ë£¬springmvc Õû¸öÆô¶¯Á÷³Ì¾ÍÍê³ÉÁË¡£²»¹ýµ½´ËÎÒÃǶ¼Ã»Óп´µ½ **spring ´¦Àí `@RequestMapping` µÄÏà¹ØÁ÷³Ì**£¬ÄÇô spring ÊÇÈçºÎ´¦ÀíÕâ¸öÁ÷³ÌÄØ £¬ÏÂһƪÎÄÕ½«½ÒÏþ¡£ +到此,springmvc 整个å�¯åЍæµ�程就完æˆ�了。ä¸�过到此我们都没有看到 **spring 处ç�† `@RequestMapping` 的相关æµ�程**,那么 spring 是如何处ç�†è¿™ä¸ªæµ�程呢 ,下一篇文章将æ�­æ™“。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4710330](https://my.oschina.net/funcy/blog/4710330) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4710330](https://my.oschina.net/funcy/blog/4710330) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/RequestMapping\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/RequestMapping\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" index 777a297..e34671d 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/RequestMapping\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/RequestMapping\345\210\235\345\247\213\345\214\226\346\265\201\347\250\213.md" @@ -1,19 +1,19 @@ -Ç°ÃæµÄÎÄÕÂÖУ¬ÎÒÃÇ·ÖÎöÁË `DispatcherServlet` ³õʼ»¯Á÷³Ì£¬±¾ÎĽ«À´·ÖÎö `RequestMapping` ³õʼ»¯Á÷³Ì¡£ÕâÀïËù˵µÄ `RequestMapping` ³õʼ»¯Á÷³Ì£¬Ö±¹ÛÀ´Ëµ£¬¾ÍÊÇ spring ´¦Àí `@RequestMaping` ×¢½âµÄ¹ý³Ì¡£ +å‰�é�¢çš„æ–‡ç« ä¸­ï¼Œæˆ‘们分æž�了 `DispatcherServlet` åˆ�始化æµ�程,本文将æ�¥åˆ†æž� `RequestMapping` åˆ�始化æµ�程。这里所说的 `RequestMapping` åˆ�始化æµ�程,直观æ�¥è¯´ï¼Œå°±æ˜¯ spring 处ç�† `@RequestMaping` 注解的过程。 -### 1\. ÔÙ̸ `@EnableWebMvc` +### 1\. å†�è°ˆ `@EnableWebMvc` -ÔÚ [spring mvc Ö® springmvc demo Óë @EnableWebMvc ×¢½â ](https://my.oschina.net/funcy/blog/4696657)Ò»ÎÄÖÐÌáµ½£¬spring ͨ¹ý `@EnableWebMvc` ×¢½âÀ´ÆôÓà mvc ¹¦ÄÜ£¬×îÖÕͨ¹ý `@Import` ×¢½âΪÏîÄ¿ÒýÈëÁË `DelegatingWebMvcConfiguration.class`£¬¸ÃÀàͨ¹ý `@Bean` ×¢½âµÄ·½·¨Ïò spring ÖÐÒýÈë´óÁ¿µÄ mvc ×é¼þ£º +在 [spring mvc 之 springmvc demo 与 @EnableWebMvc 注解 ](https://my.oschina.net/funcy/blog/4696657)一文中æ��到,spring 通过 `@EnableWebMvc` 注解æ�¥å�¯ç”¨ mvc 功能,最终通过 `@Import` 注解为项目引入了 `DelegatingWebMvcConfiguration.class`,该类通过 `@Bean` 注解的方法å�‘ spring 中引入大é‡�çš„ mvc 组件: * `public RequestMappingHandlerMapping requestMappingHandlerMapping(...)` * `public PathMatcher mvcPathMatcher()` * `public UrlPathHelper mvcUrlPathHelper()` * ... -Õâô×é¼þÖУ¬Óë `@RequestMaping` ×¢½âÏà¹ØµÄÀà¾ÍÊÇ `RequestMappingHandlerMapping`. +这么组件中,与 `@RequestMaping` 注解相关的类就是 `RequestMappingHandlerMapping`. -### 2. `RequestMappingHandlerMapping#afterPropertiesSet` ·½·¨ +### 2. `RequestMappingHandlerMapping#afterPropertiesSet` 方法 -`RequestMappingHandlerMapping` ÊÇ´´½¨ÊÇÔÚ `WebMvcConfigurationSupport` ÖУº +`RequestMappingHandlerMapping` 是创建是在 `WebMvcConfigurationSupport` 中: ``` @Bean @@ -22,14 +22,14 @@ public RequestMappingHandlerMapping requestMappingHandlerMapping( @Qualifier("mvcConversionService") FormattingConversionService conversionService, @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) { - // ´´½¨bean + // 创建bean RequestMappingHandlerMapping mapping = createRequestMappingHandlerMapping(); mapping.setOrder(0); mapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider)); mapping.setContentNegotiationManager(contentNegotiationManager); mapping.setCorsConfigurations(getCorsConfigurations()); - // ´¦Àí¸÷ÖÖÅäÖã¬ÕâÀï¾ÍÊÇÉÏһƪÎÄÕÂÖÐÌáµ½µÄgetXxx()·½·¨»ñÈ¡ÅäÖà + // 处ç�†å�„ç§�é…�置,这里就是上一篇文章中æ��到的getXxx()方法获å�–é…�ç½® PathMatchConfigurer configurer = getPathMatchConfigurer(); Boolean useSuffixPatternMatch = configurer.isUseSuffixPatternMatch(); if (useSuffixPatternMatch != null) { @@ -59,19 +59,19 @@ public RequestMappingHandlerMapping requestMappingHandlerMapping( return mapping; } -// ´´½¨¶ÔÏó +// 创建对象 protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() { return new RequestMappingHandlerMapping(); } ``` -Õâ¸ö·½·¨¾ÍÊÇÓÃÀ´´´½¨¶ÔÏó `RequestMappingHandlerMapping` ¶ÔÏóµÄ£¬ÏÈÊÇ´´½¨ÁËÒ»¸ö¶ÔÏó£¬È»ºóÉèÖÃÁ˸÷ÖÖÊôÐÔ¡£¶ÔÏó´´½¨ºó£¬¼ÌÐø½øÐÐ spring bean µÄÉúÃüÖÜÆÚ£¬¼Ì¶øµ÷Óà `RequestMappingHandlerMapping#afterPropertiesSet` ·½·¨£º +这个方法就是用æ�¥åˆ›å»ºå¯¹è±¡ `RequestMappingHandlerMapping` 对象的,先是创建了一个对象,然å�Žè®¾ç½®äº†å�„ç§�属性。对象创建å�Žï¼Œç»§ç»­è¿›è¡Œ spring bean 的生命周期,继而调用 `RequestMappingHandlerMapping#afterPropertiesSet` 方法: ``` @Override public void afterPropertiesSet() { - // ÅäÖÃÁËһЩÊôÐÔ + // é…�置了一些属性 this.config = new RequestMappingInfo.BuilderConfiguration(); this.config.setUrlPathHelper(getUrlPathHelper()); this.config.setPathMatcher(getPathMatcher()); @@ -79,13 +79,13 @@ public void afterPropertiesSet() { this.config.setTrailingSlashMatch(this.useTrailingSlashMatch); this.config.setRegisteredSuffixPatternMatch(this.useRegisteredSuffixPatternMatch); this.config.setContentNegotiationManager(getContentNegotiationManager()); - // µ÷Óø¸ÀàµÄ·½·¨ + // 调用父类的方法 super.afterPropertiesSet(); } ``` -Õâ¸ö·½·¨ÏÈÊÇ ÅäÖÃÁËһЩÊôÐÔ£¬È»ºóÔÙµ÷Óø¸ÀàµÄ `afterPropertiesSet()`£¬¼ÌÐø×·ÏÂÈ¥£º +这个方法先是 é…�置了一些属性,然å�Žå†�调用父类的 `afterPropertiesSet()`,继续追下去: > AbstractHandlerMethodMapping#afterPropertiesSet @@ -96,28 +96,28 @@ public void afterPropertiesSet() { } protected void initHandlerMethods() { - // µ÷ÓÃgetCandidateBeanNames()»ñÈ¡ÈÝÆ÷ÖÐËùÓÐbeanµÄbeanName£¬ - // È»ºó°¤¸ö´¦ÀíÈÝÆ÷ÖÐËùÓÐ bean + // 调用getCandidateBeanNames()获å�–容器中所有beançš„beanName, + // ç„¶å�ŽæŒ¨ä¸ªå¤„ç�†å®¹å™¨ä¸­æ‰€æœ‰ bean for (String beanName : getCandidateBeanNames()) { if (!beanName.startsWith(SCOPED_TARGET_NAME_PREFIX)) { - // Öð¸ö bean ´¦Àí£¬¼ÌÐøÍùÏ¿´ + // é€�个 bean 处ç�†ï¼Œç»§ç»­å¾€ä¸‹çœ‹ processCandidateBean(beanName); } } - // Õâ¸ö·½·¨½ö´òÁËÒ»¸öÈÕÖ¾£¬Ã»Ê²Ã´¹¦ÄÜ + // 这个方法仅打了一个日志,没什么功能 handlerMethodsInitialized(getHandlerMethods()); } ``` -spring ÔÚ´¦Àíʱ£¬»ñÈ¡ÁËÈÝÆ÷ÖÐËùÓÐ bean µÄ beanName£¬È»ºó¶Ô beanName ½øÐа¤¸ö´¦Àí£¬¼ÌÐø¿´ `AbstractHandlerMethodMapping#processCandidateBean`£º +spring 在处ç�†æ—¶ï¼ŒèŽ·å�–了容器中所有 bean çš„ beanName,然å�Žå¯¹ beanName 进行挨个处ç�†ï¼Œç»§ç»­çœ‹ `AbstractHandlerMethodMapping#processCandidateBean`: ``` -// ´¦ÀíbeanµÄ¾ßÌåÂß¼­ +// 处ç�†bean的具体逻辑 protected void processCandidateBean(String beanName) { - // »ñÈ¡ beanName ¶ÔÓ¦µÄ beanType - // 1\. Èç¹ûÊÇcglib´úÀí£¬beanType Ϊ Xxx$$EnhancerBySpringCGLIB - // 2\. Èç¹ûÊÇjdk¶¯Ì¬´úÀí£¬beanType Ϊ com.sum.proxy.$Proxy + // 获å�– beanName 对应的 beanType + // 1\. 如果是cglib代ç�†ï¼ŒbeanType 为 Xxx$$EnhancerBySpringCGLIB + // 2\. 如果是jdk动æ€�代ç�†ï¼ŒbeanType 为 com.sum.proxy.$Proxy Class beanType = null; try { beanType = obtainApplicationContext().getType(beanName); @@ -125,60 +125,60 @@ protected void processCandidateBean(String beanName) { catch (Throwable ex) { ... } - // isHandler: beanTypeÉÏÊÇ·ñÓÐ @Controller »ò @RequestMapping ×¢½â + // isHandler: beanType上是å�¦æœ‰ @Controller 或 @RequestMapping 注解 if (beanType != null && isHandler(beanType)) { - // ´¦Àí handlerMethods + // 处ç�† handlerMethods detectHandlerMethods(beanName); } } ``` -Õâ¸ö·½·¨»¹ÊDZȽϼòµ¥£¬Ö÷ÒªÊÇ»ñÈ¡ `beanName` ¶ÔÓ¦µÄ `beanType`£¬È»ºóÅжÏÊÇ·ñÓÐ `@Controller/@RequestMapping` ×¢½â£¬Ö®ºó¾Íµ÷Óà `AbstractHandlerMethodMapping#detectHandlerMethods` ½øÒ»²½´¦Àí¡£ +这个方法还是比较简å�•,主è¦�是获å�– `beanName` 对应的 `beanType`,然å�Žåˆ¤æ–­æ˜¯å�¦æœ‰ `@Controller/@RequestMapping` 注解,之å�Žå°±è°ƒç”¨ `AbstractHandlerMethodMapping#detectHandlerMethods` 进一步处ç�†ã€‚ -²»¹ý¶ÔÓÚ `isHandler(Class)` ÐèÒª×ÅÖØËµÃ÷Ï£º +ä¸�过对于 `isHandler(Class)` 需è¦�ç�€é‡�说明下: -1. ÄÜʶ±ð `@Controller`£¬Í¬ÑùÄÜʶ±ð `@RestController`£¬ÉõÖÁÆäËû±ê×¢ `@Controller` µÄ×¢½â£¬¼´ÄÜʶ±ðÈçÏÂ×¢½â£º +1. 能识别 `@Controller`,å�Œæ ·èƒ½è¯†åˆ« `@RestController`,甚至其他标注 `@Controller` 的注解,å�³èƒ½è¯†åˆ«å¦‚下注解: ``` - // ±ê¼ÇÁË @Controller + // 标记了 @Controller @Controller - // Ê¡ÂÔÆäËû×¢½â + // çœ�略其他注解 public @interface XxxController { ... } ``` -2. Èç¹û `beanName` ¶ÔÓ¦ bean ÊÇ cglib ´úÀí bean£¬beanType Ϊ `Xxx$$EnhancerBySpringCGLIB`£¬ÄÜʶ±ðÆä¸¸Àà (Ò²¾ÍÊÇÄ¿±êÀà) É쵀 `@Controller/@ReestMapping`; +2. 如果 `beanName` 对应 bean 是 cglib 代ç�† bean,beanType 为 `Xxx$$EnhancerBySpringCGLIB`,能识别其父类 (也就是目标类) 上的 `@Controller/@ReestMapping`; -3. Èç¹û `beanName` ¶ÔÓ¦µÄ bean ÊÇ jdk ¶¯Ì¬´úÀí bean£¬beanType Ϊ `com.sum.proxy.$Proxy`£¬ÄÜʶ±ðÆä¸¸½Ó¿ÚÉ쵀 `@Controller/@RequestMapping`; +3. 如果 `beanName` 对应的 bean 是 jdk 动æ€�代ç�† bean,beanType 为 `com.sum.proxy.$Proxy`,能识别其父接å�£ä¸Šçš„ `@Controller/@RequestMapping`; -4. Èç¹û beanType ÊÇ `com.sum.proxy.$Proxy`(jdk ¶¯Ì¬´úÀíÀà)£¬** ÎÞ·¨Ê¶±ðÆäÄ¿±êÀàÉ쵀 `@Controller/@RequestMapping` ** µÄ£» +4. 如果 beanType 是 `com.sum.proxy.$Proxy`(jdk 动æ€�代ç�†ç±»),** 无法识别其目标类上的 `@Controller/@RequestMapping` ** 的; -5. ±ê×¢ `@Controller/@RequestMapping` µÄÀàҪʵÏÖ jdk ¶¯Ì¬´úÀí£¬ÐèÒª½« `@Controller/@RequestMapping` ·ÅÔÚ½Ó¿Ú¼°½Ó¿ÚµÄ·½·¨ÉÏ¡£ +5. 标注 `@Controller/@RequestMapping` 的类è¦�实现 jdk 动æ€�代ç�†ï¼Œéœ€è¦�å°† `@Controller/@RequestMapping` 放在接å�£å�пޥå�£çš„æ–¹æ³•上。 -µ½ÁËÕâÀ´«Èë `AbstractHandlerMethodMapping#detectHandlerMethods` µÄ `beanType` ¶¼ÊDZê×¢ÁË `@Controller/@RequestMapping` µÄÀà»ò½Ó¿ÚÁË¡£ +到了这里,传入 `AbstractHandlerMethodMapping#detectHandlerMethods` çš„ `beanType` 都是标注了 `@Controller/@RequestMapping` 的类或接å�£äº†ã€‚ ### 3. `AbstractHandlerMethodMapping#detectHandlerMethods` -¼ÌÐø¿´¿´ `AbstractHandlerMethodMapping#detectHandlerMethods` µÄÄÚÈÝ£º +继续看看 `AbstractHandlerMethodMapping#detectHandlerMethods` 的内容: ``` -// ¼ì²âhandler·½·¨ +// 检测handler方法 protected void detectHandlerMethods(Object handler) { Class handlerType = (handler instanceof String ? obtainApplicationContext().getType((String) handler) : handler.getClass()); if (handlerType != null) { - // 1\. Õë¶Ôcglib´úÀí¶ÔÏ󣬵õ½Æä¸¸À࣬Ҳ¾ÍÊÇÄ¿±ê¶ÔÏóµÄÀà + // 1\. 针对cglib代ç�†å¯¹è±¡ï¼Œå¾—到其父类,也就是目标对象的类 Class userType = ClassUtils.getUserClass(handlerType); - // 2\. ÕâÀï»á´¦Àí userType¡¢userTypeµÄ²»°üÀ¨ObjectµÄËùÓи¸À༰ userType µÄËùÓнӿڵķ½·¨ + // 2\. 这里会处ç�† userTypeã€�userTypeçš„ä¸�包括Object的所有父类å�Š userType 的所有接å�£çš„æ–¹æ³• Map methods = MethodIntrospector.selectMethods(userType, - // 3\. ¶Ôÿ¸ö·½·¨£¬Èç¹ûÓÐ @RequestMapping£¬Ôò´´½¨ RequestMappingInfo - // ½« @RequestMapping ÐÅÏ¢·â×°µ½¸Ã¶ÔÏóÖÐ + // 3\. 对æ¯�个方法,如果有 @RequestMapping,则创建 RequestMappingInfo + // å°† @RequestMapping ä¿¡æ�¯å°�装到该对象中 (MethodIntrospector.MetadataLookup) method -> { try { - // ÔÚÕâÀï´¦Àí·½·¨É쵀 @RequestMapping ×¢½â + // 在这里处ç�†æ–¹æ³•上的 @RequestMapping 注解 return getMappingForMethod(method, userType); } catch (Throwable ex) { @@ -187,7 +187,7 @@ protected void detectHandlerMethods(Object handler) { }); methods.forEach((method, mapping) -> { Method invocableMethod = AopUtils.selectInvocableMethod(method, userType); - // 4\. ÔÚÕâÀォhandler¡¢mappingÓëmethod±£´æÆðÀ´ + // 4\. 在这里将handlerã€�mapping与methodä¿�存起æ�¥ registerHandlerMethod(handler, invocableMethod, mapping); }); } @@ -195,16 +195,16 @@ protected void detectHandlerMethods(Object handler) { ``` -Õâ¸ö·½·¨×öÁËÈçϼ¸¼þÊ£º +这个方法å�šäº†å¦‚下几件事: -1. Õë¶Ô cglib ´úÀí¶ÔÏ󣬵õ½Æä¸¸À࣬Ҳ¾ÍÊÇÄ¿±ê¶ÔÏóµÄÀࣨ**ÕâÀïΪºÎÖ»´¦Àí cglib ´úÀí¶ÔÏ󣬶ø²»´¦Àí jdk ¶¯Ì¬´úÀí¶ÔÏóÄØ£¿** ´ÓÉÏÃæ¶Ô `isHandler(Class)` µÄ˵Ã÷¿ÉÖª£¬spring ²¢²»ÄÜʶ±ð jdk ¶¯Ì¬´úÀí¶ÔÏó¶ÔÓ¦ÀàÉ쵀 `@Controller/@RequestMapping` ×¢½â£¬Òò´Ë²»»áÖ´Ðе½ÕâÀ£» -2. ´¦Àí `userType`¡¢`userType` µÄ²»°üÀ¨ Object µÄËùÓи¸À༰ `userType` µÄËùÓнӿڵķ½·¨£» -3. ¶Ôÿ¸ö·½·¨£¬Èç¹ûÓÐ `@RequestMapping`£¬Ôò´´½¨ `RequestMappingInfo`£¬½« `@RequestMapping` ÐÅÏ¢·â×°µ½¸Ã¶ÔÏóÖУ» -4. ×¢²á£¬½« `handler`¡¢`mapping` Óë `method` ±£´æµ½ Map ÖС£ +1. 针对 cglib 代ç�†å¯¹è±¡ï¼Œå¾—到其父类,也就是目标对象的类(**这里为何å�ªå¤„ç�† cglib 代ç�†å¯¹è±¡ï¼Œè€Œä¸�处ç�† jdk 动æ€�代ç�†å¯¹è±¡å‘¢ï¼Ÿ** 从上é�¢å¯¹ `isHandler(Class)` 的说明å�¯çŸ¥ï¼Œspring å¹¶ä¸�能识别 jdk 动æ€�代ç�†å¯¹è±¡å¯¹åº”类上的 `@Controller/@RequestMapping` 注解,因此ä¸�会执行到这里); +2. 处ç�† `userType`ã€�`userType` çš„ä¸�包括 Object 的所有父类å�Š `userType` 的所有接å�£çš„æ–¹æ³•ï¼› +3. 对æ¯�个方法,如果有 `@RequestMapping`,则创建 `RequestMappingInfo`,将 `@RequestMapping` ä¿¡æ�¯å°�装到该对象中; +4. 注册,将 `handler`ã€�`mapping` 与 `method` ä¿�存到 Map 中。 -#### 3.1 ²éÕÒ·½·¨ +#### 3.1 查找方法 -ÔÚ `detectHandlerMethods` ·½·¨µÄ´¦Àí¹ý³ÌÖУ¬»á²éÕÒ `userType`¡¢`userType` µÄËùÓи¸Àࣨ²»°üÀ¨ Object£©¼° `userType` µÄËùÓнӿڵķ½·¨£¬¹ý³ÌÈçÏ£º +在 `detectHandlerMethods` 方法的处ç�†è¿‡ç¨‹ä¸­ï¼Œä¼šæŸ¥æ‰¾ `userType`ã€�`userType` 的所有父类(ä¸�包括 Object)å�Š `userType` 的所有接å�£çš„æ–¹æ³•,过程如下: > MethodIntrospector#selectMethods(Class, MethodIntrospector.MetadataLookup) @@ -214,20 +214,20 @@ public static Map selectMethods(Class targetType, final final Map methodMap = new LinkedHashMap<>(); Set> handlerTypes = new LinkedHashSet<>(); Class specificHandlerType = null; - // ·Çjdk¶¯Ì¬´úÀíÀà + // é�žjdk动æ€�代ç�†ç±» if (!Proxy.isProxyClass(targetType)) { - // Èç¹ûÊÇcglib´úÀíÀ࣬»ñÈ¡Æä¾ßÌåµÄ¸¸Àà class + // 如果是cglib代ç�†ç±»ï¼ŒèŽ·å�–其具体的父类 class specificHandlerType = ClassUtils.getUserClass(targetType); handlerTypes.add(specificHandlerType); } - // »ñÈ¡ÀàµÄËùÓнӿڣ¬°üÀ¨½Ó¿ÚµÄ¸¸½Ó¿Ú. + // 获å�–类的所有接å�£ï¼ŒåŒ…括接å�£çš„父接å�£. handlerTypes.addAll(ClassUtils.getAllInterfacesForClassAsSet(targetType)); for (Class currentHandlerType : handlerTypes) { final Class targetClass = (specificHandlerType != null ? specificHandlerType : currentHandlerType); - // ´¦ÀícurrentHandlerType¡¢currentHandlerTypeµÄ²»°üÀ¨ObjectµÄËùÓи¸Àà¡¢ - // currentHandlerTypeµÄËùÓнӿڵķ½·¨ - // ´¦Àíaopʱ£¬µ÷ÓõÄÒ²ÊÇÕâ¸ö·½·¨ + // 处ç�†currentHandlerTypeã€�currentHandlerTypeçš„ä¸�包括Object的所有父类ã€� + // currentHandlerType的所有接å�£çš„æ–¹æ³• + // 处ç�†aop时,调用的也是这个方法 ReflectionUtils.doWithMethods(currentHandlerType, method -> { Method specificMethod = ClassUtils.getMostSpecificMethod(method, targetClass); T result = metadataLookup.inspect(specificMethod); @@ -245,23 +245,23 @@ public static Map selectMethods(Class targetType, final ``` -#### 3.2 ´´½¨ `RequestMappingInfo` +#### 3.2 创建 `RequestMappingInfo` -¶Ôÿ¸ö·½·¨£¬Èç¹ûÓÐ `@RequestMapping`£¬Ôò´´½¨ `RequestMappingInfo`£¬½« `@RequestMapping` ÐÅÏ¢·â×°µ½¸Ã¶ÔÏóÖУº +对æ¯�个方法,如果有 `@RequestMapping`,则创建 `RequestMappingInfo`,将 `@RequestMapping` ä¿¡æ�¯å°�装到该对象中: > RequestMappingHandlerMapping#getMappingForMethod ``` protected RequestMappingInfo getMappingForMethod(Method method, Class handlerType) { - // ´¦Àí·½·¨É쵀 @RequestMapping + // 处ç�†æ–¹æ³•上的 @RequestMapping RequestMappingInfo info = createRequestMappingInfo(method); if (info != null) { - // ´¦ÀíÀàÉ쵀 @RequestMapping + // 处ç�†ç±»ä¸Šçš„ @RequestMapping RequestMappingInfo typeInfo = createRequestMappingInfo(handlerType); if (typeInfo != null) { - // ºÏ²¢·½·¨ÓëÀàÉ쵀 @RequestMapping ½á¹û - // ÈçÀàµÄ @RequestMapping("/test")£¬·½·¨É쵀 @RequestMapping("/hello") - // ºÏ²¢ºóµÄ½á¹ûΪ /test/hello + // å�ˆå¹¶æ–¹æ³•与类上的 @RequestMapping 结果 + // 如类的 @RequestMapping("/test"),方法上的 @RequestMapping("/hello") + // å�ˆå¹¶å�Žçš„结果为 /test/hello info = typeInfo.combine(info); } String prefix = getPathPrefix(handlerType); @@ -274,22 +274,22 @@ protected RequestMappingInfo getMappingForMethod(Method method, Class handler @Nullable private RequestMappingInfo createRequestMappingInfo(AnnotatedElement element) { - // »ñÈ¡ @RequestMapping ×¢½â + // 获å�– @RequestMapping 注解 RequestMapping requestMapping = AnnotatedElementUtils .findMergedAnnotation(element, RequestMapping.class); - // ´¦ÀíÇëÇóÌõ¼þ£¬Êµ¼ÊÉÏÕâ¸ö·½·¨Îª¿Õ + // 处ç�†è¯·æ±‚æ�¡ä»¶ï¼Œå®žé™…上这个方法为空 RequestCondition condition = (element instanceof Class ? getCustomTypeCondition((Class) element) : getCustomMethodCondition((Method) element)); return (requestMapping != null ? createRequestMappingInfo(requestMapping, condition) : null); } -// ´´½¨ RequestMappingInfo£¬Õâ¸ö RequestMapping ¾ÍÊÇ @RequestMapping ×¢½â +// 创建 RequestMappingInfo,这个 RequestMapping 就是 @RequestMapping 注解 protected RequestMappingInfo createRequestMappingInfo( RequestMapping requestMapping, @Nullable RequestCondition customCondition) { - // Æäʵ¾ÍÊǽ« @RequestMapping ×¢½â·âװΪRequestMappingInfo¶ÔÏó + // 其实就是将 @RequestMapping 注解å°�装为RequestMappingInfo对象 RequestMappingInfo.Builder builder = RequestMappingInfo .paths(resolveEmbeddedValuesInPatterns(requestMapping.path())) - // ÏÂÃæµÄÊôÐÔ½ÔÀ´×Ô @RequestMapping ×¢½â + // 下é�¢çš„属性皆æ�¥è‡ª @RequestMapping 注解 .methods(requestMapping.method()) .params(requestMapping.params()) .headers(requestMapping.headers()) @@ -304,13 +304,13 @@ protected RequestMappingInfo createRequestMappingInfo( ``` -µ½ÁËÕâÀÎÒÃǾÍÍê³ÉÁËÓÉ `@RequestMapping` µ½ `RequestMappingInfo¶ÔÏó`µÄת»¯¡£ +到了这里,我们就完æˆ�了由 `@RequestMapping` 到 `RequestMappingInfo对象`的转化。 -ÔÙÀ´¿´¿´ `RequestMappingInfo` ³¤Ê²Ã´Ñù£º +å†�æ�¥çœ‹çœ‹ `RequestMappingInfo` 长什么样: ``` public final class RequestMappingInfo implements RequestCondition { - // ÌṩÁ˺ܶàÊôÐÔ£¬¶ÔÓ¦×Å @RequestMappingµÄÊôÐÔ + // æ��供了很多属性,对应ç�€ @RequestMapping的属性 @Nullable private final String name; private final PatternsRequestCondition patternsCondition; @@ -321,7 +321,7 @@ public final class RequestMappingInfo implements RequestCondition RequestMappingHandlerMapping#registerHandlerMethod ``` @Override protected void registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping) { - // µ÷Óø¸ÀàµÄ·½·¨£¬×¢²áÏà¹ØÂß¼­ÔÚÕâÀï + // 调用父类的方法,注册相关逻辑在这里 super.registerHandlerMethod(handler, method, mapping); updateConsumesCondition(mapping, method); } -// ´¦Àí·½·¨²ÎÊýµÄ @RequestBody ×¢½â +// 处ç�†æ–¹æ³•å�‚æ•°çš„ @RequestBody 注解 private void updateConsumesCondition(RequestMappingInfo info, Method method) { ConsumesRequestCondition condition = info.getConsumesCondition(); if (!condition.isEmpty()) { for (Parameter parameter : method.getParameters()) { - // ´¦Àí ·½·¨²ÎÊýµÄ @RequestBody ×¢½â£¬ÉèÖà BodyRequired µÄÖµ + // 处ç�† 方法å�‚æ•°çš„ @RequestBody 注解,设置 BodyRequired 的值 MergedAnnotation annot = MergedAnnotations.from(parameter) .get(RequestBody.class); if (annot.isPresent()) { @@ -397,15 +397,15 @@ private void updateConsumesCondition(RequestMappingInfo info, Method method) { ``` -×îÖÕ£¬·¢ÏÖ¾ßÌåµÄ×¢²áÂß¼­ÊÇÔÚ `AbstractHandlerMethodMapping#registerHandlerMethod` ÖÐÍê³ÉµÄ£¬¿´À´Õâ¸ö¾ÍÊÇ×îÖÕ·½·¨ÁË¡£ÔÚ·ÖÎöÕâ¸ö·½·¨Ç°£¬ÎÒÃÇÏÈÀ´¿´¿´ÕâÒ»²½µÃµ½µÄ `Map methods`: +最终,å�‘现具体的注册逻辑是在 `AbstractHandlerMethodMapping#registerHandlerMethod` 中完æˆ�的,看æ�¥è¿™ä¸ªå°±æ˜¯æœ€ç»ˆæ–¹æ³•了。在分æž�这个方法å‰�,我们先æ�¥çœ‹çœ‹è¿™ä¸€æ­¥å¾—到的 `Map methods`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ec6b4b2d2156e0e041982425173feda38fc.png) -¿ÉÒÔ¿´µ½£¬¶ÔÓ¦µÄ `T` ¾ÍÊÇ `RequestMappingInfo` ÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œå¯¹åº”çš„ `T` 就是 `RequestMappingInfo` 了。 -### 3. `AbstractHandlerMethodMapping#registerHandlerMethod` ·½·¨ +### 3. `AbstractHandlerMethodMapping#registerHandlerMethod` 方法 -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `AbstractHandlerMethodMapping#registerHandlerMethod` ´úÂ룺 +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `AbstractHandlerMethodMapping#registerHandlerMethod` 代ç �: ``` public abstract class AbstractHandlerMethodMapping extends AbstractHandlerMapping @@ -415,34 +415,34 @@ public abstract class AbstractHandlerMethodMapping extends AbstractHandlerMap this.mappingRegistry.register(mapping, handler, method); } - // Ê¡ÂÔÁ˺öà´úÂë + // çœ�略了好多代ç � ... class MappingRegistry { - // ÐÅÏ¢×îÈ«µÄmap£¬°üº¬mapping, handlerMethod, directUrls, nameµÈÐÅÏ¢ + // ä¿¡æ�¯æœ€å…¨çš„map,包å�«mapping, handlerMethod, directUrls, name等信æ�¯ private final Map> registry = new HashMap<>(); - // ËùÓÐµÄ mapping map£¬/test/hello¡¢/test/{name} + // 所有的 mapping map,/test/helloã€�/test/{name} private final Map mappingLookup = new LinkedHashMap<>(); - // Ã÷È·µÄurl map£¬Èç /test/hello + // 明确的url map,如 /test/hello private final MultiValueMap urlLookup = new LinkedMultiValueMap<>(); - // Ê¡ÂÔÁ˺öà´úÂë + // çœ�略了好多代ç � ... public void register(T mapping, Object handler, Method method) { ... - // »ñÈ¡¶ÁÐ´ËøµÄÐ´Ëø + // 获å�–读写é”�的写é”� this.readWriteLock.writeLock().lock(); try { - // 1\. »ñÈ¡ÁË handlerMethod£¬Æäʵ¾ÍÊǽ«handler Óë method °ü×°ÁËÒ»²ã + // 1\. 获å�–了 handlerMethod,其实就是将handler 与 method 包装了一层 HandlerMethod handlerMethod = createHandlerMethod(handler, method); validateMethodMapping(handlerMethod, mapping); - // 2\. ·ÅÈë mappingLookup ÖУ¬ÀàÐÍΪ LinkedHashMap - // ÕâÊÇspringmvcÖÐÒ»¸öÖØÒªµÄmap + // 2\. 放入 mappingLookup 中,类型为 LinkedHashMap + // 这是springmvc中一个é‡�è¦�çš„map this.mappingLookup.put(mapping, handlerMethod); - // 3\. »ñÈ¡url£¬·ÅÈëurlLookup£¬ÀàÐÍΪMultiValueMap£¬Õâ¸ömap ͬһkey¿ÉÒÔÓжà¸övalue - // ÕâÊÇspringmvcÖÐÁíÒ»¸öÖØÒªµÄmap + // 3\. 获å�–url,放入urlLookup,类型为MultiValueMap,这个map å�Œä¸€keyå�¯ä»¥æœ‰å¤šä¸ªvalue + // 这是springmvc中å�¦ä¸€ä¸ªé‡�è¦�çš„map List directUrls = getDirectUrls(mapping); for (String url : directUrls) { this.urlLookup.add(url, mapping); @@ -457,8 +457,8 @@ public abstract class AbstractHandlerMethodMapping extends AbstractHandlerMap this.corsLookup.put(handlerMethod, corsConfig); } - // 4\. ½«mapping, handlerMethod, directUrls, nameµÈ·â×°·ÅÈëregistry£¬ - // registry ÀàÐÍΪHashMap£¬ÕâÊÇspringmvc ÖнӿÚÐÅÏ¢×îÈ«µÄÒ»¸ömap + // 4\. å°†mapping, handlerMethod, directUrls, nameç­‰å°�装放入registry, + // registry 类型为HashMap,这是springmvc 中接å�£ä¿¡æ�¯æœ€å…¨çš„一个map this.registry.put(mapping, new MappingRegistration<>(mapping, handlerMethod, directUrls, name)); } @@ -471,11 +471,11 @@ public abstract class AbstractHandlerMethodMapping extends AbstractHandlerMap ``` -¿ÉÒÔ¿´µ½£¬×¢²áµÄÂß¼­×îÖÕÊÇÔÚ `AbstractHandlerMethodMapping.MappingRegistry#register` ÖÐÍê³ÉµÄ¡£½ÓÏÂÀ´ÎÒÃǾÍÒ»²½²½·ÖÎö×¢²áÂß¼­¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œæ³¨å†Œçš„逻辑最终是在 `AbstractHandlerMethodMapping.MappingRegistry#register` 中完æˆ�的。接下æ�¥æˆ‘们就一步步分æž�注册逻辑。 -#### 3.1 »ñÈ¡ `HandlerMethod` +#### 3.1 获å�– `HandlerMethod` -Ïà¹Ø´úÂëÈçÏ£º +相关代ç �如下: ``` protected HandlerMethod createHandlerMethod(Object handler, Method method) { @@ -488,12 +488,12 @@ protected HandlerMethod createHandlerMethod(Object handler, Method method) { ``` -Õâ¶Î·½·¨¾ÍÊǼòµ¥µØµ÷ÓÃÁË `HandlerMethod` µÄ¹¹Ôì·½·¨£¬¼ÌÐø£º +这段方法就是简å�•地调用了 `HandlerMethod` 的构造方法,继续: ``` public class HandlerMethod { - // ÌṩÁ˷dz£¶àµÄÊôÐÔ + // æ��供了é�žå¸¸å¤šçš„属性 protected final Log logger = LogFactory.getLog(getClass()); private final Object bean; @Nullable @@ -512,7 +512,7 @@ public class HandlerMethod { private volatile List interfaceParameterAnnotations; private final String description; - // ¹¹Ôì·½·¨ + // 构造方法 public HandlerMethod(Object bean, Method method) { Assert.notNull(bean, "Bean is required"); Assert.notNull(method, "Method is required"); @@ -526,17 +526,17 @@ public class HandlerMethod { this.description = initDescription(this.beanType, this.method); } - // Ê¡ÂÔÆäËû + // çœ�略其他 ... } ``` -¿ÉÒÔ¿´µ½£¬`HandlerMethod` ÖÐÓзdz£¶àµÄÊôÐÔ£¬¹¹Ôì·½·¨Ëù×öµÄÊÂÒ²½ö½öÊǸ³Öµ¶øÒÑ¡£Óɴ˿ɿ´³ö£¬`HandlerMethod` ¾ÍÊÇ¶Ô `handler` Óë `method` µÄÒ»¸ö°ü×°¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`HandlerMethod` 中有é�žå¸¸å¤šçš„属性,构造方法所å�šçš„事也仅仅是赋值而已。由此å�¯çœ‹å‡ºï¼Œ`HandlerMethod` 就是对 `handler` 与 `method` 的一个包装。 -#### 3.2 ÑéÖ¤ mapping ÊÇ·ñÖØ¸´ +#### 3.2 验è¯� mapping 是å�¦é‡�å¤� -ÔÚ springmvc ʹÓÃÖУ¬Èç¹û²»Ð¡Ð͍ÒåÁËÁ½¸öÏàͬµÄ `requestMapping`£¬»á³öÏÖÈçÏÂÒì³££º +在 springmvc 使用中,如果ä¸�å°�心定义了两个相å�Œçš„ `requestMapping`,会出现如下异常: ``` Caused by: java.lang.IllegalStateException: Ambiguous mapping. Cannot map @@ -545,16 +545,16 @@ bean method xxxMethod mapped. ``` -Õâ¸öÒì³£¾ÍÊÇÔÚÑéÖ¤ mapping ʱ£¬·¢ÏÖÁËÖØ¸´ÁË mapping ¶ø´¥·¢µÄ£¬´úÂëÈçÏ£º +这个异常就是在验è¯� mapping 时,å�‘现了é‡�å¤�了 mapping 而触å�‘的,代ç �如下: ``` -// ËùÓÐµÄ mapping map£¬/test/hello¡¢/test/{name} +// 所有的 mapping map,/test/helloã€�/test/{name} private final Map mappingLookup = new LinkedHashMap<>(); private void validateMethodMapping(HandlerMethod handlerMethod, T mapping) { - // ÕÒµ½ÒÑ´æÔÚµÄ method + // 找到已存在的 method HandlerMethod existingHandlerMethod = this.mappingLookup.get(mapping); - // ÒÑ´æÔÚµÄhandlerMethod²»Îª¿Õ£¬ÇÒ²»µÈÓÚµ±Ç° handlerMethod + // 已存在的handlerMethodä¸�为空,且ä¸�等于当å‰� handlerMethod if (existingHandlerMethod != null && !existingHandlerMethod.equals(handlerMethod)) { throw new IllegalStateException( "Ambiguous mapping. Cannot map '" + handlerMethod.getBean() + "' method \n" + @@ -566,9 +566,9 @@ private void validateMethodMapping(HandlerMethod handlerMethod, T mapping) { ``` -Ê×ÏÈÊǸù¾Ý `mapping` ´Ó `mappingLookup` ÖвéÕÒ `HandlerMethod`£¬Èç¹ûÕÒµ½ÁËÇÒÕÒµ½µÄ `handlerMethod` ²»Êǵ±Ç° `handlerMethod`£¬Ôò±íÊ¾ÖØ¸´£¬¾Í±¨Òì³£ÁË¡£ +首先是根æ�® `mapping` 从 `mappingLookup` 中查找 `HandlerMethod`,如果找到了且找到的 `handlerMethod` ä¸�是当å‰� `handlerMethod`,则表示é‡�å¤�,就报异常了。 -×îºó·Ö±ðÀ´¿´¿´ÅÐ¶Ï `HandlerMethod` Óë `RequestMappingInfo` ÊÇÈçºÎÅжÏÏàµÈµÄ£º +最å�Žåˆ†åˆ«æ�¥çœ‹çœ‹åˆ¤æ–­ `HandlerMethod` 与 `RequestMappingInfo` 是如何判断相等的: > HandlerMethod#equals @@ -610,11 +610,11 @@ public boolean equals(@Nullable Object other) { ``` -`RequestMappingInfo` ÐèÒª¸÷ÊôÐÔÏàͬ²ÅÅжÏÏàµÈ£¬Òò´ËÏñÏÂÃæÕâÑùµÄ `@RequestMapping`£¬µÃµ½µÄ `RequestMappingInfo` ²¢²»ÏàµÈ£º +`RequestMappingInfo` 需è¦�å�„属性相å�Œæ‰�判断相等,因此åƒ�下é�¢è¿™æ ·çš„ `@RequestMapping`,得到的 `RequestMappingInfo` å¹¶ä¸�相等: ``` -// ÒÔÏÂÈý¸ö @RequestMapping£¬ËäÈ»ÇëÇó·¾¶¶¼ÊÇ¡°/hello¡±£¬µ«Ö§³ÖµÄÇëÇó·½·¨¸÷²»Ïàͬ -// Òò´ËµÃµ½µÄ RequestMappingInfo ²¢²»ÏàµÈ +// 以下三个 @RequestMapping,虽然请求路径都是“/helloâ€�,但支æŒ�的请求方法å�„ä¸�相å�Œ +// 因此得到的 RequestMappingInfo å¹¶ä¸�相等 @RequestMapping(path = "/hello") public String hello1() { @@ -633,11 +633,11 @@ public String hello3() { ``` -#### 3.3 »ñÈ¡ `directUrls` +#### 3.3 获å�– `directUrls` -springmvc ÖУ¬ÓÐÁ½ÖÖ url ÀàÐÍ: +springmvc 中,有两ç§� url 类型: -1. Ã÷È·µÄ url£¬Èç +1. 明确的 url,如 ``` @RequestMapping("/hello") @@ -647,7 +647,7 @@ springmvc ``` -2. ²»Ã÷È·µÄ url£¬Èç +2. ä¸�明确的 url,如 ``` @RequestMapping("/{name}") @@ -657,27 +657,27 @@ springmvc ``` -springmvc ÌṩÁËרÃÅµÄ `urlLookup` À´±£´æÃ÷È·µÄ url£¬½á¹¹ÈçÏ£º +springmvc æ��供了专门的 `urlLookup` æ�¥ä¿�存明确的 url,结构如下: ``` MultiValueMap> ``` -ÔÙÀ´¿´¿´ springmvc ÊÇÈçºÎ»ñÈ¡Ã÷È·µÄ url µÄ: +å†�æ�¥çœ‹çœ‹ springmvc 是如何获å�–明确的 url çš„: ``` List directUrls = getDirectUrls(mapping); /** * AbstractHandlerMethodMapping.MappingRegistry#getDirectUrls - * »ñÈ¡Ã÷È·µÄurl + * 获å�–明确的url */ private List getDirectUrls(T mapping) { List urls = new ArrayList<>(1); - // ´ÓRequestMappingInfo»ñÈ¡ËùÓÐµÄ MappingPathPattern + // 从RequestMappingInfo获å�–所有的 MappingPathPattern for (String path : getMappingPathPatterns(mapping)) { - // Åжϵõ½µÄ MappingPathPattern ÊÇ·ñΪÃ÷È·µÄurl + // 判断得到的 MappingPathPattern 是å�¦ä¸ºæ˜Žç¡®çš„url if (!getPathMatcher().isPattern(path)) { urls.add(path); } @@ -687,8 +687,8 @@ private List getDirectUrls(T mapping) { /** * RequestMappingInfoHandlerMapping#getMappingPathPatterns - * »ñÈ¡ patterns, ´Ó RequestMappingInfo »ñÈ¡ - * ʵ¼ÊÉϾÍÊÇ @RequestMapping ÖÐµÄ path() Öµ + * 获å�– patterns, 从 RequestMappingInfo 获å�– + * 实际上就是 @RequestMapping 中的 path() 值 */ @Override protected Set getMappingPathPatterns(RequestMappingInfo info) { @@ -697,8 +697,8 @@ protected Set getMappingPathPatterns(RequestMappingInfo info) { /** * AntPathMatcher#isPattern - * ÅжÏÊÇ·ñΪÃ÷È·µÄ url - * Ö»Òª°üº¬ÁË *¡¢£¿Ö®Ò»£¬»òͬʱ°üº¬{¡¢}£¬¾Í²»ÊÇÃ÷È·µÄurl + * 判断是å�¦ä¸ºæ˜Žç¡®çš„ url + * å�ªè¦�包å�«äº† *ã€�?之一,或å�Œæ—¶åŒ…å�«{ã€�},就ä¸�是明确的url */ @Override public boolean isPattern(@Nullable String path) { @@ -724,39 +724,39 @@ public boolean isPattern(@Nullable String path) { ``` -Á÷³ÌÈçÏ£º +æµ�程如下: -1. »ñÈ¡µ±Ç° `mapping` µÄËùÓÐ `path`£¬Ò²¾ÍÊÇ `@RequestMapping` µÄ `path()` Öµ£» -2. ±éÀúµÃµ½µÄ `path`£¬ÖðÒ»ÅжÏÊÇ·ñΪÃ÷È·µÄ url (Ö»Òª°üº¬ÁË `*`¡¢`?` Ö®Ò»£¬»òͬʱ°üº¬ `{`¡¢`}`£¬¾Í²»ÊÇÃ÷È·µÄ url). +1. 获å�–当å‰� `mapping` 的所有 `path`,也就是 `@RequestMapping` çš„ `path()` 值; +2. é��历得到的 `path`,é€�一判断是å�¦ä¸ºæ˜Žç¡®çš„ url (å�ªè¦�包å�«äº† `*`ã€�`?` 之一,或å�Œæ—¶åŒ…å�« `{`ã€�`}`,就ä¸�是明确的 url). -#### 3.4 ×¢²á½Ó¿ÚÐÅÏ¢ +#### 3.4 注册接å�£ä¿¡æ�¯ -×¢²á½Ó¿ÚÐÅÏ¢¾Í±È½Ï¼òµ¥ÁË£¬Æäʵ¾ÍÊÇÍù map ÖÐÌí¼ÓÊý¾Ý£¬ÕâÀï½éÉÜÈý¸ö map£º +注册接å�£ä¿¡æ�¯å°±æ¯”较简å�•了,其实就是往 map 中添加数æ�®ï¼Œè¿™é‡Œä»‹ç»�三个 map: -* `urlLookup`£ºÃ÷È·µÄ `url map`£¬ÀàÐÍΪ `MultiValueMap>`£¬`key` ΪÃ÷È·µÄ url£¬Èç `/test/hello`£¬`value` Ϊ `LinkedList`£» +* `urlLookup`:明确的 `url map`,类型为 `MultiValueMap>`,`key` 为明确的 url,如 `/test/hello`,`value` 为 `LinkedList`ï¼› -* `mappingLookup`£ºËùÓÐµÄ `mapping map`£¬ËùÓÐµÄ `@RequestMapping` ¶ÔÓ¦µÄ `RequestMappingInfo` ¶¼ÄÜÔÚÕâÀïÕÒµ½£¬°üÀ¨ `/test/hello`¡¢`/test/{name}` ¶ÔÓ¦µÄ `RequestMappingInfo`£¬ÀàÐÍΪ `Map`£» +* `mappingLookup`:所有的 `mapping map`,所有的 `@RequestMapping` 对应的 `RequestMappingInfo` 都能在这里找到,包括 `/test/hello`ã€�`/test/{name}` 对应的 `RequestMappingInfo`,类型为 `Map`ï¼› -* `registry`£ºÐÅÏ¢×îÈ«µÄ map£¬ÀàÐÍΪ `Map>`£¬°üº¬ËùÓÐµÄ `RequestMappingInfo`£¬key Ϊ `RequestMappingInfo`£¬value Ϊ `MappingRegistration`£¬¶ø `MappingRegistration` Ϊ `mapping`, `handlerMethod`, `directUrls`, `name` µÄ°ü×°À࣬Ҳ¾ÍÊÇ˵ `MappingRegistration` °üº¬ÁË `mapping`, `handlerMethod`, `directUrls`, `name` µÈÐÅÏ¢¡£ +* `registry`:信æ�¯æœ€å…¨çš„ map,类型为 `Map>`,包å�«æ‰€æœ‰çš„ `RequestMappingInfo`,key 为 `RequestMappingInfo`,value 为 `MappingRegistration`,而 `MappingRegistration` 为 `mapping`, `handlerMethod`, `directUrls`, `name` 的包装类,也就是说 `MappingRegistration` 包å�«äº† `mapping`, `handlerMethod`, `directUrls`, `name` 等信æ�¯ã€‚ -Àí½âÕâЩ map ºó£¬×¢²á¾ÍÏ൱¼òµ¥ÁË£¬¾ÍÊǼòµ¥µØµ÷ÓÃÏ `Map#put` ·½·¨£¬¾Í²»¶à˵ÁË¡£ +ç�†è§£è¿™äº› map å�Žï¼Œæ³¨å†Œå°±ç›¸å½“简å�•了,就是简å�•地调用下 `Map#put` 方法,就ä¸�多说了。 -### 4\. ×ܽá +### 4\. 总结 -±¾ÎÄ·ÖÎöÁË spring ´¦Àí´¦Àí `@RequestMapping` ×¢½âµÄÁ÷³Ì£¬Õⲿ·ÖÁ÷³ÌÔÚ `RequestMappingHandlerMapping#afterPropertiesSet` ·½·¨ÖУ¬Á÷³ÌÈçÏ£º +本文分æž�了 spring 处ç�†å¤„ç�† `@RequestMapping` 注解的æµ�程,这部分æµ�程在 `RequestMappingHandlerMapping#afterPropertiesSet` 方法中,æµ�程如下: -1. »ñÈ¡ÈÝÆ÷ÖÐËùÓÐ bean µÄ `beanName`£¬Öð¸ö´¦Àí£¬´¦Àí·½·¨¼ûµÚ 2 ²½£» -2. ÕÒµ½Óë `beanName` ¶ÔÓ¦µÄ `beanType`£¬ÅÐ¶ÏÆäÉÏÊÇ·ñÓÐ `@Controller/@RequestMapping` ×¢½â£» -3. ¶Ô°üº¬ `@Controller/@RequestMapping` µÄ `beanType`£¬ÕÒµ½ÓÐ `@RequestMapping` ×¢½âµÄ·½·¨£¬½«Æä `@RequestMapping` ×¢½â·âװΪ `RequestMappingInfo`£¬ÕâÒ»²½µÃµ½µÄ½á¹ûΪһ¸ö map£º`Map`£» -4. ½« `beanName`¡¢`beanType` Óë `Map` ×¢²áµ½ springmvc ÖУ¬ÕâÀïÓÐÈý¸ö±È½ÏÖØÒªµÄ map£º - * `MultiValueMap>`¡¢ - * `Map`(`HandlerMethod` Ϊ `Method` µÄ°ü×°Àà) - * `Map>`(`MappingRegistration` Ϊ `RequestMappingInfo`, `HandlerMethod`, `directUrls`, `beanName` µÄ°ü×°Àà)£» +1. 获å�–容器中所有 bean çš„ `beanName`,é€�个处ç�†ï¼Œå¤„ç�†æ–¹æ³•è§�第 2 步; +2. 找到与 `beanName` 对应的 `beanType`,判断其上是å�¦æœ‰ `@Controller/@RequestMapping` 注解; +3. 对包å�« `@Controller/@RequestMapping` çš„ `beanType`,找到有 `@RequestMapping` 注解的方法,将其 `@RequestMapping` 注解å°�装为 `RequestMappingInfo`,这一步得到的结果为一个 map:`Map`ï¼› +4. å°† `beanName`ã€�`beanType` 与 `Map` 注册到 springmvc 中,这里有三个比较é‡�è¦�çš„ map: + * `MultiValueMap>`ã€� + * `Map`(`HandlerMethod` 为 `Method` 的包装类) + * `Map>`(`MappingRegistration` 为 `RequestMappingInfo`, `HandlerMethod`, `directUrls`, `beanName` 的包装类)ï¼› ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fe807564e60040b262b28977a46a74f60e9.png) -×ܵÄÀ´Ëµ£¬`RequestMapping` µÄ´¦ÀíÁ÷³ÌÒþ²Ø±È½ÏÉ±¾ÈËÒ²Êǵ÷ÊÔÁ˺öà´Î²ÅÕÒµ½¡£ +总的æ�¥è¯´ï¼Œ`RequestMapping` 的处ç�†æµ�程éš�è—�比较深,本人也是调试了好多次æ‰�找到。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4715079](https://my.oschina.net/funcy/blog/4715079) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4715079](https://my.oschina.net/funcy/blog/4715079) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\346\225\264\344\275\223\346\272\220\347\240\201\347\273\223\346\236\204\346\200\273\347\273\223.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\346\225\264\344\275\223\346\272\220\347\240\201\347\273\223\346\236\204\346\200\273\347\273\223.md" index 7fdb68a..b9064af 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\346\225\264\344\275\223\346\272\220\347\240\201\347\273\223\346\236\204\346\200\273\347\273\223.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\346\225\264\344\275\223\346\272\220\347\240\201\347\273\223\346\236\204\346\200\273\347\273\223.md" @@ -1,25 +1,25 @@ -### 1\. servlet 3.0 ¹æ·¶ +### 1\. servlet 3.0 规范 -±¾ÏµÁÐÒ»¿ªÊ¼£¬ÏȽéÉÜÁË `servlet3.0` ¹æ·¶£¬Í¨¹ý¸Ã¹æ·¶£¬¿ÉÒÔÈÃÎÒÃÇʵÏÖ web ÏîÄ¿µÄ `0xml` ÅäÖÃ. +本系列一开始,先介ç»�了 `servlet3.0` 规范,通过该规范,å�¯ä»¥è®©æˆ‘们实现 web 项目的 `0xml` é…�ç½®. -* `servlet3.0` ¹æ·¶ÖУ¬servlet ͨ¹ý `SPI` »úÖÆÌṩÁËÒ»¸ö½Ó¿Ú£º`ServletContainerInitializer`£» -* spring ʵÏÖÁ˸ýӿڣ¬ÔÚÆäʵÏÖÀà `SpringServletContainerInitializer` µÄ `onStartup(...)` ·½·¨ÖУ¬»áÖ´ÐÐËùÓÐʵÏÖÁË `WebApplicationInitializer` ½Ó¿ÚµÄÀàµÄ `onStartup(...)` ·½·¨£¬×îÖÕÎÒÃÇÖ»ÐèҪʵÏÖ `WebApplicationInitializer` ½Ó¿Ú¼´¿É£» -* ÔÚÎÒÃÇ×ÔÖ÷ʵÏÖ `WebApplicationInitializer` ½Ó¿ÚµÄÀàÖУ¬ÔÚ `onStartup(...)` Ïò servlet ÈÝÆ÷ÖÐÊÖ¶¯×¢²áÁËÒ» ¸ö servlet£º`DispatcherServlet`£¬ÔÚÕâ¸ö servlet ÖлáÆô¶¯ spring ÈÝÆ÷£» +* `servlet3.0` 规范中,servlet 通过 `SPI` 机制æ��供了一个接å�£ï¼š`ServletContainerInitializer`ï¼› +* spring 实现了该接å�£ï¼Œåœ¨å…¶å®žçŽ°ç±» `SpringServletContainerInitializer` çš„ `onStartup(...)` 方法中,会执行所有实现了 `WebApplicationInitializer` 接å�£çš„类的 `onStartup(...)` 方法,最终我们å�ªéœ€è¦�实现 `WebApplicationInitializer` 接å�£å�³å�¯ï¼› +* 在我们自主实现 `WebApplicationInitializer` 接å�£çš„类中,在 `onStartup(...)` å�‘ servlet 容器中手动注册了一 个 servlet:`DispatcherServlet`,在这个 servlet 中会å�¯åЍ spring 容器; -ÒÔÉÏÕû¸öÁ÷³Ì¾ÍÕâÑù£º +以上整个æµ�程就这样: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0874fa7ef39ca9c405cdf55d99ca891ebf2.png) -### 2\. ÆôÓà webMvc µÄ·½Ê½ +### 2\. å�¯ç”¨ webMvc 的方å¼� -ÎÒÃÇ·ÖÎöÁËÆôÓà `webMvc` µÄÁ½ÖÖ·½Ê½£º +我们分æž�了å�¯ç”¨ `webMvc` 的两ç§�æ–¹å¼�: #### 1. `@EnableWebMvc` -ÕâÖÖ·½Ê½ºÜ¼òµ¥£¬Ö»ÐèÒªÕâÑù£º +è¿™ç§�æ–¹å¼�很简å�•,å�ªéœ€è¦�这样: ``` -// ʹÓÃ@EnableWebMvc×¢½âÆôÓÃmvc¹¦ÄÜ +// 使用@EnableWebMvc注解å�¯ç”¨mvc功能 @Component @EnableWebMvc public class MvcConfig { @@ -28,34 +28,34 @@ public class MvcConfig { ``` -Èç¹ûÎÒÃÇÒª´¦Àí webMvc µÄһЩÅäÖÃʱ£¬ÐèҪʵÏÖ `WebMvcConfigurer`: +如果我们è¦�处ç�† webMvc 的一些é…�置时,需è¦�实现 `WebMvcConfigurer`: ``` -// ʵÏÖ WebMvcConfigurer£¬Ìí¼Ó×Ô¶¨ÒåÅäÖà +// 实现 WebMvcConfigurer,添加自定义é…�ç½® @Component public class MyWebMvcConfigurer implements WebMvcConfigurer { - // ÖØÐ´WebMvcConfigurer·½·¨£¬´¦Àí×Ô¶¨ÒåÅäÖà + // é‡�写WebMvcConfigurer方法,处ç�†è‡ªå®šä¹‰é…�ç½® } ``` -#### 2\. ʵÏÖ `WebMvcConfigurationSupport` +#### 2\. 实现 `WebMvcConfigurationSupport` -»¹ÓÐÒ»ÖÖ·½Ê½ÆôÓà `webMvc` µÄ ·½Ê½ÊÇʵÏÖ `WebMvcConfigurationSupport`£º +还有一ç§�æ–¹å¼�å�¯ç”¨ `webMvc` çš„ æ–¹å¼�是实现 `WebMvcConfigurationSupport`: ``` @Component public class MyWebMvcConfigurationSupport extends WebMvcConfigurationSupport { - // ÖØÐ´ÅäÖ÷½·¨£¬´¦Àí×Ô¶¨ÒåÅäÖà + // é‡�写é…�置方法,处ç�†è‡ªå®šä¹‰é…�ç½® ... /** - * ±ÈÈ磬Ìí¼Ó¿çÓòÅäÖã¬Ö±½ÓÖØÐ´ addCorsMappings ·½·¨ + * 比如,添加跨域é…�置,直接é‡�写 addCorsMappings 方法 */ @Override public void addCorsMappings(CorsRegistry registry) { - // Ìí¼Ó×Ô¼ºµÄÅäÖà + // 添加自己的é…�ç½® ... } @@ -63,20 +63,20 @@ public class MyWebMvcConfigurationSupport extends WebMvcConfigurationSupport { ``` -ÐèҪעÒâµÄÊÇ£¬Ê¹ÓÃÕâÖÖ·½Ê½ºó£¬ÐèÒª´¦Àí×Ô¶¨ÒåÅäÖÃʱ£¬¾Í²»ÄÜÔÙȥʵÏÖ `WebMvcConfigurer` ½Ó¿ÚÁË£¬¶øÓ¦¸ÃÖ±½ÓÖØÐ´ `WebMvcConfigurationSupport` ÖеÄÏàÓ¦·½·¨£¬ÈçÉÏÃæÖØÐ´ `addCorsMappings()`. +需è¦�注æ„�的是,使用这ç§�æ–¹å¼�å�Žï¼Œéœ€è¦�处ç�†è‡ªå®šä¹‰é…�置时,就ä¸�能å†�去实现 `WebMvcConfigurer` 接å�£äº†ï¼Œè€Œåº”该直接é‡�写 `WebMvcConfigurationSupport` 中的相应方法,如上é�¢é‡�写 `addCorsMappings()`. -### 3\. Õû¸öÆô¶¯Á÷³Ì +### 3\. 整个å�¯åЍæµ�程 -ÓÃÒ»ÕÅͼÀ´×ܽáÕû¸öÆô¶¯Á÷³Ì£º +用一张图æ�¥æ€»ç»“整个å�¯åЍæµ�程: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-74d675bbae28247726b8d054e8758c3d8b1.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-aa6bb35d0ab26925c45c62ab4d709d05cdd.png) -### 4\. ÇëÇóÁ÷³Ì +### 4\. 请求æµ�程 -Ò²ÓÃÒ»ÕÅͼÀ´×ܽáÕû¸öÇëÇóÁ÷³Ì£º +也用一张图æ�¥æ€»ç»“整个请求æµ�程: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-024b75e7f7952dbf1ace7aa5a8cfe3bcb77.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4773418](https://my.oschina.net/funcy/blog/4773418) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4773418](https://my.oschina.net/funcy/blog/4773418) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\347\232\204Demo\344\270\216@EnableWebMvc\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\347\232\204Demo\344\270\216@EnableWebMvc\346\263\250\350\247\243.md" index 2682d3d..f8a3b31 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\347\232\204Demo\344\270\216@EnableWebMvc\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/SpringMVC\347\232\204Demo\344\270\216@EnableWebMvc\346\263\250\350\247\243.md" @@ -1,19 +1,19 @@ -### 1\. demo ×¼±¸ +### 1\. demo 准备 -ΪÁ˸üºÃµØ·ÖÎö springmvc Ïà¹ØÔ´Â룬ÎÒÃÇÐèÒªÏÈ×¼±¸Ò»¸ö springmvc µÄ demo£¬ÕâÀïµÄ demo »¹ÊÇ·ÅÔÚ `spring-learn` Ä£¿é¡£ +为了更好地分æž� springmvc 相关æº�ç �,我们需è¦�先准备一个 springmvc çš„ demo,这里的 demo 还是放在 `spring-learn` 模å�—。 -#### 1\. ÒýÈë tomcat °ü +#### 1\. 引入 tomcat 包 -ÔÚ tomcat 8 Ö®ºó£¬tomcat ÌṩÁ˶ÀÁ¢µÄÔËÐаü£¬ÐèҪʱֱ½ÓÒýÈëÏà¹ØÒÀÀµ¾Í¿ÉÒÔÁË£¬¶ÔÓ¦µÄ gradle ÒÀÀµÈçÏÂ: +在 tomcat 8 之å�Žï¼Œtomcat æ��供了独立的è¿�行包,需è¦�时直接引入相关ä¾�èµ–å°±å�¯ä»¥äº†ï¼Œå¯¹åº”çš„ gradle ä¾�赖如下: ``` optional("org.apache.tomcat.embed:tomcat-embed-core") ``` -ÔÚ spring ÏîÄ¿µÄ `build.gradle` ÖУ¬ÒѾ­ÒýÈëÁË `tomcat-embed-core-9.0.29.jar`£¬Òò´ËÔÚ `spring-learn` Ä£¿éÖÐÒýÈëʱ²»ÓÃÔÙÖ¸¶¨°æ±¾¡£ +在 spring 项目的 `build.gradle` 中,已ç»�引入了 `tomcat-embed-core-9.0.29.jar`,因此在 `spring-learn` 模å�—中引入时ä¸�用å†�指定版本。 -#### 2\. ×¼±¸ÅäÖÃÀà +#### 2\. 准备é…�置类 ``` package org.springframework.learn.mvc.demo01; @@ -31,9 +31,9 @@ public class MvcConfig { ``` -ÅäÖÃÀàΪ `MvcConfig`£¬¸ÃÀàÖ¸¶¨ÁËÏîÄ¿µÄ°üɨÃè·¾¶£¬ÒÔ¼°Í¨¹ý `@EnableWebMvc` ¿ªÆô mvc ¹¦ÄÜ¡£ +é…�置类为 `MvcConfig`,该类指定了项目的包扫æ��路径,以å�Šé€šè¿‡ `@EnableWebMvc` å¼€å�¯ mvc 功能。 -#### 3\. ʵÏÖ `WebApplicationInitializer` +#### 3\. 实现 `WebApplicationInitializer` ``` package org.springframework.learn.mvc.demo01; @@ -61,9 +61,9 @@ public class MyWebApplicationInitializer implements WebApplicationInitializer { ``` -spring ÌṩÁËÒ»¸ö½Ó¿Ú ¡ª¡ª`WebApplicationInitializer`£¬ÊµÏָýӿÚʱ£¬ÎÒÃÇÔÚ `onStartup(...)` ·½·¨Öд´½¨ spring µÄ `applicationContext`£¬È»ºóÍù servelet ÖÐ×¢²á `DispatcherServlet`¡£ +spring æ��供了一个接å�£ ——`WebApplicationInitializer`,实现该接å�£æ—¶ï¼Œæˆ‘们在 `onStartup(...)` 方法中创建 spring çš„ `applicationContext`,然å�Žå¾€ servelet 中注册 `DispatcherServlet`。 -#### 4\. ×¼±¸ controller +#### 4\. 准备 controller ``` package org.springframework.learn.mvc.demo01; @@ -84,11 +84,11 @@ public class TestController { ``` -ÕâÀï×¼±¸ÁËÒ»¸ö¼òµ¥µÄ controller£¬·µ»ØÒ»¸ö×Ö·û´® "hello world". +这里准备了一个简å�•çš„ controller,返回一个字符串 "hello world". -#### 5\. Ö÷Àà +#### 5\. 主类 -½ÓÏÂÀ´¾ÍÊÇÖ÷ÀàÁË£º +接下æ�¥å°±æ˜¯ä¸»ç±»äº†ï¼š ``` package org.springframework.learn.mvc.demo01; @@ -120,35 +120,35 @@ public class MvcDemo01Main { ``` -ÔÚ `main` ·½·¨ÖУ¬Ö÷Òª´¦Àí tomcat Æô¶¯Âß¼­¡£ +在 `main` 方法中,主è¦�处ç�† tomcat å�¯åŠ¨é€»è¾‘ã€‚ -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: -¿ØÖÆÌ¨£º +控制å�°ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8d13bb650364488f8ce5e593eff00448ee1.png) -Ò³Ãæ·µ»Ø£º +页é�¢è¿”回: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6a8407a1945dccd6e4ef217a383d4309ec5.png) -¿ÉÒÔ¿´µ½£¬Ò»¸ö¼òµ¥µÄ springmvc ÏîÄ¿¾Í´î½¨Íê³ÉÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œä¸€ä¸ªç®€å�•çš„ springmvc 项目就æ�­å»ºå®Œæˆ�了。 -### 2. `servlet 3.0` ¹æ·¶½éÉÜ +### 2. `servlet 3.0` 规范介ç»� -»ØÒäϹÅÀ쵀 springmvc ÏîÄ¿£¬Ò»°ãÓÐÕ⼸¸ö xml ÅäÖÃÎļþ£º +回忆下å�¤è€�çš„ springmvc 项目,一般有这几个 xml é…�置文件: -* `web.xml`£»servlet ÅäÖÃÎļþ£¬ÅäÖà web Æô¶¯Ê±µÄ²Ù×÷£¬ÒÔ¼° `servlet`/`listener`/`filter`; -* `spring.xml`£ºspring ÈÝÆ÷µÄÅäÖÃÎļþ£¬Ö÷ÒªÓÃÀ´ÅäÖà spring bean. -* `spring-mvc.xml`£ºspringmvc ÅäÖÃÎļþ£¬ÓÃÀ´ÅäÖà mvc Ïà¹ØµÄ bean£¬ÈçÎļþÉÏ´«Ïà¹ØµÄ bean£¬ÊÓͼ½âÎö bean£¬controller °ü·¾¶µÈ¡£ +* `web.xml`ï¼›servlet é…�置文件,é…�ç½® web å�¯åŠ¨æ—¶çš„æ“�作,以å�Š `servlet`/`listener`/`filter`; +* `spring.xml`:spring 容器的é…�置文件,主è¦�用æ�¥é…�ç½® spring bean. +* `spring-mvc.xml`:springmvc é…�置文件,用æ�¥é…�ç½® mvc 相关的 bean,如文件上传相关的 bean,视图解æž� bean,controller 包路径等。 -ÏîÄ¿ÔÚÆô¶¯Ê±£¬»áÏȼÓÔØ `web.xml`£¬ÔÚ `web.xml` ÖмÓÔØ spring Ïà¹ØÅäÖã¬Æô¶¯ spring ÈÝÆ÷¡£ +项目在å�¯åŠ¨æ—¶ï¼Œä¼šå…ˆåŠ è½½ `web.xml`,在 `web.xml` 中加载 spring 相关é…�置,å�¯åЍ spring 容器。 -ÔÚÉÏÃæµÄ demo ÖУ¬ÎÒÃÇ·¢ÏÖ²¢ ûÓÐÕâЩÅäÖã¬ÉõÖÁÁ¬ `web.xml` Îļþ¶¼Ã»ÓУ¡ÄÇô£¬ÉÏÃæµÄ web ÏîÄ¿ÊÇÔõôÆô¶¯µÄÄØ£¿ +在上é�¢çš„ demo 中,我们å�‘现并 没有这些é…�置,甚至连 `web.xml` 文件都没有ï¼�那么,上é�¢çš„ web 项目是怎么å�¯åŠ¨çš„å‘¢ï¼Ÿ -ÔÚ `servlet` ÔÚ `3.0` Ö®ºó£¬ÌṩÁËÒ»¸ö spi ¹æ·¶£¬spring ¶ÔÆäʵÏÖÈçÏ£º +在 `servlet` 在 `3.0` 之å�Žï¼Œæ��供了一个 spi 规范,spring 对其实现如下: -1. ÔÚ `spring-web` Ä£¿éµÄ `/src/main/resources/META-INF/services/` Îļþ¼ÐÏ£¬´´½¨Îļþ `javax.servlet.ServletContainerInitializer`£¬ÄÚÈÝÈçÏ +1. 在 `spring-web` 模å�—çš„ `/src/main/resources/META-INF/services/` 文件夹下,创建文件 `javax.servlet.ServletContainerInitializer`,内容如下 ``` org.springframework.web.SpringServletContainerInitializer @@ -157,19 +157,19 @@ org.springframework.web.SpringServletContainerInitializer ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-92853ebc9c4388d325244b81557ecf80ddd.png) -1. `org.springframework.web.SpringServletContainerInitializer` ʵÏÖÁË servlet ¹æ·¶£º +1. `org.springframework.web.SpringServletContainerInitializer` 实现了 servlet 规范: ``` -// @HandlesTypes ×¢½âÀ´×ÔÓÚservlet¹æ·¶£¬±íʾ webAppInitializerClass Ϊ WebApplicationInitializer.class +// @HandlesTypes 注解æ�¥è‡ªäºŽservlet规范,表示 webAppInitializerClass 为 WebApplicationInitializer.class @HandlesTypes(WebApplicationInitializer.class) public class SpringServletContainerInitializer implements ServletContainerInitializer { /* - * ÖØÐ´ ServletContainerInitializer µÄ onStartup ·½·¨ - * ÔÚÕâ¸ö·½·¨ÀÖ÷ÒªÊÇʵÀý»¯ spring ÌṩµÄ WebApplicationInitializer.class£¬È»ºóÖ´ÐÐÆä onStartup ·½·¨ + * é‡�写 ServletContainerInitializer çš„ onStartup 方法 + * 在这个方法里,主è¦�是实例化 spring æ��供的 WebApplicationInitializer.class,然å�Žæ‰§è¡Œå…¶ onStartup 方法 * - * Set> webAppInitializerClasses ÖеÄÀàÐÍΪ WebApplicationInitializer.class£¬ - * Õâ¸öÀàÐÍÓÉ @HandlesTypes ×¢½âÖ¸¶¨ + * Set> webAppInitializerClasses 中的类型为 WebApplicationInitializer.class, + * 这个类型由 @HandlesTypes 注解指定 */ @Override public void onStartup(@Nullable Set> webAppInitializerClasses, ServletContext servletContext) @@ -182,7 +182,7 @@ public class SpringServletContainerInitializer implements ServletContainerInitia if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) && WebApplicationInitializer.class.isAssignableFrom(waiClass)) { try { - // ʹÓ÷´ÉäʵÀý»¯ WebApplicationInitializer µÄʵÏÖÀ࣬Ìí¼Óµ½ initializers ÖÐ + // 使用å��射实例化 WebApplicationInitializer 的实现类,添加到 initializers 中 initializers.add((WebApplicationInitializer) ReflectionUtils.accessibleConstructor(waiClass).newInstance()); } @@ -194,10 +194,10 @@ public class SpringServletContainerInitializer implements ServletContainerInitia } servletContext.log(initializers.size() + " ..."); - // ÅÅÐò£¬ÊµÏÖÁËOrderd½Ó¿Ú£¬±ê×¢ @Order ×¢½â£¬»òʵÏÖÁË PriorityOrderd ½Ó¿Ú + // 排åº�,实现了Orderd接å�£ï¼Œæ ‡æ³¨ @Order 注解,或实现了 PriorityOrderd 接å�£ AnnotationAwareOrderComparator.sort(initializers); for (WebApplicationInitializer initializer : initializers) { - // µ÷Óà WebApplicationInitializer ʵÏÖÀàµÄonStartup·½·¨ + // 调用 WebApplicationInitializer 实现类的onStartup方法 initializer.onStartup(servletContext); } } @@ -206,7 +206,7 @@ public class SpringServletContainerInitializer implements ServletContainerInitia ``` -1. `WebApplicationInitializer` µÄʵÏÖ ÎÒÃÇÀ´¿´¿´ demo ÖÐ¶Ô `WebApplicationInitializer` µÄʵÏÖ£º +1. `WebApplicationInitializer` 的实现 我们æ�¥çœ‹çœ‹ demo 中对 `WebApplicationInitializer` 的实现: ``` package org.springframework.learn.mvc.demo01; @@ -221,15 +221,15 @@ import javax.servlet.ServletRegistration; public class MyWebApplicationInitializer implements WebApplicationInitializer { /* - * ÔÚÕâÀïÆô¶¯ spring ÏîÄ¿ + * 在这里å�¯åЍ spring 项目 */ @Override public void onStartup(ServletContext servletContext) { - // ´´½¨ spring µÄ ApplicationContext + // 创建 spring çš„ ApplicationContext AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext(); context.register(MvcConfig.class); - // Ìí¼Ó DispatcherServlet µ½ servlet ÖÐ + // 添加 DispatcherServlet 到 servlet 中 DispatcherServlet servlet = new DispatcherServlet(context); ServletRegistration.Dynamic registration = servletContext.addServlet("app", servlet); registration.setLoadOnStartup(1); @@ -239,15 +239,15 @@ public class MyWebApplicationInitializer implements WebApplicationInitializer { ``` -×îÖÕÖ´Ðйý³ÌÈçÏ£º +最终执行过程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0874fa7ef39ca9c405cdf55d99ca891ebf2.png) -ÓÉ´Ë£¬spring ÈÝÆ÷¾ÍÆô¶¯ÁË¡£ +由此,spring 容器就å�¯åŠ¨äº†ã€‚ -### 3\. @EnableWebMvc ×÷Óà +### 3\. @EnableWebMvc 作用 -ÔÚ demo ÖУ¬ÎÒÃÇͨ¹ý `@EnableWebMvc` À´Æô¶¯ mvc ¹¦ÄÜ£¬ÄÇôÕâ¸ö×¢½â×öÁËÊ²Ã´ÄØ£¿ÎÒÃǽøÈë `EnableWebMvc` Àࣺ +在 demo 中,我们通过 `@EnableWebMvc` æ�¥å�¯åЍ mvc 功能,那么这个注解å�šäº†ä»€ä¹ˆå‘¢ï¼Ÿæˆ‘们进入 `EnableWebMvc` 类: ``` @Retention(RetentionPolicy.RUNTIME) @@ -259,7 +259,7 @@ public @interface EnableWebMvc { ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö×¢½âͨ¹ý `@Import` ×¢½âÒýÈëÁË `DelegatingWebMvcConfiguration.class`£¬ÎÒÃÇÔÙÀ´¿´¿´ `DelegatingWebMvcConfiguration`: +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ³¨è§£é€šè¿‡ `@Import` 注解引入了 `DelegatingWebMvcConfiguration.class`,我们å†�æ�¥çœ‹çœ‹ `DelegatingWebMvcConfiguration`: ``` @Configuration(proxyBeanMethods = false) @@ -270,27 +270,27 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { ``` -Õâ¸öÀà±êÓÐ `@Configuration` ×¢½â£¬±íÃ÷ÕâÊǸöÅäÖÃÀ࣬Õâ¸öÀà¼Ì³ÐµÄÊÇ `WebMvcConfigurationSupport`£¬´ÓÃû×ÖÀ´¿´£¬`WebMvcConfigurationSupport` Ϊ "mvc ÅäÖÃÖ§³Ö"£¬Õâ±íÃ÷Õâ¸öÀàÊÇÓÃÀ´Öô¦Àí mvc Ïà¹ØµÄÅäÖõġ£ +这个类标有 `@Configuration` 注解,表明这是个é…�置类,这个类继承的是 `WebMvcConfigurationSupport`,从å��å­—æ�¥çœ‹ï¼Œ`WebMvcConfigurationSupport` 为 "mvc é…�置支æŒ�",这表明这个类是用æ�¥ç½®å¤„ç�† mvc 相关的é…�置的。 -ΪÁ˸üºÃµØ·ÖÎö£¬ÕâÀïÏȽéÉܼ¸¸öÀࣺ +为了更好地分æž�,这里先介ç»�几个类: -1. `DelegatingWebMvcConfiguration`£ºÓÉ `@EnableWebMvc` ÒýÈëµÄÀ࣬ÊÇ `WebMvcConfigurationSupport` µÄ×ÓÀà£¬ÖØÐ´ÁË `WebMvcConfigurationSupport` ÌṩµÄÅäÖ÷½·¨£º +1. `DelegatingWebMvcConfiguration`:由 `@EnableWebMvc` 引入的类,是 `WebMvcConfigurationSupport` çš„å­�类,é‡�写了 `WebMvcConfigurationSupport` æ��供的é…�置方法: ``` /* - * @Configuration£º±íÃ÷ÕâÊǸöÅäÖÃÀà - * extends WebMvcConfigurationSupport£º¼Ì³ÐÁËWebMvcConfigurationSupportÀà + * @Configuration:表明这是个é…�置类 + * extends WebMvcConfigurationSupport:继承了WebMvcConfigurationSupportç±» */ @Configuration(proxyBeanMethods = false) public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { - // WebMvcConfigurerComposite ÊÇ WebMvcConfigurer µÄ×éºÏ£¬ÏÂÃæ»áÌáµ½ + // WebMvcConfigurerComposite 是 WebMvcConfigurer 的组å�ˆï¼Œä¸‹é�¢ä¼šæ��到 private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite(); /** - * ÉèÖÃconfigurers - * Ìí¼ÓÁË@Autowired×¢½â£¬±íʾ½«springÈÝÆ÷ÖеÄËùÓÐWebMvcConfigurer bean ×÷Ϊ - * ²ÎÊýconfigurersµÄÖµ £¬È»ºóµ÷Óø÷½·¨ + * 设置configurers + * 添加了@Autowired注解,表示将spring容器中的所有WebMvcConfigurer bean 作为 + * å�‚æ•°configurers的值 ,然å�Žè°ƒç”¨è¯¥æ–¹æ³• */ @Autowired(required = false) public void setConfigurers(List configurers) { @@ -300,35 +300,35 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { } /** - * ÅäÖÃPathMatch + * é…�ç½®PathMatch */ @Override protected void configurePathMatch(PathMatchConfigurer configurer) { - // µ÷Óà WebMvcConfigurerComposite µÄ·½·¨½øÐÐÅäÖà + // 调用 WebMvcConfigurerComposite 的方法进行é…�ç½® this.configurers.configurePathMatch(configurer); } - // ÆäËûÅäÖ÷½·¨Ò²Êǵ÷Óà WebMvcConfigurerComposite ¶ÔÓ¦µÄ·½·¨½øÐÐÅäÖÃµÄ + // å…¶ä»–é…�置方法也是调用 WebMvcConfigurerComposite 对应的方法进行é…�置的 ... } ``` -2. `WebMvcConfigurerComposite`£º`WebMvcConfigurer` µÄ×éºÏ£º +2. `WebMvcConfigurerComposite`:`WebMvcConfigurer` 的组å�ˆï¼š ``` /** - * ʵÏÖÁË WebMvcConfigurer + * 实现了 WebMvcConfigurer */ class WebMvcConfigurerComposite implements WebMvcConfigurer { - // delegatesÊôÐÔΪ WebMvcConfigurer µÄ¼¯ºÏ + // delegates属性为 WebMvcConfigurer 的集å�ˆ private final List delegates = new ArrayList<>(); /* - * ±»DelegatingWebMvcConfiguration#setConfigurersµ÷Óà - * ×îÖÕÊǰѴ«ÈëµÄconfigurersÌí¼Óµ½delegates(Ò²¾ÍÊÇWebMvcConfigurer¼¯ºÏ)ÖÐ + * 被DelegatingWebMvcConfiguration#setConfigurers调用 + * 最终是把传入的configurers添加到delegates(也就是WebMvcConfigurer集å�ˆ)中 */ public void addWebMvcConfigurers(List configurers) { if (!CollectionUtils.isEmpty(configurers)) { @@ -337,8 +337,8 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { } /** - * ÅäÖÃʱ£¬»á±éÀúdelegates(Ò²¾ÍÊÇWebMvcConfigurer¼¯ºÏ)£¬½«´«ÈëµÄÅäÖÃÉèÖõ½ - * ¼¯ºÏÖеÄÿһ¸öWebMvcConfigurer + * é…�置时,会é��历delegates(也就是WebMvcConfigurer集å�ˆ),将传入的é…�置设置到 + * 集å�ˆä¸­çš„æ¯�一个WebMvcConfigurer */ @Override public void configurePathMatch(PathMatchConfigurer configurer) { @@ -347,13 +347,13 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { } } - // ÆäËûÅäÖÃÀàËÆ£¬Ê¡ÂÔ + // å…¶ä»–é…�置类似,çœ�ç•¥ ... } ``` -3. `WebMvcConfigurer`£ºspringmvc µÄÅäÖýӿڣ¬ÌṩÁ˷dz£¶àµÄÅäÖà +3. `WebMvcConfigurer`:springmvc çš„é…�置接å�£ï¼Œæ��供了é�žå¸¸å¤šçš„é…�ç½® ``` public interface WebMvcConfigurer { @@ -372,15 +372,15 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { ``` -4. `WebMvcConfigurationSupport`£ºspringmvc µÄÅäÖÃÖ§³ÖÀà +4. `WebMvcConfigurationSupport`:springmvc çš„é…�置支æŒ�ç±» ``` /** - * ʵÏÖÁËÁ½¸öaware½Ó¿Ú + * 实现了两个aware接å�£ */ public class WebMvcConfigurationSupport implements ApplicationContextAware, ServletContextAware { - //================= À´×Ô XxxAware ½Ó¿ÚµÄ·½·¨ ================= + //================= æ�¥è‡ª XxxAware 接å�£çš„æ–¹æ³• ================= @Override public void setApplicationContext(@Nullable ApplicationContext applicationContext) { this.applicationContext = applicationContext; @@ -391,17 +391,17 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { this.servletContext = servletContext; } - //================= @Bean ·½·¨£¬ÏòspringÖÐÌí¼Ó bean ================= + //================= @Bean 方法,å�‘spring中添加 bean ================= @Bean public RequestMappingHandlerMapping requestMappingHandlerMapping(...) { RequestMappingHandlerMapping mapping = createRequestMappingHandlerMapping(); mapping.setOrder(0); - // getInterceptors(...) »ñÈ¡ interceptors£¬ÍùÏ¿´ + // getInterceptors(...) 获å�– interceptors,往下看 mapping.setInterceptors(getInterceptors(conversionService, resourceUrlProvider)); mapping.setContentNegotiationManager(contentNegotiationManager); - // getCorsConfigurations(...) »ñÈ¡CorsÅäÖã¬ÍùÏ¿´ + // getCorsConfigurations(...) 获å�–Corsé…�置,往下看 mapping.setCorsConfigurations(getCorsConfigurations()); - // getPathMatchConfigurer(...) »ñÈ¡PathMatchÅäÖã¬ÍùÏ¿´ + // getPathMatchConfigurer(...) 获å�–PathMatché…�置,往下看 PathMatchConfigurer configurer = getPathMatchConfigurer(); ... @@ -409,14 +409,14 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { return mapping; } ... - //================= get xxx ÅäÖ÷½·¨£¬Ìí¼ÓspringÌṩµÄĬÈÏÅäÖã¬Ìí¼Ó×Ô¶¨ÒåÅäÖà ======= - // »ñÈ¡ interceptors + //================= get xxx é…�置方法,添加springæ��供的默认é…�置,添加自定义é…�ç½® ======= + // 获å�– interceptors protected final Object[] getInterceptors( FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) { if (this.interceptors == null) { InterceptorRegistry registry = new InterceptorRegistry(); - // µ÷ÓÃÅäÖ÷½·¨£¬Ìí¼Ó interceptor£¬ÍùÏ¿´ + // 调用é…�置方法,添加 interceptor,往下看 addInterceptors(registry); registry.addInterceptor(new ConversionServiceExposingInterceptor(mvcConversionService)); registry.addInterceptor(new ResourceUrlProviderExposingInterceptor(mvcResourceUrlProvider)); @@ -425,18 +425,18 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { return this.interceptors.toArray(); } - // »ñÈ¡CorsÅäÖà + // 获å�–Corsé…�ç½® protected final Map getCorsConfigurations() { if (this.corsConfigurations == null) { CorsRegistry registry = new CorsRegistry(); - // µ÷ÓÃÅäÖ÷½·¨£¬Ìí¼Ó CorsMapping£¬ÍùÏ¿´ + // 调用é…�置方法,添加 CorsMapping,往下看 addCorsMappings(registry); this.corsConfigurations = registry.getCorsConfigurations(); } return this.corsConfigurations; } - // »ñÈ¡PathMatchÅäÖà + // 获å�–PathMatché…�ç½® protected PathMatchConfigurer getPathMatchConfigurer() { if (this.pathMatchConfigurer == null) { this.pathMatchConfigurer = new PathMatchConfigurer(); @@ -447,16 +447,16 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { ... - //================= ÅäÖ÷½·¨£¬Áô´ý×ÓÀàʵÏÖ ================= - // Ìí¼Ó×Ô¶¨Òå Interceptor£¬´ý×ÓÀàʵÏÖ + //================= é…�置方法,留待å­�类实现 ================= + // 添加自定义 Interceptor,待å­�类实现 protected void addInterceptors(InterceptorRegistry registry) { } - // Ìí¼Ó×Ô¶¨Òå CorsMapping£¬´ý×ÓÀàʵÏÖ + // 添加自定义 CorsMapping,待å­�类实现 protected void addCorsMappings(CorsRegistry registry) { } - // ÅäÖÃ×Ô¶¨Òå PathMatch + // é…�置自定义 PathMatch protected void configurePathMatch(PathMatchConfigurer configurer) { } ... @@ -465,91 +465,91 @@ public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport { ``` - ¿ÉÒÔ¿´µ½£¬Õâ¸öÀàµÄ·½·¨·ÖΪËÄÀࣺ + å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªç±»çš„æ–¹æ³•分为四类: - * À´×Ô `XxxAware` µÄ·½·¨£º`XxxAware` ½Ó¿ÚÓÉ spring Ìṩ£¬bean ³õʼ»¯Íê³Éʱ´¦Àí»Øµ÷£» - * ÓÐ `@Bean` ×¢½âµÄ·½·¨£ºÍù spring ÖÐÌí¼Ó bean£¬Éú³É bean ʱ»áµ÷Óà `getXxx` ·½·¨£» - * `getXxx` ·½·¨£º»ñÈ¡ÅäÖ÷½·¨£¬Ôڸ÷½·¨ÖУ¬»áÌí¼Ó spring ÌṩµÄĬÈÏÅäÖã¬ÒÔ¼°µ÷Óà `addXxx/configureXxx` ·½·¨Ìí¼Ó×Ô¶¨ÒåÅäÖã» - * `addXxx/configureXxx` ·½·¨£ºÓÉ×ÓÀàʵÏÖ£¬¿ÉÒÔÏò springmvc ÖÐÌí¼Ó×Ô¶¨ÒåÅäÖᣠ+ * æ�¥è‡ª `XxxAware` 的方法:`XxxAware` 接å�£ç”± spring æ��供,bean åˆ�始化完æˆ�时处ç�†å›žè°ƒï¼› + * 有 `@Bean` 注解的方法:往 spring 中添加 bean,生æˆ� bean 时会调用 `getXxx` 方法; + * `getXxx` 方法:获å�–é…�置方法,在该方法中,会添加 spring æ��供的默认é…�置,以å�Šè°ƒç”¨ `addXxx/configureXxx` 方法添加自定义é…�置; + * `addXxx/configureXxx` 方法:由å­�类实现,å�¯ä»¥å�‘ springmvc 中添加自定义é…�置。 -ÕâÀï×ܽáÏÂÕâ 4 ¸öÀàµÄ¹ØÏµ£º +这里总结下这 4 个类的关系: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-5e25e6e7303044e7282b3472492c04cf656.png) -ÀíÇåÁËÕâËĸöÀàµÄ¹ØÏµ£¬`@EnableWebMvc` µÄÖ´ÐÐÁ÷³Ì¾ÍһĿÁËÈ»ÁË£¬ÕâÀï×ܽáÈçÏ£º +ç�†æ¸…了这四个类的关系,`@EnableWebMvc` 的执行æµ�程就一目了然了,这里总结如下: -1. `@EnableWebMvc` Ïò spring ÈÝÆ÷ÖÐÒýÈëÁË` DelegatingWebMvcConfiguration`£» +1. `@EnableWebMvc` å�‘ spring 容器中引入了` DelegatingWebMvcConfiguration`ï¼› -2. `DelegatingWebMvcConfiguration` ÖÐÓаüº¬ `@Autowired` ×¢½âµÄ·½·¨ `setConfigurers(List)`£¬ÔÚ spring bean µÄÖÜÆÚÖлá¶ÔÆäÖ´ÐУ¬×÷ÓÃΪ»ñÈ¡ÈÝÆ÷ÖÐËùÓÐ `WebMvcConfigurer` µÄ bean ½«ÆäÉèÖõ½` DelegatingWebMvcConfiguration` µÄÊôÐÔÖУ» +2. `DelegatingWebMvcConfiguration` 中有包å�« `@Autowired` 注解的方法 `setConfigurers(List)`,在 spring bean 的周期中会对其执行,作用为获å�–容器中所有 `WebMvcConfigurer` çš„ bean 将其设置到` DelegatingWebMvcConfiguration` 的属性中; -3. `DelegatingWebMvcConfiguration` ¼Ì³ÐÁË `WebMvcConfigurationSupport`£¬ÔÚ spring bean µÄÖÜÆÚÖлᴦÀí `WebMvcConfigurationSupport` ÖÐÓÐ `@Bean` ×¢½âµÄ·½·¨£¬ÕâÖÖ·½·¨±È½Ï¶à£¬Èç `requestMappingHandlerMapping()`¡¢`mvcPathMatcher` µÈ£¬ÕâЩ¶¼ÊÇ smvc µÄ¹¦ÄÜ×é¼þ£» +3. `DelegatingWebMvcConfiguration` 继承了 `WebMvcConfigurationSupport`,在 spring bean 的周期中会处ç�† `WebMvcConfigurationSupport` 中有 `@Bean` 注解的方法,这ç§�方法比较多,如 `requestMappingHandlerMapping()`ã€�`mvcPathMatcher` 等,这些都是 smvc 的功能组件; -4. ÔÚ´¦Àí `WebMvcConfigurationSupport` ÖÐÓÐ `@Bean` ×¢½âµÄ·½·¨Ê±£¬»áµ÷Óà `getXxx()` »ñÈ¡Ïà¹ØÅäÖ㬸ÃÅäÖðüÀ¨ spring ÌṩµÄĬÈÏÅäÖü°×Ô¶¨ÒåÅäÖã¬`getXxx()` ÓÉ `WebMvcConfigurationSupport` Ìṩ£» +4. 在处ç�† `WebMvcConfigurationSupport` 中有 `@Bean` 注解的方法时,会调用 `getXxx()` 获å�–相关é…�置,该é…�置包括 spring æ��供的默认é…�ç½®å�Šè‡ªå®šä¹‰é…�置,`getXxx()` ç”± `WebMvcConfigurationSupport` æ��供; -5. ÔÚµ÷Óà `WebMvcConfigurationSupport#getXxx()` »ñÈ¡×Ô¶¨ÒåÅäÖÃʱ£¬»áµ÷Óà `addXxx()/configureXxx()`£¬¸Ã·½·¨ÔÚ `WebMvcConfigurationSupport` ÖÐÊǿշ½·¨£¬¾ßÌåÐÝÂß¼­ÓÉ×ÓÀà (Ò²¾ÍÊÇ` DelegatingWebMvcConfiguration`) Ìṩ£¬×îÖÕµ÷Ó÷½Ê½ÊÇ**±éÀúÖ´ÐÐµÚ 2 ²½»ñÈ¡µÄ `WebMvcConfigurer` µÄ `addXxx()/configureXxx()`**£» +5. 在调用 `WebMvcConfigurationSupport#getXxx()` 获å�–自定义é…�置时,会调用 `addXxx()/configureXxx()`,该方法在 `WebMvcConfigurationSupport` 中是空方法,具体休逻辑由å­�ç±» (也就是` DelegatingWebMvcConfiguration`) æ��供,最终调用方å¼�是**é��历执行第 2 步获å�–çš„ `WebMvcConfigurer` çš„ `addXxx()/configureXxx()`**ï¼› -Õû¸öÁ÷³ÌÈçÏÂͼËùʾ£º +整个æµ�程如下图所示: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-4057f913076f01ba0b507b4654e5031391c.png) -ÔÚÆôÓà springmvc ¹¦ÄÜ£¬²¢Ìí¼Ó×Ô¶¨ÒåÅäÖÃʱ£¬ÎÒÃÇ¿ÉÒÔÕâô×ö: +在å�¯ç”¨ springmvc 功能,并添加自定义é…�置时,我们å�¯ä»¥è¿™ä¹ˆå�š: -1. ·½Ê½ 1£ºÊ¹Óà @EnableWebMvc ×¢½âÆôÓà mvc ¹¦ÄÜ£¬ÊµÏÖ WebMvcConfigurer£¬Ìí¼Ó×Ô¶¨ÒåÅäÖà +1. æ–¹å¼� 1:使用 @EnableWebMvc 注解å�¯ç”¨ mvc 功能,实现 WebMvcConfigurer,添加自定义é…�ç½® ``` - // ʹÓÃ@EnableWebMvc×¢½âÆôÓÃmvc¹¦ÄÜ + // 使用@EnableWebMvc注解å�¯ç”¨mvc功能 @Component @EnableWebMvc public class MvcConfig { ... } - // ʵÏÖ WebMvcConfigurer£¬Ìí¼Ó×Ô¶¨ÒåÅäÖà + // 实现 WebMvcConfigurer,添加自定义é…�ç½® @Component public class MyWebMvcConfigurer implements WebMvcConfigurer { - // ÖØÐ´WebMvcConfigurer·½·¨£¬´¦Àí×Ô¶¨ÒåÅäÖà + // é‡�写WebMvcConfigurer方法,处ç�†è‡ªå®šä¹‰é…�ç½® } ``` -2. ·½Ê½ 2£ºÊµÏÖ `WebMvcConfigurationSupport` Àà£¬ÖØÐ´ÆäÖеÄÅäÖ÷½·¨ +2. æ–¹å¼� 2:实现 `WebMvcConfigurationSupport` 类,é‡�写其中的é…�置方法 ``` @Component public class MyWebMvcConfigurationSupport extends WebMvcConfigurationSupport { - // ÖØÐ´ÅäÖ÷½·¨£¬´¦Àí×Ô¶¨ÒåÅäÖà + // é‡�写é…�置方法,处ç�†è‡ªå®šä¹‰é…�ç½® } ``` - ²»¹ý²ÉÓÃÕâÖÖ·½Ê½ºó£¬ÔÙʵÏÖ `WebMvcConfigurer` Ìí¼Ó×Ô¶¨ÒåÅäÖþͲ»ÉúЧÁË£¬×Ô¶¨ÒåÅäÖÃÖ»ÄÜÔÚ `WebMvcConfigurationSupport` ½øÐÐÅäÖᣠ- -springmvc ÌṩÁËÄÄЩÅäÖÃÏîÄØ£¿ÎÒÃÇÀ´¿´¿´ `WebMvcConfigurer` ÌṩµÄ·½·¨£º - -* `configurePathMatch`£ºÅäÖ÷ÓÉÇëÇó¹æÔò -* `configureContentNegotiation`£ºÄÚÈÝЭÉÌÅäÖà -* `configureAsyncSupport`£º -* `configureDefaultServletHandling`£ºÄ¬ÈϾ²Ì¬×ÊÔ´´¦ÀíÆ÷ -* `addFormatters`£º×¢²á×Ô¶¨Òåת»¯Æ÷ -* `addInterceptors`£ºÀ¹½ØÆ÷ÅäÖà -* `addResourceHandlers`£º×ÊÔ´´¦Àí -* `addCorsMappings`£ºCORS ÅäÖà -* `addViewControllers`£ºÊÓÍ¼Ìø×ª¿ØÖÆÆ÷ -* `configureViewResolvers`£ºÅäÖÃÊÓͼ½âÎö -* `addArgumentResolvers`£ºÌí¼Ó×Ô¶¨Òå·½·¨²ÎÊý´¦ÀíÆ÷ -* `addReturnValueHandlers`£ºÌí¼Ó×Ô¶¨Òå·µ»Ø½á¹û´¦ÀíÆ÷ -* `configureMessageConverters`£ºÅäÖÃÏûϢת»»Æ÷¡£ÖØÔػḲ¸ÇĬÈÏ×¢²áµÄ `HttpMessageConverter` -* `extendMessageConverters`£ºÅäÖÃÏûϢת»»Æ÷¡£½öÌí¼ÓÒ»¸ö×Ô¶¨ÒåµÄ `HttpMessageConverter`. -* `configureHandlerExceptionResolvers`£ºÅäÖÃÒ쳣ת»»Æ÷ -* `extendHandlerExceptionResolvers`£ºÌí¼ÓÒ쳣ת»¯Æ÷ + ä¸�过采用这ç§�æ–¹å¼�å�Žï¼Œå†�实现 `WebMvcConfigurer` 添加自定义é…�置就ä¸�生效了,自定义é…�ç½®å�ªèƒ½åœ¨ `WebMvcConfigurationSupport` 进行é…�置。 + +springmvc æ��供了哪些é…�置项呢?我们æ�¥çœ‹çœ‹ `WebMvcConfigurer` æ��供的方法: + +* `configurePathMatch`:é…�置路由请求规则 +* `configureContentNegotiation`:内容å��商é…�ç½® +* `configureAsyncSupport`: +* `configureDefaultServletHandling`:默认é�™æ€�资æº�处ç�†å™¨ +* `addFormatters`:注册自定义转化器 +* `addInterceptors`:拦截器é…�ç½® +* `addResourceHandlers`:资æº�处ç�† +* `addCorsMappings`:CORS é…�ç½® +* `addViewControllers`:视图跳转控制器 +* `configureViewResolvers`:é…�置视图解æž� +* `addArgumentResolvers`:添加自定义方法å�‚数处ç�†å™¨ +* `addReturnValueHandlers`:添加自定义返回结果处ç�†å™¨ +* `configureMessageConverters`:é…�置消æ�¯è½¬æ�¢å™¨ã€‚é‡�载会覆盖默认注册的 `HttpMessageConverter` +* `extendMessageConverters`:é…�置消æ�¯è½¬æ�¢å™¨ã€‚仅添加一个自定义的 `HttpMessageConverter`. +* `configureHandlerExceptionResolvers`:é…�置异常转æ�¢å™¨ +* `extendHandlerExceptionResolvers`:添加异常转化器 * `getValidator`: -* `getMessageCodesResolver`£º +* `getMessageCodesResolver`: -Èç¹ûÐèÒªÅäÖÃÏà¹ØÏֻÐèÒªÖØÐ´Ïà¹Ø·½·¨ ¼´¿É¡£ +如果需è¦�é…�置相关项,å�ªéœ€è¦�é‡�写相关方法 å�³å�¯ã€‚ -×îºóÎÒÃÇÔÙÀ´¿´¿´ `WebMvcConfigurationSupport` ÖÐÒýÈëÁËÄÄЩ Bean£¬ÓÐ `@Bean` ×¢½âµÄ·½·¨ÈçÏ£º +最å�Žæˆ‘们å†�æ�¥çœ‹çœ‹ `WebMvcConfigurationSupport` 中引入了哪些 Bean,有 `@Bean` 注解的方法如下: * `public RequestMappingHandlerMapping requestMappingHandlerMapping(...)` * `public PathMatcher mvcPathMatcher()` @@ -572,12 +572,12 @@ springmvc * `public ViewResolver mvcViewResolver(...)` * `HandlerMappingIntrospector mvcHandlerMappingIntrospector()` -ÕâЩ¶¼ÊÇ springmvc ÖÐÓõ½µÄһЩ×é¼þ£¬¾ßÌåµÄ¾ßÌåÄÚÈݾͲ»Õ¹¿ªÁË¡£ +这些都是 springmvc 中用到的一些组件,具体的具体内容就ä¸�展开了。 -### 4\. ×ܽá +### 4\. 总结 -±¾ÎÄÄÚÈݱȽÏÔÓ£¬ÏÈÌṩÁËÒ»¸ö springmvc µÄ demo£¬È»ºó½éÉÜÁË demo ÖÐ `0 xml` ÅäÖÃÔ­Àí (Ò²¾ÍÊÇ `servlet 3.0` ¹æ·¶£©£¬½Ó׎éÉÜÁË `@EnableWebMvc` µÄ¹¦ÄÜ£¬×ÅÖØ½éÉÜÁË `WebMvcConfigurationSupport` µÄ×÷Óᣠ+本文内容比较æ�‚,先æ��供了一个 springmvc çš„ demo,然å�Žä»‹ç»�了 demo 中 `0 xml` é…�置原ç�† (也就是 `servlet 3.0` 规范),接ç�€ä»‹ç»�了 `@EnableWebMvc` 的功能,ç�€é‡�介ç»�了 `WebMvcConfigurationSupport` 的作用。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4696657](https://my.oschina.net/funcy/blog/4696657) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4696657](https://my.oschina.net/funcy/blog/4696657) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\256\271\345\231\250\345\220\257\345\212\250Tomcat.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\256\271\345\231\250\345\220\257\345\212\250Tomcat.md" index 4623d0f..777ae3c 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\256\271\345\231\250\345\220\257\345\212\250Tomcat.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\256\271\345\231\250\345\220\257\345\212\250Tomcat.md" @@ -1,13 +1,13 @@ -''ÔÚ [spring mvc Ö® springmvc demo Óë @EnableWebMvc ×¢½â](https://my.oschina.net/funcy/blog/4696657)Ò»ÎÄÖУ¬ÎÒÃÇÌṩÁËÒ»¸öʾÀý demo£¬¸Ã demo »áÏÈÆô¶¯ servlet ÈÝÆ÷£¬È»ºóͨ¹ý `servlet3.0` ¹æ·¶½« `DispatcherServlet` ×¢²áµ½ `servlet` ÈÝÆ÷ÖУ¬È»ºóÔÚ `DispatcherServlet#init` ·½·¨ÖÐÆô¶¯ spring ÈÝÆ÷£¬Õû¸öÁ÷³Ì¾ÍÏñÕâÑù£º +''在 [spring mvc 之 springmvc demo 与 @EnableWebMvc 注解](https://my.oschina.net/funcy/blog/4696657)一文中,我们æ��供了一个示例 demo,该 demo 会先å�¯åЍ servlet 容器,然å�Žé€šè¿‡ `servlet3.0` 规范将 `DispatcherServlet` 注册到 `servlet` 容器中,然å�Žåœ¨ `DispatcherServlet#init` 方法中å�¯åЍ spring 容器,整个æµ�程就åƒ�这样: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0874fa7ef39ca9c405cdf55d99ca891ebf2.png) -ÕâûʲôÎÊÌ⣬ÄÜÕý³£Æô¶¯Ò²ÔËÐÐÁ¼ºÃ£¬Ö»²»¹ýÎÒÃÇÔÚ spring ÈÝÆ÷ÖÐÎÞ·¨»ñÈ¡ `DispatcherServlet`£¬ÏñÕâÑù£º +这没什么问题,能正常å�¯åŠ¨ä¹Ÿè¿�行良好,å�ªä¸�过我们在 spring 容器中无法获å�– `DispatcherServlet`,åƒ�这样: ``` @Component public class Test { - // ÔÚÇ°ÃæÌṩµÄʾÀý£¨tomcatÀïÆô¶¯springÈÝÆ÷£©ÊÇ×¢Èë²»Á赀 + // 在å‰�é�¢æ��供的示例(tomcat里å�¯åЍspring容器)是注入ä¸�了的 @Autowired public DispatcherServlet dispatcherServlet; @@ -17,11 +17,11 @@ public class Test { ``` -Æô¶¯Ê±£¬spring ¿Ï¶¨»á±¨´í£¬ÒòΪÕÒ²»µ½ `DispatcherServlet` ¶ÔÓ¦µÄ bean¡£ +å�¯åŠ¨æ—¶ï¼Œspring 肯定会报错,因为找ä¸�到 `DispatcherServlet` 对应的 bean。 -×î½üÔÚ¿´ springboot Ô´Âëʱ£¬·¢ÏÖ spring ÈÝÆ÷²¢²»ÊÇÓÉ tomcat ÈÝÆ÷Æô¶¯µÄ£¬Ïà·´£¬springboot ÊÇÏÈÆô¶¯ spring ÈÝÆ÷£¬È»ºóÓÉ spring ÈÝÆ÷Æô¶¯ tomcat Æô¶¯£¬ÕâÊÇÈçºÎ×öµ½µÄÄØ£¿ÕâÀï±¾ÈËÌṩһ¸ö demo Ä£ÄâÏ¡£ +最近在看 springboot æº�ç �时,å�‘现 spring 容器并ä¸�是由 tomcat 容器å�¯åŠ¨çš„ï¼Œç›¸å��,springboot 是先å�¯åЍ spring 容器,然å�Žç”± spring 容器å�¯åЍ tomcat å�¯åŠ¨ï¼Œè¿™æ˜¯å¦‚ä½•å�šåˆ°çš„呢?这里本人æ��供一个 demo 模拟下。 -### 1\. ×¼±¸ `DispatcherServlet` +### 1\. 准备 `DispatcherServlet` ``` @Component @@ -50,13 +50,13 @@ public class MvcConfig implements WebMvcConfigurer { ``` -¶Ô¸ÃÀà˵Ã÷ÈçÏ£º +对该类说明如下: -* `MvcConfig` Àà±» `@EnableWebMvc` ×¢½â±ê¼Ç£¬±íʾÐèÒªÆô¶¯Óà `web mvc` ¹¦ÄÜ -* `MvcConfig` ʵÏÖÁË `WebMvcConfigurer`£¬¿ÉÒÔͨ¹ýÖØÐ´ `WebMvcConfigurer` µÄ·½·¨À´ÊµÏÖ×Ô¶¨Òå `web mvc` µÄÅäÖà -* `MvcConfig` ÖлáÉú³É `DispatcherServlet` bean£¬¸Ã bean »á±£´æµ½ spring ÈÝÆ÷ÖÐ +* `MvcConfig` 类被 `@EnableWebMvc` 注解标记,表示需è¦�å�¯åŠ¨ç”¨ `web mvc` 功能 +* `MvcConfig` 实现了 `WebMvcConfigurer`,å�¯ä»¥é€šè¿‡é‡�写 `WebMvcConfigurer` 的方法æ�¥å®žçŽ°è‡ªå®šä¹‰ `web mvc` çš„é…�ç½® +* `MvcConfig` 中会生æˆ� `DispatcherServlet` bean,该 bean 会ä¿�存到 spring 容器中 -### 2\. ×¼±¸Ò»¸ö `WebApplicationInitializer` ʵÏÖÀà +### 2\. 准备一个 `WebApplicationInitializer` 实现类 ``` @Component @@ -68,20 +68,20 @@ public class MyWebApplicationInitializer implements WebApplicationInitializer { @Override public void onStartup(ServletContext servletContext) { - // ´Ó beanFactory ÖлñÈ¡ DispatcherServlet ²¢×¢²áµ½servletÈÝÆ÷ + // 从 beanFactory 中获å�– DispatcherServlet 并注册到servlet容器 DispatcherServlet servlet = beanFactory.getBean(DispatcherServlet.class); ServletRegistration.Dynamic registration = servletContext.addServlet("app", servlet); - // loadOnStartup ÉèÖÃ³É -1 ʱ£¬Ö»ÓÐÔÚµÚÒ»´ÎÇëÇóʱ£¬²Å»áµ÷Óà init ·½·¨ + // loadOnStartup 设置æˆ� -1 时,å�ªæœ‰åœ¨ç¬¬ä¸€æ¬¡è¯·æ±‚时,æ‰�会调用 init 方法 registration.setLoadOnStartup(-1); registration.addMapping("/*"); - // Ϊ applicationContext ÉèÖà servletContext + // 为 applicationContext 设置 servletContext applicationContext.setServletContext(servletContext); } /** - * ÉèÖà beanFactory - * ΪʲôҪÉèÖà beanFactoryµÄÖµ£¿ÒòΪ DispatcherServlet Òª´Ó beanFactory ÖлñÈ¡ + * 设置 beanFactory + * 为什么è¦�设置 beanFactory的值?因为 DispatcherServlet è¦�从 beanFactory 中获å�– * @param beanFactory * @throws BeansException */ @@ -90,8 +90,8 @@ public class MyWebApplicationInitializer implements WebApplicationInitializer { } /** - * ÉèÖà applicationContext - * ΪʲôҪÉèÖà applicationContext µÄÖµ£¿ÒòΪ servletContext ÒªÉèÖõ½ applicationContext + * 设置 applicationContext + * 为什么è¦�设置 applicationContext 的值?因为 servletContext è¦�设置到 applicationContext * @param applicationContext */ public static void setApplicationContext( @@ -102,14 +102,14 @@ public class MyWebApplicationInitializer implements WebApplicationInitializer { ``` -`WebApplicationInitializer` ÊÇ spring ¶Ô servlet 3.0 ¹æ·¶µÄʵÏÖ£¬ÔÚ [spring mvc Ö® springmvc demo Óë @EnableWebMvc ×¢½â](https://my.oschina.net/funcy/blog/4696657)Ò»ÎÄÒ²Ïêϸ·ÖÎö¹ý£¬tomcat ÔÚÆô¶¯Ê±£¬»áÖ´ÐÐ `WebApplicationInitializer#onStartup` ·½·¨¡£ +`WebApplicationInitializer` 是 spring 对 servlet 3.0 规范的实现,在 [spring mvc 之 springmvc demo 与 @EnableWebMvc 注解](https://my.oschina.net/funcy/blog/4696657)一文也详细分æž�过,tomcat 在å�¯åŠ¨æ—¶ï¼Œä¼šæ‰§è¡Œ `WebApplicationInitializer#onStartup` 方法。 -¶Ô `MyWebApplicationInitializer` ˵Ã÷ÈçÏ£º +对 `MyWebApplicationInitializer` 说明如下: -* `MyWebApplicationInitializer` ÖÐÓÐÁ½¸ö¾²Ì¬³ÉÔ±±äÁ¿£º`beanFactory` Óë `applicationContext`£¬¶ÔÓ¦µØÌṩÁËÁ½¸ö¾²Ì¬ `set` ·½·¨£¬ÐèҪעÒâµÄÊÇ£¬ÕâÁ½¸ö¾²Ì¬ `set` ·½·¨ÒªÔÚ `onStartup()` ·½·¨Ç°µ÷Óã¬Ò²¾ÍÊÇ tomcat Æô¶¯Ç°µ÷Óõ÷Óã» -* ÔÚ `MyWebApplicationInitializer#onStartup` ·½·¨ÖУ¬ÎÒÃÇÏÈÊÇ´Ó `beanFactory` ÖлñÈ¡ÁË `DispatcherServlet`£¬È»ºó½«Æä×¢²áµ½ `servlet` ÈÝÆ÷ÖУ¬È»ºó½« `onStartup(...)` ·½·¨µÄ²ÎÊý `servletContext` ÉèÖõ½ `applicationContext` ÖÐ +* `MyWebApplicationInitializer` 中有两个é�™æ€�æˆ�员å�˜é‡�:`beanFactory` 与 `applicationContext`,对应地æ��供了两个é�™æ€� `set` 方法,需è¦�注æ„�的是,这两个é�™æ€� `set` 方法è¦�在 `onStartup()` 方法å‰�调用,也就是 tomcat å�¯åЍå‰�调用调用; +* 在 `MyWebApplicationInitializer#onStartup` 方法中,我们先是从 `beanFactory` 中获å�–了 `DispatcherServlet`,然å�Žå°†å…¶æ³¨å†Œåˆ° `servlet` 容器中,然å�Žå°† `onStartup(...)` 方法的å�‚æ•° `servletContext` 设置到 `applicationContext` 中 -### 3\. ×¼±¸Ò»¸ö `ServletContextAwareProcessor` µÄ×ÓÀà +### 3\. 准备一个 `ServletContextAwareProcessor` çš„å­�ç±» ``` public class MyServletContextAwareProcessor extends ServletContextAwareProcessor { @@ -117,7 +117,7 @@ public class MyServletContextAwareProcessor extends ServletContextAwareProcessor AbstractRefreshableWebApplicationContext webApplicationContext; /** - * ´«Èë webApplicationContext + * ä¼ å…¥ webApplicationContext * @param webApplicationContext */ public MyServletContextAwareProcessor( @@ -126,8 +126,8 @@ public class MyServletContextAwareProcessor extends ServletContextAwareProcessor } /** - * ·µ»Ø ServletContext - * ÏÈ´Ó webApplicationContext ÖлñÈ¡£¬Èç¹û»ñÈ¡²»µ½£¬ÔÙ´Ó¸¸Àà·½·¨ÖлñÈ¡ + * 返回 ServletContext + * 先从 webApplicationContext 中获å�–,如果获å�–ä¸�到,å†�从父类方法中获å�– * @return */ @Override @@ -145,11 +145,11 @@ public class MyServletContextAwareProcessor extends ServletContextAwareProcessor ``` -ÔÚ `MyWebApplicationInitializer#onStartup` ·½·¨ÖÐ¶Ô `applicationContext` ÉèÖÃµÄ `servletContext` ¾ÍÊÇÔÚÕâÀïʹÓõģ¬`MyServletContextAwareProcessor` µÄ¹¹Ôì·½·¨´«ÈëÁË `webApplicationContext`£¬È»ºóÖØÐ´ÁË `getServletContext()` ·½·¨£¬»ñÈ¡ `servletContext` ʱ£¬ÏÈ´Ó `webApplicationContext` ÖлñÈ¡£¬Èç¹û»ñÈ¡²»µ½£¬ÔÙ´Ó¸¸Àà·½·¨ÖлñÈ¡¡£ +在 `MyWebApplicationInitializer#onStartup` 方法中对 `applicationContext` 设置的 `servletContext` 就是在这里使用的,`MyServletContextAwareProcessor` 的构造方法传入了 `webApplicationContext`,然å�Žé‡�写了 `getServletContext()` 方法,获å�– `servletContext` 时,先从 `webApplicationContext` 中获å�–,如果获å�–ä¸�到,å†�从父类方法中获å�–。 -### 4\. ×¼±¸Ò»¸ö `ApplicationContext` µÄʵÏÖÀà +### 4\. 准备一个 `ApplicationContext` 的实现类 -`ApplicationContext` ÖÁ¹ØÖØÒª£¬ÕâÀïÎÒÃÇÑ¡ÔñÖ±½ÓÀ©Õ¹ `AnnotationConfigWebApplicationContext`£º +`ApplicationContext` 至关é‡�è¦�,这里我们选择直接扩展 `AnnotationConfigWebApplicationContext`: ``` public class MyWebApplicationContext extends AnnotationConfigWebApplicationContext { @@ -157,8 +157,8 @@ public class MyWebApplicationContext extends AnnotationConfigWebApplicationConte private Tomcat tomcat; /** - * ÖØÐ´ postProcessBeanFactory ·½·¨ - * ÔÚÕâ¸ö·½·¨ÀïÌí¼ÓÎÒÃÇ×Ô¶¨ÒåµÄ MyServletContextAwareProcessor + * é‡�写 postProcessBeanFactory 方法 + * 在这个方法里添加我们自定义的 MyServletContextAwareProcessor * @param beanFactory */ @Override @@ -169,17 +169,17 @@ public class MyWebApplicationContext extends AnnotationConfigWebApplicationConte } /** - * ÔÚÕâ¸ö·½·¨ÀïÆô¶¯ tomcat + * 在这个方法里å�¯åЍ tomcat */ @Override protected void onRefresh() { - // Ïȵ÷Óø¸ÀàµÄ·½·¨ + // 先调用父类的方法 super.onRefresh(); - // ÉèÖà MyWebApplicationInitializer µÄ beanFactory Óë applicationContext + // 设置 MyWebApplicationInitializer çš„ beanFactory 与 applicationContext MyWebApplicationInitializer.setBeanFactory(getBeanFactory()); MyWebApplicationInitializer.setApplicationContext(this); - // tomcatµÄ´´½¨¼°Æô¶¯ + // tomcat的创建å�Šå�¯åЍ tomcat = new Tomcat(); Connector connector = new Connector(); connector.setPort(8080); @@ -193,10 +193,10 @@ public class MyWebApplicationContext extends AnnotationConfigWebApplicationConte Class.forName(tomcat.getHost().getConfigClass()) .getDeclaredConstructor().newInstance(); context.addLifecycleListener(lifecycleListener); - // Æô¶¯tomcat + // å�¯åЍtomcat tomcat.start(); } catch (Exception e) { - System.out.println("Æô¶¯Òì³££º"); + System.out.println("å�¯åŠ¨å¼‚å¸¸ï¼š"); e.printStackTrace(); } } @@ -205,14 +205,14 @@ public class MyWebApplicationContext extends AnnotationConfigWebApplicationConte ``` -Õâ¸öÀàÀ©Õ¹ÁË spring µÄÆô¶¯Á÷³Ì£¬ÕâÀïÒ»¹²ÖØÐ´ÁËÁ½¸ö·½·¨£¬ÕâÀïÒ»Ò»½éÉÜÏÂ: +这个类扩展了 spring çš„å�¯åЍæµ�程,这里一共é‡�写了两个方法,这里一一介ç»�下: -* `postProcessBeanFactory()`£ºÕâ¸ö·½·¨Ö÷ÒªÊÇΪÁË×¢²á `MyServletContextAwareProcessor`£¬Ç°ÃæÎÒÃÇ×¼±¸µÄ `MyServletContextAwareProcessor` ¾ÍÊÇÔÚÕâÀï×¢²áµÄ£¬Ö®ËùÒÔÖØÐ´£¬»¹ÊÇΪÁËʹÓà `tomcat` ÌṩµÄ `ServletContext`£» -* `onRefresh()`£ºÔÚÕâ¸ö·½·¨ÀÏÈÊÇÉèÖà `MyWebApplicationInitializer` µÄ `beanFactory` Óë `applicationContext` ÊôÐÔÖµ£¬È»ºóÆô¶¯ `tomcat`£» +* `postProcessBeanFactory()`:这个方法主è¦�是为了注册 `MyServletContextAwareProcessor`,å‰�é�¢æˆ‘们准备的 `MyServletContextAwareProcessor` 就是在这里注册的,之所以é‡�写,还是为了使用 `tomcat` æ��供的 `ServletContext`ï¼› +* `onRefresh()`:在这个方法里,先是设置 `MyWebApplicationInitializer` çš„ `beanFactory` 与 `applicationContext` 属性值,然å�Žå�¯åЍ `tomcat`ï¼› -### 5\. ×¼±¸Ò»¸ö¼òµ¥µÄ `Controller` +### 5\. 准备一个简å�•çš„ `Controller` -×¼±¸Ò»¸ö `Controller`£¬Ö÷ÒªÊǰïÖúÎÒÃÇÑéÖ¤ÏîÄ¿ÊÇ·ñÆô¶¯Õý³££º +准备一个 `Controller`,主è¦�是帮助我们验è¯�项目是å�¦å�¯åŠ¨æ­£å¸¸ï¼š ``` @RestController @@ -229,9 +229,9 @@ public class TestController { ``` -### 6\. Ö÷Àà +### 6\. 主类 -×îºó¾ÍÊÇÖ÷ÀàÁË£¬Ö÷ÒªÊÇ´¦Àí spring µÄÆô¶¯²Ù×÷£¬Ò²ÊÇÏ൱¼òµ¥£º +最å�Žå°±æ˜¯ä¸»ç±»äº†ï¼Œä¸»è¦�是处ç�† spring çš„å�¯åЍæ“�作,也是相当简å�•: ``` @ComponentScan @@ -246,43 +246,43 @@ public class MvcDemo03Main { ``` -ÔËÐУ¬·ÃÎÊ `http://localhost:8080/test/hello`£¬½á¹ûÈçÏ£º +è¿�行,访问 `http://localhost:8080/test/hello`,结果如下: -Ò³Ãæ£º +页é�¢ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d87b4a09e7a87e0535eb52a09759fcc6534.png) -¿ØÖÆÌ¨£º +控制å�°ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c608886c751dcf595d74efb8506e5d67306.png) -### 7\. ÎÊÌ⣺Æô¶¯ºó£¬`DispatcherServlet#init` ·½·¨»áÔÙ´ÎÆô¶¯ spring ÈÝÆ÷Â𣿠+### 7\. 问题:å�¯åЍå�Žï¼Œ`DispatcherServlet#init` 方法会å†�次å�¯åЍ spring 容器å�—? -Ç°ÃæÎÒÃÇ·ÖÎöµ½£¬Ê¹Óà tomcat Æô¶¯ spring ÈÝÆ÷µÄ·½Ê½Ê±£¬spring ÈÝÆ÷ÊÇÔÚ `DispatcherServlet#init` ·½·¨ÖÐÆô¶¯µÄ£¬ÔÚÎÒÃÇʹÓà **spring ÈÝÆ÷Æô¶¯ tomcat** µÄÆô¶¯·½Ê½Ê±£¬tomcat Ö´ÐÐ `DispatcherServlet#init` ·½·¨Ê±£¬»áÔÙ´ÎÆô¶¯ spring ÈÝÆ÷Â𣿠+å‰�é�¢æˆ‘们分æž�到,使用 tomcat å�¯åЍ spring 容器的方å¼�时,spring 容器是在 `DispatcherServlet#init` 方法中å�¯åŠ¨çš„ï¼Œåœ¨æˆ‘ä»¬ä½¿ç”¨ **spring 容器å�¯åЍ tomcat** çš„å�¯åŠ¨æ–¹å¼�时,tomcat 执行 `DispatcherServlet#init` 方法时,会å†�次å�¯åЍ spring 容器å�—? -ÕâÀïÎÒÃÇÖ±½Ó½øÈë `FrameworkServlet#initWebApplicationContext` ·½·¨£¬´òÉ϶ϵ㣺 +这里我们直接进入 `FrameworkServlet#initWebApplicationContext` 方法,打上断点: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-64ee29f90ef5683f7968f782b9175d42e0f.png) -ÕâÀïµÄ `wac` Óë `this.webApplicationContext` ¾ÍÊÇ `MyWebApplicationContext` µÄʵÀý£¬ÔÚ´´½¨ `DispatcherServlet` ʱ´«ÈëµÄ: +这里的 `wac` 与 `this.webApplicationContext` 就是 `MyWebApplicationContext` 的实例,在创建 `DispatcherServlet` 时传入的: ``` @Bean public DispatcherServlet dispatcherServlet(WebApplicationContext webApplicationContext) { - // ÔÚ¹¹Ôì·½·¨µÄ²ÎÊýÖд«ÈëÁË webApplicationContext + // 在构造方法的å�‚数中传入了 webApplicationContext return new DispatcherServlet(webApplicationContext); } ``` -µ½ÓÚΪʲô´òµ½Õâ¸ö·½·¨£¬ÄÇÊÇÒòΪ `DispatcherServlet#init` ¾­¹ý²ã²ãµ÷Óúó£¬×îÖÕÊÇÔÚÕâ¸ö·½·¨Àï´¦Àí spring ÈÝÆ÷µÄÆô¶¯µÄ£¬µ±¶ÏµãÔËÐе½ `if (!cwac.isActive()) {...` ʱ£¬`!cwac.isActive()` ·µ»Ø½á¹ûΪ `false`£¬Òò´Ë `if` ¿éÀïµÄÆô¶¯ spring ÈÝÆ÷¾Í²»»áÖ´Ðе½ÁË¡£ +到于为什么打到这个方法,那是因为 `DispatcherServlet#init` ç»�过层层调用å�Žï¼Œæœ€ç»ˆæ˜¯åœ¨è¿™ä¸ªæ–¹æ³•里处ç�† spring 容器的å�¯åŠ¨çš„ï¼Œå½“æ–­ç‚¹è¿�行到 `if (!cwac.isActive()) {...` 时,`!cwac.isActive()` 返回结果为 `false`,因此 `if` å�—里的å�¯åЍ spring 容器就ä¸�会执行到了。 -×ÛÉÏËùÊö£¬Í¨¹ý spring ÈÝÆ÷Æô¶¯ tomcat ºó£¬ÔÚ `DispatcherServlet#init` Àï²»»áÔÙ´ÎÆô¶¯ spring ÈÝÆ÷¡£ÕâÑùÆô¶¯ºó£¬`DispatcherServlet` ¾ÍÊÇÒ»¸ö spring bean£¬ÎÒÃǾͿÉÒÔÔÚ´úÂëÀïʹÓà `@Autowired` ×¢½â½«Æä×¢Èëµ½ÆäËûÀàÖÐÁË£º +综上所述,通过 spring 容器å�¯åЍ tomcat å�Žï¼Œåœ¨ `DispatcherServlet#init` 里ä¸�会å†�次å�¯åЍ spring 容器。这样å�¯åЍå�Žï¼Œ`DispatcherServlet` 就是一个 spring bean,我们就å�¯ä»¥åœ¨ä»£ç �里使用 `@Autowired` 注解将其注入到其他类中了: ``` @Component public class Test { - // ±¾ÎĵÄʾÀý£¨ÔÚ spring ÈÝÆ÷ÖÐÆô¶¯ tomcat£©ÊÇ¿ÉÒÔ×¢Èë³É¹¦µÄ + // 本文的示例(在 spring 容器中å�¯åЍ tomcat)是å�¯ä»¥æ³¨å…¥æˆ�功的 @Autowired public DispatcherServlet dispatcherServlet; @@ -292,8 +292,8 @@ public class Test { ``` -¹ØÓÚ `spring` Æô¶¯ `tomcat` µÄ·ÖÎö¾Íµ½ÕâÀÆäÖеÄÄѵãÔÚÓÚ**ÈçºÎ½« `tomcat` ÌṩµÄ `ServletContext` ÉèÖõ½ `ServletContextAwareProcessor` ÖÐ**£¬ÆäÖеĽâ¾ö·½Ê½×¢ÒâÌå»á¡£ +关于 `spring` å�¯åЍ `tomcat` 的分æž�就到这里,其中的难点在于**如何将 `tomcat` æ��供的 `ServletContext` 设置到 `ServletContextAwareProcessor` 中**,其中的解决方å¼�注æ„�体会。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4928222](https://my.oschina.net/funcy/blog/4928222) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4928222](https://my.oschina.net/funcy/blog/4928222) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\344\271\213\350\216\267\345\217\226Handler.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\344\271\213\350\216\267\345\217\226Handler.md" index 2f1e035..45f6bf1 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\344\271\213\350\216\267\345\217\226Handler.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\270\200\357\274\211\344\271\213\350\216\267\345\217\226Handler.md" @@ -1,20 +1,20 @@ -ÉÏһƪÎÄÕÂÎÒÃÇ·ÖÎö `RequestMapping` ³õʼ»¯Á÷³Ì£¬±¾ÎĽ«·ÖÎö spring mvc µÄÇëÇóÖ´ÐÐÁ÷³Ì¡£ +上一篇文章我们分æž� `RequestMapping` åˆ�始化æµ�程,本文将分æž� spring mvc 的请求执行æµ�程。 -### 1\. ÇëÇóµÄÖ´ÐÐÈë¿Ú +### 1\. 请求的执行入å�£ -ÔÚ [spring mvc Ö® DispatcherServlet ³õʼ»¯Á÷³Ì](https://my.oschina.net/funcy/blog/4710330 "spring mvcÖ®DispatcherServlet ³õʼ»¯Á÷³Ì")Ò»ÎÄÖУ¬ÎÒÃÇÉîÈë·ÖÎöÁËÏò `servlet` ÈÝÆ÷Ìí¼ÓÁË `DispatcherServlet` ºó£¬Òý·¢µÄһϵÁгõʼ»¯Á÷³Ì£¬±¾ÎĽ«¼ÌÐøÎ§ÈÆÕâ¸ö `servlet` ·ÖÎö `springmvc` µÄÇëÇóÁ÷³Ì¡£ +在 [spring mvc 之 DispatcherServlet åˆ�始化æµ�程](https://my.oschina.net/funcy/blog/4710330 "spring mvc之DispatcherServlet åˆ�始化æµ�程")一文中,我们深入分æž�了å�‘ `servlet` 容器添加了 `DispatcherServlet` å�Žï¼Œå¼•å�‘的一系列åˆ�始化æµ�程,本文将继续围绕这个 `servlet` 分æž� `springmvc` 的请求æµ�程。 -#### 1.1 »Ø¹Ë servlet µÄÖ´ÐÐÈë¿Ú£º +#### 1.1 回顾 servlet 的执行入å�£ï¼š -ÔÚ·ÖÎö `DispatcherServlet` ǰÊ×ÏÈÒª»Ø¹ËÏ servlet µÄÖ´ÐÐÈë¿Ú¡£ +在分æž� `DispatcherServlet` å‰�首先è¦�回顾下 servlet 的执行入å�£ã€‚ -ÔÚÎÒÃÇʵÏÖ×Ô¶¨ÒåµÄ servlet ʱ£¬Ò»°ãÊÇʵÏÖ `HttpServlet`£¬È»ºóÖØÐ´ `doGet(xxx)`¡¢`doPost()` ·½·¨£¬¶øÊµ¼ÊÉÏ servlet Ϊ `HttpServlet#service(ServletRequest, ServletResponse)`£º +在我们实现自定义的 servlet 时,一般是实现 `HttpServlet`,然å�Žé‡�写 `doGet(xxx)`ã€�`doPost()` 方法,而实际上 servlet 为 `HttpServlet#service(ServletRequest, ServletResponse)`: ``` public abstract class HttpServlet extends GenericServlet { ... - // Õâ¸ö·½·¨½ö×öÁ˲ÎÊýÀàÐÍת»» + // 这个方法仅å�šäº†å�‚数类型转æ�¢ @Override public void service(ServletRequest req, ServletResponse res) throws ServletException, IOException { @@ -22,7 +22,7 @@ public abstract class HttpServlet extends GenericServlet { HttpServletRequest request; HttpServletResponse response; - // ÔÚÕâÀï´¦Àí²ÎÊýµÄÀàÐÍת»» + // 在这里处ç�†å�‚数的类型转æ�¢ try { request = (HttpServletRequest) req; response = (HttpServletResponse) res; @@ -33,15 +33,15 @@ public abstract class HttpServlet extends GenericServlet { } /** - * ÔÚÕâÀï´¦ÀíÇëÇó - * ´Ó´úÂë¿ÉÒÔ¿´µ½£¬Õâ¸öÀàÆäʵÊÇ×öÒ»¸öת·¢£ºÅжÏÇëÇó·½·¨£¬È»ºóµ÷ÓþßÌåµÄ·½·¨Ö´ÐÐ + * 在这里处ç�†è¯·æ±‚ + * 从代ç �å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªç±»å…¶å®žæ˜¯å�šä¸€ä¸ªè½¬å�‘:判断请求方法,然å�Žè°ƒç”¨å…·ä½“的方法执行 */ protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { String method = req.getMethod(); - // ÅжϵÄÇëÇó·½·¨£¬È»ºóÕÒµ½¶ÔÓ¦µÄ·½·¨È¥Ö´ÐÐ + // 判断的请求方法,然å�Žæ‰¾åˆ°å¯¹åº”的方法去执行 if (method.equals(METHOD_GET)) { long lastModified = getLastModified(req); if (lastModified == -1) { @@ -65,7 +65,7 @@ public abstract class HttpServlet extends GenericServlet { } else if (method.equals(METHOD_TRACE)) { doTrace(req,resp); } else { - // ûÓжÔÓ¦µÄ·½·¨£¬±¨´í + // 没有对应的方法,报错 ... } } @@ -74,23 +74,23 @@ public abstract class HttpServlet extends GenericServlet { ``` -ÒÔÉÏÊÇ servlet Ô´Â룬·½·¨±È½Ï¼òµ¥£¬Öص㲿·Ö¶¼×öÁË×¢ÊÍ£¬ÕâÀïÓÐÁ½¸öÐèÒªÔÙ´ÎÇ¿µ÷Ï£º +以上是 servlet æº�ç �,方法比较简å�•,é‡�点部分都å�šäº†æ³¨é‡Šï¼Œè¿™é‡Œæœ‰ä¸¤ä¸ªéœ€è¦�å†�次强调下: -1. servlet µÄÖ´ÐÐÈë¿ÚΪ `HttpServlet#service(ServletRequest, ServletResponse)`£» -2. `HttpServlet#service(HttpServletRequest, HttpServletResponse)` ·½·¨»á¸ù¾ÝÇëÇó·½·¨ÕÒµ½¶ÔÓ¦µÄ´¦Àí·½·¨Ö´ÐУ¬Ò»°ãÀ´Ëµ£¬ÎÒÃÇ×Ô¶¨Òå servlet£¬Ö»ÒªÖØÐ´ `doGet(xxx)`¡¢`doPost(xxx)` µÈ·½·¨¼´¿É¡£ +1. servlet 的执行入å�£ä¸º `HttpServlet#service(ServletRequest, ServletResponse)`ï¼› +2. `HttpServlet#service(HttpServletRequest, HttpServletResponse)` 方法会根æ�®è¯·æ±‚方法找到对应的处ç�†æ–¹æ³•执行,一般æ�¥è¯´ï¼Œæˆ‘们自定义 servlet,å�ªè¦�é‡�写 `doGet(xxx)`ã€�`doPost(xxx)` 等方法å�³å�¯ã€‚ -ÇëÇóÁ÷³Ì´ó¸ÅÈçÏ£º +请求æµ�程大概如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-60d0e2afcbdb75a175c6f28471fc467f0e5.png) -#### 1.2 `DispatcherServlet` µÄ¸¸Àࣺ`FrameworkServlet` +#### 1.2 `DispatcherServlet` 的父类:`FrameworkServlet` -Á˽âÍê servlet µÄÇëÇóÈë¿Úºó£¬½ÓÏÂÀ´¾ÍµÃ·ÖÎöÒ»¸ö²»µÃ²»ÌáµÄÀàÁË£º`FrameworkServlet`¡£`FrameworkServlet` ÊÇ `HttpServlet` µÄ×ÓÀ࣬ʵÏÖÁË `HttpServlet` µÄ¸÷ÖÖ `doXxx()`£¬Í¬Ê±Ò²ÊµÏÖÁË `service(HttpServletRequest, HttpServletResponse)`£º +了解完 servlet 的请求入å�£å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±å¾—分æž�一个ä¸�å¾—ä¸�æ��的类了:`FrameworkServlet`。`FrameworkServlet` 是 `HttpServlet` çš„å­�类,实现了 `HttpServlet` çš„å�„ç§� `doXxx()`,å�Œæ—¶ä¹Ÿå®žçŽ°äº† `service(HttpServletRequest, HttpServletResponse)`: ``` /** - * FrameworkServlet¼Ì³ÐÁËHttpServletBean£¬¶øHttpServletBean¼Ì³ÐÁËHttpServlet - * Òò´ËFrameworkServletÒ²ÊÇHttpServletµÄ×ÓÀà + * FrameworkServlet继承了HttpServletBean,而HttpServletBean继承了HttpServlet + * å› æ­¤FrameworkServlet也是HttpServletçš„å­�ç±» */ public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware { @Override @@ -125,7 +125,7 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic processRequest(request, response); } else { - // GET/POST/PUT/DELETE µÈÇëÇó·½·¨£¬»¹ÊÇ»áµ÷Óø¸ÀàµÄ·½·¨ + // GET/POST/PUT/DELETE 等请求方法,还是会调用父类的方法 super.service(request, response); } } @@ -133,17 +133,17 @@ public abstract class FrameworkServlet extends HttpServletBean implements Applic ``` -¿ÉÒÔ¿´µ½£¬ÒÔÉÏ´úÂëÖУ¬ÓÐÒ»¸ö·½·¨µÄ³ö¾µÂÊÏ൱¸ß£º`FrameworkServlet#processRequest`£¬²»¹ÜÊÇ `doXxx(xxx)`£¬»¹ÊÇ `service(xxx)`£¬¶¼»áµ÷Óà `processRequest(xxx)`£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´¿´¿´Õâ¸ö·½·¨×öÁËʲô£º +å�¯ä»¥çœ‹åˆ°ï¼Œä»¥ä¸Šä»£ç �中,有一个方法的出镜率相当高:`FrameworkServlet#processRequest`,ä¸�管是 `doXxx(xxx)`,还是 `service(xxx)`,都会调用 `processRequest(xxx)`,接下æ�¥æˆ‘们就æ�¥çœ‹çœ‹è¿™ä¸ªæ–¹æ³•å�šäº†ä»€ä¹ˆï¼š > FrameworkServlet#processRequest ``` protected final void processRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { - // ¼Ç¼¿ªÊ¼Ê±¼ä + // 记录开始时间 long startTime = System.currentTimeMillis(); Throwable failureCause = null; - // ¼Ç¼µ±Ç°Ï̵߳ÄÐÅÏ¢ + // 记录当å‰�线程的信æ�¯ LocaleContext previousLocaleContext = LocaleContextHolder.getLocaleContext(); LocaleContext localeContext = buildLocaleContext(request); RequestAttributes previousAttributes = RequestContextHolder.getRequestAttributes(); @@ -154,7 +154,7 @@ protected final void processRequest(HttpServletRequest request, HttpServletRespo new RequestBindingInterceptor()); initContextHolders(request, localeContext, requestAttributes); try { - // ºËÐÄ´¦Àí + // 核心处ç�† doService(request, response); } catch (ServletException | IOException ex) { @@ -166,25 +166,25 @@ protected final void processRequest(HttpServletRequest request, HttpServletRespo throw new NestedServletException("Request processing failed", ex); } finally { - // Çå³ýḬ̈߳ó¶¨ÐÅÏ¢ + // 清除线程绑定信æ�¯ resetContextHolders(request, previousLocaleContext, previousAttributes); if (requestAttributes != null) { requestAttributes.requestCompleted(); } logResult(request, response, failureCause, asyncManager); - // ·¢ËÍʼþ֪ͨ + // å�‘é€�事件通知 publishRequestHandledEvent(request, response, startTime, failureCause); } } ``` -Õâ¸ö·½·¨ËäÈ»Óе㳤£¬µ«´ó²¿·ÖÓëÇëÇó´¦ÀíÁ÷³Ì¹ØÏµ²»´ó£¬ÓëÇëÇó´¦ÀíÁ÷³ÌÏà¹ØµÄÖ»Óм¸ÐУº +这个方法虽然有点长,但大部分与请求处ç�†æµ�程关系ä¸�大,与请求处ç�†æµ�程相关的å�ªæœ‰å‡ è¡Œï¼š ``` ... try { - // ºËÐÄ´¦Àí + // 核心处ç�† doService(request, response); } catch (ServletException | IOException ex) { @@ -195,7 +195,7 @@ protected final void processRequest(HttpServletRequest request, HttpServletRespo ``` -ÓÉ´Ë¿ÉÒÔ¿´µ½£¬Êµ¼Ê´¦ÀíÇëÇóµÄ·½·¨ÊÇÔÚ `FrameworkServlet#doService` ÖС£²»¹ý£¬`FrameworkServlet#doService` ÊǸö³éÏó·½·¨£º +由此å�¯ä»¥çœ‹åˆ°ï¼Œå®žé™…处ç�†è¯·æ±‚的方法是在 `FrameworkServlet#doService` 中。ä¸�过,`FrameworkServlet#doService` 是个抽象方法: ``` protected abstract void doService(HttpServletRequest request, @@ -203,11 +203,11 @@ protected abstract void doService(HttpServletRequest request, ``` -ÕæÕýµÄʵÏÖÊÇÔÚ×ÓÀ࣬Ҳ¾ÍÊÇ `DispatcherServlet#doService` ÖС£ +真正的实现是在å­�类,也就是 `DispatcherServlet#doService` 中。 #### 1.3 `DispatcherServlet#doService` -À´¿´¿´ `DispatcherServlet#doService` ×öÁËɶÊ£º +æ�¥çœ‹çœ‹ `DispatcherServlet#doService` å�šäº†å•¥äº‹ï¼š ``` public class DispatcherServlet extends FrameworkServlet { @@ -215,10 +215,10 @@ public class DispatcherServlet extends FrameworkServlet { protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception { logRequest(request); - // Ê¡ÂÔÁËÒ»´ó¶ÎÊôÐÔÉèÖà + // çœ�略了一大段属性设置 ... try { - // ¾ßÌåµÄ´¦Àí + // 具体的处ç�† doDispatch(request, response); } finally { @@ -229,15 +229,15 @@ public class DispatcherServlet extends FrameworkServlet { ``` -ÕâÈË·½·¨Ò²Ã»¸ÉʲôÊÂʵ£¬Ö»Êǵ÷ÓÃÁËһϠ`doDispatch` ·½·¨£¬È»ºó¾ÍûÁË¡£ÊÂʵÉÏ£¬`DispatcherServlet#doDispatch` ¾ÍÊÇ×îÖÕ´¦ÀíÇëÇóµÄÂß¼­£¬½ÓÏÂÀ´ÎÒÃÇÖØµã·ÖÎöÕâ¸ö·½·¨ ¡£ +这人方法也没干什么事实,å�ªæ˜¯è°ƒç”¨äº†ä¸€ä¸‹ `doDispatch` 方法,然å�Žå°±æ²¡äº†ã€‚事实上,`DispatcherServlet#doDispatch` 就是最终处ç�†è¯·æ±‚的逻辑,接下æ�¥æˆ‘们é‡�点分æž�这个方法 。 -ÕâÒ»½ÚÎÒÃÇÀ´×ܽáÏ `DispatcherServlet` µÄÇëÇóÁ÷³Ì£º +这一节我们æ�¥æ€»ç»“下 `DispatcherServlet` 的请求æµ�程: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-f854710c25924666cd5ab755c2983a9baf7.png) -### 2\. springmvc ÇëÇó·Ö·¢£º`DispatcherServlet#doDispatch` +### 2\. springmvc 请求分å�‘:`DispatcherServlet#doDispatch` -ÉÏÒ»½ÚµÄ×îºó£¬ÎÒÃÇ·¢ÏÖ springmvc ´¦ÀíÇëÇóµÄ·½·¨ÊÇ `DispatcherServlet#doDispatch`£¬±¾½Ú¾Í´ÓÕâ¸ö·½·¨ÈëÊÖ£¬¿´¿´Õâ¸ö·½·¨µÄÂß¼­£º +上一节的最å�Žï¼Œæˆ‘们å�‘现 springmvc 处ç�†è¯·æ±‚的方法是 `DispatcherServlet#doDispatch`,本节就从这个方法入手,看看这个方法的逻辑: ``` protected void doDispatch(HttpServletRequest request, HttpServletResponse response) @@ -250,20 +250,20 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon ModelAndView mv = null; Exception dispatchException = null; try { - //Èç¹ûÊÇÎļþÉÏ´«ÇëÇóÔò½øÐÐÌØÊâ´¦Àí + //如果是文件上传请求则进行特殊处ç�† processedRequest = checkMultipart(request); multipartRequestParsed = (processedRequest != request); - // 1\. »ñÈ¡¶ÔÓ¦µÄhandler, - // HandlerÖаüº¬ÕæÕýµØ´¦ÀíÆ÷£¨ControllerÖеķ½·¨£©ºÍÒ»×éHandlerInterceptorÀ¹½ØÆ÷ + // 1\. 获å�–对应的handler, + // Handler中包å�«çœŸæ­£åœ°å¤„ç�†å™¨ï¼ˆController中的方法)和一组HandlerInterceptor拦截器 mappedHandler = getHandler(processedRequest); if (mappedHandler == null) { - // Èç¹ûûÕÒµ½£¬±¨¸ö404 + // 如果没找到,报个404 noHandlerFound(processedRequest, response); return; } - // 2\. »ñÈ¡¶ÔÓ¦µÄhandlerAdapter£¬ÓÃÀ´ÔËÐÐ handler(xxx) + // 2\. 获å�–对应的handlerAdapter,用æ�¥è¿�行 handler(xxx) HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler()); - // ´¦Àílast-modifiedÇé¿ö + // 处ç�†last-modified情况 String method = request.getMethod(); boolean isGet = "GET".equals(method); if (isGet || "HEAD".equals(method)) { @@ -272,18 +272,18 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon return; } } - // 3\. ÔËÐÐspringµÄÀ¹½ØÆ÷, ÔËÐÐ HandlerInterceptor#preHandle ·½·¨ + // 3\. è¿�行spring的拦截器, è¿�行 HandlerInterceptor#preHandle 方法 if (!mappedHandler.applyPreHandle(processedRequest, response)) { return; } - // 4\. ͨ¹ýÉÏÃæ»ñÈ¡µ½µÄhandlerAdapterÀ´µ÷ÓÃhandle + // 4\. 通过上é�¢èŽ·å�–到的handlerAdapteræ�¥è°ƒç”¨handle mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); if (asyncManager.isConcurrentHandlingStarted()) { return; } - // Èç¹ûº¯Êýµ÷ÓÃûÓзµ»ØÊÓͼÔòʹÓÃĬÈ쵀 + // 如果函数调用没有返回视图则使用默认的 applyDefaultViewName(processedRequest, mv); - // 5\. Ö´ÐÐÀ¹½ØÆ÷£¬ÔËÐÐ HandlerInterceptor#postHandle ·½·¨ + // 5\. 执行拦截器,è¿�行 HandlerInterceptor#postHandle 方法 mappedHandler.applyPostHandle(processedRequest, response, mv); } catch (Exception ex) { @@ -292,17 +292,17 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon catch (Throwable err) { dispatchException = new NestedServletException("Handler dispatch failed", err); } - // 6\. ´¦Àí·µ»Ø½á¹û£¬ÔÚÕâ¸ö·½·¨Àï»áäÖȾÊÓͼ£¬ÒÔ¼°Ö´ÐÐ HandlerInterceptor#afterCompletion + // 6\. 处ç�†è¿”回结果,在这个方法里会渲染视图,以å�Šæ‰§è¡Œ HandlerInterceptor#afterCompletion processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException); } catch (...) { - // ÕâÀï»áÖ´ÐÐ HandlerInterceptor#afterCompletion + // 这里会执行 HandlerInterceptor#afterCompletion triggerAfterCompletion(processedRequest, response, mappedHandler, ex); } finally { if (asyncManager.isConcurrentHandlingStarted()) { if (mappedHandler != null) { - // »Øµ÷À¹½ØÆ÷£¬Ö´Ðз½·¨ AsyncHandlerInterceptor#afterConcurrentHandlingStarted + // 回调拦截器,执行方法 AsyncHandlerInterceptor#afterConcurrentHandlingStarted mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response); } } @@ -316,28 +316,28 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon ``` -Õâ¸ö·½·¨Ôڵ㳤£¬²»¹ýÁ÷³ÌºÜÇåÎú£¬springmvc µÄÕû¸öÇëÇóÁ÷³Ì¶¼ÔÚÕâÀïÁË£¬ÕâÀï°Ñ¹Ø¼ü²½ÖèչʾÈçÏ£º +这个方法在点长,ä¸�过æµ�程很清晰,springmvc 的整个请求æµ�程都在这里了,这里把关键步骤展示如下: -1. »ñÈ¡¶ÔÓ¦µÄ `HandlerExecutionChain`, »ñÈ¡µÄ `HandlerExecutionChain` Öаüº¬ÕæÕýµØ´¦ÀíÆ÷£¨`Controller` Öеķ½·¨£©ºÍÒ»×é `HandlerInterceptor` À¹½ØÆ÷£» -2. »ñÈ¡¶ÔÓ¦µÄ `handlerAdapter`£¬¸Ã¶ÔÏóÓÃÀ´ÔËÐÐ `handler(xxx)` ·½·¨£» -3. Ö´ÐÐ spring µÄÀ¹½ØÆ÷£¬ÔËÐÐ `HandlerInterceptor#preHandle` ·½·¨£» -4. ´¦ÀíÇëÇó£¬Ò²¾ÍÊÇͨ¹ýÉÏÃæ»ñÈ¡µ½µÄ `handlerAdapter` À´µ÷Óà `handle(xxx)` ·½·¨£» -5. Ö´ÐÐ spring µÄÀ¹½ØÆ÷£¬ÔËÐÐ `HandlerInterceptor#postHandle` ·½·¨£» -6. ´¦Àí·µ»Ø½á¹û£¬ÕâÀï»áäÖȾÊÓͼ£¬ÒÔ¼°Ö´ÐÐ spring À¹½ØÆ÷µÄ `HandlerInterceptor#afterCompletion`¡£ +1. 获å�–对应的 `HandlerExecutionChain`, 获å�–çš„ `HandlerExecutionChain` 中包å�«çœŸæ­£åœ°å¤„ç�†å™¨ï¼ˆ`Controller` 中的方法)和一组 `HandlerInterceptor` 拦截器; +2. 获å�–对应的 `handlerAdapter`,该对象用æ�¥è¿�行 `handler(xxx)` 方法; +3. 执行 spring 的拦截器,è¿�行 `HandlerInterceptor#preHandle` 方法; +4. 处ç�†è¯·æ±‚,也就是通过上é�¢èŽ·å�–到的 `handlerAdapter` æ�¥è°ƒç”¨ `handle(xxx)` 方法; +5. 执行 spring 的拦截器,è¿�行 `HandlerInterceptor#postHandle` 方法; +6. 处ç�†è¿”回结果,这里会渲染视图,以å�Šæ‰§è¡Œ spring 拦截器的 `HandlerInterceptor#afterCompletion`。 -×ܵÄÁ÷³ÌÊáÀíÇå³þÁË£¬½ÓÏÂÀ´¾ÍÊÇÖð¸öÁ÷³Ì·ÖÎöÁË¡£ +总的æµ�程梳ç�†æ¸…楚了,接下æ�¥å°±æ˜¯é€�个æµ�程分æž�了。 -### 3\. »ñÈ¡ `HandlerExecutionChain` +### 3\. 获å�– `HandlerExecutionChain` -»ñÈ¡ `HandlerExecutionChain` µÄ·½·¨ÔÚ `DispatcherServlet#getHandler` ÖУº +获å�– `HandlerExecutionChain` 的方法在 `DispatcherServlet#getHandler` 中: ``` protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception { if (this.handlerMappings != null) { - // ±éÀúËùÓеÄhandlerMapping£¬ - // ÕâÀïµÄ handlerMapping ÊÇÔÚWebMvcConfigurationSupportÖÐÒýÈëµÄ + // é��历所有的handlerMapping, + // 这里的 handlerMapping 是在WebMvcConfigurationSupport中引入的 for (HandlerMapping mapping : this.handlerMappings) { - // ÕâÀïµ÷ÓþßÌåµÄhandler£¬ÄĸöhandlerÄܹ»´¦Àí¾ÍÖ±½Ó·µ»Ø + // 这里调用具体的handler,哪个handler能够处ç�†å°±ç›´æŽ¥è¿”回 HandlerExecutionChain handler = mapping.getHandler(request); if (handler != null) { return handler; @@ -349,43 +349,43 @@ protected HandlerExecutionChain getHandler(HttpServletRequest request) throws Ex ``` -ÕâÀïµÄ `handlerMappings` ÊÇÔÚ `WebMvcConfigurationSupport` ÖÐÒýÈëµÄ£¬¹ØÓÚÕâÒ»¿éµÄ·ÖÎö£¬¿ÉÄܲο¼ [springmvc demo Óë @EnableWebMvc ×¢½â](https://my.oschina.net/funcy/blog/4678093 "springmvc demo Óë @EnableWebMvc ×¢½â")Ò»ÎÄ£¬ÕâÀïÀ´¿´¿´Õâ¸ö `handlerMappings` ÓÐЩɶ£º +这里的 `handlerMappings` 是在 `WebMvcConfigurationSupport` 中引入的,关于这一å�—的分æž�,å�¯èƒ½å�‚考 [springmvc demo 与 @EnableWebMvc 注解](https://my.oschina.net/funcy/blog/4678093 "springmvc demo 与 @EnableWebMvc 注解")一文,这里æ�¥çœ‹çœ‹è¿™ä¸ª `handlerMappings` 有些啥: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-4465a638ca6c52f24f8c9343986be0bbee9.png) -¶ÔÓÚ `RequestMappingHandlerMapping` ÏàÐÅ´ó¼ÒÒѾ­ºÜÊìϤ£¬¶ÔÓÚ `@Controller`/`@RequestMapping` ·½Ê½ÊµÏÖµÄ `controller`£¬¶ÔÓ¦µÄ `HandlerMapping` ¾ÍÊÇ `RequestMappingHandlerMapping`¡£ÖÁÓÚÁíÍâµÄÁ½¸ö `HandlerMapping`£¬Ôò·Ö±ð¶ÔÓ¦²»Í¬·½Ê½ÊµÏÖµÄ `controller`£¬¹ØÓÚÕâÒ»µã£¬¸ÐÐËȤµÄС»ï°é¿ÉÒÔ×ÔÐаٶȣ¬ÕâÀï¾Í²»Õ¹¿ªÁË¡£ +对于 `RequestMappingHandlerMapping` 相信大家已ç»�很熟悉,对于 `@Controller`/`@RequestMapping` æ–¹å¼�实现的 `controller`,对应的 `HandlerMapping` 就是 `RequestMappingHandlerMapping`。至于å�¦å¤–的两个 `HandlerMapping`,则分别对应ä¸�å�Œæ–¹å¼�实现的 `controller`,关于这一点,感兴趣的å°�伙伴å�¯ä»¥è‡ªè¡Œç™¾åº¦ï¼Œè¿™é‡Œå°±ä¸�展开了。 -ÎÒÃǼÌÐø¿´ `AbstractHandlerMapping#getHandler` ·½·¨£º +我们继续看 `AbstractHandlerMapping#getHandler` 方法: ``` public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception { - // 1\. µ÷ÓþßÌåµÄʵÏÖÈ¥»ñÈ¡handler + // 1\. 调用具体的实现去获å�–handler Object handler = getHandlerInternal(request); - // Èç¹ûΪ¿ÕʹÓÃĬÈ쵀 + // 如果为空使用默认的 if (handler == null) { handler = getDefaultHandler(); } - // ûÓÐĬÈϵķµ»Ø¿Õ + // 没有默认的返回空 if (handler == null) { return null; } - // ³¢ÊÔͨ¹ýBeanNameÈ¥»ñÈ¡handler + // å°�试通过BeanName去获å�–handler if (handler instanceof String) { String handlerName = (String) handler; handler = obtainApplicationContext().getBean(handlerName); } - // 2\. »ñÈ¡ executionChain£¬Æäʵ¾ÍÊÇÕÒµ½ uri ¶ÔÓ¦µÄ Interceptors, - // È»ºóÓëÉÏÃæÕÒµ½µÄhandlerÒ»Æð·â×°µ½HandlerExecutionChain¶ÔÏóÖÐ - // ÕâÀïµÄInterceptors£¬Ò²ÊÇÔÚWebMvcConfigurationSupportÖÐÅäÖÃµÄ + // 2\. 获å�– executionChain,其实就是找到 uri 对应的 Interceptors, + // ç„¶å�Žä¸Žä¸Šé�¢æ‰¾åˆ°çš„handler一起å°�装到HandlerExecutionChain对象中 + // 这里的Interceptors,也是在WebMvcConfigurationSupport中é…�置的 HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request); - // 3\. ´¦Àí·ÓòÏà¹ØµÄÅäÖãºCorsHandlerExecutionChain - // ÕâÀï¿ÉÒÔ¿´µ½£¬ËùνµÄcors¿çÓòÅäÖã¬Ò²ÊÇÓÉÀ¹½ØÆ÷ʵÏÖµÄ + // 3\. 处ç�†è·¯åŸŸç›¸å…³çš„é…�置:CorsHandlerExecutionChain + // 这里å�¯ä»¥çœ‹åˆ°ï¼Œæ‰€è°“çš„cors跨域é…�置,也是由拦截器实现的 if (hasCorsConfigurationSource(handler)) { CorsConfiguration config = (this.corsConfigurationSource != null ? this.corsConfigurationSource.getCorsConfiguration(request) : null); CorsConfiguration handlerConfig = getCorsConfiguration(handler, request); config = (config != null ? config.combine(handlerConfig) : handlerConfig); - // ½«¿çÓòÏà¹ØµÄÅäÖÃÌí¼Óµ½ Interceptors£¬¼Óµ½À¹½ØÆ÷ListµÄµÚÒ»¸öÖÐ + // 将跨域相关的é…�置添加到 Interceptors,加到拦截器List的第一个中 executionChain = getCorsHandlerExecutionChain(request, executionChain, config); } return executionChain; @@ -393,29 +393,29 @@ public final HandlerExecutionChain getHandler(HttpServletRequest request) throws ``` -Õâ¸ö·½·¨Ö÷Òª×öÁËÈý¼þÊ£º +这个方法主è¦�å�šäº†ä¸‰ä»¶äº‹ï¼š -1. µ÷ÓþßÌåµÄʵÏÖÈ¥»ñÈ¡ handler£¬Õâ¸ö·½·¨ÊÇÖØµã£¬ÏÂÃæ»á¼ÌÐø½²£» -2. »ñÈ¡ `executionChain`£¬Õâ¸ö `executionChain` ³ýÁ˰üº¬ÁËÉÏÒ»²½µÄ `handler` Í⣬»¹°üº¬ `uri` ¶ÔÓ¦µÄ `Interceptors`£¬»ñÈ¡·½·¨Îª»ñÈ¡ËùÓÐµÄ `Interceptors` ÅäÖã¨ÔÚ `WebMvcConfigurationSupport` ÖÐÅäÖõģ©£¬ÔÙÖðÒ»ÅÐ¶Ï uri ÊÇ·ñ·ûºÏ `Interceptor` µÄ uri ÅäÖã» -3. »ñÈ¡ cors ¿çÓòÅäÖã¬È»ºóÌí¼Óµ½ `executionChain` ÖÐµÄ `Interceptors` ÁбíµÄµÚһλ¡£àÅ£¬Ã»´í£¬cors ¿çÓòÅäÖÃÒ²ÊÇÔÚ `WebMvcConfigurationSupport` ÖÐÅäÖõġ£ +1. 调用具体的实现去获å�– handler,这个方法是é‡�点,下é�¢ä¼šç»§ç»­è®²ï¼› +2. 获å�– `executionChain`,这个 `executionChain` 除了包å�«äº†ä¸Šä¸€æ­¥çš„ `handler` 外,还包å�« `uri` 对应的 `Interceptors`,获å�–方法为获å�–所有的 `Interceptors` é…�置(在 `WebMvcConfigurationSupport` 中é…�置的),å†�é€�一判断 uri 是å�¦ç¬¦å�ˆ `Interceptor` çš„ uri é…�置; +3. 获å�– cors 跨域é…�置,然å�Žæ·»åŠ åˆ° `executionChain` 中的 `Interceptors` 列表的第一ä½�。嗯,没错,cors 跨域é…�置也是在 `WebMvcConfigurationSupport` 中é…�置的。 -#### 3.1 ²éÕÒ `HandlerMethod` +#### 3.1 查找 `HandlerMethod` -ÎÒÃǽøÈë `getHandlerInternal(xxx)` ·½·¨£º +我们进入 `getHandlerInternal(xxx)` 方法: > AbstractHandlerMethodMapping#getHandlerInternal ``` @Override protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Exception { - // »ñÈ¡ÇëÇóµÄurl + // 获å�–请求的url String lookupPath = getUrlPathHelper().getLookupPathForRequest(request); request.setAttribute(LOOKUP_PATH, lookupPath); this.mappingRegistry.acquireReadLock(); try { - // ÔÚÕâÀï²éÕÒuri¶ÔÓ¦µÄhandlerMethod + // 在这里查找uri对应的handlerMethod HandlerMethod handlerMethod = lookupHandlerMethod(lookupPath, request); - // Èç¹ûhandlerMethod²»Îª¿Õ£¬ÔòÖØÐ´´½¨Ò»¸öHandlerMethod·µ»Ø + // 如果handlerMethodä¸�为空,则é‡�新创建一个HandlerMethod返回 return (handlerMethod != null ? handlerMethod.createWithResolvedBean() : null); } finally { @@ -425,7 +425,7 @@ protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Ex ``` -ÕâÀﻹÊǵ÷Óà `lookupHandlerMethod(xxx)` À´²éÕÒ `handlerMethod`£¬¼ÌÐø +这里还是调用 `lookupHandlerMethod(xxx)` æ�¥æŸ¥æ‰¾ `handlerMethod`,继续 > AbstractHandlerMethodMapping#lookupHandlerMethod @@ -433,19 +433,19 @@ protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Ex protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletRequest request) throws Exception { List matches = new ArrayList<>(); - // ÏÈ´ÓurlLookupÖÐÕÒ£¬urlLookupÊÇÒ»¸ömap£¬keyÊÇurl£¬valueÊÇLinkedList + // 先从urlLookup中找,urlLookup是一个map,key是url,value是LinkedList List directPathMatches = this.mappingRegistry.getMappingsByUrl(lookupPath); if (directPathMatches != null) { - // ÓÉÓÚ·µ»ØµÄÊÇÒ»¸ö list£¬ÕâÀï»á°ÑËùÓÐµÄÆ¥ÅäµÄ½á¹û·ÅÈëÒ»¸ömatchesÖÐ + // 由于返回的是一个 list,这里会把所有的匹é…�的结果放入一个matches中 addMatchingMappings(directPathMatches, matches, request); } if (matches.isEmpty()) { - // Èç¹ûͨ¹ýurlûÕÒµ½£¬Ôò±éÀúËùÓÐµÄ mappings Æ¥Å䣬ƥÅäÀàËÆÓÚ /test/{name} µÄurl - // mappingsÒ²ÊÇÒ»¸ömap£¬keyÊÇRequestMappingInfo£¬ valueÊÇHandlerMethod + // 如果通过url没找到,则é��历所有的 mappings 匹é…�,匹é…�类似于 /test/{name} çš„url + // mappings也是一个map,key是RequestMappingInfo, value是HandlerMethod addMatchingMappings(this.mappingRegistry.getMappings().keySet(), matches, request); } - // ÕÒµ½×î¼ÑÆ¥ÅäµÄmapping,·µ»ØÆä¶ÔÓ¦µÄHandlerMethod - // ±È½Ï¹æÔòÀ´×ÔÓÚ RequestMappingInfo#compareTo·½·¨ + // 找到最佳匹é…�çš„mapping,返回其对应的HandlerMethod + // 比较规则æ�¥è‡ªäºŽ RequestMappingInfo#compareTo方法 if (!matches.isEmpty()) { Comparator comparator = new MatchComparator(getMappingComparator(request)); matches.sort(comparator); @@ -455,7 +455,7 @@ protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletReques return PREFLIGHT_AMBIGUOUS_MATCH; } Match secondBestMatch = matches.get(1); - // ÕÒµ½ÁËÁ½¸ö×î¼ÑÆ¥Å䣬Å׳öÒì³£ + // 找到了两个最佳匹é…�,抛出异常 if (comparator.compare(bestMatch, secondBestMatch) == 0) { Method m1 = bestMatch.handlerMethod.getMethod(); Method m2 = secondBestMatch. .,m.bvc .getMethod(); @@ -474,13 +474,13 @@ protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletReques ``` -Õâ¸ö·½·¨¾ÍÊÇ´¦Àí handler µÄ»ñÈ¡ÁË¡£ÕâÀïµÄ»ñÈ¡·ÖΪ¼¸¸ö²½Ö裺 +这个方法就是处ç�† handler 的获å�–了。这里的获å�–分为几个步骤: -1. ÏÈ´Ó `urlLookup` ÖÐÕÒ£¬`urlLookup` ÊÇÒ»¸ö `map`£¬`key` ÊÇ `url`£¬`value` ÊÇ `LinkedList`£¬Õâ¸ö²Ù×÷¾ÍÊÇ `map.get(xxx)` ·½·¨£» -2. Èç¹ûͨ¹ý `url` ûÕÒµ½£¬Ôò±éÀúËùÓÐµÄ `mappings` Æ¥Å䣬ƥÅäÀàËÆÓÚ `/test/{name}` µÄ `url`£¬`mappings` Ò²ÊÇÒ»¸ö `map`£¬`key` ÊÇ `RequestMappingInfo`£¬ `value` ÊÇ `HandlerMethod`£» -3. Èç¹ûÕÒµ½Á˶à¸ö `HandlerMethod`£¬Ôò¸ù¾Ý `RequestMappingInfo#compareTo` ·½·¨ÌṩµÄ·½·¨£¬ÕÒµ½×î¼ÑµÄ `RequestMappingInfo` ¶ÔÓ¦µÄ `HandlerMethod`¡£ +1. 先从 `urlLookup` 中找,`urlLookup` 是一个 `map`,`key` 是 `url`,`value` 是 `LinkedList`,这个æ“�作就是 `map.get(xxx)` 方法; +2. 如果通过 `url` 没找到,则é��历所有的 `mappings` 匹é…�,匹é…�类似于 `/test/{name}` çš„ `url`,`mappings` 也是一个 `map`,`key` 是 `RequestMappingInfo`, `value` 是 `HandlerMethod`ï¼› +3. 如果找到了多个 `HandlerMethod`,则根æ�® `RequestMappingInfo#compareTo` 方法æ��供的方法,找到最佳的 `RequestMappingInfo` 对应的 `HandlerMethod`。 -ÎÒÃÇÀ´¿´¿´ÔÚ `mappings` ÀïÊÇÈçºÎÕÒµ½Æ¥ÅäµÄ `RequestMappingInfo` µÄ£º +我们æ�¥çœ‹çœ‹åœ¨ `mappings` 里是如何找到匹é…�çš„ `RequestMappingInfo` 的: > AbstractHandlerMethodMapping#addMatchingMappings @@ -488,7 +488,7 @@ protected HandlerMethod lookupHandlerMethod(String lookupPath, HttpServletReques private void addMatchingMappings(Collection mappings, List matches, HttpServletRequest request) { for (T mapping : mappings) { - // Æ¥ÅäÆäËûÌõ¼þ£¬ÕÒµ½ÆäÖÐËùÓзûºÏÌõ¼þµÄ mappings + // 匹é…�å…¶ä»–æ�¡ä»¶ï¼Œæ‰¾åˆ°å…¶ä¸­æ‰€æœ‰ç¬¦å�ˆæ�¡ä»¶çš„ mappings T match = getMatchingMapping(mapping, request); if (match != null) { matches.add(new Match(match, this.mappingRegistry.getMappings().get(mapping))); @@ -498,14 +498,14 @@ private void addMatchingMappings(Collection mappings, List matches, ``` -×îÖÕ·¢ÏÖÆ¥ÅäµÄ´¦ÀíÊÇÔÚ `RequestMappingInfo#getMatchingCondition` ·½·¨ÖУ¬`RequestMappingInfo` »¹ÓÐÒ»¸ö `compareTo` ·½·¨£¬ÎÒÃÇÒ²Ò»²¢²é¿´Ï£º +最终å�‘现匹é…�的处ç�†æ˜¯åœ¨ `RequestMappingInfo#getMatchingCondition` 方法中,`RequestMappingInfo` 还有一个 `compareTo` 方法,我们也一并查看下: > RequestMappingInfo ``` /** - * Æ¥Å乿Ôò - * »á·Ö±ðÆ¥Åä ÇëÇó·½·¨(get,postµÈ)¡¢ÇëÇó²ÎÊý¡¢ÇëÇóÍ·µÈ + * 匹é…�规则 + * 会分别匹é…� 请求方法(get,postç­‰)ã€�请求å�‚æ•°ã€�请求头等 */ public RequestMappingInfo getMatchingCondition(HttpServletRequest request) { RequestMethodsRequestCondition methods = this.methodsCondition.getMatchingCondition(request); @@ -541,8 +541,8 @@ public RequestMappingInfo getMatchingCondition(HttpServletRequest request) { } /** - * ±È½Ï¹æÔò£¬ÕÒµ½×î¼ÑÆ¥Åä - * »á·Ö±ð±È½Ï ÇëÇó·½·¨(get,postµÈ)¡¢ÇëÇó²ÎÊý¡¢ÇëÇóÍ·µÈ + * 比较规则,找到最佳匹é…� + * 会分别比较 请求方法(get,postç­‰)ã€�请求å�‚æ•°ã€�请求头等 */ public int compareTo(RequestMappingInfo other, HttpServletRequest request) { int result; @@ -585,20 +585,20 @@ public int compareTo(RequestMappingInfo other, HttpServletRequest request) { ``` -ÎÞÂÛÆ¥Å䣬»¹ÊDZȽϣ¬¶¼»á¶ÔÇëÇó·½·¨ (get,post µÈ)¡¢ÇëÇó²ÎÊý¡¢ÇëÇóÍ·µÈÒ»Ò»½øÐд¦Àí¡£ +无论匹é…�,还是比较,都会对请求方法 (get,post ç­‰)ã€�请求å�‚æ•°ã€�请求头等一一进行处ç�†ã€‚ -µ½ÕâÀÎÒÃǾÍÃ÷°×ÁË springmvc ÊÇÈçºÎÕÒµ½ `HandlerMethod` µÄÁË¡£ +到这里,我们就明白了 springmvc 是如何找到 `HandlerMethod` 的了。 -#### 3.2 ²éÕÒ `Interceptors` +#### 3.2 查找 `Interceptors` -ÎÒÃǻص½ `AbstractHandlerMapping#getHandler`£¬¿´¿´ÊÇÈçºÎ»ñÈ¡ `Interceptor` µÄ£º +我们回到 `AbstractHandlerMapping#getHandler`,看看是如何获å�– `Interceptor` 的: ``` public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception { ... - // 2\. »ñÈ¡ executionChain£¬Æäʵ¾ÍÊÇÕÒµ½ uri ¶ÔÓ¦µÄ Interceptors, - // È»ºóÓëÉÏÃæÕÒµ½µÄhandlerÒ»Æð·â×°µ½HandlerExecutionChain¶ÔÏóÖÐ - // ÕâÀïµÄInterceptors£¬Ò²ÊÇÔÚWebMvcConfigurationSupportÖÐÅäÖÃµÄ + // 2\. 获å�– executionChain,其实就是找到 uri 对应的 Interceptors, + // ç„¶å�Žä¸Žä¸Šé�¢æ‰¾åˆ°çš„handler一起å°�装到HandlerExecutionChain对象中 + // 这里的Interceptors,也是在WebMvcConfigurationSupport中é…�置的 HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request); ... return executionChain; @@ -606,7 +606,7 @@ public final HandlerExecutionChain getHandler(HttpServletRequest request) throws ``` -½øÈë `getHandlerExecutionChain` ·½·¨£º +进入 `getHandlerExecutionChain` 方法: > AbstractHandlerMapping#getHandlerExecutionChain @@ -615,12 +615,12 @@ protected HandlerExecutionChain getHandlerExecutionChain(Object handler, HttpServletRequest request) { HandlerExecutionChain chain = (handler instanceof HandlerExecutionChain ? (HandlerExecutionChain) handler : new HandlerExecutionChain(handler)); - // »ñÈ¡µ±Ç°µÄÇëÇó·¾¶ + // 获å�–当å‰�的请求路径 String lookupPath = this.urlPathHelper.getLookupPathForRequest(request, LOOKUP_PATH); for (HandlerInterceptor interceptor : this.adaptedInterceptors) { if (interceptor instanceof MappedInterceptor) { MappedInterceptor mappedInterceptor = (MappedInterceptor) interceptor; - // Åжϵ±Ç°ÇëÇó·¾¶ÊÇ·ñÂú×ãinterceptorÀïÅäÖõÄ·¾¶ + // 判断当å‰�请求路径是å�¦æ»¡è¶³interceptor里é…�置的路径 if (mappedInterceptor.matches(lookupPath, this.pathMatcher)) { chain.addInterceptor(mappedInterceptor.getInterceptor()); } @@ -634,25 +634,25 @@ protected HandlerExecutionChain getHandlerExecutionChain(Object handler, ``` -Õâ¸ö·½·¨±È½Ï¼òµ¥£¬Ïà¹ØÄÚÈÝÒѾ­ÔÚ´úÂëÖÐ×öÁË×¢ÊÍ£¬¾Í²»¶à˵ÁË ¡£ +这个方法比较简å�•,相关内容已ç»�在代ç �中å�šäº†æ³¨é‡Šï¼Œå°±ä¸�多说了 。 -#### 3.3 ´¦Àí cors ¿çÓòÅäÖà +#### 3.3 处ç�† cors 跨域é…�ç½® -ÎÒÃÇÔÙÀ´¿´¿´¿çÓòÅäÖõĴ¦Àí£º +我们å†�æ�¥çœ‹çœ‹è·¨åŸŸé…�置的处ç�†ï¼š ``` public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception { ... - // 3\. ´¦Àí·ÓòÏà¹ØµÄÅäÖãºCorsHandlerExecutionChain - // ÕâÀï¿ÉÒÔ¿´µ½£¬ËùνµÄcors¿çÓòÅäÖã¬Ò²ÊÇÓÉÀ¹½ØÆ÷ʵÏÖµÄ + // 3\. 处ç�†è·¯åŸŸç›¸å…³çš„é…�置:CorsHandlerExecutionChain + // 这里å�¯ä»¥çœ‹åˆ°ï¼Œæ‰€è°“çš„cors跨域é…�置,也是由拦截器实现的 if (hasCorsConfigurationSource(handler)) { - // »ñÈ¡¿çÓòÅäÖà + // 获å�–跨域é…�ç½® CorsConfiguration config = (this.corsConfigurationSource != null ? this.corsConfigurationSource.getCorsConfiguration(request) : null); CorsConfiguration handlerConfig = getCorsConfiguration(handler, request); config = (config != null ? config.combine(handlerConfig) : handlerConfig); - // ½«¿çÓòÏà¹ØµÄÅäÖÃÌí¼Óµ½ Interceptors£¬¼Óµ½À¹½ØÆ÷ListµÄµÚÒ»¸öÖÐ + // 将跨域相关的é…�置添加到 Interceptors,加到拦截器List的第一个中 executionChain = getCorsHandlerExecutionChain(request, executionChain, config); } return executionChain; @@ -660,7 +660,7 @@ public final HandlerExecutionChain getHandler(HttpServletRequest request) ``` -¿çÓòÏà¹ØÅäÖÃÒ²¿ÉÒÔ `WebMvcConfigurationSupport` ÖÐÅäÖ㺠+跨域相关é…�置也å�¯ä»¥ `WebMvcConfigurationSupport` 中é…�置: ``` protected void addCorsMappings(CorsRegistry registry) { @@ -669,7 +669,7 @@ protected void addCorsMappings(CorsRegistry registry) { ``` -springmvc »ñÈ¡µ½¿çÓòÅäÖú󣬻á°ÑÏà¹ØÅäÖÃÌí¼Óµ½ `HandlerExecutionChain` ÖУº +springmvc 获å�–到跨域é…�ç½®å�Žï¼Œä¼šæŠŠç›¸å…³é…�置添加到 `HandlerExecutionChain` 中: ``` # AbstractHandlerMapping#getCorsHandlerExecutionChain @@ -680,7 +680,7 @@ protected HandlerExecutionChain getCorsHandlerExecutionChain(HttpServletRequest chain = new HandlerExecutionChain(new PreFlightHandler(config), interceptors); } else { - // Ìí¼Óµ½InterceptorsµÄÊ×λ + // 添加到Interceptors的首ä½� chain.addInterceptor(0, new CorsInterceptor(config)); } return chain; @@ -688,43 +688,43 @@ protected HandlerExecutionChain getCorsHandlerExecutionChain(HttpServletRequest # HandlerExecutionChain#addInterceptor(int, HandlerInterceptor) public void addInterceptor(int index, HandlerInterceptor interceptor) { - // Æäʵ¾ÍÊDzÙ×÷Ò»¸ölist + // 其实就是æ“�作一个list initInterceptorList().add(index, interceptor); } ``` -ÔÚ `HandlerExecutionChain` ÖУ¬ÓÐÒ»¸ö `List` ÓÃÀ´´æÈë `Interceptor`£¬»ñÈ¡µ½µÄ¿çÓòÅäÖ㬻áÌí¼Óµ½Õâ¸ö `List` µÄ `index=0` µÄλÖᣠ+在 `HandlerExecutionChain` 中,有一个 `List` 用æ�¥å­˜å…¥ `Interceptor`,获å�–到的跨域é…�置,会添加到这个 `List` çš„ `index=0` çš„ä½�置。 -µ½ÕâÀ`handler` ¾Í»ñÈ¡Íê³ÉÁË£¬Õâ¸ö `handler` °üº¬Á½²¿·Ö£º +到这里,`handler` 就获å�–完æˆ�了,这个 `handler` 包å�«ä¸¤éƒ¨åˆ†ï¼š -* `HandlerMethod`: ´¦ÀíÇëÇóµÄ·½·¨£¬ÓÉÓÚ±¾ÎÄÖ»·ÖÎö `@Controller` ·½Ê½µÄ controller£¬¿ÉÒÔ¼òµ¥Àí½âΪÓÐ `@RequestMapping` ×¢½âµÄ·½·¨£» -* `List`: À¹½ØÆ÷Á´£¬Èç¹ûÓпçÓòÅäÖã¬ÄÇô¿çÓòÅäÖûá·ÅÔÚÕâ¸ö List µÄµÚһλ¡£ +* `HandlerMethod`: 处ç�†è¯·æ±‚的方法,由于本文å�ªåˆ†æž� `@Controller` æ–¹å¼�çš„ controller,å�¯ä»¥ç®€å�•ç�†è§£ä¸ºæœ‰ `@RequestMapping` 注解的方法; +* `List`: 拦截器链,如果有跨域é…�置,那么跨域é…�置会放在这个 List 的第一ä½�。 -### 4\. »ñÈ¡ `HandlerAdapter` +### 4\. 获å�– `HandlerAdapter` -Ôٻص½ `DispatcherServlet#doDispatch` ·½·¨£¬ÎÒÃÇÀ´¿´¿´»ñÈ¡ `HandlerAdapter` µÄ·½·¨£º +å†�回到 `DispatcherServlet#doDispatch` 方法,我们æ�¥çœ‹çœ‹èŽ·å�– `HandlerAdapter` 的方法: ``` protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception { ... - // 2\. »ñÈ¡¶ÔÓ¦µÄhandlerAdapter£¬ÓÃÀ´ÔËÐÐ handler(xxx) + // 2\. 获å�–对应的handlerAdapter,用æ�¥è¿�行 handler(xxx) HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler()); ... ``` -½øÈë `getHandlerAdapter(xxx)` ·½·¨£º +进入 `getHandlerAdapter(xxx)` 方法: > DispatcherServlet#getHandlerAdapter ``` protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletException { - // handlerAdapters ÀïµÄbean£¬Ò²ÊÇÓÉWebMvcConfigurationSupportÒýÈëµÄ + // handlerAdapters 里的bean,也是由WebMvcConfigurationSupport引入的 if (this.handlerAdapters != null) { for (HandlerAdapter adapter : this.handlerAdapters) { - // ²»Í¬µÄhandlerAdapterµÄÅжϷ½·¨²»Í¬ + // ä¸�å�Œçš„handlerAdapter的判断方法ä¸�å�Œ if (adapter.supports(handler)) { return adapter; } @@ -735,24 +735,24 @@ protected HandlerAdapter getHandlerAdapter(Object handler) throws ServletExcepti ``` -¿ÉÒÔ¿´µ½£¬ÕâÀï»áÕÒµ½µ±Ç°ËùÓÐµÄ `adapter`£¬È»ºó±éÀú£¬Öð¸öÅжÏÊÇ·ñÄÜ´¦Àíµ±Ç°µÄ `handler`£¬ËùÓÐµÄ `adapter` ÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œä¼šæ‰¾åˆ°å½“å‰�所有的 `adapter`,然å�Žé��历,é€�个判断是å�¦èƒ½å¤„ç�†å½“å‰�çš„ `handler`,所有的 `adapter` 如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-dedb2d58b9e99091aeb559f6c5a4aab4ccc.png) -ÔÙÀ´¿´¿´ÈçºÎÅжÏÊÇ·ñÄÜ´¦Àíµ±Ç°µÄ `handler` µÄ£¬ÎÒÃÇ¿´ÆäÖÐÒ»¸ö `handler`£¬½øÈë `AbstractHandlerMethodAdapter#supports` ·½·¨£º +å†�æ�¥çœ‹çœ‹å¦‚何判断是å�¦èƒ½å¤„ç�†å½“å‰�çš„ `handler` 的,我们看其中一个 `handler`,进入 `AbstractHandlerMethodAdapter#supports` 方法: > AbstractHandlerMethodAdapter#supports ``` @Override public final boolean supports(Object handler) { - // ÅжÏhandlerÊÇ·ñΪHandlerMethodµÄʵÀý + // 判断handler是å�¦ä¸ºHandlerMethod的实例 return (handler instanceof HandlerMethod && supportsInternal((HandlerMethod) handler)); } ``` -ÕâÀï½ö×öÁËÒ»¸ö¼òµ¥µÄÅжϣ¬È»ºóÔÙµ÷Óà `supportsInternal` ·½·¨£¬¼ÌÐø£º +这里仅å�šäº†ä¸€ä¸ªç®€å�•的判断,然å�Žå†�调用 `supportsInternal` 方法,继续: > RequestMappingHandlerAdapter#supportsInternal @@ -763,10 +763,10 @@ protected boolean supportsInternal(HandlerMethod handlerMethod) { ``` -Õâ¸ö·½·¨Ö±½Ó·µ»Ø true, ÓÉÓڿɼû£¬Èç¹û `handler` µÄʵÀýÊÇ `HandlerMethod`£¬ÄÇô¾Í»á·µ»Ø `RequestMappingHandlerAdapter`. +这个方法直接返回 true, 由于å�¯è§�,如果 `handler` 的实例是 `HandlerMethod`,那么就会返回 `RequestMappingHandlerAdapter`. -ÕâÒ»²½ÕÒµ½µÄ `adapter` Ϊ `RequestMappingHandlerAdapter`£¬Õâ¸ö `adapter` ÓÐʲôÓÃÄØ£¿ÏÞÓÚÆª·ù£¬±¾ÎľÍÏȵ½ÕâÀïÁË£¬Ê£ÏµÄÁ÷³ÌÏÂÆªÎÄÕ¼ÌÐø·ÖÎö¡£ +这一步找到的 `adapter` 为 `RequestMappingHandlerAdapter`,这个 `adapter` 有什么用呢?é™�于篇幅,本文就先到这里了,剩下的æµ�程下篇文章继续分æž�。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4717420](https://my.oschina.net/funcy/blog/4717420) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4717420](https://my.oschina.net/funcy/blog/4717420) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\344\271\213\346\211\247\350\241\214Handler\346\226\271\346\263\225.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\344\271\213\346\211\247\350\241\214Handler\346\226\271\346\263\225.md" index daed837..2ca9d1d 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\344\271\213\346\211\247\350\241\214Handler\346\226\271\346\263\225.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringMVC\346\272\220\347\240\201\345\210\206\346\236\220/\350\257\267\346\261\202\346\211\247\350\241\214\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\344\271\213\346\211\247\350\241\214Handler\346\226\271\346\263\225.md" @@ -1,21 +1,21 @@ -±¾ÎÄÊÇ **springmvc ÇëÇóÖ´ÐÐÁ÷³Ì**µÄµÚ¶þƪÎÄÕ£¬ÔÚÉÏһƪÎÄÕÂÖУ¬ÎÒÃÇ·ÖÎöÁË `DispatcherServlet#doDispatch` ·½·¨£¬×ܽá³öÇëÇóÖ´ÐзÖΪÈçϲ½Ö裺 +本文是 **springmvc 请求执行æµ�程**的第二篇文章,在上一篇文章中,我们分æž�了 `DispatcherServlet#doDispatch` 方法,总结出请求执行分为如下步骤: -1. »ñÈ¡¶ÔÓ¦µÄ `HandlerExecutionChain`, »ñÈ¡µÄ `HandlerExecutionChain` Öаüº¬ÕæÕýµØ´¦ÀíÆ÷£¨`Controller` Öеķ½·¨£©ºÍÒ»×é `HandlerInterceptor` À¹½ØÆ÷£» -2. »ñÈ¡¶ÔÓ¦µÄ `handlerAdapter`£¬¸Ã¶ÔÏóÓÃÀ´ÔËÐÐ `handler(xxx)` ·½·¨£» -3. Ö´ÐÐ spring µÄÀ¹½ØÆ÷£¬ÔËÐÐ `HandlerInterceptor#preHandle` ·½·¨£» -4. ´¦ÀíÇëÇó£¬Ò²¾ÍÊÇͨ¹ýÉÏÃæ»ñÈ¡µ½µÄ `handlerAdapter` À´µ÷Óà `handle(xxx)` ·½·¨£» -5. Ö´ÐÐ spring µÄÀ¹½ØÆ÷£¬ÔËÐÐ `HandlerInterceptor#postHandle` ·½·¨£» -6. ´¦Àí·µ»Ø½á¹û£¬ÕâÀï»áäÖȾÊÓͼ£¬ÒÔ¼°Ö´ÐÐ spring À¹½ØÆ÷µÄ `HandlerInterceptor#afterCompletion`¡£ +1. 获å�–对应的 `HandlerExecutionChain`, 获å�–çš„ `HandlerExecutionChain` 中包å�«çœŸæ­£åœ°å¤„ç�†å™¨ï¼ˆ`Controller` 中的方法)和一组 `HandlerInterceptor` 拦截器; +2. 获å�–对应的 `handlerAdapter`,该对象用æ�¥è¿�行 `handler(xxx)` 方法; +3. 执行 spring 的拦截器,è¿�行 `HandlerInterceptor#preHandle` 方法; +4. 处ç�†è¯·æ±‚,也就是通过上é�¢èŽ·å�–到的 `handlerAdapter` æ�¥è°ƒç”¨ `handle(xxx)` 方法; +5. 执行 spring 的拦截器,è¿�行 `HandlerInterceptor#postHandle` 方法; +6. 处ç�†è¿”回结果,这里会渲染视图,以å�Šæ‰§è¡Œ spring 拦截器的 `HandlerInterceptor#afterCompletion`。 -½Ó×Å£¬ÎÒÃǼÌÐø·ÖÎö `HandlerExecutionChain` µÄ»ñÈ¡ÒÔ¼° `handlerAdapter` µÄ»ñÈ¡£¬Êé½ÓÉϻأ¬±¾ÎĽ«¼ÌÐø·ÖÎö½ÓÏÂÀ´µÄ²½Öè¡£ +接ç�€ï¼Œæˆ‘们继续分æž� `HandlerExecutionChain` 的获å�–以å�Š `handlerAdapter` 的获å�–,书接上回,本文将继续分æž�接下æ�¥çš„æ­¥éª¤ã€‚ -### 5\. Ö´ÐÐ spring µÄÀ¹½ØÆ÷£º`HandlerInterceptor#preHandle` +### 5\. 执行 spring 的拦截器:`HandlerInterceptor#preHandle` ``` protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception { ... - // 3\. ÔËÐÐspringµÄÀ¹½ØÆ÷, ÔËÐÐ HandlerInterceptor#preHandle ·½·¨ - // Õâ¸ömappedHandler£¬¾ÍÊǵÚ1²½»ñÈ¡µÄHandlerExecutionChain + // 3\. è¿�行spring的拦截器, è¿�行 HandlerInterceptor#preHandle 方法 + // 这个mappedHandler,就是第1步获å�–çš„HandlerExecutionChain if (!mappedHandler.applyPreHandle(processedRequest, response)) { return; } @@ -24,24 +24,24 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon ``` -ÉÏÃæµÄ `mappedHandler`£¬¾ÍÊÇµÚ 1 ²½»ñÈ¡µÄ `HandlerExecutionChain`£¬½øÈë `HandlerExecutionChain#applyPreHandle`£º +上é�¢çš„ `mappedHandler`,就是第 1 步获å�–çš„ `HandlerExecutionChain`,进入 `HandlerExecutionChain#applyPreHandle`: > HandlerExecutionChain#applyPreHandle ``` /** - * Ö´ÐÐ HandlerInterceptor#preHandle ·½·¨ + * 执行 HandlerInterceptor#preHandle 方法 */ boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception { - // »ñÈ¡ËùÓеÄÀ¹½ØÆ÷ + // 获å�–所有的拦截器 HandlerInterceptor[] interceptors = getInterceptors(); if (!ObjectUtils.isEmpty(interceptors)) { - // ±éÀúÖ´ÐÐ preHandle ·½·¨ + // é��历执行 preHandle 方法 for (int i = 0; i < interceptors.length; i++) { HandlerInterceptor interceptor = interceptors[i]; if (!interceptor.preHandle(request, response, this.handler)) { - // ʧ°ÜÁË£¬»¹»á¼ÌÐøÖ´ÐÐ HandlerInterceptor#afterCompletion ·½·¨ + // 失败了,还会继续执行 HandlerInterceptor#afterCompletion 方法 triggerAfterCompletion(request, response, null); return false; } @@ -52,15 +52,15 @@ boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) } /** - * Ö´ÐÐ HandlerInterceptor#afterCompletion ·½·¨ - * ΪÁ˱£Ö¤HandlerInterceptor#afterCompletionµÄÖ´ÐУ¬ - * ½ÓÏÂÀ´µÄ·ÖÎö»á¿´µ½£¬Õâ¸ö·½·¨»áÔÚ¶à¸ö·½·¨µ÷Óõ½ + * 执行 HandlerInterceptor#afterCompletion 方法 + * 为了ä¿�è¯�HandlerInterceptor#afterCompletion的执行, + * 接下æ�¥çš„分æž�会看到,这个方法会在多个方法调用到 */ void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) throws Exception { HandlerInterceptor[] interceptors = getInterceptors(); if (!ObjectUtils.isEmpty(interceptors)) { - // ±éÀúÖ´ÐÐ HandlerInterceptor#afterCompletion ·½·¨ + // é��历执行 HandlerInterceptor#afterCompletion 方法 for (int i = this.interceptorIndex; i >= 0; i--) { HandlerInterceptor interceptor = interceptors[i]; try { @@ -75,45 +75,45 @@ void triggerAfterCompletion(HttpServletRequest request, ``` -ÎÒÃÇÀ´¿´Ò»ÑÛ `HandlerExecutionChain`£º +我们æ�¥çœ‹ä¸€çœ¼ `HandlerExecutionChain`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-40ba62630b5d83a16ed9aba35aba48af8be.png) -ÔÙÀ´¿´¿´´«Èë `HandlerInterceptor` µÄ `handler` ÊÇɶ£º +å†�æ�¥çœ‹çœ‹ä¼ å…¥ `HandlerInterceptor` çš„ `handler` 是啥: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6c50a936804c1db4a7b817dbb5ff417034d.png) -Õâ¸ö `handler` ¾ÍÊÇ `HandlerMethod`£¬ÀïÃæ°üº¬µÄÐÅÏ¢»¹ÊÇͦ·á¸»µÄ£¬Ïñ `bean`/`beanFactory`/`method`£¬ÀûÓÃÕ⼸¸öÊôÐÔ£¬ÎÒÃÇ¿ÉÒÔ¶ÔÆä½øÐи÷ÖÖ²Ù×÷¡£ +这个 `handler` 就是 `HandlerMethod`,里é�¢åŒ…å�«çš„ä¿¡æ�¯è¿˜æ˜¯æŒºä¸°å¯Œçš„,åƒ� `bean`/`beanFactory`/`method`,利用这几个属性,我们å�¯ä»¥å¯¹å…¶è¿›è¡Œå�„ç§�æ“�作。 -### 6\. ·½·¨µÄÖ´ÐУº`AbstractHandlerMethodAdapter#handle` +### 6\. 方法的执行:`AbstractHandlerMethodAdapter#handle` -ÎÒÃÇÔٻص½ `DispatcherServlet#doDispatch`£¬Ö´ÐÐÍê `HandlerInterceptor#preHandle` ·½·¨ºó£¬¾ÍÀ´µ½ËùÓÐÁ÷³ÌÖеÄÖØÍ·Ï·£º`handler` µÄÖ´ÐУ¬Ò²¾ÍÊÇ `controller` ÖУ¬`url` ¶ÔÓ¦µÄ·½·¨Ö´ÐУº +我们å†�回到 `DispatcherServlet#doDispatch`,执行完 `HandlerInterceptor#preHandle` 方法å�Žï¼Œå°±æ�¥åˆ°æ‰€æœ‰æµ�程中的é‡�头æˆ�:`handler` 的执行,也就是 `controller` 中,`url` 对应的方法执行: ``` protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception { ... - // 4\. ͨ¹ýÉÏÃæ»ñÈ¡µ½µÄhandlerAdapterÀ´µ÷ÓÃhandle + // 4\. 通过上é�¢èŽ·å�–到的handlerAdapteræ�¥è°ƒç”¨handle mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); ... } ``` -һ·¸ú½øÈ¥£¬×îÖÕÀ´µ½ÁË `RequestMappingHandlerAdapter#invokeHandlerMethod` ·½·¨£º +一路跟进去,最终æ�¥åˆ°äº† `RequestMappingHandlerAdapter#invokeHandlerMethod` 方法: ``` protected ModelAndView invokeHandlerMethod(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception { - // °ü×°requesÓërequest¶ÔÏó + // 包装reques与request对象 ServletWebRequest webRequest = new ServletWebRequest(request, response); try { - // »ñÈ¡ @InitBinder ×¢½âµÄ·½·¨£¬ - // °üº¬µ±Ç°controllerÓë @ControllerAdvice ±ê×¢µÄÀàÀïµÄ @InitBinder ×¢½âµÄ·½·¨ + // 获å�– @InitBinder 注解的方法, + // 包å�«å½“å‰�controller与 @ControllerAdvice 标注的类里的 @InitBinder 注解的方法 WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod); - // »ñÈ¡ @ModelAttribute ×¢½âµÄ·½·¨£¬ - // °üº¬µ±Ç°controllerÓë @ControllerAdvice ±ê×¢µÄÀàÀïµÄ @ModelAttribute ×¢½âµÄ·½·¨ + // 获å�– @ModelAttribute 注解的方法, + // 包å�«å½“å‰�controller与 @ControllerAdvice 标注的类里的 @ModelAttribute 注解的方法 ModelFactory modelFactory = getModelFactory(handlerMethod, binderFactory); - // ´´½¨·½·¨Ö´ÐжÔÏó + // 创建方法执行对象 ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod); if (this.argumentResolvers != null) { invocableMethod.setHandlerMethodArgumentResolvers(this.argumentResolvers); @@ -123,12 +123,12 @@ protected ModelAndView invokeHandlerMethod(HttpServletRequest request, } invocableMethod.setDataBinderFactory(binderFactory); invocableMethod.setParameterNameDiscoverer(this.parameterNameDiscoverer); - // ´´½¨ModelAndViewµÄÈÝÆ÷ + // 创建ModelAndView的容器 ModelAndViewContainer mavContainer = new ModelAndViewContainer(); mavContainer.addAllAttributes(RequestContextUtils.getInputFlashMap(request)); modelFactory.initModel(webRequest, mavContainer, invocableMethod); mavContainer.setIgnoreDefaultModelOnRedirect(this.ignoreDefaultModelOnRedirect); - // ´¦ÀíÒì²½ÇëÇó + // 处ç�†å¼‚步请求 AsyncWebRequest asyncWebRequest = WebAsyncUtils.createAsyncWebRequest(request, response); asyncWebRequest.setTimeout(this.asyncRequestTimeout); WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request); @@ -146,12 +146,12 @@ protected ModelAndView invokeHandlerMethod(HttpServletRequest request, }); invocableMethod = invocableMethod.wrapConcurrentResult(result); } - // Ö´ÐÐControllerµÄ·½·¨£¨Öص㣩 + // 执行Controller的方法(é‡�点) invocableMethod.invokeAndHandle(webRequest, mavContainer); if (asyncManager.isConcurrentHandlingStarted()) { return null; } - // ´¦Àí·µ»Ø½á¹û + // 处ç�†è¿”回结果 return getModelAndView(mavContainer, modelFactory, webRequest); } finally { @@ -161,16 +161,16 @@ protected ModelAndView invokeHandlerMethod(HttpServletRequest request, ``` -Õâ¸ö·½·¨Óе㳤£¬µ«Öص㷽·¨Ö»ÓÐÒ»ÐУº`invocableMethod.invokeAndHandle(webRequest, mavContainer);`£¬ÔÚÕâ¸ö·½·¨Ç°µÄ²¿·Ö¶¼ÊÇÔÚ×ö·½·¨Ö´ÐÐǰµÄ×¼±¸¹¤×÷£¬Èç»ñÈ¡ `@InitBinder` ×¢½âµÄ·½·¨¡¢»ñÈ¡ `@ModelAttribute` ×¢½âµÄ·½·¨£¬×¼±¸·½·¨²ÎÊý `webRequest`(°ü×° `request` Óë `response` ¶ÔÏó) Óë `mavContainer`(`ModelAndView` °ü×°¶ÔÏó) µÈ¡£ÕâÀïÎÒÃÇÖ±½Ó½øÈë `invocableMethod.invokeAndHandle`£¬¿´¿´·½·¨ÊÇÈçºÎÖ´Ðеģº +这个方法有点长,但é‡�点方法å�ªæœ‰ä¸€è¡Œï¼š`invocableMethod.invokeAndHandle(webRequest, mavContainer);`,在这个方法å‰�的部分都是在å�šæ–¹æ³•æ‰§è¡Œå‰�的准备工作,如获å�– `@InitBinder` 注解的方法ã€�获å�– `@ModelAttribute` 注解的方法,准备方法å�‚æ•° `webRequest`(包装 `request` 与 `response` 对象) 与 `mavContainer`(`ModelAndView` 包装对象) 等。这里我们直接进入 `invocableMethod.invokeAndHandle`,看看方法是如何执行的: > ServletInvocableHandlerMethod#invokeAndHandle ``` public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception { - // Ö´ÐÐhandler·½·¨ + // 执行handler方法 Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs); - // ÉèÖà RequestHandled ÊôÐÔÖµ£¬springmvc»á¸ù¾Ý¸ÃÖµÅжÏÒª²»ÒªÌø×ª + // 设置 RequestHandled 属性值,springmvc会根æ�®è¯¥å€¼åˆ¤æ–­è¦�ä¸�è¦�跳转 if (returnValue == null) { if (isRequestNotModified(webRequest) || getResponseStatus() != null || mavContainer.isRequestHandled()) { @@ -186,7 +186,7 @@ public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer.setRequestHandled(false); Assert.state(this.returnValueHandlers != null, "No return value handlers"); try { - // ´¦Àí·µ»Ø½á¹û + // 处ç�†è¿”回结果 this.returnValueHandlers.handleReturnValue( returnValue, getReturnValueType(returnValue), mavContainer, webRequest); } @@ -197,7 +197,7 @@ public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer ``` -ÕâÀï·½·¨ÏÈÊǵ÷ÓÃÁË `invokeForRequest` Ö´Ðз½·¨£¬È»ºóÔÙ¸ù¾Ý·½·¨µÄ·µ»ØÖµÀ´ÉèÖà `mavContainer` µÄ `RequestHandled` Öµ£¬×îºó´¦Àí·µ»Ø½á¹û¡£¼ÌÐø¸ú½ø `invokeForRequest` ·½·¨£º +这里方法先是调用了 `invokeForRequest` 执行方法,然å�Žå†�æ ¹æ�®æ–¹æ³•的返回值æ�¥è®¾ç½® `mavContainer` çš„ `RequestHandled` 值,最å�Žå¤„ç�†è¿”回结果。继续跟进 `invokeForRequest` 方法: > InvocableHandlerMethod#invokeForRequest @@ -205,38 +205,38 @@ public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer @Nullable public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainermavContainer, Object... providedArgs) throws Exception { - // ´¦Àí²ÎÊý°ó¶¨ + // 处ç�†å�‚数绑定 Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs); - // ·´Éäµ÷Ó÷½·¨ + // å��射调用方法 return doInvoke(args); } ``` -Õâ¸ö·½·¨ÀïÏÈÊÇ´¦ÀíÁ˲ÎÊý½âÎö£¬È»ºóʹÓ÷´Éä½øÐз½·¨µ÷Óá£ÊÂʵÉÏ£¬Õû¸öÖ´ÐÐÁ÷³ÌÖУ¬×îºËÐĵľÍÊDzÎÊý½âÎöÁË£¬ÔÚ controller ÀïµÄ handler ·½·¨ÖУ¬ÎÒÃÇ¿ÉÒÔÕâÑùÖ¸¶¨²ÎÊý£º +这个方法里先是处ç�†äº†å�‚æ•°è§£æž�,然å�Žä½¿ç”¨å��射进行方法调用。事实上,整个执行æµ�程中,最核心的就是å�‚æ•°è§£æž�了,在 controller 里的 handler 方法中,我们å�¯ä»¥è¿™æ ·æŒ‡å®šå�‚数: ``` -// Ö±½Ó´«²Î +// 直接传å�‚ @RequestMapping("xxx") public Object test(String name) { ... } -// ÔÚ²ÎÊýÉϱêÓÐ@RequestParam¡¢@RequestHeaderµÈ×¢½â +// 在å�‚数上标有@RequestParamã€�@RequestHeader等注解 @RequestMapping("xxx") public Object test(@RequestParam("name") String name, @RequestHeader("uid") String uid) { ... } -// ½«´«ÈëµÄ²ÎÊý·âװΪ¶ÔÏó +// 将传入的å�‚æ•°å°�装为对象 @RequestMapping("xxx") public Object test(User user) { ... } -// ÉÏÃæµÄ·½·¨¶¼ÊÇʹÓÃform±íµ¥´«²Î(Ò²¾ÍÊÇk1=v1&2=v2&...µÄ·½·¨) -// Õâ¸ö·½·¨Ê¹Óà RequestBody ·½Ê½´«²Î£¬½«²ÎÊýÄÚÈÝ·ÅÈëÏûÏ¢ÌåÖÐ +// 上é�¢çš„æ–¹æ³•都是使用form表å�•ä¼ å�‚(也就是k1=v1&2=v2&...的方法) +// 这个方法使用 RequestBody æ–¹å¼�ä¼ å�‚,将å�‚数内容放入消æ�¯ä½“中 @RequestMapping("xxx") public Object test(@RequestBody User user) { ... @@ -246,24 +246,24 @@ public Object test(@RequestBody User user) { ``` -µ±ÎÒÃǰ´¹æ·¶´«Èë²ÎÊýʱ£¬springmvc ¶¼ÄÜÕý³£´¦Àí£¬ÎÒÃÇÀ´¿´¿´ springmvc ÊÇÈçºÎ×öµ½ÕâÒ»µãµÄ¡£ +当我们按规范传入å�‚数时,springmvc 都能正常处ç�†ï¼Œæˆ‘们æ�¥çœ‹çœ‹ springmvc 是如何å�šåˆ°è¿™ä¸€ç‚¹çš„。 -#### ²ÎÊý½âÎö +#### å�‚æ•°è§£æž� -¼ÌÐø£¬½øÈë `InvocableHandlerMethod#getMethodArgumentValues` ·½·¨£º +继续,进入 `InvocableHandlerMethod#getMethodArgumentValues` 方法: > InvocableHandlerMethod#getMethodArgumentValues ``` protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception { - // »ñÈ¡·½·¨µÄËùÓвÎÊý£¬¿ÉÒÔ¼òµ¥Àí½âΪÀûÓ÷´Éä»ñÈ¡handler·½·¨²ÎÊý£¬È»ºó°üװΪ MethodParameter + // 获å�–方法的所有å�‚数,å�¯ä»¥ç®€å�•ç�†è§£ä¸ºåˆ©ç”¨å��射获å�–handler方法å�‚数,然å�ŽåŒ…装为 MethodParameter MethodParameter[] parameters = getMethodParameters(); if (ObjectUtils.isEmpty(parameters)) { return EMPTY_ARGS; } Object[] args = new Object[parameters.length]; - // ÒÀ´Î´¦Àíÿ¸ö²ÎÊý + // ä¾�次处ç�†æ¯�个å�‚æ•° for (int i = 0; i < parameters.length; i++) { MethodParameter parameter = parameters[i]; parameter.initParameterNameDiscovery(this.parameterNameDiscoverer); @@ -271,12 +271,12 @@ protected Object[] getMethodArgumentValues(NativeWebRequest request, if (args[i] != null) { continue; } - // ÅжÏÊÇ·ñÓвÎÊý½âÎöÀàÖ§³Öµ±Ç°²ÎÊýµÄ½âÎö + // 判断是å�¦æœ‰å�‚æ•°è§£æž�类支æŒ�当å‰�å�‚数的解æž� if (!this.resolvers.supportsParameter(parameter)) { throw new IllegalStateException(formatArgumentError(parameter, "No suitable resolver")); } try { - // ´¦Àí²ÎÊý½âÎö + // 处ç�†å�‚æ•°è§£æž� args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory); } @@ -289,7 +289,7 @@ protected Object[] getMethodArgumentValues(NativeWebRequest request, ``` -Õâ¸ö·½·¨ÏÈ»ñÈ¡ÁË handler ·½·¨µÄ²ÎÊý (¿ÉÒÔ¼òµ¥Àí½âΪÀûÓ÷´Éä»ñÈ¡ handler ·½·¨²ÎÊý£¬È»ºó°üװΪ `MethodParameter`)£¬È»ºó¶ÔÕâЩ²ÎÊýÖð¸ö½âÎö¡£½âÎöʱ£¬»áÓõ½Á½¸öÖØÒªµÄ·½·¨£º`resolvers.supportsParameter(...)` Óë `resolvers.resolveArgument(...)`£¬ÕâÁ½¸ö·½·¨×îÖÕµ÷Óõķ½·¨ÔÚ `HandlerMethodArgumentResolverComposite` ÖУº +这个方法先获å�–了 handler 方法的å�‚æ•° (å�¯ä»¥ç®€å�•ç�†è§£ä¸ºåˆ©ç”¨å��射获å�– handler 方法å�‚数,然å�ŽåŒ…装为 `MethodParameter`),然å�Žå¯¹è¿™äº›å�‚æ•°é€�个解æž�。解æž�时,会用到两个é‡�è¦�的方法:`resolvers.supportsParameter(...)` 与 `resolvers.resolveArgument(...)`,这两个方法最终调用的方法在 `HandlerMethodArgumentResolverComposite` 中: > HandlerMethodArgumentResolverComposite @@ -297,22 +297,22 @@ protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainermavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception { - // »ñȡһ¸ö½âÎöÆ÷ + // 获å�–一个解æž�器 HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter); if (resolver == null) { throw new IllegalArgumentException(...); } - // ½âÎö²ÎÊý£¬µ÷Óà HandlerMethodArgumentResolver#resolveArgument ·½·¨ + // è§£æž�å�‚数,调用 HandlerMethodArgumentResolver#resolveArgument 方法 return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory); } private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parameter) { HandlerMethodArgumentResolver result = this.argumentResolverCache.get(parameter); if (result == null) { - // ±éÀúËùÓеĽâÎöÆ÷ + // é��历所有的解æž�器 for (HandlerMethodArgumentResolver resolver : this.argumentResolvers) { - // ÕÒµ½ÆäÖÐÒ»¸ö½âÎöÆ÷£¬·µ»Ø - // µ÷Óà HandlerMethodArgumentResolver#supportsParameter ·½·¨ + // 找到其中一个解æž�器,返回 + // 调用 HandlerMethodArgumentResolver#supportsParameter 方法 if (resolver.supportsParameter(parameter)) { result = resolver; this.argumentResolverCache.put(parameter, result); @@ -325,17 +325,17 @@ private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parame ``` -ÕâÁ½¸ö·½·¨Ö÷ÒªÊDZéÀú½âÎöÆ÷£¬È»ºóµ÷Óà `HandlerMethodArgumentResolver#supportsParameter` Óë `HandlerMethodArgumentResolver#resolveArgument` ´¦Àí¾ßÌåµÄ²Ù×÷¡£`HandlerMethodArgumentResolver` ÊǸö½Ó¿Ú£¬ÀïÃæ½öÓÐÁ½¸ö·½·¨£º +这两个方法主è¦�是é��历解æž�器,然å�Žè°ƒç”¨ `HandlerMethodArgumentResolver#supportsParameter` 与 `HandlerMethodArgumentResolver#resolveArgument` 处ç�†å…·ä½“çš„æ“�作。`HandlerMethodArgumentResolver` 是个接å�£ï¼Œé‡Œé�¢ä»…有两个方法: ``` public interface HandlerMethodArgumentResolver { /** - * µ±Ç°ÊÇ·ñÖ§³Ö´¦Àíµ±Ç°²ÎÊý + * 当å‰�是å�¦æ”¯æŒ�处ç�†å½“å‰�å�‚æ•° */ boolean supportsParameter(MethodParameter parameter); /** - * ¾ßÌåµÄ½âÎö²Ù×÷ + * 具体的解æž�æ“�作 */ @Nullable Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, @@ -344,15 +344,15 @@ public interface HandlerMethodArgumentResolver { ``` -Õâ¸ö¾ÍÊÇÕæÕýµÄ²ÎÊý½âÎöÆ÷ÁË¡£ÔÚ springmvc ÖУ¬ÌṩÁ˶àÉÙÖÖ²ÎÊý½âÎöÆ÷ÄØ£¿¾­¹ý±¾È˵ĵ÷ÊÔ£¬·¢ÏÖ¶à´ï 26 ¸ö£º +这个就是真正的å�‚æ•°è§£æž�器了。在 springmvc 中,æ��供了多少ç§�å�‚æ•°è§£æž�器呢?ç»�过本人的调试,å�‘现多达 26 个: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fd30bc847fc2cf7082de3731e68df6ae5f9.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-894b391bbe4567734ee7237d900bc55ee31.png) -ÕýÊÇÔÚÕâЩ²ÎÊý½âÎöÆ÷µÄ°ïÖúÏ£¬springmvc ÄÜÖ§³Ö¶àÖÖ²ÎÊý½ÓÊÕ·½Ê½£¡¶ÔÓÚ²ÎÊý½âÎöÆ÷£¬ÓÉÓÚÉè¼Æ±È½Ï¸´ÔÓ£¬Éæ¼°¶àÖÖ´«²Î·½Ê½£¬±¾ÎIJ¢²»ÏëÕ¹¿ªÌÖÂÛ£¬¸ÐÐËȤµÄС»ï°é¿É×ÔÐвéÔÄÏà¹ØÎĵµ¡£ +正是在这些å�‚æ•°è§£æž�器的帮助下,springmvc 能支æŒ�多ç§�å�‚数接收方å¼�ï¼�对于å�‚æ•°è§£æž�器,由于设计比较å¤�æ�‚,涉å�Šå¤šç§�ä¼ å�‚æ–¹å¼�,本文并ä¸�想展开讨论,感兴趣的å°�伙伴å�¯è‡ªè¡ŒæŸ¥é˜…相关文档。 -#### Ö´ÐÐ handler ·½·¨ +#### 执行 handler 方法 -´¦ÀíÍê²ÎÊý½âÎöºó£¬¾Í¿ªÊ¼Ö´ÐÐ handler ·½·¨ÁË¡£ÈÃÎÒÃǻص½ `InvocableHandlerMethod#invokeForRequest` ·½·¨£º +处ç�†å®Œå�‚æ•°è§£æž�å�Žï¼Œå°±å¼€å§‹æ‰§è¡Œ handler 方法了。让我们回到 `InvocableHandlerMethod#invokeForRequest` 方法: > InvocableHandlerMethod#invokeForRequest @@ -360,23 +360,23 @@ public interface HandlerMethodArgumentResolver { @Nullable public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainermavContainer, Object... providedArgs) throws Exception { - // ´¦Àí²ÎÊý°ó¶¨ + // 处ç�†å�‚数绑定 Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs); - // ·´Éäµ÷Ó÷½·¨ + // å��射调用方法 return doInvoke(args); } ``` -½øÈë `doInvoke` ·½·¨£º +进入 `doInvoke` 方法: ``` @Nullable protected Object doInvoke(Object... args) throws Exception { - // ʹÓ÷´ÉäÖ´Ðз½·¨ + // 使用å��射执行方法 ReflectionUtils.makeAccessible(getBridgedMethod()); try { - // ÕâÀï¾ÍÊÇ·´Éä²Ù×÷ + // 这里就是å��å°„æ“�作 return getBridgedMethod().invoke(getBean(), args); } catch (...) { @@ -386,22 +386,22 @@ protected Object doInvoke(Object... args) throws Exception { ``` -Õâ¸ö·½·¨ºÜ¼òµ¥£¬¾ÍÊÇÀûÓ÷´ÉäÀ´½øÐз½·¨Ö´Ðеģ¬¾Í²»¹ý¶à·ÖÎöÁË¡£ +这个方法很简å�•,就是利用å��å°„æ�¥è¿›è¡Œæ–¹æ³•执行的,就ä¸�过多分æž�了。 -#### ´¦Àí·µ»Ø²ÎÊý +#### 处ç�†è¿”回å�‚æ•° -ÈÃÎÒÃǻص½ `ServletInvocableHandlerMethod#invokeAndHandle` ·½·¨£º +让我们回到 `ServletInvocableHandlerMethod#invokeAndHandle` 方法: > ServletInvocableHandlerMethod#invokeAndHandle ``` public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception { - // Ö´ÐÐhandle·½·¨ + // 执行handle方法 Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs); ... try { - // ´¦Àí·µ»Ø½á¹û + // 处ç�†è¿”回结果 this.returnValueHandlers.handleReturnValue( returnValue, getReturnValueType(returnValue), mavContainer, webRequest); } @@ -412,7 +412,7 @@ public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer ``` -´¦ÀíÍê·½·¨Ö´Ðк󣬽Óמʹ¦Àí·µ»Ø½á¹û£º +处ç�†å®Œæ–¹æ³•执行å�Žï¼ŒæŽ¥ç�€å°±å¤„ç�†è¿”回结果: > HandlerMethodReturnValueHandlerComposite#handleReturnValue @@ -420,7 +420,7 @@ public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer @Override public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception { - // ¸ù¾Ý·µ»ØÀàÐÍÕÒÒ»¸öºÏÊʵÄhandlerÀ´´¦Àí·µ»ØÊý¾Ý + // æ ¹æ�®è¿”回类型找一个å�ˆé€‚çš„handleræ�¥å¤„ç�†è¿”回数æ�® HandlerMethodReturnValueHandler handler = selectHandler(returnValue, returnType); if (handler == null) { throw new IllegalArgumentException(...); @@ -431,7 +431,7 @@ public void handleReturnValue(@Nullable Object returnValue, MethodParameter retu @Nullable private HandlerMethodReturnValueHandler selectHandler(@Nullable Object value, MethodParameterreturnType) { boolean isAsyncValue = isAsyncReturnValue(value, returnType); - // ±éÀú£¬Öð¸öÅжÏÊÇ·ñÄÜ´¦Àíµ±Ç°·µ»ØÀàÐÍ + // é��历,é€�个判断是å�¦èƒ½å¤„ç�†å½“å‰�返回类型 for (HandlerMethodReturnValueHandler handler : this.returnValueHandlers) { if (isAsyncValue && !(handler instanceof AsyncHandlerMethodReturnValueHandler)) { continue; @@ -445,18 +445,18 @@ private HandlerMethodReturnValueHandler selectHandler(@Nullable Object value, Me ``` -»ñÈ¡ `ReturnValueHandler` µÄÌ×·ÓëÇ°Ãæ»ñÈ¡ `ArgumentResolver` µÄÌ×·Ïà¹ØÎÞ¼¸£¬`ReturnValueHandler` ÊÇ `HandlerMethodReturnValueHandler` µÄ×ÓÀ࣬`HandlerMethodReturnValueHandler` ´úÂëÈçÏ£º +获å�– `ReturnValueHandler` 的套路与å‰�é�¢èŽ·å�– `ArgumentResolver` 的套路相关无几,`ReturnValueHandler` 是 `HandlerMethodReturnValueHandler` çš„å­�类,`HandlerMethodReturnValueHandler` 代ç �如下: ``` public interface HandlerMethodReturnValueHandler { /** - * Åжϵ±Ç°ReturnValueHandlerÄÜ·ñ´¦Àí´«ÈëµÄreturnType + * 判断当å‰�ReturnValueHandler能å�¦å¤„ç�†ä¼ å…¥çš„returnType */ boolean supportsReturnType(MethodParameter returnType); /** - * ¾ßÌåµÄ´¦ÀíÂß¼­ + * 具体的处ç�†é€»è¾‘ */ void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception; @@ -465,18 +465,18 @@ public interface HandlerMethodReturnValueHandler { ``` -Í¬Ç°Ãæ²ÎÊý½âÎöÆ÷Ò»Ñù£¬Õâ¸ö½Ó¿ÚÀïÒ²ÓÐÁ½¸ö·½·¨£º +å�Œå‰�é�¢å�‚æ•°è§£æž�器一样,这个接å�£é‡Œä¹Ÿæœ‰ä¸¤ä¸ªæ–¹æ³•: -* `boolean supportsReturnType(xxx)`£ºÅжϵ±Ç° `ReturnValueHandler` ÄÜ·ñ´¦Àí´«ÈëµÄ `returnType` -* `void handleReturnValue(xxx)`£º¾ßÌåµÄ´¦ÀíÂß¼­ +* `boolean supportsReturnType(xxx)`:判断当å‰� `ReturnValueHandler` 能å�¦å¤„ç�†ä¼ å…¥çš„ `returnType` +* `void handleReturnValue(xxx)`:具体的处ç�†é€»è¾‘ -ͬÑùµØ£¬springmvc Ò²ÌṩÁ˷dz£¶àµÄʵÏÖÀ´´¦Àí·µ»Ø²ÎÊý£º +å�Œæ ·åœ°ï¼Œspringmvc 也æ��供了é�žå¸¸å¤šçš„实现æ�¥å¤„ç�†è¿”回å�‚数: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8e3c1fd4dca7c13efbceac5800e26145963.png) -¶ÔÓÚ²ÎÊýµÄ·µ»Ø£¬ÎÒÃÇÀ´¿´Ò»¸ö¼òµ¥µÄʾÀý£º +对于å�‚数的返回,我们æ�¥çœ‹ä¸€ä¸ªç®€å�•的示例: -Èç¹ûÎÒÃÇÏñÕâÑù·µ»ØÖµÊ±£º +如果我们åƒ�这样返回值时: ``` @Controller @@ -491,7 +491,7 @@ public class XxxController { ``` -·µ»Øµ½Ò³ÃæµÄ½«ÊÇÒ»¸öÊÓͼ£¬¶ÔÓ¦µÄ `HandlerMethodReturnValueHandler` Ϊ `ViewNameMethodReturnValueHandler`£º +返回到页é�¢çš„将是一个视图,对应的 `HandlerMethodReturnValueHandler` 为 `ViewNameMethodReturnValueHandler`: ``` public class ViewNameMethodReturnValueHandler implements HandlerMethodReturnValueHandler { @@ -499,29 +499,29 @@ public class ViewNameMethodReturnValueHandler implements HandlerMethodReturnValu @Nullable private String[] redirectPatterns; - // Ê¡ÂÔ redirectPatterns µÄsetterÓëgetter·½·¨ + // çœ�ç•¥ redirectPatterns çš„setter与getter方法 ... @Override public boolean supportsReturnType(MethodParameter returnType) { Class paramType = returnType.getParameterType(); - // Ö§³Ö´¦ÀíµÄ·µ»ØÖµÀàÐÍ£º·µ»ØÖµÀàÐÍΪvoid£¬»òÕßΪ×Ö·û´®ÀàÐÍ + // 支æŒ�处ç�†çš„返回值类型:返回值类型为void,或者为字符串类型 return (void.class == paramType || CharSequence.class.isAssignableFrom(paramType)); } /** - * ¾ßÌåµÄ´¦ÀíÂß¼­ + * 具体的处ç�†é€»è¾‘ */ @Override public void handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception { if (returnValue instanceof CharSequence) { - // viewName ¾ÍÊÇ·µ»ØÖµ + // viewName 就是返回值 String viewName = returnValue.toString(); mavContainer.setViewName(viewName); if (isRedirectViewName(viewName)) { - // ÊÇ·ñÐèÒªÌø×ª + // 是å�¦éœ€è¦�跳转 mavContainer.setRedirectModelScenario(true); } } @@ -531,12 +531,12 @@ public class ViewNameMethodReturnValueHandler implements HandlerMethodReturnValu } /** - * ÅжÏÊÇ·ñÐèÒªÌø×ª + * 判断是å�¦éœ€è¦�跳转 */ protected boolean isRedirectViewName(String viewName) { - // this.redirectPatterns ĬÈÏΪnull£¬¿ÉÒÔ×ÔÐе÷Óà setter ·½·¨ÉèÖà + // this.redirectPatterns 默认为null,å�¯ä»¥è‡ªè¡Œè°ƒç”¨ setter 方法设置 return (PatternMatchUtils.simpleMatch(this.redirectPatterns, viewName) - // Æ¥Åä redirect: ¿ªÍ·£¬Ò²¾ÍÊÇ˵£¬Èç¹ûÎÒÃÇ·µ»Ø "redirect:index"£¬¾Í±íÃ÷¸Ã½á¹ûÐèÒªÌø×ª + // 匹é…� redirect: 开头,也就是说,如果我们返回 "redirect:index",就表明该结果需è¦�跳转 || viewName.startsWith("redirect:")); } @@ -544,11 +544,11 @@ public class ViewNameMethodReturnValueHandler implements HandlerMethodReturnValu ``` -Õâ¸öÀà±È½Ï¼òµ¥£¬¹Ø¼ü²¿·ÖÒÑÔÚ´úÂëÖÐ×÷ÁË×¢ÊÍ£¬ÕâÀï¾Í²»¶à˵ÁË¡£ÖµµÃÒ»ÌáµÄÊÇ£¬ÔÚ `handleReturnValue(xxx)` ·½·¨ÖУ¬springmvc ½«·µ»ØµÄ×Ö·û´®ÉèÖÃΪ `viewName` ÐèҪעÒâÏ£¬ºóÃæÔÚ´¦ÀíÊÓͼʱ£¬»áÀûÓÃÕâ¸ö `viewName` Äõ½¶ÔÓ¦µÄ `View`¡£ +这个类比较简å�•,关键部分已在代ç �中作了注释,这里就ä¸�多说了。值得一æ��的是,在 `handleReturnValue(xxx)` 方法中,springmvc 将返回的字符串设置为 `viewName` 需è¦�注æ„�下,å�Žé�¢åœ¨å¤„ç�†è§†å›¾æ—¶ï¼Œä¼šåˆ©ç”¨è¿™ä¸ª `viewName` 拿到对应的 `View`。 -#### »ñÈ¡ ModelAndView +#### 获å�– ModelAndView -ÈÃÎÒÃǻص½ `RequestMappingHandlerAdapter#invokeHandlerMethod` ·½·¨£º +让我们回到 `RequestMappingHandlerAdapter#invokeHandlerMethod` 方法: ``` @Nullable @@ -557,12 +557,12 @@ protected ModelAndView invokeHandlerMethod(HttpServletRequest request, ServletWebRequest webRequest = new ServletWebRequest(request, response); try { ... - // Ö´ÐÐControllerµÄ·½·¨ + // 执行Controller的方法 invocableMethod.invokeAndHandle(webRequest, mavContainer); if (asyncManager.isConcurrentHandlingStarted()) { return null; } - // ´¦ÀíÖ´Ðнá¹û£¬´ÓÖÐÄõ½ ModelAndView + // 处ç�†æ‰§è¡Œç»“果,从中拿到 ModelAndView return getModelAndView(mavContainer, modelFactory, webRequest); } finally { @@ -572,24 +572,24 @@ protected ModelAndView invokeHandlerMethod(HttpServletRequest request, ``` -Ö´ÐÐÍê `invocableMethod.invokeAndHandle(webRequest, mavContainer)` ·½·¨ºó½ÓמÍÊÇ´ÓÖ´Ðнá¹ûÖÐÄõ½ `ModelAndView` ÁË£¬½øÈë `RequestMappingHandlerAdapter#getModelAndView` ·½·¨£º +执行完 `invocableMethod.invokeAndHandle(webRequest, mavContainer)` 方法å�޿ޥç�€å°±æ˜¯ä»Žæ‰§è¡Œç»“果中拿到 `ModelAndView` 了,进入 `RequestMappingHandlerAdapter#getModelAndView` 方法: ``` private ModelAndView getModelAndView(ModelAndViewContainer mavContainer, ModelFactory modelFactory, NativeWebRequest webRequest) throws Exception { - // Õâ¸ö ModelFactory£¬¾ÍÊÇÇ°Ãæ»ñÈ¡µÄ °üº¬@ModelAttribute ×¢½âµÄ·½·¨ + // 这个 ModelFactory,就是å‰�é�¢èŽ·å�–çš„ 包å�«@ModelAttribute 注解的方法 modelFactory.updateModel(webRequest, mavContainer); if (mavContainer.isRequestHandled()) { return null; } ModelMap model = mavContainer.getModel(); - // ´´½¨ÊÓͼ¶ÔÏ󣬰ÑmavContainer.getViewName()´«Èëµ½ModelAndViewµÄ¹¹Ôì·½·¨ÖÐ + // 创建视图对象,把mavContainer.getViewName()传入到ModelAndView的构造方法中 ModelAndView mav = new ModelAndView(mavContainer.getViewName(), model, mavContainer.getStatus()); if (!mavContainer.isViewReference()) { mav.setView((View) mavContainer.getView()); } - // ´¦ÀíÖØ¶¨Ïò²ÎÊý + // 处ç�†é‡�定å�‘å�‚æ•° if (model instanceof RedirectAttributes) { Map flashAttributes = ((RedirectAttributes) model).getFlashAttributes(); HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class); @@ -602,13 +602,13 @@ private ModelAndView getModelAndView(ModelAndViewContainer mavContainer, ``` -¿ÉÒÔ¿´µ½£¬`ModelAndView` ¾ÍÊÇ´ÓÇ°ÃæÖ´Ðнá¹ûµÄ `viewName` µÃµ½µÄ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`ModelAndView` 就是从å‰�é�¢æ‰§è¡Œç»“果的 `viewName` 得到的。 -ÖÁ´Ë£¬`AbstractHandlerMethodAdapter#handle` Ö´ÐÐÍê±Ï¡£ +至此,`AbstractHandlerMethodAdapter#handle` 执行完毕。 -### 7\. Ö´ÐÐÀ¹½ØÆ÷£º`HandlerInterceptor#postHandle` +### 7\. 执行拦截器:`HandlerInterceptor#postHandle` -ÈÃÎÒÃÇÔٻص½ `DispatcherServlet#doDispatch` ·½·¨£º +让我们å†�回到 `DispatcherServlet#doDispatch` 方法: > DispatcherServlet#doDispatch @@ -620,17 +620,17 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon ... try { ... - // 4.ͨ¹ýÉÏÃæ»ñÈ¡µ½µÄhandlerAdapterÀ´µ÷ÓÃhandle + // 4.通过上é�¢èŽ·å�–到的handlerAdapteræ�¥è°ƒç”¨handle mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); - // 5.Èç¹ûº¯Êýµ÷ÓÃûÓзµ»ØÊÓͼÔòʹÓÃĬÈ쵀 + // 5.如果函数调用没有返回视图则使用默认的 applyDefaultViewName(processedRequest, mv); - // 6\. Ö´ÐÐÀ¹½ØÆ÷£¬ÔËÐÐ HandlerInterceptor#postHandle ·½·¨ + // 6\. 执行拦截器,è¿�行 HandlerInterceptor#postHandle 方法 mappedHandler.applyPostHandle(processedRequest, response, mv); } catch (...) { ... } - // 7\. ´¦Àí·µ»Ø½á¹û£¬ÔÚÕâ¸ö·½·¨Àï»áÖ´ÐÐ HandlerInterceptor.afterCompletion + // 7\. 处ç�†è¿”回结果,在这个方法里会执行 HandlerInterceptor.afterCompletion processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException); } catch (...) { @@ -640,7 +640,7 @@ protected void doDispatch(HttpServletRequest request, HttpServletResponse respon ``` -Ö´ÐÐÍê `handler` ·½·¨ºó£¬¾Í¿ªÊ¼Ö´ÐÐÀ¹½ØÆ÷µÄ `HandlerInterceptor#postHandle` ·½·¨ÁË£º +执行完 `handler` 方法å�Žï¼Œå°±å¼€å§‹æ‰§è¡Œæ‹¦æˆªå™¨çš„ `HandlerInterceptor#postHandle` 方法了: > HandlerExecutionChain#applyPostHandle @@ -649,7 +649,7 @@ void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @NullableModelAndView mv) throws Exception { HandlerInterceptor[] interceptors = getInterceptors(); if (!ObjectUtils.isEmpty(interceptors)) { - // ±éÀúÖ´ÐÐ postHandle(...) ·½·¨ + // é��历执行 postHandle(...) 方法 for (int i = interceptors.length - 1; i >= 0; i--) { HandlerInterceptor interceptor = interceptors[i]; interceptor.postHandle(request, response, this.handler, mv); @@ -659,10 +659,10 @@ void applyPostHandle(HttpServletRequest request, HttpServletResponse response, ``` -Õâ¸öÍ¬Ç°ÃæÖ´ÐÐÀ¹½ØÆ÷·½·¨ÀàËÆ£¬ÕâÀï¾Í²»¹ý¶à·ÖÎöÁË¡£ÐèҪǿµ÷µÄÊÇ£¬`HandlerInterceptor#postHandle` µÄÖ´ÐÐʱ»úÊÇ**ÔÚÖ´ÐÐÍê `handler` ·½·¨ºóÖ®ºó£¬ÔÚÊÓͼ½âÎö֮ǰ**¡£Òò´Ë£¬ÎÒÃÇ¿ÉÒÔÔÚÀ¹½ØÆ÷µÄÕâ¸ö·½·¨Àï´¦ÀíһЩ¶îÍâµÄäÖȾ²ÎÊý¡£ +这个å�Œå‰�é�¢æ‰§è¡Œæ‹¦æˆªå™¨æ–¹æ³•类似,这里就ä¸�过多分æž�了。需è¦�强调的是,`HandlerInterceptor#postHandle` 的执行时机是**在执行完 `handler` 方法å�Žä¹‹å�Žï¼Œåœ¨è§†å›¾è§£æž�之å‰�**。因此,我们å�¯ä»¥åœ¨æ‹¦æˆªå™¨çš„这个方法里处ç�†ä¸€äº›é¢�外的渲染å�‚数。 -ÏÞÓÚÆª·ù£¬±¾ÎľÍÏȵ½ÕâÀïÁË£¬request Ö´ÐеĺóÐøÁ÷³Ì£¬ÎÒÃÇÏÂÆªÎÄÕÂÔÙ·ÖÎö¡£ +é™�于篇幅,本文就先到这里了,request 执行的å�Žç»­æµ�程,我们下篇文章å†�分æž�。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4741104](https://my.oschina.net/funcy/blog/4741104) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4741104](https://my.oschina.net/funcy/blog/4741104) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/AnnotationAwareAspectJAutoProxyCreator\345\210\206\346\236\220\357\274\210\344\270\213\357\274\211.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/AnnotationAwareAspectJAutoProxyCreator\345\210\206\346\236\220\357\274\210\344\270\213\357\274\211.md" index c21a988..70a0a58 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/AnnotationAwareAspectJAutoProxyCreator\345\210\206\346\236\220\357\274\210\344\270\213\357\274\211.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/AnnotationAwareAspectJAutoProxyCreator\345\210\206\346\236\220\357\274\210\344\270\213\357\274\211.md" @@ -1,6 +1,6 @@ -[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4678817 "ÉÏһƪÎÄÕÂ")Ö÷Òª·ÖÎöÁË `AbstractAutoProxyCreator#postProcessAfterInitialization` ·½·¨£¬±¾ÎÄÎÒÃÇÀ´·ÖÎö `AbstractAutoProxyCreator#postProcessAfterInitialization` ·½·¨¡£ +[上一篇文章](https://my.oschina.net/funcy/blog/4678817 "上一篇文章")主è¦�分æž�了 `AbstractAutoProxyCreator#postProcessAfterInitialization` 方法,本文我们æ�¥åˆ†æž� `AbstractAutoProxyCreator#postProcessAfterInitialization` 方法。 -ÎÒÃÇÏÈÀ´¿´¿´Õâ¸ö·½·¨µÄµ÷ÓÃÁ´£º +我们先æ�¥çœ‹çœ‹è¿™ä¸ªæ–¹æ³•的调用链: ``` |-AnnotationConfigApplicationContext @@ -19,7 +19,7 @@ ``` -ʵ¼ÊÉÏÕâ¸ö·½·¨µÄµ÷ÓÃÁ´¾ÍÊÇ spring bean µÄ´´½¨¹ý³Ì£¬ÎÒÃǽøÈë `AbstractAutoProxyCreator#postProcessAfterInitialization`£º +实际上这个方法的调用链就是 spring bean 的创建过程,我们进入 `AbstractAutoProxyCreator#postProcessAfterInitialization`: ``` @Override @@ -27,7 +27,7 @@ public Object postProcessAfterInitialization(@Nullable Object bean, String beanN if (bean != null) { Object cacheKey = getCacheKey(bean.getClass(), beanName); if (this.earlyProxyReferences.remove(cacheKey) != bean) { - // ÉîÈëwrapIfNecessary()·½·¨ + // 深入wrapIfNecessary()方法 return wrapIfNecessary(bean, beanName, cacheKey); } } @@ -36,31 +36,31 @@ public Object postProcessAfterInitialization(@Nullable Object bean, String beanN ``` -¼ÌÐø½øÈë `AbstractAutoProxyCreator#wrapIfNecessary`£º +继续进入 `AbstractAutoProxyCreator#wrapIfNecessary`: ``` protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) { - //Èç¹ûÒѾ­´¦Àí¹ý + //如果已ç»�处ç�†è¿‡ if (StringUtils.hasLength(beanName) && this.targetSourcedBeans.contains(beanName)) { return bean; } - //Èç¹ûµ±Ç°ÀàÊÇÔöÇ¿À࣬·µ»Ø + //如果当å‰�类是增强类,返回 if (Boolean.FALSE.equals(this.advisedBeans.get(cacheKey))) { return bean; } - // ÖØÒª´úÂëÒ»£ºÅжϵ±Ç°ÀàÊÇ·ñΪÇÐÃæÀ࣬¸Ã´úÂëÔÚÉÏһƪÎÄÕÂÒѾ­·ÖÎöÁË£¬¾Í²»¶à˵ÁË + // é‡�è¦�代ç �一:判断当å‰�类是å�¦ä¸ºåˆ‡é�¢ç±»ï¼Œè¯¥ä»£ç �在上一篇文章已ç»�分æž�了,就ä¸�多说了 if (isInfrastructureClass(bean.getClass()) || shouldSkip(bean.getClass(), beanName)) { this.advisedBeans.put(cacheKey, Boolean.FALSE); return bean; } - // ÖØÒª´úÂë¶þ£ºÐ£Ñé´ËÀàÊÇ·ñÓ¦¸Ã±»´úÀí£¬»ñÈ¡Õâ¸öÀàµÄÔöÇ¿ + // é‡�è¦�代ç �二:校验此类是å�¦åº”该被代ç�†ï¼ŒèŽ·å�–这个类的增强 Object[] specificInterceptors = getAdvicesAndAdvisorsForBean(bean.getClass(), beanName, null); - //Èç¹û»ñÈ¡µ½ÁËÔöÇ¿ÔòÐèÒªÕë¶ÔÔöÇ¿´´½¨´úÀí + //如果获å�–到了增强则需è¦�针对增强创建代ç�† if (specificInterceptors != DO_NOT_PROXY) { this.advisedBeans.put(cacheKey, Boolean.TRUE); - // ÖØÒª´úÂëÈý£º´´½¨´úÀí + // é‡�è¦�代ç �三:创建代ç�† Object proxy = createProxy( bean.getClass(), beanName, specificInterceptors, new SingletonTargetSource(bean)); this.proxyTypes.put(cacheKey, proxy.getClass()); @@ -73,29 +73,29 @@ protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) ``` -Õâ¸ö·½·¨ ¿´×ÅÓе㳤£¬µ«´ó¶à´úÂë¶¼ÊÇÔÚ×öÅжϣ¬Óë aop ¹¦ÄܹØÏµ²»´ó¡£ÕæÕýÓйØÏµµÄ´úÂëÖ»ÓÐÈýÐУº +这个方法 看ç�€æœ‰ç‚¹é•¿ï¼Œä½†å¤§å¤šä»£ç �都是在å�šåˆ¤æ–­ï¼Œä¸Ž aop 功能关系ä¸�大。真正有关系的代ç �å�ªæœ‰ä¸‰è¡Œï¼š ``` -// ÖØÒª´úÂëÒ»£º -// 1\. isInfrastructureClass£ºÅжϵ±Ç°ÊÇ·ñΪaopÏà¹ØÀ࣬ -// ÈçAdvice/Pointcut/AdvisorµÈµÄ×ÓÀ࣬ÊÇ·ñ°üº¬ @AspectJµÄ×¢½â -// 2\. shouldSkip£º²éÕÒËùÓÐÇÐÃæÀ࣬ÅжÏÊÇ·ñ±»Åųý +// é‡�è¦�代ç �一: +// 1\. isInfrastructureClass:判断当å‰�是å�¦ä¸ºaop相关类, +// 如Advice/Pointcut/Advisor等的å­�类,是å�¦åŒ…å�« @AspectJ的注解 +// 2\. shouldSkip:查找所有切é�¢ç±»ï¼Œåˆ¤æ–­æ˜¯å�¦è¢«æŽ’除 if (isInfrastructureClass(bean.getClass()) || shouldSkip(bean.getClass(), beanName)) { ... } -// ÖØÒª´úÂë¶þ£ºÐ£Ñé´ËÀàÊÇ·ñÓ¦¸Ã±»´úÀí£¬»ñÈ¡Õâ¸öÀàµÄÔöÇ¿ +// é‡�è¦�代ç �二:校验此类是å�¦åº”该被代ç�†ï¼ŒèŽ·å�–这个类的增强 Object[] specificInterceptors = getAdvicesAndAdvisorsForBean(bean.getClass(), beanName, null); -// ÖØÒª´úÂëÈý£º´´½¨´úÀí +// é‡�è¦�代ç �三:创建代ç�† Object proxy = createProxy( bean.getClass(), beanName, specificInterceptors, new SingletonTargetSource(bean)); ``` -¶ÔÓÚ`ÖØÒª´úÂëÒ»`£¬ÉÏһƪÎÄÕÂÒѾ­·ÖÎö¹ý£¬±¾ÎÄÎÒÃÇÖ÷Òª·ÖÎö`ÖØÒª´úÂë¶þ`Óë`ÖØÒª´úÂëÈý`¡£ +对于`é‡�è¦�代ç �一`,上一篇文章已ç»�分æž�过,本文我们主è¦�分æž�`é‡�è¦�代ç �二`与`é‡�è¦�代ç �三`。 -### 1\. »ñÈ¡ÀàµÄÔöÇ¿ +### 1\. 获å�–类的增强 > AbstractAdvisorAutoProxyCreator @@ -104,7 +104,7 @@ Object proxy = createProxy( @Nullable protected Object[] getAdvicesAndAdvisorsForBean( Class beanClass, String beanName, @Nullable TargetSource targetSource) { - // ²éÕÒ·ûºÏÌõ¼þµÄÔöÇ¿£¬¼ÌÐøÍùÏ¿´ + // 查找符å�ˆæ�¡ä»¶çš„增强,继续往下看 List advisors = findEligibleAdvisors(beanClass, beanName); if (advisors.isEmpty()) { return DO_NOT_PROXY; @@ -113,12 +113,12 @@ protected Object[] getAdvicesAndAdvisorsForBean( } /** - * ²éÕÒ·ûºÏÌõ¼þµÄÔöÇ¿ + * 查找符å�ˆæ�¡ä»¶çš„增强 */ protected List findEligibleAdvisors(Class beanClass, String beanName) { - //»ñÈ¡ÈÝÆ÷ÖеÄËùÓÐÔöÇ¿£¬ÔÚÉÏһƪÎÄÕÂÖÐÒѾ­·ÖÎö¹ýÁË + //获å�–容器中的所有增强,在上一篇文章中已ç»�分æž�过了 List candidateAdvisors = findCandidateAdvisors(); - //ÑéÖ¤beanClassÊÇ·ñ¸Ã±»´úÀí£¬Èç¹ûÓ¦¸Ã£¬Ôò·µ»ØÊÊÓÃÓÚÕâ¸öbeanµÄÔöÇ¿ + //验è¯�beanClass是å�¦è¯¥è¢«ä»£ç�†ï¼Œå¦‚果应该,则返回适用于这个bean的增强 List eligibleAdvisors = findAdvisorsThatCanApply(candidateAdvisors, beanClass, beanName); extendAdvisors(eligibleAdvisors); if (!eligibleAdvisors.isEmpty()) { @@ -128,13 +128,13 @@ protected List findEligibleAdvisors(Class beanClass, String beanName } /** - * ÑéÖ¤beanClassÊÇ·ñ¸Ã±»´úÀí + * 验è¯�beanClass是å�¦è¯¥è¢«ä»£ç�† */ protected List findAdvisorsThatCanApply( List candidateAdvisors, Class beanClass, String beanName) { ProxyCreationContext.setCurrentProxiedBeanName(beanName); try { - // ÑéÖ¤beanClassÊÇ·ñ¸Ã±»´úÀí + // 验è¯�beanClass是å�¦è¯¥è¢«ä»£ç�† return AopUtils.findAdvisorsThatCanApply(candidateAdvisors, beanClass); } finally { @@ -144,7 +144,7 @@ protected List findAdvisorsThatCanApply( ``` -spring µÄ·½·¨µ÷ÓñȽÏÉһ·׷×Ù£¬×îÖÕµ½ÁË `AopUtils.findAdvisorsThatCanApply` ·½·¨£¬¼ÌÐøÍùÏ¿´£º +spring 的方法调用比较深,一路追踪,最终到了 `AopUtils.findAdvisorsThatCanApply` 方法,继续往下看: > AopUtils @@ -154,9 +154,9 @@ public static List findAdvisorsThatCanApply(List candidateAdvi return candidateAdvisors; } List eligibleAdvisors = new ArrayList<>(); - // ±éÀú candidateAdvisors£¬ÅжÏÊÇ·ñÂú×ã´úÀíÌõ¼þ + // é��历 candidateAdvisors,判断是å�¦æ»¡è¶³ä»£ç�†æ�¡ä»¶ for (Advisor candidate : candidateAdvisors) { - //´¦ÀíÔöÇ¿£¬Öص㣬ÔÙÍùÏ¿´ + //处ç�†å¢žå¼ºï¼Œé‡�点,å†�往下看 if (candidate instanceof IntroductionAdvisor && canApply(candidate, clazz)) { eligibleAdvisors.add(candidate); } @@ -167,7 +167,7 @@ public static List findAdvisorsThatCanApply(List candidateAdvi // already processed continue; } - //¶ÔÆÕͨbeanµÄ´¦Àí + //对普通bean的处ç�† if (canApply(candidate, clazz, hasIntroductions)) { eligibleAdvisors.add(candidate); } @@ -176,24 +176,24 @@ public static List findAdvisorsThatCanApply(List candidateAdvi } /** - * ÅжÏÊÇ·ñÐèÒªÔöÇ¿ + * 判断是å�¦éœ€è¦�增强 */ public static boolean canApply(Advisor advisor, Class targetClass) { - // µ÷ÓÃÏÂÒ»¸ö·½·¨ + // 调用下一个方法 return canApply(advisor, targetClass, false); } /** - * ÅжÏÊÇ·ñÐèÒªÔöÇ¿ + * 判断是å�¦éœ€è¦�增强 */ public static boolean canApply(Advisor advisor, Class targetClass, boolean hasIntroductions) { - //Èç¹û´æÔÚÅųýµÄÅäÖà + //如果存在排除的é…�ç½® if (advisor instanceof IntroductionAdvisor) { return ((IntroductionAdvisor) advisor).getClassFilter().matches(targetClass); } else if (advisor instanceof PointcutAdvisor) { PointcutAdvisor pca = (PointcutAdvisor) advisor; - //½øÈë¸Ã·½·¨¼ÌÐø + //进入该方法继续 return canApply(pca.getPointcut(), targetClass, hasIntroductions); } else { @@ -203,15 +203,15 @@ public static boolean canApply(Advisor advisor, Class targetClass, boolean ha } /** - * ÅжÏÊÇ·ñÐèÒªÔöÇ¿ + * 判断是å�¦éœ€è¦�增强 */ public static boolean canApply(Pointcut pc, Class targetClass, boolean hasIntroductions) { Assert.notNull(pc, "Pointcut must not be null"); - //ÇеãÉÏÊÇ·ñ´æÔÚÅųýÀàµÄÅäÖà + //切点上是å�¦å­˜åœ¨æŽ’除类的é…�ç½® if (!pc.getClassFilter().matches(targetClass)) { return false; } - //Ñé֤ע½âµÄ×÷ÓÃÓòÊÇ·ñ¿ÉÒÔ×÷ÓÃÓÚ·½·¨ÉÏ + //验è¯�注解的作用域是å�¦å�¯ä»¥ä½œç”¨äºŽæ–¹æ³•上 MethodMatcher methodMatcher = pc.getMethodMatcher(); if (methodMatcher == MethodMatcher.TRUE) { // No need to iterate the methods if we're matching any method anyway... @@ -223,23 +223,23 @@ public static boolean canApply(Pointcut pc, Class targetClass, boolean hasInt introductionAwareMethodMatcher = (IntroductionAwareMethodMatcher) methodMatcher; } - // classes°üº¬targetClass¡¢³ýObjectµÄËùÓи¸Àà¡¢ËùÓÐ½Ó¿Ú + // classes包å�«targetClassã€�除Object的所有父类ã€�所有接å�£ Set> classes = new LinkedHashSet<>(); if (!Proxy.isProxyClass(targetClass)) { classes.add(ClassUtils.getUserClass(targetClass)); } classes.addAll(ClassUtils.getAllInterfacesForClassAsSet(targetClass)); - // Ñ­»·ÅжϷ½·¨ÊÇ·ñÐèÒª´úÀí£¬ - // ÕâÀï¿ÉÒÔ¿´³ö£¬ - // 1\. Ö»ÒªÒ»¸ö·½·¨Âú×ã´úÀíÒªÇó£¬ÄÇôÕû¸öÀà¾Í»á±»´úÀí - // 2\. Èç¹û¸¸ÀàÓз½·¨ÐèÒª±»´úÀí£¬ÄÇô×ÓÀàÒ²»á±»´úÀí + // 循环判断方法是å�¦éœ€è¦�代ç�†ï¼Œ + // 这里å�¯ä»¥çœ‹å‡ºï¼Œ + // 1\. å�ªè¦�一个方法满足代ç�†è¦�求,那么整个类就会被代ç�† + // 2\. 如果父类有方法需è¦�被代ç�†ï¼Œé‚£ä¹ˆå­�类也会被代ç�† for (Class clazz : classes) { - // »ñÈ¡ clazz ¶¨ÒåµÄ·½·¨ - // °üÀ¨µ±Ç°ÀàµÄ·½·¨¡¢³ýObjectÍâµÄËùÓи¸Àà·½·¨¡¢½Ó¿ÚµÄĬÈÏ·½·¨ + // 获å�– clazz 定义的方法 + // 包括当å‰�类的方法ã€�除Object外的所有父类方法ã€�接å�£çš„默认方法 Method[] methods = ReflectionUtils.getAllDeclaredMethods(clazz); for (Method method : methods) { - //»ñÈ¡ÀàËùʵÏÖµÄËùÓнӿںÍËùÓÐÀà²ã¼¶µÄ·½·¨£¬Ñ­»·ÑéÖ¤ + //获å�–类所实现的所有接å�£å’Œæ‰€æœ‰ç±»å±‚级的方法,循环验è¯� if (introductionAwareMethodMatcher != null ? introductionAwareMethodMatcher.matches(method, targetClass, hasIntroductions) : methodMatcher.matches(method, targetClass)) { @@ -253,51 +253,51 @@ public static boolean canApply(Pointcut pc, Class targetClass, boolean hasInt ``` -¿´µ½ÕâÀ»ù±¾ÉϾÍÁ˽âÁË spring ÊÇÈçºÎÀ´ÅжÏÒ»¸ö¶ÔÏóÊÇ·ñÐèÒª±»´úÀíµÄ£¬ÕâÀï×ܽáÁ÷³ÌÈçÏ£º +看到这里,基本上就了解了 spring 是如何æ�¥åˆ¤æ–­ä¸€ä¸ªå¯¹è±¡æ˜¯å�¦éœ€è¦�被代ç�†çš„,这里总结æµ�程如下: -1. »ñÈ¡µ½ÏîÄ¿ÖÐËùÓеÄÇÐÃæ¶ÔÏ󣬽«ÆäÖеÄÇÐÃæ·½·¨·âװΪһ¸ö `List`£¬¾ßÌå²Ù×÷ÔÚÉÏһƪÎÄÕÂÖÐÓÐÏêϸ·ÖÎö£» -2. ±éÀú `Advisor`£¬¶Ôÿһ¸ö `Advisor`£¬ÀûÓ÷´Éä»ñÈ¡µ±Ç°ÀàµÄ³ý `Object` ÍâµÄËùÓи¸À༰½Ó¿Ú£¬½á¹ûΪ `Set`£» -3. ±éÀú `Set`£¬¶ÔÆäÖÐÿһ¸ö `Class`£¬ÀûÓ÷´Éä»ñÈ¡¸Ã `Class` ·½·¨¡¢³ý Object ÍâµÄËùÓи¸ÀàµÄ·½·¨¡¢½Ó¿ÚµÄĬÈÏ·½·¨£¬½á¹ûΪ `Method[]`; -4. ±éÀú `Method[]`£¬Èç¹ûÓÐÒ»¸ö `method` Âú×ã `Advisor` µÄÇÐÃæÌõ¼þ£¬Ôò±íʾµ±Ç° `Advisor` ¿ÉÒÔÓ¦Óõ½µ±Ç° bean£¬¸Ã bean ¾ÍÐèÒª±»´úÀí£¬ÕâÒ»²½×îÖյõ½µÄ½á¹ûÒ²ÊÇÒ»¸ö `List`£¬±íʾ¸ÃÓжà¸ö `Advisor` ÐèÒªÓ¦Óõ½¸Ã¶ÔÏó¡£ +1. 获å�–到项目中所有的切é�¢å¯¹è±¡ï¼Œå°†å…¶ä¸­çš„切é�¢æ–¹æ³•å°�装为一个 `List`,具体æ“�作在上一篇文章中有详细分æž�ï¼› +2. é��历 `Advisor`,对æ¯�一个 `Advisor`,利用å��射获å�–当å‰�类的除 `Object` 外的所有父类å�пޥå�£ï¼Œç»“果为 `Set`ï¼› +3. é��历 `Set`,对其中æ¯�一个 `Class`,利用å��射获å�–该 `Class` 方法ã€�除 Object 外的所有父类的方法ã€�接å�£çš„默认方法,结果为 `Method[]`; +4. é��历 `Method[]`,如果有一个 `method` 满足 `Advisor` 的切é�¢æ�¡ä»¶ï¼Œåˆ™è¡¨ç¤ºå½“å‰� `Advisor` å�¯ä»¥åº”用到当å‰� bean,该 bean 就需è¦�被代ç�†ï¼Œè¿™ä¸€æ­¥æœ€ç»ˆå¾—到的结果也是一个 `List`,表示该有多个 `Advisor` 需è¦�应用到该对象。 -α´úÂëÀàËÆÓÚ£º +伪代ç �类似于: ``` -// 1\. »ñÈ¡ËùÓеÄAdvisor +// 1\. 获å�–所有的Advisor List advisorList = getAdvisorList(); -// 2\. ±éÀúAdvisor +// 2\. é��历Advisor for(Advisor advisor : advisorList) { - // »ñÈ¡µ±Ç°ÀàµÄ³ý`Object`ÍâµÄËùÓи¸À༰½Ó¿Ú£¬classSetÒ²°üº¬targetClass + // 获å�–当å‰�类的除`Object`外的所有父类å�пޥå�£ï¼ŒclassSet也包å�«targetClass Set classSet = getSuperClassAndInterfaces(targetClass); for(Class cls : classSet) { - // ±éÀúclsÖж¨ÒåµÄ·½·¨£¬°üÀ¨µ±Ç°ÀàµÄ·½·¨¡¢³ýObjectÍâµÄËùÓи¸Àà·½·¨¡¢½Ó¿ÚµÄĬÈÏ·½·¨ + // é��历cls中定义的方法,包括当å‰�类的方法ã€�除Object外的所有父类方法ã€�接å�£çš„默认方法 Method[] methods = ReflectionUtils.getAllDeclaredMethods(clazz); - // ±éÀúÕâЩ·½·¨ + // é��历这些方法 for (Method method : methods) { - // ÅжÏmethodÊÇ·ñÂú×ãÇÐÃæÌõ¼þ + // 判断method是å�¦æ»¡è¶³åˆ‡é�¢æ�¡ä»¶ } } } ``` -µÃµ½ `List` ºó£¬½ÓÏÂÀ´¾ÍÊǸù¾Ý `List` À´´´½¨´úÀí¶ÔÏóÁË¡£ +得到 `List` å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ˜¯æ ¹æ�® `List` æ�¥åˆ›å»ºä»£ç�†å¯¹è±¡äº†ã€‚ -### 2\. ´´½¨´úÀí¶ÔÏó +### 2\. 创建代ç�†å¯¹è±¡ -ÎÒÃÇÀ´¿´¿´ spring ´´½¨´úÀí¶ÔÏóµÄÁ÷³Ì¡£ +我们æ�¥çœ‹çœ‹ spring 创建代ç�†å¯¹è±¡çš„æµ�程。 -> `AbstractAutoProxyCreator#wrapIfNecessary`£º +> `AbstractAutoProxyCreator#wrapIfNecessary`: ``` protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) { ... if (specificInterceptors != DO_NOT_PROXY) { this.advisedBeans.put(cacheKey, Boolean.TRUE); - // ´úÀí¶ÔÏó¾ÍÊÇÔÚÕâÀï´´½¨µÄ - // - specificInterceptors£º¿ÉÒÔÓ¦Óõ½¸Ã¶ÔÏóµÄ Advisor£¬ - // specificInterceptorsµÄ»ñÈ¡¹ý³Ì£¬ÉÏÒ»²¿·ÖÒѾ­Ïêϸ·ÖÎö¹ýÁË£¬²»ÔÙ׸ÊöÁË - // - SingletonTargetSource£º¶Ôԭʼ¶ÔÏóµÄÒ»¸ö°ü×° + // 代ç�†å¯¹è±¡å°±æ˜¯åœ¨è¿™é‡Œåˆ›å»ºçš„ + // - specificInterceptors:å�¯ä»¥åº”用到该对象的 Advisor, + // specificInterceptors的获å�–过程,上一部分已ç»�详细分æž�过了,ä¸�å†�赘述了 + // - SingletonTargetSource:对原始对象的一个包装 Object proxy = createProxy( bean.getClass(), beanName, specificInterceptors, new SingletonTargetSource(bean)); @@ -310,7 +310,7 @@ protected Object wrapIfNecessary(Object bean, String beanName, Object cacheKey) ``` -ÎÒÃÇÏÈÀ´¿´¿´ `SingletonTargetSource`£º +我们先æ�¥çœ‹çœ‹ `SingletonTargetSource`: ``` public class SingletonTargetSource implements TargetSource, Serializable { @@ -339,7 +339,7 @@ public class SingletonTargetSource implements TargetSource, Serializable { ``` -Õâ¸öÀà´úÂëºÜ¼òµ¥£¬¾ÍÊǶÔԭʼ¶ÔÏó×öÁËÒ»²ã°ü×°¡£¼ÌÐøÍùÏ¿´£º +这个类代ç �很简å�•,就是对原始对象å�šäº†ä¸€å±‚包装。继续往下看: > AbstractAutoProxyCreator#createProxy @@ -353,82 +353,82 @@ protected Object createProxy(Class beanClass, @Nullable String beanName, } ProxyFactory proxyFactory = new ProxyFactory(); - //ʹÓÃproxyFactory¶ÔÏócopyµ±Ç°ÀàÖеÄÏà¹ØÊôÐÔ + //使用proxyFactory对象copy当å‰�类中的相关属性 proxyFactory.copyFrom(this); - // ÅжÏÊÇ·ñʹÓÃCglib¶¯Ì¬´úÀí£¬¿ÉÒÔÔÚ×¢½âÖÐÖ¸¶¨£º + // 判断是å�¦ä½¿ç”¨Cglib动æ€�代ç�†ï¼Œå�¯ä»¥åœ¨æ³¨è§£ä¸­æŒ‡å®šï¼š // @EnableAspectJAutoProxy(proxyTargetClass = true) if (!proxyFactory.isProxyTargetClass()) { - // Èç¹û beanFactory ÊÇ ConfigurableListableBeanFactory£¬ - // Ôò¿ÉÔÚ BeanDefinition ÉèÖÃÊôÐÔ£¬µ¥¶À¿ØÖÆÄ³Ò»¸öÀàʹÓà cglib ´úÀí + // 如果 beanFactory 是 ConfigurableListableBeanFactory, + // 则å�¯åœ¨ BeanDefinition 设置属性,å�•独控制æŸ�一个类使用 cglib 代ç�† if (shouldProxyTargetClass(beanClass, beanName)) { proxyFactory.setProxyTargetClass(true); } else { - // Èç¹ûûÓÐÅäÖÿªÆô, ÔòÅжÏbeanÊÇ·ñÓкÏÊʵĽӿÚʹÓÃJDKµÄ¶¯Ì¬´úÀí - // ×¢Ò⣺JDK¶¯Ì¬´úÀí±ØÐëÊÇ´øÓнӿڵÄÀà - // Èç¹ûÀàûÓÐʵÏÖÈκνӿÚÔòÖ»ÄÜʹÓÃCglib¶¯Ì¬´úÀí£© + // 如果没有é…�置开å�¯, 则判断bean是å�¦æœ‰å�ˆé€‚的接å�£ä½¿ç”¨JDK的动æ€�代ç�† + // 注æ„�:JDK动æ€�代ç�†å¿…须是带有接å�£çš„ç±» + // 如果类没有实现任何接å�£åˆ™å�ªèƒ½ä½¿ç”¨Cglib动æ€�代ç�†ï¼‰ evaluateProxyInterfaces(beanClass, proxyFactory); } } - // ¹¹½¨Advisor£¬ÕâÀï°üº¬Á½¸ö²Ù×÷£º - // 1\. Ìí¼Ó¹«¹²µÄ Interceptor - // 2\. ¶ÔÓÚ¸ø¶¨µÄadvisor£¬ÅÐ¶ÏÆäÀàÐÍ£¬È»ºóת»»ÎªÆä¾ßÌåÀàÐÍ + // 构建Advisor,这里包å�«ä¸¤ä¸ªæ“�作: + // 1\. 添加公共的 Interceptor + // 2\. 对于给定的advisor,判断其类型,然å�Žè½¬æ�¢ä¸ºå…¶å…·ä½“类型 Advisor[] advisors = buildAdvisors(beanName, specificInterceptors); - //Ìí¼ÓËùÓÐÔöÇ¿ + //添加所有增强 proxyFactory.addAdvisors(advisors); - //ÉèÖÃÒª´úÀíµÄÀà + //设置è¦�代ç�†çš„ç±» proxyFactory.setTargetSource(targetSource); - //SpringµÄÒ»¸öÀ©Õ¹µã£¬Ä¬ÈÏʵÏÖΪ¿Õ¡£Áô¸øÎÒÃÇÔÚÐèÒª¶Ô´úÀí½øÐÐÌØÊâ²Ù×÷µÄʱºòʵÏÖ + //Spring的一个扩展点,默认实现为空。留给我们在需è¦�对代ç�†è¿›è¡Œç‰¹æ®Šæ“�作的时候实现 customizeProxyFactory(proxyFactory); proxyFactory.setFrozen(this.freezeProxy); if (advisorsPreFiltered()) { proxyFactory.setPreFiltered(true); } - //ʹÓôúÀí¹¤³§»ñÈ¡´úÀí¶ÔÏó + //使用代ç�†å·¥åŽ‚èŽ·å�–代ç�†å¯¹è±¡ return proxyFactory.getProxy(getProxyClassLoader()); } ``` -ÔÚ `@EnableAspectJAutoProxy` ×¢½âÖУ¬¿ÉÒÔʹÓà `proxyTargetClass = true` À´ÉèÖÃÏîĿʹÓà `cglib` ´úÀí£¬ÕâÔÚ´úÂëÖÐÒ²ÓÐÌåÏÖ£º +在 `@EnableAspectJAutoProxy` 注解中,å�¯ä»¥ä½¿ç”¨ `proxyTargetClass = true` æ�¥è®¾ç½®é¡¹ç›®ä½¿ç”¨ `cglib` 代ç�†ï¼Œè¿™åœ¨ä»£ç �中也有体现: ``` -// Ö»ÓÐÔÚproxyFactory.isProxyTargetClass()Ϊfalseʱ£¬²Å»á½øÐÐÏÂÃæµÄÅÐ¶Ï -// »»ÑÔÖ®£¬µ± @EnableAspectJAutoProxy(proxyTargetClass = true) ʱ -// ÏÂÃæµÄ´úÂëÊDz»»áÔËÐеģ¬Ä¬ÈÏʹÓþÍÊÇcglib´úÀí +// å�ªæœ‰åœ¨proxyFactory.isProxyTargetClass()为false时,æ‰�会进行下é�¢çš„判断 +// æ�¢è¨€ä¹‹ï¼Œå½“ @EnableAspectJAutoProxy(proxyTargetClass = true) æ—¶ +// 下é�¢çš„代ç �是ä¸�会è¿�行的,默认使用就是cglib代ç�† if (!proxyFactory.isProxyTargetClass()) { - // ÅжÏÓÐûÔÚ BeanDefinition ÖÐÉèÖÃʹÓà cglib´úÀí + // 判断有没在 BeanDefinition 中设置使用 cglib代ç�† if (shouldProxyTargetClass(beanClass, beanName)) { proxyFactory.setProxyTargetClass(true); } else { - // ÊÇ·ñÂú×ã´úÀí½Ó¿ÚµÄÌõ¼þ£¬¼´ÊÇ·ñÂú×ãjdk¶¯Ì¬´úÀíµÄÌõ¼þ + // 是å�¦æ»¡è¶³ä»£ç�†æŽ¥å�£çš„æ�¡ä»¶ï¼Œå�³æ˜¯å�¦æ»¡è¶³jdk动æ€�代ç�†çš„æ�¡ä»¶ evaluateProxyInterfaces(beanClass, proxyFactory); } } ``` -spring ÊÇÈçºÎÅжÏÒ»¸öÀàÊÇ·ñÂú×ã jdk ¶¯Ì¬´úÀíµÄÌõ¼þµÄÄØ£¿´ÓÎÒÃÇÀ´ÈÏÖªÉÏÀ´Ëµ£¬ÊµÏÖÁ˽ӿڣ¬¾Í¿ÉÒÔʹÓö¯Ì¬´úÀí£¬·ñÔò¾ÍÖ»ÄÜʹÓà cglib ´úÀí£¬ÎÒÃÇÀ´¿´¿´ spring ÊÇÈçºÎÅжϵģº +spring 是如何判断一个类是å�¦æ»¡è¶³ jdk 动æ€�代ç�†çš„æ�¡ä»¶çš„呢?从我们æ�¥è®¤çŸ¥ä¸Šæ�¥è¯´ï¼Œå®žçŽ°äº†æŽ¥å�£ï¼Œå°±å�¯ä»¥ä½¿ç”¨åЍæ€�代ç�†ï¼Œå�¦åˆ™å°±å�ªèƒ½ä½¿ç”¨ cglib 代ç�†ï¼Œæˆ‘们æ�¥çœ‹çœ‹ spring 是如何判断的: > ProxyProcessorSupport#evaluateProxyInterfaces ``` /** - * ÅжÏÊÇ·ñÄÜʹÓÃjdk¶¯Ì¬´úÀí + * 判断是å�¦èƒ½ä½¿ç”¨jdk动æ€�代ç�† */ protected void evaluateProxyInterfaces(Class beanClass, ProxyFactory proxyFactory) { - // »ñÈ¡ÀàµÄËùÓÐ½Ó¿Ú + // 获å�–类的所有接å�£ Class[] targetInterfaces = ClassUtils.getAllInterfacesForClass(beanClass, getProxyClassLoader()); boolean hasReasonableProxyInterface = false; for (Class ifc : targetInterfaces) { - // 1.isConfigurationCallbackInterface: ÅжÏifcÊÇ·ñΪInitializingBean£¬DisposableBean£¬ - // Closeable£¬AutoCloseable£¬ÒÔ¼°°üº¬ Aware - // 2.isInternalLanguageInterface: ÊÇ·ñΪÄÚ²¿ÓïÑÔ½Ó¿Ú£¬Èçgroovy£¬mockµÈ - // 3.ifc.getMethods().length > 0£º½Ó¿ÚµÄ·½·¨Êý±ØÐë´óÓÚ1 + // 1.isConfigurationCallbackInterface: 判断ifc是å�¦ä¸ºInitializingBean,DisposableBean, + // Closeable,AutoCloseable,以å�ŠåŒ…å�« Aware + // 2.isInternalLanguageInterface: 是å�¦ä¸ºå†…部语言接å�£ï¼Œå¦‚groovy,mockç­‰ + // 3.ifc.getMethods().length > 0:接å�£çš„æ–¹æ³•数必须大于1 if (!isConfigurationCallbackInterface(ifc) && !isInternalLanguageInterface(ifc) && ifc.getMethods().length > 0) { hasReasonableProxyInterface = true; @@ -436,10 +436,10 @@ protected void evaluateProxyInterfaces(Class beanClass, ProxyFactory proxyFac } } if (hasReasonableProxyInterface) { - // ÐèÒª½«ËùÓеĽӿڶ¼ÉèÖõ½proxyFactory - // ÊÔÏëһϣ¬Èç¹ûÒ»¸öÀàA ʵÏÖÁË½Ó¿Ú I1 Óë I2£¬ - // Èç¹ûÀàAµÄ¶ÔÏóa Íйܵ½ÁËspringÈÝÆ÷£¬ÄÇôÎÞÂÛÊÇʹÓà beanFactory.get(I1.class)£¬ - // »¹ÊÇ beanFactory.get(I1.class)£¬¶¼Ó¦¸ÃÄÜ»ñÈ¡µ½a. + // 需è¦�将所有的接å�£éƒ½è®¾ç½®åˆ°proxyFactory + // 试想一下,如果一个类A 实现了接å�£ I1 与 I2, + // 如果类A的对象a 托管到了spring容器,那么无论是使用 beanFactory.get(I1.class), + // 还是 beanFactory.get(I1.class),都应该能获å�–到a. for (Class ifc : targetInterfaces) { proxyFactory.addInterface(ifc); } @@ -451,32 +451,32 @@ protected void evaluateProxyInterfaces(Class beanClass, ProxyFactory proxyFac ``` -´ÓÔ´ÂëÉÏÀ´¿´£¬spring ÅжÏÊÇ·ñÄÜʹÓà jdk ¶¯Ì¬´úÀíµÄ¹ý³ÌÓëÎÒÃÇÈÏÖªÉϵIJ¶à£¬²»¹ý²¢²»ÊÇʵÏÖÁËÈÎÒâ½Ó¿Ú¾ÍÄÜʹÓà jdk ¶¯Ì¬´úÀí£¬spring »áÅųý `InitializingBean`£¬`DisposableBean`£¬`Closeable`£¬`AutoCloseable` µÈ½Ó¿Ú£¬Í¬Ê±Ò²»áÅųýÎÞÈκη½·¨µÄ½Ó¿Ú¡£ +从æº�ç �上æ�¥çœ‹ï¼Œspring 判断是å�¦èƒ½ä½¿ç”¨ jdk 动æ€�代ç�†çš„过程与我们认知上的差ä¸�多,ä¸�过并ä¸�是实现了任æ„�接å�£å°±èƒ½ä½¿ç”¨ jdk 动æ€�代ç�†ï¼Œspring 会排除 `InitializingBean`,`DisposableBean`,`Closeable`,`AutoCloseable` 等接å�£ï¼Œå�Œæ—¶ä¹Ÿä¼šæŽ’除无任何方法的接å�£ã€‚ -·ÖÎöÍê spring ÈçºÎÅжÏÊÇ·ñʹÓà jdk ¶¯Ì¬´úÀíºó£¬½Ó¿ÚÎÒÃÇÀ´¿´¿´ spring ÊÇÈçºÎ´´½¨´úÀí¶ÔÏóµÄ¡£ÎªÁË˵Ã÷ÎÊÌ⣬Ê×Ïȼò»¯Ï `AbstractAutoProxyCreator#createProxy`£º +分æž�完 spring 如何判断是å�¦ä½¿ç”¨ jdk 动æ€�代ç�†å�Žï¼ŒæŽ¥å�£æˆ‘们æ�¥çœ‹çœ‹ spring 是如何创建代ç�†å¯¹è±¡çš„。为了说明问题,首先简化下 `AbstractAutoProxyCreator#createProxy`: ``` protected Object createProxy(Class beanClass, @Nullable String beanName, @Nullable Object[] specificInterceptors, TargetSource targetSource) { - // Ê¡ÂÔһЩ´úÂë + // çœ�略一些代ç � ... ProxyFactory proxyFactory = new ProxyFactory(); - //ʹÓÃproxyFactory¶ÔÏócopyµ±Ç°ÀàÖеÄÏà¹ØÊôÐÔ + //使用proxyFactory对象copy当å‰�类中的相关属性 proxyFactory.copyFrom(this); - // ÕâÀïÊ¡ÂÔÁ˺öàµÄÅÐ¶Ï + // 这里çœ�略了好多的判断 proxyFactory.setProxyTargetClass(true); - //Ìí¼ÓËùÓÐÔöÇ¿ + //添加所有增强 proxyFactory.addAdvisors(advisors); - //ÉèÖÃÒª´úÀíµÄÀà + //设置è¦�代ç�†çš„ç±» proxyFactory.setTargetSource(targetSource); ... - //ʹÓôúÀí¹¤³§»ñÈ¡´úÀí¶ÔÏó + //使用代ç�†å·¥åŽ‚èŽ·å�–代ç�†å¯¹è±¡ return proxyFactory.getProxy(getProxyClassLoader()); } ``` -´ÓÕâÀï¿ÉÒÔ¿´³ö£¬Õâ¸ö·½·¨´´½¨ÁËÒ»¸ö `ProxyFactory` ¶ÔÏó£¬È»ºóÍù¸Ã¶ÔÏóµÄÊôÐÔÀïÉèÖÃÁËһЩֵ¡£¼ÌÐøÍùÏ¿´£º +从这里å�¯ä»¥çœ‹å‡ºï¼Œè¿™ä¸ªæ–¹æ³•创建了一个 `ProxyFactory` 对象,然å�Žå¾€è¯¥å¯¹è±¡çš„属性里设置了一些值。继续往下看: > ProxyFactory#getProxy(java.lang.ClassLoader) @@ -487,7 +487,7 @@ public Object getProxy(@Nullable ClassLoader classLoader) { ``` -ÕâÀïÓÐÁ½¸ö·½·¨£º`createAopProxy()` Óë `getProxy(classLoader)`£¬ÎÒÃÇÏÈÀ´¿´ `createAopProxy()`¡£ +这里有两个方法:`createAopProxy()` 与 `getProxy(classLoader)`,我们先æ�¥çœ‹ `createAopProxy()`。 > ProxyCreatorSupport#createAopProxy @@ -501,15 +501,15 @@ protected final synchronized AopProxy createAopProxy() { ``` -¼ÌÐø£¬ +继续, > DefaultAopProxyFactory#createAopProxy ``` /** - * ÅжϴúÀíÀàÐÍ - * Èç¹ûÄÜʹÓÃjdk¶¯Ì¬´úÀí£¬¾Í·µ»Ø JdkDynamicAopProxy - * ·ñÔò¾Í·µ»Ø ObjenesisCglibAopProxy + * 判断代ç�†ç±»åž‹ + * 如果能使用jdk动æ€�代ç�†ï¼Œå°±è¿”回 JdkDynamicAopProxy + * å�¦åˆ™å°±è¿”回 ObjenesisCglibAopProxy */ public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException { if (config.isOptimize() || config.isProxyTargetClass() || hasNoUserSuppliedProxyInterfaces(config)) { @@ -529,7 +529,7 @@ public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException ``` -µ½ÕâÀÎÒÃǾÍÄÜÃ÷°×£¬`JdkDynamicAopProxy` ÊÇÓÃÀ´´¦Àí jdk ¶¯Ì¬´úÀíµÄ£¬`ObjenesisCglibAopProxy` ÊÇÓÃÀ´´¦Àí cglib ´úÀíµÄ¡£½ÓÏÂÀ´£¬ÎÒÃÇÀ´¿´¿´ `getProxy(classLoader)` ·½·¨¡£ +到这里,我们就能明白,`JdkDynamicAopProxy` 是用æ�¥å¤„ç�† jdk 动æ€�代ç�†çš„,`ObjenesisCglibAopProxy` 是用æ�¥å¤„ç�† cglib 代ç�†çš„。接下æ�¥ï¼Œæˆ‘们æ�¥çœ‹çœ‹ `getProxy(classLoader)` 方法。 > JdkDynamicAopProxy#getProxy(java.lang.ClassLoader) @@ -538,19 +538,19 @@ public AopProxy createAopProxy(AdvisedSupport config) throws AopConfigException public Object getProxy(@Nullable ClassLoader classLoader) { Class[] proxiedInterfaces = AopProxyUtils .completeProxiedInterfaces(this.advised, true); - // ÊÇ·ñÓÐequals()ÓëhashCode()·½·¨ + // 是å�¦æœ‰equals()与hashCode()方法 findDefinedEqualsAndHashCodeMethods(proxiedInterfaces); - // µ÷Óà jdk ·½·¨ ´´½¨¶ÔÏó + // 调用 jdk 方法 创建对象 return Proxy.newProxyInstance(classLoader, proxiedInterfaces, this); } ``` -×îºóÎÒÃÇÀ´¿´¿´µÃµ½µÄ´úÀí¶ÔÏóÊÇʲôÑùµÄ£º +最å�Žæˆ‘们æ�¥çœ‹çœ‹å¾—到的代ç�†å¯¹è±¡æ˜¯ä»€ä¹ˆæ ·çš„: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ee46c03d86755b936862c9e8cde266fca1e.png) -¿ÉÒÔ¿´µ½£¬´úÀí¶ÔÏóµÄ `h` ÊôÐÔ±£´æµÄ¾ÍÊÇ `JdkDynamicAopProxy` ¶ÔÏó£¬`JdkDynamicAopProxy` ¶ÔÏóµÄ `advised` ÊôÐÔ±£´æÁË´úÀíµÄ´úÀíµÄÏà¹ØÐÅÏ¢¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œä»£ç�†å¯¹è±¡çš„ `h` 属性ä¿�存的就是 `JdkDynamicAopProxy` 对象,`JdkDynamicAopProxy` 对象的 `advised` 属性ä¿�存了代ç�†çš„代ç�†çš„相关信æ�¯ã€‚ > CglibAopProxy#getProxy(java.lang.ClassLoader) @@ -571,7 +571,7 @@ public Object getProxy(@Nullable ClassLoader classLoader) { validateClassIfNecessary(proxySuperClass, classLoader); - // ´´½¨ Enhancer ¶ÔÏ󣬲¢setһЩÊôÐÔ + // 创建 Enhancer 对象,并set一些属性 Enhancer enhancer = createEnhancer(); if (classLoader != null) { enhancer.setClassLoader(classLoader); @@ -580,9 +580,9 @@ public Object getProxy(@Nullable ClassLoader classLoader) { enhancer.setUseCache(false); } } - // Superclass¾ÍÊÇÒª´úÀíµÄÀà + // Superclass就是è¦�代ç�†çš„ç±» enhancer.setSuperclass(proxySuperClass); - // ÉèÖýӿڣ¬Èç SpringProxy£¬Advised + // 设置接å�£ï¼Œå¦‚ SpringProxy,Advised enhancer.setInterfaces(AopProxyUtils.completeProxiedInterfaces(this.advised)); enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE); enhancer.setStrategy(new ClassLoaderAwareGeneratorStrategy(classLoader)); @@ -609,20 +609,20 @@ public Object getProxy(@Nullable ClassLoader classLoader) { ``` -spring ʹÓà cglib ´´½¨¶ÔÏó£¬Ö÷ÒªÓõ½ÁË `Enhancer` À࣬¹ØÓÚÕâÒ»¿éºóÃæ»áÔÙ·ÖÎö¡£ +spring 使用 cglib 创建对象,主è¦�用到了 `Enhancer` 类,关于这一å�—å�Žé�¢ä¼šå†�分æž�。 -×îºóÎÒÃÇÒ²À´¿´¿´´´½¨ºóµÃµ½µÄ¶ÔÏó£º +最å�Žæˆ‘们也æ�¥çœ‹çœ‹åˆ›å»ºå�Žå¾—到的对象: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-97d647a818f62fa0979dabd58f3aa19e473.png) -### 3\. ×ܽá +### 3\. 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË `AbstractAutoProxyCreator#postProcessAfterInitialization`£¬¸Ã·½·¨Ö÷Òª×öÁËÈý¼þÊ£º +本文主è¦�分æž�了 `AbstractAutoProxyCreator#postProcessAfterInitialization`,该方法主è¦�å�šäº†ä¸‰ä»¶äº‹ï¼š -1. »ñÈ¡ÏîÄ¿ÖÐËùÓÐÇÐÃæÀ࣬½«Çе㷽·¨°üװΪ `List`£ºÊµ¼ÊÉÏ£¬ÕâÒ»²½µÄ²Ù×÷Ò²»áÔÚ `AbstractAutoProxyCreator#postProcessBeforeInitialization` ÖÐÖ´ÐУ¬È»ºó½«½á¹û»º´æÁËÆðÀ´£¬ÕâÒ»²½ÆäʵÊÇÖ±½ÓÔÚ»º´æÖÐÄýá¹û£» -2. »ñÈ¡µ±Ç°¶ÔÏóµÄËùÓÐÔöÇ¿£ºÕâÒ»²½¾ÍÊÇÅжÏÄÄЩÔöÇ¿¿ÉÒÔÓÃÓÚµ±Ç°¶ÔÏó£¬ÅжÏʱÏÈ»ñÈ¡µ±Ç°ÀàµÄËùÓнӿÚÓë²»°üÀ¨ Object µÄ¸¸À࣬ȻºóÖðÒ»ÅжÏÕâЩ½Ó¿ÚÓëÀàÖеķ½·¨ÊÇ·ñÂú×ãÔöÇ¿Ìõ¼þ£¬Ö»ÒªÓÐÒ»¸ö·½·¨Âú×㣬¾Í±íʾµ±Ç°¶ÔÏóÐèÒª±»´úÀí£» -3. ´´½¨´úÀí¶ÔÏ󣺴´½¨´úÀí¶ÔÏóʱ£¬Ä¬ÈÏÇé¿öÏ£¬»á¸ù¾ÝÊÇ·ñʵÏÖÁ˽ӿÚÀ´Ñ¡ÔñʹÓà jdk ¶¯Ì¬´úÀí»¹ÊÇ cglib£¬¿ÉÓ¦ÓÃÓÚµ±Ç° bean µÄ `List` Ò²»á·â×°½ø´úÀí¶ÔÏóÖС£ +1. 获å�–项目中所有切é�¢ç±»ï¼Œå°†åˆ‡ç‚¹æ–¹æ³•包装为 `List`:实际上,这一步的æ“�作也会在 `AbstractAutoProxyCreator#postProcessBeforeInitialization` 中执行,然å�Žå°†ç»“果缓存了起æ�¥ï¼Œè¿™ä¸€æ­¥å…¶å®žæ˜¯ç›´æŽ¥åœ¨ç¼“存中拿结果; +2. 获å�–当å‰�对象的所有增强:这一步就是判断哪些增强å�¯ä»¥ç”¨äºŽå½“å‰�对象,判断时先获å�–当å‰�类的所有接å�£ä¸Žä¸�包括 Object 的父类,然å�Žé€�一判断这些接å�£ä¸Žç±»ä¸­çš„æ–¹æ³•是å�¦æ»¡è¶³å¢žå¼ºæ�¡ä»¶ï¼Œå�ªè¦�有一个方法满足,就表示当å‰�对象需è¦�被代ç�†ï¼› +3. 创建代ç�†å¯¹è±¡ï¼šåˆ›å»ºä»£ç�†å¯¹è±¡æ—¶ï¼Œé»˜è®¤æƒ…况下,会根æ�®æ˜¯å�¦å®žçŽ°äº†æŽ¥å�£æ�¥é€‰æ‹©ä½¿ç”¨ jdk 动æ€�代ç�†è¿˜æ˜¯ cglib,å�¯åº”用于当å‰� bean çš„ `List` 也会å°�装进代ç�†å¯¹è±¡ä¸­ã€‚ * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4687961](https://my.oschina.net/funcy/blog/4687961) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4687961](https://my.oschina.net/funcy/blog/4687961) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\344\272\224\357\274\211\357\274\232cglib\344\273\243\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\344\272\224\357\274\211\357\274\232cglib\344\273\243\347\220\206.md" index 412483a..4743ae9 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\344\272\224\357\274\211\357\274\232cglib\344\273\243\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\344\272\224\357\274\211\357\274\232cglib\344\273\243\347\220\206.md" @@ -1,18 +1,18 @@ -[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4696654 "ÉÏһƪÎÄÕÂ")½éÉÜÁË spring µÄ jdK ¶¯Ì¬´úÀí£¬±¾ÎÄÀ´½éÉÜ spring µÄ cglib ´úÀí¡£ +[上一篇文章](https://my.oschina.net/funcy/blog/4696654 "上一篇文章")介ç»�了 spring çš„ jdK 动æ€�代ç�†ï¼Œæœ¬æ–‡æ�¥ä»‹ç»� spring çš„ cglib 代ç�†ã€‚ -### 1\. cglib ´úÀí¼ò½é +### 1\. cglib 代ç�†ç®€ä»‹ -jdk ËäÈ»ÌṩÁ˶¯Ì¬´úÀí£¬µ«ÊǶ¯Ì¬´úÀíÓÐÒ»¸ö²»×㣺**Èç¹ûÀàûÓÐʵÏÖ½Ó¿Ú£¬¾ÍÎÞ·¨ jdk ¶¯Ì¬´úÀí**¡£ÎªÁ˽â¾öÕâ¸ö²»×㣬spring ÓÖÒýÈëÁË cglib ´úÀí¡£ +jdk 虽然æ��供了动æ€�代ç�†ï¼Œä½†æ˜¯åЍæ€�代ç�†æœ‰ä¸€ä¸ªä¸�足:**如果类没有实现接å�£ï¼Œå°±æ— æ³• jdk 动æ€�代ç�†**。为了解决这个ä¸�足,spring å�ˆå¼•入了 cglib 代ç�†ã€‚ -cglib µ×²ãÊÇ»ùÓÚ asm µÄ£¬Ò²¾ÍÊÇÖ±½Ó²Ù×÷×Ö½ÚÂ룬Ï൱ÓÚ¶Ô asm ½øÐÐÁËÒ»²ã·â×°¡£Ö±½Ó²Ù×÷×ÖÂ룬ÐèÒª¶Ô java Ö¸Áî¡¢×Ö½ÚÂëÎļþÓÐÉîÈëÀí½â²ÅÄܽøÐУ¬µ«×Ö½ÚÂë»ÞɬÄѶ®£¬Ò»°ã²»½¨ÒéÖ±½Ó²Ù×÷¡£¾­ cglib ·â×°ºó£¬×Ö½ÚÂëµÄ²Ù×÷¾Í±äµÃ¼òµ¥¶àÁË£¬Òò´Ë**¾ø´ó¶àÊýÇé¿ö϶¼½¨ÒéʹÓà cglib ·â×°ºÃµÄ·½·¨À´½øÐÐ×Ö½ÚÂë²Ù×÷**¡£ +cglib 底层是基于 asm 的,也就是直接æ“�作字节ç �,相当于对 asm 进行了一层å°�装。直接æ“�作字ç �,需è¦�对 java 指令ã€�字节ç �文件有深入ç�†è§£æ‰�能进行,但字节ç �晦涩难懂,一般ä¸�建议直接æ“�作。ç»� cglib å°�装å�Žï¼Œå­—节ç �çš„æ“�作就å�˜å¾—简å�•多了,因此**ç»�大多数情况下都建议使用 cglib å°�装好的方法æ�¥è¿›è¡Œå­—节ç �æ“�作**。 -spring cglib ²Ù×÷λÓÚ `spring-core` Ä£¿é£º +spring cglib æ“�作ä½�于 `spring-core` 模å�—: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6b64440344221ca08ed8c822b5b22c1d341.png) -ÔÙÀ´¿´¿´ asm Óë cglib °ü˵Ã÷£º +å†�æ�¥çœ‹çœ‹ asm 与 cglib 包说明: ``` /** @@ -31,7 +31,7 @@ spring cglib ``` -×¢ÒâµÚÒ»¾ä£º`Spring's repackaging of ASM 7.0`£¬±íÃ÷ÕâÊÇ spring ¶Ô `asm7.0` ÖØÐ´ò°ü. +注æ„�第一å�¥ï¼š`Spring's repackaging of ASM 7.0`,表明这是 spring 对 `asm7.0` é‡�新打包. ``` /** @@ -50,15 +50,15 @@ package org.springframework.cglib; ``` -×¢ÒâµÚÒ»¾ä£º`Spring's repackaging of CGLIB 3.3`£¬±íÃ÷ÕâÊÇ spring ¶Ô `CGLIB 3.3` ÖØÐ´ò°ü. +注æ„�第一å�¥ï¼š`Spring's repackaging of CGLIB 3.3`,表明这是 spring 对 `CGLIB 3.3` é‡�新打包. -ºÎÎ½ÖØÐ´ò°üÄØ£¿¸öÈËÀí½â£¬¾ÍÊǽ« `asm7.0` Óë `CGLIB 3.3` µÄÔ´Âë¸Ä¸ö°üÃû£¬¸´ÖƵ½ spring ÏîĿϡ£Òò´Ë spring ²¢Ã»ÓÐÔÚ `gradle` ÎļþÖÐÒýÈë `asm` Óë `cglib` µÄÏ൱ jar °ü£¬¶øÊÇÔÚÏîÄ¿ÖÐÖ±½ÓÒýÈëÁËÕâÁ½¸öÏîÄ¿µÄÔ´Â룡 +何谓é‡�新打包呢?个人ç�†è§£ï¼Œå°±æ˜¯å°† `asm7.0` 与 `CGLIB 3.3` çš„æº�ç �改个包å��,å¤�制到 spring 项目下。因此 spring 并没有在 `gradle` 文件中引入 `asm` 与 `cglib` 的相当 jar 包,而是在项目中直接引入了这两个项目的æº�ç �ï¼� -### 2\. cglib ´úÀíʾÀý +### 2\. cglib 代ç�†ç¤ºä¾‹ -ÔÚÕýʽ¿ªÊ¼Ö®Ç°£¬ÎÒÃÇÏÈÀ´¿´ ¿´ cglib ´úÀíÊÇÈçºÎ½øÐеġ£ +在正å¼�开始之å‰�,我们先æ�¥çœ‹ 看 cglib 代ç�†æ˜¯å¦‚何进行的。 -Ê×ÏÈ×¼±¸Ò»¸öÀࣺ +首先准备一个类: ``` package org.springframework.learn.demo04; @@ -71,7 +71,7 @@ public class CglibProxyService { ``` -ÔÙ×¼±¸Ò»¸ö `MethodInterceptor`£¨Àà±È jdk ¶¯Ì¬´úÀíÖÐµÄ `InvocationHandler`£©£º +å†�准备一个 `MethodInterceptor`(类比 jdk 动æ€�代ç�†ä¸­çš„ `InvocationHandler`): ``` package org.springframework.learn.demo04; @@ -83,7 +83,7 @@ import java.lang.reflect.Method; public class MyMethodInterceptor implements MethodInterceptor { - /** Ä¿±ê¶ÔÏó */ + /** 目标对象 */ private Object target; public MyMethodInterceptor(Object target){ @@ -93,14 +93,14 @@ public class MyMethodInterceptor implements MethodInterceptor { @Override public Object intercept(Object proxyObj, Method method, Object[] objects, MethodProxy proxy) throws Throwable { - System.out.println("Ö´Ðз½·¨Îª:" + method.getName()); + System.out.println("执行方法为:" + method.getName()); return proxy.invoke(target, objects); } } ``` -×îºóÊÇÖ÷Àࣺ +最å�Žæ˜¯ä¸»ç±»ï¼š ``` package org.springframework.learn.demo04; @@ -108,10 +108,10 @@ package org.springframework.learn.demo04; import org.springframework.cglib.proxy.Enhancer; /** - * £ûÕâÀïÌí¼ÓÃèÊö£ý + * {这里添加æ��è¿°ï½� * * @author fangchengyan - * @date 2020-11-01 9:23 ÏÂÎç + * @date 2020-11-01 9:23 下å�ˆ */ public class Demo04Main { @@ -120,11 +120,11 @@ public class Demo04Main { MyMethodInterceptor interceptor = new MyMethodInterceptor(target); Enhancer enhancer = new Enhancer(); - // ÉèÖø¸Àà + // 设置父类 enhancer.setSuperclass(CglibProxyService.class); - // ÉèÖÃcallback£¬Õâ¸öcallback¾ÍÊÇÉÏÃæÌṩµÄ MyMethodInterceptor + // 设置callback,这个callback就是上é�¢æ��供的 MyMethodInterceptor enhancer.setCallback(interceptor); - // ʹÓà enhancer ´´½¨´úÀí¶ÔÏó + // 使用 enhancer 创建代ç�†å¯¹è±¡ CglibProxyService proxy = (CglibProxyService)enhancer.create(); proxy.hello01(); } @@ -132,29 +132,29 @@ public class Demo04Main { ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` -Ö´Ðз½·¨Îª:hello01 +执行方法为:hello01 hello01 ``` -¿ÉÒÔ¿´µ½£¬×îÖÕÊÇÔÚ `MyMethodInterceptor#intercept` Ö´ÐÐÄ¿±ê¶ÔÏóµÄ·½·¨¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œæœ€ç»ˆæ˜¯åœ¨ `MyMethodInterceptor#intercept` 执行目标对象的方法。 -ͬ jdk ¶¯Ì¬´úÀí±È½Ïºó£¬·¢ÏÖÁ½Õß´úÂë¸ß¶ÈÏàËÆ£º +å�Œ jdk 动æ€�代ç�†æ¯”较å�Žï¼Œå�‘现两者代ç �高度相似: -* `InvocationHandler` Óë `InvocationHandler`£ºÁ½Õß´úÂëÐÎʽ¼¸ºõÒ»Ö ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6f3e8213e743554a7a8ffc587b98b1d7d3a.png) +* `InvocationHandler` 与 `InvocationHandler`:两者代ç �å½¢å¼�几乎一致 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6f3e8213e743554a7a8ffc587b98b1d7d3a.png) -* ´úÀí¶ÔÏóµÄ´´½¨£ºÒ»¸öÊÇʹÓà `Enhangcer` ½øÐдúÀí¶ÔÏó´´½¨£¬Ò»¸öÊÇʹÓ÷â×°ºÃµÄ·½·¨½øÐжÔÏó´´½¨¡£ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8ee847f9cbb7ec7fa6c35b2ad5a5537ef3a.png) +* 代ç�†å¯¹è±¡çš„创建:一个是使用 `Enhangcer` 进行代ç�†å¯¹è±¡åˆ›å»ºï¼Œä¸€ä¸ªæ˜¯ä½¿ç”¨å°�装好的方法进行对象创建。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8ee847f9cbb7ec7fa6c35b2ad5a5537ef3a.png) -´Ó´úÀí¶ÔÏó´´½¨À´¿´£¬¿ÉÒÔ¿´³ö `cglib` Éú³É¶ÔÏóʱ£¬ÅäÖõIJÎÊý½Ï¶à£¬¹¦ÄܽϷḻ¡£ +从代ç�†å¯¹è±¡åˆ›å»ºæ�¥çœ‹ï¼Œå�¯ä»¥çœ‹å‡º `cglib` 生æˆ�对象时,é…�置的å�‚数较多,功能较丰富。 -¹ØÓÚ `Enhangcer` ÊÇÈçºÎ´´½¨´úÀí¶ÔÏó£¬ÒÔ¼° `org.springframework.asm` Óë `org.springframework.cglib` ÕâÁ½¸ö°üϵĴúÂ룬ÕâЩÊôÓÚ cglib µÄÄÚÈÝ£¬¾Í²»¹ý¶à·ÖÎöÁË¡£ +关于 `Enhangcer` 是如何创建代ç�†å¯¹è±¡ï¼Œä»¥å�Š `org.springframework.asm` 与 `org.springframework.cglib` 这两个包下的代ç �,这些属于 cglib 的内容,就ä¸�过多分æž�了。 -### 3\. spring ÖÐ `cglib` ´´½¨´úÀí¶ÔÏó +### 3\. spring 中 `cglib` 创建代ç�†å¯¹è±¡ -ÎÒÃÇÔÙÀ´¿´¿´ spring ÊÇÈçºÎ´´½¨´úÀí¶ÔÏóµÄ£º +我们å†�æ�¥çœ‹çœ‹ spring 是如何创建代ç�†å¯¹è±¡çš„: > CglibAopProxy#getProxy(java.lang.ClassLoader) @@ -173,11 +173,11 @@ public Object getProxy(@Nullable ClassLoader classLoader) { } } - // ¶ÔÄ¿±êÀà½øÐмì²é£¬Ö÷Òª¼ì²éµãÓÐÈý¸ö£º - // 1\. Ä¿±ê·½·¨²»ÄÜʹÓÃfinalÐÞÊΣ» - // 2\. Ä¿±ê·½·¨²»ÄÜÊÇprivateÀàÐ͵ģ» - // 3\. Ä¿±ê·½·¨²»ÄÜÊǰü·ÃÎÊȨÏ޵ģ» - // ÕâÈý¸öµãÂú×ãÈκÎÒ»¸ö£¬µ±Ç°·½·¨¾Í²»Äܱ»´úÀí£¬´Ëʱ¸Ã·½·¨¾Í»á±»ÂÔ¹ý + // 对目标类进行检查,主è¦�检查点有三个: + // 1\. 目标方法ä¸�能使用final修饰; + // 2\. 目标方法ä¸�能是private类型的; + // 3\. 目标方法ä¸�能是包访问æ�ƒé™�的; + // 这三个点满足任何一个,当å‰�方法就ä¸�能被代ç�†ï¼Œæ­¤æ—¶è¯¥æ–¹æ³•就会被略过 validateClassIfNecessary(proxySuperClass, classLoader); Enhancer enhancer = createEnhancer(); @@ -188,32 +188,32 @@ public Object getProxy(@Nullable ClassLoader classLoader) { enhancer.setUseCache(false); } } - // Superclass¾ÍÊÇÒª´úÀíµÄÀà + // Superclass就是è¦�代ç�†çš„ç±» enhancer.setSuperclass(proxySuperClass); - // ÕâÀïAopProxyUtils.completeProxiedInterfaces()·½·¨µÄÖ÷ҪĿµÄÊÇΪҪÉú³ÉµÄ´úÀíÀà - // Ôö¼ÓSpringProxy£¬Advised£¬DecoratingProxyÈý¸öÐèҪʵÏֵĽӿڡ£ÕâÀïÈý¸ö½Ó¿ÚµÄ×÷ÓÃÈçÏ£º - // 1\. SpringProxy£ºÊÇÒ»¸ö¿Õ½Ó¿Ú£¬ÓÃÓÚ±ê¼Çµ±Ç°Éú³ÉµÄ´úÀíÀàÊÇSpringÉú³ÉµÄ´úÀíÀࣻ - // 2\. Advised£ºSpringÉú³É´úÀíÀàËùʹÓõÄÊôÐÔ¶¼±£´æÔڸýӿÚÖУ¬ - // °üÀ¨Advisor£¬AdviceºÍÆäËûÏà¹ØÊôÐÔ£» - // 3\. DecoratingProxy£º¸Ã½Ó¿ÚÓÃÓÚ»ñÈ¡µ±Ç°´úÀí¶ÔÏóËù´úÀíµÄÄ¿±ê¶ÔÏóµÄClassÀàÐÍ¡£ + // 这里AopProxyUtils.completeProxiedInterfaces()方法的主è¦�目的是为è¦�生æˆ�的代ç�†ç±» + // 增加SpringProxy,Advised,DecoratingProxy三个需è¦�实现的接å�£ã€‚这里三个接å�£çš„作用如下: + // 1\. SpringProxy:是一个空接å�£ï¼Œç”¨äºŽæ ‡è®°å½“å‰�生æˆ�的代ç�†ç±»æ˜¯Spring生æˆ�的代ç�†ç±»ï¼› + // 2\. Advised:Spring生æˆ�代ç�†ç±»æ‰€ä½¿ç”¨çš„属性都ä¿�存在该接å�£ä¸­ï¼Œ + // 包括Advisor,Advice和其他相关属性; + // 3\. DecoratingProxy:该接å�£ç”¨äºŽèŽ·å�–当å‰�代ç�†å¯¹è±¡æ‰€ä»£ç�†çš„目标对象的Class类型。 enhancer.setInterfaces(AopProxyUtils.completeProxiedInterfaces(this.advised)); enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE); enhancer.setStrategy(new ClassLoaderAwareGeneratorStrategy(classLoader)); - // Ìí¼Ócallback + // 添加callback Callback[] callbacks = getCallbacks(rootClass); Class[] types = new Class[callbacks.length]; for (int x = 0; x < types.length; x++) { types[x] = callbacks[x].getClass(); } - // ÉèÖôúÀíÀàÖи÷¸ö·½·¨½«ÒªÊ¹ÓõÄÇÐÃæÂß¼­£¬ÕâÀïProxyCallbackFilter.accept()·½·¨·µ»Ø - // µÄÕûÐÍÖµÕýºÃÒ»Ò»¶ÔÓ¦ÉÏÃæCallbackÊý×éÖи÷¸öÇÐÃæÂß¼­µÄϱ꣬Ҳ¾ÍÊÇ˵ÕâÀïµÄCallbackFilter - // µÄ×÷ÓÃÕýºÃÖ¸¶¨ÁË´úÀíÀàÖи÷¸ö·½·¨½«ÒªÊ¹ÓÃCallbackÊý×éÖеÄÄĸö»òÄöÇÐÃæÂß¼­ + // 设置代ç�†ç±»ä¸­å�„个方法将è¦�使用的切é�¢é€»è¾‘,这里ProxyCallbackFilter.accept()方法返回 + // 的整型值正好一一对应上é�¢Callback数组中å�„个切é�¢é€»è¾‘的下标,也就是说这里的CallbackFilter + // 的作用正好指定了代ç�†ç±»ä¸­å�„个方法将è¦�使用Callback数组中的哪个或哪几个切é�¢é€»è¾‘ enhancer.setCallbackFilter(new ProxyCallbackFilter( this.advised.getConfigurationOnlyCopy(), this.fixedInterceptorMap, this.fixedInterceptorOffset)); enhancer.setCallbackTypes(types); - // Éú³É´úÀí¶ÔÏó + // 生æˆ�代ç�†å¯¹è±¡ return createProxyClassAndInstance(enhancer, callbacks); } catch (...) { @@ -223,17 +223,17 @@ public Object getProxy(@Nullable ClassLoader classLoader) { ``` -ÒÔÉÏ´úÂëºËÐÄÊÇÉèÖà `Enhancer` µÄÊôÐÔ£¬Èç `classLoader`¡¢`superclass`¡¢`callbackFilter` µÈ£¬×îºóµ÷Óà `createProxyClassAndInstance(xxx)` ´´½¨´úÀí¶ÔÏó£º +以上代ç �核心是设置 `Enhancer` 的属性,如 `classLoader`ã€�`superclass`ã€�`callbackFilter` 等,最å�Žè°ƒç”¨ `createProxyClassAndInstance(xxx)` 创建代ç�†å¯¹è±¡ï¼š > ObjenesisCglibAopProxy#createProxyClassAndInstance ``` protected Object createProxyClassAndInstance(Enhancer enhancer, Callback[] callbacks) { - // ´´½¨´úÀíÀà + // 创建代ç�†ç±» Class proxyClass = enhancer.createClass(); Object proxyInstance = null; - // ¸ù¾Ý´úÀíÀ࣬ʹÓ÷´ÉäÉú³É¶ÔÏó + // æ ¹æ�®ä»£ç�†ç±»ï¼Œä½¿ç”¨å��射生æˆ�对象 if (objenesis.isWorthTrying()) { try { proxyInstance = objenesis.newInstance(proxyClass, enhancer.getUseCache()); @@ -256,15 +256,15 @@ protected Object createProxyClassAndInstance(Enhancer enhancer, Callback[] callb throw new AopConfigException(...); } } - // ÉèÖÃcallbackÊôÐÔ - // µ±ÉèÖÃÁ˶à¸ö callback ʱ£¬»áͨ¹ý CallbackFilter À´È·¶¨×îÖÕʹÓÃÄĸö callback + // 设置callback属性 + // 当设置了多个 callback 时,会通过 CallbackFilter æ�¥ç¡®å®šæœ€ç»ˆä½¿ç”¨å“ªä¸ª callback ((Factory) proxyInstance).setCallbacks(callbacks); return proxyInstance; } ``` -ͨ¹ýÔÚµÚ¶þ²¿·ÖµÄ `demo04` ¿ÉÒÔÖªµÀ£¬cglib ·½·¨µÄÖ´ÐУ¬»á¾­¹ý `MethodInterceptor#intercept` ·½·¨µ÷Óõģ¬Ò²¾ÍÊÇ `Enhancer` µÄ `callback` ÊôÐÔ£¬Òò´Ë½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `callback` µÄ»ñÈ¡£¬Ïà¹Ø´úÂëλÓÚ `CglibAopProxy#getCallbacks`£º +通过在第二部分的 `demo04` å�¯ä»¥çŸ¥é�“,cglib 方法的执行,会ç»�过 `MethodInterceptor#intercept` 方法调用的,也就是 `Enhancer` çš„ `callback` 属性,因此接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `callback` 的获å�–,相关代ç �ä½�于 `CglibAopProxy#getCallbacks`: > CglibAopProxy#getCallbacks @@ -274,51 +274,51 @@ private Callback[] getCallbacks(Class rootClass) throws Exception { boolean isFrozen = this.advised.isFrozen(); boolean isStatic = this.advised.getTargetSource().isStatic(); - // Óû§×Ô¶¨ÒåµÄ´úÀíÂß¼­µÄcallback£¬¼´¿ª·¢ÖУ¬¶¨ÒåµÄ @Before¡¢@Around¡¢@AfterµÈÇÐÃæ·½·¨£¬ - // ½«ÔÚDynamicAdvisedInterceptor½øÐе÷Óà + // 用户自定义的代ç�†é€»è¾‘çš„callback,å�³å¼€å�‘中,定义的 @Beforeã€�@Aroundã€�@After等切é�¢æ–¹æ³•, + // 将在DynamicAdvisedInterceptor进行调用 Callback aopInterceptor = new DynamicAdvisedInterceptor(this.advised); Callback targetInterceptor; - // ÅжÏÈç¹ûÒª±©Â¶´úÀí¶ÔÏó£¬Èç¹ûÊÇ£¬ÔòʹÓÃAopContextÉèÖý«´úÀí¶ÔÏóÉèÖõ½ThreadLocalÖÐ - // Óû§Ôò¿ÉÒÔͨ¹ýAopContext»ñȡĿ±ê¶ÔÏó + // 判断如果è¦�暴露代ç�†å¯¹è±¡ï¼Œå¦‚果是,则使用AopContext设置将代ç�†å¯¹è±¡è®¾ç½®åˆ°ThreadLocal中 + // 用户则å�¯ä»¥é€šè¿‡AopContext获å�–目标对象 if (exposeProxy) { - // Åжϱ»´úÀíµÄ¶ÔÏóÊÇ·ñÊǾ²Ì¬µÄ£¬Èç¹ûÊǾ²Ì¬µÄ£¬Ôò½«Ä¿±ê¶ÔÏ󻺴æÆðÀ´£¬Ã¿´Î¶¼Ê¹ÓøöÔÏó¼´¿É£¬ - // Èç¹ûÄ¿±ê¶ÔÏóÊǶ¯Ì¬µÄ£¬ÔòÔÚDynamicUnadvisedExposedInterceptorÖÐÿ´Î¶¼Éú³ÉÒ»¸öÐ嵀 - // Ä¿±ê¶ÔÏó£¬ÒÔÖ¯ÈëºóÃæµÄ´úÀíÂß¼­ + // 判断被代ç�†çš„对象是å�¦æ˜¯é�™æ€�的,如果是é�™æ€�的,则将目标对象缓存起æ�¥ï¼Œæ¯�次都使用该对象å�³å�¯ï¼Œ + // 如果目标对象是动æ€�的,则在DynamicUnadvisedExposedInterceptor中æ¯�次都生æˆ�一个新的 + // 目标对象,以织入å�Žé�¢çš„代ç�†é€»è¾‘ targetInterceptor = (isStatic ? new StaticUnadvisedExposedInterceptor(this.advised.getTargetSource().getTarget()) : new DynamicUnadvisedExposedInterceptor(this.advised.getTargetSource())); } else { - // ÕâÀïµÄÁ½¸öÀàÓëÉÏÃæÁ½¸öµÄÎ¨Ò»Çø±ð¾ÍÔÚÓÚÊÇ·ñʹÓÃAopContext±©Â¶Éú³ÉµÄ´úÀí¶ÔÏó + // 这里的两个类与上é�¢ä¸¤ä¸ªçš„唯一区别就在于是å�¦ä½¿ç”¨AopContext暴露生æˆ�的代ç�†å¯¹è±¡ targetInterceptor = (isStatic ? new StaticUnadvisedInterceptor(this.advised.getTargetSource().getTarget()) : new DynamicUnadvisedInterceptor(this.advised.getTargetSource())); } - // µ±Ç°CallbackÓÃÓÚ²»Óñ»´úÀíµÄ·½·¨ + // 当å‰�Callback用于ä¸�用被代ç�†çš„æ–¹æ³• Callback targetDispatcher = (isStatic ? new StaticDispatcher(this.advised.getTargetSource().getTarget()) : new SerializableNoOp()); - // ½«»ñÈ¡µ½µÄcallback×éװΪһ¸öÊý×é + // 将获å�–到的callback组装为一个数组 Callback[] mainCallbacks = new Callback[] { - // Óû§×Ô¼º¶¨ÒåµÄÀ¹½ØÆ÷ + // 用户自己定义的拦截器 aopInterceptor, // for normal advice - // ¸ù¾ÝÌõ¼þÊÇ·ñ±©Â¶´úÀí¶ÔÏóµÄÀ¹½ØÆ÷ + // æ ¹æ�®æ�¡ä»¶æ˜¯å�¦æš´éœ²ä»£ç�†å¯¹è±¡çš„æ‹¦æˆªå™¨ targetInterceptor, // invoke target without considering advice, if optimized - // ²»×öÈκβÙ×÷µÄÀ¹½ØÆ÷ + // ä¸�å�šä»»ä½•æ“�作的拦截器 new SerializableNoOp(), // no override for methods mapped to this - // ÓÃÓÚ´æ´¢Advised¶ÔÏóµÄ·Ö·¢Æ÷ + // 用于存储Advised对象的分å�‘器 targetDispatcher, this.advisedDispatcher, - // Õë¶Ôequals·½·¨µ÷ÓõÄÀ¹½ØÆ÷ + // 针对equals方法调用的拦截器 new EqualsInterceptor(this.advised), - // Õë¶Ôhashcode·½·¨µ÷ÓõÄÀ¹½ØÆ÷ + // 针对hashcode方法调用的拦截器 new HashCodeInterceptor(this.advised) }; Callback[] callbacks; - // Èç¹ûÄ¿±ê¶ÔÏóÊǾ²Ì¬µÄ£¬²¢ÇÒÇÐÃæÂß¼­µÄµ÷ÓÃÁ´Êǹ̶¨µÄ£¬Ôò¶ÔÄ¿±ê¶ÔÏóºÍÕû¸öµ÷ÓÃÁ´½øÐлº´æ + // 如果目标对象是é�™æ€�的,并且切é�¢é€»è¾‘的调用链是固定的,则对目标对象和整个调用链进行缓存 if (isStatic && isFrozen) { Method[] methods = rootClass.getMethods(); Callback[] fixedCallbacks = new Callback[methods.length]; @@ -326,22 +326,22 @@ private Callback[] getCallbacks(Class rootClass) throws Exception { for (int x = 0; x < methods.length; x++) { Method method = methods[x]; - // »ñȡĿ±ê¶ÔÏóµÄÇÐÃæÂß¼­ + // 获å�–目标对象的切é�¢é€»è¾‘ List chain = this.advised .getInterceptorsAndDynamicInterceptionAdvice(method, rootClass); fixedCallbacks[x] = new FixedChainStaticTargetInterceptor( chain, this.advised.getTargetSource().getTarget(), this.advised.getTargetClass()); - // ¶Ôµ÷ÓÃÁ´½øÐлº´æ + // 对调用链进行缓存 this.fixedInterceptorMap.put(method, x); } - // ½«Éú³ÉµÄ¾²Ì¬µ÷ÓÃÁ´´æÈëCallbackÊý×éÖÐ + // 将生æˆ�çš„é�™æ€�调用链存入Callback数组中 callbacks = new Callback[mainCallbacks.length + fixedCallbacks.length]; System.arraycopy(mainCallbacks, 0, callbacks, 0, mainCallbacks.length); System.arraycopy(fixedCallbacks, 0, callbacks, mainCallbacks.length, fixedCallbacks.length); - // ÕâÀïfixedInterceptorOffset¼Ç¼Á˵±Ç°¾²Ì¬µÄµ÷ÓÃÁ´µÄÇÐÃæÂß¼­µÄÆðʼλÖ㬠- // ÕâÀï¼Ç¼µÄÓô¦ÔÚÓÚºóÃæÊ¹ÓÃCallbackFilterµÄʱºò£¬Èç¹û·¢ÏÖÊǾ²Ì¬µÄµ÷ÓÃÁ´£¬ - // ÔòÖ±½Óͨ¹ý¸Ã²ÎÊý»ñÈ¡ÏàÓ¦µÄµ÷ÓÃÁ´£¬¶øÖ±½ÓÂÔ¹ýÁËÇ°ÃæµÄ¶¯Ì¬µ÷ÓÃÁ´ + // 这里fixedInterceptorOffset记录了当å‰�é�™æ€�的调用链的切é�¢é€»è¾‘的起始ä½�置, + // 这里记录的用处在于å�Žé�¢ä½¿ç”¨CallbackFilter的时候,如果å�‘现是é�™æ€�的调用链, + // 则直接通过该å�‚数获å�–相应的调用链,而直接略过了å‰�é�¢çš„动æ€�调用链 this.fixedInterceptorOffset = mainCallbacks.length; } else { @@ -352,13 +352,13 @@ private Callback[] getCallbacks(Class rootClass) throws Exception { ``` -ÒÔÉÏ´úÂë±È½Ï³¤£¬Ö÷Òª×÷ÓþÍÊÇ»ñÈ¡ `callback`£¬ËäÈ» spring ÌṩÁËÖÚ¶à `callback`£¬µ«ÓëÎÒÃÇ×Ô¶¨Òå֪ͨÏà¹ØµÄ callback Ö»ÓÐÒ»¸ö£º `DynamicAdvisedInterceptor`£¬ÔÚÕâ¸ö `callback` µÄ `CglibAopProxy.DynamicAdvisedInterceptor#intercept` ·½·¨ÖУ¬ÎÒÃÇÔÚ´úÂëÖеÄ×Ô¶¨Í¨Öª¾ÍÊÇÔÚÕâÀïÖ´Ðеġ£ +以上代ç �比较长,主è¦�作用就是获å�– `callback`,虽然 spring æ��供了众多 `callback`,但与我们自定义通知相关的 callback å�ªæœ‰ä¸€ä¸ªï¼š `DynamicAdvisedInterceptor`,在这个 `callback` çš„ `CglibAopProxy.DynamicAdvisedInterceptor#intercept` 方法中,我们在代ç �中的自定通知就是在这里执行的。 -ÕâÒ»²½ÎÒÃǵõ½ cglib µÄ´úÀí¶ÔÏóºó£¬½ÓÏÂÀ´¾ÍÀ´¿´¿´ÇÐÃæ·½·¨ÊÇÈçºÎÖ´Ðеġ£ +这一步我们得到 cglib 的代ç�†å¯¹è±¡å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ�¥çœ‹çœ‹åˆ‡é�¢æ–¹æ³•是如何执行的。 -### 4\. cglib ÇÐÃæ·½·¨µÄÖ´ÐÐ +### 4\. cglib 切é�¢æ–¹æ³•的执行 -cglib ÇÐÃæ·½·¨µÄÖ´ÐÐ `CglibAopProxy.DynamicAdvisedInterceptor#intercept` ·½·¨£º +cglib 切é�¢æ–¹æ³•的执行 `CglibAopProxy.DynamicAdvisedInterceptor#intercept` 方法: > `CglibAopProxy.DynamicAdvisedInterceptor#intercept` @@ -368,35 +368,35 @@ public Object intercept(Object proxy, Method method, Object[] args, MethodProxy Object oldProxy = null; boolean setProxyContext = false; Object target = null; - // ͨ¹ýTargetSource»ñȡĿ±ê¶ÔÏó + // 通过TargetSource获å�–目标对象 TargetSource targetSource = this.advised.getTargetSource(); try { - // ÅжÏÈç¹ûÐèÒª±©Â¶´úÀí¶ÔÏó£¬Ôò½«µ±Ç°´úÀí¶ÔÏóÉèÖõ½ThreadLocalÖÐ + // 判断如果需è¦�暴露代ç�†å¯¹è±¡ï¼Œåˆ™å°†å½“å‰�代ç�†å¯¹è±¡è®¾ç½®åˆ°ThreadLocal中 if (this.advised.exposeProxy) { oldProxy = AopContext.setCurrentProxy(proxy); setProxyContext = true; } target = targetSource.getTarget(); Class targetClass = (target != null ? target.getClass() : null); - // »ñȡĿ±ê¶ÔÏóÇÐÃæÂß¼­µÄµ÷ÓÃÁ´ + // 获å�–目标对象切é�¢é€»è¾‘的调用链 List chain = this.advised .getInterceptorsAndDynamicInterceptionAdvice(method, targetClass); Object retVal; if (chain.isEmpty() && Modifier.isPublic(method.getModifiers())) { Object[] argsToUse = AopProxyUtils.adaptArgumentsIfNecessary(method, args); - // ûÓÐÀ¹½ØÆ÷£¬Ö±½Óµ÷ÓÃÄ¿±ê¶ÔÏóµÄ·½·¨ + // 没有拦截器,直接调用目标对象的方法 retVal = methodProxy.invoke(target, argsToUse); } else { - // ÕâÀïÓÐÁ½¸ö²½Ö裺 - // 1\. ´´½¨Ö´ÐÐÆ÷£ºnew CglibMethodInvocation() - // 2\. Ö´ÐÐÀ¹½ØÆ÷Á´£ºCglibMethodInvocation#proceed + // 这里有两个步骤: + // 1\. 创建执行器:new CglibMethodInvocation() + // 2\. 执行拦截器链:CglibMethodInvocation#proceed retVal = new CglibMethodInvocation(proxy, target, method, args, targetClass, chain, methodProxy).proceed(); } - // ¶Ô·µ»ØÖµ½øÐд¦Àí£¬Èç¹û·µ»ØÖµ¾ÍÊǵ±Ç°Ä¿±ê¶ÔÏó£¬ÄÇô½«´úÀíÉú³ÉµÄ´úÀí¶ÔÏ󷵻أ» - // Èç¹û·µ»ØÖµÎª¿Õ£¬²¢ÇÒ·µ»ØÖµÀàÐÍÊÇ·ÇvoidµÄ»ù±¾Êý¾ÝÀàÐÍ£¬ÔòÅ׳öÒì³££» - // Èç¹ûÉÏÊöÁ½¸öÌõ¼þ¶¼²»·ûºÏ£¬ÔòÖ±½Ó½«Éú³ÉµÄ·µ»ØÖµ·µ»Ø + // 对返回值进行处ç�†ï¼Œå¦‚果返回值就是当å‰�目标对象,那么将代ç�†ç”Ÿæˆ�的代ç�†å¯¹è±¡è¿”回; + // 如果返回值为空,并且返回值类型是é�žvoid的基本数æ�®ç±»åž‹ï¼Œåˆ™æŠ›å‡ºå¼‚常; + // 如果上述两个æ�¡ä»¶éƒ½ä¸�符å�ˆï¼Œåˆ™ç›´æŽ¥å°†ç”Ÿæˆ�的返回值返回 retVal = processReturnType(proxy, target, method, retVal); return retVal; } @@ -412,7 +412,7 @@ public Object intercept(Object proxy, Method method, Object[] args, MethodProxy ``` -×îÖÕÖ´ÐÐÊÇÔÚ `new CglibMethodInvocation(proxy, target, method, args, targetClass, chain, methodProxy).proceed()`£¬¼ÌÐø¿´ÏÂÈ¥£º +最终执行是在 `new CglibMethodInvocation(proxy, target, method, args, targetClass, chain, methodProxy).proceed()`,继续看下去: > CglibAopProxy.CglibMethodInvocation#proceed @@ -428,22 +428,22 @@ public Object proceed() throws Throwable { ``` -Ö±½Óµ÷ÓõÄÊǸ¸ÀàµÄ·½·¨£¬`CglibAopProxy.CglibMethodInvocation` µÄ¸¸ÀàÊÇË­ÄØ£¿Ò»¿´ÏÂÈ¥£¬·¢ÏÖ¾¹È»ÊÇ `ReflectiveMethodInvocation`£¬`super.proceed()` µ÷ÓõÄÊÇ `ReflectiveMethodInvocation#proceed`£¡ +直接调用的是父类的方法,`CglibAopProxy.CglibMethodInvocation` 的父类是è°�呢?一看下去,å�‘现竟然是 `ReflectiveMethodInvocation`,`super.proceed()` 调用的是 `ReflectiveMethodInvocation#proceed`ï¼� -ÔÚ[ÉÏÒ» ƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4696654 "ÉÏÒ» ƪÎÄÕÂ")ÖУ¬ÎÒÃǾÍÏêϸ·ÖÎöÁË `ReflectiveMethodInvocation#proceed` µÄµ÷Óùý³Ì£¬¶øÏÖÔÚ£¬ÔÚ cglib ´úÀíÀ×îÖÕÖ´ÐеÄÒ²ÊÇͬÑùµÄ´úÂ룬ÕâÒ»¿éµÄÖ´Ðйý³Ì¾Í²»Öظ´·ÖÎöÁË¡£ +在[上一 篇文章](https://my.oschina.net/funcy/blog/4696654 "上一 篇文章")中,我们就详细分æž�了 `ReflectiveMethodInvocation#proceed` 的调用过程,而现在,在 cglib 代ç�†é‡Œï¼Œæœ€ç»ˆæ‰§è¡Œçš„也是å�Œæ ·çš„代ç �,这一å�—的执行过程就ä¸�é‡�å¤�分æž�了。 -×îºóÓÃÒ»ÕÅͼÀ´ËµÃ÷ÇÐÃæÍ¨ÖªµÄÖ´Ðйý³Ì£º +最å�Žç”¨ä¸€å¼ å›¾æ�¥è¯´æ˜Žåˆ‡é�¢é€šçŸ¥çš„æ‰§è¡Œè¿‡ç¨‹ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1c31c8e6279af4c150df18ebbd345c7f110.png) -×îÖÕµÄÖ´ÐÐ˳Ðò£º +最终的执行顺åº�: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a1f3ccebe3b7335eaef88b8a39ca36b9e05.png) -### 5\. ×ܽá +### 5\. 总结 -±¾ÎÄ·ÖÎöÁË cglib ´úÀíµÄÖ´Ðйý³Ì£¬ÇÐÃæµÄÖ´ÐÐÁ÷³ÌλÓÚ `CglibAopProxy.DynamicAdvisedInterceptor#intercept`£¬×îÖÕµ÷ÓõÄÊÇ `ReflectiveMethodInvocation#proceed`£¬ÕâÓë jdk ¶¯Ì¬´úÀíµÄÖ´ÐÐÁ÷³ÌÏàͬ¡£ +本文分æž�了 cglib 代ç�†çš„æ‰§è¡Œè¿‡ç¨‹ï¼Œåˆ‡é�¢çš„æ‰§è¡Œæµ�程ä½�于 `CglibAopProxy.DynamicAdvisedInterceptor#intercept`,最终调用的是 `ReflectiveMethodInvocation#proceed`,这与 jdk 动æ€�代ç�†çš„æ‰§è¡Œæµ�程相å�Œã€‚ * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4696655](https://my.oschina.net/funcy/blog/4696655) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4696655](https://my.oschina.net/funcy/blog/4696655) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\205\255\357\274\211\357\274\232aop\346\200\273\347\273\223.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\205\255\357\274\211\357\274\232aop\346\200\273\347\273\223.md" index 041e629..89395ba 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\205\255\357\274\211\357\274\232aop\346\200\273\347\273\223.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\205\255\357\274\211\357\274\232aop\346\200\273\347\273\223.md" @@ -1,22 +1,22 @@ -Ç°Ãæ¼¸ÆªÎÄÕÂÎÒÃÇ·ÖÎöÁË spring aop µÄÏà¹Ø´úÂ룬ÕâÀïÀ´×ö¸ö×ܽᡣ +å‰�é�¢å‡ ç¯‡æ–‡ç« æˆ‘们分æž�了 spring aop 的相关代ç �,这里æ�¥å�šä¸ªæ€»ç»“。 -### 1\. spring ÆôÓà aop ¹¦ÄÜ +### 1\. spring å�¯ç”¨ aop 功能 -ÔÚ [spring aop£¨Ò»£©£ºÊ¾Àý demo ¼° @EnableAspectJAutoProxy](https://my.oschina.net/funcy/blog/4678093 "spring aop£¨Ò»£©£ºÊ¾Àý demo ¼° @EnableAspectJAutoProxy") Ò»ÎÄÖУ¬ÎÒÃÇ·ÖÎöÁË spring ͨ¹ý `@EnableAspectJAutoProxy` ×¢½âÆôÓà aop ¹¦ÄÜ£¬¶øÕâ¸ö×¢½âʵ¼ÊÉÏÊÇÏò spring Öе¼ÈëÁË `AnnotationAwareAspectJAutoProxyCreator`£¬¶øÕâ¸öÀàÊÇÒ»¸ö `BeanPostProcessor`£¬×îÖÕÔÚ bean ³õʼ»¯Ç°ºóÍê³É´úÀí¶ÔÏóµÄÉú³É¡£ +在 [spring aop(一):示例 demo å�Š @EnableAspectJAutoProxy](https://my.oschina.net/funcy/blog/4678093 "spring aop(一):示例 demo å�Š @EnableAspectJAutoProxy") 一文中,我们分æž�了 spring 通过 `@EnableAspectJAutoProxy` 注解å�¯ç”¨ aop 功能,而这个注解实际上是å�‘ spring 中导入了 `AnnotationAwareAspectJAutoProxyCreator`,而这个类是一个 `BeanPostProcessor`,最终在 bean åˆ�始化å‰�å�Žå®Œæˆ�代ç�†å¯¹è±¡çš„生æˆ�。 -### 2\. ´úÀí¶ÔÏóµÄÉú³É +### 2\. 代ç�†å¯¹è±¡çš„生æˆ� -spring aop »ùÓÚ×¢½â·½Ê½µÄʵÏÖÊÇͨ¹ý `AnnotationAwareAspectJAutoProxyCreator` ÀàÀ´²Ù×÷µÄ£¬Õâ¸öÀàÊÇÒ»¸ö `BeanPostProcessor`£¬ÔÚ bean µÄ³õʼ»¯Ç°ºóÖ´ÐеIJÙ×÷ÈçÏ£º +spring aop 基于注解方å¼�的实现是通过 `AnnotationAwareAspectJAutoProxyCreator` ç±»æ�¥æ“�作的,这个类是一个 `BeanPostProcessor`,在 bean çš„åˆ�始化å‰�å�Žæ‰§è¡Œçš„æ“�作如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c634a0bda86d94cce68aaa46ac74f57d41d.png) -### 3\. ÇÐÃæ·½·¨µÄÖ´ÐÐ +### 3\. 切é�¢æ–¹æ³•的执行 -µ±µ÷ÓôúÀí¶ÔÏóµÄ·½·¨£¬jdk »á¸ù¾Ý´úÀíµÄÀàÐͶøÑ¡ÔñÖ´ÐÐ `InvocationHandler#invoke`(jdk ¶¯Ì¬´úÀí) »¹ÊÇ `MethodInterceptor#intercept`(cglib ´úÀí)£¬ÕâÒ»²½ÔÚ´´½¨´úÀí¶ÔÏóʱ£¬ÒѾ­Óë´úÀí¶ÔÏó½áºÏÁË£¬¿ª·¢ÕßÎÞ·¨¸ÉÉæµ÷ÓÃÄĸö·½·¨£¬²»¹ýÕâÁ½¸ö·½·¨ÀïµÄÄÚÈÝ¿ª·¢Õß¿ÉÒÔ×ÔÓÉ·¢»Ó¡£ÔÚÕâÁ½¸ö·½·¨ÖУ¬spring »á»ñÈ¡¿ÉÓÃÓõ±Ç°·½·¨µÄËùÓÐ Advisors£¬È»ºóÖ´ÐÐ Advisors ÀïµÄÇÐÃæ·½·¨£¬Õû¸ö¹ý³ÌÈçÏ£º +当调用代ç�†å¯¹è±¡çš„æ–¹æ³•,jdk 会根æ�®ä»£ç�†çš„类型而选择执行 `InvocationHandler#invoke`(jdk 动æ€�代ç�†) 还是 `MethodInterceptor#intercept`(cglib 代ç�†),这一步在创建代ç�†å¯¹è±¡æ—¶ï¼Œå·²ç»�与代ç�†å¯¹è±¡ç»“å�ˆäº†ï¼Œå¼€å�‘者无法干涉调用哪个方法,ä¸�过这两个方法里的内容开å�‘者å�¯ä»¥è‡ªç”±å�‘挥。在这两个方法中,spring 会获å�–å�¯ç”¨ç”¨å½“å‰�方法的所有 Advisors,然å�Žæ‰§è¡Œ Advisors 里的切é�¢æ–¹æ³•,整个过程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-96bb9ba4b77e60a85a1da1c2cec3858edf7.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-013fb0c06e03fbe5044c211497df8ce306a.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4701587](https://my.oschina.net/funcy/blog/4701587) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ +_本文原文链接:[https://my.oschina.net/funcy/blog/4701587](https://my.oschina.net/funcy/blog/4701587) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\233\233\357\274\211\357\274\232jdk\345\212\250\346\200\201\344\273\243\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\233\233\357\274\211\357\274\232jdk\345\212\250\346\200\201\344\273\243\347\220\206.md" index c2965a5..f5b725a 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\233\233\357\274\211\357\274\232jdk\345\212\250\346\200\201\344\273\243\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/SpringAOP/SpringAop\357\274\210\345\233\233\357\274\211\357\274\232jdk\345\212\250\346\200\201\344\273\243\347\220\206.md" @@ -1,10 +1,10 @@ -ÉÏһƪÎÄÕµÄ×îºó£¬ÎÒÃÇ·ÖÎöµ½ spring ÖÕÓÚ´´½¨ÁË´úÀí¶ÔÏ󣬯äÖдúÀí¶ÔÏóµÄ·½Ê½Îª `jdk¶¯Ì¬´úÀí`Óë `cglib´úÀí`£¬±¾ÎÄÎÒÃǽ«·ÖÎö spring µÄ¶¯Ì¬´úÀí¡£ +上一篇文章的最å�Žï¼Œæˆ‘们分æž�到 spring 终于创建了代ç�†å¯¹è±¡ï¼Œå…¶ä¸­ä»£ç�†å¯¹è±¡çš„æ–¹å¼�为 `jdk动æ€�代ç�†`与 `cglib代ç�†`,本文我们将分æž� spring 的动æ€�代ç�†ã€‚ -### 1. jdk ¶¯Ì¬´úÀí½éÉÜ +### 1. jdk 动æ€�代ç�†ä»‹ç»� -À´·ÖÎö spring µÄ¶¯Ì¬´úÀíǰ£¬ÎÒÃÇÏÈÀ´Á˽âÏ jdk µÄ¶¯Ì¬´úÀí¡£jdk ¶¯Ì¬´úÀíÐèÒª½Ó¿Ú£¬Îª´ËÎÒÃÇÏÈ×¼±¸Á½¸ö½Ó¿Ú£º +æ�¥åˆ†æž� spring 的动æ€�代ç�†å‰�,我们先æ�¥äº†è§£ä¸‹ jdk 的动æ€�代ç�†ã€‚jdk 动æ€�代ç�†éœ€è¦�接å�£ï¼Œä¸ºæ­¤æˆ‘们先准备两个接å�£ï¼š > IJdkDynamicProxy01 @@ -26,7 +26,7 @@ public interface IJdkDynamicProxy02 { } ``` -ÔÙÀ´×¼±¸Á½¸öʵÏÖÀࣺ +å†�æ�¥å‡†å¤‡ä¸¤ä¸ªå®žçŽ°ç±»ï¼š > JdkDynamicProxyImpl01 @@ -61,9 +61,9 @@ public class JdkDynamicProxyImpl02 implements IJdkDynamicProxy01 { } ``` -ÕâÀïÐèҪעÒâµÄÊÇ£¬`JdkDynamicProxyImpl01` ʵÏÖÁË `IJdkDynamicProxy01` Óë `IJdkDynamicProxy02` Á½¸ö½Ó¿Ú£¬`JdkDynamicProxyImpl02` ֻʵÏÖÁË `IJdkDynamicProxy01` Ò»¸ö ½Ó¿Ú¡£ +这里需è¦�注æ„�的是,`JdkDynamicProxyImpl01` 实现了 `IJdkDynamicProxy01` 与 `IJdkDynamicProxy02` 两个接å�£ï¼Œ`JdkDynamicProxyImpl02` å�ªå®žçŽ°äº† `IJdkDynamicProxy01` 一个 接å�£ã€‚ -½Ó×Å×¼±¸Ò»¸ö `InvocationHandler`: +接ç�€å‡†å¤‡ä¸€ä¸ª `InvocationHandler`: > MyInvocationHandler @@ -75,7 +75,7 @@ import java.lang.reflect.Method; public class MyInvocationHandler implements InvocationHandler { - /** Ä¿±ê¶ÔÏó */ + /** 目标对象 */ private Object target; public MyInvocationHandler(Object target){ @@ -84,8 +84,8 @@ public class MyInvocationHandler implements InvocationHandler { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { - System.out.println("Ö´Ðз½·¨Îª:" + method.getName()); - // ·½·¨µÄÕæÕýÖ´ÐÐÔÚÕâÀï + System.out.println("执行方法为:" + method.getName()); + // 方法的真正执行在这里 Object rs = method.invoke(target,args); return rs; } @@ -93,7 +93,7 @@ public class MyInvocationHandler implements InvocationHandler { } ``` -×îºóÊÇÖ÷Àà: +最å�Žæ˜¯ä¸»ç±»: ```java package org.springframework.learn.demo03; @@ -106,85 +106,85 @@ public class Demo03Main { System.out.println("------------bean01------------"); JdkDynamicProxyImpl01 bean01 = new JdkDynamicProxyImpl01(); Object obj1 = Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), - // JdkDynamicProxyImpl01ʵÏÖÁË IJdkDynamicProxy01, IJdkDynamicProxy02 - // ´«ÈëµÄclassΪ IJdkDynamicProxy01, IJdkDynamicProxy02 + // JdkDynamicProxyImpl01实现了 IJdkDynamicProxy01, IJdkDynamicProxy02 + // 传入的class为 IJdkDynamicProxy01, IJdkDynamicProxy02 new Class[]{ IJdkDynamicProxy01.class, IJdkDynamicProxy02.class }, new MyInvocationHandler(bean01)); - // ¿ÉÒÔ½øÐÐÀàÐÍÇ¿ÖÆ×ª»» + // å�¯ä»¥è¿›è¡Œç±»åž‹å¼ºåˆ¶è½¬æ�¢ ((IJdkDynamicProxy01) obj1).hello01(); ((IJdkDynamicProxy02) obj1).hello02(); System.out.println("------------bean01------------"); Object obj2 = Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), - // JdkDynamicProxyImpl01ʵÏÖÁË IJdkDynamicProxy01, IJdkDynamicProxy02 - // ´«ÈëµÄclassΪ IJdkDynamicProxy01 + // JdkDynamicProxyImpl01实现了 IJdkDynamicProxy01, IJdkDynamicProxy02 + // 传入的class为 IJdkDynamicProxy01 new Class[]{ IJdkDynamicProxy01.class }, new MyInvocationHandler(bean01)); ((IJdkDynamicProxy01) obj2).hello01(); - // ±¨Òì³££ºjava.lang.ClassCastException: class com.sun.proxy.$Proxy1 cannot be cast to class xxx + // 报异常:java.lang.ClassCastException: class com.sun.proxy.$Proxy1 cannot be cast to class xxx //((IJdkDynamicProxy02) obj2).hello02(); System.out.println("-----------bean02-------------"); JdkDynamicProxyImpl02 bean02 = new JdkDynamicProxyImpl02(); Object obj3 = Proxy.newProxyInstance(Thread.currentThread().getContextClassLoader(), - // JdkDynamicProxyImpl01ʵÏÖÁË IJdkDynamicProxy01 - // ´«ÈëµÄclassΪ IJdkDynamicProxy01, IJdkDynamicProxy02 + // JdkDynamicProxyImpl01实现了 IJdkDynamicProxy01 + // 传入的class为 IJdkDynamicProxy01, IJdkDynamicProxy02 new Class[]{ IJdkDynamicProxy01.class, IJdkDynamicProxy02.class }, new MyInvocationHandler(bean02)); ((IJdkDynamicProxy01) obj3).hello01(); IJdkDynamicProxy02 proxy02 = (IJdkDynamicProxy02) obj3; - // ±¨Òì³££ºjava.lang.IllegalArgumentException: object is not an instance of declaring class + // 报异常:java.lang.IllegalArgumentException: object is not an instance of declaring class //proxy02.hello02(); } } ``` -ÔËÐнá¹û£º +è¿�行结果: ``` -Ö´Ðз½·¨Îª:hello01 +执行方法为:hello01 hello01 -Ö´Ðз½·¨Îª:hello02 +执行方法为:hello02 hello02 ------------bean01------------ -Ö´Ðз½·¨Îª:hello01 +执行方法为:hello01 hello01 -----------bean02------------- -Ö´Ðз½·¨Îª:hello01 +执行方法为:hello01 hello01 ``` -¶Ô½á¹û·ÖÎöÈçÏ£º +对结果分æž�如下: -1. `Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)` µÄµÚ¶þ¸ö²ÎÊý´«ÈëµÄ½Ó¿Ú£¬ÉùÃ÷µÄÊÇ´úÀí¶ÔÏóËùÊôµÄ½Ó¿ÚÀàÐÍ£¬µÚÈý¸ö²ÎÊýÊÇÖ´ÐÐÆ÷£¬´úÀíÀà¶ÔÏóµÄÖ´ÐÐΪÆä `invoke()` ·½·¨£» -2. `JdkDynamicProxyImpl01` ͬʱʵÏÖÁË `IJdkDynamicProxy01` Óë `IJdkDynamicProxy02` ½Ó¿Ú£¬µ«´«Èë½Ó¿ÚÀàÐÍʱ£¬Ö»´«ÈëÁË `IJdkDynamicProxy01`£¬µ±´úÀí¶ÔÏó obj2 ǿתΪ `IJdkDynamicProxy02` ʱ£¬¾Í»á±¨ `ClassCastException`£¬Ç¿×ªÊ§°Ü£¬Õâ±íÃ÷ `Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)` ÉùÃ÷µÄÊÇ´úÀí¶ÔÏóËùÊôµÄ½Ó¿ÚÀàÐÍ£» -3. `JdkDynamicProxyImpl02` ֻʵÏÖÁË `IJdkDynamicProxy01` ½Ó¿Ú£¬µ«´«Èë½Ó¿ÚÀàÐÍʱ£¬´«ÈëÁË `IJdkDynamicProxy01` Óë `IJdkDynamicProxy02`£¬µ±´úÀí¶ÔÏó `obj3` ǿתΪ `IJdkDynamicProxy02` ʱ£¬²¢Î´±¨Òì³££¬µ«ÊÇÔÚÖ´ÐÐ `proxy02.hello02()` ʱ£¬È´±¨ÁË `java.lang.IllegalArgumentException: object is not an instance of declaring class`£¬Í¬Ñù±íÃ÷ÁË `Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)` ÉùÃ÷µÄÊÇ´úÀí¶ÔÏóËùÊôµÄ½Ó¿ÚÀàÐÍ£¬¸úÄ¿±ê¶ÔÏóµÄÀàÐÍÎ޹ء£ +1. `Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)` 的第二个å�‚数传入的接å�£ï¼Œå£°æ˜Žçš„æ˜¯ä»£ç�†å¯¹è±¡æ‰€å±žçš„æŽ¥å�£ç±»åž‹ï¼Œç¬¬ä¸‰ä¸ªå�‚数是执行器,代ç�†ç±»å¯¹è±¡çš„æ‰§è¡Œä¸ºå…¶ `invoke()` 方法; +2. `JdkDynamicProxyImpl01` å�Œæ—¶å®žçŽ°äº† `IJdkDynamicProxy01` 与 `IJdkDynamicProxy02` 接å�£ï¼Œä½†ä¼ å…¥æŽ¥å�£ç±»åž‹æ—¶ï¼Œå�ªä¼ å…¥äº† `IJdkDynamicProxy01`,当代ç�†å¯¹è±¡ obj2 强转为 `IJdkDynamicProxy02` 时,就会报 `ClassCastException`,强转失败,这表明 `Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)` 声明的是代ç�†å¯¹è±¡æ‰€å±žçš„æŽ¥å�£ç±»åž‹ï¼› +3. `JdkDynamicProxyImpl02` å�ªå®žçŽ°äº† `IJdkDynamicProxy01` 接å�£ï¼Œä½†ä¼ å…¥æŽ¥å�£ç±»åž‹æ—¶ï¼Œä¼ å…¥äº† `IJdkDynamicProxy01` 与 `IJdkDynamicProxy02`,当代ç�†å¯¹è±¡ `obj3` 强转为 `IJdkDynamicProxy02` 时,并未报异常,但是在执行 `proxy02.hello02()` 时,å�´æŠ¥äº† `java.lang.IllegalArgumentException: object is not an instance of declaring class`,å�Œæ ·è¡¨æ˜Žäº† `Proxy#newProxyInstance(ClassLoader, Class[], InvocationHandler)` 声明的是代ç�†å¯¹è±¡æ‰€å±žçš„æŽ¥å�£ç±»åž‹ï¼Œè·Ÿç›®æ ‡å¯¹è±¡çš„类型无关。 -### 2. ÔٴηÖÎö spring jdk ¶¯Ì¬´úÀí¶ÔÏóµÄ´´½¨ +### 2. å†�次分æž� spring jdk 动æ€�代ç�†å¯¹è±¡çš„创建 -ÓÐÁËÉÏÃæµÄ·ÖÎö£¬ÎÒÃÇÔÙÀ´¿´¿´ spring ÊÇÈçºÎ´´½¨´úÀí¶ÔÏóµÄ£º +有了上é�¢çš„分æž�,我们å†�æ�¥çœ‹çœ‹ spring 是如何创建代ç�†å¯¹è±¡çš„: ```java @Override public Object getProxy(@Nullable ClassLoader classLoader) { - // »ñȡĿ±ê¶ÔÏóʵÏÖµÄ½Ó¿Ú + // 获å�–目标对象实现的接å�£ Class[] proxiedInterfaces = AopProxyUtils.completeProxiedInterfaces(this.advised, true); - // ÊÇ·ñÓÐequals()ÓëhashCode()·½·¨ + // 是å�¦æœ‰equals()与hashCode()方法 findDefinedEqualsAndHashCodeMethods(proxiedInterfaces); - // µ÷Óà jdk ·½·¨ ´´½¨¶ÔÏó + // 调用 jdk 方法 创建对象 return Proxy.newProxyInstance(classLoader, proxiedInterfaces, this); } ``` -1. ´«ÈëµÄ½Ó¿ÚΪ `proxiedInterfaces`£¬Õâ¸öÖµ°üº¬ÁËÄ¿±êÀàʵÏÖµÄËùÓнӿڣ¬Í¬Ê± spring Ò²»áÌí¼Ó×ÔÉíµÄ½Ó¿Ú£¬Èç `SpringProxy`¡¢`Advised`£¬ÕâЩÔÚÉÏһƪÎÄÕÂÒѾ­Ïêϸ·ÖÎö¹ýÁË£» -2. Ö¸¶¨ `InvocationHandler` Ϊ `this`£¬Ò²¾ÍÊÇ `JdkDynamicAopProxy` µÄ¶ÔÏó£¬Êµ¼ÊÉÏ `JdkDynamicAopProxy` ʵÏÖÁË `InvocationHandler`. +1. 传入的接å�£ä¸º `proxiedInterfaces`,这个值包å�«äº†ç›®æ ‡ç±»å®žçŽ°çš„æ‰€æœ‰æŽ¥å�£ï¼Œå�Œæ—¶ spring 也会添加自身的接å�£ï¼Œå¦‚ `SpringProxy`ã€�`Advised`,这些在上一篇文章已ç»�详细分æž�过了; +2. 指定 `InvocationHandler` 为 `this`,也就是 `JdkDynamicAopProxy` 的对象,实际上 `JdkDynamicAopProxy` 实现了 `InvocationHandler`. -ÓɵÚÒ»²¿·ÖµÄ·ÖÎö¿ÉÖª£¬jdk ¶¯Ì¬´úÀí¶ÔÏóµÄ·½·¨×îÖÕÊÇÔÚ `java.lang.reflect.InvocationHandler#invoke` ÖÐÖ´Ðеģ¬Ò²¾ÍÊÇ `JdkDynamicAopProxy#invoke`£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎö `JdkDynamicAopProxy#invoke` ·½·¨£¬À´¿´¿´ spring ÊÇÈçºÎÖ´ÐдúÀí·½·¨µÄ¡£ +由第一部分的分æž�å�¯çŸ¥ï¼Œjdk 动æ€�代ç�†å¯¹è±¡çš„æ–¹æ³•最终是在 `java.lang.reflect.InvocationHandler#invoke` 中执行的,也就是 `JdkDynamicAopProxy#invoke`,接下æ�¥æˆ‘们就æ�¥åˆ†æž� `JdkDynamicAopProxy#invoke` 方法,æ�¥çœ‹çœ‹ spring 是如何执行代ç�†æ–¹æ³•的。 -### 3. jdk ¶¯Ì¬´úÀí·½·¨µÄÖ´ÐÐ +### 3. jdk 动æ€�代ç�†æ–¹æ³•的执行 -spring jdk ¶¯Ì¬´úÀí·½·¨µÄÖ´ÐÐÔÚ `JdkDynamicAopProxy#invoke`£º +spring jdk 动æ€�代ç�†æ–¹æ³•的执行在 `JdkDynamicAopProxy#invoke`: > JdkDynamicAopProxy#invoke @@ -197,15 +197,15 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl Object target = null; try { - // ÈôÖ´ÐÐµÄ equals ·½·¨£¬²»ÐèÒª´úÀíÖ´ÐÐ + // 若执行的 equals 方法,ä¸�需è¦�代ç�†æ‰§è¡Œ if (!this.equalsDefined && AopUtils.isEqualsMethod(method)) { return equals(args[0]); } - // ÈôÖ´ÐÐµÄ hashCode ·½·¨£¬²»ÐèÒª´úÀíÖ´ÐÐ + // 若执行的 hashCode 方法,ä¸�需è¦�代ç�†æ‰§è¡Œ else if (!this.hashCodeDefined && AopUtils.isHashCodeMethod(method)) { return hashCode(); } - // Èç¹ûÖ´ÐеÄclass¶ÔÏóÊÇDecoratingProxy£¬Ò²²»ÐèÒª´úÀíÖ´ÐÐ + // 如果执行的class对象是DecoratingProxy,也ä¸�需è¦�代ç�†æ‰§è¡Œ else if (method.getDeclaringClass() == DecoratingProxy.class) { return AopProxyUtils.ultimateTargetClass(this.advised); } @@ -216,33 +216,33 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl Object retVal; - // ÅÐ¶Ï advisedµÄexposeProxy ÖµÊÇ·ñΪ true - // advisedµÄexposeProxyÀ´Ô´ÓÚ @EnableAspectJAutoProxy µÄ exposeProxy - // ¼´ ÏñÕâÑùÖ¸¶¨Ê±£¬@EnableAspectJAutoProxy(exposeProxy = true)£¬ÒÔÏ´úÂëÖ´ÐÐ + // 判断 advisedçš„exposeProxy 值是å�¦ä¸º true + // advisedçš„exposeProxyæ�¥æº�于 @EnableAspectJAutoProxy çš„ exposeProxy + // å�³ åƒ�这样指定时,@EnableAspectJAutoProxy(exposeProxy = true),以下代ç �执行 if (this.advised.exposeProxy) { - // ½«µ±Ç°µÄ proxy ¶ÔÏó·Åµ½ threadLocal ÖÐ - // ºóÐø¿ÉÒÔ (UserService (AopContext.currentProxy)).getUser() ·½Ê½µ÷Óà + // 将当å‰�çš„ proxy 对象放到 threadLocal 中 + // å�Žç»­å�¯ä»¥ (UserService (AopContext.currentProxy)).getUser() æ–¹å¼�调用 oldProxy = AopContext.setCurrentProxy(proxy); setProxyContext = true; } - // »ñȡĿ±ê¶ÔÏó¼°Ä¿±ê¶ÔÏóµÄclass + // 获å�–目标对象å�Šç›®æ ‡å¯¹è±¡çš„class target = targetSource.getTarget(); Class targetClass = (target != null ? target.getClass() : null); - // ½« aop µÄ advisor ת»¯ÎªÀ¹½ØÆ÷£¬ÔÚÕâÀïÅжϸ÷½·¨¿ÉÒÔʹÓÃÄÄЩÇÐÃæ·½·¨ + // å°† aop çš„ advisor 转化为拦截器,在这里判断该方法å�¯ä»¥ä½¿ç”¨å“ªäº›åˆ‡é�¢æ–¹æ³• List chain = this.advised.getInterceptorsAndDynamicInterceptionAdvice( method, targetClass); if (chain.isEmpty()) { - // Èç¹û¼ÓÈëµÄÀ¹½ØÆ÷Á´Îª¿Õ£¬±íÃ÷¸Ã·½·¨Ã»Óб»À¹½Ø£¬Í¨¹ý·´ÉäÖ±½ÓÖ´ÐÐ + // 如果加入的拦截器链为空,表明该方法没有被拦截,通过å��射直接执行 Object[] argsToUse = AopProxyUtils.adaptArgumentsIfNecessary(method, args); retVal = AopUtils.invokeJoinpointUsingReflection(target, method, argsToUse); } else { - // ´´½¨Ò»¸ö·½·¨µ÷ÓöÔÏó + // 创建一个方法调用对象 MethodInvocation invocation = new ReflectiveMethodInvocation(proxy, target, method, args, targetClass, chain); - // µ÷ÓÃÖ´ÐУ¬Öصã + // 调用执行,é‡�点 retVal = invocation.proceed(); } @@ -268,28 +268,28 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl } ``` -ÒÔÉÏ·½·¨Á÷³ÌÈçÏ£º +以上方法æµ�程如下: -1. ÅжÏÒªÖ´Ðеķ½·¨ÊÇ·ñΪ `equals`¡¢`hashcode` µÈ£¬ÕâЩ·½·¨²»ÐèÒª´úÀí£» -2. »ñÈ¡¿ÉÓÃÓÚÒªÖ´Ðеķ½·¨µÄËùÓÐÇÐÃæ·½·¨£¬µÃµ½Ò»¸öÀ¹½ØÆ÷¼¯ºÏ£» -3. µ÷ÓÃÇÐÃæ·½·¨¼¯ºÏÓë¼°Ä¿±ê·½·¨¡£ +1. 判断è¦�执行的方法是å�¦ä¸º `equals`ã€�`hashcode` 等,这些方法ä¸�需è¦�代ç�†ï¼› +2. 获å�–å�¯ç”¨äºŽè¦�执行的方法的所有切é�¢æ–¹æ³•,得到一个拦截器集å�ˆï¼› +3. 调用切é�¢æ–¹æ³•集å�ˆä¸Žå�Šç›®æ ‡æ–¹æ³•。 -ÕâÀïÎÒÃÇÖØµã¹Ø×¢ÇÐÃæ·½·¨ÓëÄ¿±ê·½·¨µÄÖ´ÐУ¬¹Ø¼ü´úÂëÈçÏ£º +这里我们é‡�点关注切é�¢æ–¹æ³•与目标方法的执行,关键代ç �如下: ```java -// ½« aop µÄ advisor ת»¯ÎªÀ¹½ØÆ÷£¬ÔÚÕâÀïÅжϸ÷½·¨¿ÉÒÔʹÓÃÄÄЩÇÐÃæ·½·¨ +// å°† aop çš„ advisor 转化为拦截器,在这里判断该方法å�¯ä»¥ä½¿ç”¨å“ªäº›åˆ‡é�¢æ–¹æ³• List chain = this.advised.getInterceptorsAndDynamicInterceptionAdvice( method, targetClass); -// ´´½¨Ò»¸ö·½·¨µ÷ÓöÔÏó +// 创建一个方法调用对象 MethodInvocation invocation = new ReflectiveMethodInvocation(proxy, target, method, args, targetClass, chain); -// µ÷ÓÃÖ´ÐУ¬Öصã +// 调用执行,é‡�点 retVal = invocation.proceed(); ``` -#### »ñÈ¡ `MethodInterceptor` +#### 获å�– `MethodInterceptor` -ÔÚ·ÖÎö·½·¨µÄÖ´ÐÐǰ£¬ÎÒÃÇÏÈÀ´¿´¿´ `getInterceptorsAndDynamicInterceptionAdvice(...)`£¬Õâ¸ö·½·¨ÊÇÓÃÀ´»ñȡִÐеÄÇÐÃæ·½·¨µÄ£¬Ò²¾ÍÊÇ `MethodInterceptor`£º +在分æž�方法的执行å‰�,我们先æ�¥çœ‹çœ‹ `getInterceptorsAndDynamicInterceptionAdvice(...)`,这个方法是用æ�¥èŽ·å�–执行的切é�¢æ–¹æ³•的,也就是 `MethodInterceptor`: > AdvisedSupport#getInterceptorsAndDynamicInterceptionAdvice @@ -299,7 +299,7 @@ public List getInterceptorsAndDynamicInterceptionAdvice(Method method, MethodCacheKey cacheKey = new MethodCacheKey(method); List cached = this.methodCache.get(cacheKey); if (cached == null) { - // ÔÚÕâ¸ö·½·¨Àï¼ÌÐø»ñÈ¡£¬ÏÂÃæ»áÔÙ·ÖÎö + // 在这个方法里继续获å�–,下é�¢ä¼šå†�分æž� cached = this.advisorChainFactory.getInterceptorsAndDynamicInterceptionAdvice( this, method, targetClass); this.methodCache.put(cacheKey, cached); @@ -308,27 +308,27 @@ public List getInterceptorsAndDynamicInterceptionAdvice(Method method, } ``` -¼ÌÐø£¬ +继续, ```java /** - * »ñÈ¡ Interceptor£¬¹ý³ÌÈçÏ£º + * 获å�– Interceptor,过程如下: */ @Override public List getInterceptorsAndDynamicInterceptionAdvice( Advised config, Method method, @Nullable Class targetClass) { AdvisorAdapterRegistry registry = GlobalAdvisorAdapterRegistry.getInstance(); - // »ñÈ¡ advisors£¬aopµÄadvisorsÈçÏ£º + // 获å�– advisors,aopçš„advisors如下: Advisor[] advisors = config.getAdvisors(); List interceptorList = new ArrayList<>(advisors.length); Class actualClass = (targetClass != null ? targetClass : method.getDeclaringClass()); Boolean hasIntroductions = null; for (Advisor advisor : advisors) { - // Èç¹ûadvisorÊÇPointcutAdvisor£¬ÔòʹÓÃPointcutAdvisorÀïµÄPointcut½øÐÐÆ¥Åä + // 如果advisor是PointcutAdvisor,则使用PointcutAdvisor里的Pointcut进行匹é…� if (advisor instanceof PointcutAdvisor) { PointcutAdvisor pointcutAdvisor = (PointcutAdvisor) advisor; - // ÕâÀïÅжÏÇÐÃæÂß¼­µÄµ÷ÓÃÁ´ÊÇ·ñÌáǰ½øÐйý¹ýÂË£¬Èç¹û½øÐйý£¬Ôò²»ÔÙ½øÐÐÄ¿±ê·½·¨µÄÆ¥Å䣬 - // Èç¹ûûÓУ¬ÔòÔÙ½øÐÐÒ»´ÎÆ¥Åä¡£ + // 这里判断切é�¢é€»è¾‘的调用链是å�¦æ��å‰�进行过过滤,如果进行过,则ä¸�å†�进行目标方法的匹é…�, + // 如果没有,则å†�进行一次匹é…�。 if (config.isPreFiltered() || pointcutAdvisor.getPointcut().getClassFilter().matches(actualClass)) { MethodMatcher mm = pointcutAdvisor.getPointcut().getMethodMatcher(); @@ -344,11 +344,11 @@ public List getInterceptorsAndDynamicInterceptionAdvice( match = mm.matches(method, actualClass); } if (match) { - // ½«Advisor¶ÔÏóת»»ÎªMethodInterceptorÊý×é + // å°†Advisor对象转æ�¢ä¸ºMethodInterceptor数组 MethodInterceptor[] interceptors = registry.getInterceptors(advisor); if (mm.isRuntime()) { for (MethodInterceptor interceptor : interceptors) { - // ½« interceptorÓëmethodMatcher°ü×°³ÉInterceptorAndDynamicMethodMatcher + // å°† interceptor与methodMatcher包装æˆ�InterceptorAndDynamicMethodMatcher interceptorList.add(new InterceptorAndDynamicMethodMatcher(interceptor, mm)); } } @@ -359,7 +359,7 @@ public List getInterceptorsAndDynamicInterceptionAdvice( } } else if (advisor instanceof IntroductionAdvisor) { - // ÅжÏÈç¹ûΪIntroductionAdvisorÀàÐ͵ÄAdvisor£¬Ôò½«µ÷ÓÃÁ´·âװΪInterceptorÊý×é + // 判断如果为IntroductionAdvisor类型的Advisor,则将调用链å°�装为Interceptor数组 IntroductionAdvisor ia = (IntroductionAdvisor) advisor; if (config.isPreFiltered() || ia.getClassFilter().matches(actualClass)) { Interceptor[] interceptors = registry.getInterceptors(advisor); @@ -367,9 +367,9 @@ public List getInterceptorsAndDynamicInterceptionAdvice( } } else { - // ÕâÀïÊÇÌṩµÄʹÓÃ×Ô¶¨ÒåµÄת»»Æ÷¶ÔAdvisor½øÐÐת»»µÄÂß¼­£¬ÒòΪgetInterceptors()·½·¨ÖÐ - // »áʹÓÃÏàÓ¦µÄAdapter¶ÔÄ¿±êAdvisor½øÐÐÆ¥Å䣬Èç¹ûÄÜÆ¥ÅäÉÏ£¬Í¨¹ýÆägetInterceptor()·½·¨ - // ½«×Ô¶¨ÒåµÄAdviceת»»ÎªMethodInterceptor¶ÔÏó + // 这里是æ��供的使用自定义的转æ�¢å™¨å¯¹Advisor进行转æ�¢çš„逻辑,因为getInterceptors()方法中 + // 会使用相应的Adapter对目标Advisor进行匹é…�,如果能匹é…�上,通过其getInterceptor()方法 + // 将自定义的Advice转æ�¢ä¸ºMethodInterceptor对象 Interceptor[] interceptors = registry.getInterceptors(advisor); interceptorList.addAll(Arrays.asList(interceptors)); } @@ -378,11 +378,11 @@ public List getInterceptorsAndDynamicInterceptionAdvice( } ``` -ÎÒÃǸù¾ÝÒÔÉÏ·½·¨À´×ܽáÏ»ñÈ¡ `MethodInterceptor` µÄ¹ý³Ì¹ý³ÌÈçÏ£º +我们根æ�®ä»¥ä¸Šæ–¹æ³•æ�¥æ€»ç»“下获å�– `MethodInterceptor` 的过程过程如下: -1. »ñÈ¡ÏîÄ¿ÖÐËùÓÐµÄ `advisors` +1. 获å�–项目中所有的 `advisors` -2. ±éÀú£¬¶Ôÿ¸ö +2. é��历,对æ¯�个 @@ -392,19 +392,19 @@ public List getInterceptorsAndDynamicInterceptionAdvice( -¼ÌÐø°´ÒÔÏÂÁ÷³Ì´¦Àí£º +继续按以下æµ�程处ç�†ï¼š -1. Èç¹û `advisor` ÊÇ `PointcutAdvisor`£¬ÔòʹÓÃÆäÖÐµÄ `Pointcut` ½øÐÐÆ¥Å䣬ƥÅä³É¹¦ºó£¬»ñÈ¡ `MethodInterceptor` ·µ»Ø£» -2. Èç¹û `advisor` ÊÇ `IntroductionAdvisor`£¬ÔòʹÓÃÆäÖÐµÄ `ClassFilter` ½øÐÐÆ¥Å䣬ƥÅä³É¹¦ºó£¬»ñÈ¡ `MethodInterceptor` ·µ»Ø£» -3. Èç¹ûÒÔÉÏÌõ¼þ²»Âú×㣬ֱ½Ó»ñÈ¡ `MethodInterceptor` ·µ»Ø£» +1. 如果 `advisor` 是 `PointcutAdvisor`,则使用其中的 `Pointcut` 进行匹é…�,匹é…�æˆ�功å�Žï¼ŒèŽ·å�– `MethodInterceptor` 返回; +2. 如果 `advisor` 是 `IntroductionAdvisor`,则使用其中的 `ClassFilter` 进行匹é…�,匹é…�æˆ�功å�Žï¼ŒèŽ·å�– `MethodInterceptor` 返回; +3. 如果以上æ�¡ä»¶ä¸�满足,直接获å�– `MethodInterceptor` 返回; -ÄÇô `MethodInterceptor` ÊÇÈçºÎ»ñÈ¡µÄÄØ£¿ÎÒÃǼÌÐøÍùÏ¿´£º +那么 `MethodInterceptor` 是如何获å�–的呢?我们继续往下看: ```java -// ´æ·Å AdvisorAdapter µÄµØ·½ +// 存放 AdvisorAdapter 的地方 private final List adapters = new ArrayList<>(3); -// Ìí¼Ó adapter +// 添加 adapter public DefaultAdvisorAdapterRegistry() { // @Before registerAdvisorAdapter(new MethodBeforeAdviceAdapter()); @@ -415,20 +415,20 @@ public DefaultAdvisorAdapterRegistry() { } /** - * »ñÈ¡advisor¶ÔÓ¦µÄMethodInterceptor + * 获å�–advisor对应的MethodInterceptor */ @Override public MethodInterceptor[] getInterceptors(Advisor advisor) throws UnknownAdviceTypeException { List interceptors = new ArrayList<>(3); - // »ñÈ¡µ±Ç°advisorÀïµÄMethodInterceptor + // 获å�–当å‰�advisor里的MethodInterceptor Advice advice = advisor.getAdvice(); - // Èç¹û advice ÊÇ MethodInterceptorµÄʵÀý£¬Ìí¼Ó + // 如果 advice 是 MethodInterceptor的实例,添加 if (advice instanceof MethodInterceptor) { interceptors.add((MethodInterceptor) advice); } // - // ʹÓà AdvisorAdapter ½« advice ת»»Îª MethodInterceptor - // Èç¹ûadviceÂú×ãadapter£¬µ÷Óà adapter.getInterceptor »ñÈ¡ MethodInterceptor + // 使用 AdvisorAdapter å°† advice 转æ�¢ä¸º MethodInterceptor + // 如果advice满足adapter,调用 adapter.getInterceptor 获å�– MethodInterceptor for (AdvisorAdapter adapter : this.adapters) { if (adapter.supportsAdvice(advice)) { interceptors.add(adapter.getInterceptor(advisor)); @@ -441,23 +441,23 @@ public MethodInterceptor[] getInterceptors(Advisor advisor) throws UnknownAdvice } ``` -¶ÔÕâ¸ö·½·¨µÄÁ÷³Ì×ܽáÈçÏ£º +对这个方法的æµ�程总结如下: -1. Èç¹û `advice` ÊÇ `MethodInterceptor`£¬Ö±½Ó½«Æäת»»³É `MethodInterceptor`£» -2. Èç¹ûÒÔÉϲ»Âú×㣬ÔòʹÓà `AdvisorAdapter` ½« advice ת»»³É `MethodInterceptor`. +1. 如果 `advice` 是 `MethodInterceptor`,直接将其转æ�¢æˆ� `MethodInterceptor`ï¼› +2. 如果以上ä¸�满足,则使用 `AdvisorAdapter` å°† advice 转æ�¢æˆ� `MethodInterceptor`. -¹ØÓÚ `adapters`£¬spring ΪÌṩÁËÈý¸ö `Adapter`£º +关于 `adapters`,spring 为æ��供了三个 `Adapter`: -- MethodBeforeAdviceAdapter£º´¦Àí `@Before` -- AfterReturningAdviceAdapter£º´¦Àí `@AfterReturning` -- ThrowsAdviceAdapter£º´¦Àí `@AfterThrowing` +- MethodBeforeAdviceAdapter:处ç�† `@Before` +- AfterReturningAdviceAdapter:处ç�† `@AfterReturning` +- ThrowsAdviceAdapter:处ç�† `@AfterThrowing` -ÕâÈý¸ö `Adapter` ¾ÍÖ»ÓÐÒ»¸ö¹¦ÄÜ£º·µ»Ø `advice` ¶ÔÓ¦µÄ `MethodInterceptor`£¬ÎÒÃÇÀ´¿´Ï `MethodBeforeAdviceAdapter` µÄ´úÂë¾ÍÃ÷°×ÁË£º +这三个 `Adapter` å°±å�ªæœ‰ä¸€ä¸ªåŠŸèƒ½ï¼šè¿”å›ž `advice` 对应的 `MethodInterceptor`,我们æ�¥çœ‹ä¸‹ `MethodBeforeAdviceAdapter` 的代ç �就明白了: ```java class MethodBeforeAdviceAdapter implements AdvisorAdapter, Serializable { /** - * ÊÇ·ñÄÜ´¦Àíµ±Ç°advice + * 是å�¦èƒ½å¤„ç�†å½“å‰�advice */ @Override public boolean supportsAdvice(Advice advice) { @@ -465,7 +465,7 @@ class MethodBeforeAdviceAdapter implements AdvisorAdapter, Serializable { } /** - * ·µ»Ø¶ÔÓ¦µÄMethodInterceptor + * 返回对应的MethodInterceptor */ @Override public MethodInterceptor getInterceptor(Advisor advisor) { @@ -475,9 +475,9 @@ class MethodBeforeAdviceAdapter implements AdvisorAdapter, Serializable { } ``` -ÆäËûÁ½¸ö `Adapter` µÄ¹¦Äܼ«ÆäÏàËÆ£¬¾Í²»·ÖÎöÁË£¬ÕâÀï×ܽáϸ÷×¢½â¶ÔÓ¦µÄ `advice`¡¢`methodInterceptor`£º +其他两个 `Adapter` 的功能æž�其相似,就ä¸�分æž�了,这里总结下å�„注解对应的 `advice`ã€�`methodInterceptor`: -| ×¢½â | advice | methodInterceptor | +| 注解 | advice | methodInterceptor | | --------------- | --------------------------- | ------------------------------- | | @Before | AspectJMethodBeforeAdvice | MethodBeforeAdviceInterceptor | | @After | AspectJAfterAdvice | AspectJAfterAdvice | @@ -487,17 +487,17 @@ class MethodBeforeAdviceAdapter implements AdvisorAdapter, Serializable { #### ReflectiveMethodInvocation#proceed -»ñÈ¡Íê `MethodInterceptor` ºó£¬¾Í¿ªÊ¼½øÐз½·¨µÄÖ´ÐÐÁË£¬ÎÒÃÇÖ±½Ó½øÈë `ReflectiveMethodInvocation#proceed` ·½·¨£º +获å�–完 `MethodInterceptor` å�Žï¼Œå°±å¼€å§‹è¿›è¡Œæ–¹æ³•的执行了,我们直接进入 `ReflectiveMethodInvocation#proceed` 方法: ```java public Object proceed() throws Throwable { - // Ö´ÐÐÍêËùÓеÄÔöÇ¿ºóÖ´ÐÐÄ¿±ê·½·¨ - // ÕâÀïʹÓÃÁËÔðÈÎÁ´Ä£Ê½£¬Õâ¸ö·½·¨ÔÚÔðÈÎÁ´Öе÷Óã¬Âú×ãÌõ¼þ±íʾµ±Ç°ÔðÈÎÁ´ÒѾ­Ö´Ðе½×îºóÁË + // 执行完所有的增强å�Žæ‰§è¡Œç›®æ ‡æ–¹æ³• + // 这里使用了责任链模å¼�,这个方法在责任链中调用,满足æ�¡ä»¶è¡¨ç¤ºå½“å‰�责任链已ç»�执行到最å�Žäº† if (this.currentInterceptorIndex == this.interceptorsAndDynamicMethodMatchers.size() - 1) { return invokeJoinpoint(); } - // »ñÈ¡ÏÂÒ»¸öÒªÖ´ÐеÄÀ¹½ØÆ÷ + // 获å�–下一个è¦�执行的拦截器 Object interceptorOrInterceptionAdvice = this.interceptorsAndDynamicMethodMatchers.get(++this.currentInterceptorIndex); if (interceptorOrInterceptionAdvice instanceof InterceptorAndDynamicMethodMatcher) { @@ -506,37 +506,37 @@ public Object proceed() throws Throwable { Class targetClass = (this.targetClass != null ? this.targetClass : this.method.getDeclaringClass()); if (dm.methodMatcher.matches(this.method, targetClass, this.arguments)) { - // Æ¥Å䣬¾Íµ÷ÓÃÀ¹½ØÆ÷µÄ·½·¨£¬Ò²¾ÍÊÇÇÐÃæ·½·¨ - // ÔÚ MethodInterceptor#invokeÀ»áÔÙ´Î ReflectiveMethodInvocation#proceed£¬ÓÖµ÷»ØÁ˵±Ç°·½·¨ + // 匹é…�,就调用拦截器的方法,也就是切é�¢æ–¹æ³• + // 在 MethodInterceptor#invoke里,会å†�次 ReflectiveMethodInvocation#proceed,å�ˆè°ƒå›žäº†å½“å‰�方法 return dm.interceptor.invoke(this); } else { - // ²»Æ¥Å䣬ÔòµÝ¹éµ÷Óõ±Ç°·½·¨ + // ä¸�匹é…�,则递归调用当å‰�方法 return proceed(); } } else { - // ×¢Ò⣬Õâ¸ö·½·¨´«ÈëµÄ²ÎÊýÊÇ this£¬±íʾµ±Ç°¶ÔÏó - // ÔÚ MethodInterceptor#invokeÀ»áÔÙ´Î ReflectiveMethodInvocation#proceed£¬ÓÖµ÷»ØÁ˵±Ç°·½·¨ + // 注æ„�,这个方法传入的å�‚数是 this,表示当å‰�对象 + // 在 MethodInterceptor#invoke里,会å†�次 ReflectiveMethodInvocation#proceed,å�ˆè°ƒå›žäº†å½“å‰�方法 return ((MethodInterceptor) interceptorOrInterceptionAdvice).invoke(this); } } /** - * µ÷ÓÃÄ¿±ê·½·¨ + * 调用目标方法 */ protected Object invokeJoinpoint() throws Throwable { - // ʹÓ÷´Éäµ÷ÓÃÄ¿±ê¶ÔÏó·½·¨£¬×¢ÒâÕâÀï´«ÈëµÄÓ¦¸ÃÊÇÄ¿±ê¶ÔÏ󣬶ø²»ÊÇ´úÀí¶ÔÏó + // 使用å��射调用目标对象方法,注æ„�这里传入的应该是目标对象,而ä¸�是代ç�†å¯¹è±¡ return AopUtils.invokeJoinpointUsingReflection(this.target, this.method, this.arguments); } ``` -ÒÔÉÏ´úÂëµÄµ÷ÓÃʹÓÃÁËÔðÈÎÁ´Ä£Ê½£¬Ö´ÐÐÂß¼­ÈçÏ£º +以上代ç �的调用使用了责任链模å¼�,执行逻辑如下: -1. ÅжÏÊÇ·ñÖ´ÐÐÍêËùÓеÄÇÐÃæ·½·¨£¬ÈôÊÇ£¬ÔòÖ´ÐÐÄ¿±ê·½·¨£¬·ñÔòÖ´ÐÐÏÂÒ»²½£» -2. »ñÈ¡ÏÂÒ»¸öÀ¹½ØÆ÷£¬ÅжÏÄÜ·ñÖ´ÐУ¬ÈôÄÜ£¬Ôòµ÷ÓÃÀ¹½ØÆ÷·½·¨£¬·ñÔòÖ´ÐÐµÚ Ò»²½²Ù×÷£» +1. 判断是å�¦æ‰§è¡Œå®Œæ‰€æœ‰çš„切é�¢æ–¹æ³•,若是,则执行目标方法,å�¦åˆ™æ‰§è¡Œä¸‹ä¸€æ­¥ï¼› +2. 获å�–下一个拦截器,判断能å�¦æ‰§è¡Œï¼Œè‹¥èƒ½ï¼Œåˆ™è°ƒç”¨æ‹¦æˆªå™¨æ–¹æ³•,å�¦åˆ™æ‰§è¡Œç¬¬ 一步æ“�作; -ÒÔÉÏÂß¼­¿´×Åͦ¼òµ¥£¬µ«¾ßÌåÊÇÔõôִÐеÄÄØ£¿ÔÚ spring ÖУ¬ÇÐÃæÍ¨ÖªÓÐÎåÖÖÀàÐÍ£º`@Before`¡¢`@After`¡¢`@AfterReturning`¡¢`@AfterThrowing` Óë `@Around`£¬ÕâÀïÎÒÃÇÒ»Ò»À´¿´¿´ÕâÎåÖÖ֪ͨÊÇÈçºÎµ÷Óõġ£ +以上逻辑看ç�€æŒºç®€å�•,但具体是怎么执行的呢?在 spring 中,切é�¢é€šçŸ¥æœ‰äº”ç§�类型:`@Before`ã€�`@After`ã€�`@AfterReturning`ã€�`@AfterThrowing` 与 `@Around`,这里我们一一æ�¥çœ‹çœ‹è¿™äº”ç§�通知是如何调用的。 #### 1. `@Before` @@ -545,14 +545,14 @@ protected Object invokeJoinpoint() throws Throwable { ```java @Override public Object invoke(MethodInvocation mi) throws Throwable { - // Ö´ÐÐǰÖÃ֪ͨ£¬¿´ÏÂÃæ + // 执行å‰�置通知,看下é�¢ this.advice.before(mi.getMethod(), mi.getArguments(), mi.getThis()); - // ¼ÌÐøÖ´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷ + // 继续执行下一个拦截器 return mi.proceed(); } ``` -½øÈë `advice.before(xxx)` ·½·¨£º +进入 `advice.before(xxx)` 方法: > AspectJMethodBeforeAdvice#before @@ -563,7 +563,7 @@ public void before(Method method, Object[] args, @Nullable Object target) throws } ``` -¼ÌÐø¸úÏÂÈ¥£º +继续跟下去: > AbstractAspectJAdvice#invokeAdviceMethod(JoinPointMatch, Object, Throwable) @@ -576,7 +576,7 @@ protected Object invokeAdviceMethod( } /** - * µ÷Ó÷´ÉäÖ´ÐÐ + * 调用å��射执行 */ protected Object invokeAdviceMethodWithGivenArgs(Object[] args) throws Throwable { Object[] actualArgs = args; @@ -584,7 +584,7 @@ protected Object invokeAdviceMethodWithGivenArgs(Object[] args) throws Throwable actualArgs = null; } try { - // ÊìϤµÄjdk·´Éä´úÂë + // 熟悉的jdkå��射代ç � ReflectionUtils.makeAccessible(this.aspectJAdviceMethod); return this.aspectJAdviceMethod.invoke( this.aspectInstanceFactory.getAspectInstance(), actualArgs); @@ -594,7 +594,7 @@ protected Object invokeAdviceMethodWithGivenArgs(Object[] args) throws Throwable } ``` -¿ÉÒÔ¿´µ½£¬×îÖÕÊǵ÷Óà jdk ·´ÉäÀ´µ÷Óõġ£ +å�¯ä»¥çœ‹åˆ°ï¼Œæœ€ç»ˆæ˜¯è°ƒç”¨ jdk å��å°„æ�¥è°ƒç”¨çš„。 #### 2. `@After` @@ -604,11 +604,11 @@ protected Object invokeAdviceMethodWithGivenArgs(Object[] args) throws Throwable @Override public Object invoke(MethodInvocation mi) throws Throwable { try { - // ¼ÌÐøÖ´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷ + // 继续执行下一个拦截器 return mi.proceed(); } finally { - // µ÷ÓÃÇÐÃæ·½·¨£º·ÅÔÚ finally ¿é£¬±íʾһ¶¨»áÖ´ÐУ¬×îÖÕÒ²ÊÇʹÓ÷´Éäµ÷Óà + // 调用切é�¢æ–¹æ³•:放在 finally å�—,表示一定会执行,最终也是使用å��射调用 invokeAdviceMethod(getJoinPointMatch(), null, null); } } @@ -621,9 +621,9 @@ public Object invoke(MethodInvocation mi) throws Throwable { ```java @Override public Object invoke(MethodInvocation mi) throws Throwable { - // ¼ÌÐøÖ´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷ + // 继续执行下一个拦截器 Object retVal = mi.proceed(); - // µ÷ÓÃÇÐÃæ·½·¨£¬¼ÌÐøÍùÏ¿´ + // 调用切é�¢æ–¹æ³•,继续往下看 this.advice.afterReturning(retVal, mi.getMethod(), mi.getArguments(), mi.getThis()); return retVal; } @@ -635,7 +635,7 @@ public Object invoke(MethodInvocation mi) throws Throwable { public void afterReturning(@Nullable Object returnValue, Method method, Object[] args, @Nullable Object target) throws Throwable { if (shouldInvokeOnReturnValueOf(method, returnValue)) { - // µ÷ÓÃÇÐÃæ·½·¨£¬ÒÀÈ»Êǵ÷Ó÷´ÉäÖ´ÐÐ + // 调用切é�¢æ–¹æ³•,ä¾�然是调用å��射执行 invokeAdviceMethod(getJoinPointMatch(), returnValue, null); } } @@ -649,12 +649,12 @@ public void afterReturning(@Nullable Object returnValue, Method method, @Override public Object invoke(MethodInvocation mi) throws Throwable { try { - // µ÷Óà ReflectiveMethodInvocation#proceed + // 调用 ReflectiveMethodInvocation#proceed return mi.proceed(); } catch (Throwable ex) { if (shouldInvokeOnThrowing(ex)) { - // µ÷ÓÃÇÐÃæ·½·¨£¬Ö»ÓÐÔÚÅ׳öÒ쳣ʱ²Å»á±»µ÷Óà + // 调用切é�¢æ–¹æ³•,å�ªæœ‰åœ¨æŠ›å‡ºå¼‚常时æ‰�会被调用 invokeAdviceMethod(getJoinPointMatch(), null, ex); } throw ex; @@ -675,68 +675,68 @@ public Object invoke(MethodInvocation mi) throws Throwable { ProxyMethodInvocation pmi = (ProxyMethodInvocation) mi; ProceedingJoinPoint pjp = lazyGetProceedingJoinPoint(pmi); JoinPointMatch jpm = getJoinPointMatch(pmi); - // µ÷ÓÃÇÐÃæ·½·¨ + // 调用切é�¢æ–¹æ³• return invokeAdviceMethod(pjp, jpm, null, null); } ``` -ÎÒÃÇÔÚʵÏÖ»·ÈÆÍ¨ÖªÊ±£¬Ò»°ãÏñÕâÑùʵÏÖ£º +我们在实现环绕通知时,一般åƒ�这样实现: ```java @Around(xxx) public Object around(ProceedingJoinPoint p){ - // Ö´ÐÐÄ¿±ê·½·¨Ç°µÄ²Ù×÷ + // 执行目标方法å‰�çš„æ“�作 ... - // Ö´ÐÐÄ¿±ê·½·¨£¬ÕâÒ»¾äÊǹؼü - // ʵ¼ÊÕâÀï²¢²»½ö½öÊÇÖ´ÐÐÄ¿±ê·½·¨£¬×îÖÕµ÷ÓõÄÊÇ ReflectiveMethodInvocation#proceed - // ¼´Èç¹ûÓÐÀ¹½ØÆ÷£¬Ôò¼ÌÐøÖ´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£¬·ñÔòÖ´ÐÐÄ¿±ê·½·¨ + // 执行目标方法,这一å�¥æ˜¯å…³é”® + // 实际这里并ä¸�仅仅是执行目标方法,最终调用的是 ReflectiveMethodInvocation#proceed + // å�³å¦‚果有拦截器,则继续执行下一个拦截器,å�¦åˆ™æ‰§è¡Œç›®æ ‡æ–¹æ³• Object o = p.proceed(); - // Ö´ÐÐÄ¿±ê·½·¨ºóµÄ²Ù×÷ + // 执行目标方法å�Žçš„æ“�作 ... return o; } ``` -spring ¶ÔÒÔÉÏÎåÖÖ֪ͨµÄÖ´ÐУ¬Ö÷Òª·ÖΪÁ½¸ö²¿·Ö£º +spring 对以上五ç§�通知的执行,主è¦�分为两个部分: -1. ʹÓ÷´É䷽ʽִÐÐÇÐÃæ·½·¨£¬Ò²¾ÍÊÇËùνµÄ ¡°ÔöÇ¿¡±£» -2. µ÷Óà `ReflectiveMethodInvocation#proceed` ¼ÌÐøÖ´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£¬»òÖ´ÐÐÄ¿±ê·½·¨¡£ +1. 使用å��å°„æ–¹å¼�执行切é�¢æ–¹æ³•,也就是所谓的 “增强â€�ï¼› +2. 调用 `ReflectiveMethodInvocation#proceed` 继续执行下一个拦截器,或执行目标方法。 -ÒÔÉÏÁ½¸ö²¿·ÖµÄ²î±ð½öÔÚÓÚÖ´ÐдÎÐò¼°Ö´ÐеÄλÖã¬Èç +以上两个部分的差别仅在于执行次åº�å�Šæ‰§è¡Œçš„ä½�置,如 -- `@Before` ֪ͨ£¬`1` ÔÚǰ£¬`2` ÔÚºó£» -- `@AfterReturning` ֪ͨ£¬`2` ÔÚǰ£¬`1` ÔÚºó£¬Èç¹ûÖ´ÐÐ `2` ʱ·¢ÉúÁËÒì³££¬`1` ¾Í²»»áÖ´ÐÐÁË£» -- `@AfterThrowing` ֪ͨ£¬`2` ÔÚǰ£¬`1` ÔÚºó£¬ÇÒ `1` ÊÇ·ÅÔÚ `catch` ¿éÖÐÖ´ÐУ¬¼´Ö»Óз¢ÉúÁËÒì³££¬`1` ²Å»áÖ´ÐУ» -- `@After` ֪ͨ£¬`2` ÔÚǰ£¬`1` ÔÚºó£¬`1` ÊÇ·ÅÔÚ `finally` ¿éÖÐÖ´ÐУ¬ÓÉÓÚ `finally` µÄÌØÊâÐÔ£¬¼´Ê¹·¢ÉúÁËÒì³££¬`1` ͬÑù»áÖ´ÐУ» -- `@Around` ֪ͨ£¬ÔÚÇÐÃæ·½·¨ÖÐ×ÔÐÐÖ¸¶¨ÁË `2` µÄÖ´ÐÐʱ»ú¡£ +- `@Before` 通知,`1` 在å‰�,`2` 在å�Žï¼› +- `@AfterReturning` 通知,`2` 在å‰�,`1` 在å�Žï¼Œå¦‚果执行 `2` æ—¶å�‘生了异常,`1` å°±ä¸�会执行了; +- `@AfterThrowing` 通知,`2` 在å‰�,`1` 在å�Žï¼Œä¸” `1` 是放在 `catch` å�—中执行,å�³å�ªæœ‰å�‘生了异常,`1` æ‰�会执行; +- `@After` 通知,`2` 在å‰�,`1` 在å�Žï¼Œ`1` 是放在 `finally` å�—中执行,由于 `finally` 的特殊性,å�³ä½¿å�‘生了异常,`1` å�Œæ ·ä¼šæ‰§è¡Œï¼› +- `@Around` 通知,在切é�¢æ–¹æ³•中自行指定了 `2` 的执行时机。 -×¢ÒâÇø±ð `@AfterReturning`¡¢`@AfterThrowing` Óë `@After` ֪ͨµÄÖ´ÐÐʱ»ú¡£ +注æ„�区别 `@AfterReturning`ã€�`@AfterThrowing` 与 `@After` 通知的执行时机。 -×îºó£¬ÎÒÃÇÔÙÀ´¿´¿´Õ⼸¸ö֪ͨÊÇÈçºÎÖ´Ðеġ£ +最å�Žï¼Œæˆ‘们å†�æ�¥çœ‹çœ‹è¿™å‡ ä¸ªé€šçŸ¥æ˜¯å¦‚何执行的。 -ͨ¹ýµ÷ÊԵķ½Ê½£¬·¢ÏÖ spring Ö´ÐÐ֪ͨµÄ˳ÐòÈçÏ£º +通过调试的方å¼�,å�‘现 spring 执行通知的顺åº�如下: -1. Ê×ÏÈÖ´ÐÐ `@AfterThrowing` ֪ͨ£¬Ïȵ÷Óà `mi.proceed()` Ö´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£¬È»ºóÔÚ `catch` ¿éÖÐÖ´ÐÐÇÐÃæ·½·¨£¬±íÃ÷Ö»ÓгöÏÖÒ쳣ʱ£¬¸ÃÇÐÃæ·½·¨²Å»áÖ´ÐУ» -2. ÉÏÒ»²½²Ù×÷ÖУ¬µ÷Óà `mi.proceed()` ʱ»áÖ´ÐÐ `@AfterReturning` ֪ͨ£¬Ö´ÐÐʱÏȵ÷Óà `mi.proceed()` Ö´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£¬È»ºóÔÙÖ´ÐÐÇÐÃæ·½·¨£» -3. ÉÏÒ»²½²Ù×÷ÖУ¬µ÷Óà `mi.proceed()` ʱ»áÖ´ÐÐ `@After` ֪ͨ£¬Ö´ÐÐʱÏȵ÷Óà `mi.proceed()` Ö´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£¬È»ºóÔÚ `finally` ¿éÖÐÖ´ÐÐÇÐÃæ·½·¨£¬±íÃ÷¼´Ê¹³öÏÖÒì³££¬ÇÐÃæ·½·¨»¹ÊÇ»áÖ´ÐУ» -4. ÉÏÒ»²½²Ù×÷ÖУ¬µ÷Óà `mi.proceed()` ʱ»áÖ´ÐÐ `@Around` ֪ͨ£¬Ö´ÐÐʱֱ½ÓÖ´ÐÐÇÐÃæ·½·¨£¬ÓÉÓÚ `@Around` ֪ͨµÄÇÐÃæ·½·¨Àï»áµ÷Óà `ProceedingJoinPoint#proceed()`£¬×îÖÕ»¹ÊÇ»áÖ´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£» -5. ÉÏÒ»²½²Ù×÷ÖУ¬µ÷Óà `mi.proceed()` ʱ»áÖ´ÐÐ `@Before` ֪ͨ£¬Ö´ÐÐʱ»áÏÈÖ´ÐÐÇÐÃæ·½·¨£¬ÔÙµ÷Óà `mi.proceed()` Ö´ÐÐÏÂÒ»¸öÀ¹½ØÆ÷£» -6. À¹½ØÆ÷Á´Ö´Ðе½×îºó£¬·¢ÏÖûÓпÉÖ´ÐеÄÀ¹½ØÆ÷ÁË£¬´Ëʱ¾Í¿ªÊ¼Ö´ÐÐÄ¿±ê·½·¨¡£ +1. 首先执行 `@AfterThrowing` 通知,先调用 `mi.proceed()` 执行下一个拦截器,然å�Žåœ¨ `catch` å�—中执行切é�¢æ–¹æ³•,表明å�ªæœ‰å‡ºçŽ°å¼‚å¸¸æ—¶ï¼Œè¯¥åˆ‡é�¢æ–¹æ³•æ‰�会执行; +2. 上一步æ“�作中,调用 `mi.proceed()` 时会执行 `@AfterReturning` 通知,执行时先调用 `mi.proceed()` 执行下一个拦截器,然å�Žå†�执行切é�¢æ–¹æ³•ï¼› +3. 上一步æ“�作中,调用 `mi.proceed()` 时会执行 `@After` 通知,执行时先调用 `mi.proceed()` 执行下一个拦截器,然å�Žåœ¨ `finally` å�—中执行切é�¢æ–¹æ³•,表明å�³ä½¿å‡ºçŽ°å¼‚å¸¸ï¼Œåˆ‡é�¢æ–¹æ³•还是会执行; +4. 上一步æ“�作中,调用 `mi.proceed()` 时会执行 `@Around` 通知,执行时直接执行切é�¢æ–¹æ³•,由于 `@Around` 通知的切é�¢æ–¹æ³•里会调用 `ProceedingJoinPoint#proceed()`,最终还是会执行下一个拦截器; +5. 上一步æ“�作中,调用 `mi.proceed()` 时会执行 `@Before` 通知,执行时会先执行切é�¢æ–¹æ³•,å†�调用 `mi.proceed()` 执行下一个拦截器; +6. 拦截器链执行到最å�Žï¼Œå�‘现没有å�¯æ‰§è¡Œçš„æ‹¦æˆªå™¨äº†ï¼Œæ­¤æ—¶å°±å¼€å§‹æ‰§è¡Œç›®æ ‡æ–¹æ³•。 -»­Í¼Ê¾Òâ֪ͨµÄÖ´Ðйý³ÌÈçÏ£º +画图示æ„�通知的执行过程如下: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-e88e0cec49c47648005e5d3160663425739.png) -×îÖÕµÄÖ´ÐÐ˳Ðò£º +最终的执行顺åº�: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-97026239d0b2dc02abbe87a9b76325c3cc0.png) -### 4. ×ܽá +### 4. 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË jdk ¶¯Ì¬´úÀíµÄÖ´Ðйý³Ì£¬ÊáÀíÁ˸÷¸öÇÐÃæÍ¨ÖªµÄÖ´ÐÐ˳Ðò¡£±¾ÎľÍÏȵ½ÕâÀïÁË£¬ÏÂһƪÎÄÕ½«½éÉÜ cglib µÄÖ´Ðйý³Ì¡£ +本文主è¦�分æž�了 jdk 动æ€�代ç�†çš„æ‰§è¡Œè¿‡ç¨‹ï¼Œæ¢³ç�†äº†å�„个切é�¢é€šçŸ¥çš„æ‰§è¡Œé¡ºåº�。本文就先到这里了,下一篇文章将介ç»� cglib 的执行过程。 ------ -*±¾ÎÄÔ­ÎÄÁ´½Ó£ºhttps://my.oschina.net/funcy/blog/4696654 £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£* \ No newline at end of file +*本文原文链接:https://my.oschina.net/funcy/blog/4696654 ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。* \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\200\357\274\211\357\274\232\350\256\244\350\257\206\344\272\213\345\212\241\347\273\204\344\273\266.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\200\357\274\211\357\274\232\350\256\244\350\257\206\344\272\213\345\212\241\347\273\204\344\273\266.md" index d46a99e..1c7b135 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\200\357\274\211\357\274\232\350\256\244\350\257\206\344\272\213\345\212\241\347\273\204\344\273\266.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\200\357\274\211\357\274\232\350\256\244\350\257\206\344\272\213\345\212\241\347\273\204\344\273\266.md" @@ -1,20 +1,20 @@ -Ç°Ãæ·ÖÎöÍêÁË spring aop Ïà¹Ø¹¦Äܺ󣬱¾ÎĽ«À´·ÖÎö spring aop µÄÒ»¸öÓ¦Óà ¡ª¡ª ÊÂÎñ¹ÜÀí¡£ +å‰�é�¢åˆ†æž�完了 spring aop 相关功能å�Žï¼Œæœ¬æ–‡å°†æ�¥åˆ†æž� spring aop 的一个应用 —— 事务管ç�†ã€‚ -### 1\. ´ÓÁ½¸ö demo ½²Æð +### 1\. 从两个 demo 讲起 -ÔÚÕýʽ·ÖÎöǰ£¬ÎÒÃÇÏÈÀ´Ë¼¿¼Ï£¬Èç¹ûÈÃÎÒÃÇ×Ô¼ºÀ´»ùÓÚ spring aop À´Éè¼ÆÒ»Ì×ÊÂÎñ´¦Àí»úÖÆ£¬¸ÃÈçºÎʵÏÖÄØ£¿Èç¹ûûÓÐ spring£¬ÎÒÃǵÄÊÂÎñ´¦Àí´úÂëÒ»°ã³¤ÕâÑù£º +在正å¼�分æž�å‰�,我们先æ�¥æ€�考下,如果让我们自己æ�¥åŸºäºŽ spring aop æ�¥è®¾è®¡ä¸€å¥—事务处ç�†æœºåˆ¶ï¼Œè¯¥å¦‚何实现呢?如果没有 spring,我们的事务处ç�†ä»£ç �一般长这样: ``` public void fun() { - // ¿ªÆôÊÂÎñ + // å¼€å�¯äº‹åŠ¡ start(); try { - // ÒµÎñ´¦Àí + // 业务处ç�† xxx(); - // Ìá½»ÊÂÎñ + // æ��交事务 commit(); } catch(Exception e) { - // »Ø¹öÊÂÎñ + // 回滚事务 rollback(); throw e; } @@ -22,13 +22,13 @@ public void fun() { ``` -´ÓÉÏÃæµÄ´úÂëÀ´¿´£¬Ïñ¿ªÆôÊÂÎñ¡¢Ìá½»ÊÂÎñ¡¢»Ø¹öÊÂÎñ£¬¶¼¸úÒµÎñ´úÂëÎ޹أ¬ÕâЩ¿ÉÒÔʹÓà spring aop À´ÊµÏÖ£¬Òò´Ë¾ÍÓÐÁËÏÂÃæÁ½¸ö demo. +从上é�¢çš„代ç �æ�¥çœ‹ï¼Œåƒ�å¼€å�¯äº‹åŠ¡ã€�æ��交事务ã€�回滚事务,都跟业务代ç �无关,这些å�¯ä»¥ä½¿ç”¨ spring aop æ�¥å®žçŽ°ï¼Œå› æ­¤å°±æœ‰äº†ä¸‹é�¢ä¸¤ä¸ª demo. -#### demo01£º»ùÓÚ `@Around` ×¢½âʵÏÖÊÂÎñ +#### demo01:基于 `@Around` 注解实现事务 -ÔÛÃÇ¿ÉÒÔʹÓà `@Around` ×¢½âÀ´²Ù×÷£¬´úÂëÈçÏ£º +咱们å�¯ä»¥ä½¿ç”¨ `@Around` 注解æ�¥æ“�作,代ç �如下: -1. ¶¨ÒåÒ»¸ö×¢½â£º`@MyTransactional` +1. 定义一个注解:`@MyTransactional` ``` @Target({ElementType.TYPE, ElementType.METHOD}) @@ -40,7 +40,7 @@ public @interface MyTransactional { ``` -1. ¶¨Òå aop ²Ù×÷ +1. 定义 aop æ“�作 ``` @Aspect @@ -53,16 +53,16 @@ public class MyAopAspectj { @Around("testAop()") public Object around(ProceedingJoinPoint p) throws Throwable { - System.out.println("Ö´ÐÐǰ£¬¿ªÆôÊÂÎñ...."); + System.out.println("执行å‰�,开å�¯äº‹åŠ¡...."); try { Object o = p.proceed(); - System.out.println("Ö´ÐÐÍê³É£¬Ìá½»ÊÂÎñ...."); + System.out.println("执行完æˆ�,æ��交事务...."); return o; } catch (Throwable e) { - System.out.println("³öÏÖÁËÒì³££¬¸ù¾ÝÒì³£ÀàÐͻعöÊÂÎñ...."); + System.out.println("出现了异常,根æ�®å¼‚常类型回滚事务...."); throw e; } finally { - System.out.println("Ö´Ðкó...."); + System.out.println("执行å�Ž...."); } } @@ -70,7 +70,7 @@ public class MyAopAspectj { ``` -1. config£¬½øÐÐһЩ±ØÒªµÄÅäÖà +1. config,进行一些必è¦�çš„é…�ç½® ``` @Configuration @@ -82,7 +82,7 @@ public class TxDemo02Config { ``` -1. Ìí¼ÓÒ»¸ö service À࣬ÆäÖÐÒ»¸ö·½·¨ÉÏÓÐ `@MyTransactional` ×¢½â +1. 添加一个 service 类,其中一个方法上有 `@MyTransactional` 注解 ``` @Service @@ -90,18 +90,18 @@ public class TxTestService { @MyTransactional public void test01() { - System.out.println("Ö´ÐÐtest01·½·¨"); + System.out.println("执行test01方法"); } public void test02() { - System.out.println("Ö´ÐÐtest02·½·¨"); + System.out.println("执行test02方法"); } } ``` -1. Ö÷Àà +1. 主类 ``` public class TxDemo02Main { @@ -120,65 +120,65 @@ public class TxDemo02Main { ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` ------------------- -Ö´ÐÐǰ£¬¿ªÆôÊÂÎñ.... -Ö´ÐÐtest01·½·¨ -Ö´ÐÐÍê³É£¬Ìá½»ÊÂÎñ.... -Ö´Ðкó.... +执行å‰�,开å�¯äº‹åŠ¡.... +执行test01方法 +执行完æˆ�,æ��交事务.... +执行å�Ž.... ------------------- -Ö´ÐÐtest02·½·¨ +执行test02方法 ``` -Õâ¸ö demo ÖУ¬ÎÒÃÇʹÓà `@Around` ×¢½âÀ´À¹½ØÒµÎñ´úÂëÖ´ÐÐǰºóµÄÇé¿ö£¬¿ÉÒÔ¿´µ½£¬`@Around` ×¢½â¿ÉÒÔÔÚ´úÂëÔËÐÐǰºóÉõÖÁÊdzöÏÖÒ쳣ʱ´¦ÀíһЩ¶îÍâµÄ²Ù×÷¡£ +这个 demo 中,我们使用 `@Around` 注解æ�¥æ‹¦æˆªä¸šåС代ç �执行å‰�å�Žçš„æƒ…况,å�¯ä»¥çœ‹åˆ°ï¼Œ`@Around` 注解å�¯ä»¥åœ¨ä»£ç �è¿�行å‰�å�Žç”šè‡³æ˜¯å‡ºçŽ°å¼‚å¸¸æ—¶å¤„ç�†ä¸€äº›é¢�外的æ“�作。 -#### demo02£º×Ô¶¨Òå `advisor` ʵÏÖÊÂÎñ +#### demo02:自定义 `advisor` 实现事务 -ÈÃÎÒÃÇ»ØÒäÏ spring aop ¶Ô `@Around` ×¢½âµÄ´¦Àí£¬Êµ¼ÊÉÏ `@Around` ×îÖÕ»á·âװΪ `InstantiationModelAwarePointcutAdvisorImpl` ¶ÔÏ󣬺óÃæµÄ´¦Àí¾Í¸ú `@Around` ÎÞ¹ØÁË£¬`@Around` µ½ `InstantiationModelAwarePointcutAdvisorImpl` ¶ÔÏóµÄ¹ý³Ì£¬¿É²Î¿¼ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨ÉÏ£©](https://my.oschina.net/funcy/blog/4678817). +让我们回忆下 spring aop 对 `@Around` 注解的处ç�†ï¼Œå®žé™…上 `@Around` 最终会å°�装为 `InstantiationModelAwarePointcutAdvisorImpl` 对象,å�Žé�¢çš„处ç�†å°±è·Ÿ `@Around` 无关了,`@Around` 到 `InstantiationModelAwarePointcutAdvisorImpl` 对象的过程,å�¯å�‚考 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(上)](https://my.oschina.net/funcy/blog/4678817). -`InstantiationModelAwarePointcutAdvisorImpl` ÊǸöʲô¶«Î÷ÄØ£¿ÕâÊǸö `advisor`£¬¾ßÌåÀ´Ëµ¾ÍÊÇ¿ÉÓÃÓÚ·½·¨µÄÔöÇ¿¡£¹ØÓÚ spring aop ÊÇÈçºÎÕÒµ½ÄÜÓ¦ÓÃÓÚµ±Ç°·½·¨µÄ `advisor` µÄ£¬¿É²Î¿¼ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)¡£ +`InstantiationModelAwarePointcutAdvisorImpl` 是个什么东西呢?这是个 `advisor`,具体æ�¥è¯´å°±æ˜¯å�¯ç”¨äºŽæ–¹æ³•的增强。关于 spring aop 是如何找到能应用于当å‰�方法的 `advisor` 的,å�¯å�‚考 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)。 -ͨ¹ýÒÔÉÏ·ÖÎö£¬¸øÎÒÃÇÌṩÁËÁíÒ»¸ö˼·£ºÎÒÃÇ¿ÉÒÔʵÏÖ `advisor` ½Ó¿Ú£¬¶¨ÖÆ»¯×Ô¼ºµÄÂß¼­£¬´úÂëÈçÏ£º +通过以上分æž�,给我们æ��供了å�¦ä¸€ä¸ªæ€�路:我们å�¯ä»¥å®žçް `advisor` 接å�£ï¼Œå®šåˆ¶åŒ–自己的逻辑,代ç �如下: -1. ×¼±¸ `advice` +1. 准备 `advice` ``` /** - * Õâ¸öadvice¾ÍÊÇadvisorµÄÒ»¸öÊôÐÔ£¬ÇÐÃæÂß¼­ÔÚÕâÀï´¦Àí + * 这个advice就是advisor的一个属性,切é�¢é€»è¾‘在这里处ç�† */ public class MyAdvice implements MethodInterceptor { @Override public Object invoke(MethodInvocation invocation) throws Throwable { - System.out.println("Ö´ÐÐǰ£¬¿ªÆôÊÂÎñ...."); + System.out.println("执行å‰�,开å�¯äº‹åŠ¡...."); try { Object val = invocation.proceed(); - System.out.println("Ö´ÐÐÍê³É£¬Ìá½»ÊÂÎñ...."); + System.out.println("执行完æˆ�,æ��交事务...."); return val; } catch (Throwable e) { - System.out.println("³öÏÖÁËÒì³££¬¸ù¾ÝÒì³£ÀàÐͻعöÊÂÎñ...."); + System.out.println("出现了异常,根æ�®å¼‚常类型回滚事务...."); throw e; } finally { - System.out.println("Ö´Ðкó...."); + System.out.println("执行å�Ž...."); } } } ``` -1. ×¼±¸ `pointcut` +1. 准备 `pointcut` ``` /** - * Çеã - * ÅжÏÄÄЩ·½·¨ÄÜÓÃÓÚ¸Ãadvisor + * 切点 + * 判断哪些方法能用于该advisor */ public class MyPointcut extends StaticMethodMatcherPointcut { /** - * Æ¥Åä·½·¨£¬ÓÐ @MyTransactional µÄÀà»ò·½·¨¾Í·µ»Øtrue + * 匹é…�方法,有 @MyTransactional 的类或方法就返回true */ @Override public boolean matches(Method method, Class targetClass) { @@ -189,11 +189,11 @@ public class MyPointcut extends StaticMethodMatcherPointcut { ``` -1. ×¼±¸ `advisor` +1. 准备 `advisor` ``` /** - * advisor ¿É¿´×÷ÊÇ advice Óë pointcut µÄ°ü×° + * advisor å�¯çœ‹ä½œæ˜¯ advice 与 pointcut 的包装 */ @Component public class MyAdvisor extends AbstractBeanFactoryPointcutAdvisor { @@ -216,9 +216,9 @@ public class MyAdvisor extends AbstractBeanFactoryPointcutAdvisor { ``` -ÒÔÉÏÊDz»Í¬ÓÚ×¢½âµÄʵÏÖ·½Ê½£¬½ÓÏÂÀ´µÄ´úÂë¾ÍÓë×¢½âÒ»ÑùÁË¡£ +以上是ä¸�å�ŒäºŽæ³¨è§£çš„实现方å¼�,接下æ�¥çš„代ç �就与注解一样了。 -1. ×¼±¸Ò»¸ö×¢½â£º`@MyTransactional` +1. 准备一个注解:`@MyTransactional` ``` @Target({ElementType.TYPE, ElementType.METHOD}) @@ -230,7 +230,7 @@ public @interface MyTransactional { ``` -1. ´¦ÀíÏîÄ¿ÅäÖà +1. 处ç�†é¡¹ç›®é…�ç½® ``` @Configuration @@ -242,7 +242,7 @@ public class TxDemo01Config { ``` -1. ×¼±¸Ò»¸ö service +1. 准备一个 service ``` @Service @@ -250,18 +250,18 @@ public class TxTestService { @MyTransactional public void test01() { - System.out.println("Ö´ÐÐtest01·½·¨"); + System.out.println("执行test01方法"); } public void test02() { - System.out.println("Ö´ÐÐtest02·½·¨"); + System.out.println("执行test02方法"); } } ``` -1. Ö÷Àà +1. 主类 ``` public class TxDemo01Main { @@ -280,33 +280,33 @@ public class TxDemo01Main { ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` ------------------- -Ö´ÐÐǰ£¬¿ªÆôÊÂÎñ.... -Ö´ÐÐtest01·½·¨ -Ö´ÐÐÍê³É£¬Ìá½»ÊÂÎñ.... -Ö´Ðкó.... +执行å‰�,开å�¯äº‹åŠ¡.... +执行test01方法 +执行完æˆ�,æ��交事务.... +执行å�Ž.... ------------------- -Ö´ÐÐtest02·½·¨ +执行test02方法 ``` -### 2\. ʹÓà spring ÊÂÎñ¹ÜÀí +### 2\. 使用 spring 事务管ç�† -ÓÐÁËÇ°ÃæµÄÁ½¸öС demo ×÷Ϊ¿ªÎ¸²Ë£¬¶ÔÓÚ spring ÊÂÎñ´¦ÀíÏë±ØÄãÒÑÓÐÁËÒ»¸öÇåÎúµÄÈÏʶ£¬spring ÔÚ´¦ÀíÊÂÎñʱ£¬Ê¹ÓõľÍÊǵڶþÖÖ·½Ê½£¬¼´Íù×Ô¶¨ÒåÒ»¸ö `advisor` Ìí¼Óµ½ spring ÈÝÆ÷ÖС£¹ØÓÚ spring ʵÏÖÈÎÎñµÄ¾ßÌåϸ½Ú£¬ÎÒÃÇ´ý»á·ÖÎö£¬ÕâÀïÎÒÃÇÔÙÉÏÒ»¸ö demo£¬ÌåÑéÏÂÎÒÃÇÆ½Ê±ÊÇÔõôʹÓÃÊÂÎñµÄ¡£ +有了å‰�é�¢çš„两个å°� demo 作为开胃è�œï¼Œå¯¹äºŽ spring 事务处ç�†æƒ³å¿…你已有了一个清晰的认识,spring 在处ç�†äº‹åŠ¡æ—¶ï¼Œä½¿ç”¨çš„å°±æ˜¯ç¬¬äºŒç§�æ–¹å¼�,å�³å¾€è‡ªå®šä¹‰ä¸€ä¸ª `advisor` 添加到 spring 容器中。关于 spring 实现任务的具体细节,我们待会分æž�,这里我们å†�上一个 demo,体验下我们平时是怎么使用事务的。 -ΪÁ˽øÐÐÊý¾Ý¿âÁ¬½Ó£¬ÎÒÃÇÐèÒªÒýÈëÊý¾Ý¿âÁ¬½Ó³Ø£¬ÕâÀïÎÒÃÇʹÓõÄÊÇ mysql£¬ÐèÒªÔÚ `spring-learn.gradle` ÖÐÌí¼ÓÒÀÀµ£º +为了进行数æ�®åº“连接,我们需è¦�引入数æ�®åº“连接池,这里我们使用的是 mysql,需è¦�在 `spring-learn.gradle` 中添加ä¾�赖: ``` optional("mysql:mysql-connector-java:5.1.48") ``` -½ÓמÍÊÇ´úÂëÁË¡£ +接ç�€å°±æ˜¯ä»£ç �了。 -1. ÅäÖÃÀà +1. é…�置类 ``` @Configuration @@ -315,7 +315,7 @@ optional("mysql:mysql-connector-java:5.1.48") public class TxDemo01Config { /** - * Éú³ÉÊý¾ÝÔ´ + * 生æˆ�æ•°æ�®æº� * @return * @throws Exception */ @@ -329,7 +329,7 @@ public class TxDemo01Config { } /** - * Éú³ÉjdbcTemplate£¬ºóÃæ¾ÍÊÇÓÃÕâ¸öÀàÀ´´¦ÀíÊý¾Ý¿âµÄ²Ù×÷ + * 生æˆ�jdbcTemplate,å�Žé�¢å°±æ˜¯ç”¨è¿™ä¸ªç±»æ�¥å¤„ç�†æ•°æ�®åº“çš„æ“�作 * @param dataSource * @return */ @@ -339,7 +339,7 @@ public class TxDemo01Config { } /** - * ÊÂÎñ¹ÜÀíÆ÷ + * 事务管ç�†å™¨ * @param dataSource * @return */ @@ -352,7 +352,7 @@ public class TxDemo01Config { ``` -1. Êý¾Ý¿â²Ù×÷Àà +1. æ•°æ�®åº“æ“�作类 ``` @Service @@ -362,7 +362,7 @@ public class UserService { private JdbcTemplate jdbcTemplate; /** - * Êý¾Ý¿â²åÈë²Ù×÷£¬Ê¹Óà @Transactional ¿ªÆôÊÂÎñ + * æ•°æ�®åº“æ�’å…¥æ“�作,使用 @Transactional å¼€å�¯äº‹åŠ¡ * @return */ @Transactional(rollbackFor = Exception.class) @@ -371,7 +371,7 @@ public class UserService { + "values (?, ?, ?, ?)"; int result = jdbcTemplate.update(sql, "test", "test", new Date(), new Date()); if(true) { - //throw new RuntimeException("Å׳ö¸öÒì³£"); + //throw new RuntimeException("抛出个异常"); } System.out.println(result); return result; @@ -381,7 +381,7 @@ public class UserService { ``` -1. Ö÷Àà +1. 主类 ``` public class TxDemo01Main { @@ -397,46 +397,46 @@ public class TxDemo01Main { ``` -demo ÖУ¬`DataSource` ʹÓà spring ×Ô´øµÄ `SimpleDriverDataSource`£¬`orm` ¿ò¼ÜÒ²ÊÇ spring ÌṩµÄ `jdbcTemplate`£¬Ê¹ÓÃµÄ `user` ±í sql ÈçÏ£º +demo 中,`DataSource` 使用 spring 自带的 `SimpleDriverDataSource`,`orm` 框架也是 spring æ��供的 `jdbcTemplate`,使用的 `user` 表 sql 如下: ``` CREATE TABLE `user` ( - `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT 'Ö÷¼üid', - `login_name` varchar(32) NOT NULL DEFAULT '0' COMMENT 'µÇ¼Ãû', - `nick` varchar(32) NOT NULL DEFAULT '0' COMMENT 'êdzÆ', - `create_time` datetime DEFAULT NULL COMMENT '´´½¨Ê±¼ä', - `update_time` datetime DEFAULT NULL COMMENT '¸üÐÂʱ¼ä', + `id` int(11) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键id', + `login_name` varchar(32) NOT NULL DEFAULT '0' COMMENT '登录å��', + `nick` varchar(32) NOT NULL DEFAULT '0' COMMENT '昵称', + `create_time` datetime DEFAULT NULL COMMENT '创建时间', + `update_time` datetime DEFAULT NULL COMMENT 'æ›´æ–°æ—¶é—´', PRIMARY KEY (`id`), KEY `create_time` (`create_time`) -) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='Óû§±í'; +) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT='用户表'; ``` -Ö´Ðнá¹ûÈçÏ£º +执行结果如下: -µÚÒ»´Î²»Å׳öÒì³££¬Êý¾Ý¿â½á¹û£º +第一次ä¸�抛出异常,数æ�®åº“结果: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-30bbe23a8e0491d1f59378469ad04703e03.png) -µÚ¶þ´ÎÅ׳öÒì³££¬Êý¾Ý¿â½á¹û£º +第二次抛出异常,数æ�®åº“结果: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-edf98369ccef9735d83813cef7af7ea1dcd.png) -µÚÈý´Î²»Å׳öÒì³££¬Êý¾Ý¿â½á¹û£º +第三次ä¸�抛出异常,数æ�®åº“结果: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fab4169dbec7661f27bba203c5e77232f65.png) -¿ÉÒÔ¿´µ½£¬µÚ¶þ´ÎÅ׳öÒ쳣ʱ£¬Êý¾ÝÕý³£»Ø¹öÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œç¬¬äºŒæ¬¡æŠ›å‡ºå¼‚常时,数æ�®æ­£å¸¸å›žæ»šäº†ã€‚ -ÎÒÃÇÔÙÀ´·ÖÎöÏÂÕâ¸ö demo£¬¸úÊÂÎñÓйصĴúÂëÓÐÈý´¦£º +我们å†�æ�¥åˆ†æž�下这个 demo,跟事务有关的代ç �有三处: -* `@EnableTransactionManagement(proxyTargetClass = true)`£ºÆôÓÃÊÂÎñ -* `DataSourceTransactionManager`£ºÊÂÎñ¹ÜÀíÆ÷ -* `@Transactional`£ºÖ¸¶¨¿ªÆôÊÂÎñµÄ·½·¨ +* `@EnableTransactionManagement(proxyTargetClass = true)`:å�¯ç”¨äº‹åŠ¡ +* `DataSourceTransactionManager`:事务管ç�†å™¨ +* `@Transactional`:指定开å�¯äº‹åŠ¡çš„æ–¹æ³• -Àà±ÈÓÚ aop µÄ `@EnableAspectJAutoProxy`£¬`@EnableTransactionManagement` ÊÇÆô¶¯ÊÂÎñµÄÈë¿Ú£¬½Ó×ÅÎÒÃǾʹÓÕâ¸ö×¢½âÈëÊÖ£¬·ÖÎö spring ÊÂÎñµÄÆôÓÃÁ÷³Ì¡£ +类比于 aop çš„ `@EnableAspectJAutoProxy`,`@EnableTransactionManagement` 是å�¯åŠ¨äº‹åŠ¡çš„å…¥å�£ï¼ŒæŽ¥ç�€æˆ‘们就从这个注解入手,分æž� spring 事务的å�¯ç”¨æµ�程。 -### 3. `@EnableTransactionManagement` ×¢½â +### 3. `@EnableTransactionManagement` 注解 ``` @Target(ElementType.TYPE) @@ -446,20 +446,20 @@ CREATE TABLE `user` ( public @interface EnableTransactionManagement { /** - * ѧÍêaopºó£¬Ïë±Ø¶ÔÕâ¸öÊôÐÔÒѾ­ºÜÊìϤ - * true: ±íÊ¾Ç¿ÖÆÊ¹ÓÃcglib´úÀí - * false£ºÈç¹ûÄ¿±êÀàʵÏÖÁ˽ӿڣ¬ÔòʹÓÃjdk¶¯Ì¬´úÀí£¬·ñÔòʹÓÃcglib´úÀí - * ½öÔÚ mode Ϊ PROXY ÏÂÉúЧ + * 学完aopå�Žï¼Œæƒ³å¿…对这个属性已ç»�很熟悉 + * true: 表示强制使用cglib代ç�† + * false:如果目标类实现了接å�£ï¼Œåˆ™ä½¿ç”¨jdk动æ€�代ç�†ï¼Œå�¦åˆ™ä½¿ç”¨cglib代ç�† + * 仅在 mode 为 PROXY 下生效 */ boolean proxyTargetClass() default false; /** - * adviceģʽ£¬Ê¹ÓôúÀí£¬»¹ÊÇʹÓà aspectJ + * advice模å¼�,使用代ç�†ï¼Œè¿˜æ˜¯ä½¿ç”¨ aspectJ */ AdviceMode mode() default AdviceMode.PROXY; /** - * Ö´ÐÐ˳Ðò£¬µ±Ò»¸ö´úÀí¶ÔÏóÓжà¸öÔöǿʱ£¬°´Ê²Ã´ÑùµÄ˳ÐòÀ´Ö´ÐÐ + * 执行顺åº�,当一个代ç�†å¯¹è±¡æœ‰å¤šä¸ªå¢žå¼ºæ—¶ï¼ŒæŒ‰ä»€ä¹ˆæ ·çš„顺åº�æ�¥æ‰§è¡Œ */ int order() default Ordered.LOWEST_PRECEDENCE; @@ -467,7 +467,7 @@ public @interface EnableTransactionManagement { ``` -Õâ¸ö×¢½â±¾Éíûʲô£¬¾ÍÈý¸öÊôÐÔ£¬×¢ÊÍÒѾ­ºÜÃ÷È·ÁË£¬ÎÒÃǹؼü»¹ÊÇ¿´Õâ¸ö×¢½âÒýÈëµÄÀࣺ`TransactionManagementConfigurationSelector`£º +这个注解本身没什么,就三个属性,注释已ç»�很明确了,我们关键还是看这个注解引入的类:`TransactionManagementConfigurationSelector`: ``` public class TransactionManagementConfigurationSelector extends @@ -476,30 +476,30 @@ public class TransactionManagementConfigurationSelector extends protected String[] selectImports(AdviceMode adviceMode) { switch (adviceMode) { case PROXY: - // »ùÓÚ´úÀíµÄÊÂÎñ¹ÜÀí£¬»áÒýÈëÁ½¸öÀà + // 基于代ç�†çš„事务管ç�†ï¼Œä¼šå¼•入两个类 return new String[] {AutoProxyRegistrar.class.getName(), ProxyTransactionManagementConfiguration.class.getName()}; case ASPECTJ: - // »ùÓÚaspectJµÄÊÂÎñ¹ÜÀí£¬»áÒýÈëÕâ¸öÀ࣬±¾ÎIJ»·ÖÎö + // 基于aspectJ的事务管ç�†ï¼Œä¼šå¼•入这个类,本文ä¸�分æž� return new String[] {determineTransactionAspectClass()}; default: return null; } } - // Ê¡ÂÔÆäËû + // çœ�略其他 ... } ``` -»ùÓÚ´úÀíµÄÊÂÎñ¹ÜÀí£¬»áÒýÈëÁ½¸öÀࣺ`AutoProxyRegistrar`¡¢`ProxyTransactionManagementConfiguration`£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÕâÁ½¸öÀà¡£ +基于代ç�†çš„事务管ç�†ï¼Œä¼šå¼•入两个类:`AutoProxyRegistrar`ã€�`ProxyTransactionManagementConfiguration`,接下æ�¥æˆ‘们就æ�¥åˆ†æž�这两个类。 #### 3.1 `AutoProxyRegistrar` -´ÓÃû×ÖÉÏÀ´¿´£¬`AutoProxyRegistrar` ÊÇÒ»¸ö×¢²áÆ÷£¬»¹¼ÇµÃÇ°Ãæ aop µÄ×¢²áÆ÷ `AspectJAutoProxyRegistrar` Âð£¬Á½ÕßÒ»ÑùµÄÌ×·£¡ +从å��字上æ�¥çœ‹ï¼Œ`AutoProxyRegistrar` 是一个注册器,还记得å‰�é�¢ aop 的注册器 `AspectJAutoProxyRegistrar` å�—,两者一样的套路ï¼� -ÎÒÃÇÀ´¿´¿´ÀïÃæ¾¿¾¹×öÁËɶ£º +我们æ�¥çœ‹çœ‹é‡Œé�¢ç©¶ç«Ÿå�šäº†å•¥ï¼š ``` public class AutoProxyRegistrar implements ImportBeanDefinitionRegistrar { @@ -519,15 +519,15 @@ public class AutoProxyRegistrar implements ImportBeanDefinitionRegistrar { } Object mode = candidate.get("mode"); Object proxyTargetClass = candidate.get("proxyTargetClass"); - // Âú×ãifÌõ¼þµÄ£¬¾ÍÊÇ @EnableTransactionManagement ×¢½â + // 满足ifæ�¡ä»¶çš„,就是 @EnableTransactionManagement 注解 if (mode != null && proxyTargetClass != null && AdviceMode.class == mode.getClass() && Boolean.class == proxyTargetClass.getClass()) { candidateFound = true; if (mode == AdviceMode.PROXY) { - // ×¢²á²Ù×÷£¬×îÖÕ×¢²áÁË InfrastructureAdvisorAutoProxyCreator À࣬½ÓÏÂÀ´»á¼ÌÐø·ÖÎö + // 注册æ“�作,最终注册了 InfrastructureAdvisorAutoProxyCreator 类,接下æ�¥ä¼šç»§ç»­åˆ†æž� AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry); if ((Boolean) proxyTargetClass) { - // ʹÓÃcglib´úÀí + // 使用cglib代ç�† AopConfigUtils.forceAutoProxyCreatorToUseClassProxying(registry); return; } @@ -543,33 +543,33 @@ public class AutoProxyRegistrar implements ImportBeanDefinitionRegistrar { ``` -ÕâÐдúÂë¹Ø¼üµÄ¾ÍÖ»ÓÐ if ÀïµÄ¼¸ÐУ¬ÏÈ˵Ï if Ìõ¼þ£º`mode != null && proxyTargetClass != null && AdviceMode.class == mode.getClass() &&Boolean.class == proxyTargetClass.getClass()`£¬Í¨¹ýÉÏÃæµÄ¶Ô `@EnableTransactionManagement`£¬Õâ˵µÄ¾ÍÊÇËüÁË£»¶ÔÓÚ `mode == AdviceMode.PROXY`£¬¼ÌÐøµ÷Óà `AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry)`£¨¹ØÓÚÕâ¸ö·½·¨µÄµ÷Óã¬ÎÒÃǽÓÏÂÀ´»á¼ÌÐø·ÖÎö£©£»È»ºó´¦Àí `proxyTargetClass`£¬Õâ¸öÊôÐÔµÄ×÷ÓÃÓë `@EnableAspectJAutoProxy` ÖÐµÄ `proxyTargetClass` Ò»Ö£¬Ò²ÊÇ¿ÉÒÔÇ¿ÖÆÊ¹Óà cglib ´úÀí¡£ +这行代ç �关键的就å�ªæœ‰ if 里的几行,先说下 if æ�¡ä»¶ï¼š`mode != null && proxyTargetClass != null && AdviceMode.class == mode.getClass() &&Boolean.class == proxyTargetClass.getClass()`,通过上é�¢çš„对 `@EnableTransactionManagement`,这说的就是它了;对于 `mode == AdviceMode.PROXY`,继续调用 `AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry)`(关于这个方法的调用,我们接下æ�¥ä¼šç»§ç»­åˆ†æž�);然å�Žå¤„ç�† `proxyTargetClass`,这个属性的作用与 `@EnableAspectJAutoProxy` 中的 `proxyTargetClass` 一致,也是å�¯ä»¥å¼ºåˆ¶ä½¿ç”¨ cglib 代ç�†ã€‚ -½Ó×ÅÎÒÃÇÀ´·ÖÎöÏ `AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry)` µÄ¹ý³Ì£¬¸ú½ø´úÂ룺 +接ç�€æˆ‘们æ�¥åˆ†æž�下 `AopConfigUtils.registerAutoProxyCreatorIfNecessary(registry)` 的过程,跟进代ç �: > AopConfigUtils ``` @Nullable public static BeanDefinition registerAutoProxyCreatorIfNecessary(BeanDefinitionRegistry registry) { - // ¼ÌÐøÍùÏ¿´ + // 继续往下看 return registerAutoProxyCreatorIfNecessary(registry, null); } @Nullable public static BeanDefinition registerAutoProxyCreatorIfNecessary( BeanDefinitionRegistry registry, @Nullable Object source) { - // ´«Èë InfrastructureAdvisorAutoProxyCreator À࣬¼ÌÐøµ÷Óà + // ä¼ å…¥ InfrastructureAdvisorAutoProxyCreator 类,继续调用 return registerOrEscalateApcAsRequired(InfrastructureAdvisorAutoProxyCreator.class, registry, source); } ``` -¿´µ½ÕâÀÊDz»ÊÇÓÐÖÖÉîÉîµÄÊìϤ¸Ð£¿aop ÖÐµÄ `AspectJAnnotationAutoProxyCreator` Ò² ÊÇÕâôע²áµÄ£¡½øÈë `AopConfigUtils#registerOrEscalateApcAsRequired` ·½·¨£º +看到这里,是ä¸�是有ç§�深深的熟悉感?aop 中的 `AspectJAnnotationAutoProxyCreator` 也 是这么注册的ï¼�进入 `AopConfigUtils#registerOrEscalateApcAsRequired` 方法: ``` -// AopConfigUtils ¿É×¢²áµÄÀà¶¼ÔÚÕâÀïÁË +// AopConfigUtils å�¯æ³¨å†Œçš„类都在这里了 private static final List> APC_PRIORITY_LIST = new ArrayList<>(3); static { @@ -579,29 +579,29 @@ static { } /** - * ×¢²á²Ù×÷ + * 注册æ“�作 */ private static BeanDefinition registerOrEscalateApcAsRequired( Class cls, BeanDefinitionRegistry registry, @Nullable Object source) { Assert.notNull(registry, "BeanDefinitionRegistry must not be null"); - //Èç¹ûÒÑ´æÔÚÕâ¸öbean + //如果已存在这个bean if (registry.containsBeanDefinition(AUTO_PROXY_CREATOR_BEAN_NAME)) { BeanDefinition apcDefinition = registry.getBeanDefinition(AUTO_PROXY_CREATOR_BEAN_NAME); - //ÅжÏÓÅÏȼ¶£¬Èç¹ûÓÅÏȼ¶½Ï¸ßÔòÌæ»»Ô­ÏȵÄbean + //判断优先级,如果优先级较高则替æ�¢åŽŸå…ˆçš„bean if (!cls.getName().equals(apcDefinition.getBeanClassName())) { int currentPriority = findPriorityForClass(apcDefinition.getBeanClassName()); int requiredPriority = findPriorityForClass(cls); - // ÒÑ´æÔÚÀà µÄÓÅÏȼ¶ СÓÚÕýÔÚ×¢²áµÄ£¬ÔòʹÓÃÕýÔÚ×¢²áµÄ£¬ÒÑ´æÔÚµÄÈý¸öÀàµÄÓÅÏȼ¶Îª - // 0: InfrastructureAdvisorAutoProxyCreator(´¦ÀíÊÂÎñ) - // 1: AspectJAwareAdvisorAutoProxyCreator(´¦Àí»ùÓÚxmlµÄaop) - // 2: AnnotationAwareAspectJAutoProxyCreator(´¦Àí»ùÓÚ×¢½âµÄaop) + // 已存在类 的优先级 å°�于正在注册的,则使用正在注册的,已存在的三个类的优先级为 + // 0: InfrastructureAdvisorAutoProxyCreator(处ç�†äº‹åŠ¡) + // 1: AspectJAwareAdvisorAutoProxyCreator(处ç�†åŸºäºŽxmlçš„aop) + // 2: AnnotationAwareAspectJAutoProxyCreator(处ç�†åŸºäºŽæ³¨è§£çš„aop) if (currentPriority < requiredPriority) { apcDefinition.setBeanClassName(cls.getName()); } } return null; } - //×¢²áXxxAutoProxyCreatorµ½ÈÝÆ÷ÖÐ + //注册XxxAutoProxyCreator到容器中 RootBeanDefinition beanDefinition = new RootBeanDefinition(cls); beanDefinition.setSource(source); beanDefinition.getPropertyValues().add("order", Ordered.HIGHEST_PRECEDENCE); @@ -611,7 +611,7 @@ private static BeanDefinition registerOrEscalateApcAsRequired( } /** - * ²éÕÒ×¢²áÀàµÄÓÅÏȼ¶ + * 查找注册类的优先级 */ private static int findPriorityForClass(@Nullable String className) { for (int i = 0; i < APC_PRIORITY_LIST.size(); i++) { @@ -626,18 +626,18 @@ private static int findPriorityForClass(@Nullable String className) { ``` -`AopConfigUtils` ¿É×¢²áµÄÀàÓÐÓÐÈý¸ö£º +`AopConfigUtils` å�¯æ³¨å†Œçš„类有有三个: -* `InfrastructureAdvisorAutoProxyCreator`£º´¦ÀíÊÂÎñ -* `AspectJAwareAdvisorAutoProxyCreator`£º´¦Àí»ùÓÚ xml µÄ aop -* `AnnotationAwareAspectJAutoProxyCreator`£º´¦Àí»ùÓÚ×¢½âµÄ aop +* `InfrastructureAdvisorAutoProxyCreator`:处ç�†äº‹åŠ¡ +* `AspectJAwareAdvisorAutoProxyCreator`:处ç�†åŸºäºŽ xml çš„ aop +* `AnnotationAwareAspectJAutoProxyCreator`:处ç�†åŸºäºŽæ³¨è§£çš„ aop -ÕâÈýÕßµÄÓÅÏȼ¶Îª `AnnotationAwareAspectJAutoProxyCreator` > `AspectJAwareAdvisorAutoProxyCreator` > `InfrastructureAdvisorAutoProxyCreator`£¬×¢Èëʱ£¬»áÅжÏ×¢ÈëÀàµÄÓÅÏȼ¶£¬ÓÅÏȼ¶¸ßµÄ×îÖջᱻעÈëµ½ spring ÈÝÆ÷ÖС£ÕâÑù¾Íµ¼ÖÂÁËÒ»¸öÎÊÌ⣺**Èç¹ûÏîÄ¿ÖÐͬʱ¿ªÆôÁË aop (`@EnableAspectJAutoProxy`) ÓëÊÂÎñ (`@EnableTransactionManagement`)£¬ÄÇô×îÖÕ×¢Èëµ½ÈÝÆ÷µÄ½«ÊÇ `AnnotationAwareAspectJAutoProxyCreator`£¬ÕâÒ²¾ÍÊÇ˵£¬`AnnotationAwareAspectJAutoProxyCreator` Ò²ÄÜ´¦ÀíÊÂÎñ£¡** Õâ¾ä»°·Ç³£¹Ø¼ü£¬ËüÒâζ×ÅÊÂÎñµÄ´¦Àí¹ý³Ì£¬Êµ¼ÊÉϾͰüº¬ÔÚÇ°Ãæ·ÖÎöµÄ aop µÄ¹ý³ÌÖÐÁË£¡ +这三者的优先级为 `AnnotationAwareAspectJAutoProxyCreator` > `AspectJAwareAdvisorAutoProxyCreator` > `InfrastructureAdvisorAutoProxyCreator`,注入时,会判断注入类的优先级,优先级高的最终会被注入到 spring 容器中。这样就导致了一个问题:**如果项目中å�Œæ—¶å¼€å�¯äº† aop (`@EnableAspectJAutoProxy`) 与事务 (`@EnableTransactionManagement`),那么最终注入到容器的将是 `AnnotationAwareAspectJAutoProxyCreator`,这也就是说,`AnnotationAwareAspectJAutoProxyCreator` 也能处ç�†äº‹åŠ¡ï¼�** è¿™å�¥è¯�é�žå¸¸å…³é”®ï¼Œå®ƒæ„�味ç�€äº‹åŠ¡çš„å¤„ç�†è¿‡ç¨‹ï¼Œå®žé™…上就包å�«åœ¨å‰�é�¢åˆ†æž�çš„ aop 的过程中了ï¼� -ÎÒÃÇÒ²À´¿´¿´ `InfrastructureAdvisorAutoProxyCreator`£º +我们也æ�¥çœ‹çœ‹ `InfrastructureAdvisorAutoProxyCreator`: ``` -// ¼Ì³ÐÁË AbstractAdvisorAutoProxyCreator£¬Õâ¸öÀà·Ç³£¹Ø¼ü +// 继承了 AbstractAdvisorAutoProxyCreator,这个类é�žå¸¸å…³é”® public class InfrastructureAdvisorAutoProxyCreator extends AbstractAdvisorAutoProxyCreator { @Nullable @@ -661,23 +661,23 @@ public class InfrastructureAdvisorAutoProxyCreator extends AbstractAdvisorAutoPr ``` -`InfrastructureAdvisorAutoProxyCreator` Æäʵ²¢Ã»ÓÐ×öʲôÓë aop Ïà¹ØµÄÊ£¬µ«Ëü¼Ì³ÐÁËÒ»¸ö¹Ø¼üµÄÀࣺ`AbstractAdvisorAutoProxyCreator`£¬Õâ¸öÀà¿ÉÊÇ´óÓÐÀ´Í·£º +`InfrastructureAdvisorAutoProxyCreator` 其实并没有å�šä»€ä¹ˆä¸Ž aop 相关的事,但它继承了一个关键的类:`AbstractAdvisorAutoProxyCreator`,这个类å�¯æ˜¯å¤§æœ‰æ�¥å¤´ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-2881f63ac07afc5095c449ddb9a0df2bb55.png) -´Ó¼Ì³Ð¹ØÏµÀ´¿´£¬Õâ¸öÀà¼Ì³ÐÁË `AbstractAutoProxyCreator`£¬¶ø `AbstractAutoProxyCreator` ÕýÊÇÎÒÃÇÔÚ - [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨ÉÏ£©](https://my.oschina.net/funcy/blog/4678817) Óë [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)ÖÐÖØµã·ÖÎöµÄ¡¢´úÀí¶ÔÏóµÄ²úÉúËùÔÚ£¡ +从继承关系æ�¥çœ‹ï¼Œè¿™ä¸ªç±»ç»§æ‰¿äº† `AbstractAutoProxyCreator`,而 `AbstractAutoProxyCreator` 正是我们在 - [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(上)](https://my.oschina.net/funcy/blog/4678817) 与 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)中é‡�点分æž�çš„ã€�代ç�†å¯¹è±¡çš„产生所在ï¼� -ÎÒÃÇÔÙÀ´¿´Ï `AnnotationAwareAspectJAutoProxyCreator`¡¢`AspectJAwareAdvisorAutoProxyCreator` ¡¢`InfrastructureAdvisorAutoProxyCreator` ÕâÈýÕߵĹØÏµ£º +我们å†�æ�¥çœ‹ä¸‹ `AnnotationAwareAspectJAutoProxyCreator`ã€�`AspectJAwareAdvisorAutoProxyCreator` ã€�`InfrastructureAdvisorAutoProxyCreator` 这三者的关系: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-acd72335503eeb686abe81d930b45f1f3f0.png) -¿ÉÒÔ¿´µ½£¬`AspectJAwareAdvisorAutoProxyCreator` ¡¢`InfrastructureAdvisorAutoProxyCreator` ¶¼¼Ì³ÐÁË `AbstractAdvisorAutoProxyCreator`£¬`AnnotationAwareAspectJAutoProxyCreator` Óּ̳ÐÁË `AspectJAwareAdvisorAutoProxyCreator`¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`AspectJAwareAdvisorAutoProxyCreator` ã€�`InfrastructureAdvisorAutoProxyCreator` 都继承了 `AbstractAdvisorAutoProxyCreator`,`AnnotationAwareAspectJAutoProxyCreator` å�ˆç»§æ‰¿äº† `AspectJAwareAdvisorAutoProxyCreator`。 -ͨ¹ýÒÔÉÏ·ÖÎö£¬`AutoProxyRegistrar` ×îÖÕÏò spring ÈÝÆ÷×¢²áÁË `InfrastructureAdvisorAutoProxyCreator`(`aop` δÆôÓõÄÇé¿öÏÂ)£¬Èç¹ûÆôÓÃÁË `aop`£¬Ôò»á×¢²á `AspectJAwareAdvisorAutoProxyCreator`(»ùÓÚ `xml` µÄ `aop`) »ò `AnnotationAwareAspectJAutoProxyCreator`(»ùÓÚ `annotation` µÄ `aop`)¡£ +通过以上分æž�,`AutoProxyRegistrar` 最终å�‘ spring 容器注册了 `InfrastructureAdvisorAutoProxyCreator`(`aop` 未å�¯ç”¨çš„æƒ…况下),如果å�¯ç”¨äº† `aop`,则会注册 `AspectJAwareAdvisorAutoProxyCreator`(基于 `xml` çš„ `aop`) 或 `AnnotationAwareAspectJAutoProxyCreator`(基于 `annotation` çš„ `aop`)。 #### 3.2 `ProxyTransactionManagementConfiguration` -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `ProxyTransactionManagementConfiguration` Àà¡£Ãû×ÖÉÏÀ´¿´£¬ÕâÊǸöÅäÖÃÀࣺ +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `ProxyTransactionManagementConfiguration` 类。å��字上æ�¥çœ‹ï¼Œè¿™æ˜¯ä¸ªé…�置类: ``` @Configuration(proxyBeanMethods = false) @@ -685,7 +685,7 @@ public class ProxyTransactionManagementConfiguration extends AbstractTransactionManagementConfiguration { /** - * ¶ÁÈ¡SpringµÄ @Transactional ×¢½â£¬²¢½«ÏàÓ¦µÄÊÂÎñÊôÐÔ¹«¿ª¸øSpringµÄÊÂÎñ»ù´¡½á¹¹ + * 读å�–Springçš„ @Transactional 注解,并将相应的事务属性公开给Spring的事务基础结构 */ @Bean @Role(BeanDefinition.ROLE_INFRASTRUCTURE) @@ -694,15 +694,15 @@ public class ProxyTransactionManagementConfiguration } /** - * TransactionInterceptor¼Ì³ÐÁËAdvice£¬Õâ¸öÀàÊǸöadvice£¬ÓÃÀ´´¦ÀíÊÂÎñµÄÖ´ÐвÙ×÷ - * @param transactionAttributeSource£ºÀ´×ÔÓÚÉÏÃæµÄ transactionAttributeSource() ·½·¨ + * TransactionInterceptor继承了Advice,这个类是个advice,用æ�¥å¤„ç�†äº‹åŠ¡çš„æ‰§è¡Œæ“�作 + * @param transactionAttributeSource:æ�¥è‡ªäºŽä¸Šé�¢çš„ transactionAttributeSource() 方法 */ @Bean @Role(BeanDefinition.ROLE_INFRASTRUCTURE) public TransactionInterceptor transactionInterceptor( TransactionAttributeSource transactionAttributeSource) { TransactionInterceptor interceptor = new TransactionInterceptor(); - // ÉèÖÃÊÂÎñÊôÐÔ´¦Àí¶ÔÏ󣬾ÍÊÇÓÃÀ´´¦Àí @Transactional ×¢½â µÄ¶ÁÈ¡ + // 设置事务属性处ç�†å¯¹è±¡ï¼Œå°±æ˜¯ç”¨æ�¥å¤„ç�† @Transactional 注解 的读å�– interceptor.setTransactionAttributeSource(transactionAttributeSource); if (this.txManager != null) { interceptor.setTransactionManager(this.txManager); @@ -711,9 +711,9 @@ public class ProxyTransactionManagementConfiguration } /** - * ÊÂÎñÔöÇ¿Æ÷. - * @param transactionAttributeSource£ºÀ´×ÔÓÚÉÏÃæµÄ transactionAttributeSource() ·½·¨ - * @param transactionInterceptor£ºÀ´×ÔÓÚÉÏÃæµÄ transactionInterceptor(...) ·½·¨ + * 事务增强器. + * @param transactionAttributeSource:æ�¥è‡ªäºŽä¸Šé�¢çš„ transactionAttributeSource() 方法 + * @param transactionInterceptor:æ�¥è‡ªäºŽä¸Šé�¢çš„ transactionInterceptor(...) 方法 */ @Bean(name = TransactionManagementConfigUtils.TRANSACTION_ADVISOR_BEAN_NAME) @Role(BeanDefinition.ROLE_INFRASTRUCTURE) @@ -722,9 +722,9 @@ public class ProxyTransactionManagementConfiguration TransactionInterceptor transactionInterceptor) { BeanFactoryTransactionAttributeSourceAdvisor advisor = new BeanFactoryTransactionAttributeSourceAdvisor(); - // ÊÂÎñÊôÐÔÀ࣬ÓÃÀ´±£´æ @Transactional µÄÊôÐÔ + // 事务属性类,用æ�¥ä¿�å­˜ @Transactional 的属性 advisor.setTransactionAttributeSource(transactionAttributeSource); - // ÅäÖÃadvice£¬ÔÚadviceÀï´¦ÀíÊÂÎñ + // é…�ç½®advice,在advice里处ç�†äº‹åŠ¡ advisor.setAdvice(transactionInterceptor); if (this.enableTx != null) { advisor.setOrder(this.enableTx.getNumber("order")); @@ -736,13 +736,13 @@ public class ProxyTransactionManagementConfiguration ``` -¿ÉÒÔ¿´µ½Õâ¸öÀàÒýÈëÁËÒ» Щ `bean`£º +å�¯ä»¥çœ‹åˆ°è¿™ä¸ªç±»å¼•入了一 些 `bean`: -* `transactionAttributeSource`£ºÀàÐÍΪ `AnnotationTransactionAttributeSource`£¬ÓÃÀ´½âÎö `@Transactional` ×¢½â£» -* `transactionInterceptor`£ºÀàÐÍΪ `TransactionInterceptor`£¬`Advice` µÄ×ÓÀ࣬´¦ÀíÊÂÎñµÄÂß¼­ÔÚÕâ¸öÀàÀ -* `transactionAdvisor`£ºÀàÐÍΪ `BeanFactoryTransactionAttributeSourceAdvisor`£¬ÕâÊǸö `Advisor`£¬ÓÃÀ´´¦ÀíÇÐÃæÂß¼­£¬ÄÚ²¿¼¯³ÉÁËÉÏÃæÁ½¸ö¶ÔÏó£º`transactionAttributeSource` Óë `transactionInterceptor`£» +* `transactionAttributeSource`:类型为 `AnnotationTransactionAttributeSource`,用æ�¥è§£æž� `@Transactional` 注解; +* `transactionInterceptor`:类型为 `TransactionInterceptor`,`Advice` çš„å­�类,处ç�†äº‹åŠ¡çš„é€»è¾‘åœ¨è¿™ä¸ªç±»é‡Œï¼› +* `transactionAdvisor`:类型为 `BeanFactoryTransactionAttributeSourceAdvisor`,这是个 `Advisor`,用æ�¥å¤„ç�†åˆ‡é�¢é€»è¾‘,内部集æˆ�了上é�¢ä¸¤ä¸ªå¯¹è±¡ï¼š`transactionAttributeSource` 与 `transactionInterceptor`ï¼› -`ProxyTransactionManagementConfiguration` ¼Ì³ÐÁË `AbstractTransactionManagementConfiguration`£¬¶ø `AbstractTransactionManagementConfiguration` ÖÐÒ²ÒýÈëÁËһЩ `bean`£º +`ProxyTransactionManagementConfiguration` 继承了 `AbstractTransactionManagementConfiguration`,而 `AbstractTransactionManagementConfiguration` 中也引入了一些 `bean`: ``` @Configuration @@ -752,13 +752,13 @@ public abstract class AbstractTransactionManagementConfiguration implements Impo protected AnnotationAttributes enableTx; /** - * ±£´æÊÂÎñ¹ÜÀíÆ÷ + * ä¿�存事务管ç�†å™¨ */ @Nullable protected TransactionManager txManager; /** - * À´×ÔÓÚ ImportAware ½Ó¿ÚµÄ·½·¨ + * æ�¥è‡ªäºŽ ImportAware 接å�£çš„æ–¹æ³• */ @Override public void setImportMetadata(AnnotationMetadata importMetadata) { @@ -772,11 +772,11 @@ public abstract class AbstractTransactionManagementConfiguration implements Impo } /** - * ÅäÖÃÊÂÎñ¹ÜÀíÆ÷. - * ×¢ÈëspringÈÝÆ÷ÖÐËùÓÐµÄ TransactionManagementConfigurer ¶ÔÏó - * TransactionManagementConfigurer¾ÍÖ»ÓÐÒ»¸ö·½·¨£º + * é…�置事务管ç�†å™¨. + * 注入spring容器中所有的 TransactionManagementConfigurer 对象 + * TransactionManagementConfigurerå°±å�ªæœ‰ä¸€ä¸ªæ–¹æ³•: * TransactionManager annotationDrivenTransactionManager() - * Õâ¸ö·½·¨ÓÃÀ´·µ»ØÒ»¸öÊÂÎñ¹ÜÀíÆ÷ + * 这个方法用æ�¥è¿”回一个事务管ç�†å™¨ */ @Autowired(required = false) void setConfigurers(Collection configurers) { @@ -791,7 +791,7 @@ public abstract class AbstractTransactionManagementConfiguration implements Impo } /** - * ´¦Àíʼþ¼àÌý£¬ÓÃÀ´´¦Àí @TransactionalEventListener ×¢½âµÄ·½·¨. + * 处ç�†äº‹ä»¶ç›‘å�¬ï¼Œç”¨æ�¥å¤„ç�† @TransactionalEventListener 注解的方法. */ @Bean(name = TransactionManagementConfigUtils.TRANSACTIONAL_EVENT_LISTENER_FACTORY_BEAN_NAME) @Role(BeanDefinition.ROLE_INFRASTRUCTURE) @@ -803,23 +803,23 @@ public abstract class AbstractTransactionManagementConfiguration implements Impo ``` -* `void setConfigurers(Collection configurers)`£º×¢Èë `TransactionManagementConfigurer` ¶ÔÏ󣬾ßÌå×÷ÓÃÒÑÔÚ´úÂë×¢ÊÍÖÐ˵Ã÷£» -* `TransactionalEventListenerFactory`£ºÀàÐÍΪ `TransactionalEventListenerFactory`£¬ÓÃÀ´´¦ÀíÊÂÎñʼþ£¨Ö÷ÒªÊÇ `@TransactionalEventListener` ×¢½âµÄ·½·¨£¬¹ØÓÚÕⲿ·ÖµÄÄÚÈÝ£¬±¾ÎľͲ»Õ¹¿ªÁË£©¡£ +* `void setConfigurers(Collection configurers)`:注入 `TransactionManagementConfigurer` 对象,具体作用已在代ç �注释中说明; +* `TransactionalEventListenerFactory`:类型为 `TransactionalEventListenerFactory`,用æ�¥å¤„ç�†äº‹åŠ¡äº‹ä»¶ï¼ˆä¸»è¦�是 `@TransactionalEventListener` 注解的方法,关于这部分的内容,本文就ä¸�展开了)。 -ºÃÁË£¬ÓÐÁËÕâЩ¶ÔÏóºó£¬spring ¾Í¿ÉÒÔ½øÐÐÊÂÎñ´¦ÀíÁË£¬ÕâЩÎÒÃÇÁôµ½ÏÂÆªÎÄÕÂÔÙ·ÖÎö¡£ +好了,有了这些对象å�Žï¼Œspring å°±å�¯ä»¥è¿›è¡Œäº‹åС处ç�†äº†ï¼Œè¿™äº›æˆ‘们留到下篇文章å†�分æž�。 -### 4\. ×ܽá +### 4\. 总结 -±¾ÎÄÏÈÊÇ´ÓÁ½¸ö demo ÈëÊÖ£¬Ê¾·¶ÁËÈç¹ûÊÇÓÉÎÒÃÇ×Ô¼º¿ª·¢Ò»¸ö»ùÓÚ spring aop µÄÊÂÎñ¹ÜÀí¹¦ÄÜÊÇÈçºÎ½øÐе쬽Ó×ÅÓÖÓÃÒ»¸ö demo ʾ·¶ÁËÈçºÎʹÓà spring ÌṩµÄÊÂÎñ¹ÜÀí¹¦ÄÜ£¬È»ºó¾Í¾ßÌå·ÖÎöÁË spring ÊÂÎñÆôÓÃ×¢½â `@EnableTransactionManagement` µÄ¹¦ÄÜ¡£ +本文先是从两个 demo 入手,示范了如果是由我们自己开å�‘一个基于 spring aop 的事务管ç�†åŠŸèƒ½æ˜¯å¦‚ä½•è¿›è¡Œçš„ï¼ŒæŽ¥ç�€å�ˆç”¨ä¸€ä¸ª demo 示范了如何使用 spring æ��供的事务管ç�†åŠŸèƒ½ï¼Œç„¶å�Žå°±å…·ä½“分æž�了 spring 事务å�¯ç”¨æ³¨è§£ `@EnableTransactionManagement` 的功能。 -`@EnableTransactionManagement` ÊÇ spring ÖÐÓÃÀ´ÆôÓÃÊÂÎñ¹ÜÀí¹¦Äܵģ¬ÔÚ `AdviceMode` Ϊ `proxy` ģʽÏ£¬¸Ã×¢½âÏò spring ÖÐÒýÈëÁËÁ½¸öÀࣺ`AutoProxyRegistrar`¡¢`ProxyTransactionManagementConfiguration`£¬×÷ÓÃÈçÏ£º +`@EnableTransactionManagement` 是 spring 中用æ�¥å�¯ç”¨äº‹åŠ¡ç®¡ç�†åŠŸèƒ½çš„ï¼Œåœ¨ `AdviceMode` 为 `proxy` 模å¼�下,该注解å�‘ spring 中引入了两个类:`AutoProxyRegistrar`ã€�`ProxyTransactionManagementConfiguration`,作用如下: -* `AutoProxyRegistrar`£º`aop` δÆôÓõÄÇé¿öÏ£¬»áÏò spring ÈÝÆ÷ÖÐ×¢²á `InfrastructureAdvisorAutoProxyCreator`£»Èç¹ûÆôÓÃÁË `aop`£¬Ôò»á×¢²á `AspectJAwareAdvisorAutoProxyCreator`(»ùÓÚ `xml` µÄ `aop`) »ò `AnnotationAwareAspectJAutoProxyCreator`(»ùÓÚ `annotation` µÄ `aop`)¡£ÕâÈý¸öÀà¶¼ÊÇ `AbstractAdvisorAutoProxyCreator` µÄ×ÓÀ࣬ÓÃÀ´Éú³É´úÀí¶ÔÏó¡£ +* `AutoProxyRegistrar`:`aop` 未å�¯ç”¨çš„æƒ…况下,会å�‘ spring 容器中注册 `InfrastructureAdvisorAutoProxyCreator`;如果å�¯ç”¨äº† `aop`,则会注册 `AspectJAwareAdvisorAutoProxyCreator`(基于 `xml` çš„ `aop`) 或 `AnnotationAwareAspectJAutoProxyCreator`(基于 `annotation` çš„ `aop`)。这三个类都是 `AbstractAdvisorAutoProxyCreator` çš„å­�类,用æ�¥ç”Ÿæˆ�代ç�†å¯¹è±¡ã€‚ -* `ProxyTransactionManagementConfiguration`£ºÕâÊÇÒ»¸öÅäÖÃÀ࣬ͨ¹ý´øÓÐ `@Bean` ×¢½âµÄ·½·¨ÏòÈÝÆ÷ÖÐÒýÈëÁËһϵÁÐµÄ bean£¬ÓÃÀ´´¦ÀíÊÂÎñÂß¼­£¬¶ÔÕâЩ bean£¬±¾ÎÄÖ»Ðè´ó¸ÅÁ˽⼴¿É¡£ +* `ProxyTransactionManagementConfiguration`:这是一个é…�置类,通过带有 `@Bean` 注解的方法å�‘容器中引入了一系列的 bean,用æ�¥å¤„ç�†äº‹åŠ¡é€»è¾‘ï¼Œå¯¹è¿™äº› bean,本文å�ªéœ€å¤§æ¦‚了解å�³å�¯ã€‚ -±¾ÎľÍÏȵ½ÕâÀïÁË£¬ÏÂÆªÎÄÕ¼ÌÐø·ÖÎöÊÂÎñ´¦Àí»úÖÆ¡£ +本文就先到这里了,下篇文章继续分æž�事务处ç�†æœºåˆ¶ã€‚ * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4773454](https://my.oschina.net/funcy/blog/4773454) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4773454](https://my.oschina.net/funcy/blog/4773454) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\211\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20601.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\211\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20601.md" index 73a5691..1d1dc85 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\211\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20601.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\270\211\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20601.md" @@ -1,54 +1,54 @@ -ÔÚÉÏһƪÎÄÕµÄ×îºó£¬ÎÒÃÇÌáµ½ÊÂÎñµÄÖ´ÐÐÔÚ `TransactionAspectSupport#invokeWithinTransaction` ·½·¨ÖУ¬±¾ÎĽ«´ÓÕâ¸ö·½·¨³ö·¢£¬Ì½¾¿ spring µÄÊÂÎñ»úÖÆ¡£ +在上一篇文章的最å�Žï¼Œæˆ‘们æ��到事务的执行在 `TransactionAspectSupport#invokeWithinTransaction` 方法中,本文将从这个方法出å�‘,探究 spring 的事务机制。 -×¢£º±¾ÎÄËù̽ÌÖµÄÊý¾Ý¿âÊÇ `mysql`£¬ÆäËûÊý¾Ý¿â¿ÉÄÜ»áÓÐËù²îÒì¡£ +注:本文所探讨的数æ�®åº“是 `mysql`,其他数æ�®åº“å�¯èƒ½ä¼šæœ‰æ‰€å·®å¼‚。 -### 1. ÊÂÎñÏà¹Ø¸ÅÄî +### 1. 事务相关概念 -ÔÚÕýʽ·ÖÎöÊÂÎñÔ´Âëǰ£¬Ò»Ð©Ç°ÖÃ֪ʶ»¹ÊÇÒªÁ˽âһϵģ¬ÕâÀïÖ÷Òª½éÉÜÓë spring Ïà¹ØµÄÊÂÎñ¸ÅÄî¡£ +在正å¼�分æž�事务æº�ç �å‰�,一些å‰�置知识还是è¦�了解一下的,这里主è¦�介ç»�与 spring 相关的事务概念。 -#### 1.1 ÊÂÎñµÄ¸ôÀë¼¶±ð +#### 1.1 事务的隔离级别 -ÊÂÎñÓÐËÄ´óÌØÐÔ `ACID`£¬ÁоÙÈçÏ£º +事务有四大特性 `ACID`,列举如下: -- Ô­×ÓÐÔ£¨`Atomicity`£© -- Ò»ÖÂÐÔ£¨`Consistency`£© -- ¸ôÀëÐÔ£¨`Isolation`£© -- ³Ö¾ÃÐÔ£¨`Durability`£© +- 原å­�性(`Atomicity`) +- 一致性(`Consistency`) +- 隔离性(`Isolation`) +- æŒ�久性(`Durability`) -¶øÊÂÎñµÄ¸ôÀë¼¶±ðÕýÊǶԸôÀëÐÔ£¨`Isolation`£©µÄ½øÒ»²½»®·Ö£¬ÕâЩ¸ôÀë¼¶±ðÈçÏ£º +而事务的隔离级别正是对隔离性(`Isolation`)的进一步划分,这些隔离级别如下: -- `¶ÁδÌá½»` -- `¶ÁÌá½»` -- `¿ÉÖØ¸´¶Á` -- `´®Ðл¯` +- `读未æ��交` +- `读æ��交` +- `å�¯é‡�å¤�读` +- `串行化` -¹ØÓÚÕâЩ¸ÅÄî±¾ÎIJ¢²»»áÉîÈë½â¶Á£¬ÎÒÃÇÖØµã»¹ÊǹØ×¢ spring Ïà¹ØµÄÄÚÈÝ£¬spring ¶ÔÊÂÎñ¸ôÀë¼¶±ðµÄ¶¨ÒåÔÚ `org.springframework.transaction.annotation.Isolation` ÖУ¬´úÂëÈçÏ£º +关于这些概念本文并ä¸�会深入解读,我们é‡�点还是关注 spring 相关的内容,spring 对事务隔离级别的定义在 `org.springframework.transaction.annotation.Isolation` 中,代ç �如下: ``` public enum Isolation { /** - * ĬÈÏÖµ£¬²»ÉèÖøôÀë¼¶±ð£¬×îÖÕʹÓõÄÊÇÊý¾Ý¿âÉèÖõĸôÀë¼¶±ð + * 默认值,ä¸�设置隔离级别,最终使用的是数æ�®åº“设置的隔离级别 */ DEFAULT(TransactionDefinition.ISOLATION_DEFAULT), /** - * ¶ÁδÌá½» + * 读未æ��交 */ READ_UNCOMMITTED(TransactionDefinition.ISOLATION_READ_UNCOMMITTED), /** - * ¶ÁÌá½» + * 读æ��交 */ READ_COMMITTED(TransactionDefinition.ISOLATION_READ_COMMITTED), /** - * ¿ÉÖØ¸´¶Á + * å�¯é‡�å¤�读 */ REPEATABLE_READ(TransactionDefinition.ISOLATION_REPEATABLE_READ), /** - * ´®Ðл¯ + * 串行化 */ SERIALIZABLE(TransactionDefinition.ISOLATION_SERIALIZABLE); @@ -56,92 +56,92 @@ public enum Isolation { } ``` -ÎÒÃÇ¿ÉÒÔʹÓà `@Transactional` ×¢½âµÄ `isolation` À´ÉèÖøôÀë¼¶±ð +我们å�¯ä»¥ä½¿ç”¨ `@Transactional` 注解的 `isolation` æ�¥è®¾ç½®éš”离级别 -#### 1.2 ÊÂÎñµÄ³¬Ê±Ê±¼ä +#### 1.2 事务的超时时间 -- ¿ÉÒÔ¸øÊÂÎñÖ¸¶¨Ò»¸öÖ´ÐÐʱ¼ä£¬Èç¹ûÖ´ÐÐÏûºÄµÄʱ¼ä³¬¹ýÁËÖ¸¶¨Ê±¼ä£¬ÊÂÎñ¾Í»áÅ׳öÒì³£´Ó¶ø»Ø¹ö -- ¿ÉÒÔÔÚ `@Transactional` ×¢½âµÄ `timeout` À´ÉèÖó¬Ê±Ê±¼ä +- å�¯ä»¥ç»™äº‹åŠ¡æŒ‡å®šä¸€ä¸ªæ‰§è¡Œæ—¶é—´ï¼Œå¦‚æžœæ‰§è¡Œæ¶ˆè€—çš„æ—¶é—´è¶…è¿‡äº†æŒ‡å®šæ—¶é—´ï¼Œäº‹åŠ¡å°±ä¼šæŠ›å‡ºå¼‚å¸¸ä»Žè€Œå›žæ»š +- å�¯ä»¥åœ¨ `@Transactional` 注解的 `timeout` æ�¥è®¾ç½®è¶…æ—¶æ—¶é—´ -#### 1.3 Ö»¶ÁÊÂÎñ +#### 1.3 å�ªè¯»äº‹åŠ¡ -- ¿ÉÒÔ½«ÊÂÎñÉèÖÃΪ`Ö»¶Áģʽ`£¬Õâ¸öÎÒÆ½Ê±Óûù±¾Ã»Óõ½£¬²éµ½Ò»Ð©ÎÄÕÂ˵£¬½«ÊÂÎñÉèÖÃΪ`Ö»¶Áģʽ`ºó£¬ÆäËûÊÂÎñÖеĸüÐÂÖ»¶ÁÊÂÎñ¿´²»µ½£¬ÇÒÖ»¶ÁÊÂÎñÖв»ÄÜÓÐд²Ù×÷£¬ÕæÊµÐÔÓдýÑéÖ¤ -- ÎÒÃÇ¿ÉÒÔʹÓà `@Transactional` ×¢½âµÄ `readOnly` À´ÉèÖÃÖ»¶Áģʽ +- å�¯ä»¥å°†äº‹åŠ¡è®¾ç½®ä¸º`å�ªè¯»æ¨¡å¼�`,这个我平时用基本没用到,查到一些文章说,将事务设置为`å�ªè¯»æ¨¡å¼�`å�Žï¼Œå…¶ä»–事务中的更新å�ªè¯»äº‹åŠ¡çœ‹ä¸�到,且å�ªè¯»äº‹åС䏭ä¸�能有写æ“�作,真实性有待验è¯� +- 我们å�¯ä»¥ä½¿ç”¨ `@Transactional` 注解的 `readOnly` æ�¥è®¾ç½®å�ªè¯»æ¨¡å¼� -#### 1.4 ÊÂÎñµÄ´«²¥ÀàÐÍ +#### 1.4 事务的传播类型 -ÎÒÃÇÊÔÏëÒ»ÖÖÇé¿ö£º`·½·¨A` Óë`·½Ê½B` ¶¼¿ªÆôÁËÊÂÎñ£¬ÔÚ`·½·¨B` Öе÷ÓÃ`·½·¨A`£¬Èç¹ûÔÚ`·½·¨A` Ö´ÐÐÍê³Éºó£¬`·½·¨B` ±¨´íÁË£¬´úÂëʾÒâÈçÏ£º +我们试想一ç§�情况:`方法A` 与`æ–¹å¼�B` 都开å�¯äº†äº‹åŠ¡ï¼Œåœ¨`方法B` 中调用`方法A`,如果在`方法A` 执行完æˆ�å�Žï¼Œ`方法B` 报错了,代ç �示æ„�如下: ``` class A { - // ¿ªÆôÁËÊÂÎñ + // å¼€å�¯äº†äº‹åŠ¡ @Transactional public void methdA() { - // ´¦ÀíһЩ²Ù×÷ + // 处ç�†ä¸€äº›æ“�作 ... } } class B { - // ¿ªÆôÁËÊÂÎñ + // å¼€å�¯äº†äº‹åŠ¡ @Transactional public void methodB() { - // 1. ´¦ÀíһЩ²Ù×÷ + // 1. 处ç�†ä¸€äº›æ“�作 ... - // 2. µ÷Óà methodA() + // 2. 调用 methodA() a.methodA(); - // 3. ÕâÀﱨ¸ö´í + // 3. 这里报个错 throw new RuntimeException(); } } ``` -ÓÉÓÚ¿ªÆôÁËÊÂÎñ£¬`·½·¨B` ÊÇÒ»¶¨»á»Ø¹öµÄ£¬ÄÇô`·½·¨A` Òª²»Òª»Ø¹öÄØ£¿ +由于开å�¯äº†äº‹åŠ¡ï¼Œ`方法B` 是一定会回滚的,那么`方法A` è¦�ä¸�è¦�回滚呢? -- Èç¹ûÎÒÃǰÑ`·½·¨A` Óë`·½·¨B` µÄÊÂÎñ¿´³ÉÊÇͬһ¸öÊÂÎñ£¬`·½·¨A` Ó¦¸ÃÒ²ÊÇÒª»Ø¹öµÄ -- Èç¹ûÎÒÃǰÑ`·½·¨A` Óë`·½·¨B` ¿´³ÉÊÇÔÚÁ½¸ö¶ÀÁ¢µÄÊÂÎñÖÐÖ´ÐУ¬`·½·¨A` µÄÖ´ÐÐÓë`·½·¨B` µÄ±¨´íÎ޹أ¬`·½·¨A` ¾Í²»Ó¦¸Ã»Ø¹ö +- 如果我们把`方法A` 与`方法B` 的事务看æˆ�是å�Œä¸€ä¸ªäº‹åŠ¡ï¼Œ`方法A` 应该也是è¦�回滚的 +- 如果我们把`方法A` 与`方法B` 看æˆ�是在两个独立的事务中执行,`方法A` 的执行与`方法B` 的报错无关,`方法A` å°±ä¸�应该回滚 -ΪÁË´¦ÀíÕâÖÖ¾À·×£¬spring ÒýÈëÁË`ÊÂÎñµÄ´«²¥ÀàÐÍ`µÄ¸ÅÄÎÒÃÇ¿ÉÒÔʹÓà `@Transactional` ×¢½âµÄ `propagation` À´ÉèÖÃÖ»¶Áģʽ£º +为了处ç�†è¿™ç§�纠纷,spring 引入了`事务的传播类型`的概念,我们å�¯ä»¥ä½¿ç”¨ `@Transactional` 注解的 `propagation` æ�¥è®¾ç½®å�ªè¯»æ¨¡å¼�: ``` public @interface Transactional { ... - // ĬÈϵļ¶±ðΪ Propagation.REQUIRED + // 默认的级别为 Propagation.REQUIRED Propagation propagation() default Propagation.REQUIRED; } ``` -spring Ò»¹²¶¨ÒåÁË 7 ÖÖÊÂÎñµÄ´«²¥ÀàÐÍ£¬ÁоÙÈçÏ£º +spring 一共定义了 7 ç§�事务的传播类型,列举如下: -| ÊÂÎñ´«²¥ÐÐΪ | ÃèÊö | +| 事务传播行为 | æ��è¿° | | --------------------------- | ------------------------------------------------------------ | -| `PROPAGATION_REQUIRED` | ¡¾Ä¬ÈÏÖµ£º±ØÐè¡¿µ±Ç°·½·¨±ØÐëÔÚÊÂÎñÖÐÔËÐУ¬Èç¹ûµ±Ç°Ïß³ÌÖÐûÓÐÊÂÎñ£¬Ôò¿ªÆôÒ»¸öеÄÊÂÎñ£»Èç¹ûµ±Ç°Ïß³ÌÖÐÒѾ­´æÔÚÊÂÎñ£¬Ôò·½·¨½«»áÔÚ¸ÃÊÂÎñÖÐÔËÐС£ | -| `PROPAGATION_MANDATORY` | ¡¾Ç¿ÖÆ¡¿µ±Ç°·½·¨±ØÐëÔÚÊÂÎñÖÐÔËÐУ¬Èç¹ûµ±Ç°Ïß³ÌÖв»´æÔÚÊÂÎñ£¬Ôò**Å׳öÒì³£** | -| `PROPAGATION_SUPPORTS` | ¡¾Ö§³Ö¡¿µ±Ç°·½·¨µ¥¶ÀÔËÐÐʱ²»ÐèÒªÊÂÎñ£¬µ«Èç¹ûµ±Ç°Ïß³ÌÖдæÔÚÊÂÎñʱ£¬·½·¨»áÔÚÊÂÎñÖÐÔËÐÐ | -| `PROPAGATION_REQUIRES_NEW` | ¡¾ÐÂÊÂÎñ¡¿µ±Ç°·½·¨±ØÐëÔÚ¶ÀÁ¢µÄÊÂÎñÖÐÔËÐУ¬Èç¹ûµ±Ç°Ïß³ÌÖÐÒѾ­´æÔÚÊÂÎñ£¬Ôò½«¸ÃÊÂÎñ¹ÒÆð£¬ÖØÐ¿ªÆôÒ»¸öÊÂÎñ£¬Ö±µ½·½·¨ÔËÐнáÊøÔÙ»Ö¸´Ö®Ç°µÄÊÂÎñ | -| `PROPAGATION_NESTED` | ¡¾Ç¶Ìס¿µ±Ç°·½·¨±ØÐëÔÚÊÂÎñÖÐÔËÐУ¬Èç¹ûµ±Ç°Ïß³ÌÖдæÔÚÊÂÎñ£¬Ôò½«¸ÃÊÂÎñ±ê×¢**±£´æµã**£¬ÐγÉǶÌ×ÊÂÎñ¡£Ç¶Ì×ÊÂÎñÖеÄ×ÓÊÂÎñ³öÏÖÒì³£²»»áÓ°Ïìµ½¸¸ÊÂÎñ±£´æµã֮ǰµÄ²Ù×÷¡£ | -| `PROPAGATION_NOT_SUPPORTED` | ¡¾²»Ö§³Ö¡¿µ±Ç°·½·¨²»»áÔÚÊÂÎñÖÐÔËÐУ¬Èç¹ûµ±Ç°Ïß³ÌÖдæÔÚÊÂÎñ£¬Ôò½«ÊÂÎñ¹ÒÆð£¬Ö±µ½·½·¨ÔËÐнáÊø | -| `PROPAGATION_NEVER` | ¡¾²»ÔÊÐí¡¿µ±Ç°·½·¨²»ÔÊÐíÔÚÊÂÎñÖÐÔËÐУ¬Èç¹ûµ±Ç°Ïß³ÌÖдæÔÚÊÂÎñ£¬Ôò**Å׳öÒì³£** | +| `PROPAGATION_REQUIRED` | ã€�默认值:必需】当å‰�方法必须在事务中è¿�行,如果当å‰�线程中没有事务,则开å�¯ä¸€ä¸ªæ–°çš„事务;如果当å‰�线程中已ç»�存在事务,则方法将会在该事务中è¿�行。 | +| `PROPAGATION_MANDATORY` | ã€�强制】当å‰�方法必须在事务中è¿�行,如果当å‰�线程中ä¸�存在事务,则**抛出异常** | +| `PROPAGATION_SUPPORTS` | ã€�支æŒ�】当å‰�方法å�•独è¿�行时ä¸�需è¦�事务,但如果当å‰�线程中存在事务时,方法会在事务中è¿�行 | +| `PROPAGATION_REQUIRES_NEW` | ã€�新事务】当å‰�方法必须在独立的事务中è¿�行,如果当å‰�线程中已ç»�存在事务,则将该事务挂起,é‡�æ–°å¼€å�¯ä¸€ä¸ªäº‹åŠ¡ï¼Œç›´åˆ°æ–¹æ³•è¿�行结æ�Ÿå†�æ�¢å¤�之å‰�的事务 | +| `PROPAGATION_NESTED` | ã€�嵌套】当å‰�方法必须在事务中è¿�行,如果当å‰�线程中存在事务,则将该事务标注**ä¿�存点**,形æˆ�嵌套事务。嵌套事务中的å­�事务出现异常ä¸�会影å“�到父事务ä¿�存点之å‰�çš„æ“�作。 | +| `PROPAGATION_NOT_SUPPORTED` | ã€�ä¸�支æŒ�】当å‰�方法ä¸�会在事务中è¿�行,如果当å‰�线程中存在事务,则将事务挂起,直到方法è¿�行结æ�Ÿ | +| `PROPAGATION_NEVER` | ã€�ä¸�å…�许】当å‰�方法ä¸�å…�许在事务中è¿�行,如果当å‰�线程中存在事务,则**抛出异常** | -×¢ÒâÌå»áÒÔÏÂÀàÐ͵ÄÇø±ð£º +注æ„�体会以下类型的区别: -1. `PROPAGATION_REQUIRED` Óë `PROPAGATION_MANDATORY` - - `PROPAGATION_REQUIRED`£º±ØÐëÒªÔÚÊÂÎñÖÐÔËÐУ¬Ã»ÓÐÊÂÎñ¾Í**¿ªÆôÐÂÊÂÎñ** - - `PROPAGATION_MANDATORY`£º±ØÐëÒªÔÚÊÂÎñÖÐÔËÐУ¬Ã»ÓÐÊÂÎñ¾Í**Å×Òì³£** -2. `PROPAGATION_NOT_SUPPORTED` Óë `PROPAGATION_NEVER` - - `PROPAGATION_NOT_SUPPORTED`£º²»ÄÜÔÚÊÂÎñÖÐÔËÐУ¬ÓÐÊÂÎñ¾Í**¹ÒÆðÊÂÎñ** - - `PROPAGATION_NEVER`£º²»ÄÜÔÚÊÂÎñÖÐÔËÐУ¬ÓÐÊÂÎñ¾Í**Å×Òì³£** -3. `PROPAGATION_REQUIRES_NEW` Óë `PROPAGATION_NESTED` - - `PROPAGATION_REQUIRES_NEW`£ºÐÂÊÂÎñÖ´ÐÐÍê³Éºó£¬¾ÉÊÂÎñ±¨´í£¬Ö»»Ø¹ö¾ÉÊÂÎñ£¬ÐÂÊÂÎñ²»»Ø¹ö£»ÐÂÊÂÎñÖ´Ðб¨´í£¬Ð¾ÉÊÂÎñÒ»Æð»Ø¹ö - - `PROPAGATION_NESTED`£º×ÓÊÂÎñÖ´ÐÐÍê³Éºó£¬¸¸ÊÂÎñ±¨´í£¬»Ø¹öµ½±£´æµã£»×ÓÊÂÎñÖ´Ðб¨´í£¬Ò²Êǻعöµ½±£´æµã +1. `PROPAGATION_REQUIRED` 与 `PROPAGATION_MANDATORY` + - `PROPAGATION_REQUIRED`:必须è¦�在事务中è¿�行,没有事务就**å¼€å�¯æ–°äº‹åŠ¡** + - `PROPAGATION_MANDATORY`:必须è¦�在事务中è¿�行,没有事务就**抛异常** +2. `PROPAGATION_NOT_SUPPORTED` 与 `PROPAGATION_NEVER` + - `PROPAGATION_NOT_SUPPORTED`:ä¸�能在事务中è¿�行,有事务就**挂起事务** + - `PROPAGATION_NEVER`:ä¸�能在事务中è¿�行,有事务就**抛异常** +3. `PROPAGATION_REQUIRES_NEW` 与 `PROPAGATION_NESTED` + - `PROPAGATION_REQUIRES_NEW`:新事务执行完æˆ�å�Žï¼Œæ—§äº‹åŠ¡æŠ¥é”™ï¼Œå�ªå›žæ»šæ—§äº‹åŠ¡ï¼Œæ–°äº‹åŠ¡ä¸�回滚;新事务执行报错,新旧事务一起回滚 + - `PROPAGATION_NESTED`:å­�事务执行完æˆ�å�Žï¼Œçˆ¶äº‹åŠ¡æŠ¥é”™ï¼Œå›žæ»šåˆ°ä¿�存点;å­�事务执行报错,也是回滚到ä¿�存点 -### 2. demo ×¼±¸ +### 2. demo 准备 -Ã÷È·ÁËÒÔÉϸÅÄîºó£¬½ÓÏÂÀ´¾Í¿ªÊ¼·ÖÎöÁË£¬ÎÒÃÇÏÈ×¼±¸¸ö¼òµ¥µÄ demo£º +明确了以上概念å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±å¼€å§‹åˆ†æž�了,我们先准备个简å�•çš„ demo: -ÏÈÊÇ×¼±¸Ò»Ð©ÅäÖ㺠+先是准备一些é…�置: ``` @Configuration @@ -150,7 +150,7 @@ spring Ò» public class TxDemo03Config { /** - * Éú³ÉÊý¾ÝÔ´ + * 生æˆ�æ•°æ�®æº� */ @Bean public DataSource dataSource() throws Exception { @@ -162,7 +162,7 @@ public class TxDemo03Config { } /** - * Éú³ÉjdbcTemplate£¬ºóÃæ¾ÍÊÇÓÃÕâ¸öÀàÀ´´¦ÀíÊý¾Ý¿âµÄ²Ù×÷ + * 生æˆ�jdbcTemplate,å�Žé�¢å°±æ˜¯ç”¨è¿™ä¸ªç±»æ�¥å¤„ç�†æ•°æ�®åº“çš„æ“�作 */ @Bean public JdbcTemplate jdbcTemplate(DataSource dataSource) { @@ -170,7 +170,7 @@ public class TxDemo03Config { } /** - * ÊÂÎñ¹ÜÀíÆ÷ + * 事务管ç�†å™¨ */ @Bean public DataSourceTransactionManager transactionManager(DataSource dataSource) { @@ -180,13 +180,13 @@ public class TxDemo03Config { } ``` -¶ÔÒÔÉÏ´úÂë˵Ã÷ÈçÏ£º +对以上代ç �说明如下: -- Êý¾ÝÔ´£ºÊ¹ÓõÄÊÇ spring ÌṩµÄ `SimpleDriverDataSource`£¬Õâ¸öÊý¾ÝÔ´¹¦Äܲ»¶à£¬ÊʺÏÕâ¸ö¼òµ¥µÄ demo -- ´¦Àí jdbc Ïà¹Ø²Ù×÷£ºÒ²ÊÇʹÓà spring ÌṩµÄ `jdbcTemplate`£¬×÷Ϊһ¸ö¼òµ¥µÄ demo£¬²»ÏëÒýÈë `mybatis`£¬`jpa` µÈ -- ÊÂÎñ¹ÜÀíÆ÷£ºÊ¹ÓõÄÒ²ÊÇ spring ÌṩµÄ `DataSourceTransactionManager` £¬¶Ôµ¥Êý¾ÝÔ´À´Ëµ£¬Õâ¸öÍêÈ«¹»ÓÃÁË +- æ•°æ�®æº�:使用的是 spring æ��供的 `SimpleDriverDataSource`,这个数æ�®æº�功能ä¸�多,适å�ˆè¿™ä¸ªç®€å�•çš„ demo +- 处ç�† jdbc 相关æ“�作:也是使用 spring æ��供的 `jdbcTemplate`,作为一个简å�•çš„ demo,ä¸�想引入 `mybatis`,`jpa` ç­‰ +- 事务管ç�†å™¨ï¼šä½¿ç”¨çš„也是 spring æ��供的 `DataSourceTransactionManager` ,对å�•æ•°æ�®æº�æ�¥è¯´ï¼Œè¿™ä¸ªå®Œå…¨å¤Ÿç”¨äº† -×¼±¸Ò»¸ö mysql µÄ²Ù×÷£¬Òª¿ªÆôÊÂÎñ£º +准备一个 mysql çš„æ“�作,è¦�å¼€å�¯äº‹åŠ¡ï¼š ``` @Service @@ -196,7 +196,7 @@ public class UserService { private JdbcTemplate jdbcTemplate; /** - * Êý¾Ý¿â²åÈë²Ù×÷£¬Ê¹Óà @Transactional ¿ªÆôÊÂÎñ + * æ•°æ�®åº“æ�’å…¥æ“�作,使用 @Transactional å¼€å�¯äº‹åŠ¡ */ @Transactional(rollbackFor = Exception.class) public int insert() { @@ -204,7 +204,7 @@ public class UserService { + "values (?, ?, ?, ?)"; int result = jdbcTemplate.update(sql, "test", "test", new Date(), new Date()); if(true) { - //throw new RuntimeException("Å׳ö¸öÒì³£"); + //throw new RuntimeException("抛出个异常"); } System.out.println(result); return result; @@ -213,7 +213,7 @@ public class UserService { } ``` -×îºóÊÇÖ÷Àࣺ +最å�Žæ˜¯ä¸»ç±»ï¼š ``` public class TxDemo03Main { @@ -228,50 +228,50 @@ public class TxDemo03Main { } ``` -Õâ¸ö demo Ê®·Ö¼òµ¥£¬¾Í²»¶à×ö·ÖÎöÁË£¬ÎÒÃǽÓÏÂÀ´»áͨ¹ýÕâ¸ö demo ½øÐÐһЩµ÷¶È²Ù×÷£¬Ì½¾¿Ï spring ¶ÔÊÂÎñµÄ¸ôÀë¼¶±ð¡¢´«²¥·½Ê½µÄ´¦Àí¡£ +这个 demo å��分简å�•,就ä¸�多å�šåˆ†æž�了,我们接下æ�¥ä¼šé€šè¿‡è¿™ä¸ª demo 进行一些调度æ“�作,探究下 spring 对事务的隔离级别ã€�ä¼ æ’­æ–¹å¼�的处ç�†ã€‚ ### 3. `TransactionAspectSupport#invokeWithinTransaction` -±¾ÎÄÒ»¿ªÆªÎÒÃǾÍ˵¹ý£¬ÊÂÎñµÄ´¦ÀíÔÚ `TransactionAspectSupport#invokeWithinTransaction` ·½·¨£¬½ÓÏÂÀ´ÎÒÃǽ«Öصã·ÖÎöÕâ¸ö·½·¨¡£ +本文一开篇我们就说过,事务的处ç�†åœ¨ `TransactionAspectSupport#invokeWithinTransaction` 方法,接下æ�¥æˆ‘们将é‡�点分æž�这个方法。 -ÉÏ´úÂ룺 +上代ç �: ``` protected Object invokeWithinTransaction(Method method, @Nullable Class targetClass, final InvocationCallback invocation) throws Throwable { TransactionAttributeSource tas = getTransactionAttributeSource(); - // 1. »ñÈ¡ @Transactional µÄÊôÐÔÅäÖà + // 1. 获å�– @Transactional 的属性é…�ç½® final TransactionAttribute txAttr = (tas != null ? tas.getTransactionAttribute(method, targetClass) : null); - // 2. »ñÈ¡ÊÂÎñ¹ÜÀíÆ÷£¨IOCÈÝÆ÷ÖлñÈ¡£© + // 2. 获å�–事务管ç�†å™¨ï¼ˆIOC容器中获å�–) final TransactionManager tm = determineTransactionManager(txAttr); - // Õⲿ·ÖµÄ´úÂëÊÇÕë¶Ô TransactionManager ÊÇ ReactiveTransactionManager µÄÇé¿ö£¬²»×÷·ÖÎö + // 这部分的代ç �是针对 TransactionManager 是 ReactiveTransactionManager 的情况,ä¸�作分æž� ... - // 3. ½« TransactionManager ת»»Îª PlatformTransactionManager + // 3. å°† TransactionManager 转æ�¢ä¸º PlatformTransactionManager PlatformTransactionManager ptm = asPlatformTransactionManager(tm); - // 4. »ñÈ¡·½·¨µÄÈ«ÏÞ¶¨Ãû£¬¸ñʽΪ£º"°üÃû.ÀàÐÍ.·½·¨Ãû" + // 4. 获å�–方法的全é™�定å��,格å¼�为:"包å��.类型.方法å��" final String joinpointIdentification = methodIdentification(method, targetClass, txAttr); if (txAttr == null || !(ptm instanceof CallbackPreferringPlatformTransactionManager)) { - // 5. »ñÈ¡ÊÂÎñÐÅÏ¢£¬»áÔÚÕâÀ↑ÆôÊÂÎñ + // 5. 获å�–事务信æ�¯ï¼Œä¼šåœ¨è¿™é‡Œå¼€å�¯äº‹åŠ¡ TransactionInfo txInfo = createTransactionIfNecessary( ptm, txAttr, joinpointIdentification); Object retVal; try { - // 6. Ö´ÐоßÌåµÄÒµÎñ + // 6. 执行具体的业务 retVal = invocation.proceedWithInvocation(); } catch (Throwable ex) { - // 7. Òì³£»Ø¹ö + // 7. 异常回滚 completeTransactionAfterThrowing(txInfo, ex); throw ex; } finally { - // 8. ÖØÖÃÊÂÎñÐÅÏ¢£¬¾ÍÊǽ«ÊÂÎñÐÅÏ¢ÉèÖÃΪ¾ÉµÄ + // 8. é‡�置事务信æ�¯ï¼Œå°±æ˜¯å°†äº‹åŠ¡ä¿¡æ�¯è®¾ç½®ä¸ºæ—§çš„ cleanupTransactionInfo(txInfo); } @@ -281,28 +281,28 @@ protected Object invokeWithinTransaction(Method method, @Nullable Class targe retVal = VavrDelegate.evaluateTryFailure(retVal, txAttr, status); } } - // 9. Ìá½»ÊÂÎñ + // 9. æ��交事务 commitTransactionAfterReturning(txInfo); return retVal; } else { - // ´¦Àí CallbackPreferringPlatformTransactionManager ÀàÐ굀 TransactionManager£¬²»×÷·ÖÎö + // 处ç�† CallbackPreferringPlatformTransactionManager 类型的 TransactionManager,ä¸�作分æž� ... } } ``` -¶Ô `TransactionAspectSupport#invokeWithinTransaction` ·½·¨µÄÄÚÈÝ£¬×¢ÊÍÖÐÒÑÏêϸ˵Ã÷£¬½ÓÏÂÀ´ÎªÎÒÃÇÀ´·ÖÎöÕâЩִÐйý³Ì¡£ +对 `TransactionAspectSupport#invokeWithinTransaction` 方法的内容,注释中已详细说明,接下æ�¥ä¸ºæˆ‘们æ�¥åˆ†æž�这些执行过程。 -#### 3.1 »ñÈ¡ `@Transactional` µÄÊôÐÔÅäÖà +#### 3.1 获å�– `@Transactional` 的属性é…�ç½® -Õâ¸ö¾ÍÊÇ»ñÈ¡ `UserService#insert` ·½·¨Éϱê¼ÇµÄ `@Transactional` µÄÊôÐÔÅäÖ㬵õ½µÄ½á¹ûÈçÏ£º +这个就是获å�– `UserService#insert` 方法上标记的 `@Transactional` 的属性é…�置,得到的结果如下: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-aefbe56da2db53982f73092a191e587fcc8.png) -#### 3.2 »ñÈ¡ÊÂÎñ¹ÜÀíÆ÷ +#### 3.2 获å�–事务管ç�†å™¨ -»ñÈ¡ÊÂÎñ¹ÜÀíÆ÷µÄ·½·¨Îª `TransactionAspectSupport#determineTransactionManager`£¬Ö±½Ó¿´´úÂ룺 +获å�–事务管ç�†å™¨çš„æ–¹æ³•为 `TransactionAspectSupport#determineTransactionManager`,直接看代ç �: ``` protected TransactionManager determineTransactionManager(@Nullable TransactionAttribute txAttr) { @@ -310,25 +310,25 @@ protected TransactionManager determineTransactionManager(@Nullable TransactionAt return getTransactionManager(); } - // Èç¹ûÔÚ @Transaction ×¢½âÉÏÖ¸¶¨ÁËÊÂÎñ¹ÜÀíÆ÷£¬¾Í´ÓspringÈÝÆ÷ÖлñÈ¡Õâ¸öÊÂÎñ¹ÜÀíÆ÷ + // 如果在 @Transaction 注解上指定了事务管ç�†å™¨ï¼Œå°±ä»Žspring容器中获å�–这个事务管ç�†å™¨ String qualifier = txAttr.getQualifier(); if (StringUtils.hasText(qualifier)) { return determineQualifiedTransactionManager(this.beanFactory, qualifier); } - // Ö¸¶¨ÊÂÎñ¹ÜÀíÆ÷Ãû³Æ£¬×îÖÕÒ²ÊÇ´ÓspringÈÝÆ÷ÖлñÈ¡ + // 指定事务管ç�†å™¨å��称,最终也是从spring容器中获å�– else if (StringUtils.hasText(this.transactionManagerBeanName)) { return determineQualifiedTransactionManager( this.beanFactory, this.transactionManagerBeanName); } else { - // Ö¸¶¨ÊÂÎñ¹ÜÀíÆ÷¶ÔÏó£¬Ö±½Ó·µ»Ø + // 指定事务管ç�†å™¨å¯¹è±¡ï¼Œç›´æŽ¥è¿”回 TransactionManager defaultTransactionManager = getTransactionManager(); if (defaultTransactionManager == null) { - // ´Ó»º´æÖлñȡĬÈ쵀 + // 从缓存中获å�–默认的 defaultTransactionManager = this.transactionManagerCache .get(DEFAULT_TRANSACTION_MANAGER_KEY); if (defaultTransactionManager == null) { - // ¸ù¾ÝÀàÐÍ´Ó spring ÈÝÆ÷Öлñȡһ¸öÊÂÎñ¹ÜÀíÆ÷ + // æ ¹æ�®ç±»åž‹ä»Ž spring 容器中获å�–一个事务管ç�†å™¨ defaultTransactionManager = this.beanFactory.getBean(TransactionManager.class); this.transactionManagerCache.putIfAbsent( DEFAULT_TRANSACTION_MANAGER_KEY, defaultTransactionManager); @@ -339,14 +339,14 @@ protected TransactionManager determineTransactionManager(@Nullable TransactionAt } ``` -´úÂëËäÈ»Óе㳤£¬µ«Âß¼­·Ç³£ÇåÎú£¬ÕâÀï¶Ô¸Ã·½·¨µÄÁ÷³Ì×ܽáÈçÏ£º +代ç �虽然有点长,但逻辑é�žå¸¸æ¸…晰,这里对该方法的æµ�程总结如下: -1. Èç¹ûÔÚ `@Transaction` ×¢½âÉÏÖ¸¶¨ÁËÊÂÎñ¹ÜÀíÆ÷£¬¾Í´Ó spring ÈÝÆ÷ÖлñÈ¡¸ÃÊÂÎñ¹ÜÀíÆ÷ -2. Èç¹ûÖ¸¶¨ÊÂÎñ¹ÜÀíÆ÷Ãû³Æ£¬¾Í´Ó spring ÈÝÆ÷ÖлñÈ¡¸ÃÊÂÎñ¹ÜÀíÆ÷ -3. Èç¹ûÖ¸¶¨ÊÂÎñ¹ÜÀíÆ÷¶ÔÏó£¬Ö±½Ó·µ»Ø -4. ÒÔÉ϶¼²»Âú×㣬ֱ½Ó´Ó spring ÈÝÆ÷ÖлñÈ¡ÀàÐÍΪ `TransactionManager` µÄ bean +1. 如果在 `@Transaction` 注解上指定了事务管ç�†å™¨ï¼Œå°±ä»Ž spring 容器中获å�–该事务管ç�†å™¨ +2. 如果指定事务管ç�†å™¨å��称,就从 spring 容器中获å�–该事务管ç�†å™¨ +3. 如果指定事务管ç�†å™¨å¯¹è±¡ï¼Œç›´æŽ¥è¿”回 +4. 以上都ä¸�满足,直接从 spring 容器中获å�–类型为 `TransactionManager` çš„ bean -ÔÚ `TxDemo03Config` ÖУ¬ÎÒÃÇÅäÖÃÊÂÎñ¹ÜÀíÆ÷Ϊ `DataSourceTransactionManager`£º +在 `TxDemo03Config` 中,我们é…�置事务管ç�†å™¨ä¸º `DataSourceTransactionManager`: ``` public DataSourceTransactionManager transactionManager(DataSource dataSource) { @@ -354,13 +354,13 @@ public DataSourceTransactionManager transactionManager(DataSource dataSource) { } ``` -ÕâÀïµÃµ½µÄÒ²ÊÇ `DataSourceTransactionManager`£º +这里得到的也是 `DataSourceTransactionManager`: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-34ac74501b184c44f95432b31b21a041619.png) -#### 3.3 ½« `TransactionManager` ת»»Îª `PlatformTransactionManager` +#### 3.3 å°† `TransactionManager` 转æ�¢ä¸º `PlatformTransactionManager` -Õâ¸öûɶºÃ˵µÄ£¬`DataSourceTransactionManager` ¾ÍÊÇ `PlatformTransactionManager` µÄ×ÓÀ࣬´úÂëÀï×öÁËÒ»¸öÀàÐÍת»»¡£ +这个没啥好说的,`DataSourceTransactionManager` 就是 `PlatformTransactionManager` çš„å­�类,代ç �里å�šäº†ä¸€ä¸ªç±»åž‹è½¬æ�¢ã€‚ ``` private PlatformTransactionManager asPlatformTransactionManager( @@ -368,20 +368,20 @@ private PlatformTransactionManager asPlatformTransactionManager( if (transactionManager == null || transactionManager instanceof PlatformTransactionManager) { return (PlatformTransactionManager) transactionManager; } else { - // Å׸öÒì³£ + // 抛个异常 ... } } ``` -#### 3.4 »ñÈ¡·½·¨µÄÈ«ÏÞ¶¨Ãû +#### 3.4 获å�–方法的全é™�定å�� -ÕâÒ»²½»áÄõ½·½·¨µÄÈ«ÏÞ¶¨Ãû£¬¸ñʽΪ£º"°üÃû¡£ÀàÐÍ¡£·½·¨Ãû"£¬ÕâҲûɶºÃ˵µÄ£¬ÕâÒ»²½µÃµ½µÄ½á¹ûÈçÏ£º +这一步会拿到方法的全é™�定å��,格å¼�为:"包å��。类型。方法å��",这也没啥好说的,这一步得到的结果如下: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-656a73b9eb1cd3120d3586fe4f1302de373.png) -ÏÞÓÚÆª·ù£¬±¾ÎľÍÏÈ·ÖÎöµ½ÕâÀïÁË£¬ÏÂÆªÎÒÃǼÌÐø¡£ +é™�于篇幅,本文就先分æž�到这里了,下篇我们继续。 ------ -*±¾ÎÄÔ­ÎÄÁ´½Ó£ºhttps://my.oschina.net/funcy/blog/4773459 £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£* \ No newline at end of file +*本文原文链接:https://my.oschina.net/funcy/blog/4773459 ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。* \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\214\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\346\211\247\350\241\214\346\265\201\347\250\213.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\214\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\346\211\247\350\241\214\346\265\201\347\250\213.md" index f086983..4b7b524 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\214\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\346\211\247\350\241\214\346\265\201\347\250\213.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\214\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\346\211\247\350\241\214\346\265\201\347\250\213.md" @@ -1,24 +1,24 @@ -ÔÚ [spring ÊÂÎñÖ®ÈÏʶÊÂÎñ×é¼þ](https://my.oschina.net/funcy/blog/4773454)Ò»ÎÄÖУ¬ÎÒÃÇͨ¹ýÒ»¸ö demo ÑÝʾÁËÈçºÎʹÓà spring ÊÂÎñ¹ÜÀí¹¦ÄÜ£¬È»ºó·ÖÎöÁË `@EnableTransactionManagement` ×¢½âµÄ¹¦ÄÜ£¬±¾ÎĽ«¼ÌÐø·ÖÎö spring ÊÂÎñÏà¹Ø´úÂë¡£ +在 [spring 事务之认识事务组件](https://my.oschina.net/funcy/blog/4773454)一文中,我们通过一个 demo 演示了如何使用 spring 事务管ç�†åŠŸèƒ½ï¼Œç„¶å�Žåˆ†æž�了 `@EnableTransactionManagement` 注解的功能,本文将继续分æž� spring 事务相关代ç �。 -### 1\. ´úÀí¶ÔÏó´´½¨Á÷³Ì +### 1\. 代ç�†å¯¹è±¡åˆ›å»ºæµ�程 -spring ÊÂÎñ¹ÜÀí¹¦ÄÜÊÇ»ùÓÚ aop µÄ£¬Ê¹ÓôúÀí¶ÔÏóÀ´½øÐÐÊÂÎñµÄһϵÁвÙ×÷£¬±¾ÎĽ«Í¨¹ýµ÷ÊԵķ½Ê½À´·ÖÎö´úÀí¶ÔÏóµÄ´´½¨¹ý³Ì¡£ +spring 事务管ç�†åŠŸèƒ½æ˜¯åŸºäºŽ aop 的,使用代ç�†å¯¹è±¡æ�¥è¿›è¡Œäº‹åŠ¡çš„ä¸€ç³»åˆ—æ“�作,本文将通过调试的方å¼�æ�¥åˆ†æž�代ç�†å¯¹è±¡çš„创建过程。 -ÔÚ [spring ÊÂÎñÖ®ÈÏʶÊÂÎñ×é¼þ](https://my.oschina.net/funcy/blog/4773454)ÖÐÎÒÃÇͨ¹ý·ÖÎö `@EnableTransactionManagement` ×¢½â£¬·¢ÏÖ¸Ã×¢½â»áÏò spring ÈÝÆ÷ÖÐ×¢²á `InfrastructureAdvisorAutoProxyCreator`£¬Õâ¸öÀàÊÇ `AbstractAdvisorAutoProxyCreator` µÄ×ÓÀ࣬ÓÃÀ´Éú³É´úÀí¶ÔÏóµÄ£¬±¾½Ú½«»ùÓÚ `InfrastructureAdvisorAutoProxyCreator` À´·ÖÎö¶ÔÏóµÄ´´½¨¹ý³Ì¡£ +在 [spring 事务之认识事务组件](https://my.oschina.net/funcy/blog/4773454)中我们通过分æž� `@EnableTransactionManagement` 注解,å�‘现该注解会å�‘ spring 容器中注册 `InfrastructureAdvisorAutoProxyCreator`,这个类是 `AbstractAdvisorAutoProxyCreator` çš„å­�类,用æ�¥ç”Ÿæˆ�代ç�†å¯¹è±¡çš„,本节将基于 `InfrastructureAdvisorAutoProxyCreator` æ�¥åˆ†æž�对象的创建过程。 -> ¹ØÓÚ `AbstractAdvisorAutoProxyCreator` µÄ·ÖÎöÒÔ¼°´úÀí¶ÔÏóµÄÉú³É£¬ÔÚ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨ÉÏ£©](https://my.oschina.net/funcy/blog/4678817) Óë [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)ÒѾ­×÷ÁËÏêϸ·ÖÎö£¬ÕâÀïÎÒÃÇÖ÷Òª·ÖÎöÓë aop ÓвîÒìµÄµØ·½£¬ÐèÒªÏêϸÁ˽â spring aop ´úÀí¶ÔÏóÈçºÎ²úÉúµÄС»ï°é£¬¿ÉÒÔÔĶÁÉÏÊöÁ½ÆªÎÄÕ¡£ +> 关于 `AbstractAdvisorAutoProxyCreator` 的分æž�以å�Šä»£ç�†å¯¹è±¡çš„生æˆ�,在 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(上)](https://my.oschina.net/funcy/blog/4678817) 与 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)å·²ç»�作了详细分æž�,这里我们主è¦�分æž�与 aop 有差异的地方,需è¦�详细了解 spring aop 代ç�†å¯¹è±¡å¦‚何产生的å°�伙伴,å�¯ä»¥é˜…读上述两篇文章。 -ÎÒÃÇÒÀ¾ÉÊǽøÈë `AbstractAutoProxyCreator#postProcessBeforeInitialization`£º +我们ä¾�旧是进入 `AbstractAutoProxyCreator#postProcessBeforeInitialization`: ``` public Object postProcessBeforeInstantiation(Class beanClass, String beanName) { ... if (...) { //1\. shouldSkip: - // - AspectJAwareAdvisorAutoProxyCreator µÄ shouldSkip ·½·¨»á´¦Àí @Aspect ×¢½âµÄÀ࣬ - // ½«ÆäÖеÄ@Before/@After/@AroundµÈ×¢½â°üװΪAdvisor£¬ÔÙµ÷Óø¸Àà(Ò²¾ÍÊÇ - // AbstractAutoProxyCreator)µÄshouldSkip·½·¨ - // - InfrastructureAdvisorAutoProxyCreatorÖ±½ÓÖ´ÐÐAbstractAutoProxyCreatorµÄshouldSkip·½·¨ + // - AspectJAwareAdvisorAutoProxyCreator çš„ shouldSkip 方法会处ç�† @Aspect 注解的类, + // 将其中的@Before/@After/@Around等注解包装为Advisor,å†�调用父类(也就是 + // AbstractAutoProxyCreator)çš„shouldSkip方法 + // - InfrastructureAdvisorAutoProxyCreator直接执行AbstractAutoProxyCreatorçš„shouldSkip方法 if (isInfrastructureClass(beanClass) || shouldSkip(beanClass, beanName)) { this.advisedBeans.put(cacheKey, Boolean.FALSE); return null; @@ -27,7 +27,7 @@ public Object postProcessBeforeInstantiation(Class beanClass, String beanName if(...) { ... - // 2\. getAdvicesAndAdvisorsForBean£º»ñÈ¡ÊÊÓÃÓÃÓÚµ±Ç°¶ÔÏóµÄadvisor + // 2\. getAdvicesAndAdvisorsForBean:获å�–适用用于当å‰�对象的advisor Object[] specificInterceptors = getAdvicesAndAdvisorsForBean( beanClass, beanName, targetSource); Object proxy = createProxy(beanClass, beanName, specificInterceptors, targetSource); @@ -39,11 +39,11 @@ public Object postProcessBeforeInstantiation(Class beanClass, String beanName ``` -Õâ¸ö·½·¨ÓÐÁ½´¦²»Í¬µã£¬´úÂëÖÐÒѾ­×¢Ã÷ÁËÆäÖеIJîÒ죬¹ØÓÚ `shouldSkip`£¬Ã»É¶ºÃ˵µÄ£¬ÎÒÃÇÖØµãÕ¹¿ª `getAdvicesAndAdvisorsForBean(...)` ·½·¨¡£ +这个方法有两处ä¸�å�Œç‚¹ï¼Œä»£ç �中已ç»�注明了其中的差异,关于 `shouldSkip`,没啥好说的,我们é‡�点展开 `getAdvicesAndAdvisorsForBean(...)` 方法。 #### 1.1 `BeanFactoryAdvisorRetrievalHelper#findAdvisorBeans` -һ·¸ú½ø `getAdvicesAndAdvisorsForBean(...)` ·½·¨£¬ÆäÖеIJÙ×÷Óë `AspectJAwareAdvisorAutoProxyCreator` µÄ²Ù×÷²¢²»Ì«´óÇø±ð£¬²»¹ýÓиö·½·¨¸öÈËÈÏΪÐèҪǿµ÷Ï£¬·½·¨ÈçÏ£º +一路跟进 `getAdvicesAndAdvisorsForBean(...)` 方法,其中的æ“�作与 `AspectJAwareAdvisorAutoProxyCreator` çš„æ“�作并ä¸�太大区别,ä¸�过有个方法个人认为需è¦�强调下,方法如下: > BeanFactoryAdvisorRetrievalHelper#findAdvisorBeans @@ -51,8 +51,8 @@ public Object postProcessBeforeInstantiation(Class beanClass, String beanName public List findAdvisorBeans() { String[] advisorNames = this.cachedAdvisorBeanNames; if (advisorNames == null) { - // ²éÕÒµ±Ç°beanFactoryÖÐËùÓÐ Advisor µÄ bean class - // Advisor¿ÉÒÔÊÇÓû§ÊµÏÖAdvisorÏà¹Ø½Ó¿Ú£¬Ò²¿ÉÒÔÊÇxmlÖ¸¶¨µÄ + // 查找当å‰�beanFactory中所有 Advisor çš„ bean class + // Advisorå�¯ä»¥æ˜¯ç”¨æˆ·å®žçްAdvisor相关接å�£ï¼Œä¹Ÿå�¯ä»¥æ˜¯xml指定的 advisorNames = BeanFactoryUtils.beanNamesForTypeIncludingAncestors( this.beanFactory, Advisor.class, true, false); this.cachedAdvisorBeanNames = advisorNames; @@ -61,7 +61,7 @@ public List findAdvisorBeans() { List advisors = new ArrayList<>(); for (String name : advisorNames) { ... - // ¸ù¾ÝadvisorµÄbean name£¬´ÓspringÈÝÆ÷ÖлñÈ¡ bean + // æ ¹æ�®advisorçš„bean name,从spring容器中获å�– bean advisors.add(this.beanFactory.getBean(name, Advisor.class)); ... } @@ -71,54 +71,54 @@ public List findAdvisorBeans() { ``` -Õâ¸ö·½·¨Ö÷ÒªµÄ×÷ÓÃÊÇ»ñÈ¡ spring ÈÝÆ÷ÖеÄËùÓÐ `advisor`£¬ÆäʵÔÚ `AnnotationAwareAspectJAutoProxyCreator` ÖÐÒ²ÊÇÕâô»ñÈ¡µÄ£¬Ö»²»¹ýÔÚ»ñȡǰ£¬`AnnotationAwareAspectJAutoProxyCreator` »áÔÚ `shouldSkip(...)` ·½·¨ÖÐ°Ñ `@Aspect` ÀàÖаüº¬ `@Befor/@After/@Around` µÈ×¢½âµÄ·½·¨°ü×°³É¶ÔÓ¦µÄ `Advisor`£¬¶ø `InfrastructureAdvisorAutoProxyCreator` Ôò²»»á£¬±¾½ÚÒ»¿ªÊ¼Ò²Ìáµ½¹ýÁË¡£ +这个方法主è¦�的作用是获å�– spring 容器中的所有 `advisor`,其实在 `AnnotationAwareAspectJAutoProxyCreator` 中也是这么获å�–的,å�ªä¸�过在获å�–å‰�,`AnnotationAwareAspectJAutoProxyCreator` 会在 `shouldSkip(...)` 方法中把 `@Aspect` 类中包å�« `@Befor/@After/@Around` 等注解的方法包装æˆ�对应的 `Advisor`,而 `InfrastructureAdvisorAutoProxyCreator` 则ä¸�会,本节一开始也æ��到过了。 -ÔÚ [spring ÊÂÎñÖ®ÈÏʶÊÂÎñ×é¼þ](https://my.oschina.net/funcy/blog/4773454)Ò»ÎÄÖУ¬·ÖÎö `@EnableTransactionManagement` ×¢½â¹¦ÄÜʱ£¬ÎÒÃÇ·ÖÎöµ½¸Ã×¢½â»áͨ¹ý `@Bean` ×¢½âÏò spring ÖÐÒýÈë `BeanFactoryTransactionAttributeSourceAdvisor`£¬Õâ¸ö bean ¾Í»áÔÚ `BeanFactoryAdvisorRetrievalHelper#findAdvisorBeans` ±»»ñÈ¡µ½¡£ +在 [spring 事务之认识事务组件](https://my.oschina.net/funcy/blog/4773454)一文中,分æž� `@EnableTransactionManagement` 注解功能时,我们分æž�到该注解会通过 `@Bean` 注解å�‘ spring 中引入 `BeanFactoryTransactionAttributeSourceAdvisor`,这个 bean 就会在 `BeanFactoryAdvisorRetrievalHelper#findAdvisorBeans` 被获å�–到。 #### 1.2 `AopUtils#canApply(...)` -¸ú×Å·½·¨Ò»Â·ÍùÏÂ×ߣ¬½ÓמÍÀ´µ½ÁËÅÐ¶Ï `advisor` ÄÜ·ñÊÊÓÃÓÚÄ¿±ê `class` µÄµØ·½ÁË£º +è·Ÿç�€æ–¹æ³•一路往下走,接ç�€å°±æ�¥åˆ°äº†åˆ¤æ–­ `advisor` 能å�¦é€‚用于目标 `class` 的地方了: ``` /** - * ÅжÏadvisorÄÜ·ñÊÊÓÃÓÚÄ¿±êclass + * 判断advisor能å�¦é€‚用于目标class */ public static boolean canApply(Advisor advisor, Class targetClass, boolean hasIntroductions) { ... - // ÅжÏÊÇ·ñΪ PointcutAdvisor£¬´¦ÀíÊÂÎñµÄadvisorΪBeanFactoryTransactionAttributeSourceAdvisor£¬ - // ËüʵÏÖÁËPointcutAdvisor£¬Òò´ËÏÂÃæµÄ´úÂë»áÖ´ÐÐ + // 判断是å�¦ä¸º PointcutAdvisor,处ç�†äº‹åŠ¡çš„advisor为BeanFactoryTransactionAttributeSourceAdvisor, + // 它实现了PointcutAdvisor,因此下é�¢çš„代ç �会执行 else if (advisor instanceof PointcutAdvisor) { PointcutAdvisor pca = (PointcutAdvisor) advisor; - //ʹÓà PointcutAdvisor ¼ÌÐøÅÐ¶Ï + //使用 PointcutAdvisor 继续判断 return canApply(pca.getPointcut(), targetClass, hasIntroductions); } ... } /** - * ÅжÏadvisorÄÜ·ñÊÊÓÃÓÚÄ¿±êclass + * 判断advisor能å�¦é€‚用于目标class */ public static boolean canApply(Pointcut pc, Class targetClass, boolean hasIntroductions) { Assert.notNull(pc, "Pointcut must not be null"); - //1\. ÇеãÉÏÊÇ·ñ´æÔÚÅųýÀàµÄÅäÖà + //1\. 切点上是å�¦å­˜åœ¨æŽ’除类的é…�ç½® if (!pc.getClassFilter().matches(targetClass)) { return false; } - // »ñÈ¡·½·¨Æ¥Åä¶ÔÏó£¬MethodMatcher.TRUE ΪĬÈ쵀 MethodMatcher ¶ÔÏó + // 获å�–方法匹é…�对象,MethodMatcher.TRUE 为默认的 MethodMatcher 对象 MethodMatcher methodMatcher = pc.getMethodMatcher(); if (methodMatcher == MethodMatcher.TRUE) { return true; } ... - // classes°üº¬targetClass¡¢³ýObjectµÄËùÓи¸Àà¡¢ËùÓÐ½Ó¿Ú + // classes包å�«targetClassã€�除Object的所有父类ã€�所有接å�£ Set> classes = new LinkedHashSet<>(); - // Ê¡ÂÔ»ñÈ¡targetClassµÄ¸¸ÀಽÖè + // çœ�略获å�–targetClass的父类步骤 ... for (Class clazz : classes) { - // »ñÈ¡ clazz ¶¨ÒåµÄ·½·¨£¬°üÀ¨µ±Ç°ÀàµÄ·½·¨¡¢³ýObjectÍâµÄËùÓи¸Àà·½·¨¡¢½Ó¿ÚµÄĬÈÏ·½·¨ + // 获å�– clazz 定义的方法,包括当å‰�类的方法ã€�除Object外的所有父类方法ã€�接å�£çš„默认方法 Method[] methods = ReflectionUtils.getAllDeclaredMethods(clazz); for (Method method : methods) { - // 2\. Æ¥ÅäµÄ¹Ø¼üÔÚÕâÀï + // 2\. 匹é…�的关键在这里 if (introductionAwareMethodMatcher != null ? introductionAwareMethodMatcher.matches(method, targetClass, hasIntroductions) : methodMatcher.matches(method, targetClass)) { @@ -131,18 +131,18 @@ public static boolean canApply(Pointcut pc, Class targetClass, boolean hasInt ``` -ÕâÒ»¿éµÄ´úÂëÓë `AnnotationAwareAspectJAutoProxyCreator` һģһÑù£¬ËûÃǶ¼Êǵ÷ÓÃͬÑùµÄ·½·¨À´Åжϣ¬µ«ÓÉÓÚ´«ÈëµÄµÄ `advisor` ²»Í¬£¬×îÖÕµ÷Óõ½µÄ¾ßÌåµÄÆ¥Å乿ÔòÒ²²»Ïàͬ¡£ +这一å�—的代ç �与 `AnnotationAwareAspectJAutoProxyCreator` 一模一样,他们都是调用å�Œæ ·çš„æ–¹æ³•æ�¥åˆ¤æ–­ï¼Œä½†ç”±äºŽä¼ å…¥çš„çš„ `advisor` ä¸�å�Œï¼Œæœ€ç»ˆè°ƒç”¨åˆ°çš„具体的匹é…�规则也ä¸�相å�Œã€‚ -´Ó´úÂëµÄ·ÖÎöÀ´¿´£¬Æ¥ÅäµÄÂß¼­¶¼ÔÚ `Pointcut` ÖУ¬¶ø `Pointcut` ÓÖÀ´×ÔÓÚ `Advisor`£¬¿É¼û `Advisor` Ê®·Ö¹Ø¼ü¡£´¦ÀíÊÂÎñµÄ `Advisor` Ϊ `BeanFactoryTransactionAttributeSourceAdvisor`£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÕâ¸öÀà¡£ +从代ç �的分æž�æ�¥çœ‹ï¼ŒåŒ¹é…�的逻辑都在 `Pointcut` 中,而 `Pointcut` å�ˆæ�¥è‡ªäºŽ `Advisor`,å�¯è§� `Advisor` å��分关键。处ç�†äº‹åŠ¡çš„ `Advisor` 为 `BeanFactoryTransactionAttributeSourceAdvisor`,接下æ�¥æˆ‘们就æ�¥åˆ†æž�这个类。 -#### 1.3 `BeanFactoryTransactionAttributeSourceAdvisor` Æ¥Å乿Ôò·ÖÎö +#### 1.3 `BeanFactoryTransactionAttributeSourceAdvisor` 匹é…�规则分æž� -´ÓÉÏһС ½ÚµÄ·ÖÎöÖУ¬ÎÒÃÇÖªµÀÅÐ¶Ï `targetClass` ÄÜ·ñÓ¦Óõ±Ç° `advisor` µÄ¹æÔòÀ´Ô´ÓÚ `advisor` µÄ `pointcut`£¬`pointcut` ÓÐÁ½¸öµØ·½°üº¬ÁËÅжϹæÔò£º +从上一å°� 节的分æž�中,我们知é�“判断 `targetClass` 能å�¦åº”用当å‰� `advisor` 的规则æ�¥æº�于 `advisor` çš„ `pointcut`,`pointcut` 有两个地方包å�«äº†åˆ¤æ–­è§„则: -* Æ¥ÅäÀࣺ`pc.getClassFilter().matches(targetClass)` -* Æ¥Åä·½·¨£º`pc.getMethodMatcher().matches(method, targetClass)` +* 匹é…�类:`pc.getClassFilter().matches(targetClass)` +* 匹é…�方法:`pc.getMethodMatcher().matches(method, targetClass)` -ÕâһС ½ÚÎÒÃÇ´Ó `BeanFactoryTransactionAttributeSourceAdvisor` ÈëÊÖ£¬Ò»²½²½·ÖÎöÆ¥Å乿Ôò¡£ +这一å°� 节我们从 `BeanFactoryTransactionAttributeSourceAdvisor` 入手,一步步分æž�匹é…�规则。 ``` public class BeanFactoryTransactionAttributeSourceAdvisor @@ -152,7 +152,7 @@ public class BeanFactoryTransactionAttributeSourceAdvisor private TransactionAttributeSource transactionAttributeSource; /** - * Õâ¸ö¾ÍÊÇ pointcut + * 这个就是 pointcut */ private final TransactionAttributeSourcePointcut pointcut = new TransactionAttributeSourcePointcut() { @@ -164,7 +164,7 @@ public class BeanFactoryTransactionAttributeSourceAdvisor }; /** - * ÉèÖà transactionAttributeSource + * 设置 transactionAttributeSource */ public void setTransactionAttributeSource(TransactionAttributeSource transactionAttributeSource) { @@ -172,14 +172,14 @@ public class BeanFactoryTransactionAttributeSourceAdvisor } /** - * ÉèÖà ClassFilter + * 设置 ClassFilter */ public void setClassFilter(ClassFilter classFilter) { this.pointcut.setClassFilter(classFilter); } /** - * »ñÈ¡ pointcut + * 获å�– pointcut */ @Override public Pointcut getPointcut() { @@ -189,19 +189,19 @@ public class BeanFactoryTransactionAttributeSourceAdvisor ``` -ÉÏÃæµÄ´úÂë¹Ø¼ü²¿·ÖÒѾ­×¢ÊÍÁË£¬ÕâÀïÀ´×ܽáÏ£º`BeanFactoryTransactionAttributeSourceAdvisor#getPointcut` µÃµ½µÄ `pointcut` Ϊ `TransactionAttributeSourcePointcut`£¬¾ÍÊÇÔÚ `private final TransactionAttributeSourcePointcut pointcut = new TransactionAttributeSourcePointcut() {...}` Öд´½¨µÄ¡£ +上é�¢çš„代ç �关键部分已ç»�注释了,这里æ�¥æ€»ç»“下:`BeanFactoryTransactionAttributeSourceAdvisor#getPointcut` 得到的 `pointcut` 为 `TransactionAttributeSourcePointcut`,就是在 `private final TransactionAttributeSourcePointcut pointcut = new TransactionAttributeSourcePointcut() {...}` 中创建的。 -`BeanFactoryTransactionAttributeSourceAdvisor` µÄ `transactionAttributeSource` ÊÇÊ²Ã´ÄØ£¿»ØÒäÏ `ProxyTransactionManagementConfiguration` Öд´½¨ `transactionAdvisor` µÄ´úÂ룺 +`BeanFactoryTransactionAttributeSourceAdvisor` çš„ `transactionAttributeSource` 是什么呢?回忆下 `ProxyTransactionManagementConfiguration` 中创建 `transactionAdvisor` 的代ç �: ``` public class ProxyTransactionManagementConfiguration extends AbstractTransactionManagementConfiguration { - // Ê¡ÂÔÆäËû + // çœ�略其他 ... /** - * ¶ÁÈ¡SpringµÄ @Transactional ×¢½â£¬²¢½«ÏàÓ¦µÄÊÂÎñÊôÐÔ¹«¿ª¸øSpringµÄÊÂÎñ»ù´¡½á¹¹ + * 读å�–Springçš„ @Transactional 注解,并将相应的事务属性公开给Spring的事务基础结构 */ @Bean @Role(BeanDefinition.ROLE_INFRASTRUCTURE) @@ -210,8 +210,8 @@ public class ProxyTransactionManagementConfiguration } /** - * ÊÂÎñÔöÇ¿Æ÷. - * transactionAttributeSource£ºtransactionAttributeSource() ·µ»ØµÄ¶ÔÏó + * 事务增强器. + * transactionAttributeSource:transactionAttributeSource() 返回的对象 */ @Bean(name = TransactionManagementConfigUtils.TRANSACTION_ADVISOR_BEAN_NAME) @Role(BeanDefinition.ROLE_INFRASTRUCTURE) @@ -220,7 +220,7 @@ public class ProxyTransactionManagementConfiguration TransactionInterceptor transactionInterceptor) { BeanFactoryTransactionAttributeSourceAdvisor advisor = new BeanFactoryTransactionAttributeSourceAdvisor(); - // ÉèÖÃÊÂÎñÊôÐÔÀ࣬ÓÃÀ´±£´æ @Transactional µÄÊôÐÔ + // 设置事务属性类,用æ�¥ä¿�å­˜ @Transactional 的属性 advisor.setTransactionAttributeSource(transactionAttributeSource); ... return advisor; @@ -230,53 +230,53 @@ public class ProxyTransactionManagementConfiguration ``` -ÓÉ´Ë¿ÉÖª£¬`BeanFactoryTransactionAttributeSourceAdvisor` µÄ `transactionAttributeSource` ÊôÐÔΪ `AnnotationTransactionAttributeSource`. +由此å�¯çŸ¥ï¼Œ`BeanFactoryTransactionAttributeSourceAdvisor` çš„ `transactionAttributeSource` 属性为 `AnnotationTransactionAttributeSource`. -ÎÒÃÇÔٻص½ `BeanFactoryTransactionAttributeSourceAdvisor`£¬´ÓÉÏÃæµÄ·ÖÎö¿ÉÖª£¬`getPointcut()` µÃµ½µÄÊÇ `TransactionAttributeSourcePointcut` ¶ÔÏó£¬È»ºó½øÈëÕâ¸öÀࣺ +我们å†�回到 `BeanFactoryTransactionAttributeSourceAdvisor`,从上é�¢çš„分æž�å�¯çŸ¥ï¼Œ`getPointcut()` 得到的是 `TransactionAttributeSourcePointcut` 对象,然å�Žè¿›å…¥è¿™ä¸ªç±»ï¼š ``` abstract class TransactionAttributeSourcePointcut extends StaticMethodMatcherPointcut implements Serializable { protected TransactionAttributeSourcePointcut() { - // ÔÚ¹¹Ôì·½·¨ÖÐÉèÖà ClassFilter + // 在构造方法中设置 ClassFilter setClassFilter(new TransactionAttributeSourceClassFilter()); } /** - * pointcut µÄ matches ·½·¨ + * pointcut çš„ matches 方法 */ @Override public boolean matches(Method method, Class targetClass) { - // µÃµ½µÄ½á¹ûΪAnnotationTransactionAttributeSource + // 得到的结果为AnnotationTransactionAttributeSource TransactionAttributeSource tas = getTransactionAttributeSource(); return (tas == null || tas.getTransactionAttribute(method, targetClass) != null); } /** - * ÔÚ BeanFactoryTransactionAttributeSourceAdvisor ÖÐÒÑÖ¸¶¨ + * 在 BeanFactoryTransactionAttributeSourceAdvisor 中已指定 */ @Nullable protected abstract TransactionAttributeSource getTransactionAttributeSource(); /** - * ÄÚ²¿À࣬ʵÏÖÁË ClassFilter + * 内部类,实现了 ClassFilter */ private class TransactionAttributeSourceClassFilter implements ClassFilter { /** - * ClassFilter µÄ matches + * ClassFilter çš„ matches */ @Override public boolean matches(Class clazz) { - // ÊÇ·ñΪTransactionalProxy¡¢PlatformTransactionManager¡¢PersistenceExceptionTranslatorµÄʵÏÖÀà + // 是å�¦ä¸ºTransactionalProxyã€�PlatformTransactionManagerã€�PersistenceExceptionTranslator的实现类 if (TransactionalProxy.class.isAssignableFrom(clazz) || PlatformTransactionManager.class.isAssignableFrom(clazz) || PersistenceExceptionTranslator.class.isAssignableFrom(clazz)) { return false; } - //ÅÐ¶Ï TransactionAttributeSource »ñÈ¡ÊÂÎñÊôÐÔÊÇ·ñΪ¿Õ - // µÃµ½µÄ½á¹ûΪAnnotationTransactionAttributeSource + //判断 TransactionAttributeSource 获å�–事务属性是å�¦ä¸ºç©º + // 得到的结果为AnnotationTransactionAttributeSource TransactionAttributeSource tas = getTransactionAttributeSource(); return (tas == null || tas.isCandidateClass(clazz)); } @@ -286,16 +286,16 @@ abstract class TransactionAttributeSourcePointcut ``` -´ÓÉÏÃæµÄ·½·¨£¬ÎÒÃǵõ½ÁËÒ»¸öÖØÒªµÄ¹æÔò£º +从上é�¢çš„æ–¹æ³•,我们得到了一个é‡�è¦�的规则: -* Æ¥ÅäÀࣺ`pc.getClassFilter().matches(targetClass)`£¬`ClassFilter` Ϊ `TransactionAttributeSourceClassFilter` +* 匹é…�类:`pc.getClassFilter().matches(targetClass)`,`ClassFilter` 为 `TransactionAttributeSourceClassFilter` -Æ¥ÅäÀàµÄ¹æÔòÊÇÕÒµ½ÁË£¬ÄÇÆ¥Åä·½·¨µÄ¹æÔòÄØ£¿ÎÒÃǽøÈë `TransactionAttributeSourcePointcut#getMethodMatcher()` ·½·¨£¬½øÈëµÄÊÇ `StaticMethodMatcherPointcut`£º +匹é…�类的规则是找到了,那匹é…�方法的规则呢?我们进入 `TransactionAttributeSourcePointcut#getMethodMatcher()` 方法,进入的是 `StaticMethodMatcherPointcut`: ``` public abstract class StaticMethodMatcherPointcut extends StaticMethodMatcher implements Pointcut { - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... @Override @@ -306,51 +306,51 @@ public abstract class StaticMethodMatcherPointcut ``` -·µ»ØµÄ¾¹È»ÊÇ `this`£¡ÕâÊǸöɶ£¿²»Òª»Å£¬ÔÙϸ¿´ `TransactionAttributeSourcePointcut`£¬·¢ÏÖËü¼Ì³ÐÁË `StaticMethodMatcherPointcut`£º +返回的竟然是 `this`ï¼�这是个啥?ä¸�è¦�慌,å†�细看 `TransactionAttributeSourcePointcut`,å�‘现它继承了 `StaticMethodMatcherPointcut`: ``` abstract class TransactionAttributeSourcePointcut extends StaticMethodMatcherPointcut implements Serializable { - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... } ``` -ËùÒÔ£¬`pc.getMethodMatcher()` µÃµ½µÄ¾ÍÊÇ `TransactionAttributeSourcePointcut`£¬Æä `mathes(...)` ·½·¨¾ÍÊÇ `TransactionAttributeSourcePointcut#matches`. +所以,`pc.getMethodMatcher()` 得到的就是 `TransactionAttributeSourcePointcut`,其 `mathes(...)` 方法就是 `TransactionAttributeSourcePointcut#matches`. -ÔÚ±¾Ð¡½ÚµÄ×îºó£¬ÎÒÃÇÀ´×ܽáÏ·ÖÎöµÄ½á¹û£º +在本å°�节的最å�Žï¼Œæˆ‘们æ�¥æ€»ç»“下分æž�的结果: -* Æ¥ÅäÀࣺ`pc.getClassFilter().matches(targetClass)`£¬`ClassFilter` Ϊ `TransactionAttributeSourceClassFilter`£» -* Æ¥Åä·½·¨£º`pc.getMethodMatcher().matches(method, targetClass)`£¬`methodMatcher` Ϊ `TransactionAttributeSourcePointcut`£» -* ÔÚÉÏÃæÁ½¸ö¹æÔòÖУ¬¶¼»áµ÷Óà `TransactionAttributeSourcePointcut#getTransactionAttributeSource`£¬Õâ¸ö·½·¨·µ»ØµÄ½á¹ûΪ `AnnotationTransactionAttributeSource`. +* 匹é…�类:`pc.getClassFilter().matches(targetClass)`,`ClassFilter` 为 `TransactionAttributeSourceClassFilter`ï¼› +* 匹é…�方法:`pc.getMethodMatcher().matches(method, targetClass)`,`methodMatcher` 为 `TransactionAttributeSourcePointcut`ï¼› +* 在上é�¢ä¸¤ä¸ªè§„则中,都会调用 `TransactionAttributeSourcePointcut#getTransactionAttributeSource`,这个方法返回的结果为 `AnnotationTransactionAttributeSource`. -#### 1.4 Æ¥ÅäÁ÷³Ì +#### 1.4 匹é…�æµ�程 -ÔÚ 1.2 ²¿·Ö£¬ÎÒÃÇÖªµÀ£¬µ±Ç° `advisor` ÄÜ·ñÓ¦ÓÃÓÚÄ¿±ê class£¬ÐèҪͬʱÂú×ãÁ½¸öÆ¥Å乿Ôò£º +在 1.2 部分,我们知é�“,当å‰� `advisor` 能å�¦åº”用于目标 class,需è¦�å�Œæ—¶æ»¡è¶³ä¸¤ä¸ªåŒ¹é…�规则: -* Æ¥ÅäÀࣺ`pc.getClassFilter().matches(targetClass)`£¬`ClassFilter` Ϊ `TransactionAttributeSourceClassFilter`£» -* Æ¥Åä·½·¨£º`pc.getMethodMatcher().matches(method, targetClass)`£¬`methodMatcher` Ϊ `TransactionAttributeSourcePointcut`£» +* 匹é…�类:`pc.getClassFilter().matches(targetClass)`,`ClassFilter` 为 `TransactionAttributeSourceClassFilter`ï¼› +* 匹é…�方法:`pc.getMethodMatcher().matches(method, targetClass)`,`methodMatcher` 为 `TransactionAttributeSourcePointcut`ï¼› -ÎÒÃÇÀ´¿´ÏÂÕâÁ½¸ö·½·¨£º +我们æ�¥çœ‹ä¸‹è¿™ä¸¤ä¸ªæ–¹æ³•: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-133740c93d470e16ec8dc9a34106adb8fc8.png) -* `TransactionAttributeSourceClassFilter#matches`£ºÏÈÅжϵ±Ç°ÀàÊÇ·ñΪÊÇ·ñΪ `TransactionalProxy`¡¢`PlatformTransactionManager`¡¢`PersistenceExceptionTranslator` »òÆäʵÏÖÀ࣬Ȼºóµ÷Óà `AnnotationTransactionAttributeSource#isCandidateClass` ¼ÌÐøÅжϣ» -* `TransactionAttributeSourcePointcut#matches`£ºµ÷Óà `AnnotationTransactionAttributeSource#getTransactionAttribute`£¨ÓÉÓڼ̳йØÏµ£¬Êµ¼Êµ÷ÓõÄÊÇ `AbstractFallbackTransactionAttributeSource#getTransactionAttribute`£©Åжϡ£ +* `TransactionAttributeSourceClassFilter#matches`:先判断当å‰�类是å�¦ä¸ºæ˜¯å�¦ä¸º `TransactionalProxy`ã€�`PlatformTransactionManager`ã€�`PersistenceExceptionTranslator` 或其实现类,然å�Žè°ƒç”¨ `AnnotationTransactionAttributeSource#isCandidateClass` 继续判断; +* `TransactionAttributeSourcePointcut#matches`:调用 `AnnotationTransactionAttributeSource#getTransactionAttribute`(由于继承关系,实际调用的是 `AbstractFallbackTransactionAttributeSource#getTransactionAttribute`)判断。 -½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöϾßÌ寥ÅäÁ÷³Ì¡£ +接下æ�¥æˆ‘们就æ�¥åˆ†æž�下具体匹é…�æµ�程。 ##### `AnnotationTransactionAttributeSource#isCandidateClass` -ÈÃÎÒÃÇÖ±±¼Ö÷Ì⣬½øÈë `isCandidateClass` ·½·¨£º +让我们直奔主题,进入 `isCandidateClass` 方法: > AnnotationTransactionAttributeSource#isCandidateClass ``` @Override public boolean isCandidateClass(Class targetClass) { - // ÕÒµ½ËùÓеÄannotationParsers£¬Ñ­»·Æ¥Åä + // 找到所有的annotationParsers,循环匹é…� for (TransactionAnnotationParser parser : this.annotationParsers) { if (parser.isCandidateClass(targetClass)) { return true; @@ -361,18 +361,18 @@ public boolean isCandidateClass(Class targetClass) { ``` -¿ÉÒÔ¿´µ½£¬ÕâÊÇÔÚÑ­»·Àïµ÷Óà `TransactionAnnotationParser` µÄ `isCandidateClass` ·½·¨¡£`this.annotationParsers` ÊÇɶĨ£¿Í¨¹ýµ÷ÊÔ£¬ÄÚÈÝÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™æ˜¯åœ¨å¾ªçŽ¯é‡Œè°ƒç”¨ `TransactionAnnotationParser` çš„ `isCandidateClass` 方法。`this.annotationParsers` 是啥呢?通过调试,内容如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-5e16d6769e5a74c2f3064afdd090de08d42.png) -`this.annotationParsers` ÖÐÖ»ÓÐ `SpringTransactionAnnotationParser`£¬ÎÒÃǽøÈëÆä `isCandidateClass` ·½·¨£º +`this.annotationParsers` 中å�ªæœ‰ `SpringTransactionAnnotationParser`,我们进入其 `isCandidateClass` 方法: ``` public class SpringTransactionAnnotationParser implements TransactionAnnotationParser, Serializable { /** - * ÅжÏÀàÉÏÊÇ·ñÓÐ @Transactional ×¢½â + * 判断类上是å�¦æœ‰ @Transactional 注解 */ @Override public boolean isCandidateClass(Class targetClass) { @@ -382,20 +382,20 @@ public class SpringTransactionAnnotationParser ``` -Õâ¸ö·½·¨×îÖÕµ÷ÓõÄÊÇ `AnnotationUtils.isCandidateClass`£¬ÓÃÀ´ÅжÏÖ¸¶¨µÄÀàÉÏÊÇ·ñÓÐ `@Transactional` ×¢½â¡£ +这个方法最终调用的是 `AnnotationUtils.isCandidateClass`,用æ�¥åˆ¤æ–­æŒ‡å®šçš„类上是å�¦æœ‰ `@Transactional` 注解。 -µ½ÕâÀÎÒÃǾÍÃ÷°×ÁË£¬`TransactionAttributeSourceClassFilter#matches` ÏÈÅųýһЩÀà (`TransactionalProxy`/`PlatformTransactionManager`/`PersistenceExceptionTranslator` ¼°Æä×ÓÀà) ºó£¬×îÖÕ»áÆ¥Åä´øÓÐ `@Transactional` ×¢½âµÄÀà¡£ +到这里,我们就明白了,`TransactionAttributeSourceClassFilter#matches` 先排除一些类 (`TransactionalProxy`/`PlatformTransactionManager`/`PersistenceExceptionTranslator` å�Šå…¶å­�ç±») å�Žï¼Œæœ€ç»ˆä¼šåŒ¹é…�带有 `@Transactional` 注解的类。 ##### `AnnotationTransactionAttributeSource#getTransactionAttribute` -ÉÏÃæµÄ·½·¨Æ¥Åä³É¹¦ºó£¬²¢²»Äܱíʾ³É¹¦Æ¥Å䣬»¹µÃÆ¥Åä `TransactionAttributeSourcePointcut#matches`£¬Á½ÕßͬʱÂú×ã²Å»áÆ¥Åä³É¹¦¡£`TransactionAttributeSourcePointcut#matches` µ÷Óà `AnnotationTransactionAttributeSource#getTransactionAttribute` Íê³ÉÆ¥ÅäµÄ£¬ÎÒÃǸú½øÈ¥£º +上é�¢çš„æ–¹æ³•匹é…�æˆ�功å�Žï¼Œå¹¶ä¸�能表示æˆ�功匹é…�,还得匹é…� `TransactionAttributeSourcePointcut#matches`,两者å�Œæ—¶æ»¡è¶³æ‰�会匹é…�æˆ�功。`TransactionAttributeSourcePointcut#matches` 调用 `AnnotationTransactionAttributeSource#getTransactionAttribute` 完æˆ�匹é…�的,我们跟进去: ``` public abstract class AbstractFallbackTransactionAttributeSource implements TransactionAttributeSource { /** - * »ñÈ¡ @Transactional ×¢½âµÄÊôÐÔ + * 获å�– @Transactional 注解的属性 */ public TransactionAttribute getTransactionAttribute(Method method, @Nullable Class targetClass) { @@ -403,12 +403,12 @@ public abstract class AbstractFallbackTransactionAttributeSource return null; } - // Ê¡ÂÔ´Ó»º´æÖлñÈ¡ + // çœ�略从缓存中获å�– ... else { - // »ñÈ¡ Transaction ÊôÐÔ£¬¼´ @Transactional ×¢½âµÄÊôÐÔ + // 获å�– Transaction 属性,å�³ @Transactional 注解的属性 TransactionAttribute txAttr = computeTransactionAttribute(method, targetClass); - // Ê¡ÂÔ·ÅÈ뻺´æ²Ù×÷ + // çœ�略放入缓存æ“�作 ... return txAttr; } @@ -417,76 +417,76 @@ public abstract class AbstractFallbackTransactionAttributeSource ``` -`AnnotationTransactionAttributeSource` µÄ `getTransactionAttribute` ÊǼ̳Ð×Ô `AbstractFallbackTransactionAttributeSource` µÄ£¬Òò´ËÎÒÃǽøÈëµÄ·½·¨ÊÇ `AbstractFallbackTransactionAttributeSource#getTransactionAttribute`£¬Õâ¸ö·½·¨ÓÃÀ´»ñÈ¡·½·¨É쵀 `@Transactional` ×¢½âµÄÊôÐÔ£¬ÎÒÃǸú½ø `computeTransactionAttribute(...)`£º +`AnnotationTransactionAttributeSource` çš„ `getTransactionAttribute` 是继承自 `AbstractFallbackTransactionAttributeSource` 的,因此我们进入的方法是 `AbstractFallbackTransactionAttributeSource#getTransactionAttribute`,这个方法用æ�¥èŽ·å�–方法上的 `@Transactional` 注解的属性,我们跟进 `computeTransactionAttribute(...)`: > AbstractFallbackTransactionAttributeSource ``` protected TransactionAttribute computeTransactionAttribute(Method method, @Nullable Class targetClass) { - // ĬÈϱØÐëÒª public ·½·¨²ÅÖ§³ÖÊÂÎñ + // 默认必须è¦� public 方法æ‰�支æŒ�事务 if (allowPublicMethodsOnly() && !Modifier.isPublic(method.getModifiers())) { return null; } - // 1\. »ñȡȷÇеķ½·¨£¬ÀýÈç´«ÈëµÄclassÊÇIFoo£¬Êµ¼ÊµÄµÄclassÊÇDefaultFoo£¬ - // ÄÇôӦ¸Ã½« IFoo#method ת»»Îª DefaultFoo#method + // 1\. 获å�–确切的方法,例如传入的class是IFoo,实际的的class是DefaultFoo, + // 那么应该将 IFoo#method 转æ�¢ä¸º DefaultFoo#method Method specificMethod = AopUtils.getMostSpecificMethod(method, targetClass); - // 2\. ´Ó·½·¨ÉÏ»ñÈ¡ @Transactional µÄÊôÐÔ + // 2\. 从方法上获å�– @Transactional 的属性 TransactionAttribute txAttr = findTransactionAttribute(specificMethod); if (txAttr != null) { return txAttr; } - // 3\. ´ÓÀàÉÏ»ñÈ¡ @Transaction µÄÊôÐÔ + // 3\. 从类上获å�– @Transaction 的属性 txAttr = findTransactionAttribute(specificMethod.getDeclaringClass()); if (txAttr != null && ClassUtils.isUserLevelMethod(method)) { return txAttr; } if (specificMethod != method) { - // 4\. È·Çеķ½·¨ÉÏÕÒ²»µ½£¬¾ÍÕÒ´«ÈëµÄ·½·¨É쵀 + // 4\. 确切的方法上找ä¸�到,就找传入的方法上的 txAttr = findTransactionAttribute(method); if (txAttr != null) { return txAttr; } - // 5\. ÒÔÉ϶¼Ã»ÕÒµ½£¬¾ÍÕÒÈ·ÇеÄÀàÉ쵀 + // 5\. 以上都没找到,就找确切的类上的 txAttr = findTransactionAttribute(method.getDeclaringClass()); if (txAttr != null && ClassUtils.isUserLevelMethod(method)) { return txAttr; } } - // 6\. ûÓлñÈ¡µ½£¬×îÖÕ·µ»Ønull + // 6\. 没有获å�–到,最终返回null return null; } ``` -´ÓÒÔÉÏ·½·¨µÄÁ÷³Ì£¬¿É×ܽá»ñÈ¡ `@Transactional` ÊôÐÔÁ÷³ÌÈçÏ£º +从以上方法的æµ�程,å�¯æ€»ç»“获å�– `@Transactional` 属性æµ�程如下: -1. ½«´«ÈëµÄ·½·¨×ª»»ÎªÈ·Çеķ½·¨£¬ÀýÈç´«ÈëµÄ `class` ÊÇ `IFoo`£¬Êµ¼ÊµÄµÄ `class` ÊÇ `DefaultFoo`£¬ÕâÀï¾Í»á½« `IFoo#method` ת»»Îª `DefaultFoo#method` -2. ´ÓÈ·Çеķ½·¨ÉÏ»ñÈ¡ `@Transactional` µÄÊôÐÔ -3. Èç¹ûûÓлñÈ¡µ½£¬¾Í´ÓÈ·ÇеĴÓÀàÉÏ»ñÈ¡ `@Transaction` µÄÊôÐÔ -4. Èç¹ûûÓлñÈ¡µ½£¬¾Í´«ÈëµÄ·½·¨ÉÏ»ñÈ¡ `@Transaction` µÄÊôÐÔ -5. Èç¹ûûÓлñÈ¡µ½£¬¾Í´«ÈëµÄÀàÉÏ»ñÈ¡ `@Transaction` µÄÊôÐÔ -6. Èç¹ûÒÔÉ϶¼Ã»ÓлñÈ¡µ½£¬¾Í·µ»Ø `null` +1. 将传入的方法转æ�¢ä¸ºç¡®åˆ‡çš„æ–¹æ³•,例如传入的 `class` 是 `IFoo`,实际的的 `class` 是 `DefaultFoo`,这里就会将 `IFoo#method` 转æ�¢ä¸º `DefaultFoo#method` +2. 从确切的方法上获å�– `@Transactional` 的属性 +3. 如果没有获å�–到,就从确切的从类上获å�– `@Transaction` 的属性 +4. 如果没有获å�–到,就传入的方法上获å�– `@Transaction` 的属性 +5. 如果没有获å�–到,就传入的类上获å�– `@Transaction` 的属性 +6. 如果以上都没有获å�–到,就返回 `null` -spring ÓÖÊÇÈçºÎ´Ó·½·¨»òÀàÉÏ»ñÈ¡ `@Transactional` µÄÊôÐÔÄØ£¿¼ÌÐø¿´ÏÂÈ¥£º +spring å�ˆæ˜¯å¦‚何从方法或类上获å�– `@Transactional` 的属性呢?继续看下去: > AnnotationTransactionAttributeSource ``` - // ´Ó·½·¨ÉÏ»ñÈ¡ @Transactional ÊôÐÔ + // 从方法上获å�– @Transactional 属性 protected TransactionAttribute findTransactionAttribute(Method method) { return determineTransactionAttribute(method); } - // ´ÓÀàÉÏ»ñÈ¡ @Transactional ÊôÐÔ + // 从类上获å�– @Transactional 属性 protected TransactionAttribute findTransactionAttribute(Class clazz) { return determineTransactionAttribute(clazz); } - // ×îÖÕµ÷Óõķ½·¨ + // 最终调用的方法 protected TransactionAttribute determineTransactionAttribute(AnnotatedElement element) { for (TransactionAnnotationParser parser : this.annotationParsers) { - // ½âÎö @Transactional ×¢½âµÄÊôÐÔ + // è§£æž� @Transactional 注解的属性 TransactionAttribute attr = parser.parseTransactionAnnotation(element); if (attr != null) { return attr; @@ -497,16 +497,16 @@ spring ``` -×îÖÕËûÃǶ¼Êǵ÷Óà `AnnotationTransactionAttributeSource#determineTransactionAttribute` À´»ñÈ¡µÄ£¬¶øÔÚ `AnnotationTransactionAttributeSource#determineTransactionAttribute` µ÷ÓÃÁË `TransactionAnnotationParser#parseTransactionAnnotation` ·½·¨¡£¶ÔÓÚ `this.annotationParsers` »¹ÑÛÊìÂð£¬ÔÚÇ°ÃæÒѾ­·ÖÎö¹ýÁË£¬ÀïÃæÖ»ÓÐÒ»¸öÀࣺ`SpringTransactionAnnotationParser`£¬ÎÒÃǸú½øÈ¥£º +最终他们都是调用 `AnnotationTransactionAttributeSource#determineTransactionAttribute` æ�¥èŽ·å�–的,而在 `AnnotationTransactionAttributeSource#determineTransactionAttribute` 调用了 `TransactionAnnotationParser#parseTransactionAnnotation` 方法。对于 `this.annotationParsers` 还眼熟å�—,在å‰�é�¢å·²ç»�分æž�过了,里é�¢å�ªæœ‰ä¸€ä¸ªç±»ï¼š`SpringTransactionAnnotationParser`,我们跟进去: > SpringTransactionAnnotationParser ``` /** - * »ñÈ¡ Transactional ×¢½â£¬´æÔÚÔò¼ÌÐø½âÎö£¬²»´æÔÚÔò·µ»Ø null + * 获å�– Transactional 注解,存在则继续解æž�,ä¸�存在则返回 null */ public TransactionAttribute parseTransactionAnnotation(AnnotatedElement element) { - // »ñÈ¡ Transactional ×¢½â£¬´æÔÚÔò¼ÌÐø½âÎö£¬²»´æÔÚÔò·µ»Ø null + // 获å�– Transactional 注解,存在则继续解æž�,ä¸�存在则返回 null AnnotationAttributes attributes = AnnotatedElementUtils.findMergedAnnotationAttributes( element, Transactional.class, false, false); if (attributes != null) { @@ -518,22 +518,22 @@ spring } /** - * ½âÎö Transactional ×¢½âµÄ¾ßÌå²Ù×÷ + * è§£æž� Transactional 注解的具体æ“�作 */ protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes attributes) { RuleBasedTransactionAttribute rbta = new RuleBasedTransactionAttribute(); - // ÊÂÎñµÄ´«²¥·½Ê½ + // 事务的传播方å¼� Propagation propagation = attributes.getEnum("propagation"); rbta.setPropagationBehavior(propagation.value()); - // ÊÂÎñµÄ¸ôÀë¼¶±ð + // 事务的隔离级别 Isolation isolation = attributes.getEnum("isolation"); rbta.setIsolationLevel(isolation.value()); - // ÊÂÎñµÄ³¬Ê±Ê±¼ä + // 事务的超时时间 rbta.setTimeout(attributes.getNumber("timeout").intValue()); - // ÊÇ·ñΪֻ¶Á + // 是å�¦ä¸ºå�ªè¯» rbta.setReadOnly(attributes.getBoolean("readOnly")); rbta.setQualifier(attributes.getString("value")); - // ´¦Àí»Ø¹öÒì³£ + // 处ç�†å›žæ»šå¼‚常 List rollbackRules = new ArrayList<>(); for (Class rbRule : attributes.getClassArray("rollbackFor")) { rollbackRules.add(new RollbackRuleAttribute(rbRule)); @@ -541,7 +541,7 @@ spring for (String rbRule : attributes.getStringArray("rollbackForClassName")) { rollbackRules.add(new RollbackRuleAttribute(rbRule)); } - // ´¦Àí²»»Ø¹öÒì³£ + // 处ç�†ä¸�回滚异常 for (Class rbRule : attributes.getClassArray("noRollbackFor")) { rollbackRules.add(new NoRollbackRuleAttribute(rbRule)); } @@ -555,21 +555,21 @@ spring ``` -¿ÉÒÔ¿´µ½£¬`Transactional` ×¢½âµÄ¸÷ÊôÐÔ½âÎö³ÉÁË `RuleBasedTransactionAttribute`. +å�¯ä»¥çœ‹åˆ°ï¼Œ`Transactional` 注解的å�„属性解æž�æˆ�了 `RuleBasedTransactionAttribute`. -ÖÁ´Ë£¬ÎÒÃǾÍÃ÷°×ÁË£¬`TransactionAttributeSourcePointcut#matches` ¾ÍÊÇÓÃÀ´ÅжÏÀà»ò·½·¨ÉÏÓÐûÓÐ `Transactional` ×¢½â¡£ +至此,我们就明白了,`TransactionAttributeSourcePointcut#matches` 就是用æ�¥åˆ¤æ–­ç±»æˆ–方法上有没有 `Transactional` 注解。 -#### 1.5 ´úÀí¶ÔÏóµÄ´´½¨ +#### 1.5 代ç�†å¯¹è±¡çš„创建 -´úÀí¶ÔÏóµÄ´´½¨ÔÚ `AbstractAutoProxyCreator#postProcessAfterInitialization` ·½·¨ÖÐÍê³ÉµÄ£¬Õâ¸öÁ÷³Ìͬ aop Á÷³ÌÕæµÄÊÇһģһÑù£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË£¬ÏëÁ˽âµÄС»ï°é¿É²é¿´ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)¡£ +代ç�†å¯¹è±¡çš„创建在 `AbstractAutoProxyCreator#postProcessAfterInitialization` 方法中完æˆ�的,这个æµ�程å�Œ aop æµ�程真的是一模一样,这里就ä¸�å†�分æž�了,想了解的å°�伙伴å�¯æŸ¥çœ‹ [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)。 -### 2\. ·½·¨µÄÖ´ÐÐ +### 2\. 方法的执行 -·½·¨µÄÖ´Ðз½Ã棬ÊÂÎñÓë aop µÄÖ´ÐÐÁ÷³Ì²¢ÎÞÇø±ð£¬Ò»ÑùÊÇͨ¹ý `Advisor` ÕÒµ½¶ÔÓ¦µÄ `Advice`£¬ÔÙͨ¹ý `Advice` ÕÒµ½¶ÔÓ¦µÄ `methodInterceptor`£¬×îÖÕÖ´ÐеÄÊÇ `MethodInterceptor#invoke` ·½·¨£¬ÔÚÊÂÎñÕâÀï `MethodInterceptor` Ϊ `TransactionInterceptor`£¬Õâ¸öÀàÊÇÔÚ `ProxyTransactionManagementConfiguration` ÖÐͨ¹ý `@Bean` ×¢½âÒýÈëµÄ¡£ +方法的执行方é�¢ï¼Œäº‹åŠ¡ä¸Ž aop 的执行æµ�程并无区别,一样是通过 `Advisor` 找到对应的 `Advice`,å†�通过 `Advice` 找到对应的 `methodInterceptor`,最终执行的是 `MethodInterceptor#invoke` 方法,在事务这里 `MethodInterceptor` 为 `TransactionInterceptor`,这个类是在 `ProxyTransactionManagementConfiguration` 中通过 `@Bean` 注解引入的。 -¹ØÓÚ aop µÄÁ÷³Ì£¬ÎÒÃDz¢²»´òËã·ÖÎö£¬Ïà¹Ø·ÖÎöÔÚ [spring aop Ö® jdk ¶¯Ì¬´úÀí](https://my.oschina.net/funcy/blog/4696654) Óë[ spring aop Ö® cglib ´úÀí](https://my.oschina.net/funcy/blog/4696655) ÒÑÓÐÏêϸ·ÖÎö£¬¸ÐÐËȤµÄС»ï°é¿É×ÔÐвéÔÄ£¬ÕâÀïÎÒÃÇÖ±½ÓÀ´¿´ `TransactionInterceptor#invoke` µÄÖ´ÐÐÁ÷³Ì¡£ +关于 aop çš„æµ�程,我们并ä¸�打算分æž�,相关分æž�在 [spring aop 之 jdk 动æ€�代ç�†](https://my.oschina.net/funcy/blog/4696654) 与[ spring aop 之 cglib 代ç�†](https://my.oschina.net/funcy/blog/4696655) 已有详细分æž�,感兴趣的å°�伙伴å�¯è‡ªè¡ŒæŸ¥é˜…,这里我们直接æ�¥çœ‹ `TransactionInterceptor#invoke` 的执行æµ�程。 -ÊÂÎñµÄ´¦ÀíµÄÁ÷³ÌÔÚ `TransactionInterceptor#invoke` ·½·¨ÖУº +事务的处ç�†çš„æµ�程在 `TransactionInterceptor#invoke` 方法中: > TransactionInterceptor#invoke @@ -577,13 +577,13 @@ spring public Object invoke(MethodInvocation invocation) throws Throwable { Class targetClass = (invocation.getThis() != null ? AopUtils.getTargetClass(invocation.getThis()) : null); - // ¼ÌÐøÍùÏ¿´ + // 继续往下看 return invokeWithinTransaction(invocation.getMethod(), targetClass, invocation::proceed); } ``` -ÕæÕýµÄ´¦ÀíÂß¼­ÔÚ `TransactionAspectSupport#invokeWithinTransaction` ·½·¨ÖУº +真正的处ç�†é€»è¾‘在 `TransactionAspectSupport#invokeWithinTransaction` 方法中: > TransactionAspectSupport#invokeWithinTransaction @@ -591,35 +591,35 @@ public Object invoke(MethodInvocation invocation) throws Throwable { protected Object invokeWithinTransaction(Method method, @Nullable Class targetClass, final InvocationCallback invocation) throws Throwable { TransactionAttributeSource tas = getTransactionAttributeSource(); - // »ñÈ¡@TransactionalµÄÊôÐÔÅäÖà + // 获å�–@Transactional的属性é…�ç½® final TransactionAttribute txAttr = (tas != null ? tas.getTransactionAttribute(method, targetClass) : null); - // »ñÈ¡ÊÂÎñ¹ÜÀíÆ÷£¨IOCÈÝÆ÷ÖлñÈ¡£© + // 获å�–事务管ç�†å™¨ï¼ˆIOC容器中获å�–) final TransactionManager tm = determineTransactionManager(txAttr); - // Ê¡ÂÔ ReactiveTransactionManager µÄ´¦Àí + // çœ�ç•¥ ReactiveTransactionManager 的处ç�† ... PlatformTransactionManager ptm = asPlatformTransactionManager(tm); - // »ñÈ¡·½·¨µÄÈ«ÏÞ¶¨Ãû£¬¸ñʽΪ£º"°üÃû.ÀàÐÍ.·½·¨Ãû" + // 获å�–方法的全é™�定å��,格å¼�为:"包å��.类型.方法å��" final String joinpointIdentification = methodIdentification(method, targetClass, txAttr); - // ÊÂÎñµÄ´¦ÀíÂß¼­£¬ÕâÒ²ÊÇÎÒÃǽÓÏÂÀ´Ö÷Òª·ÖÎöµÄµØ·½ + // 事务的处ç�†é€»è¾‘,这也是我们接下æ�¥ä¸»è¦�分æž�的地方 if (txAttr == null || !(ptm instanceof CallbackPreferringPlatformTransactionManager)) { - // 1\. ¿ªÆôÊÂÎñ + // 1\. å¼€å�¯äº‹åŠ¡ TransactionInfo txInfo = createTransactionIfNecessary(ptm, txAttr, joinpointIdentification); Object retVal; try { - // 2\. Ö´ÐоßÌåµÄÒµÎñ + // 2\. 执行具体的业务 retVal = invocation.proceedWithInvocation(); } catch (Throwable ex) { - // 3\. Òì³£»Ø¹ö + // 3\. 异常回滚 completeTransactionAfterThrowing(txInfo, ex); throw ex; } finally { - // ÖØÖÃÊÂÎñÐÅÏ¢ + // é‡�置事务信æ�¯ cleanupTransactionInfo(txInfo); } if (vavrPresent && VavrDelegate.isVavrTry(retVal)) { @@ -628,37 +628,37 @@ protected Object invokeWithinTransaction(Method method, @Nullable Class targe retVal = VavrDelegate.evaluateTryFailure(retVal, txAttr, status); } } - // 4\. Ìá½»ÊÂÎñ£¬´úÂëÖлáÅжÏÊÇ·ñÄÜÖ§³Ö + // 4\. æ��交事务,代ç �中会判断是å�¦èƒ½æ”¯æŒ� commitTransactionAfterReturning(txInfo); return retVal; } else { - // Ê¡ÂÔÆäËû + // çœ�略其他 ... } } ``` -ÒÔÉÏ·½·¨¾ÍÊÇÊÂÎñµÄÈ«²¿Á÷³ÌÁË£¬²½ÖèÈçÏ£º +以上方法就是事务的全部æµ�程了,步骤如下: -1. ¿ªÆôÊÂÎñ -2. Ö´ÐÐÒµÎñ´úÂë -3. Òì³£»Ø¹ö -4. Ìá½»ÊÂÎñ +1. å¼€å�¯äº‹åŠ¡ +2. 执行业务代ç � +3. 异常回滚 +4. æ��交事务 -¹ØÓÚÊÂÎñµÄ¾ßÌå·ÖÎö£¬ÎÒÃǽ«ÔÚÏÂһƪÎÄÕ·ÖÎö£¬±¾ÎÄÖ»ÐèÒª¶ÔÊÂÎñµÄ´¦ÀíÁ÷³ÌÓдóÖÂÁ˽⼴¿É¡£ +关于事务的具体分æž�,我们将在下一篇文章分æž�,本文å�ªéœ€è¦�对事务的处ç�†æµ�程有大致了解å�³å�¯ã€‚ -### 3\. ×ܽá +### 3\. 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁËÊÂÎñÖдúÀí¶ÔÏóµÄ´´½¨¼°Ö´ÐÐÁ÷³Ì£¬Êµ¼ÊÉÏÕâЩ²½Öèͬ aop »ù±¾Ò»Ö£¬±¾ÎÄ×ÅÖØ·ÖÎöÁËÓë aop ²»Í¬µÄ²¿·Ö£º +本文主è¦�分æž�了事务中代ç�†å¯¹è±¡çš„创建å�Šæ‰§è¡Œæµ�程,实际上这些步骤å�Œ aop 基本一致,本文ç�€é‡�分æž�了与 aop ä¸�å�Œçš„部分: -* ÔÚ´úÀí¶ÔÏóµÄ´´½¨·½Ã棬·ÖÎöÁËÈçºÎÅжϵ±Ç°·½·¨ÄÜ·ñʹÓà `BeanFactoryTransactionAttributeSourceAdvisor`£¬Öصã·ÖÎöÁË `TransactionAttributeSourceClassFilter#matches` Óë `TransactionAttributeSourcePointcut#matches` ·½·¨£¬ÕâÊÇÅжϵĺËÐÄËùÔÚ£» +* 在代ç�†å¯¹è±¡çš„创建方é�¢ï¼Œåˆ†æž�了如何判断当å‰�方法能å�¦ä½¿ç”¨ `BeanFactoryTransactionAttributeSourceAdvisor`,é‡�点分æž�了 `TransactionAttributeSourceClassFilter#matches` 与 `TransactionAttributeSourcePointcut#matches` 方法,这是判断的核心所在; -* ÔÚ·½·¨µÄÖ´ÐÐÉϵ쬴ÖÂÔ·ÖÎöÁË `TransactionInterceptor#invoke` µÄÖ´ÐÐÁ÷³Ì£¬ÕâЩÊÂÎñµÄ¿ªÆô¡¢Ìá½»¡¢Òì³£»Ø¹öµÈÁ÷³Ì¸úÎÒÃÇÆ½³£Ê¹ÓõIJî±ð²»´ó£¬²»¹ýÀïÃæµÄ¾ßÌåϸ½ÚÎÒÃDz¢Ã»ÓзÖÎö¡£ +* 在方法的执行上的,粗略分æž�了 `TransactionInterceptor#invoke` 的执行æµ�程,这些事务的开å�¯ã€�æ��交ã€�异常回滚等æµ�程跟我们平常使用的差别ä¸�大,ä¸�过里é�¢çš„具体细节我们并没有分æž�。 -±¾ÎÄÖØµãÊÇ´úÀí¶ÔÏóµÄ´´½¨¼°Ö´ÐÐÁ÷³Ì£¬ÊÂÎñÖ´ÐеľßÌåϸ½ÚÎÒÃÇÏÂÆªÔÙ·ÖÎö¡£ +本文é‡�点是代ç�†å¯¹è±¡çš„创建å�Šæ‰§è¡Œæµ�程,事务执行的具体细节我们下篇å†�分æž�。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4773457](https://my.oschina.net/funcy/blog/4773457) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4773457](https://my.oschina.net/funcy/blog/4773457) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\224\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20603.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\224\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20603.md" index 8ac63de..12a9454 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\224\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20603.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\344\272\224\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20603.md" @@ -1,10 +1,10 @@ -±¾ÎÄÊÇ¡¶ÊÂÎñµÄ¸ôÀë¼¶±ðÓë´«²¥·½Ê½µÄ´¦Àí¡··ÖÎöµÄµÚ 3 ƪ£¬½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø¡£ +本文是《事务的隔离级别与传播方å¼�的处ç�†ã€‹åˆ†æž�的第 3 篇,接上文,我们继续。 -ÉÏÎÄÖÐÎÒÃÇÌáµ½ÁËÊÂÎñµÄ¿ªÆô£¨`doBegin(...)`£©¡¢¹ÒÆð£¨`suspend(...)`£©Óë´´½¨±£´æµã£¨`createAndHoldSavepoint(...)`£©µÄ²Ù×÷£¬±¾ÎĽ«À´·ÖÎöÕâЩ²Ù×÷µÄʵÏÖ¡£ +上文中我们æ��到了事务的开å�¯ï¼ˆ`doBegin(...)`)ã€�挂起(`suspend(...)`)与创建ä¿�存点(`createAndHoldSavepoint(...)`)的æ“�作,本文将æ�¥åˆ†æž�这些æ“�作的实现。 -### 1. `doBegin(...)`£ºÆô¶¯ÐµÄÊÂÎñ +### 1. `doBegin(...)`:å�¯åŠ¨æ–°çš„äº‹åŠ¡ -Æô¶¯ÐÂÊÂÎñµÄ·½·¨Îª `DataSourceTransactionManager#doBegin`£¬´úÂëÈçÏ£º +å�¯åŠ¨æ–°äº‹åŠ¡çš„æ–¹æ³•ä¸º `DataSourceTransactionManager#doBegin`,代ç �如下: ``` protected void doBegin(Object transaction, TransactionDefinition definition) { @@ -12,49 +12,49 @@ protected void doBegin(Object transaction, TransactionDefinition definition) { Connection con = null; try { - // 1\. »ñÈ¡Êý¾Ý¿âÁ¬½Ó + // 1\. 获å�–æ•°æ�®åº“连接 if (!txObject.hasConnectionHolder() || txObject.getConnectionHolder().isSynchronizedWithTransaction()) { - // getConnection(): »ñÈ¡Êý¾Ý¿âÁ¬½Ó£¬obtainDataSource()£º»ñÈ¡Êý¾ÝÔ´ + // getConnection(): 获å�–æ•°æ�®åº“连接,obtainDataSource():获å�–æ•°æ�®æº� Connection newCon = obtainDataSource().getConnection(); txObject.setConnectionHolder(new ConnectionHolder(newCon), true); } - // ÕâÀォ synchronizedWithTransaction ÉèÖÃΪtrue + // 这里将 synchronizedWithTransaction 设置为true txObject.getConnectionHolder().setSynchronizedWithTransaction(true); con = txObject.getConnectionHolder().getConnection(); - // 2\. ÉèÖÃÊÂÎñµÄ¸ôÀë¼¶±ð + // 2\. 设置事务的隔离级别 Integer previousIsolationLevel = DataSourceUtils.prepareConnectionForTransaction(con, definition); txObject.setPreviousIsolationLevel(previousIsolationLevel); - // ÉèÖÃÖ»¶ÁÊôÐÔ + // 设置å�ªè¯»å±žæ€§ txObject.setReadOnly(definition.isReadOnly()); - // 3\. ¿ªÆôÊÂÎñ + // 3\. å¼€å�¯äº‹åŠ¡ if (con.getAutoCommit()) { txObject.setMustRestoreAutoCommit(true); - // ¹Ø±ÕÊÂÎñµÄ×Ô¶¯Ìá½»£¬Ò²¾ÍÊÇ¿ªÆôÊÂÎñ + // 关闭事务的自动æ��交,也就是开å�¯äº‹åŠ¡ con.setAutoCommit(false); } - // 4\. Èç¹ûÊÇÖ»¶ÁÊÂÎñ£¬ÔÚÕâÀïÉèÖà + // 4\. 如果是å�ªè¯»äº‹åŠ¡ï¼Œåœ¨è¿™é‡Œè®¾ç½® prepareTransactionalConnection(con, definition); - // ÉèÖÃÊÂÎñµÄ¼¤»î±ê¼Ç + // 设置事务的激活标记 txObject.getConnectionHolder().setTransactionActive(true); - // 5\. ÉèÖÃÊÂÎñµÄ³¬Ê±Ê±¼ä + // 5\. 设置事务的超时时间 int timeout = determineTimeout(definition); if (timeout != TransactionDefinition.TIMEOUT_DEFAULT) { txObject.getConnectionHolder().setTimeoutInSeconds(timeout); } - // 6\. °ó¶¨Êý¾ÝÔ´ÓëÁ¬½Óµ½µ±Ç°Ïß³Ì + // 6\. 绑定数æ�®æº�与连接到当å‰�线程 if (txObject.isNewConnectionHolder()) { TransactionSynchronizationManager.bindResource( obtainDataSource(), txObject.getConnectionHolder()); } } } catch (Throwable ex) { - // ´¦ÀíÒì³£²Ù×÷£¬Èç¹ûÊÇÐÂÁ¬½ÓÔò¹Ø±Õ¸ÃÁ¬½Ó + // 处ç�†å¼‚常æ“�作,如果是新连接则关闭该连接 if (txObject.isNewConnectionHolder()) { DataSourceUtils.releaseConnection(con, obtainDataSource()); txObject.setConnectionHolder(null, false); @@ -65,27 +65,27 @@ protected void doBegin(Object transaction, TransactionDefinition definition) { ``` -ÒÔÉÏ´úÂ뻹ÊÇͦÇåÎúµÄ£¬×¢ÊÍÒ²ºÜÃ÷È·ÁË£¬ÕâÀï¶Ô¹Ø¼ü²½Öè×÷½øÒ»²½·ÖÎö¡£ +以上代ç �还是挺清晰的,注释也很明确了,这里对关键步骤作进一步分æž�。 -#### 1.1 »ñÈ¡Êý¾Ý¿âÁ¬½Ó +#### 1.1 获å�–æ•°æ�®åº“连接 -Êý¾Ý¿âÁ¬½ÓµÄ»ñÈ¡»¹ÊǺܼòµ¥µÄ£¬´úÂëÈçÏ£º +æ•°æ�®åº“连接的获å�–还是很简å�•的,代ç �如下: ``` Connection newCon = obtainDataSource().getConnection(); ``` -Æäʵ¾ÍÊǵ÷Óà `javax.sql.DataSource#getConnection()` ·½·¨¡£ +其实就是调用 `javax.sql.DataSource#getConnection()` 方法。 -#### 1.2 ÉèÖÃÊÂÎñµÄ¸ôÀë¼¶±ð +#### 1.2 设置事务的隔离级别 -ÔÚ `@Transactional` ÖУ¬ÎÒÃÇ¿ÉÒÔʹÓà `isolation` Ö¸¶¨ÊÂÎñµÄ¸ôÀë¼¶±ð£º +在 `@Transactional` 中,我们å�¯ä»¥ä½¿ç”¨ `isolation` 指定事务的隔离级别: ``` public @interface Transactional { /** - * Ö¸¶¨ÊÂÎñµÄ¸ôÀë¼¶±ð + * 指定事务的隔离级别 */ Isolation isolation() default Isolation.DEFAULT; ... @@ -93,9 +93,9 @@ public @interface Transactional { ``` -Èç¹û²»Ö¸¶¨£¬¾ÍʹÓÃĬÈϵĸôÀë¼¶±ð£¬Ò²¾ÍÊÇʹÓÃÊý¾Ý¿âÅäÖõġ£ +如果ä¸�指定,就使用默认的隔离级别,也就是使用数æ�®åº“é…�置的。 -spring ÉèÖÃÊÂÎñ¸ôÀë¼¶±ðµÄ·½·¨Îª `DataSourceUtils#prepareConnectionForTransaction`£¬´úÂëÈçÏ£º +spring 设置事务隔离级别的方法为 `DataSourceUtils#prepareConnectionForTransaction`,代ç �如下: ``` public static Integer prepareConnectionForTransaction(Connection con, @@ -103,7 +103,7 @@ public static Integer prepareConnectionForTransaction(Connection con, Assert.notNull(con, "No Connection specified"); if (definition != null && definition.isReadOnly()) { try { - // ÉèÖÃΪֻ¶Áģʽ + // 设置为å�ªè¯»æ¨¡å¼� con.setReadOnly(true); } catch (SQLException | RuntimeException ex) { @@ -116,9 +116,9 @@ public static Integer prepareConnectionForTransaction(Connection con, != TransactionDefinition.ISOLATION_DEFAULT) { int currentIsolation = con.getTransactionIsolation(); if (currentIsolation != definition.getIsolationLevel()) { - // Äõ½Ö®Ç°µÄ¸ôÀë¼¶±ð£¬ÊÂÎñÍê³ÉÊ£¬ÐèÒªÖØÖÃΪԭÀ´µÄ¸ôÀë¼¶±ð + // 拿到之å‰�的隔离级别,事务完æˆ�事,需è¦�é‡�置为原æ�¥çš„隔离级别 previousIsolationLevel = currentIsolation; - // ÔÚÕâÀïÉèÖÃÊý¾Ý¿âµÄ¸ôÀë¼¶±ð£¬µ÷ÓõÄÊÇ£º + // 在这里设置数æ�®åº“的隔离级别,调用的是: // java.sql.Connection.setTransactionIsolation con.setTransactionIsolation(definition.getIsolationLevel()); } @@ -128,17 +128,17 @@ public static Integer prepareConnectionForTransaction(Connection con, ``` -Õâ ¸ö·½·¨´¦ÀíÁËÁ½¸öÉèÖ㺠+è¿™ 个方法处ç�†äº†ä¸¤ä¸ªè®¾ç½®ï¼š -1. ÉèÖÃΪֻ¶Áģʽ£ºµ÷ÓõÄÊÇ `java.sql.Connection#setReadOnly` ·½·¨ -2. ÉèÖøôÀë¼¶±ð£ºµ÷ÓõÄÊÇ `java.sql.Connection.setTransactionIsolation` ·½·¨ +1. 设置为å�ªè¯»æ¨¡å¼�:调用的是 `java.sql.Connection#setReadOnly` 方法 +2. 设置隔离级别:调用的是 `java.sql.Connection.setTransactionIsolation` 方法 -¹ØÓÚÖ»¶Áģʽ£¬Ò²ÊÇ¿ÉÒÔÔÚ `@Transactional` ÖÐÉèÖõģº +关于å�ªè¯»æ¨¡å¼�,也是å�¯ä»¥åœ¨ `@Transactional` 中设置的: ``` public @interface Transactional { /** - * ÉèÖÃÖ»¶ÁÊÂÎñ + * 设置å�ªè¯»äº‹åŠ¡ */ boolean readOnly() default false; ... @@ -146,34 +146,34 @@ public @interface Transactional { ``` -#### 1.3 ¿ªÆôÊÂÎñ +#### 1.3 å¼€å�¯äº‹åŠ¡ -¼¤¶¯ÈËÐĵÄʱ¿ÌÖÕÓÚÀ´ÁË£¬Ç°ÃæÆÌµæÁËÄÇô¶à£¬¾ÍÊÇΪÁËÕâÒ»²½µÄ²Ù×÷£º¿ªÆôÊÂÎñ¡£¿ªÆôÊÂÎñµÄ´úÂëÈçÏ£º +激动人心的时刻终于æ�¥äº†ï¼Œå‰�é�¢é“ºåž«äº†é‚£ä¹ˆå¤šï¼Œå°±æ˜¯ä¸ºäº†è¿™ä¸€æ­¥çš„æ“�作:开å�¯äº‹åŠ¡ã€‚å¼€å�¯äº‹åŠ¡çš„ä»£ç �如下: ``` if (con.getAutoCommit()) { txObject.setMustRestoreAutoCommit(true); - // ¹Ø±ÕÊÂÎñµÄ×Ô¶¯Ìá½»£¬Ò²¾ÍÊÇ¿ªÆôÊÂÎñ + // 关闭事务的自动æ��交,也就是开å�¯äº‹åŠ¡ con.setAutoCommit(false); } ``` -¾ßÌåÁ÷³ÌΪ£¬ÏÈÅжÏ×Ô¶¯Ìá½»ÊÇ·ñ¿ªÆô£¬Èç¹û¿ªÉèÖÃÁË£¬¾Í½«ÆäÉèÖÃΪ false£¬µ÷ÓõÄÒ²ÊÇ `java.sql` µÄ·½·¨£º +具体æµ�程为,先判断自动æ��交是å�¦å¼€å�¯ï¼Œå¦‚果开设置了,就将其设置为 false,调用的也是 `java.sql` 的方法: -* »ñÈ¡×Ô¶¯Ìύ״̬£º`java.sql.Connection#getAutoCommit` -* ÉèÖÃ×Ô¶¯Ìύ״̬£º`java.sql.Connection#setAutoCommit` +* 获å�–自动æ��交状æ€�:`java.sql.Connection#getAutoCommit` +* 设置自动æ��交状æ€�:`java.sql.Connection#setAutoCommit` -#### 1.4 Èç¹ûÊÇÖ»¶ÁÊÂÎñ£¬ÔÚÕâÀïÉèÖà +#### 1.4 如果是å�ªè¯»äº‹åŠ¡ï¼Œåœ¨è¿™é‡Œè®¾ç½® -ÔÚÇ°Ãæ·ÖÎö `1.2 ÉèÖÃÊÂÎñµÄ¸ôÀë¼¶±ð`ÖУ¬Í¨¹ýµ÷Óà `java.sql.Connection#setReadOnly` ½«Á¬½ÓÉèÖÃΪֻ¶ÁÁË£¬ÕâÀﻹ»áÔÙÒ»´ÎÉèÖ㬷½·¨Îª `DataSourceTransactionManager#prepareTransactionalConnection`£º +在å‰�é�¢åˆ†æž� `1.2 设置事务的隔离级别`中,通过调用 `java.sql.Connection#setReadOnly` 将连接设置为å�ªè¯»äº†ï¼Œè¿™é‡Œè¿˜ä¼šå†�一次设置,方法为 `DataSourceTransactionManager#prepareTransactionalConnection`: ``` protected void prepareTransactionalConnection(Connection con, TransactionDefinition definition) throws SQLException { if (isEnforceReadOnly() && definition.isReadOnly()) { try (Statement stmt = con.createStatement()) { - // ÉèÖÃÖ»¶ÁÀàÐÍÒªÔËÐÐsql + // 设置å�ªè¯»ç±»åž‹è¦�è¿�行sql stmt.executeUpdate("SET TRANSACTION READ ONLY"); } } @@ -181,16 +181,16 @@ protected void prepareTransactionalConnection(Connection con, TransactionDefinit ``` -ÕâÒ»´ÎÊÇͨ¹ýÖ´ÐÐ sql Óï¾ä `SET TRANSACTION READ ONLY` ½«ÊÂÎñÉèÖÃΪֻ¶Á¡£ +这一次是通过执行 sql 语å�¥ `SET TRANSACTION READ ONLY` 将事务设置为å�ªè¯»ã€‚ -#### 1.5 ÉèÖÃÊÂÎñµÄ³¬Ê±Ê±¼ä +#### 1.5 设置事务的超时时间 -ÔÚ `@Transactional` ×¢½âÖУ¬ÎÒÃÇ¿ÉÒÔʹÓà `timeout` À´Ö¸¶¨ÊÂÎñµÄ³¬Ê±Ê±¼ä£º +在 `@Transactional` 注解中,我们å�¯ä»¥ä½¿ç”¨ `timeout` æ�¥æŒ‡å®šäº‹åŠ¡çš„è¶…æ—¶æ—¶é—´ï¼š ``` public @interface Transactional { /** - * ÉèÖó¬Ê±Ê±¼ä + * 设置超时时间 */ int timeout() default TransactionDefinition.TIMEOUT_DEFAULT; ... @@ -198,32 +198,32 @@ public @interface Transactional { ``` -ÕâÑùÉèÖõij¬Ê±Ê±¼ä»áÔÚÕâÀïÓõ½£¬ÎÒÃǽøÈë `ResourceHolderSupport#setTimeoutInSeconds`£º +这样设置的超时时间会在这里用到,我们进入 `ResourceHolderSupport#setTimeoutInSeconds`: ``` public abstract class ResourceHolderSupport implements ResourceHolder { /** - * ½ØÖ¹Ê±¼ä + * 截止时间 */ private Date deadline; /** - * ÉèÖÃʱ¼ä£¬µ¥Î»£ºÃë + * 设置时间,å�•ä½�:秒 */ public void setTimeoutInSeconds(int seconds) { setTimeoutInMillis(seconds * 1000L); } /** - * ÉèÖÃʱ¼ä£¬µ¥Î»£ººÁÃë - * ×îºó»áת»¯Îª ½ØÖ¹Ê±¼ä + * 设置时间,å�•ä½�:毫秒 + * 最å�Žä¼šè½¬åŒ–为 截止时间 */ public void setTimeoutInMillis(long millis) { this.deadline = new Date(System.currentTimeMillis() + millis); } /** - * »ñÈ¡½ØÖ¹Ê±¼ä + * 获å�–截止时间 */ @Nullable public Date getDeadline() { @@ -231,7 +231,7 @@ public abstract class ResourceHolderSupport implements ResourceHolder { } /** - * »ñȡʣÓàʱ¼ä£¬µ¥Î»£ºÃë + * 获å�–剩余时间,å�•ä½�:秒 */ public int getTimeToLiveInSeconds() { double diff = ((double) getTimeToLiveInMillis()) / 1000; @@ -241,7 +241,7 @@ public abstract class ResourceHolderSupport implements ResourceHolder { } /** - * »ñȡʣÓàʱ¼ä£¬µ¥Î»£ººÁÃë + * 获å�–剩余时间,å�•ä½�:毫秒 */ public long getTimeToLiveInMillis() throws TransactionTimedOutException{ if (this.deadline == null) { @@ -257,19 +257,19 @@ public abstract class ResourceHolderSupport implements ResourceHolder { ``` -ÔÚ `ResourceHolderSupport` ÖÐά»¤ÁËÒ»¸ö³ÉÔ±±äÁ¿ `deadline`£¨½ØÖ¹Ê±¼ä£©£¬´«ÈëµÄ³¬Ê±Ê±¼ä×îÖÕ¶¼»áת»¯Îª `deadline`¡£ +在 `ResourceHolderSupport` 中维护了一个æˆ�员å�˜é‡� `deadline`(截止时间),传入的超时时间最终都会转化为 `deadline`。 -»ñȡʣÓàʱ¼äʱ£¬Ò²ÊÇÓÉ `deadline` ¼ÆËãµÃµ½£¬·µ»ØµÄÊ£Óàʱ¼äÓÐÃëÓëºÁÃëÁ½ÖÖ¡£ +获å�–剩余时间时,也是由 `deadline` 计算得到,返回的剩余时间有秒与毫秒两ç§�。 -¿´µ½ÕâÀ`txObject.getConnectionHolder().setTimeoutInSeconds(timeout)` Ö»Êǽ«³¬Ê±Ê±¼äÉèÖõ½ `ConnectionHolder` µÄ³ÉÔ±±äÁ¿ÖУ¨`ConnectionHolder` ÊÇ `ResourceHolderSupport` µÄ×ÓÀࣩ£¬Ëƺõ¸úÊý¾Ý¿âûɶ¹ØÏµ£¬Êý¾Ý¿âÊÇÔõô¿ØÖÆÊÂÎñ³¬Ê±µÄÄØ£¿ +看到这里,`txObject.getConnectionHolder().setTimeoutInSeconds(timeout)` å�ªæ˜¯å°†è¶…时时间设置到 `ConnectionHolder` çš„æˆ�员å�˜é‡�中(`ConnectionHolder` 是 `ResourceHolderSupport` çš„å­�类),似乎跟数æ�®åº“没啥关系,数æ�®åº“是怎么控制事务超时的呢? -²»µÃ²»Ëµ£¬Õâ¸ö³¬Ê±µÄ¿ØÖÆÊÇÓеãÄÑÕÒ£¬±¾ÎÄÊÇͨ¹ýµ÷ÊÔÕÒµ½µÄ£¬³¬Ê±Ê±¼äµÄÉèÖÃÔÚÔÚ `DataSourceUtils#applyTimeout` ·½·¨ÖУ¬ÕâÆäÖпÉνÊǾ­¹ýÁËǧɽÍòË®£º +ä¸�å¾—ä¸�说,这个超时的控制是有点难找,本文是通过调试找到的,超时时间的设置在在 `DataSourceUtils#applyTimeout` 方法中,这其中å�¯è°“是ç»�过了å�ƒå±±ä¸‡æ°´ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-9fc1a75dc7b0644269b6dba16dfd5d0e676.png) -¸Ðлµ÷ÊÔ¹¦ÄÜ£¬Ã»ÓÐËü£¬ÌìÖªµÀÒª¶à¾Ã²ÅÄÜÕÒµ½Õâ¸öʱ¼äµÄÉèÖã¡ÎÒÕâÀïʹÓõÄÊÇ `jdbcTemplate`£¬ÔÚÆäËû `orm` ¿ò¼ÜÏ£¬ÉèÖó¬Ê±Ê±¼äÓ¦¸Ã»áÓÐËù²»Í¬ ¡£ +感谢调试功能,没有它,天知é�“è¦�多久æ‰�能找到这个时间的设置ï¼�我这里使用的是 `jdbcTemplate`,在其他 `orm` 框架下,设置超时时间应该会有所ä¸�å�Œ 。 -ÎÒÃÇ¿´¿´ `DataSourceUtils#applyTimeout` ÊÇÔõôÉèÖó¬Ê±Ê±¼äµÄ£º +我们看看 `DataSourceUtils#applyTimeout` 是怎么设置超时时间的: ``` public static void applyTimeout(Statement stmt, @Nullable DataSource dataSource, int timeout) @@ -280,33 +280,33 @@ public static void applyTimeout(Statement stmt, @Nullable DataSource dataSource, holder = (ConnectionHolder) TransactionSynchronizationManager.getResource(dataSource); } if (holder != null && holder.hasTimeout()) { - // ÕâÀï¾ÍÊÇ»ñȡʣÓàµÄ³¬Ê±Ê±¼ä£¬ÓÉ ConnectionHolder.dateline ¼ÆËãµÃµ½µÄ + // 这里就是获å�–剩余的超时时间,由 ConnectionHolder.dateline 计算得到的 stmt.setQueryTimeout(holder.getTimeToLiveInSeconds()); } else if (timeout >= 0) { - // jdbcTemplate ×ÔÉíÒ²¿ÉÒÔÉèÖòéѯ³¬Ê±Ê±¼ä + // jdbcTemplate 自身也å�¯ä»¥è®¾ç½®æŸ¥è¯¢è¶…æ—¶æ—¶é—´ stmt.setQueryTimeout(timeout); } } ``` -×îÖÕµ÷ÓõÄÊÇ `java.sql.Statement#setQueryTimeout` À´ÉèÖó¬Ê±Ê±¼äµÄ¡£ +最终调用的是 `java.sql.Statement#setQueryTimeout` æ�¥è®¾ç½®è¶…时时间的。 -#### 1.6 °ó¶¨Êý¾ÝÔ´ÓëÁ¬½Óµ½µ±Ç°Ïß³Ì +#### 1.6 绑定数æ�®æº�与连接到当å‰�线程 -ÒÔÉÏÊÂÇé´¦ÀíÍê³Éºó£¬½ÓÏÂÀ´¾ÍÊǰó¶¨Êý¾ÝÔ´ÓëÁ¬½ÓÁË£¬´¦Àí·½·¨Îª `TransactionSynchronizationManager#bindResource`: +以上事情处ç�†å®Œæˆ�å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ˜¯ç»‘定数æ�®æº�与连接了,处ç�†æ–¹æ³•为 `TransactionSynchronizationManager#bindResource`: ``` /** - * resources ´æ·Åµ±Ç°Ïß³ÌÖеÄÊý¾ÝÔ´ÓëÁ¬½Ó - * ÆäÖдæ·ÅµÄÄÚÈÝΪһ¸ö Map£¬Map µÄ key ΪÊý¾ÝÔ´£¬value ΪÊý¾ÝÔ´¶ÔÓ¦µÄÁ¬½Ó + * resources 存放当å‰�线程中的数æ�®æº�与连接 + * 其中存放的内容为一个 Map,Map çš„ key 为数æ�®æº�,value 为数æ�®æº�对应的连接 */ private static final ThreadLocal> resources = new NamedThreadLocal<>("Transactional resources"); /** - * °ó¶¨²Ù×÷ + * 绑定æ“�作 */ public static void bindResource(Object key, Object value) throws IllegalStateException { Object actualKey = TransactionSynchronizationUtils.unwrapResourceIfNecessary(key); @@ -316,7 +316,7 @@ public static void bindResource(Object key, Object value) throws IllegalStateExc map = new HashMap<>(); resources.set(map); } - // ½«Êý¾ÝÔ´ÓëÁ¬½Ó´æ·Åµ½mapÖÐ + // 将数æ�®æº�与连接存放到map中 Object oldValue = map.put(actualKey, value); if (oldValue instanceof ResourceHolder && ((ResourceHolder) oldValue).isVoid()) { oldValue = null; @@ -328,38 +328,38 @@ public static void bindResource(Object key, Object value) throws IllegalStateExc ``` -Õâ Ò»²½µÄ²Ù×÷»¹ÊDZȽϼòµ¥µÄ£¬¾ÍÊǽ«Êý¾ÝÔ´ÓëÁ¬½Ó·Å½ø `resources` ÖУ¬´Ó¶øÍê³ÉÓ뵱ǰÏ̵߳İ󶨲Ù×÷¡£ +è¿™ 一步的æ“�作还是比较简å�•的,就是将数æ�®æº�与连接放进 `resources` 中,从而完æˆ�与当å‰�线程的绑定æ“�作。 -### 2. `suspend(...)`£º¹ÒÆðÊÂÎñ +### 2. `suspend(...)`:挂起事务 -¹ÒÆðÊÂÎñµÄ²Ù×÷Ϊ `AbstractPlatformTransactionManager#suspend`£¬´úÂëÈçÏ£º +挂起事务的æ“�作为 `AbstractPlatformTransactionManager#suspend`,代ç �如下: ``` protected final SuspendedResourcesHolder suspend(@Nullable Object transaction) throws TransactionException { - // Èç¹ûÓÐͬ²½µÄÊÂÎñ£¬ÔòÓÅÏÈ¹ÒÆðͬ²½µÄÊÂÎñ + // 如果有å�Œæ­¥çš„事务,则优先挂起å�Œæ­¥çš„事务 if (TransactionSynchronizationManager.isSynchronizationActive()) { List suspendedSynchronizations = doSuspendSynchronization(); try { Object suspendedResources = null; if (transaction != null) { - // ¹ÒÆð²Ù×÷ + // 挂起æ“�作 suspendedResources = doSuspend(transaction); } - // ÖØÖÃÊÂÎñÃû³Æ + // é‡�置事务å��ç§° String name = TransactionSynchronizationManager.getCurrentTransactionName(); TransactionSynchronizationManager.setCurrentTransactionName(null); - // ÖØÖÃÖ»¶Á״̬ + // é‡�ç½®å�ªè¯»çжæ€� boolean readOnly = TransactionSynchronizationManager.isCurrentTransactionReadOnly(); TransactionSynchronizationManager.setCurrentTransactionReadOnly(false); - // ÖØÖøôÀë¼¶±ð + // é‡�置隔离级别 Integer isolationLevel = TransactionSynchronizationManager .getCurrentTransactionIsolationLevel(); TransactionSynchronizationManager.setCurrentTransactionIsolationLevel(null); - // ÖØÖÃÊÂÎñ¼¤»î״̬ + // é‡�置事务激活状æ€� boolean wasActive = TransactionSynchronizationManager.isActualTransactionActive(); TransactionSynchronizationManager.setActualTransactionActive(false); - // ·µ»Ø¹ÒÆðµÄÊÂÎñ + // 返回挂起的事务 return new SuspendedResourcesHolder( suspendedResources, suspendedSynchronizations, name, readOnly, isolationLevel, wasActive); @@ -380,27 +380,27 @@ protected final SuspendedResourcesHolder suspend(@Nullable Object transaction) ``` -`suspend(...)` ·½·¨ÖÐ×îÖØÒªµÄ¾ÍÊÇ¹ÒÆðÊÂÎñµÄ²Ù×÷ÁË£¬Ò²¾ÍÊÇ `doSuspend(transaction)`£¬¸Ã·½·¨ λÓÚ `` ÖУ¬Ö±½Ó¿´´úÂ룺 +`suspend(...)` 方法中最é‡�è¦�的就是挂起事务的æ“�作了,也就是 `doSuspend(transaction)`,该方法 ä½�于 `` 中,直接看代ç �: ``` protected Object doSuspend(Object transaction) { DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction; txObject.setConnectionHolder(null); - // ½â³ý°ó¶¨ + // 解除绑定 return TransactionSynchronizationManager.unbindResource(obtainDataSource()); } ``` -¼ÌÐø½øÈë `TransactionSynchronizationManager.unbindResource` ·½·¨£º +继续进入 `TransactionSynchronizationManager.unbindResource` 方法: ``` /** - * ½â³ý°ó¶¨²Ù×÷ + * 解除绑定æ“�作 */ public static Object unbindResource(Object key) throws IllegalStateException { Object actualKey = TransactionSynchronizationUtils.unwrapResourceIfNecessary(key); - // ¼ÌÐøµ÷Óà + // 继续调用 Object value = doUnbindResource(actualKey); if (value == null) { throw new IllegalStateException(...); @@ -409,14 +409,14 @@ public static Object unbindResource(Object key) throws IllegalStateException { } /** - * ½â³ý°ó¶¨²Ù×÷ + * 解除绑定æ“�作 */ private static Object doUnbindResource(Object actualKey) { Map map = resources.get(); if (map == null) { return null; } - // ÒÆ³ý×ÊÔ´ + // 移除资æº� Object value = map.remove(actualKey); if (map.isEmpty()) { resources.remove(); @@ -429,17 +429,17 @@ private static Object doUnbindResource(Object actualKey) { ``` -ÔÚ¿ªÆôÊÂÎñʱ£¬Êǽ«Êý¾ÝÔ´ÓëÁ¬½Ó°ó¶¨µ½µ±Ç°Ị̈߳¬¹ÒÆðʱ £¬Êǽ«Êý¾ÝÔ´ÓëÁ¬½Ó½â³ýÓ뵱ǰÏ̵߳İ󶨹ØÏµ¡£ +在开å�¯äº‹åŠ¡æ—¶ï¼Œæ˜¯å°†æ•°æ�®æº�与连接绑定到当å‰�线程,挂起时 ,是将数æ�®æº�与连接解除与当å‰�线程的绑定关系。 -### 3. `createAndHoldSavepoint(...)`£º´´½¨±£´æµã +### 3. `createAndHoldSavepoint(...)`:创建ä¿�存点 -±£´æµãµÄ´´½¨ÔÚ `AbstractTransactionStatus#createAndHoldSavepoint` ·½·¨Öд¦Àí£¬´úÂëÈçÏ£º +ä¿�存点的创建在 `AbstractTransactionStatus#createAndHoldSavepoint` 方法中处ç�†ï¼Œä»£ç �如下: ``` - // ±£´æµã + // ä¿�存点 private Object savepoint; - // ´´½¨±£´æµã + // 创建ä¿�存点 public void createAndHoldSavepoint() throws TransactionException { setSavepoint(getSavepointManager().createSavepoint()); } @@ -450,7 +450,7 @@ private static Object doUnbindResource(Object actualKey) { ``` -àÅ£¬¿´À´Õâ¸ö·½·¨ÀïÖ»ÊÇ×öÁË`±£´æµã`µÄ±£´æ£¨Ò²¾ÍÊǸ³Öµ¸ø `AbstractTransactionStatus` µÄ³ÉÔ±±äÁ¿£©£¬ÒªÕæÕýÁ˽Ᵽ´æµãµÄ´´½¨£¬»¹µÃ¿´ `getSavepointManager().createSavepoint()`£¬½øÈëµ½ `JdbcTransactionObjectSupport#createSavepoint`£º +嗯,看æ�¥è¿™ä¸ªæ–¹æ³•里å�ªæ˜¯å�šäº†`ä¿�存点`çš„ä¿�存(也就是赋值给 `AbstractTransactionStatus` çš„æˆ�员å�˜é‡�),è¦�真正了解ä¿�存点的创建,还得看 `getSavepointManager().createSavepoint()`,进入到 `JdbcTransactionObjectSupport#createSavepoint`: ``` public Object createSavepoint() throws TransactionException { @@ -462,7 +462,7 @@ public Object createSavepoint() throws TransactionException { if (conHolder.isRollbackOnly()) { throw new CannotCreateTransactionException(...); } - // ´´½¨±£´æµã + // 创建ä¿�存点 return conHolder.createSavepoint(); } catch (SQLException ex) { @@ -472,29 +472,29 @@ public Object createSavepoint() throws TransactionException { ``` -·¢ÏÖ×îºóµ÷ÓõÄÊÇ `ConnectionHolder#createSavepoint` ·½·¨£¬Ô­À´±£´æµãÊÇÔÚ `ConnectionHolder` Öд´½¨µÄ°¡£¡¼ÌÐø£º +å�‘现最å�Žè°ƒç”¨çš„æ˜¯ `ConnectionHolder#createSavepoint` 方法,原æ�¥ä¿�存点是在 `ConnectionHolder` 中创建的啊ï¼�继续: ``` -// ±£´æµãÃû³ÆÇ°×º +// ä¿�存点å��ç§°å‰�ç¼€ public static final String SAVEPOINT_NAME_PREFIX = "SAVEPOINT_"; -// ±£´æµãÊýÁ¿ +// ä¿�存点数é‡� private int savepointCounter = 0; public Savepoint createSavepoint() throws SQLException { this.savepointCounter++; - // ÕâÀï´´½¨±£´æµã£¬µ÷ÓõÄÊÇ java.sql.Connection#setSavepoint(java.lang.String) ·½·¨ + // 这里创建ä¿�存点,调用的是 java.sql.Connection#setSavepoint(java.lang.String) 方法 return getConnection().setSavepoint(SAVEPOINT_NAME_PREFIX + this.savepointCounter); } ``` -±£´æµãÃû³ÆÇ°×ºÎª `SAVEPOINT_`£¬Ã¿´´½¨Ò»¸ö±£´æµã£¬`savepointCounter` µÄ¼ÆÊýÆ÷¾Í¼Ó 1£¬×îÖÕ±£´æµãµÄÃû³ÆÎª `SAVEPOINT_1`¡¢`SAVEPOINT_2`¡¢... +ä¿�存点å��ç§°å‰�缀为 `SAVEPOINT_`,æ¯�创建一个ä¿�存点,`savepointCounter` 的计数器就加 1,最终ä¿�存点的å��称为 `SAVEPOINT_1`ã€�`SAVEPOINT_2`ã€�... -´´½¨±£´æµã×îÖÕµ÷Óõķ½·¨ÊÇ `java.sql.Connection#setSavepoint(java.lang.String)`£¬ÒÀÈ»ÊÇ jdk ÌṩµÄ·½·¨£¬·ÖÎöµ½ÕâÀÎÒÃǻᷢÏÖÊÂÎñµÄ´ó²¿·Ö²Ù×÷¶¼ÊÇ spring ¶Ô jdk ·½·¨µÄ·â×°¡£ +创建ä¿�存点最终调用的方法是 `java.sql.Connection#setSavepoint(java.lang.String)`,ä¾�然是 jdk æ��供的方法,分æž�到这里,我们会å�‘现事务的大部分æ“�作都是 spring 对 jdk 方法的å°�装。 -ºÃÁË£¬±¾ÎĵķÖÎö¾ÍÏȵ½ÁË£¬¹ØÓÚÊÂÎñµÄÌá½»¡¢»Ø¹ö¡¢»Ø¹öµ½±£´æµã¡¢»Ö¸´¹ÒÆðµÄÊÂÎñµÈ£¬ÏÂÆªÎÄÕ¼ÌÐø·ÖÎö¡£ +好了,本文的分æž�就先到了,关于事务的æ��交ã€�回滚ã€�回滚到ä¿�存点ã€�æ�¢å¤�挂起的事务等,下篇文章继续分æž�。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4947826](https://my.oschina.net/funcy/blog/4947826) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4947826](https://my.oschina.net/funcy/blog/4947826) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\205\255\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20604.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\205\255\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20604.md" index 415c012..15967b0 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\205\255\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20604.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\205\255\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20604.md" @@ -1,27 +1,27 @@ -±¾ÎÄÊÇ¡¶ÊÂÎñµÄ¸ôÀë¼¶±ðÓë´«²¥·½Ê½µÄ´¦Àí¡··ÖÎöµÄµÚ 4 ƪ£¬½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø¡£ +本文是《事务的隔离级别与传播方å¼�的处ç�†ã€‹åˆ†æž�的第 4 篇,接上文,我们继续。 -#### 3.6 Ö´ÐоßÌåµÄÒµÎñ +#### 3.6 执行具体的业务 -Õâ¿é´úÂëÈçÏ£º +è¿™å�—代ç �如下: ``` retVal = invocation.proceedWithInvocation(); ``` -ÕâÀï×îÖÕ»áµ÷Óõ½ÒµÎñ·½·¨ `UserService#insert`£¬±¾ÎIJ¢²»»á̽¾¿ÕâÆäÖÐÊÇÈçºÎÒ»²½²½µ÷ÓùýÈ¥µÄ£¬ÒªÁ˽âµ÷Óùý³ÌµÄС»ï°é¿ÉÒԲο¼ aop Ïà¹Ø²Ù×÷£º +这里最终会调用到业务方法 `UserService#insert`,本文并ä¸�会探究这其中是如何一步步调用过去的,è¦�了解调用过程的å°�伙伴å�¯ä»¥å�‚考 aop 相关æ“�作: -* [spring aop Ö® jdk ¶¯Ì¬´úÀí](https://my.oschina.net/funcy/blog/4696654) -* [spring aop Ö® cglib ´úÀí](https://my.oschina.net/funcy/blog/4696655) +* [spring aop 之 jdk 动æ€�代ç�†](https://my.oschina.net/funcy/blog/4696654) +* [spring aop 之 cglib 代ç�†](https://my.oschina.net/funcy/blog/4696655) -#### 3.7 Òì³£»Ø¹ö +#### 3.7 异常回滚 -´¦ÀíÒì³£µÄ·½·¨Îª `TransactionAspectSupport#completeTransactionAfterThrowing`£¬´úÂëÈçÏ£º +处ç�†å¼‚常的方法为 `TransactionAspectSupport#completeTransactionAfterThrowing`,代ç �如下: ``` protected void completeTransactionAfterThrowing(@Nullable TransactionInfo txInfo, Throwable ex) { if (txInfo != null && txInfo.getTransactionStatus() != null) { - // Òì³£·ûºÏ²Å»Ø¹ö + // 异常符å�ˆæ‰�回滚 if (txInfo.transactionAttribute != null && txInfo.transactionAttribute.rollbackOn(ex)) { try { txInfo.getTransactionManager().rollback(txInfo.getTransactionStatus()); @@ -32,7 +32,7 @@ protected void completeTransactionAfterThrowing(@Nullable TransactionInfo txInfo } else { try { - // Òì³£²»·ûºÏ£¬¼´Ê¹Ö´Ðгö´íÒ²»áÌá½» + // 异常ä¸�符å�ˆï¼Œå�³ä½¿æ‰§è¡Œå‡ºé”™ä¹Ÿä¼šæ��交 txInfo.getTransactionManager().commit(txInfo.getTransactionStatus()); } catch (...) { @@ -44,11 +44,11 @@ protected void completeTransactionAfterThrowing(@Nullable TransactionInfo txInfo ``` -´ÓÕâ¸ö·½·¨À´¿´£¬³öÏÖÁËÒì³£²¢²»»áÖ±½Ó½øÐлعöµÄ£¬¶øÊÇÏÈÒªÅжÏÒì³£ÀàÐÍ£¬¶ÔÓÚÐèÒª»Ø¹öµÄÒì³£²Å»Ø¹ö¡£ +从这个方法æ�¥çœ‹ï¼Œå‡ºçŽ°äº†å¼‚å¸¸å¹¶ä¸�会直接进行回滚的,而是先è¦�判断异常类型,对于需è¦�回滚的异常æ‰�回滚。 -##### Åжϵ±Ç°Òì³£ÊÇ·ñÒª»Ø¹ö +##### 判断当å‰�异常是å�¦è¦�回滚 -ÅжÏÒì³£ÊÇ·ñ·ûºÏµÄ·½·¨Îª `RuleBasedTransactionAttribute#rollbackOn`£º +判断异常是å�¦ç¬¦å�ˆçš„æ–¹æ³•为 `RuleBasedTransactionAttribute#rollbackOn`: ``` public boolean rollbackOn(Throwable ex) { @@ -56,9 +56,9 @@ public boolean rollbackOn(Throwable ex) { int deepest = Integer.MAX_VALUE; if (this.rollbackRules != null) { for (RollbackRuleAttribute rule : this.rollbackRules) { - // »ñÈ¡Òì³£µÄÉî¶È + // 获å�–异常的深度 int depth = rule.getDepth(ex); - // Éî¶ÈÂú×ãÌõ¼þ£¬±íʾµ±Ç°Òì³£ÐèÒª»Ø¹ö + // 深度满足æ�¡ä»¶ï¼Œè¡¨ç¤ºå½“å‰�异常需è¦�回滚 if (depth >= 0 && depth < deepest) { deepest = depth; winner = rule; @@ -73,7 +73,7 @@ public boolean rollbackOn(Throwable ex) { ``` -»ñÈ¡Ê÷ÉîµÄ·½·¨Îª `RollbackRuleAttribute#getDepth(Throwable)`£¬´úÂëÈçÏ£º +获å�–树深的方法为 `RollbackRuleAttribute#getDepth(Throwable)`,代ç �如下: ``` public int getDepth(Throwable ex) { @@ -89,35 +89,35 @@ private int getDepth(Class exceptionClass, int depth) { if (exceptionClass == Throwable.class) { return -1; } - // µÝ¹é»ñÈ¡ + // 递归获å�– return getDepth(exceptionClass.getSuperclass(), depth + 1); } ``` -Õâ¸öʵÏֺܼòµ¥£¬¾ÍÊǵݹé»ñÈ¡ `exception` µÄ¸¸À࣬ÕÒµ½Á˾ͷµ»ØµÝ¹éµÄ´ÎÊý£¬Èç¹û×îÖÕÕÒµ½µÄÊÇ `Throwable`£¬¾Í·µ»Ø - 1. +这个实现很简å�•,就是递归获å�– `exception` 的父类,找到了就返回递归的次数,如果最终找到的是 `Throwable`,就返回 - 1. -Ö®ËùÒÔʹÓÃÊ÷ÉîÀ´ÅжÏÊÇ·ñÐèÒª»Ø¹ö£¬Ô­ÒòÊÇÉèÖûعöµÄÒ쳣ʱ£¬¿ÉÒÔÉèÖÃÒì³£Ãû³Æ£º +之所以使用树深æ�¥åˆ¤æ–­æ˜¯å�¦éœ€è¦�回滚,原因是设置回滚的异常时,å�¯ä»¥è®¾ç½®å¼‚常å��称: ``` public @interface Transactional { ... - // ×¢ÒâÕâ¸öÀàÐÍÊÇ×Ö·û´® + // 注æ„�这个类型是字符串 String[] rollbackForClassName() default {}; } ``` -Òò´Ë²»ÄÜʹÓà `ex instanceof Exception` µÄ·½Ê½À´ÅжÏÄÜ·ñ»Ø¹ö¡£ +å› æ­¤ä¸�能使用 `ex instanceof Exception` 的方å¼�æ�¥åˆ¤æ–­èƒ½å�¦å›žæ»šã€‚ -`RuleBasedTransactionAttribute#rollbackOn` ÖÐµÄ `RollbackRuleAttribute` Óë `NoRollbackRuleAttribute` ÓÖÊÇɶĨ£¿ËüÃÇ `rollbackFor` Óë `noRollbackFor` µÄ°ü×°À࣬ÔÚ `SpringTransactionAnnotationParser#parseTransactionAnnotation(AnnotationAttributes)` ·½·¨ÖÐÉèÖ㬴úÂëÈçÏ£º +`RuleBasedTransactionAttribute#rollbackOn` 中的 `RollbackRuleAttribute` 与 `NoRollbackRuleAttribute` å�ˆæ˜¯å•¥å‘¢ï¼Ÿå®ƒä»¬ `rollbackFor` 与 `noRollbackFor` 的包装类,在 `SpringTransactionAnnotationParser#parseTransactionAnnotation(AnnotationAttributes)` 方法中设置,代ç �如下: ``` protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes attributes) { RuleBasedTransactionAttribute rbta = new RuleBasedTransactionAttribute(); ... - // ´¦Àí»Ø¹öÒì³£ + // 处ç�†å›žæ»šå¼‚常 List rollbackRules = new ArrayList<>(); for (Class rbRule : attributes.getClassArray("rollbackFor")) { rollbackRules.add(new RollbackRuleAttribute(rbRule)); @@ -125,32 +125,32 @@ protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes a for (String rbRule : attributes.getStringArray("rollbackForClassName")) { rollbackRules.add(new RollbackRuleAttribute(rbRule)); } - // ´¦Àí²»»Ø¹öÒì³£ + // 处ç�†ä¸�回滚异常 for (Class rbRule : attributes.getClassArray("noRollbackFor")) { rollbackRules.add(new NoRollbackRuleAttribute(rbRule)); } for (String rbRule : attributes.getStringArray("noRollbackForClassName")) { rollbackRules.add(new NoRollbackRuleAttribute(rbRule)); } - // ´¦Àí¹æÔò + // 处ç�†è§„则 rbta.setRollbackRules(rollbackRules); return rbta; } ``` -##### »Ø¹ö²Ù×÷ +##### 回滚æ“�作 -»Ø¹ö²Ù×÷ÔÚ `AbstractPlatformTransactionManager#rollback` ·½·¨Öд¦Àí£¬³ýÁËÊý¾Ý¿âµÄ»Ø¹ö²Ù×÷Í⣬Õâ¸ö·½·¨»¹´¦ÀíÁËһЩ»Øµ÷´¦Àí£¬ÕâÀïÎÒÃǾͲ»·ÖÎöÁË£¬Ö±½Ó¿´¹Ø¼üµÄ»Ø¹ö´úÂë¡£ÔÚÇ°ÃæµÄ·ÖÎöÊÂÎñµÄ´«²¥ÀàÐÍʱ£¬´ó¶à´«²¥ÀàÐÍÊǻعöÊÂÎñ£¬²»¹ý `PROPAGATION_NESTED` ÀýÍ⣬ËüÊǻعöµ½±£´æµã£¬ÕâÀïÎÒÃÇ·Ö±ðÀ´¿´¿´¹Ø¼ü´úÂ룺 +回滚æ“�作在 `AbstractPlatformTransactionManager#rollback` 方法中处ç�†ï¼Œé™¤äº†æ•°æ�®åº“的回滚æ“�作外,这个方法还处ç�†äº†ä¸€äº›å›žè°ƒå¤„ç�†ï¼Œè¿™é‡Œæˆ‘们就ä¸�分æž�了,直接看关键的回滚代ç �。在å‰�é�¢çš„分æž�事务的传播类型时,大多传播类型是回滚事务,ä¸�过 `PROPAGATION_NESTED` 例外,它是回滚到ä¿�存点,这里我们分别æ�¥çœ‹çœ‹å…³é”®ä»£ç �: -1. ÊÂÎñ»Ø¹ö +1. 事务回滚 - ´¦ÀíÊÂÎñ»Ø¹öµÄ·½·¨Îª `DataSourceTransactionManager#doRollback`£¬×îÖÕµ÷ÓõÄÊÇ `java.sql.Connection` µÄ·½·¨£º + 处ç�†äº‹åŠ¡å›žæ»šçš„æ–¹æ³•ä¸º `DataSourceTransactionManager#doRollback`,最终调用的是 `java.sql.Connection` 的方法: ``` protected void doRollback(DefaultTransactionStatus status) { DataSourceTransactionObject txObject = (DataSourceTransactionObject) status.getTransaction(); - // »ñÈ¡Á¬½Ó£¬Connection Ϊ java.sql.Connection + // 获å�–连接,Connection 为 java.sql.Connection Connection con = txObject.getConnectionHolder().getConnection(); try { con.rollback(); @@ -162,7 +162,7 @@ protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes a ``` -2. »Ø¹öµ½±£´æµã ´¦Àí»Ø¹öµ½±£´æµãµÄ²Ù×÷ÔÚ `AbstractTransactionStatus#rollbackToHeldSavepoint` ·½·¨ÖУº +2. 回滚到ä¿�存点 处ç�†å›žæ»šåˆ°ä¿�存点的æ“�作在 `AbstractTransactionStatus#rollbackToHeldSavepoint` 方法中: ``` public void rollbackToHeldSavepoint() throws TransactionException { @@ -170,19 +170,19 @@ protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes a if (savepoint == null) { throw new TransactionUsageException(...); } - // »Ø¹öµ½±£´æµã + // 回滚到ä¿�存点 getSavepointManager().rollbackToSavepoint(savepoint); - // Êͷű£´æµã + // 释放ä¿�存点 getSavepointManager().releaseSavepoint(savepoint); - // ½«±£´æµãÖÃΪnull + // å°†ä¿�存点置为null setSavepoint(null); } ``` - Õâ¸ö·½·¨Ö÷ÒªÓÐÁ½¸ö²Ù×÷£º»Ø¹öµ½±£´æµãÓëÊͷű£´æµã¡£ + 这个方法主è¦�有两个æ“�作:回滚到ä¿�存点与释放ä¿�存点。 - »Ø¹öµ½±£´æµãµÄ²Ù×÷ÔÚ `JdbcTransactionObjectSupport#rollbackToSavepoint` ·½·¨£º + 回滚到ä¿�存点的æ“�作在 `JdbcTransactionObjectSupport#rollbackToSavepoint` 方法: ``` public void rollbackToSavepoint(Object savepoint) throws TransactionException { @@ -198,7 +198,7 @@ protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes a ``` - Êͷű£´æµãµÄ²Ù×÷ÔÚ `JdbcTransactionObjectSupport#releaseSavepoint` ·½·¨£º + 释放ä¿�存点的æ“�作在 `JdbcTransactionObjectSupport#releaseSavepoint` 方法: ``` public void releaseSavepoint(Object savepoint) throws TransactionException { @@ -213,18 +213,18 @@ protected TransactionAttribute parseTransactionAnnotation(AnnotationAttributes a ``` - ×îÖÕ¶¼Êǵ÷Óà `java.sql.Connection` ÌṩµÄ·½·¨À´Íê³É²Ù×÷¡£ + 最终都是调用 `java.sql.Connection` æ��供的方法æ�¥å®Œæˆ�æ“�作。 -##### Ìá½»²Ù×÷ +##### æ��交æ“�作 -ÔÙÀ´¿´¿´Ìá½»²Ù×÷£¬´¦ÀíÌá½»²Ù×÷µÄ´úÂëΪ +å†�æ�¥çœ‹çœ‹æ��交æ“�作,处ç�†æ��交æ“�作的代ç �为 ``` txInfo.getTransactionManager().commit(txInfo.getTransactionStatus()); ``` -ÎÒÃǸú½øÕâ¸ö·½·¨£¬Ò»Ö±¸úµ½ `AbstractPlatformTransactionManager#processCommit`£º +我们跟进这个方法,一直跟到 `AbstractPlatformTransactionManager#processCommit`: ``` private void processCommit(DefaultTransactionStatus status) throws TransactionException { @@ -235,13 +235,13 @@ private void processCommit(DefaultTransactionStatus status) throws TransactionEx if (status.hasSavepoint()) { ... unexpectedRollback = status.isGlobalRollbackOnly(); - // 1\. Êͷű£´æµã + // 1\. 释放ä¿�存点 status.releaseHeldSavepoint(); } else if (status.isNewTransaction()) { ... unexpectedRollback = status.isGlobalRollbackOnly(); - // 2\. ´¦ÀíÌá½»²Ù×÷ + // 2\. 处ç�†æ��交æ“�作 doCommit(status); } else if (isFailEarlyOnGlobalRollbackOnly()) { @@ -255,28 +255,28 @@ private void processCommit(DefaultTransactionStatus status) throws TransactionEx } } finally { - // 3\. ´¦ÀíÍê³É²Ù×÷£¬ÔÚÕâÀï»á»Ö¸´¹ÒÆðµÄÊÂÎñ(»Ö¸´Êý¾Ý¿âÁ¬½Ó) + // 3\. 处ç�†å®Œæˆ�æ“�作,在这里会æ�¢å¤�挂起的事务(æ�¢å¤�æ•°æ�®åº“连接) cleanupAfterCompletion(status); } } ``` -ÒÔÉÏ·½·¨Ê¡ÂÔÁË´óÁ¿´úÂ룬´ó¶àÊÇÓë `TransactionSynchronization` »Øµ÷Ïà¹ØµÄ£¬ÎÒÃǾۼ¯Ö÷Òª²Ù×÷£º +以上方法çœ�略了大é‡�代ç �,大多是与 `TransactionSynchronization` 回调相关的,我们è�šé›†ä¸»è¦�æ“�作: -1. Êͷű£´æµã£ºÕâ¸ö²Ù×÷ÔÚÉÏÃæÒѾ­·ÖÎö¹ýÁË£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË -2. ´¦ÀíÌá½»²Ù×÷£ºÌá½»ÔÚÕâÀï½øÐУ¬Ò»»á·ÖÎö£¬×îºóÎÒÃǻᷢÏÖËüÊǵ÷ÓÃÁË `java.sql.Connection` ÌṩµÄ·½·¨ -3. ´¦ÀíÍê³É²Ù×÷£ºÕâ¸ö²Ù×÷±È½ÏÖØÒª£¬ÖØÖÃÁ¬½ÓµÄÐÅÏ¢¡¢»Ö¸´¹ÒÆðÊÂÎñÁ¬½Ó¾ÍÊÇÔÚÕâÀï½øÐÐµÄ +1. 释放ä¿�存点:这个æ“�作在上é�¢å·²ç»�分æž�过了,这里就ä¸�å†�分æž�了 +2. 处ç�†æ��交æ“�作:æ��交在这里进行,一会分æž�,最å�Žæˆ‘们会å�‘现它是调用了 `java.sql.Connection` æ��供的方法 +3. 处ç�†å®Œæˆ�æ“�作:这个æ“�作比较é‡�è¦�,é‡�置连接的信æ�¯ã€�æ�¢å¤�挂起事务连接就是在这里进行的 -ÎÒÃÇÏÈÀ´¿´Ìá½»²Ù×÷£¬Ö±½Ó½øÈë×îÖÕ´úÂ룺`DataSourceTransactionManager#doCommit` +我们先æ�¥çœ‹æ��交æ“�作,直接进入最终代ç �:`DataSourceTransactionManager#doCommit` ``` protected void doCommit(DefaultTransactionStatus status) { DataSourceTransactionObject txObject = (DataSourceTransactionObject) status.getTransaction(); - // »ñÈ¡Á¬½Ó£¬Connection Ϊ java.sql.Connection + // 获å�–连接,Connection 为 java.sql.Connection Connection con = txObject.getConnectionHolder().getConnection(); try { - // Ìá½»ÊÂÎñ + // æ��交事务 con.commit(); } catch (SQLException ex) { @@ -286,9 +286,9 @@ protected void doCommit(DefaultTransactionStatus status) { ``` -×îÖÕÒ²Êǵ÷Óà `java.sql.Connection` ÌṩµÄ·½·¨¡£ +最终也是调用 `java.sql.Connection` æ��供的方法。 -ÔÙÀ´¿´ÏÂÍê³É²Ù×÷µÄ´¦Àí£¬½øÈë `AbstractPlatformTransactionManager#cleanupAfterCompletion` ·½·¨£º +å†�æ�¥çœ‹ä¸‹å®Œæˆ�æ“�作的处ç�†ï¼Œè¿›å…¥ `AbstractPlatformTransactionManager#cleanupAfterCompletion` 方法: ``` private void cleanupAfterCompletion(DefaultTransactionStatus status) { @@ -297,31 +297,31 @@ private void cleanupAfterCompletion(DefaultTransactionStatus status) { TransactionSynchronizationManager.clear(); } if (status.isNewTransaction()) { - // ÕâÀï»áÖØÖÃÁ¬½Ó£¬Èç¹ûÊÇÐÂÁ¬½Ó£¬ÔÚÕâÀï»á¹Ø±ÕÁ¬½Ó + // 这里会é‡�置连接,如果是新连接,在这里会关闭连接 doCleanupAfterCompletion(status.getTransaction()); } - // Èç¹ûÓÐ¹ÒÆðµÄÊÂÎñ£¬ÔÚÕâÀï½øÐлָ´ + // 如果有挂起的事务,在这里进行æ�¢å¤� if (status.getSuspendedResources() != null) { Object transaction = (status.hasTransaction() ? status.getTransaction() : null); - // »Ö¸´¹ÒÆðµÄÊÂÎñ + // æ�¢å¤�挂起的事务 resume(transaction, (SuspendedResourcesHolder) status.getSuspendedResources()); } } ``` -ÎÒÃÇÏÈÀ´¿´ `DataSourceTransactionManager#doCleanupAfterCompletion` ·½·¨: +我们先æ�¥çœ‹ `DataSourceTransactionManager#doCleanupAfterCompletion` 方法: ``` protected void doCleanupAfterCompletion(Object transaction) { DataSourceTransactionObject txObject = (DataSourceTransactionObject) transaction; - // ÒÆ³ýÊý¾ÝÔ´ÓëÁ¬½ÓµÄ°ó¶¨¹ØÏµ + // 移除数æ�®æº�与连接的绑定关系 if (txObject.isNewConnectionHolder()) { TransactionSynchronizationManager.unbindResource(obtainDataSource()); } - // ÖØÖÃÁ¬½Ó£¬¾ÍÊǽ«Á¬½ÓÐÅÏ¢»Ö¸´µ½Ö´ÐÐÊÂÎñǰµÄ״̬ + // é‡�置连接,就是将连接信æ�¯æ�¢å¤�到执行事务å‰�的状æ€� Connection con = txObject.getConnectionHolder().getConnection(); try { if (txObject.isMustRestoreAutoCommit()) { @@ -333,9 +333,9 @@ protected void doCleanupAfterCompletion(Object transaction) { catch (Throwable ex) { logger.debug("Could not reset JDBC Connection after transaction", ex); } - // Èç¹ûÊÇÐÂÁ¬½Ó£¬ÓÃÍê¾ÍÔÚÕâÀï¹Ø±ÕÁ¬½Ó + // 如果是新连接,用完就在这里关闭连接 if (txObject.isNewConnectionHolder()) { - // ×îÖÕµ÷ÓõÄÊÇ java.sql.Connection#close + // 最终调用的是 java.sql.Connection#close DataSourceUtils.releaseConnection(con, this.dataSource); } @@ -344,31 +344,31 @@ protected void doCleanupAfterCompletion(Object transaction) { ``` -ÔÙÀ´¿´¿´ÊÂÎñµÄ»Ö¸´²Ù×÷£¬Ò²¾ÍÊÇ `resume(...)` ·½·¨£¬¸ú½øÕâ¸ö·½·¨ºó£¬·¢ÏÖ×îÖÕµ÷ÓõÄÊÇ `DataSourceTransactionManager#doResume` ·½·¨£¬´úÂëÈçÏ£º +å†�æ�¥çœ‹çœ‹äº‹åŠ¡çš„æ�¢å¤�æ“�作,也就是 `resume(...)` 方法,跟进这个方法å�Žï¼Œå�‘现最终调用的是 `DataSourceTransactionManager#doResume` 方法,代ç �如下: ``` @Override protected void doResume(@Nullable Object transaction, Object suspendedResources) { - // ½«Êý¾ÝÔ´¡¢¹ÒÆðµÄÊý¾Ý¿âÁ¬½ÓÓ뵱ǰÏß³Ì°ó¶¨ + // 将数æ�®æº�ã€�挂起的数æ�®åº“连接与当å‰�线程绑定 TransactionSynchronizationManager.bindResource(obtainDataSource(), suspendedResources); } ``` -´¦ÀíÍêÕâÒ»²½ºó£¬´ËʱµÄÊý¾ÝÔ´¾ÍÊÇ֮ǰ¹ÒÆðµÄÊý¾ÝÔ´ÁË¡£ +处ç�†å®Œè¿™ä¸€æ­¥å�Žï¼Œæ­¤æ—¶çš„æ•°æ�®æº�就是之å‰�挂起的数æ�®æº�了。 -#### 3.8 ÖØÖÃÊÂÎñÐÅÏ¢ +#### 3.8 é‡�置事务信æ�¯ -ÔÚijЩ´«²¥·½Ê½Ï£¬±ÈÈç `PROPAGATION_REQUIRES_NEW`£¬ÎÒÃÇÐèÒª¹ÒÆðµ±Ç°ÊÂÎñ£¬È»ºó´´½¨ÐµÄÊÂÎñ£¬ÔÚÐÂÊÂÎñÖ´ÐÐÍê³Éºó£¬ÐèÒª»Ö¸´Ô­À´µÄÊÂÎñ£¬ÕâÀïµÄÖØÖÃÊÂÎñÐÅÏ¢¾ÍÊǽ«µ±Ç°ÊÂÎñÐÅÏ¢»Ö¸´Îª¹ÒÆðµÄÊÂÎñµÄÐÅÏ¢£¨Ö»Êǻָ´ÁËÊÂÎñÐÅÏ¢£¬¹ÒÆðµÄÊý¾Ý¿âÁ¬½Ó²»ÊÇÔÚÕâÀï»Ö¸´£©£º +在æŸ�些传播方å¼�下,比如 `PROPAGATION_REQUIRES_NEW`,我们需è¦�挂起当å‰�事务,然å�Žåˆ›å»ºæ–°çš„事务,在新事务执行完æˆ�å�Žï¼Œéœ€è¦�æ�¢å¤�原æ�¥çš„事务,这里的é‡�置事务信æ�¯å°±æ˜¯å°†å½“å‰�事务信æ�¯æ�¢å¤�为挂起的事务的信æ�¯ï¼ˆå�ªæ˜¯æ�¢å¤�了事务信æ�¯ï¼ŒæŒ‚起的数æ�®åº“连接ä¸�是在这里æ�¢å¤�): ``` public abstract class TransactionAspectSupport implements BeanFactoryAware, InitializingBean { - // ´æ·Åµ±Ç°Ê¹ÓõÄÊÂÎïÐÅÏ¢ + // 存放当å‰�使用的事物信æ�¯ private static final ThreadLocal transactionInfoHolder = new NamedThreadLocal<>("Current aspect-driven transaction"); - // ÖØÖÃΪ¾ÉµÄÊÂÎñÐÅÏ¢ + // é‡�置为旧的事务信æ�¯ protected void cleanupTransactionInfo(@Nullable TransactionInfo txInfo) { if (txInfo != null) { txInfo.restoreThreadLocalStatus(); @@ -376,22 +376,22 @@ public abstract class TransactionAspectSupport implements BeanFactoryAware, Init } /** - * TransactionInfo: ±£´æÊÂÎñÐÅÏ¢ + * TransactionInfo: ä¿�存事务信æ�¯ */ protected static final class TransactionInfo { - // µ±Ç°µÄÊÂÎñ״̬¶ÔÏó + // 当å‰�的事务状æ€�对象 @Nullable private TransactionStatus transactionStatus; - // ¾ÉµÄÊÂÎñÐÅÏ¢£¨Ò²¾ÍÊÇ¹ÒÆðµÄÊÂÎñÐÅÏ¢£© + // 旧的事务信æ�¯ï¼ˆä¹Ÿå°±æ˜¯æŒ‚起的事务信æ�¯ï¼‰ @Nullable private TransactionInfo oldTransactionInfo; ... private void restoreThreadLocalStatus() { - // ÉèÖÃΪ¾ÉµÄÊÂÎñÐÅÏ¢ + // 设置为旧的事务信æ�¯ transactionInfoHolder.set(this.oldTransactionInfo); } @@ -402,32 +402,32 @@ public abstract class TransactionAspectSupport implements BeanFactoryAware, Init ``` -¿ÉÒÔ¿´µ½£¬`TransactionInfo` ¶Ô»»³ÖÓÐÉÏÒ»¸öÊÂÎñµÄÐÅÏ¢£¨`oldTransactionInfo` µÄ³ÉÔ±±äÁ¿£©£¬ÖØÖûØÉÏÒ»¸öÊÂÎñÐÅϢʱ£¬Ö»ÊǼòµ¥µØ½« `oldTransactionInfo` ÉèÖõ½ÃûΪ `transactionInfoHolder` µÄ `ThreadLocal` Àï¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`TransactionInfo` 对æ�¢æŒ�有上一个事务的信æ�¯ï¼ˆ`oldTransactionInfo` çš„æˆ�员å�˜é‡�),é‡�置回上一个事务信æ�¯æ—¶ï¼Œå�ªæ˜¯ç®€å�•地将 `oldTransactionInfo` 设置到å��为 `transactionInfoHolder` çš„ `ThreadLocal` 里。 -#### 3.9 Ìá½»ÊÂÎñ +#### 3.9 æ��交事务 -´¦ÀíÊÂÎñÌá½»µÄ´úÂëΪ `TransactionAspectSupport#commitTransactionAfterReturning`£¬´úÂëÈçÏ£º +处ç�†äº‹åŠ¡æ��交的代ç �为 `TransactionAspectSupport#commitTransactionAfterReturning`,代ç �如下: ``` protected void commitTransactionAfterReturning(@Nullable TransactionInfo txInfo) { - // ÅжÏÏÂÊÂÎñµÄ״̬ + // 判断下事务的状æ€� if (txInfo != null && txInfo.getTransactionStatus() != null) { - // ´¦ÀíÌá½»²Ù×÷£¬ÕâÇ°ÃæÒѾ­·ÖÎö¹ýÁË + // 处ç�†æ��交æ“�作,这å‰�é�¢å·²ç»�分æž�过了 txInfo.getTransactionManager().commit(txInfo.getTransactionStatus()); } } ``` -Ôڸ÷½·¨ÖУ¬ÎÒÃÇÓÖ¿´µ½ÁËÕâÐдúÂ룺 +在该方法中,我们å�ˆçœ‹åˆ°äº†è¿™è¡Œä»£ç �: ``` txInfo.getTransactionManager().commit(txInfo.getTransactionStatus()); ``` -Õâ¸öÒѾ­ÔÚÓÉ**Òì³£ÒýÆðµÄÊÂÎñÌá½»**ÖзÖÎö¹ýÁË£¬¾Í²»ÔÙ·ÖÎöÁË¡£ +这个已ç»�在由**异常引起的事务æ��交**中分æž�过了,就ä¸�å†�分æž�了。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4947800](https://my.oschina.net/funcy/blog/4947800) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4947800](https://my.oschina.net/funcy/blog/4947800) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\233\233\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20602.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\233\233\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20602.md" index eba0726..949cc3b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\233\233\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20602.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\344\272\213\345\212\241/Spring\344\272\213\345\212\241\357\274\210\345\233\233\357\274\211\357\274\232\344\272\213\345\212\241\347\232\204\351\232\224\347\246\273\347\272\247\345\210\253\344\270\216\344\274\240\346\222\255\346\226\271\345\274\217\347\232\204\345\244\204\347\220\20602.md" @@ -1,13 +1,13 @@ -±¾ÎÄÊÇ¡¶ÊÂÎñµÄ¸ôÀë¼¶±ðÓë´«²¥·½Ê½µÄ´¦Àí¡··ÖÎöµÄµÚ 2 ƪ£¬½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø¡£ +本文是《事务的隔离级别与传播方å¼�的处ç�†ã€‹åˆ†æž�的第 2 篇,接上文,我们继续。 -#### 3.5 »ñÈ¡ÊÂÎñÐÅÏ¢ +#### 3.5 获å�–事务信æ�¯ -ÊÂÎñµÄÐÅÏ¢»áÔÚ `TransactionAspectSupport#createTransactionIfNecessary` ·½·¨ÖлñÈ¡£¬Õâ¸ö·½·¨·Ç³£ÖØÒª£¬Ç°Ãæ½éÉܸôÀë¼¶±ð¡¢´«²¥·½Ê½¶¼»áÔÚÕâ¸ö·½·¨Àï´¦Àí¡£¸Ã·½·¨´úÂëÈçÏ£º +事务的信æ�¯ä¼šåœ¨ `TransactionAspectSupport#createTransactionIfNecessary` 方法中获å�–,这个方法é�žå¸¸é‡�è¦�,å‰�é�¢ä»‹ç»�隔离级别ã€�ä¼ æ’­æ–¹å¼�都会在这个方法里处ç�†ã€‚该方法代ç �如下: ``` protected TransactionInfo createTransactionIfNecessary(@Nullable PlatformTransactionManager tm, @Nullable TransactionAttribute txAttr, final String joinpointIdentification) { - // Èç¹ûδָ¶¨Ãû³Æ£¬Ôò½«·½·¨Ãûµ±×öÊÂÎñÃû³Æ + // 如果未指定å��称,则将方法å��当å�šäº‹åŠ¡å��ç§° if (txAttr != null && txAttr.getName() == null) { txAttr = new DelegatingTransactionAttribute(txAttr) { @Override @@ -20,22 +20,22 @@ protected TransactionInfo createTransactionIfNecessary(@Nullable PlatformTransac TransactionStatus status = null; if (txAttr != null) { if (tm != null) { - // »ñÈ¡ÊÂÎñ״̬£¬Èç¹ûµ±Ç°Ã»ÓÐÊÂÎñ£¬¿ÉÄܻᴴ½¨ÊÂÎñ + // 获å�–事务状æ€�,如果当å‰�没有事务,å�¯èƒ½ä¼šåˆ›å»ºäº‹åŠ¡ status = tm.getTransaction(txAttr); } } - // ×¼±¸ÊÂÎñÐÅÏ¢£¬¾ÍÊǽ«Ç°ÃæµÃµ½µÄÐÅÏ¢·â×°³É TransactionInfo + // 准备事务信æ�¯ï¼Œå°±æ˜¯å°†å‰�é�¢å¾—到的信æ�¯å°�装æˆ� TransactionInfo return prepareTransactionInfo(tm, txAttr, joinpointIdentification, status); } ``` -Õâ¸ö·½·¨Ö÷ÒªÊÇÁ½¸ö²Ù×÷£º +这个方法主è¦�是两个æ“�作: -1. »ñÈ¡ÊÂÎñ״̬ -2. ×¼±¸ÊÂÎñÐÅÏ¢ +1. 获å�–事务状æ€� +2. 准备事务信æ�¯ -ÏÈÀ´¿´Ï»ñÈ¡ÊÂÎñ״̬µÄÁ÷³Ì£¬·½·¨Îª `AbstractPlatformTransactionManager#getTransaction`£º +å…ˆæ�¥çœ‹ä¸‹èŽ·å�–事务状æ€�çš„æµ�程,方法为 `AbstractPlatformTransactionManager#getTransaction`: ``` public final TransactionStatus getTransaction(@Nullable TransactionDefinition definition) @@ -44,40 +44,40 @@ public final TransactionStatus getTransaction(@Nullable TransactionDefinition de TransactionDefinition def = (definition != null ? definition : TransactionDefinition.withDefaults()); - // »ñÈ¡ÊÂÎñ¶ÔÏó + // 获å�–事务对象 Object transaction = doGetTransaction(); boolean debugEnabled = logger.isDebugEnabled(); - // ÊÇ·ñ´æÔÚÊÂÎñ£¬´æÔÚÔò·µ»Ø + // 是å�¦å­˜åœ¨äº‹åŠ¡ï¼Œå­˜åœ¨åˆ™è¿”å›ž if (isExistingTransaction(transaction)) { return handleExistingTransaction(def, transaction, debugEnabled); } - // ÔËÐе½ÁËÕâÀ±íÃ÷µ±Ç°Ã»ÓÐÊÂÎñ + // è¿�行到了这里,表明当å‰�没有事务 - // ¼ì²é³¬Ê±Ê±¼äµÄÉèÖÃÊÇ·ñºÏÀí + // 检查超时时间的设置是å�¦å�ˆç�† if (def.getTimeout() < TransactionDefinition.TIMEOUT_DEFAULT) { throw new InvalidTimeoutException("Invalid transaction timeout", def.getTimeout()); } - // PROPAGATION_MANDATORY£º±ØÐëÔÚÊÂÎñÖÐÔËÐУ¬ÕâÀïûÓÐÊÂÎñ£¬Ö±½ÓÅ×Òì³£ + // PROPAGATION_MANDATORY:必须在事务中è¿�行,这里没有事务,直接抛异常 // No existing transaction found -> check propagation behavior to find out how to proceed. if (def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_MANDATORY) { throw new IllegalTransactionStateException(...); } - // ¹ÒÆðµ±Ç°ÊÂÎñ£¬´´½¨ÐÂÊÂÎñ + // 挂起当å‰�事务,创建新事务 else if (def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRED || def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRES_NEW || def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NESTED) { - // suspend(...) ´«Èënull£ºÈç¹ûÓÐͬ²½ÊÂÎñ£¬Ôò¹ÒÆðͬ²½ÊÂÎñ£¬·ñÔòʲôҲ²»×ö + // suspend(...) ä¼ å…¥null:如果有å�Œæ­¥äº‹åŠ¡ï¼Œåˆ™æŒ‚èµ·å�Œæ­¥äº‹åŠ¡ï¼Œå�¦åˆ™ä»€ä¹ˆä¹Ÿä¸�å�š SuspendedResourcesHolder suspendedResources = suspend(null); try { boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER); - // ´´½¨ÊÂÎñ¶ÔÏó + // 创建事务对象 DefaultTransactionStatus status = newTransactionStatus( def, transaction, true, newSynchronization, debugEnabled, suspendedResources); - // Æô¶¯ÊÂÎñ + // å�¯åŠ¨äº‹åŠ¡ doBegin(transaction, def); - // ÉèÖà TransactionSynchronizationManager µÄÊôÐÔ + // 设置 TransactionSynchronizationManager 的属性 prepareSynchronization(status, def); return status; } @@ -94,17 +94,17 @@ public final TransactionStatus getTransaction(@Nullable TransactionDefinition de ``` -Õâ¸ö·½·¨Óе㳤£¬ÎÒÃÇÂýÂý·ÖÎö¡£ +这个方法有点长,我们慢慢分æž�。 -##### 1. `doGetTransaction(...)`£º»ñÈ¡ÊÂÎñ¶ÔÏó +##### 1. `doGetTransaction(...)`:获å�–事务对象 -»ñÈ¡ÊÂÎñ¶ÔÏóµÄ·½·¨Îª `DataSourceTransactionManager#doGetTransaction`£º +获å�–事务对象的方法为 `DataSourceTransactionManager#doGetTransaction`: ``` protected Object doGetTransaction() { DataSourceTransactionObject txObject = new DataSourceTransactionObject(); txObject.setSavepointAllowed(isNestedTransactionAllowed()); - // »ñÈ¡Á¬½ÓÐÅÏ¢£¬obtainDataSource()£º»ñÈ¡Êý¾ÝÔ´ + // 获å�–连接信æ�¯ï¼ŒobtainDataSource():获å�–æ•°æ�®æº� ConnectionHolder conHolder = (ConnectionHolder) TransactionSynchronizationManager.getResource(obtainDataSource()); txObject.setConnectionHolder(conHolder, false); @@ -113,12 +113,12 @@ protected Object doGetTransaction() { ``` -ÕâÀïÓÐÁ½¸ö²Ù×÷£º +这里有两个æ“�作: -1. »ñÈ¡Êý¾ÝÔ´ -2. »ñÈ¡ `ConnectionHolder` +1. 获å�–æ•°æ�®æº� +2. 获å�– `ConnectionHolder` -ÎÒÃÇÏÈÀ´¿´¿´Êý¾ÝÔ´ÊÇÈçºÎ»ñÈ¡µÄ£º +我们先æ�¥çœ‹çœ‹æ•°æ�®æº�是如何获å�–的: ``` public class DataSourceTransactionManager extends AbstractPlatformTransactionManager @@ -128,7 +128,7 @@ public class DataSourceTransactionManager extends AbstractPlatformTransactionMan private DataSource dataSource; /** - * ¹¹Ôì·½·¨´«ÈëÁËÊý¾ÝÔ´ + * 构造方法传入了数æ�®æº� */ public DataSourceTransactionManager(DataSource dataSource) { this(); @@ -137,7 +137,7 @@ public class DataSourceTransactionManager extends AbstractPlatformTransactionMan } /** - * ÉèÖÃÊý¾ÝÔ´ + * 设置数æ�®æº� */ public void setDataSource(@Nullable DataSource dataSource) { if (dataSource instanceof TransactionAwareDataSourceProxy) { @@ -155,7 +155,7 @@ public class DataSourceTransactionManager extends AbstractPlatformTransactionMan } /** - * »ñÈ¡Êý¾ÝÔ´ + * 获å�–æ•°æ�®æº� */ protected DataSource obtainDataSource() { DataSource dataSource = getDataSource(); @@ -168,14 +168,14 @@ public class DataSourceTransactionManager extends AbstractPlatformTransactionMan ``` -`obtainDataSource()` ʵ¼ÊÉÏÊǵ÷ÓÃÁË `getDataSource()` ·½·¨£¬·µ»ØµÄÊÇ `dataSource` ³ÉÔ±±äÁ¿£¬¶ø `dataSource` ÓÖÊÇÔÚ `DataSourceTransactionManager` µÄ¹¹Ôì·½·¨Àï´«ÈëµÄ£¬Òò´Ë£¬µÃµ½µÄ½áÂÛÊÇ£¬ÕâÀï»ñÈ¡µÄÊý¾ÝÔ´¾ÍÊÇÎÒÃÇÔÚÉèÖà `DataSourceTransactionManager` ʱ´«ÈëµÄ£º +`obtainDataSource()` 实际上是调用了 `getDataSource()` 方法,返回的是 `dataSource` æˆ�员å�˜é‡�,而 `dataSource` å�ˆæ˜¯åœ¨ `DataSourceTransactionManager` 的构造方法里传入的,因此,得到的结论是,这里获å�–的数æ�®æº�就是我们在设置 `DataSourceTransactionManager` 时传入的: ``` @Configuration public class TxDemo03Config { /** - * Éú³ÉÊý¾ÝÔ´ + * 生æˆ�æ•°æ�®æº� * @return * @throws Exception */ @@ -189,7 +189,7 @@ public class TxDemo03Config { } /** - * ÊÂÎñ¹ÜÀíÆ÷ + * 事务管ç�†å™¨ * @param dataSource * @return */ @@ -204,31 +204,31 @@ public class TxDemo03Config { ``` -¶øÕâ¸öÊý¾ÝÔ´£¬ÕýÊÇ `SimpleDriverDataSource`. +而这个数æ�®æº�,正是 `SimpleDriverDataSource`. -ÎÒÃÇÔÙÀ´¿´¿´ `ConnectionHolder` µÄ»ñÈ¡£¬¸Ã·½·¨Îª `TransactionSynchronizationManager#getResource` £¬´úÂëÈçÏ£º +我们å†�æ�¥çœ‹çœ‹ `ConnectionHolder` 的获å�–,该方法为 `TransactionSynchronizationManager#getResource` ,代ç �如下: ``` -// Óà ThreadLocal À´´æ·Å ConnectionHolder ÐÅÏ¢ +// 用 ThreadLocal æ�¥å­˜æ”¾ ConnectionHolder ä¿¡æ�¯ private static final ThreadLocal> resources = new NamedThreadLocal<>("Transactional resources"); /** - * »ñÈ¡ ConnectionHolder + * 获å�– ConnectionHolder */ public static Object getResource(Object key) { - // °ü×°Ï´«ÈëµÄ key + // 包装下传入的 key Object actualKey = TransactionSynchronizationUtils.unwrapResourceIfNecessary(key); - // ÔÚÕâÀï»ñÈ¡Á¬½ÓÐÅÏ¢ + // 在这里获å�–连接信æ�¯ Object value = doGetResource(actualKey); return value; } /** - * ¾ßÌåµÄ»ñÈ¡²Ù×÷ + * 具体的获å�–æ“�作 */ private static Object doGetResource(Object actualKey) { - // ´ÓThreadLocalÖлñÈ¡ + // 从ThreadLocal中获å�– Map map = resources.get(); if (map == null) { return null; @@ -246,19 +246,19 @@ private static Object doGetResource(Object actualKey) { ``` -´Ó´úÂëÀ´¿´£¬`TransactionSynchronizationManager` ³ÖÓÐÒ»¸ö `ThreadLocal` µÄʵÀý£¬ÆäÖдæ·ÅÁËÒ»¸ö `Map`£¬¸Ã `Map` µÄ `key` Ϊ `datasource`£¬`value` Ϊ `ConnectionHolder`. +从代ç �æ�¥çœ‹ï¼Œ`TransactionSynchronizationManager` æŒ�有一个 `ThreadLocal` 的实例,其中存放了一个 `Map`,该 `Map` çš„ `key` 为 `datasource`,`value` 为 `ConnectionHolder`. -ÄÇôÕâ¸ö `ConnectionHolder` ÊÇÊ²Ã´ÄØ£¿¿ÉÒÔ¼òµ¥µØ½«ÆäÀí½âΪ `Connection`(Êý¾Ý¿âÁ¬½Ó) µÄ°ü×°À࣬ÆäÖÐ×îÖØÒªµÄÊôÐÔ¾ÍÊÇ `Connection` ÁË£º +那么这个 `ConnectionHolder` 是什么呢?å�¯ä»¥ç®€å�•地将其ç�†è§£ä¸º `Connection`(æ•°æ�®åº“连接) 的包装类,其中最é‡�è¦�的属性就是 `Connection` 了: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d8c4ae3884177f485fbb95d1828fdb39ae2.png) -ºÃÁË£¬µ½ÕâÀï¾Í°Ñ `doGetTransaction(xxx)` ·½·¨·ÖÎöÍêÁË£¬ÔÙÀ´¿´¿´Õâ¸ö·½·¨·µ»ØµÄ½á¹û£º +好了,到这里就把 `doGetTransaction(xxx)` 方法分æž�完了,å†�æ�¥çœ‹çœ‹è¿™ä¸ªæ–¹æ³•返回的结果: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0944429e31a6c0b67e121674202dd5ec0fd.png) -##### 2. `isExistingTransaction(...)`£ºÊÇ·ñ´æÔÚÊÂÎñ +##### 2. `isExistingTransaction(...)`:是å�¦å­˜åœ¨äº‹åŠ¡ -»ñÈ¡µ½ÊÂÎñ¶ÔÏó `DataSourceTransactionObject` ºó£¬½ÓÏÂÀ´¾ÍÊÇÅжÏÊÇ·ñ´æÔÚÊÂÎñÁË£¬ÅжϷ½·¨ÔÚ `DataSourceTransactionManager#isExistingTransaction`£¬´úÂëÈçÏ£º +获å�–到事务对象 `DataSourceTransactionObject` å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ˜¯åˆ¤æ–­æ˜¯å�¦å­˜åœ¨äº‹åŠ¡äº†ï¼Œåˆ¤æ–­æ–¹æ³•åœ¨ `DataSourceTransactionManager#isExistingTransaction`,代ç �如下: ``` protected boolean isExistingTransaction(Object transaction) { @@ -269,38 +269,38 @@ protected boolean isExistingTransaction(Object transaction) { ``` -`ConnectionHolder` ÖÐÓÐÒ»¸ö³ÉÔ±±äÁ¿ `transactionActive`£¬Ëü±íÃ÷µ±Ç° `ConnectionHolder` µÄÊÂÎñÊÇ·ñ´¦ÓÚ¼¤»î״̬£¬`isExistingTransaction(...)` ·½·¨Ö÷ÒªÊǸù¾ÝËüÀ´Åжϵ±Ç°ÊÂÎñ¶ÔÏóÊÇ·ñ´æÔÚÊÂÎñµÄ¡£ +`ConnectionHolder` 中有一个æˆ�员å�˜é‡� `transactionActive`,它表明当å‰� `ConnectionHolder` 的事务是å�¦å¤„于激活状æ€�,`isExistingTransaction(...)` 方法主è¦�是根æ�®å®ƒæ�¥åˆ¤æ–­å½“å‰�事务对象是å�¦å­˜åœ¨äº‹åŠ¡çš„ã€‚ -##### 3\. ´¦ÀíÒÑ´æÔÚµÄÊÂÎñ£º`handleExistingTransaction(...)` +##### 3\. 处ç�†å·²å­˜åœ¨çš„事务:`handleExistingTransaction(...)` -ÕâÀïÎÒÃÇÀ´¿´¿´Èç¹ûµ±Ç°´æÔÚÊÂÎñ£¬spring ÊÇÔõô´¦ÀíµÄ£¬´¦ÀíÒÑ´æÔÚÊÂÎñµÄ·½·¨Îª `AbstractPlatformTransactionManager#handleExistingTransaction`£¬´úÂëÈçÏ£º +这里我们æ�¥çœ‹çœ‹å¦‚果当å‰�存在事务,spring 是怎么处ç�†çš„,处ç�†å·²å­˜åœ¨äº‹åŠ¡çš„æ–¹æ³•ä¸º `AbstractPlatformTransactionManager#handleExistingTransaction`,代ç �如下: ``` private TransactionStatus handleExistingTransaction(TransactionDefinition definition, Object transaction, boolean debugEnabled) throws TransactionException { - // µ±´«²¥·½Ê½Îª¡¾²»Ê¹ÓÃÊÂÎñ¡¿Ê±£¬Å׳öÒì³£ + // 当传播方å¼�为ã€�ä¸�使用事务】时,抛出异常 if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NEVER) { throw new IllegalTransactionStateException( "Existing transaction found for transaction marked with propagation 'never'"); } - // µ±´«²¥·½Ê½Îª¡¾²»Ö§³ÖÊÂÎñ¡¿Ê±£¬¹ÒÆðµ±Ç°ÊÂÎñ£¬È»ºóÔÚÎÞÊÂÎñµÄ״̬ÖÐÔËÐÐ + // 当传播方å¼�为ã€�ä¸�支æŒ�事务】时,挂起当å‰�事务,然å�Žåœ¨æ— äº‹åŠ¡çš„çŠ¶æ€�中è¿�行 if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NOT_SUPPORTED) { - // 1\. suspend()£º¹ÒÆðÊÂÎñ²Ù×÷ + // 1\. suspend():挂起事务æ“�作 Object suspendedResources = suspend(transaction); boolean newSynchronization = (getTransactionSynchronization() == SYNCHRONIZATION_ALWAYS); return prepareTransactionStatus( definition, null, false, newSynchronization, debugEnabled, suspendedResources); } - // µ±´«²¥·½Ê½Îª¡¾ÔÚеÄÊÂÎñÖÐÔËÐС¿Ê±£¬¹ÒÆðµ±Ç°ÊÂÎñ£¬È»ºóÆô¶¯ÐµÄÊÂÎñ + // 当传播方å¼�为ã€�在新的事务中è¿�行】时,挂起当å‰�事务,然å�Žå�¯åŠ¨æ–°çš„äº‹åŠ¡ if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRES_NEW) { - // ¹ÒÆðÊÂÎñ²Ù×÷ + // 挂起事务æ“�作 SuspendedResourcesHolder suspendedResources = suspend(transaction); try { boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER); DefaultTransactionStatus status = newTransactionStatus(definition, transaction, true, newSynchronization, debugEnabled, suspendedResources); - // 2\. doBegin()£ºÆô¶¯ÐµÄÊÂÎñ + // 2\. doBegin():å�¯åŠ¨æ–°çš„äº‹åŠ¡ doBegin(transaction, definition); prepareSynchronization(status, definition); return status; @@ -311,14 +311,14 @@ private TransactionStatus handleExistingTransaction(TransactionDefinition defini } } - // µ±´«²¥·½Ê½Îª¡¾Ç¶Ì×Ö´ÐС¿Ê±£¬ ÉèÖÃÊÂÎñµÄ±£´æµã - // ´æÔÚÊÂÎñ£¬½«¸ÃÊÂÎñ±ê×¢±£´æµã£¬ÐγÉǶÌ×ÊÂÎñ¡£ - // ǶÌ×ÊÂÎñÖеÄ×ÓÊÂÎñ³öÏÖÒì³£²»»áÓ°Ïìµ½¸¸ÊÂÎñ±£´æµã֮ǰµÄ²Ù×÷¡£ + // 当传播方å¼�为ã€�嵌套执行】时, 设置事务的ä¿�存点 + // 存在事务,将该事务标注ä¿�存点,形æˆ�嵌套事务。 + // 嵌套事务中的å­�事务出现异常ä¸�会影å“�到父事务ä¿�存点之å‰�çš„æ“�作。 if (definition.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NESTED) { if (!isNestedTransactionAllowed()) { throw new NestedTransactionNotSupportedException(...); } - // 3\. createAndHoldSavepoint(...)£º´´½¨±£´æµã£¬»Ø¹öʱֻ»Ø¹öµ½¸Ã±£´æµã + // 3\. createAndHoldSavepoint(...):创建ä¿�存点,回滚时å�ªå›žæ»šåˆ°è¯¥ä¿�存点 if (useSavepointForNestedTransaction()) { DefaultTransactionStatus status = prepareTransactionStatus(definition, transaction, false, false, debugEnabled, null); @@ -329,14 +329,14 @@ private TransactionStatus handleExistingTransaction(TransactionDefinition defini boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER); DefaultTransactionStatus status = newTransactionStatus( definition, transaction, true, newSynchronization, debugEnabled, null); - // Èç¹û²»Ö§³Ö±£´æµã£¬¾ÍÆô¶¯ÐµÄÊÂÎñ + // 如果ä¸�支æŒ�ä¿�存点,就å�¯åŠ¨æ–°çš„äº‹åŠ¡ doBegin(transaction, definition); prepareSynchronization(status, definition); return status; } } if (isValidateExistingTransaction()) { - // ´¦ÀíÑéÖ¤²Ù×÷£¬²»×÷·ÖÎö + // 处ç�†éªŒè¯�æ“�作,ä¸�作分æž� ... } boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER); @@ -346,50 +346,50 @@ private TransactionStatus handleExistingTransaction(TransactionDefinition defini ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½·¨Àï¾Í´¦ÀíÁËÊÂÎñµÄ¸ôÀë¼¶±ðµÄÂß¼­£¬Ïà¹ØµÄ´úÂëÒѾ­×÷ÁË×¢ÊÍ£¬ÕâÀï¾Í²»¶à˵ÁË£¬²»¹ýÕâÀïÓм¸¸ö·½·¨ÐèÒªÌØ±ðÌá³ö£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ³•里就处ç�†äº†äº‹åŠ¡çš„éš”ç¦»çº§åˆ«çš„é€»è¾‘ï¼Œç›¸å…³çš„ä»£ç �å·²ç»�作了注释,这里就ä¸�多说了,ä¸�过这里有几个方法需è¦�特别æ��出: -1. `suspend()`£º¹ÒÆðÊÂÎñ²Ù×÷ -2. `doBegin()`£ºÆô¶¯ÐµÄÊÂÎñ -3. `createAndHoldSavepoint(...)`£º´´½¨±£´æµã£¬»Ø¹öʱֻ»Ø¹öµ½¸Ã±£´æµã +1. `suspend()`:挂起事务æ“�作 +2. `doBegin()`:å�¯åŠ¨æ–°çš„äº‹åŠ¡ +3. `createAndHoldSavepoint(...)`:创建ä¿�存点,回滚时å�ªå›žæ»šåˆ°è¯¥ä¿�存点 -Õ⼸¸ö²Ù×÷°üº¬ÁËÊÂÎñ´¦Àí²Ù×÷£¬ºóÃæÎÒÃÇÔÙͳһ·ÖÎö¡£ +这几个æ“�作包å�«äº†äº‹åС处ç�†æ“�作,å�Žé�¢æˆ‘们å†�统一分æž�。 -##### 4\. ¼ÌÐø `AbstractPlatformTransactionManager#getTransaction` +##### 4\. ç»§ç»­ `AbstractPlatformTransactionManager#getTransaction` -ÈÃÎÒÃÇÔٻص½ `AbstractPlatformTransactionManager#getTransaction` ·½·¨£¬¼ÌÐøÊ£ÏµÄÁ÷³Ì£º +让我们å†�回到 `AbstractPlatformTransactionManager#getTransaction` 方法,继续剩下的æµ�程: ``` public final TransactionStatus getTransaction(@Nullable TransactionDefinition definition) throws TransactionException { - // Ç°ÃæÒѾ­·ÖÎö¹ýÁË£¬Ê¡ÂÔ + // å‰�é�¢å·²ç»�分æž�过了,çœ�ç•¥ ... - // ÔËÐе½ÁËÕâÀ±íÃ÷µ±Ç°Ã»ÓÐÊÂÎñ + // è¿�行到了这里,表明当å‰�没有事务 - // ¼ì²é³¬Ê±Ê±¼äµÄÉèÖÃÊÇ·ñºÏÀí + // 检查超时时间的设置是å�¦å�ˆç�† if (def.getTimeout() < TransactionDefinition.TIMEOUT_DEFAULT) { throw new InvalidTimeoutException("Invalid transaction timeout", def.getTimeout()); } - // PROPAGATION_MANDATORY£º±ØÐëÔÚÊÂÎñÖÐÔËÐУ¬ÕâÀïûÓÐÊÂÎñ£¬Ö±½ÓÅ×Òì³£ + // PROPAGATION_MANDATORY:必须在事务中è¿�行,这里没有事务,直接抛异常 if (def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_MANDATORY) { throw new IllegalTransactionStateException(...); } - // ¹ÒÆðµ±Ç°ÊÂÎñ£¬´´½¨ÐÂÊÂÎñ + // 挂起当å‰�事务,创建新事务 else if (def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRED || def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_REQUIRES_NEW || def.getPropagationBehavior() == TransactionDefinition.PROPAGATION_NESTED) { - // suspend(...) ´«Èënull£ºÈç¹ûÓÐͬ²½ÊÂÎñ£¬Ôò¹ÒÆðͬ²½ÊÂÎñ£¬·ñÔòʲôҲ²»×ö + // suspend(...) ä¼ å…¥null:如果有å�Œæ­¥äº‹åŠ¡ï¼Œåˆ™æŒ‚èµ·å�Œæ­¥äº‹åŠ¡ï¼Œå�¦åˆ™ä»€ä¹ˆä¹Ÿä¸�å�š SuspendedResourcesHolder suspendedResources = suspend(null); try { boolean newSynchronization = (getTransactionSynchronization() != SYNCHRONIZATION_NEVER); - // ´´½¨ÊÂÎñ¶ÔÏó + // 创建事务对象 DefaultTransactionStatus status = newTransactionStatus( def, transaction, true, newSynchronization, debugEnabled, suspendedResources); - // Æô¶¯ÊÂÎñ + // å�¯åŠ¨äº‹åŠ¡ doBegin(transaction, def); - // ÉèÖà TransactionSynchronizationManager µÄÊôÐÔ + // 设置 TransactionSynchronizationManager 的属性 prepareSynchronization(status, def); return status; } @@ -406,39 +406,39 @@ public final TransactionStatus getTransaction(@Nullable TransactionDefinition de ``` -`handleExistingTransaction(...)` ·½·¨µÄ¹¦ÄÜÊÇ**µ±ÊÂÎñ´æÔÚʱ£¬ÄÇЩ¸ö´«²¥ÀàÐÍÒªÔõô´¦Àí**£¬`getTransaction(...)` ·½·¨Óàϲ¿·ÖµÄ¹¦ÄÜÊÇ£¬**µ±ÊÂÎñ´æÔÚʱ£¬ÄÇЩ¸ö´«²¥ÀàÐÍÓÖÒªÔõô´¦Àí**¡£¿ÉÒÔ¿´µ½£¬ÕâÀïÃæÒÀÈ»»¹ÊÇÓÐ `suspend(...)`¡¢`doBegin(...)` µÈ·½·¨£¬ÕâЩ¸ö·½·¨ÎÒÃÇÒ»»áҲͳһ·ÖÎö¡£ +`handleExistingTransaction(...)` 方法的功能是**当事务存在时,那些个传播类型è¦�怎么处ç�†**,`getTransaction(...)` 方法余下部分的功能是,**当事务存在时,那些个传播类型å�ˆè¦�怎么处ç�†**。å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œé�¢ä¾�然还是有 `suspend(...)`ã€�`doBegin(...)` 等方法,这些个方法我们一会也统一分æž�。 -##### 5\. ×¼±¸·µ»Ø½á¹û£º`prepareTransactionStatus(...)` +##### 5\. 准备返回结果:`prepareTransactionStatus(...)` -`handleExistingTransaction(...)` ·½·¨Óë `getTransaction(...)` ·½·¨ÔÚ´¦Àí·µ»Ø½á¹ûʱ£¬¶¼Ê¹ÓÃÁË `prepareTransactionStatus(...)` ·½·¨£º +`handleExistingTransaction(...)` 方法与 `getTransaction(...)` 方法在处ç�†è¿”回结果时,都使用了 `prepareTransactionStatus(...)` 方法: ``` -// `handleExistingTransaction(...)`·½·¨ +// `handleExistingTransaction(...)`方法 return prepareTransactionStatus(definition, transaction, false, newSynchronization, debugEnabled, null); -// `getTransaction(...)`·½·¨ +// `getTransaction(...)`方法 return prepareTransactionStatus(def, null, true, newSynchronization, debugEnabled, null); ``` -ÎÒÃÇÀ´·ÖÎöÏÂÕâ¸ö·½·¨ÊÇ×öÁËɶ£¬½øÈë `AbstractPlatformTransactionManager#prepareTransactionStatus`£º +我们æ�¥åˆ†æž�下这个方法是å�šäº†å•¥ï¼Œè¿›å…¥ `AbstractPlatformTransactionManager#prepareTransactionStatus`: ``` protected final DefaultTransactionStatus prepareTransactionStatus( TransactionDefinition definition, @Nullable Object transaction, boolean newTransaction, boolean newSynchronization, boolean debug, @Nullable Object suspendedResources) { - // ´´½¨ÁËÒ»¸ö DefaultTransactionStatus ¶ÔÏó + // 创建了一个 DefaultTransactionStatus 对象 DefaultTransactionStatus status = newTransactionStatus( definition, transaction, newTransaction, newSynchronization, debug, suspendedResources); - // ×¼±¸ Synchronization + // 准备 Synchronization prepareSynchronization(status, definition); return status; } /** - *´´½¨Ò»¸ö TransactionStatus ʵÀý + *创建一个 TransactionStatus 实例 */ protected DefaultTransactionStatus newTransactionStatus( TransactionDefinition definition, @Nullable Object transaction, boolean newTransaction, @@ -446,7 +446,7 @@ protected DefaultTransactionStatus newTransactionStatus( boolean actualNewSynchronization = newSynchronization && !TransactionSynchronizationManager.isSynchronizationActive(); - // µ÷Óà DefaultTransactionStatus µÄ¹¹Ôì·½·¨ + // 调用 DefaultTransactionStatus 的构造方法 return new DefaultTransactionStatus( transaction, newTransaction, actualNewSynchronization, definition.isReadOnly(), debug, suspendedResources); @@ -454,13 +454,13 @@ protected DefaultTransactionStatus newTransactionStatus( ``` -ËùÒÔÕâ¸ö·½·¨Ö÷Òª¾ÍÊÇΪÁË´´½¨ `DefaultTransactionStatus` ¶ÔÏó£¡ÎÒÃÇÀ´¿´ÏÂÕâÒ»²½µÄÔËÐнá¹û£º +所以这个方法主è¦�就是为了创建 `DefaultTransactionStatus` 对象ï¼�我们æ�¥çœ‹ä¸‹è¿™ä¸€æ­¥çš„è¿�行结果: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a491ee7ca22238b2d9c698c55ae9dd6d005.png) -##### 6\. ×¼±¸ÊÂÎñÐÅÏ¢£º`TransactionAspectSupport#prepareTransactionInfo` +##### 6\. 准备事务信æ�¯ï¼š`TransactionAspectSupport#prepareTransactionInfo` -»Øµ½ `TransactionAspectSupport#createTransactionIfNecessary` ·½·¨£º +回到 `TransactionAspectSupport#createTransactionIfNecessary` 方法: ``` protected TransactionInfo createTransactionIfNecessary(@Nullable PlatformTransactionManager tm, @@ -469,17 +469,17 @@ protected TransactionInfo createTransactionIfNecessary(@Nullable PlatformTransac TransactionStatus status = null; if (txAttr != null) { if (tm != null) { - // »ñÈ¡ÊÂÎñ״̬£¬Èç¹ûµ±Ç°Ã»ÓÐÊÂÎñ£¬¿ÉÄܻᴴ½¨ÊÂÎñ + // 获å�–事务状æ€�,如果当å‰�没有事务,å�¯èƒ½ä¼šåˆ›å»ºäº‹åŠ¡ status = tm.getTransaction(txAttr); } } - // ×¼±¸ÊÂÎñÐÅÏ¢£¬¾ÍÊǽ«Ç°ÃæµÃµ½µÄÐÅÏ¢·â×°³É TransactionInfo + // 准备事务信æ�¯ï¼Œå°±æ˜¯å°†å‰�é�¢å¾—到的信æ�¯å°�装æˆ� TransactionInfo return prepareTransactionInfo(tm, txAttr, joinpointIdentification, status); } ``` -Ç°Ãæ·ÖÎöÁËÄÇô¶à£¬Ö»Êǵõ½ÁË `TransactionStatus`£¬ÎÒÃÇÔÙ½ÓÔÙÀ÷£¬¼ÌÐø·ÖÎö×¼±¸ÊÂÎñÐÅÏ¢µÄ·½·¨ `prepareTransactionInfo(...)`£º +å‰�é�¢åˆ†æž�了那么多,å�ªæ˜¯å¾—到了 `TransactionStatus`,我们å†�接å†�厉,继续分æž�准备事务信æ�¯çš„æ–¹æ³• `prepareTransactionInfo(...)`: ``` protected TransactionInfo prepareTransactionInfo(@Nullable PlatformTransactionManager tm, @@ -491,26 +491,26 @@ protected TransactionInfo prepareTransactionInfo(@Nullable PlatformTransactionMa txInfo.newTransactionStatus(status); } - // Ê¡ÂÔlogµÄ´òÓ¡ + // çœ�ç•¥log的打å�° ... - // ÓëÏß³Ì°ó¶¨ + // 与线程绑定 txInfo.bindToThread(); return txInfo; } ``` -àÅ£¬Í¬ `prepareTransactionStatus(...)` ÀàËÆ£¬Õâ¸ö·½·¨Ò²ÊÇ´´½¨ÁËÒ»¸ö `TransactionInfo` ¶ÔÏ󣬲¢ÇÒ½« `TransactionInfo` Ó뵱ǰḬ̈߳󶨣¬°ó¶¨µÄ´úÂëÈçÏ£º +嗯,å�Œ `prepareTransactionStatus(...)` 类似,这个方法也是创建了一个 `TransactionInfo` 对象,并且将 `TransactionInfo` 与当å‰�线程绑定,绑定的代ç �如下: ``` public abstract class TransactionAspectSupport implements BeanFactoryAware, InitializingBean { - // ´æ·Åµ±Ç°Ê¹ÓõÄÊÂÎïÐÅÏ¢ + // 存放当å‰�使用的事物信æ�¯ private static final ThreadLocal transactionInfoHolder = new NamedThreadLocal<>("Current aspect-driven transaction"); - // ÖØÖÃΪ¾ÉµÄÊÂÎñÐÅÏ¢ + // é‡�置为旧的事务信æ�¯ protected void cleanupTransactionInfo(@Nullable TransactionInfo txInfo) { if (txInfo != null) { txInfo.restoreThreadLocalStatus(); @@ -518,33 +518,33 @@ public abstract class TransactionAspectSupport implements BeanFactoryAware, Init } /** - * TransactionInfo: ±£´æÊÂÎñÐÅÏ¢ + * TransactionInfo: ä¿�存事务信æ�¯ */ protected static final class TransactionInfo { - // µ±Ç°µÄÊÂÎñ״̬¶ÔÏó + // 当å‰�的事务状æ€�对象 @Nullable private TransactionStatus transactionStatus; - // ¾ÉµÄÊÂÎñÐÅÏ¢£¨Ò²¾ÍÊÇ¹ÒÆðµÄÊÂÎñÐÅÏ¢£© + // 旧的事务信æ�¯ï¼ˆä¹Ÿå°±æ˜¯æŒ‚起的事务信æ�¯ï¼‰ @Nullable private TransactionInfo oldTransactionInfo; /** - * ½«ÊÂÎñÐÅÏ¢°ó¶¨µ½µ±Ç°Ïß³Ì + * 将事务信æ�¯ç»‘定到当å‰�线程 */ private void bindToThread() { - // Äõ½¾ÉµÄÊÂÎñÐÅÏ¢ + // 拿到旧的事务信æ�¯ this.oldTransactionInfo = transactionInfoHolder.get(); - // ÉèÖóÉ×îеÄÊÂÎñÐÅÏ¢ + // 设置æˆ�最新的事务信æ�¯ transactionInfoHolder.set(this); } /** - * ÊÂÎñÍê³Éºó£¬»á½«¾ÉµÄÊÂÎñÐÅÏ¢°ó¶¨µ½µ±Ç°Ïß³Ì + * 事务完æˆ�å�Žï¼Œä¼šå°†æ—§çš„事务信æ�¯ç»‘定到当å‰�线程 */ private void restoreThreadLocalStatus() { - // ÉèÖÃΪ¾ÉµÄÊÂÎñÐÅÏ¢ + // 设置为旧的事务信æ�¯ transactionInfoHolder.set(this.oldTransactionInfo); } @@ -555,26 +555,26 @@ public abstract class TransactionAspectSupport implements BeanFactoryAware, Init ``` -`TransactionAspectSupport` ÖÐÓÐÒ»¸ö `ThreadLocal`£¬ÓÃÀ´´æ·Åµ±Ç°µÄ `TransactionInfo` ¶ÔÏ󣬽øÐÐḬ̈߳ó¶¨Ê±£¬»áÏÈÄõ½¾ÉµÄÊÂÎñÐÅÏ¢£¬±£´æÔÚ `TransactionInfo` µÄ³ÉÔ±±äÁ¿ `oldTransactionInfo` ÖУ¬È»ºó½«Ð嵀 `TransactionInfo` ·ÅÈë `ThreadLocal` ÖУ»µ±ÊÂÎñÖ´ÐÐÍê³Éºó£¬»á´Ó `TransactionInfo` µÄ³ÉÔ±±äÁ¿ `oldTransactionInfo` ÖÐÄõ½¾ÉµÄÊÂÎñÐÅÏ¢£¬ÔÙ½«¾ÉµÄÊÂÎñÐÅÏ¢·ÅÈë `ThreadLocal` ÖУ¬Õâ¾ÍÍê³ÉÁËÊÂÎñ "¾É - Р- ¾É" µÄÇл». +`TransactionAspectSupport` 中有一个 `ThreadLocal`,用æ�¥å­˜æ”¾å½“å‰�çš„ `TransactionInfo` 对象,进行线程绑定时,会先拿到旧的事务信æ�¯ï¼Œä¿�存在 `TransactionInfo` çš„æˆ�员å�˜é‡� `oldTransactionInfo` 中,然å�Žå°†æ–°çš„ `TransactionInfo` 放入 `ThreadLocal` 中;当事务执行完æˆ�å�Žï¼Œä¼šä»Ž `TransactionInfo` çš„æˆ�员å�˜é‡� `oldTransactionInfo` 中拿到旧的事务信æ�¯ï¼Œå†�将旧的事务信æ�¯æ”¾å…¥ `ThreadLocal` 中,这就完æˆ�了事务 "æ—§ - æ–° - æ—§" 的切æ�¢. -ÕâÒ»²½µÃµ½µÄ `TransactionInfo` ÈçÏ£º +这一步得到的 `TransactionInfo` 如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ab882613ce67ba3bf7afcbd2eab01c6cf27.png) -¶ÔÓÚ `TransactionInfo` µÄ½á¹¹£¬ÕâÀï×÷һЩ˵Ã÷£º +对于 `TransactionInfo` 的结构,这里作一些说明: -* ÀàÐÍÊÇ `TransactionAspectSupport.TransactionInfo`£¬ÊÇ `TransactionAspectSupport` µÄÒ»¸öÄÚ²¿À࣬·â×°ÁËÊÂÎñµÄһЩÐÅÏ¢ -* `transactionManager`: ÊÂÎñ¹ÜÀíÆ÷£¬¾ÍÊÇÎÒÃÇÉèÖÃµÄ `DataSourceTransactionManager` -* `transactionAttribute`: ÊÂÎñÊôÐÔÖµ£¬ÓÃÀ´±£´æ `@Transactional` ×¢½âµÄÊôÐÔÖµ -* `joinpointIdentification`: ·½·¨µÄÈ«ÏÞ¶¨Ãû£¨¸ñʽΪ£º"°üÃû¡£ÀàÐÍ¡£·½·¨Ãû"£© -* `transactionStatus`: ´ÓÃû³ÆÉÏ¿´£¬ÊǼǼÊÂÎñµÄ״̬£¬Êµ¼ÊÕâ¸ö¶ÔÏó²»½ö¼Ç¼ÁËÊÂÎñµÄ״̬£¬°üÀ¨µÄÖØ´ó¹¦ÄÜÈçÏ£º - * `complete`: ÊÂÎñµÄÍê³É״̬ - * `connectionHolder`: µ±Ç°³ÖÓеÄÊý¾Ý¿âÁ¬½Ó - * `suspendedResources`: ¹ÒÆðµÄÊý¾Ý¿âÁ¬½Ó£¬µ±ÐèÒª»Ö¸´¹ÒÆðµÄÊÂÎñʱ£¬¿ÉÒÔÄܹý¸Ã¶ÔÏóÄõ½¹ÒÆðµÄÊý¾Ý¿âÁ¬½Ó -* `oldTransactionInfo`: ÉÏÒ»¸öÊÂÎñ£¨Ò²¾ÍÊÇ¹ÒÆðµÄÊÂÎñ£©µÄÐÅÏ¢£¬Ö´ÐÐÍ굱ǰÊÂÎñºó£¬»á»Ö¸´µ½ÉÏÒ»¸öÊÂÎñµÄÖ´ÐÐ +* 类型是 `TransactionAspectSupport.TransactionInfo`,是 `TransactionAspectSupport` 的一个内部类,å°�装了事务的一些信æ�¯ +* `transactionManager`: 事务管ç�†å™¨ï¼Œå°±æ˜¯æˆ‘们设置的 `DataSourceTransactionManager` +* `transactionAttribute`: 事务属性值,用æ�¥ä¿�å­˜ `@Transactional` 注解的属性值 +* `joinpointIdentification`: 方法的全é™�定å��(格å¼�为:"包å��。类型。方法å��") +* `transactionStatus`: 从å��称上看,是记录事务的状æ€�,实际这个对象ä¸�仅记录了事务的状æ€�,包括的é‡�大功能如下: + * `complete`: 事务的完æˆ�状æ€� + * `connectionHolder`: 当å‰�æŒ�有的数æ�®åº“连接 + * `suspendedResources`: 挂起的数æ�®åº“连接,当需è¦�æ�¢å¤�挂起的事务时,å�¯ä»¥èƒ½è¿‡è¯¥å¯¹è±¡æ‹¿åˆ°æŒ‚起的数æ�®åº“连接 +* `oldTransactionInfo`: 上一个事务(也就是挂起的事务)的信æ�¯ï¼Œæ‰§è¡Œå®Œå½“å‰�事务å�Žï¼Œä¼šæ�¢å¤�到上一个事务的执行 -Ò»²»Ð¡ÐÄÓÖдÁËÕâô³¤ÁË£¬±¾ÎľÍÏÈ·ÖÎöµ½ÕâÀïÁË£¬`suspend(...)`¡¢`doBegin(...)` µÈ·½·¨ÏÂÆªÔÙ·ÖÎö°É¡£ +一ä¸�å°�心å�ˆå†™äº†è¿™ä¹ˆé•¿äº†ï¼Œæœ¬æ–‡å°±å…ˆåˆ†æž�到这里了,`suspend(...)`ã€�`doBegin(...)` 等方法下篇å†�分æž�å�§ã€‚ * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4947799](https://my.oschina.net/funcy/blog/4947799) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4947799](https://my.oschina.net/funcy/blog/4947799) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\203\357\274\211\357\274\232\345\233\275\351\231\205\345\214\226\344\270\216\344\272\213\344\273\266\345\244\204\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\203\357\274\211\357\274\232\345\233\275\351\231\205\345\214\226\344\270\216\344\272\213\344\273\266\345\244\204\347\220\206.md" index 4f97b54..60e613b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\203\357\274\211\357\274\232\345\233\275\351\231\205\345\214\226\344\270\216\344\272\213\344\273\266\345\244\204\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\203\357\274\211\357\274\232\345\233\275\351\231\205\345\214\226\344\270\216\344\272\213\344\273\266\345\244\204\347\220\206.md" @@ -1,10 +1,10 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ed6b80d76ba4b2ddb0f8d15e070a0c32df7.png) -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö spring µÄÆô¶¯Á÷³Ì¡£ +接上文,我们继续分æž� spring çš„å�¯åЍæµ�程。 -### 7\. ¹ú¼Ê»¯: `initMessageSource()` +### 7\. 国际化: `initMessageSource()` -Õâ¸ö·½·¨ÊÇÓÃÀ´³õʼ»¯ `MessageSource` µÄ£¬ÄÚÈÝÈçÏ£º +这个方法是用æ�¥åˆ�始化 `MessageSource` 的,内容如下: ``` public abstract class AbstractApplicationContext extends DefaultResourceLoader @@ -13,34 +13,34 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader ... /** - * ³õʼ»¯ MessageSource + * åˆ�始化 MessageSource */ protected void initMessageSource() { ConfigurableListableBeanFactory beanFactory = getBeanFactory(); - // Èç¹ûbeanFactoryÖдæÔÚMessageSource£¬ÉèÖÃÆä ParentMessageSource + // 如果beanFactory中存在MessageSource,设置其 ParentMessageSource if (beanFactory.containsLocalBean(MESSAGE_SOURCE_BEAN_NAME)) { this.messageSource = beanFactory.getBean( MESSAGE_SOURCE_BEAN_NAME, MessageSource.class); if (this.parent != null && this.messageSource instanceof HierarchicalMessageSource) { HierarchicalMessageSource hms = (HierarchicalMessageSource) this.messageSource; if (hms.getParentMessageSource() == null) { - // ÉèÖÃParentMessageSource + // 设置ParentMessageSource hms.setParentMessageSource(getInternalParentMessageSource()); } } } - // Èç¹ûbeanFactoryÖв»´æÔÚMessageSource£¬¾Í ´´½¨-ÉèÖÃ-×¢²á + // 如果beanFactory中ä¸�存在MessageSource,就 创建-设置-注册 else { DelegatingMessageSource dms = new DelegatingMessageSource(); dms.setParentMessageSource(getInternalParentMessageSource()); this.messageSource = dms; - // ÉèÖÃParentMessageSource + // 设置ParentMessageSource beanFactory.registerSingleton(MESSAGE_SOURCE_BEAN_NAME, this.messageSource); } } /** - * ·µ»Ø¸¸ÈÝÆ÷µÄ messageSource + * 返回父容器的 messageSource */ @Nullable protected MessageSource getInternalParentMessageSource() { @@ -53,25 +53,25 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader ``` -¿ÉÒÔ¿´µ½£¬Õû¸ö·½·¨Ö÷ÒªÊDzÙ×÷ `MessageSource`£¬Ö÷ÒªÂß¼­Îª£ºÈç¹ûÒѾ­´æÔÚ `MessageSource` ÁË£¬¾ÍÉèÖÃһЩÊôÐÔ£»·ñÔò¾Í´´½¨ `MessageSource`£¬²¢ÉèÖÃЩ ÊôÐÔ£¬×îºó×¢²áµ½ `beanFactory` ÖС£ +å�¯ä»¥çœ‹åˆ°ï¼Œæ•´ä¸ªæ–¹æ³•主è¦�是æ“�作 `MessageSource`,主è¦�逻辑为:如果已ç»�存在 `MessageSource` 了,就设置一些属性;å�¦åˆ™å°±åˆ›å»º `MessageSource`,并设置些 属性,最å�Žæ³¨å†Œåˆ° `beanFactory` 中。 -¹ØÓÚ `MessageSource` µÄ¾ßÌå×÷Ó㬱¾ÎľͲ»Õ¹¿ªÁË¡£ +关于 `MessageSource` 的具体作用,本文就ä¸�展开了。 -### 8\. ³õʼ»¯Ê¼þ¹ã²¥Æ÷£º`initApplicationEventMulticaster()` +### 8\. åˆ�始化事件广播器:`initApplicationEventMulticaster()` -`AbstractApplicationContext#initApplicationEventMulticaster` ´úÂëÈçÏ£º +`AbstractApplicationContext#initApplicationEventMulticaster` 代ç �如下: ``` protected void initApplicationEventMulticaster() { ConfigurableListableBeanFactory beanFactory = getBeanFactory(); - // Èç¹ûÓû§ÅäÖÃÁË×Ô¶¨Òåʼþ¹ã²¥Æ÷£¬¾ÍʹÓÃÓû§µÄ + // 如果用户é…�置了自定义事件广播器,就使用用户的 if (beanFactory.containsLocalBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME)) { this.applicationEventMulticaster = beanFactory.getBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, ApplicationEventMulticaster.class); } else { - // Óû§Ã»ÓÐÅäÖù㲥Æ÷£¬¾ÍʹÓÃĬÈϵÄʼþ¹ã²¥Æ÷ + // 用户没有é…�置广播器,就使用默认的事件广播器 this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory); beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, this.applicationEventMulticaster); @@ -80,11 +80,11 @@ protected void initApplicationEventMulticaster() { ``` -Õâ¿éÂß¼­Ò²ºÜ¼òµ¥£¬Èç¹ûÒÑ´æÔÚʼþ¹ã²¥Æ÷£¬¾ÍʹÓÃÒÑ´æÔڵ쬷ñÔò¾Í´´½¨Ò»¸ö¡£¹ØÓÚ `ApplicationEventMulticaster`£¬Ö÷Òª¾ÍÊÇÓÃÀ´¹ã²¥Ê¼þµÄ£¬¸ü¶à¹ØÓÚʼþµÄÄÚÈÝ£¬¿ÉÒԲο¼ [spring Ì½ÃØÖ® spring ʼþ»úÖÆ](https://my.oschina.net/funcy/blog/4713339). +è¿™å�—逻辑也很简å�•,如果已存在事件广播器,就使用已存在的,å�¦åˆ™å°±åˆ›å»ºä¸€ä¸ªã€‚关于 `ApplicationEventMulticaster`,主è¦�就是用æ�¥å¹¿æ’­äº‹ä»¶çš„,更多关于事件的内容,å�¯ä»¥å�‚考 [spring 探秘之 spring 事件机制](https://my.oschina.net/funcy/blog/4713339). -### 9\. À©Õ¹µã£ºonRefresh () +### 9\. 扩展点:onRefresh () -`AbstractApplicationContext#onRefresh` ÊÇ spring ÌṩµÄÒ»¸öÀ©Õ¹µã£¬·½·¨²¢ÎÞÄÚÈÝ£º +`AbstractApplicationContext#onRefresh` 是 spring æ��供的一个扩展点,方法并无内容: ``` protected void onRefresh() throws BeansException { @@ -93,27 +93,27 @@ protected void onRefresh() throws BeansException { ``` -Èç¹ûÐèÒª´¦ÀíÌØ¶¨µÄ²Ù×÷£¬¿ÉÒÔÔÚ×ÓÀàÖÐʵÏÖ¡£ +如果需è¦�处ç�†ç‰¹å®šçš„æ“�作,å�¯ä»¥åœ¨å­�类中实现。 -µ±Ç°Ê¹ÓÃµÄ `ApplicationContext` ÊÇ `AnnotationConfigApplicationContext`£¬²¢ÎÞ `onRefresh()` ·½·¨£¬¾Í²»¹ý¶à·ÖÎöÁË¡£ +当å‰�使用的 `ApplicationContext` 是 `AnnotationConfigApplicationContext`,并无 `onRefresh()` 方法,就ä¸�过多分æž�了。 -### 10\. ×¢²áʼþ¼àÌýÆ÷£ºregisterListeners () +### 10\. 注册事件监å�¬å™¨ï¼šregisterListeners () -`AbstractApplicationContext#registerListeners` Ïà¹Ø´úÂëÈçÏ£º +`AbstractApplicationContext#registerListeners` 相关代ç �如下: > AbstractApplicationContext ``` -/** ÕâÀï¾ÍÊÇÓÃÀ´´æ·Å¼àÌýÆ÷µÄ */ +/** 这里就是用æ�¥å­˜æ”¾ç›‘å�¬å™¨çš„ */ private final Set> applicationListeners = new LinkedHashSet<>(); -/** ·µ»Øµ±Ç°ËùÓеļàÌýÆ÷ */ +/** 返回当å‰�所有的监å�¬å™¨ */ public Collection> getApplicationListeners() { return this.applicationListeners; } /** - * Ìí¼Ó¼àÌýÆ÷ + * 添加监å�¬å™¨ */ public void addApplicationListener(ApplicationListener listener) { Assert.notNull(listener, "ApplicationListener must not be null"); @@ -124,26 +124,26 @@ public void addApplicationListener(ApplicationListener listener) { } /** - * ×¢²á¼àÌýÆ÷ + * 注册监å�¬å™¨ */ protected void registerListeners() { - // ÏÈÌí¼ÓÊÖ¶¯setµÄһЩ¼àÌýÆ÷ - // getApplicationListeners() »ñÈ¡µÄ¼àÌýÆ÷»ù±¾ÊÇͨ¹ýµ÷Óà addApplicationListener(...) Ìí¼ÓµÄ + // 先添加手动set的一些监å�¬å™¨ + // getApplicationListeners() 获å�–的监å�¬å™¨åŸºæœ¬æ˜¯é€šè¿‡è°ƒç”¨ addApplicationListener(...) 添加的 for (ApplicationListener listener : getApplicationListeners()) { getApplicationEventMulticaster().addApplicationListener(listener); } - // »ñȡȡµ½¼àÌýÆ÷µÄÃû³Æ£¬ÉèÖõ½¹ã²¥Æ÷ - // ´Ëʱ»ñÈ¡µÄ¼àÌýÆ÷ÊÇ´Ó beanFactory ÖлñÈ¡µÄ£¬¼´ÊÇspringͨ¹ý°üɨÃèµÃµ½µÄ + // 获å�–å�–到监å�¬å™¨çš„å��称,设置到广播器 + // 此时获å�–的监å�¬å™¨æ˜¯ä»Ž beanFactory 中获å�–的,å�³æ˜¯spring通过包扫æ��得到的 String[] listenerBeanNames = getBeanNamesForType(ApplicationListener.class, true, false); for (String listenerBeanName : listenerBeanNames) { getApplicationEventMulticaster().addApplicationListenerBean(listenerBeanName); } - // Èç¹û´æÔÚÔçÆÚÓ¦ÓÃʼþ£¬¹ã²¥ + // 如果存在早期应用事件,广播 Set earlyEventsToProcess = this.earlyApplicationEvents; this.earlyApplicationEvents = null; if (earlyEventsToProcess != null) { for (ApplicationEvent earlyEvent : earlyEventsToProcess) { - // ¹ã²¥ÔçÆÚʼþ + // 广播早期事件 getApplicationEventMulticaster().multicastEvent(earlyEvent); } } @@ -151,16 +151,16 @@ protected void registerListeners() { ``` -Õâ¸ö·½·¨µÄÁ÷³Ì´óÖÂÈçÏ£º +这个方法的æµ�程大致如下: -1. Ìí¼Ó `AbstractApplicationContext#applicationListeners` ÖеļàÌýÆ÷µ½ `ApplicationEventMulticaster` ÖÐ -2. ´Ó `beanFactory` »ñÈ¡¼àÌýÆ÷µÄ `beanName`£¬Ìí¼Óµ½ `ApplicationEventMulticaster` ÖÐ -3. Èç¹ûÓÐÔçÆÚʼþ£¬¾Í½øÐй㲥 +1. 添加 `AbstractApplicationContext#applicationListeners` 中的监å�¬å™¨åˆ° `ApplicationEventMulticaster` 中 +2. 从 `beanFactory` 获å�–监å�¬å™¨çš„ `beanName`,添加到 `ApplicationEventMulticaster` 中 +3. 如果有早期事件,就进行广播 -¹ØÓÚ spring µÄʼþ£¬±¾ÎIJ¢²»´òËãÕ¹¿ª£¬Èç¹ûÏëÁ˽â¸ü¶à£¬¿É²Î¿¼ [spring Ì½ÃØÖ® spring ʼþ»úÖÆ](https://my.oschina.net/funcy/blog/4713339). +关于 spring 的事件,本文并ä¸�打算展开,如果想了解更多,å�¯å�‚考 [spring 探秘之 spring 事件机制](https://my.oschina.net/funcy/blog/4713339). -±¾ÎĵķÖÎö¾Íµ½ÕâÀïÁË¡£ +本文的分æž�就到这里了。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4892120](https://my.oschina.net/funcy/blog/4892120) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4892120](https://my.oschina.net/funcy/blog/4892120) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\214\205\347\232\204\346\211\253\346\217\217\346\265\201\347\250\213.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\214\205\347\232\204\346\211\253\346\217\217\346\265\201\347\250\213.md" index f7c7a4d..b1b73ce 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\214\205\347\232\204\346\211\253\346\217\217\346\265\201\347\250\213.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\270\211\357\274\211\357\274\232\345\214\205\347\232\204\346\211\253\346\217\217\346\265\201\347\250\213.md" @@ -1,44 +1,44 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-3ed1cf4bd6fc2ef3f569376093a6462987d.png) -ÔÚ [applicationContext µÄ´´½¨](https://my.oschina.net/funcy/blog/4608767)ÖУ¬ÎÒÃÇ·ÖÎöÁË `applicationContext` µÄ´´½¨¹ý³Ì£¬ÔÚ±¾ÎÄÖУ¬ÎÒÃǽ«·ÖÎö spring ÊÇÈçºÎ½øÐаüɨÃèµÄ¡£ +在 [applicationContext 的创建](https://my.oschina.net/funcy/blog/4608767)中,我们分æž�了 `applicationContext` 的创建过程,在本文中,我们将分æž� spring 是如何进行包扫æ��的。 -ÒÀ¾ÉÊÇ `AnnotationConfigApplicationContext` µÄ¹¹Ôì·½·¨£º +ä¾�旧是 `AnnotationConfigApplicationContext` 的构造方法: ``` public AnnotationConfigApplicationContext(String... basePackages) { this(); - //¶Ô´«ÈëµÄ°ü½øÐÐɨÃ裬ɨÃèÍê³Éºó£¬»áµÃµ½Ò»¸ö BeanDefinition µÄ¼¯ºÏ + //对传入的包进行扫æ��,扫æ��完æˆ�å�Žï¼Œä¼šå¾—到一个 BeanDefinition 的集å�ˆ scan(basePackages); refresh(); } ``` -Õâ´ÎÎÒÃǽ«Ä¿¹â·ÅÔÚ `scan(basePackages);` ÉÏ£¬½øÈë¸Ã·½·¨£º +这次我们将目光放在 `scan(basePackages);` 上,进入该方法: > AnnotationConfigApplicationContext#scan ``` public void scan(String... basePackages) { Assert.notEmpty(basePackages, "At least one base package must be specified"); - // ÕâÀïµÄscanner¶ÔÏó¾ÍÊÇÔÚthis()Öд´½¨µÄ + // 这里的scanner对象就是在this()中创建的 this.scanner.scan(basePackages); } ``` -Õâ¸ö·½·¨¹Ø¼ü´úÂëÊÇ `this.scanner.scan(basePackages);`£¬Õâ¸ö `scanner` ¾ÍÊÇÔÚ `this()` Öд´½¨µÄ¶ÔÏó£º +这个方法关键代ç �是 `this.scanner.scan(basePackages);`,这个 `scanner` 就是在 `this()` 中创建的对象: ``` public AnnotationConfigApplicationContext() { this.reader = new AnnotatedBeanDefinitionReader(this); - // scanner ¾ÍÊÇÔÚÕâÀï´´½¨µÄ + // scanner 就是在这里创建的 this.scanner = new ClassPathBeanDefinitionScanner(this); } ``` -¼ÌÐø×·×Ù£¬ÕâÀïÎÒÃǶԲ»ÖØÒªµÄ·½·¨½ö¸ø³öµ÷ÓÃÁ´£¬ÖØµã¹Ø×¢É¨Ãè°üµÄ¹ý³Ì£º +继续追踪,这里我们对ä¸�é‡�è¦�的方法仅给出调用链,é‡�点关注扫æ��包的过程: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -48,24 +48,24 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) ``` -`ClassPathBeanDefinitionScanner#doScan` ´úÂëÈçÏ£º +`ClassPathBeanDefinitionScanner#doScan` 代ç �如下: ``` protected Set doScan(String... basePackages) { Assert.notEmpty(basePackages, "At least one base package must be specified"); Set beanDefinitions = new LinkedHashSet<>(); - //±éÀúÐèҪɨÃèµÄ°ü·¾¶ + //é��历需è¦�扫æ��的包路径 for (String basePackage : basePackages) { - //»ñÈ¡ËùÓзûºÏÌõ¼þµÄBeanDefinition + //获å�–所有符å�ˆæ�¡ä»¶çš„BeanDefinition Set candidates = findCandidateComponents(basePackage); for (BeanDefinition candidate : candidates) { - //°ó¶¨BeanDefinitionÓëScope + //绑定BeanDefinition与Scope ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); candidate.setScope(scopeMetadata.getScopeName()); - //²é¿´ÊÇ·ñÅäÖÃÀàÊÇ·ñÖ¸¶¨beanµÄÃû³Æ£¬Èçûָ¶¨ÔòʹÓÃÀàÃûÊ××ÖĸСд + //查看是å�¦é…�置类是å�¦æŒ‡å®šbeançš„å��称,如没指定则使用类å��首字æ¯�å°�写 String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); - //ÏÂÃæÁ½¸öifÊÇ´¦Àílazy¡¢Autowire¡¢DependencyOn¡¢initMethod¡¢enforceInitMethod¡¢destroyMethod¡¢ - // enforceDestroyMethod¡¢Primary¡¢Role¡¢DescriptionÕâЩÂß¼­µÄ + //下é�¢ä¸¤ä¸ªif是处ç�†lazyã€�Autowireã€�DependencyOnã€�initMethodã€�enforceInitMethodã€�destroyMethodã€� + // enforceDestroyMethodã€�Primaryã€�Roleã€�Description这些逻辑的 if (candidate instanceof AbstractBeanDefinition) { postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName); } @@ -73,15 +73,15 @@ protected Set doScan(String... basePackages) { AnnotationConfigUtils.processCommonDefinitionAnnotations( (AnnotatedBeanDefinition) candidate); } - //¼ì²ébeanÊÇ·ñ´æÔÚ + //检查bean是å�¦å­˜åœ¨ if (checkCandidate(beanName, candidate)) { - //ÓÖ°ü×°ÁËÒ»²ã + //å�ˆåŒ…装了一层 BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName); - //¼ì²éscopeÊÇ·ñ´´½¨£¬Èçδ´´½¨Ôò½øÐд´½¨ + //检查scope是å�¦åˆ›å»ºï¼Œå¦‚未创建则进行创建 definitionHolder = AnnotationConfigUtils.applyScopedProxyMode( scopeMetadata, definitionHolder, this.registry); beanDefinitions.add(definitionHolder); - //×¢²á beanDefinition + //注册 beanDefinition registerBeanDefinition(definitionHolder, this.registry); } } @@ -91,19 +91,19 @@ protected Set doScan(String... basePackages) { ``` -Õâ¶Î´úÂëÍê³ÉµÄ¹¦ÄܺÜÃ÷ÁË£¬´óÌåÉÏ×öÁËÒÔϼ¸¼þÊ£º +这段代ç �完æˆ�的功能很明了,大体上å�šäº†ä»¥ä¸‹å‡ ä»¶äº‹ï¼š -1. ¸ù¾Ý°ü·¾¶£¬µÃµ½·ûºÏÌõ¼þµÄ BeanDefinition -2. ±éÀú BeanDefinition£¬½øÒ»²½·á¸» beanDefinition ÐÅÏ¢ -3. ½« BeanDefinition Ìí¼Óµ½ beanFactory +1. æ ¹æ�®åŒ…路径,得到符å�ˆæ�¡ä»¶çš„ BeanDefinition +2. é��历 BeanDefinition,进一步丰富 beanDefinition ä¿¡æ�¯ +3. å°† BeanDefinition 添加到 beanFactory -> BeanDefinition Ò²ÊÇ spring µÄÖØÒª×é¼þÖ®Ò»£¬¹ØÓÚ BeanDefinition µÄ·ÖÎö£¬¿É²Î¿¼ [spring ×é¼þÖ® BeanDefinition](https://my.oschina.net/funcy/blog/4597536 "spring×é¼þÖ®BeanDefinition")¡£ +> BeanDefinition 也是 spring çš„é‡�è¦�组件之一,关于 BeanDefinition 的分æž�,å�¯å�‚考 [spring 组件之 BeanDefinition](https://my.oschina.net/funcy/blog/4597536 "spring组件之BeanDefinition")。 -½ÓÏÂÀ´ÎÒÃÇÖ÷Òª·ÖÎöÕâÈý¸öµÄ²Ù×÷¡£ +接下æ�¥æˆ‘们主è¦�分æž�这三个的æ“�作。 -### 1\. ¸ù¾Ý°ü·¾¶µÃµ½ BeanDefinition +### 1\. æ ¹æ�®åŒ…路径得到 BeanDefinition -ÕâÒ»²½Ö÷Òª·¢ÉúÔÚ `Set candidates = findCandidateComponents(basePackage);`£¬ÎÒÃǸú½øÈ¥¿´¿´´úÂëµÄÖ´ÐУ¬ÕâÀïÒÀ¾É¶Ô²»ÖØÒª´úÂë¸ø³öµ÷ÓÃÁ´£¬¸Ã·½·¨µÄµ÷ÓÃÈçÏ£º +这一步主è¦�å�‘生在 `Set candidates = findCandidateComponents(basePackage);`,我们跟进去看看代ç �的执行,这里ä¾�旧对ä¸�é‡�è¦�代ç �给出调用链,该方法的调用如下: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -115,23 +115,23 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) ``` -×îÖÕµ÷Óõ½ÁË `ClassPathScanningCandidateComponentProvider#scanCandidateComponents`£¬´úÂëÈçÏ (ÓÐɾ¼õ)£º +最终调用到了 `ClassPathScanningCandidateComponentProvider#scanCandidateComponents`,代ç �如下 (有删å‡�): ``` private Set scanCandidateComponents(String basePackage) { Set candidates = new LinkedHashSet<>(); - //×éװɨÃè·¾¶£¨×é×°Íê³ÉºóÊÇÕâÖÖ¸ñʽ£ºclasspath*:org/springframework/learn/demo01/**/*.class£© + //组装扫æ��路径(组装完æˆ�å�Žæ˜¯è¿™ç§�æ ¼å¼�:classpath*:org/springframework/learn/demo01/**/*.class) String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + resolveBasePackage(basePackage) + '/' + this.resourcePattern; - //¸ù¾Ý·¾¶»ñÈ¡×ÊÔ´¶ÔÏ󣬼´É¨Ãè³ö¸Ã·¾¶ÏµĵÄËùÓÐclassÎļþ£¬µÃµ½ Resource + //æ ¹æ�®è·¯å¾„获å�–资æº�对象,å�³æ‰«æ��出该路径下的的所有class文件,得到 Resource Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath); for (Resource resource : resources) { if (resource.isReadable()) { - //¸ù¾Ý×ÊÔ´¶ÔÏó»ñÈ¡×ÊÔ´¶ÔÏóµÄMetadataReader + //æ ¹æ�®èµ„æº�对象获å�–资æº�对象的MetadataReader MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource); - // ÕâÀï×öÁËÁ½¼þÊ£º - // 1\. ÊÇ·ñÐèÒª³õʼ»¯Îªspring bean£¬¼´ÊÇ·ñÓÐ @Component¡¢@ServiceµÈ×¢½â - // 2\. ²é¿´ÅäÖÃÀàÊÇ·ñÓÐ@ConditionalһϵÁеÄ×¢½â£¬È»ºóÊÇ·ñÂú×ã×¢²áBeanµÄÌõ¼þ + // 这里å�šäº†ä¸¤ä»¶äº‹ï¼š + // 1\. 是å�¦éœ€è¦�åˆ�始化为spring bean,å�³æ˜¯å�¦æœ‰ @Componentã€�@Service等注解 + // 2\. 查看é…�置类是å�¦æœ‰@Conditional一系列的注解,然å�Žæ˜¯å�¦æ»¡è¶³æ³¨å†ŒBeançš„æ�¡ä»¶ if (isCandidateComponent(metadataReader)) { ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader); sbd.setResource(resource); @@ -147,17 +147,17 @@ private Set scanCandidateComponents(String basePackage) { ``` -¿ÉÒÔ¿´µ½£¬ÒÔÉÏ´úÂë×öÁËÈý¼þÊ£º +å�¯ä»¥çœ‹åˆ°ï¼Œä»¥ä¸Šä»£ç �å�šäº†ä¸‰ä»¶äº‹ï¼š -1. ¸ù¾Ý´«ÈëµÄ basePackage µÃµ½É¨Ãè·¾¶ -2. ¸ù¾ÝɨÃè·¾¶µÃµ½¸Ã·¾¶ÏµÄËùÓÐ class Îļþ¶ÔÓ¦µÄ Resource -3. ½« Resource ת»¯Îª beanDefinition +1. æ ¹æ�®ä¼ å…¥çš„ basePackage 得到扫æ��路径 +2. æ ¹æ�®æ‰«æ��路径得到该路径下的所有 class 文件对应的 Resource +3. å°† Resource 转化为 beanDefinition -½ÓÏÂÀ´ÎÒÃǾÍÒÔÉÏ´úÂë½øÐзÖÎö¡£ +接下æ�¥æˆ‘们就以上代ç �进行分æž�。 -#### 1.1 ¸ù¾Ý basePackage µÃµ½°üɨÃè·¾¶ +#### 1.1 æ ¹æ�® basePackage 得到包扫æ��路径 -ÕâÒ»²½Ã»É¶ºÃ·ÖÎö£¬¾ÍÊÇÒ»¸ö×Ö·û´®µÄÆ´½ÓÓëÌæ»»£¬½«´«ÈëµÄ `org.springframework.learn.demo01` ת»»Îª `classpath*:org/springframework/learn/demo01/**/*.class`£¬Ïà¹Ø´úÂë¾ÍÒ»ÐУº +这一步没啥好分æž�,就是一个字符串的拼接与替æ�¢ï¼Œå°†ä¼ å…¥çš„ `org.springframework.learn.demo01` 转æ�¢ä¸º `classpath*:org/springframework/learn/demo01/**/*.class`,相关代ç �就一行: ``` String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + @@ -165,16 +165,16 @@ String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + ``` -#### 1.2 ɨÃè°ü·¾¶ +#### 1.2 扫æ��包路径 -µÃµ½°üɨÃè·¾¶ºó£¬½ÓÏÂÀ´¾ÍÊǽøÐÐɨÃèÁË¡£spring ÔÚɨÃèʱ£¬»á°ÑɨÃè·¾¶ÏµÄËùÓÐ class ÎļþɨÃè³öÀ´£¬È»ºó·â×°³É `Resource`£¬´úÂëÈçÏ +得到包扫æ��路径å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ˜¯è¿›è¡Œæ‰«æ��了。spring 在扫æ��时,会把扫æ��路径下的所有 class 文件扫æ��出æ�¥ï¼Œç„¶å�Žå°�装æˆ� `Resource`,代ç �如下 ``` Resource[] resources = getResourcePatternResolver().getResources(packageSearchPath); ``` -¸ú½ø´úÂ룬ͬÑùµØ£¬ÎÒÃǶԲ»ÖØÒªµÄ·½·¨£¬ÒÀ¾ÉÖ»¸ø³ö·½·¨µ÷Ó㺠+跟进代ç �,å�Œæ ·åœ°ï¼Œæˆ‘们对ä¸�é‡�è¦�的方法,ä¾�æ—§å�ªç»™å‡ºæ–¹æ³•调用: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -190,18 +190,18 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) ``` -ÎÒÃǽ«´úÂë¾Û¼¯ÓÚ `PathMatchingResourcePatternResolver#findPathMatchingResources`: +我们将代ç �è�šé›†äºŽ `PathMatchingResourcePatternResolver#findPathMatchingResources`: ``` protected Resource[] findPathMatchingResources(String locationPattern) throws IOException { - // ´«ÈëµÄ locationPattern ÊÇ classpath*:org/springframework/learn/demo01/**/*.class - // rootDirPath ÊÇ classpath*:org/springframework/learn/demo01/ + // 传入的 locationPattern 是 classpath*:org/springframework/learn/demo01/**/*.class + // rootDirPath 是 classpath*:org/springframework/learn/demo01/ String rootDirPath = determineRootDir(locationPattern); - // subPattern ÊÇ **/*.class + // subPattern 是 **/*.class String subPattern = locationPattern.substring(rootDirPath.length()); - // ÕâÀï·µ»ØµÄ Resource ÊÇ rootDirPath µÄ¾ø¶Ô·¾¶(ÓÃurl±íʾ) + // 这里返回的 Resource 是 rootDirPath çš„ç»�对路径(用url表示) // URL [file:/xxx/spring-learn/build/classes/java/main/org/springframework/learn/demo01/] Resource[] rootDirResources = getResources(rootDirPath); @@ -216,16 +216,16 @@ protected Resource[] findPathMatchingResources(String locationPattern) throws IO } rootDirResource = new UrlResource(rootDirUrl); } - // ´¦Àí vfs ×ÊÔ´²éÕÒ + // 处ç�† vfs 资æº�查找 if (rootDirUrl.getProtocol().startsWith(ResourceUtils.URL_PROTOCOL_VFS)) { result.addAll(VfsResourceMatchingDelegate .findMatchingResources(rootDirUrl, subPattern, getPathMatcher())); } - // ´¦Àíjar°üÎļþ²éÕÒ + // 处ç�†jar包文件查找 else if (ResourceUtils.isJarURL(rootDirUrl) || isJarResource(rootDirResource)) { result.addAll(doFindPathMatchingJarResources(rootDirResource, rootDirUrl, subPattern)); } - // ´¦ÀíÎļþ·¾¶ÏµÄÎļþ²éÕÒ + // 处ç�†æ–‡ä»¶è·¯å¾„下的文件查找 else { result.addAll(doFindPathMatchingFileResources(rootDirResource, subPattern)); } @@ -235,12 +235,12 @@ protected Resource[] findPathMatchingResources(String locationPattern) throws IO ``` -ͨ¹ý·ÖÎö£¬·¢ÏÖ¸ÃÀàµÄ´¦Àí¹ý³ÌÈçÏ£º +通过分æž�,å�‘现该类的处ç�†è¿‡ç¨‹å¦‚下: -1. ͨ¹ý´«ÈëµÄ locationPattern µÃµ½¸Ã pattern Ï嵀 url ¾ø¶Ô·¾¶£¬·âװΪ Resource -2. ±éÀú·µ»ØµÄ·¾¶£¬²éÕÒ class Îļþ£¬·âװΪ Resource +1. 通过传入的 locationPattern 得到该 pattern 下的 url ç»�对路径,å°�装为 Resource +2. é��历返回的路径,查找 class 文件,å°�装为 Resource -ÎÒÃÇÀ´¿´¿´ spring ÊÇÈçºÎ½« pattrn ת»»Îª url ·¾¶µÄ£¬ÎÒÃǸú½ø´úÂ룺 +我们æ�¥çœ‹çœ‹ spring 是如何将 pattrn 转æ�¢ä¸º url 路径的,我们跟进代ç �: ``` |-PathMatchingResourcePatternResolver#getResources @@ -249,18 +249,18 @@ protected Resource[] findPathMatchingResources(String locationPattern) throws IO ``` -×îÖÕ´úÂëµ½ÁË `PathMatchingResourcePatternResolver#doFindAllClassPathResources`: +最终代ç �到了 `PathMatchingResourcePatternResolver#doFindAllClassPathResources`: ``` protected Set doFindAllClassPathResources(String path) throws IOException { Set result = new LinkedHashSet<>(16); ClassLoader cl = getClassLoader(); - // path¶ÔÓ¦µÄurl + // path对应的url Enumeration resourceUrls = (cl != null ? cl.getResources(path) : ClassLoader.getSystemResources(path)); while (resourceUrls.hasMoreElements()) { URL url = resourceUrls.nextElement(); - // ½«urlת»»ÎªResource£¬²¢Ìí¼Óµ½½á¹ûÖÐ + // å°†url转æ�¢ä¸ºResource,并添加到结果中 result.add(convertClassLoaderURL(url)); } if ("".equals(path)) { @@ -269,24 +269,24 @@ protected Set doFindAllClassPathResources(String path) throws IOExcept return result; } -// ½«urlת»»ÎªResource +// å°†url转æ�¢ä¸ºResource protected Resource convertClassLoaderURL(URL url) { return new UrlResource(url); } ``` -´Ëʱ´«ÈëµÄ `path` Ϊ `org/springframework/learn/demo01/`£¬´Ó´úÂë¿ÉÖª£¬×îÖÕµ÷ÓÃÁË java µÄ `ClassLoader` ·½·¨À´»ñÈ¡ path ¶ÔÓ¦µÄ url£¬È»ºó½« url ת»»Îª `Resource` Ìí¼Óµ½½á¹û¼¯Öв¢·µ»Ø¡£ +此时传入的 `path` 为 `org/springframework/learn/demo01/`,从代ç �å�¯çŸ¥ï¼Œæœ€ç»ˆè°ƒç”¨äº† java çš„ `ClassLoader` 方法æ�¥èŽ·å�– path 对应的 url,然å�Žå°† url 转æ�¢ä¸º `Resource` 添加到结果集中并返回。 -Äõ½ÀàµÄ¾ø¶Ô·¾¶Ö®ºó£¬½ÓϾÍÊǶÔ·¾¶½øÐбéÀú£¬Äõ½ class ÎļþÁË¡£ÈÃÎÒÃÇÔٻص½ `PathMatchingResourcePatternResolver#findPathMatchingResources`£¬spring ɨÃèʱ£¬»á¸ù¾Ý´«ÈëµÄ url ÀàÐÍ£¬¹²É¨Ãè 3 ¸öµØ·½£º +拿到类的ç»�对路径之å�Žï¼ŒæŽ¥ä¸‹å°±æ˜¯å¯¹è·¯å¾„进行é��历,拿到 class 文件了。让我们å†�回到 `PathMatchingResourcePatternResolver#findPathMatchingResources`,spring 扫æ��时,会根æ�®ä¼ å…¥çš„ url 类型,共扫æ�� 3 个地方: 1. vfs -2. jar °ü -3. Îļþ·¾¶ +2. jar 包 +3. 文件路径 -`vfs` ×¢ÊÍÉÏ˵ÊÇ "URL protocol for a general JBoss VFS resource"£¬¼´Í¨Óà JBoss VFS ×ÊÔ´µÄ URL ЭÒ飬ÕâÀï²»É¡£Èç¹ûÏîÄ¿ÖÐÒýÈëÁË jar °üÇÒÐèҪɨÃè jar ÖеÄ·¾¶£¬¾Í»áʹÓà jar °üɨÃ跽ʽ½øÐÐ class Îļþ²éÕÒ£¬ÓÉÓÚµ÷ÊÔʱ£¬`demo01` ÊÇʹÓÃÎļþ·½Ê½É¨ÃèµÄ£¬ÕâÀï¾ÍÖØµã·ÖÎöÎļþɨÃ跽ʽ£¬ÖÁÓÚ jar ÊÇÈçºÎɨÃèµÄ£¬ÓÐÐËȤµÄС»ï°é¿É×ÔÐÐÑо¿Ï¡£ +`vfs` 注释上说是 "URL protocol for a general JBoss VFS resource",å�³é€šç”¨ JBoss VFS 资æº�çš„ URL å��议,这里ä¸�深究。如果项目中引入了 jar 包且需è¦�扫æ�� jar 中的路径,就会使用 jar 包扫æ��æ–¹å¼�进行 class 文件查找,由于调试时,`demo01` 是使用文件方å¼�扫æ��的,这里就é‡�点分æž�文件扫æ��æ–¹å¼�,至于 jar 是如何扫æ��的,有兴趣的å°�伙伴å�¯è‡ªè¡Œç ”究下。 -ÎÒÃǸú½ø `findPathMatchingResources` ·½·¨£º +我们跟进 `findPathMatchingResources` 方法: ``` |-PathMatchingResourcePatternResolver#findPathMatchingResources @@ -298,7 +298,7 @@ protected Resource convertClassLoaderURL(URL url) { ``` protected Set doFindMatchingFileSystemResources(File rootDir, String subPattern) throws IOException { - // ÕâÀï½øÐÐÎļþ²éÕÒ + // 这里进行文件查找 Set matchingFiles = retrieveMatchingFiles(rootDir, subPattern); Set result = new LinkedHashSet<>(matchingFiles.size()); for (File file : matchingFiles) { @@ -309,9 +309,9 @@ protected Set doFindMatchingFileSystemResources(File rootDir, ``` -ÔÚ `PathMatchingResourcePatternResolver#doFindMatchingFileSystemResources` ÖУ¬spring ½«É¨Ãèµ½µÄ File ת»»Îª `FileSystemResource` ±£´æ£¬ÕâÊÇÎÒÃÇÓöµ½µÄµÚ¶þ¸ö `Resource` ÀàÐÍÁË (Ç°ÃæÎª `UrlResource`£¬ÕâÀïΪ `FileSystemResource`). +在 `PathMatchingResourcePatternResolver#doFindMatchingFileSystemResources` 中,spring 将扫æ��到的 File 转æ�¢ä¸º `FileSystemResource` ä¿�存,这是我们é�‡åˆ°çš„第二个 `Resource` 类型了 (å‰�é�¢ä¸º `UrlResource`,这里为 `FileSystemResource`). -½ÓÏÂÎÒÃÇÖØµã¹Ø×¢ `Set matchingFiles = retrieveMatchingFiles(rootDir, subPattern);`£¬¿´¿´ spring ÊÇÈçºÎÍê³ÉÎļþ²éÕҵģº +接下我们é‡�点关注 `Set matchingFiles = retrieveMatchingFiles(rootDir, subPattern);`,看看 spring 是如何完æˆ�文件查找的: ``` |-PathMatchingResourcePatternResolver#findPathMatchingResources @@ -331,11 +331,11 @@ protected void doRetrieveMatchingFiles(String fullPattern, File dir, Set r if (!content.canRead()) { } else { - // Èç¹ûÊÇÎļþ¼Ð£¬µÝ¹éµ÷Óà + // 如果是文件夹,递归调用 doRetrieveMatchingFiles(fullPattern, content, result); } } - // Èç¹ûÊÇÎļþÇÒÎļþ·¾¶ + // 如果是文件且文件路径 if (getPathMatcher().match(fullPattern, currPath)) { result.add(content); } @@ -344,36 +344,36 @@ protected void doRetrieveMatchingFiles(String fullPattern, File dir, Set r ``` -ÒÔÉÏ´úÂë±È½Ï¼òµ¥£¬ÓëÎÒÃÇÆ½³£±éÀúÎļþµÄ·½Ê½ÊÇÒ»ÑùµÄ¡£ +以上代ç �比较简å�•,与我们平常é��历文件的方å¼�是一样的。 -ÖµµÃÒ»ÌáµÄÊÇ£¬`getPathMatcher().match(fullPattern, currPath)` ×îÖÕµ÷Óõ½µÄÊÇ `AntPathMatcher#doMatch`£¬ÕâÊÇÒ»¸ö ant ·ç¸ñµÄ·¾¶Æ¥ÅäÑéÖ¤£¬¼´Â·¾¶ÖдøÓÐ `*`£¬Èç´«ÈëµÄ pattern ÊÇ `/xxx/spring-framework/spring-learn/build/classes/java/main/org/springframework/learn/demo01/**/*.class`£¬±íʾƥÅä `/xxx/spring-framework/spring-learn/build/classes/java/main/org/springframework/learn/demo01/` ¼°Æä×ÓÎļþ¼ÐÏÂËùÓÐÒÔ`.class` Îļþ½áβµÄÎļþ£¬µ±Ç°´«ÈëµÄ path ÊÇ `/xxx/spring-framework/spring-learn/build/classes/java/main/org/springframework/learn/demo01/BeanObj2.class`£¬ÏÔȻƥÅä¡£¹ØÓÚ `AntPathMatcher#doMatch` ·½·¨ÊÇÈçºÎ½øÐÐÆ¥ÅäµÄ£¬ÕâÀï¾Í²»½øÐÐÕ¹¿ªÁË¡£ +值得一æ��的是,`getPathMatcher().match(fullPattern, currPath)` 最终调用到的是 `AntPathMatcher#doMatch`,这是一个 ant 风格的路径匹é…�验è¯�,å�³è·¯å¾„中带有 `*`,如传入的 pattern 是 `/xxx/spring-framework/spring-learn/build/classes/java/main/org/springframework/learn/demo01/**/*.class`,表示匹é…� `/xxx/spring-framework/spring-learn/build/classes/java/main/org/springframework/learn/demo01/` å�Šå…¶å­�文件夹下所有以`.class` 文件结尾的文件,当å‰�传入的 path 是 `/xxx/spring-framework/spring-learn/build/classes/java/main/org/springframework/learn/demo01/BeanObj2.class`,显然匹é…�。关于 `AntPathMatcher#doMatch` 方法是如何进行匹é…�的,这里就ä¸�进行展开了。 -¾­¹ýÁËÒÔÉϲ½Ö裬ÎÒÃÇÖÕÓڵõ½ÁË class Îļþ¶ÔÓ¦µÄ Resource ÁË. +ç»�过了以上步骤,我们终于得到了 class 文件对应的 Resource 了. -#### 1.3 ½« Resource ת»¯Îª BeanDefinition +#### 1.3 å°† Resource 转化为 BeanDefinition -½« Resource ת»¯Îª BeanDefinition£¬´úÂëÊÇ +å°† Resource 转化为 BeanDefinition,代ç �是 > ClassPathScanningCandidateComponentProvider#scanCandidateComponents ``` -// ´Ó resource µÃµ½ MetadataReader +// 从 resource 得到 MetadataReader MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource); -// ÕâÀï×öÁËÁ½¼þÊ£º -// 1\. ÊÇ·ñÐèÒª³õʼ»¯Îªspring bean£¬¼´ÊÇ·ñÓÐ @Component¡¢@ServiceµÈ×¢½â -// 2\. ²é¿´ÅäÖÃÀàÊÇ·ñÓÐ@ConditionalһϵÁеÄ×¢½â£¬È»ºóÊÇ·ñÂú×ã×¢²áBeanµÄÌõ¼þ +// 这里å�šäº†ä¸¤ä»¶äº‹ï¼š +// 1\. 是å�¦éœ€è¦�åˆ�始化为spring bean,å�³æ˜¯å�¦æœ‰ @Componentã€�@Service等注解 +// 2\. 查看é…�置类是å�¦æœ‰@Conditional一系列的注解,然å�Žæ˜¯å�¦æ»¡è¶³æ³¨å†ŒBeançš„æ�¡ä»¶ if (isCandidateComponent(metadataReader)) { - // ½« metadataReader ת»»Îª ScannedGenericBeanDefinition£¬ÕâÒ²ÊÇBeanDefinition¼Ò×åÖеÄÒ»Ô± + // å°† metadataReader 转æ�¢ä¸º ScannedGenericBeanDefinition,这也是BeanDefinitionå®¶æ—�中的一员 ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader); ... } ``` -##### 1\. ´Ó Resource µÃµ½ MetadataReader +##### 1\. 从 Resource 得到 MetadataReader -ÎÒÃÇ×·×ÙÏ `MetadataReader` µÄ»ñÈ¡£º +我们追踪下 `MetadataReader` 的获å�–: ``` |-ClassPathScanningCandidateComponentProvider#scanCandidateComponents @@ -383,13 +383,13 @@ if (isCandidateComponent(metadataReader)) { ``` -´úÂë×îÖÕÔËÐе½ÁË `SimpleMetadataReader` µÄ¹¹Ôì·½·¨: +代ç �最终è¿�行到了 `SimpleMetadataReader` 的构造方法: ``` SimpleMetadataReader(Resource resource, @Nullable ClassLoader classLoader) throws IOException { SimpleAnnotationMetadataReadingVisitor visitor = new SimpleAnnotationMetadataReadingVisitor(classLoader); - // ÕâÀï·¢ÉúÁËclassÎļþµÄ¶ÁÈ¡Óë½âÎö + // 这里å�‘生了class文件的读å�–与解æž� getClassReader(resource).accept(visitor, PARSING_OPTIONS); this.resource = resource; this.annotationMetadata = visitor.getMetadata(); @@ -397,19 +397,19 @@ SimpleMetadataReader(Resource resource, @Nullable ClassLoader classLoader) throw ``` -ÔÙ½øÒ»²½×·×Ù£¬·¢ÏÖ class ÎļþµÄ¶ÁÈ¡Óë½âÎö·¢ÉúÔÚ `ClassReader` Àࣺ +å†�进一步追踪,å�‘现 class 文件的读å�–与解æž�å�‘生在 `ClassReader` 类: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-595687d3a766ffaacf69f31216a5b09f9d5.png) -Õâ¸öÀàʹÓà asm À´¶ÁÈ¡ class Îļþ£¬´úÂë±È½Ï¸´ÔÓ£¬¾Í²»ÉÁË¡£ +这个类使用 asm æ�¥è¯»å�– class 文件,代ç �比较å¤�æ�‚,就ä¸�深究了。 -Ò»Ö±ÒÔÀ´£¬ÎÒ¶¼ÒÔΪ spring ÊÇͨ¹ý·´ÉäÀ´»ñÈ¡ÀàÐÅÏ¢µÄ£¬µ½ÕâÀï²ÅÖªµÀ£¬**Ô­À´ spring ÊÇͨ¹ý asm Ö±½Ó¶ÁÈ¡ class ÎļþÀ´»ñÈ¡ÀàµÄÐÅÏ¢µÄ** ¡£ +一直以æ�¥ï¼Œæˆ‘都以为 spring 是通过å��å°„æ�¥èŽ·å�–类信æ�¯çš„,到这里æ‰�知é�“,**原æ�¥ spring 是通过 asm 直接读å�– class 文件æ�¥èŽ·å�–类的信æ�¯çš„** 。 -×îºóÎÒÃÇÀ´¿´Ïµõ½µÄ `MetadataReader` µÄ½á¹û£º +最å�Žæˆ‘们æ�¥çœ‹ä¸‹å¾—到的 `MetadataReader` 的结果: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-9df07587a3a8191231da87fe21d80052357.png) -ÕâÀïÖØµã¹Ø×¢ `annotations` ÊôÐÔ£¬ÀïÃæÓÐÒ»¸ö `annotations` ºÍ `mappings`£¬`annotations` ÄÚÈÝΪ `@Service`£¬`mappings` ÊÇÒ»¸öÊý×飬ÄÚÈÝΪ +这里é‡�点关注 `annotations` 属性,里é�¢æœ‰ä¸€ä¸ª `annotations` å’Œ `mappings`,`annotations` 内容为 `@Service`,`mappings` 是一个数组,内容为 ``` 0-@Service @@ -424,29 +424,29 @@ SimpleMetadataReader(Resource resource, @Nullable ClassLoader classLoader) throw ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-930a4e6844efd3f9f52c6d3f4e13a200337.png) -`annotations` ±¾È˲²âÊÇ `BeanObj1` ÉϵÄ×¢½â£º +`annotations` 本人猜测是 `BeanObj1` 上的注解: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-77271c438dde39f2bc905aa9f2cf9fb73d8.png) -ÖÁÓÚ `mappings` ÊÇɶ£¬ÎÒ²»ºÃ²Â²â£¬²»¹ýÒ²¿ÉÒÔ´Ó×¢½âÖз¢ÏÖһЩ¶ËÄߣº +至于 `mappings` 是啥,我ä¸�好猜测,ä¸�过也å�¯ä»¥ä»Žæ³¨è§£ä¸­å�‘现一些端倪: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-f31efb6252beb2108dc0ce93d482666f8d0.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a8ce5d11b4b02907f0ff497c6369a1c1dde.png) -`@Service` ÉÏÓÐ `@Component` ×¢½â£¬`@Component` ÉÏÓÐ `@Indexed`£¬¶øÕâÈýÕß¶¼³öÏÖÔÚÁË `mappings` ÖУ¬Õâ¿´×ÅÏñÊÇרÃÅÓÃÀ´±£´æÄÃ×¢½âÖ®ÉϵÄ×¢½âµÄ£¿²»¾À½áÕâ¸öÁË£¬ÔÝÇҾ͵±×÷ÊÇÕ⹦Äܰɣ¡**×¢Ò⣺`mappings` ÀïÃæµÄÄÚÈݺÜÖØÒª£¬ºóÃæ»áÓÃÀ´£¡** +`@Service` 上有 `@Component` 注解,`@Component` 上有 `@Indexed`,而这三者都出现在了 `mappings` 中,这看ç�€åƒ�是专门用æ�¥ä¿�存拿注解之上的注解的?ä¸�纠结这个了,暂且就当作是这功能å�§ï¼�**注æ„�:`mappings` 里é�¢çš„内容很é‡�è¦�,å�Žé�¢ä¼šç”¨æ�¥ï¼�** -##### 2. `isCandidateComponent(MetadataReader)`£ºÅжÏÊÇ·ñÐèҪʵÀý»¯Îª spring bean +##### 2. `isCandidateComponent(MetadataReader)`:判断是å�¦éœ€è¦�实例化为 spring bean -ÔÚÉÏÒ»²½ÖУ¬ÎÒÃǵõ½ÁË basePackage ÏÂ**ËùÓÐÀà**µÄ `MetadataReader` ÃèÊöÎļþ£¬×¢ÒâÕâÀïÊÇ**ËùÓÐÀà**£¬µ«ÕâЩÀàÊDz»ÊǶ¼Òª×ª³É `spring bean`£¬Íйܵ½ spring ÈÝÆ÷ÄØ£¿Õâ¾ÍÊÇ `isCandidateComponent(MetadataReader)` µÄ¹¦ÄÜÁË¡£·Ï»°ÉÙ˵£¬ÉÏ´úÂ룺 +在上一步中,我们得到了 basePackage 下**所有类**çš„ `MetadataReader` æ��述文件,注æ„�这里是**所有类**,但这些类是ä¸�是都è¦�转æˆ� `spring bean`,托管到 spring 容器呢?这就是 `isCandidateComponent(MetadataReader)` 的功能了。废è¯�少说,上代ç �: ``` protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOException { - // Ê¡ÂÔ²¿·Ö´úÂë + // çœ�略部分代ç � for (TypeFilter tf : this.includeFilters) { - // ÕâÀïÅжÏÊÇ·ñÐèÒªÍйܵ½springÈÝÆ÷ + // 这里判断是å�¦éœ€è¦�托管到spring容器 if (tf.match(metadataReader, getMetadataReaderFactory())) { - // ÅжÏÊÇ·ñÓÐ@ConditionalһϵÁеÄ×¢½â + // 判断是å�¦æœ‰@Conditional一系列的注解 return isConditionMatch(metadataReader); } } @@ -455,20 +455,20 @@ protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOE ``` -Õâ¶ÎÖ÷ÒªÊÇ×öÁËÁ½¸öÅжϣº +这段主è¦�是å�šäº†ä¸¤ä¸ªåˆ¤æ–­ï¼š -* ÊÇ·ñÐèҪΪ spring bean -* ÊÇ·ñÓÐ `@Conditional` µÈһϵÁеÄ×¢½â +* 是å�¦éœ€è¦�为 spring bean +* 是å�¦æœ‰ `@Conditional` 等一系列的注解 -ÕâÀïÎÒÃÇÏÈÀ´¿´µÚÒ»¸öÅжϡ£ +这里我们先æ�¥çœ‹ç¬¬ä¸€ä¸ªåˆ¤æ–­ã€‚ -ÔÚ spring ÖУ¬±êÃ÷ spring bean µÄ×¢½âÓкܶ࣬Ïñ `@Component`¡¢`@Repository`¡¢`@Service`¡¢`@Controller`¡¢`@Configuration`£¬ÉõÖÁÊÇÄã×Ô¼ºÐ´µÄ×¢½âÀֻ࣬ҪÉÏÃæ±êÁËÕâЩע½â£¬Ïñ +在 spring 中,标明 spring bean 的注解有很多,åƒ� `@Component`ã€�`@Repository`ã€�`@Service`ã€�`@Controller`ã€�`@Configuration`,甚至是你自己写的注解类,å�ªè¦�上é�¢æ ‡äº†è¿™äº›æ³¨è§£ï¼Œåƒ� ``` @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented -// Ìí¼Ó @Component »ò @Service »ò @Repository µÈÆäÖÐÖ®Ò» +// 添加 @Component 或 @Service 或 @Repository 等其中之一 @Component public @interface MySpringBean { ... @@ -476,7 +476,7 @@ public @interface MySpringBean { ``` -¶¼Äܱ» spring ʶ±ð¡£Èç¹ûÊÇ spring ÌṩµÄ×¢½â£¨`@Component`¡¢`@Repository` µÈ£©£¬ÔÚÅжÏÊDz»ÊÇ spring bean ʱ£¬Ö»ÐèÒª×öÀàËÆ +都能被 spring 识别。如果是 spring æ��供的注解(`@Component`ã€�`@Repository` 等),在判断是ä¸�是 spring bean 时,å�ªéœ€è¦�å�šç±»ä¼¼ ``` if(annotation == Component.class || annotation == Repository.class) { @@ -485,7 +485,7 @@ if(annotation == Component.class || annotation == Repository.class) { ``` -µÄÅжϾÍÐÐÁË¡£µ«¶ÔÓÚ×Ô¶¨ÒåµÄ×¢½â `@MySpringBean`£¬spring ÊÇÔõô֪µÀÕâÊÇ spring bean ÄØ£¿ÔÚÎÒÃǶ¨Òå `@MySpringBean` ʱ£¬Ò»¶¨ÒªÔÚÀàÉÏÌí¼Ó `@Component` »ò `@Service` »ò `@Repository` µÈÆäÖÐÖ®Ò»²ÅÄܱ» spring ʶ±ð£¬ÕâÆäÖÐÓÐʲôÐþ»úÄØ£¿ÎÒÃǸú½ø´úÂë `AbstractTypeHierarchyTraversingFilter#match(MetadataReader, MetadataReaderFactory)`£¬ÕâÀïÎÒÃǶԲ»ÖØÒªµÄ´úÂëÒÀ¾ÉÖ»¸ø³öµ÷ÓÃÁ´£º +的判断就行了。但对于自定义的注解 `@MySpringBean`,spring 是怎么知é�“这是 spring bean 呢?在我们定义 `@MySpringBean` 时,一定è¦�在类上添加 `@Component` 或 `@Service` 或 `@Repository` 等其中之一æ‰�能被 spring 识别,这其中有什么玄机呢?我们跟进代ç � `AbstractTypeHierarchyTraversingFilter#match(MetadataReader, MetadataReaderFactory)`,这里我们对ä¸�é‡�è¦�的代ç �ä¾�æ—§å�ªç»™å‡ºè°ƒç”¨é“¾ï¼š ``` |-ClassPathScanningCandidateComponentProvider#isCandidateComponent(MetadataReader) @@ -494,29 +494,29 @@ if(annotation == Component.class || annotation == Repository.class) { ``` -´úÂë×îÖÕµ½ÁË `AnnotationTypeFilter#matchSelf`: +代ç �最终到了 `AnnotationTypeFilter#matchSelf`: ``` @Override protected boolean matchSelf(MetadataReader metadataReader) { AnnotationMetadata metadata = metadataReader.getAnnotationMetadata(); - // ÕâÀïµÄannotationType¾ÍÊÇ @Component + // 这里的annotationType就是 @Component return metadata.hasAnnotation(this.annotationType.getName()) || (this.considerMetaAnnotations && metadata.hasMetaAnnotation(this.annotationType.getName())); } ``` -¹Ø¼ü¾ÍÔÚÕâÁË£º +关键就在这了: ``` metadata.hasAnnotation(this.annotationType.getName()) -Óë +与 this.considerMetaAnnotations && metadata.hasMetaAnnotation(this.annotationType.getName()) ``` -ÎÒÃÇÏÈ¿´ `metadata.hasAnnotation(this.annotationType.getName())` µÄ±È½Ï£º +我们先看 `metadata.hasAnnotation(this.annotationType.getName())` 的比较: ``` // AnnotationMetadata#hasAnnotation @@ -526,11 +526,11 @@ default boolean hasAnnotation(String annotationName) { ``` -ÕâÀïµÄ `getAnnotations()` µÃµ½µÄ½á¹ûÊÇ +这里的 `getAnnotations()` 得到的结果是 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-3e46b2ece5ddb2328342a469dc7dd554d9e.png) -mappings ÀïµÄÄÚÈÝÊÇ +mappings 里的内容是 ``` 0-@Service @@ -539,13 +539,13 @@ mappings ``` -ÕâÆäʵ¾ÍÊÇÎÒÃÇÇ°ÃæµÃµ½µÄ `MetadataReader` ÀïµÄÄÚÈÝ£¡ +这其实就是我们å‰�é�¢å¾—到的 `MetadataReader` 里的内容ï¼� -ÔÙ×·×ÙÏÂÈ¥£¬·¢ÏÖ `isDirectlyPresent` ¾ÍÊÇÅÐ¶Ï `annotations` Óë `mappings` ÀïÓÐûÓгöÏÖ `@Component`: +å†�追踪下去,å�‘现 `isDirectlyPresent` 就是判断 `annotations` 与 `mappings` 里有没有出现 `@Component`: ``` private boolean isPresent(Object requiredType, boolean directOnly) { - // ÅÐ¶Ï annotations ÀïÓÐûÓгöÏÖ @Component + // 判断 annotations 里有没有出现 @Component for (MergedAnnotation annotation : this.annotations) { Class type = annotation.getType(); if (type == requiredType || type.getName().equals(requiredType)) { @@ -553,7 +553,7 @@ private boolean isPresent(Object requiredType, boolean directOnly) { } } if (!directOnly) { - // ÅÐ¶Ï mappings ÀïÓÐûÓгöÏÖ @Component + // 判断 mappings 里有没有出现 @Component for (AnnotationTypeMappings mappings : this.mappings) { for (int i = 1; i < mappings.size(); i++) { AnnotationTypeMapping mapping = mappings.get(i); @@ -568,7 +568,7 @@ private boolean isPresent(Object requiredType, boolean directOnly) { ``` -½Ó×ÅÎÒÃÇÔÙÀ´¿´ `this.considerMetaAnnotations && metadata.hasMetaAnnotation(this.annotationType.getName())`£¬²é¿´µ÷Ó㺠+接ç�€æˆ‘们å†�æ�¥çœ‹ `this.considerMetaAnnotations && metadata.hasMetaAnnotation(this.annotationType.getName())`,查看调用: ``` |-AnnotationTypeFilter#matchSelf @@ -579,7 +579,7 @@ private boolean isPresent(Object requiredType, boolean directOnly) { ``` -×îÖյIJéÕÒ·½·¨ÔÚ `MergedAnnotationsCollection#find`: +最终的查找方法在 `MergedAnnotationsCollection#find`: ``` private MergedAnnotation find(Object requiredType, @@ -590,13 +590,13 @@ private MergedAnnotation find(Object requiredType, for (int i = 0; i < this.annotations.length; i++) { MergedAnnotation root = this.annotations[i]; AnnotationTypeMappings mappings = this.mappings[i]; - // mappings ±éÀú mappings + // mappings é��历 mappings for (int mappingIndex = 0; mappingIndex < mappings.size(); mappingIndex++) { AnnotationTypeMapping mapping = mappings.get(mappingIndex); if (!isMappingForType(mapping, requiredType)) { continue; } - // µ½ÕâÀ¾ÍÊÇÕÒµ½ÁË @Component ×¢½â + // 到这里,就是找到了 @Component 注解 MergedAnnotation candidate = (mappingIndex == 0 ? (MergedAnnotation) root : TypeMappedAnnotation.createIfPossible(mapping, root, IntrospectionFailureLogger.INFO)); @@ -613,11 +613,11 @@ private MergedAnnotation find(Object requiredType, ``` -¿ÉÒÔ¿´µ½£¬²éÕÒ·½Ê½¸úÉÏÃæµÄ `metadata.hasAnnotation(this.annotationType.getName())` ¸ß¶ÈÏàËÆ¡£ +å�¯ä»¥çœ‹åˆ°ï¼ŒæŸ¥æ‰¾æ–¹å¼�跟上é�¢çš„ `metadata.hasAnnotation(this.annotationType.getName())` 高度相似。 -ÒÔÉϾÍÊÇ spring ÓÃÀ´ÅжÏÊÇ·ñ°üº¬ `@Service`¡¢`@Component` µÈ×¢½âµÄÂß¼­ÁË¡£ +以上就是 spring 用æ�¥åˆ¤æ–­æ˜¯å�¦åŒ…å�« `@Service`ã€�`@Component` 等注解的逻辑了。 -ÔÚ `java` ÖУ¬×¢½âÊDz»Äܼ̳еģ¬Èç +在 `java` 中,注解是ä¸�能继承的,如 ``` @Target({ElementType.TYPE, ElementType.METHOD}) @@ -636,15 +636,15 @@ public @interface Child extends Base { ``` -ÒÔÉÏÓï·¨ÔÚ java Öв»±»ÔÊÐíµÄ£¬spring ¾ÍÊDzÉÓÃÕâ½âÎö`×¢½âµÄ×¢½â`µÄ·½Ê½£¬ÊµÏÖÁËÀàËÆÓڼ̳еŦÄÜ¡£ +以上语法在 java 中ä¸�被å…�许的,spring 就是采用这解æž�`注解的注解`的方å¼�,实现了类似于继承的功能。 -½Ó×ÅÎÒÃÇÔÙÀ´¿´ `ClassPathScanningCandidateComponentProvider#isConditionMatch` ·½·¨¡£Êµ¼ÊÉÏ£¬Õâ¸ö·½·¨ÊÇÓÃÀ´ÅжÏÀàÊÇ·ñº¬ÓÐ `@Conditional` ×¢½âµÄ£¬Âú×ãÌõ¼þÔò»áʶ±ðΪ spring bean£¬´úÂë×îÖÕµ÷Óõ½ÁË `ConditionEvaluator#shouldSkip(AnnotatedTypeMetadata, ConfigurationCondition.ConfigurationPhase)`: +接ç�€æˆ‘们å†�æ�¥çœ‹ `ClassPathScanningCandidateComponentProvider#isConditionMatch` 方法。实际上,这个方法是用æ�¥åˆ¤æ–­ç±»æ˜¯å�¦å�«æœ‰ `@Conditional` 注解的,满足æ�¡ä»¶åˆ™ä¼šè¯†åˆ«ä¸º spring bean,代ç �最终调用到了 `ConditionEvaluator#shouldSkip(AnnotatedTypeMetadata, ConfigurationCondition.ConfigurationPhase)`: ``` public boolean shouldSkip(@Nullable AnnotatedTypeMetadata metadata, @Nullable ConfigurationPhase phase) { - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � - // µÃµ½ condition ¶ÔÏó + // 得到 condition 对象 List conditions = new ArrayList<>(); for (String[] conditionClasses : getConditionClasses(metadata)) { for (String conditionClass : conditionClasses) { @@ -655,14 +655,14 @@ public boolean shouldSkip(@Nullable AnnotatedTypeMetadata metadata, @Nullable Co } AnnotationAwareOrderComparator.sort(conditions); - // ±éÀú£¬ÅÐ¶Ï condition Ìõ¼þÊÇ·ñ³ÉÁ¢ + // é��历,判断 condition æ�¡ä»¶æ˜¯å�¦æˆ�ç«‹ for (Condition condition : conditions) { ConfigurationPhase requiredPhase = null; if (condition instanceof ConfigurationCondition) { requiredPhase = ((ConfigurationCondition) condition).getConfigurationPhase(); } if ((requiredPhase == null || requiredPhase == phase) - // ÅÐ¶Ï condition Ìõ¼þÊÇ·ñ³ÉÁ¢£¬Ò»¸öÌõ¼þÂú×ã¾Í·µ»Øtrue + // 判断 condition æ�¡ä»¶æ˜¯å�¦æˆ�立,一个æ�¡ä»¶æ»¡è¶³å°±è¿”回true && !condition.matches(this.context, metadata)) { return true; } @@ -671,7 +671,7 @@ public boolean shouldSkip(@Nullable AnnotatedTypeMetadata metadata, @Nullable Co return false; } -// ͨ¹ý·´Éä»ñÈ¡ Condition ¶ÔÏó +// 通过å��射获å�– Condition 对象 private Condition getCondition(String conditionClassName, @Nullable ClassLoader classloader) { Class conditionClass = ClassUtils.resolveClassName(conditionClassName, classloader); return (Condition) BeanUtils.instantiateClass(conditionClass); @@ -679,14 +679,14 @@ private Condition getCondition(String conditionClassName, @Nullable ClassLoader ``` -ÕâÀï×öÁËÁ½¼þÊ£º +这里å�šäº†ä¸¤ä»¶äº‹ï¼š -1. »ñÈ¡ condition ¶ÔÏó -2. ±éÀú condition ¶ÔÏ󣬵÷Óà `condition.matches()` ·½·¨£¬ÅжÏÌõ¼þÊÇ·ñ³ÉÁ¢ +1. 获å�– condition 对象 +2. é��历 condition 对象,调用 `condition.matches()` 方法,判断æ�¡ä»¶æ˜¯å�¦æˆ�ç«‹ -##### 3\. ´Ó `MetadataReader` µÃµ½ `ScannedGenericBeanDefinition` +##### 3\. 从 `MetadataReader` 得到 `ScannedGenericBeanDefinition` -ÕâÀï½öÊÇ×öÁËÒ»¸ö¼òµ¥µÄ¸³Öµ£¬¿´Ï `ScannedGenericBeanDefinition` µÄ¹¹Ôì·½·¨¾ÍÃ÷°×ÁË£º +这里仅是å�šäº†ä¸€ä¸ªç®€å�•的赋值,看下 `ScannedGenericBeanDefinition` 的构造方法就明白了: > ScannedGenericBeanDefinition#ScannedGenericBeanDefinition @@ -699,11 +699,11 @@ public ScannedGenericBeanDefinition(MetadataReader metadataReader) { ``` -´úÂë±È½Ï¼òµ¥£¬¾Í²»¶à×ö·ÖÎöÁË¡£ +代ç �比较简å�•,就ä¸�多å�šåˆ†æž�了。 -### 2\. ·á¸» beanDefinition ÐÅÏ¢ +### 2\. 丰富 beanDefinition ä¿¡æ�¯ -Àú¾­Ç§ÄÑÍòÏÕ£¬ÖÕÓڵõ½ÁË `beanDefinition`£¬µ«´Ëʱ `beanDefinition` ²¢²»·á¸»£¬½ÓÏÂÀ´¾ÍÊǽøÒ»²½À©Õ¹ `beanDefinition` µÄÐÅÏ¢ÁË¡£ÕâЩÐÅÏ¢°üÀ¨ `beanµÄÃû³Æ`¡¢`beanµÄ×÷ÓÃÓò`¡¢`@Lazy` ×¢½â¡¢`@Primary` ×¢½â¡¢`@DependsOn` ×¢½âµÈ£¬´úÂëÈçÏ£º +历ç»�å�ƒéš¾ä¸‡é™©ï¼Œç»ˆäºŽå¾—到了 `beanDefinition`,但此时 `beanDefinition` å¹¶ä¸�丰富,接下æ�¥å°±æ˜¯è¿›ä¸€æ­¥æ‰©å±• `beanDefinition` 的信æ�¯äº†ã€‚这些信æ�¯åŒ…括 `beançš„å��ç§°`ã€�`bean的作用域`ã€�`@Lazy` 注解ã€�`@Primary` 注解ã€�`@DependsOn` 注解等,代ç �如下: ``` public abstract class AnnotationConfigUtils { @@ -711,11 +711,11 @@ public abstract class AnnotationConfigUtils { ... /** - * ½øÒ»²½·á¸» BeanDefinition + * 进一步丰富 BeanDefinition */ static void processCommonDefinitionAnnotations(AnnotatedBeanDefinition abd, AnnotatedTypeMetadata metadata) { - // ´¦Àí @Lazy + // 处ç�† @Lazy AnnotationAttributes lazy = attributesFor(metadata, Lazy.class); if (lazy != null) { abd.setLazyInit(lazy.getBoolean("value")); @@ -726,21 +726,21 @@ public abstract class AnnotationConfigUtils { abd.setLazyInit(lazy.getBoolean("value")); } } - // ´¦Àí @Primary + // 处ç�† @Primary if (metadata.isAnnotated(Primary.class.getName())) { abd.setPrimary(true); } - // ´¦Àí @DependsOn + // 处ç�† @DependsOn AnnotationAttributes dependsOn = attributesFor(metadata, DependsOn.class); if (dependsOn != null) { abd.setDependsOn(dependsOn.getStringArray("value")); } - // ´¦Àí @Role + // 处ç�† @Role AnnotationAttributes role = attributesFor(metadata, Role.class); if (role != null) { abd.setRole(role.getNumber("value").intValue()); } - // ´¦Àí @Description + // 处ç�† @Description AnnotationAttributes description = attributesFor(metadata, Description.class); if (description != null) { abd.setDescription(description.getString("value")); @@ -750,9 +750,9 @@ public abstract class AnnotationConfigUtils { ``` -### 3.` registerBeanDefinition(definitionHolder, this.registry)`: Ìí¼Ó BeanDefinition µ½ beanFactory +### 3.` registerBeanDefinition(definitionHolder, this.registry)`: 添加 BeanDefinition 到 beanFactory -½« `BeanDefinition` µ½ `beanFactory` µÄ²Ù×÷±È½Ï¼òµ¥£¬¹Ø¼üµÄ´úÂëÈçÏ£º +å°† `BeanDefinition` 到 `beanFactory` çš„æ“�作比较简å�•,关键的代ç �如下: ``` |-ClassPathBeanDefinitionScanner#registerBeanDefinition @@ -769,32 +769,32 @@ this.beanDefinitionMap.put(beanName, beanDefinition); ``` -´Ó `ClassPathBeanDefinitionScanner#registerBeanDefinition` µ½ `DefaultListableBeanFactory#registerBeanDefinition`£¬ÕâÆäÖÐËäÈ»¾­ÀúÁËһЩÍäÍäÈÆÈÆ£¬µ«ÒÀ¾É²»·Á°­ÎÒÃÇÕÒµ½¹Ø¼üµÄ´úÂë¡£ +从 `ClassPathBeanDefinitionScanner#registerBeanDefinition` 到 `DefaultListableBeanFactory#registerBeanDefinition`,这其中虽然ç»�历了一些弯弯绕绕,但ä¾�æ—§ä¸�妨ç¢�我们找到关键的代ç �。 -µ½´Ë£¬´ÅÅÌÉ쵀 class Îļþ£¬¾­¹ý spring ɨÃ裬ÖÕÓÚ±ä³ÉÁË `BeanDefinition`£¬±£´æÔÚ `BeanFactory` ÖÐÁË¡£ +到此,ç£�盘上的 class 文件,ç»�过 spring 扫æ��,终于å�˜æˆ�了 `BeanDefinition`,ä¿�存在 `BeanFactory` 中了。 -### 4\. ×ܽá +### 4\. 总结 -±¾ÎıȽϳ¤£¬Ö÷Òª·ÖÎöÁË spring ɨÃè°ü·¾¶µÃµ½ `beanDefinition` µÄ¹ý³Ì£¬Ö÷ÒªÁ÷³ÌÈçÏ£º +本文比较长,主è¦�分æž�了 spring 扫æ��包路径得到 `beanDefinition` 的过程,主è¦�æµ�程如下: -1. ¸ù¾Ý°üÃûµÃµ½Â·¾¶ `Resource`£» -2. ¸ù¾Ý·¾¶ `Resouce` µÃµ½¸Ã·¾¶ÏÂËùÓÐ class ÎļþµÄ `Resouce`£» -3. ¸ù¾Ý class ÎļþµÄ `Resouce` ͨ¹ý asm ½âÎöµÃµ½ `MetadataReader`£¬×¢Ò⣺ÕâÀïµÄ `MetadataReader` »¹ÊÇËùÓÐ class ÎļþµÄ `MetadataReader`£» -4. ´Ó `MetadataReader` ÖÐÕÒµ½ÐèÒª spring ÍÐ¹ÜµÄ `MetadataReader`£¬½«Æäת»¯Îª `ScannedGenericBeanDefinition`£¬`ScannedGenericBeanDefinition` Ϊ `BeanDefinition` µÄ×ÓÀࣻ -5. ½øÒ»²½·á¸» `ScannedGenericBeanDefinition` µÄÐÅÏ¢£» -6. ½«ÉÏÃæµÃµ½µÄ `BeanDefinition` Ìí¼Óµ½ `BeanFactory` ÖÐ +1. æ ¹æ�®åŒ…å��得到路径 `Resource`ï¼› +2. æ ¹æ�®è·¯å¾„ `Resouce` 得到该路径下所有 class 文件的 `Resouce`ï¼› +3. æ ¹æ�® class 文件的 `Resouce` 通过 asm è§£æž�得到 `MetadataReader`,注æ„�:这里的 `MetadataReader` 还是所有 class 文件的 `MetadataReader`ï¼› +4. 从 `MetadataReader` 中找到需è¦� spring 托管的 `MetadataReader`,将其转化为 `ScannedGenericBeanDefinition`,`ScannedGenericBeanDefinition` 为 `BeanDefinition` çš„å­�类; +5. 进一步丰富 `ScannedGenericBeanDefinition` 的信æ�¯ï¼› +6. 将上é�¢å¾—到的 `BeanDefinition` 添加到 `BeanFactory` 中 -ÖÁ´Ë£¬°üÃûת»»Îª `BeanDefinition` Íê³É¡£ +至此,包å��转æ�¢ä¸º `BeanDefinition` 完æˆ�。 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-f8ff2e4071ba3941e2a0664f6e478b78961.png) -±¾ÎÄ»¹ÓÐÁ½¸öÖµµÃ×¢ÒâµÄµØ·½£º +本文还有两个值得注æ„�的地方: -1. spring ÔÚ»ñÈ¡ÀàÉϵÄ×¢½âʱ£¬²»ÊÇͨ¹ý·´É䣬¶øÊÇʹÓà asm Ö±½Ó½âÎö class Îļþ£¬È»ºóÔÙ»ñÈ¡ÀàÉϵÄ×¢½âµÄ -2. ÔÚ´¦Àí×¢½âʱ£¬spring ͨ¹ý½âÎö ¡°×¢½âµÄ×¢½â¡± ʵÏÖÁËÒ»Ì×ÀàËÆÓÚ×¢½â¼Ì³ÐµÄ·½Ê½£¬ÕâÒ²ÊÇ spring ÄÜʶ±ð `@Component`¡¢`@Service` ÉõÖÁÊÇ¿ª·¢Õß×Ô¶¨Òå×¢½âµÄÔ­Òò¡£ +1. spring 在获å�–类上的注解时,ä¸�是通过å��射,而是使用 asm 直接解æž� class 文件,然å�Žå†�获å�–类上的注解的 +2. 在处ç�†æ³¨è§£æ—¶ï¼Œspring 通过解æž� “注解的注解â€� 实现了一套类似于注解继承的方å¼�,这也是 spring 能识别 `@Component`ã€�`@Service` 甚至是开å�‘者自定义注解的原因。 -µÃµ½ÁË `BeanDefinition` ºó£¬½ÓמÍÊÇ spring ÈÝÆ÷µÄ³õʼ»¯ÁË£¬ÎÒÃÇÏÂÆªÎÄÕÂÔÙ¼û¡£ +得到了 `BeanDefinition` å�Žï¼ŒæŽ¥ç�€å°±æ˜¯ spring 容器的åˆ�始化了,我们下篇文章å†�è§�。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4614071](https://my.oschina.net/funcy/blog/4614071) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4614071](https://my.oschina.net/funcy/blog/4614071) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\271\235\357\274\211\357\274\232\345\215\225\344\276\213bean\347\232\204\345\210\233\345\273\272.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\271\235\357\274\211\357\274\232\345\215\225\344\276\213bean\347\232\204\345\210\233\345\273\272.md" index 9690e98..15f6285 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\271\235\357\274\211\357\274\232\345\215\225\344\276\213bean\347\232\204\345\210\233\345\273\272.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\271\235\357\274\211\357\274\232\345\215\225\344\276\213bean\347\232\204\345\210\233\345\273\272.md" @@ -1,8 +1,8 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1f1ac8f3d8241fad9693d9684048ab7f3ae.png) -½ÓÉÏÎÄ£¬±¾ÎÄÒÀ¾ÉÊÇ·ÖÎö `finishBeanFactoryInitialization(beanFactory)`£¬±¾ÎĽ«Öصã·ÖÎöµ¥Àý bean µÄ´´½¨Á÷³Ì¡£ +接上文,本文ä¾�旧是分æž� `finishBeanFactoryInitialization(beanFactory)`,本文将é‡�点分æž�å�•例 bean 的创建æµ�程。 -ÔÚÉÏһƪÎÄÕÂÖУ¬ÎÒÃǽéÉÜÁË `AbstractApplicationContext#finishBeanFactoryInitialization` µÄÖ´Ðйý³Ì£¬±¾ÎĽ«ÉîÈëϸ½Ú£¬·ÖÎö spring bean µÄ´´½¨¹ý³Ì¡£ +在上一篇文章中,我们介ç»�了 `AbstractApplicationContext#finishBeanFactoryInitialization` 的执行过程,本文将深入细节,分æž� spring bean 的创建过程。 ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -15,7 +15,7 @@ ``` -ÎÒÃÇÖ±½Ó¿´ `AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])`£¬¾«¼òºóµÄ´úÂëÈçÏ£º +我们直接看 `AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])`,精简å�Žçš„代ç �如下: ``` @Override @@ -24,14 +24,14 @@ protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable O RootBeanDefinition mbdToUse = mbd; - // È·±£ BeanDefinition ÖÐµÄ Class ±»¼ÓÔØ + // ç¡®ä¿� BeanDefinition 中的 Class 被加载 Class resolvedClass = resolveBeanClass(mbd, beanName); if (resolvedClass != null && !mbd.hasBeanClass() && mbd.getBeanClassName() != null) { mbdToUse = new RootBeanDefinition(mbd); mbdToUse.setBeanClass(resolvedClass); } - // ×¼±¸·½·¨¸²Ð´£¬Èç¹ûbeanÖж¨ÒåÁË ºÍ + // 准备方法覆写,如果bean中定义了 å’Œ try { mbdToUse.prepareMethodOverrides(); } @@ -40,7 +40,7 @@ protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable O } try { - // Èç¹ûÓдúÀíµÄ»°Ö±½Ó·µ»Ø + // 如果有代ç�†çš„è¯�直接返回 Object bean = resolveBeforeInstantiation(beanName, mbdToUse); if (bean != null) { return bean; @@ -51,7 +51,7 @@ protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable O } try { - // ´´½¨ bean + // 创建 bean Object beanInstance = doCreateBean(beanName, mbdToUse, args); return beanInstance; } @@ -65,14 +65,14 @@ protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable O ``` -¿ÉÒÔ¿´µ½£¬¸Ã·½·¨×öÁËËļþÊ£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¯¥æ–¹æ³•å�šäº†å››ä»¶äº‹ï¼š -1. È·±£ class ±»¼ÓÔØ -2. ¸²Ð´·½·¨ -3. ²éÕÒ´úÀí¶ÔÏó£¬ÈôÓÐÔò·µ»Ø -4. ´´½¨ spring bean +1. ç¡®ä¿� class 被加载 +2. 覆写方法 +3. 查找代ç�†å¯¹è±¡ï¼Œè‹¥æœ‰åˆ™è¿”回 +4. 创建 spring bean -¶ÔÓÚÇ°ÃæÈý¸ö²Ù×÷£¬±¾ÎIJ»¹Ø×¢£¬ÎÒÃǽö¿´µÚËĸö²Ù×÷¡£½øÈë `AbstractAutowireCapableBeanFactory#doCreateBean`: +对于å‰�é�¢ä¸‰ä¸ªæ“�作,本文ä¸�关注,我们仅看第四个æ“�作。进入 `AbstractAutowireCapableBeanFactory#doCreateBean`: ``` protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, @@ -80,16 +80,16 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb BeanWrapper instanceWrapper = null; if (mbd.isSingleton()) { - //Èç¹ûÊÇ factoryBeanÔò´Ó»º´æÉ¾³ý + //如果是 factoryBean则从缓存删除 instanceWrapper = this.factoryBeanInstanceCache.remove(beanName); } if (instanceWrapper == null) { - // ʵÀý»¯ Bean£¬Õâ¸ö·½·¨ÀïÃæ²ÅÊÇÖÕµã + // 实例化 Bean,这个方法里é�¢æ‰�是终点 instanceWrapper = createBeanInstance(beanName, mbd, args); } - //beanʵÀý + //bean实例 final Object bean = instanceWrapper.getWrappedInstance(); - //beanÀàÐÍ + //bean类型 Class beanType = instanceWrapper.getWrappedClass(); if (beanType != NullBean.class) { mbd.resolvedTargetType = beanType; @@ -98,11 +98,11 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb synchronized (mbd.postProcessingLock) { if (!mbd.postProcessed) { try { - // Ñ­»·µ÷ÓÃMergedBeanDefinitionPostProcessorµÄpostProcessMergedBeanDefinition·½·¨¡£ÀýÈ磬 - // 1\. µ÷Óà AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition ΪÁËÕÒµ½ - // ´øÓÐ@Autowired¡¢@Value ×¢½âµÄÊôÐԺͷ½·¨ - // 2\. µ÷Óà CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition ΪÁËÕÒµ½ - // ´øÓÐ@Resource ×¢½âµÄÊôÐԺͷ½·¨ + // 循环调用MergedBeanDefinitionPostProcessorçš„postProcessMergedBeanDefinition方法。例如, + // 1\. 调用 AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition 为了找到 + // 带有@Autowiredã€�@Value 注解的属性和方法 + // 2\. 调用 CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition 为了找到 + // 带有@Resource 注解的属性和方法 applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName); } catch (Throwable ex) { @@ -112,33 +112,33 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb } } - // ½â¾öÑ­»·ÒÀÀµÎÊÌâ, ÊÇ·ñÔÊÐíÑ­»·ÒÀÀµ, allowCircularReferencesĬÈÏΪtrue£¬¿ÉÒÔ¹Ø±Õ + // 解决循环ä¾�赖问题, 是å�¦å…�许循环ä¾�èµ–, allowCircularReferences默认为true,å�¯ä»¥å…³é—­ boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences && isSingletonCurrentlyInCreation(beanName)); if (earlySingletonExposure) { - // Ñ­»·ÒÀÀµµÄ½â¾ö£¬ºóÃæ»áµ¥¶À·ÖÎö + // 循环ä¾�赖的解决,å�Žé�¢ä¼šå�•独分æž� ... } Object exposedObject = bean; try { - // ¸ºÔðÊôÐÔ×°Åä, Ò²¾ÍÊÇÎÒÃdz£³£ËµµÄ×Ô¶¯×¢È룬ºÜÖØÒª + // 负责属性装é…�, 也就是我们常常说的自动注入,很é‡�è¦� populateBean(beanName, mbd, instanceWrapper); - // ÕâÀïÊÇ´¦Àíbean³õʼ»¯Íê³ÉºóµÄ¸÷Öֻص÷£¬ - // ÀýÈçinit-method¡¢InitializingBean ½Ó¿Ú¡¢BeanPostProcessor ½Ó¿Ú + // 这里是处ç�†beanåˆ�始化完æˆ�å�Žçš„å�„ç§�回调, + // 例如init-methodã€�InitializingBean 接å�£ã€�BeanPostProcessor 接å�£ exposedObject = initializeBean(beanName, exposedObject, mbd); } catch (Throwable ex) { ... } - //ͬÑùµÄ£¬Èç¹û´æÔÚÑ­»·ÒÀÀµ + //å�Œæ ·çš„,如果存在循环ä¾�èµ– if (earlySingletonExposure) { - // Ñ­»·ÒÀÀµµÄ½â¾ö£¬ºóÃæ»áµ¥¶À·ÖÎö + // 循环ä¾�赖的解决,å�Žé�¢ä¼šå�•独分æž� ... } - // °Ñbean×¢²áµ½ÏàÓ¦µÄScopeÖÐ + // 把bean注册到相应的Scope中 try { registerDisposableBeanIfNecessary(beanName, bean, mbd); } @@ -151,46 +151,46 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` -¿ÉÒÔ¿´µ½£¬spring ÔÚ´´½¨ bean ʱ£¬Ö÷Òª×öÁËÈçÏÂÈý¼þÊ£º +å�¯ä»¥çœ‹åˆ°ï¼Œspring 在创建 bean 时,主è¦�å�šäº†å¦‚下三件事: -1. ´´½¨ÊµÀý -2. ²éÕÒÊôÐÔ -3. ×¢ÈëÊôÐÔ -4. ³õʼ»¯ bean +1. 创建实例 +2. 查找属性 +3. 注入属性 +4. åˆ�始化 bean -½ÓÏÂÀ´£¬ÔÛÃǾÍÖ÷Òª·ÖÎöÕâËĸö²½Öè¡£ +接下æ�¥ï¼Œå’±ä»¬å°±ä¸»è¦�分æž�这四个步骤。 -#### 1\. ´´½¨ÊµÀý +#### 1\. 创建实例 -spring ´´½¨ÊµÀýµÄ·½·¨ÊÇ `AbstractAutowireCapableBeanFactory#createBeanInstance`£¬ÄÚÈÝÈçÏ£º +spring 创建实例的方法是 `AbstractAutowireCapableBeanFactory#createBeanInstance`,内容如下: ``` protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) { - // È·±£ÒѾ­¼ÓÔØÁË´Ë class + // ç¡®ä¿�å·²ç»�加载了此 class Class beanClass = resolveBeanClass(mbd, beanName); - // УÑéÀàµÄ·ÃÎÊȨÏÞ + // 校验类的访问æ�ƒé™� if (beanClass != null && !Modifier.isPublic(beanClass.getModifiers()) && !mbd.isNonPublicAccessAllowed()) { throw new BeanCreationException(...); } - // ÊÇ·ñÉèÖÃÁËbean´´½¨µÄSupplier£¬SupplierÊÇjava8ÌṩµÄÀ࣬¿ÉÒÔ´«ÈëÒ»¸ölambda±í´ïʽ - // µ÷Óà AbstractBeanDefinition#setInstanceSupplier Ö¸¶¨ + // 是å�¦è®¾ç½®äº†bean创建的Supplier,Supplier是java8æ��供的类,å�¯ä»¥ä¼ å…¥ä¸€ä¸ªlambda表达å¼� + // 调用 AbstractBeanDefinition#setInstanceSupplier 指定 Supplier instanceSupplier = mbd.getInstanceSupplier(); if (instanceSupplier != null) { return obtainFromSupplier(instanceSupplier, beanName); } if (mbd.getFactoryMethodName() != null) { - // ²ÉÓù¤³§·½·¨ÊµÀý»¯ + // 采用工厂方法实例化 return instantiateUsingFactoryMethod(beanName, mbd, args); } - // ÊÇ·ñµÚÒ»´Î + // 是å�¦ç¬¬ä¸€æ¬¡ boolean resolved = false; - // ÊÇ·ñ²ÉÓù¹Ô캯Êý×¢Èë + // 是å�¦é‡‡ç”¨æž„造函数注入 boolean autowireNecessary = false; if (args == null) { synchronized (mbd.constructorArgumentLock) { @@ -205,13 +205,13 @@ protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd return autowireConstructor(beanName, mbd, null, null); } else { - // Î޲ι¹Ô캯Êý + // æ— å�‚构造函数 return instantiateBean(beanName, mbd); } } // Candidate constructors for autowiring? - // ÅжÏÊÇ·ñ²ÉÓÃÓвι¹Ô캯Êý + // 判断是å�¦é‡‡ç”¨æœ‰å�‚构造函数 Constructor[] ctors = determineConstructorsFromBeanPostProcessors(beanClass, beanName); if (ctors != null || mbd.getResolvedAutowireMode() == AUTOWIRE_CONSTRUCTOR || mbd.hasConstructorArgumentValues() || !ObjectUtils.isEmpty(args)) { @@ -220,24 +220,24 @@ protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd ctors = mbd.getPreferredConstructors(); if (ctors != null) { - // ¹¹Ô캯ÊýÒÀÀµ×¢Èë + // 构造函数ä¾�赖注入 return autowireConstructor(beanName, mbd, ctors, null); } - // µ÷ÓÃÎ޲ι¹Ô캯Êý + // 调用无å�‚构造函数 return instantiateBean(beanName, mbd); } ``` -´ÓÒÔÉÏ´úÂëÀ´¿´£¬spring ÔÚʵÀý»¯ bean ʱ£¬ÓÐ 4 ÖÖ·½Ê½£º +从以上代ç �æ�¥çœ‹ï¼Œspring 在实例化 bean 时,有 4 ç§�æ–¹å¼�: -1. ʹÓÃʵÀý»¯·½·¨£ºobtainFromSupplier -2. ʹÓù¤³§·½·¨£ºinstantiateUsingFactoryMethod -3. ʹÓÃÓвι¹Ô죺autowireConstructor -4. ʹÓÃÎ޲ι¹Ô죺instantiateBean +1. 使用实例化方法:obtainFromSupplier +2. 使用工厂方法:instantiateUsingFactoryMethod +3. 使用有å�‚构造:autowireConstructor +4. 使用无å�‚构造:instantiateBean -¶ÔÓÚÇ°ÃæÁ½¸ö·½·¨£¬ÕâÊÇ¿ª·¢ÕßÖ¸¶¨µÄ·½·¨£¬Ã»É¶ºÃ˵µÄ£¬ºóÃæÁ½¸ö·½·¨ÊÇ spring ¸ù¾ÝÀàµÄʵ¼ÊÇé¿öÀ´Ñ¡Ôñ¹¹Ôì·½·¨½øÐÐʵÀý»¯µÄ¡£¶ÔÓÚÒ»¸ö bean À´Ëµ£¬Èç¹ûδÌṩÈκι¹Ôì·½·¨»òÌṩÁËÎ޲ι¹Ôì·½·¨£¬Ôòµ÷Óà `AbstractAutowireCapableBeanFactory#instantiateBean` À´½øÐÐʵÀý»¯£¬·ñÔòµ÷Óà `AbstractAutowireCapableBeanFactory#autowireConstructor` ½øÐÐʵÀý»¯¡£Êµ¼ÊÉÏ£¬ÕâÁ½¸ö·½·¨×îÖÕ¶¼»áÖ´Ðе½ `BeanUtils#instantiateClass(Constructor, Object...)`: +对于å‰�é�¢ä¸¤ä¸ªæ–¹æ³•,这是开å�‘者指定的方法,没啥好说的,å�Žé�¢ä¸¤ä¸ªæ–¹æ³•是 spring æ ¹æ�®ç±»çš„实际情况æ�¥é€‰æ‹©æž„造方法进行实例化的。对于一个 bean æ�¥è¯´ï¼Œå¦‚果未æ��供任何构造方法或æ��供了无å�‚构造方法,则调用 `AbstractAutowireCapableBeanFactory#instantiateBean` æ�¥è¿›è¡Œå®žä¾‹åŒ–,å�¦åˆ™è°ƒç”¨ `AbstractAutowireCapableBeanFactory#autowireConstructor` 进行实例化。实际上,这两个方法最终都会执行到 `BeanUtils#instantiateClass(Constructor, Object...)`: ``` public static T instantiateClass(Constructor ctor, Object... args) @@ -263,7 +263,7 @@ public static T instantiateClass(Constructor ctor, Object... args) argsWithDefaultValues[i] = args[i]; } } - // ÕâÀï½øÐÐʵÀý»¯ + // 这里进行实例化 return ctor.newInstance(argsWithDefaultValues); } } @@ -274,20 +274,20 @@ public static T instantiateClass(Constructor ctor, Object... args) ``` -¿ÉÒÔ¿´µ½£¬×îÖÕµ÷ÓõÄÊÇ `java.lang.reflect.Constructor#newInstance`£¬Õâ¾ÍÊÇ jdk µÄ·´ÉäÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œæœ€ç»ˆè°ƒç”¨çš„æ˜¯ `java.lang.reflect.Constructor#newInstance`,这就是 jdk çš„å��射了。 -ÁíÍ⣬µ± bean ÌṩÁË¶à ¸ö¹¹Ôì·½·¨Ê±£¬spring »á½øÐÐÒ»Ì׸´ÔÓµÄÍÆ¶Ï»úÖÆ£¬Íƶϳö×î¼ÑµÄ¹¹Ôì·½·¨£¬ÕâÀï¾Í²»Õ¹¿ªÁË¡£ +å�¦å¤–,当 bean æ��供了多 个构造方法时,spring 会进行一套å¤�æ�‚的推断机制,推断出最佳的构造方法,这里就ä¸�展开了。 -#### 2\. ²éÕÒÊôÐÔ +#### 2\. 查找属性 -¶ÔÏó´´½¨ºó£¬½ÓÏÂÀ´¾ÍÊǽøÐÐÊôÐÔ×¢ÈëÁË£¬²»¹ýÔÚ×¢ÈëÊôÐÔǰ£¬ÐèÒªÖªµÀÀàÖÐÓÐÄÄЩÊôÐÔÐèҪעÈë¡£spring ÊôÐÔ²éÕÒÊÇÔÚ `AbstractAutowireCapableBeanFactory#applyMergedBeanDefinitionPostProcessors` Öе÷ÓúóÖô¦ÀíÆ÷½øÐвÙ×÷µÄ£º +对象创建å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ˜¯è¿›è¡Œå±žæ€§æ³¨å…¥äº†ï¼Œä¸�过在注入属性å‰�,需è¦�知é�“类中有哪些属性需è¦�注入。spring 属性查找是在 `AbstractAutowireCapableBeanFactory#applyMergedBeanDefinitionPostProcessors` 中调用å�Žç½®å¤„ç�†å™¨è¿›è¡Œæ“�作的: ``` protected void applyMergedBeanDefinitionPostProcessors(RootBeanDefinition mbd, Class beanType, String beanName) { for (BeanPostProcessor bp : getBeanPostProcessors()) { if (bp instanceof MergedBeanDefinitionPostProcessor) { - // µ÷ÓúóÖô¦ÀíÆ÷ + // 调用å�Žç½®å¤„ç�†å™¨ MergedBeanDefinitionPostProcessor bdp = (MergedBeanDefinitionPostProcessor) bp; bdp.postProcessMergedBeanDefinition(mbd, beanType, beanName); } @@ -296,12 +296,12 @@ protected void applyMergedBeanDefinitionPostProcessors(RootBeanDefinition mbd, ``` -ÔÚÕâЩºóÖô¦ÀíÆ÷ÖУ¬ +在这些å�Žç½®å¤„ç�†å™¨ä¸­ï¼Œ -1. µ÷Óà `AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` ²éÕÒ´øÓÐ `@Autowired`¡¢`@Value` ×¢½âµÄÊôÐԺͷ½·¨ -2. µ÷Óà `CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` ²éÕÒ´øÓÐ `@Resource` ×¢½âµÄÊôÐԺͷ½·¨ +1. 调用 `AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` 查找带有 `@Autowired`ã€�`@Value` 注解的属性和方法 +2. 调用 `CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` 查找带有 `@Resource` 注解的属性和方法 -ÕâÀïΪÁË·½±ã˵Ã÷ `@Autowired` µÄ×¢ÈëÁ÷³Ì£¬ÎÒÃÇÔÚ demo01 µÄ `org.springframework.learn.demo01.BeanObj1` Ìí¼ÓÁ½ÐÐÐдúÂ룺 +这里为了方便说明 `@Autowired` 的注入æµ�程,我们在 demo01 çš„ `org.springframework.learn.demo01.BeanObj1` 添加两行行代ç �: ``` package org.springframework.learn.demo01; @@ -312,12 +312,12 @@ import org.springframework.stereotype.Service; @Service public class BeanObj1 { - // ÒÔÏÂÁ½ÐÐΪмÓÈëµÄ´úÂë + // 以下两行为新加入的代ç � @Autowired private BeanObj2 beanObj2; public BeanObj1() { - System.out.println("µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨"); + System.out.println("调用beanObj1的构造方法"); } @Override @@ -328,30 +328,30 @@ public class BeanObj1 { ``` -½øÈë `AutowiredAnnotationBeanPostProcessor#postProcessMergedBeanDefinition` ·½·¨£º +进入 `AutowiredAnnotationBeanPostProcessor#postProcessMergedBeanDefinition` 方法: ``` @Override public void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, Class beanType, String beanName) { - // ²éÕÒÊôÐÔÓë·½·¨ + // 查找属性与方法 InjectionMetadata metadata = findAutowiringMetadata(beanName, beanType, null); - // ÑéÖ¤²éÕÒµ½µÄÊôÐÔÓë·½·¨£¬²¢×¢²áµ½beanDefinition + // 验è¯�查找到的属性与方法,并注册到beanDefinition metadata.checkConfigMembers(beanDefinition); } ``` -һ·¸ú½ø `AutowiredAnnotationBeanPostProcessor#findAutowiringMetadata` ·½·¨£¬¸úµ½ÁË `AutowiredAnnotationBeanPostProcessor#buildAutowiringMetadata`: +一路跟进 `AutowiredAnnotationBeanPostProcessor#findAutowiringMetadata` 方法,跟到了 `AutowiredAnnotationBeanPostProcessor#buildAutowiringMetadata`: ``` private InjectionMetadata buildAutowiringMetadata(final Class clazz) { ... - // ÕâÀïÅÜÁËÒ»¸öÑ­»·£¬ÕÒÍ굱ǰÀàÕÒµ±Ç°ÀàµÄ¸¸Àֱ࣬µ½ObjectÀà + // 这里跑了一个循环,找完当å‰�类找当å‰�类的父类,直到Objectç±» do { final List currElements = new ArrayList<>(); - // ²éÕÒÊôÐÔ + // 查找属性 ReflectionUtils.doWithLocalFields(targetClass, field -> { MergedAnnotation ann = findAutowiredAnnotation(field); if (ann != null) { @@ -359,12 +359,12 @@ private InjectionMetadata buildAutowiringMetadata(final Class clazz) { return; } boolean required = determineRequiredStatus(ann); - // ÊôÐÔ·â×°³É AutowiredFieldElement + // 属性å°�装æˆ� AutowiredFieldElement currElements.add(new AutowiredFieldElement(field, required)); } }); - // ²éÕÒ·½·¨ + // 查找方法 ReflectionUtils.doWithLocalMethods(targetClass, method -> { Method bridgedMethod = BridgeMethodResolver.findBridgedMethod(method); if (!BridgeMethodResolver.isVisibilityBridgeMethodPair(method, bridgedMethod)) { @@ -379,7 +379,7 @@ private InjectionMetadata buildAutowiringMetadata(final Class clazz) { } boolean required = determineRequiredStatus(ann); PropertyDescriptor pd = BeanUtils.findPropertyForMethod(bridgedMethod, clazz); - // ·½·¨·â×°³É AutowiredMethodElement + // 方法å°�装æˆ� AutowiredMethodElement currElements.add(new AutowiredMethodElement(method, required, pd)); } }); @@ -394,19 +394,19 @@ private InjectionMetadata buildAutowiringMetadata(final Class clazz) { ``` -ÒÔÉÏ´úÂë¾ÍÊDzéÕÒ¹ý³Ì£¬×ܽáÈçÏ£º +以上代ç �就是查找过程,总结如下: -* Ñ­»·²éѯ¸¸À࣬´Óµ±Ç°À࿪ʼ£¬ÕÒÍ굱ǰÀà¾ÍÕÒµ±Ç°ÀàµÄ¸¸Àֱ࣬½Ó Object Ϊֹ£» -* ²éÕÒÊôÐÔÓë·½·¨£¬ÊôÐÔÕÒµ½ºó·âװΪ `AutowiredFieldElement`£¬·½·¨ÕÒµ½ºó·âװΪ `AutowiredMethodElement`£» -* ÎÞÂÛÊDzéÕÒÊôÐÔ»¹ÊÇ·½·¨£¬Ê¹ÓõͼÊÇ `findAutowiredAnnotation` ·½·¨ +* 循环查询父类,从当å‰�类开始,找完当å‰�类就找当å‰�类的父类,直接 Object 为止; +* 查找属性与方法,属性找到å�Žå°�装为 `AutowiredFieldElement`,方法找到å�Žå°�装为 `AutowiredMethodElement`ï¼› +* 无论是查找属性还是方法,使用的都是 `findAutowiredAnnotation` 方法 -½ÓÏÂÀ´£¬ÎÒÃǾͿ´¿´ `findAutowiredAnnotation` ·½·¨ÊÇÈçºÎ½øÐвéÕҵġ£½øÈë `AutowiredAnnotationBeanPostProcessor#findAutowiredAnnotation` ·½·¨£¬ÄÚÈÝÈçÏ£º +接下æ�¥ï¼Œæˆ‘们就看看 `findAutowiredAnnotation` 方法是如何进行查找的。进入 `AutowiredAnnotationBeanPostProcessor#findAutowiredAnnotation` 方法,内容如下: ``` private final Set> autowiredAnnotationTypes = new LinkedHashSet<>(4); -// ĬÈϹ¹Ôì·½·¨ÖÐÖ¸¶¨ÁË@Autowired¡¢@Value×¢½â +// 默认构造方法中指定了@Autowiredã€�@Value注解 @SuppressWarnings("unchecked") public AutowiredAnnotationBeanPostProcessor() { this.autowiredAnnotationTypes.add(Autowired.class); @@ -414,11 +414,11 @@ public AutowiredAnnotationBeanPostProcessor() { ... } -// ÕâÀï¾ÍÊDzéÕÒ·½·¨ +// 这里就是查找方法 @Nullable private MergedAnnotation findAutowiredAnnotation(AccessibleObject ao) { MergedAnnotations annotations = MergedAnnotations.from(ao); - // autowiredAnnotationTypes °üº¬ÁË @Autowired¡¢@Value×¢½â + // autowiredAnnotationTypes 包å�«äº† @Autowiredã€�@Value注解 for (Class type : this.autowiredAnnotationTypes) { MergedAnnotation annotation = annotations.get(type); if (annotation.isPresent()) { @@ -430,9 +430,9 @@ private MergedAnnotation findAutowiredAnnotation(AccessibleObject ao) { ``` -ÒÔÉÏ´úÂë×¢½âµÃºÜÃ÷°×ÁË£¬ÕâÀï¾Í²»¶à˵ÁË¡£ +以上代ç �注解得很明白了,这里就ä¸�多说了。 -ÕÒµ½ÊôÐÔÓë·½·¨ºó£¬½ÓמÍÊÇ×¢²áµ½ `beanDefinition` ÁË£¬ÕâÊÇ `InjectionMetadata#checkConfigMembers` Ëù×öµÄ¹¤×÷£º +找到属性与方法å�Žï¼ŒæŽ¥ç�€å°±æ˜¯æ³¨å†Œåˆ° `beanDefinition` 了,这是 `InjectionMetadata#checkConfigMembers` 所å�šçš„工作: ``` public void checkConfigMembers(RootBeanDefinition beanDefinition) { @@ -440,7 +440,7 @@ public void checkConfigMembers(RootBeanDefinition beanDefinition) { for (InjectedElement element : this.injectedElements) { Member member = element.getMember(); if (!beanDefinition.isExternallyManagedConfigMember(member)) { - // ×¢²áµ½ beanDefinition + // 注册到 beanDefinition beanDefinition.registerExternallyManagedConfigMember(member); checkedElements.add(element); } @@ -450,7 +450,7 @@ public void checkConfigMembers(RootBeanDefinition beanDefinition) { ``` -ËùνµÄ×¢²á£¬ÆäʵҲÏ൱¼òµ¥£¬¾ÍÊÇÍù `beanDefinition` ³ÖÓÐµÄ `externallyManagedConfigMembers` ¼¯ºÏÖÐÌí¼ÓÒ»Ìõ¼Ç¼£º +所谓的注册,其实也相当简å�•,就是往 `beanDefinition` æŒ�有的 `externallyManagedConfigMembers` 集å�ˆä¸­æ·»åР䏀æ�¡è®°å½•: > RootBeanDefinition#registerExternallyManagedConfigMember @@ -460,16 +460,16 @@ public void registerExternallyManagedConfigMember(Member configMember) { if (this.externallyManagedConfigMembers == null) { this.externallyManagedConfigMembers = new HashSet<>(1); } - // Íùset¼¯ºÏÖÐÌí¼ÓÒ»Ìõ¼Ç¼ + // å¾€set集å�ˆä¸­æ·»åР䏀æ�¡è®°å½• this.externallyManagedConfigMembers.add(configMember); } } ``` -#### 3\. ×¢ÈëÊôÐÔ +#### 3\. 注入属性 -spring µÄÊôÐÔ×¢ÈëÊÇÔÚ·½·¨ `AbstractAutowireCapableBeanFactory#populateBean` Öд¦ÀíµÄ£¬ÄÚÈÝÈçÏ£º +spring 的属性注入是在方法 `AbstractAutowireCapableBeanFactory#populateBean` 中处ç�†çš„,内容如下: ``` protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable BeanWrapper bw) { @@ -485,11 +485,11 @@ protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable B if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) { for (BeanPostProcessor bp : getBeanPostProcessors()) { if (bp instanceof InstantiationAwareBeanPostProcessor) { - // µ÷ÓþßÌåµÄºóÖô¦ÀíÆ÷Íê³ÉÊôÐÔÌî³ä - // AutowiredAnnotationBeanPostProcessor.postProcessProperties ´¦Àí @Autowired¡¢@Value ×¢½â - // CommonAnnotationBeanPostProcessor.postProcessProperties ´¦Àí @Resource×¢½â + // 调用具体的å�Žç½®å¤„ç�†å™¨å®Œæˆ�属性填充 + // AutowiredAnnotationBeanPostProcessor.postProcessProperties 处ç�† @Autowiredã€�@Value 注解 + // CommonAnnotationBeanPostProcessor.postProcessProperties 处ç�† @Resource注解 InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp; - // Èç¹û·µ»Ø false£¬´ú±í²»ÐèÒª½øÐкóÐøµÄÊôÐÔÉèÖµ£¬Ò²²»ÐèÒªÔÙ¾­¹ýÆäËûµÄ BeanPostProcessor µÄ´¦Àí + // 如果返回 false,代表ä¸�需è¦�进行å�Žç»­çš„属性设值,也ä¸�需è¦�å†�ç»�过其他的 BeanPostProcessor 的处ç�† if (!ibp.postProcessAfterInstantiation(bw.getWrappedInstance(), beanName)) { return; } @@ -497,18 +497,18 @@ protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable B } } - // beanµÄËùÓÐÊôÐÔ + // bean的所有属性 PropertyValues pvs = (mbd.hasPropertyValues() ? mbd.getPropertyValues() : null); int resolvedAutowireMode = mbd.getResolvedAutowireMode(); - // ÊôÐÔ×¢ÈëÀàÐÍΪbyType»¹ÊÇbyName£¬×¢£º@Autowired ¼È²»ÊÇbyTypeÒ²²»ÊÇbyName,Òò´ËÕâÀï·µ»Øfalse + // 属性注入类型为byType还是byName,注:@Autowired æ—¢ä¸�是byType也ä¸�是byName,因此这里返回false if (resolvedAutowireMode == AUTOWIRE_BY_NAME || resolvedAutowireMode == AUTOWIRE_BY_TYPE) { MutablePropertyValues newPvs = new MutablePropertyValues(pvs); - // ͨ¹ýÃû×ÖÕÒµ½ËùÓÐÊôÐÔÖµ£¬Èç¹ûÊÇ bean ÒÀÀµ£¬Ïȳõʼ»¯ÒÀÀµµÄ bean¡£¼Ç¼ÒÀÀµ¹ØÏµ + // 通过å��字找到所有属性值,如果是 bean ä¾�赖,先åˆ�始化ä¾�èµ–çš„ bean。记录ä¾�赖关系 if (resolvedAutowireMode == AUTOWIRE_BY_NAME) { autowireByName(beanName, mbd, bw, newPvs); } - // ͨ¹ýÀàÐÍ×°Åä¡£¸´ÔÓһЩ + // 通过类型装é…�。å¤�æ�‚一些 if (resolvedAutowireMode == AUTOWIRE_BY_TYPE) { autowireByType(beanName, mbd, bw, newPvs); } @@ -525,16 +525,16 @@ protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable B } for (BeanPostProcessor bp : getBeanPostProcessors()) { if (bp instanceof InstantiationAwareBeanPostProcessor) { - // µ÷ÓúóÖô¦ÀíÆ÷Íê³É×¢Ê͵ÄÊôÐÔÌî³ä - // ´¦Àí@Autowired×¢½âµÄÊÇ AutowiredAnnotationBeanPostProcessor + // 调用å�Žç½®å¤„ç�†å™¨å®Œæˆ�注释的属性填充 + // 处ç�†@Autowired注解的是 AutowiredAnnotationBeanPostProcessor InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp; PropertyValues pvsToUse = ibp.postProcessProperties(pvs, bw.getWrappedInstance(), beanName); if (pvsToUse == null) { if (filteredPds == null) { filteredPds = filterPropertyDescriptorsForDependencyCheck(bw, mbd.allowCaching); } - // ÕâÀï¾ÍÊÇÉÏ·½Ôø¾­Ìáµ½¹ýµÃ¶Ô@Autowired´¦ÀíµÄÒ»¸öBeanPostProcessorÁË - // Ëü»á¶ÔËùÓбê¼Ç@Autowired¡¢@Value ×¢½âµÄÊôÐÔ½øÐÐÉèÖµ + // 这里就是上方曾ç»�æ��到过得对@Autowired处ç�†çš„一个BeanPostProcessor了 + // 它会对所有标记@Autowiredã€�@Value 注解的属性进行设值 pvsToUse = ibp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName); if (pvsToUse == null) { @@ -553,22 +553,22 @@ protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable B } if (pvs != null) { - // ÉèÖà bean ʵÀýµÄÊôÐÔÖµ + // 设置 bean 实例的属性值 applyPropertyValues(beanName, mbd, bw, pvs); } } ``` -spring µÄÊôÐÔÌî³äÊÇÔÚºóÖô¦ÀíÆ÷ÖнøÐеģ¬`@Autowired` µÄÊôÐÔÌî³ä·½·¨Îª `AutowiredAnnotationBeanPostProcessor#postProcessProperties`: +spring 的属性填充是在å�Žç½®å¤„ç�†å™¨ä¸­è¿›è¡Œçš„,`@Autowired` 的属性填充方法为 `AutowiredAnnotationBeanPostProcessor#postProcessProperties`: ``` public PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName) { - // µ÷Óà findAutowiringMetadata ·½·¨£¬È·±£±ê×¢ @Autowired @Value ×¢½âµÄÊôÐÔÓë·½·¨»ñÈ¡³É¹¦ - // findAutowiringMetadata ¿ÉÒÔ·¢ÏÖ£¬ÀïÃæ×öÁËÒ»¸ö»º´æ£¬Ö»ÓеÚÒ»´Î²Å»áÕæÕýÈ¥»ñÈ¡£¬Ö®ºó¶¼´Ó»º´æÖлñÈ¡ + // 调用 findAutowiringMetadata 方法,确ä¿�标注 @Autowired @Value 注解的属性与方法获å�–æˆ�功 + // findAutowiringMetadata å�¯ä»¥å�‘现,里é�¢å�šäº†ä¸€ä¸ªç¼“存,å�ªæœ‰ç¬¬ä¸€æ¬¡æ‰�会真正去获å�–,之å�Žéƒ½ä»Žç¼“存中获å�– InjectionMetadata metadata = findAutowiringMetadata(beanName, bean.getClass(), pvs); try { - // ÕâÀï½øÐÐÊôÐÔ×¢Èë + // 这里进行属性注入 metadata.inject(bean, beanName, pvs); } catch (...) { @@ -578,7 +578,7 @@ public PropertyValues postProcessProperties(PropertyValues pvs, Object bean, Str ``` -ÎÒÃÇÔÙ½øÈë `InjectionMetadata#inject`£º +我们å†�进入 `InjectionMetadata#inject`: ``` public void inject(Object target, @Nullable String beanName, @Nullable PropertyValues pvs) @@ -587,8 +587,8 @@ public void inject(Object target, @Nullable String beanName, @Nullable PropertyV Collection elementsToIterate = (checkedElements != null ? checkedElements : this.injectedElements); if (!elementsToIterate.isEmpty()) { - // ÕâÀïµÄ InjectedElement£¬¾ÍÊÇÔÚ AutowiredAnnotationBeanPostProcessor#findAutowiringMetadata - // ÖвéÕÒµ½µÄ£¬field »á·âװΪ AutowiredFieldElement£¬method »á»á·âװΪ AutowiredMethodElement + // 这里的 InjectedElement,就是在 AutowiredAnnotationBeanPostProcessor#findAutowiringMetadata + // 中查找到的,field 会å°�装为 AutowiredFieldElement,method 会会å°�装为 AutowiredMethodElement for (InjectedElement element : elementsToIterate) { element.inject(target, beanName, pvs); } @@ -597,7 +597,7 @@ public void inject(Object target, @Nullable String beanName, @Nullable PropertyV ``` -ÎÒÃÇÔÙ¸ú½ø `element.inject(target, beanName, pvs)`£¬ÕâÀïµ÷Óõ½µÄÊÇ `AutowiredAnnotationBeanPostProcessor.AutowiredFieldElement#inject`£º +我们å†�è·Ÿè¿› `element.inject(target, beanName, pvs)`,这里调用到的是 `AutowiredAnnotationBeanPostProcessor.AutowiredFieldElement#inject`: ``` @Override @@ -615,7 +615,7 @@ protected void inject(Object bean, @Nullable String beanName, Assert.state(beanFactory != null, "No BeanFactory available"); TypeConverter typeConverter = beanFactory.getTypeConverter(); try { - // ÕâÒ»ÐоÍÊÇ»ñȡעÈëµÄbean + // 这一行就是获å�–注入的bean value = beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter); } catch (BeansException ex) { @@ -623,7 +623,7 @@ protected void inject(Object bean, @Nullable String beanName, } ... } - // ͨ¹ý·´É䏸ÊôÐÔÉèÖÃÖµ + // 通过å��射给属性设置值 if (value != null) { ReflectionUtils.makeAccessible(field); field.set(bean, value); @@ -633,14 +633,14 @@ protected void inject(Object bean, @Nullable String beanName, ``` -ÒÔÉÏ´úÂëÓеã¶à£¬µ«ÎÒÃÇÖ»ÒªÖ÷Òª¹Ø×¢Á½ÐдúÂë¾ÍÐÐÁË£º +以上代ç �有点多,但我们å�ªè¦�主è¦�关注两行代ç �就行了: -1. »ñÈ¡ÐèҪעÈëµÄ bean: `value = beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter)` -2. ʹÓ÷´ÉäÉèÖà bean£º`ReflectionUtils.makeAccessible(field);field.set(bean, value);` +1. 获å�–需è¦�注入的 bean: `value = beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter)` +2. 使用å��射设置 bean:`ReflectionUtils.makeAccessible(field);field.set(bean, value);` -¶ÔÓÚµÚ 2 µã£¬×îÖÕµ÷ÓõÄÊÇ jdk ÌṩµÄ·´Éä·½·¨£¬Ã»Ê²Ã´ºÃ˵µÄ¡£ÕâÀïÎÒÃÇÖØµãÀ´¿´¿´ spring ÊÇÈçºÎ»ñÈ¡ÐèҪעÈëµÄ bean¡£ +对于第 2 点,最终调用的是 jdk æ��供的å��射方法,没什么好说的。这里我们é‡�点æ�¥çœ‹çœ‹ spring 是如何获å�–需è¦�注入的 bean。 -¸ú½ø `beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter)`£¬ÕâÀï¶Ô²»ÖØÒªµÄ´úÂë½ö¸ø³öµ÷ÓÃÁ´£¬µ÷ÓÃÈçÏ£º +è·Ÿè¿› `beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter)`,这里对ä¸�é‡�è¦�的代ç �仅给出调用链,调用如下: ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -661,7 +661,7 @@ protected void inject(Object bean, @Nullable String beanName, ``` -×îÖÕÔËÐе½ `DefaultListableBeanFactory#doResolveDependency`: +最终è¿�行到 `DefaultListableBeanFactory#doResolveDependency`: ``` @Nullable @@ -672,14 +672,14 @@ public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable Str InjectionPoint previousInjectionPoint = ConstructorResolver.setCurrentInjectionPoint(descriptor); try { ... - // 1\. ¸ù¾ÝÀàÐͲéÕÒËùÓеÄbeanClass£¬mapÖб£´æµÄÄÚÈÝΪ£ºbeanName -> Class + // 1\. æ ¹æ�®ç±»åž‹æŸ¥æ‰¾æ‰€æœ‰çš„beanClass,map中ä¿�存的内容为:beanName -> Class Map matchingBeans = findAutowireCandidates(beanName, type, descriptor); ... String autowiredBeanName; Object instanceCandidate; - // 2\. Èç¹ûÕÒµ½µÄbeanÓжà¸ö£¬¼´ÊýÁ¿´óÓÚ1 + // 2\. 如果找到的bean有多个,å�³æ•°é‡�大于1 if (matchingBeans.size() > 1) { - // Ôò»ñȡעÈëµÄÊôÐÔÃû + // 则获å�–注入的属性å�� autowiredBeanName = determineAutowireCandidate(matchingBeans, descriptor); if (autowiredBeanName == null) { if (isRequired(descriptor) || !indicatesMultipleBeans(type)) { @@ -689,8 +689,8 @@ public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable Str return null; } } - // 3\. ¸ù¾Ý×¢ÈëµÄÊôÐÔÃû´Ó ¸ù¾ÝÀàÐÍÕÒ³öÀ´µÄmapµ±ÖÐÕÒ£¬ - // µÃµ½beanµÄClass¶ÔÏó + // 3\. æ ¹æ�®æ³¨å…¥çš„属性å��从 æ ¹æ�®ç±»åž‹æ‰¾å‡ºæ�¥çš„map当中找, + // 得到beançš„Class对象 instanceCandidate = matchingBeans.get(autowiredBeanName); } else { @@ -702,7 +702,7 @@ public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable Str autowiredBeanNames.add(autowiredBeanName); } if (instanceCandidate instanceof Class) { - // ¸ù¾Ýclass »ñÈ¡ bean£¬Èç¹ûbean²»´æÔÚ£¬Ôò»á´´½¨bean + // æ ¹æ�®class 获å�– bean,如果beanä¸�存在,则会创建bean instanceCandidate = descriptor.resolveCandidate(autowiredBeanName, type, this); } Object result = instanceCandidate; @@ -724,13 +724,13 @@ public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable Str ``` -¶ÔÓÚ bean µÄ»ñÈ¡£¬ÕâÀïÔÙ×ܽáÏ£º +对于 bean 的获å�–,这里å†�总结下: -1. ¸ù¾Ý bean ÀàÐÍ´Ó spring ÖлñÈ¡ bean µÄ Class ¶ÔÏó£¬×¢Ò⣺ÕâÀïµÃµ½µÄ¶ÔÏóΪ Class£¬ÇÒ»ñÈ¡µ½µÄ Class ¶ÔÏó´Ó spring ÖлñÈ¡ beanClass ¿ÉÄÜÓжà¸ö£» -2. Èç¹ûµÃµ½µÄ Class ¶ÔÏóÓжà¸ö£¬Ôò»ñȡעÈëµÄÊôÐÔÃû£¬¸ù¾ÝÊôÐÔÃû²éÕÒ´ÓµÚ 1 ²½µÃµ½µÄ Class ¶ÔÏóÖвéÕÒ·ûºÏÌõ¼þµÄ 1 ¸ö Class ¶ÔÏó£» -3. ¸ù¾Ý Class ¶ÔÏó´Ó spring ÖлñÈ¡ bean. +1. æ ¹æ�® bean 类型从 spring 中获å�– bean çš„ Class 对象,注æ„�:这里得到的对象为 Class,且获å�–到的 Class 对象从 spring 中获å�– beanClass å�¯èƒ½æœ‰å¤šä¸ªï¼› +2. 如果得到的 Class 对象有多个,则获å�–注入的属性å��,根æ�®å±žæ€§å��查找从第 1 步得到的 Class 对象中查找符å�ˆæ�¡ä»¶çš„ 1 个 Class 对象; +3. æ ¹æ�® Class 对象从 spring 中获å�– bean. -ÀýÈ磬ÏÖÔÚ½Ó¿Ú `Inter`¡¢ÊµÏÖÀà `A` Óë `B`£¬ÈýÕß¹ØÏµÈçÏ£º +例如,现在接å�£ `Inter`ã€�实现类 `A` 与 `B`,三者关系如下: ``` interface Inter { @@ -749,7 +749,7 @@ class B implements Inter { ``` -ÔÚÀà `C` ÖУ¬×¢Èë `Inter` ÀàÐÍ£º +在类 `C` 中,注入 `Inter` 类型: ``` @Service @@ -760,13 +760,13 @@ class C { ``` -ÔÚ×¢Èëʱ£¬ +在注入时, -1. spring »áͨ¹ý `Inter.class` ²éÕÒ£¬µÃµ½Á½¸öÀࣺ`A.class` Óë `B.class`£¬³öÏÖÁ˶à¸ö bean Class ¶ÔÏó£» -2. µÃµ½×¢ÈëµÄÊôÐÔÃû£¬ÕâÀïÊÇ `b`£¬È»ºóʹÓà `b` ÔÚÒÔÉϵõ½µÄ bean Class ¶ÔÏóÕÒµ½·ûºÏµÄ bean Class ¶ÔÏó£¬ÏÔÈ»£¬`B.class` ·ûºÏ£» -3. ´Ó spring ÈÝÆ÷ÖлñÈ¡ `B.class` ¶ÔÓ¦µÄ bean. +1. spring 会通过 `Inter.class` 查找,得到两个类:`A.class` 与 `B.class`,出现了多个 bean Class 对象; +2. 得到注入的属性å��,这里是 `b`,然å�Žä½¿ç”¨ `b` 在以上得到的 bean Class 对象找到符å�ˆçš„ bean Class 对象,显然,`B.class` 符å�ˆï¼› +3. 从 spring 容器中获å�– `B.class` 对应的 bean. -ÕâÀï»áÓиöСÎÊÌ⣺Èç¹ûÔÚ `C` ÖÐÕâÑù×¢Èë: +这里会有个å°�问题:如果在 `C` 中这样注入: ``` @Service @@ -777,32 +777,32 @@ class C { ``` -¼´ `Inter` µÄÊôÐÔÃûΪ `inter`£¬¶ø spring ÖÐÓÖûÓÐÃû³ÆÎª `inter` µÄ bean Class ¶ÔÏó£¬ÕâÑùÄÜ×¢Èë³É¹¦Â𣿠+å�³ `Inter` 的属性å��为 `inter`,而 spring 中å�ˆæ²¡æœ‰å��称为 `inter` çš„ bean Class 对象,这样能注入æˆ�功å�—? -ÊÂʵÉÏ£¬ÕâÑù×¢Èë²»»á³É¹¦£¬ÇÒ spring »á±¨Òì³££¬¸ÐÐËȤµÄС»ï°é¿ÉÒÔ×Ô¼ºÊÔÊÔ¡£ +事实上,这样注入ä¸�会æˆ�功,且 spring 会报异常,感兴趣的å°�伙伴å�¯ä»¥è‡ªå·±è¯•试。 -×îºó£¬ÎÒÃÇÔÙÀ´¿´¿´ÈçºÎ¸ù¾Ý class ´Ó spring ÖлñÈ¡¶ÔÓ¦µÄ bean£¬¼´ `instanceCandidate = descriptor.resolveCandidate(autowiredBeanName, type, this)`£¬¸ú½øÈ¥£º +最å�Žï¼Œæˆ‘们å†�æ�¥çœ‹çœ‹å¦‚何根æ�® class 从 spring 中获å�–对应的 bean,å�³ `instanceCandidate = descriptor.resolveCandidate(autowiredBeanName, type, this)`,跟进去: > DependencyDescriptor#resolveCandidate ``` public Object resolveCandidate(String beanName, Class requiredType, BeanFactory beanFactory) throws BeansException { - // µ÷ÓõÄÉÏ AbstractBeanFactory#getBean(String) + // 调用的上 AbstractBeanFactory#getBean(String) return beanFactory.getBean(beanName); } ``` -Õâ¸ö·½·¨Ï൱¼òµ¥£¬¾ÍÖ»ÓÐÒ»ÐУº`beanFactory.getBean(beanName)`£¬»Ø¹Ëϵ÷ÓÃÁ´£º +这个方法相当简å�•,就å�ªæœ‰ä¸€è¡Œï¼š`beanFactory.getBean(beanName)`,回顾下调用链: ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) |-AbstractApplicationContext#refresh |-AbstractApplicationContext#finishBeanFactoryInitialization |-DefaultListableBeanFactory#preInstantiateSingletons - // ÕâÀïµÚÒ»´Îµ÷ÓÃÁËAbstractBeanFactory#getBean - // ´Ëʱ´«ÈëµÄ²ÎÊýΪbeanObj1 + // 这里第一次调用了AbstractBeanFactory#getBean + // 此时传入的å�‚数为beanObj1 |-AbstractBeanFactory#getBean(String) |-AbstractBeanFactory#doGetBean |-DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory) @@ -815,35 +815,35 @@ public Object resolveCandidate(String beanName, Class requiredType, BeanFacto |-DefaultListableBeanFactory#resolveDependency |-DefaultListableBeanFactory#doResolveDependency |-DependencyDescriptor#resolveCandidate - // ÕâÀïµÚÒ»´Îµ÷ÓÃÁËAbstractBeanFactory#getBean£¬ - // ´Ëʱ´«ÈëµÄ²ÎÊýΪbeanObj2 + // 这里第一次调用了AbstractBeanFactory#getBean, + // 此时传入的å�‚数为beanObj2 |-AbstractBeanFactory#getBean(String) - .. ÏÂÃæ¿ªÊ¼½øÐÐ`beanObj2`µÄʵÀý»¯Óë³õʼ»¯²Ù×÷ + .. 下é�¢å¼€å§‹è¿›è¡Œ`beanObj2`的实例化与åˆ�始化æ“�作 ``` -½áºÏµ÷ÓÃÁ´¼°Ç°Ãæ·ÖÎö¿ÉÒÔ¿´³ö£¬ +结å�ˆè°ƒç”¨é“¾å�Šå‰�é�¢åˆ†æž�å�¯ä»¥çœ‹å‡ºï¼Œ -* ÔÚ»ñÈ¡ `beanObj1` ʱµÚÒ»´Îµ÷Óà `AbstractBeanFactory#getBean(String)`£¬ÓÉÓÚ´Ëʱ spring Öв»´æÔÚ `beanObj1`£¬¾Í¿ªÊ¼ÁË `beanObj1` µÄ´´½¨£» -* `beanObj1` ʵÀý»¯Íê³Éºó£¬½ÓמͽøÐÐÊôÐÔ×¢È룬`beanObj1` ÖÐÓиöÊôÐÔ `BeanObj2 beanObj2`£¬Í¬Ñùµ÷Óà `AbstractBeanFactory#getBean(String)` ´Ó spring ÖлñÈ¡ `beanObj2` ¶ÔÏó£» -* ÓÉÓÚ´Ëʱ spring Öв»´æÔÚ `beanObj2`£¬½ÓמͽøÈëÁË `beanObj2` ¶ÔÏóµÄ´´½¨¹ý³Ì£»´´½¨¶ÔÏóºó£¬Í¬ÑùÒ²»á¶Ô `beanObj2` ÊôÐÔ×¢Èë¡¢ÔËÐгõʼ»¯·½·¨µÈ²Ù×÷£¬ÕâÓë `beanObj1` µÄ²Ù×÷ÀàËÆ£» -* µÃµ½ `beanObj2` ¶ÔÏóºó£¬×¢Èëµ½ `beanObj1` µÄ `BeanObj2 beanObj2` ÊôÐÔÖУ¬È»ºó½øÐÐ `beanObj1` µÄºóÐø²Ù×÷¡£ +* 在获å�– `beanObj1` 时第一次调用 `AbstractBeanFactory#getBean(String)`,由于此时 spring 中ä¸�存在 `beanObj1`,就开始了 `beanObj1` 的创建; +* `beanObj1` 实例化完æˆ�å�Žï¼ŒæŽ¥ç�€å°±è¿›è¡Œå±žæ€§æ³¨å…¥ï¼Œ`beanObj1` 中有个属性 `BeanObj2 beanObj2`,å�Œæ ·è°ƒç”¨ `AbstractBeanFactory#getBean(String)` 从 spring 中获å�– `beanObj2` 对象; +* 由于此时 spring 中ä¸�存在 `beanObj2`,接ç�€å°±è¿›å…¥äº† `beanObj2` 对象的创建过程;创建对象å�Žï¼Œå�Œæ ·ä¹Ÿä¼šå¯¹ `beanObj2` 属性注入ã€�è¿�行åˆ�始化方法等æ“�作,这与 `beanObj1` çš„æ“�作类似; +* 得到 `beanObj2` 对象å�Žï¼Œæ³¨å…¥åˆ° `beanObj1` çš„ `BeanObj2 beanObj2` 属性中,然å�Žè¿›è¡Œ `beanObj1` çš„å�Žç»­æ“�作。 -´ÓÕâÀï¿ÉÒÔ¿´³ö£¬ÊôÐÔ×¢Èëʱ£¬¿ÉÄÜ»áʹ bean ³õʼ»¯Ìáǰ£»Í¬Ê±£¬¶ÔÓÚÒÀÀµ²ã´Î¶àµÄÇé¿ö£¬µ÷ÓÃÁ´½«»á·Ç³£³¤£¬Èç A ÐèҪעÈë B£¬B ҪעÈë C£¬ÄÇôÔÚ A µÄÊôÐÔ×¢Èëʱ£¬½«»á³õʼ»¯ B£¬¶ø B ÔÚ³õʼ»¯Ê±£¬ÓÖ»á³õʼ»¯ C¡£ +从这里å�¯ä»¥çœ‹å‡ºï¼Œå±žæ€§æ³¨å…¥æ—¶ï¼Œå�¯èƒ½ä¼šä½¿ bean åˆ�始化æ��å‰�ï¼›å�Œæ—¶ï¼Œå¯¹äºŽä¾�赖层次多的情况,调用链将会é�žå¸¸é•¿ï¼Œå¦‚ A 需è¦�注入 B,B è¦�注入 C,那么在 A 的属性注入时,将会åˆ�始化 B,而 B 在åˆ�始化时,å�ˆä¼šåˆ�始化 C。 -¶ÔÓÚ bean µÄʵÀý»¯Óë³õʼ»¯£¬ÕâÀïÐèÒªÃ÷È·Ï£º +对于 bean 的实例化与åˆ�始化,这里需è¦�明确下: -* ʵÀý»¯£º½öÖ¸´´½¨¶ÔÏóµÄ²Ù×÷£¬¿ÉÒÔʹÓà new »ò·´Éä»úÖÆ£¬Î´´¦Àí spring ÊôÐÔ×¢Èë¼°Ö®ºóµÄÔËÐгõʼ»¯·½·¨¡¢±£´æµ½ spring ÈÝÆ÷µÈһϵÁвÙ×÷£» -* ³õʼ»¯£º¶ÔʵÀý»¯ºóµÄ¶ÔÏó½øÐÐÊôÐÔ×¢Èë¡¢ÔËÐгõʼ»¯·½·¨£¬×îÖÕ±£´æµ½ spring ÈÝÆ÷£» +* 实例化:仅指创建对象的æ“�作,å�¯ä»¥ä½¿ç”¨ new 或å��射机制,未处ç�† spring 属性注入å�Šä¹‹å�Žçš„è¿�行åˆ�始化方法ã€�ä¿�存到 spring 容器等一系列æ“�作; +* åˆ�始化:对实例化å�Žçš„对象进行属性注入ã€�è¿�行åˆ�始化方法,最终ä¿�存到 spring 容器; -#### 4\. ³õʼ»¯ bean +#### 4\. åˆ�始化 bean -spring ³õʼ»¯ bean µÄ·½·¨ÊÇ `AbstractAutowireCapableBeanFactory#initializeBean(String, Object, RootBeanDefinition)`: +spring åˆ�始化 bean 的方法是 `AbstractAutowireCapableBeanFactory#initializeBean(String, Object, RootBeanDefinition)`: ``` protected Object initializeBean(final String beanName, final Object bean, @Nullable RootBeanDefinition mbd) { - // 1\. ÔËÐÐ invokeAwareMethods + // 1\. è¿�行 invokeAwareMethods if (System.getSecurityManager() != null) { AccessController.doPrivileged((PrivilegedAction) () -> { invokeAwareMethods(beanName, bean); @@ -854,22 +854,22 @@ protected Object initializeBean(final String beanName, final Object bean, invokeAwareMethods(beanName, bean); } - // 2\. ÔËÐÐ applyBeanPostProcessorsBeforeInitialization + // 2\. è¿�行 applyBeanPostProcessorsBeforeInitialization Object wrappedBean = bean; if (mbd == null || !mbd.isSynthetic()) { - // Ö´ÐÐ spring µ±ÖеÄÄÚÖô¦ÀíÆ÷¡ª¡ªxxxPostProcessor-------@PostConstruct + // 执行 spring 当中的内置处ç�†å™¨â€”—xxxPostProcessor-------@PostConstruct wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName); } try { - // 3\. Ö´ÐÐ InitializingBean ³õʼ»¯ + // 3\. 执行 InitializingBean åˆ�始化 invokeInitMethods(beanName, wrappedBean, mbd); } catch (Throwable ex) { ... } if (mbd == null || !mbd.isSynthetic()) { - // 4\. ÔËÐÐ applyBeanPostProcessorsAfterInitialization + // 4\. è¿�行 applyBeanPostProcessorsAfterInitialization wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName); } @@ -878,16 +878,16 @@ protected Object initializeBean(final String beanName, final Object bean, ``` -ÒÔÉÏ´úÂëÖ÷ÒªÊÇÓÃÀ´ÔËÐÐ 4 ¸ö·½·¨£º +以上代ç �主è¦�是用æ�¥è¿�行 4 个方法: 1. invokeAwareMethods(beanName, bean); 2. applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName); 3. invokeInitMethods(beanName, wrappedBean, mbd); 4. applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName); -##### 4.1 µ÷Óà Aware bean µÄ·½·¨ +##### 4.1 调用 Aware bean 的方法 -`invokeAwareMethods` ¾ÍÊÇÖ´ÐÐ Aware bean µÄÏà¹Ø·½·¨£º +`invokeAwareMethods` 就是执行 Aware bean 的相关方法: ``` private void invokeAwareMethods(final String beanName, final Object bean) { @@ -909,18 +909,18 @@ private void invokeAwareMethods(final String beanName, final Object bean) { ``` -ÒÔÉÏ·½·¨±È½Ï¼òµ¥£¬¾Í²»¶à˵ÁË¡£ +以上方法比较简å�•,就ä¸�多说了。 -##### 4.2 ÔËÐкóÖô¦ÀíÆ÷µÄ `postProcessBeforeInitialization` ·½·¨ +##### 4.2 è¿�行å�Žç½®å¤„ç�†å™¨çš„ `postProcessBeforeInitialization` 方法 -½Ó×ÅÀ´¿´¿´ `AbstractAutowireCapableBeanFactory#applyBeanPostProcessorsBeforeInitialization` µÄÔËÐУº +接ç�€æ�¥çœ‹çœ‹ `AbstractAutowireCapableBeanFactory#applyBeanPostProcessorsBeforeInitialization` çš„è¿�行: ``` public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName) throws BeansException { Object result = existingBean; for (BeanPostProcessor processor : getBeanPostProcessors()) { - // µ÷ÓúóÖô¦ÀíÆ÷ + // 调用å�Žç½®å¤„ç�†å™¨ Object current = processor.postProcessBeforeInitialization(result, beanName); if (current == null) { return result; @@ -932,7 +932,7 @@ public Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, S ``` -ÕâÀïÖ÷ÒªÔËÐÐ `ApplicationContextAwareProcessor#postProcessBeforeInitialization` ·½·¨£¬ÄÚÈÝÈçÏ£º +这里主è¦�è¿�行 `ApplicationContextAwareProcessor#postProcessBeforeInitialization` 方法,内容如下: ``` @Override @@ -954,7 +954,7 @@ public Object postProcessBeforeInitialization(Object bean, String beanName) thro }, acc); } else { - // ÔËÐз½·¨ + // è¿�行方法 invokeAwareInterfaces(bean); } return bean; @@ -976,7 +976,7 @@ private void invokeAwareInterfaces(Object bean) { if (bean instanceof MessageSourceAware) { ((MessageSourceAware) bean).setMessageSource(this.applicationContext); } - // ×°Åä ʵÏÖÁËApplicationContextAwareµÄÀàµÄ applicationContext + // 装é…� 实现了ApplicationContextAware的类的 applicationContext if (bean instanceof ApplicationContextAware) { ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext); } @@ -984,9 +984,9 @@ private void invokeAwareInterfaces(Object bean) { ``` -ÆäʵÕâ¸ö·½·¨¾ÍÊǸø¸÷ÖÖ `XxxAware` ¸³Öµ£¬±ÈÈç´óÃû¶¦¶¦µÄ `ApplicationContextAware` ¸³ÖµÒ²ÊÇÔÚÕâÀï½øÐС£ +其实这个方法就是给å�„ç§� `XxxAware` 赋值,比如大å��鼎鼎的 `ApplicationContextAware` 赋值也是在这里进行。 -˳´øÒ»ÌáµÄÊÇ£¬Èç¹ûÔÚ bean ÖУ¬·½·¨ÉÏÓÐ `@PostConstruct` ×¢½â£º +顺带一æ��的是,如果在 bean 中,方法上有 `@PostConstruct` 注解: ``` @PostConstruct @@ -996,16 +996,16 @@ public void test() { ``` -¸Ã·½·¨½«»áÔÚ `InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization` ÖнøÐе÷Ó㬴úÂë±È½Ï¼òµ¥£¬Ò²ÊÇÀûÓÃÁË jdk µÄ·´Éä»úÖÆ£¬ÕâÀï¾Í²»¶à˵ÁË¡£ +该方法将会在 `InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization` 中进行调用,代ç �比较简å�•,也是利用了 jdk çš„å��射机制,这里就ä¸�多说了。 -##### 4.3 µ÷Óà bean µÄ³õʼ»¯·½·¨ +##### 4.3 调用 bean çš„åˆ�始化方法 -½Ó×ÅÀ´¿´¿´ `AbstractAutowireCapableBeanFactory#invokeInitMethods` ·½·¨: +接ç�€æ�¥çœ‹çœ‹ `AbstractAutowireCapableBeanFactory#invokeInitMethods` 方法: ``` protected void invokeInitMethods(String beanName, final Object bean, @Nullable RootBeanDefinition mbd) throws Throwable { - // Ö´ÐÐ InitializingBean#afterPropertiesSet ·½·¨ + // 执行 InitializingBean#afterPropertiesSet 方法 boolean isInitializingBean = (bean instanceof InitializingBean); if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) { @@ -1021,12 +1021,12 @@ protected void invokeInitMethods(String beanName, final Object bean, } } else { - // Èç¹ûbeanʵÏÖÁË InitializingBean ½Ó¿Ú£¬Ôòµ÷Óà afterPropertiesSet() + // 如果bean实现了 InitializingBean 接å�£ï¼Œåˆ™è°ƒç”¨ afterPropertiesSet() ((InitializingBean) bean).afterPropertiesSet(); } } - // Ö´ÐÐ×Ô¶¨ÒåµÄ³õʼ»¯·½·¨£¬¼´ÔÚxmlÖУ¬Í¨¹ý init-method Ö¸¶¨µÄ·½·¨ + // 执行自定义的åˆ�始化方法,å�³åœ¨xml中,通过 init-method 指定的方法 if (mbd != null && bean.getClass() != NullBean.class) { String initMethodName = mbd.getInitMethodName(); if (StringUtils.hasLength(initMethodName) && @@ -1039,14 +1039,14 @@ protected void invokeInitMethods(String beanName, final Object bean, ``` -ÕâÀïÖ÷ÒªÊÇÔËÐÐÁ½¸ö·½·¨£º +这里主è¦�是è¿�行两个方法: -1. Èç¹û bean ʵÏÖÁË InitializingBean ½Ó¿Ú£¬Ôòµ÷Óà afterPropertiesSet () -2. Èç¹ûÖ¸¶¨ÁË init-method£¬ÔòÔÚ `invokeCustomInitMethod` ÖÐÔËÐУ¬Ò²ÊÇͨ¹ý jdk ·´Éä»úÖÆÀ´ÔËÐеģ¬¾Í²»¶à˵ÁË¡£ +1. 如果 bean 实现了 InitializingBean 接å�£ï¼Œåˆ™è°ƒç”¨ afterPropertiesSet () +2. 如果指定了 init-method,则在 `invokeCustomInitMethod` 中è¿�行,也是通过 jdk å��射机制æ�¥è¿�行的,就ä¸�多说了。 -##### 4.4 ÔËÐкóÖô¦ÀíÆ÷µÄ `postProcessAfterInitialization` ·½·¨ +##### 4.4 è¿�行å�Žç½®å¤„ç�†å™¨çš„ `postProcessAfterInitialization` 方法 -ÕâÒ»²½Ö÷ÒªÊÇÔËÐÐ `BeanPostProcessor#postProcessAfterInitialization`£¬ËùÔËÐÐµÄ `BeanPostProcessor` ÊÇ `ApplicationListenerDetector`: +这一步主è¦�是è¿�行 `BeanPostProcessor#postProcessAfterInitialization`,所è¿�行的 `BeanPostProcessor` 是 `ApplicationListenerDetector`: ``` @Override @@ -1065,41 +1065,41 @@ public Object postProcessAfterInitialization(Object bean, String beanName) { ``` -Õâ¸ö·½·¨ÊÇÓÃÀ´´¦Àí `ApplicationListener` µÄ£¬Èç¹ûÓÐ bean ʵÏÖÁË `ApplicationListener`£¬¾ÍÊÇÔÚÕâÀïÌí¼Óµ½ spring µÄ¼àÌýÆ÷ÁбíµÄ¡£ +这个方法是用æ�¥å¤„ç�† `ApplicationListener` 的,如果有 bean 实现了 `ApplicationListener`,就是在这里添加到 spring 的监å�¬å™¨åˆ—表的。 -#### 5\. ×ܽá +#### 5\. 总结 -±¾ÎÄÖ÷Òª½éÉÜÁË spring bean ´´½¨¹ý³Ì£¬Ïà¹ØÁ÷³Ì×ܽáÈçÏ£º +本文主è¦�介ç»�了 spring bean 创建过程,相关æµ�程总结如下: -1. ʵÀý»¯ bean£¬Ö¸¶¨Á˳õʼ»¯·½·¨¡¢Ö¸¶¨ÁË `factory method`¡¢×ÔÖ÷ÍÆ¶Ï¹¹Ôì·½·¨µÈ·½Ê½£» +1. 实例化 bean,指定了åˆ�始化方法ã€�指定了 `factory method`ã€�自主推断构造方法等方å¼�ï¼› -2. ²éѯ´ý×¢ÈëµÄÊôÐÔ»ò·½·¨£¬¼´ÄÄЩÊôÐÔ»ò·½·¨Éϱê×¢ÁË `@Autowird`/`@Value`/`@Resource` +2. 查询待注入的属性或方法,å�³å“ªäº›å±žæ€§æˆ–方法上标注了 `@Autowird`/`@Value`/`@Resource` - * `AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` ÓÃÀ´²éÕÒ´øÓÐ @Autowired¡¢@Value ×¢½âµÄÊôÐԺͷ½·¨ - * `CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` ÓÃÀ´²éÕÒ´øÓÐ @Resource ×¢½âµÄÊôÐԺͷ½·¨ -3. ÊôÐÔÌî³ä + * `AutowiredAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` 用æ�¥æŸ¥æ‰¾å¸¦æœ‰ @Autowiredã€�@Value 注解的属性和方法 + * `CommonAnnotationBeanPostProcessor.postProcessMergedBeanDefinition` 用æ�¥æŸ¥æ‰¾å¸¦æœ‰ @Resource 注解的属性和方法 +3. 属性填充 - * `AutowiredAnnotationBeanPostProcessor.postProcessProperties` ´¦Àí `@Autowired`¡¢`@Value` ×¢½â£¬`CommonAnnotationBeanPostProcessor.postProcessProperties` ´¦Àí `@Resource` ×¢½â - * ´¦Àí `@Autowired` ʱ£¬Ïȸù¾ÝÀàÐÍÕÒµ½ËùÓÐµÄ `Class`£¬Èç¹ûÓжà¸ö£¬ÔÙ¸ù¾Ý×¢ÈëÊôÐÔµÄÃû³Æ²éÕÒ·ûºÏµÄ `Class`£¬×îºóµ÷Óà `beanFactory.getBean(...)` ´Ó spring »ñȡҪעÈëµÄ¶ÔÏó£¬Í¨¹ý·´Éä»úÖÆÎª¶ÔÓ¦µÄÊôÐÔÉèÖÃÖµ£» -4. ³õʼ»¯ bean + * `AutowiredAnnotationBeanPostProcessor.postProcessProperties` 处ç�† `@Autowired`ã€�`@Value` 注解,`CommonAnnotationBeanPostProcessor.postProcessProperties` 处ç�† `@Resource` 注解 + * 处ç�† `@Autowired` 时,先根æ�®ç±»åž‹æ‰¾åˆ°æ‰€æœ‰çš„ `Class`,如果有多个,å†�æ ¹æ�®æ³¨å…¥å±žæ€§çš„å��称查找符å�ˆçš„ `Class`,最å�Žè°ƒç”¨ `beanFactory.getBean(...)` 从 spring 获å�–è¦�注入的对象,通过å��射机制为对应的属性设置值; +4. åˆ�始化 bean - 1. Ö´ÐÐ Aware bean µÄÏà¹Ø·½·¨ - 2. µ÷Óà `BeanPostProcessor#postProcessBeforeInitialization` ·½·¨ - * ÔÚ `ApplicationContextAwareProcessor#postProcessBeforeInitialization` ÖÐÖ´ÐÐ Aware bean µÄÏà¹Ø·½·¨ - * ÔÚ `InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization` Öд¦Àí `@PostConstruct` ×¢½â - 3. Ö´Ðгõʼ»¯·½·¨ - * Ö´ÐÐ `InitializingBean#afterPropertiesSet` ·½·¨ - * Ö´ÐÐ×Ô¶¨ÒåµÄ `init-method` ·½·¨ - 4. ÔËÐÐ `BeanPostProcessor#postProcessAfterInitialization` ·½·¨ - * ÔÚ `ApplicationListenerDetector#postProcessAfterInitialization` Öд¦Àí spring ¼àÌýÆ÷ + 1. 执行 Aware bean 的相关方法 + 2. 调用 `BeanPostProcessor#postProcessBeforeInitialization` 方法 + * 在 `ApplicationContextAwareProcessor#postProcessBeforeInitialization` 中执行 Aware bean 的相关方法 + * 在 `InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization` 中处ç�† `@PostConstruct` 注解 + 3. 执行åˆ�始化方法 + * 执行 `InitializingBean#afterPropertiesSet` 方法 + * 执行自定义的 `init-method` 方法 + 4. è¿�行 `BeanPostProcessor#postProcessAfterInitialization` 方法 + * 在 `ApplicationListenerDetector#postProcessAfterInitialization` 中处ç�† spring 监å�¬å™¨ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b7a4d4bc1bfbd76537e40cf843b0d18df93.png) -¹ØÓÚ spring bean µÄ´´½¨Á÷³Ì¾ÍÏÈ·ÖÎöµ½ÕâÀïÁË£¬²»¹ý spring ÔÚ´´½¨ bean µÄ¹ý³ÌÖУ¬ÓÐÒ»¸öÎÞ·¨ºöÊÓµÄÇé¿ö£ºÑ­»·ÒÀÀµ£¬¹ØÓÚÕâ·½ÃæµÄ´¦Àí£¬¿ÉÒԲο¼£º +关于 spring bean 的创建æµ�程就先分æž�到这里了,ä¸�过 spring 在创建 bean 的过程中,有一个无法忽视的情况:循环ä¾�赖,关于这方é�¢çš„处ç�†ï¼Œå�¯ä»¥å�‚考: -* [spring Ì½ÃØÖ®Ñ­»·ÒÀÀµµÄ½â¾ö£¨Ò»£©£ºÀíÂÛ»ùʯ](https://my.oschina.net/funcy/blog/4659555) -* [spring Ì½ÃØÖ®Ñ­»·ÒÀÀµµÄ½â¾ö£¨¶þ£©£ºÔ´Âë·ÖÎö](https://my.oschina.net/funcy/blog/4815992) +* [spring 探秘之循环ä¾�赖的解决(一):ç�†è®ºåŸºçŸ³](https://my.oschina.net/funcy/blog/4659555) +* [spring 探秘之循环ä¾�赖的解决(二):æº�ç �分æž�](https://my.oschina.net/funcy/blog/4815992) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4659524](https://my.oschina.net/funcy/blog/4659524) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4659524](https://my.oschina.net/funcy/blog/4659524) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232ApplicationContext\347\232\204\345\210\233\345\273\272.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232ApplicationContext\347\232\204\345\210\233\345\273\272.md" index 9b9d16e..b5d62b9 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232ApplicationContext\347\232\204\345\210\233\345\273\272.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\214\357\274\211\357\274\232ApplicationContext\347\232\204\345\210\233\345\273\272.md" @@ -1,8 +1,8 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-07194ddebd25cb2b71ee5e422bf84e8a397.png) -ÔÚÇ°ÃæÒ»ÆªÎÄÕÂÖУ¬ÎÒÃÇ·ÖÎöÁË spring µÄÕûÌåÆô¶¯Á÷³Ì£¬´ÓÕâÆª¿ªÊ¼ £¬ÎÒÃǽ«¶ÔÆô¶¯¹ý³ÌÖеÄһЩ¹Ø¼ü´úÂë½øÐзÖÎö¡£ +在å‰�é�¢ä¸€ç¯‡æ–‡ç« ä¸­ï¼Œæˆ‘们分æž�了 spring 的整体å�¯åЍæµ�程,从这篇开始 ,我们将对å�¯åŠ¨è¿‡ç¨‹ä¸­çš„ä¸€äº›å…³é”®ä»£ç �进行分æž�。 -·ÖÎöÒÀ¾ÉÊÇ»ùÓÚµÄ `demo01`£¬ÎÒÃÇÖ±½Ó½øÐÐ `ApplicationContext context = new AnnotationConfigApplicationContext("org.springframework.learn.demo01");` µÄÖ´ÐÐÖУº +分æž�ä¾�旧是基于的 `demo01`,我们直接进行 `ApplicationContext context = new AnnotationConfigApplicationContext("org.springframework.learn.demo01");` 的执行中: > AnnotationConfigApplicationContext @@ -15,24 +15,24 @@ public AnnotationConfigApplicationContext(String... basePackages) { ``` -Õâ¸ö·½·¨Ö»ÓÐÈýÐУ¬Ã¿ÐдúÂëµÄ×÷ÓÃÔÚ [spring Æô¶¯Á÷³Ì¸ÅÀÀ](https://my.oschina.net/funcy/blog/4597493 "springÆô¶¯Á÷³Ì¸ÅÀÀ")ÒÑ×ö¹ý˵Ã÷£¬ÕâÀïÎÒÃǽ«¶ÔÕâЩ·½·¨Õ¹¿ª£¬Ïêϸ·ÖÎöÀïÃæµÄÄÚÈÝ¡£ +这个方法å�ªæœ‰ä¸‰è¡Œï¼Œæ¯�行代ç �的作用在 [spring å�¯åЍæµ�程概览](https://my.oschina.net/funcy/blog/4597493 "springå�¯åЍæµ�程概览")å·²å�šè¿‡è¯´æ˜Žï¼Œè¿™é‡Œæˆ‘们将对这些方法展开,详细分æž�里é�¢çš„内容。 -### 1. `beanFacotry` µÄ´´½¨ +### 1. `beanFacotry` 的创建 -ÎÒÃÇÖ±½Ó½øÐÐ `this()` ·½·¨£¬ÄÚÈÝÈçÏ£º +我们直接进行 `this()` 方法,内容如下: > AnnotationConfigApplicationContext ``` public AnnotationConfigApplicationContext() { - // AnnotatedBeanDefinitionReader ½âÎö @Configuration + // AnnotatedBeanDefinitionReader è§£æž� @Configuration this.reader = new AnnotatedBeanDefinitionReader(this); this.scanner = new ClassPathBeanDefinitionScanner(this); } ``` -±íÃæÉÏ¿´£¬´úÂëÖ»ÓÐÁ½ÐУ¬´´½¨ÁËÁ½¸ö¶ÔÏó¡£µ«ÊìϤ java »ù´¡Óï·¨µÄ¶¼ÖªµÀ£¬×ÓÀàÔÚµ÷Óù¹Ôì·½·¨Ê±£¬»áÏȵ÷Óø¸ÀàµÄ¹¹Ôì·½·¨ÔÙÖ´ÐÐ×ÓÀ๹Ôì·½·¨µÄ´úÂ룬ÒòЩÎÒÃÇ»¹ÐèÒª¿´¿´¸ÃÀàµÄ¸¸À๹Ôì·½·¨Àï×öÁËʲô£º +表é�¢ä¸Šçœ‹ï¼Œä»£ç �å�ªæœ‰ä¸¤è¡Œï¼Œåˆ›å»ºäº†ä¸¤ä¸ªå¯¹è±¡ã€‚但熟悉 java 基础语法的都知é�“,å­�类在调用构造方法时,会先调用父类的构造方法å†�执行å­�类构造方法的代ç �,因些我们还需è¦�看看该类的父类构造方法里å�šäº†ä»€ä¹ˆï¼š > GenericApplicationContext @@ -43,22 +43,22 @@ public GenericApplicationContext() { ``` -¿ÉÒÔ¿´µ½£¬¸¸ÀàµÄ¹¹Ôì·½·¨Àï½ö×öÁËÒ»¼þÊ£º´´½¨ `beanFactory`¡£×Ô´Ë£¬ÎÒÃÇ¿ÉÒÔÖªµÀ£º**`AnnotationConfigApplicationContext` ʹÓÃµÄ `BeanFacotry` Ϊ `DefaultListableBeanFactory`**¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œçˆ¶ç±»çš„æž„造方法里仅å�šäº†ä¸€ä»¶äº‹ï¼šåˆ›å»º `beanFactory`。自此,我们å�¯ä»¥çŸ¥é�“:**`AnnotationConfigApplicationContext` 使用的 `BeanFacotry` 为 `DefaultListableBeanFactory`**。 -ÎÒÃÇÔٻص½ `AnnotationConfigApplicationContext` µÄ¹¹Ôì·½·¨£º +我们å†�回到 `AnnotationConfigApplicationContext` 的构造方法: > AnnotationConfigApplicationContext ``` public AnnotationConfigApplicationContext() { - // AnnotatedBeanDefinitionReader ½âÎö @Configuration + // AnnotatedBeanDefinitionReader è§£æž� @Configuration this.reader = new AnnotatedBeanDefinitionReader(this); this.scanner = new ClassPathBeanDefinitionScanner(this); } ``` -Õâ¸ö·½·¨ËäȻֻÓÐÁ½ÐУ¬×÷ÓÃÈ´²»Ð¡¡£ÎÒÃÇÉîÈë `new AnnotatedBeanDefinitionReader(this);` ¿´Ï£¬ÓÉÓÚÆäÖеķ½·¨µ÷Óò¢²»ÖØÒª£¬ÕâÀï½öÌṩµ÷ÓÃÁ´£º +这个方法虽然å�ªæœ‰ä¸¤è¡Œï¼Œä½œç”¨å�´ä¸�å°�。我们深入 `new AnnotatedBeanDefinitionReader(this);` 看下,由于其中的方法调用并ä¸�é‡�è¦�,这里仅æ��供调用链: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext() @@ -69,15 +69,15 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext() ``` -¿ÉÒÔ¿´µ½£¬×îÖÕÊǵ÷ÓÃÁË `AnnotationConfigUtils#registerAnnotationConfigProcessors(BeanDefinitionRegistry, Object)`£¬ÎÒÃDz鿴ϸ÷½·¨£¬ÎªÁËÖ±¹Û²é¿´£¬ÕâÀïÊ¡ÂÔÁ˲»±ØÒªµÄ´úÂ룬ÎÒÃǽö¹Ø×¢Ö÷ÒªµÄÁ÷³Ì¼´¿É£º +å�¯ä»¥çœ‹åˆ°ï¼Œæœ€ç»ˆæ˜¯è°ƒç”¨äº† `AnnotationConfigUtils#registerAnnotationConfigProcessors(BeanDefinitionRegistry, Object)`,我们查看下该方法,为了直观查看,这里çœ�略了ä¸�å¿…è¦�的代ç �,我们仅关注主è¦�çš„æµ�程å�³å�¯ï¼š ``` public static Set registerAnnotationConfigProcessors( BeanDefinitionRegistry registry, @Nullable Object source) { - // »ñµÃbeanFactory + // 获得beanFactory DefaultListableBeanFactory beanFactory = unwrapDefaultListableBeanFactory(registry); - // -------- ÍùbeanFactoryÖÐÌí¼Ó´¦ÀíÀà + // -------- å¾€beanFactory中添加处ç�†ç±» if (beanFactory != null) { if (!(beanFactory.getDependencyComparator() instanceof AnnotationAwareOrderComparator)) { beanFactory.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE); @@ -90,7 +90,7 @@ public static Set registerAnnotationConfigProcessors( Set beanDefs = new LinkedHashSet<>(8); - // ------------ ÍùbeanFactoryÖÐÌí¼ÓbeanDefinition + // ------------ å¾€beanFactory中添加beanDefinition if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) { RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class); def.setSource(source); @@ -140,22 +140,22 @@ public static Set registerAnnotationConfigProcessors( ``` -Õâ¸ö·½·¨´úÂëËäÈ»Óе㳤£¬µ«¹¦ÄÜÈ´Ï൱ֱ°×£¬¾ÍÊÇÏò `beanFactory` Ìí¼Ó `annotation` Ïà¹ØµÄ´¦ÀíÆ÷¡£Êµ¼ÊÉÏ£¬ÔÚ [spring Æô¶¯Á÷³Ì¸ÅÀÀ](https://my.oschina.net/funcy/blog/4597493 "springÆô¶¯Á÷³Ì¸ÅÀÀ")Ìáµ½µÄ beanDefinitionMap ÖÐ 4 ¸öĬÈ쵀 beanDefinition ¾ÍÊÇÔÚÕâÀïÌí¼ÓµÄ£º +这个方法代ç �虽然有点长,但功能å�´ç›¸å½“直白,就是å�‘ `beanFactory` 添加 `annotation` 相关的处ç�†å™¨ã€‚实际上,在 [spring å�¯åЍæµ�程概览](https://my.oschina.net/funcy/blog/4597493 "springå�¯åЍæµ�程概览")æ��到的 beanDefinitionMap 中 4 个默认的 beanDefinition 就是在这里添加的: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a490052bdc1379ef24a7754c65584214c1c.png) -½Ó×ÅÎÒÃÇÔÙ¹Ø×¢ `this.scanner = new ClassPathBeanDefinitionScanner(this)`£¬ÕâÊdzõʼ»¯ `scanner` ¶ÔÏó£¬ÀàÐÍΪ `ClassPathBeanDefinitionScanner`£¬¸ÃÀà´ÓÃû×ÖÉÏ¿ÉÒÔ¿´³ö£¬ÕâÊÇÓë `classPath` Ïà¹ØµÄ£¬`beanDefinition` ɨÃèÆ÷£¬Í¨Ë×µØËµ£¬¾ÍÊÇ**ɨÃè classPath ·¾¶£¬½« java class Îļþ×é×°³É `beanDefinition` ¶ÔÏó**¡£ +接ç�€æˆ‘们å†�关注 `this.scanner = new ClassPathBeanDefinitionScanner(this)`,这是åˆ�始化 `scanner` 对象,类型为 `ClassPathBeanDefinitionScanner`,该类从å��字上å�¯ä»¥çœ‹å‡ºï¼Œè¿™æ˜¯ä¸Ž `classPath` 相关的,`beanDefinition` 扫æ��器,通俗地说,就是**扫æ�� classPath 路径,将 java class 文件组装æˆ� `beanDefinition` 对象**。 -### 2\. ×ܽá +### 2\. 总结 -`AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...)` ÖÐ `this()` µÄÖ´ÐоͷÖÎöµ½ÕâÀïÁË£¬ÕâÒ» ÐдúÂëÖ÷Òª×öÁËÕ⼸¼þÊ£º +`AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...)` 中 `this()` 的执行就分æž�到这里了,这一 行代ç �主è¦�å�šäº†è¿™å‡ ä»¶äº‹ï¼š -1. ´´½¨ÁËÀàÐÍΪ `DefaultListableBeanFactory` µÄ `beanFactory` -2. ´´½¨ÁËÀàÐÍΪ `AnnotatedBeanDefinitionReader` µÄ reader£¬ÔÚÆä´´½¨µÄ¹ý³ÌÖУ¬»áÍù `beanFactory` Ìí¼Ó annotation Ïà¹ØµÄ´¦ÀíÆ÷ -3. ´´½¨ÁËÀàÐÍΪ `ClassPathBeanDefinitionScanner` µÄ `scanner` +1. 创建了类型为 `DefaultListableBeanFactory` çš„ `beanFactory` +2. 创建了类型为 `AnnotatedBeanDefinitionReader` çš„ reader,在其创建的过程中,会往 `beanFactory` 添加 annotation 相关的处ç�†å™¨ +3. 创建了类型为 `ClassPathBeanDefinitionScanner` çš„ `scanner` -±¾ÎÄÁ÷³ÌͼʾÈçÏ£º +本文æµ�程图示如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b7a7a01b4d38769419a0e25e8f60037cbb5.png) -±¾ÎľÍÏȵ½ÕâÀïÁË£¬½ÓÏÂÀ´µÄÎÄÕÂÎÒÃǼÌÐø·ÖÎöºóÐøµÄ´úÂë¡£ \ No newline at end of file +本文就先到这里了,接下æ�¥çš„æ–‡ç« æˆ‘们继续分æž�å�Žç»­çš„代ç �。 \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\346\211\247\350\241\214BeanFactoryPostProcessor.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\346\211\247\350\241\214BeanFactoryPostProcessor.md" index 1aea867..6d5cb25 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\346\211\247\350\241\214BeanFactoryPostProcessor.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\344\272\224\357\274\211\357\274\232\346\211\247\350\241\214BeanFactoryPostProcessor.md" @@ -1,10 +1,10 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c8c446fca94a382109bdc7b6babd6db4c0d.png) -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö¡£ +接上文,我们继续分æž�。 -### 4\. À©Õ¹µã£º`postProcessBeanFactory(beanFactory)` +### 4\. 扩展点:`postProcessBeanFactory(beanFactory)` -Õâ¸öÀàÊÇ spring ÌṩµÄÀ©Õ¹µã£¬±¾Éí²¢ÎÞÈκι¦ÄÜ£¬Áô´ý×ÓÀàʵÏÖ£¬`AbstractApplicationContext` µÄ `postProcessBeanFactory` ·½·¨´úÂëÈçÏ£º +这个类是 spring æ��供的扩展点,本身并无任何功能,留待å­�类实现,`AbstractApplicationContext` çš„ `postProcessBeanFactory` 方法代ç �如下: ``` protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { @@ -12,19 +12,19 @@ ``` -µ±Ç°ÎÒÃÇʹÓÃµÄ `ApplicationContext` ÊÇ `AnnotationConfigApplicationContext`£¬²¢Ã»ÓÐʵÏÖÕâ¸ö·½·¨¡£ +当å‰�我们使用的 `ApplicationContext` 是 `AnnotationConfigApplicationContext`,并没有实现这个方法。 -### 5\. Ö´ÐÐ `BeanFactoryPostProcessors`: `invokeBeanFactoryPostProcessors(beanFactory)` +### 5\. 执行 `BeanFactoryPostProcessors`: `invokeBeanFactoryPostProcessors(beanFactory)` -> `BeanFactoryPostProcessor` ³ÆÎª beanFactory µÄºóÖô¦Àí£¬ÓÃÀ´ÐÞ¸Ä beanFactory µÄһЩÐÐΪ¡£¹ØÓÚ `BeanFactoryPostProcessor` µÄÏêϸ·ÖÎö£¬¿ÉÒԲο¼ [spring ×é¼þÖ® BeanFactoryPostProcessors](https://my.oschina.net/funcy/blog/4597545)¡£ +> `BeanFactoryPostProcessor` 称为 beanFactory çš„å�Žç½®å¤„ç�†ï¼Œç”¨æ�¥ä¿®æ”¹ beanFactory 的一些行为。关于 `BeanFactoryPostProcessor` 的详细分æž�,å�¯ä»¥å�‚考 [spring 组件之 BeanFactoryPostProcessors](https://my.oschina.net/funcy/blog/4597545)。 -¹ØÓÚ `BeanFactoryPostProcessor`£¬ÕâÀïÌἸµã£º +关于 `BeanFactoryPostProcessor`,这里æ��几点: -* `BeanFactoryPostProcessor` ·ÖΪÁ½ÖÖ£º`BeanFactoryPostProcessor` Óë `BeanDefinitionRegistryPostProcessor` -* `BeanDefinitionRegistryPostProcessor` ÊÇ `BeanFactoryPostProcessor` µÄ×ÓÀà -* ÏÈÖ´ÐÐ `BeanDefinitionRegistryPostProcessor` µÄ·½·¨£¬ÔÙÖ´ÐÐ `BeanFactoryPostProcessor` µÄ·½·¨ +* `BeanFactoryPostProcessor` 分为两ç§�:`BeanFactoryPostProcessor` 与 `BeanDefinitionRegistryPostProcessor` +* `BeanDefinitionRegistryPostProcessor` 是 `BeanFactoryPostProcessor` çš„å­�ç±» +* 先执行 `BeanDefinitionRegistryPostProcessor` 的方法,å†�执行 `BeanFactoryPostProcessor` 的方法 -Á˽âÕâЩºó£¬ÎÒÃǸú½ø´úÂ룬ÕâÀï¶Ô²»ÖØÒª´úÂëÒÀ¾ÉÖ»¸ø³öµ÷ÓÃÁ´£¬ÈçÏ£º +了解这些å�Žï¼Œæˆ‘们跟进代ç �,这里对ä¸�é‡�è¦�代ç �ä¾�æ—§å�ªç»™å‡ºè°ƒç”¨é“¾ï¼Œå¦‚下: ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -35,34 +35,34 @@ ``` -ÎÒÃÇÖ±½Ó¿´ `invokeBeanFactoryPostProcessors` ·½·¨£º +我们直接看 `invokeBeanFactoryPostProcessors` 方法: ``` public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory, List beanFactoryPostProcessors) { - // ËùÓдæÔÚµÄBeanDefinitionRegistryPostProcessorµÄÃû×Ö + // 所有存在的BeanDefinitionRegistryPostProcessorçš„å��å­— Set processedBeans = new HashSet<>(); - //beanFactoryÊÇDefaultListableBeanFactory£¬ÊÇBeanDefinitionRegistryµÄʵÏÖÀ࣬ËùÒԿ϶¨Âú×ãif + //beanFactory是DefaultListableBeanFactory,是BeanDefinitionRegistry的实现类,所以肯定满足if if (beanFactory instanceof BeanDefinitionRegistry) { BeanDefinitionRegistry registry = (BeanDefinitionRegistry) beanFactory; - //regularPostProcessors ÓÃÀ´´æ·ÅBeanFactoryPostProcessor + //regularPostProcessors 用æ�¥å­˜æ”¾BeanFactoryPostProcessor List regularPostProcessors = new ArrayList<>(); - //registryProcessors ÓÃÀ´´æ·ÅBeanDefinitionRegistryPostProcessor - //BeanDefinitionRegistryPostProcessor À©Õ¹ÁË BeanFactoryPostProcessor + //registryProcessors 用æ�¥å­˜æ”¾BeanDefinitionRegistryPostProcessor + //BeanDefinitionRegistryPostProcessor 扩展了 BeanFactoryPostProcessor List registryProcessors = new ArrayList<>(); - // Ñ­»·´«½øÀ´µÄbeanFactoryPostProcessors£¬Õý³£Çé¿öÏ£¬beanFactoryPostProcessors¿Ï¶¨Ã»ÓÐÊý¾Ý - // ÒòΪbeanFactoryPostProcessorsÊÇ»ñµÃÊÖ¶¯Ìí¼ÓµÄ£¬¶ø²»ÊÇspringɨÃèµÄ - // Ö»ÓÐÊÖ¶¯µ÷ÓÃannotationConfigApplicationContext.addBeanFactoryPostProcessor(XXX)²Å»áÓÐÊý¾Ý + // 循环传进æ�¥çš„beanFactoryPostProcessors,正常情况下,beanFactoryPostProcessors肯定没有数æ�® + // 因为beanFactoryPostProcessors是获得手动添加的,而ä¸�是spring扫æ��çš„ + // å�ªæœ‰æ‰‹åŠ¨è°ƒç”¨annotationConfigApplicationContext.addBeanFactoryPostProcessor(XXX)æ‰�会有数æ�® for (BeanFactoryPostProcessor postProcessor : beanFactoryPostProcessors) { - // ÅжÏpostProcessorÊDz»ÊÇBeanDefinitionRegistryPostProcessor£¬ - // ÒòΪBeanDefinitionRegistryPostProcessor À©Õ¹ÁËBeanFactoryPostProcessor£¬ - // ËùÒÔÕâÀïÏÈÒªÅжÏÊDz»ÊÇBeanDefinitionRegistryPostProcessor, Êǵϰ£¬Ö±½ÓÖ´ÐÐ - // postProcessBeanDefinitionRegistry·½·¨£¬È»ºó°Ñ¶ÔÏó×°µ½registryProcessorsÀïÃæÈ¥ + // 判断postProcessor是ä¸�是BeanDefinitionRegistryPostProcessor, + // 因为BeanDefinitionRegistryPostProcessor 扩展了BeanFactoryPostProcessor, + // 所以这里先è¦�判断是ä¸�是BeanDefinitionRegistryPostProcessor, 是的è¯�,直接执行 + // postProcessBeanDefinitionRegistry方法,然å�ŽæŠŠå¯¹è±¡è£…åˆ°registryProcessors里é�¢åŽ» if (postProcessor instanceof BeanDefinitionRegistryPostProcessor) { BeanDefinitionRegistryPostProcessor registryProcessor = (BeanDefinitionRegistryPostProcessor) postProcessor; @@ -70,56 +70,56 @@ public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFacto registryProcessors.add(registryProcessor); } else { - //²»Êǵϰ£¬¾Í×°µ½regularPostProcessors + //ä¸�是的è¯�,就装到regularPostProcessors regularPostProcessors.add(postProcessor); } } - // Ò»¸öÁÙʱ±äÁ¿£¬ÓÃÀ´×°ÔØBeanDefinitionRegistryPostProcessor - // BeanDefinitionRegistry¼Ì³ÐÁËPostProcessorBeanFactoryPostProcessor + // 一个临时å�˜é‡�,用æ�¥è£…è½½BeanDefinitionRegistryPostProcessor + // BeanDefinitionRegistry继承了PostProcessorBeanFactoryPostProcessor List currentRegistryProcessors = new ArrayList<>(); - // »ñµÃʵÏÖBeanDefinitionRegistryPostProcessor½Ó¿ÚµÄÀàµÄBeanName - // ÕâÀï°üº¬ÁËspringÄÚ²¿ÌṩµÄBeanDefinitionRegistryPostProcessor - // ÒÔ¼°¿ª·¢Õß×Ô¼ºÊµÏÖµÄBeanDefinitionRegistryPostProcessor + // 获得实现BeanDefinitionRegistryPostProcessor接å�£çš„类的BeanName + // 这里包å�«äº†spring内部æ��供的BeanDefinitionRegistryPostProcessor + // 以å�Šå¼€å�‘者自己实现的BeanDefinitionRegistryPostProcessor String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanDefinitionRegistryPostProcessor.class, true, false); for (String ppName : postProcessorNames) { if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { - //»ñµÃConfigurationClassPostProcessorÀ࣬²¢Çҷŵ½currentRegistryProcessors - //ConfigurationClassPostProcessorÊǺÜÖØÒªµÄÒ»¸öÀ࣬ËüʵÏÖÁË - //BeanDefinitionRegistryPostProcessor½Ó¿Ú£¬ - //BeanDefinitionRegistryPostProcessor½Ó¿ÚÓÖʵÏÖÁËBeanFactoryPostProcessor½Ó¿Ú - //ConfigurationClassPostProcessorÊǼ«ÆäÖØÒªµÄÀà, ÀïÃæÖ´ÐÐÁË - //ɨÃè @Bean£¬@Import£¬@ImportResource µÈ¸÷ÖÖ²Ù×÷ + //获得ConfigurationClassPostProcessor类,并且放到currentRegistryProcessors + //ConfigurationClassPostProcessor是很é‡�è¦�的一个类,它实现了 + //BeanDefinitionRegistryPostProcessor接å�£ï¼Œ + //BeanDefinitionRegistryPostProcessor接å�£å�ˆå®žçŽ°äº†BeanFactoryPostProcessor接å�£ + //ConfigurationClassPostProcessor是æž�å…¶é‡�è¦�的类, 里é�¢æ‰§è¡Œäº† + //扫æ�� @Bean,@Import,@ImportResource ç­‰å�„ç§�æ“�作 currentRegistryProcessors.add(beanFactory.getBean( ppName, BeanDefinitionRegistryPostProcessor.class)); processedBeans.add(ppName); } } - //´¦ÀíÅÅÐò + //处ç�†æŽ’åº� sortPostProcessors(currentRegistryProcessors, beanFactory); - //ºÏ²¢Processors£¬ÎªÊ²Ã´ÒªºÏ²¢£¬ÒòΪregistryProcessorsÊÇ - //×°ÔØBeanDefinitionRegistryPostProcessorµÄ - //Ò»¿ªÊ¼µÄʱºò£¬springÖ»»áÖ´ÐÐBeanDefinitionRegistryPostProcessor¶ÀÓеķ½·¨ - //¶ø²»»áÖ´ÐÐBeanDefinitionRegistryPostProcessor¸¸ÀàµÄ·½·¨£¬¼´BeanFactoryProcessorµÄ·½·¨ - //ËùÒÔÕâÀïÐèÒª°Ñ´¦ÀíÆ÷·ÅÈëÒ»¸ö¼¯ºÏÖУ¬ºóÐøÍ³Ò»Ö´Ðи¸ÀàµÄ·½·¨ + //å�ˆå¹¶Processors,为什么è¦�å�ˆå¹¶ï¼Œå› ä¸ºregistryProcessors是 + //装载BeanDefinitionRegistryPostProcessorçš„ + //一开始的时候,springå�ªä¼šæ‰§è¡ŒBeanDefinitionRegistryPostProcessor独有的方法 + //而ä¸�会执行BeanDefinitionRegistryPostProcessor父类的方法,å�³BeanFactoryProcessor的方法 + //所以这里需è¦�把处ç�†å™¨æ”¾å…¥ä¸€ä¸ªé›†å�ˆä¸­ï¼Œå�Žç»­ç»Ÿä¸€æ‰§è¡Œçˆ¶ç±»çš„æ–¹æ³• registryProcessors.addAll(currentRegistryProcessors); - //¿ÉÒÔÀí½âΪִÐÐConfigurationClassPostProcessorµÄpostProcessBeanDefinitionRegistry·½·¨ + //å�¯ä»¥ç�†è§£ä¸ºæ‰§è¡ŒConfigurationClassPostProcessorçš„postProcessBeanDefinitionRegistry方法 invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); - //ÒòΪcurrentRegistryProcessorsÊÇÒ»¸öÁÙʱ±äÁ¿£¬ËùÒÔÐèÒªÇå³ý + //因为currentRegistryProcessors是一个临时å�˜é‡�,所以需è¦�清除 currentRegistryProcessors.clear(); - // Ôٴθù¾ÝBeanDefinitionRegistryPostProcessor»ñµÃBeanName£¬ - // ¿´Õâ¸öBeanNameÊÇ·ñÒѾ­±»Ö´ÐйýÁË£¬ÓÐûÓÐʵÏÖOrdered½Ó¿Ú - // Èç¹ûûÓб»Ö´Ðйý£¬Ò²ÊµÏÖÁËOrdered½Ó¿ÚµÄ»°£¬°Ñ¶ÔÏóÍÆË͵½currentRegistryProcessors£¬ - // Ãû³ÆÍÆË͵½processedBeans - // Èç¹ûûÓÐʵÏÖOrdered½Ó¿ÚµÄ»°£¬ÕâÀï²»°ÑÊý¾Ý¼Óµ½currentRegistryProcessors£¬ - // processedBeansÖУ¬ºóÐøÔÙ×ö´¦Àí - // ÕâÀï²Å¿ÉÒÔ»ñµÃÎÒÃǶ¨ÒåµÄʵÏÖÁËBeanDefinitionRegistryPostProcessorµÄBean + // å†�次根æ�®BeanDefinitionRegistryPostProcessor获得BeanName, + // 看这个BeanName是å�¦å·²ç»�被执行过了,有没有实现Ordered接å�£ + // 如果没有被执行过,也实现了Ordered接å�£çš„è¯�,把对象推é€�到currentRegistryProcessors, + // å��称推é€�到processedBeans + // 如果没有实现Ordered接å�£çš„è¯�,这里ä¸�把数æ�®åŠ åˆ°currentRegistryProcessors, + // processedBeans中,å�Žç»­å†�å�šå¤„ç�† + // 这里æ‰�å�¯ä»¥èŽ·å¾—æˆ‘ä»¬å®šä¹‰çš„å®žçŽ°äº†BeanDefinitionRegistryPostProcessorçš„Bean postProcessorNames = beanFactory.getBeanNamesForType( BeanDefinitionRegistryPostProcessor.class, true, false); for (String ppName : postProcessorNames) { @@ -129,16 +129,16 @@ public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFacto processedBeans.add(ppName); } } - //´¦ÀíÅÅÐò + //处ç�†æŽ’åº� sortPostProcessors(currentRegistryProcessors, beanFactory); - //ºÏ²¢Processors + //å�ˆå¹¶Processors registryProcessors.addAll(currentRegistryProcessors); - //Ö´ÐÐÎÒÃÇ×Ô¶¨ÒåµÄBeanDefinitionRegistryPostProcessor + //执行我们自定义的BeanDefinitionRegistryPostProcessor invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry); - //Çå¿ÕÁÙʱ±äÁ¿ + //清空临时å�˜é‡� currentRegistryProcessors.clear(); - // ÉÏÃæµÄ´úÂëÊÇÖ´ÐÐÁËʵÏÖÁËOrdered½Ó¿ÚµÄBeanDefinitionRegistryPostProcessor£¬ - // ÏÂÃæµÄ´úÂë¾ÍÊÇÖ´ÐÐûÓÐʵÏÖOrdered½Ó¿ÚµÄBeanDefinitionRegistryPostProcessor + // 上é�¢çš„代ç �是执行了实现了Ordered接å�£çš„BeanDefinitionRegistryPostProcessor, + // 下é�¢çš„代ç �就是执行没有实现Ordered接å�£çš„BeanDefinitionRegistryPostProcessor boolean reiterate = true; while (reiterate) { reiterate = false; @@ -158,16 +158,16 @@ public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFacto currentRegistryProcessors.clear(); } - // registryProcessors¼¯ºÏ×°ÔØBeanDefinitionRegistryPostProcessor - // ÉÏÃæµÄ´úÂëÊÇÖ´ÐÐ×ÓÀà¶ÀÓеķ½·¨£¬ÕâÀïÐèÒªÔٰѸ¸ÀàµÄ·½·¨Ò²Ö´ÐÐÒ»´Î + // registryProcessors集å�ˆè£…è½½BeanDefinitionRegistryPostProcessor + // 上é�¢çš„代ç �是执行å­�类独有的方法,这里需è¦�å†�把父类的方法也执行一次 invokeBeanFactoryPostProcessors(registryProcessors, beanFactory); invokeBeanFactoryPostProcessors(regularPostProcessors, beanFactory); } else { - //regularPostProcessors×°ÔØBeanFactoryPostProcessor£¬Ö´ÐÐBeanFactoryPostProcessorµÄ·½·¨ - //µ«ÊÇregularPostProcessorsÒ»°ãÇé¿öÏ£¬ÊDz»»áÓÐÊý¾ÝµÄ£¬ - //Ö»ÓÐÔÚÍâÃæÊÖ¶¯Ìí¼ÓBeanFactoryPostProcessor£¬²Å»áÓÐÊý¾Ý + //regularPostProcessors装载BeanFactoryPostProcessor,执行BeanFactoryPostProcessor的方法 + //但是regularPostProcessors一般情况下,是ä¸�会有数æ�®çš„, + //å�ªæœ‰åœ¨å¤–é�¢æ‰‹åŠ¨æ·»åŠ BeanFactoryPostProcessor,æ‰�会有数æ�® invokeBeanFactoryPostProcessors(beanFactoryPostProcessors, beanFactory); } @@ -177,34 +177,34 @@ public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFacto List priorityOrderedPostProcessors = new ArrayList<>(); List orderedPostProcessorNames = new ArrayList<>(); List nonOrderedPostProcessorNames = new ArrayList<>(); - //Ñ­»·BeanNameÊý×é + //循环BeanName数组 for (String ppName : postProcessorNames) { - //Èç¹ûÕâ¸öBean±»Ö´ÐйýÁË£¬Ìø¹ý + //如果这个Bean被执行过了,跳过 if (processedBeans.contains(ppName)) { } - //Èç¹ûʵÏÖÁËPriorityOrdered½Ó¿Ú£¬¼ÓÈëµ½priorityOrderedPostProcessors + //如果实现了PriorityOrdered接å�£ï¼ŒåŠ å…¥åˆ°priorityOrderedPostProcessors else if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { priorityOrderedPostProcessors.add(beanFactory .getBean(ppName, BeanFactoryPostProcessor.class)); } - //Èç¹ûʵÏÖÁËOrdered½Ó¿Ú£¬¼ÓÈëµ½orderedPostProcessorNames + //如果实现了Ordered接å�£ï¼ŒåŠ å…¥åˆ°orderedPostProcessorNames else if (beanFactory.isTypeMatch(ppName, Ordered.class)) { orderedPostProcessorNames.add(ppName); } - //Èç¹û¼ÈûÓÐʵÏÖPriorityOrdered£¬Ò²Ã»ÓÐʵÏÖOrdered¡£¼ÓÈëµ½nonOrderedPostProcessorNames + //如果既没有实现PriorityOrdered,也没有实现Ordered。加入到nonOrderedPostProcessorNames else { nonOrderedPostProcessorNames.add(ppName); } } - // ÅÅÐò´¦ÀípriorityOrderedPostProcessors£¬¼´ÊµÏÖÁËPriorityOrdered½Ó¿ÚµÄBeanFactoryPostProcessor + // 排åº�处ç�†priorityOrderedPostProcessors,å�³å®žçŽ°äº†PriorityOrdered接å�£çš„BeanFactoryPostProcessor sortPostProcessors(priorityOrderedPostProcessors, beanFactory); - // Ö´ÐÐpriorityOrderedPostProcessors + // 执行priorityOrderedPostProcessors invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory); - // Ö´ÐÐʵÏÖÁËOrdered½Ó¿ÚµÄBeanFactoryPostProcessor + // 执行实现了Ordered接å�£çš„BeanFactoryPostProcessor List orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size()); for (String postProcessorName : orderedPostProcessorNames) { @@ -214,7 +214,7 @@ public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFacto sortPostProcessors(orderedPostProcessors, beanFactory); invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory); - // Ö´ÐмÈûÓÐʵÏÖPriorityOrdered½Ó¿Ú£¬Ò²Ã»ÓÐʵÏÖOrdered½Ó¿ÚµÄBeanFactoryPostProcessor + // 执行既没有实现PriorityOrdered接å�£ï¼Œä¹Ÿæ²¡æœ‰å®žçްOrdered接å�£çš„BeanFactoryPostProcessor List nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size()); for (String postProcessorName : nonOrderedPostProcessorNames) { @@ -228,47 +228,47 @@ public static void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFacto ``` -Õâ¸ö·½·¨·Ç³£·Ç³£³¤£¬µ«Àí½âÆðÀ´²¢²»ÄÑ£¬Ö´ÐÐÆðÀ´×ñÑ­Õ⼸Ìõ¹æÔò£º +这个方法é�žå¸¸é�žå¸¸é•¿ï¼Œä½†ç�†è§£èµ·æ�¥å¹¶ä¸�难,执行起æ�¥é�µå¾ªè¿™å‡ æ�¡è§„则: -* ÏÈÖ´ÐÐ `BeanDefinitionRegistryPostProcessor`£¬ÔÙÖ´ÐÐ `BeanFactoryPostProcessor` -* Ö´ÐÐ `BeanDefinitionRegistryPostProcessor` µÄ˳ÐòÈçÏ£º - 1. Ö´ÐвÎÊý´«ÈëµÄ `BeanDefinitionRegistryPostProcessor` - 2. Ö´ÐÐ spring ÄÚ²¿ÌṩµÄ£¬ÕâÀï»áÖ´ÐÐÒ»¸ö·Ç³£ÖØÒªµÄ `BeanDefinitionRegistryPostProcessor`¡ª¡ª`ConfigurationClassPostProcessor`£¬Ëü»á´¦ÀíÏîÄ¿ÖÐµÄ `@ComponentScan`¡¢`@Component`¡¢`@Import`¡¢`@Bean` µÈ×¢½â£¬¼ÓÔØÓû§×Ô¶¨ÒåµÄ `BeanDefinitionRegistryPostProcessor`¡¢`BeanFactoryPostProcessor` - 3. Ö´ÐÐÊ£Ï嵀 `BeanDefinitionRegistryPostProcessor`£¬Ò²¾ÍÊÇÔÚÉÏÒ»²½ÖмÓÔØµ½µÄ `BeanDefinitionRegistryPostProcessor` -* Ö´ÐÐ `BeanFactoryPostProcessor` µÄ˳ÐòÈçÏ£º - 1. Ö´ÐÐʵÏÖÁË `PriorityOrdered` ½Ó¿ÚµÄ `BeanFactoryPostProcessor` - 2. Ö´ÐÐʵÏÖÁË `Ordered` ½Ó¿ÚµÄ `BeanFactoryPostProcessor` - 3. Ö´ÐÐÊ£Ï嵀 `BeanFactoryPostProcessor` -* `BeanDefinitionRegistryPostProcessor` ÊÇ `BeanFactoryPostProcessor` µÄ×ÓÀ࣬ͬÑùÒªÖ´ÐÐ `BeanFactoryPostProcessor` µÄ·½·¨ +* 先执行 `BeanDefinitionRegistryPostProcessor`,å†�执行 `BeanFactoryPostProcessor` +* 执行 `BeanDefinitionRegistryPostProcessor` 的顺åº�如下: + 1. 执行å�‚数传入的 `BeanDefinitionRegistryPostProcessor` + 2. 执行 spring 内部æ��供的,这里会执行一个é�žå¸¸é‡�è¦�çš„ `BeanDefinitionRegistryPostProcessor`——`ConfigurationClassPostProcessor`,它会处ç�†é¡¹ç›®ä¸­çš„ `@ComponentScan`ã€�`@Component`ã€�`@Import`ã€�`@Bean` 等注解,加载用户自定义的 `BeanDefinitionRegistryPostProcessor`ã€�`BeanFactoryPostProcessor` + 3. 执行剩下的 `BeanDefinitionRegistryPostProcessor`,也就是在上一步中加载到的 `BeanDefinitionRegistryPostProcessor` +* 执行 `BeanFactoryPostProcessor` 的顺åº�如下: + 1. 执行实现了 `PriorityOrdered` 接å�£çš„ `BeanFactoryPostProcessor` + 2. 执行实现了 `Ordered` 接å�£çš„ `BeanFactoryPostProcessor` + 3. 执行剩下的 `BeanFactoryPostProcessor` +* `BeanDefinitionRegistryPostProcessor` 是 `BeanFactoryPostProcessor` çš„å­�类,å�Œæ ·è¦�执行 `BeanFactoryPostProcessor` 的方法 -ÒÔÉÏ˵µÄÖ´ÐÐ `BeanDefinitionRegistryPostProcessor`£¬ÊÇÖ¸Ö´ÐÐ `PostProcessorRegistrationDelegate#invokeBeanDefinitionRegistryPostProcessors`£¬Ö´ÐÐ `BeanFactoryPostProcessor` ÊÇÖ¸Ö´ÐÐ `BeanFactoryPostProcessor#postProcessBeanFactory` +以上说的执行 `BeanDefinitionRegistryPostProcessor`,是指执行 `PostProcessorRegistrationDelegate#invokeBeanDefinitionRegistryPostProcessors`,执行 `BeanFactoryPostProcessor` 是指执行 `BeanFactoryPostProcessor#postProcessBeanFactory` -Àí½âÒÔÉÏÄÚÈݺ󣬽ÓÏÂÀ´¾ÍÊǶÔÒÔÉÏ·½·¨µÄÏêϸ½âÊÍÁË£º +ç�†è§£ä»¥ä¸Šå†…容å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±æ˜¯å¯¹ä»¥ä¸Šæ–¹æ³•的详细解释了: -1. Ö´ÐÐ `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry`: - 1. Ö´Ðпª·¢ÕßÊÖ¶¯µ÷Óà `applicationContext.addBeanFactoryPostProcessor` Ìí¼ÓµÄ `BeanDefinitionRegistryPostProcessor` µÄ `postProcessBeanDefinitionRegistry` ·½·¨£¨Ò»°ãÇé¿öÏ£¬¿ª·¢Õß²»»áÊÖ¶¯µ÷Óø÷½·¨£©; - 2. Ö´ÐÐ spring ÄÚ²¿ÌṩµÄ¡¢ÊµÏÖÁË `PriorityOrdered` ½Ó¿ÚµÄ `BeanDefinitionRegistryPostProcessor` µÄ `postProcessBeanDefinitionRegistry` ·½·¨£» - 3. Ö´ÐÐʵÏÖÁË `Ordered` ½Ó¿ÚÇÒδִÐйýµÄ `BeanDefinitionRegistryPostProcessor` µÄ `postProcessBeanDefinitionRegistry` ·½·¨£» - 4. Ö´ÐÐÒÔÉÏδִÐйýµÄ `BeanDefinitionRegistryPostProcessor` µÄ `postProcessBeanDefinitionRegistry` ·½·¨£» -2. Ö´ÐÐ `BeanFactoryPostProcessor#postProcessBeanFactory` ·½·¨£º - 1. Ö´Ðпª·¢Õßµ÷Óà `applicationContext.addBeanFactoryPostProcessor` Ìí¼ÓµÄ `BeanDefinitionRegistryPostProcessor` µÄ `postProcessBeanFactory` ·½·¨£¨Ò»°ãÇé¿öÏ£¬¿ª·¢Õß²»»áÊÖ¶¯µ÷Óø÷½·¨£©; - 2. Ö´ÐÐÒÔÉÏ´ÓδִÐйýµÄ¡¢ÊµÏÖÁË `PriorityOrdered` µÄ `BeanFactoryPostProcessor` µÄ `postProcessBeanFactory` ·½·¨£» - 3. Ö´ÐÐÒÔÉÏ´ÓδִÐйýµÄ¡¢ÊµÏÖÁË `Ordered` µÄ `BeanFactoryPostProcessor` µÄ `postProcessBeanFactory` ·½·¨£» - 4. Ö´ÐÐÒÔÉÏ´ÓδִÐйýµÄ `BeanFactoryPostProcessor` µÄ `postProcessBeanFactory` ·½·¨ +1. 执行 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry`: + 1. 执行开å�‘者手动调用 `applicationContext.addBeanFactoryPostProcessor` 添加的 `BeanDefinitionRegistryPostProcessor` çš„ `postProcessBeanDefinitionRegistry` 方法(一般情况下,开å�‘者ä¸�会手动调用该方法); + 2. 执行 spring 内部æ��供的ã€�实现了 `PriorityOrdered` 接å�£çš„ `BeanDefinitionRegistryPostProcessor` çš„ `postProcessBeanDefinitionRegistry` 方法; + 3. 执行实现了 `Ordered` 接å�£ä¸”未执行过的 `BeanDefinitionRegistryPostProcessor` çš„ `postProcessBeanDefinitionRegistry` 方法; + 4. 执行以上未执行过的 `BeanDefinitionRegistryPostProcessor` çš„ `postProcessBeanDefinitionRegistry` 方法; +2. 执行 `BeanFactoryPostProcessor#postProcessBeanFactory` 方法: + 1. 执行开å�‘者调用 `applicationContext.addBeanFactoryPostProcessor` 添加的 `BeanDefinitionRegistryPostProcessor` çš„ `postProcessBeanFactory` 方法(一般情况下,开å�‘者ä¸�会手动调用该方法); + 2. 执行以上从未执行过的ã€�实现了 `PriorityOrdered` çš„ `BeanFactoryPostProcessor` çš„ `postProcessBeanFactory` 方法; + 3. 执行以上从未执行过的ã€�实现了 `Ordered` çš„ `BeanFactoryPostProcessor` çš„ `postProcessBeanFactory` 方法; + 4. 执行以上从未执行过的 `BeanFactoryPostProcessor` çš„ `postProcessBeanFactory` 方法 -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½·¨Êµ¼Ê¾ÍÊÇΪÁËÖ´ÐÐÁ½¸ö·½·¨£º`BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` Óë `BeanFactoryPostProcessor#postProcessBeanFactory`¡£ÐèҪעÒâµÄÊÇ£¬`BeanDefinitionRegistryPostProcessor` ÊÇ `BeanFactoryPostProcessor` µÄ×ÓÀ࣬ÔÚµ÷Óà `BeanFactoryPostProcessor#postProcessBeanFactory` ʱ £¬Êµ¼ÊÉÏÒ²µ÷ÓÃÁË `BeanDefinitionRegistryPostProcessor` µÄ `postProcessBeanFactory` ·½·¨. +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ³•实际就是为了执行两个方法:`BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` 与 `BeanFactoryPostProcessor#postProcessBeanFactory`。需è¦�注æ„�的是,`BeanDefinitionRegistryPostProcessor` 是 `BeanFactoryPostProcessor` çš„å­�类,在调用 `BeanFactoryPostProcessor#postProcessBeanFactory` æ—¶ ,实际上也调用了 `BeanDefinitionRegistryPostProcessor` çš„ `postProcessBeanFactory` 方法. -ÔÚÒÔÉ쵀 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` Óë `BeanFactoryPostProcessor#postProcessBeanFactory` Ö´ÐÐÖУ¬¾¿¾¹Ö´ÐÐÁËÄÄЩ´úÂëÄØ£¿ÕâÀïÎÒÃÇͨ¹ýµ÷ÊÔ `demo01`£¬·¢ÏÖÖ´ÐеĴúÂëÈçÏ£º +在以上的 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` 与 `BeanFactoryPostProcessor#postProcessBeanFactory` 执行中,究竟执行了哪些代ç �呢?这里我们通过调试 `demo01`,å�‘现执行的代ç �如下: -1. ÔÚ `1.2` ²½Öèʱ£¬Ö´ÐÐÁË `ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry` -2. ÔÚ `1.4` ²½Öèʱ£¬Ö´ÐÐÁË `ConfigurationClassPostProcessor#postProcessBeanFactory` -3. ÔÚ `2.4` ²½Öèʱ£¬Ö´ÐÐÁË `EventListenerMethodProcessor#postProcessBeanFactory` +1. 在 `1.2` 步骤时,执行了 `ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry` +2. 在 `1.4` 步骤时,执行了 `ConfigurationClassPostProcessor#postProcessBeanFactory` +3. 在 `2.4` 步骤时,执行了 `EventListenerMethodProcessor#postProcessBeanFactory` -½Ó×Å£¬ÎÒÃDZã¶ÔÒÔÉÏÈý¸ö·½·¨½øÐÐÕ¹¿ª£¬¿´¿´¾¿¾¹×öÁËʲô¡£ +接ç�€ï¼Œæˆ‘们便对以上三个方法进行展开,看看究竟å�šäº†ä»€ä¹ˆã€‚ -#### 5.1 `ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry` µÄÖ´ÐÐÁ÷³Ì +#### 5.1 `ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry` 的执行æµ�程 -ÎÒÃÇÒ»¸úÏÂÈ¥£¬¶Ô²»ÖØÒªµÄ·½·¨Ö»ÏÔʾµ÷ÓÃÕ»£º +我们一跟下去,对ä¸�é‡�è¦�的方法å�ªæ˜¾ç¤ºè°ƒç”¨æ ˆï¼š ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(java.lang.String...) @@ -282,48 +282,48 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(java.lang. ``` -ÎÒÃÇÖ±½Ó½øÈë `ConfigurationClassPostProcessor#processConfigBeanDefinitions`£º +我们直接进入 `ConfigurationClassPostProcessor#processConfigBeanDefinitions`: ``` public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { List configCandidates = new ArrayList<>(); String[] candidateNames = registry.getBeanDefinitionNames(); - //Ñ­»·candidateNamesÊý×é + //循环candidateNames数组 for (String beanName : candidateNames) { BeanDefinition beanDef = registry.getBeanDefinition(beanName); - // ÄÚ²¿ÓÐÁ½¸ö±ê¼ÇλÀ´±ê¼ÇÊÇ·ñÒѾ­´¦Àí¹ýÁË - // ÕâÀï»áÒý·¢Ò»Á¬´®ÖªÊ¶Ã¤µã - // µ±ÎÒÃÇ×¢²áÅäÖÃÀàµÄʱºò£¬¿ÉÒÔ²»¼ÓConfiguration×¢½â£¬ - // Ö±½ÓʹÓÃComponent ComponentScan Import ImportResource×¢½â£¬³ÆÖ®ÎªLiteÅäÖÃÀà - // Èç¹û¼ÓÁËConfiguration×¢½â£¬¾Í³ÆÖ®ÎªFullÅäÖÃÀà - // Èç¹ûÎÒÃÇ×¢²áÁËLiteÅäÖÃÀ࣬ÎÒÃÇgetBeanÕâ¸öÅäÖÃÀ࣬»á·¢ÏÖËü¾ÍÊÇÔ­±¾µÄÄǸöÅäÖÃÀà - // Èç¹ûÎÒÃÇ×¢²áÁËFullÅäÖÃÀ࣬ÎÒÃÇgetBeanÕâ¸öÅäÖÃÀ࣬»á·¢ÏÖËüÒѾ­²»ÊÇÔ­±¾ÄǸöÅäÖÃÀàÁË£¬ - // ¶øÊÇÒѾ­±»cgilb´úÀíµÄÀàÁË + // 内部有两个标记ä½�æ�¥æ ‡è®°æ˜¯å�¦å·²ç»�处ç�†è¿‡äº† + // 这里会引å�‘一连串知识盲点 + // 当我们注册é…�置类的时候,å�¯ä»¥ä¸�加Configuration注解, + // 直接使用Component ComponentScan Import ImportResource注解,称之为Liteé…�置类 + // 如果加了Configuration注解,就称之为Fullé…�置类 + // 如果我们注册了Liteé…�置类,我们getBean这个é…�置类,会å�‘现它就是原本的那个é…�置类 + // 如果我们注册了Fullé…�置类,我们getBean这个é…�置类,会å�‘现它已ç»�ä¸�是原本那个é…�置类了, + // 而是已ç»�被cgilb代ç�†çš„类了 if (beanDef.getAttribute(ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE) != null) { if (logger.isDebugEnabled()) { logger.debug(...); } } - // ÅжÏÊÇ·ñΪÅäÖÃÀ࣬ÕâÀï·ÖÁ½ÖÖÇé¿ö£º - // 1\. ´øÓÐ @Configuration ×¢½â ÇÒ proxyBeanMethods != false µÄÀ࣬spring ³ÆÆäΪ Full ÅäÖÃÀà - // 2\. ´øÓÐ @Configuration ×¢½â ÇÒ proxyBeanMethods == false, - // »ò ´øÓÐ @Component¡¢@ComponentScan¡¢@Import¡¢@ImportResource¡¢ - // @Bean ÆäÖÐÖ®Ò»×¢½âµÄÀ࣬spring ³ÆÆäΪ Lite ÅäÖÃÀà - // FullÓëLite£¬beanDef»á½øÐбêʶ + // 判断是å�¦ä¸ºé…�置类,这里分两ç§�情况: + // 1\. 带有 @Configuration 注解 且 proxyBeanMethods != false 的类,spring 称其为 Full é…�置类 + // 2\. 带有 @Configuration 注解 且 proxyBeanMethods == false, + // 或 带有 @Componentã€�@ComponentScanã€�@Importã€�@ImportResourceã€� + // @Bean 其中之一注解的类,spring 称其为 Lite é…�置类 + // Full与Lite,beanDef会进行标识 else if (ConfigurationClassUtils .checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) { configCandidates.add(new BeanDefinitionHolder(beanDef, beanName)); } } - // Èç¹ûûÓÐÅäÖÃÀֱ࣬½Ó·µ»Ø + // 如果没有é…�置类,直接返回 if (configCandidates.isEmpty()) { return; } - // ´¦ÀíÅÅÐò + // 处ç�†æŽ’åº� configCandidates.sort((bd1, bd2) -> { int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition()); int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition()); @@ -331,11 +331,11 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { }); SingletonBeanRegistry sbr = null; - // DefaultListableBeanFactory×îÖÕ»áʵÏÖSingletonBeanRegistry½Ó¿Ú£¬ËùÒÔ¿ÉÒÔ½øÈëµ½Õâ¸öif + // DefaultListableBeanFactory最终会实现SingletonBeanRegistry接å�£ï¼Œæ‰€ä»¥å�¯ä»¥è¿›å…¥åˆ°è¿™ä¸ªif if (registry instanceof SingletonBeanRegistry) { sbr = (SingletonBeanRegistry) registry; if (!this.localBeanNameGeneratorSet) { - //springÖпÉÒÔÐÞ¸ÄĬÈϵÄbeanÃüÃû·½Ê½£¬ÕâÀï¾ÍÊÇ¿´Óû§ÓÐûÓÐ×Ô¶¨ÒåbeanÃüÃû·½Ê½ + //spring中å�¯ä»¥ä¿®æ”¹é»˜è®¤çš„bean命å��æ–¹å¼�,这里就是看用户有没有自定义bean命å��æ–¹å¼� BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton( AnnotationConfigUtils.CONFIGURATION_BEAN_NAME_GENERATOR); if (generator != null) { @@ -356,8 +356,8 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { Set candidates = new LinkedHashSet<>(configCandidates); Set alreadyParsed = new HashSet<>(configCandidates.size()); do { - //½âÎöÅäÖÃÀ࣬Õâ¸öÀà×öÁ˺ܶàÊ£¬ - //È磺¶Ô@Component£¬@PropertySources£¬@ComponentScans£¬@ImportResourceµÈµÄ´¦Àí + //è§£æž�é…�置类,这个类å�šäº†å¾ˆå¤šäº‹ï¼Œ + //如:对@Component,@PropertySources,@ComponentScans,@ImportResource等的处ç�† parser.parse(candidates); parser.validate(); @@ -370,19 +370,19 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { registry, this.sourceExtractor, this.resourceLoader, this.environment, this.importBeanNameGenerator, parser.getImportRegistry()); } - // Ö±µ½ÕâÒ»²½²Å°ÑImportµÄÀ࣬@Bean @ImportRosource ת»»³ÉBeanDefinition + // 直到这一步æ‰�把Import的类,@Bean @ImportRosource 转æ�¢æˆ�BeanDefinition this.reader.loadBeanDefinitions(configClasses); - // °ÑconfigClasses¼ÓÈëµ½alreadyParsed + // 把configClasses加入到alreadyParsed alreadyParsed.addAll(configClasses); candidates.clear(); - // »ñµÃ×¢²áÆ÷ÀïÃæBeanDefinitionµÄÊýÁ¿ ºÍ candidateNames½øÐÐ±È½Ï - // Èç¹û´óÓڵϰ£¬ËµÃ÷ÓÐеÄBeanDefinition×¢²á½øÀ´ÁË + // 获得注册器里é�¢BeanDefinition的数é‡� å’Œ candidateNames进行比较 + // 如果大于的è¯�,说明有新的BeanDefinition注册进æ�¥äº† if (registry.getBeanDefinitionCount() > candidateNames.length) { String[] newCandidateNames = registry.getBeanDefinitionNames(); Set oldCandidateNames = new HashSet<>(Arrays.asList(candidateNames)); Set alreadyParsedClasses = new HashSet<>(); - // Ñ­»·alreadyParsed¡£°ÑÀàÃû¼ÓÈëµ½alreadyParsedClasses + // 循环alreadyParsed。把类å��加入到alreadyParsedClasses for (ConfigurationClass configurationClass : alreadyParsed) { alreadyParsedClasses.add(configurationClass.getMetadata().getClassName()); } @@ -412,33 +412,33 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { ``` -ÒÔÉÏ·½·¨»¹ÊÇ¶Ô `BeanDefinition` ÐÅÏ¢µÄ½øÒ»²½ÍêÉÆ£¬°üÀ¨¶Ô `@Configuration`¡¢`@PropertySources`¡¢`@ComponentScans`¡¢`@ImportResource` µÈµÄ´¦Àí¡£ÓÉÓÚ demo01 ûÓÐÕâЩע½â£¬ÕâÀïÎÒÃǾͲ»Õ¹¿ªÁË£¬ºóÃæÎÒÃÇÔÙ·ÖÎö¡£ +以上方法还是对 `BeanDefinition` ä¿¡æ�¯çš„进一步完善,包括对 `@Configuration`ã€�`@PropertySources`ã€�`@ComponentScans`ã€�`@ImportResource` 等的处ç�†ã€‚由于 demo01 没有这些注解,这里我们就ä¸�展开了,å�Žé�¢æˆ‘们å†�分æž�。 -#### 5.2 Ö´ÐÐ `ConfigurationClassPostProcessor#postProcessBeanFactory` µÄÁ÷³Ì +#### 5.2 执行 `ConfigurationClassPostProcessor#postProcessBeanFactory` çš„æµ�程 -`ConfigurationClassPostProcessor` µÄ `postProcessBeanFactory` ·½·¨±È½Ï¼òµ¥£¬Ëù×öµÄÊ»¹ÊÇ¶Ô `@Configuration` µÄÔöÇ¿£º +`ConfigurationClassPostProcessor` çš„ `postProcessBeanFactory` 方法比较简å�•,所å�šçš„事还是对 `@Configuration` 的增强: ``` @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { - // Ê¡ÂÔÆäËû´úÂë + // çœ�略其他代ç � - // ¶Ô ConfigurationClasses µÄÔöÇ¿ + // 对 ConfigurationClasses 的增强 enhanceConfigurationClasses(beanFactory); beanFactory.addBeanPostProcessor(new ImportAwareBeanPostProcessor(beanFactory)); } public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFactory) { - // Ê¡ÂÔÆäËû´úÂë + // çœ�略其他代ç � - // È«ÅäÖÃÀࣺ´¦Àí´úÀí + // å…¨é…�置类:处ç�†ä»£ç�† ConfigurationClassEnhancer enhancer = new ConfigurationClassEnhancer(); for (Map.Entry entry : configBeanDefs.entrySet()) { AbstractBeanDefinition beanDef = entry.getValue(); // If a @Configuration class gets proxied, always proxy the target class beanDef.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE, Boolean.TRUE); // Set enhanced subclass of the user-specified bean class - // ÔÚÕâÀï½øÐÐÔöÇ¿µÄ + // 在这里进行增强的 Class configClass = beanDef.getBeanClass(); Class enhancedClass = enhancer.enhance(configClass, this.beanClassLoader); if (configClass != enhancedClass) { @@ -449,11 +449,11 @@ public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFact ``` -ÓÉÓÚ demo01 ûÓÐÅäÖà `@Configuration`£¬ÕâÀï¾Í²»Õ¹¿ªÁË£¬ºóÃæÎÒÃÇÔÙ·ÖÎö¡£ +由于 demo01 没有é…�ç½® `@Configuration`,这里就ä¸�展开了,å�Žé�¢æˆ‘们å†�分æž�。 -#### 5.3 Ö´ÐÐ `EventListenerMethodProcessor#postProcessBeanFactory` µÄÁ÷³Ì +#### 5.3 执行 `EventListenerMethodProcessor#postProcessBeanFactory` çš„æµ�程 -Õâ¸ö·½·¨ÊÇÓÃÀ´´¦Àíʼþ¼àÌýÆ÷µÄ£¬ÎÒÃÇÖ±½ÓÉÏ´úÂ룺 +这个方法是用æ�¥å¤„ç�†äº‹ä»¶ç›‘å�¬å™¨çš„,我们直接上代ç �: ``` @Override @@ -469,27 +469,27 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) ``` -¿ÉÒÔ¿´µ½£¬ÕâÀï´Ó spring ÈÝÆ÷ÖУ¬ÄóöÁËËùÓÐµÄ `EventListenerFactory`£¬È»ºó¸³Öµ¸ø `this.eventListenerFactories`£¬Õâ¸ö¾Í²»Õ¹¿ªÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œä»Ž spring 容器中,拿出了所有的 `EventListenerFactory`,然å�Žèµ‹å€¼ç»™ `this.eventListenerFactories`,这个就ä¸�展开了。 -#### 5.4 ×ܽá +#### 5.4 总结 -±¾ÎĽéÉÜÁË `invokeBeanFactoryPostProcessors` µÄÖ´ÐÐÁ÷³Ì£¬Õû¸öÀàÏÂÀ´¾ÍÊÇΪÁËÖ´ÐÐÁ½¸ö·½·¨£º`BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` Óë `BeanFactoryPostProcessor#postProcessBeanFactory`£¬ÕâÁ½¸ö·½·¨µÄÖ´Ðйý³ÌÈçÏ£º +本文介ç»�了 `invokeBeanFactoryPostProcessors` 的执行æµ�程,整个类下æ�¥å°±æ˜¯ä¸ºäº†æ‰§è¡Œä¸¤ä¸ªæ–¹æ³•:`BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` 与 `BeanFactoryPostProcessor#postProcessBeanFactory`,这两个方法的执行过程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b6188601112b2b2c031b0a70f64f2cc885f.png) -ͨ¹ýµ÷ÊÔ·¢ÏÖ£¬`invokeBeanFactoryPostProcessors` Ò»¹²Ö´ÐÐÁË `BeanFactoryPostProcessor`£º +通过调试å�‘现,`invokeBeanFactoryPostProcessors` 一共执行了 `BeanFactoryPostProcessor`: 1. `ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry` 2. `ConfigurationClassPostProcessor#postProcessBeanFactory` 3. `EventListenerMethodProcessor#postProcessBeanFactory` -ÆäÖУ¬`ConfigurationClassPostProcessor` ÊÇÒ»¸ö·Ç³£·Ç³£ÖØÒªµÄ `BeanFactoryPostProcessor`£¬¹ØÓÚËüµÄ½øÒ»²½·ÖÎö¿ÉÒԲο¼ÒÔÏÂÎÄÕ£º +其中,`ConfigurationClassPostProcessor` 是一个é�žå¸¸é�žå¸¸é‡�è¦�çš„ `BeanFactoryPostProcessor`,关于它的进一步分æž�å�¯ä»¥å�‚考以下文章: -* [spring Ì½ÃØÖ® ConfigurationClassPostProcessor Ö®´¦Àí @ComponentScan ×¢½â](https://my.oschina.net/funcy/blog/4836178) -* [spring Ì½ÃØÖ® ConfigurationClassPostProcessor Ö®´¦Àí @Bean ×¢½â](https://my.oschina.net/funcy/blog/4492878) -* [spring Ì½ÃØÖ® ConfigurationClassPostProcessor Ö®´¦Àí @Import ×¢½â](https://my.oschina.net/funcy/blog/4678152) -* [spring Ì½ÃØÖ® ConfigurationClassPostProcessor Ö®´¦Àí @Conditional ×¢½â](https://my.oschina.net/funcy/blog/4873444) +* [spring 探秘之 ConfigurationClassPostProcessor 之处ç�† @ComponentScan 注解](https://my.oschina.net/funcy/blog/4836178) +* [spring 探秘之 ConfigurationClassPostProcessor 之处ç�† @Bean 注解](https://my.oschina.net/funcy/blog/4492878) +* [spring 探秘之 ConfigurationClassPostProcessor 之处ç�† @Import 注解](https://my.oschina.net/funcy/blog/4678152) +* [spring 探秘之 ConfigurationClassPostProcessor 之处ç�† @Conditional 注解](https://my.oschina.net/funcy/blog/4873444) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4641114](https://my.oschina.net/funcy/blog/4641114) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4641114](https://my.oschina.net/funcy/blog/4641114) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\253\357\274\211\357\274\232\345\256\214\346\210\220BeanFactory\347\232\204\345\210\235\345\247\213\345\214\226.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\253\357\274\211\357\274\232\345\256\214\346\210\220BeanFactory\347\232\204\345\210\235\345\247\213\345\214\226.md" index a7372b9..6488c62 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\253\357\274\211\357\274\232\345\256\214\346\210\220BeanFactory\347\232\204\345\210\235\345\247\213\345\214\226.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\253\357\274\211\357\274\232\345\256\214\346\210\220BeanFactory\347\232\204\345\210\235\345\247\213\345\214\226.md" @@ -1,12 +1,12 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1f1ac8f3d8241fad9693d9684048ab7f3ae.png) -½ÓÉÏÎÄ£¬±¾ÎļÌÐø·ÖÎö spring µÄÆô¶¯ Á÷³Ì¡£ +接上文,本文继续分æž� spring çš„å�¯åЍ æµ�程。 -### 11\. ³õʼ»¯µ¥Àý bean: `finishBeanFactoryInitialization(beanFactory)` +### 11\. åˆ�始化å�•例 bean: `finishBeanFactoryInitialization(beanFactory)` -±¾ÎĽ«·ÖÎöÒ»¸ö**·Ç³£ÖØÒª**µÄ·½·¨ `AbstractApplicationContext#finishBeanFactoryInitialization` ÁË¡£ +本文将分æž�一个**é�žå¸¸é‡�è¦�**的方法 `AbstractApplicationContext#finishBeanFactoryInitialization` 了。 -·½·¨µÄµ÷ÓÃÈçÏ£º +方法的调用如下: ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -16,25 +16,25 @@ ``` -ÎÒÃÇÖ±½Ó½øÈë `DefaultListableBeanFactory#preInstantiateSingletons`: +我们直接进入 `DefaultListableBeanFactory#preInstantiateSingletons`: ``` public void preInstantiateSingletons() throws BeansException { - // this.beanDefinitionNames ±£´æÁËËùÓÐµÄ beanNames + // this.beanDefinitionNames ä¿�存了所有的 beanNames List beanNames = new ArrayList<>(this.beanDefinitionNames); for (String beanName : beanNames) { - // ºÏ²¢¸¸ Bean ÖеÄÅäÖã¬×¢Òâ ÖÐµÄ parentÊôÐÔ + // å�ˆå¹¶çˆ¶ Bean 中的é…�置,注æ„� 中的 parent属性 RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName); - // ²»ÊdzéÏóÀà¡¢Êǵ¥ÀýµÄÇÒ²»ÊÇÀÁ¼ÓÔØµÄ + // ä¸�是抽象类ã€�是å�•例的且ä¸�是懒加载的 if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) { - // ´¦Àí FactoryBean + // 处ç�† FactoryBean if (isFactoryBean(beanName)) { - //ÔÚ beanName Ç°Ãæ¼ÓÉÏ¡°&¡± ·ûºÅ + //在 beanName å‰�é�¢åŠ ä¸Šâ€œ&â€� 符å�· Object bean = getBean(FACTORY_BEAN_PREFIX + beanName); if (bean instanceof FactoryBean) { final FactoryBean factory = (FactoryBean) bean; - // Åжϵ±Ç° FactoryBean ÊÇ·ñÊÇ SmartFactoryBean µÄʵÏÖ + // 判断当å‰� FactoryBean 是å�¦æ˜¯ SmartFactoryBean 的实现 boolean isEagerInit; if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) { @@ -47,7 +47,7 @@ public void preInstantiateSingletons() throws BeansException { ((SmartFactoryBean) factory).isEagerInit()); } if (isEagerInit) { - // ²»ÊÇFactoryBeanµÄÖ±½ÓʹÓô˷½·¨½øÐгõʼ»¯ + // ä¸�是FactoryBean的直接使用此方法进行åˆ�始化 getBean(beanName); } } @@ -59,7 +59,7 @@ public void preInstantiateSingletons() throws BeansException { } // Trigger post-initialization callback for all applicable beans... - // Èç¹ûbeanʵÏÖÁË SmartInitializingSingleton ½Ó¿ÚµÄ£¬ÄÇôÔÚÕâÀïµÃµ½»Øµ÷ + // 如果bean实现了 SmartInitializingSingleton 接å�£çš„,那么在这里得到回调 for (String beanName : beanNames) { Object singletonInstance = getSingleton(beanName); if (singletonInstance instanceof SmartInitializingSingleton) { @@ -80,7 +80,7 @@ public void preInstantiateSingletons() throws BeansException { ``` -ÒÔÉÏ´úÂ룬¿´Ëƺܶ࣬µ«¹Ø¼ü´úÂë¿É¼ò»¯ÈçÏ£º +以上代ç �,看似很多,但关键代ç �å�¯ç®€åŒ–如下: ``` List beanNames = new ArrayList<>(this.beanDefinitionNames); @@ -93,15 +93,15 @@ for (String beanName : beanNames) { ``` -> ÒÔÉÏ´úÂëµÄ¼ò»¯ÖУ¬Ê¡ÂÔÁËÐí¶àϸ½Ú£¬ÀýÈçÅжÏÊÇ·ñ¿ÉÒÔʵÀý»¯Ê±£¬ÐèÒªÅжÏÊÇ·ñΪ³éÏóÀ࣬ÊÇ·ñΪµ¥Àý£¬ÊÇ·ñΪÀÁ¼ÓÔØµÈ£¬Í¬Ê±¶Ô bean Ò²ÅжÏÁËÊÇ·ñΪÆÕͨ bean »¹ÊÇ `FactoryBean`£¬Èç¹ûʵÏÖÁË `SmartInitializingSingleton` ½Ó¿ÚµÄ bean£¬ÐèÒªÁíÍâ´¦ÀíµÈ¡£¶ÔÓÚÎÒÃdzõ´ÎÔĶÁ´úÂëÀ´Ëµ£¬°Ñ¾«Á¦¾Û¼¯Ö÷ÒªÁ÷³Ì¾ÍÐÐÁË£¬¶ÔÓÚÒ»Ð©ÌØÀý¼°Ï¸½Ú£¬¿ÉÒÔÏȲ»¾À½á£¬ÏëÁ˽â¸ü¶àϸ½Ú£¬¿ÉÒÔÔÚ°ÑÎÕÖ÷ÒªÁ÷³ÌµÄÇé¿öÏ£¬ºóÃæÔÙ¿´¡£¹ýÓÚ¾À½áÌØÀý¼°Ï¸½Ú£¬·´µ¹ÈÃ×Ô¼º×¥²»×¡Öص㣬ÃÔʧÓÚÔ´ÂëÖС£ +> 以上代ç �的简化中,çœ�略了许多细节,例如判断是å�¦å�¯ä»¥å®žä¾‹åŒ–时,需è¦�判断是å�¦ä¸ºæŠ½è±¡ç±»ï¼Œæ˜¯å�¦ä¸ºå�•例,是å�¦ä¸ºæ‡’加载等,å�Œæ—¶å¯¹ bean 也判断了是å�¦ä¸ºæ™®é€š bean 还是 `FactoryBean`,如果实现了 `SmartInitializingSingleton` 接å�£çš„ bean,需è¦�å�¦å¤–处ç�†ç­‰ã€‚对于我们åˆ�次阅读代ç �æ�¥è¯´ï¼ŒæŠŠç²¾åŠ›è�šé›†ä¸»è¦�æµ�程就行了,对于一些特例å�Šç»†èŠ‚ï¼Œå�¯ä»¥å…ˆä¸�纠结,想了解更多细节,å�¯ä»¥åœ¨æŠŠæ�¡ä¸»è¦�æµ�程的情况下,å�Žé�¢å†�看。过于纠结特例å�Šç»†èŠ‚ï¼Œå��倒让自己抓ä¸�ä½�é‡�点,迷失于æº�ç �中。 -ÕâÑùÒ»¼ò»¯£¬¾Í¿ÉÒÔÇåÎú¿´³ö¸Ã·½·¨µÄ¹¦ÄÜ£º +这样一简化,就å�¯ä»¥æ¸…晰看出该方法的功能: -1. »ñÈ¡ `beanFactory` ÖÐµÄ `beanNames` ²¢±éÀú£» -2. ͨ¹ý `beanName` »ñÈ¡ `BeanDefinition`£¬½øÐÐÌõ¼þÅжϣ¬ÈçÊÇ·ñΪµ¥Àý£» -3. ±éÀúµ÷Óà `getBean(beanName)` ´´½¨ bean ²¢½«ÆäÌí¼Óµ½ spring ÖС£ +1. 获å�– `beanFactory` 中的 `beanNames` å¹¶é��历; +2. 通过 `beanName` 获å�– `BeanDefinition`,进行æ�¡ä»¶åˆ¤æ–­ï¼Œå¦‚是å�¦ä¸ºå�•例; +3. é��历调用 `getBean(beanName)` 创建 bean 并将其添加到 spring 中。 -´Ó¼ò»¯ºóµÄ´úÂë¿ÉÒÔ¿´³ö£¬¿´ËÆÆ½Æ½ÎÞÆæµÄ `getBean(beanName)`£¬¾ÍÊÇ spring ʵÀý»¯ bean µÄ¹Ø¼ü¡£½ÓÏÂÀ´£¬ÎÒÃÇ»¹ÊǺöÂÔÆäËû´úÂ룬ֻ¹Ø×¢Ö÷ÒªÁ÷³Ì£¬¼ÌÐø·ÖÎöÏÂÈ¥£º +从简化å�Žçš„代ç �å�¯ä»¥çœ‹å‡ºï¼Œçœ‹ä¼¼å¹³å¹³æ— å¥‡çš„ `getBean(beanName)`,就是 spring 实例化 bean 的关键。接下æ�¥ï¼Œæˆ‘们还是忽略其他代ç �,å�ªå…³æ³¨ä¸»è¦�æµ�程,继续分æž�下去: ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -119,25 +119,25 @@ for (String beanName : beanNames) { protected T doGetBean(final String name, @Nullable final Class requiredType, @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException { - // Ö÷ÒªÂß¼­¾ÍÊÇÈç¹ûÊÇFactoryBean¾Í°Ñ&È¥µô,Èç¹ûÊDZðÃû¾Í°Ñ¸ù¾Ý±ðÃû»ñÈ¡ÕæÊµÃû³Æ + // 主è¦�逻辑就是如果是FactoryBean就把&去掉,如果是别å��就把根æ�®åˆ«å��获å�–真实å��ç§° final String beanName = transformedBeanName(name); - //×îºóµÄ·µ»ØÖµ + //最å�Žçš„返回值 Object bean; - // ¼ì²éÊÇ·ñÒѳõʼ»¯ + // 检查是å�¦å·²åˆ�始化 Object sharedInstance = getSingleton(beanName); - // Èç¹ûÒѾ­³õʼ»¯¹ýÁË£¬ÇÒûÓд«args²ÎÊý¾Í´ú±íÊÇget£¬Ö±½ÓÈ¡³ö·µ»Ø + // 如果已ç»�åˆ�始化过了,且没有传argså�‚数就代表是get,直接å�–出返回 if (sharedInstance != null && args == null) { - // ÕâÀïÈç¹ûÊÇÆÕͨBean µÄ»°£¬Ö±½Ó·µ»Ø£¬Èç¹ûÊÇ FactoryBean µÄ»°£¬·µ»ØËü´´½¨µÄÄǸöʵÀý¶ÔÏó + // 这里如果是普通Bean çš„è¯�,直接返回,如果是 FactoryBean çš„è¯�,返回它创建的那个实例对象 bean = getObjectForBeanInstance(sharedInstance, name, beanName, null); } else { - // Èç¹û´æÔÚprototypeÀàÐ͵ÄÕâ¸öbean + // 如果存在prototype类型的这个bean if (isPrototypeCurrentlyInCreation(beanName)) { throw new BeanCurrentlyInCreationException(beanName); } - // Èç¹ûµ±Ç°BeanDefinition²»´æÔÚÕâ¸öbeanÇÒ¾ßÓи¸BeanFactory + // 如果当å‰�BeanDefinitionä¸�存在这个bean且具有父BeanFactory BeanFactory parentBeanFactory = getParentBeanFactory(); if (parentBeanFactory != null && !containsBeanDefinition(beanName)) { String nameToLookup = originalBeanName(name); @@ -146,7 +146,7 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy nameToLookup, requiredType, args, typeCheckOnly); } else if (args != null) {. - // ·µ»Ø¸¸ÈÝÆ÷µÄ²éѯ½á¹û + // 返回父容器的查询结果 return (T) parentBeanFactory.getBean(nameToLookup, args); } else if (requiredType != null) { @@ -158,26 +158,26 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy } if (!typeCheckOnly) { - // typeCheckOnly Ϊ false£¬½«µ±Ç° beanName ·ÅÈëÒ»¸ö alreadyCreated µÄ Set ¼¯ºÏÖС£ + // typeCheckOnly 为 false,将当å‰� beanName 放入一个 alreadyCreated çš„ Set 集å�ˆä¸­ã€‚ markBeanAsCreated(beanName); } - // µ½Õâ¾ÍÒª´´½¨beanÁË + // 到这就è¦�创建bean了 try { final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName); checkMergedBeanDefinition(mbd, beanName, args); - // Ïȳõʼ»¯ÒÀÀµµÄËùÓÐ Bean£¬ depends-on Öж¨ÒåµÄÒÀÀµ + // å…ˆåˆ�始化ä¾�赖的所有 Bean, depends-on 中定义的ä¾�èµ– String[] dependsOn = mbd.getDependsOn(); if (dependsOn != null) { for (String dep : dependsOn) { - // ¼ì²éÊDz»ÊÇÓÐÑ­»·ÒÀÀµ + // 检查是ä¸�是有循环ä¾�èµ– if (isDependent(beanName, dep)) { throw new BeanCreationException(...); } - // ×¢²áÒ»ÏÂÒÀÀµ¹ØÏµ + // 注册一下ä¾�赖关系 registerDependentBean(dep, beanName); try { - // Ïȳõʼ»¯±»ÒÀÀµÏî + // å…ˆåˆ�始化被ä¾�赖项 getBean(dep); } catch (NoSuchBeanDefinitionException ex) { @@ -186,11 +186,11 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy } } - // Èç¹ûÊǵ¥ÀýµÄ + // 如果是å�•例的 if (mbd.isSingleton()) { sharedInstance = getSingleton(beanName, () -> { try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } catch (BeansException ex) { @@ -200,12 +200,12 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy }); bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd); } - // Èç¹ûÊÇprototype + // 如果是prototype else if (mbd.isPrototype()) { Object prototypeInstance = null; try { beforePrototypeCreation(beanName); - // Ö´Ðд´½¨ Bean + // 执行创建 Bean prototypeInstance = createBean(beanName, mbd, args); } finally { @@ -213,8 +213,8 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy } bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd); } - // Èç¹û²»ÊÇ singleton ºÍ prototype, ÄÇô¾ÍÊÇ×Ô¶¨ÒåµÄscope(ÀýÈçWebÏîÄ¿ÖеÄsessionµÈÀàÐÍ)£¬ - // ÕâÀï¾Í½»¸ø×Ô¶¨ÒåscopeµÄÓ¦Ó÷½È¥ÊµÏÖ + // 如果ä¸�是 singleton å’Œ prototype, 那么就是自定义的scope(例如Web项目中的session等类型), + // 这里就交给自定义scope的应用方去实现 else { String scopeName = mbd.getScope(); final Scope scope = this.scopes.get(scopeName); @@ -225,7 +225,7 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy Object scopedInstance = scope.get(beanName, () -> { beforePrototypeCreation(beanName); try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } finally { @@ -245,7 +245,7 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy } } - //¼ì²ébeanµÄÀàÐÍ + //检查bean的类型 if (requiredType != null && !requiredType.isInstance(bean)) { try { T convertedBean = getTypeConverter().convertIfNecessary(bean, requiredType); @@ -263,17 +263,17 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy ``` -ÉÏÃæµÄ´úÂë»ù±¾Éϸø³öÁË×¢ÊÍ£¬ ÔÚÕâ¾Í²»¶à×ö ½âÊÍÁË¡£spring ¹¦ÄܱȽϸ´ÔÓ£¬¿¼ÂǵĶ«Î÷Ò²±È½Ï¶à£¬Òò´ËÉÏÊö´úÂë»á¶à×ö¶àÖÖÅжϣ¬Ó¦¶Ô¶àÖÖÇé¿ö¡£Èç¹ûÎÒÃǽö¿¼ÂÇ demo01 µÄÇé¿ö (`singleton` Çé¿ö)£¬ÒÔÉÏ´úÂë¹Ø¼üÈçÏ£º +上é�¢çš„代ç �基本上给出了注释, 在这就ä¸�多å�š 解释了。spring 功能比较å¤�æ�‚,考虑的东西也比较多,因此上述代ç �会多å�šå¤šç§�判断,应对多ç§�情况。如果我们仅考虑 demo01 的情况 (`singleton` 情况),以上代ç �关键如下: ``` -//×îºóµÄ·µ»ØÖµ +//最å�Žçš„返回值 Object bean; -// ÕâÀï½ö¸ø³öµ¥ÀýµÄÇé¿ö -// 1\. »ñÈ¡µ¥Àý¶ÔÏó£¬Í¬Ê±Ò²ÌṩÁËÒ»¸ölambda±í´ïʽ£¬ÓÃÀ´½øÐÐbeanµÄ´´½¨ +// 这里仅给出å�•例的情况 +// 1\. 获å�–å�•例对象,å�Œæ—¶ä¹Ÿæ��供了一个lambda表达å¼�,用æ�¥è¿›è¡Œbean的创建 sharedInstance = getSingleton(beanName, () -> { try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } catch (BeansException ex) { @@ -282,15 +282,15 @@ sharedInstance = getSingleton(beanName, () -> { } }); -// 2\. ½øÒ»²½´¦ÀísharedInstance£¬È»ºó·µ»Øbean¡£ÊÂʵÉÏ£¬Õâ¸ö·½·¨Ö÷Òª´¦ÀíµÄÊÇ£¬ -// Èç¹ûÊÇFactoryBean£¬¾Í·µ»Ø·µ»ØËü´´½¨µÄÄǸöʵÀý¶ÔÏ󣬷ñÔò¾ÍÖ±½Ó·µ»Ø +// 2\. 进一步处ç�†sharedInstance,然å�Žè¿”回bean。事实上,这个方法主è¦�处ç�†çš„æ˜¯ï¼Œ +// 如果是FactoryBean,就返回返回它创建的那个实例对象,å�¦åˆ™å°±ç›´æŽ¥è¿”回 bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd); return (T) bean; ``` -¾«¼òºóµÄ´úÂ룬¾ÍÊÇ spring ´´½¨ bean µÄÁ÷³Ì¡£½Ó×ÅÎÒÃǾͷֱ𿴿´ÕâÁ½¸ö·½·¨µÄÄÚÈÝ£¬ÕâÀïɾ³ýÁËһЩ²»±ØÒªµÄ´úÂ룺 +精简å�Žçš„代ç �,就是 spring 创建 bean çš„æµ�程。接ç�€æˆ‘们就分别看看这两个方法的内容,这里删除了一些ä¸�å¿…è¦�的代ç �: > `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` @@ -299,7 +299,7 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { synchronized (this.singletonObjects) { boolean newSingleton = false; try { - // ¶ÔÏó¾ÍÊÇÔÚÕâÀï½øÐд´½¨µÄ + // 对象就是在这里进行创建的 singletonObject = singletonFactory.getObject(); newSingleton = true; } @@ -307,11 +307,11 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { ... } finally { - // ´´½¨Íê³Éºó£¬×öһЩÅжϲÙ×÷£¬Óë´´½¨¹ý³Ì¹ØÏµ²»´ó + // 创建完æˆ�å�Žï¼Œå�šä¸€äº›åˆ¤æ–­æ“�作,与创建过程关系ä¸�大 afterSingletonCreation(beanName); } if (newSingleton) { - // Ìí¼Óµ½ beanFactory »º´æ + // 添加到 beanFactory 缓存 addSingleton(beanName, singletonObject); } return singletonObject; @@ -320,9 +320,9 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { ``` -´ÓÒÔÉÏ´úÂë¿ÉÒÔ¿´³ö£¬bean µÄ´´½¨¾ÍÊÇÔÚ `singletonFactory.getObject()`£¬¹ØÓÚÕâ¸ö·½·¨Ö´ÐÐÁËʲô£¬ÎÒÃÇ»¹Ó¦¸Ã½áºÏ `AbstractBeanFactory#doGetBean`. +从以上代ç �å�¯ä»¥çœ‹å‡ºï¼Œbean 的创建就是在 `singletonFactory.getObject()`,关于这个方法执行了什么,我们还应该结å�ˆ `AbstractBeanFactory#doGetBean`. -Ê×ÏÈ£¬ÎÒÃǽøÈë `ObjectFactory#getObject`£¬·¢ÏÖ´úÂëÈçÏ£º +首先,我们进入 `ObjectFactory#getObject`,å�‘现代ç �如下: ``` @FunctionalInterface @@ -332,12 +332,12 @@ public interface ObjectFactory { ``` -ÕâÊÇÒ»¸öº¯Êýʽ±à³Ì½Ó¿Ú£¬jdk8 ÌṩµÄÐÂÓï·¨¡£ÔÙ¿´¿´ `AbstractBeanFactory#doGetBean` ·½·¨´«ÈëµÄ¶ÔÏó£º +这是一个函数å¼�编程接å�£ï¼Œjdk8 æ��供的新语法。å†�看看 `AbstractBeanFactory#doGetBean` 方法传入的对象: ``` sharedInstance = getSingleton(beanName, () -> { try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } catch (BeansException ex) { @@ -348,11 +348,11 @@ sharedInstance = getSingleton(beanName, () -> { ``` -ÕâÀï´«ÈëµÄÊÇÒ»¸ö lambda ±í´ïʽ£¬µ±´úÂëÖ´ÐÐ `singletonFactory.getObject()` ʱ£¬Êµ¼ÊÉÏÖ´ÐеÄÊÇ +这里传入的是一个 lambda 表达å¼�,当代ç �执行 `singletonFactory.getObject()` 时,实际上执行的是 ``` try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } catch (BeansException ex) { @@ -362,16 +362,16 @@ catch (BeansException ex) { ``` -¼´ `AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])`£¬Ç°ÃæÍäÍäÈÆÈÆÁËÄÇô¶à£¬spring ÖÕÓÚÒª½øÈë bean µÄ´´½¨ÁË£¡ +å�³ `AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])`,å‰�é�¢å¼¯å¼¯ç»•绕了那么多,spring 终于è¦�进入 bean 的创建了ï¼� -¹ØÓÚ spring ¶ÔÏóµÄ´´½¨£¬ÎÒÃÇ»áÔÚºóÃæµÄÎÄÕ¼ÌÐø·ÖÎö£¬±¾ÎÄÎÒÃÇÖ»¹Ø×¢ `AbstractBeanFactory#getBean` Óë `DefaultSingletonBeanRegistry#getSingleton`£¬½áºÏÒÔÉÏ·ÖÎö£¬ÎÒÃǶÔÕâÁ½¸ö·½·¨×öÒ»¸ö×ܽ᣺ +关于 spring 对象的创建,我们会在å�Žé�¢çš„æ–‡ç« ç»§ç»­åˆ†æž�,本文我们å�ªå…³æ³¨ `AbstractBeanFactory#getBean` 与 `DefaultSingletonBeanRegistry#getSingleton`,结å�ˆä»¥ä¸Šåˆ†æž�,我们对这两个方法å�šä¸€ä¸ªæ€»ç»“: -* `AbstractBeanFactory#getBean`£º¶ÔÓÚ scope Ϊ `PropertyType` µÄ bean À´Ëµ£¬¸Ã·½·¨»áÖ±½Ó´´½¨ bean£»¶ÔÓÚ scope Ϊ `singleton` µÄ bean À´Ëµ£¬¸Ã·½·¨»áÏÈÅÐ¶Ï `beanFactory` ÊÇ·ñ´æÔڸà bean£¬Èô´æÔÚÔòÖ±½Ó·µ»Ø£¬·ñÔò¾ÍÏÈ´´½¨ÔÙ·µ»Ø¡£ +* `AbstractBeanFactory#getBean`:对于 scope 为 `PropertyType` çš„ bean æ�¥è¯´ï¼Œè¯¥æ–¹æ³•会直接创建 bean;对于 scope 为 `singleton` çš„ bean æ�¥è¯´ï¼Œè¯¥æ–¹æ³•会先判断 `beanFactory` 是å�¦å­˜åœ¨è¯¥ bean,若存在则直接返回,å�¦åˆ™å°±å…ˆåˆ›å»ºå†�返回。 -* `DefaultSingletonBeanRegistry#getSingleton`£ºÕâ¸ö·½·¨¾ÍÊÇ´Ó `beanFactory` »ñÈ¡ singleton bean µÄ·½·¨£ºÈô´æÔÚÔòÖ±½Ó·µ»Ø£¬·ñÔò¾ÍÏÈ´´½¨ÔÙ·µ»Ø¡£ +* `DefaultSingletonBeanRegistry#getSingleton`:这个方法就是从 `beanFactory` 获å�– singleton bean 的方法:若存在则直接返回,å�¦åˆ™å°±å…ˆåˆ›å»ºå†�返回。 -±¾ÎľÍÏÈ·ÖÎöµ½ÕâÀïÁË£¬ÏÂÆªÎÄÕÂÎÒÃÇÔÙ·ÖÎö spring bean ´´½¨¹ý³Ì¡£ +本文就先分æž�到这里了,下篇文章我们å†�分æž� spring bean 创建过程。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4658230](https://my.oschina.net/funcy/blog/4658230) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4658230](https://my.oschina.net/funcy/blog/4658230) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\346\263\250\345\206\214BeanPostProcessor.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\346\263\250\345\206\214BeanPostProcessor.md" index ebdc18b..ba172ab 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\346\263\250\345\206\214BeanPostProcessor.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\205\255\357\274\211\357\274\232\346\263\250\345\206\214BeanPostProcessor.md" @@ -1,21 +1,21 @@ ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-be7f7797a27a2dc5ab1ad8d11327b140c90.png) -½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö¡£ +接上文,我们继续分æž�。 -### 6\. ×¢²á `BeanPostProcessor`: `registerBeanPostProcessors(beanFactory)` +### 6\. 注册 `BeanPostProcessor`: `registerBeanPostProcessors(beanFactory)` -ÔÚÕýʽ·ÖÎöǰ£¬ÐèÒªÃ÷È·Á½¸ö¸ÅÄ +在正å¼�分æž�å‰�,需è¦�明确两个概念: -* `BeanFactoryPostProcessor`£¬±»³ÆÎª `BeanFactory` µÄºóÖô¦ÀíÆ÷£¬¿ÉÒÔ¶Ô `BeanFactory` ½øÐÐһЩ²Ù×÷£» -* `BeanPostProcessor`£¬±»³ÆÎª `Bean` µÄºóÖô¦ÀíÆ÷£¬¿ÉÒÔ¶Ô `Bean` ½øÐÐһЩ²Ù×÷¡£ +* `BeanFactoryPostProcessor`,被称为 `BeanFactory` çš„å�Žç½®å¤„ç�†å™¨ï¼Œå�¯ä»¥å¯¹ `BeanFactory` 进行一些æ“�作; +* `BeanPostProcessor`,被称为 `Bean` çš„å�Žç½®å¤„ç�†å™¨ï¼Œå�¯ä»¥å¯¹ `Bean` 进行一些æ“�作。 -²»Òª½«±¾ÎÄµÄ `BeanPostProcessor` ÓëÇ°ÃæµÄ `BeanFactoryPostProcessor` Ū»ìÁË¡£ +ä¸�è¦�将本文的 `BeanPostProcessor` 与å‰�é�¢çš„ `BeanFactoryPostProcessor` 弄混了。 -±¾ÎÄÖ÷ÒªÊÇ¶Ô `BeanPostProcessor` µÄ `register` ²Ù×÷ (`registerBeanPostProcessors(beanFactory)`)£¬¼´½« `BeanPostProcessor` ×¢²áµ½ `BeanFactory` ÖУ¬ÄÇôµ÷ÓÃÊÇÔÚʲôʱºòÄØ£¿¼ÈÈ»ÊÇ¶Ô `Bean` µÄ²Ù×÷£¬µ±È»ÊÇÓÐÁË bean Ö®ºóÔÙÔËÐÐÁË¡£ +本文主è¦�是对 `BeanPostProcessor` çš„ `register` æ“�作 (`registerBeanPostProcessors(beanFactory)`),å�³å°† `BeanPostProcessor` 注册到 `BeanFactory` 中,那么调用是在什么时候呢?既然是对 `Bean` çš„æ“�作,当然是有了 bean 之å�Žå†�è¿�行了。 -> `BeanPostProcessor` Ò²ÊÇ spring ÖÐÒ»¸öÖØÒª×é¼þ£¬¹ØÓÚ¸Ã×é¼þµÄÏêϸ·ÖÎö£¬¿ÉÒԲο¼ [spring ×é¼þÖ® BeanPostProcessors](https://my.oschina.net/funcy/blog/4597551) +> `BeanPostProcessor` 也是 spring 中一个é‡�è¦�组件,关于该组件的详细分æž�,å�¯ä»¥å�‚考 [spring 组件之 BeanPostProcessors](https://my.oschina.net/funcy/blog/4597551) -·Ï»°²»¶à˵£¬Ö±½ÓÉÏ´úÂ룬ͬÑùµØ£¬¶Ô²»ÖØÒªµÄ·½·¨ÎÒÃÇÖ»¸ø³öµ÷ÓÃÁ´£º +废è¯�ä¸�多说,直接上代ç �,å�Œæ ·åœ°ï¼Œå¯¹ä¸�é‡�è¦�的方法我们å�ªç»™å‡ºè°ƒç”¨é“¾ï¼š ``` |-AbstractApplicationContext#refresh @@ -25,15 +25,15 @@ ``` -×îÖÕµ÷Óõ½ÁË `PostProcessorRegistrationDelegate#registerBeanPostProcessors`£¬´úÂëÈçÏ£º +最终调用到了 `PostProcessorRegistrationDelegate#registerBeanPostProcessors`,代ç �如下: ``` public static void registerBeanPostProcessors( ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) { - // »ñÈ¡springÖÐËùÓÐµÄ BeanPostProcessor£¬ÕâÀï½öÓÐÒ»¸öbean: - // org.springframework.context.annotation.internalAutowiredAnnotationProcessor£¬ - // ¼´ AutowiredAnnotationBeanPostProcessor + // 获å�–spring中所有的 BeanPostProcessor,这里仅有一个bean: + // org.springframework.context.annotation.internalAutowiredAnnotationProcessor, + // å�³ AutowiredAnnotationBeanPostProcessor String[] postProcessorNames = beanFactory .getBeanNamesForType(BeanPostProcessor.class, true, false); @@ -47,9 +47,9 @@ public static void registerBeanPostProcessors( List orderedPostProcessorNames = new ArrayList<>(); List nonOrderedPostProcessorNames = new ArrayList<>(); - // ÏÈ»ñȡʵÏÖÁËPriorityOrderedµÄBeanPostProcessor - // ÔÙ»ñȡʵÏÖÁËOrderedµÄBeanPostProcessor - // ×îºóÔÙ»ñÈ¡²»Âú×ãÒÔÉÏÌõ¼þµÄBeanPostProcessor + // 先获å�–实现了PriorityOrderedçš„BeanPostProcessor + // å†�获å�–实现了Orderedçš„BeanPostProcessor + // 最å�Žå†�获å�–ä¸�满足以上æ�¡ä»¶çš„BeanPostProcessor for (String ppName : postProcessorNames) { if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) { BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class); @@ -66,7 +66,7 @@ public static void registerBeanPostProcessors( } } - // ´¦ÀípriorityOrderedPostProcessor£ºÅÅÐò£¬È»ºóÌí¼Óµ½beanFactoryÖÐ + // 处ç�†priorityOrderedPostProcessor:排åº�,然å�Žæ·»åŠ åˆ°beanFactory中 sortPostProcessors(priorityOrderedPostProcessors, beanFactory); registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors); @@ -79,7 +79,7 @@ public static void registerBeanPostProcessors( internalPostProcessors.add(pp); } } - // ´¦ÀíorderedPostProcessor£ºÅÅÐò£¬È»ºóÌí¼Óµ½beanFactoryÖÐ + // 处ç�†orderedPostProcessor:排åº�,然å�Žæ·»åŠ åˆ°beanFactory中 sortPostProcessors(orderedPostProcessors, beanFactory); registerBeanPostProcessors(beanFactory, orderedPostProcessors); @@ -92,11 +92,11 @@ public static void registerBeanPostProcessors( internalPostProcessors.add(pp); } } - // ´¦ÀíÓàϵÄBeanPostProcessor£ºÅÅÐò£¬È»ºóÌí¼Óµ½beanFactoryÖÐ + // 处ç�†ä½™ä¸‹çš„BeanPostProcessor:排åº�,然å�Žæ·»åŠ åˆ°beanFactory中 registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors); - // ´¦ÀíinternalPostProcessor£ºÅÅÐò£¬È»ºóÌí¼Óµ½beanFactoryÖÐ - // AutowiredAnnotationBeanPostProcessorʵÏÖÁËMergedBeanDefinitionPostProcessor£¬ - // Òò´ËÕâÀï»áÔÙ´Î×¢²á + // 处ç�†internalPostProcessor:排åº�,然å�Žæ·»åŠ åˆ°beanFactory中 + // AutowiredAnnotationBeanPostProcessor实现了MergedBeanDefinitionPostProcessor, + // 因此这里会å†�次注册 sortPostProcessors(internalPostProcessors, beanFactory); registerBeanPostProcessors(beanFactory, internalPostProcessors); @@ -105,16 +105,16 @@ public static void registerBeanPostProcessors( ``` -Õâ¿é´úÂëÖ÷ÒªÊÇ¶Ô `BeanFactoryPostProcessor` ½øÐÐ×¢²á²Ù×÷£¬²½ÖèÈçÏ£º +è¿™å�—代ç �主è¦�是对 `BeanFactoryPostProcessor` 进行注册æ“�作,步骤如下: -* ½«ÊµÏÖÁË `PriorityOrdered` µÄ `BeanPostProcessor` ×¢²áµ½ `beanFactory` ÖУ» -* ½«ÊµÏÖÁË `Ordered` µÄ `BeanPostProcessor` ×¢²áµ½ `beanFactory` ÖУ» -* ½«²»Âú×ãÉÏÊöÁ½¸öÌõ¼þµÄ `BeanPostProcessor` ×¢²áµ½ `beanFactory` ÖУ» -* ½«ËùÓÐʵÏÖÁË `MergedBeanDefinitionPostProcessor` µÄ `BeanPostProcessor` ÔÙ´Î×¢²áµ½ `beanFactory` ÖС£ +* 将实现了 `PriorityOrdered` çš„ `BeanPostProcessor` 注册到 `beanFactory` 中; +* 将实现了 `Ordered` çš„ `BeanPostProcessor` 注册到 `beanFactory` 中; +* å°†ä¸�满足上述两个æ�¡ä»¶çš„ `BeanPostProcessor` 注册到 `beanFactory` 中; +* 将所有实现了 `MergedBeanDefinitionPostProcessor` çš„ `BeanPostProcessor` å†�次注册到 `beanFactory` 中。 -ÊÂʵÉÏ£¬¶Ô demo01 ¶øÑÔ£¬ÕâÀï×¢²áµÄ bean Ö»ÓÐÒ»¸ö£º`AutowiredAnnotationBeanPostProcessor`£¬ËüͬʱʵÏÖÁË `MergedBeanDefinitionPostProcessor` Óë `PriorityOrdered`£¬Òò´Ë»á×¢²áÁ½´Î¡£ +事实上,对 demo01 而言,这里注册的 bean å�ªæœ‰ä¸€ä¸ªï¼š`AutowiredAnnotationBeanPostProcessor`,它å�Œæ—¶å®žçŽ°äº† `MergedBeanDefinitionPostProcessor` 与 `PriorityOrdered`,因此会注册两次。 -¾¡¹Ü×¢²áÁ˶à´Î `AutowiredAnnotationBeanPostProcessor`£¬µ«×îÖÕÖ»»á´æÔÚÒ»¸ö£¬ÈÃÎÒÃǽøÈë `registerBeanPostProcessors` ¿´¿´ spring ÊÇÈçºÎ×¢²áµÄ£¬Ò»Â·¸úÏÂÈ¥£¬´úÂëµ½ÁË `AbstractBeanFactory#addBeanPostProcessor`: +尽管注册了多次 `AutowiredAnnotationBeanPostProcessor`,但最终å�ªä¼šå­˜åœ¨ä¸€ä¸ªï¼Œè®©æˆ‘们进入 `registerBeanPostProcessors` 看看 spring 是如何注册的,一路跟下去,代ç �到了 `AbstractBeanFactory#addBeanPostProcessor`: > AbstractBeanFactory#addBeanPostProcessor @@ -124,7 +124,7 @@ private final List beanPostProcessors = new CopyOnWriteArrayL @Override public void addBeanPostProcessor(BeanPostProcessor beanPostProcessor) { Assert.notNull(beanPostProcessor, "BeanPostProcessor must not be null"); - // ÏȽøÐÐÒÆ³ý£¬Òò´Ë¶à´Î×¢²ábeanPostProcessorsÒ²Ö»´æÔÚÒ»¸ö + // 先进行移除,因此多次注册beanPostProcessors也å�ªå­˜åœ¨ä¸€ä¸ª this.beanPostProcessors.remove(beanPostProcessor); if (beanPostProcessor instanceof InstantiationAwareBeanPostProcessor) { this.hasInstantiationAwareBeanPostProcessors = true; @@ -137,10 +137,10 @@ public void addBeanPostProcessor(BeanPostProcessor beanPostProcessor) { ``` -¿ÉÒÔ¿´µ½£¬ËùνµÄ×¢²áµ½ `BeanFactory`£¬Æäʵ¾ÍÊÇ°Ñ `beanPostProcessor` ¼ÓÈëµ½ `BeanFactory` µÄ `beanPostProcessors` ÖС£ +å�¯ä»¥çœ‹åˆ°ï¼Œæ‰€è°“的注册到 `BeanFactory`,其实就是把 `beanPostProcessor` 加入到 `BeanFactory` çš„ `beanPostProcessors` 中。 -±¾ÎĽöÉÜÁË `beanPostProcessor` µÄ×¢²á£¬¹ØÓÚ `beanPostProcessor` µÄµ÷Ó㬺óÐøµÄ·ÖÎöÔÙÌáµ½£¬±¾ÎĵķÖÎö¾ÍÏȵ½ÕâÀï°É£¡ +本文仅ç»�了 `beanPostProcessor` 的注册,关于 `beanPostProcessor` 的调用,å�Žç»­çš„分æž�å†�æ��到,本文的分æž�就先到这里å�§ï¼� * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4657181](https://my.oschina.net/funcy/blog/4657181) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4657181](https://my.oschina.net/funcy/blog/4657181) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\344\270\200\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\344\270\200\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" index 1820d8f..f7c2725 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\344\270\200\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\344\270\200\357\274\211\357\274\232\345\220\257\345\212\250\346\265\201\347\250\213\346\200\273\347\273\223.md" @@ -1,15 +1,15 @@ -µ½ÁËÕâÀspring ÈÝÆ÷µÄÆô¶¯Á÷³ÌÖÕÓÚÊÇ·ÖÎöÍê³ÉÁË£¬ÕâÀïʹÓÃÒ»ÕÅͼÀ´×ܽáÕû¸öÆô¶¯Á÷³Ì£º +到了这里,spring 容器的å�¯åЍæµ�程终于是分æž�完æˆ�了,这里使用一张图æ�¥æ€»ç»“整个å�¯åЍæµ�程: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-72a4008f2ad3401de6b4f2d5c7f697923a3.png) -±¾ÏµÁÐ´Ó `AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...)` ·½·¨³ö·¢£¬·ÖÎöÁË `AnnotationConfigApplicationContext` µÄÎ޲ι¹Ôì·½·¨¡¢°üɨÃèÁ÷³Ì¡¢ÈÝÆ÷µÄÆô¶¯Á÷³ÌµÈ£¬Õⲿ·ÖÄÚÈÝ±È½Ï¶à£¬ÖØµãÁ÷³ÌÈçÏ£º +本系列从 `AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...)` 方法出å�‘,分æž�了 `AnnotationConfigApplicationContext` 的无å�‚构造方法ã€�包扫æ��æµ�程ã€�容器的å�¯åЍæµ�程等,这部分内容比较多,é‡�点æµ�程如下: -1. °üɨÃèÁ÷³Ì -2. ÔËÐÐ `beanFactoryProcessor` -3. ³õʼ»¯µ¥Àý bean +1. 包扫æ��æµ�程 +2. è¿�行 `beanFactoryProcessor` +3. åˆ�始化å�•例 bean -ÔÚ·ÖÎö¹ý³ÌÖУ¬ÎÒÃǺöÂÔÁËÐí¶àϸ½Ú£¬½ö¹Ø×¢ÁËÖ÷ÒªÁ÷³Ì£¬¶Ôϸ½Ú¸ÐÐËȤµÄС»ï°é¿ÉÒÔ¸ù¾ÝÌṩµÄÁ´½Ó½øÈëÏàÓ¦ÎÄÕÂÔĶÁ¡£ +在分æž�过程中,我们忽略了许多细节,仅关注了主è¦�æµ�程,对细节感兴趣的å°�伙伴å�¯ä»¥æ ¹æ�®æ��供的链接进入相应文章阅读。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4659519](https://my.oschina.net/funcy/blog/4659519) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4659519](https://my.oschina.net/funcy/blog/4659519) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\357\274\211\357\274\232\345\220\257\345\212\250\345\256\214\346\210\220\347\232\204\345\244\204\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\357\274\211\357\274\232\345\220\257\345\212\250\345\256\214\346\210\220\347\232\204\345\244\204\347\220\206.md" index a60a4d6..5acea1e 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\357\274\211\357\274\232\345\220\257\345\212\250\345\256\214\346\210\220\347\232\204\345\244\204\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\215\201\357\274\211\357\274\232\345\220\257\345\212\250\345\256\214\346\210\220\347\232\204\345\244\204\347\220\206.md" @@ -1,30 +1,30 @@ -½ÓÉÏÎÄ£¬¼ÌÐø·ÖÎö spring µÄÆô¶¯Á÷³Ì¡£ +接上文,继续分æž� spring çš„å�¯åЍæµ�程。 -12. Íê³ÉÆô¶¯²Ù×÷: finishRefresh() +12. 完æˆ�å�¯åЍæ“�作: finishRefresh() -AbstractApplicationContext#finishRefresh ·½·¨ÈçÏ£º +AbstractApplicationContext#finishRefresh 方法如下: protected void finishRefresh() { - // ¿´Ãû×Ö¾ÍÖªµÀÁË£¬ÇåÀí³õʼ»¯¹ý³ÌÖÐһϵÁвÙ×÷ʹÓõ½µÄ×ÊÔ´»º´æ + // 看å��字就知é�“了,清ç�†åˆ�始化过程中一系列æ“�作使用到的资æº�缓存 clearResourceCaches(); - // ³õʼ»¯LifecycleProcessor + // åˆ�始化LifecycleProcessor initLifecycleProcessor(); - // Õâ¸ö·½·¨µÄÄÚ²¿ÊµÏÖÊÇÆô¶¯ËùÓÐʵÏÖÁËLifecycle½Ó¿ÚµÄbean + // 这个方法的内部实现是å�¯åŠ¨æ‰€æœ‰å®žçŽ°äº†Lifecycle接å�£çš„bean getLifecycleProcessor().onRefresh(); - // ·¢²¼ContextRefreshedEventʼþ + // å�‘布ContextRefreshedEvent事件 publishEvent(new ContextRefreshedEvent(this)); - // ¼ì²éspring.liveBeansView.mbeanDomainÊÇ·ñ´æÔÚ£¬Óоͻᴴ½¨Ò»¸öMBeanServer + // 检查spring.liveBeansView.mbeanDomain是å�¦å­˜åœ¨ï¼Œæœ‰å°±ä¼šåˆ›å»ºä¸€ä¸ªMBeanServer LiveBeansView.registerApplicationContext(this); } -Õâ¸ö·½·¨´úÂë²»¶à£¬¾Í¼¸¸ö·½·¨£¬ÎÒÃÇ·Ö±ðÀ´¿´¿´¡£ +这个方法代ç �ä¸�多,就几个方法,我们分别æ�¥çœ‹çœ‹ã€‚ -1. ÇåÀí×ÊÔ´»º´æ£ºclearResourceCaches() +1. 清ç�†èµ„æº�缓存:clearResourceCaches() -clearResourceCaches() ·½·¨ÄÚÈÝÈçÏ£º +clearResourceCaches() 方法内容如下: public class DefaultResourceLoader implements ResourceLoader { @@ -35,72 +35,72 @@ clearResourceCaches() this.resourceCaches.clear(); } - // Ê¡ÂÔÁËÕâ¸öÀàµÄºÃ¶à´úÂë + // çœ�略了这个类的好多代ç � ... } -Õâ¸ö·½·¨¾ÍÊÇÓÃÀ´ÇåÀí resourceCaches µÄ£¬ÕâÊǸö Map£¬ÀïÃæ´æÈëµÄÄÚÈÝÊÇ Resource¡£ +这个方法就是用æ�¥æ¸…ç�† resourceCaches 的,这是个 Map,里é�¢å­˜å…¥çš„内容是 Resource。 -ÄÇʲôÊÇ Resource ÄØ£¿ÔÚÇ°Ãæ½éÉÜɨÃè°üµÄ¹ý³ÌÖУ¬ÎÒÃÇ»áÏ顄 class Îļþ¶ÁÈ¡³öÀ´£¬×ª»»³É Resource ºóÔÙ½øÒ»²½´¦Àí£¬³£¼ûµÄ Resource ÀàÐÍÓÐ FileSystemResource¡¢UrlResource µÈ£¬resourceCaches ¾ÍÊÇ´æ·ÅÕâЩ Resource µÄ¡£ +那什么是 Resource 呢?在å‰�é�¢ä»‹ç»�扫æ��包的过程中,我们会先把 class 文件读å�–出æ�¥ï¼Œè½¬æ�¢æˆ� Resource å�Žå†�进一步处ç�†ï¼Œå¸¸è§�çš„ Resource 类型有 FileSystemResourceã€�UrlResource 等,resourceCaches 就是存放这些 Resource 的。 -2. ´¦Àí LifecycleProcessor +2. 处ç�† LifecycleProcessor -ÎÒÃÇÏÈÀ´¿´¿´Ê²Ã´ÊÇ LifecycleProcessor£º +我们先æ�¥çœ‹çœ‹ä»€ä¹ˆæ˜¯ LifecycleProcessor: /** - * ´¦ÀíÈÝÆ÷µÄÆô¶¯Óë¹Ø±Õ²Ù×÷ + * 处ç�†å®¹å™¨çš„å�¯åŠ¨ä¸Žå…³é—­æ“�作 */ public interface LifecycleProcessor extends Lifecycle { /** - * ÈÝÆ÷Æô¶¯Íê³Éʱµ÷Óà + * 容器å�¯åŠ¨å®Œæˆ�时调用 */ void onRefresh(); /** - * ÈÝÆ÷¹Ø±Õʱµ÷Óà + * 容器关闭时调用 */ void onClose(); } -Õâ¸ö½Ó¿ÚÓÃÀ´´¦ÀíÈÝÆ÷´¦ÀíÈÝÆ÷µÄÆô¶¯Óë¹Ø±Õ²Ù×÷£¬±ÈÈçÎÒÃÇ×Ô¼ºÊµÏָýӿڣ¬È»ºóÖØÐ´ onRefresh() Óë onClose()£¬ÒÔ±ãÔÚÈÝÆ÷Æô¶¯Óë¹Ø±Õʱ×öһЩ²Ù×÷£¬ÏñÕâÑù£º +这个接å�£ç”¨æ�¥å¤„ç�†å®¹å™¨å¤„ç�†å®¹å™¨çš„å�¯åŠ¨ä¸Žå…³é—­æ“�作,比如我们自己实现该接å�£ï¼Œç„¶å�Žé‡�写 onRefresh() 与 onClose(),以便在容器å�¯åŠ¨ä¸Žå…³é—­æ—¶å�šä¸€äº›æ“�作,åƒ�这样: @Component public class MyLifecycleProcessor implements LifecycleProcessor { @Override public void onRefresh() { - System.out.println("ÈÝÆ÷Æô¶¯"); + System.out.println("容器å�¯åЍ"); } @Override public void onClose() { - System.out.println("ÈÝÆ÷¹Ø±Õ"); + System.out.println("容器关闭"); } } -Óë LifecycleProcessor Ïà¹ØµÄ·½·¨ÓÐÁ½¸ö£ºinitLifecycleProcessor()¡¢getLifecycleProcessor()£¬ÎÒÃÇÒ»ÆðһΪ¿´¿´ÕâÁ½¸ö·½·¨£º +与 LifecycleProcessor 相关的方法有两个:initLifecycleProcessor()ã€�getLifecycleProcessor(),我们一起一为看看这两个方法: AbstractApplicationContext private LifecycleProcessor lifecycleProcessor; /** - * ³õʼ»¯ LifecycleProcessor + * åˆ�始化 LifecycleProcessor */ protected void initLifecycleProcessor() { ConfigurableListableBeanFactory beanFactory = getBeanFactory(); - // ´æÔÚ£¬Ö±½ÓʹÓà + // 存在,直接使用 if (beanFactory.containsLocalBean(LIFECYCLE_PROCESSOR_BEAN_NAME)) { this.lifecycleProcessor = beanFactory.getBean(LIFECYCLE_PROCESSOR_BEAN_NAME, LifecycleProcessor.class); } - // ²»´æÔÚÔò´´½¨£¬Ä¬ÈÏʹÓÃDefaultLifecycleProcessor + // ä¸�存在则创建,默认使用DefaultLifecycleProcessor else { DefaultLifecycleProcessor defaultProcessor = new DefaultLifecycleProcessor(); defaultProcessor.setBeanFactory(beanFactory); @@ -110,7 +110,7 @@ AbstractApplicationContext } /** - * ·µ»Ø lifecycleProcessor + * 返回 lifecycleProcessor */ LifecycleProcessor getLifecycleProcessor() throws IllegalStateException { if (this.lifecycleProcessor == null) { @@ -120,11 +120,11 @@ AbstractApplicationContext } -initLifecycleProcessor Ëù×öµÄ¾ÍÊÇÉèÖà AbstractApplicationContext#lifecycleProcessor ÊôÐÔ£¬Èç¹û beanFactory ÖдæÔÚ initLifecycleProcessor ÔòÖ±½ÓʹÓ㬷ñÔò¾Í´´½¨Ò»¸ö¡£ +initLifecycleProcessor 所å�šçš„就是设置 AbstractApplicationContext#lifecycleProcessor 属性,如果 beanFactory 中存在 initLifecycleProcessor 则直接使用,å�¦åˆ™å°±åˆ›å»ºä¸€ä¸ªã€‚ -getLifecycleProcessor() ½ö½öÖ»ÊÇ·µ»ØÁË AbstractApplicationContext#lifecycleProcessor ÊôÐÔ¡£ +getLifecycleProcessor() ä»…ä»…å�ªæ˜¯è¿”回了 AbstractApplicationContext#lifecycleProcessor 属性。 -ÔÚ getLifecycleProcessor().onRefresh() ÖУ¬»¹µ÷ÓÃÁË onRefresh() ·½·¨£¬ÎÒÃÇÒ»ÆðÀ´¿´¿´ DefaultLifecycleProcessor#onRefresh ×öÁËʲô£º +在 getLifecycleProcessor().onRefresh() 中,还调用了 onRefresh() 方法,我们一起æ�¥çœ‹çœ‹ DefaultLifecycleProcessor#onRefresh å�šäº†ä»€ä¹ˆï¼š @Override public void onRefresh() { @@ -133,15 +133,15 @@ getLifecycleProcessor() } -´Ó±äÁ¿À´¿´£¬Õâ¸ö·½·¨½ö½öÖ»ÊǸÄÁËÒ»¸öÔËÐÐ״̬¡£ +从å�˜é‡�æ�¥çœ‹ï¼Œè¿™ä¸ªæ–¹æ³•ä»…ä»…å�ªæ˜¯æ”¹äº†ä¸€ä¸ªè¿�行状æ€�。 -3. ·¢²¼ ContextRefreshedEvent ʼþ +3. å�‘布 ContextRefreshedEvent 事件 -´úÂë publishEvent(new ContextRefreshedEvent(this)) ·¢²¼ÁË ContextRefreshedEvent£¬ÎÒÃÇ×Ô¼ºÒ²¿ÉÒÔÀ´¼àÌý¸Ãʼþ¡£¹ØÓÚʼþ£¬±¾ÎIJ¢²»´òËãÉîÈ룬¹ØÓÚ spring ʼþµÄÏêϸ·ÖÎö£¬¿ÉÒԲο¼ spring Ì½ÃØÖ® spring ʼþ»úÖÆ¡£ +代ç � publishEvent(new ContextRefreshedEvent(this)) å�‘布了 ContextRefreshedEvent,我们自己也å�¯ä»¥æ�¥ç›‘å�¬è¯¥äº‹ä»¶ã€‚关于事件,本文并ä¸�打算深入,关于 spring 事件的详细分æž�,å�¯ä»¥å�‚考 spring 探秘之 spring 事件机制。 -13. Çå³ý»º´æ: resetCommonCaches() +13. 清除缓存: resetCommonCaches() -¸Ã·½·¨´úÂëÈçÏ£º +该方法代ç �如下: protected void resetCommonCaches() { ReflectionUtils.clearCache(); @@ -151,8 +151,8 @@ getLifecycleProcessor() } -´Ó·½·¨À´¿´£¬¾ÍÊÇÖ´Ðи÷ÖÖ»º´æ£¬Ö´ÐбȽϼòµ¥£¬¾Í²»ÉÁË¡£ +从方法æ�¥çœ‹ï¼Œå°±æ˜¯æ‰§è¡Œå�„ç§�缓存,执行比较简å�•,就ä¸�深究了。 --- -±¾ÎÄÔ­ÎÄÁ´½Ó£ºhttps://my.oschina.net/funcy/blog/4892555 £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£ +本文原文链接:https://my.oschina.net/funcy/blog/4892555 ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250\345\211\215\347\232\204\345\207\206\345\244\207\345\267\245\344\275\234.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250\345\211\215\347\232\204\345\207\206\345\244\207\345\267\245\344\275\234.md" index 10070df..9fca6fb 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250\345\211\215\347\232\204\345\207\206\345\244\207\345\267\245\344\275\234.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\345\220\257\345\212\250\346\265\201\347\250\213/Spring\345\220\257\345\212\250\346\265\201\347\250\213\357\274\210\345\233\233\357\274\211\357\274\232\345\220\257\345\212\250\345\211\215\347\232\204\345\207\206\345\244\207\345\267\245\344\275\234.md" @@ -1,12 +1,12 @@ -Íê³É°üµÄɨÃèºó£¬½ÓמͿªÊ¼ÁË spring µÄÆô¶¯ÁË£¬¼´ `AbstractApplicationContext#refresh` ·½·¨£¬¸Ã·½·¨Ò»¹²°üº¬ 13 ¸ö²Ù×÷£¬º­¸ÇÒ² spring Æô¶¯µÄÕû¸öÁ÷³Ì£º +完æˆ�包的扫æ��å�Žï¼ŒæŽ¥ç�€å°±å¼€å§‹äº† spring çš„å�¯åŠ¨äº†ï¼Œå�³ `AbstractApplicationContext#refresh` 方法,该方法一共包å�« 13 个æ“�作,涵盖也 spring å�¯åŠ¨çš„æ•´ä¸ªæµ�程: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-88c3a2486c24ccd0ad390ba9b62b986a6b2.png) -±¾ÏµÁдӱ¾ÎÄ¿ªÊ¼£¬Öð²½·ÖÎöÕâ 13 ¸ö·½·¨£¬Ì½Ë÷ spring µÄÆô¶¯Á÷³Ì¡£ +本系列从本文开始,é€�步分æž�è¿™ 13 个方法,探索 spring çš„å�¯åЍæµ�程。 -### 1\. Æô¶¯Ç°×¼±¸£º`prepareRefresh()` +### 1\. å�¯åЍå‰�准备:`prepareRefresh()` -¸ú½ø `prepareRefresh()` ·½·¨£¬µ÷ÓÃÁ´ÈçÏ£º +è·Ÿè¿› `prepareRefresh()` 方法,调用链如下: ``` |-AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(String...) @@ -15,7 +15,7 @@ ``` -´úÂëÈçÏ£º +代ç �如下: ``` protected void prepareRefresh() { @@ -24,10 +24,10 @@ protected void prepareRefresh() { this.closed.set(false); this.active.set(true); - // ³õʼ»¯¼ÓÔØÅäÖÃÎļþ·½·¨£¬²¢Ã»ÓоßÌåʵÏÖ£¬Ò»¸öÁô¸øÓû§µÄÀ©Õ¹µã + // åˆ�始化加载é…�置文件方法,并没有具体实现,一个留给用户的扩展点 initPropertySources(); - // ¼ì²é»·¾³±äÁ¿ + // 检查环境å�˜é‡� getEnvironment().validateRequiredProperties(); if (this.earlyApplicationListeners == null) { @@ -42,39 +42,39 @@ protected void prepareRefresh() { ``` -Õâ¶Î´úÂë±È½Ï¼òµ¥£¬¾ÍÊÇÉèÖÃÁËÏÂÆô¶¯Ê±¼ä¡¢ÈÝÆ÷µÄÆô¶¯×´Ì¬¡¢»·¾³±äÁ¿µÄ¼ì²é¡¢ÊôÐԵijõʼ»¯µÈ¡£ +这段代ç �比较简å�•,就是设置了下å�¯åŠ¨æ—¶é—´ã€�容器的å�¯åŠ¨çŠ¶æ€�ã€�环境å�˜é‡�的检查ã€�属性的åˆ�始化等。 -### 2\. »ñÈ¡ `beanFactory: obtainFreshBeanFactory()` +### 2\. 获å�– `beanFactory: obtainFreshBeanFactory()` -ÎÒÃÇÔÙ¸ú½ø `obtainFreshBeanFactory()` ·½·¨£¬ÄÚÈÝÈçÏ£º +我们å†�è·Ÿè¿› `obtainFreshBeanFactory()` 方法,内容如下: > AbstractApplicationContext#obtainFreshBeanFactory ``` protected ConfigurableListableBeanFactory obtainFreshBeanFactory() { refreshBeanFactory(); - // ·µ»Ø¸Õ¸Õ´´½¨µÄ BeanFactory + // 返回刚刚创建的 BeanFactory return getBeanFactory(); } ``` -Õâ¸ö·½·¨ÏÈÊÇ `refresh` ÁË `BeanFactory`£¬È»ºóÔÙ·µ»ØÁË `BeanFactory`£¬ÎÒÃǼÌÐø¸ú½ø `refreshBeanFactory()`£º +这个方法先是 `refresh` 了 `BeanFactory`,然å�Žå†�返回了 `BeanFactory`,我们继续跟进 `refreshBeanFactory()`: > GenericApplicationContext#refreshBeanFactory ``` @Override protected final void refreshBeanFactory() throws IllegalStateException { - // Ê¡ÂÔÁËһЩÅжϴúÂë + // çœ�略了一些判断代ç � this.beanFactory.setSerializationId(getId()); } ``` -Õâ¸ö·½·¨¹Ø¼ü´úÂëÖ»ÓÐÒ»ÐУ¬×÷ÓÃÊÇÓÃÀ´ÉèÖà beanFactory µÄ `SerializationId`. +这个方法关键代ç �å�ªæœ‰ä¸€è¡Œï¼Œä½œç”¨æ˜¯ç”¨æ�¥è®¾ç½® beanFactory çš„ `SerializationId`. -ÎÒÃÇÔٻعýÍ·À´¿´¿´ `getBeanFactory()` ·½·¨£º +我们å†�回过头æ�¥çœ‹çœ‹ `getBeanFactory()` 方法: > GenericApplicationContext#getBeanFactory @@ -85,32 +85,32 @@ public final ConfigurableListableBeanFactory getBeanFactory() { ``` -Õâ¸ö·½·¨¾Í¸ü¼òµ¥ÁË£¬½ö½ö·µ»ØÁ˵±Ç°ÀàµÄ `beanFactory`£¬Õâ¸ö `beanFactory` ¾ÍÊÇÎÒÃÇÔÚ·ÖÎö `AnnotationConfigApplicationContext` ¹¹Ôì·½·¨Ê±´´½¨µÄ£¬ÀàÐÍΪ `DefaultListableBeanFactory`. +这个方法就更简å�•了,仅仅返回了当å‰�类的 `beanFactory`,这个 `beanFactory` 就是我们在分æž� `AnnotationConfigApplicationContext` 构造方法时创建的,类型为 `DefaultListableBeanFactory`. -### 3\. ×¼±¸ `beanFactory: prepareBeanFactory(beanFactory)` +### 3\. 准备 `beanFactory: prepareBeanFactory(beanFactory)` -ÎÒÃǼÌÐø£¬½øÈë `prepareBeanFactory(beanFactory)` ·½·¨£º +我们继续,进入 `prepareBeanFactory(beanFactory)` 方法: > AbstractApplicationContext#prepareBeanFactory ``` protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) { - // ÉèÖÃΪ¼ÓÔØµ±Ç°ApplicationContextÀàµÄÀà¼ÓÔØÆ÷ + // 设置为加载当å‰�ApplicationContext类的类加载器 beanFactory.setBeanClassLoader(getClassLoader()); - // ÉèÖà BeanExpressionResolver¡ª¡ªbean±í´ïʽ½âÎöÆ÷ + // 设置 BeanExpressionResolver——bean表达å¼�è§£æž�器 beanFactory.setBeanExpressionResolver( new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader())); - // ÊôÐԱ༭Æ÷Ö§³Ö + // 属性编辑器支æŒ� beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment())); - // ÕâÀïÊÇSpringµÄÓÖÒ»¸öÀ©Õ¹µã - // ÔÚËùÓÐʵÏÖÁËAware½Ó¿ÚµÄbeanÔÚ³õʼ»¯µÄʱºò£¬Õâ¸ö processor¸ºÔð»Øµ÷£¬ - // Õâ¸öÎÒÃǺܳ£Óã¬ÈçÎÒÃÇ»áΪÁË»ñÈ¡ ApplicationContext ¶ø implement ApplicationContextAware - // ×¢Ò⣺Ëü²»½ö½ö»Øµ÷ ApplicationContextAware£¬»¹»á¸ºÔð»Øµ÷ EnvironmentAware¡¢ResourceLoaderAware µÈ + // 这里是Springçš„å�ˆä¸€ä¸ªæ‰©å±•点 + // 在所有实现了Aware接å�£çš„bean在åˆ�始化的时候,这个 processor负责回调, + // 这个我们很常用,如我们会为了获å�– ApplicationContext 而 implement ApplicationContextAware + // 注æ„�:它ä¸�仅仅回调 ApplicationContextAware,还会负责回调 EnvironmentAwareã€�ResourceLoaderAware ç­‰ beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this)); - // ÏÂÃæ¼¸ÐеÄÒâ˼¾ÍÊÇ£¬Èç¹ûij¸ö bean ÒÀÀµÓÚÒÔϼ¸¸ö½Ó¿ÚµÄʵÏÖÀ࣬ - // ÔÚ×Ô¶¯×°ÅäµÄʱºòºöÂÔËüÃÇ£¬Spring »áͨ¹ýÆäËû·½Ê½À´´¦ÀíÕâЩÒÀÀµ¡£ + // 下é�¢å‡ è¡Œçš„æ„�æ€�就是,如果æŸ�个 bean ä¾�赖于以下几个接å�£çš„实现类, + // 在自动装é…�的时候忽略它们,Spring 会通过其他方å¼�æ�¥å¤„ç�†è¿™äº›ä¾�赖。 beanFactory.ignoreDependencyInterface(EnvironmentAware.class); beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class); beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class); @@ -118,16 +118,16 @@ protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) { beanFactory.ignoreDependencyInterface(MessageSourceAware.class); beanFactory.ignoreDependencyInterface(ApplicationContextAware.class); - // ÏÂÃæ¼¸ÐоÍÊÇÎªÌØÊâµÄ¼¸¸ö bean ¸³Öµ£¬Èç¹ûÓÐ bean ÒÀÀµÁËÒÔϼ¸¸ö£¬»á×¢ÈëÕâ±ßÏàÓ¦µÄÖµ + // 下é�¢å‡ è¡Œå°±æ˜¯ä¸ºç‰¹æ®Šçš„几个 bean 赋值,如果有 bean ä¾�赖了以下几个,会注入这边相应的值 beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory); beanFactory.registerResolvableDependency(ResourceLoader.class, this); beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this); beanFactory.registerResolvableDependency(ApplicationContext.class, this); - // Ìí¼ÓÒ»¸öºóÖô¦ÀíÆ÷£ºApplicationListenerDetector£¬´ËºóÖô¦ÀíÆ÷ʵÏÖÁËBeanPostProcessor½Ó¿Ú + // 添加一个å�Žç½®å¤„ç�†å™¨ï¼šApplicationListenerDetector,此å�Žç½®å¤„ç�†å™¨å®žçŽ°äº†BeanPostProcessor接å�£ beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this)); - // Èç¹û´æÔÚbeanÃû³ÆÎªloadTimeWeaverµÄbeanÔò×¢²áÒ»¸öBeanPostProcessor + // 如果存在beanå��称为loadTimeWeaverçš„bean则注册一个BeanPostProcessor if (beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) { beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory)); // Set a temporary ClassLoader for type matching. @@ -135,16 +135,16 @@ protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) { new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader())); } - // Èç¹ûûÓж¨Òå "environment" Õâ¸ö bean£¬ÄÇô Spring »á "ÊÖ¶¯" ×¢²áÒ»¸ö + // 如果没有定义 "environment" 这个 bean,那么 Spring 会 "手动" 注册一个 if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) { beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment()); } - // Èç¹ûûÓж¨Òå "systemProperties" Õâ¸ö bean£¬ÄÇô Spring »á "ÊÖ¶¯" ×¢²áÒ»¸ö + // 如果没有定义 "systemProperties" 这个 bean,那么 Spring 会 "手动" 注册一个 if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) { beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties()); } - // Èç¹ûûÓж¨Òå "systemEnvironment" Õâ¸ö bean£¬ÄÇô Spring »á "ÊÖ¶¯" ×¢²áÒ»¸ö + // 如果没有定义 "systemEnvironment" 这个 bean,那么 Spring 会 "手动" 注册一个 if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) { beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment()); @@ -153,9 +153,9 @@ protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) { ``` -Õâ¸ö·½·¨ÊÇ¶Ô beanFactory µÄһЩ׼±¸£¬ÉèÖÃһЩÊôÐÔ£¬Ìí¼ÓһЩ bean ´¦ÀíµÈ£¬´úÂë¶¼ÓÐ×¢½â£¬ÕâÀï¾Í²»Öظ´ËµÁË¡£ +这个方法是对 beanFactory 的一些准备,设置一些属性,添加一些 bean 处ç�†ç­‰ï¼Œä»£ç �都有注解,这里就ä¸�é‡�å¤�说了。 -¹ØÓÚÍù beanFactory ÖÐÌí¼Ó `ApplicationListenerDetector` ÐèÒªÌáÏ£¬Ïà¹Ø´úÂëΪ `beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this));`£¬ÎÒÃÇ¿´Ï `ApplicationListenerDetector` Õâ¸öÀࣺ +关于往 beanFactory 中添加 `ApplicationListenerDetector` 需è¦�æ��下,相关代ç �为 `beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this));`,我们看下 `ApplicationListenerDetector` 这个类: > org.springframework.context.support.ApplicationContextAwareProcessor @@ -164,7 +164,7 @@ class ApplicationContextAwareProcessor implements BeanPostProcessor { @Override @Nullable public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � AccessControlContext acc = null; if (System.getSecurityManager() != null) { acc = this.applicationContext.getBeanFactory().getAccessControlContext(); @@ -180,51 +180,51 @@ class ApplicationContextAwareProcessor implements BeanPostProcessor { return bean; } - // »Øµ÷ Aware½Ó¿Ú + // 回调 Aware接å�£ private void invokeAwareInterfaces(Object bean) { - // µ÷Óà EnvironmentAware#setEnvironment ·½·¨ + // 调用 EnvironmentAware#setEnvironment 方法 if (bean instanceof EnvironmentAware) { ((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment()); } - // µ÷Óà EmbeddedValueResolverAware#setEmbeddedValueResolver ·½·¨ + // 调用 EmbeddedValueResolverAware#setEmbeddedValueResolver 方法 if (bean instanceof EmbeddedValueResolverAware) { ((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver); } - // µ÷Óà ResourceLoaderAware#setResourceLoader ·½·¨ + // 调用 ResourceLoaderAware#setResourceLoader 方法 if (bean instanceof ResourceLoaderAware) { ((ResourceLoaderAware) bean).setResourceLoader(this.applicationContext); } - // µ÷Óà ApplicationEventPublisherAware#setApplicationEventPublisher ·½·¨ + // 调用 ApplicationEventPublisherAware#setApplicationEventPublisher 方法 if (bean instanceof ApplicationEventPublisherAware) { ((ApplicationEventPublisherAware) bean).setApplicationEventPublisher(this.applicationContext); } - // µ÷Óà MessageSourceAware#setMessageSource ·½·¨ + // 调用 MessageSourceAware#setMessageSource 方法 if (bean instanceof MessageSourceAware) { ((MessageSourceAware) bean).setMessageSource(this.applicationContext); } - // µ÷Óà ApplicationContextAware#setApplicationContext ·½·¨ + // 调用 ApplicationContextAware#setApplicationContext 方法 if (bean instanceof ApplicationContextAware) { ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext); } } - // Ê¡ÂÔÆäËû´úÂë + // çœ�略其他代ç � } ``` -¿ÉÒÔ¿´µ½£¬ +å�¯ä»¥çœ‹åˆ°ï¼Œ -1. Õâ¸öÀàʵÏÖÁË `BeanPostProcessor` ½Ó¿Ú£» -2. ·½·¨ `postProcessBeforeInitialization` ÓÉ `BeanPostProcessor` Ìṩ£¬×îΪ¹Ø¼üµÄ´úÂëÊÇ` invokeAwareInterfaces(bean);`£» -3. `invokeAwareInterfaces` Ö»ÊÇһϵÁеķ½·¨µ÷Óà +1. 这个类实现了 `BeanPostProcessor` 接å�£ï¼› +2. 方法 `postProcessBeforeInitialization` ç”± `BeanPostProcessor` æ��供,最为关键的代ç �是` invokeAwareInterfaces(bean);`ï¼› +3. `invokeAwareInterfaces` å�ªæ˜¯ä¸€ç³»åˆ—的方法调用 -¹ØÓÚ `BeanPostProcessor` µÄµÄ·ÖÎö£¬¿ÉÒԲο¼ [spring ×é¼þÖ® BeanPostProcessors ](https://my.oschina.net/funcy/blog/4597551)£¬¹ØÓÚ¸ÃÀàµÄ×÷Ó㬺óÐø»á¼ÌÐø½²µ½¡£ +关于 `BeanPostProcessor` 的的分æž�,å�¯ä»¥å�‚考 [spring 组件之 BeanPostProcessors ](https://my.oschina.net/funcy/blog/4597551),关于该类的作用,å�Žç»­ä¼šç»§ç»­è®²åˆ°ã€‚ -ºÃÁË£¬±¾ÎĵķÖÎö¾Íµ½ÕâÀïÁË£¬±¾ÎĽö·ÖÎöÁË spring Æô¶¯Ê±¶Ô beanFactory µÄ×¼±¸£¬ÄÚÈݽϼòµ¥£¬×îºóÓÃÒ»·ùͼÀ´×ܽáϱ¾ÎÄÄÚÈÝ£º +好了,本文的分æž�就到这里了,本文仅分æž�了 spring å�¯åŠ¨æ—¶å¯¹ beanFactory 的准备,内容较简å�•,最å�Žç”¨ä¸€å¹…图æ�¥æ€»ç»“下本文内容: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1e10d7aff080b2e0bbfbef5d79c56cc54c9.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4633169](https://my.oschina.net/funcy/blog/4633169) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4633169](https://my.oschina.net/funcy/blog/4633169) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213ApplicationContext.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213ApplicationContext.md" index ff74cca..b1967e6 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213ApplicationContext.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213ApplicationContext.md" @@ -1,13 +1,13 @@ -### 1. `ApplicationContext` ¼ò½é +### 1. `ApplicationContext` 简介 -ÎÒÃÇÔÚÆô¶¯ spring ÈÝÆ÷ʱ£¬Ò»°ãÏñÕâÑùÆô¶¯£º +我们在å�¯åЍ spring 容器时,一般åƒ�这样å�¯åŠ¨ï¼š ``` ApplicationContext context = new AnnotationConfigApplicationContext(Main.class); ``` -»òÕâÑù£º +或这样: ``` ApplicationContext context = new AnnotationConfigWebApplicationContext(); @@ -16,11 +16,11 @@ context.refresh(); ``` -ÕâÀïµÄ `AnnotationConfigApplicationContext` Óë `AnnotationConfigWebApplicationContext` ¶¼ÊÇ `ApplicationContext`£¬×îÖÕ½øÐлáµ÷Óà `AbstractApplicationContext#refresh` ·½·¨Æô¶¯ spring ÈÝÆ÷¡£ +这里的 `AnnotationConfigApplicationContext` 与 `AnnotationConfigWebApplicationContext` 都是 `ApplicationContext`,最终进行会调用 `AbstractApplicationContext#refresh` 方法å�¯åЍ spring 容器。 -`ApplicationContext` ·­ÒëΪ **spring Ó¦ÓÃÉÏÏÂÎÄ**£¬´ÓÕâ¸öÀàÀï¿ÉÒÔ»ñÈ¡ spring ÔËÐÐÆÚ¼äµÄ¸÷ÖÖÐÅÏ¢£¬Èç `BeanFactory`¡¢`Environment` µÈ£¬ÊÇ spring ÖÐÖÁ¹ØÖØÒªµÄÒ»¸öÀà¡£ +`ApplicationContext` 翻译为 **spring 应用上下文**,从这个类里å�¯ä»¥èŽ·å�– spring è¿�行期间的å�„ç§�ä¿¡æ�¯ï¼Œå¦‚ `BeanFactory`ã€�`Environment` 等,是 spring 中至关é‡�è¦�的一个类。 -`ApplicationContext` ¼Ì³ÐµÄ½Ó¿ÚÈçÏ£º +`ApplicationContext` 继承的接å�£å¦‚下: ``` public interface ApplicationContext extends EnvironmentCapable, ListableBeanFactory, @@ -31,39 +31,39 @@ public interface ApplicationContext extends EnvironmentCapable, ListableBeanFact ``` -´ÓÕâÀï¿ÉÒÔ¿´µ½£¬`ApplicationContext` ±¾ÉíÒ²ÊÇÆäËû½Ó¿ÚµÄ×Ó½Ó¿Ú£¬ÕâЩ½Ó¿ÚµÄ¹¦ÄÜÈçÏ£º +从这里å�¯ä»¥çœ‹åˆ°ï¼Œ`ApplicationContext` 本身也是其他接å�£çš„å­�接å�£ï¼Œè¿™äº›æŽ¥å�£çš„功能如下: -* `EnvironmentCapable`£ºÌṩÁË»·¾³ÅäÖù¦ÄÜ£¬`applicationContext` ʵÏÖÖлáÓÐÒ»¸ö `Environment` ÀàÐ͵ijÉÔ±±äÁ¿£¬¿ÉÒÔͨ¹ý `EnvironmentCapable#getEnvironment()` ·½·¨È¡µÃ -* `ListableBeanFactory`£º`BeanFactory` µÄ×Ó½Ó¿Ú£¬ÌṩÁËÁо٠`BeanFactory` ÖÐËùÓÐ `bean` µÄ·½·¨ -* `HierarchicalBeanFactory`£º`BeanFactory` µÄ×Ó½Ó¿Ú£¬ÌṩÁË `BeanFactory` ÀàËÆ¼Ì³ÐµÄÄÜÁ¦£¨¿ÉÒÔ»ñÈ¡¸¸ `BeanFactory`£© -* `MessageSource`£ºÖ¸¶¨ÏûÏ¢À´Ô´£¬¿ÉÒÔÓÃÀ´ÊµÏÖ¹ú¼Ê»¯²Ù×÷ -* `ApplicationEventPublisher`£ºÊ¼þ·¢²¼Æ÷£¬ÓÃÆäÌṩµÄ `publishEvent(...)` ·½·¨À´·¢²¼Ê¼þ -* `ResourcePatternResolver`£º×ÊÔ´½âÎöÆ÷£¬ÌṩÁË»ñÈ¡×ÊÔ´£¨`Resource`£©µÄ·½·¨£º`getResources(...)` +* `EnvironmentCapable`:æ��供了环境é…�置功能,`applicationContext` 实现中会有一个 `Environment` 类型的æˆ�员å�˜é‡�,å�¯ä»¥é€šè¿‡ `EnvironmentCapable#getEnvironment()` 方法å�–å¾— +* `ListableBeanFactory`:`BeanFactory` çš„å­�接å�£ï¼Œæ��供了列举 `BeanFactory` 中所有 `bean` 的方法 +* `HierarchicalBeanFactory`:`BeanFactory` çš„å­�接å�£ï¼Œæ��供了 `BeanFactory` 类似继承的能力(å�¯ä»¥èŽ·å�–父 `BeanFactory`) +* `MessageSource`:指定消æ�¯æ�¥æº�,å�¯ä»¥ç”¨æ�¥å®žçŽ°å›½é™…åŒ–æ“�作 +* `ApplicationEventPublisher`:事件å�‘布器,用其æ��供的 `publishEvent(...)` 方法æ�¥å�‘布事件 +* `ResourcePatternResolver`:资æº�è§£æž�器,æ��供了获å�–资æº�(`Resource`)的方法:`getResources(...)` -ÎÒÃÇÀ´¿´¿´ `ApplicationContext` ×ÔÉíÌṩµÄ·½·¨£º +我们æ�¥çœ‹çœ‹ `ApplicationContext` 自身æ��供的方法: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-82de66bd51d650aa8a1fda29bdda3efd6b4.png) -¿ÉÒÔ¿´µ½£¬Ëü×ÔÉíµÄ·½·¨²¢²»¶à¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒè‡ªèº«çš„æ–¹æ³•å¹¶ä¸�多。 -### 2. `ApplicationContext` ¼Ì³Ð½á¹¹ +### 2. `ApplicationContext` 继承结构 -ÔÚ `ApplicationContext` ¼Ò×åÖУ¬`ApplicationContext` Ö÷Òª·ÖΪÁ½´óÅÉϵ£¬ËûÃǼ°Æä´ú±íÈçÏ£º +在 `ApplicationContext` å®¶æ—�中,`ApplicationContext` 主è¦�分为两大派系,他们å�Šå…¶ä»£è¡¨å¦‚下: -* ·Ç web ÀàÐ굀 `ApplicationContext`£º´¦ÀíÆÕͨ java Ó¦ÓÃµÄ `ApplicationContext`£¬´ú±íÀàΪ `AnnotationConfigApplicationContext` -* web ÀàÐ굀 `ApplicationContext`£º´¦Àí web Ó¦ÓÃµÄ `ApplicationContext`£¬´ú±íÀàΪ `AnnotationConfigWebApplicationContext`£¨ÕâÀïÖ»¿¼ÂÇ `servlet` ÀàÐ굀 web£¬²»¿¼ÂÇ `reactive` µÄ web£© +* é�ž web 类型的 `ApplicationContext`:处ç�†æ™®é€š java 应用的 `ApplicationContext`,代表类为 `AnnotationConfigApplicationContext` +* web 类型的 `ApplicationContext`:处ç�† web 应用的 `ApplicationContext`,代表类为 `AnnotationConfigWebApplicationContext`(这里å�ªè€ƒè™‘ `servlet` 类型的 web,ä¸�考虑 `reactive` çš„ web) -ÎÒÃÇÔÙÀ´¿´¿´ `AnnotationConfigApplicationContext` µÄ¼Ì³Ð½á¹¹£º +我们å†�æ�¥çœ‹çœ‹ `AnnotationConfigApplicationContext` 的继承结构: -![ͼƬÀ´×ÔÍøÂç](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6e20477e8f5948894a5f241cd41038cfa15.png) +![图片æ�¥è‡ªç½‘络](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-6e20477e8f5948894a5f241cd41038cfa15.png) -ÎÒÃÇÔÙÀ´¿´¿´ `AnnotationConfigWebApplicationContext` µÄ¼Ì³Ð½á¹¹£º +我们å†�æ�¥çœ‹çœ‹ `AnnotationConfigWebApplicationContext` 的继承结构: -![ͼƬÀ´×ÔÍøÂç](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-23a6c84d82370afe39245a568cbcf918209.png) +![图片æ�¥è‡ªç½‘络](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-23a6c84d82370afe39245a568cbcf918209.png) -### 3\. ÔÚ bean ÖлñÈ¡ `ApplicationContext` +### 3\. 在 bean 中获å�– `ApplicationContext` -ÔÚ spring bean ÖлñÈ¡ `ApplicationContext`£¬¿ÉÒÔͨ¹ý `ApplicationContextAware` ½Ó¿ÚÀ´´¦Àí£º +在 spring bean 中获å�– `ApplicationContext`,å�¯ä»¥é€šè¿‡ `ApplicationContextAware` 接å�£æ�¥å¤„ç�†ï¼š ``` @Component @@ -77,26 +77,26 @@ public class TestBean implements ApplicationContextAware { this.applicationContext = applicationContext; } - // ÆäËû²Ù×÷ + // å…¶ä»–æ“�作 } ``` -¼Ì³Ð `ApplicationContextAware` ºó£¬`ApplicationContextAwareProcessor` »áÔÚ³õʼ»¯Íê³Éºóµ÷Óà `setApplicationContext(xxx)` ·½·¨£¬ÕâÑùÎÒÃÇÖ»ÐèÒªÔÚ `TestBean` ÖÐά»¤Ò»¸ö³ÉÔ±±äÁ¿£¬¶Ô `applicationContext` ±£´æ¼´¿É¡£ +继承 `ApplicationContextAware` å�Žï¼Œ`ApplicationContextAwareProcessor` 会在åˆ�始化完æˆ�å�Žè°ƒç”¨ `setApplicationContext(xxx)` 方法,这样我们å�ªéœ€è¦�在 `TestBean` 中维护一个æˆ�员å�˜é‡�,对 `applicationContext` ä¿�å­˜å�³å�¯ã€‚ ### 4. `ApplicationContextAwareProcessor` -`ApplicationContextAwareProcessor` ÊÇÒ»¸ö `BeanPostProcessor`£¬ÎÒÃÇÖ÷Òª¹Ø×¢ `ApplicationContextAwareProcessor#postProcessBeforeInitialization` ·½·¨£¬´ú±íÈçÏ£º +`ApplicationContextAwareProcessor` 是一个 `BeanPostProcessor`,我们主è¦�关注 `ApplicationContextAwareProcessor#postProcessBeforeInitialization` 方法,代表如下: ``` @Override @Nullable public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { /** - * applicationContext ÊÇ Environment¡¢ResourceLoader¡¢ - * ApplicationEventPublisher¡¢MessageSource µÈµÄ×ÓÀ࣬ÕâЩÀàµÄaware½Ó¿ÚµÄµ÷Ó㬶¼¿ÉÒÔ - * ͨ¹ý applicationContext ²ÎÊý½øÐÐ + * applicationContext 是 Environmentã€�ResourceLoaderã€� + * ApplicationEventPublisherã€�MessageSource 等的å­�类,这些类的aware接å�£çš„调用,都å�¯ä»¥ + * 通过 applicationContext å�‚数进行 */ if (!(bean instanceof EnvironmentAware || bean instanceof EmbeddedValueResolverAware || bean instanceof ResourceLoaderAware || bean instanceof ApplicationEventPublisherAware || @@ -120,15 +120,15 @@ public Object postProcessBeforeInitialization(Object bean, String beanName) thro } /** - * µ÷Óà Aware ½Ó¿ÚµÄ·½·¨ - * ³ýÁËEmbeddedValueResolverAwareÍ⣬ÆäÓàµÄ´«Èë²ÎÊý¶¼ÊÇ this.applicationContext + * 调用 Aware 接å�£çš„æ–¹æ³• + * 除了EmbeddedValueResolverAware外,其余的传入å�‚数都是 this.applicationContext */ private void invokeAwareInterfaces(Object bean) { if (bean instanceof EnvironmentAware) { ((EnvironmentAware) bean).setEnvironment(this.applicationContext.getEnvironment()); } if (bean instanceof EmbeddedValueResolverAware) { - // ×¢ÒâembeddedValueResolverµÄ»ñÈ¡²Ù×÷ÈçÏ£º + // 注æ„�embeddedValueResolver的获å�–æ“�作如下: // new EmbeddedValueResolver(applicationContext.getBeanFactory()); ((EmbeddedValueResolverAware) bean).setEmbeddedValueResolver(this.embeddedValueResolver); } @@ -142,7 +142,7 @@ private void invokeAwareInterfaces(Object bean) { if (bean instanceof MessageSourceAware) { ((MessageSourceAware) bean).setMessageSource(this.applicationContext); } - // ×°Åä ʵÏÖÁËApplicationContextAwareµÄÀàµÄ applicationContext + // 装é…� 实现了ApplicationContextAware的类的 applicationContext if (bean instanceof ApplicationContextAware) { ((ApplicationContextAware) bean).setApplicationContext(this.applicationContext); } @@ -150,19 +150,19 @@ private void invokeAwareInterfaces(Object bean) { ``` -Õâ¸ö·½·¨»¹ÊDZȽϼòµ¥µÄ£¬¾ÍÊÇÅÐ¶Ï bean ÀàÐÍ£¬È»ºóת»»¡¢µ÷Ó÷½·¨¡£ +这个方法还是比较简å�•的,就是判断 bean 类型,然å�Žè½¬æ�¢ã€�调用方法。 -### 5. `ApplicationContext` Óë `BeanFactory` µÄ¹ØÏµ +### 5. `ApplicationContext` 与 `BeanFactory` 的关系 -×îºóÎÒÃÇÔÙÀ´ÌÖÂÛÏ `ApplicationContext` Óë `BeanFactory` Á½ÕߵĹØÏµ¡£±¾ÎÄÒ»¿ªÊ¼¾Í˵Ã÷ÁË `ApplicationContext` ¼Ì³ÐÁË `BeanFactory` µÄ½Ó¿Ú£¬ÒòΪÕâÁ½ÕßÊǼ̳йØÏµ¡£²»¹ý£¬³ýÁ˼̳йØÏµÍ⣬ËûÃÇ»¹ÊÇ×éºÏ¹ØÏµ£¬`ApplicationContext` ³ÖÓÐ `BeanFactory` µÄ¶ÔÏó£¬Ö±½Ó¿´´úÂ룺 +最å�Žæˆ‘们å†�æ�¥è®¨è®ºä¸‹ `ApplicationContext` 与 `BeanFactory` 两者的关系。本文一开始就说明了 `ApplicationContext` 继承了 `BeanFactory` 的接å�£ï¼Œå› ä¸ºè¿™ä¸¤è€…是继承关系。ä¸�过,除了继承关系外,他们还是组å�ˆå…³ç³»ï¼Œ`ApplicationContext` æŒ�有 `BeanFactory` 的对象,直接看代ç �: -¶ÔÓÚ `AnnotationConfigApplicationContext`£¬`beanFactory` ¸³Öµ´úÂëÈçÏ£º +对于 `AnnotationConfigApplicationContext`,`beanFactory` 赋值代ç �如下: ``` public class GenericApplicationContext extends AbstractApplicationContext implements BeanDefinitionRegistry { - // Õâ¾ÍÊdzÖÓÐµÄ beanFactory ¶ÔÏó + // 这就是æŒ�有的 beanFactory 对象 private final DefaultListableBeanFactory beanFactory; public GenericApplicationContext() { @@ -180,31 +180,31 @@ public class GenericApplicationContext extends AbstractApplicationContext ``` -¶ÔÓÚ `AnnotationConfigWebApplicationContext`£¬`beanFactory` ¸³Öµ´úÂëÈçÏ£º +对于 `AnnotationConfigWebApplicationContext`,`beanFactory` 赋值代ç �如下: ``` public abstract class AbstractRefreshableApplicationContext extends AbstractApplicationContext { - // Õâ¾ÍÊdzÖÓÐµÄ beanFactory ¶ÔÏó + // 这就是æŒ�有的 beanFactory 对象 @Nullable private DefaultListableBeanFactory beanFactory; @Override protected final void refreshBeanFactory() throws BeansException { - // Åжϵ±Ç°ApplicationContextÊÇ·ñ´æÔÚBeanFactory£¬Èç¹û´æÔڵϰ¾ÍÏú»ÙËùÓÐ Bean£¬¹Ø±Õ BeanFactory + // 判断当å‰�ApplicationContext是å�¦å­˜åœ¨BeanFactory,如果存在的è¯�就销æ¯�所有 Bean,关闭 BeanFactory if (hasBeanFactory()) { destroyBeans(); closeBeanFactory(); } try { - // ³õʼ»¯DefaultListableBeanFactory£¬¿´ÏÂÃæµÄ´´½¨·½·¨ + // åˆ�始化DefaultListableBeanFactory,看下é�¢çš„创建方法 DefaultListableBeanFactory beanFactory = createBeanFactory(); beanFactory.setSerializationId(getId()); - // ÉèÖà BeanFactory µÄÁ½¸öÅäÖÃÊôÐÔ£ºÊÇ·ñÔÊÐí Bean ¸²¸Ç¡¢ÊÇ·ñÔÊÐíÑ­»·ÒýÓà + // 设置 BeanFactory 的两个é…�置属性:是å�¦å…�许 Bean 覆盖ã€�是å�¦å…�许循环引用 customizeBeanFactory(beanFactory); - // ¼ÓÔØ Bean µ½ BeanFactory ÖÐ + // 加载 Bean 到 BeanFactory 中 loadBeanDefinitions(beanFactory); synchronized (this.beanFactoryMonitor) { this.beanFactory = beanFactory; @@ -215,13 +215,13 @@ public abstract class AbstractRefreshableApplicationContext extends AbstractAppl } } - // ´´½¨ beanFactory + // 创建 beanFactory protected DefaultListableBeanFactory createBeanFactory() { - // Ö¸¶¨¸¸beanFactory + // 指定父beanFactory return new DefaultListableBeanFactory(getInternalParentBeanFactory()); } - // »ñÈ¡ beanFactory + // 获å�– beanFactory @Override public final ConfigurableListableBeanFactory getBeanFactory() { synchronized (this.beanFactoryMonitor) { @@ -238,185 +238,185 @@ public abstract class AbstractRefreshableApplicationContext extends AbstractAppl ``` -`BeanFactory` µÄÏà¹Ø·½·¨ÊµÏÖÈçÏ£º +`BeanFactory` 的相关方法实现如下: ``` public abstract class AbstractApplicationContext extends DefaultResourceLoader - implements ConfigurableApplicationContext {### 1\. ʲôÊÇ `BeanDefinition` + implements ConfigurableApplicationContext {### 1\. 什么是 `BeanDefinition` -`BeanDefinition` ´ÓÃû³ÆÉÏÀ´¿´£¬¾ÍÊÇ `bean¶¨Òå`£¬ÓÃÀ´¶¨Òå spring bean µÄÐÅÏ¢¡£ +`BeanDefinition` 从å��称上æ�¥çœ‹ï¼Œå°±æ˜¯ `bean定义`,用æ�¥å®šä¹‰ spring bean 的信æ�¯ã€‚ -ÔÚ java ÖУ¬¶¨ÒåÒ»¸öÀàµÄÔªÐÅÏ¢£¨¹¹Ôì·½·¨£¬³ÉÔ±±äÁ¿£¬³ÉÔ±·½·¨µÈ£©£¬Ê¹ÓõÄÊÇ `Class` À࣬һ¸ö`.class` Îļþ¼ÓÔØµ½ jvm ºó£¬¶¼»áÉú³ÉÒ»¸ö `Class` ¶ÔÏó£¬ÔÚ¶ÔÏóʵÀý»¯Ê±£¬¾Í¸ù¾ÝÕâ¸ö `Class` ¶ÔÏóµÄÐÅÏ¢À´Éú³É¡£ +在 java 中,定义一个类的元信æ�¯ï¼ˆæž„造方法,æˆ�员å�˜é‡�,æˆ�员方法等),使用的是 `Class` 类,一个`.class` 文件加载到 jvm å�Žï¼Œéƒ½ä¼šç”Ÿæˆ�一个 `Class` 对象,在对象实例化时,就根æ�®è¿™ä¸ª `Class` 对象的信æ�¯æ�¥ç”Ÿæˆ�。 -ÔÚ spring ÖУ¬Ò²ÓÐÕâôһ¸öÀàÀ´¶¨Òå bean µÄÐÅÏ¢£¬Õâ¸öÀà¾ÍÊÇ `BeanDefinition`£¬Ëü¶¨ÒåÁË spring bean ÈçºÎÉú³É£¬ÈçºÎ³õʼ»¯£¬ÈçºÎÏú»ÙµÈ£¬ÎÒÃÇÀ´¿´¿´ËüÖ§³ÖµÄ²¿·Ö·½·¨£º +在 spring 中,也有这么一个类æ�¥å®šä¹‰ bean 的信æ�¯ï¼Œè¿™ä¸ªç±»å°±æ˜¯ `BeanDefinition`,它定义了 spring bean 如何生æˆ�,如何åˆ�始化,如何销æ¯�等,我们æ�¥çœ‹çœ‹å®ƒæ”¯æŒ�的部分方法: ``` public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { /** - * ÉèÖø¸ BeanDefinition - * BeanDefinition ÓиöÀàËÆ¼Ì³ÐµÄ¸ÅÄÕâÀïÖ¸¶¨Á˸¸BeanDefinition - * ʵÀý»¯beanʱ£¬»áºÏ²¢¸¸BeanDefinition + * 设置父 BeanDefinition + * BeanDefinition 有个类似继承的概念,这里指定了父BeanDefinition + * 实例化bean时,会å�ˆå¹¶çˆ¶BeanDefinition */ void setParentName(@Nullable String parentName); /** - * »ñÈ¡¸¸Bean + * 获å�–父Bean */ @Nullable String getParentName(); /** - * ÉèÖÃbeanClassÃû³Æ - * ʵÀý»¯Ê±£¬»áʵÀý»¯³ÉÕâ¸ö Class µÄ¶ÔÏó + * 设置beanClasså��ç§° + * 实例化时,会实例化æˆ�这个 Class 的对象 */ void setBeanClassName(@Nullable String beanClassName); /** - * »ñÈ¡beanClassÃû³Æ + * 获å�–beanClasså��ç§° */ @Nullable String getBeanClassName(); /** - * ÉèÖÃbeanµÄ×÷Ó÷¶Î§£¬µ¥Àý»òÔ­ÐÍ + * 设置bean的作用范围,å�•例或原型 */ void setScope(@Nullable String scope); /** - * »ñÈ¡beanµÄ×÷Ó÷¶Î§£¬µ¥Àý»òÔ­ÐÍ + * 获å�–bean的作用范围,å�•例或原型 */ @Nullable String getScope(); /** - * ÉèÖÃÀÁ¼ÓÔØ + * 设置懒加载 */ void setLazyInit(boolean lazyInit); /** - * ÊÇ·ñΪÀÁ¼ÓÔØ + * 是å�¦ä¸ºæ‡’加载 */ boolean isLazyInit(); /** - * ÉèÖøÃBeanÒÀÀµµÄËùÓÐBean - * ¼´ @DependsOn Ö¸¶¨µÄbean + * 设置该Beanä¾�赖的所有Bean + * å�³ @DependsOn 指定的bean */ void setDependsOn(@Nullable String... dependsOn); /** - * ·µ»Ø¸ÃBeanµÄËùÓÐÒÀÀµ¡£ + * 返回该Bean的所有ä¾�赖。 */ @Nullable String[] getDependsOn(); /** - * ÉèÖÃÊÇ·ñ×÷Ϊ×Ô¶¯×¢ÈëµÄºòÑ¡¶ÔÏó¡£ + * 设置是å�¦ä½œä¸ºè‡ªåŠ¨æ³¨å…¥çš„å€™é€‰å¯¹è±¡ã€‚ */ void setAutowireCandidate(boolean autowireCandidate); /** - * ÊÇ·ñ×÷Ϊ×Ô¶¯×¢ÈëµÄºòÑ¡¶ÔÏó + * 是å�¦ä½œä¸ºè‡ªåŠ¨æ³¨å…¥çš„å€™é€‰å¯¹è±¡ */ boolean isAutowireCandidate(); /** - * ÉèÖÃÊÇ·ñΪÖ÷ÒªµÄ£¬µ±ÈÝÆ÷ÖдæÔÚ¶à¸öͬÀàÐ͵Äbeanʱ£¬¿ÉÒÔÖ»·µ»ØÖ÷ÒªµÄ - * ¾ÍÊÇ @Primary µÄ×÷Óà + * 设置是å�¦ä¸ºä¸»è¦�的,当容器中存在多个å�Œç±»åž‹çš„bean时,å�¯ä»¥å�ªè¿”回主è¦�çš„ + * 就是 @Primary 的作用 */ void setPrimary(boolean primary); /** - * ÊÇ·ñΪÖ÷ÒªµÄbean + * 是å�¦ä¸ºä¸»è¦�çš„bean */ boolean isPrimary(); /** - * Õë¶ÔfactoryBean - * Ö¸¶¨factoryBeanµÄÃû³Æ + * 针对factoryBean + * 指定factoryBeançš„å��ç§° */ void setFactoryBeanName(@Nullable String factoryBeanName); /** - * Õë¶ÔfactoryBean - * »ñÈ¡factoryBeanµÄÃû³Æ + * 针对factoryBean + * 获å�–factoryBeançš„å��ç§° */ @Nullable String getFactoryBeanName(); /** - * ÉèÖù¤³§·½·¨µÄÃû³Æ - * ÀýÈç @Bean ±ê¼ÇµÄ·½·¨ + * 设置工厂方法的å��ç§° + * 例如 @Bean 标记的方法 */ void setFactoryMethodName(@Nullable String factoryMethodName); /** - * ·µ»Ø¹¤³§·½·¨µÄÃû³Æ - * ÀýÈç @Bean ±ê¼ÇµÄ·½·¨ + * 返回工厂方法的å��ç§° + * 例如 @Bean 标记的方法 */ @Nullable String getFactoryMethodName(); /** - * »ñÈ¡¹¹Ôì¾ÍÈ¥µÄ²ÎÊýÖµ + * 获å�–构造就去的å�‚数值 */ ConstructorArgumentValues getConstructorArgumentValues(); /** - * ¹¹Ôì·½·¨ÊÇ·ñÓвÎÊý + * 构造方法是å�¦æœ‰å�‚æ•° */ default boolean hasConstructorArgumentValues() { return !getConstructorArgumentValues().isEmpty(); } /** - * »ñÈ¡ÊôÐÔÖµ - * ÕâÀï¿ÉÒÔ×ÔÖ÷ÉèÖÃÖµ×÷Ϊ¹¹Ôì·½·¨¡¢¹¤³§·½·¨µÄ²ÎÊý + * 获å�–属性值 + * 这里å�¯ä»¥è‡ªä¸»è®¾ç½®å€¼ä½œä¸ºæž„造方法ã€�工厂方法的å�‚æ•° */ MutablePropertyValues getPropertyValues(); /** - * ÊÇ·ñÓÐÊôÐÔÖµ + * 是å�¦æœ‰å±žæ€§å€¼ */ default boolean hasPropertyValues() { return !getPropertyValues().isEmpty(); } /** - * ÉèÖóõʼ»¯·½·¨Ãû³Æ + * 设置åˆ�始化方法å��ç§° */ void setInitMethodName(@Nullable String initMethodName); /** - * »ñÈ¡³õʼ»¯·½·¨Ãû³Æ + * 获å�–åˆ�始化方法å��ç§° */ @Nullable String getInitMethodName(); /** - * ÉèÖÃÏú»Ù·½·¨Ãû³Æ + * 设置销æ¯�方法å��ç§° */ void setDestroyMethodName(@Nullable String destroyMethodName); /** - * »ñÈ¡Ïú»Ù·½·¨Ãû³Æ + * 获å�–销æ¯�方法å��ç§° */ @Nullable String getDestroyMethodName(); /** - * ÊÇ·ñΪµ¥Àýbean + * 是å�¦ä¸ºå�•例bean */ boolean isSingleton(); /** - * ÊÇ·ñΪԭÐÍbean + * 是å�¦ä¸ºåŽŸåž‹bean */ boolean isPrototype(); /** - * Èç¹ûÕâ¸ö Bean ÊDZ»ÉèÖÃΪ abstract£¬ÄÇô²»ÄÜʵÀý»¯£¬³£ÓÃÓÚ×÷Ϊ ¸¸bean ÓÃÓڼ̳Р+ * 如果这个 Bean 是被设置为 abstract,那么ä¸�能实例化,常用于作为 父bean 用于继承 */ boolean isAbstract(); @@ -426,26 +426,26 @@ public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement { ``` -¿ÉÒÔ¿´µ½£¬`BeanDefinition` Ö§³ÖµÄ·½·¨·Ç³£¶à£¬ÓкܶàÊÇÎÒÃÇÆ½Ê±Ê¹ÓÃʱָ¶¨µÄ£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`BeanDefinition` 支æŒ�的方法é�žå¸¸å¤šï¼Œæœ‰å¾ˆå¤šæ˜¯æˆ‘们平时使用时指定的: -* `setScope(...)`£ºÉèÖà bean µÄ×÷Ó÷¶Î§£¬ÓÉ `@Scope` Ö¸¶¨ -* `setLazyInit(...)`£ºÉèÖÃÀÁ¼ÓÔØ£¬ÓÉ `@Lazy` Ö¸¶¨ -* `setDependsOn(...)`£ºÉèÖà bean ÒÀÀµ£¬ÓÉ `@DependsOn` Ö¸¶¨ -* `setPrimary(...)`£ºÉèÖÃΪÖ÷Òª bean£¬ÓÉ `@Primary` Ö¸¶¨ -* `setFactoryMethodName(...)`£ºÉèÖù¤³§·½·¨Ãû³Æ£¬ÀýÈçÓÉ `@Bean` ±ê¼ÇµÄ·½·¨ +* `setScope(...)`:设置 bean 的作用范围,由 `@Scope` 指定 +* `setLazyInit(...)`:设置懒加载,由 `@Lazy` 指定 +* `setDependsOn(...)`:设置 bean ä¾�赖,由 `@DependsOn` 指定 +* `setPrimary(...)`:设置为主è¦� bean,由 `@Primary` 指定 +* `setFactoryMethodName(...)`:设置工厂方法å��称,例如由 `@Bean` 标记的方法 -ÒÔÉÏÊÇÔÚ×¢½âʱ´ú¿ÉÒÔÖ¸¶¨µÄ£¬»¹ÓÐЩÊÇÔÚ `xml` ʱ´úÖ¸¶¨µÄ£¬È磺 +以上是在注解时代å�¯ä»¥æŒ‡å®šçš„,还有些是在 `xml` 时代指定的,如: -* `setInitMethodName(...)`£ºÉèÖóõʼ»¯·½·¨ £¬ÓÉ `init-method` Ö¸¶¨ -* `setDestroyMethodName(...)`£ºÉèÖÃÏú»Ù·½·¨£¬ÓÉ `destroy-method` Ö¸¶¨ +* `setInitMethodName(...)`:设置åˆ�始化方法 ,由 `init-method` 指定 +* `setDestroyMethodName(...)`:设置销æ¯�方法,由 `destroy-method` 指定 -### 2\. spring ÌṩÁËÄÄЩ `BeanDefinition` +### 2\. spring æ��供了哪些 `BeanDefinition` -`BeanDefinition` ÊÇÒ»¸ö½Ó¿Ú£¬ÎÒÃǵ±È»²»ÄÜÖ±½ÓʹÓ㬽ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ Spring ÌṩÁËÄÄЩ `BeanDefinition`£º +`BeanDefinition` 是一个接å�£ï¼Œæˆ‘们当然ä¸�能直接使用,接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ Spring æ��供了哪些 `BeanDefinition`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-49cbc9cb32badc1db52717cd19a9447eca7.png) -spring ÌṩµÄ `BeanDefinition` »ù±¾¾ÍÊÇÉÏͼËùʾµÄ¼¸ÖÖÁË£¬ÕâÀïÎÒÃÇÖ÷Òª¿´ÕâÏòÖÖ£º +spring æ��供的 `BeanDefinition` 基本就是上图所示的几ç§�了,这里我们主è¦�看这å�‘ç§�: * `RootBeanDefinition` * `ChildBeanDefinition` @@ -453,9 +453,9 @@ spring * `ScannedGenericBeanDefinition` * `AnnotatedGenericBeanDefinition` -#### 2.1 `RootBeanDefinition` ºÍ `ChildBeanDefinition` +#### 2.1 `RootBeanDefinition` å’Œ `ChildBeanDefinition` -ÔÚÇ°ÃæÌáµ½ÁË `BeanDefinition` ¼Ì×ӵĸÅÄÕâÀï¾ÍÊÇÓÃÀ´´¦Àí¼Ì³ÐµÄ£¬Ò»°ãÀ´Ëµ£¬ÎÒÃÇ¿ÉÒÔÔÚ `RootBeanDefinition` ¶¨Ò幫¹²²ÎÊý£¬È»ºóÔÚ `ChildBeanDefinition` Öж¨Òå¸÷×ÔµÄÄÚÈÝ£¬Ê¾ÀýÈçÏ£º +在å‰�é�¢æ��到了 `BeanDefinition` ç»§å­�的概念,这里就是用æ�¥å¤„ç�†ç»§æ‰¿çš„,一般æ�¥è¯´ï¼Œæˆ‘们å�¯ä»¥åœ¨ `RootBeanDefinition` 定义公共å�‚数,然å�Žåœ¨ `ChildBeanDefinition` 中定义å�„自的内容,示例如下: ``` public static void main(String[] args) { @@ -464,24 +464,24 @@ AnnotationConfigApplicationContext context = new AnnotationConfigApplicationCont RootBeanDefinition root = new RootBeanDefinition(); root.setBeanClass(User.class); root.getPropertyValues().add("name", "123"); -// ÕâÖÖ×¢²á·½·¨½ö×öչʾ£¬Êµ¼ÊÏîÄ¿Öв»½¨ÒéʹÓà -// ʹÓÃÏîÄ¿½¨ÒéʹÓÃµÄ BeanDefinitionRegistryPostProcessor ÌṩµÄ·½·¨ +// è¿™ç§�注册方法仅å�šå±•示,实际项目中ä¸�建议使用 +// 使用项目建议使用的 BeanDefinitionRegistryPostProcessor æ��供的方法 context.registerBeanDefinition("root", root); // ChildBeanDefinition ChildBeanDefinition child1 = new ChildBeanDefinition("root"); child1.getPropertyValues().add("age", "11"); - // ÕâÖÖ×¢²á·½·¨½ö×öչʾ£¬Êµ¼ÊÏîÄ¿Öв»½¨ÒéʹÓà - // ʹÓÃÏîÄ¿½¨ÒéʹÓÃµÄ BeanDefinitionRegistryPostProcessor ÌṩµÄ·½·¨ + // è¿™ç§�注册方法仅å�šå±•示,实际项目中ä¸�建议使用 + // 使用项目建议使用的 BeanDefinitionRegistryPostProcessor æ��供的方法 context.registerBeanDefinition("child1", child1); // ChildBeanDefinition ChildBeanDefinition child2 = new ChildBeanDefinition("root"); child2.getPropertyValues().add("age", "12"); - // ÕâÖÖ×¢²á·½·¨½ö×öչʾ£¬Êµ¼ÊÏîÄ¿Öв»½¨ÒéʹÓà - // ʹÓÃÏîÄ¿½¨ÒéʹÓÃµÄ BeanDefinitionRegistryPostProcessor ÌṩµÄ·½·¨ + // è¿™ç§�注册方法仅å�šå±•示,实际项目中ä¸�建议使用 + // 使用项目建议使用的 BeanDefinitionRegistryPostProcessor æ��供的方法 context.registerBeanDefinition("child2", child2); - // Æô¶¯ÈÝÆ÷ + // å�¯åЍ容噍 context.refresh(); User rootUser = (User) context.getBean("root"); @@ -494,7 +494,7 @@ context.registerBeanDefinition("root", root); ``` -ÔËÐнá¹û£º +è¿�行结果: ``` User{name='123', age=null} @@ -503,15 +503,15 @@ User{name='123', age=12} ``` -¿ÉÒÔ¿´µ½£¬`child1` Óë `child1` ½øÐгɹ¦µØ´Ó `RootBeanDefinition` ¼Ì³Ðµ½ÁËÊôÐÔ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`child1` 与 `child1` 进行æˆ�功地从 `RootBeanDefinition` 继承到了属性。 #### 2.2 `GenericBeanDefinition` -ÕâÊǸöͨÓÃµÄ `BeanDefinition`£¬Ö±½Ó¼Ì³ÐÁË `AbstractBeanDefinition`£¬Ëü×ÔÉíÌṩµÄ·½·¨ÈçÏ£º +这是个通用的 `BeanDefinition`,直接继承了 `AbstractBeanDefinition`,它自身æ��供的方法如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-5ed980070b301dc84926fac2494093d4fc6.png) -¿ÉÒÔ¿´µ½£¬Ëü×ÔÉíÌṩµÄ·½·¨²¢²»¶à£¬Æä²Ù×÷»ù±¾¼Ì³Ð `AbstractBeanDefinition`£¬Ò»°ãÇé¿öÏ£¬ÎÒÃÇÒªÉú³É×Ô¼ºµÄ `BeanDefinition` ʱ£¬Ö»ÐèҪʹÓÃÕâ¸öÀà¾Í¿ÉÒÔÁË£¬ÕâÀïÒ²Ìṩһ¸öʾÀý£º +å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒè‡ªèº«æ��供的方法并ä¸�多,其æ“�作基本继承 `AbstractBeanDefinition`,一般情况下,我们è¦�生æˆ�自己的 `BeanDefinition` 时,å�ªéœ€è¦�使用这个类就å�¯ä»¥äº†ï¼Œè¿™é‡Œä¹Ÿæ��供一个示例: ``` public static void main(String[] args) { @@ -521,11 +521,11 @@ AnnotationConfigApplicationContext context = new AnnotationConfigApplicationCont userBeanDefinition.setBeanClass(User.class); userBeanDefinition.getPropertyValues().add("name", "123"); userBeanDefinition.getPropertyValues().add("age", "11"); - // ÕâÖÖ×¢²á·½·¨½ö×öչʾ£¬Êµ¼ÊÏîÄ¿Öв»½¨ÒéʹÓà - // ʹÓÃÏîÄ¿½¨ÒéʹÓÃµÄ BeanDefinitionRegistryPostProcessor ÌṩµÄ·½·¨ + // è¿™ç§�注册方法仅å�šå±•示,实际项目中ä¸�建议使用 + // 使用项目建议使用的 BeanDefinitionRegistryPostProcessor æ��供的方法 context.registerBeanDefinition("user", userBeanDefinition); - // Æô¶¯ÈÝÆ÷ + // å�¯åЍ容噍 context.refresh(); User user = (User) context.getBean("user"); @@ -536,29 +536,29 @@ AnnotationConfigApplicationContext context = new AnnotationConfigApplicationCont ### 2.3 `ScannedGenericBeanDefinition` -`ScannedGenericBeanDefinition` ¼Ì³ÐÁË `GenericBeanDefinition`£¬Í¬Ê±Ò²ÊµÏÖÁË `AnnotatedBeanDefinition` ½Ó¿Ú£¬±¾ÉíÌṩµÄ·½·¨²¢²»¶à£º +`ScannedGenericBeanDefinition` 继承了 `GenericBeanDefinition`,å�Œæ—¶ä¹Ÿå®žçŽ°äº† `AnnotatedBeanDefinition` 接å�£ï¼Œæœ¬èº«æ��供的方法并ä¸�多: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-9ed3925090a9ae5fc1d4218ed5a59c2ea19.png) -Æä²Ù×÷»ù±¾À´×Ô `GenericBeanDefinition`£¬ÕâÀï¾Í²»ÌṩʾÀýÁË¡£ +å…¶æ“�作基本æ�¥è‡ª `GenericBeanDefinition`,这里就ä¸�æ��供示例了。 ### 2.4 `AnnotatedGenericBeanDefinition` -`AnnotatedGenericBeanDefinition` ¼Ì³ÐÁË `GenericBeanDefinition`£¬Í¬Ê±Ò²ÊµÏÖÁË `AnnotatedBeanDefinition` ½Ó¿Ú£¬±¾ÉíÌṩµÄ·½·¨²¢²»¶à£º +`AnnotatedGenericBeanDefinition` 继承了 `GenericBeanDefinition`,å�Œæ—¶ä¹Ÿå®žçŽ°äº† `AnnotatedBeanDefinition` 接å�£ï¼Œæœ¬èº«æ��供的方法并ä¸�多: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b2e7f49fcdcae4f7272e2670b4fbb92766a.png) -Æä²Ù×÷»ù±¾À´×Ô `GenericBeanDefinition`£¬ÕâÀï¾Í²»ÌṩʾÀýÁË¡£ +å…¶æ“�作基本æ�¥è‡ª `GenericBeanDefinition`,这里就ä¸�æ��供示例了。 -### 3\. ²Ù×÷ spring ÈÝÆ÷ÖÐÒÑÓÐµÄ `BeanDefinition` +### 3\. æ“�作 spring 容器中已有的 `BeanDefinition` -ÉÏÃæµÄÀý×Ó¶¼ÊÇÍù spring ÈÝÆ÷ÖÐÌí¼Ó `BeanDefinition`£¬ÎÒÃÇÒªÈçºÎ²Ù×÷ spring ÈÝÆ÷ÖÐÒÑÓÐµÄ `BeanDefinition` ÄØ£¿ +上é�¢çš„例å­�都是往 spring 容器中添加 `BeanDefinition`,我们è¦�如何æ“�作 spring 容器中已有的 `BeanDefinition` 呢? -#### 3.1 demo ×¼±¸ +#### 3.1 demo 准备 -ÕâÀïÊ×ÏÈ×¼±¸Ò»¸ö demo£º +这里首先准备一个 demo: -Ê×ÏÈ×¼±¸Á½¸ö `service`£º +首先准备两个 `service`: ``` @Service @@ -599,7 +599,7 @@ public class Service02 { ``` -½Ó×ÅÊÇÖ÷ÒªÀࣺ +接ç�€æ˜¯ä¸»è¦�类: ``` @ComponentScan @@ -621,7 +621,7 @@ public class Demo02Main { ``` -ÔËÐÐ £¬½á¹ûÈçÏ£º +è¿�行 ,结果如下: ``` hello null, from service01 @@ -629,19 +629,19 @@ hello null, from service02 ``` -Õâ˵Ã÷ÎÒÃǵÄÈÝÆ÷ÒѾ­Æô¶¯³É¹¦ÁË£¬`service01` Óë `service02` Ò²³õʼ»¯³É¹¦ÁË¡£ +这说明我们的容器已ç»�å�¯åЍæˆ�功了,`service01` 与 `service02` 也åˆ�始化æˆ�功了。 -#### 3.2 ²»³É¹¦µÄ³¢ÊÔ +#### 3.2 ä¸�æˆ�功的å°�试 -ÕâÀïÎÒÃÇ·´ÍÆÏ£¬`service01` Óë `service02` ÒѾ­³õʼ»¯³É¹¦ÁË£¬¾Í˵Ã÷ÈÝÆ÷ÖбØÈ» `service01` Óë `service02` ¶ÔÓ¦µÄ `beanDefifnition`£¬ÎÒÃÇÏë²Ù×÷Õâ¸ö `beanDefifnition`£¬¾Í±ØÐëÒªÏÈ»ñÈ¡Õâ¸ö `beanDefifnition`¡£ +这里我们å��推下,`service01` 与 `service02` å·²ç»�åˆ�始化æˆ�功了,就说明容器中必然 `service01` 与 `service02` 对应的 `beanDefifnition`,我们想æ“�作这个 `beanDefifnition`,就必须è¦�先获å�–这个 `beanDefifnition`。 -ÈçºÎ»ñÈ¡ spring ÖÐÒѾ­´æÔÚµÄ `beanDefifnition` ÄØ£¿²Î¿¼µÚ 2 ½ÚµÄʾÀý£¬Èç¹ûÄãÈÏΪÔÚ `context.refresh()` ǰ»ñÈ¡£¬ÏñÕâÑù£º +如何获å�– spring 中已ç»�存在的 `beanDefifnition` 呢?å�‚考第 2 节的示例,如果你认为在 `context.refresh()` å‰�获å�–,åƒ�这样: ``` public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); context.register(Demo02Main.class); -// ÔÚÕâÀï»ñÈ¡ beanDefinition£¬»á±¨´í +// 在这里获å�– beanDefinition,会报错 BeanDefinition service01Bd = context.getBeanDefinition("service01"); service01Bd.getPropertyValues().addPropertyValue("name", "123"); @@ -655,7 +655,7 @@ service01Bd.getPropertyValues().addPropertyValue("name", "123"); ``` -ÔËÐУ¬·¢Ïֻᱨ´í£º +è¿�行,å�‘现会报错: ``` Exception in thread "main" org.springframework.beans.factory @@ -663,7 +663,7 @@ Exception in thread "main" org.springframework.beans.factory ``` -´ÏÃ÷ÈçÄ㣬һ¶¨»áÏëµ½£¬ÔÚ `context.refresh()` ǰ»ñÈ¡»á±¨´í£¬ÄÇÔÚÖ®ºóÄØ£¿´úÂëÏñÕâÑù£º +è�ªæ˜Žå¦‚你,一定会想到,在 `context.refresh()` å‰�获å�–会报错,那在之å�Žå‘¢ï¼Ÿä»£ç �åƒ�这样: ``` public static void main(String[] args) { @@ -671,7 +671,7 @@ AnnotationConfigApplicationContext context = new AnnotationConfigApplicationCont context.register(Demo02Main.class); context.refresh(); - // »ñÈ¡ beanDefinition£¬Ð޸IJ»Æð×÷Óà + // 获å�– beanDefinition,修改ä¸�起作用 BeanDefinition service01Bd = context.getBeanDefinition("service01"); service01Bd.getPropertyValues().addPropertyValue("name", "123"); @@ -684,24 +684,24 @@ context.refresh(); ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-268bb546197c4eb9d1686118a12fabb0009.png) -ȷʵûÓб¨´í£¬µ«ÊÇÎÒÃǵÄÐÞ¸ÄҲûÆð×÷Óá£ÔÚ´úÂëÀÎÒÃǸø `service01` µÄ `name` ÊôÐÔÖ¸¶¨ÖµÎª `123`£¬ÔËÐнá¹û»¹ÊÇ `null`£¬Ã»Æð×÷ÓõÄÔ­ÒòÊÇ `service01` ÊÇÔÚ `context.refresh()` ½øÐгõʼ»¯ µÄ£¬ºóÃæÔÙÔõô¶ÔËüµÄ `BeanDefinition` Ð޸ģ¬Ò²ÌåÏÖ²»µ½ËüÉíÉÏ¡£ +确实没有报错,但是我们的修改也没起作用。在代ç �里,我们给 `service01` çš„ `name` 属性指定值为 `123`,è¿�行结果还是 `null`,没起作用的原因是 `service01` 是在 `context.refresh()` 进行åˆ�始化 的,å�Žé�¢å†�怎么对它的 `BeanDefinition` 修改,也体现ä¸�到它身上。 -ÄÇô¾¿¾¹ÒªÔõô×öÄØ£¿ +那么究竟è¦�怎么å�šå‘¢ï¼Ÿ -#### 3.2 `BeanDefinitionRegistryPostProcessor`£º¶¨ÖÆ»¯ `beanDefinition` +#### 3.2 `BeanDefinitionRegistryPostProcessor`:定制化 `beanDefinition` -½ÓÏÂÀ´ÎÒÃÇÒª·Å³ö´óÕÐÁË£¬Õâ¸ö´óÕоÍÊÇ£º`BeanFactoryPostProcessor`£¬¹ØÓÚÕâ¸öµÄ½éÉÜ£¬¿ÉÒÔËüµÄ½éÉÜ£¬¿ÉÒԲο¼ [spring ×é¼þÖ® BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4597545)£¬ÕâÀïÖ±½Ó¸øÏ½áÂÛ£º +接下æ�¥æˆ‘们è¦�放出大招了,这个大招就是:`BeanFactoryPostProcessor`,关于这个的介ç»�,å�¯ä»¥å®ƒçš„介ç»�,å�¯ä»¥å�‚考 [spring 组件之 BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4597545),这里直接给下结论: -> `BeanFactoryPostProcessor` ÖÐÎÄÃû½Ð `spring beanFactory µÄºóÖô¦ÀíÆ÷`£¬¿ÉÒÔÓÃÀ´¶¨ÖÆ»¯ `beanFactory` µÄһЩÐÐΪ¡£spring ΪÎÒÃÇÌṩÁËÁ½ÖÖ `BeanFactoryPostProcessor`£º +> `BeanFactoryPostProcessor` 中文å��å�« `spring beanFactory çš„å�Žç½®å¤„ç�†å™¨`,å�¯ä»¥ç”¨æ�¥å®šåˆ¶åŒ– `beanFactory` 的一些行为。spring 为我们æ��供了两ç§� `BeanFactoryPostProcessor`: > -> * `BeanFactoryPostProcessor`£º¶¨ÖÆ»¯ `beanFactory` µÄÐÐΪ -> * `BeanDefinitionRegistryPostProcessor`£º¶¨ÖÆ»¯ `beanDefinition` µÄÐÐΪ +> * `BeanFactoryPostProcessor`:定制化 `beanFactory` 的行为 +> * `BeanDefinitionRegistryPostProcessor`:定制化 `beanDefinition` 的行为 -ºÜÃ÷ÏÔ£¬ÎÒÃÇÓ¦¸ÃʹÓà `BeanDefinitionRegistryPostProcessor`£¬Ö±½ÓʵÏÖÕâ¸ö½Ó¿Ú£º +很明显,我们应该使用 `BeanDefinitionRegistryPostProcessor`,直接实现这个接å�£ï¼š ``` @Component @@ -718,14 +718,14 @@ implements BeanDefinitionRegistryPostProcessor { @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException { - // BeanDefinitionRegistryPostProcessor ÊÇ BeanFactoryPostProcessor µÄ×Ó½Ó¿Ú - // postProcessBeanFactory(...) À´×Ô BeanFactoryPostProcessor£¬ÎÒÃÇÕâÀï²»´¦Àí + // BeanDefinitionRegistryPostProcessor 是 BeanFactoryPostProcessor çš„å­�接å�£ + // postProcessBeanFactory(...) æ�¥è‡ª BeanFactoryPostProcessor,我们这里ä¸�处ç�† } } ``` -`main` ·½·¨¸ú×î³õ±£³ÖÒ»Ö£º +`main` 方法跟最åˆ�ä¿�æŒ�一致: ``` public static void main(String[] args) { @@ -742,7 +742,7 @@ context.refresh(); ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` hello 123, from service01 @@ -750,30 +750,30 @@ hello null, from service02 ``` -¿ÉÒÔ¿´µ½ `service01` µÄ `name` ȷʵ±ä³É `123` ÁË¡£ +å�¯ä»¥çœ‹åˆ° `service01` çš„ `name` 确实å�˜æˆ� `123` 了。 -ʵ¼ÊÉÏ£¬`BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` Ö÷Òª¾ÍÊÇʹÓà `BeanDefinitionRegistry` À´Íê³É `BeanDefinition` µÄ²Ù×÷£¬ËüÖ§³ÖµÄ·½·¨ÈçÏ£º +实际上,`BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` 主è¦�就是使用 `BeanDefinitionRegistry` æ�¥å®Œæˆ� `BeanDefinition` çš„æ“�作,它支æŒ�的方法如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-5812a2cac994c5940d57c7e6ab55c23a63e.png) -ÖØÒª²Ù×÷ÈçÏ£º +é‡�è¦�æ“�作如下: -* `getBeanDefinition(...)`£º»ñÈ¡ `BeanDefinition`£¬´æÔÚÔò·µ»Ø£¬²»´æÔÚÔò±¨´í£¬µÃµ½ `BeanDefinition` ºó£¬¾Í¿ÉÒÔ¶ÔÆä½øÐи÷ÖÖ²Ù×÷ÁË -* `registerBeanDefinition(...)`£º×¢²á `BeanDefinition`£¬¿ÉÒÔ×Ô¶¨Òå `BeanDefinition` ¶ÔÏó£¬È»ºóµ÷Óø÷½·¨×¢²áµ½ÈÝÆ÷ÖУ¬Ç°ÃæµÄÀý×ÓÖУ¬ÎÒÃÇÊÇÔÚ `context.refresh()` ǰµ÷Óà `context.registerBeanDefinition`£¬ÕâÀïÐèҪ˵µÄÊÇÍüÁËÇ°ÃæµÄ·½·¨°É£¬²¢²»ÊÇËùÓеÄÇé¿öÏ£¬¶¼ÄÜÄõ½ `context.refresh()` µÄ `context`£¨ÀýÈç `springboot` ÖУ©£¬Òò´ËÍÆ¼öʹÓà `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` ·½·¨×¢²á `BeanDefinition` -* `removeBeanDefinition(...)`£ºÒƳý `BeanDefinition`£¬Ò»°ãÇé¿öÏÂÓ¦¸Ã²»»áÓõ½ -* `containsBeanDefinition(...)`£ºÅжÏÊÇ·ñ°üº¬Ä³¸ö `BeanDefinition` +* `getBeanDefinition(...)`:获å�– `BeanDefinition`,存在则返回,ä¸�存在则报错,得到 `BeanDefinition` å�Žï¼Œå°±å�¯ä»¥å¯¹å…¶è¿›è¡Œå�„ç§�æ“�作了 +* `registerBeanDefinition(...)`:注册 `BeanDefinition`,å�¯ä»¥è‡ªå®šä¹‰ `BeanDefinition` 对象,然å�Žè°ƒç”¨è¯¥æ–¹æ³•注册到容器中,å‰�é�¢çš„例å­�中,我们是在 `context.refresh()` å‰�调用 `context.registerBeanDefinition`,这里需è¦�说的是忘了å‰�é�¢çš„æ–¹æ³•å�§ï¼Œå¹¶ä¸�是所有的情况下,都能拿到 `context.refresh()` çš„ `context`(例如 `springboot` 中),因此推è��使用 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` 方法注册 `BeanDefinition` +* `removeBeanDefinition(...)`:移除 `BeanDefinition`,一般情况下应该ä¸�会用到 +* `containsBeanDefinition(...)`:判断是å�¦åŒ…å�«æŸ�个 `BeanDefinition` -### 4\. ×ܽá +### 4\. 总结 -±¾ÎÄÖ÷Òª½éÉÜÁË `BeanDefinition` µÄ×÷Ó㺠+本文主è¦�介ç»�了 `BeanDefinition` 的作用: -1. `BeanDefinition` µÄ·½·¨ -2. ¼¸¸öÀàÐ굀 `BeanDefinition` µÄʹÓà -3. ʹÓà `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` ²Ù×÷ `BeanDefinition`£¬Ö÷ÒªÊÇ×¢²á¡¢ÐÞ¸Ä `BeanDefinition` +1. `BeanDefinition` 的方法 +2. 几个类型的 `BeanDefinition` 的使用 +3. 使用 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` æ“�作 `BeanDefinition`,主è¦�是注册ã€�修改 `BeanDefinition` * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4597536](https://my.oschina.net/funcy/blog/4597536) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ +_本文原文链接:[https://my.oschina.net/funcy/blog/4597536](https://my.oschina.net/funcy/blog/4597536) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ ... @Override @@ -793,10 +793,10 @@ _ ``` -ÕâЩ·½·¨ÔÚʵÏÖʱ£¬¶¼Êǵ÷Óà `getBeanFactory()` »ñÈ¡µ½ `BeanFactory` ¶ÔÏó£¬È»ºóÖ±½Óµ÷Óà `BeanFactory` µÄ·½·¨£¬`getBeanFactory()` µ÷ÓõľÍÊÇ `GenericApplicationContext` »ò `AnnotationConfigWebApplicationContext` µÄ `getBeanFactory()` ·½·¨¡£ +这些方法在实现时,都是调用 `getBeanFactory()` 获å�–到 `BeanFactory` 对象,然å�Žç›´æŽ¥è°ƒç”¨ `BeanFactory` 的方法,`getBeanFactory()` 调用的就是 `GenericApplicationContext` 或 `AnnotationConfigWebApplicationContext` çš„ `getBeanFactory()` 方法。 -¹ØÓÚ `ApplicationContext` µÄÄÚÈݾͽéÉܵ½ÕâÀïÁË¡£ +关于 `ApplicationContext` 的内容就介ç»�到这里了。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4597456](https://my.oschina.net/funcy/blog/4597456) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4597456](https://my.oschina.net/funcy/blog/4597456) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactory.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactory.md" index 7700641..213b585 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactory.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactory.md" @@ -1,87 +1,87 @@ public interface BeanFactory { /** - * factoryBeanʹÓà + * factoryBean使用 */ String FACTORY_BEAN_PREFIX = "&"; /** - * ¸ù¾ÝÃû³Æ»ñÈ¡bean + * æ ¹æ�®å��称获å�–bean */ Object getBean(String name) throws BeansException; /** - * ¸ù¾ÝÃû³Æ»ñÈ¡bean + * æ ¹æ�®å��称获å�–bean */ T getBean(String name, Class requiredType) throws BeansException; /** - * ¸ù¾ÝÃû³Æ»ñÈ¡bean + * æ ¹æ�®å��称获å�–bean */ Object getBean(String name, Object... args) throws BeansException; /** - * ¸ù¾ÝÀàÐÍ»ñÈ¡bean + * æ ¹æ�®ç±»åž‹èŽ·å�–bean */ T getBean(Class requiredType) throws BeansException; /** - * ¸ù¾ÝÀàÐÍ»ñÈ¡bean + * æ ¹æ�®ç±»åž‹èŽ·å�–bean */ T getBean(Class requiredType, Object... args) throws BeansException; /** - * »ñÈ¡BeanProvider + * 获å�–BeanProvider */ ObjectProvider getBeanProvider(Class requiredType); /** - * »ñÈ¡BeanProvider + * 获å�–BeanProvider */ ObjectProvider getBeanProvider(ResolvableType requiredType); /** - * ÊÇ·ñ°üº¬bean + * 是å�¦åŒ…å�«bean */ boolean containsBean(String name); /** - * ÊÇ·ñΪµ¥Àýbean + * 是å�¦ä¸ºå�•例bean */ boolean isSingleton(String name) throws NoSuchBeanDefinitionException; /** - * ÊÇ·ñΪԭÐÍbean + * 是å�¦ä¸ºåŽŸåž‹bean */ boolean isPrototype(String name) throws NoSuchBeanDefinitionException; /** - * ÅжÏÀàÐÍÊÇ·ñÆ¥Åä + * 判断类型是å�¦åŒ¹é…� */ boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException; /** - * ÅжÏÀàÐÍÊÇ·ñÆ¥Åä + * 判断类型是å�¦åŒ¹é…� */ boolean isTypeMatch(String name, Class typeToMatch) throws NoSuchBeanDefinitionException; /** - * ¸ù¾ÝÃû³Æ»ñÈ¡beanµÄÀàÐÍ + * æ ¹æ�®å��称获å�–bean的类型 */ @Nullable Class getType(String name) throws NoSuchBeanDefinitionException; /** - * ¸ù¾ÝÃû³Æ»ñÈ¡beanµÄÀàÐÍ + * æ ¹æ�®å��称获å�–bean的类型 */ @Nullable Class getType(String name, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException; /** - * ¸ù¾ÝbeanÃû³Æ»ñÈ¡beanµÄ±ðÃû + * æ ¹æ�®beanå��称获å�–bean的别å�� */ String[] getAliases(String name); diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactoryPostProcessor.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactoryPostProcessor.md" index 121dfeb..02261b1 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactoryPostProcessor.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanFactoryPostProcessor.md" @@ -1,19 +1,19 @@ -### 1\. ʲôÊÇ `BeanFactoryPostProcessor` +### 1\. 什么是 `BeanFactoryPostProcessor` -`BeanFactoryPostProcessor` ÖÐÎÄÃû½Ð spring beanFactory µÄºóÖô¦ÀíÆ÷£¬¿ÉÒÔÓÃÀ´¶¨ÖÆ»¯ beanFactory µÄһЩÐÐΪ¡£ +`BeanFactoryPostProcessor` 中文å��å�« spring beanFactory çš„å�Žç½®å¤„ç�†å™¨ï¼Œå�¯ä»¥ç”¨æ�¥å®šåˆ¶åŒ– beanFactory 的一些行为。 -spring ΪÎÒÃÇÌṩÁËÁ½ÖÖ `BeanFactoryPostProcessor`£º +spring 为我们æ��供了两ç§� `BeanFactoryPostProcessor`: * `org.springframework.beans.factory.config.BeanFactoryPostProcessor` ``` /** - * beanFactory µÄºóÖô¦ÀíÆ÷£¬¿ÉÒԸıä beanFactory µÄһЩÐÐΪ + * beanFactory çš„å�Žç½®å¤„ç�†å™¨ï¼Œå�¯ä»¥æ”¹å�˜ beanFactory 的一些行为 */ public interface BeanFactoryPostProcessor { /** - * ´¦Àí beanFactory µÄ·½·¨£¬²ÎÊýΪ beanFactory£¬Êµ¼ÊÀàÐÍÊÇ DefaultListableBeanFactory + * 处ç�† beanFactory 的方法,å�‚数为 beanFactory,实际类型是 DefaultListableBeanFactory */ void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException; @@ -26,16 +26,16 @@ spring Ϊ ``` /** - * BeanDefinition ×¢²áÆ÷£¬´ÓÃû³ÆÀ´¿´£¬¾ÍÊÇÓÃÀ´×¢²á beanDefinition µÄ - * ¼Ì³ÐÁË BeanFactoryPostProcessor ½Ó¿Ú£¬ - * Ò²¿ÉÒÔÖØÐ´ BeanFactoryPostProcessor#postProcessBeanFactory ·½·¨ + * BeanDefinition 注册器,从å��ç§°æ�¥çœ‹ï¼Œå°±æ˜¯ç”¨æ�¥æ³¨å†Œ beanDefinition çš„ + * 继承了 BeanFactoryPostProcessor 接å�£ï¼Œ + * 也å�¯ä»¥é‡�写 BeanFactoryPostProcessor#postProcessBeanFactory 方法 * */ public interface BeanDefinitionRegistryPostProcessor extends BeanFactoryPostProcessor { /** - * 1\. ¸Ã·½·¨ÏÈÓÚ BeanDefinitionRegistryPostProcessor#postProcessBeanFactory Ö´ÐÐ - * 2\. ´«Èë²ÎÊýΪ registry£¬Êµ¼ÊÀàÊÇ DefaultListableBeanFactory£¬Ò²¿ÉÒÔʹÓà beanFactory µÄ²Ù×÷ + * 1\. 该方法先于 BeanDefinitionRegistryPostProcessor#postProcessBeanFactory 执行 + * 2\. ä¼ å…¥å�‚数为 registry,实际类是 DefaultListableBeanFactory,也å�¯ä»¥ä½¿ç”¨ beanFactory çš„æ“�作 */ void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException; @@ -44,15 +44,15 @@ spring Ϊ ``` -`BeanFactoryPostProcessor` ÔÚ `AbstractApplicationContext#invokeBeanFactoryPostProcessors` ·½·¨Öб»Ö´ÐУ¬Ö´ÐÐʱÏÈÖ´ÐÐ `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry`£¬ÔÙÖ´ÐÐ `BeanFactoryPostProcessor#postProcessBeanFactory`£¬¹ØÓÚÕâ¿éµÄ·ÖÎö£¬¿ÉÒԲο¼ [spring Æô¶¯Á÷³ÌÖ®Ö´ÐÐ BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4641114) Ò»ÎÄ¡£ +`BeanFactoryPostProcessor` 在 `AbstractApplicationContext#invokeBeanFactoryPostProcessors` 方法中被执行,执行时先执行 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry`,å†�执行 `BeanFactoryPostProcessor#postProcessBeanFactory`,关于这å�—的分æž�,å�¯ä»¥å�‚考 [spring å�¯åЍæµ�程之执行 BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4641114) 一文。 -### 2. `BeanFactoryPostProcessor` ÌṩµÄ¹¦ÄÜ +### 2. `BeanFactoryPostProcessor` æ��供的功能 -±¾½ÚÎÒÃÇÀ´½éÉÜ `BeanFactoryPostProcessor` ÌṩµÄ¹¦ÄÜ¡£ +本节我们æ�¥ä»‹ç»� `BeanFactoryPostProcessor` æ��供的功能。 -#### 2.1 `BeanFactoryPostProcessor` µÄ×÷Óà +#### 2.1 `BeanFactoryPostProcessor` 的作用 -̽ÌÖǰ£¬ÎÒÃÇÏÈÀ´Á˽âÏ `BeanFactoryPostProcessor` Ìṩ·½·¨£º +探讨å‰�,我们先æ�¥äº†è§£ä¸‹ `BeanFactoryPostProcessor` æ��供方法: ``` void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) @@ -60,17 +60,17 @@ void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) ``` -¸Ã·½·¨ÖÐÖ»ÓÐÒ»¸ö²ÎÊý£º`ConfigurableListableBeanFactory`£¬ÎÒÃÇÏëÁ˽â `BeanFactoryPostProcessor` ÄÜΪÎÒÃÇ×öʲô£¬ÐèÒªÖªµÀÕâ¸ö²ÎÊýÌṩÁËÄÄЩ¹¦ÄÜ£º +该方法中å�ªæœ‰ä¸€ä¸ªå�‚数:`ConfigurableListableBeanFactory`,我们想了解 `BeanFactoryPostProcessor` 能为我们å�šä»€ä¹ˆï¼Œéœ€è¦�知é�“这个å�‚æ•°æ��供了哪些功能: -ÎÒÃÇÏÈÀ´¿´¿´ËüµÄ `set` ·½·¨£º ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-63b39c81bcae0b10c60a2f847c6b47af932.png) +我们先æ�¥çœ‹çœ‹å®ƒçš„ `set` 方法: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-63b39c81bcae0b10c60a2f847c6b47af932.png) -³ý´ËÖ®Í⣬»¹ÓÐ `register` ·½·¨£º ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-50c48da9b50dcf18abcd99db09142644c6c.png) +除此之外,还有 `register` 方法: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-50c48da9b50dcf18abcd99db09142644c6c.png) -ÓÐÁËÕâЩ·½·¨£¬ÎÒÃǾͿÉÒÔ¶¨ÖÆ»¯ `beanFactory` µÄһЩÐÐΪÁË¡£ +有了这些方法,我们就å�¯ä»¥å®šåˆ¶åŒ– `beanFactory` 的一些行为了。 -#### 2.2 `BeanDefinitionRegistryPostProcessor` µÄ×÷Óà +#### 2.2 `BeanDefinitionRegistryPostProcessor` 的作用 -ÎÒÃÇÒ²À´Á˽âÏ `BeanDefinitionRegistryPostProcessor` ÌṩµÄ·½·¨£º +我们也æ�¥äº†è§£ä¸‹ `BeanDefinitionRegistryPostProcessor` æ��供的方法: ``` void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) @@ -78,52 +78,52 @@ void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) ``` -Õâ¸ö·½·¨µÄ²ÎÊýÊÇ `BeanDefinitionRegistry`£¬´Ó×ÖÃæÒâÒåÀ´¿´£¬ÕâÊǸö `BeanDefinition ×¢²áÆ÷`£¬ËüÌṩÁËÈçÏ·½·¨£º +这个方法的å�‚数是 `BeanDefinitionRegistry`,从字é�¢æ„�义æ�¥çœ‹ï¼Œè¿™æ˜¯ä¸ª `BeanDefinition 注册器`,它æ��供了如下方法: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-5812a2cac994c5940d57c7e6ab55c23a63e.png) -¿ÉÒÔ¿´µ½£¬Õâ¸ö²ÎÊýÖ÷Òª¾ÍÊÇÎ§ÈÆ `BeanDefinition` À´²Ù×÷£¬±È½ÏÖØÒªµÄ·½·¨ÁоÙÈçÏ£º +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªå�‚数主è¦�就是围绕 `BeanDefinition` æ�¥æ“�作,比较é‡�è¦�的方法列举如下: -* `BeanDefinitionRegistry#containsBeanDefinition`£ºÊÇ·ñ°üº¬Ö¸¶¨Ãû³ÆµÄ `BeanDefinition` -* `BeanDefinitionRegistry#getBeanDefinition`£º»ñȡָ¶¨Ãû³ÆµÄ `BeanDefinition` -* `BeanDefinitionRegistry#registerBeanDefinition`£º×¢²áÒ»¸ö `BeanDefinition` -* `BeanDefinitionRegistry#removeBeanDefinition`£ºÒƳý `BeanDefinition` +* `BeanDefinitionRegistry#containsBeanDefinition`:是å�¦åŒ…å�«æŒ‡å®šå��ç§°çš„ `BeanDefinition` +* `BeanDefinitionRegistry#getBeanDefinition`:获å�–指定å��ç§°çš„ `BeanDefinition` +* `BeanDefinitionRegistry#registerBeanDefinition`:注册一个 `BeanDefinition` +* `BeanDefinitionRegistry#removeBeanDefinition`:移除 `BeanDefinition` -### 3\. spring ÌṩµÄ `BeanFactoryPostProcessor` +### 3\. spring æ��供的 `BeanFactoryPostProcessor` -spring ÖÐÒ»¹²ÓÐÁ½¸ö `BeanFactoryPostProcessor` µÄʵÏÖÀ࣬Ïà¹ØÐÅÏ¢¼°×÷ÓÃÈçÏ£º +spring 中一共有两个 `BeanFactoryPostProcessor` 的实现类,相关信æ�¯å�Šä½œç”¨å¦‚下: -* `EventListenerMethodProcessor`£º +* `EventListenerMethodProcessor`: - * ʵÏÖÁË `BeanFactoryPostProcessor`£¬`SmartInitializingSingleton` ½Ó¿Ú - * ÔÚ `BeanDefinitionRegistryPostProcessor#postProcessBeanFactory` ·½·¨ÖлñÈ¡ÁË `EventListenerFactory` - * ÔÚ `SmartInitializingSingleton#afterSingletonsInstantiated` ·½·¨Öд¦Àí `@EventListener` ×¢½â -* `ConfigurationClassPostProcessor`£º + * 实现了 `BeanFactoryPostProcessor`,`SmartInitializingSingleton` 接å�£ + * 在 `BeanDefinitionRegistryPostProcessor#postProcessBeanFactory` 方法中获å�–了 `EventListenerFactory` + * 在 `SmartInitializingSingleton#afterSingletonsInstantiated` 方法中处ç�† `@EventListener` 注解 +* `ConfigurationClassPostProcessor`: - * ÔÚ `AnnotationConfigUtils#registerAnnotationConfigProcessors(BeanDefinitionRegistry, Object)` ·½·¨ÖÐ×¢²á - * ʵÏÖÁË `BeanDefinitionRegistryPostProcessor` ½Ó¿Ú - * ´¦Àí `@Conditional` ×¢½â - * ´¦Àí `@Component` ×¢½â - * ´¦Àí `@PropertySource/@PropertySources` ×¢½â - * ´¦Àí `@ComponentScan/@ComponentScans` ×¢½â - * ´¦Àí `@Import` ×¢½â - * ´¦Àí `@ImportResource` ×¢½â - * ´¦Àí `@Bean` ×¢½â - * ´¦Àí `@Configuration` ×¢½â + * 在 `AnnotationConfigUtils#registerAnnotationConfigProcessors(BeanDefinitionRegistry, Object)` 方法中注册 + * 实现了 `BeanDefinitionRegistryPostProcessor` 接å�£ + * 处ç�† `@Conditional` 注解 + * 处ç�† `@Component` 注解 + * 处ç�† `@PropertySource/@PropertySources` 注解 + * 处ç�† `@ComponentScan/@ComponentScans` 注解 + * 处ç�† `@Import` 注解 + * 处ç�† `@ImportResource` 注解 + * 处ç�† `@Bean` 注解 + * 处ç�† `@Configuration` 注解 -¹ØÓÚ `EventListenerMethodProcessor` ´¦Àí `@EventListener` µÄ·ÖÎö£¬¿ÉÒԲο¼[¡¾spring Ô´Âë·ÖÎö¡¿spring Ì½ÃØÖ®¼àÌýÆ÷×¢½â @EventListener](https://my.oschina.net/funcy/blog/4926344). +关于 `EventListenerMethodProcessor` 处ç�† `@EventListener` 的分æž�,å�¯ä»¥å�‚考[ã€�spring æº�ç �分æž�】spring 探秘之监å�¬å™¨æ³¨è§£ @EventListener](https://my.oschina.net/funcy/blog/4926344). -¹ØÓÚ `ConfigurationClassPostProcessor` ´¦Àí¸÷×¢½âµÄÁ÷³Ì£¬¿ÉÒԲο¼£º +关于 `ConfigurationClassPostProcessor` 处ç�†å�„注解的æµ�程,å�¯ä»¥å�‚考: -* [ConfigurationClassPostProcessor£¨Ò»£©£º´¦Àí @ComponentScan ×¢½â](https://my.oschina.net/funcy/blog/4836178) -* [ConfigurationClassPostProcessor£¨¶þ£©£º´¦Àí @Bean ×¢½â](https://my.oschina.net/funcy/blog/4492878) -* [ConfigurationClassPostProcessor£¨Èý£©£º´¦Àí @Import ×¢½â](https://my.oschina.net/funcy/blog/4678152) -* [ConfigurationClassPostProcessor£¨ËÄ£©£º´¦Àí @Conditional ×¢½â](https://my.oschina.net/funcy/blog/4873444) +* [ConfigurationClassPostProcessor(一):处ç�† @ComponentScan 注解](https://my.oschina.net/funcy/blog/4836178) +* [ConfigurationClassPostProcessor(二):处ç�† @Bean 注解](https://my.oschina.net/funcy/blog/4492878) +* [ConfigurationClassPostProcessor(三):处ç�† @Import 注解](https://my.oschina.net/funcy/blog/4678152) +* [ConfigurationClassPostProcessor(四):处ç�† @Conditional 注解](https://my.oschina.net/funcy/blog/4873444) -### 4\. ×ܽá +### 4\. 总结 -±¾ÎĽéÉÜÁË `BeanFactoryPostProcessor` µÄ¸ÅÄ¾ÙÀý˵Ã÷ÁË `BeanFactoryPostProcessor` µÄʹÓã¬ÒÔ¼°½éÉÜÁË spring ÌṩµÄÁ½¸ö `BeanFactoryPostProcessor` ʵÏÖÀࣺ`EventListenerMethodProcessor` Óë `ConfigurationClassPostProcessor`¡£ +本文介ç»�了 `BeanFactoryPostProcessor` 的概念,举例说明了 `BeanFactoryPostProcessor` 的使用,以å�Šä»‹ç»�了 spring æ��供的两个 `BeanFactoryPostProcessor` 实现类:`EventListenerMethodProcessor` 与 `ConfigurationClassPostProcessor`。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4597545](https://my.oschina.net/funcy/blog/4597545) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4597545](https://my.oschina.net/funcy/blog/4597545) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanPostProcessor.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanPostProcessor.md" index 8bed1ab..046f2be 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanPostProcessor.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\347\273\204\344\273\266\345\210\206\346\236\220/Spring\347\273\204\344\273\266\344\271\213BeanPostProcessor.md" @@ -1,31 +1,31 @@ -`BeanPostProcessor` ÖÐÎÄÃûΪ spring bean µÄºóÖô¦ÀíÆ÷£¬Çø±ðÓÚ `BeanFactoryPostProcessor`£¬`BeanPostProcessor` ¿ÉÒÔ¶Ô bean ½øÐвÙ×÷¡£ +`BeanPostProcessor` 中文å��为 spring bean çš„å�Žç½®å¤„ç�†å™¨ï¼ŒåŒºåˆ«äºŽ `BeanFactoryPostProcessor`,`BeanPostProcessor` å�¯ä»¥å¯¹ bean 进行æ“�作。 -spring `BeanPostProcessor` ÔÚ bean µÄ´´½¨¹ý³ÌÖÐÖ´ÐУ¬Ö´ÐÐʱ»úÈçÏÂ: +spring `BeanPostProcessor` 在 bean 的创建过程中执行,执行时机如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b7a4d4bc1bfbd76537e40cf843b0d18df93.png) -ÔÚ bean µÄ´´½¨¹ý³ÌÖУ¬`BeanPostProcessor` Ò»¹²Ö´Ðйý 8 ´Î£º +在 bean 的创建过程中,`BeanPostProcessor` 一共执行过 8 次: -1. ³¢ÊÔÉú³É´úÀí¶ÔÏó -2. ÍÆ¶Ï¹¹Ôì·½·¨ -3. »ñȡעÈëµÄÊôÐÔ -4. Ìí¼ÓÈý¼¶»º´æ -5. ÊÇ·ñÐèҪעÈëÊôÐÔ -6. Ìî³äÊôÐÔ -7. ³õʼ»¯Ç° -8. ³õʼ»¯ºó +1. å°�试生æˆ�代ç�†å¯¹è±¡ +2. 推断构造方法 +3. 获å�–注入的属性 +4. 添加三级缓存 +5. 是å�¦éœ€è¦�注入属性 +6. 填充属性 +7. åˆ�始化å‰� +8. åˆ�始化å�Ž -±¾À´½«»áÖðÒ»ÊáÀíÕâЩ¹ý³ÌÖÐÖ´ÐÐµÄ `BeanPostProcessor`¡£ +本æ�¥å°†ä¼šé€�一梳ç�†è¿™äº›è¿‡ç¨‹ä¸­æ‰§è¡Œçš„ `BeanPostProcessor`。 -### 1\. ʲôÊÇ `BeanPostProcessor` +### 1\. 什么是 `BeanPostProcessor` -ÊáÀí `BeanPostProcessor` ǰ£¬ÎÒÃÇÏÈÀ´¿´¿´Ê²Ã´ÊÇ `BeanPostProcessor`£¬´úÂëÈçÏ£º +梳ç�† `BeanPostProcessor` å‰�,我们先æ�¥çœ‹çœ‹ä»€ä¹ˆæ˜¯ `BeanPostProcessor`,代ç �如下: ``` public interface BeanPostProcessor { /** - * ³õʼ»¯Ç°Ö´ÐÐ + * åˆ�始化å‰�执行 */ @Nullable default Object postProcessBeforeInitialization(Object bean, String beanName) @@ -34,7 +34,7 @@ public interface BeanPostProcessor { } /** - * ³õʼ»¯ºóÖ´ÐÐ + * åˆ�始化å�Žæ‰§è¡Œ */ @Nullable default Object postProcessAfterInitialization(Object bean, String beanName) @@ -46,87 +46,87 @@ public interface BeanPostProcessor { ``` -`BeanPostProcessor` ÊÇÒ»¸ö½Ó¿Ú£¬¶¨ÒåÁË bean ³õʼǰºóµÄһЩ²Ù×÷£¬ÎÒÃÇ¿ÉÒÔʵÏÖÕâ¸ö½Ó¿Ú£¬ÖØÐ´ËüµÄÁ½¸ö·½·¨£¬¾Í¿ÉÒÔÔÚ bean ³õʼ»¯Ç°½øÐÐһЩ´¦Àí²Ù×÷ÁË¡£ +`BeanPostProcessor` 是一个接å�£ï¼Œå®šä¹‰äº† bean åˆ�å§‹å‰�å�Žçš„一些æ“�作,我们å�¯ä»¥å®žçŽ°è¿™ä¸ªæŽ¥å�£ï¼Œé‡�写它的两个方法,就å�¯ä»¥åœ¨ bean åˆ�始化å‰�进行一些处ç�†æ“�作了。 -`BeanPostProcessor` ÔÚ `AbstractApplicationContext#registerBeanPostProcessors` ÖÐ×¢²á¡£ +`BeanPostProcessor` 在 `AbstractApplicationContext#registerBeanPostProcessors` 中注册。 -ʵ¼ÊÉÏ£¬`BeanPostProcessor` »¹ÓÐÖÚ¶àµÄ×Ó½Ó¿Ú£¬ÕâЩÎÒÃǶ¼Í³³ÆÎª `BeanPostProcessor`£¬±¾ÎĵÄÖ÷ҪĿµÄ¾ÍÊÇÊáÀíÕâЩ `BeanPostProcessor`¡£ +实际上,`BeanPostProcessor` 还有众多的å­�接å�£ï¼Œè¿™äº›æˆ‘们都统称为 `BeanPostProcessor`,本文的主è¦�目的就是梳ç�†è¿™äº› `BeanPostProcessor`。 -### 2. `BeanPostProcessor` ÊáÀí +### 2. `BeanPostProcessor` 梳ç�† ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-102ca0d1e4db82a28871661241b05bc3956.png) -#### 2.1 ³¢ÊÔÉú³É´úÀí¶ÔÏó +#### 2.1 å°�试生æˆ�代ç�†å¯¹è±¡ -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#resolveBeforeInstantiation` -* Ö´Ðз½·¨£º`InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation` -* `AbstractAutoProxyCreator#postProcessBeforeInstantiation`£ºÉú³É´úÀí¶ÔÏó +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#resolveBeforeInstantiation` +* 执行方法:`InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation` +* `AbstractAutoProxyCreator#postProcessBeforeInstantiation`:生æˆ�代ç�†å¯¹è±¡ -#### 2.2 ÍÆ¶Ï¹¹Ôì·½·¨ +#### 2.2 推断构造方法 -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#determineConstructorsFromBeanPostProcessors` -* Ö´Ðз½·¨£º`SmartInstantiationAwareBeanPostProcessor#determineCandidateConstructors` -* `AutowiredAnnotationBeanPostProcessor#determineCandidateConstructors`£ºÍƶϹ¹Ôì·½·¨ +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#determineConstructorsFromBeanPostProcessors` +* 执行方法:`SmartInstantiationAwareBeanPostProcessor#determineCandidateConstructors` +* `AutowiredAnnotationBeanPostProcessor#determineCandidateConstructors`:推断构造方法 -#### 2.3 »ñȡעÈëµÄÊôÐÔ +#### 2.3 获å�–注入的属性 -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#applyMergedBeanDefinitionPostProcessors` -* Ö´Ðз½·¨£º`MergedBeanDefinitionPostProcessor#postProcessMergedBeanDefinition` -* `ApplicationListenerDetector#postProcessMergedBeanDefinition`£ºÊÕ¼¯µ¥ÀýµÄ `ApplicationListener` -* `AutowiredAnnotationBeanPostProcessor#postProcessMergedBeanDefinition`£º²éÕÒ±» `@Autowired`¡¢`@Value`¡¢`@Inject` ±ê¼ÇµÄÊôÐÔÓë·½·¨ -* `CommonAnnotationBeanPostProcessor#postProcessMergedBeanDefinition`£º²éÕÒ±» `@Resource` ±ê¼ÇµÄÊôÐÔÓë·½·¨ -* `InitDestroyAnnotationBeanPostProcessor#postProcessMergedBeanDefinition`£º²éÕÒ±» `@PostConstruct`¡¢`@PreDestroy` ±ê¼ÇµÄ·½·¨ +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#applyMergedBeanDefinitionPostProcessors` +* 执行方法:`MergedBeanDefinitionPostProcessor#postProcessMergedBeanDefinition` +* `ApplicationListenerDetector#postProcessMergedBeanDefinition`:收集å�•例的 `ApplicationListener` +* `AutowiredAnnotationBeanPostProcessor#postProcessMergedBeanDefinition`:查找被 `@Autowired`ã€�`@Value`ã€�`@Inject` 标记的属性与方法 +* `CommonAnnotationBeanPostProcessor#postProcessMergedBeanDefinition`:查找被 `@Resource` 标记的属性与方法 +* `InitDestroyAnnotationBeanPostProcessor#postProcessMergedBeanDefinition`:查找被 `@PostConstruct`ã€�`@PreDestroy` 标记的方法 -#### 2.4 Ìí¼ÓÈý¼¶»º´æ +#### 2.4 添加三级缓存 -* µ÷ÓÃλÖ㨷½·¨²¢Ã»ÓÐÖ´ÐУ©£º`AbstractAutowireCapableBeanFactory#doCreateBean` -* Ö´Ðз½·¨£º`SmartInstantiationAwareBeanPostProcessor#getEarlyBeanReference` -* `AbstractAutoProxyCreator#getEarlyBeanReference`£ºÌáǰÉú³É´úÀí¶ÔÏó +* 调用ä½�置(方法并没有执行):`AbstractAutowireCapableBeanFactory#doCreateBean` +* 执行方法:`SmartInstantiationAwareBeanPostProcessor#getEarlyBeanReference` +* `AbstractAutoProxyCreator#getEarlyBeanReference`:æ��å‰�生æˆ�代ç�†å¯¹è±¡ -#### 2.5 ÊÇ·ñÐèҪעÈëÊôÐÔ +#### 2.5 是å�¦éœ€è¦�注入属性 -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#populateBean` -* Ö´Ðз½·¨£º`InstantiationAwareBeanPostProcessor#postProcessAfterInstantiation` +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#populateBean` +* 执行方法:`InstantiationAwareBeanPostProcessor#postProcessAfterInstantiation` -#### 2.6 Ìî³äÊôÐÔ +#### 2.6 填充属性 -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#populateBean` -* Ö´Ðз½·¨£º`InstantiationAwareBeanPostProcessor#postProcessProperties` -* `AutowiredAnnotationBeanPostProcessor#postProcessProperties`£ºÌî³ä±» `@Autowired`¡¢`@Value`¡¢`@Inject` ±ê¼ÇµÄÊôÐÔÓë·½·¨ -* `CommonAnnotationBeanPostProcessor#postProcessProperties`£ºÌî³ä±» `@Resource` ±ê¼ÇµÄÊôÐÔÓë·½·¨ -* `ImportAwareBeanPostProcessor#postProcessProperties`£ºÎª `EnhancedConfiguration` ʵÀýÉèÖà `beanFactory` +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#populateBean` +* 执行方法:`InstantiationAwareBeanPostProcessor#postProcessProperties` +* `AutowiredAnnotationBeanPostProcessor#postProcessProperties`:填充被 `@Autowired`ã€�`@Value`ã€�`@Inject` 标记的属性与方法 +* `CommonAnnotationBeanPostProcessor#postProcessProperties`:填充被 `@Resource` 标记的属性与方法 +* `ImportAwareBeanPostProcessor#postProcessProperties`:为 `EnhancedConfiguration` 实例设置 `beanFactory` -#### 2.7 ³õʼ»¯Ç° +#### 2.7 åˆ�始化å‰� -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#applyBeanPostProcessorsBeforeInitialization` -* Ö´Ðз½·¨£º`BeanPostProcessor#postProcessBeforeInitialization` -* `ApplicationContextAwareProcessor#postProcessBeforeInitialization`£ºµ÷Óà `XxxAware` ½Ó¿ÚµÄ·½·¨ -* `BeanValidationPostProcessor#postProcessBeforeInitialization`£º´¦Àí `JSR-303` УÑé -* `ImportAwareBeanPostProcessor#postProcessBeforeInitialization`£ºµ÷Óà `ImportAware` ½Ó¿ÚµÄ·½·¨ -* `InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization`£ºµ÷Óñ» `@PostConstruct` ±ê¼ÇµÄ·½·¨ -* `LoadTimeWeaverAwareProcessor#postProcessBeforeInitialization`£ºµ÷Óà `LoadTimeWeaverAware` ½Ó¿ÚµÄ·½·¨ -* `ServletContextAwareProcessor#postProcessBeforeInitialization`£ºµ÷Óà `ServletContextAware` ½Ó¿ÚµÄ·½·¨£¬ÉèÖà `servletContext` Óë `servletConfig` +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#applyBeanPostProcessorsBeforeInitialization` +* 执行方法:`BeanPostProcessor#postProcessBeforeInitialization` +* `ApplicationContextAwareProcessor#postProcessBeforeInitialization`:调用 `XxxAware` 接å�£çš„æ–¹æ³• +* `BeanValidationPostProcessor#postProcessBeforeInitialization`:处ç�† `JSR-303` 校验 +* `ImportAwareBeanPostProcessor#postProcessBeforeInitialization`:调用 `ImportAware` 接å�£çš„æ–¹æ³• +* `InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization`:调用被 `@PostConstruct` 标记的方法 +* `LoadTimeWeaverAwareProcessor#postProcessBeforeInitialization`:调用 `LoadTimeWeaverAware` 接å�£çš„æ–¹æ³• +* `ServletContextAwareProcessor#postProcessBeforeInitialization`:调用 `ServletContextAware` 接å�£çš„æ–¹æ³•,设置 `servletContext` 与 `servletConfig` -#### 2.8 ³õʼ»¯ºó +#### 2.8 åˆ�始化å�Ž -* µ÷ÓÃλÖãº`AbstractAutowireCapableBeanFactory#applyBeanPostProcessorsAfterInitialization` -* Ö´Ðз½·¨£º`BeanPostProcessor#postProcessAfterInitialization` -* `AbstractAdvisingBeanPostProcessor#postProcessAfterInitialization`£º´¦Àí `AopInfrastructureBean` -* `AbstractAutoProxyCreator#postProcessAfterInitialization`£ºÉú³É´úÀí¶ÔÏó -* `AdvisorAdapterRegistrationManager#postProcessAfterInitialization`£ºÈç¹ûµ±Ç° bean ÊÇ `AdvisorAdapter`£¬Ôò×¢²á -* `ApplicationListenerDetector#postProcessAfterInitialization`£ºÈç¹ûµ±Ç° bean ÊÇ `ApplicationListener`£¬ÔòÌí¼Óµ½Ê¼þ¼àÌýÆ÷ÖÐ -* `BeanPostProcessorChecker#postProcessAfterInitialization`£º¼ì²é²Ù×÷£¬´òÁ˸ö log -* `BeanValidationPostProcessor#postProcessAfterInitialization`£º´¦Àí `JSR-303` УÑé -* `JmsListenerAnnotationBeanPostProcessor#postProcessAfterInitialization`£º´¦Àí `@JmsListener` ×¢½â -* `ScheduledAnnotationBeanPostProcessor#postProcessAfterInitialization`£º´¦Àí `@Scheduled` ×¢½â -* `SimpleServletPostProcessor#postProcessAfterInitialization`£º¶Ô `Servlet` ʵÀý£¬µ÷Ó÷½·¨ `Servlet#init(ServletConfig)` +* 调用ä½�置:`AbstractAutowireCapableBeanFactory#applyBeanPostProcessorsAfterInitialization` +* 执行方法:`BeanPostProcessor#postProcessAfterInitialization` +* `AbstractAdvisingBeanPostProcessor#postProcessAfterInitialization`:处ç�† `AopInfrastructureBean` +* `AbstractAutoProxyCreator#postProcessAfterInitialization`:生æˆ�代ç�†å¯¹è±¡ +* `AdvisorAdapterRegistrationManager#postProcessAfterInitialization`:如果当å‰� bean 是 `AdvisorAdapter`,则注册 +* `ApplicationListenerDetector#postProcessAfterInitialization`:如果当å‰� bean 是 `ApplicationListener`,则添加到事件监å�¬å™¨ä¸­ +* `BeanPostProcessorChecker#postProcessAfterInitialization`:检查æ“�作,打了个 log +* `BeanValidationPostProcessor#postProcessAfterInitialization`:处ç�† `JSR-303` 校验 +* `JmsListenerAnnotationBeanPostProcessor#postProcessAfterInitialization`:处ç�† `@JmsListener` 注解 +* `ScheduledAnnotationBeanPostProcessor#postProcessAfterInitialization`:处ç�† `@Scheduled` 注解 +* `SimpleServletPostProcessor#postProcessAfterInitialization`:对 `Servlet` 实例,调用方法 `Servlet#init(ServletConfig)` -### 3\. ×ܽá +### 3\. 总结 -×îºóÓÃÒ»¸ö±í¸ñÀ´×ܽáÕâЩ `BeanPostProcessor`: +最å�Žç”¨ä¸€ä¸ªè¡¨æ ¼æ�¥æ€»ç»“这些 `BeanPostProcessor`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b1117b66c4881f366669dab69b332164d8f.png) * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4597551](https://my.oschina.net/funcy/blog/4597551) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4597551](https://my.oschina.net/funcy/blog/4597551) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\200\357\274\211\357\274\232\345\244\204\347\220\206@ComponentScan\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\200\357\274\211\357\274\232\345\244\204\347\220\206@ComponentScan\346\263\250\350\247\243.md" index f8eb270..b2ebe19 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\200\357\274\211\357\274\232\345\244\204\347\220\206@ComponentScan\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\200\357\274\211\357\274\232\345\244\204\347\220\206@ComponentScan\346\263\250\350\247\243.md" @@ -1,8 +1,8 @@ -ÔÚ [spring Æô¶¯Á÷³ÌÖ®Ö´ÐÐ BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4641114) Ò»ÎÄÖУ¬ÔÚÖ´ÐÐ `BeanFactoryPostProcessor` ¹ý³ÌÖУ¬ÓÐÒ»¸öÖØÒªµÄÀà»á±»Ö´Ðе½£¬Ëü¾ÍÊÇ `ConfigurationClassPostProcessor`¡£Õâ¸öÀà·Ç³£ÖØÒª£¬Ëü»á´¦Àí spring µÄÅäÖÃÀ࣬Èç `@Component`£¬`@PropertySources`£¬`@ComponentScans`£¬`@ImportResource` µÈ×¢½â£¬±¾ÏµÁÐÎÄÕ½«Í¨¹ý¼¸¸öʵÀý£¬´ÓÔ´ÂëµÄ½Ç¶È·ÖÎö spring ¶ÔÕ⼸¸ö×¢½âµÄ´¦Àí¡£ +在 [spring å�¯åЍæµ�程之执行 BeanFactoryPostProcessor](https://my.oschina.net/funcy/blog/4641114) 一文中,在执行 `BeanFactoryPostProcessor` 过程中,有一个é‡�è¦�的类会被执行到,它就是 `ConfigurationClassPostProcessor`。这个类é�žå¸¸é‡�è¦�,它会处ç�† spring çš„é…�置类,如 `@Component`,`@PropertySources`,`@ComponentScans`,`@ImportResource` 等注解,本系列文章将通过几个实例,从æº�ç �的角度分æž� spring 对这几个注解的处ç�†ã€‚ -## 1\. »Ø¹Ë `BeanFactoryPostProcessor` µÄÖ´ÐÐ +## 1\. 回顾 `BeanFactoryPostProcessor` 的执行 -»ØÒäÏ `BeanFactoryPostProcessor` µÄÖ´ÐУ¬µ÷ÓÃÁ´ÈçÏÂ: +回忆下 `BeanFactoryPostProcessor` 的执行,调用链如下: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(java.lang.String...) @@ -13,16 +13,16 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(java.lang. ``` -ÔÚ `PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory, List)` ÖУ¬»áÁ½´Îµ÷Óà `ConfigurationClassPostProcessor` µÄ·½·¨£º +在 `PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory, List)` 中,会两次调用 `ConfigurationClassPostProcessor` 的方法: -* `invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry)`£ºµ÷ÓõÄÊÇ `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` ·½·¨£» -* `invokeBeanFactoryPostProcessors(registryProcessors, beanFactory)`£ºµ÷ÓõÄÊÇ `BeanFactoryPostProcessor#postProcessBeanFactory` ·½·¨£» +* `invokeBeanDefinitionRegistryPostProcessors(currentRegistryProcessors, registry)`:调用的是 `BeanDefinitionRegistryPostProcessor#postProcessBeanDefinitionRegistry` 方法; +* `invokeBeanFactoryPostProcessors(registryProcessors, beanFactory)`:调用的是 `BeanFactoryPostProcessor#postProcessBeanFactory` 方法; -`ConfigurationClassPostProcessor` ͬʱʵÏÖÁË `BeanDefinitionRegistryPostProcessor` Óë `BeanFactoryPostProcessor`£¬Òò´ËÉÏÊöÁ½¸ö·½·¨¶¼»áÖ´Ðе½£¬ÏÂÃæÎÒÃÇÀ´¿´Ï `ConfigurationClassPostProcessor` µÄÕâÁ½¸ö·½·¨£º +`ConfigurationClassPostProcessor` å�Œæ—¶å®žçŽ°äº† `BeanDefinitionRegistryPostProcessor` 与 `BeanFactoryPostProcessor`,因此上述两个方法都会执行到,下é�¢æˆ‘们æ�¥çœ‹ä¸‹ `ConfigurationClassPostProcessor` 的这两个方法: ``` /** - * ÏÈÖ´ÐÐ postProcessBeanDefinitionRegistry(...) + * 先执行 postProcessBeanDefinitionRegistry(...) */ @Override public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) { @@ -34,12 +34,12 @@ public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) { throw new IllegalStateException(...); } this.registriesPostProcessed.add(registryId); - // ÓÖµ÷ÓÃÁËÒ»¸ö·½·¨ + // å�ˆè°ƒç”¨äº†ä¸€ä¸ªæ–¹æ³• processConfigBeanDefinitions(registry); } /** - * Ö´ÐÐÍê postProcessBeanDefinitionRegistry(...) ºó£¬ÔÙÖ´ÐÐ postProcessBeanFactory(...) + * 执行完 postProcessBeanDefinitionRegistry(...) å�Žï¼Œå†�执行 postProcessBeanFactory(...) */ @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { @@ -50,33 +50,33 @@ public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) } this.factoriesPostProcessed.add(factoryId); if (!this.registriesPostProcessed.contains(factoryId)) { - // Èç¹û beanFactory ûÓб»´¦Àí£¬»áÔÙÖ´ÐÐÒ»´Î processConfigBeanDefinitions ·½·¨ - // Ò»°ãÇé¿öÏ£¬ÕâÀï²»»á±»Ö´Ðе½ + // 如果 beanFactory 没有被处ç�†ï¼Œä¼šå†�执行一次 processConfigBeanDefinitions 方法 + // 一般情况下,这里ä¸�会被执行到 processConfigBeanDefinitions((BeanDefinitionRegistry) beanFactory); } - // ÔöÇ¿ÅäÖÃÀà + // 增强é…�置类 enhanceConfigurationClasses(beanFactory); - // Ìí¼Ó´¦Àí ImportAware »Øµ÷µÄ BeanPostProcessor£¬Óë±¾ÎÄÖ÷Ìâ¹ØÏµ²»´ó£¬²»·ÖÎö + // 添加处ç�† ImportAware 回调的 BeanPostProcessor,与本文主题关系ä¸�大,ä¸�分æž� beanFactory.addBeanPostProcessor(new ImportAwareBeanPostProcessor(beanFactory)); } ``` -¶ÔÉÏÊöÁ½¸ö·½·¨£¬ËµÃ÷ÈçÏ£º +对上述两个方法,说明如下: -* °´ÕÕ `PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory, List)` µÄÖ´ÐÐÂß¼­£¬»áÏÈÖ´ÐÐ `postProcessBeanDefinitionRegistry(...)`£¬ÔÙÖ´ÐÐ `postProcessBeanDefinitionRegistry(...)` -* `postProcessBeanDefinitionRegistry(...)` Ö÷ÒªÊǵ÷Óà `processConfigBeanDefinitions(...)` ·½·¨£» -* `postProcessBeanFactory(...)` »áÏÈÅжϵ±Ç° beanFactory ÊÇ·ñÖ´Ðйý `processConfigBeanDefinitions(...)` ·½·¨£¬Èç¹ûûÓУ¬Ôò»áÖ´ÐÐ `processConfigBeanDefinitions(...)` ·½·¨£¬Ö®ºó»á `enhanceConfigurationClasses(...)` ·½·¨¶ÔÅäÖÃÀà½øÐÐÔöÇ¿¡£ +* 按照 `PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory, List)` 的执行逻辑,会先执行 `postProcessBeanDefinitionRegistry(...)`,å†�执行 `postProcessBeanDefinitionRegistry(...)` +* `postProcessBeanDefinitionRegistry(...)` 主è¦�是调用 `processConfigBeanDefinitions(...)` 方法; +* `postProcessBeanFactory(...)` 会先判断当å‰� beanFactory 是å�¦æ‰§è¡Œè¿‡ `processConfigBeanDefinitions(...)` 方法,如果没有,则会执行 `processConfigBeanDefinitions(...)` 方法,之å�Žä¼š `enhanceConfigurationClasses(...)` 方法对é…�置类进行增强。 -´ÓÒÔÉÏ·ÖÎöÀ´¿´£¬ÒÔÉÏÁ½¸ö·½·¨×îÖÕµ÷ÓõÄÊÇ `processConfigBeanDefinitions(...)` Óë `enhanceConfigurationClasses(...)`£¬Òò´ËÕâÁ½¸ö·½·¨ÊÇÎÒÃǽÓÏÂÀ´·ÖÎöµÄÖØµã¡£ +从以上分æž�æ�¥çœ‹ï¼Œä»¥ä¸Šä¸¤ä¸ªæ–¹æ³•最终调用的是 `processConfigBeanDefinitions(...)` 与 `enhanceConfigurationClasses(...)`,因此这两个方法是我们接下æ�¥åˆ†æž�çš„é‡�点。 -## 2\. spring ÊÇÈçºÎ´¦Àí `@ComponentScan` ×¢½âµÄ£¿ +## 2\. spring 是如何处ç�† `@ComponentScan` 注解的? -### 2.1 demo ×¼±¸ +### 2.1 demo 准备 -ÔÚ·ÖÎöÁ÷³Ìǰ£¬ÎÒÃÇÏÈ×¼±¸µ÷ÊÔ demo: +在分æž�æµ�程å‰�,我们先准备调试 demo: -Ê×ÏÈ×¼±¸Ò»¸öÀ࣬ÉÏÃæ±êÁË `@ComponentScan` ×¢½â£º +首先准备一个类,上é�¢æ ‡äº† `@ComponentScan` 注解: ``` @ComponentScan("org.springframework.learn.explore.demo02") @@ -86,14 +86,14 @@ public class BeanConfigs { ``` -ÔÙ×¼±¸Á½¸ö `Bean`£º +å†�准备两个 `Bean`: ``` @Component public class BeanObj1 { public BeanObj1() { - System.out.println("µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨"); + System.out.println("调用beanObj1的构造方法"); } @Override @@ -106,7 +106,7 @@ public class BeanObj1 { public class BeanObj2 { public BeanObj2() { - System.out.println("µ÷ÓÃbeanObj2µÄ¹¹Ôì·½·¨"); + System.out.println("调用beanObj2的构造方法"); } @Override @@ -117,7 +117,7 @@ public class BeanObj2 { ``` -×îºóÊÇÖ÷Àࣺ +最å�Žæ˜¯ä¸»ç±»ï¼š ``` public class Demo05Main { @@ -133,46 +133,46 @@ public class Demo05Main { ``` -ÒÔÉÏÖ»ÊÇ demo µÄÖ÷Òª²¿·Ö£¬ÍêÕûµÄ demo ¼û [gitee/funcy](https://gitee.com/funcy/spring-framework/tree/v5.2.2.RELEASE_learn/spring-learn/src/main/java/org/springframework/learn/explore/demo05). +以上å�ªæ˜¯ demo 的主è¦�部分,完整的 demo è§� [gitee/funcy](https://gitee.com/funcy/spring-framework/tree/v5.2.2.RELEASE_learn/spring-learn/src/main/java/org/springframework/learn/explore/demo05). -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` -µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨ -µ÷ÓÃbeanObj2µÄ¹¹Ôì·½·¨ +调用beanObj1的构造方法 +调用beanObj2的构造方法 obj1:BeanObj1{} obj2:BeanObj2{} org.springframework.learn.explore.demo05.BeanConfigs@13eb8acf ``` -½ÓÏÂÀ´£¬¾ÍÒÔÕâ¸ö demo ΪÀý£¬Ò»²½²½½øÐзÖÎö¡£ +接下æ�¥ï¼Œå°±ä»¥è¿™ä¸ª demo 为例,一步步进行分æž�。 -### 2.2 `ApplicationContext` µÄ¹¹Ôì·½·¨£º`AnnotationConfigApplicationContext(Class)` +### 2.2 `ApplicationContext` 的构造方法:`AnnotationConfigApplicationContext(Class)` -ÎÒÃǽøÈë `AnnotationConfigApplicationContext` µÄ¹¹Ôì·½·¨: +我们进入 `AnnotationConfigApplicationContext` 的构造方法: ``` public AnnotationConfigApplicationContext(Class... componentClasses) { this(); register(componentClasses); - // spring ÈÝÆ÷Æô¶¯Àà + // spring 容器å�¯åŠ¨ç±» refresh(); } /** - * this() ·½·¨µÄµ÷ÓÃÄÚÈÝ + * this() 方法的调用内容 */ public AnnotationConfigApplicationContext() { - // ¶ÔÁ½¸ö³ÉÔ±½øÐи³Öµ - // Èç¹ûµ÷ÓõÄÊÇ`AnnotationConfigApplicationContext(Class)`·½·¨ £¬ÕâÁ½¸öÊôÐÔ²»»áÓõ½ - // Èç¹ûµ÷ÓõÄÊÇ`AnnotationConfigApplicationContext(String)`·½·¨ £¬ÕâÁ½¸öÊôÐԲŻáÓõ½ + // 对两个æˆ�员进行赋值 + // 如果调用的是`AnnotationConfigApplicationContext(Class)`方法 ,这两个属性ä¸�会用到 + // 如果调用的是`AnnotationConfigApplicationContext(String)`方法 ,这两个属性æ‰�会用到 this.reader = new AnnotatedBeanDefinitionReader(this); this.scanner = new ClassPathBeanDefinitionScanner(this); } /** - * register(...) ·½·¨µÄÄÚÈÝ + * register(...) 方法的内容 */ @Override public void register(Class... componentClasses) { @@ -182,29 +182,29 @@ public void register(Class... componentClasses) { ``` -`AnnotationConfigApplicationContext` µÄ¹¹Ôì·½·¨ÄÚÈÝÈçÏ£º +`AnnotationConfigApplicationContext` 的构造方法内容如下: -* `this()`£ºµ÷ÓÃÎ޲ι¹Ôì·½·¨£¬Õâ¸ö·½·¨ÀïÖ÷ÒªÊǸø `reader` Óë `scanner` ³ÉÔ±±äÁ¿¸³Öµ£» -* `register(componentClasses)`£º×¢²á `component` Àൽ `beanFactory` ÖУ¬µ÷ÓõÄÊÇ `reader.register(...)` ·½·¨£» -* `refresh()`£ºspring µÄÈÝÆ÷Æô¶¯·½·¨£¬¾Í²»·ÖÎö¡£ +* `this()`:调用无å�‚构造方法,这个方法里主è¦�是给 `reader` 与 `scanner` æˆ�员å�˜é‡�赋值; +* `register(componentClasses)`:注册 `component` 类到 `beanFactory` 中,调用的是 `reader.register(...)` 方法; +* `refresh()`:spring 的容器å�¯åŠ¨æ–¹æ³•ï¼Œå°±ä¸�分æž�。 -Ö´ÐÐÍê `register(componentClasses);` ǰºó£¬`beanFactory` ÄÚµÄ `BeanDefinitionMap` ÄÚÈÝÈçÏ£º +执行完 `register(componentClasses);` å‰�å�Žï¼Œ`beanFactory` 内的 `BeanDefinitionMap` 内容如下: -Ö´ÐÐǰ£º +执行å‰�: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c317168bfde886f7817e6e9a11301c84b52.png) -Ö´ÐÐºó£º +执行å�Žï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-cc2f7bcdb4b56f67893ac29774bb8119892.png) -¿ÉÒÔ¿´µ½£¬`beanConfigs` ÒѾ­×¢²áµ½ `beanDefinitionNames` ÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`beanConfigs` å·²ç»�注册到 `beanDefinitionNames` 了。 -µ½ÕâÀspring ½ö½öÖ»ÊÇ°Ñ `beanConfigs` ×¢²áµ½ÁË `beanDefinitionNames`£¨`BeanConfigs` ÓÉ `new AnnotationConfigApplicationContext(BeanConfigs.class)` ´«ÈëµÄ£©£¬²¢Ã»ÓÐɨÃè `@ComponentSacn` ×¢½âÖ¸¶¨µÄ°üÃû£¬Ò²¾ÍÊÇ `org.springframework.learn.explore.demo05`£¬ÄÇô°üµÄɨÃèÊÇÔÚÄÄÀï½øÐеÄÄØ£¿´ðÓ¦¾ÍÊÇ `ConfigurationClassPostProcessor` ÖУ¬ÎÒÃǼÌÐøÍùÏ¿´¡£ +到这里,spring ä»…ä»…å�ªæ˜¯æŠŠ `beanConfigs` 注册到了 `beanDefinitionNames`(`BeanConfigs` ç”± `new AnnotationConfigApplicationContext(BeanConfigs.class)` 传入的),并没有扫æ�� `@ComponentSacn` 注解指定的包å��,也就是 `org.springframework.learn.explore.demo05`,那么包的扫æ��是在哪里进行的呢?答应就是 `ConfigurationClassPostProcessor` 中,我们继续往下看。 -### 2.3 ´¦ÀíÅäÖÃÀࣺ`ConfigurationClassPostProcessor#processConfigBeanDefinitions` +### 2.3 处ç�†é…�置类:`ConfigurationClassPostProcessor#processConfigBeanDefinitions` -¸ù¾Ý¿ªÆªµÄ·ÖÎö£¬ÎÒÃÇÖ±½Ó½øÈë `ConfigurationClassPostProcessor#processConfigBeanDefinitions` ·½·¨£¬µ÷ÓÃÁ´ÈçÏ£º +æ ¹æ�®å¼€ç¯‡çš„分æž�,我们直接进入 `ConfigurationClassPostProcessor#processConfigBeanDefinitions` 方法,调用链如下: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) @@ -218,83 +218,83 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) ``` -·½·¨ÄÚÈÝÈçÏ£º +方法内容如下: ``` public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { List configCandidates = new ArrayList<>(); - // 1\. »ñÈ¡ËùÓÐBeanDefinitionÃû³Æ + // 1\. 获å�–所有BeanDefinitionå��ç§° String[] candidateNames = registry.getBeanDefinitionNames(); - // 2\. Ñ­»·candidateNamesÊý×飬±êʶFullÓëLite + // 2\. 循环candidateNames数组,标识Full与Lite for (String beanName : candidateNames) { BeanDefinition beanDef = registry.getBeanDefinition(beanName); - // Åжϵ±Ç°BeanDefinitionÊÇÒѾ­´¦Àí¹ýÁË£¬´¦Àí¹ýÁ˾Ͳ»ÔÙ´¦ÀíÁË + // 判断当å‰�BeanDefinition是已ç»�处ç�†è¿‡äº†ï¼Œå¤„ç�†è¿‡äº†å°±ä¸�å†�处ç�†äº† if (beanDef.getAttribute(ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE) != null) { - // ÕâÀïÖ»ÊÇ´òÁ˸ölog£¬Ê¡ÂÔ + // 这里å�ªæ˜¯æ‰“了个log,çœ�ç•¥ ... } - // ÅжÏÊÇ·ñΪÅäÖÃÀ࣬ÕâÀï·ÖÁ½ÖÖÇé¿ö£º - // 1\. ´øÓÐ @Configuration ×¢½âÇÒ proxyBeanMethods != false µÄÀ࣬spring ³ÆÆäΪ Full ÅäÖÃÀà - // 2\. ´øÓÐ @Configuration ×¢½âÇÒ proxyBeanMethods == false, »ò´øÓÐ @Component¡¢@ComponentScan¡¢ - // @Import¡¢@ImportResource¡¢@Bean ÆäÖÐÖ®Ò»×¢½âµÄÀ࣬spring ³ÆÆäΪ Lite ÅäÖÃÀà - // ÕâÀï»á¶ÔFullÓëLite£¬½øÐбêʶ + // 判断是å�¦ä¸ºé…�置类,这里分两ç§�情况: + // 1\. 带有 @Configuration 注解且 proxyBeanMethods != false 的类,spring 称其为 Full é…�置类 + // 2\. 带有 @Configuration 注解且 proxyBeanMethods == false, 或带有 @Componentã€�@ComponentScanã€� + // @Importã€�@ImportResourceã€�@Bean 其中之一注解的类,spring 称其为 Lite é…�置类 + // 这里会对Full与Lite,进行标识 else if (ConfigurationClassUtils .checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) { configCandidates.add(new BeanDefinitionHolder(beanDef, beanName)); } } - // Èç¹ûûÓÐÅäÖÃÀֱ࣬½Ó·µ»Ø + // 如果没有é…�置类,直接返回 if (configCandidates.isEmpty()) { return; } - // Ê¡ÂÔÎ޹صĴúÂë + // çœ�略无关的代ç � ... - // ÅäÖÃÀà½âÎöÆ÷£¬Õâ¸öÀà·Ç³£ÖØÒª£¬ÏÂÃæ¾ÍÊÇÓÃËüÀ´½âÎö ¶Ô@Component¡¢@ImportµÈ×¢½âµÄ + // é…�置类解æž�器,这个类é�žå¸¸é‡�è¦�,下é�¢å°±æ˜¯ç”¨å®ƒæ�¥è§£æž� 对@Componentã€�@Import等注解的 ConfigurationClassParser parser = new ConfigurationClassParser( this.metadataReaderFactory, this.problemReporter, this.environment, this.resourceLoader, this.componentScanBeanNameGenerator, registry); - // Á½¸ö½á¹¹£¬candidates£ºÐèÒª½âÎöµÄÅäÖÃÀ࣬alreadyParsed£ºÍê³É½âÎöµÄÅäÖÃÀà + // 两个结构,candidates:需è¦�è§£æž�çš„é…�置类,alreadyParsed:完æˆ�è§£æž�çš„é…�置类 Set candidates = new LinkedHashSet<>(configCandidates); Set alreadyParsed = new HashSet<>(configCandidates.size()); do { - // 3\. ½âÎöÅäÖÃÀ࣬Õâ¸ö·½·¨×öÁ˺ܶàÊ£¬ - // È磺½âÎö@Component£¬@PropertySources£¬@ComponentScans£¬@ImportResourceµÈ×¢½â - // ×¢£ºÕâÀïÊÇÒ»´ÎÐÔ½âÎöËùÓеÄcandidates + // 3\. è§£æž�é…�置类,这个方法å�šäº†å¾ˆå¤šäº‹ï¼Œ + // 如:解æž�@Component,@PropertySources,@ComponentScans,@ImportResource等注解 + // 注:这里是一次性解æž�所有的candidates parser.parse(candidates); parser.validate(); Set configClasses = new LinkedHashSet<>(parser.getConfigurationClasses()); configClasses.removeAll(alreadyParsed); - // ´´½¨ reader£¬Õâ¸öreaderÓëÇ°ÃæApplicationContextÖеÄreader²»ÊÇͬһ¸ö + // 创建 reader,这个reader与å‰�é�¢ApplicationContext中的readerä¸�是å�Œä¸€ä¸ª if (this.reader == null) { this.reader = new ConfigurationClassBeanDefinitionReader( registry, this.sourceExtractor, this.resourceLoader, this.environment, this.importBeanNameGenerator, parser.getImportRegistry()); } - // 4\. ´¦Àí±¾´Î½âÎöµÄÀà - // ¾ÍÊǰÑ@ImportÒýÈëµÄÀà¡¢ÅäÖÃÀàÖдø@BeanµÄ·½·¨¡¢@ImportResourceÒýÈëµÄ×ÊÔ´µÈת»»³ÉBeanDefinition + // 4\. 处ç�†æœ¬æ¬¡è§£æž�的类 + // 就是把@Import引入的类ã€�é…�置类中带@Bean的方法ã€�@ImportResource引入的资æº�等转æ�¢æˆ�BeanDefinition this.reader.loadBeanDefinitions(configClasses); - // °ÑconfigClasses¼ÓÈëµ½alreadyParsed + // 把configClasses加入到alreadyParsed alreadyParsed.addAll(configClasses); - // ½âÎöÍê³Éºó£¬»á°ÑcandidatesµÄÇå¿Õ£¬½ÓÏÂÀ´»á°ÑÐÂÌí¼ÓµÄ¡¢Î´½âÎö¹ýµÄFullÅäÖÃÀàÌí¼Óµ½candidatesÖÐ + // è§£æž�完æˆ�å�Žï¼Œä¼šæŠŠcandidates的清空,接下æ�¥ä¼šæŠŠæ–°æ·»åŠ çš„ã€�未解æž�过的Fullé…�置类添加到candidates中 candidates.clear(); - // 5\. ´¦Àí·µ»Ø½á¹û£¬Èç¹ûÐÂÌí¼ÓµÄÀàΪ Full ÅäÖÃÀàÇÒδ½âÎö¹ý£¬¾Í°ÑËüÌí¼Óµ½candidatesÖУ¬ÔÚÏ´ÎÑ­»·Ê±ÔÙ½âÎö - // »ñµÃ×¢²áÆ÷ÀïÃæBeanDefinitionµÄÊýÁ¿ ºÍ candidateNames½øÐÐ±È½Ï - // Èç¹û´óÓڵϰ£¬ËµÃ÷ÓÐеÄBeanDefinition×¢²á½øÀ´ÁË + // 5\. 处ç�†è¿”回结果,如果新添加的类为 Full é…�置类且未解æž�过,就把它添加到candidates中,在下次循环时å†�è§£æž� + // 获得注册器里é�¢BeanDefinition的数é‡� å’Œ candidateNames进行比较 + // 如果大于的è¯�,说明有新的BeanDefinition注册进æ�¥äº† if (registry.getBeanDefinitionCount() > candidateNames.length) { String[] newCandidateNames = registry.getBeanDefinitionNames(); Set oldCandidateNames = new HashSet<>(Arrays.asList(candidateNames)); Set alreadyParsedClasses = new HashSet<>(); - // Ñ­»·alreadyParsed¡£°ÑÀàÃû¼ÓÈëµ½alreadyParsedClasses + // 循环alreadyParsed。把类å��加入到alreadyParsedClasses for (ConfigurationClass configurationClass : alreadyParsed) { alreadyParsedClasses.add(configurationClass.getMetadata().getClassName()); } for (String candidateName : newCandidateNames) { if (!oldCandidateNames.contains(candidateName)) { BeanDefinition bd = registry.getBeanDefinition(candidateName); - // Èç¹ûмӵÄÀàΪÅäÖÃÀ࣬ÇÒδ½âÎö¹ý£¬¾Í°ÑËüÌí¼Óµ½candidatesÖУ¬µÈ´ýÏ´ÎÑ­»·½âÎö + // 如果新加的类为é…�置类,且未解æž�过,就把它添加到candidates中,等待下次循环解æž� if (ConfigurationClassUtils .checkConfigurationClassCandidate(bd, this.metadataReaderFactory) && !alreadyParsedClasses.contains(bd.getBeanClassName())) { @@ -306,46 +306,46 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { } } - // Ê¡ÂÔÓë±¾ÎÄÁ÷³ÌÎ޹صĴúÂë + // çœ�略与本文æµ�程无关的代ç � ... } ``` -Õýʽ·ÖÎöÒÔÉÏ·½·¨Ç°£¬ÏÈÃ÷È· spring ¹ØÓÚÅäÖÃÀàµÄ¼¸¸ö¸ÅÄ£º +æ­£å¼�分æž�以上方法å‰�,先明确 spring 关于é…�置类的几个概念:: -* ÅäÖÃÀࣺ´øÓÐ `@Configuration`¡¢`@Component`¡¢`@ComponentScan`¡¢`@Import`¡¢`@ImportResource` µÈÆäÖÐÖ®Ò»×¢½âµÄÀࣻ -* `Full` ÅäÖÃÀࣺ´øÓÐ `@Configuration` ×¢½âÇÒ `proxyBeanMethods != false` µÄÀ࣬`spring` ³ÆÆäΪ `Full` ÅäÖÃÀࣻ -* `Lite` ÅäÖÃÀࣺ´øÓÐ `@Configuration` ×¢½âÇÒ `proxyBeanMethods == false`, »ò´øÓÐ `@Component`¡¢`@ComponentScan`¡¢`@Import`¡¢`@ImportResource` µÈÆäÖÐÖ®Ò»×¢½âµÄÀ࣬`spring` ³ÆÆäΪ `Lite` ÅäÖÃÀà¡£ +* é…�置类:带有 `@Configuration`ã€�`@Component`ã€�`@ComponentScan`ã€�`@Import`ã€�`@ImportResource` 等其中之一注解的类; +* `Full` é…�置类:带有 `@Configuration` 注解且 `proxyBeanMethods != false` 的类,`spring` 称其为 `Full` é…�置类; +* `Lite` é…�置类:带有 `@Configuration` 注解且 `proxyBeanMethods == false`, 或带有 `@Component`ã€�`@ComponentScan`ã€�`@Import`ã€�`@ImportResource` 等其中之一注解的类,`spring` 称其为 `Lite` é…�置类。 -ÒÔÉÏ·½·¨Óе㳤£¬×ܽáÏÂÀ´´ó¸Å×öÁËÒÔϼ¸¼þÊ£º +以上方法有点长,总结下æ�¥å¤§æ¦‚å�šäº†ä»¥ä¸‹å‡ ä»¶äº‹ï¼š -1. »ñÈ¡ËùÓÐ `BeanDefinition` µÄÃû³ÆÕâ²½Ö´ÐÐÍê³Éºó£¬½á¹ûÈçÏ£º +1. 获å�–所有 `BeanDefinition` çš„å��称这步执行完æˆ�å�Žï¼Œç»“果如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-df320c2911c4222a6867a0f0a4fe7d9987d.png) -2. Ñ­»· `candidateNames` Êý×飬±êʶÅäÖÃÀàµÄÀàÐÍΪ `Full` »¹ÊÇ `Lite`£¬ÕâÒ»²½Ëù×öµÄ¹¤×÷¾ÍÊǶÔÅäÖÃÀà¶ÔÓ¦µÄ `BeanDefinition` ½øÐбêʶ£¨ÖÁÓÚ±êʶºóÓÐʲô×÷Óã¬ÔÚºóÃæ·ÖÎö `@Configuration` ×¢½âʱ»áÔÙ·ÖÎö£©£¬`beanConfigs` ûÓÐ `@Configuration` ×¢½â£¬Òò´ËÊÇ `Lite` ÅäÖÃÀà¡£ÕâÒ»²½µÃµ½µÄ `configCandidates` ÈçÏ£º +2. 循环 `candidateNames` 数组,标识é…�置类的类型为 `Full` 还是 `Lite`,这一步所å�šçš„工作就是对é…�置类对应的 `BeanDefinition` 进行标识(至于标识å�Žæœ‰ä»€ä¹ˆä½œç”¨ï¼Œåœ¨å�Žé�¢åˆ†æž� `@Configuration` 注解时会å†�分æž�),`beanConfigs` 没有 `@Configuration` 注解,因此是 `Lite` é…�置类。这一步得到的 `configCandidates` 如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-81a68ec905807d77153158af4c86d48a1d3.png) -3. ½âÎöÅäÖÃÀ࣬¼´½âÎö `@Component`£¬`@PropertySources`£¬`@ComponentScans`£¬`@ImportResource` µÈ×¢½â±ê×¢µÄÀ࣬Õâ¸ö·½·¨·Ç³£ÖØÒª£¬ÏÂÃæ»áÖØµã·ÖÎö£» +3. è§£æž�é…�置类,å�³è§£æž� `@Component`,`@PropertySources`,`@ComponentScans`,`@ImportResource` 等注解标注的类,这个方法é�žå¸¸é‡�è¦�,下é�¢ä¼šé‡�点分æž�ï¼› -4. ´¦Àí±¾´Î½âÎöµÄÀ࣬°Ñ @Import ÒýÈëµÄÀà¡¢ÅäÖÃÀàÖдø @Bean µÄ·½·¨¡¢@ImportResource ÒýÈëµÄ×ÊÔ´µÈת»»³É BeanDefinition£¬¼ÓÔØµ½ `BeanDefinitionMap` ÖУ» +4. 处ç�†æœ¬æ¬¡è§£æž�的类,把 @Import 引入的类ã€�é…�置类中带 @Bean 的方法ã€�@ImportResource 引入的资æº�等转æ�¢æˆ� BeanDefinition,加载到 `BeanDefinitionMap` 中; -5. ´¦Àí·µ»Ø½á¹û£¬Èç¹ûÐÂÌí¼ÓµÄÀàΪ `Full` ÅäÖÃÀ࣬ÇÒδ½âÎö¹ý£¬¾Í°ÑËüÌí¼Óµ½ `candidates` ÖУ¬ÔÚÏ´ÎÑ­»·Ê±ÔÙ½âÎö¡£ +5. 处ç�†è¿”回结果,如果新添加的类为 `Full` é…�置类,且未解æž�过,就把它添加到 `candidates` 中,在下次循环时å†�è§£æž�。 -ÒÔÉÏ·½·¨µÄÁ÷³Ì¾ÍÕâÑùÁË£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´¿´¿´ÅäÖÃÀàµÄ½âÎö£¬Ò²¾ÍÊÇÉÏÊöµÄµÚ 3 ²½¡£ +以上方法的æµ�程就这样了,接下æ�¥æˆ‘们就æ�¥çœ‹çœ‹é…�置类的解æž�,也就是上述的第 3 步。 -### 2.4 ½âÎö£º`ConfigurationClassParser#parse(Set)` +### 2.4 è§£æž�:`ConfigurationClassParser#parse(Set)` ``` public void parse(Set configCandidates) { - // Ñ­»·´«½øÀ´µÄÅäÖÃÀà + // 循环传进æ�¥çš„é…�置类 for (BeanDefinitionHolder holder : configCandidates) { BeanDefinition bd = holder.getBeanDefinition(); try { - // Èç¹û»ñµÃBeanDefinitionÊÇAnnotatedBeanDefinitionµÄʵÀý - // Ç°ÃæµÃµ½µÄ beanConfigs¾ÍÊÇAnnotatedBeanDefinitionµÄʵÀý£¬ifÀïµÄ·½·¨»áÖ´ÐÐ + // 如果获得BeanDefinition是AnnotatedBeanDefinition的实例 + // å‰�é�¢å¾—到的 beanConfigs就是AnnotatedBeanDefinition的实例,if里的方法会执行 if (bd instanceof AnnotatedBeanDefinition) { parse(((AnnotatedBeanDefinition) bd).getMetadata(), holder.getBeanName()); } @@ -365,38 +365,38 @@ public void parse(Set configCandidates) { } /** - * µ÷ÓÃparse½øÐнâÎö + * 调用parse进行解æž� */ protected final void parse(AnnotationMetadata metadata, String beanName) throws IOException { - // ConfigurationClass£ºmetadataÓëbeanNameµÄ°ü×°Àà + // ConfigurationClass:metadata与beanName的包装类 processConfigurationClass(new ConfigurationClass(metadata, beanName)); } ``` -Ç°Ãæ´«ÈëµÄ `BeanConfigs` »á±»°ü×°³É `AnnotatedGenericBeanDefinition`£¬ËüÊÇ `AnnotatedBeanDefinition` µÄʵÀý£¬È»ºó¾Í»áµ÷Óà `ConfigurationClassParser#parse(String, String)`£¬ÕâÀïÆäʵ²¢Ã»×öʲôʵÖÊÐԵŤ×÷£¬¼ÌÐø½øÈë `processConfigurationClass(...)` ·½·¨£º +å‰�é�¢ä¼ å…¥çš„ `BeanConfigs` 会被包装æˆ� `AnnotatedGenericBeanDefinition`,它是 `AnnotatedBeanDefinition` 的实例,然å�Žå°±ä¼šè°ƒç”¨ `ConfigurationClassParser#parse(String, String)`,这里其实并没å�šä»€ä¹ˆå®žè´¨æ€§çš„工作,继续进入 `processConfigurationClass(...)` 方法: ``` /** - * Õâ¸ö·½·¨ÊÇÔÚÅжÏÌõ¼þ£¬±£Ö¤ÅäÖÃÀà²»ÖØ¸´½âÎö - * ʵ¼Ê¸É»îµÄÊÇ doProcessConfigurationClass(...) + * 这个方法是在判断æ�¡ä»¶ï¼Œä¿�è¯�é…�置类ä¸�é‡�å¤�è§£æž� + * 实际干活的是 doProcessConfigurationClass(...) */ protected void processConfigurationClass(ConfigurationClass configClass) throws IOException { - // ÅжÏÊÇ·ñÐèÒªÌø¹ý´¦Àí£¬Õë¶ÔÓÚ @Conditional ×¢½â£¬ÅжÏÊÇ·ñÂú×ãÌõ¼þ + // 判断是å�¦éœ€è¦�跳过处ç�†ï¼Œé’ˆå¯¹äºŽ @Conditional 注解,判断是å�¦æ»¡è¶³æ�¡ä»¶ if (this.conditionEvaluator.shouldSkip(configClass.getMetadata() , ConfigurationPhase.PARSE_CONFIGURATION)) { return; } ConfigurationClass existingClass = this.configurationClasses.get(configClass); - // ÅжÏÊÇ·ñ½âÎö¹ý£¬½âÎö¹ý¾Í²»½âÎöÁË£¬Óë½âÎöÄÚÈݹØÏµ²»´ó£¬Ê¡ÂÔ + // 判断是å�¦è§£æž�过,解æž�过就ä¸�è§£æž�了,与解æž�内容关系ä¸�大,çœ�ç•¥ if (existingClass != null) { ... } - // SourceClass Í¬Ç°ÃæµÄ ConfigurationClass Ò»Ñù£¬Ò²ÊǶÔmetadataÓëbeanNameµÄ°ü×° + // SourceClass å�Œå‰�é�¢çš„ ConfigurationClass 一样,也是对metadata与beanName的包装 SourceClass sourceClass = asSourceClass(configClass); do { - // doXxx(...) ·½·¨²ÅÊÇÕæÕý¸É»îµÄ - // Èç¹û·µ»ØµÄÄÚÈݲ»Îª¿Õ£¬ÏÂÃæ»áÔÙ´ÎÑ­»· + // doXxx(...) 方法æ‰�是真正干活的 + // 如果返回的内容ä¸�为空,下é�¢ä¼šå†�次循环 sourceClass = doProcessConfigurationClass(configClass, sourceClass); } while (sourceClass != null); @@ -405,63 +405,63 @@ protected void processConfigurationClass(ConfigurationClass configClass) throws ``` -Õâ¸ö·½·¨ÏÈÅжÏÅäÖÃÀàÊÇ·ñÂú×ãÖ´ÐÐÌõ¼þ£¬È»ºóÔÚ `do-while` Ñ­»·ÖÐÖ´ÐÐ `doProcessConfigurationClass(...)`£¬Ñ­»·Ìõ¼þÊÇ `doProcessConfigurationClass(...)` ·µ»ØµÄÄÚÈݲ»Îª¿Õ£¬ÎÒÃǼÌÐøÍùÏ¿´¡£ +这个方法先判断é…�置类是å�¦æ»¡è¶³æ‰§è¡Œæ�¡ä»¶ï¼Œç„¶å�Žåœ¨ `do-while` 循环中执行 `doProcessConfigurationClass(...)`,循环æ�¡ä»¶æ˜¯ `doProcessConfigurationClass(...)` 返回的内容ä¸�为空,我们继续往下看。 -### 2.5 ½âÎöÅäÖÃÀࣺ`ConfigurationClassParser#doProcessConfigurationClass` +### 2.5 è§£æž�é…�置类:`ConfigurationClassParser#doProcessConfigurationClass` ``` /** - * Õâ¸ö·½·¨²ÅÊÇÕæÕý´¦Àí½âÎöµÄ·½·¨ + * 这个方法æ‰�是真正处ç�†è§£æž�的方法 */ protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass) throws IOException { - // 1\. Èç¹ûÊÇ @Component ×¢½â£¬µÝ¹é´¦ÀíÄÚ²¿À࣬±¾ÎIJ»¹Ø×¢ + // 1\. 如果是 @Component 注解,递归处ç�†å†…部类,本文ä¸�关注 ... - // 2\. ´¦Àí@PropertySource×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 2\. 处ç�†@PropertySource注解,本文ä¸�关注 ... - // 3\. ´¦Àí @ComponentScan/@ComponentScans ×¢½â - // 3.1 »ñÈ¡ÅäÖÃÀàÉ쵀 @ComponentScan/@ComponentScans ×¢½â + // 3\. 处ç�† @ComponentScan/@ComponentScans 注解 + // 3.1 获å�–é…�置类上的 @ComponentScan/@ComponentScans 注解 Set componentScans = AnnotationConfigUtils.attributesForRepeatable( sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class); - // Èç¹ûûÓдòÉÏComponentScan£¬»òÕß±»@ConditionÌõ¼þÌø¹ý£¬¾Í²»ÔÙ½øÈëÕâ¸öif + // 如果没有打上ComponentScan,或者被@Conditionæ�¡ä»¶è·³è¿‡ï¼Œå°±ä¸�å†�进入这个if if (!componentScans.isEmpty() && !this.conditionEvaluator .shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) { - // Ñ­»·´¦ÀícomponentScans£¬Ò²¾ÍÊÇÅäÖÃÀàÉϵÄËùÓÐ@ComponentScan×¢½âµÄÄÚÈÝ + // 循环处ç�†componentScans,也就是é…�置类上的所有@ComponentScan注解的内容 for (AnnotationAttributes componentScan : componentScans) { - // 3.2 componentScanParser.parse(...)£º¾ßÌå½âÎöcomponentScanµÄ²Ù×÷ - // componentScan¾ÍÊÇ@ComponentScanÉϵľßÌåÄÚÈÝ£¬ - // sourceClass.getMetadata().getClassName()¾ÍÊÇÅäÖÃÀàµÄÃû³Æ + // 3.2 componentScanParser.parse(...):具体解æž�componentScançš„æ“�作 + // componentScan就是@ComponentScan上的具体内容, + // sourceClass.getMetadata().getClassName()就是é…�置类的å��ç§° Set scannedBeanDefinitions = this.componentScanParser .parse(componentScan, sourceClass.getMetadata().getClassName()); - // 3.3 Ñ­»·µÃµ½µÄ BeanDefinition£¬Èç¹û¶ÔÓ¦µÄÀàÊÇÅäÖÃÀ࣬µÝ¹éµ÷ÓÃparse(...)·½·¨ - // componentScanÒýÈëµÄÀà¿ÉÄÜÓб»@Bean±ê¼ÇµÄ·½·¨£¬»òÕßÓÐ@ComponentScan×¢½â + // 3.3 循环得到的 BeanDefinition,如果对应的类是é…�置类,递归调用parse(...)方法 + // componentScan引入的类å�¯èƒ½æœ‰è¢«@Bean标记的方法,或者有@ComponentScan注解 for (BeanDefinitionHolder holder : scannedBeanDefinitions) { BeanDefinition bdCand = holder.getBeanDefinition().getOriginatingBeanDefinition(); if (bdCand == null) { bdCand = holder.getBeanDefinition(); } - // ÅжÏBeanDefinition¶ÔÓ¦µÄÀàÊÇ·ñΪÅäÖÃÀà + // 判断BeanDefinition对应的类是å�¦ä¸ºé…�置类 if (ConfigurationClassUtils .checkConfigurationClassCandidate(bdCand, this.metadataReaderFactory)) { - // ¶ÔµÃµ½µÄÀ࣬µ÷ÓÃparse(...)·½·¨£¬ÔٴνøÐнâÎö + // 对得到的类,调用parse(...)方法,å†�次进行解æž� parse(bdCand.getBeanClassName(), holder.getBeanName()); } } } } - // 4\. ´¦Àí@Import×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 4\. 处ç�†@Import注解,本文ä¸�关注 ... - // 5\. ´¦Àí@ImportResource×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 5\. 处ç�†@ImportResource注解,本文ä¸�关注 ... - // 6\. ´¦Àí@BeanµÄ×¢½â£¬£¬±¾ÎIJ»¹Ø×¢ + // 6\. 处ç�†@Bean的注解,,本文ä¸�关注 ... - // 7\. ·µ»ØÅäÖÃÀàµÄ¸¸À࣬»áÔÚ processConfigurationClass(...) ·½·¨µÄÏÂÒ»´ÎÑ­»·Ê±½âÎö - // sourceClass.getMetadata()¾ÍÊÇÅäÖÃÀà + // 7\. 返回é…�置类的父类,会在 processConfigurationClass(...) 方法的下一次循环时解æž� + // sourceClass.getMetadata()就是é…�置类 if (sourceClass.getMetadata().hasSuperClass()) { String superclass = sourceClass.getMetadata().getSuperClassName(); if (superclass != null && !superclass.startsWith("java") && @@ -474,42 +474,42 @@ protected final SourceClass doProcessConfigurationClass(ConfigurationClass confi } /** - * Õâ¸ö·½·¨»áÔٴε÷ÓÃprocessConfigurationClass(...)·½·¨½øÐнâÎö - * Ä¿µÄÊÇ£¬ÐÂÒýÈëµÄÀàÒ²ÓпÉÄÜÓб»@Bean±ê¼ÇµÄ·½·¨£¬»òÕßÓÐComponentScanµÈ×¢½â + * 这个方法会å†�次调用processConfigurationClass(...)方法进行解æž� + * 目的是,新引入的类也有å�¯èƒ½æœ‰è¢«@Bean标记的方法,或者有ComponentScan等注解 */ protected final void parse(@Nullable String className, String beanName) throws IOException { Assert.notNull(className, "No bean class name for configuration class bean definition"); MetadataReader reader = this.metadataReaderFactory.getMetadataReader(className); - // ÓÖµ÷»Ø processConfigurationClass(...) ·½·¨ÁË + // å�ˆè°ƒå›ž processConfigurationClass(...) 方法了 processConfigurationClass(new ConfigurationClass(reader, beanName)); } ``` -`ConfigurationClassParser#doProcessConfigurationClass` Õâ¸ö·½·¨¾ÍÊÇ¶Ô `@PropertySource`¡¢`@ComponentScan`¡¢`@Import`¡¢`@ImportResource`¡¢`@Bean` µÈ×¢½â£¬±¾ÎÄÎÒÃǽö¹Ø×¢ `@ComponentScan` ×¢½âµÄ´¦Àí£¬Á÷³ÌÈçÏ£º +`ConfigurationClassParser#doProcessConfigurationClass` 这个方法就是对 `@PropertySource`ã€�`@ComponentScan`ã€�`@Import`ã€�`@ImportResource`ã€�`@Bean` 等注解,本文我们仅关注 `@ComponentScan` 注解的处ç�†ï¼Œæµ�程如下: -1. »ñÈ¡ÅäÖÃÀàÉ쵀 `@ComponentScan/@ComponentScans` ×¢½â£» -2. `componentScanParser.parse(...)`£º¾ßÌå½âÎö `componentScan` µÄ²Ù×÷£¬ºóÃæ»áÖØµã·ÖÎö£» -3. Ñ­»·µÃµ½µÄ `BeanDefinition`£¬Èç¹û¶ÔÓ¦µÄÀàÊÇÅäÖÃÀ࣬µÝ¹éµ÷Óà `parse(...)` ·½·¨£¬Èç¹ûɨÃèµ½µÄÀà°üº¬ `@Import`¡¢`@Bean`¡¢`@ComponentScan` µÈ×¢½â£¬µÝ¹éµ÷Óà `parse(...)` ·½·¨Ê±»á±»½âÎöµ½¡£ +1. 获å�–é…�置类上的 `@ComponentScan/@ComponentScans` 注解; +2. `componentScanParser.parse(...)`:具体解æž� `componentScan` çš„æ“�作,å�Žé�¢ä¼šé‡�点分æž�ï¼› +3. 循环得到的 `BeanDefinition`,如果对应的类是é…�置类,递归调用 `parse(...)` 方法,如果扫æ��到的类包å�« `@Import`ã€�`@Bean`ã€�`@ComponentScan` 等注解,递归调用 `parse(...)` 方法时会被解æž�到。 -ÉÏÃæµÄ²Ù×÷Á÷³ÌÔÚ´úÂëÖÐÒѾ­×¢Ê͵úÜÇå³þÁË£¬¾Í²»¶à˵ÁË£¬ÎÒÃÇÖ±½ÓÀ´¿´ `@ComponentScan` µÄ½âÎö²Ù×÷. +上é�¢çš„æ“�作æµ�程在代ç �中已ç»�注释得很清楚了,就ä¸�多说了,我们直接æ�¥çœ‹ `@ComponentScan` 的解æž�æ“�作. -### 2.6 ÕæÕý½âÎöµÄµØ·½£º`ComponentScanAnnotationParser#parse` +### 2.6 真正解æž�的地方:`ComponentScanAnnotationParser#parse` -`@ComponentScan` µÄ½âÎöÔÚ `ComponentScanAnnotationParser#parse` ·½·¨ÖУ¬´úÂëÈçÏ£º +`@ComponentScan` 的解æž�在 `ComponentScanAnnotationParser#parse` 方法中,代ç �如下: ``` public Set parse(AnnotationAttributes componentScan, final String declaringClass) { - // 1\. ¶¨ÒåÒ»¸öɨÃèÆ÷£¬ÓÃÀ´É¨Ãè°ü + // 1\. 定义一个扫æ��器,用æ�¥æ‰«æ��包 ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(this.registry, componentScan.getBoolean("useDefaultFilters"), this.environment, this.resourceLoader); - // 2\. ÅжÏÊÇ·ñÖØÐ´ÁËĬÈϵÄÃüÃû¹æÔò + // 2\. 判断是å�¦é‡�写了默认的命å��规则 Class generatorClass = componentScan.getClass("nameGenerator"); boolean useInheritedGenerator = (BeanNameGenerator.class == generatorClass); scanner.setBeanNameGenerator(useInheritedGenerator ? this.beanNameGenerator : BeanUtils.instantiateClass(generatorClass)); - // 3\. ½âÎö @ComponentScan ×¢½âµÄÊôÐÔ - // 3.1 ´¦Àí @ComponentScan µÄ scopedProxy ÊôÐÔ + // 3\. è§£æž� @ComponentScan 注解的属性 + // 3.1 处ç�† @ComponentScan çš„ scopedProxy 属性 ScopedProxyMode scopedProxyMode = componentScan.getEnum("scopedProxy"); if (scopedProxyMode != ScopedProxyMode.DEFAULT) { scanner.setScopedProxyMode(scopedProxyMode); @@ -518,17 +518,17 @@ public Set parse(AnnotationAttributes componentScan, final Class resolverClass = componentScan.getClass("scopeResolver"); scanner.setScopeMetadataResolver(BeanUtils.instantiateClass(resolverClass)); } - // 3.2 ´¦Àí @ComponentScan µÄ resourcePattern ÊôÐÔ + // 3.2 处ç�† @ComponentScan çš„ resourcePattern 属性 scanner.setResourcePattern(componentScan.getString("resourcePattern")); - // 3.3 ´¦Àí @ComponentScan µÄ includeFilters ÊôÐÔ - // addIncludeFilter addExcludeFilter,×îÖÕÊÇÍùListÀïÃæÌî³äÊý¾Ý + // 3.3 处ç�† @ComponentScan çš„ includeFilters 属性 + // addIncludeFilter addExcludeFilter,最终是往List里é�¢å¡«å……æ•°æ�® for (AnnotationAttributes filter : componentScan.getAnnotationArray("includeFilters")) { for (TypeFilter typeFilter : typeFiltersFor(filter)) { scanner.addIncludeFilter(typeFilter); } } - // 3.4 ´¦Àí @ComponentScan µÄ excludeFilters ÊôÐÔ + // 3.4 处ç�† @ComponentScan çš„ excludeFilters 属性 for (AnnotationAttributes filter : componentScan.getAnnotationArray("excludeFilters")) { for (TypeFilter typeFilter : typeFiltersFor(filter)) { scanner.addExcludeFilter(typeFilter); @@ -539,54 +539,54 @@ public Set parse(AnnotationAttributes componentScan, final scanner.getBeanDefinitionDefaults().setLazyInit(true); } Set basePackages = new LinkedHashSet<>(); - // 3.5\. @ComponentScan Ö¸¶¨ÁË basePackages ÊôÐÔ£¬Õâ¸öÊôÐÔµÄÀàÐÍÊÇString + // 3.5\. @ComponentScan 指定了 basePackages 属性,这个属性的类型是String String[] basePackagesArray = componentScan.getStringArray("basePackages"); for (String pkg : basePackagesArray) { String[] tokenized = StringUtils.tokenizeToStringArray(this.environment.resolvePlaceholders(pkg), ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS); Collections.addAll(basePackages, tokenized); } - // 3.6\. @ComponentScan Ö¸¶¨ÁË basePackageClasses£¬ Õâ¸öÊôÐÔµÄÀàÐÍÊÇClass£¬ - // ¼´Ö»ÒªÊÇÓëÕ⼸¸öÀàͬ¼¶µÄ£¬»òÕßÔÚÕ⼸¸öÀàϼ¶µÄ¶¼¿ÉÒÔ±»É¨Ãèµ½ + // 3.6\. @ComponentScan 指定了 basePackageClasses, 这个属性的类型是Class, + // å�³å�ªè¦�是与这几个类å�Œçº§çš„,或者在这几个类下级的都å�¯ä»¥è¢«æ‰«æ��到 for (Class clazz : componentScan.getClassArray("basePackageClasses")) { basePackages.add(ClassUtils.getPackageName(clazz)); } - // 3.7 ÒÔÉ϶¼Ã»ÓÐÖ¸¶¨£¬Ä¬ÈÏ»á°ÑÅäÖÃÀàËùÔڵİüÃû×÷ΪɨÃè·¾¶ + // 3.7 以上都没有指定,默认会把é…�置类所在的包å��作为扫æ��路径 if (basePackages.isEmpty()) { basePackages.add(ClassUtils.getPackageName(declaringClass)); } - // 3.8 Ìí¼ÓÅųý¹æÔò£¬ÕâÀï¾Í°Ñ×¢²áÀà×ÔÉíµ±×÷Åųý¹æÔò£¬ÕæÕýÖ´ÐÐÆ¥ÅäµÄʱºò£¬»á°Ñ×ÔÉí¸øÅųý + // 3.8 添加排除规则,这里就把注册类自身当作排除规则,真正执行匹é…�的时候,会把自身给排除 scanner.addExcludeFilter(new AbstractTypeHierarchyTraversingFilter(false, false) { @Override protected boolean matchClassName(String className) { return declaringClass.equals(className); } }); - // 4\. µ½ÕâÀ²Å¿ªÊ¼É¨Ãè @ComponentScan Ö¸¶¨µÄ°ü - // ɨÃèÍê³Éºó£¬¶Ô·ûºÏÌõ¼þµÄÀ࣬spring»á½«ÆäÌí¼Óµ½beanFactoryµÄBeanDefinitionMapÖÐ + // 4\. 到这里,æ‰�开始扫æ�� @ComponentScan 指定的包 + // 扫æ��完æˆ�å�Žï¼Œå¯¹ç¬¦å�ˆæ�¡ä»¶çš„类,spring会将其添加到beanFactoryçš„BeanDefinitionMap中 return scanner.doScan(StringUtils.toStringArray(basePackages)); } ``` -ÒÔÉÏ·½·¨Ö´ÐÐÁ÷³ÌÈçÏ£º +以上方法执行æµ�程如下: -1. ¶¨ÒåÒ»¸öɨÃèÆ÷£¬ÓÃÀ´É¨Ãè°ü -2. ÅжÏÊÇ·ñÖØÐ´ÁËĬÈϵÄÃüÃû¹æÔò -3. ½âÎö `@ComponentScan` ×¢½âµÄÊôÐÔ£¬ÍêɯɍÃèÆ÷ - 1. ´¦Àí `@ComponentScan` µÄ `scopedProxy` ÊôÐÔ - 2. ´¦Àí `@ComponentScan` µÄ `resourcePattern` ÊôÐÔ - 3. ´¦Àí `@ComponentScan` µÄ `includeFilters` ÊôÐÔ - 4. ´¦Àí `@ComponentScan` µÄ `excludeFilters` ÊôÐÔ - 5. ´¦Àí `@ComponentScan` µÄ `basePackages` ÊôÐÔ£¬Õâ¸öÊôÐÔµÄÀàÐÍÊÇ `String` - 6. ´¦Àí `@ComponentScan` µÄ `basePackageClasses` ÊôÐÔ£¬ Õâ¸öÊôÐÔµÄÀàÐÍÊÇ `Class` - 7. Èç¹ûûÓÐÖ¸¶¨É¨°ü¹æÔò£¬Ä¬ÈÏ»á°ÑÅäÖÃÀàËùÔڵİüÃû×÷ΪɨÃè·¾¶ - 8. Ìí¼ÓÅųý¹æÔò£¬ÕâÀï¾Í°Ñ×¢²áÀà×ÔÉíµ±×÷Åųý¹æÔò£¬ÕæÕýÖ´ÐÐÆ¥ÅäµÄʱºò£¬»á°Ñ×ÔÉí¸øÅųý -4. µ÷Óà `ClassPathBeanDefinitionScanner#doScan` Íê³ÉɨÃè +1. 定义一个扫æ��器,用æ�¥æ‰«æ��包 +2. 判断是å�¦é‡�写了默认的命å��规则 +3. è§£æž� `@ComponentScan` 注解的属性,完善扫æ��器 + 1. 处ç�† `@ComponentScan` çš„ `scopedProxy` 属性 + 2. 处ç�† `@ComponentScan` çš„ `resourcePattern` 属性 + 3. 处ç�† `@ComponentScan` çš„ `includeFilters` 属性 + 4. 处ç�† `@ComponentScan` çš„ `excludeFilters` 属性 + 5. 处ç�† `@ComponentScan` çš„ `basePackages` 属性,这个属性的类型是 `String` + 6. 处ç�† `@ComponentScan` çš„ `basePackageClasses` 属性, 这个属性的类型是 `Class` + 7. 如果没有指定扫包规则,默认会把é…�置类所在的包å��作为扫æ��路径 + 8. 添加排除规则,这里就把注册类自身当作排除规则,真正执行匹é…�的时候,会把自身给排除 +4. 调用 `ClassPathBeanDefinitionScanner#doScan` 完æˆ�扫æ�� -×îÖÕ£¬µ÷ÓÃÁË `ClassPathBeanDefinitionScanner#doScan` ·½·¨À´Íê³É°üµÄÃèÊö£¬Õâ¸ö·½·¨ÎÒÃÇÔÚ [spring Æô¶¯Á÷³ÌÖ®°üµÄɨÃèÁ÷³Ì](https://my.oschina.net/funcy/blog/4614071)ÒѾ­Ïêϸ·ÖÎö¹ýÁË£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË¡£ +最终,调用了 `ClassPathBeanDefinitionScanner#doScan` 方法æ�¥å®Œæˆ�包的æ��述,这个方法我们在 [spring å�¯åЍæµ�程之包的扫æ��æµ�程](https://my.oschina.net/funcy/blog/4614071)å·²ç»�详细分æž�过了,这里就ä¸�å†�分æž�了。 -ÈÃÎÒÃǻص½ `ConfigurationClassPostProcessor#processConfigBeanDefinitions` ·½·¨£º +让我们回到 `ConfigurationClassPostProcessor#processConfigBeanDefinitions` 方法: ``` public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { @@ -597,26 +597,26 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { ``` -Ö´ÐÐǰ£º +执行å‰�: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-85e400f7d45b4fe5e2353e359f034b1a726.png) -Ö´ÐÐºó£º +执行å�Žï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a6d02c305f562414326ca7836c281ebf472.png) -¿ÉÒÔ¿´µ½£¬`BeanObj1`¡¢`BeanObj2` ÒѾ­·ÅÈëÁË `BeanFactory` µÄ `BeanDefinitionMap` ÖÐÁË ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`BeanObj1`ã€�`BeanObj2` å·²ç»�放入了 `BeanFactory` çš„ `BeanDefinitionMap` 中了 。 -### 2.7 ×ܽá +### 2.7 总结 -spring ´¦Àí `@ComponentScan` µÄÁ÷³Ìµ½ÕâÀï¾Í½áÊøÁË£¬½âÎöÁ÷³ÌλÓÚ `ConfigurationClassParser#doProcessConfigurationClass` ·½·¨£¬Õâ¸ö·½·¨³ýÁ˽âÎö `@ComponentScan`£¬»¹»á½âÎö `@Bean`¡¢`@Import` µÈ×¢½â£¬±¾ÎÄÖ»·ÖÎö `@ComponentScan` µÄ´¦ÀíÁ÷³Ì£¬¶ÔÒÔÉÏÁ÷³Ì×ܽáÈçÏ£º +spring 处ç�† `@ComponentScan` çš„æµ�程到这里就结æ�Ÿäº†ï¼Œè§£æž�æµ�程ä½�于 `ConfigurationClassParser#doProcessConfigurationClass` 方法,这个方法除了解æž� `@ComponentScan`,还会解æž� `@Bean`ã€�`@Import` 等注解,本文å�ªåˆ†æž� `@ComponentScan` 的处ç�†æµ�程,对以上æµ�程总结如下: -1. »ñÈ¡ÅäÖÃÀàÉ쵀 `@ComponentScan/@ComponentScans` ×¢½â -2. ½øÐнâÎö `@ComponentScan` µÄ²Ù×÷£¬½âÎöʱ£¬Ïȶ¨ÒåÁËÒ»¸öÃèÊöÆ÷£¬È»ºó¸ù¾Ý `@ComponentScan` µÄÊôÐÔ£¬¶ÔÃèÊöÆ÷Æ÷½øÐÐÊôÐÔÌî³ä£¬´¦ÀíÍêÕâЩ֮ºó£¬¾Í¿ªÊ¼½øÐаüɨÃè²Ù×÷£» -3. ±éÀúɨÃèµÃµ½µÄÀ࣬Èç¹ûÆäΪÅäÖÃÀ࣬»áͨ¹ýµ÷Óà `parse(...)` ·½·¨ÔÙÒ»´Îµ÷Óà `ConfigurationClassParser#doProcessConfigurationClass` ½øÐнâÎö£¬ÕâÒ»µã·Ç³£ÖØÒª£¬Õâ¾Í±£Ö¤ÁËɨÃèµÃµ½µÄÀàÖÐµÄ `@Bean`¡¢`@Import`¡¢`@ComponentScan` µÈ×¢½âµÃµ½½âÎö¡£ +1. 获å�–é…�置类上的 `@ComponentScan/@ComponentScans` 注解 +2. 进行解æž� `@ComponentScan` çš„æ“�作,解æž�时,先定义了一个æ��述器,然å�Žæ ¹æ�® `@ComponentScan` 的属性,对æ��述器器进行属性填充,处ç�†å®Œè¿™äº›ä¹‹å�Žï¼Œå°±å¼€å§‹è¿›è¡ŒåŒ…扫æ��æ“�作; +3. é��历扫æ��得到的类,如果其为é…�置类,会通过调用 `parse(...)` 方法å†�一次调用 `ConfigurationClassParser#doProcessConfigurationClass` 进行解æž�,这一点é�žå¸¸é‡�è¦�,这就ä¿�è¯�了扫æ��得到的类中的 `@Bean`ã€�`@Import`ã€�`@ComponentScan` 等注解得到解æž�。 -ºÃÁË£¬±¾ÎľÍÏȵ½ÕâÀïÁË£¬½ÓÏÂÀ´¼¸ÆªÎÄÕ»á¼ÌÐø·ÖÎö `ConfigurationClassPostProcessor` ¶ÔÆäËû×¢½âµÄ´¦Àí¡£ +好了,本文就先到这里了,接下æ�¥å‡ ç¯‡æ–‡ç« ä¼šç»§ç»­åˆ†æž� `ConfigurationClassPostProcessor` 对其他注解的处ç�†ã€‚ * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4836178](https://my.oschina.net/funcy/blog/4836178) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4836178](https://my.oschina.net/funcy/blog/4836178) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\211\357\274\211\357\274\232\345\244\204\347\220\206@Import\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\211\357\274\211\357\274\232\345\244\204\347\220\206@Import\346\263\250\350\247\243.md" index ad1a70a..966c487 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\211\357\274\211\357\274\232\345\244\204\347\220\206@Import\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\270\211\357\274\211\357\274\232\345\244\204\347\220\206@Import\346\263\250\350\247\243.md" @@ -1,12 +1,12 @@ -±¾ÎÄÊÇ `ConfigurationClassPostProcessor` ·ÖÎöµÄµÚÈýƪ£¬Ö÷ÒªÊÇ·ÖÎö spring ¶Ô `@Import` ×¢½âµÄ´¦ÀíÁ÷³Ì¡£ +本文是 `ConfigurationClassPostProcessor` 分æž�的第三篇,主è¦�是分æž� spring 对 `@Import` 注解的处ç�†æµ�程。 -## 4. spring ÊÇÈçºÎ´¦Àí @Import ×¢½âµÄ£¿ +## 4. spring 是如何处ç�† @Import 注解的? -³Ð½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö spring ¶Ô `@Import` ×¢½âµÄ´¦ÀíÁ÷³Ì¡£ +承接上文,我们继续分æž� spring 对 `@Import` 注解的处ç�†æµ�程。 -### 4.1 Á˽â `@Import` ×¢½â +### 4.1 了解 `@Import` 注解 -ÎÒÃÇÀ´¿´Ï `@Import` ×¢½âµÄ¶¨Ò壺 +我们æ�¥çœ‹ä¸‹ `@Import` 注解的定义: ``` @Target(ElementType.TYPE) @@ -21,18 +21,18 @@ public @interface Import { } ``` -`@Import` ÀïÓÐÒ»¸ö·½·¨£º`value()`£¬Ö§³ÖµÄÀàÐÍÊÇ `Class`£¬´ÓÉÏÃæµÄÎĵµÀ´¿´£¬¿ÉÒÔÖ§³ÖÀàÐÍÓÐ 4 ÖÖ£º +`@Import` 里有一个方法:`value()`,支æŒ�的类型是 `Class`,从上é�¢çš„æ–‡æ¡£æ�¥çœ‹ï¼Œå�¯ä»¥æ”¯æŒ�类型有 4 ç§�: -- ±» `@Configuration` ×¢½â±ê¼ÇµÄÀà -- ʵÏÖÁË `ImportSelector` µÄÀà -- ʵÏÖÁË `ImportBeanDefinitionRegistrar` µÄÀà -- ÆÕͨÀà +- 被 `@Configuration` 注解标记的类 +- 实现了 `ImportSelector` 的类 +- 实现了 `ImportBeanDefinitionRegistrar` 的类 +- 普通类 -½ÓÏÂÀ´£¬ÎÒÃÇͨ¹ýÒ»¸ö demo À´Õ¹Ê¾Ê¹Óà `@Import` ÈçºÎ½«ÕâËÄÖÖÀർÈëµ½ spring ÖС£ +接下æ�¥ï¼Œæˆ‘们通过一个 demo æ�¥å±•示使用 `@Import` 如何将这四ç§�类导入到 spring 中。 -### 4.2 demo ×¼±¸ +### 4.2 demo 准备 -1. Ê×ÏÈ×¼±¸ 4 ¸ö bean£º +1. 首先准备 4 个 bean: ``` /** @@ -72,15 +72,15 @@ public class Element04 { } ``` -1. ×¼±¸ÊµÏÖ `ImportBeanDefinitionRegistrar` µÄÀ࣬½« `element02` ×¢ÈëÆäÖÐ +1. 准备实现 `ImportBeanDefinitionRegistrar` 的类,将 `element02` 注入其中 ``` public class Element02ImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar { /** - * ÔÚ registerBeanDefinitions ÖÐ×¢²áelement02¶ÔÓ¦µÄBeanDefinition - * Ò²¾ÍÊÇ°Ñ Element02 ¶ÔÓ¦µÄ beanDefinition ÊÖ¶¯×¢²áµ½beanFactory - * µÄ beanDefinitionMap ÖÐ + * 在 registerBeanDefinitions 中注册element02对应的BeanDefinition + * 也就是把 Element02 对应的 beanDefinition 手动注册到beanFactory + * çš„ beanDefinitionMap 中 */ @Override public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, @@ -90,13 +90,13 @@ public class Element02ImportBeanDefinitionRegistrar implements ImportBeanDefinit } ``` -1. ×¼±¸ÊµÏÖ `ImportSelector` µÄÀ࣬ÔÚ `selectImports(...)` ·½·¨ÖУ¬·µ»Ø `Element03` µÄ "°üÃû¡£ÀàÃû" +1. 准备实现 `ImportSelector` 的类,在 `selectImports(...)` 方法中,返回 `Element03` çš„ "包å��。类å��" ``` public class Element03Selector implements ImportSelector { /** - * ·µ»ØString Ϊ °üÃû.ÀàÃû - * ÓÉÓÚºóÃæÒªÓõ½·´É䣬Òò´Ë±ØÐëÊÇ"°üÃû.ÀàÃû" + * 返回String 为 包å��.ç±»å�� + * 由于å�Žé�¢è¦�用到å��射,因此必须是"包å��.ç±»å��" * @param importingClassMetadata * @return */ @@ -107,7 +107,7 @@ public class Element03Selector implements ImportSelector { } ``` -1. ×¼±¸Ò»¸ö±» `@Configuration` ×¢½â±ê¼ÇÀ࣬ͨ¹ýÀàÖб» `@Bean` ±ê¼ÇµÄ·½·¨·µ»Ø `Element04` +1. 准备一个被 `@Configuration` 注解标记类,通过类中被 `@Bean` 标记的方法返回 `Element04` ``` @Configuration @@ -120,20 +120,20 @@ public class Element04Configuration { } ``` -1. ¶¨Òå `@EnableElement` ×¢½â£¬ÆäÖÐµÄ `@Import` ×¢½âÒÀ´ÎÒýÈë `Element01.class`¡¢`Element02ImportBeanDefinitionRegistrar.class`¡¢`Element03Selector.class`¡¢`Element04Configuration.class` +1. 定义 `@EnableElement` 注解,其中的 `@Import` 注解ä¾�次引入 `Element01.class`ã€�`Element02ImportBeanDefinitionRegistrar.class`ã€�`Element03Selector.class`ã€�`Element04Configuration.class` ``` @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented @Import({ - // ÆÕͨÀà + // 普通类 Element01.class, - // ʵÏÖÁË ImportBeanDefinitionRegistrar µÄÀà + // 实现了 ImportBeanDefinitionRegistrar 的类 Element02ImportBeanDefinitionRegistrar.class, - // ʵÏÖÁË ImportSelector µÄÀà + // 实现了 ImportSelector 的类 Element03Selector.class, - // ±» @Configuration ±ê¼ÇµÄÀà + // 被 @Configuration 标记的类 Element04Configuration.class }) public @interface EnableElement { @@ -141,15 +141,15 @@ public @interface EnableElement { } ``` -1. Ö÷Àࣺ +1. 主类: ``` -// Ö»ÐèÒª @EnableElement ×¢½â +// å�ªéœ€è¦� @EnableElement 注解 @EnableElement public class Demo04Main { public static void main(String[] args) { - // ´«ÈëµÄÊÇ Demo04Main.class + // 传入的是 Demo04Main.class ApplicationContext context = new AnnotationConfigApplicationContext(Demo04Main.class); Element01 element01 = context.getBean(Element01.class); @@ -167,9 +167,9 @@ public class Demo04Main { } ``` -ÍêÕû´úÂë¼û [gitee/funcy](https://gitee.com/funcy/spring-framework/tree/v5.2.2.RELEASE_learn/spring-learn/src/main/java/org/springframework/learn/explore/demo04). +完整代ç �è§� [gitee/funcy](https://gitee.com/funcy/spring-framework/tree/v5.2.2.RELEASE_learn/spring-learn/src/main/java/org/springframework/learn/explore/demo04). -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` this is element 01 @@ -178,13 +178,13 @@ this is element 03 this is element 04 ``` -¿ÉÒÔ¿´µ½£¬4 ¸ö bean ¶¼³É¹¦ÒýÈëÁË spring ÈÝÆ÷¡£½ÓÏÂÀ´£¬ÎÒÃÇͨ¹ý´úÂëÀ´¿´¿´ spring ÊÇÈçºÎ´¦ÀíµÄ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ4 个 bean 都æˆ�功引入了 spring 容器。接下æ�¥ï¼Œæˆ‘们通过代ç �æ�¥çœ‹çœ‹ spring 是如何处ç�†çš„。 -×¢£º±¾ÎÄÊÇ `ConfigurationClassPostProcessor` ·ÖÎöµÄµÚÈýƪ£¬¶ÔÓëÇ°ÃæÁ½ÆªÎÄÕ£¨[´¦Àí @ComponentScan ×¢½â](https://my.oschina.net/funcy/blog/4836178)¡¢[´¦Àí @Bean ×¢½â](https://my.oschina.net/funcy/blog/4492878)£©À×ͬµÄ´úÂ룬±¾ÎÄ»áÒ»±Ê´ø¹ý£¬²»»á¾ßÌå·ÖÎöÁË¡£ +注:本文是 `ConfigurationClassPostProcessor` 分æž�的第三篇,对与å‰�é�¢ä¸¤ç¯‡æ–‡ç« ï¼ˆ[处ç�† @ComponentScan 注解](https://my.oschina.net/funcy/blog/4836178)ã€�[处ç�† @Bean 注解](https://my.oschina.net/funcy/blog/4492878))雷å�Œçš„代ç �,本文会一笔带过,ä¸�会具体分æž�了。 -### 4.3 ´¦ÀíÅäÖÃÀࣺ`ConfigurationClassPostProcessor#processConfigBeanDefinitions` +### 4.3 处ç�†é…�置类:`ConfigurationClassPostProcessor#processConfigBeanDefinitions` -¹ØÓÚÅäÖÃÀàµÄ½âÁ÷³Ì£¬Ç°Á½ÆªÒѾ­¶à´ÎÌáµ½¹ýÁË£¬ÕâÀïÎÒÃÇÖ±½Ó¿´¹Ø¼ü´úÂ룺 +关于é…�置类的解æµ�程,å‰�两篇已ç»�多次æ��到过了,这里我们直接看关键代ç �: ``` public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { @@ -192,28 +192,28 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { Set candidates = new LinkedHashSet<>(configCandidates); Set alreadyParsed = new HashSet<>(configCandidates.size()); do { - // 1. ½âÎöÅäÖÃÀà, ¶Ô@Component£¬@PropertySources£¬@ComponentScans£¬ - // @ImportResourceµÈµÄ½âÎö + // 1. è§£æž�é…�置类, 对@Component,@PropertySources,@ComponentScans, + // @ImportResource等的解æž� parser.parse(candidates); parser.validate(); - // ½âÎöÍê³Éºó£¬µÃµ½µÄÅäÖÃÀ࣬ÅäÖÃÀà±£´æÔÚ parser µÄ configurationClasses ÊôÐÔÖÐ + // è§£æž�完æˆ�å�Žï¼Œå¾—到的é…�置类,é…�置类ä¿�存在 parser çš„ configurationClasses 属性中 Set configClasses = new LinkedHashSet<>(parser.getConfigurationClasses()); ... - // 2. °Ñ @Import ÒýÈëµÄÀà¡¢ÅäÖÃÀàÖдø@BeanµÄ·½·¨¡¢ - // @ImportResource ÒýÈëµÄ×ÊÔ´µÈת»»³ÉBeanDefinition + // 2. 把 @Import 引入的类ã€�é…�置类中带@Bean的方法ã€� + // @ImportResource 引入的资æº�等转æ�¢æˆ�BeanDefinition this.reader.loadBeanDefinitions(configClasses); ... - // »ñµÃ×¢²áÆ÷ÀïÃæBeanDefinitionµÄÊýÁ¿ ºÍ candidateNames½øÐÐ±È½Ï - // Èç¹û´óÓڵϰ£¬ËµÃ÷ÓÐеÄBeanDefinition×¢²á½øÀ´ÁË + // 获得注册器里é�¢BeanDefinition的数é‡� å’Œ candidateNames进行比较 + // 如果大于的è¯�,说明有新的BeanDefinition注册进æ�¥äº† if (registry.getBeanDefinitionCount() > candidateNames.length) { ... for (String candidateName : newCandidateNames) { - // ¹ýÂ˱¾´ÎÐÂÔöµÄBeanDefinition + // 过滤本次新增的BeanDefinition if (!oldCandidateNames.contains(candidateName)) { BeanDefinition bd = registry.getBeanDefinition(candidateName); - // 3. ¶ÔÐÂÌí¼ÓµÄÀ࣬Èç¹ûÊÇÅäÖÃÀ࣬ÇÒδ½âÎö£¬Ìí¼Óµ½candidatesÖУ¬µÈ´ýÏ´ÎÑ­»·´¦Àí + // 3. 对新添加的类,如果是é…�置类,且未解æž�,添加到candidates中,等待下次循环处ç�† if (ConfigurationClassUtils.checkConfigurationClassCandidate( bd, this.metadataReaderFactory) &&!alreadyParsedClasses.contains(bd.getBeanClassName())) { @@ -229,80 +229,80 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { } ``` -ÒÔÉÏ´úÂë¾­¹ýÁËһЩ¾«¼ò£¬Ö»±£ÁôÁË´¦Àí `@Import` ¹Ø¼ü²½Ö裬×ܽáÈçÏ£º +以上代ç �ç»�过了一些精简,å�ªä¿�留了处ç�† `@Import` 关键步骤,总结如下: -1. ½âÎöÅäÖÃÀ࣬¶Ô `@Component`£¬`@PropertySources`£¬`@ComponentScans`£¬`@ImportResource` µÈµÄ½âÎö£¬Õâ¸ö ·½·¨Ç°Á½ÆªÎÄÕÂÒ²·ÖÎöÁË£¬Õâ´ÎÎÒÃǾۼ¯ÓÚ `@Import` »áÔٴηÖÎö£¬ÔÚÕâÒ»²½£¬Òª½âÎöµÄÅäÖÃÀàÖ»ÓÐÒ»¸ö£¬¾ÍÊÇÎÒÃÇÔÚ `main()` ·½·¨ÖÐ×¢²áµÄ `Demo04.class`£º +1. è§£æž�é…�置类,对 `@Component`,`@PropertySources`,`@ComponentScans`,`@ImportResource` 等的解æž�,这个 方法å‰�两篇文章也分æž�了,这次我们è�šé›†äºŽ `@Import` 会å†�次分æž�,在这一步,è¦�è§£æž�çš„é…�置类å�ªæœ‰ä¸€ä¸ªï¼Œå°±æ˜¯æˆ‘们在 `main()` 方法中注册的 `Demo04.class`: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-840c14685be569012b54d94aad67ee48825.png) -2. °Ñ `@Import` ÒýÈëµÄÀà¡¢ÅäÖÃÀàÖдø `@Bean` µÄ·½·¨¡¢`@ImportResource` ÒýÈëµÄ×ÊÔ´µÈת»»³É `BeanDefinition`£¬Õâ¸ö·½·¨ÔÚÇ°Ãæ·ÖÎö `@Bean` µÄʱºòÒ²·ÖÎö¹ýÁË£¬Õâ´ÎÎÒÃÇÒ²»á·ÖÎöµ½£» +2. 把 `@Import` 引入的类ã€�é…�置类中带 `@Bean` 的方法ã€�`@ImportResource` 引入的资æº�等转æ�¢æˆ� `BeanDefinition`,这个方法在å‰�é�¢åˆ†æž� `@Bean` 的时候也分æž�过了,这次我们也会分æž�到; -3. ¶ÔÐÂÌí¼ÓµÄÀ࣬Èç¹ûÊÇÅäÖÃÀ࣬ÇÒδ½âÎö£¬Ìí¼Óµ½ `candidates` ÖУ¬µÈ´ýÏ´ÎÑ­»·´¦Àí¡£ +3. 对新添加的类,如果是é…�置类,且未解æž�,添加到 `candidates` 中,等待下次循环处ç�†ã€‚ -### 4.4 ½âÎöÅäÖÃÀࣺ`ConfigurationClassParser#doProcessConfigurationClass` +### 4.4 è§£æž�é…�置类:`ConfigurationClassParser#doProcessConfigurationClass` -ÎÒÃÇÀ´¿´¿´ `@Import` ÊÇÈçºÎ½âÎöµÄ£¬½øÈë `ConfigurationClassParser#doProcessConfigurationClass`£º +我们æ�¥çœ‹çœ‹ `@Import` 是如何解æž�的,进入 `ConfigurationClassParser#doProcessConfigurationClass`: ``` /** - * Õâ¸ö·½·¨²ÅÊÇÕæÕý´¦Àí½âÎöµÄ·½·¨ + * 这个方法æ‰�是真正处ç�†è§£æž�的方法 */ protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass) throws IOException { - // 1. Èç¹ûÊÇ @Component ×¢½â£¬µÝ¹é´¦ÀíÄÚ²¿À࣬±¾ÎIJ»¹Ø×¢ + // 1. 如果是 @Component 注解,递归处ç�†å†…部类,本文ä¸�关注 ... - // 2. ´¦Àí@PropertySource×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 2. 处ç�†@PropertySource注解,本文ä¸�关注 ... - // 3. ´¦Àí @ComponentScan/@ComponentScans ×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 3. 处ç�† @ComponentScan/@ComponentScans 注解,本文ä¸�关注 ... - // 4. ´¦Àí@Import×¢½â + // 4. 处ç�†@Import注解 processImports(configClass, sourceClass, getImports(sourceClass), true); - // 5. ´¦Àí@ImportResource×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 5. 处ç�†@ImportResource注解,本文ä¸�关注 ... - // 6. ´¦Àí@BeanµÄ×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 6. 处ç�†@Bean的注解,本文ä¸�关注 ... - // 7. ·µ»ØÅäÖÃÀàµÄ¸¸À࣬»áÔÚ processConfigurationClass(...) ·½·¨µÄÏÂÒ»´ÎÑ­»·Ê±½âÎö + // 7. 返回é…�置类的父类,会在 processConfigurationClass(...) 方法的下一次循环时解æž� ... return null; } ``` -´¦Àí `@Import` ×¢½âµ÷ÓõÄÊÇ `processImports(...)` ·½·¨£¬ÎÒÃǼÌÐø£º +处ç�† `@Import` 注解调用的是 `processImports(...)` 方法,我们继续: -#### 1. »ñÈ¡ `@Import` µ¼ÈëµÄÀà +#### 1. 获å�– `@Import` 导入的类 -ÈÃÎÒÃǰÑÄ¿±ê·Åµ½ `processImports(...)` ·½·¨£º +让我们把目标放到 `processImports(...)` 方法: ``` processImports(configClass, sourceClass, getImports(sourceClass), true); ``` -Õâ¸ö·½·¨¹²´«ÈëÁË 4 ¸ö²ÎÊý£º +这个方法共传入了 4 个å�‚数: -- `configClass`£ºÅäÖÃÀ࣬¾ÍÊÇ `demo04Main` ¶ÔÓ¦µÄÅäÖÃÀࣻ -- `sourceClass`£º¶Ô `demo04Main` ¼°ÆäÉϵÄ×¢½âµÄ°ü×°£» -- `getImports(sourceClass)`£º`getImports(...)` ÓÃÀ´»ñÈ¡´«Èë `sourceClass` µÄËùÓÐ `@Import` ×¢½âÒýÈëµÄÀࣻ -- `true`£º²¼¶ûÖµ£¬ÊÇ·ñ¼ì²éÑ­»·ÒýÈë¡£ +- `configClass`:é…�置类,就是 `demo04Main` 对应的é…�置类; +- `sourceClass`:对 `demo04Main` å�Šå…¶ä¸Šçš„æ³¨è§£çš„包装; +- `getImports(sourceClass)`:`getImports(...)` 用æ�¥èŽ·å�–ä¼ å…¥ `sourceClass` 的所有 `@Import` 注解引入的类; +- `true`:布尔值,是å�¦æ£€æŸ¥å¾ªçŽ¯å¼•å…¥ã€‚ -ÆäÖУ¬»ñÈ¡ `@Import` ×¢½âÒýÈëµÄÀàÊÇ `getImports(...)` µÄ¹¦ÄÜ£¬ÎÒÃÇÏÈÀ´¿´¿´Õâ¸ö·½·¨ÊÇÈçºÎ»ñÈ¡µÄ£º +其中,获å�– `@Import` 注解引入的类是 `getImports(...)` 的功能,我们先æ�¥çœ‹çœ‹è¿™ä¸ªæ–¹æ³•是如何获å�–的: ``` private Set getImports(SourceClass sourceClass) throws IOException { Set imports = new LinkedHashSet<>(); Set visited = new LinkedHashSet<>(); - // ÔÚÕâÀï»ñÈ¡ + // 在这里获å�– collectImports(sourceClass, imports, visited); return imports; } /** - * ¾ßÌåµÄ»ñÈ¡²Ù×÷ + * 具体的获å�–æ“�作 */ private void collectImports(SourceClass sourceClass, Set imports, Set visited) throws IOException { @@ -310,24 +310,24 @@ private void collectImports(SourceClass sourceClass, Set imports, for (SourceClass annotation : sourceClass.getAnnotations()) { String annName = annotation.getMetadata().getClassName(); if (!annName.equals(Import.class.getName())) { - // Èç¹ûannotationµÄÃû³Æ²»ÊÇimport£¬ÔòµÝ¹éµ÷Óà collectImports(...) ·½·¨ + // 如果annotationçš„å��ç§°ä¸�是import,则递归调用 collectImports(...) 方法 collectImports(annotation, imports, visited); } } - // »ñÈ¡µ±Ç°ÀàµÄ @Import ×¢½â + // 获å�–当å‰�类的 @Import 注解 imports.addAll(sourceClass.getAnnotationAttributes(Import.class.getName(), "value")); } } ``` -»ñÈ¡ `@Import` µÄ·½·¨ÊÇ `ConfigurationClassParser#collectImports`£¬Õâ¸ö·½·¨Àï»á»ñÈ¡»ñÈ¡£¬²Ù×÷·½Ê½ÈçÏ£º +获å�– `@Import` 的方法是 `ConfigurationClassParser#collectImports`,这个方法里会获å�–获å�–,æ“�作方å¼�如下: -1. »ñÈ¡´«ÈëÀàµÄËùÓÐ×¢½â£» -2. ±éÀúÕâЩע½â£¬Èç¹ûÊÇ `@Import` ×¢½â£¬Ôò»ñÈ¡ `@Import` µÄ `value` Öµ£»·ñÔò£¬»Øµ½µÚÒ»²½£¬¼ÌÐø´¦Àí¡£ +1. 获å�–传入类的所有注解; +2. é��历这些注解,如果是 `@Import` 注解,则获å�– `@Import` çš„ `value` 值;å�¦åˆ™ï¼Œå›žåˆ°ç¬¬ä¸€æ­¥ï¼Œç»§ç»­å¤„ç�†ã€‚ -ÕâÑùÖ®ºó£¬ÅäÖÃÀàÉÏ `demo04Main` É쵀 `@EnableElement` ×¢½â»á±»»ñÈ¡µ½£¬ÓÉÓÚÕâ¸ö×¢½â²»ÊÇ `@Import` ×¢½â£¬¾Í¼ÌÐø»ñÈ¡ `@EnableElement` ÆäÉϵÄ×¢½â£¬´Ëʱ·¢ÏÖ `@EnableElement` ÓÐ `@Import` ×¢½â£¬Õâʱ¾Í»á»ñÈ¡ `@Import` µÄ `value()` Öµ£¬Ò²¾ÍÊÇ `@Import` ×¢½âÒýÈëµÄÀà¡£ +这样之å�Žï¼Œé…�置类上 `demo04Main` 上的 `@EnableElement` 注解会被获å�–到,由于这个注解ä¸�是 `@Import` 注解,就继续获å�– `@EnableElement` 其上的注解,此时å�‘现 `@EnableElement` 有 `@Import` 注解,这时就会获å�– `@Import` çš„ `value()` 值,也就是 `@Import` 注解引入的类。 -Õâ¸ö·½·¨ÔËÐÐºó £¬µÃµ½µÄ½á¹ûÈçÏ£º +这个方法è¿�行å�Ž ï¼Œå¾—åˆ°çš„ç»“æžœå¦‚ä¸‹ï¼š ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-05c7fb442b4bb84d13ff6688e5fbf31cfa5.png) @@ -337,50 +337,50 @@ private void collectImports(SourceClass sourceClass, Set imports, ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d7e2063676e6e19850c35893b62f4ab76a9.png) -µÃµ½µÄ½á¹ûΪ `LinkedHashSet`£¬Ò»´Î½ØÍ¼²»·½±ã£¬Òò´Ë·ÖΪÁË 4 ÕÅͼ¡£¿ÉÒÔ¿´µ½£¬`@Import` ×¢½âÒýÈëµÄ 4 ¸öÀà¶¼»ñÈ¡µ½ÁË£º +得到的结果为 `LinkedHashSet`,一次截图ä¸�方便,因此分为了 4 张图。å�¯ä»¥çœ‹åˆ°ï¼Œ`@Import` 注解引入的 4 个类都获å�–到了: ![img](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d615198a8f6dbef1ac6a800526311f36078.png) -#### 2. ´¦Àí `@Import` µ¼ÈëµÄÀà +#### 2. 处ç�† `@Import` 导入的类 -»ñÈ¡µ½ `@Import` ×¢½âµ¼ÈëµÄÀàºó£¬ÎÒÃÇÔÙÀ´¿´ `processImports(...)` ·½·¨£º +获å�–到 `@Import` 注解导入的类å�Žï¼Œæˆ‘们å†�æ�¥çœ‹ `processImports(...)` 方法: ``` private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass, Collection importCandidates, boolean checkForCircularImports) { ... for (SourceClass candidate : importCandidates) { - // 1. ÒýÈëÀàµÄÀàÐÍÊÇ ImportSelector + // 1. 引入类的类型是 ImportSelector if (candidate.isAssignable(ImportSelector.class)) { Class candidateClass = candidate.loadClass(); - // ʵÀý»¯ÒýÈëµÄ ImportSelector£¬²¢ÇÒ»áÖ´ÐÐ Aware ½Ó¿Ú·½·¨ - // Ö§³ÖµÄAwareÓÐBeanClassLoaderAware£¬BeanFactoryAware£¬EnvironmentAware£¬ResourceLoaderAware + // 实例化引入的 ImportSelector,并且会执行 Aware 接å�£æ–¹æ³• + // 支æŒ�çš„Aware有BeanClassLoaderAware,BeanFactoryAware,EnvironmentAware,ResourceLoaderAware ImportSelector selector = ParserStrategyUtils.instantiateClass(candidateClass, ImportSelector.class, this.environment, this.resourceLoader, this.registry); if (selector instanceof DeferredImportSelector) { this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector); } else { - // Ö´ÐÐ selectImports ·½·¨£¬»ñÈ¡ÒýÈëµÄÀ࣬Êý×éÖÐΪÒýÈëÀàµÄ"°üÃû.ÀàÃû" + // 执行 selectImports 方法,获å�–引入的类,数组中为引入类的"包å��.ç±»å��" String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata()); Collection importSourceClasses = asSourceClasses(importClassNames); - // µÝ¹éµ÷Óà processImports(...) ·½·¨£¬ÔÙÒ»´Î´¦ÀíÒýÈëµÄÀà + // 递归调用 processImports(...) 方法,å†�一次处ç�†å¼•入的类 processImports(configClass, currentSourceClass, importSourceClasses, false); } } - // 2. ÒýÈëÀàµÄÀàÐÍÊÇ ImportBeanDefinitionRegistrar + // 2. 引入类的类型是 ImportBeanDefinitionRegistrar else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) { Class candidateClass = candidate.loadClass(); - // ʵÀý»¯ ImportBeanDefinitionRegistrar£¬²¢ÇÒÖ´ÐÐ Aware ½Ó¿ÚµÄ·½·¨ - // Ö§³ÖµÄAwareÓÐBeanClassLoaderAware£¬BeanFactoryAware£¬EnvironmentAware£¬ResourceLoaderAware + // 实例化 ImportBeanDefinitionRegistrar,并且执行 Aware 接å�£çš„æ–¹æ³• + // 支æŒ�çš„Aware有BeanClassLoaderAware,BeanFactoryAware,EnvironmentAware,ResourceLoaderAware ImportBeanDefinitionRegistrar registrar = ParserStrategyUtils .instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class, this.environment, this.resourceLoader, this.registry); - // ½« ImportBeanDefinitionRegistrar ±£´æÆðÀ´ + // å°† ImportBeanDefinitionRegistrar ä¿�存起æ�¥ configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata()); } - // 3. ²»ÊÇÒÔÉÏÁ½Õߣ¬µ÷Óà processConfigurationClass(...) Ö±½Ó½âÎö - // Èç¹ûÒýÈëµÄÀàÊÇÅäÖÃÀࣨ°üº¬ @Component¡¢@Configuration¡¢@Import µÈ×¢½â£©£¬»áÔÚÕâÀï½øÐнâÎö + // 3. ä¸�是以上两者,调用 processConfigurationClass(...) 直接解æž� + // 如果引入的类是é…�置类(包å�« @Componentã€�@Configurationã€�@Import 等注解),会在这里进行解æž� else { this.importStack.registerImport( currentSourceClass.getMetadata(), candidate.getMetadata().getClassName()); @@ -392,12 +392,12 @@ private void processImports(ConfigurationClass configClass, SourceClass currentS } ``` -ÒÔÉÏÊǾ­¹ý¾«¼òºóµÄ´úÂ룬ÎÒÃÇÖ»¿´´¦Àí `@Import` µÄ¹Ø¼ü²½Ö裺 +以上是ç»�过精简å�Žçš„代ç �,我们å�ªçœ‹å¤„ç�† `@Import` 的关键步骤: -1. Èç¹ûÒýÈëÀàµÄÀàÐÍÊÇ `ImportSelector`£¬´¦ÀíÁ÷³ÌÈçÏ£º +1. 如果引入类的类型是 `ImportSelector`,处ç�†æµ�程如下: - 1. ʹÓ÷´ÉäʵÀý»¯ `ImportSelector`£¬Ö®ºóÔÙÖ´ÐÐ `Aware` ½Ó¿Ú·½·¨£¬ËùÒÔÎÒÃÇÔÚ´¦Àí `ImportSelector` ʱ£¬»¹¿ÉÒÔʵÏÖ `Aware` ½Ó¿Ú£¬Ö§³ÖµÄ `Aware` ÓÐ `BeanClassLoaderAware`£¬`BeanFactoryAware`£¬`EnvironmentAware`£¬`ResourceLoaderAware`£» - 2. Ö´ÐÐ `ImportSelector` ʵÀýµÄ `selectImports` ·½·¨£¬ÕâÒ»²½ÊÇΪÁË»ñÈ¡ÒýÈëµÄÀ࣬½á¹ûΪ `Class[]`£¬ÒýÈëÀàµÄ "°üÃû¡£ÀàÃû"£¬`Element03Selector` Öи÷½·¨´úÂëÈçÏ£º + 1. 使用å��射实例化 `ImportSelector`,之å�Žå†�执行 `Aware` 接å�£æ–¹æ³•,所以我们在处ç�† `ImportSelector` 时,还å�¯ä»¥å®žçް `Aware` 接å�£ï¼Œæ”¯æŒ�çš„ `Aware` 有 `BeanClassLoaderAware`,`BeanFactoryAware`,`EnvironmentAware`,`ResourceLoaderAware`ï¼› + 2. 执行 `ImportSelector` 实例的 `selectImports` 方法,这一步是为了获å�–引入的类,结果为 `Class[]`,引入类的 "包å��。类å��",`Element03Selector` 中该方法代ç �如下: ``` @Override @@ -406,68 +406,68 @@ private void processImports(ConfigurationClass configClass, SourceClass currentS } ``` - ÕâÒ»²½»á»ñÈ¡µ½ `Element03.class`; 3. ½«»ñÈ¡µ½µÄ `Class` Êý×飬ת»»³É `SourceClass` ¼¯ºÏ£¬ÔÙÒ»´Îµ÷Óà `processImports(...)`£¬ÔÚµÚ¶þ´Îµ÷ÓÃʱ£¬²ÅÊÇÕæÕý´¦Àí `Element03`¡£ + 这一步会获å�–到 `Element03.class`; 3. 将获å�–到的 `Class` 数组,转æ�¢æˆ� `SourceClass` 集å�ˆï¼Œå†�一次调用 `processImports(...)`,在第二次调用时,æ‰�是真正处ç�† `Element03`。 -2. Èç¹ûÒýÈëÀàµÄÀàÐÍÊÇ `ImportBeanDefinitionRegistrar`£¬´¦ÀíÁ÷³ÌÈçÏ£º +2. 如果引入类的类型是 `ImportBeanDefinitionRegistrar`,处ç�†æµ�程如下: - 1. ʵÀý»¯ `ImportBeanDefinitionRegistrar`£¬²¢ÇÒÖ´ÐÐ `Aware` ½Ó¿ÚµÄ·½·¨£¬ÕâÒ»²½Í¬ `ImportSelector` µÄʵÀý»¯²Ù×÷Ò»Ñù£¬²»ÔÙ׸Êö£» - 2. ½«ÉÏÒ»²½µÃµ½µÄ `ImportBeanDefinitionRegistrar` ʵÀý±£´æµ½ `configClass` ÖУ¬ºóÃæÎÒÃÇÔÙ·ÖÎö±£´æÆðÀ´µÄʵÀýÊÇÈçºÎ´¦ÀíµÄ£» + 1. 实例化 `ImportBeanDefinitionRegistrar`,并且执行 `Aware` 接å�£çš„æ–¹æ³•,这一步å�Œ `ImportSelector` 的实例化æ“�作一样,ä¸�å†�赘述; + 2. 将上一步得到的 `ImportBeanDefinitionRegistrar` 实例ä¿�存到 `configClass` 中,å�Žé�¢æˆ‘们å†�分æž�ä¿�存起æ�¥çš„实例是如何处ç�†çš„ï¼› -3. Èç¹ûÒýÈëÀàµÄÀàÐͲ»ÊÇÒÔÉÏÁ½Õߣ¬µ÷Óà `processConfigurationClass(...)` Ö±½Ó½âÎö£¬Õâ¸ö·½·¨Ç°Á½ÆªÎÄÕÂÒѾ­¶à´ÎÌá¼°ÁË£¬¾ÍÊÇÓÃÀ´½âÎö `@Component`¡¢`@Import`¡¢`@ComponentScan`¡¢`@Configuration`¡¢`@Bean` µÈ×¢½âµÄ£¬ÕâÒ»²½ÊÇΪÁ˽âÎöÒýÈëÀàÖеÄÕâЩע½â£¬ÒýÈëµÄ `Element01`¡¢`Element02`¡¢`Element03`(ÉÏÃæµÚ 1 ²½ÖÐÌáµ½µÄ£¬´Ó `Element03Selector` ÖлñÈ¡µ½ `Element03.class` ºó£¬½«Æäת»»³É `SourceClass`£¬Ôٴε÷Óà `processImports(...)` µÄ¹ý³Ì) ¶¼ÊÇÔÚÕâÒ»²½½âÎöµÄ¡£ +3. 如果引入类的类型ä¸�是以上两者,调用 `processConfigurationClass(...)` 直接解æž�,这个方法å‰�两篇文章已ç»�多次æ��å�Šäº†ï¼Œå°±æ˜¯ç”¨æ�¥è§£æž� `@Component`ã€�`@Import`ã€�`@ComponentScan`ã€�`@Configuration`ã€�`@Bean` 等注解的,这一步是为了解æž�引入类中的这些注解,引入的 `Element01`ã€�`Element02`ã€�`Element03`(上é�¢ç¬¬ 1 步中æ��到的,从 `Element03Selector` 中获å�–到 `Element03.class` å�Žï¼Œå°†å…¶è½¬æ�¢æˆ� `SourceClass`,å†�次调用 `processImports(...)` 的过程) 都是在这一步解æž�的。 -µ½ÁËÕâÀÎÒÃÇ·¢ÏÖ£¬³ýÁË `ImportBeanDefinitionRegistrar` µÄ·½Ê½Í⣬ÆäËûÈýÖÖÒýÈ뷽ʽ£¨ÆÕͨÀà¡¢ÅäÖÃÀà¡¢`ImportSelector` µÄʵÏÖÀࣩ¶¼ÊÇÒ»ÑùµÄ´¦Àí·½Ê½£¬¶¼Êǰ´**ÅäÖÃÀàµÄ½âÎö·½Ê½À´´¦Àí**£¬×îÖÕµ÷ÓõÄÊÇ `processConfigurationClass(...)` ·½·¨£¡ÕâÒ» ¿éÎÒÃÇǰÁ½ÆªÎÄÕÂÒѾ­¶à´Î·ÖÎöÁË£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË£¬½ÓÏÂÀ´ÎÒÃÇÀ´¼ÌÐøÀ´¿´ `ImportBeanDefinitionRegistrar` µÄ´¦Àí¡£ +到了这里,我们å�‘现,除了 `ImportBeanDefinitionRegistrar` 的方å¼�外,其他三ç§�引入方å¼�(普通类ã€�é…�置类ã€�`ImportSelector` 的实现类)都是一样的处ç�†æ–¹å¼�,都是按**é…�置类的解æž�æ–¹å¼�æ�¥å¤„ç�†**,最终调用的是 `processConfigurationClass(...)` 方法ï¼�这一 å�—我们å‰�两篇文章已ç»�多次分æž�了,这里就ä¸�å†�分æž�了,接下æ�¥æˆ‘们æ�¥ç»§ç»­æ�¥çœ‹ `ImportBeanDefinitionRegistrar` 的处ç�†ã€‚ -### 4.5 ¼ÓÔØ `BeanDefinitions`£º`ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` +### 4.5 加载 `BeanDefinitions`:`ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` -ÔÚ·ÖÎö `@Bean` ·½·¨Ê±£¬ÎÒÃÇ·ÖÎö¹ý `ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` ¼ÓÔØ `@Bean` ·½·¨µÄÁ÷³Ì£¬ÕâÀïÎÒÃÇÀ´¿´¼ÓÔØ `@Import` µÄÁ÷³Ì£¬ÎÒÃÇÖ±½Ó½øÈë¹Ø¼ü·½·¨ `ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForConfigurationClass`£º +在分æž� `@Bean` 方法时,我们分æž�过 `ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` 加载 `@Bean` 方法的æµ�程,这里我们æ�¥çœ‹åŠ è½½ `@Import` çš„æµ�程,我们直接进入关键方法 `ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForConfigurationClass`: ``` private void loadBeanDefinitionsForConfigurationClass( ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) { ... - // ´¦Àí @Import ÒýÈëµÄÅäÖÃÀà + // 处ç�† @Import 引入的é…�置类 if (configClass.isImported()) { registerBeanDefinitionForImportedConfigurationClass(configClass); } - // ´¦Àí @Bean ·½·¨ + // 处ç�† @Bean 方法 for (BeanMethod beanMethod : configClass.getBeanMethods()) { loadBeanDefinitionsForBeanMethod(beanMethod); } - // ´¦Àí @ImportResource ÒýÈëµÄ×ÊÔ´ + // 处ç�† @ImportResource 引入的资æº� loadBeanDefinitionsFromImportedResources(configClass.getImportedResources()); - // ´¦Àí @Import ÒýÈëµÄ ImportBeanDefinitionRegistrar - // Ç°Ãæ±£´æÔÚconfigClassÖеÄImportBeanDefinitionRegistrars£¬ÔÚÕâÀïʹÓÃÁË + // 处ç�† @Import 引入的 ImportBeanDefinitionRegistrar + // å‰�é�¢ä¿�存在configClass中的ImportBeanDefinitionRegistrars,在这里使用了 loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars()); } ``` -´¦Àí `@Import` µÄµØ·½ÓÐÁ½´¦£º +处ç�† `@Import` 的地方有两处: -1. ´¦Àí `@Import` ÒýÈëµÄÅäÖÃÀà -2. ´¦Àí `@Import` ÒýÈëµÄ `ImportBeanDefinitionRegistrar` +1. 处ç�† `@Import` 引入的é…�置类 +2. 处ç�† `@Import` 引入的 `ImportBeanDefinitionRegistrar` -ÎÒÃÇ·Ö±ðÀ´¿´¿´ÕâÁ½´¦ÊÇÈçºÎ´¦ÀíµÄ¡£ +我们分别æ�¥çœ‹çœ‹è¿™ä¸¤å¤„是如何处ç�†çš„。 -#### 1. ´¦Àí `@Import` ÒýÈëµÄÅäÖÃÀà +#### 1. 处ç�† `@Import` 引入的é…�置类 -´¦Àí `@Import` ÒýÈëµÄÅäÖÃÀàµÄÏà¹Ø´úÂëΪ£º +处ç�† `@Import` 引入的é…�置类的相关代ç �为: ``` - // ´¦Àí @Import ÒýÈëµÄÅäÖÃÀà + // 处ç�† @Import 引入的é…�置类 if (configClass.isImported()) { registerBeanDefinitionForImportedConfigurationClass(configClass); } ``` -ÎÒÃǽøÈëÆäÖÐһ̽¾¿¾¹£º +我们进入其中一探究竟: ``` private void registerBeanDefinitionForImportedConfigurationClass(ConfigurationClass configClass) { AnnotationMetadata metadata = configClass.getMetadata(); - // ´´½¨ BeanDefinition£¬ÀàÐÍΪ AnnotatedGenericBeanDefinition + // 创建 BeanDefinition,类型为 AnnotatedGenericBeanDefinition AnnotatedGenericBeanDefinition configBeanDef = new AnnotatedGenericBeanDefinition(metadata); - // ´¦ÀíһϵÁеÄÊôÐÔ + // 处ç�†ä¸€ç³»åˆ—的属性 ScopeMetadata scopeMetadata = scopeMetadataResolver.resolveScopeMetadata(configBeanDef); configBeanDef.setScope(scopeMetadata.getScopeName()); String configBeanName = this.importBeanNameGenerator.generateBeanName(configBeanDef, this.registry); @@ -475,18 +475,18 @@ private void registerBeanDefinitionForImportedConfigurationClass(ConfigurationCl BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(configBeanDef, configBeanName); definitionHolder = AnnotationConfigUtils .applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); - // ×¢²á + // 注册 this.registry.registerBeanDefinition(definitionHolder.getBeanName(), definitionHolder.getBeanDefinition()); configClass.setBeanName(configBeanName); } ``` -Õâ¾ÍÊÇÒ»¸ö½«Àà×¢²áµ½ `BeanDefinition` ÖеĹý³Ì£¬Ê¹ÓÃµÄ `BeanDefinition` ÊÇ `AnnotatedGenericBeanDefinition`¡£ +这就是一个将类注册到 `BeanDefinition` 中的过程,使用的 `BeanDefinition` 是 `AnnotatedGenericBeanDefinition`。 -#### 2. ´¦Àí `@Import` ÒýÈëµÄ `ImportBeanDefinitionRegistrar` +#### 2. 处ç�† `@Import` 引入的 `ImportBeanDefinitionRegistrar` -´¦Àí¸Ã¹ý³ÌµÄ·½·¨Îª `loadBeanDefinitionsFromRegistrars(...)`£¬´úÂëÈçÏ£º +处ç�†è¯¥è¿‡ç¨‹çš„æ–¹æ³•为 `loadBeanDefinitionsFromRegistrars(...)`,代ç �如下: ``` private void loadBeanDefinitionsFromRegistrars(Map getImportGroup() { @@ -605,33 +605,33 @@ public interface DeferredImportSelector extends ImportSelector { /** - * ·Ö×éµÄ¶¨Òå + * 分组的定义 */ interface Group { /** - * ¸Ã·Ö×éµÄ´¦Àí·½·¨ + * 该分组的处ç�†æ–¹æ³• */ void process(AnnotationMetadata metadata, DeferredImportSelector selector); /** - * ·µ»Ø¸Ã·Ö×éµÄÄÚÈÝ + * 返回该分组的内容 */ Iterable selectImports(); /** - * ·Ö×éµÄÔªËØ¶¨Òå + * 分组的元素定义 */ class Entry { /** - * ×¢½âÊý¾Ý + * 注解数æ�® */ private final AnnotationMetadata metadata; /** - * µ¼ÈëµÄÀàÃû + * 导入的类å�� */ private final String importClassName; @@ -640,7 +640,7 @@ public interface DeferredImportSelector extends ImportSelector { this.importClassName = importClassName; } - // Ê¡ÂÔ get/set ·½·¨£¬Ê¡ÂÔ equals/toString/hashCode ·½·¨ + // çœ�ç•¥ get/set 方法,çœ�ç•¥ equals/toString/hashCode 方法 ... } @@ -648,18 +648,18 @@ public interface DeferredImportSelector extends ImportSelector { } ``` -´ÓÉÏÃæµÄ´úÂë¿ÉÒÔ¿´³ö£¬ +从上é�¢çš„代ç �å�¯ä»¥çœ‹å‡ºï¼Œ -- `DeferredImportSelector` ÊÇ `ImportSelector` µÄ×Ó½Ó¿Ú£¬¾ß±¸ `ImportSelector` µÄ¹¦ÄÜ -- `DeferredImportSelector` ÌṩÁËÒ»¸ö·½·¨£º`Class getImportGroup()`£¬¸Ã·½·¨·µ»ØµÄÊǵ±Ç° `DeferredImportSelector` ʵÀýËùÔڵķÖ×é¡£ +- `DeferredImportSelector` 是 `ImportSelector` çš„å­�接å�£ï¼Œå…·å¤‡ `ImportSelector` 的功能 +- `DeferredImportSelector` æ��供了一个方法:`Class getImportGroup()`,该方法返回的是当å‰� `DeferredImportSelector` 实例所在的分组。 -½ÓÏÂÀ´ÎÒÃÇÀ´¹Ø×¢ÕâÐдúÂ룺 +接下æ�¥æˆ‘们æ�¥å…³æ³¨è¿™è¡Œä»£ç �: ``` this.deferredImportSelectorHandler.handle(configClass, (DeferredImportSelector) selector); ``` -À´¿´¿´ÕâÐдúÂë×ö×öÁËʲô£¬½øÈë `ConfigurationClassParser#handler·½·¨`£º +æ�¥çœ‹çœ‹è¿™è¡Œä»£ç �å�šå�šäº†ä»€ä¹ˆï¼Œè¿›å…¥ `ConfigurationClassParser#handler方法`: ``` class ConfigurationClassParser { @@ -672,7 +672,7 @@ class ConfigurationClassParser { private List deferredImportSelectors = new ArrayList<>(); public void handle(ConfigurationClass configClass, DeferredImportSelector importSelector) { - // ½« configClass Óë importSelector °ü×°³É DeferredImportSelectorHolder + // å°† configClass 与 importSelector 包装æˆ� DeferredImportSelectorHolder DeferredImportSelectorHolder holder = new DeferredImportSelectorHolder( configClass, importSelector); if (this.deferredImportSelectors == null) { @@ -682,7 +682,7 @@ class ConfigurationClassParser { handler.processGroupImports(); } else { - // Ìí¼Óµ½ deferredImportSelectors ÖÐ + // 添加到 deferredImportSelectors 中 this.deferredImportSelectors.add(holder); } } @@ -692,18 +692,18 @@ class ConfigurationClassParser { } ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö·½Ï´ÏȽ« `configClass` Óë `importSelector` °ü×°³É `DeferredImportSelector`£¬È»ºóÔÙÌí¼Óµ½ `deferredImportSelectors`¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ–¹æ´—先将 `configClass` 与 `importSelector` 包装æˆ� `DeferredImportSelector`,然å�Žå†�添加到 `deferredImportSelectors`。 -µ½Ä¿Ç°ÎªÖ¹£¬`DeferredImportSelector` ÒýÈëµÄÀಢûÓнøÐд¦Àí£¬ÄÇô `DeferredImportSelector` ÒýÈëµÄÀàÊÇÔÚÄÄÀï´¦ÀíµÄÄØ£¿ÈÃÎÒÃǻص½ `ConfigurationClassParser#parse(Set)` ·½·¨£º +到目å‰�为止,`DeferredImportSelector` 引入的类并没有进行处ç�†ï¼Œé‚£ä¹ˆ `DeferredImportSelector` 引入的类是在哪里处ç�†çš„呢?让我们回到 `ConfigurationClassParser#parse(Set)` 方法: ``` public class ConfigurationClassParser { public void parse(Set configCandidates) { - // Ñ­»·´«½øÀ´µÄÅäÖÃÀà + // 循环传进æ�¥çš„é…�置类 for (BeanDefinitionHolder holder : configCandidates) { BeanDefinition bd = holder.getBeanDefinition(); try { - // Èç¹û»ñµÃBeanDefinitionÊÇAnnotatedBeanDefinitionµÄʵÀý + // 如果获得BeanDefinition是AnnotatedBeanDefinition的实例 if (bd instanceof AnnotatedBeanDefinition) { parse(((AnnotatedBeanDefinition) bd).getMetadata(), holder.getBeanName()); } @@ -716,16 +716,16 @@ public class ConfigurationClassParser { ... } } - // ÔÚÕâÀï´¦Àí DeferredImportSelector + // 在这里处ç�† DeferredImportSelector this.deferredImportSelectorHandler.process(); } ... } ``` -¿ÉÒÔ¿´µ½£¬ÔÚ´¦ÀíÍêÅäÖÃÀàµÄ½âÎöºó£¬×îºóÔÙÀ´´¦Àí `DeferredImportSelector`£¬Ò²¾ÍÊÇÉÏÃæÌí¼Óµ½ `deferredImportSelectors` µÄÄÚÈÝ£¬µ÷ÓõÄÊÇ `deferredImportSelectorHandler.process()`. +å�¯ä»¥çœ‹åˆ°ï¼Œåœ¨å¤„ç�†å®Œé…�置类的解æž�å�Žï¼Œæœ€å�Žå†�æ�¥å¤„ç�† `DeferredImportSelector`,也就是上é�¢æ·»åŠ åˆ° `deferredImportSelectors` 的内容,调用的是 `deferredImportSelectorHandler.process()`. -ÎÒÃǼÌÐø£º +我们继续: ``` class ConfigurationClassParser { @@ -739,11 +739,11 @@ class ConfigurationClassParser { if (deferredImports != null) { DeferredImportSelectorGroupingHandler handler = new DeferredImportSelectorGroupingHandler(); - // ÅÅÐò£¬DeferredImportSelector ¿ÉÒÔÖ¸¶¨´¦Àí˳Ðò£¬@Order/Orderd + // 排åº�,DeferredImportSelector å�¯ä»¥æŒ‡å®šå¤„ç�†é¡ºåº�,@Order/Orderd deferredImports.sort(DEFERRED_IMPORT_COMPARATOR); - // ±éÀúµ÷Óà DeferredImportSelectorGroupingHandler#register ·½·¨ + // é��历调用 DeferredImportSelectorGroupingHandler#register 方法 deferredImports.forEach(handler::register); - // ´¦Àíµ¼Èë + // 处ç�†å¯¼å…¥ handler.processGroupImports(); } } @@ -757,13 +757,13 @@ class ConfigurationClassParser { } ``` -`process()` ·½·¨²½ÖèÈçÏ£º +`process()` 方法步骤如下: -1. ÅÅÐò£¬Õâ¸öÖ÷ÒªÊǸù¾Ý `@Order` ×¢½â£¬»òÕßʵÏÖÁË `Orderd` ½Ó¿ÚÀ´ÅÅÐò£» -2. ±éÀúµ÷Óà `DeferredImportSelectorGroupingHandler#register` ·½·¨£¬Æäʵ¾ÍÊǽ« `deferredImports` ÖеÄÔªËØ×¢²áµ½ `handler` ÖУ» -3. µ÷Óà `handler.processGroupImports()` ·½·¨À´´¦Àíµ¼Èë¡£ +1. 排åº�,这个主è¦�是根æ�® `@Order` 注解,或者实现了 `Orderd` 接å�£æ�¥æŽ’åº�ï¼› +2. é��历调用 `DeferredImportSelectorGroupingHandler#register` 方法,其实就是将 `deferredImports` 中的元素注册到 `handler` 中; +3. 调用 `handler.processGroupImports()` 方法æ�¥å¤„ç�†å¯¼å…¥ã€‚ -ÎÒÃÇÔÙÀ´¿´¿´ `handler.processGroupImports()` ·½·¨£º +我们å†�æ�¥çœ‹çœ‹ `handler.processGroupImports()` 方法: ``` class ConfigurationClassParser { @@ -773,19 +773,19 @@ class ConfigurationClassParser { private class DeferredImportSelectorGroupingHandler { ... /** - * ×îÖյĴ¦ÀíÀà - * ÔÚÕâÀï´¦Àí·Ö×éµ¼Èë + * 最终的处ç�†ç±» + * 在这里处ç�†åˆ†ç»„导入 */ public void processGroupImports() { for (DeferredImportSelectorGrouping grouping : this.groupings.values()) { - // ±éÀú·Ö×飬 grouping.getImports()Êǹؼü + // é��历分组, grouping.getImports()是关键 grouping.getImports().forEach(entry -> { ConfigurationClass configurationClass = this.configurationClasses.get( entry.getMetadata()); try { - // ͬImportSelectorµÄʵÏÖÀàÒ»Ñù£¬×îÖÕÒ²Êǵ÷Óà processImports(...) ´¦Àíµ¼Èë - // ×¢Òâ entry.getImportClassName()£¬ÕâÒ»´Îµ÷Óà processImports(...) µÄ²Î - // ÊýÊÇImportSelectorÒýÈëµÄÀà + // å�ŒImportSelector的实现类一样,最终也是调用 processImports(...) 处ç�†å¯¼å…¥ + // 注æ„� entry.getImportClassName(),这一次调用 processImports(...) çš„å�‚ + // 数是ImportSelector引入的类 processImports(configurationClass, asSourceClass(configurationClass), asSourceClasses(entry.getImportClassName()), false); } @@ -802,48 +802,48 @@ class ConfigurationClassParser { } ``` -`processGroupImports(...)` Ö÷ÒªÂß¼­ÈçÏ£º +`processGroupImports(...)` 主è¦�逻辑如下: -1. ±éÀú·Ö×é -2. µ÷Óà `grouping.getImports()` »ñÈ¡·Ö×éµÄÀà -3. µ÷Óà `processImports` ´¦Àí·Ö×éÀàµÄµ¼È룬Õâµãͬ´¦Àí `ImportSelector` ½Ó¿ÚÁ÷³ÌÊÇÒ»ÑùµÄ +1. é��历分组 +2. 调用 `grouping.getImports()` 获å�–分组的类 +3. 调用 `processImports` 处ç�†åˆ†ç»„类的导入,这点å�Œå¤„ç�† `ImportSelector` 接å�£æµ�程是一样的 -ÎÒÃÇÀ´¿´¿´ `grouping.getImports()` ·½·¨£¬¸Ã·½·¨Îª `ConfigurationClassParser.DeferredImportSelectorGrouping#getImports`£¬´úÂëÈçÏ£º +我们æ�¥çœ‹çœ‹ `grouping.getImports()` 方法,该方法为 `ConfigurationClassParser.DeferredImportSelectorGrouping#getImports`,代ç �如下: ``` public Iterable getImports() { for (DeferredImportSelectorHolder deferredImport : this.deferredImports) { - // Ö´ÐÐ Group#process + // 执行 Group#process this.group.process(deferredImport.getConfigurationClass().getMetadata(), deferredImport.getImportSelector()); } - // Ö´ÐÐ Group#selectImports + // 执行 Group#selectImports return this.group.selectImports(); } ``` -ÔÚÕâ¸ö·½·¨À»áµ÷Óà `DeferredImportSelector.Group` µÄÁ½¸ö·½·¨£º +在这个方法里,会调用 `DeferredImportSelector.Group` 的两个方法: - `DeferredImportSelector.Group#process` - `DeferredImportSelector.Group#selectImports` -¹ØÓÚÕâÁ½¸ö·½·¨£¬±¾Ð¡½ÚµÄÒ»¿ªÊ¼¾ÍÌù³öÁËÆä´úÂë¼°Æä×¢ÊÍ£¬¶øÒýÈëÀàÕýÊÇÓÉ `DeferredImportSelector.Group#selectImports` ·½·¨·µ»ØµÄ. +关于这两个方法,本å°�节的一开始就贴出了其代ç �å�Šå…¶æ³¨é‡Šï¼Œè€Œå¼•入类正是由 `DeferredImportSelector.Group#selectImports` 方法返回的. -·ÖÎöÁËÀϰëÌ죬×ܽáÏ `DeferredImportSelector` Óë `ImportSelector` Á½ÕßµÄÇø±ð£º +分æž�了è€�å�Šå¤©ï¼Œæ€»ç»“下 `DeferredImportSelector` 与 `ImportSelector` 两者的区别: -- `DeferredImportSelector` ¿ÉÒÔÖ¸¶¨·Ö×飺ÔÚ´¦Àíʱ£¬¿ÉÒÔ¸ù¾Ý·Ö×éͳһ´¦Àí£» -- `DeferredImportSelector` ´¦Àíʱ»ú£º»áÔÚËùÔÚÅäÖÃÀà½âÎöÍêÖ®ºóÔÙ´¦Àí£» -- `DeferredImportSelector` ÒýÈëÀàµÄ·µ»Ø£º²»Í¬ÓÚ `ImportSelector`£¨ÆäÒýÈëÀàÓÉ `ImportSelector#selectImports` ·½·¨·µ»Ø£©£¬ËüµÄÒýÈëÀàÓÉ `DeferredImportSelector.Group#selectImports` ·½·¨·µ»Ø¡£ +- `DeferredImportSelector` å�¯ä»¥æŒ‡å®šåˆ†ç»„:在处ç�†æ—¶ï¼Œå�¯ä»¥æ ¹æ�®åˆ†ç»„统一处ç�†ï¼› +- `DeferredImportSelector` 处ç�†æ—¶æœºï¼šä¼šåœ¨æ‰€åœ¨é…�置类解æž�完之å�Žå†�处ç�†ï¼› +- `DeferredImportSelector` 引入类的返回:ä¸�å�ŒäºŽ `ImportSelector`(其引入类由 `ImportSelector#selectImports` 方法返回),它的引入类由 `DeferredImportSelector.Group#selectImports` 方法返回。 -### 4.7 ×ܽá +### 4.7 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË `ConfigurationClassPostProcessor` ¶Ô `@Import` ×¢½âµÄ´¦Àí£¬×ܽáÈçÏÂ: +本文主è¦�分æž�了 `ConfigurationClassPostProcessor` 对 `@Import` 注解的处ç�†ï¼Œæ€»ç»“如下: -1. `@Import` ¿Éµ¼ÈëµÄÀàÓÐ 4 ÖÖ£¬·Ö±ðÊÇÆÕͨÀà¡¢ÅäÖÃÀࡢʵÏÖÁË `ImportSelector` µÄÀàÒÔ¼°ÊµÏÖÁË `ImportBeanDefinitionRegistrar` µÄÀࣻ -2. »ñÈ¡ `@Import` ×¢½â£ºspring ÔÚ»ñÈ¡ÀàÉ쵀 `@Import` ʱ£¬ÏÈ»ñÈ¡ÀàÉϵÄËùÓÐ×¢½â£¬È»ºóÖðÒ»Åжϣ¬Èç¹ûµ±Ç°×¢½âÊÇ `@Import`£¬Ôò»ñÈ¡ `@Import` µÄÒýÈëµÄÀà (·½·¨Îª `Import#value`)£¬·ñÔò»ñÈ¡µ±Ç°×¢½âÉϵÄËùÓÐ×¢½â£¬Öظ´ÒÔÉÏ´¦Àí£» -3. ´¦Àí `@Import` ÒýÈëµÄÀࣺÆÕͨÀà¡¢ÅäÖÃÀàͳһ°´ÅäÖÃÀàÀ´½âÎö£»ÊµÏÖÁË `ImportSelector` µÄÀ࣬»á´Ó `selectImports(...)` ·½·¨·µ»ØµÄ ¡°°üÃû¡£ÀàÃû¡± ÖÐÄõ½ class£¬È»ºóÒ²Êǰ´ÅäÖÃÀà½âÎö£»ÊµÏÖ `ImportBeanDefinitionRegistrar` µÄÀ࣬»á°Ñ¶ÔÓ¦ÀàµÄʵÀý±£´æµ½µ±Ç°ÅäÖÃÀàÖУ¬ºóÃæ×¢²áµ½ `beanDefinitionMap` ʱ£¬¾ÍÊÇ´ÓÕâÀï»ñÈ¡µÄ£» -4. ½«ÒýÈëÀà×¢²áµ½ `beanDefinitionMap`£ºÊµÏÖÁË `ImportSelector` µÄÀà×îÖյõ½µÄÊÇÒ»¸öÆÕͨÀà»òÅäÖÃÀ࣬ͬÒýÈëµÄÆÕͨÀàÓëÅäÖÃÀàÒ»Ñù£¬Ö±½Ó×¢²á£»ÊµÏÖ `ImportBeanDefinitionRegistrar` µÄÀ࣬µ÷ÓÃÆä `ImportBeanDefinitionRegistrar#registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry)` ·½·¨½øÐÐ×¢²á£¬×¢²áÂß¼­ÓÉʵÏÖÀà×ÔÐж¨Òå¡£ +1. `@Import` å�¯å¯¼å…¥çš„类有 4 ç§�,分别是普通类ã€�é…�置类ã€�实现了 `ImportSelector` 的类以å�Šå®žçŽ°äº† `ImportBeanDefinitionRegistrar` 的类; +2. 获å�– `@Import` 注解:spring 在获å�–类上的 `@Import` 时,先获å�–类上的所有注解,然å�Žé€�一判断,如果当å‰�注解是 `@Import`,则获å�– `@Import` 的引入的类 (方法为 `Import#value`),å�¦åˆ™èŽ·å�–当å‰�注解上的所有注解,é‡�å¤�以上处ç�†ï¼› +3. 处ç�† `@Import` 引入的类:普通类ã€�é…�置类统一按é…�置类æ�¥è§£æž�;实现了 `ImportSelector` 的类,会从 `selectImports(...)` 方法返回的 “包å��。类å��â€� 中拿到 class,然å�Žä¹Ÿæ˜¯æŒ‰é…�置类解æž�;实现 `ImportBeanDefinitionRegistrar` 的类,会把对应类的实例ä¿�存到当å‰�é…�置类中,å�Žé�¢æ³¨å†Œåˆ° `beanDefinitionMap` 时,就是从这里获å�–的; +4. 将引入类注册到 `beanDefinitionMap`:实现了 `ImportSelector` 的类最终得到的是一个普通类或é…�置类,å�Œå¼•入的普通类与é…�置类一样,直接注册;实现 `ImportBeanDefinitionRegistrar` 的类,调用其 `ImportBeanDefinitionRegistrar#registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry)` 方法进行注册,注册逻辑由实现类自行定义。 ------ -*±¾ÎÄÔ­ÎÄÁ´½Ó£ºhttps://my.oschina.net/funcy/blog/4678152 £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£* \ No newline at end of file +*本文原文链接:https://my.oschina.net/funcy/blog/4678152 ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。* \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\272\214\357\274\211\357\274\232\345\244\204\347\220\206@Bean\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\272\214\357\274\211\357\274\232\345\244\204\347\220\206@Bean\346\263\250\350\247\243.md" index 84b7b0f..d64fb98 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\272\214\357\274\211\357\274\232\345\244\204\347\220\206@Bean\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\344\272\214\357\274\211\357\274\232\345\244\204\347\220\206@Bean\346\263\250\350\247\243.md" @@ -1,19 +1,19 @@ -±¾ÎÄÊÇ `ConfigurationClassPostProcessor` ·ÖÎöµÄµÚ¶þƪ£¬Ö÷ÒªÊÇ·ÖÎö spring ¶Ô `@Bean` ×¢½âµÄ´¦ÀíÁ÷³Ì¡£ +本文是 `ConfigurationClassPostProcessor` 分æž�的第二篇,主è¦�是分æž� spring 对 `@Bean` 注解的处ç�†æµ�程。 -## 3\. spring ÊÇÈçºÎ´¦Àí `@Bean` ×¢½âµÄ£¿ +## 3\. spring 是如何处ç�† `@Bean` 注解的? -³Ð½ÓÉÏÎÄ£¬ÎÒÃǼÌÐø·ÖÎö spring ¶Ô `@Bean` ×¢½âµÄ´¦ÀíÁ÷³Ì¡£ +承接上文,我们继续分æž� spring 对 `@Bean` 注解的处ç�†æµ�程。 -### 3.1 demo ×¼±¸ +### 3.1 demo 准备 -ΪÁË˵Ã÷ÎÊÌ⣬ÎÒÃÇÖ±½ÓÉÏ´úÂ룺 +为了说明问题,我们直接上代ç �: -Ê×ÏÈ×¼±¸Á½¸ö Bean: +首先准备两个 Bean: ``` public class BeanObj1 { public BeanObj1() { - System.out.println("µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨"); + System.out.println("调用beanObj1的构造方法"); } @Override @@ -24,7 +24,7 @@ public class BeanObj1 { public class BeanObj2 { public BeanObj2() { - System.out.println("µ÷ÓÃbeanObj2µÄ¹¹Ôì·½·¨"); + System.out.println("调用beanObj2的构造方法"); } @Override @@ -35,9 +35,9 @@ public class BeanObj2 { ``` -×¢Ò⣺ÒÔÉÏÁ½¸öÀ඼ûÓÐ `Component`¡¢`@Service` µÈ×¢½â¡£ +注æ„�:以上两个类都没有 `Component`ã€�`@Service` 等注解。 -ÔÙ×¼±¸Ò»¸öÅäÖÃÀ࣬ͨ¹ý `@Bean` ×¢½âµÄ·½·¨Éú³ÉÁ½¸ö bean£º +å†�准备一个é…�置类,通过 `@Bean` 注解的方法生æˆ�两个 bean: ``` @Component @@ -50,7 +50,7 @@ public class BeanConfigs { @Bean public BeanObj2 beanObj2() { - // ÕâÀïµ÷ÓÃÏ beanObj1() ·½·¨ + // 这里调用下 beanObj1() 方法 beanObj1(); return new BeanObj2(); } @@ -59,7 +59,7 @@ public class BeanConfigs { ``` -×îºóÊÇÆô¶¯Àࣺ +最å�Žæ˜¯å�¯åŠ¨ç±»ï¼š ``` @ComponentScan @@ -78,31 +78,31 @@ public class Demo02Main { ``` -¶ÔÒÔÉÏ ´úÂ룬×öÒÔϼ¸µãÐèҪ˵Ã÷£º +对以上 代ç �,å�šä»¥ä¸‹å‡ ç‚¹éœ€è¦�说明: -* `BeanConfigs` ÀàʹÓõÄ×¢½âµÄÊÇ `@Component`£¬¸ù¾Ý[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4836178)µÄ·ÖÎö£¬`@Component` Ò²ÊôÓÚÅäÖÃÀ࣬½âÎö²½Öèͬ `@Configuration` ×¢½â£» -* ÔÚ `Demo02Main` ÖУ¬´«Èë `AnnotationConfigApplicationContext` ÀàΪ `Demo02Main`£¬ÆäÉÏÓÐÒ»¸ö×¢½â `@ComponentScan`£¬Õâ¸ö×¢½âûָ¶¨°üɨÃè·¾¶£¬¸ù¾Ý[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4836178)µÄ·ÖÎö£¬²»Ö¸¶¨°üɨÃè·¾¶£¬spring »áĬÈÏɨÃèÅäÖÃÀàËùÔÚ°ü£» -* ÎÒÃDz¢Ã»ÓÐÖ±½Ó°Ñ `BeanConfigs` ×¢²áµ½ÈÝÆ÷ÖУ¨Ïñ `new AnnotationConfigApplicationContext(BeanConfigs.class)` ÕâÑù£©£¬´Ó[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4836178)µÄ·ÖÎö¿ÉÖª£¬spring »áÏȽâÎö `Demo02Main` À࣬´¦ÀíÆäÉ쵀 `@Component` ×¢½â£¬´Ó¶øÉ¨Ãèµ½ `BeanConfigs` À࣬Ȼºó»á½âÎö `BeanConfigs`£¬´¦ÀíÄÚ²¿µÄ `@Bean` ·½·¨£¬Õâ¸öÁ÷³ÌÎÒÃǽÓÏÂÀ´Ò²»áͨ¹ýµ÷ÊԵķ½Ê½½øÐÐÑéÖ¤¡£ +* `BeanConfigs` 类使用的注解的是 `@Component`,根æ�®[上一篇文章](https://my.oschina.net/funcy/blog/4836178)的分æž�,`@Component` 也属于é…�置类,解æž�步骤å�Œ `@Configuration` 注解; +* 在 `Demo02Main` 中,传入 `AnnotationConfigApplicationContext` 类为 `Demo02Main`,其上有一个注解 `@ComponentScan`,这个注解没指定包扫æ��路径,根æ�®[上一篇文章](https://my.oschina.net/funcy/blog/4836178)的分æž�,ä¸�指定包扫æ��路径,spring 会默认扫æ��é…�置类所在包; +* 我们并没有直接把 `BeanConfigs` 注册到容器中(åƒ� `new AnnotationConfigApplicationContext(BeanConfigs.class)` 这样),从[上一篇文章](https://my.oschina.net/funcy/blog/4836178)的分æž�å�¯çŸ¥ï¼Œspring 会先解æž� `Demo02Main` 类,处ç�†å…¶ä¸Šçš„ `@Component` 注解,从而扫æ��到 `BeanConfigs` 类,然å�Žä¼šè§£æž� `BeanConfigs`,处ç�†å†…部的 `@Bean` 方法,这个æµ�程我们接下æ�¥ä¹Ÿä¼šé€šè¿‡è°ƒè¯•的方å¼�进行验è¯�。 -ÔËÐÐÒÔÉÏ´úÂ룬½á¹ûÈçÏ£º +è¿�行以上代ç �,结果如下: ``` -µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨ -µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨ -µ÷ÓÃbeanObj2µÄ¹¹Ôì·½·¨ +调用beanObj1的构造方法 +调用beanObj1的构造方法 +调用beanObj2的构造方法 obj1:BeanObj1{} obj2:BeanObj2{} org.springframework.learn.explore.demo05.BeanConfigs@2b71e916 ``` -½ÓÏÂÀ´£¬¾ÍÒÔÕâ¸ö demo ½øÐзÖÎö¡£ +接下æ�¥ï¼Œå°±ä»¥è¿™ä¸ª demo 进行分æž�。 -**×¢Òâ**£º±¾ÎÄÊÇ `ConfigurationClassPostProcessor` ·ÖÎöµÄµÚ¶þƪ£¬¶ÔÓë[µÚһƪ](https://my.oschina.net/funcy/blog/4836178)À×ͬµÄ´úÂ룬±¾ÎÄÖ»Ò»±Ê´ø¹ý£¬²»»áÔÙ½øÐÐÏêϸ·ÖÎö¡£ +**注æ„�**:本文是 `ConfigurationClassPostProcessor` 分æž�的第二篇,对与[第一篇](https://my.oschina.net/funcy/blog/4836178)é›·å�Œçš„代ç �,本文å�ªä¸€ç¬”带过,ä¸�会å†�进行详细分æž�。 -### 3.2 ´¦ÀíÅäÖÃÀࣺConfigurationClassPostProcessor#processConfigBeanDefinitions +### 3.2 处ç�†é…�置类:ConfigurationClassPostProcessor#processConfigBeanDefinitions -ÎÒÃÇÖ±½Ó½øÈë `ConfigurationClassPostProcessor#processConfigBeanDefinitions` ·½·¨£¬µ÷ÓÃÁ´ÈçÏ£º +我们直接进入 `ConfigurationClassPostProcessor#processConfigBeanDefinitions` 方法,调用链如下: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) @@ -116,13 +116,13 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) ``` -´ËʱµÄ `candidates` Ö»ÓÐÒ»¸ö ÔªËØ£º +此时的 `candidates` å�ªæœ‰ä¸€ä¸ª 元素: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0d50f32d5ea1d2b79b8e17612d30693f753.png) -### 3.2 ½âÎö `demo02Main`£ºConfigurationClassParser#doProcessConfigurationClass +### 3.2 è§£æž� `demo02Main`:ConfigurationClassParser#doProcessConfigurationClass -ÕâÒ»¿é¾ÍÊǽâÎö `@ComponentScan` ×¢½âµÄ¹ý³Ì£¬[µÚһƪ](https://my.oschina.net/funcy/blog/4836178)ÒÑÏêϸ·ÖÎö¹ý£¬ÕâÀïÖ»¸ø³öµ÷ÓÃÕ»£º +这一å�—就是解æž� `@ComponentScan` 注解的过程,[第一篇](https://my.oschina.net/funcy/blog/4836178)已详细分æž�过,这里å�ªç»™å‡ºè°ƒç”¨æ ˆï¼š ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) @@ -140,15 +140,15 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) ``` -´¦Àí `Demo02Main` µÄ `@ComponentScan` Ö®ºó£¬¿ÉÒÔ¿´µ½ `beanConfigs` ÒѾ­É¨Ãèµ½ÁË£º +处ç�† `Demo02Main` çš„ `@ComponentScan` 之å�Žï¼Œå�¯ä»¥çœ‹åˆ° `beanConfigs` å·²ç»�扫æ��到了: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-7fef6007424562f63dda7f2a0b25e9c293b.png) -ÓÉÓÚ `beanConfigs` ÊÇÅäÖÃÀ࣬Òò´Ë»á¶ÔÆä½øÐнâÎö£º +由于 `beanConfigs` 是é…�置类,因此会对其进行解æž�: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fba3821df9cf2926b16bd064cf164e83471.png) -×îÖÕ»¹ÊÇ»á»Øµ½ `ConfigurationClassParser#doProcessConfigurationClass`£¬ÆäÖеĵ÷ÓÃÁ´ÈçÏ£º +最终还是会回到 `ConfigurationClassParser#doProcessConfigurationClass`,其中的调用链如下: ``` AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) @@ -169,54 +169,54 @@ AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class) ``` -´ËʱµÄ `ConfigurationClassParser#doProcessConfigurationClass`£¬Ö÷½Ç¾Í²»ÔÙÊÇ `demo02Main`£¬¶øÊÇ `beanConfigs` ÁË¡£ +此时的 `ConfigurationClassParser#doProcessConfigurationClass`,主角就ä¸�å†�是 `demo02Main`,而是 `beanConfigs` 了。 -### 3.3 ½âÎö `beanConfigs`£ºConfigurationClassParser#doProcessConfigurationClass +### 3.3 è§£æž� `beanConfigs`:ConfigurationClassParser#doProcessConfigurationClass -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `ConfigurationClassParser#doProcessConfigurationClass` ¶Ô `@Bean` ×¢½âµÄ´¦Àí£¬´úÂëÈçÏ£º +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `ConfigurationClassParser#doProcessConfigurationClass` 对 `@Bean` 注解的处ç�†ï¼Œä»£ç �如下: ``` /** - * Õâ¸ö·½·¨²ÅÊÇÕæÕý´¦Àí½âÎöµÄ·½·¨ + * 这个方法æ‰�是真正处ç�†è§£æž�的方法 */ protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass) throws IOException { - // 1\. Èç¹ûÊÇ @Component ×¢½â£¬µÝ¹é´¦ÀíÄÚ²¿À࣬±¾ÎIJ»¹Ø×¢ + // 1\. 如果是 @Component 注解,递归处ç�†å†…部类,本文ä¸�关注 ... - // 2\. ´¦Àí@PropertySource×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 2\. 处ç�†@PropertySource注解,本文ä¸�关注 ... - // 3\. ´¦Àí @ComponentScan/@ComponentScans ×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 3\. 处ç�† @ComponentScan/@ComponentScans 注解,本文ä¸�关注 ... - // 4\. ´¦Àí@Import×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 4\. 处ç�†@Import注解,本文ä¸�关注 ... - // 5\. ´¦Àí@ImportResource×¢½â£¬±¾ÎIJ»¹Ø×¢ + // 5\. 处ç�†@ImportResource注解,本文ä¸�关注 ... - // 6\. ´¦Àí@BeanµÄ×¢½â - // ¾ßÌåµÄ½âÎö´úÂë + // 6\. 处ç�†@Bean的注解 + // 具体的解æž�代ç � Set beanMethods = retrieveBeanMethodMetadata(sourceClass); for (MethodMetadata methodMetadata : beanMethods) { - // Ìí¼Óµ½ configClass ÖУ¬ºóÃæÔÙ´¦Àí + // 添加到 configClass 中,å�Žé�¢å†�处ç�† configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass)); } - // 7\. ·µ»ØÅäÖÃÀàµÄ¸¸À࣬»áÔÚ processConfigurationClass(...) ·½·¨µÄÏÂÒ»´ÎÑ­»·Ê±½âÎö + // 7\. 返回é…�置类的父类,会在 processConfigurationClass(...) 方法的下一次循环时解æž� ... return null; } ``` -»ñÈ¡ `@Bean` µÄ·½·¨µ÷ÓõÄÊÇ `retrieveBeanMethodMetadata(...)`£¬ÎÒÃǸú½øÈ¥£º +获å�– `@Bean` 的方法调用的是 `retrieveBeanMethodMetadata(...)`,我们跟进去: ``` private Set retrieveBeanMethodMetadata(SourceClass sourceClass) { AnnotationMetadata original = sourceClass.getMetadata(); - // »ñÈ¡°üº¬ @Bean ×¢½âµÄ·½·¨ + // 获å�–包å�« @Bean 注解的方法 Set beanMethods = original.getAnnotatedMethods(Bean.class.getName()); ... return beanMethods; @@ -224,17 +224,17 @@ private Set retrieveBeanMethodMetadata(SourceClass sourceClass) ``` -ÔÙ¸ú½øÈ¥£¬×îÖÕµ÷ÓõÄÊÇ `StandardAnnotationMetadata#getAnnotatedMethods`: +å†�跟进去,最终调用的是 `StandardAnnotationMetadata#getAnnotatedMethods`: ``` public Set getAnnotatedMethods(String annotationName) { Set annotatedMethods = null; if (AnnotationUtils.isCandidateClass(getIntrospectedClass(), annotationName)) { try { - // 1\. ͨ¹ý·´ÉäÀàµÄ»ñÈ¡ËùÓеķ½·¨ + // 1\. 通过å��射类的获å�–所有的方法 Method[] methods = ReflectionUtils.getDeclaredMethods(getIntrospectedClass()); for (Method method : methods) { - // 2\. ÅжÏÊÇ·ñÓÐ @Bean ×¢½â + // 2\. 判断是å�¦æœ‰ @Bean 注解 if (isAnnotatedMethod(method, annotationName)) { if (annotatedMethods == null) { annotatedMethods = new LinkedHashSet<>(4); @@ -245,7 +245,7 @@ public Set getAnnotatedMethods(String annotationName) { } } catch (Throwable ex) { - throw new IllegalStateException(¡£¡£¡£); + throw new IllegalStateException(。。。); } } return annotatedMethods != null ? annotatedMethods : Collections.emptySet(); @@ -253,53 +253,53 @@ public Set getAnnotatedMethods(String annotationName) { ``` -Õâ¸ö·½·¨ºÜºÃÀí½â£¬¹Ø¼ü¾ÍÁ½²½£º +这个方法很好ç�†è§£ï¼Œå…³é”®å°±ä¸¤æ­¥ï¼š -1. ͨ¹ý·´Éä»ñÈ¡ÀàÖÐËùÓз½·¨£» -2. ±éÀúµÃµ½µÄ·½·¨£¬ÖðÒ»Åжϸ÷½·¨ÊÇ·ñÓÐ `@Bean` ×¢½â£» +1. 通过å��射获å�–类中所有方法; +2. é��历得到的方法,é€�一判断该方法是å�¦æœ‰ `@Bean` 注解; -µ½ÁËÕâÀ`beanConfigs` ÖеÄÁ½¸ö·½·¨ÖÕÓÚ»ñÈ¡µ½ÁË£¨±£´æÔÚ `ConfigurationClass` ¶ÔÏóµÄ `beanMethods` ÊôÐÔ£©£º +到了这里,`beanConfigs` 中的两个方法终于获å�–到了(ä¿�存在 `ConfigurationClass` 对象的 `beanMethods` 属性): ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-121f4d518fa57c8932e6b7fd3e7def8704b.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a4d91c1f52703b8c911bdb9d9afaf697d92.png) -### 3.4 ½«±» `@Bean` ±ê¼ÇµÄ·½·¨¼ÓÔØµ½ `BeanDefinitionMap` +### 3.4 将被 `@Bean` 标记的方法加载到 `BeanDefinitionMap` -ÉÏÃæ»ñÈ¡µ½µÄ `beanMethod` ´Ëʱ»¹Ö»ÊÇÔÚ `ConfigurationClass` ¶ÔÏóµÄ `beanMethods` ÊôÐÔÖУ¬²¢Ã»ÓмÓÔØµ½ `beanFactory` µÄ `BeanDefinitionMap` ÖУ¬±¾Ð¡½ÚÀ´Ì½¾¿ÏÂËüÃÇÊǺÎʱ·ÅÈëµ½ `BeanDefinitionMap` ÖС£ +上é�¢èŽ·å�–到的 `beanMethod` 此时还å�ªæ˜¯åœ¨ `ConfigurationClass` 对象的 `beanMethods` 属性中,并没有加载到 `beanFactory` çš„ `BeanDefinitionMap` 中,本å°�节æ�¥æŽ¢ç©¶ä¸‹å®ƒä»¬æ˜¯ä½•时放入到 `BeanDefinitionMap` 中。 -»¹¼ÇµÃ `ConfigurationClassPostProcessor#processConfigBeanDefinition` Âð£¬ÆäÖÐÓÐÕâôһÐдúÂ룺 +还记得 `ConfigurationClassPostProcessor#processConfigBeanDefinition` å�—,其中有这么一行代ç �: ``` public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { ... - // ´¦Àí±¾´Î½âÎöµÄÀà - // °Ñ @Import ÒýÈëµÄÀà¡¢ÅäÖÃÀàÖдø@BeanµÄ·½·¨¡¢@ImportResource ÒýÈëµÄ×ÊÔ´µÈת»»³ÉBeanDefinition + // 处ç�†æœ¬æ¬¡è§£æž�的类 + // 把 @Import 引入的类ã€�é…�置类中带@Bean的方法ã€�@ImportResource 引入的资æº�等转æ�¢æˆ�BeanDefinition this.reader.loadBeanDefinitions(configClasses); ... } ``` -Õâ¾ÍÊǼÓÔØÒýÈëµÄ `BeanDefinition` µÄµØ·½£¬¼´°Ñ `@Import` ÒýÈëµÄÀà¡¢ÅäÖÃÀàÖдø `@Bean` µÄ·½·¨¡¢`@ImportResource` ÒýÈëµÄ×ÊÔ´µÈת»»³É `BeanDefinition`£¬±¾ÎÄÖØµã¹Ø×¢ `@Bean` ·½·¨µÄ´¦Àí£¬´úÂëÈçÏ£º +这就是加载引入的 `BeanDefinition` 的地方,å�³æŠŠ `@Import` 引入的类ã€�é…�置类中带 `@Bean` 的方法ã€�`@ImportResource` 引入的资æº�等转æ�¢æˆ� `BeanDefinition`,本文é‡�点关注 `@Bean` 方法的处ç�†ï¼Œä»£ç �如下: > ConfigurationClassBeanDefinitionReader ``` public void loadBeanDefinitions(Set configurationModel) { TrackedConditionEvaluator trackedConditionEvaluator = new TrackedConditionEvaluator(); - // ±éÀú´¦Àí´«ÈëµÄ configurationModel + // é��历处ç�†ä¼ å…¥çš„ configurationModel for (ConfigurationClass configClass : configurationModel) { loadBeanDefinitionsForConfigurationClass(configClass, trackedConditionEvaluator); } } /** - * Õâ¸ö·½·¨»á¼ÓÔØ¸÷ÖÖ ConfigurationClass ÒýÈëµÄ BeanDefinition - * 1\. @Import ÒýÈëµÄÀà - * 2\. ÅäÖÃÀàÖÐµÄ @Bean ·½·¨ - * 3\. @ImportResource ÒýÈëµÄ×ÊÔ´ - * 4\. @Import ÒýÈëµÄ ImportBeanDefinitionRegistrar + * 这个方法会加载å�„ç§� ConfigurationClass 引入的 BeanDefinition + * 1\. @Import 引入的类 + * 2\. é…�置类中的 @Bean 方法 + * 3\. @ImportResource 引入的资æº� + * 4\. @Import 引入的 ImportBeanDefinitionRegistrar */ private void loadBeanDefinitionsForConfigurationClass( ConfigurationClass configClass, TrackedConditionEvaluator trackedConditionEvaluator) { @@ -308,25 +308,25 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { ... } - // ´¦Àí @Import ÒýÈëµÄÅäÖÃÀà + // 处ç�† @Import 引入的é…�置类 if (configClass.isImported()) { registerBeanDefinitionForImportedConfigurationClass(configClass); } - // ´¦Àí @Bean ·½·¨ + // 处ç�† @Bean 方法 for (BeanMethod beanMethod : configClass.getBeanMethods()) { loadBeanDefinitionsForBeanMethod(beanMethod); } - // ´¦Àí @ImportResource ÒýÈëµÄ×ÊÔ´ + // 处ç�† @ImportResource 引入的资æº� loadBeanDefinitionsFromImportedResources(configClass.getImportedResources()); - // ´¦Àí @Import ÒýÈëµÄ ImportBeanDefinitionRegistrar + // 处ç�† @Import 引入的 ImportBeanDefinitionRegistrar loadBeanDefinitionsFromRegistrars(configClass.getImportBeanDefinitionRegistrars()); } /** - * ´¦Àí @Bean ·½·¨ - * 1\. ´´½¨BeanDefinition£¬beanMethod ʹÓõÄÊÇ ConfigurationClassBeanDefinition - * 2\. ´¦Àí @Bean µÄ¸÷ÖÖÊôÐÔ£¬ÉèÖõ½ BeanDefinition ÖÐ - * 3\. ½« BeanDefinition ×¢²áµ½ beanFactory ÖÐ + * 处ç�† @Bean 方法 + * 1\. 创建BeanDefinition,beanMethod 使用的是 ConfigurationClassBeanDefinition + * 2\. 处ç�† @Bean çš„å�„ç§�属性,设置到 BeanDefinition 中 + * 3\. å°† BeanDefinition 注册到 beanFactory 中 */ private void loadBeanDefinitionsForBeanMethod(BeanMethod beanMethod) { ConfigurationClass configClass = beanMethod.getConfigurationClass(); @@ -335,15 +335,15 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { ... - // 1\. beanMethodʹÓõÄÊÇConfigurationClassBeanDefinition + // 1\. beanMethod使用的是ConfigurationClassBeanDefinition ConfigurationClassBeanDefinition beanDef = new ConfigurationClassBeanDefinition(configClass, metadata); beanDef.setResource(configClass.getResource()); beanDef.setSource(this.sourceExtractor.extractSource(metadata, configClass.getResource())); - // 2\. ´¦Àí @Bean µÄ¸÷ÖÖÊôÐÔ + // 2\. 处ç�† @Bean çš„å�„ç§�属性 if (metadata.isStatic()) { - // ¾²Ì¬ @Bean ·½·¨ + // é�™æ€� @Bean 方法 if (configClass.getMetadata() instanceof StandardAnnotationMetadata) { beanDef.setBeanClass( ((StandardAnnotationMetadata) configClass.getMetadata()).getIntrospectedClass()); @@ -354,7 +354,7 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { beanDef.setUniqueFactoryMethodName(methodName); } else { - // ÆÕͨµÄ @Bean ·½·¨ + // 普通的 @Bean 方法 beanDef.setFactoryBeanName(configClass.getBeanName()); beanDef.setUniqueFactoryMethodName(methodName); } @@ -391,54 +391,54 @@ public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) { ... - // 3\. ½«BeanDefinition×¢²áµ½beanFactoryÖÐ + // 3\. å°†BeanDefinition注册到beanFactory中 this.registry.registerBeanDefinition(beanName, beanDefToRegister); } ``` -`ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` ÓÖµ÷ÓÃÁËÁ½¸ö·½·¨£¬×îÖÕ´¦ÀíÊÇÔÚ `ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForBeanMethod`£¬Õⲿ·ÖÂß¼­ÈçÏ£º +`ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` å�ˆè°ƒç”¨äº†ä¸¤ä¸ªæ–¹æ³•,最终处ç�†æ˜¯åœ¨ `ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForBeanMethod`,这部分逻辑如下: -1. ±éÀú´«ÈëµÄ `configClass` ¼¯ºÏ£¬¶Ôÿ¸ö `configClass` ½øÐÐ `Definitions` ¼ÓÔØ´¦Àí£» -2. ¶Ô `configClass` ½øÐÐ `Definitions` ¼ÓÔØ´¦Àíʱ£¬»áÖðÒ»´¦Àí `@Import`/`@Bean`/`@ImportResource` µÈ×¢½â£¬±¾Ð¡½ÚÎÒÃǽö¹Ø×¢ `@Bean` µÄ´¦Àí£» -3. ´¦Àí `@Bean` ·½·¨Ê±£¬ÏÈ´´½¨ `BeanDefinition`(`@Bean` ·½·¨¶ÔÓ¦µÄ `BeanDefinition` ÊÇ `ConfigurationClassBeanDefinition`)£¬È»ºó½âÎö `@Bean` µÄÊôÐÔ£¬ÉèÖõ½ `BeanDefinition` ÖУ¬×îÖÕÊÇ°Ñ `BeanDefinition` ×¢²áµ½ `beanFactory` ÖÐ. +1. é��历传入的 `configClass` 集å�ˆï¼Œå¯¹æ¯�个 `configClass` 进行 `Definitions` 加载处ç�†ï¼› +2. 对 `configClass` 进行 `Definitions` 加载处ç�†æ—¶ï¼Œä¼šé€�一处ç�† `@Import`/`@Bean`/`@ImportResource` 等注解,本å°�节我们仅关注 `@Bean` 的处ç�†ï¼› +3. 处ç�† `@Bean` 方法时,先创建 `BeanDefinition`(`@Bean` 方法对应的 `BeanDefinition` 是 `ConfigurationClassBeanDefinition`),然å�Žè§£æž� `@Bean` 的属性,设置到 `BeanDefinition` 中,最终是把 `BeanDefinition` 注册到 `beanFactory` 中. -ºÃ ÁË£¬Ö´ÐÐÍê `ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` ºó£¬`BeanDefinition` ¾Í¼ÓÔØµ½ `beanFactory` ÁË£¬¶ÔÓ¦µÄ `BeanDefinition` ÀàÐÍÊÇ `ConfigurationClassBeanDefinition`. +好 了,执行完 `ConfigurationClassBeanDefinitionReader#loadBeanDefinitions` å�Žï¼Œ`BeanDefinition` 就加载到 `beanFactory` 了,对应的 `BeanDefinition` 类型是 `ConfigurationClassBeanDefinition`. -### 3.5 `@Bean` ´´½¨ÊµÀý +### 3.5 `@Bean` 创建实例 -ʵÀýµÄ´´½¨Á÷³ÌͬÆÕͨµÄ `@Component` ÀàÒ»Ö£¬²»Í¬µÄÊÇÆÕͨµÄ `@Component` Ààµ÷ÓõÄÊǹ¹Ôì·½·¨£¬¶ø `@Bean` ʹÓõÄÊÇ `factoryMethod`£¬´úÂëÈçÏ£º +实例的创建æµ�程å�Œæ™®é€šçš„ `@Component` 类一致,ä¸�å�Œçš„æ˜¯æ™®é€šçš„ `@Component` 类调用的是构造方法,而 `@Bean` 使用的是 `factoryMethod`,代ç �如下: > AbstractAutowireCapableBeanFactory#createBeanInstance ``` /** - * ʵÀýµÄ´´½¨·½Ê½ - * 1\. ʹÓà instanceSupplier£¬SupplierÊÇjava8ÌṩµÄÀ࣬¿ÉÒÔ´«ÈëÒ»¸ölambda±í´ïʽ - * 2\. ʹÓù¤³§·½·¨£¬Èç @Bean ×¢½â¶ÔÓ¦µÄ·½·¨ - * 3\. ʹÓõÄÊǹ¹Ôì·½·¨×¢È룬¼´¹¹Ôì·½·¨ÉÏÓÐ @Autowired ×¢½â - * 4\. ¹¹Ôì·½·¨×¢È룬¿ÉÒÔÊÇÎ޲ι¹Ô죬Ҳ¿ÉÒÔÊÇÓвι¹Ôì + * 实例的创建方å¼� + * 1\. 使用 instanceSupplier,Supplier是java8æ��供的类,å�¯ä»¥ä¼ å…¥ä¸€ä¸ªlambda表达å¼� + * 2\. 使用工厂方法,如 @Bean 注解对应的方法 + * 3\. 使用的是构造方法注入,å�³æž„造方法上有 @Autowired 注解 + * 4\. 构造方法注入,å�¯ä»¥æ˜¯æ— å�‚构造,也å�¯ä»¥æ˜¯æœ‰å�‚构造 * */ protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) { - // È·±£ÒѾ­¼ÓÔØÁË´Ë class + // ç¡®ä¿�å·²ç»�加载了此 class Class beanClass = resolveBeanClass(mbd, beanName); ... - // ÊÇ·ñÉèÖÃÁËbean´´½¨µÄSupplier£¬SupplierÊÇjava8ÌṩµÄÀ࣬¿ÉÒÔ´«ÈëÒ»¸ölambda±í´ïʽ - // µ÷Óà AbstractBeanDefinition#setInstanceSupplier Ö¸¶¨ + // 是å�¦è®¾ç½®äº†bean创建的Supplier,Supplier是java8æ��供的类,å�¯ä»¥ä¼ å…¥ä¸€ä¸ªlambda表达å¼� + // 调用 AbstractBeanDefinition#setInstanceSupplier 指定 Supplier instanceSupplier = mbd.getInstanceSupplier(); if (instanceSupplier != null) { return obtainFromSupplier(instanceSupplier, beanName); } if (mbd.getFactoryMethodName() != null) { - // ²ÉÓù¤³§·½·¨ÊµÀý»¯ + // 采用工厂方法实例化 return instantiateUsingFactoryMethod(beanName, mbd, args); } - // ÊÇ·ñµÚÒ»´Î + // 是å�¦ç¬¬ä¸€æ¬¡ boolean resolved = false; - // ÊÇ·ñ²ÉÓù¹Ô캯Êý×¢Èë + // 是å�¦é‡‡ç”¨æž„造函数注入 boolean autowireNecessary = false; ... if (resolved) { @@ -446,12 +446,12 @@ protected BeanWrapper createBeanInstance(String beanName, return autowireConstructor(beanName, mbd, null, null); } else { - // Î޲ι¹Ô캯Êý + // æ— å�‚构造函数 return instantiateBean(beanName, mbd); } } // Candidate constructors for autowiring? - // ÅжÏÊÇ·ñ²ÉÓÃÓвι¹Ô캯Êý + // 判断是å�¦é‡‡ç”¨æœ‰å�‚构造函数 Constructor[] ctors = determineConstructorsFromBeanPostProcessors( beanClass, beanName); if (ctors != null || mbd.getResolvedAutowireMode() == AUTOWIRE_CONSTRUCTOR || @@ -460,23 +460,23 @@ protected BeanWrapper createBeanInstance(String beanName, } ctors = mbd.getPreferredConstructors(); if (ctors != null) { - // ¹¹Ô캯ÊýÒÀÀµ×¢Èë + // 构造函数ä¾�赖注入 return autowireConstructor(beanName, mbd, ctors, null); } - // µ÷ÓÃÎ޲ι¹Ô캯Êý + // 调用无å�‚构造函数 return instantiateBean(beanName, mbd); } ``` -´Ó´úÂëÉÏÀ´¿´£¬spring ʵÀý¶ÔÏóµÄ·½Ê½ÓÐ 4 ÖÖ£º +从代ç �上æ�¥çœ‹ï¼Œspring 实例对象的方å¼�有 4 ç§�: -1. ʹÓà `instanceSupplier`£¬`Supplier` ÊÇ `java8` ÌṩµÄÀ࣬¿ÉÒÔ´«ÈëÒ»¸ö `lambda` ±í´ïʽ -2. ʹÓù¤³§·½·¨£¬Èç `@Bean` ×¢½â¶ÔÓ¦µÄ·½·¨ -3. ʹÓõÄÊǹ¹Ôì·½·¨×¢È룬¼´¹¹Ôì·½·¨ÉÏÓÐ `@Autowired` ×¢½â -4. ¹¹Ôì·½·¨×¢È룬¿ÉÒÔÊÇÎ޲ι¹Ô죬Ҳ¿ÉÒÔÊÇÓвι¹Ôì +1. 使用 `instanceSupplier`,`Supplier` 是 `java8` æ��供的类,å�¯ä»¥ä¼ å…¥ä¸€ä¸ª `lambda` 表达å¼� +2. 使用工厂方法,如 `@Bean` 注解对应的方法 +3. 使用的是构造方法注入,å�³æž„造方法上有 `@Autowired` 注解 +4. 构造方法注入,å�¯ä»¥æ˜¯æ— å�‚构造,也å�¯ä»¥æ˜¯æœ‰å�‚构造 -ÕâÀïÎÒÃÇÖ÷Òª¹Ø×¢ `@Bean` µÄʵÀý·½Ê½£¬Ò²¾ÍÊǹ¤³§·½·¨ÊµÀý»¯·½Ê½£¬ÎÒÃǽøÈ¥¿´Ï£º +这里我们主è¦�关注 `@Bean` 的实例方å¼�,也就是工厂方法实例化方å¼�,我们进去看下: ``` public BeanWrapper instantiateUsingFactoryMethod(String beanName, @@ -497,7 +497,7 @@ public BeanWrapper instantiateUsingFactoryMethod(String beanName, Method factoryMethodToUse = null; ArgumentsHolder argsHolderToUse = null; Object[] argsToUse = null; - // ´¦Àí factoryMethod µÄ²ÎÊý + // 处ç�† factoryMethod çš„å�‚æ•° if (explicitArgs != null) { argsToUse = explicitArgs; } @@ -516,7 +516,7 @@ public BeanWrapper instantiateUsingFactoryMethod(String beanName, candidates = Collections.singletonList(factoryMethodToUse); } } - // Ê¡ÂÔÁ˺öà´úÂë + // çœ�略了好多代ç � ... } bw.setBeanInstance(instantiate(beanName, mbd, @@ -526,13 +526,13 @@ public BeanWrapper instantiateUsingFactoryMethod(String beanName, ``` -ÒÔÉÏ·½·¨ÊǾ­¾«¼òºóµÄ´úÂ룬ԭ±¾·½·¨´úÂë±È½Ï¶à£¬´ó²¿·Ö´úÂëÊÇÔÚÔÚ´¦Àí `argsToUse` Óë `factoryMethodToUse` ²ÎÊý£¬Ï¸½Ú·Ç³£¶à£¬¾Í²»Õ¹¿ª·ÖÎöÁË£¬ÕâÀïÎÒÃÇÖ÷Òª¹Ø×¢ÒÔϼ¸¸ö±äÁ¿£º +以上方法是ç»�精简å�Žçš„代ç �,原本方法代ç �比较多,大部分代ç �是在在处ç�† `argsToUse` 与 `factoryMethodToUse` å�‚数,细节é�žå¸¸å¤šï¼Œå°±ä¸�展开分æž�了,这里我们主è¦�关注以下几个å�˜é‡�: -1. `factoryBean`£º `@Bean` ·½·¨ËùÔÚÀàµÄʵÀý£¬ÕâÀïÊÇ `beanConfig`; -2. `factoryMethodToUse`: ʵÀý»¯ËùÓõķ½·¨£¬Ò²¾ÍÊDZ» `@Bean` ×¢½âµÄ·½·¨£¬ÕâÀïÊÇ `BeanConfigs#beanObj1`; -3. `argsToUse`£º±» `@Bean` ×¢½âµÄ·½·¨ÒªÓõIJÎÊý£¬ÓÉÓÚ `BeanConfigs#beanObj1` ûÓÐÖ¸¶¨²ÎÊý£¬ÕâÀïÊÇ null; +1. `factoryBean`: `@Bean` 方法所在类的实例,这里是 `beanConfig`; +2. `factoryMethodToUse`: 实例化所用的方法,也就是被 `@Bean` 注解的方法,这里是 `BeanConfigs#beanObj1`; +3. `argsToUse`:被 `@Bean` 注解的方法è¦�用的å�‚数,由于 `BeanConfigs#beanObj1` 没有指定å�‚数,这里是 null; -ÕâÈý¸ö±äÁ¿ÊÇÓÃÀ´½øÐÐʵÀý»¯µÄ±äÁ¿£¬ÊµÀý»¯·½Ê½´óÖÂÒ²ÄÜÏëµ½ÁË£¬ÊµÀý¡¢·½·¨¼°·½·¨²ÎÊý¶¼ÓÐÁË£¬½ÓÏÂÀ´¾ÍÊǵ÷Ó÷´Éä½øÐÐʵÀý»¯ÁË£º +这三个å�˜é‡�是用æ�¥è¿›è¡Œå®žä¾‹åŒ–çš„å�˜é‡�,实例化方å¼�大致也能想到了,实例ã€�方法å�Šæ–¹æ³•å�‚数都有了,接下æ�¥å°±æ˜¯è°ƒç”¨å��射进行实例化了: > ConstructorResolver#instantiate(...) @@ -561,7 +561,7 @@ public Object instantiate(RootBeanDefinition bd, @Nullable String beanName, Bean ... try { currentlyInvokedFactoryMethod.set(factoryMethod); - // ÕâÀï¾ÍÏ൱ÓÚµ÷Óà beanConfigs.beanObj1() + // 这里就相当于调用 beanConfigs.beanObj1() Object result = factoryMethod.invoke(factoryBean, args); if (result == null) { result = new NullBean(); @@ -579,13 +579,13 @@ public Object instantiate(RootBeanDefinition bd, @Nullable String beanName, Bean ``` -×îÖÕÊÇÔÚ `SimpleInstantiationStrategy#instantiate(...)` ·½·¨ÖнøÐз´ÉäʵÀý»¯ÁË£¡ +最终是在 `SimpleInstantiationStrategy#instantiate(...)` 方法中进行å��射实例化了ï¼� -ʵÀý»¯Íê³Éºó£¬ºóÃæÒÀÀµ×¢Èë¡¢³õʼ»¯µÈ¶¼ÓëÆÕͨµÄ spring bean Ò»Ö£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË¡£ +实例化完æˆ�å�Žï¼Œå�Žé�¢ä¾�赖注入ã€�åˆ�始化等都与普通的 spring bean 一致,这里就ä¸�å†�分æž�了。 -### 3.6 `@Configuration` Óë `@Bean` ×éºÏʹÓà +### 3.6 `@Configuration` 与 `@Bean` 组å�ˆä½¿ç”¨ -ÉÏÃæ½éÉÜÁË `@Component` Óë `@Bean` ʹÓÃʱµÄ´úÂë·ÖÎö£¬¼´ +上é�¢ä»‹ç»�了 `@Component` 与 `@Bean` 使用时的代ç �分æž�,å�³ ``` @Component @@ -598,7 +598,7 @@ public class BeanConfigs { ``` -ʵ¼ÊÉÏ£¬´ó¶àÊýÇé¿öÏÂÎÒÃÇʹÓõÄÊÇ `@Configuration` Óë `@Bean` µÄ×éºÏ£º +实际上,大多数情况下我们使用的是 `@Configuration` 与 `@Bean` 的组å�ˆï¼š ``` @Configuration @@ -611,11 +611,11 @@ public class BeanConfigs { ``` -ÕâÓëÎÒÃÇÇ°ÃæÊ¹ÓÃµÄ `@Component` Óкβî±ðÄØ£¿±¾½ÚÎÒÃǾÍÀ´·ÖÎöÏ¡£ +这与我们å‰�é�¢ä½¿ç”¨çš„ `@Component` 有何差别呢?本节我们就æ�¥åˆ†æž�下。 -#### 1\. demo ×¼±¸ +#### 1\. demo 准备 -demo ×¼±¸£º +demo 准备: ``` //@Component @@ -629,7 +629,7 @@ public class BeanConfigs { @Bean public BeanObj2 beanObj2() { - // ÕâÀïµ÷ÓÃÏ beanObj1() ·½·¨ + // 这里调用下 beanObj1() 方法 beanObj1(); return new BeanObj2(); } @@ -638,35 +638,35 @@ public class BeanConfigs { ``` -Õâ¸ö demo ½ö½öÖ»Êǽ« `@Component` Ìæ»»Îª `@Configuration`£¬Ö´ÐÐÏ£¬½á¹ûÈçÏ£º +这个 demo ä»…ä»…å�ªæ˜¯å°† `@Component` 替æ�¢ä¸º `@Configuration`,执行下,结果如下: ``` -µ÷ÓÃbeanObj1µÄ¹¹Ôì·½·¨ -µ÷ÓÃbeanObj2µÄ¹¹Ôì·½·¨ +调用beanObj1的构造方法 +调用beanObj2的构造方法 obj1:BeanObj1{} obj2:BeanObj2{} org.springframework.learn.explore.demo02.BeanConfigs$$EnhancerBySpringCGLIB$$dca1c55b@75c072cb ``` -¿´³öÇø±ðÁËÂð£¬ÎÒÃǽ«Ö®Ç°µÄÖ´ÐÐÒ²·ÅÔÚÕâÀ +看出区别了å�—,我们将之å‰�的执行也放在这里: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-88e5047479e4f30e70d09397d2631c0c6a5.png) -¾­¹ý±È½Ï£¬·¢ÏÖÓÐÁ½´¦²»Í¬£º +ç»�过比较,å�‘现有两处ä¸�å�Œï¼š -1. `beanObj1` µÄ¹¹Ôì·½·¨½öµ÷ÓÃÁËÒ»´Î£» -2. `beanConfigs` ¶ÔÓ¦µÄÀàÊÇ `BeanConfigs$$EnhancerBySpringCGLIB$$dca1c55b@75c072cb`£¬ËµÃ÷ËüÊÇÒ»¸ö´úÀí¶ÔÏó£¬Ê¹ÓÃÁË cglib ´úÀí¡£ +1. `beanObj1` 的构造方法仅调用了一次; +2. `beanConfigs` 对应的类是 `BeanConfigs$$EnhancerBySpringCGLIB$$dca1c55b@75c072cb`,说明它是一个代ç�†å¯¹è±¡ï¼Œä½¿ç”¨äº† cglib 代ç�†ã€‚ -ʵ¼ÊÉÏ£¬ÒÔÉÏÁ½¸ö²»Í¬µã¶¼¿ÉÒÔ¹é½áΪһ¸öÔ­Òò£ºspring ¶Ô `beanConfigs` ½øÐÐÁË´úÀí£¬µ÷Óà `BeanConfigs#beanObj1` ʵ¼Êµ÷ÓõÄÊÇ´úÀí·½·¨£¬¼´ **spring »á¶Ô±» `@Configuration` ±ê¼ÇµÄÀà½øÐÐ cglib ´úÀí**£¡ +实际上,以上两个ä¸�å�Œç‚¹éƒ½å�¯ä»¥å½’结为一个原因:spring 对 `beanConfigs` 进行了代ç�†ï¼Œè°ƒç”¨ `BeanConfigs#beanObj1` 实际调用的是代ç�†æ–¹æ³•,å�³ **spring 会对被 `@Configuration` 标记的类进行 cglib 代ç�†**ï¼� -ÄÇô´úÀíÊÇÔõô´´½¨¼°ÔËÐеÄÄØ£¿ÎÒÃǼÌÐøÌ½¾¿¡£ +那么代ç�†æ˜¯æ€Žä¹ˆåˆ›å»ºå�Šè¿�行的呢?我们继续探究。 -#### 2\. ´úÀíÀàµÄ´´½¨£º`ConfigurationClassPostProcessor#enhanceConfigurationClasses` +#### 2\. 代ç�†ç±»çš„创建:`ConfigurationClassPostProcessor#enhanceConfigurationClasses` -ÔÚ[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4836178)µÄ¿ªÆª£¬ÎÒÃǾÍÌáµ½¹ý `ConfigurationClassPostProcessor` ÔÚÖ´ÐÐʱ»áµ÷Óõ½Á½¸ö·½·¨£º`processConfigBeanDefinitions(...)` Óë `enhanceConfigurationClasses(...)`£¬`processConfigBeanDefinitions(...)` ÒýÆðÁË spring ¶Ô `@Import`¡¢`@Configuration` µÈ×¢½âµÄ½âÎö£¬Ç°ÃæÒѾ­·ÖÎö¹ýÁË£»¶ø `enhanceConfigurationClasses(...)` ¾ÍÊDZ» `@Configuration` ±ê¼ÇµÄÀà´úÀí²úÉúµÄ¹Ø¼üËùÔÚ£¡ +在[上一篇文章](https://my.oschina.net/funcy/blog/4836178)的开篇,我们就æ��到过 `ConfigurationClassPostProcessor` 在执行时会调用到两个方法:`processConfigBeanDefinitions(...)` 与 `enhanceConfigurationClasses(...)`,`processConfigBeanDefinitions(...)` 引起了 spring 对 `@Import`ã€�`@Configuration` 等注解的解æž�,å‰�é�¢å·²ç»�分æž�过了;而 `enhanceConfigurationClasses(...)` 就是被 `@Configuration` 标记的类代ç�†äº§ç”Ÿçš„关键所在ï¼� -`enhanceConfigurationClasses(...)` ·½·¨´úÂëÈçÏ£º +`enhanceConfigurationClasses(...)` 方法代ç �如下: > ConfigurationClassPostProcessor#enhanceConfigurationClasses @@ -678,23 +678,23 @@ public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFact Object configClassAttr = beanDef.getAttribute( ConfigurationClassUtils.CONFIGURATION_CLASS_ATTRIBUTE); ... - // 1\. ÅжÏÊÇ·ñΪһ¸öÈ«ÅäÖÃÀà + // 1\. 判断是å�¦ä¸ºä¸€ä¸ªå…¨é…�置类 if (ConfigurationClassUtils.CONFIGURATION_CLASS_FULL.equals(configClassAttr)) { ... configBeanDefs.put(beanName, (AbstractBeanDefinition) beanDef); } } - // È«ÅäÖÃÀࣺ´¦Àí´úÀí + // å…¨é…�置类:处ç�†ä»£ç�† ConfigurationClassEnhancer enhancer = new ConfigurationClassEnhancer(); for (Map.Entry entry : configBeanDefs.entrySet()) { AbstractBeanDefinition beanDef = entry.getValue(); beanDef.setAttribute(AutoProxyUtils.PRESERVE_TARGET_CLASS_ATTRIBUTE, Boolean.TRUE); - // ´¦Àí BeanClass + // 处ç�† BeanClass Class configClass = beanDef.getBeanClass(); - // 2\. Éú³É enhancedClass + // 2\. 生æˆ� enhancedClass Class enhancedClass = enhancer.enhance(configClass, this.beanClassLoader); if (configClass != enhancedClass) { - // 3\. ÉèÖà BeanClass£¬ÖµÎªenhancedClass + // 3\. 设置 BeanClass,值为enhancedClass beanDef.setBeanClass(enhancedClass); } } @@ -702,49 +702,49 @@ public void enhanceConfigurationClasses(ConfigurableListableBeanFactory beanFact ``` -Õâ¸ö·½·¨±È½Ï¼òµ¥£¬²½ÖèÈçÏ£º +这个方法比较简å�•,步骤如下: -1. ÅжÏÅäÖÃÀàÊÇ·ñΪȫÅäÖÃÀ࣬ÔÚÔÚ[ÉÏһƪÎÄÕÂ](https://my.oschina.net/funcy/blog/4836178)ÎÄÕÂÖУ¬ÎÒÃÇÌáµ½ spring »á°Ñ´øÓÐ `@Configuration` ×¢½âÇÒ `proxyBeanMethods != false` µÄÀà±ê¼ÇΪ `Full` ÅäÖÃÀ࣬ÕâÀïÕýÊǸù¾ÝÇ°ÃæµÄ±ê¼ÇÀ´ÅжϷñΪȫÅäÖÃÀ࣬ºÜÃ÷ÏÔ£¬´ËʱµÄ `beanConfigs` ¾ÍÊÇÒ»¸öÈ«ÅäÖÃÀࣻ -2. ¶ÔÈ«ÅäÖÃÀ࣬»á¸ù¾ÝÆä `configClass` Éú³É¶ÔÓ¦µÄ `enhancedClass`£» -3. ½«Éú³ÉµÄ `enhancedClass` ÉèÖõ½ `beanDefinition` µÄ `beanClass` ÖС£ +1. 判断é…�置类是å�¦ä¸ºå…¨é…�置类,在在[上一篇文章](https://my.oschina.net/funcy/blog/4836178)文章中,我们æ��到 spring 会把带有 `@Configuration` 注解且 `proxyBeanMethods != false` 的类标记为 `Full` é…�置类,这里正是根æ�®å‰�é�¢çš„æ ‡è®°æ�¥åˆ¤æ–­å�¦ä¸ºå…¨é…�置类,很明显,此时的 `beanConfigs` 就是一个全é…�置类; +2. 对全é…�置类,会根æ�®å…¶ `configClass` 生æˆ�对应的 `enhancedClass`ï¼› +3. 将生æˆ�çš„ `enhancedClass` 设置到 `beanDefinition` çš„ `beanClass` 中。 -Ö´ÐÐÍê´Ë·½·¨ºó£¬`beanConfigs` ¶ÔÓ¦µÄ `beanDefinition` µÄ `beanClass` ¾ÍÊÇ´úÀíÀàÁË£º +执行完此方法å�Žï¼Œ`beanConfigs` 对应的 `beanDefinition` çš„ `beanClass` 就是代ç�†ç±»äº†ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-f617fc93f72b13b8f785ccf5a12624dec0b.png) -ºóÃæ´´½¨µÄ `beanConfigs` ¾ÍÊÇÕâ¸ö´úÀíÀàµÄʵÀýÁË¡£ +å�Žé�¢åˆ›å»ºçš„ `beanConfigs` 就是这个代ç�†ç±»çš„实例了。 -#### 3\. Ö´ÐдúÀí¶ÔÏóµÄ·½·¨ +#### 3\. 执行代ç�†å¯¹è±¡çš„æ–¹æ³• -Éú³É´úÀí¶ÔÏóºó£¬´úÀí·½·¨ÊÇÈçºÎÖ´ÐеÄÄØ£¿¼´ spring ÊÇÈçºÎÖ´ÐÐ `beanConfigs.beanObj1()` µÄÄØ£¿ËµÆðÕâ¸ö£¬¾ÍÐèҪ̸µ½ cglib ´úÀí¶ÔÏóµÄ·½·¨Ö´ÐÐÁË¡£ÎÒÃÇÖ±½ÓÀ´¿´´úÀíµÄÉú³É£¬½øÈë `enhancer.enhance(configClass, this.beanClassLoader)`£º +生æˆ�代ç�†å¯¹è±¡å�Žï¼Œä»£ç�†æ–¹æ³•是如何执行的呢?å�³ spring 是如何执行 `beanConfigs.beanObj1()` 的呢?说起这个,就需è¦�谈到 cglib 代ç�†å¯¹è±¡çš„æ–¹æ³•执行了。我们直接æ�¥çœ‹ä»£ç�†çš„生æˆ�,进入 `enhancer.enhance(configClass, this.beanClassLoader)`: ``` public Class enhance(Class configClass, @Nullable ClassLoader classLoader) { if (EnhancedConfiguration.class.isAssignableFrom(configClass)) { return configClass; } - // newEnhancer(...) ·½·¨²ÅÊǹؼü + // newEnhancer(...) 方法æ‰�是关键 Class enhancedClass = createClass(newEnhancer(configClass, classLoader)); return enhancedClass; } ``` -¼ÌÐø½øÈ룺 +继续进入: ``` private static final Callback[] CALLBACKS = new Callback[] { - // Õâ¸öÀàÓÃÀ´±£Ö¤ @Bean ·½·¨µÄµ¥Àý + // 这个类用æ�¥ä¿�è¯� @Bean 方法的å�•例 new BeanMethodInterceptor(), new BeanFactoryAwareMethodInterceptor(), NoOp.INSTANCE }; -// Éú³É CallbackFilter£¬´«ÈëµÄ¶ÔÏóΪCallback +// 生æˆ� CallbackFilter,传入的对象为Callback private static final ConditionalCallbackFilter CALLBACK_FILTER = new ConditionalCallbackFilter(CALLBACKS); -// Éú³ÉcglibÔöÇ¿ +// 生æˆ�cglib增强 private Enhancer newEnhancer(Class configSuperClass, @Nullable ClassLoader classLoader) { Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(configSuperClass); @@ -752,7 +752,7 @@ private Enhancer newEnhancer(Class configSuperClass, @Nullable ClassLoader cl enhancer.setUseFactory(false); enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE); enhancer.setStrategy(new BeanFactoryAwareGeneratorStrategy(classLoader)); - // ´úÀí²¿·ÖÔÚcallbackFilter + // 代ç�†éƒ¨åˆ†åœ¨callbackFilter enhancer.setCallbackFilter(CALLBACK_FILTER); enhancer.setCallbackTypes(CALLBACK_FILTER.getCallbackTypes()); return enhancer; @@ -760,7 +760,7 @@ private Enhancer newEnhancer(Class configSuperClass, @Nullable ClassLoader cl ``` -¹ØÓÚ cglib ´úÀíµÄÄÚÈÝ£¬ÔÚ [spring aop Ö® cglib ´úÀí](https://my.oschina.net/funcy/blog/4696655)Ò»ÎÄÖÐÒÑÏêϸ·ÖÎö¹ýÁË£¬Õâ²»ÔÙ·ÖÎö£¬ÎÒÃÇÖ±½Ó˵½áÂÛ£ºcglib Ö´ÐдúÀí·½·¨Ê±£¬Ö´ÐеÄÊÇ `Enhancer` ÖÐ `callbackFilter` ÊôÐ﵀ `MethodInterceptor#intercept` ·½·¨£¬¼´ `CALLBACKS` Êý×éÖÐµÄ `BeanMethodInterceptor`£¬ÏÂÃæÎÒÃǾÍÀ´¿´ÏÂËüµÄÄÚÈÝ£º +关于 cglib 代ç�†çš„内容,在 [spring aop 之 cglib 代ç�†](https://my.oschina.net/funcy/blog/4696655)一文中已详细分æž�过了,这ä¸�å†�分æž�,我们直接说结论:cglib 执行代ç�†æ–¹æ³•时,执行的是 `Enhancer` 中 `callbackFilter` 属性的 `MethodInterceptor#intercept` 方法,å�³ `CALLBACKS` 数组中的 `BeanMethodInterceptor`,下é�¢æˆ‘们就æ�¥çœ‹ä¸‹å®ƒçš„内容: > ConfigurationClassEnhancer.BeanMethodInterceptor @@ -773,12 +773,12 @@ private static class BeanMethodInterceptor implements MethodInterceptor, Conditi ConfigurableBeanFactory beanFactory = getBeanFactory(enhancedConfigInstance); String beanName = BeanAnnotationHelper.determineBeanNameFor(beanMethod); ... - // Èç¹ûÊǵ÷Óõ±Ç°µÄ factoryMethod ·½·¨£¬Ö±½Óµ÷Óø¸ÀàµÄ·½·¨ + // 如果是调用当å‰�çš„ factoryMethod 方法,直接调用父类的方法 if (isCurrentlyInvokedFactoryMethod(beanMethod)) { - // µ÷Óø¸ÀàµÄ·½·¨£¬Ò²¾ÍÊÇÄ¿±ê·½·¨ + // 调用父类的方法,也就是目标方法 return cglibMethodProxy.invokeSuper(enhancedConfigInstance, beanMethodArgs); } - // ·ñÔòÖ±½Ó»ñÈ¡ beanFactoryÖÐÒÑÓеĶÔÏó + // å�¦åˆ™ç›´æŽ¥èŽ·å�– beanFactory中已有的对象 return resolveBeanReference(beanMethod, beanMethodArgs, beanFactory, beanName); } @@ -786,7 +786,7 @@ private static class BeanMethodInterceptor implements MethodInterceptor, Conditi ConfigurableBeanFactory beanFactory, String beanName) { try { ... - // µ÷ÓõĵÄÊÇ beanFactory.getBean(...) ·½·¨£¬Õâ¸ö·½·¨ÎÒÃÇÒѾ­·Ç³£ÊìϤÁË + // 调用的的是 beanFactory.getBean(...) 方法,这个方法我们已ç»�é�žå¸¸ç†Ÿæ‚‰äº† Object beanInstance = (useArgs ? beanFactory.getBean(beanName, beanMethodArgs) : beanFactory.getBean(beanName)); ... @@ -798,7 +798,7 @@ private static class BeanMethodInterceptor implements MethodInterceptor, Conditi } /** - * ÅжÏÄÜ·ñÖ´Ðе±Ç° MethodInterceptor + * 判断能å�¦æ‰§è¡Œå½“å‰� MethodInterceptor */ @Override public boolean isMatch(Method candidateMethod) { @@ -810,14 +810,14 @@ private static class BeanMethodInterceptor implements MethodInterceptor, Conditi ``` -`BeanMethodInterceptor` ʵÏÖÁË `MethodInterceptor` Óë `ConditionalCallback`£¬`ConditionalCallback#isMatch` ÓÃÀ´Åжϵ±Ç° `MethodInterceptor` ÄÜ·ñÖ´ÐУ¬`MethodInterceptor#intercept` ¾ÍÊÇÖ´Ðеķ½·¨ÄÚÈÝ£¬Ö´ÐÐÂß¼­Îª£º +`BeanMethodInterceptor` 实现了 `MethodInterceptor` 与 `ConditionalCallback`,`ConditionalCallback#isMatch` 用æ�¥åˆ¤æ–­å½“å‰� `MethodInterceptor` 能å�¦æ‰§è¡Œï¼Œ`MethodInterceptor#intercept` 就是执行的方法内容,执行逻辑为: -1. Èç¹ûÊÇÖ±½Óµ÷Óõ±Ç°µÄ `factoryMethod` ·½·¨£¬Ö±½Óµ÷Óø¸ÀàµÄ·½·¨£¬Ò²¾ÍÊÇ `beanConfigs.beanObj1()`£¬Õâ¸ö¹ý³Ì»áʵÀý»¯ `beanObj1` ʱ±»µ÷Óã» -2. Èç¹û²»ÊÇÖ±½Óµ÷Óõ±Ç°µÄ `factoryMethod` ·½·¨£¨±ÈÈçÔÚ±ðµÄ·½·¨Öе÷Óã©£¬Ôòµ÷Óà `beanFactory.getBean(...)` »ñÈ¡ bean£¬Õâ¸ö¹ý³Ì»áÔÚʵÀý»¯ `beanObj1` ʱ»á ±»µ÷Óᣠ+1. 如果是直接调用当å‰�çš„ `factoryMethod` 方法,直接调用父类的方法,也就是 `beanConfigs.beanObj1()`,这个过程会实例化 `beanObj1` 时被调用; +2. 如果ä¸�是直接调用当å‰�çš„ `factoryMethod` 方法(比如在别的方法中调用),则调用 `beanFactory.getBean(...)` 获å�– bean,这个过程会在实例化 `beanObj1` 时会 被调用。 -ÒÔÉϾÍÊÇΪʲô `beanObj1` µÄ¹¹Ôì·½·¨Ö»µ÷ÓÃÁËÒ»´Î£¬ÒÔ¼°ÎªÊ²Ã´ `beanConfigs` ÊÇ´úÀíÀàµÄÔ­ÒòËùÔÚÁË¡£ +以上就是为什么 `beanObj1` 的构造方法å�ªè°ƒç”¨äº†ä¸€æ¬¡ï¼Œä»¥å�Šä¸ºä»€ä¹ˆ `beanConfigs` 是代ç�†ç±»çš„原因所在了。 -×îºóÔÙÌáÒ»¾ä£¬`@Configuration` ÌṩÁË `proxyBeanMethods()` ·½·¨À´ÈÃÎÒÃÇÑ¡ÔñÊÇ·ñ¿ªÆôÅäÖÃÀàµÄ´úÀí£¬Ä¬ÈÏÖµÊÇ true£¬Èç¹ûÏñÕâÑùÉèÖ㺠+最å�Žå†�æ��一å�¥ï¼Œ`@Configuration` æ��供了 `proxyBeanMethods()` 方法æ�¥è®©æˆ‘们选择是å�¦å¼€å�¯é…�置类的代ç�†ï¼Œé»˜è®¤å€¼æ˜¯ true,如果åƒ�这样设置: ``` @Configuration(proxyBeanMethods=false) @@ -827,58 +827,58 @@ public class BeanConfigs { ``` -`BeanConfigs` ¾Í²»»á½øÐдúÀíÁË£¬ÔËÐнá¹ûͬ `@Component` ×¢½âÒ»Ñù£¬ÕâÀï¾Í²»Õ¹Ê¾ÁË¡£ +`BeanConfigs` å°±ä¸�会进行代ç�†äº†ï¼Œè¿�行结果å�Œ `@Component` 注解一样,这里就ä¸�展示了。 -#### 4\. ¼¸¸öСÎÊÌâ +#### 4\. 几个å°�问题 -##### 1\. ÄÚ²¿·½·¨µ÷ÓÃÒ²Äܱ»´úÀíÂ𣿠+##### 1\. 内部方法调用也能被代ç�†å�—? -ÔÚʾÀýÖУ¬ÎÒÃÇÊÇÕâÑùµ÷Óõģº +在示例中,我们是这样调用的: ``` @Bean public BeanObj2 beanObj2() { - // ÕâÀïµ÷ÓÃÏ beanObj1() ·½·¨ + // 这里调用下 beanObj1() 方法 beanObj1(); return new BeanObj2(); } ``` -¼´ÔÚ `beanObj2()` Öе÷ÓÃÁË `beanObj1()`£¬ÕâÃ÷ÏÔÊÇÄÚ²¿·½·¨µ÷Óã¬`beanObj1()` Ò²Äܱ»´úÀíÂ𣿠+å�³åœ¨ `beanObj2()` 中调用了 `beanObj1()`,这明显是内部方法调用,`beanObj1()` 也能被代ç�†å�—? -**»Ø´ð**£ºcglib ´úÀíµÄµ÷Ó÷½·¨ÓÐÁ½ÖÖ£º +**回答**:cglib 代ç�†çš„调用方法有两ç§�: ``` @Override public Object intercept(Object proxyObj, Method method, Object[] objects, MethodProxy proxy) throws Throwable { - // ·½°¸1£º ʹÓÃÄ¿±ê¶ÔÏó£¬Ö±½Óµ÷ÓÃÄ¿±ê¶ÔÏóµÄ·½·¨ + // 方案1: 使用目标对象,直接调用目标对象的方法 // return proxy.invoke(target, objects); - // ·½°¸2£º ʹÓôúÀí¶ÔÏ󣬵÷ÓÃÆä¸¸ÀàµÄ·½·¨ + // 方案2: 使用代ç�†å¯¹è±¡ï¼Œè°ƒç”¨å…¶çˆ¶ç±»çš„æ–¹æ³• return proxy.invokeSuper(proxyObj, objects); } ``` -`beanObj2()` µÄµ÷ÓÃʹÓÃÊÇ`·½°¸2`£¬Ò²¾ÍÊÇʹÓôúÀí¶ÔÏóµ÷Óà `beanObj2()`£¬`beanObj2()` µÄ `this` Ϊ´úÀí¶ÔÏó£º +`beanObj2()` 的调用使用是`方案2`,也就是使用代ç�†å¯¹è±¡è°ƒç”¨ `beanObj2()`,`beanObj2()` çš„ `this` 为代ç�†å¯¹è±¡ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-7ef891450ace815d22a5bf5c8e78e65c2db.png) -Òò´ËÔÚ `beanObj2()` ÖÐÖ±½Óµ÷Óà `beanObj1()`£¬¾ÍÏ൱ÓÚʹÓôúÀí¶ÔÏóµ÷Óà `beanObj1()`£¬µ±È»Äܱ»´úÀíÁË¡£ +因此在 `beanObj2()` 中直接调用 `beanObj1()`,就相当于使用代ç�†å¯¹è±¡è°ƒç”¨ `beanObj1()`,当然能被代ç�†äº†ã€‚ -ÔÚÎÒÃÇÓ¡ÏóÖУ¬·½·¨µÄÄÚ²¿µ÷Óò»Äܱ»´úÀí£¬ÄÇÊÇÒòΪ spring ÔÚ´¦Àí Aop ʱ£¬Ê¹ÓõÄÊÇ·½°¸ 1 µÄµ÷Ó÷½Ê½£¬´ËʱµÄ `this` Ϊԭʼ¶ÔÏ󣬵±È»²»Äܱ»´úÀíÁË¡£ +在我们å�°è±¡ä¸­ï¼Œæ–¹æ³•的内部调用ä¸�能被代ç�†ï¼Œé‚£æ˜¯å› ä¸º spring 在处ç�† Aop 时,使用的是方案 1 的调用方å¼�,此时的 `this` 为原始对象,当然ä¸�能被代ç�†äº†ã€‚ -##### 2\. ˽ÓÐÊôÐÔÈçºÎ×¢È룿 +##### 2\. ç§�有属性如何注入? -±ÈÈ磬ÎÒÃÇÏÖÔÚÓÐÒ»¸ö `BeanObj3`: +比如,我们现在有一个 `BeanObj3`: ``` @Component public class BeanObj3 { public BeanObj3() { - System.out.println("µ÷ÓÃbeanObj3µÄ¹¹Ôì·½·¨"); + System.out.println("调用beanObj3的构造方法"); } @Override @@ -889,7 +889,7 @@ public class BeanObj3 { ``` -È»ºóÔÚ `BeanConfigs` ÖÐ×¢È룺 +ç„¶å�Žåœ¨ `BeanConfigs` 中注入: ``` @Configuration @@ -905,9 +905,9 @@ public class BeanConfigs { @Bean public BeanObj2 beanObj2() { - // ÕâÀïµ÷ÓÃÏ beanObj1() ·½·¨ + // 这里调用下 beanObj1() 方法 beanObj1(); - System.out.println("beanObj3£º" + this.beanObj3); + System.out.println("beanObj3:" + this.beanObj3); return new BeanObj2(); } @@ -915,32 +915,32 @@ public class BeanConfigs { ``` -ÔÚ `BeanConfigs` ÖÐ×Ô¶¯×¢ÈëÁË `beanObj3` ÊôÐÔ£¬È»ºóÔÚ `beanObj2()` ÖÐÓÖ´òÓ¡ÁË `beanObj3` ÊôÐÔ¡£ÔËÐУ¬½á¹ûÈçÏ£º +在 `BeanConfigs` 中自动注入了 `beanObj3` 属性,然å�Žåœ¨ `beanObj2()` 中å�ˆæ‰“å�°äº† `beanObj3` 属性。è¿�行,结果如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-e21bf76da41fcf12e674fa155de4b636253.png) -¿ÉÒÔ¿´µ½£¬×¢ÈëµÄ `beanObj3` Ò²ÄÜ»ñÈ¡µ½ÁË¡£ÕâÀï¾ÍÓиöÎÊÌâÁË£º`beanObj3` ÊÇÊôÓÚÄ¿±ê¶ÔÏóµÄ£¬¶ø `this` ÊÇ´úÀí¶ÔÏó£¬ÄѲ»³É´úÀí¶ÔÏóÄÜÄõ½Ä¿±ê¶ÔÏóµÄ˽ÓÐÊôÐÔ£¿ +å�¯ä»¥çœ‹åˆ°ï¼Œæ³¨å…¥çš„ `beanObj3` 也能获å�–到了。这里就有个问题了:`beanObj3` 是属于目标对象的,而 `this` 是代ç�†å¯¹è±¡ï¼Œéš¾ä¸�æˆ�代ç�†å¯¹è±¡èƒ½æ‹¿åˆ°ç›®æ ‡å¯¹è±¡çš„ç§�有属性? -Ê×ÏÈ£¬Ìí¼Óµ½ `beanFactory` µÄ `beanDefinitionMap` ÖеÄÀàÊÇ `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` Àࣨ´úÀíÀࣩ£¬¶ø²»ÊÇ `BeanConfigs`£¬spring ÔÚ½øÐÐÊôÐÔ×¢Èëʱ£¬»á²éÕÒµ±Ç°À༰Æä¸¸ÀàµÄËùÓеÈ×¢ÈëÊôÐÔ½øÐÐ×¢È룬Òò´Ë£¬ËäÈ»Ìí¼Óµ½ spring ÈÝÆ÷ÖÐµÄ ÊÇ `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` À࣬µ« `BeanConfigs` ÖÐµÄ `beanObj3` Ò»Ñù»á±»×¢È룬ÖÁÓÚÔ­ÒòÂÓÉÓÚ cglib µÄ´úÀí¹ØÏµ£¬`BeanConfigs` ÊÇ `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` µÄ¸¸Àà¡£ +首先,添加到 `beanFactory` çš„ `beanDefinitionMap` 中的类是 `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` 类(代ç�†ç±»ï¼‰ï¼Œè€Œä¸�是 `BeanConfigs`,spring 在进行属性注入时,会查找当å‰�ç±»å�Šå…¶çˆ¶ç±»çš„æ‰€æœ‰ç­‰æ³¨å…¥å±žæ€§è¿›è¡Œæ³¨å…¥ï¼Œå› æ­¤ï¼Œè™½ç„¶æ·»åŠ åˆ° spring 容器中的 是 `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` 类,但 `BeanConfigs` 中的 `beanObj3` 一样会被注入,至于原因嘛,由于 cglib 的代ç�†å…³ç³»ï¼Œ`BeanConfigs` 是 `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` 的父类。 -ÄÇ `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` »á¼Ì³Ð `beanObj3` ÊôÐÔÂð£¿ÕâÀïÖ±½Ó¿´ÔËÐнá¹û°É£º +é‚£ `BeanConfigs$$EnhancerBySpringCGLIB$$Xxx` 会继承 `beanObj3` 属性å�—?这里直接看è¿�行结果å�§ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-27ebdebfd8c958f1de362ca1b30f2d0fc7c.png) -ÕâÊÇ×îÖյõ½µÄ `beanConfigs` ¶ÔÏ󣬿ÉÒÔ¿´µ½£¬ËüÀïÃæ¾ÍÓÐÒ»¸ö `beanObj3` ÊôÐÔ£¬²¢ÇÒ»¹ÓÐÖµ¡£ +这是最终得到的 `beanConfigs` 对象,å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒé‡Œé�¢å°±æœ‰ä¸€ä¸ª `beanObj3` 属性,并且还有值。 -### 3.7 ×ܽá +### 3.7 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË `ConfigurationClassPostProcessor` ´¦Àí `@Bean` ×¢½âµÄ¹ý³Ì£¬×ܽáÈçÏ£º +本文主è¦�分æž�了 `ConfigurationClassPostProcessor` 处ç�† `@Bean` 注解的过程,总结如下: -1. ½âÎöÅäÖÃÀ࣬ͨ¹ý·´Éä»ñÈ¡ÅäÖÃÀàÀïËùÓб» `@Bean` ±ê¼ÇµÄ·½·¨£» -2. ±éÀúÕâЩ·½·¨£¬½«Æä·â×°³ÉÒ»¸ö¸ö `BeanDefinition` ×¢²áµ½ `beanFactory` ÖУ¬¶ÔÓ¦ `BeanDefinition` ¾ßÌåÀàÐÍΪ `ConfigurationClassBeanDefinition`£» -3. Èç¹ûÅäÖÃÀàÊÇÈ«ÅäÖÃÀ࣬»á¶ÔÅäÖÃÀà½øÐÐ cglib ´úÀí£» -4. ʵÀý»¯Ê±£¬Ê¹Ó÷´Éäµ÷ÓöÔÓ¦µÄ·½·¨Éú³ÉʵÀý£¨µÃµ½ÊµÀýºó£¬spring »áÔÙ¶ÔÆä½øÐÐÒÀÀµ×¢Èë¡¢³õʼ»¯µÈ£©£» -5. ÔÚ±ðµÄ `@Bean` ·½·¨Öе÷Óõ±Ç° `@Bean` ·½·¨Ê±£¬Èç¹ûµ±Ç° `@Bean` ·½·¨ËùÔÚµÄÀàÊÇÈ«ÅäÖÃÀ࣬Ôò»áÈ¥ `beanFactory` ÖвéÕÒ¶ÔÓ¦µÄ `bean`(²éÕҵĹý³ÌÊÇ£¬ÕÒµ½Ôò·µ»Ø£¬ÕÒ²»µ½Ôò´´½¨ÔÙ·µ»Ø£¬**·µ»ØµÄ bean ÓÐÍêÕûµÄ spring bean µÄÉúÃüÖÜÆÚ**)£¬Õâ¸ö²Ù×÷ÊÇÓÉ cglib ´úÀíÍê³É£»Èç¹ûµ±Ç° `@Bean` ·½·¨ËùÔÚµÄÀ಻ÊÇÈ«ÅäÖÃÀ࣬Ôò»á°´ÕÕÆÕͨµÄ·½·¨µ÷Óã¬Éú³É bean µÄʵÀý·µ»Ø£¨**·µ»ØµÄ bean ûÓÐÍêÕûµÄ spring bean µÄÉúÃüÖÜÆÚ**£©¡£ +1. è§£æž�é…�置类,通过å��射获å�–é…�置类里所有被 `@Bean` 标记的方法; +2. é��历这些方法,将其å°�装æˆ�一个个 `BeanDefinition` 注册到 `beanFactory` 中,对应 `BeanDefinition` 具体类型为 `ConfigurationClassBeanDefinition`ï¼› +3. 如果é…�置类是全é…�置类,会对é…�置类进行 cglib 代ç�†ï¼› +4. 实例化时,使用å��射调用对应的方法生æˆ�实例(得到实例å�Žï¼Œspring 会å†�对其进行ä¾�赖注入ã€�åˆ�始化等); +5. 在别的 `@Bean` 方法中调用当å‰� `@Bean` 方法时,如果当å‰� `@Bean` 方法所在的类是全é…�置类,则会去 `beanFactory` 中查找对应的 `bean`(查找的过程是,找到则返回,找ä¸�到则创建å†�返回,**返回的 bean 有完整的 spring bean 的生命周期**),这个æ“�作是由 cglib 代ç�†å®Œæˆ�;如果当å‰� `@Bean` 方法所在的类ä¸�是全é…�置类,则会按照普通的方法调用,生æˆ� bean 的实例返回(**返回的 bean 没有完整的 spring bean 的生命周期**)。 -±¾ÎĵķÖÎö¾Íµ½ÕâÀïÁË£¬½ÓÏÂÀ´ÎÒÃǼÌÐø·ÖÎö `ConfigurationClassPostProcessor` ´¦ÀíÆäËû×¢½âµÄÁ÷³Ì¡£ +本文的分æž�就到这里了,接下æ�¥æˆ‘们继续分æž� `ConfigurationClassPostProcessor` 处ç�†å…¶ä»–注解的æµ�程。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4492878](https://my.oschina.net/funcy/blog/4492878) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4492878](https://my.oschina.net/funcy/blog/4492878) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\345\233\233\357\274\211\357\274\232\345\244\204\347\220\206@Conditional\346\263\250\350\247\243.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\345\233\233\357\274\211\357\274\232\345\244\204\347\220\206@Conditional\346\263\250\350\247\243.md" index 5d11cae..2c96995 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\345\233\233\357\274\211\357\274\232\345\244\204\347\220\206@Conditional\346\263\250\350\247\243.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/ConfigurationClassPostProcessor\357\274\210\345\233\233\357\274\211\357\274\232\345\244\204\347\220\206@Conditional\346\263\250\350\247\243.md" @@ -1,15 +1,15 @@ -±¾ÎÄÊÇ `ConfigurationClassPostProcessor` ·ÖÎöµÄµÚËÄÆª£¬Ö÷ÒªÊÇ·ÖÎö spring ¶Ô `@Conditional` ×¢½âµÄ´¦ÀíÁ÷³Ì¡£ +本文是 `ConfigurationClassPostProcessor` 分æž�的第四篇,主è¦�是分æž� spring 对 `@Conditional` 注解的处ç�†æµ�程。 -## 5\. spring ÊÇÈçºÎ´¦Àí @Conditional ×¢½âµÄ£¿ +## 5\. spring 是如何处ç�† @Conditional 注解的? -### 5.1 `@Conditional` µÄ´¦ÀíÁ÷³Ì +### 5.1 `@Conditional` 的处ç�†æµ�程 -ÔÚÇ°Ãæ·ÖÎö `ConfigurationClassParser#processConfigurationClass` ·½·¨Ê±£¬ÓÐÕâôһÐУº +在å‰�é�¢åˆ†æž� `ConfigurationClassParser#processConfigurationClass` 方法时,有这么一行: ``` class ConfigurationClassParser { protected void processConfigurationClass(ConfigurationClass configClass) throws IOException { - // ÅжÏÊÇ·ñÐèÒªÌø¹ý´¦Àí£¬Õë¶ÔÓÚ @Conditional ×¢½â£¬ÅжÏÊÇ·ñÂú×ãÌõ¼þ + // 判断是å�¦éœ€è¦�跳过处ç�†ï¼Œé’ˆå¯¹äºŽ @Conditional 注解,判断是å�¦æ»¡è¶³æ�¡ä»¶ if (this.conditionEvaluator.shouldSkip(configClass.getMetadata(), ConfigurationPhase.PARSE_CONFIGURATION)) { return; @@ -21,7 +21,7 @@ class ConfigurationClassParser { ``` -`conditionEvaluator.shouldSkip(...)` ·½·¨¾ÍÊÇÓÃÀ´´¦Àí `@Conditional` ×¢½âµÄ£¬¹ØÓÚÕâ¸ö·½·¨µÄ´¦ÀíÁ÷³Ì£¬ÎÒÃÇÍíµãÔÙ·ÖÎö£¬ÎÒÃÇÏÈÀ´¿´¿´Ê²Ã´ÊÇ `@Conditional` ×¢½â£º +`conditionEvaluator.shouldSkip(...)` 方法就是用æ�¥å¤„ç�† `@Conditional` 注解的,关于这个方法的处ç�†æµ�程,我们晚点å†�分æž�,我们先æ�¥çœ‹çœ‹ä»€ä¹ˆæ˜¯ `@Conditional` 注解: ``` @Target({ElementType.TYPE, ElementType.METHOD}) @@ -30,7 +30,7 @@ class ConfigurationClassParser { public @interface Conditional { /** - * Ìõ¼þÀà + * æ�¡ä»¶ç±» */ Class[] value(); @@ -38,13 +38,13 @@ public @interface Conditional { ``` -`@Conditional` ×¢½â·Ç³£¼òµ¥£¬½öÓÐÒ»¸öÊôÐÔ£¬·µ»ØÖµÊÇ `Class[]`£¬ÇÒ±ØÐëÊÇ `Condition` µÄ×ÓÀà¡£ÎÒÃÇÔÙÀ´¿´¿´ `Condition`£º +`@Conditional` 注解é�žå¸¸ç®€å�•,仅有一个属性,返回值是 `Class[]`,且必须是 `Condition` çš„å­�类。我们å†�æ�¥çœ‹çœ‹ `Condition`: ``` public interface Condition { /** - * ÔÚÕâÀïÖ¸¶¨Æ¥ÅäÂß¼­ + * 在这里指定匹é…�逻辑 */ boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata); @@ -52,19 +52,19 @@ public interface Condition { ``` -`Condition` ½Ó¿Ú½öÓÐÒ»¸ö `matches` ·½·¨£¬ÎÒÃÇ¿ÉÒÔÔÚÆäÖÐÖ¸¶¨Æ¥ÅäÂß¼­¡£ +`Condition` 接å�£ä»…有一个 `matches` 方法,我们å�¯ä»¥åœ¨å…¶ä¸­æŒ‡å®šåŒ¹é…�逻辑。 -½Ó×ÅÎÒÃÇÀ´¿´¿´ `conditionEvaluator.shouldSkip(...)` µÄ´¦ÀíÁ÷³Ì£º +接ç�€æˆ‘们æ�¥çœ‹çœ‹ `conditionEvaluator.shouldSkip(...)` 的处ç�†æµ�程: ``` class ConditionEvaluator { public boolean shouldSkip(@Nullable AnnotatedTypeMetadata metadata, @Nullable ConfigurationPhase phase) { - // ÊÇ·ñ±ê¼Ç @Conditional + // 是å�¦æ ‡è®° @Conditional if (metadata == null || !metadata.isAnnotated(Conditional.class.getName())) { return false; } - // Åжϴ«ÈëµÄ phase + // 判断传入的 phase if (phase == null) { if (metadata instanceof AnnotationMetadata && ConfigurationClassUtils.isConfigurationCandidate((AnnotationMetadata) metadata)) { @@ -73,25 +73,25 @@ class ConditionEvaluator { return shouldSkip(metadata, ConfigurationPhase.REGISTER_BEAN); } - // ʵÀý»¯ condition£¬Æä·ÅÈë conditions ÖÐ + // 实例化 condition,其放入 conditions 中 List conditions = new ArrayList<>(); - // 1\. getConditionClasses(metadata)£º»ñÈ¡ @Conditional ÖÐÖ¸¶¨µÄÅжÏÀà + // 1\. getConditionClasses(metadata):获å�– @Conditional 中指定的判断类 for (String[] conditionClasses : getConditionClasses(metadata)) { for (String conditionClass : conditionClasses) { - // 2\. ʵÀý»¯²Ù×÷£¨Óõ½µÄ»¹ÊÇ·´É䣩£¬Í³Ò»·Åµ½ conditions ÖÐ + // 2\. 实例化æ“�作(用到的还是å��射),统一放到 conditions 中 Condition condition = getCondition(conditionClass, this.context.getClassLoader()); conditions.add(condition); } } - // 3\. ÅÅÐòÉÏÃæµÃµ½µÄ condition ʵÀý + // 3\. 排åº�上é�¢å¾—到的 condition 实例 AnnotationAwareOrderComparator.sort(conditions); - // ±éÀúÉÏÃæµÃµ½µÄ conditions + // é��历上é�¢å¾—到的 conditions for (Condition condition : conditions) { ConfigurationPhase requiredPhase = null; if (condition instanceof ConfigurationCondition) { requiredPhase = ((ConfigurationCondition) condition).getConfigurationPhase(); } - // 4\. µ÷Óà Condition#matches ·½·¨½øÐÐÅÐ¶Ï + // 4\. 调用 Condition#matches 方法进行判断 if ((requiredPhase == null || requiredPhase == phase) && !condition.matches(this.context, metadata)) { return true; @@ -106,22 +106,22 @@ class ConditionEvaluator { ``` -¸Ã·½·¨µÄ´¦ÀíÁ÷³ÌÈçÏ£º +该方法的处ç�†æµ�程如下: -1. »ñÈ¡ `@Conditional` ÖÐÖ¸¶¨µÄÅжÏÀ࣬¾ÍÊÇ `@Conditional` µÄ `value` ÊôÐÔÖµ£» -2. ʹÓà ·´ÉäʵÀý»¯µÚ 1 ²½ÖÐ µÃµ½µÄÅжÏÀ࣬²¢ ±£´æµ½ `conditions`£¨ÕâÊǸö `List`£© ÖУ» -3. ¶ÔµÚ 2 ²½µÃµ½µÄ `conditions` ½øÐÐÅÅÐò£» -4. ±éÀúµÚ 3 ²½µÃµ½µÄ `conditions`£¬µ÷Óà `Condition#matches` ·½·¨½øÐÐÆ¥Åä¡£ +1. 获å�– `@Conditional` 中指定的判断类,就是 `@Conditional` çš„ `value` 属性值; +2. 使用 å��射实例化第 1 步中 得到的判断类,并 ä¿�存到 `conditions`(这是个 `List`) 中; +3. 对第 2 步得到的 `conditions` 进行排åº�ï¼› +4. é��历第 3 步得到的 `conditions`,调用 `Condition#matches` 方法进行匹é…�。 -`@Conditional` µÄ´¦Àí»¹ÊǷdz£¼òµ¥µÄ£¬½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ËüµÄʹÓÃʾÀý¡£ +`@Conditional` 的处ç�†è¿˜æ˜¯é�žå¸¸ç®€å�•的,接下æ�¥æˆ‘们æ�¥çœ‹çœ‹å®ƒçš„使用示例。 -### 5.2 `@Conditional` ʹÓÃʾÀý +### 5.2 `@Conditional` 使用示例 -#### ʾÀý 1£ºµ±Ö¸¶¨µÄÀà´æÔÚʱ£¬²Å´´½¨ spring bean +#### 示例 1:当指定的类存在时,æ‰�创建 spring bean -ÕâÀïÎÒÃÇʵÏÖ¸ö¹¦ÄÜ£ºµ±Ö¸¶¨µÄÀà´æÔÚʱ£¬²Å½øÐÐ spring bean µÄ´´½¨¡¢³õʼ»¯£¬´úÂëÈçÏ£º +这里我们实现个功能:当指定的类存在时,æ‰�进行 spring bean 的创建ã€�åˆ�始化,代ç �如下: -1. ×¼±¸Ò»¸ö¼òµ¥µÄ bean: +1. 准备一个简å�•çš„ bean: ``` public class BeanObj { @@ -130,7 +130,7 @@ class ConditionEvaluator { ``` -2. ʵÏÖ `Condition` ½Ó¿Ú£¬ÔÚÕâÀï´¦ÀíÅжÏÂß¼­ +2. 实现 `Condition` 接å�£ï¼Œåœ¨è¿™é‡Œå¤„ç�†åˆ¤æ–­é€»è¾‘ ``` public class MyCondition implements Condition { @@ -138,7 +138,7 @@ class ConditionEvaluator { public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { String className = "java.lang.Object"; try { - // ÅжÏÀàÊÇ·ñ´æÔÚ + // 判断类是å�¦å­˜åœ¨ Class.forName(className); return true; } catch (ClassNotFoundException e) { @@ -149,9 +149,9 @@ class ConditionEvaluator { ``` - ÔÚ `matches(...)` ·½·¨ÖÐ £¬ÏÈÊÇÖ¸¶¨ `className` Ϊ `java.lang.Object`£¬È»ºóÅÐ¶ÏÆäÊÇ·ñ´æÔÚ£¬ÅжϷ½Ê½Ò² Ê®·Ö¼òµ¥ £¬¾ÍÊÇʹÓà java µÄ·´Éä»úÖÆ£º`Class.forName(...)`£¬µ±À಻´æÔÚʱ£¬»áÅ׳ö `ClassNotFoundException`£¬ÎÒÃÇ¿ÉÒÔ²¶»ñ¸ÃÒì³££¬´Ó¶ø¾ÍÖªµÀÀà´æÔÚ²»´æÔÚÁË¡£ + 在 `matches(...)` 方法中 ,先是指定 `className` 为 `java.lang.Object`,然å�Žåˆ¤æ–­å…¶æ˜¯å�¦å­˜åœ¨ï¼Œåˆ¤æ–­æ–¹å¼�也 å��分简å�• ,就是使用 java çš„å��射机制:`Class.forName(...)`,当类ä¸�存在时,会抛出 `ClassNotFoundException`,我们å�¯ä»¥æ�•获该异常,从而就知é�“类存在ä¸�存在了。 -3. ×¼±¸ÅäÖÃÀà +3. 准备é…�置类 ``` @ComponentScan @@ -165,9 +165,9 @@ class ConditionEvaluator { ``` - ÅäÖÃÀà±È½Ï¼òµ¥£¬ÐèҪעÒâµÄÊÇ `beanObj()` É쵀 `@Conditional` ×¢½â£¬Ö¸¶¨µÄÊÇÌõ¼þÆ¥ÅäÀàÊÇ `MyCondition`£¬Æ¥Åä²Ù×÷¾ÍÊÇÔÚÕâ¸öÀàÖнøÐеġ£ + é…�置类比较简å�•,需è¦�注æ„�的是 `beanObj()` 上的 `@Conditional` 注解,指定的是æ�¡ä»¶åŒ¹é…�类是 `MyCondition`,匹é…�æ“�作就是在这个类中进行的。 -4. Ö÷Àà +4. 主类 ``` public class Demo06Main { @@ -176,29 +176,29 @@ class ConditionEvaluator { = new AnnotationConfigApplicationContext(BeanConfigs.class); try { Object obj = context.getBean("beanObj"); - System.out.println("beanObj ´æÔÚ£¡"); + System.out.println("beanObj 存在ï¼�"); } catch (Exception e) { - System.out.println("beanObj ²»´æÔÚ£¡"); + System.out.println("beanObj ä¸�存在ï¼�"); } } } ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` -beanObj ´æÔÚ£¡ +beanObj 存在ï¼� ``` -ÔÚ `MyCondition#matches` ÖУ¬ÎÒÃÇÅжϵÄÊǵ±Ç°ÏîÄ¿ÖÐÊÇ·ñ´æÔÚ `java.lang.Object`£¬ÏÔÈ»ÕâÊÇ´æÔڵģ¬Òò´Ë `beanObj` »áÔÚ spring ÈÝÆ÷ÖУ¬½Ó×ÅÎÒÃÇ»»Ï `className`: +在 `MyCondition#matches` 中,我们判断的是当å‰�项目中是å�¦å­˜åœ¨ `java.lang.Object`,显然这是存在的,因此 `beanObj` 会在 spring 容器中,接ç�€æˆ‘们æ�¢ä¸‹ `className`: ``` public class MyCondition implements Condition { @Override public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { - // ¸ü»»ÀàÃû + // æ›´æ�¢ç±»å�� String className = "java.lang.Object111"; ... } @@ -206,22 +206,22 @@ public class MyCondition implements Condition { ``` -ÏÔÈ»£¬`java.lang.Object111` ÊDz»´æÔÚÓÚµ±Ç°ÏîÄ¿Öеģ¬ÔËÐУ¬½á¹ûÈçÏ£º +显然,`java.lang.Object111` 是ä¸�存在于当å‰�项目中的,è¿�行,结果如下: ``` -beanObj ²»´æÔÚ£¡ +beanObj ä¸�存在ï¼� ``` -#### ʾÀý 2£º¸Ä½øÊ¾Àý 1 ¹¦ÄÜ +#### 示例 2:改进示例 1 功能 -ÔÚʾÀý 1 ÖУ¬ÎÒÃÇͨ¹ýÔÚ `MyCondition#matches` ÐÞ¸Ä `className` À´¸Ä±ä `beanObj` ÔÚÈÝÆ÷ÖеĴæÔÚÇé¿ö£¬ÄÇÈç¹ûÏîÄ¿ÖÐÓзdz£¶àµÄÀàÐèÒª°´ÀàµÄ´æÔÚÓë·ñ½øÐмÓÔØ£¬ÎÒÃÇÊÇʵÏÖ¶à¸ö `MyCondition` Â𣿠+在示例 1 中,我们通过在 `MyCondition#matches` 修改 `className` æ�¥æ”¹å�˜ `beanObj` 在容器中的存在情况,那如果项目中有é�žå¸¸å¤šçš„类需è¦�按类的存在与å�¦è¿›è¡ŒåŠ è½½ï¼Œæˆ‘ä»¬æ˜¯å®žçŽ°å¤šä¸ª `MyCondition` å�—? -±ÈÈ磬Àà `A` ÐèÒª¸ù¾ÝÀà `A1` µÄ´æÔÚÓë·ñÀ´ÅжÏÊÇ·ñ½øÐгõʼ»¯£¬Àà `B` ÐèÒª¸ù¾ÝÀà `B1` µÄ´æÔÚÓë·ñÀ´ÅжÏÊÇ·ñ½øÐгõʼ»¯£¬Àà `C` ÐèÒª¸ù¾ÝÀà `C1` µÄ´æÔÚÓë·ñÀ´ÅжÏÊÇ·ñ½øÐгõʼ»¯... ÎÒÃÇÊÇ·ñÐèÒª·Ö±ðΪ`ÀàA`¡¢`ÀàB`¡¢`ÀàC` ʵÏÖ `Condition`£¬ÔÚ¸÷×﵀ `match(...)` ·½·¨ÖнøÐÐÅжÏÂ𣿠+比如,类 `A` 需è¦�æ ¹æ�®ç±» `A1` 的存在与å�¦æ�¥åˆ¤æ–­æ˜¯å�¦è¿›è¡Œåˆ�始化,类 `B` 需è¦�æ ¹æ�®ç±» `B1` 的存在与å�¦æ�¥åˆ¤æ–­æ˜¯å�¦è¿›è¡Œåˆ�始化,类 `C` 需è¦�æ ¹æ�®ç±» `C1` 的存在与å�¦æ�¥åˆ¤æ–­æ˜¯å�¦è¿›è¡Œåˆ�始化... 我们是å�¦éœ€è¦�分别为`ç±»A`ã€�`ç±»B`ã€�`ç±»C` 实现 `Condition`,在å�„自的 `match(...)` 方法中进行判断å�—? -ʵ¼ÊÉÏ£¬ÎÒÃDz¢²»ÐèÒªÕâô×ö£¬ÕâÀïͨ¹ý spring ×éºÏ×¢½âµÄ·½·¨À´Íê³ÉÒÔÉϹ¦ÄÜ¡£ +实际上,我们并ä¸�需è¦�这么å�šï¼Œè¿™é‡Œé€šè¿‡ spring 组å�ˆæ³¨è§£çš„æ–¹æ³•æ�¥å®Œæˆ�以上功能。 -1. ×¼±¸Ò»¸ö bean£¬ÕâÓëʾÀý 1 ²¢ÎÞÇø±ð +1. 准备一个 bean,这与示例 1 并无区别 ``` public class BeanObj { @@ -230,18 +230,18 @@ beanObj ``` -2. ×¼±¸×¢½â `@ConditionalForClass`£¬¸Ã×¢½â×éºÏÁË `@Conditional` µÄ¹¦ÄÜ£¬´¦ÀíÌõ¼þÆ¥ÅäµÄÀàΪ `MyCondition`£¬`className` ÊôÐÔ¾ÍÊDZØÐë´æÔÚµÄÀࣺ +2. 准备注解 `@ConditionalForClass`,该注解组å�ˆäº† `@Conditional` 的功能,处ç�†æ�¡ä»¶åŒ¹é…�的类为 `MyCondition`,`className` 属性就是必须存在的类: ``` @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented -// ×éºÏÁË @Conditional µÄ¹¦ÄÜ£¬´¦ÀíÌõ¼þÆ¥ÅäµÄÀàΪ MyCondition +// 组å�ˆäº† @Conditional 的功能,处ç�†æ�¡ä»¶åŒ¹é…�的类为 MyCondition @Conditional(MyCondition.class) public @interface ConditionalForClass { /** - * ÕâÀïÖ¸¶¨±ØÐë´æÔÚµÄÀà + * 这里指定必须存在的类 */ String className(); @@ -249,25 +249,25 @@ public @interface ConditionalForClass { ``` -1. ×¼±¸ `MyCondition`£¬×¢ÒâÓëʾÀýµÄ²î±ðÔÚÓÚ£¬`className` ²»ÊÇÔڸ÷½·¨Öж¨Ò壬¶øÊÇÓÉ `@ConditionalForClass` ´«È룺 +1. 准备 `MyCondition`,注æ„�与示例的差别在于,`className` ä¸�是在该方法中定义,而是由 `@ConditionalForClass` 传入: ``` public class MyCondition implements Condition { /** - * ÕâÀï´¦ÀíÆ¥ÅäÌõ¼þ£¬×¢ÒâÓëʾÀý1ÖеÄÇø±ð + * 这里处ç�†åŒ¹é…�æ�¡ä»¶ï¼Œæ³¨æ„�与示例1中的区别 */ @Override public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { - // »ñÈ¡ @ConditionalForClass ×¢½âµÄËùÓÐÊôÐÔÖµ + // 获å�– @ConditionalForClass 注解的所有属性值 Map annotationAttributes = metadata.getAnnotationAttributes( ConditionalForClass.class.getName()); - // »ñÈ¡classNameµÄÊôÐÔÖµ£¬¾ÍÊÇ @ConditionalForClass µÄ className ÊôÐÔ + // 获å�–className的属性值,就是 @ConditionalForClass çš„ className 属性 String className = (String)annotationAttributes.get("className"); if(null == className || className.length() <= 0) { return true; } try { - // ÅжÏÀàÊÇ·ñ´æÔÚ + // 判断类是å�¦å­˜åœ¨ Class.forName(className); return true; } catch (ClassNotFoundException e) { @@ -278,14 +278,14 @@ public @interface ConditionalForClass { ``` -2. ×¼±¸ÅäÖÃÀ࣬´ËʱµÄÌõ¼þ×¢½âΪ `@ConditionalForClass`£º +2. 准备é…�置类,此时的æ�¡ä»¶æ³¨è§£ä¸º `@ConditionalForClass`: ``` @ComponentScan public class BeanConfigs { @Bean /** - * ÔÚ @ConditionalForClass ÖÐÖ¸¶¨ÁËÒÀÀµµÄÀà + * 在 @ConditionalForClass 中指定了ä¾�赖的类 */ @ConditionalForClass(className = "java.lang.Object") public BeanObj beanObj() { @@ -295,7 +295,7 @@ public @interface ConditionalForClass { ``` -3. ×îºóÊÇÖ÷À࣬ÓëʾÀý 1 ²¢²»Çø±ð£º +3. 最å�Žæ˜¯ä¸»ç±»ï¼Œä¸Žç¤ºä¾‹ 1 å¹¶ä¸�区别: ``` public class Demo07Main { @@ -305,29 +305,29 @@ public @interface ConditionalForClass { = new AnnotationConfigApplicationContext(BeanConfigs.class); try { Object obj = context.getBean("beanObj"); - System.out.println("beanObj ´æÔÚ£¡"); + System.out.println("beanObj 存在ï¼�"); } catch (Exception e) { - System.out.println("beanObj ²»´æÔÚ£¡"); + System.out.println("beanObj ä¸�存在ï¼�"); } } } ``` -ÒÔÉÏÀàͨ¹ý×Ô¶¨Òå×¢½â `@ConditionalForClass` À´Ö¸¶¨£¬µ±Àà `java.lang.Object` ´æÔÚʱ£¬`beanObj` ²Å»á±»Ìí¼Óµ½ spring ÈÝÆ÷ÖУ¬Õâ¸öÌõ¼þÏÔÈ»³ÉÁ¢£¬ÔËÐУ¬½á¹ûÈçÏ£º +以上类通过自定义注解 `@ConditionalForClass` æ�¥æŒ‡å®šï¼Œå½“ç±» `java.lang.Object` 存在时,`beanObj` æ‰�会被添加到 spring 容器中,这个æ�¡ä»¶æ˜¾ç„¶æˆ�立,è¿�行,结果如下: ``` -beanObj ´æÔÚ£¡ +beanObj 存在ï¼� ``` -ÎÒÃÇÔÙÀ´µ÷ÕûÏ `@ConditionalForClass` µÄ `className` Öµ£º +我们å†�æ�¥è°ƒæ•´ä¸‹ `@ConditionalForClass` çš„ `className` 值: ``` @ComponentScan public class BeanConfigs { @Bean - // ½öÐÞ¸ÄÁË@ConditionalForClassµÄclassNameÖµ£¬ÆäËûÌõ¼þ²»±ä + // 仅修改了@ConditionalForClassçš„className值,其他æ�¡ä»¶ä¸�å�˜ @ConditionalForClass(className = "java.lang.Object1111") public BeanObj beanObj() { return new BeanObj(); @@ -336,18 +336,18 @@ public class BeanConfigs { ``` -ÕâÀォ `@ConditionalForClass` µÄ `className` Öµµ÷ÕûΪ `java.lang.Object1111`£¬ÏÔÈ»Õâ¸öÀಢ²»ÔÚµ±Ç°ÏîÄ¿ÖУ¬ÔËÐнá¹ûÈçÏ£º +这里将 `@ConditionalForClass` çš„ `className` 值调整为 `java.lang.Object1111`,显然这个类并ä¸�在当å‰�项目中,è¿�行结果如下: ``` -beanObj ²»´æÔÚ£¡ +beanObj ä¸�存在ï¼� ``` -½á¹ûÒ²ÓëÎÒÃÇµÄÆÚÍûÒ»Ö¡£ +结果也与我们的期望一致。 -ÈÃÎÒÃǻص½±¾½Ú¿ªÍ·µÄÎÊÌ⣺±ÈÈ磬Àà `A` ÐèÒª¸ù¾ÝÀà `A1` µÄ´æÔÚÓë·ñÀ´ÅжÏÊÇ·ñ½øÐгõʼ»¯£¬Àà `B` ÐèÒª¸ù¾ÝÀà `B1` µÄ´æÔÚÓë·ñÀ´ÅжÏÊÇ·ñ½øÐгõʼ»¯£¬Àà `C` ÐèÒª¸ù¾ÝÀà `C1` µÄ´æÔÚÓë·ñÀ´ÅжÏÊÇ·ñ½øÐгõʼ»¯... ÎÒÃÇÊÇ·ñÐèÒª·Ö±ðΪ`ÀàA`¡¢`ÀàB`¡¢`ÀàC` ʵÏÖ `Condition`£¬ÔÚ¸÷×﵀ `match(...)` ·½·¨ÖнøÐÐÅжÏÂ𣿠+让我们回到本节开头的问题:比如,类 `A` 需è¦�æ ¹æ�®ç±» `A1` 的存在与å�¦æ�¥åˆ¤æ–­æ˜¯å�¦è¿›è¡Œåˆ�始化,类 `B` 需è¦�æ ¹æ�®ç±» `B1` 的存在与å�¦æ�¥åˆ¤æ–­æ˜¯å�¦è¿›è¡Œåˆ�始化,类 `C` 需è¦�æ ¹æ�®ç±» `C1` 的存在与å�¦æ�¥åˆ¤æ–­æ˜¯å�¦è¿›è¡Œåˆ�始化... 我们是å�¦éœ€è¦�分别为`ç±»A`ã€�`ç±»B`ã€�`ç±»C` 实现 `Condition`,在å�„自的 `match(...)` 方法中进行判断å�—? -ÓÐÁË `@ConditionalForClass` ×¢½âºó£¬ÎÒÃDz¢²»ÐèÒªÕâôÂé·³£¬Ö»ÐèÒªÔÚ¸÷×﵀ `@Bean` ·½·¨ÉÏÌí¼Ó `@ConditionalForClass` ¾ÍÐÐÁË£¬ÏñÕâÑù£º +有了 `@ConditionalForClass` 注解å�Žï¼Œæˆ‘们并ä¸�需è¦�这么麻烦,å�ªéœ€è¦�在å�„自的 `@Bean` 方法上添加 `@ConditionalForClass` 就行了,åƒ�这样: ``` @Bean @@ -372,14 +372,14 @@ public C c() { ``` -×¢ÒâÌå»á `@ConditionalForClass` µÄʵÏÖ£¬springboot ÖÐµÄ `@ConditionalOnClass` ¾ÍÊǰ´ÕâÖÖ˼·ʵÏֵġ£ +注æ„�体会 `@ConditionalForClass` 的实现,springboot 中的 `@ConditionalOnClass` 就是按这ç§�æ€�路实现的。 -### 5.3 ×ܽá +### 5.3 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË spring ´¦Àí `@Conditional` µÄÁ÷³Ì£¬Âß¼­±È½Ï¼òµ¥£¬×îÖÕµ÷ÓõÄÊÇ `Condition#matches` ·½·¨½øÐÐÆ¥Åä²Ù×÷µÄ£¬¶øÆ¥Åä²Ù×÷ÓÉ `Condition` µÄʵÏÖÀà×ÔÐÐÖ¸¶¨¡£ +本文主è¦�分æž�了 spring 处ç�† `@Conditional` çš„æµ�程,逻辑比较简å�•,最终调用的是 `Condition#matches` 方法进行匹é…�æ“�作的,而匹é…�æ“�作由 `Condition` 的实现类自行指定。 -ΪÁ˸üºÃµØËµÃ÷ `@Conditional` µÄʹÓ㬱¾ÎÄ×¼±¸ÁËÁ½¸öʹÓÃʾÀý£¬ÌرðÊÇʾÀý 2£¬ÐèÒªÌØ±ðÌå»á£¬springboot ÖÐµÄ `@ConditionalOnClass` ÕýÊÇ»ùÓÚʾÀý 2 µÄ˼·½øÐÐʵÏֵģ¬ÁíÍ⣬springboot ÖеĶà¸öÌõ¼þ×¢½âÒ²ÊÇ¶Ô `@Conditional` µÄÀ©Õ¹¡£ +为了更好地说明 `@Conditional` 的使用,本文准备了两个使用示例,特别是示例 2,需è¦�特别体会,springboot 中的 `@ConditionalOnClass` 正是基于示例 2 çš„æ€�路进行实现的,å�¦å¤–,springboot 中的多个æ�¡ä»¶æ³¨è§£ä¹Ÿæ˜¯å¯¹ `@Conditional` 的扩展。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4873444](https://my.oschina.net/funcy/blog/4873444) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4873444](https://my.oschina.net/funcy/blog/4873444) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213AOP\347\232\204\346\211\247\350\241\214\351\241\272\345\272\217.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213AOP\347\232\204\346\211\247\350\241\214\351\241\272\345\272\217.md" index 89b3927..e17d681 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213AOP\347\232\204\346\211\247\350\241\214\351\241\272\345\272\217.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213AOP\347\232\204\346\211\247\350\241\214\351\241\272\345\272\217.md" @@ -1,15 +1,15 @@ -spring aop Ö´ÐÐʱ£¬Ë³ÐòÊÇÔõÑùµÄ£¬ÈçºÎ¸Ä±äÖ´ÐеÄÓÅÏȼ¶£¿±¾ÎĽ«´ÓÔ´ÂëÉÏÀ´Ì½¾¿ aop Ö´ÐÐ˳ÐòµÄÃØÃÜ¡£ +spring aop 执行时,顺åº�是怎样的,如何改å�˜æ‰§è¡Œçš„优先级?本文将从æº�ç �上æ�¥æŽ¢ç©¶ aop 执行顺åº�的秘密。 -ÔÚ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨ÉÏ£©](https://my.oschina.net/funcy/blog/4678817) Óë [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)ÖУ¬×Ý¹Û spring aop ´´½¨ÓëÖ´Ðйý³Ì£¬ÎÒÃÇÒ»¹²Óöµ½Á½´Î¹ØÓÚ aop µÄÅÅÐò²Ù×÷£º +在 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(上)](https://my.oschina.net/funcy/blog/4678817) 与 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)中,纵观 spring aop 创建与执行过程,我们一共é�‡åˆ°ä¸¤æ¬¡å…³äºŽ aop 的排åº�æ“�作: -* `ReflectiveAspectJAdvisorFactory#getAdvisorMethods`£º¶Ô `aspect` ÖÐµÄ `@Around/@Before/@After` µÈ·½·¨½øÐÐÅÅÐò£» -* `AspectJAwareAdvisorAutoProxyCreator#sortAdvisors`£º¶Ô `advisor` ½øÐÐÅÅÐò¡£ +* `ReflectiveAspectJAdvisorFactory#getAdvisorMethods`:对 `aspect` 中的 `@Around/@Before/@After` 等方法进行排åº�ï¼› +* `AspectJAwareAdvisorAutoProxyCreator#sortAdvisors`:对 `advisor` 进行排åº�。 -½ÓÏÂÀ´ÎÒÃÇÖØµãÀ´·ÖÎöÕâÁ½¸ö·½·¨¡£ +接下æ�¥æˆ‘们é‡�点æ�¥åˆ†æž�这两个方法。 #### 1 `ReflectiveAspectJAdvisorFactory#getAdvisorMethods` -µÚÒ»´ÎÅÅÐòÔÚ `ReflectiveAspectJAdvisorFactory#getAdvisorMethods`£¬µ÷ÓýṹÈçÏ£º +第一次排åº�在 `ReflectiveAspectJAdvisorFactory#getAdvisorMethods`,调用结构如下: ``` |-AbstractAutoProxyCreator#postProcessBeforeInstantiation @@ -21,91 +21,91 @@ spring aop Ö´ ``` -´úÂëÈçÏ£º +代ç �如下: > ReflectiveAspectJAdvisorFactory ``` -// »ñÈ¡ @Aspect ÀàÖеķ½·¨ +// 获å�– @Aspect 类中的方法 private List getAdvisorMethods(Class aspectClass) { final List methods = new ArrayList<>(); - // Ê¡ÂÔ»ñÈ¡·½·¨µÄ²Ù×÷ + // çœ�略获å�–方法的æ“�作 ... - //¶ÔµÃµ½µÄËùÓз½·¨ÅÅÐò£¬ + //对得到的所有方法排åº�, methods.sort(METHOD_COMPARATOR); return methods; } ``` -Õâ¸ö·½·¨µÄ²Ù×÷ÔÚ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨ÉÏ£©](https://my.oschina.net/funcy/blog/4678817) Ò»ÎÄÒÑ×÷ÁËÏêϸ·ÖÎö£¬ÕâÀïÎÒÃǽö¹Ø×¢ÅÅÐò¹æÔò£º +这个方法的æ“�作在 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(上)](https://my.oschina.net/funcy/blog/4678817) 一文已作了详细分æž�,这里我们仅关注排åº�规则: > ReflectiveAspectJAdvisorFactory ``` /** - * METHOD_COMPARATOR Ïê½â + * METHOD_COMPARATOR 详解 */ private static final Comparator METHOD_COMPARATOR; static { Comparator adviceKindComparator = new ConvertingComparator<>( - // ±È½ÏÆ÷£¬°´´«Èë˳Ðò½øÐÐ±È½Ï + // 比较器,按传入顺åº�进行比较 new InstanceComparator<>( Around.class, Before.class, After.class, AfterReturning.class, AfterThrowing.class), - // ת»»Æ÷£¬½«·½·¨×ª»¯Îª @Around, @Before, @After, @AfterReturning, @AfterThrowing µÈ×¢½â + // 转æ�¢å™¨ï¼Œå°†æ–¹æ³•转化为 @Around, @Before, @After, @AfterReturning, @AfterThrowing 等注解 (Converter) method -> { AspectJAnnotation annotation = AbstractAspectJAdvisorFactory.findAspectJAnnotationOnMethod(method); return (annotation != null ? annotation.getAnnotation() : null); }); - // ת»»±È½ÏÆ÷£¬ - // 1\. ת»»£º½«´«ÈëµÄ·½·¨(Method)ת»»Îª·½·¨Ãû(String) - // 2\. ±È½Ï£º°´´«ÈëÀàÐͽøÐбȽϣ¬ÕâÀï´«ÈëµÄµÄÀàÐÍΪString£¬Ô­ÒòÊÇת»»Æ÷½«´«ÈëµÄMethodת»»³ÉStringÁË + // 转æ�¢æ¯”较器, + // 1\. 转æ�¢ï¼šå°†ä¼ å…¥çš„æ–¹æ³•(Method)转æ�¢ä¸ºæ–¹æ³•å��(String) + // 2\. 比较:按传入类型进行比较,这里传入的的类型为String,原因是转æ�¢å™¨å°†ä¼ å…¥çš„Method转æ�¢æˆ�String了 Comparator methodNameComparator = new ConvertingComparator<>(Method::getName); /* - * METHOD_COMPARATOR ±È½Ï¹æÔò£º - * 1\. Èç¹û·½·¨±êʶÁËÇÐÃæ×¢½â, Ôò°´ @Around, @Before, @After, @AfterReturning, - * @AfterThrowing ˳ÐòÅÅÐò (`adviceKindComparator`) - * 2\. Èç¹ûûÓбêʶÕâЩע½â£¬Ôò°´·½·¨Ãû³ÆµÄ×Ö·û´®ÅÅÐò(`methodNameComparator`) + * METHOD_COMPARATOR 比较规则: + * 1\. 如果方法标识了切é�¢æ³¨è§£, 则按 @Around, @Before, @After, @AfterReturning, + * @AfterThrowing 顺åº�排åº� (`adviceKindComparator`) + * 2\. 如果没有标识这些注解,则按方法å��称的字符串排åº�(`methodNameComparator`) */ METHOD_COMPARATOR = adviceKindComparator.thenComparing(methodNameComparator); } ``` -ÕâÀï¶ÔÕâ¸ö·½·¨µÄÅÅÐò¹æÔò×ܽáÈçÏ£º +这里对这个方法的排åº�规则总结如下: -1. Õâ¸ö·½·¨ÅÅÐòµÄ¶ÔÏóÊÇͬһ¸ö `@Aspect` Öеķ½·¨£» -2. ¶ÔÓÚÇÐÃæ·½·¨£¬ÅÅÐòÈçÏ£º`@Around`, `@Before`, `@After`, `@AfterReturning`, `@AfterThrowing`£» -3. ¶ÔÓÚ·ÇÇÐÃæ·½·¨£¬°´·½·¨Ãû£¨String µÄÅÅÐò¹æÔò£©ÅÅÐò¡£ +1. 这个方法排åº�的对象是å�Œä¸€ä¸ª `@Aspect` 中的方法; +2. 对于切é�¢æ–¹æ³•,排åº�如下:`@Around`, `@Before`, `@After`, `@AfterReturning`, `@AfterThrowing`ï¼› +3. 对于é�žåˆ‡é�¢æ–¹æ³•,按方法å��(String 的排åº�规则)排åº�。 -¸Ã·½·¨ÅÅÐòǰºóµÄ±ä»¯ÈçÏ£º +该方法排åº�å‰�å�Žçš„å�˜åŒ–如下: -ÅÅÐòǰ£º +排åº�å‰�: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-23df6d6a46f37badb1017ceee8dcfa6533e.png) -ÅÅÐòºó£º +排åº�å�Žï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-85bdb16953c1c6348d39578de6b6144c1cc.png) -ÅÅÐòºóÓëÎÒÃÇ·ÖÎöµÄ `@Around, @Before, @After, @AfterReturning,@AfterThrowing` µÄ˳ÐòÒ»Ö¡£ +排åº�å�Žä¸Žæˆ‘们分æž�çš„ `@Around, @Before, @After, @AfterReturning,@AfterThrowing` 的顺åº�一致。 -µÃµ½ `List` ºó£¬½Ó×Å»á±éÀúÕâЩ `method`£¬½«Æä°üװΪһ¸ö¸ö `advisor`£º +得到 `List` å�Žï¼ŒæŽ¥ç�€ä¼šé��历这些 `method`,将其包装为一个个 `advisor`: > ReflectiveAspectJAdvisorFactory ``` public List getAdvisors(MetadataAwareAspectInstanceFactory aspectInstanceFactory) { - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... List advisors = new ArrayList<>(); - //»ñÈ¡Õâ¸öÀàËùÓеÄÔöÇ¿·½·¨ + //获å�–这个类所有的增强方法 for (Method method : getAdvisorMethods(aspectClass)) { - // Éú³ÉÔöǿʵÀý£¬advisors.size() ÒÀ´ÎΪ 0£¬1£¬2£¬... ÕâÊÇ - // declarationOrderInAspect µÄÖµ£¬ºóÃæÅÅÐò»áÓõ½ + // 生æˆ�增强实例,advisors.size() ä¾�次为 0,1,2,... 这是 + // declarationOrderInAspect 的值,å�Žé�¢æŽ’åº�会用到 Advisor advisor = getAdvisor(method, lazySingletonAspectInstanceFactory, advisors.size(), aspectName); if (advisor != null) { @@ -113,17 +113,17 @@ public List getAdvisors(MetadataAwareAspectInstanceFactory aspectInstan } } - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... } ``` -°ü×°³É `Advisor` ʱ£¬»á´«Èë `declarationOrderInAspect` Öµ£¬¸ÃֵΪ `advisors.size()`£¬ÒÀ´ÎΪ `0£¬1£¬2£¬...`£¬Õâ¸öÖµÔÚºóÃæµÄÅÅÐòÖлáÓõ½¡£ +包装æˆ� `Advisor` 时,会传入 `declarationOrderInAspect` 值,该值为 `advisors.size()`,ä¾�次为 `0,1,2,...`,这个值在å�Žé�¢çš„æŽ’åº�中会用到。 -### 2\. advisor µÄÅÅÐò£º`AspectJAwareAdvisorAutoProxyCreator#sortAdvisors` +### 2\. advisor 的排åº�:`AspectJAwareAdvisorAutoProxyCreator#sortAdvisors` -`@Aspect` ÀàÖеÄÇÐÃæ·½·¨°ü×°³É `advisor` ºó£¬»òÕß»ñÈ¡Íê×Ô¶¨Òå `advisor` ºó£¬½ÓמͽøÐÐÁ˵ڶþ´ÎÅÅÐò£º`AspectJAwareAdvisorAutoProxyCreator#sortAdvisors`£¬·½·¨µÄµ÷ÓÃÁ´ÈçÏ£º +`@Aspect` 类中的切é�¢æ–¹æ³•包装æˆ� `advisor` å�Žï¼Œæˆ–者获å�–完自定义 `advisor` å�Žï¼ŒæŽ¥ç�€å°±è¿›è¡Œäº†ç¬¬äºŒæ¬¡æŽ’åº�:`AspectJAwareAdvisorAutoProxyCreator#sortAdvisors`,方法的调用链如下: ``` |-AbstractAutoProxyCreator#postProcessAfterInitialization @@ -142,10 +142,10 @@ protected List sortAdvisors(List advisors) { = new ArrayList<>(advisors.size()); for (Advisor element : advisors) { partiallyComparableAdvisors.add( - // ±È½Ï¹æÔòΪ DEFAULT_PRECEDENCE_COMPARATOR,ÆäʵÊÇAspectJPrecedenceComparator + // 比较规则为 DEFAULT_PRECEDENCE_COMPARATOR,其实是AspectJPrecedenceComparator new PartiallyComparableAdvisorHolder(element, DEFAULT_PRECEDENCE_COMPARATOR)); } - // ¾ßÌåµÄ±È½Ï²Ù×÷£¬±È½Ï¹æÔòÓÉ AspectJPrecedenceComparator Ìṩ + // 具体的比较æ“�作,比较规则由 AspectJPrecedenceComparator æ��ä¾› List sorted = PartialOrder.sort(partiallyComparableAdvisors); if (sorted != null) { @@ -162,11 +162,11 @@ protected List sortAdvisors(List advisors) { ``` -ÕâÀï½øÐÐÁËÁ½¸öÅÅÐò£¬Ò»¸öÊÇ `PartialOrder.sort(...)`£¬Ò»¸öÊÇ `super.sortAdvisors(...)`£¬ÎÒÃÇÏÈÀ´·ÖÎö `PartialOrder.sort(...)`¡£ +这里进行了两个排åº�,一个是 `PartialOrder.sort(...)`,一个是 `super.sortAdvisors(...)`,我们先æ�¥åˆ†æž� `PartialOrder.sort(...)`。 -#### 2.1 `PartialOrder.sort(...)` µÄ±È½ÏÆ÷£º`AspectJPrecedenceComparator` +#### 2.1 `PartialOrder.sort(...)` 的比较器:`AspectJPrecedenceComparator` -ʵ¼ÊÉÏ£¬`PartialOrder.sort(...)` Ö»Òª×öÁËÒ»¸öÅÅÐò¶øÒÑ£¬Õâ¸ö·½·¨Ã»É¶·ÖÎöµÄ£¬ÎÒÃÇÕæÕýÒª·ÖÎöµÄÓ¦¸ÃÊÇ´«ÈëµÄÅÅÐò¹æÔò£¬Ò²¾ÍÊÇ `DEFAULT_PRECEDENCE_COMPARATOR`£º +实际上,`PartialOrder.sort(...)` å�ªè¦�å�šäº†ä¸€ä¸ªæŽ’åº�而已,这个方法没啥分æž�的,我们真正è¦�分æž�的应该是传入的排åº�规则,也就是 `DEFAULT_PRECEDENCE_COMPARATOR`: ``` private static final Comparator DEFAULT_PRECEDENCE_COMPARATOR @@ -174,18 +174,18 @@ private static final Comparator DEFAULT_PRECEDENCE_COMPARATOR ``` -`DEFAULT_PRECEDENCE_COMPARATOR` µÄÀàÐÍÊÇ `AspectJPrecedenceComparator`£¬ÎÒÃÇÖ±½Ó²é¿´Æä `compare(xxx)` ·½·¨£º +`DEFAULT_PRECEDENCE_COMPARATOR` 的类型是 `AspectJPrecedenceComparator`,我们直接查看其 `compare(xxx)` 方法: > AspectJPrecedenceComparator ``` @Override public int compare(Advisor o1, Advisor o2) { - // ±È½Ï¹æÔò£ºAnnotationAwareOrderComparator + // 比较规则:AnnotationAwareOrderComparator int advisorPrecedence = this.advisorComparator.compare(o1, o2); - // ˳ÐòÏàͬ£¬ÇÒÀ´Ô´ÓÚͬһ aspect£¬µ÷Óà comparePrecedenceWithinAspect ÔÙ´Î±È½Ï + // 顺åº�相å�Œï¼Œä¸”æ�¥æº�于å�Œä¸€ aspect,调用 comparePrecedenceWithinAspect å†�次比较 if (advisorPrecedence == SAME_PRECEDENCE && declaredInSameAspect(o1, o2)) { - // ±È½ÏÉùÃ÷˳Ðò£¬Èç¹ûÆäÖÐÓÐÒ»¸öÊÇafter֪ͨ£¬ÔòºóÉùÃ÷µÄÓÅÏȼ¶¸ß£»·ñÔòÏÈÉùÃ÷µÄÓÅÏȼ¶¸ß + // 比较声明顺åº�,如果其中有一个是after通知,则å�Žå£°æ˜Žçš„优先级高;å�¦åˆ™å…ˆå£°æ˜Žçš„优先级高 advisorPrecedence = comparePrecedenceWithinAspect(o1, o2); } return advisorPrecedence; @@ -193,14 +193,14 @@ public int compare(Advisor o1, Advisor o2) { ``` -`AspectJPrecedenceComparator#compare` ±È½Ï¼òµ¥£¬¹ý³ÌÈçÏ£º +`AspectJPrecedenceComparator#compare` 比较简å�•,过程如下: -1. µ÷Óà `advisorComparator.compare` ½øÐбȽϣ¬Õâ¸ö±È½Ï¹æÔòÎÒÃǽÓÏÂÀ´»á·ÖÎö£» -2. Èç¹ûÓÉÉÏÊö±È½Ï¹æÔòµÃµ½µÄÓÅÏȼ¶Ïàͬ£¬ÇÒÁ½¸ö `advisor` ÊÇÔÚͬһ aspect Öж¨ÒåµÄ£¬Ôòµ÷Óà `comparePrecedenceWithinAspect` ¼ÌÐø±È½Ï. +1. 调用 `advisorComparator.compare` 进行比较,这个比较规则我们接下æ�¥ä¼šåˆ†æž�ï¼› +2. 如果由上述比较规则得到的优先级相å�Œï¼Œä¸”两个 `advisor` 是在å�Œä¸€ aspect 中定义的,则调用 `comparePrecedenceWithinAspect` 继续比较. ##### `this.advisorComparator.compare` -ÎÒÃÇÀ´¿´¿´ `this.advisorComparator.compare` µÄ±È½Ï¹æÔò£º +我们æ�¥çœ‹çœ‹ `this.advisorComparator.compare` 的比较规则: ``` private final Comparator advisorComparator; @@ -210,14 +210,14 @@ public AspectJPrecedenceComparator() { } public int compare(Advisor o1, Advisor o2) { - // ±È½Ï¹æÔò£ºAnnotationAwareOrderComparator + // 比较规则:AnnotationAwareOrderComparator int advisorPrecedence = this.advisorComparator.compare(o1, o2); ... } ``` -`this.advisorComparator.compare` µÄ±È½Ï¹æÔòÓÉ `AnnotationAwareOrderComparator` Ìṩ£º +`this.advisorComparator.compare` 的比较规则由 `AnnotationAwareOrderComparator` æ��供: ``` public int compare(@Nullable Object o1, @Nullable Object o2) { @@ -225,11 +225,11 @@ public int compare(@Nullable Object o1, @Nullable Object o2) { } /** - * ¾ßÌåµÄ±È½Ï²Ù×÷£¬ÏÈ±È½Ï PriorityOrdered£¬ÔÙ±È½Ï Ordered + * 具体的比较æ“�作,先比较 PriorityOrdered,å†�比较 Ordered */ private int doCompare(@Nullable Object o1, @Nullable Object o2, @Nullable OrderSourceProvider sourceProvider) { - // Á½Õß֮һΪ PriorityOrdered£¬Ë­ÊÇPriorityOrdered£¬Ë­µÄÓÅÏȼ¶¸ß + // 两者之一为 PriorityOrdered,è°�是PriorityOrdered,è°�的优先级高 boolean p1 = (o1 instanceof PriorityOrdered); boolean p2 = (o2 instanceof PriorityOrdered); if (p1 && !p2) { @@ -238,37 +238,37 @@ private int doCompare(@Nullable Object o1, @Nullable Object o2, else if (p2 && !p1) { return 1; } - // ²éÕÒorderµÄÖµ£¬ÏȲéÕÒOrdered½Ó¿Ú£¬Èç¹ûûÕÒµ½£¬ÔÙ²éÕÒ @Order ×¢½â + // 查找order的值,先查找Ordered接å�£ï¼Œå¦‚果没找到,å†�查找 @Order 注解 int i1 = getOrder(o1, sourceProvider); int i2 = getOrder(o2, sourceProvider); - // °´Integer¹æÔò½øÐÐ±È½Ï + // 按Integer规则进行比较 return Integer.compare(i1, i2); } ``` -´ÓÉÏÃæµÄ´úÂë¿ÉÖª£¬ÏÈ±È½Ï `PriorityOrdered`£¬ÔÙ±È½Ï `Ordered`£¬±È½Ï¹æÔòÈçÏ£º +从上é�¢çš„代ç �å�¯çŸ¥ï¼Œå…ˆæ¯”较 `PriorityOrdered`,å†�比较 `Ordered`,比较规则如下: -1. `PriorityOrdered` ±È½Ï£ºÁ½ÕßÖ®ÖУ¬Ö»ÓÐÆäһʵÏÖÁË `PriorityOrdered` ½Ó¿Ú£¬ÄÇôÀàÐÍΪ `PriorityOrdered` ÓÅÏȼ¶¸ß£¬ ÆäËûÇé¿öÔò°´ `Ordered` µÄ¹æÔò±È½Ï£» -2. `Ordered` ±È½Ï¹æÔò£º - 1. Èç¹ûʵÏÖÁË `Ordered` »ò `PriorityOrdered` ½Ó¿Ú£¬Ôò¸ù¾Ý `getOrder()` ·µ»ØÖµ½øÐбȽϣ¬ÖµÔ½Ð¡ÓÅÏȼ¶Ô½¸ß£» - 2. Èç¹û±ê×¢ÁË `@Order/@Priority` ×¢½â£¬Ôò¸ù¾ÝÆä `value()` ·µ»ØÖµ½øÐбȽϣ¬ÖµÔ½Ð¡ÓÅÏȼ¶Ô½¸ß£» - 3. Èç¹ûûÓÐʵÏÖ `Ordered/PriorityOrdered`£¬Ò²Ã»Óбê×¢ `@Order/@Priority` ×¢½â£¬ÔòΪ×îµÍÓÅÏȼ¶ (`Integer.MAX_VALUE`). +1. `PriorityOrdered` 比较:两者之中,å�ªæœ‰å…¶ä¸€å®žçŽ°äº† `PriorityOrdered` 接å�£ï¼Œé‚£ä¹ˆç±»åž‹ä¸º `PriorityOrdered` 优先级高, 其他情况则按 `Ordered` 的规则比较; +2. `Ordered` 比较规则: + 1. 如果实现了 `Ordered` 或 `PriorityOrdered` 接å�£ï¼Œåˆ™æ ¹æ�® `getOrder()` 返回值进行比较,值越å°�优先级越高; + 2. 如果标注了 `@Order/@Priority` 注解,则根æ�®å…¶ `value()` 返回值进行比较,值越å°�优先级越高; + 3. 如果没有实现 `Ordered/PriorityOrdered`,也没有标注 `@Order/@Priority` 注解,则为最低优先级 (`Integer.MAX_VALUE`). ##### `comparePrecedenceWithinAspect` -¶ÔÓÚ `@Aspect` ±ê×¢µÄÀ࣬Èç¹ûͬһ `aspect` ÀﶨÒåÁËͬÑùµÄ `advice`£¬spring aop Ò²ÌṩÁËÒ»ÌױȽϹæÔò£º +对于 `@Aspect` 标注的类,如果å�Œä¸€ `aspect` 里定义了å�Œæ ·çš„ `advice`,spring aop 也æ��供了一套比较规则: ``` /** - * Õë¶Ô @Aspect£¬ ͬһaspectÀﶨÒåÁËͬÑùµÄ advice£¬ÔÙ´Î±È½Ï + * 针对 @Aspect, å�Œä¸€aspect里定义了å�Œæ ·çš„ advice,å†�次比较 */ private int comparePrecedenceWithinAspect(Advisor advisor1, Advisor advisor2) { boolean oneOrOtherIsAfterAdvice = (AspectJAopUtils.isAfterAdvice(advisor1) || AspectJAopUtils.isAfterAdvice(advisor2)); int adviceDeclarationOrderDelta = getAspectDeclarationOrder(advisor1) - getAspectDeclarationOrder(advisor2); - // ÆäÖÐÓÐÒ»¸öÊÇafter֪ͨ£¬declarationOrderInAspect´óµÄÓÅÏȼ¶¸ß + // 其中有一个是after通知,declarationOrderInAspect大的优先级高 if (oneOrOtherIsAfterAdvice) { if (adviceDeclarationOrderDelta < 0) { return LOWER_PRECEDENCE; @@ -280,7 +280,7 @@ private int comparePrecedenceWithinAspect(Advisor advisor1, Advisor advisor2) { return HIGHER_PRECEDENCE; } } - // Á½Õß¶¼²»ÊÇafter֪ͨ£¬declarationOrderInAspectСµÄÓÅÏȼ¶¸ß + // 两者都ä¸�是after通知,declarationOrderInAspectå°�的优先级高 else { if (adviceDeclarationOrderDelta < 0) { return HIGHER_PRECEDENCE; @@ -296,22 +296,22 @@ private int comparePrecedenceWithinAspect(Advisor advisor1, Advisor advisor2) { ``` -±È½Ï¹æÔòÈçÏ£º±È½ÏÁ½ÕßµÄ `declarationOrderInAspect` Öµ£¬Èç¹ûÁ½Õß֮һΪ `after` ֪ͨ£¬`declarationOrderInAspect` ´óµÄÓÅÏȼ¶¸ß£»Èç¹ûÁ½Õß¶¼²»ÊÇ `after` ֪ͨ£¬`declarationOrderInAspect` СµÄÓÅÏȼ¶¸ß¡£ +比较规则如下:比较两者的 `declarationOrderInAspect` 值,如果两者之一为 `after` 通知,`declarationOrderInAspect` 大的优先级高;如果两者都ä¸�是 `after` 通知,`declarationOrderInAspect` å°�的优先级高。 -ÕâÀïµÄ `declarationOrderInAspect` ÊÇÊ²Ã´ÄØ£¿ÕâÊÇÉÏһС½ÚÌáµ½µÄ `advisor.size()`£¬´úÂëÈçÏ£º +这里的 `declarationOrderInAspect` 是什么呢?这是上一å°�节æ��到的 `advisor.size()`,代ç �如下: > ReflectiveAspectJAdvisorFactory ``` public List getAdvisors(MetadataAwareAspectInstanceFactory aspectInstanceFactory) { - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... List advisors = new ArrayList<>(); - //»ñÈ¡Õâ¸öÀàËùÓеÄÔöÇ¿·½·¨ + //获å�–这个类所有的增强方法 for (Method method : getAdvisorMethods(aspectClass)) { - // Éú³ÉÔöǿʵÀý£¬advisors.size() ÒÀ´ÎΪ 0£¬1£¬2£¬... ÕâÊÇ - // declarationOrderInAspect µÄÖµ£¬ºóÃæÅÅÐò»áÓõ½ + // 生æˆ�增强实例,advisors.size() ä¾�次为 0,1,2,... 这是 + // declarationOrderInAspect 的值,å�Žé�¢æŽ’åº�会用到 Advisor advisor = getAdvisor(method, lazySingletonAspectInstanceFactory, advisors.size(), aspectName); if (advisor != null) { @@ -319,13 +319,13 @@ public List getAdvisors(MetadataAwareAspectInstanceFactory aspectInstan } } - // Ê¡ÂÔÁËһЩ´úÂë + // çœ�略了一些代ç � ... } ``` -ÌØ±ðÇ¿µ÷µÄÊÇ£¬Õâ¸ö¹æÔòÖ»ÊÊÓÃÓÚͬһ `@Aspect` ÀඨÒåµÄ¡¢Í¬ÑùµÄ֪ͨ·½·¨£¬È磺 +特别强调的是,这个规则å�ªé€‚用于å�Œä¸€ `@Aspect` 类定义的ã€�å�Œæ ·çš„通知方法,如: ``` @Aspect @@ -344,7 +344,7 @@ public class AspectTest { ``` -ÕâÀïµÄ `before1()` Óë `before2()` ¶ÔÓ¦µÄ `advisor` ÊÊÓÃÓÚ `comparePrecedenceWithinAspect` ÅÅÐò£¬¶øÒÔÏ´úÂë¾Í²»ÊÊÓÃÁË£¬Ô­ÒòÊÇÔÚ²»Í¬µÄ `@Aspect` ÀàÖж¨ÒåµÄ£º +这里的 `before1()` 与 `before2()` 对应的 `advisor` 适用于 `comparePrecedenceWithinAspect` 排åº�,而以下代ç �å°±ä¸�适用了,原因是在ä¸�å�Œçš„ `@Aspect` 类中定义的: ``` @Aspect @@ -369,7 +369,7 @@ public class AspectTest2 { #### 2. `super.sortAdvisors` -ÎÒÃÇÔٻعýÍ·À´¿´ `super.sortAdvisors(advisors)`: +我们å†�回过头æ�¥çœ‹ `super.sortAdvisors(advisors)`: > AspectJAwareAdvisorAutoProxyCreator @@ -383,7 +383,7 @@ protected List sortAdvisors(List advisors) { ``` -ÎÒÃǸú½øÈ¥£º +我们跟进去: > AbstractAdvisorAutoProxyCreator @@ -395,20 +395,20 @@ protected List sortAdvisors(List advisors) { ``` -·¢ÏÖ×îºóʹÓõÄÊÇ `AnnotationAwareOrderComparator.sort(advisors)`£¬Êµ¼ÊÉÏ£¬Õâ¸ö¾ÍÊÇÉÏÃæ·ÖÎöµÄ `this.advisorComparator.compare` µÄ±È½Ï¹æÔò£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË¡£ +å�‘现最å�Žä½¿ç”¨çš„æ˜¯ `AnnotationAwareOrderComparator.sort(advisors)`,实际上,这个就是上é�¢åˆ†æž�çš„ `this.advisorComparator.compare` 的比较规则,这里就ä¸�å†�分æž�了。 -### 3. `getOrder()` ÖµµÄÓÉÀ´ +### 3. `getOrder()` 值的由æ�¥ #### `BeanFactoryTransactionAttributeSourceAdvisor#getOrder()` -`BeanFactoryTransactionAttributeSourceAdvisor` ûÓÐ `@Order/@Priority`£¬µ«ËüʵÏÖÁË `Ordered` ½Ó¿Ú£¬Òò´ËËüµÄÖ´ÐÐ˳ÐòÓÉ `getOrder()` ·½·¨µÄ·µ»ØÖµ¾ö¶¨£¬¶ÔÓ¦µÄ `getOrder()` ·½·¨ÈçÏ£º +`BeanFactoryTransactionAttributeSourceAdvisor` 没有 `@Order/@Priority`,但它实现了 `Ordered` 接å�£ï¼Œå› æ­¤å®ƒçš„æ‰§è¡Œé¡ºåº�ç”± `getOrder()` 方法的返回值决定,对应的 `getOrder()` 方法如下: ``` /** - * »ñÈ¡ order£¬·½·¨ÈçÏ£º - * 1\. Èç¹ûÒÑÖ¸¶¨ÁË order£¬Ö±½Ó·µ»Ø£» - * 2\. »ñÈ¡ advisor µÄ advice£¬Èç¹û advice ʵÏÖÁË Ordered ½Ó¿Ú£¬µ÷Óà getOrder()£» - * 3\. Èç¹ûÒÔÉ϶¼²»Âú×㣬Ôò·µ»Ø Ordered.LOWEST_PRECEDENCE (×îµÍÓÅÏȼ¶)¡£ + * 获å�– order,方法如下: + * 1\. 如果已指定了 order,直接返回; + * 2\. 获å�– advisor çš„ advice,如果 advice 实现了 Ordered 接å�£ï¼Œè°ƒç”¨ getOrder()ï¼› + * 3\. 如果以上都ä¸�满足,则返回 Ordered.LOWEST_PRECEDENCE (最低优先级)。 * @return */ @Override @@ -425,25 +425,25 @@ protected List sortAdvisors(List advisors) { ``` -`Ordered.LOWEST_PRECEDENCE` Ϊ `Integer.MAX_VALUE`£¬¼´ `2147483647`£¬ÎÒÃÇÔÙ¿´¿´ `BeanFactoryTransactionAttributeSourceAdvisor` µÄ `getOrder()` ·½·¨·µ»ØµÄÖµ£º +`Ordered.LOWEST_PRECEDENCE` 为 `Integer.MAX_VALUE`,å�³ `2147483647`,我们å†�看看 `BeanFactoryTransactionAttributeSourceAdvisor` çš„ `getOrder()` 方法返回的值: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d05044b7dcd41855ab6e59727c4be74bdb9.png) -¿É¼û£¬`BeanFactoryTransactionAttributeSourceAdvisor` µÄÖ´ÐÐ˳ÐòÊÇĬÈ쵀 `Integer.MAX_VALUE`¡£Èç¹ûµ÷¶ÈµÄ»°£¬·¢ÏÖÕâ¸öÖµÊÇÔÚ `return this.order` ·µ»ØµÄ£º +å�¯è§�,`BeanFactoryTransactionAttributeSourceAdvisor` 的执行顺åº�是默认的 `Integer.MAX_VALUE`。如果调度的è¯�,å�‘现这个值是在 `return this.order` 返回的: ``` public int getOrder() { - // ͨ¹ýµ÷¶È·¢ÏÖ£¬this.order ²¢²»Îªnull + // 通过调度å�‘现,this.order å¹¶ä¸�为null if (this.order != null) { return this.order; } - // Ê¡ÂÔһЩ´úÂë + // çœ�略一些代ç � ... } ``` -ÄÇôÕâÖµÊÇ´ÓÄÄÀïÀ´µÄÄØ£¿¾­¹ýÖØÖØ·ÖÎö£¬·¢ÏÖÊÇÔÚ´´½¨ `BeanFactoryTransactionAttributeSourceAdvisor` ¶ÔÏóʱ£¬µ÷Óà `BeanFactoryTransactionAttributeSourceAdvisor#setOrder` ÉèÖõģº +那么这值是从哪里æ�¥çš„呢?ç»�过é‡�é‡�分æž�,å�‘现是在创建 `BeanFactoryTransactionAttributeSourceAdvisor` 对象时,调用 `BeanFactoryTransactionAttributeSourceAdvisor#setOrder` 设置的: > ProxyTransactionManagementConfiguration @@ -456,7 +456,7 @@ public BeanFactoryTransactionAttributeSourceAdvisor transactionAdvisor() { advisor.setTransactionAttributeSource(transactionAttributeSource()); advisor.setAdvice(transactionInterceptor()); if (this.enableTx != null) { - // ÕâÀï»ñÈ¡µÄÊÇ @EnableTransactionManagement ×¢½âµÄ order() Öµ + // 这里获å�–的是 @EnableTransactionManagement 注解的 order() 值 advisor.setOrder(this.enableTx.getNumber("order")); } return advisor; @@ -464,7 +464,7 @@ public BeanFactoryTransactionAttributeSourceAdvisor transactionAdvisor() { ``` -µ½ÕâÀïÎÒÃǾÍÃ÷°×ÁË£¬ÊÂÎñ advisor µÄÖ´ÐÐ˳Ðò¿ÉÒÔÔÚ `@EnableTransactionManagement` ÖÐÖ¸¶¨£º +到这里我们就明白了,事务 advisor 的执行顺åº�å�¯ä»¥åœ¨ `@EnableTransactionManagement` 中指定: ``` public @interface EnableTransactionManagement { @@ -474,7 +474,7 @@ public @interface EnableTransactionManagement { AdviceMode mode() default AdviceMode.PROXY; /** - * ÕâÀïÖ¸¶¨advisorÖ´ÐÐ˳Ðò£¬Ä¬ÈÏÊÇ×îµÍÓÅÏȼ¶ + * 这里指定advisor执行顺åº�,默认是最低优先级 */ int order() default Ordered.LOWEST_PRECEDENCE; @@ -482,11 +482,11 @@ public @interface EnableTransactionManagement { ``` -½áÂÛ£º`@EnableTransactionManagement` ×¢½âµÄ `order()` ·½·¨¿ÉÒÔÖ¸¶¨ `advisor` µÄÖ´ÐÐ˳Ðò¡£ +结论:`@EnableTransactionManagement` 注解的 `order()` 方法å�¯ä»¥æŒ‡å®š `advisor` 的执行顺åº�。 #### `InstantiationModelAwarePointcutAdvisorImpl#getOrder()` -´ÓÇ°ÃæµÄ·ÖÎö¿ÉÖª£¬`@Aspect` ÀàÖеÄÿһ¸ö·½·¨×îÖÕ¶¼»áת»¯Îª `advisor`£¬ÀàÐÍΪ `InstantiationModelAwarePointcutAdvisorImpl`£¬ËüҲʵÏÖÁË `Ordered` ½Ó¿Ú£¬Òò´ËÖ´ÐÐ˳ÐòÒ²ÊÇÓÉ `InstantiationModelAwarePointcutAdvisorImpl#getOrder()` ·½·¨¾ö¶¨£¬ËüµÄ `getOrder()` ·½·¨ÈçÏ£º +从å‰�é�¢çš„分æž�å�¯çŸ¥ï¼Œ`@Aspect` 类中的æ¯�一个方法最终都会转化为 `advisor`,类型为 `InstantiationModelAwarePointcutAdvisorImpl`,它也实现了 `Ordered` 接å�£ï¼Œå› æ­¤æ‰§è¡Œé¡ºåº�也是由 `InstantiationModelAwarePointcutAdvisorImpl#getOrder()` 方法决定,它的 `getOrder()` 方法如下: > InstantiationModelAwarePointcutAdvisorImpl @@ -498,11 +498,11 @@ public int getOrder() { ``` -ÔÚ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨ÉÏ£©](https://my.oschina.net/funcy/blog/4678817)ÎÒÃÇÒѾ­Ïêϸ·ÖÎöÁË `method` µ½ `advisor` µÄת±ä¹ý³Ì£¬ÄÜ´Ó´úÂëÉÏÇáËÉÕÒµ½ `aspectInstanceFactory` µÄÀàÐÍ£¬ÕâÀïÎÒÃǾͲ»ÔÙÒ»²½²½·ÖÎöÔ´ÂëÁË£¬Ö±½Óͨ¹ýµ÷ÊԵķ½·¨»ñÈ¡ `aspectInstanceFactory` µÄÀàÐÍ£º +在 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(上)](https://my.oschina.net/funcy/blog/4678817)我们已ç»�详细分æž�了 `method` 到 `advisor` 的转å�˜è¿‡ç¨‹ï¼Œèƒ½ä»Žä»£ç �上轻æ�¾æ‰¾åˆ° `aspectInstanceFactory` 的类型,这里我们就ä¸�å†�一步步分æž�æº�ç �了,直接通过调试的方法获å�– `aspectInstanceFactory` 的类型: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-e2784fc573474f56e8555ef60d57a07bcbf.png) -´Óµ÷ÊԵĽá¹ûÀ´¿´£¬`aspectInstanceFactory` ÀàÐÍΪ `LazySingletonAspectInstanceFactoryDecorator`£¬ÎÒÃǸú½øÆä `getOrder()` ·½·¨£º +从调试的结果æ�¥çœ‹ï¼Œ`aspectInstanceFactory` 类型为 `LazySingletonAspectInstanceFactoryDecorator`,我们跟进其 `getOrder()` 方法: > LazySingletonAspectInstanceFactoryDecorator @@ -514,27 +514,27 @@ public int getOrder() { ``` -ÎÒÃÇÒÀȻʹÓõ÷ÊԵķ½Ê½»ñÈ¡ `maaif` µÄÀàÐÍ£º +我们ä¾�然使用调试的方å¼�获å�– `maaif` 的类型: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-2a4b87b6c8c824c55c4a3d86d736796def0.png) -`maaif` ÀàÐÍΪ `BeanFactoryAspectInstanceFactory`£¬ÎÒÃǼÌÐø¸ú½ø£º +`maaif` 类型为 `BeanFactoryAspectInstanceFactory`,我们继续跟进: > BeanFactoryAspectInstanceFactory ``` public int getOrder() { - // this.name Ö¸µÄÊDZê×¢ÁË @Aspect ×¢½âµÄÀà + // this.name 指的是标注了 @Aspect 注解的类 Class type = this.beanFactory.getType(this.name); if (type != null) { - // Èç¹ûʵÏÖÁË Ordered ½Ó¿Ú£¬¾Íµ÷Óà getOrder() ·½·¨»ñÈ¡ - // PriorityOrdered ÊÇ Ordered µÄ×Ó½Ó¿Ú£¬Ò²ÓÐ getOrder() ·½·¨£¬Òò´ËÕâÀïÒ²»á»ñÈ¡µ½ + // 如果实现了 Ordered 接å�£ï¼Œå°±è°ƒç”¨ getOrder() 方法获å�– + // PriorityOrdered 是 Ordered çš„å­�接å�£ï¼Œä¹Ÿæœ‰ getOrder() 方法,因此这里也会获å�–到 if (Ordered.class.isAssignableFrom(type) && this.beanFactory.isSingleton(this.name)) { return ((Ordered) this.beanFactory.getBean(this.name)).getOrder(); } - // 1\. ²éÕÒÀàÊÇÊÇ·ñÓÐ @Order ×¢½â£¬Èç¹ûÓУ¬Ôò·µ»Ø @Order ×¢½âÖ¸¶¨µÄÖµ£» - // 2\. ·ñÔò²éѯÀàÊÇ·ñÓÐ @Priority ×¢½â£¬Èç¹ûÓУ¬Ôò·µ»Ø @Priority ×¢½âÖ¸¶¨µÄÖµ£» - // 3\. Èç¹ûÒÔÉ϶¼²»Âú×㣬·µ»Ø Ordered.LOWEST_PRECEDENCE£¬ÖµÎª Integer.MAX_VALUE + // 1\. 查找类是是å�¦æœ‰ @Order 注解,如果有,则返回 @Order 注解指定的值; + // 2\. å�¦åˆ™æŸ¥è¯¢ç±»æ˜¯å�¦æœ‰ @Priority 注解,如果有,则返回 @Priority 注解指定的值; + // 3\. 如果以上都ä¸�满足,返回 Ordered.LOWEST_PRECEDENCE,值为 Integer.MAX_VALUE return OrderUtils.getOrder(type, Ordered.LOWEST_PRECEDENCE); } return Ordered.LOWEST_PRECEDENCE; @@ -542,22 +542,22 @@ public int getOrder() { ``` -´Ó´úÂëÉÏÀ´¿´£¬`getOrder()` Âß¼­ÈçÏ£º +从代ç �上æ�¥çœ‹ï¼Œ`getOrder()` 逻辑如下: -1. ͨ¹ýÃû³Æ»ñÈ¡ÇÐÃæÀ࣬Ҳ¾ÍÊDZê×¢ÁË `@Aspect` µÄÀࣻ -2. Èç¹ûÇÐÃæÀàʵÏÖÁË `Ordered` ½Ó¿Ú£¬¾Íµ÷Óà `getOrder()` ·½·¨»ñÈ¡£¬·µ»Ø£¨ÖµµÃÒ»ÌáµÄÊÇ£¬`PriorityOrdered` ÊÇ `Ordered` µÄ×Ó½Ó¿Ú£¬Ò²ÓÐ `getOrder()` ·½·¨£¬ÕâÀïÒ²»á»ñÈ¡µ½£©£» -3. Èç¹ûÉÏÃæÃ»ÓлñÈ¡µ½£¬Ôò²éÕÒÇÐÃæÀàÊÇÊÇ·ñÓÐ `@Order` ×¢½â£¬Èç¹ûÓУ¬Ôò·µ»Ø `@Order` ×¢½âÖ¸¶¨µÄÖµ£»Èç¹ûûÓУ¬²éÕÒÇÐÃæÀàÊÇ·ñÓÐ `@Priority` ×¢½â£¬Èç¹ûÓУ¬Ôò·µ»Ø `@Priority` ×¢½âÖ¸¶¨µÄÖµ£» -4. Èç¹ûÒÔÉÏûÓлñÈ¡µ½Öµ£¬¾Í·µ»ØÄ¬ÈÏÖµ£º`Ordered.LOWEST_PRECEDENCE`¡£ +1. 通过å��称获å�–切é�¢ç±»ï¼Œä¹Ÿå°±æ˜¯æ ‡æ³¨äº† `@Aspect` 的类; +2. 如果切é�¢ç±»å®žçŽ°äº† `Ordered` 接å�£ï¼Œå°±è°ƒç”¨ `getOrder()` 方法获å�–,返回(值得一æ��的是,`PriorityOrdered` 是 `Ordered` çš„å­�接å�£ï¼Œä¹Ÿæœ‰ `getOrder()` 方法,这里也会获å�–到); +3. 如果上é�¢æ²¡æœ‰èŽ·å�–到,则查找切é�¢ç±»æ˜¯æ˜¯å�¦æœ‰ `@Order` 注解,如果有,则返回 `@Order` 注解指定的值;如果没有,查找切é�¢ç±»æ˜¯å�¦æœ‰ `@Priority` 注解,如果有,则返回 `@Priority` 注解指定的值; +4. 如果以上没有获å�–到值,就返回默认值:`Ordered.LOWEST_PRECEDENCE`。 -µ½ÕâÀï¾ÍÃ÷°×ÁË£¬`@Aspect` Àà¿ÉÒÔͨ¹ýʵÏÖ `Ordered/PriorityOrdered` ½Ó¿ÚÀ´Ö¸¶¨Ö´ÐÐÓÅÏȼ¶£¬Ò²¿ÉÒÔͨ¹ý `@Order/@Priority` ×¢½âÀ´Ö¸¶¨Ö´ÐÐÓÅÏȼ¶¡£ +到这里就明白了,`@Aspect` ç±»å�¯ä»¥é€šè¿‡å®žçް `Ordered/PriorityOrdered` 接å�£æ�¥æŒ‡å®šæ‰§è¡Œä¼˜å…ˆçº§ï¼Œä¹Ÿå�¯ä»¥é€šè¿‡ `@Order/@Priority` 注解æ�¥æŒ‡å®šæ‰§è¡Œä¼˜å…ˆçº§ã€‚ -**ÐèÒªÌØ±ðÖ¸³öµÄÊÇ**£¬´Ó `getOrder()` ´úÂëÀ´¿´£¬Õⲿ·Ö ´úÂëÖ» ÊÇ°Ñ `PriorityOrdered/@Priority` µ±×÷ `Order` À´´¦Àí£¬ÓÅÏȼ¶²¢²»±È `Ordered/@Order` ¸ß¡£Ò²¾ÍÊÇ˵£¬Èç¹û `AspectA` ±ê×¢Á˵ÄÁË `@Priority`£¬`AspectB` ±ê×¢Á˵ÄÁË `@Order`£¬`AspectA` µÄÓÅÏȼ¶²¢²»Ò»¶¨±È `AspectB` ¸ß£¬ÕæÕý¾ö¶¨ÓÅÏȼ¶µÄÊÇ×¢½â ÀïµÄ `value()` Öµ¡£ +**需è¦�特别指出的是**,从 `getOrder()` 代ç �æ�¥çœ‹ï¼Œè¿™éƒ¨åˆ† 代ç �å�ª 是把 `PriorityOrdered/@Priority` 当作 `Order` æ�¥å¤„ç�†ï¼Œä¼˜å…ˆçº§å¹¶ä¸�比 `Ordered/@Order` 高。也就是说,如果 `AspectA` 标注了的了 `@Priority`,`AspectB` 标注了的了 `@Order`,`AspectA` 的优先级并ä¸�一定比 `AspectB` 高,真正决定优先级的是注解 里的 `value()` 值。 -### 4\. ÈçºÎ×Ô¶¨ÒåÓÅÏȼ¶ +### 4\. 如何自定义优先级 -ÎÒÃÇÔÚ×Ô¼ºÐ´´úÂëʱ£¬ÈçºÎÖ¸¶¨ÓÅÏȼ¶ÄØ£¿ +我们在自己写代ç �时,如何指定优先级呢? -1. Èç¹ûÊÇ×ÔÖ÷ʵÏÖ `advisor`£¬¿ÉʵÏÖ `Ordered` ½Ó¿Ú£¬Ò²¿ÉÒÔÔÚ `advisor` ÀàÉϱê×¢ `@Order` ×¢½â£º +1. 如果是自主实现 `advisor`,å�¯å®žçް `Ordered` 接å�£ï¼Œä¹Ÿå�¯ä»¥åœ¨ `advisor` 类上标注 `@Order` 注解: ``` public class MyAdvisor extends AbstractBeanFactoryPointcutAdvisor implements Ordered { @@ -581,7 +581,7 @@ public int getOrder() { ``` -2. Èç¹ûÊǵ¥¸öÇÐÃæÀà (`@Aspect` ±ê×¢µÄÀà)£¬ÇÒÎÞÖØ¸´µÄ `@Around/@Before/@After` µÈ +2. 如果是å�•个切é�¢ç±» (`@Aspect` 标注的类),且无é‡�å¤�çš„ `@Around/@Before/@After` ç­‰ ``` @Aspect @@ -615,9 +615,9 @@ public int getOrder() { ``` - ¶ÔÓÚͬһÇÐÃæµÄ²»Í¬Í¨Öª£¬spring ÒѾ­°ïÎÒÃÇÉèÖúÃÁËÖ´ÐÐ˳Ðò£¬ÎÒÃÇÎÞ´Ó¸ü¸Ä£¬Ö´ÐÐ˳ÐòÒÀ´ÎΪ `Around, Before, After, AfterReturning, AfterThrowing`. + 对于å�Œä¸€åˆ‡é�¢çš„ä¸�å�Œé€šçŸ¥ï¼Œspring å·²ç»�帮我们设置好了执行顺åº�,我们无从更改,执行顺åº�ä¾�次为 `Around, Before, After, AfterReturning, AfterThrowing`. -3. µ¥¸öÇÐÃæÀà (`@Aspect` ±ê×¢µÄÀà) ÄÚÓÐÖØ¸´µÄ `@Around/@Before/@After` µÈ£¬Çé¿öÈçÏ£º +3. å�•个切é�¢ç±» (`@Aspect` 标注的类) 内有é‡�å¤�çš„ `@Around/@Before/@After` 等,情况如下: ``` @Aspect @@ -647,9 +647,9 @@ public int getOrder() { ``` - ÕâÖÖÇé¿öÎÒÃÇÔÚ `AspectJPrecedenceComparator#comparePrecedenceWithinAspect` ·½·¨Ê±ÓзÖÎö¹ý£¬µÃµ½µÄ½áÂÛÊÇ£º±È½ÏÁ½ÕßµÄ `declarationOrderInAspect` Öµ£¬Èç¹ûÁ½Õß֮һΪ `after` ֪ͨ£¬`declarationOrderInAspect` ´óµÄÓÅÏȼ¶¸ß£»Èç¹ûÁ½Õß¶¼²»ÊÇ `after` ֪ͨ£¬`declarationOrderInAspect` СµÄÓÅÏȼ¶¸ß¡£Õâ¸ö `declarationOrderInAspect` ÍêÈ«ÒÀÀµÓÚ jdk µÄ·´Éä»úÖÆ£¬ÏÈ»ñÈ¡µ½µÄÊÇÄĸö·½·¨£¬Äĸö·½·¨µÄ `declarationOrderInAspect` ¾ÍС£¬²»Í¬ jdK °æ±¾Ö®¼ä£¬ÄÑÒÔ±£Ö¤»ñµÃµÄ˳ÐòÒ»Ö¡£ + è¿™ç§�情况我们在 `AspectJPrecedenceComparator#comparePrecedenceWithinAspect` 方法时有分æž�过,得到的结论是:比较两者的 `declarationOrderInAspect` 值,如果两者之一为 `after` 通知,`declarationOrderInAspect` 大的优先级高;如果两者都ä¸�是 `after` 通知,`declarationOrderInAspect` å°�的优先级高。这个 `declarationOrderInAspect` 完全ä¾�赖于 jdk çš„å��射机制,先获å�–到的是哪个方法,哪个方法的 `declarationOrderInAspect` å°±å°�,ä¸�å�Œ jdK 版本之间,难以ä¿�è¯�获得的顺åº�一致。 -4. ¶à¸öÇÐÃæÀà (`@Aspect` ±ê×¢µÄÀà) µÄÖ´ÐÐ˳Ðò¿ÉÒÔͨ¹ý `@Order` ×¢½â£¬»òʵÏÖ `Ordered` ½Ó¿ÚÀ´Ö¸¶¨£º +4. 多个切é�¢ç±» (`@Aspect` 标注的类) 的执行顺åº�å�¯ä»¥é€šè¿‡ `@Order` 注解,或实现 `Ordered` 接å�£æ�¥æŒ‡å®šï¼š ``` @Order(xxx) @@ -664,8 +664,8 @@ public int getOrder() { ``` -ÁíÍ⣬`getOrder()` ·µ»ØµÄÖµ»ò `@Order(xxx)` Ö¸¶¨µÄֵԽС£¬±íÃ÷ÓÅÏȼ¶Ô½¸ß¡£ +å�¦å¤–,`getOrder()` 返回的值或 `@Order(xxx)` 指定的值越å°�,表明优先级越高。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4784828](https://my.oschina.net/funcy/blog/4784828) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4784828](https://my.oschina.net/funcy/blog/4784828) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213Spring\344\272\213\344\273\266\346\234\272\345\210\266.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213Spring\344\272\213\344\273\266\346\234\272\345\210\266.md" index 5d4fa2c..127a191 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213Spring\344\272\213\344\273\266\346\234\272\345\210\266.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213Spring\344\272\213\344\273\266\346\234\272\345\210\266.md" @@ -1,8 +1,8 @@ -### 1\. demo ×¼±¸ +### 1\. demo 准备 -ÔÚÕýʽ·ÖÎöʼþ»úÖÆÇ°£¬ÎÒÃÇÏÈÀ´×¼±¸Ò»¸ö demo£º +在正å¼�分æž�事件机制å‰�,我们先æ�¥å‡†å¤‡ä¸€ä¸ª demo: -1. ×¼±¸Ò»¸öʼþÀà `MyApplicationEvent`£º +1. 准备一个事件类 `MyApplicationEvent`: ``` public class MyApplicationEvent extends ApplicationEvent { @@ -16,7 +16,7 @@ public class MyApplicationEvent extends ApplicationEvent { ``` -1. ×¼±¸Ò»¸ö¼àÌýÆ÷ `MyApplicationEventListener`£¬¶Ôʼþ `MyApplicationEvent` ½øÐмàÌý£º +1. 准备一个监å�¬å™¨ `MyApplicationEventListener`,对事件 `MyApplicationEvent` 进行监å�¬ï¼š ``` @Component @@ -31,7 +31,7 @@ public class MyApplicationEventListener ``` -×¼±¸Ò»¸öÅäÖÃÀ࣬ÏȲ»Ö¸¶¨ÄÚÈÝ£º +准备一个é…�置类,先ä¸�指定内容: ``` @Configuration @@ -42,7 +42,7 @@ public class Demo08Config { ``` -×îºóÊÇÖ÷Àࣺ +最å�Žæ˜¯ä¸»ç±»ï¼š ``` @ComponentScan @@ -51,49 +51,49 @@ public class Demo08Main { public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(Demo08Config.class); - // ·¢²¼Ê¼þ + // å�‘布事件 context.publishEvent( - new MyApplicationEvent(Thread.currentThread().getName() + " | ×Ô¶¨Òåʼþ ...")); + new MyApplicationEvent(Thread.currentThread().getName() + " | 自定义事件 ...")); } } ``` -ÒÔÉÏ´úÂ붨ÒåÁËÒ»¸öʼþ `MyApplicationEvent`£¬È»ºó¶¨ÒåÁËÒ»¸ö¼àÌýÆ÷ `MyApplicationEventListener`£¬ÓÃÀ´¼àÌý `MyApplicationEvent` ʼþ£¬È»ºóÔÚ `main()` ·½·¨ÖУ¬µ÷Óà `context.publishEvent(...)` ·½·¨À´·¢²¼¸Ãʼþ¡£ +以上代ç �定义了一个事件 `MyApplicationEvent`,然å�Žå®šä¹‰äº†ä¸€ä¸ªç›‘å�¬å™¨ `MyApplicationEventListener`,用æ�¥ç›‘å�¬ `MyApplicationEvent` 事件,然å�Žåœ¨ `main()` 方法中,调用 `context.publishEvent(...)` 方法æ�¥å�‘布该事件。 -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` -main | main | ×Ô¶¨Òåʼþ ... +main | main | 自定义事件 ... ``` -¿ÉÒÔ¿´µ½£¬Ê¼þ³É¹¦¼àÌýµ½ÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œäº‹ä»¶æˆ�功监å�¬åˆ°äº†ã€‚ -´ÓÔËÐпÉÖª£¬Ê¼þµÄ·¢²¼Ïß³ÌΪ `main`£¬Ê¼þµÄ¼àÌý´¦ÀíÏß³ÌÒ²ÊÇ `main`¡£ +从è¿�行å�¯çŸ¥ï¼Œäº‹ä»¶çš„å�‘布线程为 `main`,事件的监å�¬å¤„ç�†çº¿ç¨‹ä¹Ÿæ˜¯ `main`。 -### 2\. ʼþ×é¼þ½éÉÜ +### 2\. 事件组件介ç»� -Õýʽ¿ª½²Ç°£¬ÎÒÃÇÏÈÀ´½éÉÜÏÂʼþÏà¹ØµÄ×é¼þ¡£Ê¼þÏà¹ØµÄ×é¼þÓÐ 4 ¸ö£º +æ­£å¼�开讲å‰�,我们先æ�¥ä»‹ç»�下事件相关的组件。事件相关的组件有 4 个: -1. ʼþ£º·¢²¼µÄÄÚÈÝ -2. ·¢²¼Æ÷£ºÓÃÀ´·¢²¼Ê¼þµÄ×é¼þ -3. ¹ã²¥Æ÷£º½ÓÊÕ·¢²¼Æ÷·¢²¼µÄʼþ£¬²¢½«½ÓÊÕµ½µÄʼþ¹ã²¥¸ø¼àÌýÆ÷ -4. ¼àÌýÆ÷£º¼àÌýʼþ +1. 事件:å�‘布的内容 +2. å�‘布器:用æ�¥å�‘布事件的组件 +3. 广播器:接收å�‘布器å�‘布的事件,并将接收到的事件广播给监å�¬å™¨ +4. 监å�¬å™¨ï¼šç›‘å�¬äº‹ä»¶ -ÏÂÃæÎÒÃÇÒ»Ò»À´·ÖÎö¡£ +下é�¢æˆ‘们一一æ�¥åˆ†æž�。 -#### 2.1 ʼþ +#### 2.1 事件 -spring ÌṩµÄʼþΪ `ApplicationEvent`£¬ÕâÊÇÒ»¸ö³éÏóÀ࣬¼Ì³ÐÁË jdk ÌṩµÄ `EventObject` À࣬·¢²¼×Ô¶¨Òåʼþʱ£¬¿É¼Ì³Ð `ApplicationEvent`£º +spring æ��供的事件为 `ApplicationEvent`,这是一个抽象类,继承了 jdk æ��供的 `EventObject` 类,å�‘布自定义事件时,å�¯ç»§æ‰¿ `ApplicationEvent`: ``` public abstract class ApplicationEvent extends EventObject { private static final long serialVersionUID = 7099057708183571937L; - /** Ôö¼Ó timestamp ÊôÐÔ*/ + /** 增加 timestamp 属性*/ private final long timestamp; public ApplicationEvent(Object source) { @@ -108,17 +108,17 @@ public abstract class ApplicationEvent extends EventObject { ``` -`ApplicationEvent` ÊÇ `EventObject`£¬ÎÒÃǼÌÐø£º +`ApplicationEvent` 是 `EventObject`,我们继续: ``` /** - * EventObject ÓÉjdkÌṩ£¬Î»ÓÚ java.util °ü¡£ + * EventObject ç”±jdkæ��供,ä½�于 java.util 包。 */ public class EventObject implements java.io.Serializable { private static final long serialVersionUID = 5516075349620653480L; - // ʼþÄÚÈÝ + // 事件内容 protected transient Object source; public EventObject(Object source) { @@ -129,7 +129,7 @@ public class EventObject implements java.io.Serializable { } /** - * »ñȡʼþÄÚÈÝ + * 获å�–事件内容 */ public Object getSource() { return source; @@ -142,29 +142,29 @@ public class EventObject implements java.io.Serializable { ``` -½áºÏ `ApplicationEvent` Óë `EventObject` À´¿´£¬`ApplicationEvent` ÌṩÁËÁ½¸öÊôÐÔ£º +结å�ˆ `ApplicationEvent` 与 `EventObject` æ�¥çœ‹ï¼Œ`ApplicationEvent` æ��供了两个属性: -* `source`£ºÀ´×Ô `EventObject` µÄÊôÐÔ£¬¶¨ÒåÁËʼþµÄÄÚÈÝ£» -* `timestamp`: ʱ¼ä´Á£¬ÓÃÀ´¼Ç¼ÊÇʼþµÄÉú³Éʱ¼ä¡£ +* `source`:æ�¥è‡ª `EventObject` 的属性,定义了事件的内容; +* `timestamp`: 时间戳,用æ�¥è®°å½•是事件的生æˆ�时间。 -ʵ¼ÊÉÏ£¬spring ³ýÁËÄÜ·¢²¼ `ApplicationEvent` ÀàÐ͵ÄʼþÍ⣬»¹¿ÉÒÔ·¢²¼ `Object` ÀàÐ͵Äʼþ£¬½ÓÏÂÃæ²é¿´·¢²¼Æ÷¾Í¿ÉÒÔ·¢ ÏÖÕâÒ»µã¡£ +实际上,spring 除了能å�‘布 `ApplicationEvent` 类型的事件外,还å�¯ä»¥å�‘布 `Object` 类型的事件,接下é�¢æŸ¥çœ‹å�‘布器就å�¯ä»¥å�‘ 现这一点。 -#### 2.2 ·¢²¼Æ÷ +#### 2.2 å�‘布器 -spring ÌṩµÄ·¢²¼Æ÷Ϊ `ApplicationEventPublisher`£¬´úÂëÈçÏ£º +spring æ��供的å�‘布器为 `ApplicationEventPublisher`,代ç �如下: ``` public interface ApplicationEventPublisher { /** - * ·¢²¼ApplicationEventÀàÐ͵Äʼþ + * å�‘布ApplicationEvent类型的事件 */ default void publishEvent(ApplicationEvent event) { publishEvent((Object) event); } /** - * ·¢²¼ObjectÀàÐ͵Äʼþ + * å�‘布Object类型的事件 */ void publishEvent(Object event); @@ -172,54 +172,54 @@ public interface ApplicationEventPublisher { ``` -ÕâÊǸö½Ó¿Ú£¬ÆäÄÚ¶¨ÒåÁËÁ½¸ö·½·¨£º +这是个接å�£ï¼Œå…¶å†…定义了两个方法: -* `void publishEvent(ApplicationEvent event)`: ÓÃÀ´·¢²¼ `ApplicationEvent` ÀàÐ͵Äʼþ -* `void publishEvent(Object event)`: ÓÃÀ´·¢²¼ `Object` ÀàÐ͵Äʼþ +* `void publishEvent(ApplicationEvent event)`: 用æ�¥å�‘布 `ApplicationEvent` 类型的事件 +* `void publishEvent(Object event)`: 用æ�¥å�‘布 `Object` 类型的事件 -`AbstractApplicationContext` ÊÇ `ApplicationEventPublisher` µÄ×ÓÀ࣬Òò´ËÎÒÃÇ¿ÉÒÔÖ±½Óµ÷Óà `AbstractApplicationContext#publishEvent` À´·¢²¼Ê¼þ¡£ +`AbstractApplicationContext` 是 `ApplicationEventPublisher` çš„å­�类,因此我们å�¯ä»¥ç›´æŽ¥è°ƒç”¨ `AbstractApplicationContext#publishEvent` æ�¥å�‘布事件。 -¹ØÓÚ `AbstractApplicationContext` ¶ÔÕâÁ½¸ö·½·¨µÄʵÏÖ£¬ÎÒÃǺóÃæ·ÖÎö·¢²¼Á÷³ÌʱÔÙ¾ßÌå·ÖÎö¡£ +关于 `AbstractApplicationContext` 对这两个方法的实现,我们å�Žé�¢åˆ†æž�å�‘布æµ�程时å†�具体分æž�。 -#### 2.3 ¹ã²¥Æ÷ +#### 2.3 广播器 -¹ã²¥Æ÷µÄ×÷ÓÃÊǽÓÊÕ·¢²¼µÄʼþ£¬È»ºó½«Ê¼þ¹ã²¥¸ø¼àÌýÆ÷£¬´úÂëÈçÏ£º +广播器的作用是接收å�‘布的事件,然å�Žå°†äº‹ä»¶å¹¿æ’­ç»™ç›‘å�¬å™¨ï¼Œä»£ç �如下: ``` public interface ApplicationEventMulticaster { /** - * Ìí¼Ó¼àÌýÆ÷ + * 添加监å�¬å™¨ */ void addApplicationListener(ApplicationListener listener); /** - * Ìí¼Ó¼àÌýÆ÷µÄ beanName + * 添加监å�¬å™¨çš„ beanName */ void addApplicationListenerBean(String listenerBeanName); /** - * ÒÆ³ý¼àÌýÆ÷ + * 移除监å�¬å™¨ */ void removeApplicationListener(ApplicationListener listener); /** - * ÒÆ³ý¼àÌýÆ÷µÄ beanName + * 移除监å�¬å™¨çš„ beanName */ void removeApplicationListenerBean(String listenerBeanName); /** - * ÒÆ³ýËùÓеļàÌýÆ÷ + * 移除所有的监å�¬å™¨ */ void removeAllListeners(); /** - * ¹ã²¥Ê¼þ + * 广播事件 */ void multicastEvent(ApplicationEvent event); /** - * ¹ã²¥Ê¼þ + * 广播事件 */ void multicastEvent(ApplicationEvent event, @Nullable ResolvableType eventType); @@ -227,23 +227,23 @@ public interface ApplicationEventMulticaster { ``` -´Ó´úÂëÉÏÀ´¿´£¬¹ã²¥Æ÷Ö÷Òª¹¦ÄÜÓÐÁ½¸ö£º +从代ç �上æ�¥çœ‹ï¼Œå¹¿æ’­å™¨ä¸»è¦�功能有两个: -1. ά»¤¼àÌýÆ÷£¬¿ÉÒÔ¶Ô¼àÌýÆ÷½øÐÐÔöɾ²Ù×÷ -2. ¹ã²¥Ê¼þ +1. 维护监å�¬å™¨ï¼Œå�¯ä»¥å¯¹ç›‘å�¬å™¨è¿›è¡Œå¢žåˆ æ“�作 +2. 广播事件 -spring ĬÈϵĹ㲥Æ÷Ϊ `SimpleApplicationEventMulticaster`£¬Õâ¸öÎÒÃǺóÃæ»áÔÙ·ÖÎö¡£ +spring 默认的广播器为 `SimpleApplicationEventMulticaster`,这个我们å�Žé�¢ä¼šå†�分æž�。 -#### 2.4 ¼àÌýÆ÷ +#### 2.4 监å�¬å™¨ -¼àÌýÆ÷ÓÃÀ´¼àÌý·¢²¼µÄʼþ£¬È»ºó×öһЩ´¦Àí²Ù×÷£¬´úÂëÈçÏ£º +监å�¬å™¨ç”¨æ�¥ç›‘å�¬å�‘布的事件,然å�Žå�šä¸€äº›å¤„ç�†æ“�作,代ç �如下: ``` @FunctionalInterface public interface ApplicationListener extends EventListener { /** - * ´¦Àíʼþ + * 处ç�†äº‹ä»¶ */ void onApplicationEvent(E event); @@ -251,36 +251,36 @@ public interface ApplicationListener extends EventLi ``` -ÔÚ´¦Àíʼþ¼àÌýʱ£¬ÎÒÃÇÐèҪʵÏÖ `ApplicationListener`£¬È»ºóÔÚ `onApplicationEvent(...)` ·½·¨ÖбàдÎÒÃǵÄʼþ¼àÌýÂß¼­¡£ +在处ç�†äº‹ä»¶ç›‘å�¬æ—¶ï¼Œæˆ‘们需è¦�实现 `ApplicationListener`,然å�Žåœ¨ `onApplicationEvent(...)` 方法中编写我们的事件监å�¬é€»è¾‘。 -### 3\. »Ø¹Ë£º`¹ã²¥Æ÷µÄ³õʼ»¯`Óë`¼àÌýÆ÷µÄ×¢²á` +### 3\. 回顾:`广播器的åˆ�始化`与`监å�¬å™¨çš„æ³¨å†Œ` -±¾½ÚÎÒÃÇÀ´»Ø¹ËÏÂ`ʼþ¹ã²¥Æ÷µÄ³õʼ»¯`Óë`¼àÌýÆ÷µÄ×¢²á`µÄÁ÷³Ì¡£ +本节我们æ�¥å›žé¡¾ä¸‹`事件广播器的åˆ�始化`与`监å�¬å™¨çš„æ³¨å†Œ`çš„æµ�程。 -ÔÚ´¦Àí spring ÈÝÆ÷Æô¶¯µÄ `AbstractApplicationContext#refresh` ·½·¨ÖУ¬`ʼþ¹ã²¥Æ÷µÄ³õʼ»¯`Óë`¼àÌýÆ÷µÄ×¢²á`·Ö±ð·¢ÉúÔÚµÚ 8 ²½ÓëµÚ 10 ²½£º +在处ç�† spring 容器å�¯åŠ¨çš„ `AbstractApplicationContext#refresh` 方法中,`事件广播器的åˆ�始化`与`监å�¬å™¨çš„æ³¨å†Œ`分别å�‘生在第 8 步与第 10 步: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c4d4ac83c23e41a706b7ba545fd8d0f7681.png) -Ïà¹Ø´úÂëÈçÏ£º +相关代ç �如下: ``` public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext { /** - * ³õʼ»¯¹ã²¥Æ÷ - * Èç¹ûÒÑÅäÖÃÁËʼþ¹ã²¥Æ÷£¬¾ÍʹÓÃÒÑÅäÖõ쬷ñÔò¾ÍʹÓÃĬÈϵÄʼþ¹ã²¥Æ÷ + * åˆ�始化广播器 + * 如果已é…�置了事件广播器,就使用已é…�置的,å�¦åˆ™å°±ä½¿ç”¨é»˜è®¤çš„事件广播器 */ protected void initApplicationEventMulticaster() { ConfigurableListableBeanFactory beanFactory = getBeanFactory(); - // Èç¹ûÓû§ÅäÖÃÁË×Ô¶¨Òåʼþ¹ã²¥Æ÷£¬¾ÍʹÓÃÓû§µÄ + // 如果用户é…�置了自定义事件广播器,就使用用户的 if (beanFactory.containsLocalBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME)) { this.applicationEventMulticaster = beanFactory.getBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, ApplicationEventMulticaster.class); } else { - // Óû§Ã»ÓÐÅäÖù㲥Æ÷£¬¾ÍʹÓÃĬÈϵÄʼþ¹ã²¥Æ÷ + // 用户没有é…�置广播器,就使用默认的事件广播器 this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory); beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, this.applicationEventMulticaster); @@ -288,24 +288,24 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader } /** - * ×¢²á¼àÌýÆ÷ + * 注册监å�¬å™¨ */ protected void registerListeners() { - // 1\. ÏȽ«ÊÖ¶¯Ìí¼ÓµÄ¼àÌýÆ÷·Åµ½¹ã²¥Æ÷ÖÐ - // µ÷ÓÃAbstractApplicationContext#addApplicationListener½øÐÐÌí¼Ó + // 1\. 先将手动添加的监å�¬å™¨æ”¾åˆ°å¹¿æ’­å™¨ä¸­ + // 调用AbstractApplicationContext#addApplicationListener进行添加 for (ApplicationListener listener : getApplicationListeners()) { getApplicationEventMulticaster().addApplicationListener(listener); } - // 2\. ´ÓbeanFactoryÖлñȡȡ¼àÌýÆ÷µÄÃû³Æ£¬Ìí¼Óµ½¹ã²¥Æ÷ÖÐ + // 2\. 从beanFactory中获å�–å�–监å�¬å™¨çš„å��称,添加到广播器中 String[] listenerBeanNames = getBeanNamesForType(ApplicationListener.class, true, false); for (String listenerBeanName : listenerBeanNames) { getApplicationEventMulticaster().addApplicationListenerBean(listenerBeanName); } - // 3\. Èç¹û´æÔÚÔçÆÚÓ¦ÓÃʼþ£¬·¢²¼ + // 3\. 如果存在早期应用事件,å�‘布 Set earlyEventsToProcess = this.earlyApplicationEvents; - // ½« earlyApplicationEvents ÉèÖÃΪ null£¬ÔÙ·¢²¼ÔçÆÚʼþ + // å°† earlyApplicationEvents 设置为 null,å†�å�‘布早期事件 this.earlyApplicationEvents = null; if (earlyEventsToProcess != null) { for (ApplicationEvent earlyEvent : earlyEventsToProcess) { @@ -320,24 +320,24 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader ``` -¹ã²¥Æ÷µÄ³õʼ»¯Âß¼­ºÜ¼òµ¥£¬¼´Èç¹ûÒÑÅäÖÃÁËʼþ¹ã²¥Æ÷£¬¾ÍʹÓÃÒÑÅäÖõ쬷ñÔò¾ÍʹÓÃĬÈϵÄʼþ¹ã²¥Æ÷£¬Ä¬ÈϵÄʼþ¹ã²¥Æ÷ÊÇ `SimpleApplicationEventMulticaster`¡£ +广播器的åˆ�始化逻辑很简å�•,å�³å¦‚果已é…�置了事件广播器,就使用已é…�置的,å�¦åˆ™å°±ä½¿ç”¨é»˜è®¤çš„事件广播器,默认的事件广播器是 `SimpleApplicationEventMulticaster`。 -×¢²á¼àÌýÆ÷µÄÁ÷³ÌÈçÏ£º +注册监å�¬å™¨çš„æµ�程如下: -1. ÏȽ«ÊÖ¶¯Ìí¼ÓµÄ¼àÌýÆ÷·Åµ½¹ã²¥Æ÷ÖУ¬ÎÒÃÇ¿ÉÒÔµ÷Óà `AbstractApplicationContext#addApplicationListener` Ìí¼Ó¼àÌýÆ÷£» -2. ´Ó `beanFactory` Öлñȡȡ¼àÌýÆ÷µÄÃû³Æ£¬Ìí¼Óµ½¹ã²¥Æ÷ÖУ¬×¢Ò⣺´Ëʱ `beanFactory` ÖÐµÄ bean ²¢Ã»Óгõʼ»¯£¬Òò´ËÖ»ÄÜÌí¼Ó `beanName`; -3. Èç¹û´æÔÚÔçÆÚʼþ£¬¾Í·¢²¼ÔçÆÚʼþ¡£ +1. 先将手动添加的监å�¬å™¨æ”¾åˆ°å¹¿æ’­å™¨ä¸­ï¼Œæˆ‘们å�¯ä»¥è°ƒç”¨ `AbstractApplicationContext#addApplicationListener` 添加监å�¬å™¨ï¼› +2. 从 `beanFactory` 中获å�–å�–监å�¬å™¨çš„å��称,添加到广播器中,注æ„�:此时 `beanFactory` 中的 bean 并没有åˆ�始化,因此å�ªèƒ½æ·»åŠ  `beanName`; +3. 如果存在早期事件,就å�‘布早期事件。 -»Ø¹ËÍêÕâÁ½¸öÁ÷³Ìºó£¬ÎÒÃÇ´óÄÔÖÐÐèÒªÇå³þµØÃ÷°×ÒÔÏÂÁ½µã£º +回顾完这两个æµ�程å�Žï¼Œæˆ‘们大脑中需è¦�清楚地明白以下两点: -1. ¹ã²¥Æ÷ÊÇÔÚÄÄÀï³õʼ»¯µÄ -2. ¼àÌýÆ÷ÊÇÔÚÄÄÀï×¢²áµ½¹ã²¥Æ÷ÖÐµÄ +1. 广播器是在哪里åˆ�始化的 +2. 监å�¬å™¨æ˜¯åœ¨å“ªé‡Œæ³¨å†Œåˆ°å¹¿æ’­å™¨ä¸­çš„ -### 4\. ʼþ·¢²¼Á÷³Ì +### 4\. 事件å�‘布æµ�程 -¾­¹ýÇ°ÃæÁ½½ÚµÄÆÌµæ£¬ÎÒÃǶÔʼþµÄ×é¼þÒѾ­ÓÐÁ˸ö´ó¸ÅµÄ¸ÅÄҲÃ÷°×ÁËʼþ¹ã²¥Æ÷µÄ³õʼ»¯Óë¼àÌýÆ÷µÄ×¢²áÁ÷³Ì£¬½ÓÏÂÀ´ ÎÒÃǾÍÕýʽ·ÖÎöʼþµÄ·¢²¼Á÷³ÌÁË¡£ +ç»�过å‰�é�¢ä¸¤èŠ‚çš„é“ºåž«ï¼Œæˆ‘ä»¬å¯¹äº‹ä»¶çš„ç»„ä»¶å·²ç»�有了个大概的概念,也明白了事件广播器的åˆ�始化与监å�¬å™¨çš„æ³¨å†Œæµ�程,接下æ�¥ 我们就正å¼�分æž�事件的å�‘布æµ�程了。 -ÔÚ demo ÖУ¬ÎÒÃǵ÷Óà `context.publishEvent(...)` À´·¢²¼Ê¼þ£¬ÎÒÃǸú½øÕâ¸ö·½·¨£º +在 demo 中,我们调用 `context.publishEvent(...)` æ�¥å�‘布事件,我们跟进这个方法: ``` public abstract class AbstractApplicationContext extends DefaultResourceLoader @@ -350,7 +350,7 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader protected void publishEvent(Object event, @Nullable ResolvableType eventType) { Assert.notNull(event, "Event must not be null"); - // ´¦ÀíʼþÀàÐÍ + // 处ç�†äº‹ä»¶ç±»åž‹ ApplicationEvent applicationEvent; if (event instanceof ApplicationEvent) { applicationEvent = (ApplicationEvent) event; @@ -362,17 +362,17 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader } } - // earlyApplicationEvents ²»Îª null£¬½«applicationEventÌí¼Óµ½ earlyApplicationEvents - // ÔÚ×¢²á¼àÌýÆ÷ºó£¬»á°Ñ earlyApplicationEvents ÉèÖÃΪ null + // earlyApplicationEvents ä¸�为 null,将applicationEvent添加到 earlyApplicationEvents + // 在注册监å�¬å™¨å�Žï¼Œä¼šæŠŠ earlyApplicationEvents 设置为 null if (this.earlyApplicationEvents != null) { this.earlyApplicationEvents.add(applicationEvent); } else { - // ÕâÀïÊÇ·¢²¼Ê¼þµÄ²Ù×÷ + // 这里是å�‘布事件的æ“�作 getApplicationEventMulticaster().multicastEvent(applicationEvent, eventType); } - // ´æÔÚ¸¸ÈÝÆ÷£¬Ò»Ñù·¢²¼ + // 存在父容器,一样å�‘布 if (this.parent != null) { if (this.parent instanceof AbstractApplicationContext) { ((AbstractApplicationContext) this.parent).publishEvent(event, eventType); @@ -387,29 +387,29 @@ public abstract class AbstractApplicationContext extends DefaultResourceLoader ``` -Õâ¸ö·½·¨ºÜ¼òµ¥£¬¹Ø¼ü´úÂëΪ +这个方法很简å�•,关键代ç �为 ``` -// ÕâÀïÊÇ·¢²¼Ê¼þµÄ²Ù×÷ +// 这里是å�‘布事件的æ“�作 getApplicationEventMulticaster().multicastEvent(applicationEvent, eventType); ``` -ÕâÐдúÂëÏÈ»ñÈ¡ÁËʼþ¹ã²¥Æ÷£¬È»ºó¹ã²¥Ê¼þ¡£ +这行代ç �先获å�–了事件广播器,然å�Žå¹¿æ’­äº‹ä»¶ã€‚ -Ç°ÃæÌáµ½£¬spring ÌṩµÄĬÈϵÄʼþ¹ã²¥Æ÷ÊÇ `SimpleApplicationEventMulticaster`£¬ÎÒÃǽøÈë `SimpleApplicationEventMulticaster#multicastEvent(ApplicationEvent, ResolvableType)` À´¿´¿´Ê¼þµÄ¹ã²¥Á÷³Ì£º +å‰�é�¢æ��到,spring æ��供的默认的事件广播器是 `SimpleApplicationEventMulticaster`,我们进入 `SimpleApplicationEventMulticaster#multicastEvent(ApplicationEvent, ResolvableType)` æ�¥çœ‹çœ‹äº‹ä»¶çš„广播æµ�程: ``` /** - * ¹ã²¥Ê¼þ + * 广播事件 */ public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) { ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event)); - // 1\. »ñÈ¡ TaskExecutor + // 1\. 获å�– TaskExecutor Executor executor = getTaskExecutor(); - // 2\. getApplicationListeners(...) »ñÈ¡ÄܼàÌý¸ÃʼþµÄ¼àÌýÆ÷ + // 2\. getApplicationListeners(...) 获å�–能监å�¬è¯¥äº‹ä»¶çš„监å�¬å™¨ for (ApplicationListener listener : getApplicationListeners(event, type)) { - // 3\. ±éÀú¼àÌýÆ÷£¬ÖðÒ»µ÷Óà invokeListener(...) ·½·¨ + // 3\. é��历监å�¬å™¨ï¼Œé€�一调用 invokeListener(...) 方法 if (executor != null) { executor.execute(() -> invokeListener(listener, event)); } @@ -421,17 +421,17 @@ public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableTyp ``` -ÒÔÉÏ·½·¨°üº¬ 3 ¸ö²Ù×÷£º +以上方法包å�« 3 个æ“�作: -1. »ñȡִÐÐÆ÷£º`getTaskExecutor()` -2. »ñȡʼþµÄ¼àÌýÆ÷£º`getApplicationListeners(...)` -3. µ÷ÓüàÌýÆ÷µÄ¼àÌý·½·¨£º`invokeListener(...)` +1. 获å�–执行器:`getTaskExecutor()` +2. 获å�–事件的监å�¬å™¨ï¼š`getApplicationListeners(...)` +3. 调用监å�¬å™¨çš„监å�¬æ–¹æ³•:`invokeListener(...)` -ÒÔÉϲÙ×÷°üº¬ÁËʼþ¹ã²¥µÄÕû¸öÁ÷³Ì£¬ÎÒÃÇÏÂÃæÀ´ºÃºÃ·ÖÎöÏ¡£ +以上æ“�作包å�«äº†äº‹ä»¶å¹¿æ’­çš„æ•´ä¸ªæµ�程,我们下é�¢æ�¥å¥½å¥½åˆ†æž�下。 -#### 1\. »ñȡִÐÐÆ÷£º`getTaskExecutor()` +#### 1\. 获å�–执行器:`getTaskExecutor()` -`taskExecutor` ÊÇ `SimpleApplicationEventMulticaster` µÄÒ»¸öÊôÐÔ£¬`getTaskExecutor()` ÊÇ `taskExecutor` µÄ `getter` ·½·¨£º +`taskExecutor` 是 `SimpleApplicationEventMulticaster` 的一个属性,`getTaskExecutor()` 是 `taskExecutor` çš„ `getter` 方法: ``` private Executor taskExecutor; @@ -447,9 +447,9 @@ public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableTyp ``` -spring ΪÎÒÃÇÌṩÁËÁ½ÖÖÀàÐ굀 `taskExecutor`£º +spring 为我们æ��供了两ç§�类型的 `taskExecutor`: -1. `SyncTaskExecutor`£ºÍ¬²½µÄ `taskExecutor`£¬Æä `execute(...)` ·½·¨Îª£º +1. `SyncTaskExecutor`:å�Œæ­¥çš„ `taskExecutor`,其 `execute(...)` 方法为: ``` @Override @@ -460,9 +460,9 @@ spring Ϊ ``` - ¿ÉÒÔ¿´µ½£¬ÕâȷʵÊǸöͬ²½·½·¨£¬Ö±½Óµ÷Óà `Runnable#run` ·½·¨£¬²¢Ã»ÓÐÆô¶¯ÐµÄÏß³Ì + å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ç¡®å®žæ˜¯ä¸ªå�Œæ­¥æ–¹æ³•,直接调用 `Runnable#run` 方法,并没有å�¯åŠ¨æ–°çš„çº¿ç¨‹ -2. `SimpleAsyncTaskExecutor`£ºÒì²½µÄ `taskExecutor`£¬Æä `execute(...)` ·½·¨Îª£º +2. `SimpleAsyncTaskExecutor`:异步的 `taskExecutor`,其 `execute(...)` 方法为: ``` @Override @@ -470,7 +470,7 @@ spring Ϊ Assert.notNull(task, "Runnable must not be null"); Runnable taskToUse = (this.taskDecorator != null ? this.taskDecorator.decorate(task) : task); - // doExecute(...) ²ÅÊÇÕæÕý¸É»îµÄ·½·¨ + // doExecute(...) æ‰�是真正干活的方法 if (isThrottleActive() && startTimeout > TIMEOUT_IMMEDIATE) { this.concurrencyThrottle.beforeAccess(); doExecute(new ConcurrencyThrottlingRunnable(taskToUse)); @@ -481,11 +481,11 @@ spring Ϊ } /** - * ÕæÕý¸É»îµÄ·½·¨ - * ´Ó´úÂëÀ´¿´£¬Õâ¸ö·½·¨»á´´½¨Ð´´½¨À´Ö´ÐÐÈÎÎñ£¬µ«²¢Ã»ÓÐʹÓÃÏß³Ì³Ø + * 真正干活的方法 + * 从代ç �æ�¥çœ‹ï¼Œè¿™ä¸ªæ–¹æ³•会创建新创建æ�¥æ‰§è¡Œä»»åŠ¡ï¼Œä½†å¹¶æ²¡æœ‰ä½¿ç”¨çº¿ç¨‹æ±  */ protected void doExecute(Runnable task) { - // ¿ÉÒÔ¿´µ½£¬ÕâÀï´´½¨ÁËỊ̈߳¬²¢ÇÒÆô¶¯ÁËÏß³Ì + // å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œåˆ›å»ºäº†çº¿ç¨‹ï¼Œå¹¶ä¸”å�¯åŠ¨äº†çº¿ç¨‹ Thread thread = (this.threadFactory != null ? this.threadFactory.newThread(task) : createThread(task)); thread.start(); @@ -493,13 +493,13 @@ spring Ϊ ``` - ¿ÉÒÔ¿´£¬ÔÚ `SimpleAsyncTaskExecutor` ÖУ¬»á´´½¨ÐµÄÏß³ÌÀ´Ö´ÐÐÈÎÎñ¡£ + å�¯ä»¥çœ‹ï¼Œåœ¨ `SimpleAsyncTaskExecutor` 中,会创建新的线程æ�¥æ‰§è¡Œä»»åŠ¡ã€‚ -ÕâÀïÄܲ»ÄÜ»ñÈ¡µ½Ö´ÐÐÆ÷ÄØ£¿Í¨¹ýµ÷ÊÔ·¢ÏÖ£¬Ö´ÐÐÆ÷µÄ»ñÈ¡½á¹ûΪ `null`£º +这里能ä¸�能获å�–到执行器呢?通过调试å�‘现,执行器的获å�–结果为 `null`: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-2e6ba6389e603a6373287dac26a89a24109.png) -Òò´ËÔÚÏÂÃæÖ´ÐÐ `invokeListener(...)` ·½·¨Ê±£¬ÊÇÖ±½Óµ÷Óõģº +因此在下é�¢æ‰§è¡Œ `invokeListener(...)` 方法时,是直接调用的: ``` ... @@ -510,22 +510,22 @@ spring Ϊ ``` -#### 2\. »ñȡʼþµÄ¼àÌýÆ÷£º`getApplicationListeners(...)` +#### 2\. 获å�–事件的监å�¬å™¨ï¼š`getApplicationListeners(...)` -×¼±¸À´Ëµ£¬ÕâÀï»ñÈ¡µÄÊÇÄܼàÌý´«ÈëʼþµÄ¼àÌýÆ÷£¬·½·¨Îª `AbstractApplicationEventMulticaster#getApplicationListeners(ApplicationEvent, ResolvableType)`£º +准备æ�¥è¯´ï¼Œè¿™é‡ŒèŽ·å�–的是能监å�¬ä¼ å…¥äº‹ä»¶çš„监å�¬å™¨ï¼Œæ–¹æ³•为 `AbstractApplicationEventMulticaster#getApplicationListeners(ApplicationEvent, ResolvableType)`: ``` /** - * Õâ¸ö·½·¨¾ÍÁ½¸ö²½Ö裺 - * 1\. ´Ó»º´æÖлñÈ¡£¬ÄÜ»ñÈ¡µ½£¬Ö±½Ó·µ»Ø - * 2\. ²»ÄÜ´Ó»º´æÖлñÈ¡£¬µ÷Óà retrieveApplicationListeners(...) ·½·¨»ñÈ¡ + * 这个方法就两个步骤: + * 1\. 从缓存中获å�–,能获å�–到,直接返回 + * 2\. ä¸�能从缓存中获å�–,调用 retrieveApplicationListeners(...) 方法获å�– */ protected Collection> getApplicationListeners( ApplicationEvent event, ResolvableType eventType) { Object source = event.getSource(); Class sourceType = (source != null ? source.getClass() : null); ListenerCacheKey cacheKey = new ListenerCacheKey(eventType, sourceType); - // 1\. ´Ó»º´æÖлñÈ¡ + // 1\. 从缓存中获å�– ListenerRetriever retriever = this.retrieverCache.get(cacheKey); if (retriever != null) { return retriever.getApplicationListeners(); @@ -539,7 +539,7 @@ protected Collection> getApplicationListeners( return retriever.getApplicationListeners(); } retriever = new ListenerRetriever(true); - // 2\. »ñÈ¡²Ù×÷£¬ÕâÀï²ÅÊǹؼü + // 2\. 获å�–æ“�作,这里æ‰�是关键 Collection> listeners = retrieveApplicationListeners(eventType, sourceType, retriever); this.retrieverCache.put(cacheKey, retriever); @@ -553,16 +553,16 @@ protected Collection> getApplicationListeners( ``` -Õâ¸ö·½·¨¿´×ų¤£¬µ«¹Ø¼ü²Ù×÷¾ÍÁ½¸ö£º +这个方法看ç�€é•¿ï¼Œä½†å…³é”®æ“�作就两个: -1. ´Ó»º´æÖлñÈ¡£¬ÄÜ»ñÈ¡µ½£¬Ö±½Ó·µ»Ø -2. ²»ÄÜ´Ó»º´æÖлñÈ¡£¬µ÷Óà `retrieveApplicationListeners(...)` ·½·¨»ñÈ¡ +1. 从缓存中获å�–,能获å�–到,直接返回 +2. ä¸�能从缓存中获å�–,调用 `retrieveApplicationListeners(...)` 方法获å�– -ÎÒÃǼÌÐø½øÈë `retrieveApplicationListeners(...)`£º +我们继续进入 `retrieveApplicationListeners(...)`: ``` /** - * ÔÚÕâÀïÕæÕý»ñÈ¡¼àÌýÆ÷ + * 在这里真正获å�–监å�¬å™¨ * */ private Collection> retrieveApplicationListeners( @@ -575,9 +575,9 @@ private Collection> retrieveApplicationListeners( listeners = new LinkedHashSet<>(this.defaultRetriever.applicationListeners); listenerBeans = new LinkedHashSet<>(this.defaultRetriever.applicationListenerBeans); } - // ´Ó listeners ÖлñÈ¡ÄÜ´¦Àíµ±Ç°Ê¼þµÄ lister + // 从 listeners 中获å�–能处ç�†å½“å‰�事件的 lister for (ApplicationListener listener : listeners) { - // ÔÚÕâÀïÅжϵ±Ç°listenerÊÇ·ñÖ§³Ö´«Èëevent + // 在这里判断当å‰�listener是å�¦æ”¯æŒ�ä¼ å…¥event if (supportsEvent(listener, eventType, sourceType)) { if (retriever != null) { retriever.applicationListeners.add(listener); @@ -585,20 +585,20 @@ private Collection> retrieveApplicationListeners( allListeners.add(listener); } } - // ´Ó listenerBeans ÖлñÈ¡ÄÜ´¦Àíµ±Ç°Ê¼þµÄ lister + // 从 listenerBeans 中获å�–能处ç�†å½“å‰�事件的 lister if (!listenerBeans.isEmpty()) { ConfigurableBeanFactory beanFactory = getBeanFactory(); for (String listenerBeanName : listenerBeans) { try { - // ÕâÀïÅжϵ±Ç° listenerBeanName ÊÇ·ñÄܼàÌý´«Èëʼþ + // 这里判断当å‰� listenerBeanName 是å�¦èƒ½ç›‘å�¬ä¼ å…¥äº‹ä»¶ if (supportsEvent(beanFactory, listenerBeanName, eventType)) { - // ´ÓÈÝÆ÷ÖлñÈ¡¶ÔÓ¦µÄbean£¬¶ÔÓÚÔçÆÚʼþ£¬»áÒýÆð¼àÌýÆ÷Ìáǰ³õʼ»¯ + // 从容器中获å�–对应的bean,对于早期事件,会引起监å�¬å™¨æ��å‰�åˆ�始化 ApplicationListener listener = beanFactory.getBean( listenerBeanName, ApplicationListener.class); if (!allListeners.contains(listener) && supportsEvent(listener, eventType, sourceType)) { if (retriever != null) { - // ×¢Òâµ¥ÀýÓë·Çµ¥ÀýµÄÇø±ð + // 注æ„�å�•例与é�žå�•例的区别 if (beanFactory.isSingleton(listenerBeanName)) { retriever.applicationListeners.add(listener); } @@ -621,7 +621,7 @@ private Collection> retrieveApplicationListeners( } } } - // ÅÅÐò + // 排åº� AnnotationAwareOrderComparator.sort(allListeners); if (retriever != null && retriever.applicationListenerBeans.isEmpty()) { retriever.applicationListeners.clear(); @@ -635,23 +635,23 @@ private Collection> retrieveApplicationListeners( ``` -ÔÚ `AbstractApplicationContext#registerListeners` ·½·¨ÖУ¬ÎÒÃÇÔÚ×¢²á¼àÌýÆ÷ʱ £¬×¢²áÁËÁ½´óÀà¼àÌýÆ÷£º +在 `AbstractApplicationContext#registerListeners` 方法中,我们在注册监å�¬å™¨æ—¶ ,注册了两大类监å�¬å™¨ï¼š -1. ×¢²áÊÖ¶¯Ìí¼ÓµÄ¼àÌýÆ÷£¬ËüÃÇÊÇÒ»¸ö¸öʵÀý£» -2. ´ÓÈÝÆ÷ÖлñÈ¡¼àÌýÆ÷µÄ beanName£¬½øÐÐ×¢²á£» +1. 注册手动添加的监å�¬å™¨ï¼Œå®ƒä»¬æ˜¯ä¸€ä¸ªä¸ªå®žä¾‹ï¼› +2. 从容器中获å�–监å�¬å™¨çš„ beanName,进行注册; -`retrieveApplicationListeners()` ÖгöÏÖµÄ `listeners` Óë `listenerBeans` ¾ÍÊÇ´¦ÀíÕâÁ½ÖÖÀàÐ͵ļàÌýÆ÷µÄ¡£ +`retrieveApplicationListeners()` 中出现的 `listeners` 与 `listenerBeans` 就是处ç�†è¿™ä¸¤ç§�类型的监å�¬å™¨çš„。 -ÒÔÉÏ·½·¨ËäÈ»Óе㳤£¬µ«Âß¼­·Ç³£ÇåÎú£º +以上方法虽然有点长,但逻辑é�žå¸¸æ¸…晰: -1. ±éÀú `listeners`£¬ÖðÒ»µ÷Óà `supportsEvent(listener, eventType, sourceType)` À´Åжϵ±Ç° listener ÄÜ·ñ¼àÌý´«Èëʼþ£» -2. ±éÀú `listenerBeans`£¬ÖðÒ»µ÷Óà `supportsEvent(beanFactory, listenerBeanName, eventType)` À´Åжϵ±Ç° listener ÄÜ·ñ¼àÌý´«Èëʼþ£» +1. é��历 `listeners`,é€�一调用 `supportsEvent(listener, eventType, sourceType)` æ�¥åˆ¤æ–­å½“å‰� listener 能å�¦ç›‘å�¬ä¼ å…¥äº‹ä»¶ï¼› +2. é��历 `listenerBeans`,é€�一调用 `supportsEvent(beanFactory, listenerBeanName, eventType)` æ�¥åˆ¤æ–­å½“å‰� listener 能å�¦ç›‘å�¬ä¼ å…¥äº‹ä»¶ï¼› -¹ØÓÚÕâÁ½¸ö·½·¨µÄ´¦Àí±È½Ï¸´ÔÓ£¬ÕâÀï¾Í²»Ò»Ò»½øÐзÖÎöÁË£¬ÕâÀï¸ø³ö´¦ÀíµÄ´óÖÂ˼·£º +关于这两个方法的处ç�†æ¯”较å¤�æ�‚,这里就ä¸�一一进行分æž�了,这里给出处ç�†çš„大致æ€�路: -1. ´Ó´«ÈëµÄ `listener` »ò `listenerBeanName` »ñÈ¡ `listener` µÄ Class£¬`listener` Ö»Ðè `listener.getClass()` ¼´¿É£¬`listenerBeanName` ¿Éͨ¹ý `beanFactory.getType(listenerBeanName)` »ñÈ¡£» +1. 从传入的 `listener` 或 `listenerBeanName` 获å�– `listener` çš„ Class,`listener` å�ªéœ€ `listener.getClass()` å�³å�¯ï¼Œ`listenerBeanName` å�¯é€šè¿‡ `beanFactory.getType(listenerBeanName)` 获å�–ï¼› -2. »ñÈ¡ `listener` ¼àÌýµÄʼþÀàÐÍ£¬Ò»¸ö¼àÌýÆ÷ÊÇÕâÑù¶¨ÒåµÄ£º +2. 获å�– `listener` 监å�¬çš„事件类型,一个监å�¬å™¨æ˜¯è¿™æ ·å®šä¹‰çš„: ``` public class MyApplicationEventListener @@ -665,31 +665,31 @@ private Collection> retrieveApplicationListeners( ``` - ÎÒÃÇ¿ÉÒÔÕâÑù»ñÈ¡µ½ `MyApplicationEvent`£º + 我们å�¯ä»¥è¿™æ ·èŽ·å�–到 `MyApplicationEvent`: ``` - // ÕâЩÀà¶¼ÊÇjdkÌṩµÄ + // 这些类都是jdkæ��供的 ParameterizedType parameterizedType = (ParameterizedType) MyApplicationEventListener.class.getGenericInterfaces()[0]; Class type = (Class)parameterizedType.getActualTypeArguments()[0]; ``` - µ±È»£¬spring ÔÚ´¦ÀíÕⲿ·ÖÂß¼­Ê±Ìرð¸´ÔÓ£¬±Ï¾¹Èç¹û `MyApplicationEventListener` ͬʱʵÏÖÁ˶à¸ö½Ó¿Ú£¬»òÕß `MyApplicationEventListener` µÄ¸¸ - ¸¸ - ¸¸ -... ½Ó¿Ú²ÅÊÇ `ApplicationListener`£¬ÕâЩÇé¿ö¶¼Òª¿¼Âǵ½¡£ + 当然,spring 在处ç�†è¿™éƒ¨åˆ†é€»è¾‘时特别å¤�æ�‚,毕竟如果 `MyApplicationEventListener` å�Œæ—¶å®žçŽ°äº†å¤šä¸ªæŽ¥å�£ï¼Œæˆ–者 `MyApplicationEventListener` 的父 - 父 - 父 -... 接å�£æ‰�是 `ApplicationListener`,这些情况都è¦�考虑到。 -3. »ñÈ¡µ½¼àÌýÆ÷ÄܼàÌýµÄʼþÁË£¬¾ÍÄÜÅжϵ±Ç°ÅжϼàÌýÊÇ·ñÄܼàÌý´«ÈëʼþÁË£¬spring ´¦ÀíÆ¥ÅäµÄ·½·¨Îª `ResolvableType#isAssignableFrom(ResolvableType)`£¬´Ó×¢ÊÍÉÏÀ´¿´£¬ËüʵÏÖÁËÀàËÆ `Class.isAssignableFrom` ·½·¨µÄ¹¦ÄÜ£¬Í¬Ê±»¹¶Ô´«ÈëÀàÉϵķºÐÍҲʵÏÖÁËÀàËÆ `Class.isAssignableFrom` µÄ¹¦ÄÜ¡£ +3. 获å�–到监å�¬å™¨èƒ½ç›‘å�¬çš„事件了,就能判断当å‰�判断监å�¬æ˜¯å�¦èƒ½ç›‘å�¬ä¼ å…¥äº‹ä»¶äº†ï¼Œspring 处ç�†åŒ¹é…�的方法为 `ResolvableType#isAssignableFrom(ResolvableType)`,从注释上æ�¥çœ‹ï¼Œå®ƒå®žçŽ°äº†ç±»ä¼¼ `Class.isAssignableFrom` 方法的功能,å�Œæ—¶è¿˜å¯¹ä¼ å…¥ç±»ä¸Šçš„æ³›åž‹ä¹Ÿå®žçŽ°äº†ç±»ä¼¼ `Class.isAssignableFrom` 的功能。 -#### 3\. µ÷ÓüàÌý·½·¨£º`invokeListener(...)` +#### 3\. 调用监å�¬æ–¹æ³•:`invokeListener(...)` -ÖÕÓÚµ½µ÷ÓüàÌý·½·¨ÁË£¬´úÂëÈçÏ£º +终于到调用监å�¬æ–¹æ³•了,代ç �如下: ``` /** - * Ö´ÐмàÌýÆ÷ + * 执行监å�¬å™¨ */ protected void invokeListener(ApplicationListener listener, ApplicationEvent event) { ErrorHandler errorHandler = getErrorHandler(); - // ×îÖÕµ÷ÓõÄÊÇ doInvokeListener(...) + // 最终调用的是 doInvokeListener(...) if (errorHandler != null) { try { doInvokeListener(listener, event); @@ -704,7 +704,7 @@ protected void invokeListener(ApplicationListener listener, ApplicationEvent } /** - * ¾ßÌåµÄÖ´ÐвÙ×÷£¬×îÖÕµ÷ÓõÄÊÇ ApplicationListener#onApplicationEvent ·½·¨ + * 具体的执行æ“�作,最终调用的是 ApplicationListener#onApplicationEvent 方法 */ private void doInvokeListener(ApplicationListener listener, ApplicationEvent event) { try { @@ -713,7 +713,7 @@ private void doInvokeListener(ApplicationListener listener, ApplicationEvent eve catch (ClassCastException ex) { String msg = ex.getMessage(); if (msg == null || matchesClassCastMessage(msg, event.getClass())) { - // Ê¡ÂÔÈÕÖ¾´òÓ¡ + // çœ�略日志打å�° } else { throw ex; @@ -723,19 +723,19 @@ private void doInvokeListener(ApplicationListener listener, ApplicationEvent eve ``` -ÕâÒ»¿éºÜ¼òµ¥£¬¾ÍÊDZéÀúÉÏÒ»²½»ñÈ¡µÄ¼àÌýÆ÷£¬ÖðÒ»µ÷ÓÃÆä `onApplicationEvent(...)` ·½·¨¡£ +这一å�—很简å�•,就是é��历上一步获å�–的监å�¬å™¨ï¼Œé€�一调用其 `onApplicationEvent(...)` 方法。 -ÕâÀïÐèҪעÒâµÄÊÇ£¬ÔÚÇ°Ãæ`»ñȡִÐÐÆ÷`µÄ·ÖÎöÖУ¬ÎÒÃÇÌáµ½ `getTaskExecutor()` µÄ½á¹ûΪ `null`£¬Õâ±íÃ÷ `invokeListener(...)` ÊÇÖ±½ÓÖ´Ðе쬲¢Ã»ÓÐÁíÆðÒ»¸öÏß³ÌÖÐÖ´ÐУ¬ÕâµãÐèÒª¸ñÍâ×¢Òâ¡£ +这里需è¦�注æ„�的是,在å‰�é�¢`获å�–执行器`的分æž�中,我们æ��到 `getTaskExecutor()` 的结果为 `null`,这表明 `invokeListener(...)` 是直接执行的,并没有å�¦èµ·ä¸€ä¸ªçº¿ç¨‹ä¸­æ‰§è¡Œï¼Œè¿™ç‚¹éœ€è¦�格外注æ„�。 -### 5\. ʼþµÄÓ¦Óà +### 5\. 事件的应用 -#### 5.1 ¼àÌýÈÝÆ÷Æô¶¯Íê³Éʼþ +#### 5.1 监å�¬å®¹å™¨å�¯åŠ¨å®Œæˆ�事件 -ÔÚ spring Æô¶¯Á÷³ÌÖУ¬ÈÝÆ÷Æô¶¯Íê³É»á·¢²¼ `ContextRefreshed` ʼþ£º +在 spring å�¯åЍæµ�程中,容器å�¯åŠ¨å®Œæˆ�会å�‘布 `ContextRefreshed` 事件: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-f60ea2710c59e2ce9e1401f1b54cbd9d700.png) -ÎÒÃÇÒª¼àÌýÆ÷¸ÃʼþҲʮ·Ö¼òµ¥£¬ÏàÓ¦µÄ `Listener` ÈçÏ£º +我们è¦�监å�¬å™¨è¯¥äº‹ä»¶ä¹Ÿå��分简å�•,相应的 `Listener` 如下: ``` @Component @@ -744,64 +744,64 @@ public class ContextRefreshedListener @Override public void onApplicationEvent(ContextRefreshedEvent event) { - System.out.println("ÈÝÆ÷Æô¶¯Íê³É"); + System.out.println("容器å�¯åŠ¨å®Œæˆ�"); } } ``` -#### 5.2 ·¢²¼ÔçÆÚʼþ +#### 5.2 å�‘布早期事件 -Ò»¿ªÊ¼£¬ÎÒÒÔΪÔçÆÚʼþÊÇÕâÑù·¢²¼£º +一开始,我以为早期事件是这样å�‘布: ``` AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); context.register(Demo08Config.class); -// ·¢²¼Ê¼þ£¬ÔÚÈÝÆ÷Æô¶¯Ç°·¢²¼ +// å�‘布事件,在容器å�¯åЍå‰�å�‘布 context.publishEvent(new MyApplicationEvent( - Thread.currentThread().getName() + " | ×Ô¶¨Òåʼþ ...")); + Thread.currentThread().getName() + " | 自定义事件 ...")); context.refresh(); ``` -ÔËÐк󣬻ᱨ´í£º ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-4fc18c95f69d8c3d65be2a0f603d42e19ce.png) +è¿�行å�Žï¼Œä¼šæŠ¥é”™ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-4fc18c95f69d8c3d65be2a0f603d42e19ce.png) -´Ó´íÎóÐÅÏ¢À´¿´£¬ÊÇ˵¹ã²¥Æ÷δ³õʼ»¯¡£ +从错误信æ�¯æ�¥çœ‹ï¼Œæ˜¯è¯´å¹¿æ’­å™¨æœªåˆ�始化。 -ÄÇô¹ã²¥Æ÷ÊÇÔÚÄÄÀï³õʼ»¯µÄÄØ£¿»ØÒäÏÂÇ°ÃæµÄ·ÖÎö£¬ºÜÇå³þµØÖªµÀÊÇÔÚ `refresh()` ¹ý³ÌµÄµÚ 8 ²½£¬¶øÔçÆÚʼþµÄ·¢²¼ÓÖÔÚµÚ 10 ²½£¬ÕâÑùÒ»À´£¬ÔçÆÚʼþ¾ÍÖ»ÄÜÔÚµÚ 9 ²½ÁË£º +那么广播器是在哪里åˆ�始化的呢?回忆下å‰�é�¢çš„分æž�,很清楚地知é�“是在 `refresh()` 过程的第 8 步,而早期事件的å�‘布å�ˆåœ¨ç¬¬ 10 步,这样一æ�¥ï¼Œæ—©æœŸäº‹ä»¶å°±å�ªèƒ½åœ¨ç¬¬ 9 步了: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-1fecd516c6d58d628937b20ebd806065891.png) -´ÓÕâÀï¿ÉÒÔ¿´³ö£¬ÔçÆÚʼþ¾ÍÊÇΪ `onRefresh()` Õâ¸öÀ©Õ¹µã×¼±¸µÄ£¡ +从这里å�¯ä»¥çœ‹å‡ºï¼Œæ—©æœŸäº‹ä»¶å°±æ˜¯ä¸º `onRefresh()` 这个扩展点准备的ï¼� -ÔçÆÚʼþµÄ·¢²¼Ò²¾Í¼òµ¥ÁË£º +早期事件的å�‘布也就简å�•了: ``` ApplicationContext context = new AnnotationConfigApplicationContext(Demo08Config.class) { @Override public void onRefresh() { - // ÕâÀï·¢²¼¾ÍÊÇÔçÆÚʼþ + // 这里å�‘布就是早期事件 publishEvent(new MyApplicationEvent( - Thread.currentThread().getName() + " | ×Ô¶¨Òåʼþ ...")); + Thread.currentThread().getName() + " | 自定义事件 ...")); } }; ``` -#### 5.3 Òì²½¹ã²¥Ê¼þ +#### 5.3 异步广播事件 -´ÓÇ°ÃæµÄÔ´Âë·ÖÎöÀ´¿´£¬Ê¼þµÄÖ´ÐÐÊÇÔÚͬһ¸öÏß³ÌÖнøÐеģ¬ÕâµãÔÚ demo µÄÔËÐнá¹ûÖÐÒ²ÄÜ¿´³öÀ´£º +从å‰�é�¢çš„æº�ç �分æž�æ�¥çœ‹ï¼Œäº‹ä»¶çš„æ‰§è¡Œæ˜¯åœ¨å�Œä¸€ä¸ªçº¿ç¨‹ä¸­è¿›è¡Œçš„,这点在 demo çš„è¿�行结果中也能看出æ�¥ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-afed97c136df717ba3d9397ff142ae0675f.png) -Ç°ÃæÒѾ­·ÖÎö¹ý£¬¹ã²¥Ê¼þʱ£¬»áÏÈ»ñÈ¡ `executor`£¬Èç¹û `executor` ´æÔÚ£¬ÔÚ `executor` Ö´ÐУ¬·ñÔò¾ÍÖ±½ÓÖ´ÐУ¬¶ø¹ã²¥Æ÷ÖÐµÄ `executor` Ϊ `null`£¬Òò´ËºÜÈÝÒ×½áÂÛ£ºÒªÏëʵÏÖÒì²½Ö´ÐУ¬ÐèÒªÔڹ㲥Æ÷ÖÐÉèÖà `executor` ÊôÐÔ¡£ +å‰�é�¢å·²ç»�分æž�过,广播事件时,会先获å�– `executor`,如果 `executor` 存在,在 `executor` 执行,å�¦åˆ™å°±ç›´æŽ¥æ‰§è¡Œï¼Œè€Œå¹¿æ’­å™¨ä¸­çš„ `executor` 为 `null`,因此很容易结论:è¦�想实现异步执行,需è¦�在广播器中设置 `executor` 属性。 -Ç°ÃæÍ¬ÑùÒ²·ÖÎö¹ý£¬spring ÔÚ³õʼ»¯¹ã²¥Æ÷ʱ£¬»áÏÈÅжÏÈÝÒ×ÖÐÊÇ·ñ´æÔڹ㲥Æ÷£¨`beanName` Ϊ `applicationEventMulticaster`£©£¬²»´æÔÚÔòʹÓà `SimpleApplicationEventMulticaster` ´´½¨Ä¬ÈϵĹ㲥Æ÷¡£ +å‰�é�¢å�Œæ ·ä¹Ÿåˆ†æž�过,spring 在åˆ�始化广播器时,会先判断容易中是å�¦å­˜åœ¨å¹¿æ’­å™¨ï¼ˆ`beanName` 为 `applicationEventMulticaster`),ä¸�存在则使用 `SimpleApplicationEventMulticaster` 创建默认的广播器。 -Èç´ËÒ»À´£¬ÎÒÃÇÖ»ÐèÒª×Ô¶¨Òå `beanName` Ϊ `applicationEventMulticaster` µÄ bean ²»¾ÍÐУ¬ÏñÕâÑù£º +如此一æ�¥ï¼Œæˆ‘们å�ªéœ€è¦�自定义 `beanName` 为 `applicationEventMulticaster` çš„ bean ä¸�就行,åƒ�这样: ``` @Configuration @@ -809,14 +809,14 @@ ApplicationContext context = public class Demo08Config { /** - * Éú³É×Ô¶¨Òå¹ã²¥Æ÷ - * ×¢Ò⣺Ãû³Æ±ØÐëΪ applicationEventMulticaster + * 生æˆ�自定义广播器 + * 注æ„�:å��称必须为 applicationEventMulticaster */ @Bean public ApplicationEventMulticaster applicationEventMulticaster() { SimpleApplicationEventMulticaster applicationEventMulticaster = new SimpleApplicationEventMulticaster(); - // SimpleAsyncTaskExecutor ÊÇspringÖÐÌṩµÄÒì²½ÈÎÎñÖ´ÐÐÆ÷ + // SimpleAsyncTaskExecutor 是spring中æ��供的异步任务执行器 applicationEventMulticaster.setTaskExecutor(new SimpleAsyncTaskExecutor()); return applicationEventMulticaster; } @@ -824,20 +824,20 @@ public class Demo08Config { ``` -`SimpleApplicationEventMulticaster` ʹÓÃÁË spring ÌṩµÄÒì²½ÈÎÎñÖ´ÐÐÆ÷£º`SimpleAsyncTaskExecutor`£¬ÔËÐУ¬½á¹ûÈçÏ£º +`SimpleApplicationEventMulticaster` 使用了 spring æ��供的异步任务执行器:`SimpleAsyncTaskExecutor`,è¿�行,结果如下: ``` -SimpleAsyncTaskExecutor-2 | main | ×Ô¶¨Òåʼþ ... +SimpleAsyncTaskExecutor-2 | main | 自定义事件 ... ``` -¿ÉÒÔ¿´µ½£¬·¢²¼Ïß³ÌÓë¼àÌýÏ̲߳»ÔÙÊÇͬһ¸öÁË¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œå�‘布线程与监å�¬çº¿ç¨‹ä¸�å†�是å�Œä¸€ä¸ªäº†ã€‚ -µ«ÊÂÇéµ½Õ⻹ËãÍê£¬Ç°ÃæÒѾ­·ÖÎö¹ý `SimpleAsyncTaskExecutor` µÄÈÎÎñÖ´Ðйý³Ì£¬ÔÚÖ´ÐÐʱËü»á²»¶Ï´´½¨ÐÂỊ̈߳º +但事情到这还算完,å‰�é�¢å·²ç»�分æž�过 `SimpleAsyncTaskExecutor` 的任务执行过程,在执行时它会ä¸�断创建新线程: ``` protected void doExecute(Runnable task) { - // ¿ÉÒÔ¿´µ½£¬ÕâÀï´´½¨ÁËỊ̈߳¬²¢ÇÒÆô¶¯ÁËÏß³Ì + // å�¯ä»¥çœ‹åˆ°ï¼Œè¿™é‡Œåˆ›å»ºäº†çº¿ç¨‹ï¼Œå¹¶ä¸”å�¯åŠ¨äº†çº¿ç¨‹ Thread thread = (this.threadFactory != null ? this.threadFactory.newThread(task) : createThread(task)); thread.start(); @@ -845,74 +845,74 @@ SimpleAsyncTaskExecutor-2 | main | ``` -Èç¹ûÎÒÃÇÁ¬Ðø·¢²¼ 100 ¸öʼþ£º +如果我们连续å�‘布 100 个事件: ``` for(int i = 0; i < 100; i++) { context.publishEvent(new MyApplicationEvent( - Thread.currentThread().getName() + " | ×Ô¶¨Òåʼþ ...")); + Thread.currentThread().getName() + " | 自定义事件 ...")); } ``` -ÔËÐнá¹û»áÕâÑù£º +è¿�行结果会这样: ``` -SimpleAsyncTaskExecutor-2 | main | ×Ô¶¨Òåʼþ ... -SimpleAsyncTaskExecutor-3 | main | ×Ô¶¨Òåʼþ ... -SimpleAsyncTaskExecutor-4 | main | ×Ô¶¨Òåʼþ ... +SimpleAsyncTaskExecutor-2 | main | 自定义事件 ... +SimpleAsyncTaskExecutor-3 | main | 自定义事件 ... +SimpleAsyncTaskExecutor-4 | main | 自定义事件 ... ... -SimpleAsyncTaskExecutor-99 | main | ×Ô¶¨Òåʼþ ... -SimpleAsyncTaskExecutor-100 | main | ×Ô¶¨Òåʼþ ... -SimpleAsyncTaskExecutor-101 | main | ×Ô¶¨Òåʼþ ... +SimpleAsyncTaskExecutor-99 | main | 自定义事件 ... +SimpleAsyncTaskExecutor-100 | main | 自定义事件 ... +SimpleAsyncTaskExecutor-101 | main | 自定义事件 ... ``` -¿ÉÒÔ¿´µ½£¬¶ÔÓÚÿһ¸öʼþ£¬¶¼»á´´½¨Ò»¸öÐÂÏß³ÌÀ´Ö´ÐУ¬Ï̱߳¾¾ÍÊÇÈç´Ë±¦¹óµÄ×ÊÔ´£¬ÕâÑùƵ·±µØ´´½¨¾ÍÊÇÒ»¸ö¼«´óµÄÀË·Ñ£¬ÄÇÈçºÎÖØÓÃÏß³ÌÄØ£¿´ð°¸ÊÇÏ̳߳ء£ +å�¯ä»¥çœ‹åˆ°ï¼Œå¯¹äºŽæ¯�一个事件,都会创建一个新线程æ�¥æ‰§è¡Œï¼Œçº¿ç¨‹æœ¬å°±æ˜¯å¦‚æ­¤å®�贵的资æº�,这样频ç¹�地创建就是一个æž�大的浪费,那如何é‡�用线程呢?答案是线程池。 -ÎÒÃÇ¿´Ï `SimpleApplicationEventMulticaster#setTaskExecutor` ·½·¨µÄ²ÎÊý£¬·¢ÏÖËüÊÇ `java.util.concurrent.Executor`£¬½ÓÏÂÀ´ÊÂÇé¾Í±äµÃ¼òµ¥ÁË£¬ÎÒÃÇÖ±½ÓʹÓà jdk ÌṩµÄÏ̳߳أº +我们看下 `SimpleApplicationEventMulticaster#setTaskExecutor` 方法的å�‚数,å�‘现它是 `java.util.concurrent.Executor`,接下æ�¥äº‹æƒ…å°±å�˜å¾—简å�•了,我们直接使用 jdk æ��供的线程池: ``` @Bean public ApplicationEventMulticaster applicationEventMulticaster() { SimpleApplicationEventMulticaster applicationEventMulticaster = new SimpleApplicationEventMulticaster(); - // ʹÓÃjdkÌṩµÄÏß³Ì³Ø + // 使用jdkæ��供的线程池 applicationEventMulticaster.setTaskExecutor(Executors.newFixedThreadPool(4)); return applicationEventMulticaster; } ``` -ÕâÀïʹÓõÄÊÇ jdK ÌṩµÄ `newFixedThreadPool`£¬ÉèÖÃÁË 4 ¸öỊ̈߳¬ÔËÐУ¬½á¹ûÈçÏ£º +这里使用的是 jdK æ��供的 `newFixedThreadPool`,设置了 4 个线程,è¿�行,结果如下: ``` -pool-1-thread-2 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-3 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-4 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-4 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-1 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-3 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-3 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-2 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-1 | main | ×Ô¶¨Òåʼþ ... -pool-1-thread-3 | main | ×Ô¶¨Òåʼþ ... +pool-1-thread-2 | main | 自定义事件 ... +pool-1-thread-3 | main | 自定义事件 ... +pool-1-thread-4 | main | 自定义事件 ... +pool-1-thread-4 | main | 自定义事件 ... +pool-1-thread-1 | main | 自定义事件 ... +pool-1-thread-3 | main | 自定义事件 ... +pool-1-thread-3 | main | 自定义事件 ... +pool-1-thread-2 | main | 自定义事件 ... +pool-1-thread-1 | main | 自定义事件 ... +pool-1-thread-3 | main | 自定义事件 ... ... ``` -¿ÉÒÔ¿´µ½£¬×ÔʼÖÁÖÕÖ»ÓÐ 4 ¸öÏß³ÌÔڹ㲥ʼþ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè‡ªå§‹è‡³ç»ˆå�ªæœ‰ 4 个线程在广播事件。 -ÔÚÓÐЩ´úÂë¹æ·¶ÖУ¬ÊǽûÖ¹Ö±½ÓʹÓà jdk ÌṩµÄÏ̵߳ijأ¬ËûÃǸüÌᳫ×Ô¶¨ÒåÏ̳߳أ¬¹ØÓÚÕâµã£¬ÓÉÓÚ±¾ÎIJ¢²»ÊÇÌÖÂÛÏ̳߳ؼ¼ÊõµÄ£¬Òò´Ë¾Í¼òµ¥µØÊ¹Óà jdk ÌṩµÄÏß³ÌʾÀýÏ¡£ +在有些代ç �规范中,是ç¦�止直接使用 jdk æ��供的线程的池,他们更æ��倡自定义线程池,关于这点,由于本文并ä¸�是讨论线程池技术的,因此就简å�•地使用 jdk æ��供的线程示例下。 -#### 5.4 ×Ô¶¨Òåʼþ +#### 5.4 自定义事件 -ʵ¼ÊÉÏ£¬Ç°ÃæÌṩµÄʾÀý demo ¾ÍÊÇ×Ô¶¨Òåʼþ£¬ÕâÀï¾Í²»Öظ´ÁË¡£ +实际上,å‰�é�¢æ��供的示例 demo 就是自定义事件,这里就ä¸�é‡�å¤�了。 -### 6\. ×ܽá +### 6\. 总结 -±¾ÎÄ·ÖÎöÁË spring ʼþ»úÖÆ£¬½éÉÜÁËʼþµÄËÄ´ó»ù±¾×é¼þ£ºÊ¼þ£¬·¢²¼Æ÷£¬¹ã²¥Æ÷£¬¼àÌýÆ÷£¬²¢ÇÒ´ÓÔ´Âë·ÖÎöÁË×é¼þµÄ³õʼ»¯¡¢Ê¼þµÄ·¢²¼Á÷³Ì¡£ +本文分æž�了 spring 事件机制,介ç»�了事件的四大基本组件:事件,å�‘布器,广播器,监å�¬å™¨ï¼Œå¹¶ä¸”从æº�ç �分æž�了组件的åˆ�始化ã€�事件的å�‘布æµ�程。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4713339](https://my.oschina.net/funcy/blog/4713339) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4713339](https://my.oschina.net/funcy/blog/4713339) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\270\200\357\274\211\357\274\232\347\220\206\350\256\272\345\237\272\347\237\263.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\270\200\357\274\211\357\274\232\347\220\206\350\256\272\345\237\272\347\237\263.md" index faddf44..ad2bc1c 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\270\200\357\274\211\357\274\232\347\220\206\350\256\272\345\237\272\347\237\263.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\270\200\357\274\211\357\274\232\347\220\206\350\256\272\345\237\272\347\237\263.md" @@ -1,6 +1,6 @@ -### 1\. ʲôÊÇÑ­»·ÒÀÀµ£¿ +### 1\. 什么是循环ä¾�赖? -spring ÔÚÒÀÀµ×¢Èëʱ£¬¿ÉÄÜ»á³öÏÖÏ໥עÈëµÄÇé¿ö£º +spring 在ä¾�赖注入时,å�¯èƒ½ä¼šå‡ºçŽ°ç›¸äº’æ³¨å…¥çš„æƒ…å†µï¼š ``` @Service @@ -19,15 +19,15 @@ public class Service2 { ``` -ÈçÒÔÉÏ´úÂ룬ÔÚ `Service1` ÖÐͨ¹ý `@Autowird` ×¢ÈëÁË `Service2`£¬ÔÚ `Service2` ÖÐͨ¹ý `@Autowird` ×¢ÈëÁË `Service1`£¬ÕâÖÖÏ໥עÈëµÄÇé¿ö£¬¾Í½Ð×öÑ­»·ÒÀÀµ¡£ +如以上代ç �,在 `Service1` 中通过 `@Autowird` 注入了 `Service2`,在 `Service2` 中通过 `@Autowird` 注入了 `Service1`,这ç§�相互注入的情况,就å�«å�šå¾ªçޝä¾�赖。 -### 2\. Ñ­»·ÒÀÀµ»áÓÐʲôÎÊÌâ +### 2\. 循环ä¾�赖会有什么问题 -ʵ¼ÊÉÏ£¬ÕâÖÖ `A³ÖÓÐB¶ÔÏó£¬BÒ²³ÖÓÐA¶ÔÏó`µÄÇé¿ö£¬java ´úÂëÊÇÍêȫ֧³ÖµÄ£º +实际上,这ç§� `AæŒ�有B对象,B也æŒ�有A对象`的情况,java 代ç �是完全支æŒ�的: ``` /** - * ×¼±¸service1 + * 准备service1 */ public class Service1 { private Service2 service2; @@ -42,7 +42,7 @@ public class Service1 { } /** - * ×¼±¸service2 + * 准备service2 */ public class Service2 { private Service1 service1; @@ -57,14 +57,14 @@ public class Service2 { } /** - * Ö÷·½·¨Öе÷Óà + * 主方法中调用 */ public class Main { public void main(String[] args) { - // ×¼±¸Á½¸ö¶ÔÏó + // 准备两个对象 Service1 service1 = new Service1(); Service2 service2 = new Service2(); - // Ï໥ÉèÖà + // 相互设置 service1.setService2(service2); service2.setService1(service1); } @@ -72,78 +72,78 @@ public class Main { ``` -ÄÇô£¬ÔÚ spring ÖУ¬Á½¸öÀàÏ໥עÈë¶Ô·½ÊµÀýµÄÇé¿ö£¬»áÓÐʲôÎÊÌâÄØ£¿ÎÒÃÇÀ´¿´ `spring bean` µÄ´´½¨¹ý³Ì£¨**×¢Ò⣺ÕâÀïÎÒÃǽö·ÖÎö `bean` µÄ `scope` Ϊ `singleton` µÄÇé¿ö£¬Ò²¾ÍÊÇ `scope` Ϊ`µ¥Àý`µÄÇé¿ö**£©£º +那么,在 spring 中,两个类相互注入对方实例的情况,会有什么问题呢?我们æ�¥çœ‹ `spring bean` 的创建过程(**注æ„�:这里我们仅分æž� `bean` çš„ `scope` 为 `singleton` 的情况,也就是 `scope` 为`å�•例`的情况**): ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ca36e17077b1b191834645b3c8e588ff6c4.png) -Õâ¸ö¹ý³ÌÖÐÓм¸µãÐèҪ˵Ã÷Ï£º +这个过程中有几点需è¦�说明下: -1. ´´½¨¶ÔÏó£ºÕâ¸öÆäʵ¾ÍÊÇʹÓà jdk ÌṩµÄ·´Éä»úÖÆ´´½¨ java ¶ÔÏó£¬ÒÔµÚ 1 ½ÚÌáµ½µÄ `Service1` ΪÀý£¬¿É¼òµ¥Àí½âΪ `Service1 service = new Service1()`£» -2. ×¢ÈëÒÀÀµ¶ÔÏ󣺻¹ÊÇÒÔµÚ 1 ½ÚÌáµ½µÄ `Service1` ΪÀý£¬`Service1` ÖÐͨ¹ý `@Autowired` ×Ô¶¯×¢Èë `Service2`£¬ÕâÒ»²½¾ÍÊǸø `Service2` ¸³ÖµµÄ¹ý³Ì£¬¿É¼òµ¥Àí½âΪ `service1.setService2(service2)`£» -3. `singletonObjects`£º¾­¹ýÉÏÃæÁ½²½ºó£¬Ò»¸ö java ¶ÔÏó¾Í±ä³ÉÁËÒ»¸ö spring bean£¬È»ºó±£´æµ½ `singletonObjects` ÁË£¬ÕâÊǸö `map`£¬`key` ÊÇ bean µÄÃû³Æ£¬`value` ÊÇ bean£¬ËüÖ»±£´æ `spring bean`£¬²»»áÖ»ÔÚ java ʵÀý¡£ +1. 创建对象:这个其实就是使用 jdk æ��供的å��射机制创建 java 对象,以第 1 节æ��到的 `Service1` 为例,å�¯ç®€å�•ç�†è§£ä¸º `Service1 service = new Service1()`ï¼› +2. 注入ä¾�赖对象:还是以第 1 节æ��到的 `Service1` 为例,`Service1` 中通过 `@Autowired` 自动注入 `Service2`,这一步就是给 `Service2` 赋值的过程,å�¯ç®€å�•ç�†è§£ä¸º `service1.setService2(service2)`ï¼› +3. `singletonObjects`:ç»�过上é�¢ä¸¤æ­¥å�Žï¼Œä¸€ä¸ª java 对象就å�˜æˆ�了一个 spring bean,然å�Žä¿�存到 `singletonObjects` 了,这是个 `map`,`key` 是 bean çš„å��称,`value` 是 bean,它å�ªä¿�å­˜ `spring bean`,ä¸�会å�ªåœ¨ java 实例。 -ʵ¼ÊÉÏ£¬`java` ¶ÔÏó±ä³É `spring bean`£¬²»½ö½öÖ»ÊÇÒÀÀµ×¢È룬»¹Óгõʼ»¯¡¢Ö´ÐÐ `beanPorcessor` ·½·¨µÈ£¬**ÓÉÓÚ±¾ÎÄÊÇ·ÖÎö `spring bean` µÄÑ­»·ÒÀÀµµÄ£¬Òò´ËÎÒÃÇÖØµã¹Ø×¢ÓëÑ­»·ÒÀÀµÏà¹ØµÄ²½Öè¡£** +实际上,`java` 对象å�˜æˆ� `spring bean`,ä¸�ä»…ä»…å�ªæ˜¯ä¾�赖注入,还有åˆ�始化ã€�执行 `beanPorcessor` 方法等,**由于本文是分æž� `spring bean` 的循环ä¾�赖的,因此我们é‡�点关注与循环ä¾�赖相关的步骤。** -#### 2.1 Ñ­»·ÒÀÀµ²úÉúµÄÎÊÌâ +#### 2.1 循环ä¾�赖产生的问题 -Á˽âÁË spring bean µÄ²úÉú¹ý³ÌÖ®ºó£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÏÂÑ­»·ÒÀÀµ²úÉúµÄÎÊÌ⣬ÔÚÕýʽ·ÖÎöǰ£¬ÎÒÃÇÏÈÀ´Ã÷È·Á½¸ö¸ÅÄ +了解了 spring bean 的产生过程之å�Žï¼ŒæŽ¥ä¸‹æ�¥æˆ‘们就æ�¥åˆ†æž�下循环ä¾�赖产生的问题,在正å¼�分æž�å‰�,我们先æ�¥æ˜Žç¡®ä¸¤ä¸ªæ¦‚念: -* `java¶ÔÏó`£ºÊµ¼ÊÉÏ£¬java ÖÐÒ»ÇжÔÏ󶼿ÉÒÔ³ÆÖ®Îª `java` ¶ÔÏó£¬ÎªÁË˵Ã÷·½±ã£¬ÒÔÏÂÌáµ½µÄ `java¶ÔÏó`½öָʵÀý»¯Íê³É¡¢µ«Î´½øÐÐ spring bean µÄÉúÃüÖÜÆÚ¶ÔÏó£» -* `spring bean`£ºÊÇÒ»¸ö java ¶ÔÏ󣬲¢ÇÒ½øÐÐÁËÍêÕûµÄ spring bean µÄÉúÃüÖÜÆÚ¶ÔÏó£» +* `java对象`:实际上,java 中一切对象都å�¯ä»¥ç§°ä¹‹ä¸º `java` 对象,为了说明方便,以下æ��到的 `java对象`仅指实例化完æˆ�ã€�但未进行 spring bean 的生命周期对象; +* `spring bean`:是一个 java 对象,并且进行了完整的 spring bean 的生命周期对象; -spring bean µÄ´´½¨¹ý³ÌÈçÏ£º +spring bean 的创建过程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b55a211447b5fabeaa0c3ef0bfee0920c82.png) -¶ÔÉÏͼ˵Ã÷ÈçÏ£º +对上图说明如下: -1. ÔÚ `service1` ¶ÔÏó´´½¨Íê³Éºó£¬`spring` ·¢ÏÖ `service1` ÐèҪעÈë `service2`£¬È»ºó¾ÍÈ¥ `singletonObjects` ÖвéÕÒ `service2`£¬´ËʱÊÇÕÒ²»µ½ `service2`£¬È»ºó¾Í¿ªÊ¼ÁË `service2` µÄ´´½¨¹ý³Ì£» -2. ÔÚ `service2` ¶ÔÏó´´½¨Íê³Éºó£¬`spring` ·¢ÏÖ `service2` ÐèҪעÈë `service1`£¬È»ºó¾ÍÈ¥ `singletonObjects` ÖвéÕÒ `service1`£¬´ËʱÊÇÕÒ²»µ½ `service1`£¬ÒòΪµÚÒ»²½ÖÐ `service1` ²¢Ã»Óд´½¨³É¹¦ £¬È»ºó¾Í¿ªÊ¼ÁË `service1` µÄ´´½¨¹ý³Ì£» -3. Á÷³ÌÌø»Øµ½ `1`£¬ÔٴοªÊ¼ÁË `service1` µÄ´´½¨¡¢ÊôÐÔ×¢Èë¹ý³Ì¡£ +1. 在 `service1` 对象创建完æˆ�å�Žï¼Œ`spring` å�‘现 `service1` 需è¦�注入 `service2`,然å�Žå°±åŽ» `singletonObjects` 中查找 `service2`,此时是找ä¸�到 `service2`,然å�Žå°±å¼€å§‹äº† `service2` 的创建过程; +2. 在 `service2` 对象创建完æˆ�å�Žï¼Œ`spring` å�‘现 `service2` 需è¦�注入 `service1`,然å�Žå°±åŽ» `singletonObjects` 中查找 `service1`,此时是找ä¸�到 `service1`,因为第一步中 `service1` 并没有创建æˆ�功 ,然å�Žå°±å¼€å§‹äº† `service1` 的创建过程; +3. æµ�程跳回到 `1`,å†�次开始了 `service1` 的创建ã€�属性注入过程。 -µ½ÕâÀÎÒÃǾªÏ²µØ·¢ÏÖ£¬Ñ­»·³öÏÖÁË£¡ +到这里,我们惊喜地å�‘现,循环出现了ï¼� -#### 2.2 ÒýÈë `earlySingletonObjects` ½â¾öÑ­»·ÒÀÀµ +#### 2.2 引入 `earlySingletonObjects` 解决循环ä¾�èµ– -ÎÒÃÇ·ÖÎöÏ£¬Ñ­»·³öÏÖµÄÔ­ÒòÔÚÓÚ£¬ÔÚ `service2` »ñÈ¡ `service1` ʱ£¬ÓÉÓÚ `singletonObjects` ÖдËʱ²¢²»´æÔÚ `service1`£¬Òò´Ë»áÔÙ×ß `service1` µÄ´´½¨¹ý³Ì£¬ÖØÐ´´½¨ `service1`£¬Òò´Ë£¬ÎÒÃÇÓиö´óµ¨µÄÏë·¨£ºÈç¹ûÔÚ `service1` ʵÀý»¯ºó¾Í°ÑËü±£´æÆðÀ´£¬ºóÃæÔÙÔÙÕÒ `service1` ʱ£¬¾Í·µ»ØÕâ¸öδ½øÐÐÒÀÀµ×¢ÈëµÄ `service1`£¬ÏñÏÂÃæÕâÑù£º +我们分æž�下,循环出现的原因在于,在 `service2` 获å�– `service1` 时,由于 `singletonObjects` 中此时并ä¸�存在 `service1`,因此会å†�èµ° `service1` 的创建过程,é‡�新创建 `service1`,因此,我们有个大胆的想法:如果在 `service1` 实例化å�Žå°±æŠŠå®ƒä¿�存起æ�¥ï¼Œå�Žé�¢å†�å†�找 `service1` 时,就返回这个未进行ä¾�赖注入的 `service1`,åƒ�下é�¢è¿™æ ·ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c0eaecbe82b144a6fcd9fd048f2cca53497.png) -ÉÏͼÖУ¬ÒýÈëÁË `earlySingletonObjects`£¬ÕâÒ²ÊǸö map£¬Í¬ `singletonObjects` Ò»Ñù£¬`key` ÊÇ bean µÄÃû³Æ£¬`value` ÊÇÒ»¸öδÍê³ÉÒÀÀµ×¢ÈëµÄ¶ÔÏó¡£ +上图中,引入了 `earlySingletonObjects`,这也是个 map,å�Œ `singletonObjects` 一样,`key` 是 bean çš„å��称,`value` 是一个未完æˆ�ä¾�赖注入的对象。 -¶ÔÉÏͼ˵Ã÷ÈçÏ£º +对上图说明如下: -1. ÔÚ `service1` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service1` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -2. ¶Ô `service1` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service1` ÐèҪעÈë `service2`£¬È»ºóÏÈÈ¥ `earlySingletonObjects` ²éÕÒ `service2`£¬Î´ÕÒµ½£»ÔÙÈ¥ `singletonObjects` ÖвéÕÒ `service2`£¬»¹ÊÇδÕÒµ½£¬ÓÚÊǾͿªÊ¼ÁË `service2` µÄ´´½¨¹ý³Ì£» -3. ÔÚ `service2` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service2` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -4. ¶Ô `service2` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service2` ÐèҪעÈë `service1`£¬È»ºó¾ÍÈ¥ `earlySingletonObjects` ²éÕÒ `service1`£¬ÕÒµ½ÁË£¬¾Í½« `service1` ×¢Èëµ½ `service2` ÖУ¬´Ëʱ `service2` ¾ÍÊÇÒ»¸ö `spring bean` ÁË£¬½«Æä±£´æµ½ `singletonObjects` ÖУ» -5. ¾­¹ýµÚ 4 ²½ºó£¬ÎÒÃǵõ½ÁË `service2`£¬È»ºó½«Æä×¢Èëµ½ `service1` ÖУ¬´Ëʱ `service1` Ò²³ÉÁËÒ»¸ö `spring bean`£¬½«Æä±£´æµ½ `singletonObjects` ÖС£ +1. 在 `service1` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service1` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +2. 对 `service1` 进行ä¾�赖注入时,`spring` å�‘现 `service1` 需è¦�注入 `service2`,然å�Žå…ˆåŽ» `earlySingletonObjects` 查找 `service2`,未找到;å†�去 `singletonObjects` 中查找 `service2`,还是未找到,于是就开始了 `service2` 的创建过程; +3. 在 `service2` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service2` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +4. 对 `service2` 进行ä¾�赖注入时,`spring` å�‘现 `service2` 需è¦�注入 `service1`,然å�Žå°±åŽ» `earlySingletonObjects` 查找 `service1`,找到了,就将 `service1` 注入到 `service2` 中,此时 `service2` 就是一个 `spring bean` 了,将其ä¿�存到 `singletonObjects` 中; +5. ç»�过第 4 æ­¥å�Žï¼Œæˆ‘们得到了 `service2`,然å�Žå°†å…¶æ³¨å…¥åˆ° `service1` 中,此时 `service1` 也æˆ�了一个 `spring bean`,将其ä¿�存到 `singletonObjects` 中。 -¾­¹ýÒÔÉϲ½Ö裬ÎÒÃÇ·¢ÏÖ£¬Ñ­»·ÒÀÀµµÃµ½Á˽â¾ö¡£ +ç»�过以上步骤,我们å�‘现,循环ä¾�赖得到了解决。 -#### 2.2 aop ϵÄÑ­»·ÒÀÀµ +#### 2.2 aop 下的循环ä¾�èµ– -¾­¹ýÉÏÃæµÄ·ÖÎö£¬ÎÒÃÇ·¢ÏÖÖ»Òª¶îÍâÒýÈëÒ»¸ö `earlySingletonObjects` ºó£¬Ñ­»·ÒÀÀµ¾ÍÄܵõ½½â¾ö¡£µ«ÊÇ£¬Ñ­»·ÒÀÀµÕæµÄµÃµ½Á˽â¾öÂð£¿spring ³ýÁË ioc Í⣬»¹ÓÐÁíÒ»¸öÖØ´ó¹¦ÄÜ£ºaop£¬ÎÒÃÇÀ´¿´¿´ aop Çé¿öϳöÏÖÑ­»·ÒÀÀµ»áÔõÑù¡£ +ç»�过上é�¢çš„分æž�,我们å�‘现å�ªè¦�é¢�外引入一个 `earlySingletonObjects` å�Žï¼Œå¾ªçޝä¾�赖就能得到解决。但是,循环ä¾�赖真的得到了解决å�—?spring 除了 ioc 外,还有å�¦ä¸€ä¸ªé‡�大功能:aop,我们æ�¥çœ‹çœ‹ aop 情况下出现循环ä¾�赖会怎样。 -##### 1\. aop ¶ÔÏóµÄ´´½¨¹ý³Ì +##### 1\. aop 对象的创建过程 -ÔÚÕýʽ½éÉÜ aop ϵÄÑ­»·ÒÀÀµÇ°£¬ÎÒÃÇÏÈÀ´Ã÷È·Á½¸ö¸ö¸ÅÄ +在正å¼�介ç»� aop 下的循环ä¾�èµ–å‰�,我们先æ�¥æ˜Žç¡®ä¸¤ä¸ªä¸ªæ¦‚念: -* `ԭʼ¶ÔÏó`£ºÇø±ðÓÚ´úÀí¶ÔÏó£¬Ö¸Î´½øÐйý aop µÄ¶ÔÏ󣬿ÉÒÔÊÇ java ¶ÔÏó£¬Ò²¿ÉÒÔÊÇδ½øÐÐ aop µÄ spring bean£» -* `´úÀí¶ÔÏó`£º½øÐйý aop µÄ¶ÔÏ󣬿ÉÒÔÊÇ java ¶ÔÏó½ö½øÐйý aop µÃµ½µÄ¶ÔÏó (½ö½øÐйý aop£¬Î´½øÐÐÒÀÀµ×¢È룬Ҳδ½øÐгõʼ»¯)£¬Ò²¿ÉÒÔÊǽøÐйý aop µÄ `spring bean`. +* `原始对象`:区别于代ç�†å¯¹è±¡ï¼ŒæŒ‡æœªè¿›è¡Œè¿‡ aop 的对象,å�¯ä»¥æ˜¯ java 对象,也å�¯ä»¥æ˜¯æœªè¿›è¡Œ aop çš„ spring beanï¼› +* `代ç�†å¯¹è±¡`:进行过 aop 的对象,å�¯ä»¥æ˜¯ java 对象仅进行过 aop 得到的对象 (仅进行过 aop,未进行ä¾�赖注入,也未进行åˆ�始化),也å�¯ä»¥æ˜¯è¿›è¡Œè¿‡ aop çš„ `spring bean`. -ÎÒÃÇÏÈÀ´¿´¿´ aop ÊÇÈçºÎ´´½¨¶ÔÏóµÄ£º +我们先æ�¥çœ‹çœ‹ aop 是如何创建对象的: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-e92991c1c173bbd5579be3001a977555be7.png) -Ïà±ÈÓÚ `2.1` ÖеÄÁ÷³Ì£¬aop ¶àÁË "Éú³É´úÀí¶ÔÏó" µÄ²Ù×÷£¬²¢ÇÒ×îÖÕ±£´æµ½ `singletonObjects` ÖеĶÔÏóÒ²ÊÇ´úÀí¶ÔÏó¡£ +相比于 `2.1` 中的æµ�程,aop 多了 "生æˆ�代ç�†å¯¹è±¡" çš„æ“�作,并且最终ä¿�存到 `singletonObjects` 中的对象也是代ç�†å¯¹è±¡ã€‚ -ԭʼ¶ÔÏóÓë´úÀí¶ÔÏóÖ®¼äÊÇʲô¹ØÏµÄØ£¿ÓôúÂëʾÒâÏ£¬´óÖÂÈçÏ£º +原始对象与代ç�†å¯¹è±¡ä¹‹é—´æ˜¯ä»€ä¹ˆå…³ç³»å‘¢ï¼Ÿç”¨ä»£ç �示æ„�下,大致如下: ``` public class ProxyObj extends Obj { - // ԭʼ¶ÔÏó + // 原始对象 private Obj obj; ... @@ -151,34 +151,34 @@ public class ProxyObj extends Obj { ``` -ʵ¼ÊÉÏ£¬Á½ÕßÖ®¼äµÄ¹ØÏµ²¢Ã»ÓÐÕâô¼òµ¥£¬µ«ÎªÁË˵Ã÷ÎÊÌ⣬ÕâÀï¶ÔÁ½Õß¹ØÏµ×öÁ˼ò»¯£¬Ð¡»ï°éÃÇÖ»ÐèÒªÃ÷°×£¬**´úÀí¶ÔÏó³ÖÓÐԭʼ¶ÔÏóµÄÒýÓÃ**¼´¿É¡£ +实际上,两者之间的关系并没有这么简å�•,但为了说明问题,这里对两者关系å�šäº†ç®€åŒ–,å°�伙伴们å�ªéœ€è¦�明白,**代ç�†å¯¹è±¡æŒ�有原始对象的引用**å�³å�¯ã€‚ -¹ØÓÚԭʼ¶ÔÏóÈçºÎ±ä³É´úÀí¶ÔÏóµÄ£¬¿ÉÒԲο¼ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)¡£ +关于原始对象如何å�˜æˆ�代ç�†å¯¹è±¡çš„,å�¯ä»¥å�‚考 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)。 -¶ÔÒÔÉÏ´´½¨¹ý³Ì£¬Óà java ´úÂëÄ£ÄâÈçÏ£º +对以上创建过程,用 java 代ç �模拟如下: ``` /** - * ×¼±¸Ò»¸öÀà + * 准备一个类 */ public class Obj1 { } /** - * ×¼±¸Ò»¸öÀ࣬ÄÚ²¿ÓÐÒ»¸öÊôÐÔ Obj1 + * 准备一个类,内部有一个属性 Obj1 */ public class Obj2 { private Obj1 obj1; - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Obj2µÄ´úÀíÀ࣬ÄÚ²¿³ÖÓÐobj2µÄ¶ÔÏó + * 准备Obj2的代ç�†ç±»ï¼Œå†…部æŒ�有obj2的对象 */ public class ProxyObj2 extends Obj2 { @@ -188,309 +188,309 @@ public class ProxyObj2 extends Obj2 { this.obj2 = obj2; } - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } ``` -½Ó×Å£¬¾ÍÊÇÄ£Äâ ¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± µÄ Á÷³ÌÁË£º +接ç�€ï¼Œå°±æ˜¯æ¨¡æ‹Ÿ “创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� çš„ æµ�程了: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // ¿ªÊ¼ Obj2 µÄ´´½¨Á÷³Ì - // 1\. ´´½¨ Obj2 ¶ÔÏó + // 开始 Obj2 的创建æµ�程 + // 1\. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // 2\. Íù Obj2 ÖÐ×¢Èë obj1£¬µ«´Ëʱ²¢Ã»ÓÐobj1£¬Òò´ËÏÈÒª´´½¨obj1£¬ÔÙ½«Æä×¢Èëµ½Obj2ÖÐ + // 2\. å¾€ Obj2 中注入 obj1,但此时并没有obj1,因此先è¦�创建obj1,å†�将其注入到Obj2中 Obj1 obj1 = new Obj1(); obj2.setObj1(obj1); - // 3\. Éú³ÉObj2µÄ´úÀí¶ÔÏ󣬴úÀí¶ÔÏóÖгÖÓÐ Obj2µÄԭʼ¶ÔÏó + // 3\. 生æˆ�Obj2的代ç�†å¯¹è±¡ï¼Œä»£ç�†å¯¹è±¡ä¸­æŒ�有 Obj2的原始对象 ProxyObj2 proxyObj2 = new ProxyObj2(obj2); - // 4\. proxyObj2ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // 4\. proxyObj2å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj2); } ``` -ÉÏÊö´úÂëÖУ¬ +上述代ç �中, -* ÒÔ `new Obj2()` Ä£Äâ¶ÔÏóµÄ´´½¨ -* ÒÔ `obj2.setObj1(xxx)` Ä£ÄâÒÀÀµ×¢Èë -* ÒÔ `new ProxyObj2(xxx)` Ä£Äâ´úÀí¶ÔÏóµÄÉú³É -* ÒÔ `collection.add(xxx)` Ä£Äâ¶ÔÏóÌí¼Óµ½ÈÝÆ÷ÖеĹý³Ì +* 以 `new Obj2()` 模拟对象的创建 +* 以 `obj2.setObj1(xxx)` 模拟ä¾�赖注入 +* 以 `new ProxyObj2(xxx)` 模拟代ç�†å¯¹è±¡çš„生æˆ� +* 以 `collection.add(xxx)` 模拟对象添加到容器中的过程 -Ä£ÄâµÄÁ÷³ÌÈçÏ£º +模拟的æµ�程如下: -1. ´´½¨ `obj2` ¶ÔÏó -2. Íù `Obj2` ÖÐ×¢Èë `obj1`£¬µ«´Ëʱ²¢Ã»ÓÐ `obj1`£¬Òò´ËÏÈÒª´´½¨ `obj1`£¬ÔÙ½«Æä×¢Èëµ½ `Obj2` ÖÐ -3. Éú³É `Obj2` µÄ´úÀí¶ÔÏó `proxyObj2`£¬`proxyObj2` ÖгÖÓÐ `Obj2` µÄԭʼ¶ÔÏó -4. `proxyObj2` ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ +1. 创建 `obj2` 对象 +2. å¾€ `Obj2` 中注入 `obj1`,但此时并没有 `obj1`,因此先è¦�创建 `obj1`,å†�将其注入到 `Obj2` 中 +3. 生æˆ� `Obj2` 的代ç�†å¯¹è±¡ `proxyObj2`,`proxyObj2` 中æŒ�有 `Obj2` 的原始对象 +4. `proxyObj2` å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ -×Ðϸ·ÖÎöÉÏÃæµÄ²½Ö裬¾Í»á·¢ÏÖ£¬ÉÏÃæµÄµÚ 2 ²½ÓëµÚ 3 ²½ÍêÈ«µ÷»»Ë³ÐòҲûÎÊÌ⣬´úÂëÄ£ÄâÈçÏ£º +仔细分æž�上é�¢çš„æ­¥éª¤ï¼Œå°±ä¼šå�‘现,上é�¢çš„第 2 步与第 3 步完全调æ�¢é¡ºåº�也没问题,代ç �模拟如下: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // ¿ªÊ¼ Obj2 µÄ´´½¨Á÷³Ì - // 1\. ´´½¨ Obj2 ¶ÔÏó + // 开始 Obj2 的创建æµ�程 + // 1\. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // 2\. Éú³ÉObj2µÄ´úÀí¶ÔÏ󣬴úÀí¶ÔÏóÖгÖÓÐ Obj2µÄԭʼ¶ÔÏó + // 2\. 生æˆ�Obj2的代ç�†å¯¹è±¡ï¼Œä»£ç�†å¯¹è±¡ä¸­æŒ�有 Obj2的原始对象 ProxyObj2 proxyObj2 = new ProxyObj2(obj2); - // 3\. Íù obj2 ÖÐ×¢Èë obj1£¬µ«´Ëʱ²¢Ã»ÓÐobj1£¬Òò´ËÏÈÒª´´½¨obj1£¬ÔÙ½«Æä×¢Èëµ½Obj2ÖÐ + // 3\. å¾€ obj2 中注入 obj1,但此时并没有obj1,因此先è¦�创建obj1,å†�将其注入到Obj2中 Obj1 obj1 = new Obj1(); - // ÕâÀïÊÇ×¢È뵽ԭʼ¶ÔÏóÖÐ + // 这里是注入到原始对象中 obj2.setObj1(obj1); - // 4\. proxyObj2ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // 4\. proxyObj2å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj2); } ``` -ÉÏÊö´úÂëµÄÁ÷³ÌÈçÏ£º +上述代ç �çš„æµ�程如下: -1. ´´½¨ obj2 ¶ÔÏó -2. Éú³É Obj2 µÄ´úÀí¶ÔÏ󣬴úÀí¶ÔÏóÖгÖÓÐ Obj2 µÄԭʼ¶ÔÏó -3. Íù Obj2 ÖÐ×¢Èë obj1£¬µ«´Ëʱ²¢Ã»ÓÐ obj1£¬Òò´ËÏÈÒª´´½¨ obj1£¬ÔÙ½«Æä×¢Èëµ½ Obj2 -4. proxyObj2 ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ +1. 创建 obj2 对象 +2. 生æˆ� Obj2 的代ç�†å¯¹è±¡ï¼Œä»£ç�†å¯¹è±¡ä¸­æŒ�有 Obj2 的原始对象 +3. å¾€ Obj2 中注入 obj1,但此时并没有 obj1,因此先è¦�创建 obj1,å†�将其注入到 Obj2 +4. proxyObj2 å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ -´Ó´úÂëÉÏ¿´£¬`proxyObj2(´úÀí¶ÔÏó)` ÖгÖÓÐ `ob2(ԭʼ¶ÔÏó)`£¬Éú³É´úÀí¶ÔÏóºó£¬¼ÌÐø¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢È룬ÒÀÈ»ÄÜÓ°Ïì´úÀí¶ÔÏó£¬×îÖÕ´úÀí¶ÔÏó³ÖÓеÄԭʼ¶ÔÏóÒ²Íê³ÉÁËÒÀÀµ×¢È룬Õû¸ö¹ý³ÌÓÃͼÐÎʾÒâÈçÏ£º +从代ç �上看,`proxyObj2(代ç�†å¯¹è±¡)` 中æŒ�有 `ob2(原始对象)`,生æˆ�代ç�†å¯¹è±¡å�Žï¼Œç»§ç»­å¯¹åŽŸå§‹å¯¹è±¡è¿›è¡Œå±žæ€§æ³¨å…¥ï¼Œä¾�然能影å“�代ç�†å¯¹è±¡ï¼Œæœ€ç»ˆä»£ç�†å¯¹è±¡æŒ�有的原始对象也完æˆ�了ä¾�赖注入,整个过程用图形示æ„�如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8ff5579425f73dd5c2d321a86d0303390ac.png) -ÕâÀïÎÒÃÇÔÙ´ÎÉêÃ÷£¬´Ó java ¶ÔÏóµ½ spring bean µÄ²½ÖèÓкö࣬ÕâÀïÎÒÃǽö¹Ø×¢ÓëÑ­»·ÒÀÀµÏà¹ØµÄ²½Ö裬Èç¹ûÏëÁ˽â spring bean ÏêϸµÄ³õʼ»¯¹ý³Ì£¬¿É²é¿´ [spring Æô¶¯Á÷³ÌÖ®Æô¶¯Á÷³Ì¸ÅÀÀ](https://my.oschina.net/funcy/blog/4597493)¡£ +这里我们å†�次申明,从 java 对象到 spring bean 的步骤有好多,这里我们仅关注与循环ä¾�赖相关的步骤,如果想了解 spring bean 详细的åˆ�始化过程,å�¯æŸ¥çœ‹ [spring å�¯åЍæµ�程之å�¯åЍæµ�程概览](https://my.oschina.net/funcy/blog/4597493)。 -µ½ÕâÀÎÒÃÇ̽Ë÷µ½´úÀí¶ÔÏóµÄÉúÃüÖÜÆÚ¿ÉÒÔÓÐÁ½ÖÖ£º +到这里,我们探索到代ç�†å¯¹è±¡çš„生命周期å�¯ä»¥æœ‰ä¸¤ç§�: -* ´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖÐ -* ´´½¨ (ԭʼ¶ÔÏó)--> Éú³É´úÀí¶ÔÏó (Ìáǰ½øÐÐ aop)--> ¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢Èë --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖÐ +* 创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> 将代ç�†å¯¹è±¡ä¿�存到容器中 +* 创建 (原始对象)--> 生æˆ�代ç�†å¯¹è±¡ (æ��å‰�进行 aop)--> 对原始对象进行属性注入 --> 将代ç�†å¯¹è±¡ä¿�存到容器中 -ÕâÁ½ÖÖ¶¼ÄÜ´ïµ½×îÖÕÄ¿µÄ£¬¼´**±£´æµ½ÈÝÆ÷ÖеÄÊÇ´úÀí¶ÔÏó£¬ÇÒ´úÀí¶ÔÏó¶ÔÓ¦µÄԭʼ¶ÔÏóÍê³ÉÁËÒÀÀµ×¢Èë**¡£ÇëÀμÇÕâÁ½¸ö´´½¨Á÷³Ì£¬ÕâÊǺóÃæ½â¾ö aop ÏÂÑ­»·ÒÀÀµÎÊÌâµÄºËÐÄ£¬Ëµ°×ÁË£¬**aop ϵÄÑ­»·ÒÀÀµÎÊÌâÖ®ËùÒÔÄܽâ¾ö£¬¾ÍÊÇÒòΪ¶ÔÏó¿ÉÒÔÌáǰ½øÐÐ aop ²Ù×÷**¡£ +这两ç§�都能达到最终目的,å�³**ä¿�存到容器中的是代ç�†å¯¹è±¡ï¼Œä¸”代ç�†å¯¹è±¡å¯¹åº”的原始对象完æˆ�了ä¾�赖注入**。请牢记这两个创建æµ�程,这是å�Žé�¢è§£å†³ aop 下循环ä¾�赖问题的核心,说白了,**aop 下的循环ä¾�赖问题之所以能解决,就是因为对象å�¯ä»¥æ��å‰�进行 aop æ“�作**。 -##### 2\. ΪʲôÓà `earlySingletonObjects` ÎÞ·¨½â¾öÑ­»·ÒÀÀµ£¿ +##### 2\. 为什么用 `earlySingletonObjects` 无法解决循环ä¾�赖? -Ç°ÃæÎÒÃÇÖ÷Ҫ˵Ã÷ÁË´úÀí¶ÔÏóµÄ´´½¨¹ý³Ì£¬½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ÔÚ aop Ï£¬Ê¹Óà `earlySingletonObjects` À´½â¾öÑ­»·ÒÀÀµÓÐʲôÎÊÌ⣺ +å‰�é�¢æˆ‘们主è¦�说明了代ç�†å¯¹è±¡çš„创建过程,接下æ�¥æˆ‘们æ�¥çœ‹çœ‹åœ¨ aop 下,使用 `earlySingletonObjects` æ�¥è§£å†³å¾ªçޝä¾�赖有什么问题: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d3d00d76ab0c72339faccb7ccd853723d6c.png) -ÎÒÃÇÀ´·ÖÎöÉÏͼµÄÁ÷³Ì£º +我们æ�¥åˆ†æž�上图的æµ�程: -1. ÔÚ `service1` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service1` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -2. ¶Ô `service1` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service1` ÐèҪעÈë `service2`£¬È»ºóÏÈÈ¥ `earlySingletonObjects` ²éÕÒ `service2`£¬Î´ÕÒµ½£»ÔÙÈ¥ `singletonObjects` ÖвéÕÒ `service2`£¬»¹ÊÇδÕÒµ½£¬ÓÚÊǾͿªÊ¼ÁË `service2` µÄ´´½¨¹ý³Ì£» -3. ÔÚ `service2` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service2` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -4. ¶Ô `service2` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service2` ÐèҪעÈë `service1`£¬È»ºó¾ÍÈ¥ `earlySingletonObjects` ²éÕÒ `service1`£¬ÕÒµ½ÁË£¬¾Í½« `service1` ×¢Èëµ½ `service2` ÖУ¬È»ºóÔÙ½øÐÐ aop£¬´Ëʱ `service2` ÊÇÒ»¸ö´úÀí¶ÔÏ󣬽«Æä±£´æµ½ `singletonObjects` ÖУ» -5. ¾­¹ýµÚ 4 ²½ºó£¬ÎÒÃǵõ½ÁË `service2` µÄ´úÀí¶ÔÏó£¬È»ºó½«Æä×¢Èëµ½ `service1` ÖУ¬½Ó×ÅÔÙ¶Ô `service1` ½øÐÐ aop£¬´Ëʱ `service1` Ò²³ÉÁËÒ»¸ö `spring bean`£¬½«Æä±£´æµ½ `singletonObjects` ÖС£ +1. 在 `service1` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service1` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +2. 对 `service1` 进行ä¾�赖注入时,`spring` å�‘现 `service1` 需è¦�注入 `service2`,然å�Žå…ˆåŽ» `earlySingletonObjects` 查找 `service2`,未找到;å†�去 `singletonObjects` 中查找 `service2`,还是未找到,于是就开始了 `service2` 的创建过程; +3. 在 `service2` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service2` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +4. 对 `service2` 进行ä¾�赖注入时,`spring` å�‘现 `service2` 需è¦�注入 `service1`,然å�Žå°±åŽ» `earlySingletonObjects` 查找 `service1`,找到了,就将 `service1` 注入到 `service2` 中,然å�Žå†�进行 aop,此时 `service2` 是一个代ç�†å¯¹è±¡ï¼Œå°†å…¶ä¿�存到 `singletonObjects` 中; +5. ç»�过第 4 æ­¥å�Žï¼Œæˆ‘们得到了 `service2` 的代ç�†å¯¹è±¡ï¼Œç„¶å�Žå°†å…¶æ³¨å…¥åˆ° `service1` 中,接ç�€å†�对 `service1` 进行 aop,此时 `service1` 也æˆ�了一个 `spring bean`,将其ä¿�存到 `singletonObjects` 中。 -ÉÏÊö²½ÖèÓÐʲôÎÊÌâÄØ£¿×Ðϸ¿´µÚ 4 ²½£¬¾Í»á·¢ÏÖ£¬**×¢Èëµ½ `service2` µÄ `service1` ²¢²»ÊÇ´úÀí¶ÔÏó**£¡×ݹÛÈ«¾Ö£¬×îÖյõ½µÄ `service1` Óë `service2` ¶¼ÊÇ´úÀí¶ÔÏó£¬×¢Èëµ½ `service2` µÄ `service1` Ó¦¸ÃÒ²ÊÇ´úÀí¶ÔÏó²Å¶Ô¡£Òò´Ë£¬ÔÚ aop Ï£¬Ñ­»·ÒÀÀµµÄÎÊÌâÓÖ³öÏÖÁË£¡ +上述步骤有什么问题呢?仔细看第 4 步,就会å�‘现,**注入到 `service2` çš„ `service1` å¹¶ä¸�是代ç�†å¯¹è±¡**ï¼�纵观全局,最终得到的 `service1` 与 `service2` 都是代ç�†å¯¹è±¡ï¼Œæ³¨å…¥åˆ° `service2` çš„ `service1` 应该也是代ç�†å¯¹è±¡æ‰�对。因此,在 aop 下,循环ä¾�赖的问题å�ˆå‡ºçŽ°äº†ï¼� -#### 2.3 spring µÄ½â¾ö·½°¸ +#### 2.3 spring 的解决方案 -Ç°ÃæÎÒÃÇÌáµ½£¬ÔÚ aop Ï£¬ÒýÈë `earlySingletonObjects` ²¢²»Äܽâ¾öÑ­»·ÒÀÀµµÄÎÊÌ⣬ÄÇ spring ÊÇÔõô½â¾öµÄÄØ£¿spring ÔÙ´ÎÒýÈëÁËÒ»¸ö `map` À´½â¾öÕâ¸öÎÊÌ⣬ÕâÒ²ÊÇÈËÃdz£ËµµÄ **spring Èý¼¶»º´æ**£¬¶ÔÕâÈý¸ö `map` ˵Ã÷ÈçÏ£º +å‰�é�¢æˆ‘们æ��到,在 aop 下,引入 `earlySingletonObjects` å¹¶ä¸�能解决循环ä¾�赖的问题,那 spring 是怎么解决的呢?spring å†�次引入了一个 `map` æ�¥è§£å†³è¿™ä¸ªé—®é¢˜ï¼Œè¿™ä¹Ÿæ˜¯äººä»¬å¸¸è¯´çš„ **spring 三级缓存**,对这三个 `map` 说明如下: -* Ò»¼¶»º´æ `singletonObjects`£ºÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇÍêÕûµÄ `spring bean`£¬¼´Íê³ÉÊôÐÔ×¢Èë¡¢³õʼ»¯µÄ bean£¬Èç¹û bean ÐèÒª aop£¬´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£» -* ¶þ¼¶»º´æ `earlySingletonObjects`£ºÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇʵÀý»¯Íê³É£¬µ«Î´½øÐÐÒÀÀµ×¢ÈëµÄ `bean`£¬Èç¹û `bean` ÐèÒª `aop`£¬ÕâÀï´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£¬Ö»²»¹ý´úÀí¶ÔÏóËù³ÖÓеÄԭʼ¶ÔÏó²¢Î´½øÐÐÒÀÀµ×¢È룻 -* Èý¼¶»º´æ `singletonFactories`£ºÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ´æ´¢µÄÊÇÒ»¸ö `lambda` ±í´ïʽ£º`() -> getEarlyBeanReference(beanName, mbd, bean)`£¬ `getEarlyBeanReference` ÖÐµÄ `bean` ÊǸմ´½¨Íê³ÉµÄ `java bean`£¬Ã»ÓнøÐÐ spring ÒÀÀµ×¢È룬Ҳû½øÐÐ aop (¹ØÓÚÕâ¸ö `lambda` ±í´ïʽ£¬ºóÃæ»á¼ÌÐø·ÖÎö)¡£ +* 一级缓存 `singletonObjects`:类型为 `ConcurrentHashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是完整的 `spring bean`,å�³å®Œæˆ�属性注入ã€�åˆ�始化的 bean,如果 bean 需è¦� aop,存储的就是代ç�†å¯¹è±¡ï¼› +* 二级缓存 `earlySingletonObjects`:类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是实例化完æˆ�,但未进行ä¾�赖注入的 `bean`,如果 `bean` 需è¦� `aop`,这里存储的就是代ç�†å¯¹è±¡ï¼Œå�ªä¸�过代ç�†å¯¹è±¡æ‰€æŒ�有的原始对象并未进行ä¾�赖注入; +* 三级缓存 `singletonFactories`:类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 存储的是一个 `lambda` 表达å¼�:`() -> getEarlyBeanReference(beanName, mbd, bean)`, `getEarlyBeanReference` 中的 `bean` 是刚创建完æˆ�çš„ `java bean`,没有进行 spring ä¾�赖注入,也没进行 aop (关于这个 `lambda` 表达å¼�,å�Žé�¢ä¼šç»§ç»­åˆ†æž�)。 -ΪÁË˵Ã÷·½±ã£¬ÏÂÃæ¶Ô `singletonObjects`¡¢`earlySingletonObjects` ºÍ `singletonFactories` ·Ö±ð³ÆÎª**Ò»¼¶»º´æ**¡¢**¶þ¼¶»º´æ**ºÍ**Èý¼¶»º´æ**¡£ +为了说明方便,下é�¢å¯¹ `singletonObjects`ã€�`earlySingletonObjects` å’Œ `singletonFactories` 分别称为**一级缓存**ã€�**二级缓存**å’Œ**三级缓存**。 -spring ½â¾ö aop ϵÄÑ­»·ÒÀÀµÁ÷³ÌÈçÏ£º +spring 解决 aop 下的循环ä¾�èµ–æµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-dc325a87b321e4c246a1b2f14169821a75a.png) -Õâ¸öͼ¿´×űȽϸ´ÔÓ£¬Æäʵ·Ö¿ªÀ´¿´¾Í±È½Ï¼òµ¥ÁË£¬ÉÏÊö²Ù×÷ÖУ¬`1~8` ÊÇ»ñÈ¡ `service1` µÄÁ÷³Ì£¬`5.1~5.8` ÊÇ»ñÈ¡ `service2` µÄÁ÷³Ì£¬`5.5.1` ÊÇÔٴλñÈ¡ `service1` µÄÁ÷³Ì£¬Ö»²»¹ýÔÚ´¦Àí `service1` µÄ³õʼ»¯¹ý³ÌÖУ¬»á´¥·¢ `service2` µÄ³õʼ»¯¹ý³Ì£¬¶ø `service2` µÄ³õʼ»¯Ê±£¬ÓÖ»áÒÀÀµµ½ `service1`£¬Òò´Ë²Å¿´×ÅÏñÊÇÁ¬ÔÚÒ»Æð£¬±È½Ï¸´ÔÓ¡£ +这个图看ç�€æ¯”较å¤�æ�‚,其实分开æ�¥çœ‹å°±æ¯”较简å�•了,上述æ“�作中,`1~8` 是获å�– `service1` çš„æµ�程,`5.1~5.8` 是获å�– `service2` çš„æµ�程,`5.5.1` 是å†�次获å�– `service1` çš„æµ�程,å�ªä¸�过在处ç�† `service1` çš„åˆ�始化过程中,会触å�‘ `service2` çš„åˆ�始化过程,而 `service2` çš„åˆ�始化时,å�ˆä¼šä¾�赖到 `service1`,因此æ‰�看ç�€åƒ�是连在一起,比较å¤�æ�‚。 -¶ÔÉÏͼµÄ¹ý³Ì£¬ÕâÀï˵Ã÷ÈçÏ£¨½¨Ò飺Èç¹û¾õµÃÁ÷³Ì±È½Ï¸´ÔÓ£¬¿ÉÒÔÏÈ¿´ `1~8` µÄ²Ù×÷£¬ÔÙ¿´ `5.1~5.8` µÄ²Ù×÷£¬×îºóÁ½ÕßÁªºÏÆðÀ´¿´£¬ÕâÑù»áÇåÎúºÜ¶à£©£º +对上图的过程,这里说明如下(建议:如果觉得æµ�程比较å¤�æ�‚,å�¯ä»¥å…ˆçœ‹ `1~8` çš„æ“�作,å†�看 `5.1~5.8` çš„æ“�作,最å�Žä¸¤è€…è�”å�ˆèµ·æ�¥çœ‹ï¼Œè¿™æ ·ä¼šæ¸…晰很多): -* 1. `service1`£º»ñÈ¡ `service1`£¬´ÓÒ»¼¶»º´æÖлñÈ¡£¬´ËʱÊÇ»ñÈ¡²»µ½µÄ£» -* 1. `service1`£º´´½¨ `service1` µÄʵÀý£» -* 1. `service1`£º»ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¨ÔÚԭʼ¶ÔÏóÉϽøÐлñÈ¡£©£» -* 1. `service1`£ºÈç¹û¿ªÆôÁËÖ§³ÖÑ­»·ÒÀÀµµÄÅäÖ㬾ͽ« `service1` ·Åµ½Èý¼¶»º´æÖУ¨ÊÇ·ñÖ§³ÖÑ­»·ÒÀÀµ£¬ÊÇ¿ÉÒÔÅäÖõģ©£» -* 1. `service1`£º¶Ô `service1` ½øÐÐÒÀÀµ×¢È룬ÐèÒª `service2`£¬È»ºó¾Í¿ªÊ¼ÁË `service2` µÄ»ñÈ¡Á÷³Ì£» -* 5.1 `service2`£º»ñÈ¡ `service2`£¬´ÓÒ»¼¶»º´æÖлñÈ¡£¬´ËʱÊÇ»ñÈ¡²»µ½µÄ£» -* 5.2 `service2`£º´´½¨ `service2` µÄʵÀý£» -* 5.3 `service2`£º»ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¨ÔÚԭʼ¶ÔÏóÉϽøÐлñÈ¡£©£» -* 5.4 `service2`£ºÈç¹û¿ªÆôÁËÖ§³ÖÑ­»·ÒÀÀµµÄÅäÖ㬾ͽ« `service2` ·Åµ½Èý¼¶»º´æÖУ¨ÊÇ·ñÖ§³ÖÑ­»·ÒÀÀµ£¬ÊÇ¿ÉÒÔÅäÖõģ©£» -* 5.5 `service2`£º¶Ô `service2` ½øÐÐÒÀÀµ×¢È룬ÐèÒª `service1`£¬È»ºó¾Í¿ªÊ¼ÁË `service1` µÄ»ñÈ¡Á÷³Ì£» -* 5.5.1 `service1`: »ñÈ¡ `service1`£¬´ÓÒ»¼¶»º´æÖлñÈ¡£¬»ñÈ¡²»µ½£»´Ëʱ·¢ÏÖ `service1` ÕýÔÚ´´½¨ÖУ¬ÓÚÊǼÌÐø´Ó¶þ¡¢Èý¼¶»º´æÖлñÈ¡£¬×îÖÕ´ÓÈý¼¶»º´æÖлñÈ¡µ½ÁË£¬½«Æä·ÅÈë¶þ¼¶»º´æ¡£´ÓÈý¼¶»º´æ»ñÈ¡µÄ¹ý³ÌÖУ¬**»áÅÐ¶Ï `service1` ÊÇ·ñÐèÒª½øÐÐ aop£¬È»ºó¿ªÊ¼ aop ²Ù×÷**£¬Òò´Ë·ÅÈë¶þ¼¶»º´æÖеÄÊÇ `service1` ´úÀí´úÀí£¬Ìáǰ½øÐÐ aop Êǽâ¾öÑ­»·ÒÀÀµµÄ¹Ø¼ü£» -* 5.6 `service2`£ºµÃµ½ÁË `service1` ºó£¨ÕâÀïµÄ `service1` ÊÇ´úÀí¶ÔÏ󣩣¬½«Æä×¢Èëµ½ `service2` ÖУ¬½Ó×Å¶Ô `service2` ½øÐÐ aop£¬µÃµ½ `service2` µÄ´úÀí¶ÔÏó£» -* 5.7 `service2`£ºÈç¹ûÖ§³ÖÑ­»·ÒÀÀµ£¬ÏÈ´ÓÒ»¡¢¶þ¼¶»º´æÖÐÔٴλñÈ¡ `service2`£¬¶¼Î´»ñÈ¡µ½£¬¾ÍʹÓõ±Ç° `service2`£¨µ±Ç° `service2` ÊÇ´úÀí¶ÔÏó)£» -* 5.8 `service2`£º½« service2 µÄ´úÀí¶ÔÏó·ÅÈëÒ»¼¶»º´æÖУ¬É¾³ý¶þ¡¢Èý¼¶»º´æ£¬ÖÁ´Ë£¬`service2` ³õʼ»¯Íê³É£¬×¢ÈëµÄ `service1` ÊÇ´úÀí¶ÔÏó£¬Ò»¼¶»º´æÖÐµÄ `service2` Ò²ÊÇ´úÀí¶ÔÏó£» -* 1. `service1`£º»Øµ½ `service1` µÄÉúÃüÖÜÆÚ£¬Äõ½ `service2`£¨ÕâÀïµÄ `service2` ÊÇ´úÀí¶ÔÏ󣩺󣬽«Æä×¢Èëµ½ `service1`£¬`service1` µÄÒÀÀµ×¢ÈëÍê³É£¬½øÐгõʼ»¯£¬ÕâÀï»áÅÐ¶Ï `service1` ÊÇ·ñÐèÒª½øÐÐ aop£¬ËäÈ» `service1` ÊÇÐèÒª½øÐÐ aop µÄ£¬µ«ÓÉÓÚÔÚ `5.5.1` ÒѾ­½øÐйý aop ÁË£¬Òò´Ë£¬ÕâÀïÖ±½Ó·µ»Ø£¨µ½ÕâÒ»²½£¬`service1` »¹ÊÇԭʼ¶ÔÏ󣩣» -* 1. `service1`£ºÈç¹ûÖ§³ÖÑ­»·ÒÀÀµ£¬ÏÈ´ÓÒ»¼¶»º´æÖлñÈ¡ `service1`£¬»ñÈ¡²»µ½£»ÔÙ´Ó¶þ»º´æÖлñÈ¡ `service1`£¬¿ÉÒÔ»ñÈ¡µ½£¨´Ó `5.5.1` ¿ÉÖª£¬¶þ¼¶»º´æÀïÊÇ `service1` ´úÀí¶ÔÏ󣩣¬·µ»Ø£» -* 1. `service1`£º½«¶þ¼¶»º´æÖлñÈ¡µÄ¶ÔÏó×¢²áµ½Ò»¼¶»º´æÖУ¬É¾³ý¶þ¡¢Èý¼¶»º´æ£¬ÖÁ´Ë£¬`service1` ³õʼ»¯Íê³É£¬×¢ÈëµÄ `service2` ÊÇ´úÀí¶ÔÏó£¬Ò»¼¶»º´æÖÐµÄ `service1` Ò²ÊÇ´úÀí¶ÔÏó¡£ +* 1. `service1`:获å�– `service1`,从一级缓存中获å�–,此时是获å�–ä¸�到的; +* 1. `service1`:创建 `service1` 的实例; +* 1. `service1`:获å�–需è¦�注入的属性与方法(在原始对象上进行获å�–); +* 1. `service1`:如果开å�¯äº†æ”¯æŒ�循环ä¾�èµ–çš„é…�置,就将 `service1` 放到三级缓存中(是å�¦æ”¯æŒ�循环ä¾�赖,是å�¯ä»¥é…�置的); +* 1. `service1`:对 `service1` 进行ä¾�赖注入,需è¦� `service2`,然å�Žå°±å¼€å§‹äº† `service2` 的获å�–æµ�程; +* 5.1 `service2`:获å�– `service2`,从一级缓存中获å�–,此时是获å�–ä¸�到的; +* 5.2 `service2`:创建 `service2` 的实例; +* 5.3 `service2`:获å�–需è¦�注入的属性与方法(在原始对象上进行获å�–); +* 5.4 `service2`:如果开å�¯äº†æ”¯æŒ�循环ä¾�èµ–çš„é…�置,就将 `service2` 放到三级缓存中(是å�¦æ”¯æŒ�循环ä¾�赖,是å�¯ä»¥é…�置的); +* 5.5 `service2`:对 `service2` 进行ä¾�赖注入,需è¦� `service1`,然å�Žå°±å¼€å§‹äº† `service1` 的获å�–æµ�程; +* 5.5.1 `service1`: 获å�– `service1`,从一级缓存中获å�–,获å�–ä¸�到;此时å�‘现 `service1` 正在创建中,于是继续从二ã€�三级缓存中获å�–,最终从三级缓存中获å�–到了,将其放入二级缓存。从三级缓存获å�–的过程中,**会判断 `service1` 是å�¦éœ€è¦�进行 aop,然å�Žå¼€å§‹ aop æ“�作**,因此放入二级缓存中的是 `service1` 代ç�†ä»£ç�†ï¼Œæ��å‰�进行 aop 是解决循环ä¾�赖的关键; +* 5.6 `service2`:得到了 `service1` å�Žï¼ˆè¿™é‡Œçš„ `service1` 是代ç�†å¯¹è±¡ï¼‰ï¼Œå°†å…¶æ³¨å…¥åˆ° `service2` 中,接ç�€å¯¹ `service2` 进行 aop,得到 `service2` 的代ç�†å¯¹è±¡ï¼› +* 5.7 `service2`:如果支æŒ�循环ä¾�赖,先从一ã€�二级缓存中å†�次获å�– `service2`,都未获å�–到,就使用当å‰� `service2`(当å‰� `service2` 是代ç�†å¯¹è±¡)ï¼› +* 5.8 `service2`:将 service2 的代ç�†å¯¹è±¡æ”¾å…¥ä¸€çº§ç¼“存中,删除二ã€�三级缓存,至此,`service2` åˆ�始化完æˆ�,注入的 `service1` 是代ç�†å¯¹è±¡ï¼Œä¸€çº§ç¼“存中的 `service2` 也是代ç�†å¯¹è±¡ï¼› +* 1. `service1`:回到 `service1` 的生命周期,拿到 `service2`(这里的 `service2` 是代ç�†å¯¹è±¡ï¼‰å�Žï¼Œå°†å…¶æ³¨å…¥åˆ° `service1`,`service1` çš„ä¾�赖注入完æˆ�,进行åˆ�始化,这里会判断 `service1` 是å�¦éœ€è¦�进行 aop,虽然 `service1` 是需è¦�进行 aop 的,但由于在 `5.5.1` å·²ç»�进行过 aop 了,因此,这里直接返回(到这一步,`service1` 还是原始对象); +* 1. `service1`:如果支æŒ�循环ä¾�赖,先从一级缓存中获å�– `service1`,获å�–ä¸�到;å†�从二缓存中获å�– `service1`,å�¯ä»¥èŽ·å�–到(从 `5.5.1` å�¯çŸ¥ï¼ŒäºŒçº§ç¼“存里是 `service1` 代ç�†å¯¹è±¡ï¼‰ï¼Œè¿”回; +* 1. `service1`:将二级缓存中获å�–的对象注册到一级缓存中,删除二ã€�三级缓存,至此,`service1` åˆ�始化完æˆ�,注入的 `service2` 是代ç�†å¯¹è±¡ï¼Œä¸€çº§ç¼“存中的 `service1` 也是代ç�†å¯¹è±¡ã€‚ -ÒÔÉÏÁ÷³Ì£¬ËäÈ»²½Öè½Ï¶à£¬µ« `service1` Óë `service2` µÄ»ñÈ¡²½ÖèÊÇÏàͬµÄ£¬Ö»ÒªÅªÇåÁËÆäÖÐÖ®Ò»µÄ»ñÈ¡Á÷³Ì£¬ÁíÒ»¸ö bean µÄ»ñÈ¡Á÷³Ì¾ÍºÜÀ×ͬÁË¡£ +以上æµ�程,虽然步骤较多,但 `service1` 与 `service2` 的获å�–步骤是相å�Œçš„,å�ªè¦�弄清了其中之一的获å�–æµ�程,å�¦ä¸€ä¸ª bean 的获å�–æµ�程就很雷å�Œäº†ã€‚ -ÔÚÉÏÊöÁ÷³ÌÖУ¬»¹ÓÐÁ½¸öÊý¾Ý½á¹¹ÐèҪ˵Ã÷Ï£º +在上述æµ�程中,还有两个数æ�®ç»“构需è¦�说明下: -* `singletonsCurrentlyInCreation`£ºÀàÐÍΪ `SetFromMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry`£¬´´½¨·½Ê½Îª `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`£¬±íÃ÷ÕâÊǸöÓÉ `ConcurrentHashMap` ʵÏÖµÄ set£¬´æ´¢µÄÊÇÕýÔÚ´´½¨ÖеĶÔÏó£¬**Åжϵ±Ç°¶ÔÏóÊÇ·ñÔÚ´´½¨ÖоÍÊÇͨ¹ý²éÕÒµ±Ç°¶ÔÏóÊÇ·ñÔÚÕâ¸ö set ÖÐ**×öµ½µÄ£» -* `earlyProxyReferences`£ºÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `AbstractAutoProxyCreator`£¬´æ´¢µÄÊÇÌáǰ½øÐÐ aop µÄ¶ÔÏó£¬**Èç¹ûÒ»¸ö¶ÔÏóÌáǰ½øÐÐÁË aop£¬ÔÚºóÃæÔÙ´Î aop ʱ£¬»áͨ¹ýÅж϶ÔÏóÊÇ·ñÔÚ `earlyProxyReferences` ÖжøÈ·¶¨Òª²»Òª½øÐÐ aop£¬ÒÔ´ËÀ´±£Ö¤Ã¿¸ö¶ÔÏóÖ»½øÐÐÒ»´Î aop**¡£ +* `singletonsCurrentlyInCreation`:类型为 `SetFromMap`,ä½�于 `DefaultSingletonBeanRegistry`,创建方å¼�为 `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`,表明这是个由 `ConcurrentHashMap` 实现的 set,存储的是正在创建中的对象,**判断当å‰�对象是å�¦åœ¨åˆ›å»ºä¸­å°±æ˜¯é€šè¿‡æŸ¥æ‰¾å½“å‰�对象是å�¦åœ¨è¿™ä¸ª set 中**å�šåˆ°çš„ï¼› +* `earlyProxyReferences`:类型为 `ConcurrentHashMap`,ä½�于 `AbstractAutoProxyCreator`,存储的是æ��å‰�进行 aop 的对象,**如果一个对象æ��å‰�进行了 aop,在å�Žé�¢å†�次 aop 时,会通过判断对象是å�¦åœ¨ `earlyProxyReferences` 中而确定è¦�ä¸�è¦�进行 aop,以此æ�¥ä¿�è¯�æ¯�个对象å�ªè¿›è¡Œä¸€æ¬¡ aop**。 -ÖÁ´Ë£¬spring Ò»¹²ÌṩÁË 5 ¸öÊý¾Ý½á¹¹À´¸¨Öú½â¾öÑ­»·ÒÀÀµÎÊÌ⣬×ܽáÈçÏ£º +至此,spring 一共æ��供了 5 个数æ�®ç»“æž„æ�¥è¾…助解决循环ä¾�赖问题,总结如下: -| ½á¹¹ | ˵Ã÷ | +| 结构 | 说明 | | ------------------------------- | ------------------------------------------------------------ | -| `singletonObjects` | **Ò»¼¶»º´æ**£¬ÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇÍêÕûµÄ `spring bean`£¬¼´Íê³ÉÊôÐÔ×¢Èë¡¢³õʼ»¯µÄ bean£¬Èç¹û bean ÐèÒª aop£¬´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó | -| `earlySingletonObjects` | **¶þ¼¶»º´æ**£¬ÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇʵÀý»¯Íê³É£¬µ«Î´½øÐÐÒÀÀµ×¢ÈëµÄ `bean`£¬**Èç¹û `bean` ÐèÒª `aop`£¬ÕâÀï´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£¬Ö»²»¹ý´úÀí¶ÔÏóËù³ÖÓеÄԭʼ¶ÔÏó²¢Î´½øÐÐÒÀÀµ×¢Èë** | -| `singletonFactories` | **Èý¼¶»º´æ**£¬ÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ´æ´¢µÄÊÇÒ»¸ö `lambda` ±í´ïʽ£º`() -> getEarlyBeanReference(beanName, mbd, bean)`£¬`getEarlyBeanReference(xxx)` ÖÐµÄ `bean` ÊǸմ´½¨Íê³ÉµÄ `java bean`£¬Ã»ÓнøÐÐ spring ÒÀÀµ×¢È룬Ҳû½øÐÐ aop | -| `singletonsCurrentlyInCreation` | ÀàÐÍΪ `SetFromMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry`£¬´´½¨·½Ê½Îª `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`£¬±íÃ÷ÕâÊǸöÓÉ `ConcurrentHashMap` ʵÏÖµÄ set£¬´æ´¢µÄÊÇÕýÔÚ´´½¨ÖеĶÔÏ󣬿ÉÒÔ**ÓÃÀ´Åжϵ±Ç°¶ÔÏóÊÇ·ñÔÚ´´½¨ÖÐ** | -| `earlyProxyReferences` | ÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `AbstractAutoProxyCreator`£¬´æ´¢µÄÊÇÌáǰ½øÐÐ aop µÄ¶ÔÏ󣬿ÉÒÔ**ÓÃÀ´ÅÐ¶Ï bean ÊÇ·ñ½øÐйý aop£¬±£Ö¤Ã¿¸ö¶ÔÏóÖ»½øÐÐÒ»´Î aop** | +| `singletonObjects` | **一级缓存**,类型为 `ConcurrentHashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是完整的 `spring bean`,å�³å®Œæˆ�属性注入ã€�åˆ�始化的 bean,如果 bean 需è¦� aop,存储的就是代ç�†å¯¹è±¡ | +| `earlySingletonObjects` | **二级缓存**,类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是实例化完æˆ�,但未进行ä¾�赖注入的 `bean`,**如果 `bean` 需è¦� `aop`,这里存储的就是代ç�†å¯¹è±¡ï¼Œå�ªä¸�过代ç�†å¯¹è±¡æ‰€æŒ�有的原始对象并未进行ä¾�赖注入** | +| `singletonFactories` | **三级缓存**,类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 存储的是一个 `lambda` 表达å¼�:`() -> getEarlyBeanReference(beanName, mbd, bean)`,`getEarlyBeanReference(xxx)` 中的 `bean` 是刚创建完æˆ�çš„ `java bean`,没有进行 spring ä¾�赖注入,也没进行 aop | +| `singletonsCurrentlyInCreation` | 类型为 `SetFromMap`,ä½�于 `DefaultSingletonBeanRegistry`,创建方å¼�为 `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`,表明这是个由 `ConcurrentHashMap` 实现的 set,存储的是正在创建中的对象,å�¯ä»¥**用æ�¥åˆ¤æ–­å½“å‰�对象是å�¦åœ¨åˆ›å»ºä¸­** | +| `earlyProxyReferences` | 类型为 `ConcurrentHashMap`,ä½�于 `AbstractAutoProxyCreator`,存储的是æ��å‰�进行 aop 的对象,å�¯ä»¥**用æ�¥åˆ¤æ–­ bean 是å�¦è¿›è¡Œè¿‡ aop,ä¿�è¯�æ¯�个对象å�ªè¿›è¡Œä¸€æ¬¡ aop** | -ÒÔÉϾÍÊÇ spring ½â¾öÑ­»·ÒÀÀµµÄÍêÕûÁ÷³ÌÁË¡£ +以上就是 spring 解决循环ä¾�赖的完整æµ�程了。 -### 3\. ´úÂëÄ£Äâ +### 3\. 代ç �模拟 -ÔÚÕýʽ·ÖÎöÔ´Âëǰ£¬ÎÒÃÇÊ×ÏÈÄ£ÄâÑ­»·ÏÂÒÀÀµ½â¾öµÄ¹ý³Ì£¬´úÂëÈçÏ£º +在正å¼�分æž�æº�ç �å‰�,我们首先模拟循环下ä¾�赖解决的过程,代ç �如下: ``` /** - * ×¼±¸Ò»¸öÀ࣬ÄÚ²¿ÓÐÒ»¸öÊôÐÔ Obj2 + * 准备一个类,内部有一个属性 Obj2 */ public class Obj1 { - // ÐèҪעÈë obj2 + // 需è¦�注入 obj2 private Obj2 obj2; - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Ò»¸öÀ࣬ÄÚ²¿ÓÐÒ»¸öÊôÐÔ Obj1 + * 准备一个类,内部有一个属性 Obj1 */ public class Obj2 { - // ÐèҪעÈë ob1 + // 需è¦�注入 ob1 private Obj1 obj1; - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Obj2µÄ´úÀíÀ࣬ÄÚ²¿³ÖÓÐobj2µÄ¶ÔÏó + * 准备Obj2的代ç�†ç±»ï¼Œå†…部æŒ�有obj2的对象 */ public class ProxyObj2 extends Obj2 { - // obj2´úÀíÀàÄÚ²¿³ÖÓÐobj2µÄԭʼ¶ÔÏó + // obj2代ç�†ç±»å†…部æŒ�有obj2的原始对象 private Obj2 obj2; public ProxyObj2(Obj2 obj2) { this.obj2 = obj2; } - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Obj1µÄ´úÀíÀ࣬ÄÚ²¿³ÖÓÐobj1µÄ¶ÔÏó + * 准备Obj1的代ç�†ç±»ï¼Œå†…部æŒ�有obj1的对象 */ public class ProxyObj1 extends Obj1 { - // obj2´úÀíÀàÄÚ²¿³ÖÓÐobj1µÄԭʼ¶ÔÏó + // obj2代ç�†ç±»å†…部æŒ�有obj1的原始对象 private Obj1 obj1; public ProxyObj1(Obj1 obj1) { this.obj1 = obj1; } - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } ``` -* Ê×ÏÈ×¼±¸ÁËÁ½¸öÀࣺ`Obj1` Óë `Obj2`£¬ ÆäÖÐ `Obj1` ÓиöÊôÐÔΪ `Obj2`£¬`Obj2` ÖÐÓиöÊôÐÔΪ `Obj1`£» -* ½Ó×Å×¼±¸ÁË `Obj1` Óë `Obj2` µÄ´úÀíÀà `ProxyObj1`¡¢`ProxyObj2`£¬²¢ÇÒ `ProxyObj1`¡¢`ProxyObj2` ·Ö±ðÓÐÒ»¸öÊôÐÔ£º`Obj1` ¡¢ `Obj2`£» -* ÎÒÃÇÒÀ¾ÉÒÔ `new ObjX()` Ä£Äâ¶ÔÏóµÄ´´½¨£» -* ÎÒÃÇÒÀ¾ÉÒÔ `objX.setObjX(xxx)` Ä£ÄâÒÀÀµ×¢È룻 -* ÎÒÃÇÒÀ¾ÉÒÔ `new ProxyObjX(xxx)` Ä£Äâ´úÀí¶ÔÏóµÄÉú³É£» -* ÎÒÃÇÒÀ¾ÉÒÔ `collection.add(xxx)` Ä£Äâ¶ÔÏóÌí¼Óµ½ÈÝÆ÷ÖеĹý³Ì£» +* 首先准备了两个类:`Obj1` 与 `Obj2`, 其中 `Obj1` 有个属性为 `Obj2`,`Obj2` 中有个属性为 `Obj1`ï¼› +* 接ç�€å‡†å¤‡äº† `Obj1` 与 `Obj2` 的代ç�†ç±» `ProxyObj1`ã€�`ProxyObj2`,并且 `ProxyObj1`ã€�`ProxyObj2` 分别有一个属性:`Obj1` ã€� `Obj2`ï¼› +* 我们ä¾�旧以 `new ObjX()` 模拟对象的创建; +* 我们ä¾�旧以 `objX.setObjX(xxx)` 模拟ä¾�赖注入; +* 我们ä¾�旧以 `new ProxyObjX(xxx)` 模拟代ç�†å¯¹è±¡çš„生æˆ�ï¼› +* 我们ä¾�旧以 `collection.add(xxx)` 模拟对象添加到容器中的过程; -ÎÒÃÇÄ£Äâ×îÖյõ½µÄ½á¹ûΪ£º +我们模拟最终得到的结果为: -* ×îÖÕ·ÅÈëÈÝÆ÷µÄ¶ÔÏó·Ö±ðÊÇ `proxyObj1`£¬`proxyObj2` -* ×¢Èëµ½ `obj1` ÖеÄÊÇ `proxyObj2`£¬×¢Èëµ½ `obj2` ÖеÄÊÇ `proxyObj2` +* 最终放入容器的对象分别是 `proxyObj1`,`proxyObj2` +* 注入到 `obj1` 中的是 `proxyObj2`,注入到 `obj2` 中的是 `proxyObj2` -×¼±¸¹¤×÷ÒѾ­Íê³ÉÁË£¬½ÓÏÂÀ´ÎÒÃǾͿªÊ¼½øÐÐÄ£ÄâÁË¡£ +准备工作已ç»�完æˆ�了,接下æ�¥æˆ‘们就开始进行模拟了。 -#### 3.1 Ä£Äâ 1 +#### 3.1 模拟 1 -ÒªÇó£º +è¦�求: -* Obj1 Óë Obj2 ±ØÐëÑϸñ°´ÕÕ ¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± µÄÁ÷³Ì´´½¨ -* Á½¸ö¶ÔÏóµÄ´´½¨Á÷³Ì¿ÉÒÔ½»Ìæ½øÐÐ +* Obj1 与 Obj2 必须严格按照 “创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� çš„æµ�程创建 +* 两个对象的创建æµ�程å�¯ä»¥äº¤æ›¿è¿›è¡Œ -Ä¿±ê£º +目标: -* ×îÖÕ·ÅÈëÈÝÆ÷µÄ¶ÔÏó·Ö±ðÊÇ `proxyObj1`£¬`proxyObj2` -* ×¢Èëµ½ `obj1` ÖеÄÊÇ `proxyObj2`£¬×¢Èëµ½ `obj2` ÖеÄÊÇ `proxyObj2` +* 最终放入容器的对象分别是 `proxyObj1`,`proxyObj2` +* 注入到 `obj1` 中的是 `proxyObj2`,注入到 `obj2` 中的是 `proxyObj2` -´úÂëÈçÏ£º +代ç �如下: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // 1\. ´´½¨ Obj1 ¶ÔÏó + // 1\. 创建 Obj1 对象 Obj1 obj1 = new Obj1(); - // ½ÓÏÂÀ´ÐèÒª½«obj2µÄ´úÀí¶ÔÏó×¢Èëµ½obj1ÖУ¬µ«´ËʱÈÝÆ÷Öв¢Ã»ÓÐobj2µÄ´úÀí¶ÔÏó£¬ÓÚÊÇÇл»µ½obj2µÄ´´½¨Á÷³Ì - // Ò». ´´½¨ Obj2 ¶ÔÏó + // 接下æ�¥éœ€è¦�å°†obj2的代ç�†å¯¹è±¡æ³¨å…¥åˆ°obj1中,但此时容器中并没有obj2的代ç�†å¯¹è±¡ï¼ŒäºŽæ˜¯åˆ‡æ�¢åˆ°obj2的创建æµ�程 + // 一. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // µ½ÕâÀobj2ÐèҪעÈëobj1µÄ´úÀí¶ÔÏ󣬵«´ËʱÈÝÆ÷Öв¢Ã»ÓÐobj2µÄ´úÀí¶ÔÏó£¬ÓÚÊÇÓÖÒªÇе½obj1µÄ´´½¨Á÷³Ì + // 到这里,obj2需è¦�注入obj1的代ç�†å¯¹è±¡ï¼Œä½†æ­¤æ—¶å®¹å™¨ä¸­å¹¶æ²¡æœ‰obj2的代ç�†å¯¹è±¡ï¼ŒäºŽæ˜¯å�ˆè¦�切到obj1的创建æµ�程 } ``` -ÔÚÖ´ÐÐÒÔÉÏÁ÷³ÌÖÐ £¬·¢ÏÖ´´½¨ Obj2 ¶ÔÏóºó£¬Á÷³Ì¾Í½øÐв»ÏÂÈ¥ÁË£º +在执行以上æµ�程中 ,å�‘现创建 Obj2 对象å�Žï¼Œæµ�程就进行ä¸�下去了: -* `obj1` ÐèҪעÈë `obj2` µÄ´úÀí¶ÔÏ󣬵«ÕÒ²»µ½£¬ÓÚÊÇÇл»µ½ `obj2` µÄ´´½¨Á÷³Ì£» -* `obj2` ÐèҪעÈë `obj1` µÄ´úÀí¶ÔÏ󣬵«ÕÒ²»µ½£¬ÓÚÊÇÇл»µ½ `obj1` µÄ´´½¨Á÷³Ì£» -* `obj1` ÐèҪעÈë `obj2` µÄ´úÀí¶ÔÏ󣬵«ÕÒ²»µ½£¬ÓÚÊÇÇл»µ½ `obj2` µÄ´´½¨Á÷³Ì£» +* `obj1` 需è¦�注入 `obj2` 的代ç�†å¯¹è±¡ï¼Œä½†æ‰¾ä¸�到,于是切æ�¢åˆ° `obj2` 的创建æµ�程; +* `obj2` 需è¦�注入 `obj1` 的代ç�†å¯¹è±¡ï¼Œä½†æ‰¾ä¸�到,于是切æ�¢åˆ° `obj1` 的创建æµ�程; +* `obj1` 需è¦�注入 `obj2` 的代ç�†å¯¹è±¡ï¼Œä½†æ‰¾ä¸�到,于是切æ�¢åˆ° `obj2` 的创建æµ�程; * ... -Èç´ËÑ­»·Íù¸´¡£ +如此循环往å¤�。 -Ä£Äâ½á¹û£ºÎ´´ïµ½Ô¤ÆÚÄ¿±ê£¬±¾´ÎÄ£ÄâÐû¸æÊ§°Ü¡£ +模拟结果:未达到预期目标,本次模拟宣告失败。 -#### 3.1 Ä£Äâ 2 +#### 3.1 模拟 2 -ÒªÇó£º +è¦�求: -* Obj1 Óë Obj2 ±ØÐëÒÔÏÂÁ½ÖÖÁ÷³ÌÖ®Ò»´´½¨£º - * ¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± µÄÁ÷³Ì´´½¨ - * ¡°´´½¨ (ԭʼ¶ÔÏó)--> Éú³É´úÀí¶ÔÏó --> ¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢Èë --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖС± µÄÁ÷³Ì´´½¨ -* Á½¸ö¶ÔÏóµÄ´´½¨Á÷³Ì¿ÉÒÔ½»Ìæ½øÐÐ +* Obj1 与 Obj2 必须以下两ç§�æµ�程之一创建: + * “创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� çš„æµ�程创建 + * “创建 (原始对象)--> 生æˆ�代ç�†å¯¹è±¡ --> 对原始对象进行属性注入 --> 将代ç�†å¯¹è±¡ä¿�存到容器中â€� çš„æµ�程创建 +* 两个对象的创建æµ�程å�¯ä»¥äº¤æ›¿è¿›è¡Œ -Ä¿±ê£º +目标: -* ×îÖÕ·ÅÈëÈÝÆ÷µÄ¶ÔÏó·Ö±ðÊÇ `proxyObj1`£¬`proxyObj2` -* ×¢Èëµ½ `obj1` ÖеÄÊÇ `proxyObj2`£¬×¢Èëµ½ `obj2` ÖеÄÊÇ `proxyObj2`### 1\. ʲôÊÇÑ­»·ÒÀÀµ£¿ +* 最终放入容器的对象分别是 `proxyObj1`,`proxyObj2` +* 注入到 `obj1` 中的是 `proxyObj2`,注入到 `obj2` 中的是 `proxyObj2`### 1\. 什么是循环ä¾�赖? -spring ÔÚÒÀÀµ×¢Èëʱ£¬¿ÉÄÜ»á³öÏÖÏ໥עÈëµÄÇé¿ö£º +spring 在ä¾�赖注入时,å�¯èƒ½ä¼šå‡ºçŽ°ç›¸äº’æ³¨å…¥çš„æƒ…å†µï¼š ``` @Service @@ -509,15 +509,15 @@ public class Service2 { ``` -ÈçÒÔÉÏ´úÂ룬ÔÚ `Service1` ÖÐͨ¹ý `@Autowird` ×¢ÈëÁË `Service2`£¬ÔÚ `Service2` ÖÐͨ¹ý `@Autowird` ×¢ÈëÁË `Service1`£¬ÕâÖÖÏ໥עÈëµÄÇé¿ö£¬¾Í½Ð×öÑ­»·ÒÀÀµ¡£ +如以上代ç �,在 `Service1` 中通过 `@Autowird` 注入了 `Service2`,在 `Service2` 中通过 `@Autowird` 注入了 `Service1`,这ç§�相互注入的情况,就å�«å�šå¾ªçޝä¾�赖。 -### 2\. Ñ­»·ÒÀÀµ»áÓÐʲôÎÊÌâ +### 2\. 循环ä¾�赖会有什么问题 -ʵ¼ÊÉÏ£¬ÕâÖÖ `A³ÖÓÐB¶ÔÏó£¬BÒ²³ÖÓÐA¶ÔÏó`µÄÇé¿ö£¬java ´úÂëÊÇÍêȫ֧³ÖµÄ£º +实际上,这ç§� `AæŒ�有B对象,B也æŒ�有A对象`的情况,java 代ç �是完全支æŒ�的: ``` /** - * ×¼±¸service1 + * 准备service1 */ public class Service1 { private Service2 service2; @@ -532,7 +532,7 @@ public class Service1 { } /** - * ×¼±¸service2 + * 准备service2 */ public class Service2 { private Service1 service1; @@ -547,14 +547,14 @@ public class Service2 { } /** - * Ö÷·½·¨Öе÷Óà + * 主方法中调用 */ public class Main { public void main(String[] args) { - // ×¼±¸Á½¸ö¶ÔÏó + // 准备两个对象 Service1 service1 = new Service1(); Service2 service2 = new Service2(); - // Ï໥ÉèÖà + // 相互设置 service1.setService2(service2); service2.setService1(service1); } @@ -562,78 +562,78 @@ public class Main { ``` -ÄÇô£¬ÔÚ spring ÖУ¬Á½¸öÀàÏ໥עÈë¶Ô·½ÊµÀýµÄÇé¿ö£¬»áÓÐʲôÎÊÌâÄØ£¿ÎÒÃÇÀ´¿´ `spring bean` µÄ´´½¨¹ý³Ì£¨**×¢Ò⣺ÕâÀïÎÒÃǽö·ÖÎö `bean` µÄ `scope` Ϊ `singleton` µÄÇé¿ö£¬Ò²¾ÍÊÇ `scope` Ϊ`µ¥Àý`µÄÇé¿ö**£©£º +那么,在 spring 中,两个类相互注入对方实例的情况,会有什么问题呢?我们æ�¥çœ‹ `spring bean` 的创建过程(**注æ„�:这里我们仅分æž� `bean` çš„ `scope` 为 `singleton` 的情况,也就是 `scope` 为`å�•例`的情况**): ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-ca36e17077b1b191834645b3c8e588ff6c4.png) -Õâ¸ö¹ý³ÌÖÐÓм¸µãÐèҪ˵Ã÷Ï£º +这个过程中有几点需è¦�说明下: -1. ´´½¨¶ÔÏó£ºÕâ¸öÆäʵ¾ÍÊÇʹÓà jdk ÌṩµÄ·´Éä»úÖÆ´´½¨ java ¶ÔÏó£¬ÒÔµÚ 1 ½ÚÌáµ½µÄ `Service1` ΪÀý£¬¿É¼òµ¥Àí½âΪ `Service1 service = new Service1()`£» -2. ×¢ÈëÒÀÀµ¶ÔÏ󣺻¹ÊÇÒÔµÚ 1 ½ÚÌáµ½µÄ `Service1` ΪÀý£¬`Service1` ÖÐͨ¹ý `@Autowired` ×Ô¶¯×¢Èë `Service2`£¬ÕâÒ»²½¾ÍÊǸø `Service2` ¸³ÖµµÄ¹ý³Ì£¬¿É¼òµ¥Àí½âΪ `service1.setService2(service2)`£» -3. `singletonObjects`£º¾­¹ýÉÏÃæÁ½²½ºó£¬Ò»¸ö java ¶ÔÏó¾Í±ä³ÉÁËÒ»¸ö spring bean£¬È»ºó±£´æµ½ `singletonObjects` ÁË£¬ÕâÊǸö `map`£¬`key` ÊÇ bean µÄÃû³Æ£¬`value` ÊÇ bean£¬ËüÖ»±£´æ `spring bean`£¬²»»áÖ»ÔÚ java ʵÀý¡£ +1. 创建对象:这个其实就是使用 jdk æ��供的å��射机制创建 java 对象,以第 1 节æ��到的 `Service1` 为例,å�¯ç®€å�•ç�†è§£ä¸º `Service1 service = new Service1()`ï¼› +2. 注入ä¾�赖对象:还是以第 1 节æ��到的 `Service1` 为例,`Service1` 中通过 `@Autowired` 自动注入 `Service2`,这一步就是给 `Service2` 赋值的过程,å�¯ç®€å�•ç�†è§£ä¸º `service1.setService2(service2)`ï¼› +3. `singletonObjects`:ç»�过上é�¢ä¸¤æ­¥å�Žï¼Œä¸€ä¸ª java 对象就å�˜æˆ�了一个 spring bean,然å�Žä¿�存到 `singletonObjects` 了,这是个 `map`,`key` 是 bean çš„å��称,`value` 是 bean,它å�ªä¿�å­˜ `spring bean`,ä¸�会å�ªåœ¨ java 实例。 -ʵ¼ÊÉÏ£¬`java` ¶ÔÏó±ä³É `spring bean`£¬²»½ö½öÖ»ÊÇÒÀÀµ×¢È룬»¹Óгõʼ»¯¡¢Ö´ÐÐ `beanPorcessor` ·½·¨µÈ£¬**ÓÉÓÚ±¾ÎÄÊÇ·ÖÎö `spring bean` µÄÑ­»·ÒÀÀµµÄ£¬Òò´ËÎÒÃÇÖØµã¹Ø×¢ÓëÑ­»·ÒÀÀµÏà¹ØµÄ²½Öè¡£** +实际上,`java` 对象å�˜æˆ� `spring bean`,ä¸�ä»…ä»…å�ªæ˜¯ä¾�赖注入,还有åˆ�始化ã€�执行 `beanPorcessor` 方法等,**由于本文是分æž� `spring bean` 的循环ä¾�赖的,因此我们é‡�点关注与循环ä¾�赖相关的步骤。** -#### 2.1 Ñ­»·ÒÀÀµ²úÉúµÄÎÊÌâ +#### 2.1 循环ä¾�赖产生的问题 -Á˽âÁË spring bean µÄ²úÉú¹ý³ÌÖ®ºó£¬½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÏÂÑ­»·ÒÀÀµ²úÉúµÄÎÊÌ⣬ÔÚÕýʽ·ÖÎöǰ£¬ÎÒÃÇÏÈÀ´Ã÷È·Á½¸ö¸ÅÄ +了解了 spring bean 的产生过程之å�Žï¼ŒæŽ¥ä¸‹æ�¥æˆ‘们就æ�¥åˆ†æž�下循环ä¾�赖产生的问题,在正å¼�分æž�å‰�,我们先æ�¥æ˜Žç¡®ä¸¤ä¸ªæ¦‚念: -* `java¶ÔÏó`£ºÊµ¼ÊÉÏ£¬java ÖÐÒ»ÇжÔÏ󶼿ÉÒÔ³ÆÖ®Îª `java` ¶ÔÏó£¬ÎªÁË˵Ã÷·½±ã£¬ÒÔÏÂÌáµ½µÄ `java¶ÔÏó`½öָʵÀý»¯Íê³É¡¢µ«Î´½øÐÐ spring bean µÄÉúÃüÖÜÆÚ¶ÔÏó£» -* `spring bean`£ºÊÇÒ»¸ö java ¶ÔÏ󣬲¢ÇÒ½øÐÐÁËÍêÕûµÄ spring bean µÄÉúÃüÖÜÆÚ¶ÔÏó£» +* `java对象`:实际上,java 中一切对象都å�¯ä»¥ç§°ä¹‹ä¸º `java` 对象,为了说明方便,以下æ��到的 `java对象`仅指实例化完æˆ�ã€�但未进行 spring bean 的生命周期对象; +* `spring bean`:是一个 java 对象,并且进行了完整的 spring bean 的生命周期对象; -spring bean µÄ´´½¨¹ý³ÌÈçÏ£º +spring bean 的创建过程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b55a211447b5fabeaa0c3ef0bfee0920c82.png) -¶ÔÉÏͼ˵Ã÷ÈçÏ£º +对上图说明如下: -1. ÔÚ `service1` ¶ÔÏó´´½¨Íê³Éºó£¬`spring` ·¢ÏÖ `service1` ÐèҪעÈë `service2`£¬È»ºó¾ÍÈ¥ `singletonObjects` ÖвéÕÒ `service2`£¬´ËʱÊÇÕÒ²»µ½ `service2`£¬È»ºó¾Í¿ªÊ¼ÁË `service2` µÄ´´½¨¹ý³Ì£» -2. ÔÚ `service2` ¶ÔÏó´´½¨Íê³Éºó£¬`spring` ·¢ÏÖ `service2` ÐèҪעÈë `service1`£¬È»ºó¾ÍÈ¥ `singletonObjects` ÖвéÕÒ `service1`£¬´ËʱÊÇÕÒ²»µ½ `service1`£¬ÒòΪµÚÒ»²½ÖÐ `service1` ²¢Ã»Óд´½¨³É¹¦ £¬È»ºó¾Í¿ªÊ¼ÁË `service1` µÄ´´½¨¹ý³Ì£» -3. Á÷³ÌÌø»Øµ½ `1`£¬ÔٴοªÊ¼ÁË `service1` µÄ´´½¨¡¢ÊôÐÔ×¢Èë¹ý³Ì¡£ +1. 在 `service1` 对象创建完æˆ�å�Žï¼Œ`spring` å�‘现 `service1` 需è¦�注入 `service2`,然å�Žå°±åŽ» `singletonObjects` 中查找 `service2`,此时是找ä¸�到 `service2`,然å�Žå°±å¼€å§‹äº† `service2` 的创建过程; +2. 在 `service2` 对象创建完æˆ�å�Žï¼Œ`spring` å�‘现 `service2` 需è¦�注入 `service1`,然å�Žå°±åŽ» `singletonObjects` 中查找 `service1`,此时是找ä¸�到 `service1`,因为第一步中 `service1` 并没有创建æˆ�功 ,然å�Žå°±å¼€å§‹äº† `service1` 的创建过程; +3. æµ�程跳回到 `1`,å†�次开始了 `service1` 的创建ã€�属性注入过程。 -µ½ÕâÀÎÒÃǾªÏ²µØ·¢ÏÖ£¬Ñ­»·³öÏÖÁË£¡ +到这里,我们惊喜地å�‘现,循环出现了ï¼� -#### 2.2 ÒýÈë `earlySingletonObjects` ½â¾öÑ­»·ÒÀÀµ +#### 2.2 引入 `earlySingletonObjects` 解决循环ä¾�èµ– -ÎÒÃÇ·ÖÎöÏ£¬Ñ­»·³öÏÖµÄÔ­ÒòÔÚÓÚ£¬ÔÚ `service2` »ñÈ¡ `service1` ʱ£¬ÓÉÓÚ `singletonObjects` ÖдËʱ²¢²»´æÔÚ `service1`£¬Òò´Ë»áÔÙ×ß `service1` µÄ´´½¨¹ý³Ì£¬ÖØÐ´´½¨ `service1`£¬Òò´Ë£¬ÎÒÃÇÓиö´óµ¨µÄÏë·¨£ºÈç¹ûÔÚ `service1` ʵÀý»¯ºó¾Í°ÑËü±£´æÆðÀ´£¬ºóÃæÔÙÔÙÕÒ `service1` ʱ£¬¾Í·µ»ØÕâ¸öδ½øÐÐÒÀÀµ×¢ÈëµÄ `service1`£¬ÏñÏÂÃæÕâÑù£º +我们分æž�下,循环出现的原因在于,在 `service2` 获å�– `service1` 时,由于 `singletonObjects` 中此时并ä¸�存在 `service1`,因此会å†�èµ° `service1` 的创建过程,é‡�新创建 `service1`,因此,我们有个大胆的想法:如果在 `service1` 实例化å�Žå°±æŠŠå®ƒä¿�存起æ�¥ï¼Œå�Žé�¢å†�å†�找 `service1` 时,就返回这个未进行ä¾�赖注入的 `service1`,åƒ�下é�¢è¿™æ ·ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-c0eaecbe82b144a6fcd9fd048f2cca53497.png) -ÉÏͼÖУ¬ÒýÈëÁË `earlySingletonObjects`£¬ÕâÒ²ÊǸö map£¬Í¬ `singletonObjects` Ò»Ñù£¬`key` ÊÇ bean µÄÃû³Æ£¬`value` ÊÇÒ»¸öδÍê³ÉÒÀÀµ×¢ÈëµÄ¶ÔÏó¡£ +上图中,引入了 `earlySingletonObjects`,这也是个 map,å�Œ `singletonObjects` 一样,`key` 是 bean çš„å��称,`value` 是一个未完æˆ�ä¾�赖注入的对象。 -¶ÔÉÏͼ˵Ã÷ÈçÏ£º +对上图说明如下: -1. ÔÚ `service1` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service1` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -2. ¶Ô `service1` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service1` ÐèҪעÈë `service2`£¬È»ºóÏÈÈ¥ `earlySingletonObjects` ²éÕÒ `service2`£¬Î´ÕÒµ½£»ÔÙÈ¥ `singletonObjects` ÖвéÕÒ `service2`£¬»¹ÊÇδÕÒµ½£¬ÓÚÊǾͿªÊ¼ÁË `service2` µÄ´´½¨¹ý³Ì£» -3. ÔÚ `service2` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service2` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -4. ¶Ô `service2` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service2` ÐèҪעÈë `service1`£¬È»ºó¾ÍÈ¥ `earlySingletonObjects` ²éÕÒ `service1`£¬ÕÒµ½ÁË£¬¾Í½« `service1` ×¢Èëµ½ `service2` ÖУ¬´Ëʱ `service2` ¾ÍÊÇÒ»¸ö `spring bean` ÁË£¬½«Æä±£´æµ½ `singletonObjects` ÖУ» -5. ¾­¹ýµÚ 4 ²½ºó£¬ÎÒÃǵõ½ÁË `service2`£¬È»ºó½«Æä×¢Èëµ½ `service1` ÖУ¬´Ëʱ `service1` Ò²³ÉÁËÒ»¸ö `spring bean`£¬½«Æä±£´æµ½ `singletonObjects` ÖС£ +1. 在 `service1` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service1` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +2. 对 `service1` 进行ä¾�赖注入时,`spring` å�‘现 `service1` 需è¦�注入 `service2`,然å�Žå…ˆåŽ» `earlySingletonObjects` 查找 `service2`,未找到;å†�去 `singletonObjects` 中查找 `service2`,还是未找到,于是就开始了 `service2` 的创建过程; +3. 在 `service2` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service2` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +4. 对 `service2` 进行ä¾�赖注入时,`spring` å�‘现 `service2` 需è¦�注入 `service1`,然å�Žå°±åŽ» `earlySingletonObjects` 查找 `service1`,找到了,就将 `service1` 注入到 `service2` 中,此时 `service2` 就是一个 `spring bean` 了,将其ä¿�存到 `singletonObjects` 中; +5. ç»�过第 4 æ­¥å�Žï¼Œæˆ‘们得到了 `service2`,然å�Žå°†å…¶æ³¨å…¥åˆ° `service1` 中,此时 `service1` 也æˆ�了一个 `spring bean`,将其ä¿�存到 `singletonObjects` 中。 -¾­¹ýÒÔÉϲ½Ö裬ÎÒÃÇ·¢ÏÖ£¬Ñ­»·ÒÀÀµµÃµ½Á˽â¾ö¡£ +ç»�过以上步骤,我们å�‘现,循环ä¾�赖得到了解决。 -#### 2.2 aop ϵÄÑ­»·ÒÀÀµ +#### 2.2 aop 下的循环ä¾�èµ– -¾­¹ýÉÏÃæµÄ·ÖÎö£¬ÎÒÃÇ·¢ÏÖÖ»Òª¶îÍâÒýÈëÒ»¸ö `earlySingletonObjects` ºó£¬Ñ­»·ÒÀÀµ¾ÍÄܵõ½½â¾ö¡£µ«ÊÇ£¬Ñ­»·ÒÀÀµÕæµÄµÃµ½Á˽â¾öÂð£¿spring ³ýÁË ioc Í⣬»¹ÓÐÁíÒ»¸öÖØ´ó¹¦ÄÜ£ºaop£¬ÎÒÃÇÀ´¿´¿´ aop Çé¿öϳöÏÖÑ­»·ÒÀÀµ»áÔõÑù¡£ +ç»�过上é�¢çš„分æž�,我们å�‘现å�ªè¦�é¢�外引入一个 `earlySingletonObjects` å�Žï¼Œå¾ªçޝä¾�赖就能得到解决。但是,循环ä¾�赖真的得到了解决å�—?spring 除了 ioc 外,还有å�¦ä¸€ä¸ªé‡�大功能:aop,我们æ�¥çœ‹çœ‹ aop 情况下出现循环ä¾�赖会怎样。 -##### 1\. aop ¶ÔÏóµÄ´´½¨¹ý³Ì +##### 1\. aop 对象的创建过程 -ÔÚÕýʽ½éÉÜ aop ϵÄÑ­»·ÒÀÀµÇ°£¬ÎÒÃÇÏÈÀ´Ã÷È·Á½¸ö¸ö¸ÅÄ +在正å¼�介ç»� aop 下的循环ä¾�èµ–å‰�,我们先æ�¥æ˜Žç¡®ä¸¤ä¸ªä¸ªæ¦‚念: -* `ԭʼ¶ÔÏó`£ºÇø±ðÓÚ´úÀí¶ÔÏó£¬Ö¸Î´½øÐйý aop µÄ¶ÔÏ󣬿ÉÒÔÊÇ java ¶ÔÏó£¬Ò²¿ÉÒÔÊÇδ½øÐÐ aop µÄ spring bean£» -* `´úÀí¶ÔÏó`£º½øÐйý aop µÄ¶ÔÏ󣬿ÉÒÔÊÇ java ¶ÔÏó½ö½øÐйý aop µÃµ½µÄ¶ÔÏó (½ö½øÐйý aop£¬Î´½øÐÐÒÀÀµ×¢È룬Ҳδ½øÐгõʼ»¯)£¬Ò²¿ÉÒÔÊǽøÐйý aop µÄ `spring bean`. +* `原始对象`:区别于代ç�†å¯¹è±¡ï¼ŒæŒ‡æœªè¿›è¡Œè¿‡ aop 的对象,å�¯ä»¥æ˜¯ java 对象,也å�¯ä»¥æ˜¯æœªè¿›è¡Œ aop çš„ spring beanï¼› +* `代ç�†å¯¹è±¡`:进行过 aop 的对象,å�¯ä»¥æ˜¯ java 对象仅进行过 aop 得到的对象 (仅进行过 aop,未进行ä¾�赖注入,也未进行åˆ�始化),也å�¯ä»¥æ˜¯è¿›è¡Œè¿‡ aop çš„ `spring bean`. -ÎÒÃÇÏÈÀ´¿´¿´ aop ÊÇÈçºÎ´´½¨¶ÔÏóµÄ£º +我们先æ�¥çœ‹çœ‹ aop 是如何创建对象的: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-e92991c1c173bbd5579be3001a977555be7.png) -Ïà±ÈÓÚ `2.1` ÖеÄÁ÷³Ì£¬aop ¶àÁË "Éú³É´úÀí¶ÔÏó" µÄ²Ù×÷£¬²¢ÇÒ×îÖÕ±£´æµ½ `singletonObjects` ÖеĶÔÏóÒ²ÊÇ´úÀí¶ÔÏó¡£ +相比于 `2.1` 中的æµ�程,aop 多了 "生æˆ�代ç�†å¯¹è±¡" çš„æ“�作,并且最终ä¿�存到 `singletonObjects` 中的对象也是代ç�†å¯¹è±¡ã€‚ -ԭʼ¶ÔÏóÓë´úÀí¶ÔÏóÖ®¼äÊÇʲô¹ØÏµÄØ£¿ÓôúÂëʾÒâÏ£¬´óÖÂÈçÏ£º +原始对象与代ç�†å¯¹è±¡ä¹‹é—´æ˜¯ä»€ä¹ˆå…³ç³»å‘¢ï¼Ÿç”¨ä»£ç �示æ„�下,大致如下: ``` public class ProxyObj extends Obj { - // ԭʼ¶ÔÏó + // 原始对象 private Obj obj; ... @@ -641,34 +641,34 @@ public class ProxyObj extends Obj { ``` -ʵ¼ÊÉÏ£¬Á½ÕßÖ®¼äµÄ¹ØÏµ²¢Ã»ÓÐÕâô¼òµ¥£¬µ«ÎªÁË˵Ã÷ÎÊÌ⣬ÕâÀï¶ÔÁ½Õß¹ØÏµ×öÁ˼ò»¯£¬Ð¡»ï°éÃÇÖ»ÐèÒªÃ÷°×£¬**´úÀí¶ÔÏó³ÖÓÐԭʼ¶ÔÏóµÄÒýÓÃ**¼´¿É¡£ +实际上,两者之间的关系并没有这么简å�•,但为了说明问题,这里对两者关系å�šäº†ç®€åŒ–,å°�伙伴们å�ªéœ€è¦�明白,**代ç�†å¯¹è±¡æŒ�有原始对象的引用**å�³å�¯ã€‚ -¹ØÓÚԭʼ¶ÔÏóÈçºÎ±ä³É´úÀí¶ÔÏóµÄ£¬¿ÉÒԲο¼ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)¡£ +关于原始对象如何å�˜æˆ�代ç�†å¯¹è±¡çš„,å�¯ä»¥å�‚考 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961)。 -¶ÔÒÔÉÏ´´½¨¹ý³Ì£¬Óà java ´úÂëÄ£ÄâÈçÏ£º +对以上创建过程,用 java 代ç �模拟如下: ``` /** - * ×¼±¸Ò»¸öÀà + * 准备一个类 */ public class Obj1 { } /** - * ×¼±¸Ò»¸öÀ࣬ÄÚ²¿ÓÐÒ»¸öÊôÐÔ Obj1 + * 准备一个类,内部有一个属性 Obj1 */ public class Obj2 { private Obj1 obj1; - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Obj2µÄ´úÀíÀ࣬ÄÚ²¿³ÖÓÐobj2µÄ¶ÔÏó + * 准备Obj2的代ç�†ç±»ï¼Œå†…部æŒ�有obj2的对象 */ public class ProxyObj2 extends Obj2 { @@ -678,414 +678,414 @@ public class ProxyObj2 extends Obj2 { this.obj2 = obj2; } - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } ``` -½Ó×Å£¬¾ÍÊÇÄ£Äâ ¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± µÄ Á÷³ÌÁË£º +接ç�€ï¼Œå°±æ˜¯æ¨¡æ‹Ÿ “创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� çš„ æµ�程了: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // ¿ªÊ¼ Obj2 µÄ´´½¨Á÷³Ì - // 1\. ´´½¨ Obj2 ¶ÔÏó + // 开始 Obj2 的创建æµ�程 + // 1\. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // 2\. Íù Obj2 ÖÐ×¢Èë obj1£¬µ«´Ëʱ²¢Ã»ÓÐobj1£¬Òò´ËÏÈÒª´´½¨obj1£¬ÔÙ½«Æä×¢Èëµ½Obj2ÖÐ + // 2\. å¾€ Obj2 中注入 obj1,但此时并没有obj1,因此先è¦�创建obj1,å†�将其注入到Obj2中 Obj1 obj1 = new Obj1(); obj2.setObj1(obj1); - // 3\. Éú³ÉObj2µÄ´úÀí¶ÔÏ󣬴úÀí¶ÔÏóÖгÖÓÐ Obj2µÄԭʼ¶ÔÏó + // 3\. 生æˆ�Obj2的代ç�†å¯¹è±¡ï¼Œä»£ç�†å¯¹è±¡ä¸­æŒ�有 Obj2的原始对象 ProxyObj2 proxyObj2 = new ProxyObj2(obj2); - // 4\. proxyObj2ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // 4\. proxyObj2å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj2); } ``` -ÉÏÊö´úÂëÖУ¬ +上述代ç �中, -* ÒÔ `new Obj2()` Ä£Äâ¶ÔÏóµÄ´´½¨ -* ÒÔ `obj2.setObj1(xxx)` Ä£ÄâÒÀÀµ×¢Èë -* ÒÔ `new ProxyObj2(xxx)` Ä£Äâ´úÀí¶ÔÏóµÄÉú³É -* ÒÔ `collection.add(xxx)` Ä£Äâ¶ÔÏóÌí¼Óµ½ÈÝÆ÷ÖеĹý³Ì +* 以 `new Obj2()` 模拟对象的创建 +* 以 `obj2.setObj1(xxx)` 模拟ä¾�赖注入 +* 以 `new ProxyObj2(xxx)` 模拟代ç�†å¯¹è±¡çš„生æˆ� +* 以 `collection.add(xxx)` 模拟对象添加到容器中的过程 -Ä£ÄâµÄÁ÷³ÌÈçÏ£º +模拟的æµ�程如下: -1. ´´½¨ `obj2` ¶ÔÏó -2. Íù `Obj2` ÖÐ×¢Èë `obj1`£¬µ«´Ëʱ²¢Ã»ÓÐ `obj1`£¬Òò´ËÏÈÒª´´½¨ `obj1`£¬ÔÙ½«Æä×¢Èëµ½ `Obj2` ÖÐ -3. Éú³É `Obj2` µÄ´úÀí¶ÔÏó `proxyObj2`£¬`proxyObj2` ÖгÖÓÐ `Obj2` µÄԭʼ¶ÔÏó -4. `proxyObj2` ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ +1. 创建 `obj2` 对象 +2. å¾€ `Obj2` 中注入 `obj1`,但此时并没有 `obj1`,因此先è¦�创建 `obj1`,å†�将其注入到 `Obj2` 中 +3. 生æˆ� `Obj2` 的代ç�†å¯¹è±¡ `proxyObj2`,`proxyObj2` 中æŒ�有 `Obj2` 的原始对象 +4. `proxyObj2` å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ -×Ðϸ·ÖÎöÉÏÃæµÄ²½Ö裬¾Í»á·¢ÏÖ£¬ÉÏÃæµÄµÚ 2 ²½ÓëµÚ 3 ²½ÍêÈ«µ÷»»Ë³ÐòҲûÎÊÌ⣬´úÂëÄ£ÄâÈçÏ£º +仔细分æž�上é�¢çš„æ­¥éª¤ï¼Œå°±ä¼šå�‘现,上é�¢çš„第 2 步与第 3 步完全调æ�¢é¡ºåº�也没问题,代ç �模拟如下: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // ¿ªÊ¼ Obj2 µÄ´´½¨Á÷³Ì - // 1\. ´´½¨ Obj2 ¶ÔÏó + // 开始 Obj2 的创建æµ�程 + // 1\. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // 2\. Éú³ÉObj2µÄ´úÀí¶ÔÏ󣬴úÀí¶ÔÏóÖгÖÓÐ Obj2µÄԭʼ¶ÔÏó + // 2\. 生æˆ�Obj2的代ç�†å¯¹è±¡ï¼Œä»£ç�†å¯¹è±¡ä¸­æŒ�有 Obj2的原始对象 ProxyObj2 proxyObj2 = new ProxyObj2(obj2); - // 3\. Íù obj2 ÖÐ×¢Èë obj1£¬µ«´Ëʱ²¢Ã»ÓÐobj1£¬Òò´ËÏÈÒª´´½¨obj1£¬ÔÙ½«Æä×¢Èëµ½Obj2ÖÐ + // 3\. å¾€ obj2 中注入 obj1,但此时并没有obj1,因此先è¦�创建obj1,å†�将其注入到Obj2中 Obj1 obj1 = new Obj1(); - // ÕâÀïÊÇ×¢È뵽ԭʼ¶ÔÏóÖÐ + // 这里是注入到原始对象中 obj2.setObj1(obj1); - // 4\. proxyObj2ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // 4\. proxyObj2å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj2); } ``` -ÉÏÊö´úÂëµÄÁ÷³ÌÈçÏ£º +上述代ç �çš„æµ�程如下: -1. ´´½¨ obj2 ¶ÔÏó -2. Éú³É Obj2 µÄ´úÀí¶ÔÏ󣬴úÀí¶ÔÏóÖгÖÓÐ Obj2 µÄԭʼ¶ÔÏó -3. Íù Obj2 ÖÐ×¢Èë obj1£¬µ«´Ëʱ²¢Ã»ÓÐ obj1£¬Òò´ËÏÈÒª´´½¨ obj1£¬ÔÙ½«Æä×¢Èëµ½ Obj2 -4. proxyObj2 ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬Òò´Ë½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ +1. 创建 obj2 对象 +2. 生æˆ� Obj2 的代ç�†å¯¹è±¡ï¼Œä»£ç�†å¯¹è±¡ä¸­æŒ�有 Obj2 的原始对象 +3. å¾€ Obj2 中注入 obj1,但此时并没有 obj1,因此先è¦�创建 obj1,å†�将其注入到 Obj2 +4. proxyObj2 å·²ç»�走完了完整的生命周期,因此将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ -´Ó´úÂëÉÏ¿´£¬`proxyObj2(´úÀí¶ÔÏó)` ÖгÖÓÐ `ob2(ԭʼ¶ÔÏó)`£¬Éú³É´úÀí¶ÔÏóºó£¬¼ÌÐø¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢È룬ÒÀÈ»ÄÜÓ°Ïì´úÀí¶ÔÏó£¬×îÖÕ´úÀí¶ÔÏó³ÖÓеÄԭʼ¶ÔÏóÒ²Íê³ÉÁËÒÀÀµ×¢È룬Õû¸ö¹ý³ÌÓÃͼÐÎʾÒâÈçÏ£º +从代ç �上看,`proxyObj2(代ç�†å¯¹è±¡)` 中æŒ�有 `ob2(原始对象)`,生æˆ�代ç�†å¯¹è±¡å�Žï¼Œç»§ç»­å¯¹åŽŸå§‹å¯¹è±¡è¿›è¡Œå±žæ€§æ³¨å…¥ï¼Œä¾�然能影å“�代ç�†å¯¹è±¡ï¼Œæœ€ç»ˆä»£ç�†å¯¹è±¡æŒ�有的原始对象也完æˆ�了ä¾�赖注入,整个过程用图形示æ„�如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8ff5579425f73dd5c2d321a86d0303390ac.png) -ÕâÀïÎÒÃÇÔÙ´ÎÉêÃ÷£¬´Ó java ¶ÔÏóµ½ spring bean µÄ²½ÖèÓкö࣬ÕâÀïÎÒÃǽö¹Ø×¢ÓëÑ­»·ÒÀÀµÏà¹ØµÄ²½Ö裬Èç¹ûÏëÁ˽â spring bean ÏêϸµÄ³õʼ»¯¹ý³Ì£¬¿É²é¿´ [spring Æô¶¯Á÷³ÌÖ®Æô¶¯Á÷³Ì¸ÅÀÀ](https://my.oschina.net/funcy/blog/4597493)¡£ +这里我们å†�次申明,从 java 对象到 spring bean 的步骤有好多,这里我们仅关注与循环ä¾�赖相关的步骤,如果想了解 spring bean 详细的åˆ�始化过程,å�¯æŸ¥çœ‹ [spring å�¯åЍæµ�程之å�¯åЍæµ�程概览](https://my.oschina.net/funcy/blog/4597493)。 -µ½ÕâÀÎÒÃÇ̽Ë÷µ½´úÀí¶ÔÏóµÄÉúÃüÖÜÆÚ¿ÉÒÔÓÐÁ½ÖÖ£º +到这里,我们探索到代ç�†å¯¹è±¡çš„生命周期å�¯ä»¥æœ‰ä¸¤ç§�: -* ´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖÐ -* ´´½¨ (ԭʼ¶ÔÏó)--> Éú³É´úÀí¶ÔÏó (Ìáǰ½øÐÐ aop)--> ¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢Èë --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖÐ +* 创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> 将代ç�†å¯¹è±¡ä¿�存到容器中 +* 创建 (原始对象)--> 生æˆ�代ç�†å¯¹è±¡ (æ��å‰�进行 aop)--> 对原始对象进行属性注入 --> 将代ç�†å¯¹è±¡ä¿�存到容器中 -ÕâÁ½ÖÖ¶¼ÄÜ´ïµ½×îÖÕÄ¿µÄ£¬¼´**±£´æµ½ÈÝÆ÷ÖеÄÊÇ´úÀí¶ÔÏó£¬ÇÒ´úÀí¶ÔÏó¶ÔÓ¦µÄԭʼ¶ÔÏóÍê³ÉÁËÒÀÀµ×¢Èë**¡£ÇëÀμÇÕâÁ½¸ö´´½¨Á÷³Ì£¬ÕâÊǺóÃæ½â¾ö aop ÏÂÑ­»·ÒÀÀµÎÊÌâµÄºËÐÄ£¬Ëµ°×ÁË£¬**aop ϵÄÑ­»·ÒÀÀµÎÊÌâÖ®ËùÒÔÄܽâ¾ö£¬¾ÍÊÇÒòΪ¶ÔÏó¿ÉÒÔÌáǰ½øÐÐ aop ²Ù×÷**¡£ +这两ç§�都能达到最终目的,å�³**ä¿�存到容器中的是代ç�†å¯¹è±¡ï¼Œä¸”代ç�†å¯¹è±¡å¯¹åº”的原始对象完æˆ�了ä¾�赖注入**。请牢记这两个创建æµ�程,这是å�Žé�¢è§£å†³ aop 下循环ä¾�赖问题的核心,说白了,**aop 下的循环ä¾�赖问题之所以能解决,就是因为对象å�¯ä»¥æ��å‰�进行 aop æ“�作**。 -##### 2\. ΪʲôÓà `earlySingletonObjects` ÎÞ·¨½â¾öÑ­»·ÒÀÀµ£¿ +##### 2\. 为什么用 `earlySingletonObjects` 无法解决循环ä¾�赖? -Ç°ÃæÎÒÃÇÖ÷Ҫ˵Ã÷ÁË´úÀí¶ÔÏóµÄ´´½¨¹ý³Ì£¬½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ÔÚ aop Ï£¬Ê¹Óà `earlySingletonObjects` À´½â¾öÑ­»·ÒÀÀµÓÐʲôÎÊÌ⣺ +å‰�é�¢æˆ‘们主è¦�说明了代ç�†å¯¹è±¡çš„创建过程,接下æ�¥æˆ‘们æ�¥çœ‹çœ‹åœ¨ aop 下,使用 `earlySingletonObjects` æ�¥è§£å†³å¾ªçޝä¾�赖有什么问题: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d3d00d76ab0c72339faccb7ccd853723d6c.png) -ÎÒÃÇÀ´·ÖÎöÉÏͼµÄÁ÷³Ì£º +我们æ�¥åˆ†æž�上图的æµ�程: -1. ÔÚ `service1` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service1` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -2. ¶Ô `service1` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service1` ÐèҪעÈë `service2`£¬È»ºóÏÈÈ¥ `earlySingletonObjects` ²éÕÒ `service2`£¬Î´ÕÒµ½£»ÔÙÈ¥ `singletonObjects` ÖвéÕÒ `service2`£¬»¹ÊÇδÕÒµ½£¬ÓÚÊǾͿªÊ¼ÁË `service2` µÄ´´½¨¹ý³Ì£» -3. ÔÚ `service2` ¶ÔÏó´´½¨Íê³Éºó£¬ÏȽ« `service2` ·ÅÈë `earlySingletonObjects`£¬È»ºó½øÐÐÒÀÀµ×¢È룻 -4. ¶Ô `service2` ½øÐÐÒÀÀµ×¢Èëʱ£¬`spring` ·¢ÏÖ `service2` ÐèҪעÈë `service1`£¬È»ºó¾ÍÈ¥ `earlySingletonObjects` ²éÕÒ `service1`£¬ÕÒµ½ÁË£¬¾Í½« `service1` ×¢Èëµ½ `service2` ÖУ¬È»ºóÔÙ½øÐÐ aop£¬´Ëʱ `service2` ÊÇÒ»¸ö´úÀí¶ÔÏ󣬽«Æä±£´æµ½ `singletonObjects` ÖУ» -5. ¾­¹ýµÚ 4 ²½ºó£¬ÎÒÃǵõ½ÁË `service2` µÄ´úÀí¶ÔÏó£¬È»ºó½«Æä×¢Èëµ½ `service1` ÖУ¬½Ó×ÅÔÙ¶Ô `service1` ½øÐÐ aop£¬´Ëʱ `service1` Ò²³ÉÁËÒ»¸ö `spring bean`£¬½«Æä±£´æµ½ `singletonObjects` ÖС£ +1. 在 `service1` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service1` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +2. 对 `service1` 进行ä¾�赖注入时,`spring` å�‘现 `service1` 需è¦�注入 `service2`,然å�Žå…ˆåŽ» `earlySingletonObjects` 查找 `service2`,未找到;å†�去 `singletonObjects` 中查找 `service2`,还是未找到,于是就开始了 `service2` 的创建过程; +3. 在 `service2` 对象创建完æˆ�å�Žï¼Œå…ˆå°† `service2` 放入 `earlySingletonObjects`,然å�Žè¿›è¡Œä¾�赖注入; +4. 对 `service2` 进行ä¾�赖注入时,`spring` å�‘现 `service2` 需è¦�注入 `service1`,然å�Žå°±åŽ» `earlySingletonObjects` 查找 `service1`,找到了,就将 `service1` 注入到 `service2` 中,然å�Žå†�进行 aop,此时 `service2` 是一个代ç�†å¯¹è±¡ï¼Œå°†å…¶ä¿�存到 `singletonObjects` 中; +5. ç»�过第 4 æ­¥å�Žï¼Œæˆ‘们得到了 `service2` 的代ç�†å¯¹è±¡ï¼Œç„¶å�Žå°†å…¶æ³¨å…¥åˆ° `service1` 中,接ç�€å†�对 `service1` 进行 aop,此时 `service1` 也æˆ�了一个 `spring bean`,将其ä¿�存到 `singletonObjects` 中。 -ÉÏÊö²½ÖèÓÐʲôÎÊÌâÄØ£¿×Ðϸ¿´µÚ 4 ²½£¬¾Í»á·¢ÏÖ£¬**×¢Èëµ½ `service2` µÄ `service1` ²¢²»ÊÇ´úÀí¶ÔÏó**£¡×ݹÛÈ«¾Ö£¬×îÖյõ½µÄ `service1` Óë `service2` ¶¼ÊÇ´úÀí¶ÔÏó£¬×¢Èëµ½ `service2` µÄ `service1` Ó¦¸ÃÒ²ÊÇ´úÀí¶ÔÏó²Å¶Ô¡£Òò´Ë£¬ÔÚ aop Ï£¬Ñ­»·ÒÀÀµµÄÎÊÌâÓÖ³öÏÖÁË£¡ +上述步骤有什么问题呢?仔细看第 4 步,就会å�‘现,**注入到 `service2` çš„ `service1` å¹¶ä¸�是代ç�†å¯¹è±¡**ï¼�纵观全局,最终得到的 `service1` 与 `service2` 都是代ç�†å¯¹è±¡ï¼Œæ³¨å…¥åˆ° `service2` çš„ `service1` 应该也是代ç�†å¯¹è±¡æ‰�对。因此,在 aop 下,循环ä¾�赖的问题å�ˆå‡ºçŽ°äº†ï¼� -#### 2.3 spring µÄ½â¾ö·½°¸ +#### 2.3 spring 的解决方案 -Ç°ÃæÎÒÃÇÌáµ½£¬ÔÚ aop Ï£¬ÒýÈë `earlySingletonObjects` ²¢²»Äܽâ¾öÑ­»·ÒÀÀµµÄÎÊÌ⣬ÄÇ spring ÊÇÔõô½â¾öµÄÄØ£¿spring ÔÙ´ÎÒýÈëÁËÒ»¸ö `map` À´½â¾öÕâ¸öÎÊÌ⣬ÕâÒ²ÊÇÈËÃdz£ËµµÄ **spring Èý¼¶»º´æ**£¬¶ÔÕâÈý¸ö `map` ˵Ã÷ÈçÏ£º +å‰�é�¢æˆ‘们æ��到,在 aop 下,引入 `earlySingletonObjects` å¹¶ä¸�能解决循环ä¾�赖的问题,那 spring 是怎么解决的呢?spring å†�次引入了一个 `map` æ�¥è§£å†³è¿™ä¸ªé—®é¢˜ï¼Œè¿™ä¹Ÿæ˜¯äººä»¬å¸¸è¯´çš„ **spring 三级缓存**,对这三个 `map` 说明如下: -* Ò»¼¶»º´æ `singletonObjects`£ºÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇÍêÕûµÄ `spring bean`£¬¼´Íê³ÉÊôÐÔ×¢Èë¡¢³õʼ»¯µÄ bean£¬Èç¹û bean ÐèÒª aop£¬´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£» -* ¶þ¼¶»º´æ `earlySingletonObjects`£ºÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇʵÀý»¯Íê³É£¬µ«Î´½øÐÐÒÀÀµ×¢ÈëµÄ `bean`£¬Èç¹û `bean` ÐèÒª `aop`£¬ÕâÀï´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£¬Ö»²»¹ý´úÀí¶ÔÏóËù³ÖÓеÄԭʼ¶ÔÏó²¢Î´½øÐÐÒÀÀµ×¢È룻 -* Èý¼¶»º´æ `singletonFactories`£ºÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ´æ´¢µÄÊÇÒ»¸ö `lambda` ±í´ïʽ£º`() -> getEarlyBeanReference(beanName, mbd, bean)`£¬ `getEarlyBeanReference` ÖÐµÄ `bean` ÊǸմ´½¨Íê³ÉµÄ `java bean`£¬Ã»ÓнøÐÐ spring ÒÀÀµ×¢È룬Ҳû½øÐÐ aop (¹ØÓÚÕâ¸ö `lambda` ±í´ïʽ£¬ºóÃæ»á¼ÌÐø·ÖÎö)¡£ +* 一级缓存 `singletonObjects`:类型为 `ConcurrentHashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是完整的 `spring bean`,å�³å®Œæˆ�属性注入ã€�åˆ�始化的 bean,如果 bean 需è¦� aop,存储的就是代ç�†å¯¹è±¡ï¼› +* 二级缓存 `earlySingletonObjects`:类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是实例化完æˆ�,但未进行ä¾�赖注入的 `bean`,如果 `bean` 需è¦� `aop`,这里存储的就是代ç�†å¯¹è±¡ï¼Œå�ªä¸�过代ç�†å¯¹è±¡æ‰€æŒ�有的原始对象并未进行ä¾�赖注入; +* 三级缓存 `singletonFactories`:类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 存储的是一个 `lambda` 表达å¼�:`() -> getEarlyBeanReference(beanName, mbd, bean)`, `getEarlyBeanReference` 中的 `bean` 是刚创建完æˆ�çš„ `java bean`,没有进行 spring ä¾�赖注入,也没进行 aop (关于这个 `lambda` 表达å¼�,å�Žé�¢ä¼šç»§ç»­åˆ†æž�)。 -ΪÁË˵Ã÷·½±ã£¬ÏÂÃæ¶Ô `singletonObjects`¡¢`earlySingletonObjects` ºÍ `singletonFactories` ·Ö±ð³ÆÎª**Ò»¼¶»º´æ**¡¢**¶þ¼¶»º´æ**ºÍ**Èý¼¶»º´æ**¡£ +为了说明方便,下é�¢å¯¹ `singletonObjects`ã€�`earlySingletonObjects` å’Œ `singletonFactories` 分别称为**一级缓存**ã€�**二级缓存**å’Œ**三级缓存**。 -spring ½â¾ö aop ϵÄÑ­»·ÒÀÀµÁ÷³ÌÈçÏ£º +spring 解决 aop 下的循环ä¾�èµ–æµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-dc325a87b321e4c246a1b2f14169821a75a.png) -Õâ¸öͼ¿´×űȽϸ´ÔÓ£¬Æäʵ·Ö¿ªÀ´¿´¾Í±È½Ï¼òµ¥ÁË£¬ÉÏÊö²Ù×÷ÖУ¬`1~8` ÊÇ»ñÈ¡ `service1` µÄÁ÷³Ì£¬`5.1~5.8` ÊÇ»ñÈ¡ `service2` µÄÁ÷³Ì£¬`5.5.1` ÊÇÔٴλñÈ¡ `service1` µÄÁ÷³Ì£¬Ö»²»¹ýÔÚ´¦Àí `service1` µÄ³õʼ»¯¹ý³ÌÖУ¬»á´¥·¢ `service2` µÄ³õʼ»¯¹ý³Ì£¬¶ø `service2` µÄ³õʼ»¯Ê±£¬ÓÖ»áÒÀÀµµ½ `service1`£¬Òò´Ë²Å¿´×ÅÏñÊÇÁ¬ÔÚÒ»Æð£¬±È½Ï¸´ÔÓ¡£ +这个图看ç�€æ¯”较å¤�æ�‚,其实分开æ�¥çœ‹å°±æ¯”较简å�•了,上述æ“�作中,`1~8` 是获å�– `service1` çš„æµ�程,`5.1~5.8` 是获å�– `service2` çš„æµ�程,`5.5.1` 是å†�次获å�– `service1` çš„æµ�程,å�ªä¸�过在处ç�† `service1` çš„åˆ�始化过程中,会触å�‘ `service2` çš„åˆ�始化过程,而 `service2` çš„åˆ�始化时,å�ˆä¼šä¾�赖到 `service1`,因此æ‰�看ç�€åƒ�是连在一起,比较å¤�æ�‚。 -¶ÔÉÏͼµÄ¹ý³Ì£¬ÕâÀï˵Ã÷ÈçÏ£¨½¨Ò飺Èç¹û¾õµÃÁ÷³Ì±È½Ï¸´ÔÓ£¬¿ÉÒÔÏÈ¿´ `1~8` µÄ²Ù×÷£¬ÔÙ¿´ `5.1~5.8` µÄ²Ù×÷£¬×îºóÁ½ÕßÁªºÏÆðÀ´¿´£¬ÕâÑù»áÇåÎúºÜ¶à£©£º +对上图的过程,这里说明如下(建议:如果觉得æµ�程比较å¤�æ�‚,å�¯ä»¥å…ˆçœ‹ `1~8` çš„æ“�作,å†�看 `5.1~5.8` çš„æ“�作,最å�Žä¸¤è€…è�”å�ˆèµ·æ�¥çœ‹ï¼Œè¿™æ ·ä¼šæ¸…晰很多): -* 1. `service1`£º»ñÈ¡ `service1`£¬´ÓÒ»¼¶»º´æÖлñÈ¡£¬´ËʱÊÇ»ñÈ¡²»µ½µÄ£» -* 1. `service1`£º´´½¨ `service1` µÄʵÀý£» -* 1. `service1`£º»ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¨ÔÚԭʼ¶ÔÏóÉϽøÐлñÈ¡£©£» -* 1. `service1`£ºÈç¹û¿ªÆôÁËÖ§³ÖÑ­»·ÒÀÀµµÄÅäÖ㬾ͽ« `service1` ·Åµ½Èý¼¶»º´æÖУ¨ÊÇ·ñÖ§³ÖÑ­»·ÒÀÀµ£¬ÊÇ¿ÉÒÔÅäÖõģ©£» -* 1. `service1`£º¶Ô `service1` ½øÐÐÒÀÀµ×¢È룬ÐèÒª `service2`£¬È»ºó¾Í¿ªÊ¼ÁË `service2` µÄ»ñÈ¡Á÷³Ì£» -* 5.1 `service2`£º»ñÈ¡ `service2`£¬´ÓÒ»¼¶»º´æÖлñÈ¡£¬´ËʱÊÇ»ñÈ¡²»µ½µÄ£» -* 5.2 `service2`£º´´½¨ `service2` µÄʵÀý£» -* 5.3 `service2`£º»ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¨ÔÚԭʼ¶ÔÏóÉϽøÐлñÈ¡£©£» -* 5.4 `service2`£ºÈç¹û¿ªÆôÁËÖ§³ÖÑ­»·ÒÀÀµµÄÅäÖ㬾ͽ« `service2` ·Åµ½Èý¼¶»º´æÖУ¨ÊÇ·ñÖ§³ÖÑ­»·ÒÀÀµ£¬ÊÇ¿ÉÒÔÅäÖõģ©£» -* 5.5 `service2`£º¶Ô `service2` ½øÐÐÒÀÀµ×¢È룬ÐèÒª `service1`£¬È»ºó¾Í¿ªÊ¼ÁË `service1` µÄ»ñÈ¡Á÷³Ì£» -* 5.5.1 `service1`: »ñÈ¡ `service1`£¬´ÓÒ»¼¶»º´æÖлñÈ¡£¬»ñÈ¡²»µ½£»´Ëʱ·¢ÏÖ `service1` ÕýÔÚ´´½¨ÖУ¬ÓÚÊǼÌÐø´Ó¶þ¡¢Èý¼¶»º´æÖлñÈ¡£¬×îÖÕ´ÓÈý¼¶»º´æÖлñÈ¡µ½ÁË£¬½«Æä·ÅÈë¶þ¼¶»º´æ¡£´ÓÈý¼¶»º´æ»ñÈ¡µÄ¹ý³ÌÖУ¬**»áÅÐ¶Ï `service1` ÊÇ·ñÐèÒª½øÐÐ aop£¬È»ºó¿ªÊ¼ aop ²Ù×÷**£¬Òò´Ë·ÅÈë¶þ¼¶»º´æÖеÄÊÇ `service1` ´úÀí´úÀí£¬Ìáǰ½øÐÐ aop Êǽâ¾öÑ­»·ÒÀÀµµÄ¹Ø¼ü£» -* 5.6 `service2`£ºµÃµ½ÁË `service1` ºó£¨ÕâÀïµÄ `service1` ÊÇ´úÀí¶ÔÏ󣩣¬½«Æä×¢Èëµ½ `service2` ÖУ¬½Ó×Å¶Ô `service2` ½øÐÐ aop£¬µÃµ½ `service2` µÄ´úÀí¶ÔÏó£» -* 5.7 `service2`£ºÈç¹ûÖ§³ÖÑ­»·ÒÀÀµ£¬ÏÈ´ÓÒ»¡¢¶þ¼¶»º´æÖÐÔٴλñÈ¡ `service2`£¬¶¼Î´»ñÈ¡µ½£¬¾ÍʹÓõ±Ç° `service2`£¨µ±Ç° `service2` ÊÇ´úÀí¶ÔÏó)£» -* 5.8 `service2`£º½« service2 µÄ´úÀí¶ÔÏó·ÅÈëÒ»¼¶»º´æÖУ¬É¾³ý¶þ¡¢Èý¼¶»º´æ£¬ÖÁ´Ë£¬`service2` ³õʼ»¯Íê³É£¬×¢ÈëµÄ `service1` ÊÇ´úÀí¶ÔÏó£¬Ò»¼¶»º´æÖÐµÄ `service2` Ò²ÊÇ´úÀí¶ÔÏó£» -* 1. `service1`£º»Øµ½ `service1` µÄÉúÃüÖÜÆÚ£¬Äõ½ `service2`£¨ÕâÀïµÄ `service2` ÊÇ´úÀí¶ÔÏ󣩺󣬽«Æä×¢Èëµ½ `service1`£¬`service1` µÄÒÀÀµ×¢ÈëÍê³É£¬½øÐгõʼ»¯£¬ÕâÀï»áÅÐ¶Ï `service1` ÊÇ·ñÐèÒª½øÐÐ aop£¬ËäÈ» `service1` ÊÇÐèÒª½øÐÐ aop µÄ£¬µ«ÓÉÓÚÔÚ `5.5.1` ÒѾ­½øÐйý aop ÁË£¬Òò´Ë£¬ÕâÀïÖ±½Ó·µ»Ø£¨µ½ÕâÒ»²½£¬`service1` »¹ÊÇԭʼ¶ÔÏ󣩣» -* 1. `service1`£ºÈç¹ûÖ§³ÖÑ­»·ÒÀÀµ£¬ÏÈ´ÓÒ»¼¶»º´æÖлñÈ¡ `service1`£¬»ñÈ¡²»µ½£»ÔÙ´Ó¶þ»º´æÖлñÈ¡ `service1`£¬¿ÉÒÔ»ñÈ¡µ½£¨´Ó `5.5.1` ¿ÉÖª£¬¶þ¼¶»º´æÀïÊÇ `service1` ´úÀí¶ÔÏ󣩣¬·µ»Ø£» -* 1. `service1`£º½«¶þ¼¶»º´æÖлñÈ¡µÄ¶ÔÏó×¢²áµ½Ò»¼¶»º´æÖУ¬É¾³ý¶þ¡¢Èý¼¶»º´æ£¬ÖÁ´Ë£¬`service1` ³õʼ»¯Íê³É£¬×¢ÈëµÄ `service2` ÊÇ´úÀí¶ÔÏó£¬Ò»¼¶»º´æÖÐµÄ `service1` Ò²ÊÇ´úÀí¶ÔÏó¡£ +* 1. `service1`:获å�– `service1`,从一级缓存中获å�–,此时是获å�–ä¸�到的; +* 1. `service1`:创建 `service1` 的实例; +* 1. `service1`:获å�–需è¦�注入的属性与方法(在原始对象上进行获å�–); +* 1. `service1`:如果开å�¯äº†æ”¯æŒ�循环ä¾�èµ–çš„é…�置,就将 `service1` 放到三级缓存中(是å�¦æ”¯æŒ�循环ä¾�赖,是å�¯ä»¥é…�置的); +* 1. `service1`:对 `service1` 进行ä¾�赖注入,需è¦� `service2`,然å�Žå°±å¼€å§‹äº† `service2` 的获å�–æµ�程; +* 5.1 `service2`:获å�– `service2`,从一级缓存中获å�–,此时是获å�–ä¸�到的; +* 5.2 `service2`:创建 `service2` 的实例; +* 5.3 `service2`:获å�–需è¦�注入的属性与方法(在原始对象上进行获å�–); +* 5.4 `service2`:如果开å�¯äº†æ”¯æŒ�循环ä¾�èµ–çš„é…�置,就将 `service2` 放到三级缓存中(是å�¦æ”¯æŒ�循环ä¾�赖,是å�¯ä»¥é…�置的); +* 5.5 `service2`:对 `service2` 进行ä¾�赖注入,需è¦� `service1`,然å�Žå°±å¼€å§‹äº† `service1` 的获å�–æµ�程; +* 5.5.1 `service1`: 获å�– `service1`,从一级缓存中获å�–,获å�–ä¸�到;此时å�‘现 `service1` 正在创建中,于是继续从二ã€�三级缓存中获å�–,最终从三级缓存中获å�–到了,将其放入二级缓存。从三级缓存获å�–的过程中,**会判断 `service1` 是å�¦éœ€è¦�进行 aop,然å�Žå¼€å§‹ aop æ“�作**,因此放入二级缓存中的是 `service1` 代ç�†ä»£ç�†ï¼Œæ��å‰�进行 aop 是解决循环ä¾�赖的关键; +* 5.6 `service2`:得到了 `service1` å�Žï¼ˆè¿™é‡Œçš„ `service1` 是代ç�†å¯¹è±¡ï¼‰ï¼Œå°†å…¶æ³¨å…¥åˆ° `service2` 中,接ç�€å¯¹ `service2` 进行 aop,得到 `service2` 的代ç�†å¯¹è±¡ï¼› +* 5.7 `service2`:如果支æŒ�循环ä¾�赖,先从一ã€�二级缓存中å†�次获å�– `service2`,都未获å�–到,就使用当å‰� `service2`(当å‰� `service2` 是代ç�†å¯¹è±¡)ï¼› +* 5.8 `service2`:将 service2 的代ç�†å¯¹è±¡æ”¾å…¥ä¸€çº§ç¼“存中,删除二ã€�三级缓存,至此,`service2` åˆ�始化完æˆ�,注入的 `service1` 是代ç�†å¯¹è±¡ï¼Œä¸€çº§ç¼“存中的 `service2` 也是代ç�†å¯¹è±¡ï¼› +* 1. `service1`:回到 `service1` 的生命周期,拿到 `service2`(这里的 `service2` 是代ç�†å¯¹è±¡ï¼‰å�Žï¼Œå°†å…¶æ³¨å…¥åˆ° `service1`,`service1` çš„ä¾�赖注入完æˆ�,进行åˆ�始化,这里会判断 `service1` 是å�¦éœ€è¦�进行 aop,虽然 `service1` 是需è¦�进行 aop 的,但由于在 `5.5.1` å·²ç»�进行过 aop 了,因此,这里直接返回(到这一步,`service1` 还是原始对象); +* 1. `service1`:如果支æŒ�循环ä¾�赖,先从一级缓存中获å�– `service1`,获å�–ä¸�到;å†�从二缓存中获å�– `service1`,å�¯ä»¥èŽ·å�–到(从 `5.5.1` å�¯çŸ¥ï¼ŒäºŒçº§ç¼“存里是 `service1` 代ç�†å¯¹è±¡ï¼‰ï¼Œè¿”回; +* 1. `service1`:将二级缓存中获å�–的对象注册到一级缓存中,删除二ã€�三级缓存,至此,`service1` åˆ�始化完æˆ�,注入的 `service2` 是代ç�†å¯¹è±¡ï¼Œä¸€çº§ç¼“存中的 `service1` 也是代ç�†å¯¹è±¡ã€‚ -ÒÔÉÏÁ÷³Ì£¬ËäÈ»²½Öè½Ï¶à£¬µ« `service1` Óë `service2` µÄ»ñÈ¡²½ÖèÊÇÏàͬµÄ£¬Ö»ÒªÅªÇåÁËÆäÖÐÖ®Ò»µÄ»ñÈ¡Á÷³Ì£¬ÁíÒ»¸ö bean µÄ»ñÈ¡Á÷³Ì¾ÍºÜÀ×ͬÁË¡£ +以上æµ�程,虽然步骤较多,但 `service1` 与 `service2` 的获å�–步骤是相å�Œçš„,å�ªè¦�弄清了其中之一的获å�–æµ�程,å�¦ä¸€ä¸ª bean 的获å�–æµ�程就很雷å�Œäº†ã€‚ -ÔÚÉÏÊöÁ÷³ÌÖУ¬»¹ÓÐÁ½¸öÊý¾Ý½á¹¹ÐèҪ˵Ã÷Ï£º +在上述æµ�程中,还有两个数æ�®ç»“构需è¦�说明下: -* `singletonsCurrentlyInCreation`£ºÀàÐÍΪ `SetFromMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry`£¬´´½¨·½Ê½Îª `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`£¬±íÃ÷ÕâÊǸöÓÉ `ConcurrentHashMap` ʵÏÖµÄ set£¬´æ´¢µÄÊÇÕýÔÚ´´½¨ÖеĶÔÏó£¬**Åжϵ±Ç°¶ÔÏóÊÇ·ñÔÚ´´½¨ÖоÍÊÇͨ¹ý²éÕÒµ±Ç°¶ÔÏóÊÇ·ñÔÚÕâ¸ö set ÖÐ**×öµ½µÄ£» -* `earlyProxyReferences`£ºÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `AbstractAutoProxyCreator`£¬´æ´¢µÄÊÇÌáǰ½øÐÐ aop µÄ¶ÔÏó£¬**Èç¹ûÒ»¸ö¶ÔÏóÌáǰ½øÐÐÁË aop£¬ÔÚºóÃæÔÙ´Î aop ʱ£¬»áͨ¹ýÅж϶ÔÏóÊÇ·ñÔÚ `earlyProxyReferences` ÖжøÈ·¶¨Òª²»Òª½øÐÐ aop£¬ÒÔ´ËÀ´±£Ö¤Ã¿¸ö¶ÔÏóÖ»½øÐÐÒ»´Î aop**¡£ +* `singletonsCurrentlyInCreation`:类型为 `SetFromMap`,ä½�于 `DefaultSingletonBeanRegistry`,创建方å¼�为 `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`,表明这是个由 `ConcurrentHashMap` 实现的 set,存储的是正在创建中的对象,**判断当å‰�对象是å�¦åœ¨åˆ›å»ºä¸­å°±æ˜¯é€šè¿‡æŸ¥æ‰¾å½“å‰�对象是å�¦åœ¨è¿™ä¸ª set 中**å�šåˆ°çš„ï¼› +* `earlyProxyReferences`:类型为 `ConcurrentHashMap`,ä½�于 `AbstractAutoProxyCreator`,存储的是æ��å‰�进行 aop 的对象,**如果一个对象æ��å‰�进行了 aop,在å�Žé�¢å†�次 aop 时,会通过判断对象是å�¦åœ¨ `earlyProxyReferences` 中而确定è¦�ä¸�è¦�进行 aop,以此æ�¥ä¿�è¯�æ¯�个对象å�ªè¿›è¡Œä¸€æ¬¡ aop**。 -ÖÁ´Ë£¬spring Ò»¹²ÌṩÁË 5 ¸öÊý¾Ý½á¹¹À´¸¨Öú½â¾öÑ­»·ÒÀÀµÎÊÌ⣬×ܽáÈçÏ£º +至此,spring 一共æ��供了 5 个数æ�®ç»“æž„æ�¥è¾…助解决循环ä¾�赖问题,总结如下: -| ½á¹¹ | ˵Ã÷ | +| 结构 | 说明 | | ------------------------------- | ------------------------------------------------------------ | -| `singletonObjects` | **Ò»¼¶»º´æ**£¬ÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇÍêÕûµÄ `spring bean`£¬¼´Íê³ÉÊôÐÔ×¢Èë¡¢³õʼ»¯µÄ bean£¬Èç¹û bean ÐèÒª aop£¬´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó | -| `earlySingletonObjects` | **¶þ¼¶»º´æ**£¬ÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇʵÀý»¯Íê³É£¬µ«Î´½øÐÐÒÀÀµ×¢ÈëµÄ `bean`£¬**Èç¹û `bean` ÐèÒª `aop`£¬ÕâÀï´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£¬Ö»²»¹ý´úÀí¶ÔÏóËù³ÖÓеÄԭʼ¶ÔÏó²¢Î´½øÐÐÒÀÀµ×¢Èë** | -| `singletonFactories` | **Èý¼¶»º´æ**£¬ÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ´æ´¢µÄÊÇÒ»¸ö `lambda` ±í´ïʽ£º`() -> getEarlyBeanReference(beanName, mbd, bean)`£¬`getEarlyBeanReference(xxx)` ÖÐµÄ `bean` ÊǸմ´½¨Íê³ÉµÄ `java bean`£¬Ã»ÓнøÐÐ spring ÒÀÀµ×¢È룬Ҳû½øÐÐ aop | -| `singletonsCurrentlyInCreation` | ÀàÐÍΪ `SetFromMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry`£¬´´½¨·½Ê½Îª `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`£¬±íÃ÷ÕâÊǸöÓÉ `ConcurrentHashMap` ʵÏÖµÄ set£¬´æ´¢µÄÊÇÕýÔÚ´´½¨ÖеĶÔÏ󣬿ÉÒÔ**ÓÃÀ´Åжϵ±Ç°¶ÔÏóÊÇ·ñÔÚ´´½¨ÖÐ** | -| `earlyProxyReferences` | ÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `AbstractAutoProxyCreator`£¬´æ´¢µÄÊÇÌáǰ½øÐÐ aop µÄ¶ÔÏ󣬿ÉÒÔ**ÓÃÀ´ÅÐ¶Ï bean ÊÇ·ñ½øÐйý aop£¬±£Ö¤Ã¿¸ö¶ÔÏóÖ»½øÐÐÒ»´Î aop** | +| `singletonObjects` | **一级缓存**,类型为 `ConcurrentHashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是完整的 `spring bean`,å�³å®Œæˆ�属性注入ã€�åˆ�始化的 bean,如果 bean 需è¦� aop,存储的就是代ç�†å¯¹è±¡ | +| `earlySingletonObjects` | **二级缓存**,类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是实例化完æˆ�,但未进行ä¾�赖注入的 `bean`,**如果 `bean` 需è¦� `aop`,这里存储的就是代ç�†å¯¹è±¡ï¼Œå�ªä¸�过代ç�†å¯¹è±¡æ‰€æŒ�有的原始对象并未进行ä¾�赖注入** | +| `singletonFactories` | **三级缓存**,类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 存储的是一个 `lambda` 表达å¼�:`() -> getEarlyBeanReference(beanName, mbd, bean)`,`getEarlyBeanReference(xxx)` 中的 `bean` 是刚创建完æˆ�çš„ `java bean`,没有进行 spring ä¾�赖注入,也没进行 aop | +| `singletonsCurrentlyInCreation` | 类型为 `SetFromMap`,ä½�于 `DefaultSingletonBeanRegistry`,创建方å¼�为 `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`,表明这是个由 `ConcurrentHashMap` 实现的 set,存储的是正在创建中的对象,å�¯ä»¥**用æ�¥åˆ¤æ–­å½“å‰�对象是å�¦åœ¨åˆ›å»ºä¸­** | +| `earlyProxyReferences` | 类型为 `ConcurrentHashMap`,ä½�于 `AbstractAutoProxyCreator`,存储的是æ��å‰�进行 aop 的对象,å�¯ä»¥**用æ�¥åˆ¤æ–­ bean 是å�¦è¿›è¡Œè¿‡ aop,ä¿�è¯�æ¯�个对象å�ªè¿›è¡Œä¸€æ¬¡ aop** | -ÒÔÉϾÍÊÇ spring ½â¾öÑ­»·ÒÀÀµµÄÍêÕûÁ÷³ÌÁË¡£ +以上就是 spring 解决循环ä¾�赖的完整æµ�程了。 -### 3\. ´úÂëÄ£Äâ +### 3\. 代ç �模拟 -ÔÚÕýʽ·ÖÎöÔ´Âëǰ£¬ÎÒÃÇÊ×ÏÈÄ£ÄâÑ­»·ÏÂÒÀÀµ½â¾öµÄ¹ý³Ì£¬´úÂëÈçÏ£º +在正å¼�分æž�æº�ç �å‰�,我们首先模拟循环下ä¾�赖解决的过程,代ç �如下: ``` /** - * ×¼±¸Ò»¸öÀ࣬ÄÚ²¿ÓÐÒ»¸öÊôÐÔ Obj2 + * 准备一个类,内部有一个属性 Obj2 */ public class Obj1 { - // ÐèҪעÈë obj2 + // 需è¦�注入 obj2 private Obj2 obj2; - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Ò»¸öÀ࣬ÄÚ²¿ÓÐÒ»¸öÊôÐÔ Obj1 + * 准备一个类,内部有一个属性 Obj1 */ public class Obj2 { - // ÐèҪעÈë ob1 + // 需è¦�注入 ob1 private Obj1 obj1; - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Obj2µÄ´úÀíÀ࣬ÄÚ²¿³ÖÓÐobj2µÄ¶ÔÏó + * 准备Obj2的代ç�†ç±»ï¼Œå†…部æŒ�有obj2的对象 */ public class ProxyObj2 extends Obj2 { - // obj2´úÀíÀàÄÚ²¿³ÖÓÐobj2µÄԭʼ¶ÔÏó + // obj2代ç�†ç±»å†…部æŒ�有obj2的原始对象 private Obj2 obj2; public ProxyObj2(Obj2 obj2) { this.obj2 = obj2; } - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } /** - * ×¼±¸Obj1µÄ´úÀíÀ࣬ÄÚ²¿³ÖÓÐobj1µÄ¶ÔÏó + * 准备Obj1的代ç�†ç±»ï¼Œå†…部æŒ�有obj1的对象 */ public class ProxyObj1 extends Obj1 { - // obj2´úÀíÀàÄÚ²¿³ÖÓÐobj1µÄԭʼ¶ÔÏó + // obj2代ç�†ç±»å†…部æŒ�有obj1的原始对象 private Obj1 obj1; public ProxyObj1(Obj1 obj1) { this.obj1 = obj1; } - // Ê¡ÂÔÆäËû·½·¨ + // çœ�略其他方法 ... } ``` -* Ê×ÏÈ×¼±¸ÁËÁ½¸öÀࣺ`Obj1` Óë `Obj2`£¬ ÆäÖÐ `Obj1` ÓиöÊôÐÔΪ `Obj2`£¬`Obj2` ÖÐÓиöÊôÐÔΪ `Obj1`£» -* ½Ó×Å×¼±¸ÁË `Obj1` Óë `Obj2` µÄ´úÀíÀà `ProxyObj1`¡¢`ProxyObj2`£¬²¢ÇÒ `ProxyObj1`¡¢`ProxyObj2` ·Ö±ðÓÐÒ»¸öÊôÐÔ£º`Obj1` ¡¢ `Obj2`£» -* ÎÒÃÇÒÀ¾ÉÒÔ `new ObjX()` Ä£Äâ¶ÔÏóµÄ´´½¨£» -* ÎÒÃÇÒÀ¾ÉÒÔ `objX.setObjX(xxx)` Ä£ÄâÒÀÀµ×¢È룻 -* ÎÒÃÇÒÀ¾ÉÒÔ `new ProxyObjX(xxx)` Ä£Äâ´úÀí¶ÔÏóµÄÉú³É£» -* ÎÒÃÇÒÀ¾ÉÒÔ `collection.add(xxx)` Ä£Äâ¶ÔÏóÌí¼Óµ½ÈÝÆ÷ÖеĹý³Ì£» +* 首先准备了两个类:`Obj1` 与 `Obj2`, 其中 `Obj1` 有个属性为 `Obj2`,`Obj2` 中有个属性为 `Obj1`ï¼› +* 接ç�€å‡†å¤‡äº† `Obj1` 与 `Obj2` 的代ç�†ç±» `ProxyObj1`ã€�`ProxyObj2`,并且 `ProxyObj1`ã€�`ProxyObj2` 分别有一个属性:`Obj1` ã€� `Obj2`ï¼› +* 我们ä¾�旧以 `new ObjX()` 模拟对象的创建; +* 我们ä¾�旧以 `objX.setObjX(xxx)` 模拟ä¾�赖注入; +* 我们ä¾�旧以 `new ProxyObjX(xxx)` 模拟代ç�†å¯¹è±¡çš„生æˆ�ï¼› +* 我们ä¾�旧以 `collection.add(xxx)` 模拟对象添加到容器中的过程; -ÎÒÃÇÄ£Äâ×îÖյõ½µÄ½á¹ûΪ£º +我们模拟最终得到的结果为: -* ×îÖÕ·ÅÈëÈÝÆ÷µÄ¶ÔÏó·Ö±ðÊÇ `proxyObj1`£¬`proxyObj2` -* ×¢Èëµ½ `obj1` ÖеÄÊÇ `proxyObj2`£¬×¢Èëµ½ `obj2` ÖеÄÊÇ `proxyObj2` +* 最终放入容器的对象分别是 `proxyObj1`,`proxyObj2` +* 注入到 `obj1` 中的是 `proxyObj2`,注入到 `obj2` 中的是 `proxyObj2` -×¼±¸¹¤×÷ÒѾ­Íê³ÉÁË£¬½ÓÏÂÀ´ÎÒÃǾͿªÊ¼½øÐÐÄ£ÄâÁË¡£ +准备工作已ç»�完æˆ�了,接下æ�¥æˆ‘们就开始进行模拟了。 -#### 3.1 Ä£Äâ 1 +#### 3.1 模拟 1 -ÒªÇó£º +è¦�求: -* Obj1 Óë Obj2 ±ØÐëÑϸñ°´ÕÕ ¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± µÄÁ÷³Ì´´½¨ -* Á½¸ö¶ÔÏóµÄ´´½¨Á÷³Ì¿ÉÒÔ½»Ìæ½øÐÐ +* Obj1 与 Obj2 必须严格按照 “创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� çš„æµ�程创建 +* 两个对象的创建æµ�程å�¯ä»¥äº¤æ›¿è¿›è¡Œ -Ä¿±ê£º +目标: -* ×îÖÕ·ÅÈëÈÝÆ÷µÄ¶ÔÏó·Ö±ðÊÇ `proxyObj1`£¬`proxyObj2` -* ×¢Èëµ½ `obj1` ÖеÄÊÇ `proxyObj2`£¬×¢Èëµ½ `obj2` ÖеÄÊÇ `proxyObj2` +* 最终放入容器的对象分别是 `proxyObj1`,`proxyObj2` +* 注入到 `obj1` 中的是 `proxyObj2`,注入到 `obj2` 中的是 `proxyObj2` -´úÂëÈçÏ£º +代ç �如下: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // 1\. ´´½¨ Obj1 ¶ÔÏó + // 1\. 创建 Obj1 对象 Obj1 obj1 = new Obj1(); - // ½ÓÏÂÀ´ÐèÒª½«obj2µÄ´úÀí¶ÔÏó×¢Èëµ½obj1ÖУ¬µ«´ËʱÈÝÆ÷Öв¢Ã»ÓÐobj2µÄ´úÀí¶ÔÏó£¬ÓÚÊÇÇл»µ½obj2µÄ´´½¨Á÷³Ì - // Ò». ´´½¨ Obj2 ¶ÔÏó + // 接下æ�¥éœ€è¦�å°†obj2的代ç�†å¯¹è±¡æ³¨å…¥åˆ°obj1中,但此时容器中并没有obj2的代ç�†å¯¹è±¡ï¼ŒäºŽæ˜¯åˆ‡æ�¢åˆ°obj2的创建æµ�程 + // 一. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // µ½ÕâÀobj2ÐèҪעÈëobj1µÄ´úÀí¶ÔÏ󣬵«´ËʱÈÝÆ÷Öв¢Ã»ÓÐobj2µÄ´úÀí¶ÔÏó£¬ÓÚÊÇÓÖÒªÇе½obj1µÄ´´½¨Á÷³Ì + // 到这里,obj2需è¦�注入obj1的代ç�†å¯¹è±¡ï¼Œä½†æ­¤æ—¶å®¹å™¨ä¸­å¹¶æ²¡æœ‰obj2的代ç�†å¯¹è±¡ï¼ŒäºŽæ˜¯å�ˆè¦�切到obj1的创建æµ�程 } ``` -ÔÚÖ´ÐÐÒÔÉÏÁ÷³ÌÖÐ £¬·¢ÏÖ´´½¨ Obj2 ¶ÔÏóºó£¬Á÷³Ì¾Í½øÐв»ÏÂÈ¥ÁË£º +在执行以上æµ�程中 ,å�‘现创建 Obj2 对象å�Žï¼Œæµ�程就进行ä¸�下去了: -* `obj1` ÐèҪעÈë `obj2` µÄ´úÀí¶ÔÏ󣬵«ÕÒ²»µ½£¬ÓÚÊÇÇл»µ½ `obj2` µÄ´´½¨Á÷³Ì£» -* `obj2` ÐèҪעÈë `obj1` µÄ´úÀí¶ÔÏ󣬵«ÕÒ²»µ½£¬ÓÚÊÇÇл»µ½ `obj1` µÄ´´½¨Á÷³Ì£» -* `obj1` ÐèҪעÈë `obj2` µÄ´úÀí¶ÔÏ󣬵«ÕÒ²»µ½£¬ÓÚÊÇÇл»µ½ `obj2` µÄ´´½¨Á÷³Ì£» +* `obj1` 需è¦�注入 `obj2` 的代ç�†å¯¹è±¡ï¼Œä½†æ‰¾ä¸�到,于是切æ�¢åˆ° `obj2` 的创建æµ�程; +* `obj2` 需è¦�注入 `obj1` 的代ç�†å¯¹è±¡ï¼Œä½†æ‰¾ä¸�到,于是切æ�¢åˆ° `obj1` 的创建æµ�程; +* `obj1` 需è¦�注入 `obj2` 的代ç�†å¯¹è±¡ï¼Œä½†æ‰¾ä¸�到,于是切æ�¢åˆ° `obj2` 的创建æµ�程; * ... -Èç´ËÑ­»·Íù¸´¡£ +如此循环往å¤�。 -Ä£Äâ½á¹û£ºÎ´´ïµ½Ô¤ÆÚÄ¿±ê£¬±¾´ÎÄ£ÄâÐû¸æÊ§°Ü¡£ +模拟结果:未达到预期目标,本次模拟宣告失败。 -#### 3.1 Ä£Äâ 2 +#### 3.1 模拟 2 -ÒªÇó£º +è¦�求: -* Obj1 Óë Obj2 ±ØÐëÒÔÏÂÁ½ÖÖÁ÷³ÌÖ®Ò»´´½¨£º - * ¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± µÄÁ÷³Ì´´½¨ - * ¡°´´½¨ (ԭʼ¶ÔÏó)--> Éú³É´úÀí¶ÔÏó --> ¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢Èë --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖС± µÄÁ÷³Ì´´½¨ -* Á½¸ö¶ÔÏóµÄ´´½¨Á÷³Ì¿ÉÒÔ½»Ìæ½øÐÐ +* Obj1 与 Obj2 必须以下两ç§�æµ�程之一创建: + * “创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� çš„æµ�程创建 + * “创建 (原始对象)--> 生æˆ�代ç�†å¯¹è±¡ --> 对原始对象进行属性注入 --> 将代ç�†å¯¹è±¡ä¿�存到容器中â€� çš„æµ�程创建 +* 两个对象的创建æµ�程å�¯ä»¥äº¤æ›¿è¿›è¡Œ -Ä¿±ê£º +目标: -* ×îÖÕ·ÅÈëÈÝÆ÷µÄ¶ÔÏó·Ö±ðÊÇ `proxyObj1`£¬`proxyObj2` -* ×¢Èëµ½ `obj1` ÖеÄÊÇ `proxyObj2`£¬×¢Èëµ½ `obj2` ÖеÄÊÇ `proxyObj2` +* 最终放入容器的对象分别是 `proxyObj1`,`proxyObj2` +* 注入到 `obj1` 中的是 `proxyObj2`,注入到 `obj2` 中的是 `proxyObj2` -ʾÀý´úÂëÈçÏ£º +示例代ç �如下: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // 1\. ´´½¨ Obj1 ¶ÔÏó + // 1\. 创建 Obj1 对象 Obj1 obj1 = new Obj1(); - // ½ÓÏÂÀ´ÐèÒª½«obj2µÄ´úÀí¶ÔÏó×¢Èëµ½obj1ÖУ¬µ«´ËʱÈÝÆ÷Öв¢Ã»ÓÐobj2µÄ´úÀí¶ÔÏó£¬ÓÚÊÇÇл»µ½obj2µÄ´´½¨Á÷³Ì - // Ò». ´´½¨ Obj2 ¶ÔÏó + // 接下æ�¥éœ€è¦�å°†obj2的代ç�†å¯¹è±¡æ³¨å…¥åˆ°obj1中,但此时容器中并没有obj2的代ç�†å¯¹è±¡ï¼ŒäºŽæ˜¯åˆ‡æ�¢åˆ°obj2的创建æµ�程 + // 一. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // 2\. ¶Ô Obj1 Ìáǰ´úÀí + // 2\. 对 Obj1 æ��å‰�代ç�† ProxyObj1 proxyObj1 = new ProxyObj1(obj1); - // ¶þ. ½« proxyObj1 ×¢Èëµ½ obj2 ÖÐ + // 二. å°† proxyObj1 注入到 obj2 中 obj2.setObj1(proxyObj1); - // Èý. Éú³É obj2µÄ´úÀí¶ÔÏó + // 三. 生æˆ� obj2的代ç�†å¯¹è±¡ ProxyObj2 proxyObj2 = new ProxyObj2(obj2); - // ËÄ. proxyObj2 ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // å››. proxyObj2 å·²ç»�走完了完整的生命周期,将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj2); - // ´ËʱÈÝÆ÷ÖÐÒѾ­ÓÐ obj2 µÄ´úÀí¶ÔÏóÁË£¬¼ÌÐøobj1µÄÉúÃüÖÜÆÚ - // 3\. ½« proxyObj2 ×¢Èëµ½ obj1 ÖÐ + // 此时容器中已ç»�有 obj2 的代ç�†å¯¹è±¡äº†ï¼Œç»§ç»­obj1的生命周期 + // 3\. å°† proxyObj2 注入到 obj1 中 obj1.setObj2(proxyObj2); - // 4\. proxyObj1 ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // 4\. proxyObj1 å·²ç»�走完了完整的生命周期,将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj1); } ``` -ÉÏÃæµÄ´úÂëÖУ¬obj1 µÄÁ÷³ÌÓà ¡°1£¬2£¬3£¬4¡± ±êʶ£¬obj2 µÄÁ÷³ÌÓà ¡°Ò»£¬¶þ£¬Èý£¬ËÄ¡± ±êʶ£¬Á½ÕßÁ÷³ÌÈçÏ£º +上é�¢çš„代ç �中,obj1 çš„æµ�程用 “1,2,3,4â€� 标识,obj2 çš„æµ�程用 “一,二,三,四â€� 标识,两者æµ�程如下: -* obj1£º¡°´´½¨ (ԭʼ¶ÔÏó)--> Éú³É´úÀí¶ÔÏó --> ¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢Èë --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖС± -* obj2£º¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± +* obj1:“创建 (原始对象)--> 生æˆ�代ç�†å¯¹è±¡ --> 对原始对象进行属性注入 --> 将代ç�†å¯¹è±¡ä¿�存到容器中â€� +* obj2:“创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� -×îÖÕÁ½Õß¶¼´æÈëÁËÈÝÆ÷ÖУ¬´ïµ½ÁËÔ¤ÆÚµÄÄ¿±ê¡£ +最终两者都存入了容器中,达到了预期的目标。 -#### 3.3 ´ÓÄ£ÄâÖеõ½µÄ½áÂÛ +#### 3.3 从模拟中得到的结论 -¶Ô±ÈÉÏÃæÁ½¸öÄ£Äâ´úÂ룬·¢ÏÖÄ£Äâ 2 Ö® ËùÒÔÄÜ´ïµ½Ô¤ÆÚÄ¿±ê£¬Ö÷ÒªÊÇÒòΪÔÚ×¢Èë `obj2` µÄ `obj1` ÊôÐÔʱ£¬ÌáǰÉú³ÉÁË `obj1` µÄ´úÀí¶ÔÏó `proxyObj1`£¬Ê¹µÃ `obj2` ÄÜÍê³ÉÕû¸ö´´½¨Á÷³Ì¡£ÕâÀïÔÙ´ÎÖ¤Ã÷£¬Ìṩ½øÐÐ aop ¶ÔÑ­»·ÒÀÀµµÄ½â¾öÆðµ½ÖÁ¹ØÖØÒªµÄ×÷Óã¡ +对比上é�¢ä¸¤ä¸ªæ¨¡æ‹Ÿä»£ç �,å�‘现模拟 2 之 所以能达到预期目标,主è¦�是因为在注入 `obj2` çš„ `obj1` 属性时,æ��å‰�生æˆ�了 `obj1` 的代ç�†å¯¹è±¡ `proxyObj1`,使得 `obj2` 能完æˆ�整个创建æµ�程。这里å†�次è¯�明,æ��供进行 aop 对循环ä¾�赖的解决起到至关é‡�è¦�的作用ï¼� -ÏÞÓÚÆª·ù£¬±¾ÎľÍÏȵ½ÕâÀïÁË£¬±¾ÎÄÖ÷Òª·ÖÎöÁËÑ­»·ÒÀÀµµÄ²úÉú£¬½éÉÜÁË spring ½â¾öÑ­»·ÒÀÀµµÄ²½Ö裬×îºóͨ¹ýÁ½¶Î´úÂëÄ£ÄâÁËÑ­»·ÒÀÀµµÄ½â¾ö£¬ÏÂһƪÎÄÕÂÎÒÃǽ«´Ó spring Ô´Âë·ÖÎö spring ÊÇÈçºÎ½â¾öÑ­»·ÒÀÀµµÄ¡£ +é™�于篇幅,本文就先到这里了,本文主è¦�分æž�了循环ä¾�赖的产生,介ç»�了 spring 解决循环ä¾�赖的步骤,最å�Žé€šè¿‡ä¸¤æ®µä»£ç �模拟了循环ä¾�赖的解决,下一篇文章我们将从 spring æº�ç �分æž� spring 是如何解决循环ä¾�赖的。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4659555](https://my.oschina.net/funcy/blog/4659555) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ +_本文原文链接:[https://my.oschina.net/funcy/blog/4659555](https://my.oschina.net/funcy/blog/4659555) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ -ʾÀý´úÂëÈçÏ£º +示例代ç �如下: ``` public static main(String[] args) { - // ×¼±¸Ò»¸öÈÝÆ÷£¬ÕâÀï±£´æµÄÊÇÍê³ÉÉÏÊöÉúÃüÖÜÆÚµÄ¶ÔÏó - // 1\. Èç¹ûÔªËØÊÇԭʼ¶ÔÏó£¬Ôò¸Ã¶ÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë - // 2\. Èç¹ûÔªËØÊÇ´úÀí¶ÔÏó£¬Ôò¸Ã¶ÔÏó³ÖÓеÄÔ­ÓжÔÏóÒѾ­Íê³ÉÁËÊôÐÔ×¢Èë + // 准备一个容器,这里ä¿�存的是完æˆ�上述生命周期的对象 + // 1\. 如果元素是原始对象,则该对象已ç»�完æˆ�了属性注入 + // 2\. 如果元素是代ç�†å¯¹è±¡ï¼Œåˆ™è¯¥å¯¹è±¡æŒ�有的原有对象已ç»�完æˆ�了属性注入 Collection collection = new ArrayList(); - // 1\. ´´½¨ Obj1 ¶ÔÏó + // 1\. 创建 Obj1 对象 Obj1 obj1 = new Obj1(); - // ½ÓÏÂÀ´ÐèÒª½«obj2µÄ´úÀí¶ÔÏó×¢Èëµ½obj1ÖУ¬µ«´ËʱÈÝÆ÷Öв¢Ã»ÓÐobj2µÄ´úÀí¶ÔÏó£¬ÓÚÊÇÇл»µ½obj2µÄ´´½¨Á÷³Ì - // Ò». ´´½¨ Obj2 ¶ÔÏó + // 接下æ�¥éœ€è¦�å°†obj2的代ç�†å¯¹è±¡æ³¨å…¥åˆ°obj1中,但此时容器中并没有obj2的代ç�†å¯¹è±¡ï¼ŒäºŽæ˜¯åˆ‡æ�¢åˆ°obj2的创建æµ�程 + // 一. 创建 Obj2 对象 Obj2 obj2 = new Obj2(); - // 2\. ¶Ô Obj1 Ìáǰ´úÀí + // 2\. 对 Obj1 æ��å‰�代ç�† ProxyObj1 proxyObj1 = new ProxyObj1(obj1); - // ¶þ. ½« proxyObj1 ×¢Èëµ½ obj2 ÖÐ + // 二. å°† proxyObj1 注入到 obj2 中 obj2.setObj1(proxyObj1); - // Èý. Éú³É obj2µÄ´úÀí¶ÔÏó + // 三. 生æˆ� obj2的代ç�†å¯¹è±¡ ProxyObj2 proxyObj2 = new ProxyObj2(obj2); - // ËÄ. proxyObj2 ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // å››. proxyObj2 å·²ç»�走完了完整的生命周期,将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj2); - // ´ËʱÈÝÆ÷ÖÐÒѾ­ÓÐ obj2 µÄ´úÀí¶ÔÏóÁË£¬¼ÌÐøobj1µÄÉúÃüÖÜÆÚ - // 3\. ½« proxyObj2 ×¢Èëµ½ obj1 ÖÐ + // 此时容器中已ç»�有 obj2 的代ç�†å¯¹è±¡äº†ï¼Œç»§ç»­obj1的生命周期 + // 3\. å°† proxyObj2 注入到 obj1 中 obj1.setObj2(proxyObj2); - // 4\. proxyObj1 ÒѾ­×ßÍêÁËÍêÕûµÄÉúÃüÖÜÆÚ£¬½«´úÀí¶ÔÏóÌí¼Óµ½ÈÝÆ÷ʱ + // 4\. proxyObj1 å·²ç»�走完了完整的生命周期,将代ç�†å¯¹è±¡æ·»åŠ åˆ°å®¹å™¨æ—¶ collection.add(proxyObj1); } ``` -ÉÏÃæµÄ´úÂëÖУ¬obj1 µÄÁ÷³ÌÓà ¡°1£¬2£¬3£¬4¡± ±êʶ£¬obj2 µÄÁ÷³ÌÓà ¡°Ò»£¬¶þ£¬Èý£¬ËÄ¡± ±êʶ£¬Á½ÕßÁ÷³ÌÈçÏ£º +上é�¢çš„代ç �中,obj1 çš„æµ�程用 “1,2,3,4â€� 标识,obj2 çš„æµ�程用 “一,二,三,四â€� 标识,两者æµ�程如下: -* obj1£º¡°´´½¨ (ԭʼ¶ÔÏó)--> Éú³É´úÀí¶ÔÏó --> ¶Ôԭʼ¶ÔÏó½øÐÐÊôÐÔ×¢Èë --> ½«´úÀí¶ÔÏó±£´æµ½ÈÝÆ÷ÖС± -* obj2£º¡°´´½¨ --> ÊôÐÔ×¢Èë --> Éú³É´úÀí¶ÔÏó --> ±£´æµ½ÈÝÆ÷ÖС± +* obj1:“创建 (原始对象)--> 生æˆ�代ç�†å¯¹è±¡ --> 对原始对象进行属性注入 --> 将代ç�†å¯¹è±¡ä¿�存到容器中â€� +* obj2:“创建 --> 属性注入 --> 生æˆ�代ç�†å¯¹è±¡ --> ä¿�存到容器中â€� -×îÖÕÁ½Õß¶¼´æÈëÁËÈÝÆ÷ÖУ¬´ïµ½ÁËÔ¤ÆÚµÄÄ¿±ê¡£ +最终两者都存入了容器中,达到了预期的目标。 -#### 3.3 ´ÓÄ£ÄâÖеõ½µÄ½áÂÛ +#### 3.3 从模拟中得到的结论 -¶Ô±ÈÉÏÃæÁ½¸öÄ£Äâ´úÂ룬·¢ÏÖÄ£Äâ 2 Ö® ËùÒÔÄÜ´ïµ½Ô¤ÆÚÄ¿±ê£¬Ö÷ÒªÊÇÒòΪÔÚ×¢Èë `obj2` µÄ `obj1` ÊôÐÔʱ£¬ÌáǰÉú³ÉÁË `obj1` µÄ´úÀí¶ÔÏó `proxyObj1`£¬Ê¹µÃ `obj2` ÄÜÍê³ÉÕû¸ö´´½¨Á÷³Ì¡£ÕâÀïÔÙ´ÎÖ¤Ã÷£¬Ìṩ½øÐÐ aop ¶ÔÑ­»·ÒÀÀµµÄ½â¾öÆðµ½ÖÁ¹ØÖØÒªµÄ×÷Óã¡ +对比上é�¢ä¸¤ä¸ªæ¨¡æ‹Ÿä»£ç �,å�‘现模拟 2 之 所以能达到预期目标,主è¦�是因为在注入 `obj2` çš„ `obj1` 属性时,æ��å‰�生æˆ�了 `obj1` 的代ç�†å¯¹è±¡ `proxyObj1`,使得 `obj2` 能完æˆ�整个创建æµ�程。这里å†�次è¯�明,æ��供进行 aop 对循环ä¾�赖的解决起到至关é‡�è¦�的作用ï¼� -ÏÞÓÚÆª·ù£¬±¾ÎľÍÏȵ½ÕâÀïÁË£¬±¾ÎÄÖ÷Òª·ÖÎöÁËÑ­»·ÒÀÀµµÄ²úÉú£¬½éÉÜÁË spring ½â¾öÑ­»·ÒÀÀµµÄ²½Ö裬×îºóͨ¹ýÁ½¶Î´úÂëÄ£ÄâÁËÑ­»·ÒÀÀµµÄ½â¾ö£¬ÏÂһƪÎÄÕÂÎÒÃǽ«´Ó spring Ô´Âë·ÖÎö spring ÊÇÈçºÎ½â¾öÑ­»·ÒÀÀµµÄ¡£ +é™�于篇幅,本文就先到这里了,本文主è¦�分æž�了循环ä¾�赖的产生,介ç»�了 spring 解决循环ä¾�赖的步骤,最å�Žé€šè¿‡ä¸¤æ®µä»£ç �模拟了循环ä¾�赖的解决,下一篇文章我们将从 spring æº�ç �分æž� spring 是如何解决循环ä¾�赖的。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4659555](https://my.oschina.net/funcy/blog/4659555) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4659555](https://my.oschina.net/funcy/blog/4659555) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\272\214\357\274\211\357\274\232\346\272\220\347\240\201\345\210\206\346\236\220.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\272\214\357\274\211\357\274\232\346\272\220\347\240\201\345\210\206\346\236\220.md" index 06fe618..2bc3c54 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\272\214\357\274\211\357\274\232\346\272\220\347\240\201\345\210\206\346\236\220.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\345\276\252\347\216\257\344\276\235\350\265\226\347\232\204\350\247\243\345\206\263\357\274\210\344\272\214\357\274\211\357\274\232\346\272\220\347\240\201\345\210\206\346\236\220.md" @@ -1,24 +1,24 @@ -ÔÚ [spring Ì½ÃØÖ®Ñ­»·ÒÀÀµ£¨Ò»£©£ºÀíÂÛ»ùʯ](https://my.oschina.net/funcy/blog/4659555 "springÌ½ÃØÖ®Ñ­»·ÒÀÀµ£¨Ò»£©£ºÀíÂÛ»ùʯ")Ò»ÎÄÖÐ £¬ÎÒÃÇÌáµ½ spring ½â¾öÑ­»·ÒÀÀµµÄÁ÷³ÌÈçÏÂ: +在 [spring 探秘之循环ä¾�赖(一):ç�†è®ºåŸºçŸ³](https://my.oschina.net/funcy/blog/4659555 "spring探秘之循环ä¾�赖(一):ç�†è®ºåŸºçŸ³")一文中 ,我们æ��到 spring 解决循环ä¾�èµ–çš„æµ�程如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-dc325a87b321e4c246a1b2f14169821a75a.png) -ΪÁËÄÜÈÃÒÔÉÏÁ÷³ÌÄÜ˳Àû½øÐУ¬spring ÖÐÓÖÌṩÁË 5 ¸öÊý¾Ý½á¹¹À´±£´æÁ÷³ÌÖвúÉúµÄ¹Ø¼üÐÅÏ¢£¬Õâ 5 ¸öÊý¾Ý½á¹¹ÈçÏ£¨ÏÂÎĽ«Õâ 5 ¸öÊý¾Ý½á¹¹³ÆÎª **5 ´ó½á¹¹**£©£º +为了能让以上æµ�程能顺利进行,spring 中å�ˆæ��供了 5 个数æ�®ç»“æž„æ�¥ä¿�å­˜æµ�程中产生的关键信æ�¯ï¼Œè¿™ 5 个数æ�®ç»“构如下(下文将这 5 个数æ�®ç»“构称为 **5 大结构**): -| ½á¹¹ | ˵Ã÷ | +| 结构 | 说明 | | ------------------------------- | ------------------------------------------------------------ | -| `singletonObjects` | **Ò»¼¶»º´æ**£¬ÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇÍêÕûµÄ `spring bean`£¬¼´Íê³ÉÊôÐÔ×¢Èë¡¢³õʼ»¯µÄ bean£¬Èç¹û bean ÐèÒª aop£¬´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó | -| `earlySingletonObjects` | **¶þ¼¶»º´æ**£¬ÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ÊÇʵÀý»¯Íê³É£¬µ«Î´½øÐÐÒÀÀµ×¢ÈëµÄ `bean`£¬**Èç¹û `bean` ÐèÒª `aop`£¬ÕâÀï´æ´¢µÄ¾ÍÊÇ´úÀí¶ÔÏó£¬Ö»²»¹ý´úÀí¶ÔÏóËù³ÖÓеÄԭʼ¶ÔÏó²¢Î´½øÐÐÒÀÀµ×¢Èë** | -| `singletonFactories` | **Èý¼¶»º´æ**£¬ÀàÐÍΪ `HashMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry` ÀàÖУ¬`key` Ϊ `beanName`£¬`value` ´æ´¢µÄÊÇÒ»¸ö `lambda` ±í´ïʽ£º`() -> getEarlyBeanReference(beanName, mbd, bean)`£¬`getEarlyBeanReference(xxx)` ÖÐµÄ `bean` ÊǸմ´½¨Íê³ÉµÄ `java bean`£¬Ã»ÓнøÐÐ spring ÒÀÀµ×¢È룬Ҳû½øÐÐ aop | -| `singletonsCurrentlyInCreation` | ÀàÐÍΪ `SetFromMap`£¬Î»ÓÚ `DefaultSingletonBeanRegistry`£¬´´½¨·½Ê½Îª `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`£¬±íÃ÷ÕâÊǸöÓÉ `ConcurrentHashMap` ʵÏÖµÄ set£¬´æ´¢µÄÊÇÕýÔÚ´´½¨ÖеĶÔÏ󣬿ÉÒÔ**ÓÃÀ´Åжϵ±Ç°¶ÔÏóÊÇ·ñÔÚ´´½¨ÖÐ** | -| `earlyProxyReferences` | ÀàÐÍΪ `ConcurrentHashMap`£¬Î»ÓÚ `AbstractAutoProxyCreator`£¬´æ´¢µÄÊÇÌáǰ½øÐÐ aop µÄ¶ÔÏ󣬿ÉÒÔ**ÓÃÀ´ÅÐ¶Ï bean ÊÇ·ñ½øÐйý aop£¬±£Ö¤Ã¿¸ö¶ÔÏóÖ»½øÐÐÒ»´Î aop** | +| `singletonObjects` | **一级缓存**,类型为 `ConcurrentHashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是完整的 `spring bean`,å�³å®Œæˆ�属性注入ã€�åˆ�始化的 bean,如果 bean 需è¦� aop,存储的就是代ç�†å¯¹è±¡ | +| `earlySingletonObjects` | **二级缓存**,类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 是实例化完æˆ�,但未进行ä¾�赖注入的 `bean`,**如果 `bean` 需è¦� `aop`,这里存储的就是代ç�†å¯¹è±¡ï¼Œå�ªä¸�过代ç�†å¯¹è±¡æ‰€æŒ�有的原始对象并未进行ä¾�赖注入** | +| `singletonFactories` | **三级缓存**,类型为 `HashMap`,ä½�于 `DefaultSingletonBeanRegistry` 类中,`key` 为 `beanName`,`value` 存储的是一个 `lambda` 表达å¼�:`() -> getEarlyBeanReference(beanName, mbd, bean)`,`getEarlyBeanReference(xxx)` 中的 `bean` 是刚创建完æˆ�çš„ `java bean`,没有进行 spring ä¾�赖注入,也没进行 aop | +| `singletonsCurrentlyInCreation` | 类型为 `SetFromMap`,ä½�于 `DefaultSingletonBeanRegistry`,创建方å¼�为 `Collections.newSetFromMap(new ConcurrentHashMap<>(16))`,表明这是个由 `ConcurrentHashMap` 实现的 set,存储的是正在创建中的对象,å�¯ä»¥**用æ�¥åˆ¤æ–­å½“å‰�对象是å�¦åœ¨åˆ›å»ºä¸­** | +| `earlyProxyReferences` | 类型为 `ConcurrentHashMap`,ä½�于 `AbstractAutoProxyCreator`,存储的是æ��å‰�进行 aop 的对象,å�¯ä»¥**用æ�¥åˆ¤æ–­ bean 是å�¦è¿›è¡Œè¿‡ aop,ä¿�è¯�æ¯�个对象å�ªè¿›è¡Œä¸€æ¬¡ aop** | -Á˽âÁËÕâЩ֮ºó£¬½ÓÏÂÀ´ÎÒÃǾÍÕýʽ¿ªÊ¼½øÐÐÔ´Âë·ÖÎöÁË¡£ +了解了这些之å�Žï¼ŒæŽ¥ä¸‹æ�¥æˆ‘们就正å¼�开始进行æº�ç �分æž�了。 -### 1\. ×¼±¸ demo +### 1\. 准备 demo -±¾ÎÄÖеÄʾÀý demo λÓÚ [gitee.com/funcy](https://gitee.com/funcy/spring-framework/tree/v5.2.2.RELEASE_learn/spring-learn/src/main/java/org/springframework/learn/explore/demo03 "gitee.com/funcy")£¬ÕâÀï½ö¸ø³ö¹Ø¼ü´úÂë¡£ +本文中的示例 demo ä½�于 [gitee.com/funcy](https://gitee.com/funcy/spring-framework/tree/v5.2.2.RELEASE_learn/spring-learn/src/main/java/org/springframework/learn/explore/demo03 "gitee.com/funcy"),这里仅给出关键代ç �。 -×¼±¸Á½¸ö service£ºservice1£¬service2£¬ÕâÁ½¸ö service Àï¶¼ÓÐÒ»¸ö´úÀí·½·¨£º +准备两个 service:service1,service2,这两个 service 里都有一个代ç�†æ–¹æ³•: ``` @Service @@ -28,11 +28,11 @@ public class Service1 { private Service2 service2; public Service1() { - System.out.println("µ÷ÓÃservice1µÄ¹¹Ôì·½·¨"); + System.out.println("调用service1的构造方法"); } /** - * ±ê×¢ @AopAnnotation ÁË£¬±íÃ÷Õâ¸ö·½·¨Òª±»´úÀí + * 标注 @AopAnnotation 了,表明这个方法è¦�被代ç�† */ @AopAnnotation public void printAutowired() { @@ -52,11 +52,11 @@ public class Service2 { private Service1 service1; public Service2() { - System.out.println("µ÷ÓÃservice2µÄ¹¹Ôì·½·¨"); + System.out.println("调用service2的构造方法"); } /** - * ±ê×¢ @AopAnnotation ÁË£¬±íÃ÷Õâ¸ö·½·¨Òª±»´úÀí + * 标注 @AopAnnotation 了,表明这个方法è¦�被代ç�† */ @AopAnnotation public void printAutowired() { @@ -71,7 +71,7 @@ public class Service2 { ``` -ÕâÀïÊÇÖ÷Àࣺ +这里是主类: ``` public class Demo03Main { @@ -88,11 +88,11 @@ public class Demo03Main { ``` -ÔÚ `Service1` ÖУ¬ÐèҪעÈëÊôÐÔ `service2`£¬ÔÚÔÚ `Service2` ÖУ¬ÐèҪעÈëÊôÐÔ `service1`£¬ÇÒ `Service1`¡¢`Service2` ¶¼ÐèÒª½øÐдúÀí£¬×îÖÕ `main()` ·½·¨Ö´Ðнá¹ûÈçÏ£º +在 `Service1` 中,需è¦�注入属性 `service2`,在在 `Service2` 中,需è¦�注入属性 `service1`,且 `Service1`ã€�`Service2` 都需è¦�进行代ç�†ï¼Œæœ€ç»ˆ `main()` 方法执行结果如下: ``` -µ÷ÓÃservice1µÄ¹¹Ôì·½·¨ -µ÷ÓÃservice2µÄ¹¹Ôì·½·¨ +调用service1的构造方法 +调用service2的构造方法 Disconnected from the target VM, address: 'localhost:55518', transport: 'socket' Connected to the target VM, address: '127.0.0.1:55507', transport: 'socket' @Around: before execute... @@ -104,30 +104,30 @@ Service2 Autowired:class org.springframework.learn.explore.demo03.Service1$$Enha ``` -µÃµ½µÄ obj1¡¢obj2 ·Ö±ðΪ +得到的 obj1ã€�obj2 分别为 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-201844d13a7b489d1a18a8218d6440d6068.png) ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-3781280ce3f4da91504b0665ebfd3aed05b.png) -·ÖÎöÄÚÈÝ£¬²»ÄѵóöÈçϽáÂÛ£º +分æž�内容,ä¸�难得出如下结论: -* `service1` Óë `service2` µÄ `printAutowired()` ·½·¨¶¼Êä³öÁËÇÐÃæ·½·¨µÄÄÚÈÝ£¬±íÃ÷Á½Õß¶¼´úÀí³É¹¦ÁË£» -* ´ÓÈÝÆ÷ÖлñÈ¡µÄµÄ `service1` Óë `service2` ¶¼ÊÇ´úÀí¶ÔÏó£» -* `service1` µÄ´úÀí¶ÔÏó³ÖÓÐ `service1` µÄԭʼ¶ÔÏó£¬`service2` µÄ´úÀí¶ÔÏó³ÖÓÐ `service2` µÄԭʼ¶ÔÏó£» -* `service1` µÄԭʼ¶ÔÏóÖÐ×¢ÈëµÄ `service2` Ϊ´úÀí¶ÔÏó£¬`service2` µÄԭʼ¶ÔÏóÖÐ×¢ÈëµÄ `service1` Ϊ´úÀí¶ÔÏó¡£ +* `service1` 与 `service2` çš„ `printAutowired()` 方法都输出了切é�¢æ–¹æ³•的内容,表明两者都代ç�†æˆ�功了; +* 从容器中获å�–的的 `service1` 与 `service2` 都是代ç�†å¯¹è±¡ï¼› +* `service1` 的代ç�†å¯¹è±¡æŒ�有 `service1` 的原始对象,`service2` 的代ç�†å¯¹è±¡æŒ�有 `service2` 的原始对象; +* `service1` 的原始对象中注入的 `service2` 为代ç�†å¯¹è±¡ï¼Œ`service2` 的原始对象中注入的 `service1` 为代ç�†å¯¹è±¡ã€‚ -½ÓÏÂÀ´£¬ÎÒÃǾʹÓÔ´Âë·ÖÎö£¬¿´ spring ÊÇÈçºÎÒ»²½²½ÔËÐУ¬×îÖյõ½Õâ¸ö½á¹ûµÄ¡£ +接下æ�¥ï¼Œæˆ‘们就从æº�ç �分æž�,看 spring 是如何一步步è¿�行,最终得到这个结果的。 -> `service1` Óë `service2` µÄ´úÀí¶ÔÏóÊÇÓÉ `cglib` ´úÀí²úÉúµÄ£¬Õⲿ·ÖÄÚÈÝÓë±¾ÎÄÎ޹أ¬¾Í²»·ÖÎöÁË¡£ +> `service1` 与 `service2` 的代ç�†å¯¹è±¡æ˜¯ç”± `cglib` 代ç�†äº§ç”Ÿçš„,这部分内容与本文无关,就ä¸�分æž�了。 -### 2\. µÚÒ»´Îµ÷Óà `AbstractBeanFactory#getBean(String)`£º»ñÈ¡ `service1` +### 2\. 第一次调用 `AbstractBeanFactory#getBean(String)`:获å�– `service1` -spring bean µÄ´´½¨¡¢ÒÀÀµ×¢ÈëÁ÷³ÌÊÇ´Ó `AbstractBeanFactory#getBean(String)` ·½·¨¿ªÊ¼£¬ÕâÒ»µã¿É²Î¿¼ [spring Æô¶¯Á÷³ÌÖ®Íê³É BeanFactory µÄ³õʼ»¯](https://my.oschina.net/funcy/blog/4658230)£¬ÎÒÃǵÄÔ´Âë·ÖÎöÒ²´ÓÕâ¸ö·½·¨ÈëÊÖ¡£ +spring bean 的创建ã€�ä¾�赖注入æµ�程是从 `AbstractBeanFactory#getBean(String)` 方法开始,这一点å�¯å�‚考 [spring å�¯åЍæµ�程之完æˆ� BeanFactory çš„åˆ�始化](https://my.oschina.net/funcy/blog/4658230),我们的æº�ç �分æž�也从这个方法入手。 -±¾ÎÄÒ»¿ªÊ¼£¬¾ÍÌáµ½ÁË spring Ϊ½â¾öÑ­»·ÒÀÀµµÄ 5 ´ó½á¹¹£¬ÕâÀïչʾÈçÏ£º +本文一开始,就æ��到了 spring 为解决循环ä¾�èµ–çš„ 5 大结构,这里展示如下: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ---- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -135,13 +135,13 @@ spring bean | `singletonsCurrentlyInCreation` | | | `earlyProxyReferences` | | -Ò»¿ªÊ¼£¬5 ´ó½á¹¹ÖйØÓÚ `service1` Óë `service2` µÄʲôÊý¾Ý¶¼Ã»ÓÐ £¬½ÓÏÂÀ´£¬ÎÒÃÇÒ»±ß·ÖÎö´úÂ룬һ±ß¹Ø×¢Õ⼸¸ö½á¹¹ÖеÄÄÚÈÝ¡£ +一开始,5 大结构中关于 `service1` 与 `service2` 的什么数æ�®éƒ½æ²¡æœ‰ ,接下æ�¥ï¼Œæˆ‘们一边分æž�代ç �,一边关注这几个结构中的内容。 -> ÊÂʵÉÏ£¬5 ´ó½á¹¹ÊÇÓÐÄÚÈݵģ¬ÄÇÊÇ spring ÄÚ²¿ÌṩµÄһЩ bean£¬µ«ÓÉÓÚÎÒÃÇÖ»¹Ø×¢ `service1` Óë `service2` Ïà¹ØµÄÄÚÈÝ£¬Òò´ËÕâÀﲻչʾ¡£ +> 事实上,5 大结构是有内容的,那是 spring 内部æ��供的一些 bean,但由于我们å�ªå…³æ³¨ `service1` 与 `service2` 相关的内容,因此这里ä¸�展示。 ### 2.1 `AbstractBeanFactory#doGetBean` -»ñÈ¡ `service1` µÄ´úÂëÔÚ `AbstractBeanFactory#getBean(String)`£¬µ«ÕæÕýµÄ»ñÈ¡²Ù×÷È´ÊÇÔÚ `AbstractBeanFactory#doGetBean` ÖУ¬µ÷ÓÃÁ´ÈçÏ£º +获å�– `service1` 的代ç �在 `AbstractBeanFactory#getBean(String)`,但真正的获å�–æ“�作å�´æ˜¯åœ¨ `AbstractBeanFactory#doGetBean` 中,调用链如下: ``` |-AbstractBeanFactory#getBean(String) @@ -149,22 +149,22 @@ spring bean ``` -´úÂëÈçÏ£º +代ç �如下: ``` protected T doGetBean(final String name, @Nullable final Class requiredType, @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException { ... - // 1\. ¼ì²éÊÇ·ñÒѳõʼ»¯£¬ÕâÀï»á°ÑbeanName·ÅÈësingletonsCurrentlyInCreationÖÐ + // 1\. 检查是å�¦å·²åˆ�始化,这里会把beanName放入singletonsCurrentlyInCreation中 Object sharedInstance = getSingleton(beanName); ... - // Èç¹ûÊǵ¥ÀýµÄ + // 如果是å�•例的 if (mbd.isSingleton()) { - // 2\. getSingleton(): ´´½¨¶ÔÏó£¬É¾³ý¶þ¡¢Èý¼¶»º´æ + // 2\. getSingleton(): 创建对象,删除二ã€�三级缓存 sharedInstance = getSingleton(beanName, () -> { try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } catch (BeansException ex) { @@ -172,8 +172,8 @@ spring bean throw ex; } }); - // ÕâÀïÈç¹ûÊÇÆÕͨBean µÄ»°£¬Ö±½Ó·µ»Ø£¬Èç¹ûÊÇ FactoryBean µÄ»°£¬ - // ·µ»ØËü´´½¨µÄÄǸöʵÀý¶ÔÏó + // 这里如果是普通Bean çš„è¯�,直接返回,如果是 FactoryBean çš„è¯�, + // 返回它创建的那个实例对象 bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd); } ... @@ -181,14 +181,14 @@ spring bean ``` -ÒÔÉÏ´úÂë¾­¹ýÁ˾«¼ò£¬ÎÒÃÇÖ»±£ÁôÁËÖ÷ÒªÁ÷³Ì£¨ºóÐø·ÖÎöÖУ¬Ò²»á¾«¼ò´úÂ룬ֻ±£ÁôÖ÷ÒªÁ÷³Ì£¬Ê¡ÂÔÎ޹شúÂ룩£¬Õâ¸ö·½·¨ÓÐÁ½¸öµØ·½ÐèÒª·ÖÎö£º +以上代ç �ç»�过了精简,我们å�ªä¿�留了主è¦�æµ�程(å�Žç»­åˆ†æž�中,也会精简代ç �,å�ªä¿�留主è¦�æµ�程,çœ�略无关代ç �),这个方法有两个地方需è¦�分æž�: -1. `getSingleton(beanName)`£º»ñÈ¡¶ÔÏó£¬Ö»´ÓÈý¸ö»º´æÖлñÈ¡£» -2. `getSingleton(beanName, () -> { ... })`£º»ñÈ¡¶ÔÏ󣬴´½¨»áÔÚÕâÀï´´½¨¡£ +1. `getSingleton(beanName)`:获å�–对象,å�ªä»Žä¸‰ä¸ªç¼“存中获å�–ï¼› +2. `getSingleton(beanName, () -> { ... })`:获å�–对象,创建会在这里创建。 #### 2.2 `DefaultSingletonBeanRegistry#getSingleton(String, boolean)` -ÎÒÃÇÏÈÀ´¿´¿´ `getSingleton(beanName)`£¬µ÷ÓÃÁ´ÈçÏ£º +我们先æ�¥çœ‹çœ‹ `getSingleton(beanName)`,调用链如下: ``` |-AbstractBeanFactory#getBean(String) @@ -198,19 +198,19 @@ spring bean ``` -Ö±½Ó¿´´úÂ룺 +直接看代ç �: ``` /* - * beanName: ´«ÈëµÄֵΪ service1 - * allowEarlyReference£º´«ÈëµÄֵΪ true + * beanName: 传入的值为 service1 + * allowEarlyReference:传入的值为 true */ protected Object getSingleton(String beanName, boolean allowEarlyReference) { - // 1\. ´ÓÒ»¼¶»º´æÖлñÈ¡£¬ÕâÀïÊÇ»ñÈ¡²»µ½ + // 1\. 从一级缓存中获å�–,这里是获å�–ä¸�到 Object singletonObject = this.singletonObjects.get(beanName); - // 2\. isSingletonCurrentlyInCreation(...) ÅжÏservice1ÊÇ·ñÔÚ´´½¨ÖУ¬·µ»Ø false + // 2\. isSingletonCurrentlyInCreation(...) 判断service1是å�¦åœ¨åˆ›å»ºä¸­ï¼Œè¿”回 false if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { - // Ê¡ÂÔÏÂÃæµÄ´úÂë + // çœ�略下é�¢çš„代ç � ... } return singletonObject; @@ -218,11 +218,11 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` -¶ÔÉÏÊö´úÂë·ÖÎöÈçÏ£º +对上述代ç �分æž�如下: -1. ´ÓÈý¼¶»º´æÖлñÈ¡£¬´Ëʱ `singletonObjects` ÀﲢûÓÐ `service1`£¬»ñÈ¡²»µ½£» +1. 从三级缓存中获å�–,此时 `singletonObjects` 里并没有 `service1`,获å�–ä¸�到; -2. ¼ÌÐø£¬ÅÐ¶Ï `service1` ÊÇ·ñÔÚ´´½¨ÖУ¬ÅжϷ½Ê½ÈçÏ£º +2. 继续,判断 `service1` 是å�¦åœ¨åˆ›å»ºä¸­ï¼Œåˆ¤æ–­æ–¹å¼�如下: ``` public boolean isSingletonCurrentlyInCreation(String beanName) { @@ -231,21 +231,21 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` - ÏÔÈ»£¬`singletonsCurrentlyInCreation` ÊÇûÓÐ `service1` µÄ£¬ÕâÀïÒ²·µ»Ø false. + 显然,`singletonsCurrentlyInCreation` 是没有 `service1` 的,这里也返回 false. -`DefaultSingletonBeanRegistry#getSingleton(String, boolean)` ÔËÐе½ÕâÀï¾Í·µ»ØÁË£¬Õâ¸ö·½·¨ÀïÏÂÃæµÄ·µ»ØÎÒÃǾÍÏȲ»·ÖÎöÁË¡£ +`DefaultSingletonBeanRegistry#getSingleton(String, boolean)` è¿�行到这里就返回了,这个方法里下é�¢çš„返回我们就先ä¸�分æž�了。 #### 2.3 `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` -ÈÃÎÒÃǻص½ `AbstractBeanFactory#doGetBean`£¬½Ó×Å·ÖÎö `getSingleton(beanName, () -> { ... })`£¬´úÂëÈçÏ£º +让我们回到 `AbstractBeanFactory#doGetBean`,接ç�€åˆ†æž� `getSingleton(beanName, () -> { ... })`,代ç �如下: ``` /** - * beanName£º´«ÈëµÄÊÇservice1 - * singletonFactory£º´«ÈëµÄÊÇlambda±í´ïʽ£¬ÖµÎª + * beanName:传入的是service1 + * singletonFactory:传入的是lambda表达å¼�,值为 * () -> { * try { - * // ÕâÀï¾ÍÊÇ´´½¨beanµÄÁ÷³Ì + * // 这里就是创建beançš„æµ�程 * return createBean(beanName, mbd, args); * } * catch (BeansException ex) { @@ -257,14 +257,14 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { public Object getSingleton(String beanName, ObjectFactory singletonFactory) { Assert.notNull(beanName, "Bean name must not be null"); synchronized (this.singletonObjects) { - // ÔÙ´ÎÅжÏbeanÊÇ·ñÒÑ´æÔÚ + // å†�次判断bean是å�¦å·²å­˜åœ¨ Object singletonObject = this.singletonObjects.get(beanName); if (singletonObject == null) { - // 1\. Åжϵ±Ç°ÕýÔÚʵÀý»¯µÄbeanÊÇ·ñ´æÔÚÕýÔÚ´´½¨ÖÐ - // Õâ¸ö·½·¨»ábeanNameÌí¼Óµ½ singletonsCurrentlyInCreation ÖÐ + // 1\. 判断当å‰�正在实例化的bean是å�¦å­˜åœ¨æ­£åœ¨åˆ›å»ºä¸­ + // 这个方法会beanName添加到 singletonsCurrentlyInCreation 中 beforeSingletonCreation(beanName); try { - // 2\. ÔÚÕâÀï½øÐÐbeanµÄ´´½¨ + // 2\. 在这里进行bean的创建 singletonObject = singletonFactory.getObject(); } catch (...) { @@ -278,13 +278,13 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` -°´ÕÕ´úÂëÖеÄ×¢ÊÍÄÚÈÝ£¬ÎÒÃÇ·ÖÎöÖ÷Òª²½Ö裺 +按照代ç �中的注释内容,我们分æž�主è¦�步骤: -1. Åжϵ±Ç°ÕýÔÚʵÀý»¯µÄ bean ÊÇ·ñ´æÔÚÕýÔÚ´´½¨ÖУ¬¾ÍÊÇÅжϵ±Ç°¶ÔÏóÊÇ·ñÔÚ `singletonsCurrentlyInCreation` ÖУ¬Èç¹û´æÔÚÔòÅ׳öÒì³££¬²»´æÔÚÔòÌí¼Óµ½ `singletonsCurrentlyInCreation` ÖУ» +1. 判断当å‰�正在实例化的 bean 是å�¦å­˜åœ¨æ­£åœ¨åˆ›å»ºä¸­ï¼Œå°±æ˜¯åˆ¤æ–­å½“å‰�对象是å�¦åœ¨ `singletonsCurrentlyInCreation` 中,如果存在则抛出异常,ä¸�存在则添加到 `singletonsCurrentlyInCreation` 中; - ÔËÐÐÍêÖ®ºóÕâÒ»ÐдúÂëºó£¬5 ´ó½á¹¹ÖеÄÄÚÈÝÈçÏ£º + è¿�行完之å�Žè¿™ä¸€è¡Œä»£ç �å�Žï¼Œ5 大结构中的内容如下: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | -------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -292,12 +292,12 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | | -2. ½øÐÐ bean µÄ´´½¨¹ý³Ì£¬`singletonFactory.getObject()` ÔËÐеÄʵ¼ÊÉÏÊÇ´«ÈëµÄ lambda ±í´ïʽ£º +2. 进行 bean 的创建过程,`singletonFactory.getObject()` è¿�行的实际上是传入的 lambda 表达å¼�: ``` () -> { try { - // Ö´Ðд´½¨ Bean + // 执行创建 Bean return createBean(beanName, mbd, args); } catch (BeansException ex) { @@ -308,11 +308,11 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` - Ò²¾ÍÊÇ `AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])`£¬Õâ ¸ö·½·¨ÊǽÓÏÂÀ´·ÖÎöµÄÖØµã£» + 也就是 `AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])`,这 个方法是接下æ�¥åˆ†æž�çš„é‡�点; #### 2.4 `AbstractAutowireCapableBeanFactory#doCreateBean` -´Ó´úÂëÉÏÀ´¿´£¬`AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])` ²¢Ã»ÓÐ×öʲôʵÖÊÐÔÄÚÈÝ£¬ÎÒÃǾÍÖ±½ÓÀ´µ½ `AbstractAutowireCapableBeanFactory#doCreateBean` ÁË£¬ÕâÆäÖо­ÀúµÄǧɽÍòË®ÈçÏ£º +从代ç �上æ�¥çœ‹ï¼Œ`AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[])` 并没有å�šä»€ä¹ˆå®žè´¨æ€§å†…容,我们就直接æ�¥åˆ° `AbstractAutowireCapableBeanFactory#doCreateBean` 了,这其中ç»�历的å�ƒå±±ä¸‡æ°´å¦‚下: ``` |-AbstractBeanFactory#getBean(String) @@ -323,7 +323,7 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` -`AbstractAutowireCapableBeanFactory#doCreateBean` ÄÚÈÝÈçÏ£º +`AbstractAutowireCapableBeanFactory#doCreateBean` 内容如下: ``` protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, @@ -331,12 +331,12 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb BeanWrapper instanceWrapper = null; if (instanceWrapper == null) { - // 1\. ʵÀý»¯ Bean£¬µ÷ÓÃjava·´Éä½øÐÐʵÀý»¯ + // 1\. 实例化 Bean,调用javaå��射进行实例化 instanceWrapper = createBeanInstance(beanName, mbd, args); } - //beanʵÀý + //bean实例 final Object bean = instanceWrapper.getWrappedInstance(); - //beanÀàÐÍ + //bean类型 Class beanType = instanceWrapper.getWrappedClass(); if (beanType != NullBean.class) { mbd.resolvedTargetType = beanType; @@ -345,8 +345,8 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb synchronized (mbd.postProcessingLock) { if (!mbd.postProcessed) { try { - // µ÷Óà AutowiredAnnotationBeanPostProcessor#postProcessMergedBeanDefinition ·½·¨ - // 2\. »ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¨±ê×¢ @Autowired ×¢½â£© + // 调用 AutowiredAnnotationBeanPostProcessor#postProcessMergedBeanDefinition 方法 + // 2\. 获å�–需è¦�注入的属性与方法(标注 @Autowired 注解) applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName); } catch (Throwable ex) { @@ -356,17 +356,17 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb mbd.postProcessed = true; } } - // ½â¾öÑ­»·ÒÀÀµÎÊÌâ, ÊÇ·ñÔÊÐíÑ­»·ÒÀÀµ, allowCircularReferencesĬÈÏΪtrue£¬¿ÉÒÔ¹Ø±Õ + // 解决循环ä¾�赖问题, 是å�¦å…�许循环ä¾�èµ–, allowCircularReferences默认为true,å�¯ä»¥å…³é—­ boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences && isSingletonCurrentlyInCreation(beanName)); if (earlySingletonExposure) { - // 3\. ½« bean Ìí¼Óµ½ singletonFactories + // 3\. å°† bean 添加到 singletonFactories addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean)); } Object exposedObject = bean; try { - // 4\. ÊôÐÔ×¢È룬·¢ÏÖÐèҪעÈë service2£¬È»ºóÔÙµ÷Óà getBean("service2") + // 4\. 属性注入,å�‘现需è¦�注入 service2,然å�Žå†�调用 getBean("service2") populateBean(beanName, mbd, instanceWrapper); ... } @@ -377,25 +377,25 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` -Õâ¸ö·½·¨½øÐеIJ½ÖèÈçÏ£º +这个方法进行的步骤如下: -1. ʵÀý»¯ Bean£¬µ÷Óà java ·´Éä½øÐÐʵÀý»¯£¬Õâ¸ö¾Í²»¶à˵ÁË£¬ÊµÀý»¯ºóµÄ `service1` ÈçÏ£¬¿ÉÒÔ¿´µ½ `service2` »¹ÊÇ `null`£¨±íÃ÷δ½øÐÐÊôÐÔ×¢È룩£º +1. 实例化 Bean,调用 java å��射进行实例化,这个就ä¸�多说了,实例化å�Žçš„ `service1` 如下,å�¯ä»¥çœ‹åˆ° `service2` 还是 `null`(表明未进行属性注入): ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-8b2f5fdf0efd6beb7f62d4f35f5c5562b83.png) -2. »ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¬**±ØÐëÔÚԭʼ¶ÔÏóÖвÅÄÜ»ñÈ¡µ½£¬´úÀí¶ÔÏóÊÇ»ñÈ¡²»µ½µÄ**£¬²éÕÒ `@Autowired` µÄ `beanPostProcessor` ÊÇ `AutowiredAnnotationBeanPostProcessor`£» +2. 获å�–需è¦�注入的属性与方法,**必须在原始对象中æ‰�能获å�–到,代ç�†å¯¹è±¡æ˜¯èŽ·å�–ä¸�到的**,查找 `@Autowired` çš„ `beanPostProcessor` 是 `AutowiredAnnotationBeanPostProcessor`ï¼› -3. ½« bean Ìí¼Óµ½ `singletonFactories` ÖУ¬Ìí¼Ó¹ý³ÌÈçÏ£º +3. å°† bean 添加到 `singletonFactories` 中,添加过程如下: ``` protected void addSingletonFactory(String beanName, ObjectFactory singletonFactory) { Assert.notNull(singletonFactory, "Singleton factory must not be null"); synchronized (this.singletonObjects) { - // Èç¹ûµ¥Àý³Øµ±Öв»´æÔڲŻáadd + // 如果å�•例池当中ä¸�存在æ‰�会add if (!this.singletonObjects.containsKey(beanName)) { - // °Ñ¹¤³§¶ÔÏóputµ½singletonFactories + // 把工厂对象put到singletonFactories this.singletonFactories.put(beanName, singletonFactory); - // ɾ³ý¶þ¼¶»º´æÖеĶÔÏó + // 删除二级缓存中的对象 this.earlySingletonObjects.remove(beanName); this.registeredSingletons.add(beanName); } @@ -404,13 +404,13 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` - ¼ÓÈëµÄ¶ÔÏóΪ + 加入的对象为 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-3d9a56a0d655fe1e95d8857095fb46aa71a.png) - ´ËʱÄÇ 5 ¸ö½á¹¹ÖеÄÄÚÈÝÈçÏ£º + 此时那 5 个结构中的内容如下: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ---------------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -418,11 +418,11 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | | - `lambda(service1)` ʵ¼ÊÄÚÈÝΪ `() -> getEarlyBeanReference(beanName, mbd, bean)`£¬Õâ¸ö `lambda` ±í´ïʽËù×öµÄ¾ÍÊǽøÐÐ aop ²Ù×÷£¬¾ßÌåÄÚÈݵÈÔËÐеÄʱºòÎÒÃÇÔÙ·ÖÎö¡£ + `lambda(service1)` 实际内容为 `() -> getEarlyBeanReference(beanName, mbd, bean)`,这个 `lambda` 表达å¼�所å�šçš„就是进行 aop æ“�作,具体内容等è¿�行的时候我们å†�分æž�。 -4. ÊôÐÔ×¢È룬ÔÚµÚ 2 ²½ÖУ¬spring ÕÒµ½ `service1` ÐèҪעÈë¶ÔÏóÓÐ `service2`£¬ÕâÀï»áÔÙµ÷Óà `beanFactory.getBean("service2")` ½øÈë `service2` µÄÉúÃüÖÜÆÚ£¬ÕâÓֻص½ÁË `AbstractBeanFactory#getBean(String)` ·½·¨¡£ +4. 属性注入,在第 2 步中,spring 找到 `service1` 需è¦�注入对象有 `service2`,这里会å†�调用 `beanFactory.getBean("service2")` 进入 `service2` 的生命周期,这å�ˆå›žåˆ°äº† `AbstractBeanFactory#getBean(String)` 方法。 - ´Ó `populateBean(xxx)` µ½ `getBean(xxx)` µÄ²½ÖèÏ൱¶à£¬µ÷ÓÃÁ´ÈçÏ£º + 从 `populateBean(xxx)` 到 `getBean(xxx)` 的步骤相当多,调用链如下: ``` |-AbstractBeanFactory#getBean(String) @@ -430,7 +430,7 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb |-DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory) |-AbstractAutowireCapableBeanFactory#createBean(String, RootBeanDefinition, Object[]) |-AbstractAutowireCapableBeanFactory#doCreateBean - // ÕâÀï½øÐÐÒÀÀµ×¢Èë + // 这里进行ä¾�赖注入 |-AbstractAutowireCapableBeanFactory#populateBean |-AutowiredAnnotationBeanPostProcessor#postProcessProperties |-InjectionMetadata#inject @@ -442,7 +442,7 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` - ¿´Ò»ÑÛ `DependencyDescriptor#resolveCandidate`£¬µ÷ÓõÄÕýÊÇ `beanFactory.getBean(String)` ·½·¨£º + 看一眼 `DependencyDescriptor#resolveCandidate`,调用的正是 `beanFactory.getBean(String)` 方法: ``` public Object resolveCandidate(String beanName, Class requiredType, BeanFactory beanFactory) @@ -452,11 +452,11 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` -µ½ÁËÕâÀ`service1` µÄ»ñÈ¡Á÷³Ì¾ÍÏÈͣһϣ¬ÒòΪ `service1` ҪעÈë `service2`£¬½ÓÏÂÀ´¾Í¿ªÊ¼»ñÈ¡ `service2` µÄÁ÷³Ì¡£ +到了这里,`service1` 的获å�–æµ�程就先å�œä¸€ä¸‹ï¼Œå› ä¸º `service1` è¦�注入 `service2`,接下æ�¥å°±å¼€å§‹èŽ·å�– `service2` çš„æµ�程。 -±¾Ð¡½Ú½áÊøÊ±£¬5 ´ó½á¹¹ÖеÄÄÚÈÝÈçÏ£º +本å°�节结æ�Ÿæ—¶ï¼Œ5 大结构中的内容如下: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ---------------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -464,23 +464,23 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | | -### 3\. µÚ¶þ´Îµ÷Óà `AbstractBeanFactory#getBean(String)`£º»ñÈ¡ `service2` +### 3\. 第二次调用 `AbstractBeanFactory#getBean(String)`:获å�– `service2` #### 3.1 `AbstractBeanFactory#doGetBean` -ÕâÒ»²½¸ú»ñÈ¡ `service1` µÄÁ÷³Ì»ù±¾Ò»Ö£¬²»Í¬µÄÊÇ `beanName` ÊÇ `service2`£¬²»ÔÙ·ÖÎö¡£ +这一步跟获å�– `service1` çš„æµ�程基本一致,ä¸�å�Œçš„æ˜¯ `beanName` 是 `service2`,ä¸�å†�分æž�。 #### 3.2 `DefaultSingletonBeanRegistry#getSingleton(String, boolean)` -ÕâÒ»²½¸ú»ñÈ¡ `service1` µÄÁ÷³Ì»ù±¾Ò»Ö£¬²»Í¬µÄÊÇ `beanName` ÊÇ `service2`£¬²»ÔÙ·ÖÎö¡£ +这一步跟获å�– `service1` çš„æµ�程基本一致,ä¸�å�Œçš„æ˜¯ `beanName` 是 `service2`,ä¸�å†�分æž�。 #### 3.3 `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` -ÕâÒ»²½¸ú»ñÈ¡ `service1` µÄÁ÷³Ì»ù±¾Ò»Ö£¬²»Í¬µÄÊÇ `beanName` ÊÇ `service2`£¬¾ßÌåÄÚÈݲ»ÔÙ·ÖÎö¡£ +这一步跟获å�– `service1` çš„æµ�程基本一致,ä¸�å�Œçš„æ˜¯ `beanName` 是 `service2`,具体内容ä¸�å†�分æž�。 -`service2` »áÔÚÕâÒ»²½¼ÓÈë µ½ `singletonsCurrentlyInCreation` ½á¹¹ÖУ¬ÕâÒ»²½Ö®ºó£¬5 ´ó½á¹¹ÖеÄÄÚÈÝÈçÏ£º +`service2` 会在这一步加入 到 `singletonsCurrentlyInCreation` 结构中,这一步之å�Žï¼Œ5 大结构中的内容如下: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ------------------ | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -490,19 +490,19 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb #### 3.4 `AbstractAutowireCapableBeanFactory#doCreateBean` -ÕâÒ»²½¸ú»ñÈ¡ `service1` µÄÁ÷³Ì»ù±¾Ò»Ö£¬ËµÃ÷ÈçÏ£º +这一步跟获å�– `service1` çš„æµ�程基本一致,说明如下: -1. ¶ÔÏó´´½¨£¬ÕâÀï»á´´½¨ `service2`£¬´´½¨Íê³ÉºóµÄ¶ÔÏóÈçÏ£º +1. 对象创建,这里会创建 `service2`,创建完æˆ�å�Žçš„对象如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-393811afa91cc1ff696b02ce6d683c97640.png) - ͬÑùµÄ£¬`service2` ÖеÄÊôÐÔ `service1` ҲΪ `null`£» + å�Œæ ·çš„,`service2` 中的属性 `service1` 也为 `null`ï¼› -2. »ñÈ¡ÐèҪעÈëµÄÊôÐÔÓë·½·¨£¬`service2` µÄÊôÐÔ `service1` »á±»ÕÒµ½£¬ÒòΪ¸ÃÊôÐÔ±ê×¢ÓÐ `@Autowired` ×¢½â£» +2. 获å�–需è¦�注入的属性与方法,`service2` 的属性 `service1` 会被找到,因为该属性标注有 `@Autowired` 注解; -3. ½« bean Ìí¼Óµ½ `singletonFactories` ÖУ¬ÕâÒ»²½Ö®ºó£¬5 ¸ö½á¹¹ÖеÄÄÚÈÝÈçÏ£º +3. å°† bean 添加到 `singletonFactories` 中,这一步之å�Žï¼Œ5 个结构中的内容如下: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ---------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -510,15 +510,15 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | | - ÕâÒ»²½µÄ¹Ø¼üÔÚÓÚ£¬`service2` Ìí¼Óµ½Èý¼¶»º´æÖÐÁË£» + 这一步的关键在于,`service2` 添加到三级缓存中了; -4. ÊôÐÔ×¢È룬ÔÚµÚ 2 ²½ÖУ¬spring ÕÒµ½ `service2` ÐèҪעÈë¶ÔÏóÓÐ `service1`£¬ÕâÀï»áÔÙµ÷Óà `getBean("service2")` ·½·¨£¬Óֻص½ÁË `AbstractBeanFactory#getBean(String)` ·½·¨ÁË¡£ +4. 属性注入,在第 2 步中,spring 找到 `service2` 需è¦�注入对象有 `service1`,这里会å†�调用 `getBean("service2")` 方法,å�ˆå›žåˆ°äº† `AbstractBeanFactory#getBean(String)` 方法了。 -µ½ÁËÕâÀ`service2` µÄ»ñÈ¡Á÷³ÌÒ²ÒªÏÈÍ£Ò»ÏÂÁË£¬ÒòΪ `service2` ҪעÈë `service1`£¬½ÓÏÂÀ´ÓÖÒª¿ªÊ¼»ñÈ¡ `service1` µÄÁ÷³Ì¡£ +到了这里,`service2` 的获å�–æµ�程也è¦�å…ˆå�œä¸€ä¸‹äº†ï¼Œå› ä¸º `service2` è¦�注入 `service1`,接下æ�¥å�ˆè¦�开始获å�– `service1` çš„æµ�程。 -±¾Ð¡½Ú½áÊøÊ±£¬5 ¸ö½á¹¹ÖеÄÄÚÈÝÈçÏ£º +本å°�节结æ�Ÿæ—¶ï¼Œ5 个结构中的内容如下: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ---------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -526,53 +526,53 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | | -### 4\. µÚÈý´Îµ÷Óà `AbstractBeanFactory#getBean(String)`£ºÔٴλñÈ¡ `service1` +### 4\. 第三次调用 `AbstractBeanFactory#getBean(String)`:å†�次获å�– `service1` #### 4.1 `AbstractBeanFactory#doGetBean` -`AbstractBeanFactory#doGetBean` ´úÂëÈçÏ£º +`AbstractBeanFactory#doGetBean` 代ç �如下: ``` protected T doGetBean(final String name, @Nullable final Class requiredType, @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException { ... - // 1\. ¼ì²éÊÇ·ñÒѳõʼ»¯£¬ÕâÀï»á°ÑbeanName·ÅÈësingletonsCurrentlyInCreationÖÐ + // 1\. 检查是å�¦å·²åˆ�始化,这里会把beanName放入singletonsCurrentlyInCreation中 Object sharedInstance = getSingleton(beanName); ... } ``` -ÔÚÔËÐе½ `Object sharedInstance = getSingleton(beanName)` ǰ£¬`AbstractBeanFactory#doGetBean` µÄÔËÐÐÁ÷³ÌÓëÇ°ÃæÁ½Ð¡½ÚÎÞÇø±ð£¬ÔÚ `Object sharedInstance = getSingleton(beanName)` Àï¾ÍÓÐÁ˱仯£¬½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ `getSingleton(beanName)` µÄÖ´ÐС£ +在è¿�行到 `Object sharedInstance = getSingleton(beanName)` å‰�,`AbstractBeanFactory#doGetBean` çš„è¿�行æµ�程与å‰�é�¢ä¸¤å°�节无区别,在 `Object sharedInstance = getSingleton(beanName)` 里就有了å�˜åŒ–,接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ `getSingleton(beanName)` 的执行。 #### 4.2 `DefaultSingletonBeanRegistry#getSingleton(String, boolean)` ``` /* - * beanName: ´«ÈëµÄֵΪ service1 - * allowEarlyReference£º´«ÈëµÄֵΪ true + * beanName: 传入的值为 service1 + * allowEarlyReference:传入的值为 true */ protected Object getSingleton(String beanName, boolean allowEarlyReference) { - // 1\. ´ÓÒ»¼¶»º´æÖлñÈ¡£¬ÕâÀïÊÇ»ñÈ¡²»µ½ + // 1\. 从一级缓存中获å�–,这里是获å�–ä¸�到 Object singletonObject = this.singletonObjects.get(beanName); - // 2\. isSingletonCurrentlyInCreation(...) ÅжÏservice1ÊÇ·ñÔÚ´´½¨ÖУ¬·µ»Ø true + // 2\. isSingletonCurrentlyInCreation(...) 判断service1是å�¦åœ¨åˆ›å»ºä¸­ï¼Œè¿”回 true if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { synchronized (this.singletonObjects) { - // 3\. ´Ó¶þ¼¶»º´æÖлñÈ¡£¬ÕâÀïÒ²»ñÈ¡²»µ½ + // 3\. 从二级缓存中获å�–,这里也获å�–ä¸�到 singletonObject = this.earlySingletonObjects.get(beanName); - // 4\. ´«ÈëµÄallowEarlyReferenceÊÇtrue£¬¼ÌÐøÖ´ÐÐÀïÃæµÄÄÚÈÝ + // 4\. 传入的allowEarlyReference是true,继续执行里é�¢çš„内容 if (singletonObject == null && allowEarlyReference) { - // 5\. ´ÓÈý¼¶»º´æÖлñÈ¡£¬ÄÜ»ñÈ¡µ½ + // 5\. 从三级缓存中获å�–,能获å�–到 ObjectFactory singletonFactory = this.singletonFactories.get(beanName); if (singletonFactory != null) { - // 6\. µ÷Óà singletonFactory.getObject() - // ×îÖÕµ÷ÓõÄÊÇ AbstractAutowireCapableBeanFactory.getEarlyBeanReference ·½·¨ + // 6\. 调用 singletonFactory.getObject() + // 最终调用的是 AbstractAutowireCapableBeanFactory.getEarlyBeanReference 方法 singletonObject = singletonFactory.getObject(); - // 7\. ´¦Àí»º´æ - // ·Åµ½¶þ¼¶»º´æÖÐ + // 7\. 处ç�†ç¼“å­˜ + // 放到二级缓存中 this.earlySingletonObjects.put(beanName, singletonObject); - // ´ÓÈý¼¶»º´æÖÐÇå³ý + // 从三级缓存中清除 this.singletonFactories.remove(beanName); } } @@ -583,9 +583,9 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` -ÔÚ·ÖÎö´úÂëǰ£¬ÏÈÀ´¿´¿´´Ëʱ 5 ´ó½á¹¹ÖеÄÄÚÈÝ£º +在分æž�代ç �å‰�,先æ�¥çœ‹çœ‹æ­¤æ—¶ 5 大结构中的内容: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ---------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -593,21 +593,21 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | | -¶ÔÕÕ×ÅÉÏÃæµÄÄÚÈÝ£¬·ÖÎöÈçÏ£º +对照ç�€ä¸Šé�¢çš„内容,分æž�如下: -1. ´ÓÒ»¼¶»º´æÖлñÈ¡£¬¶ÔÕÕ×Å 5 ¸ö½á¹¹ÖеÄÄÚÈÝ£¬»ñÈ¡²»µ½£¬·µ»Ø `null`; +1. 从一级缓存中获å�–,对照ç�€ 5 个结构中的内容,获å�–ä¸�到,返回 `null`; -2. `isSingletonCurrentlyInCreation(...)` ÅÐ¶Ï `service1` ÊÇ·ñÔÚ´´½¨ÖУ¬¶ÔÕÕ×Å 5 ¸ö½á¹¹ÖеÄÄÚÈÝ£¬`service1` ÔÚ `singletonsCurrentlyInCreation` ÖУ¬·µ»Ø true£¬¼ÌÐøÏÂÃæµÄÁ÷³Ì£¬**ÕâÊÇÓëµÚÒ»´Î»ñÈ¡ `service1` µÄ²»Í¬Ö®´¦**£» +2. `isSingletonCurrentlyInCreation(...)` 判断 `service1` 是å�¦åœ¨åˆ›å»ºä¸­ï¼Œå¯¹ç…§ç�€ 5 个结构中的内容,`service1` 在 `singletonsCurrentlyInCreation` 中,返回 true,继续下é�¢çš„æµ�程,**这是与第一次获å�– `service1` çš„ä¸�å�Œä¹‹å¤„**ï¼› -3. ¼ÌÐø´Ó¶þ¼¶»º´æÖлñÈ¡£¬¶ÔÕÕ×Å 5 ¸ö½á¹¹ÖеÄÄÚÈÝ£¬`service1` ²»ÔÚ `earlySingletonObjects`£¬ÒÀÈ»·µ»Ø `null`£» +3. 继续从二级缓存中获å�–,对照ç�€ 5 个结构中的内容,`service1` ä¸�在 `earlySingletonObjects`,ä¾�然返回 `null`ï¼› -4. `allowEarlyReference` ÊÇ´«ÈëµÄ²ÎÊý£¬Îª `true`£¬¼ÌÐøÖ´ÐÐ ÏÂÃæµÄ´úÂ룻 +4. `allowEarlyReference` 是传入的å�‚数,为 `true`,继续执行 下é�¢çš„代ç �ï¼› -5. ¼ÌÐø´Ó´ÓÈý¼¶»º´æÖлñÈ¡£¬¶ÔÕÕ×Å 5 ¸ö½á¹¹ÖеÄÄÚÈÝ£¬`service1` ÔÚ `singletonFactories` ÖУ¬ÕâÀïÄÜ»ñÈ¡µ½£¬·µ»ØµÄ½á¹ûÈçÏ£º +5. 继续从从三级缓存中获å�–,对照ç�€ 5 个结构中的内容,`service1` 在 `singletonFactories` 中,这里能获å�–到,返回的结果如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-57677e20855580e5bc2f5163d87ecfda7d2.png) -6. µ÷Óà `singletonFactory.getObject()` ·½·¨£¬µ±³õÎÒÃÇ´«Èë `singletonFactories` µÄ»¹ÊǸö lambda ±í´ïʽ£º`() -> getEarlyBeanReference(beanName, mbd, bean)`£¬µ÷Óà `singletonFactory.getObject()` ×îÖÕµ÷ÓõľÍÊÇ `AbstractAutowireCapableBeanFactory#getEarlyBeanReference`£º +6. 调用 `singletonFactory.getObject()` 方法,当åˆ�我们传入 `singletonFactories` 的还是个 lambda 表达å¼�:`() -> getEarlyBeanReference(beanName, mbd, bean)`,调用 `singletonFactory.getObject()` 最终调用的就是 `AbstractAutowireCapableBeanFactory#getEarlyBeanReference`: ``` protected Object getEarlyBeanReference(String beanName, RootBeanDefinition mbd, Object bean) { @@ -615,10 +615,10 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) { for (BeanPostProcessor bp : getBeanPostProcessors()) { if (bp instanceof SmartInstantiationAwareBeanPostProcessor) { - // µ÷ÓúóÖô¦ÀíÆ÷£¬ÕâÀïÍê³ÉÁËaop²Ù×÷ + // 调用å�Žç½®å¤„ç�†å™¨ï¼Œè¿™é‡Œå®Œæˆ�了aopæ“�作 SmartInstantiationAwareBeanPostProcessor ibp = (SmartInstantiationAwareBeanPostProcessor) bp; - // µ÷Óà `AbstractAutoProxyCreator#getEarlyBeanReference`£¬Ìáǰ½øÐÐ aop + // 调用 `AbstractAutoProxyCreator#getEarlyBeanReference`,æ��å‰�进行 aop exposedObject = ibp.getEarlyBeanReference(exposedObject, beanName); } } @@ -628,21 +628,21 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { ``` - ÎÒÃǸú½ø `AbstractAutoProxyCreator#getEarlyBeanReference` ·½·¨£º + 我们跟进 `AbstractAutoProxyCreator#getEarlyBeanReference` 方法: ``` public Object getEarlyBeanReference(Object bean, String beanName) { Object cacheKey = getCacheKey(bean.getClass(), beanName); this.earlyProxyReferences.put(cacheKey, bean); - // ÕâÀïÉú³É´úÀí¶ÔÏó + // 这里生æˆ�代ç�†å¯¹è±¡ return wrapIfNecessary(bean, beanName, cacheKey); } ``` - ¹ØÓÚ aop µÄÁ÷³Ì£¬¿É²Î¿¼ [spring aop Ö® AnnotationAwareAspectJAutoProxyCreator ·ÖÎö£¨Ï£©](https://my.oschina.net/funcy/blog/4687961)£¬ÕâÀï¾Í²»ÔÙ·ÖÎöÁË¡£Ö´ÐÐÍê `AbstractAutoProxyCreator#getEarlyBeanReference` Ö®ºó£¬5 ¸ö½á¹¹ÖеÄÄÚÈÝÈçÏ£º + 关于 aop çš„æµ�程,å�¯å�‚考 [spring aop 之 AnnotationAwareAspectJAutoProxyCreator 分æž�(下)](https://my.oschina.net/funcy/blog/4687961),这里就ä¸�å†�分æž�了。执行完 `AbstractAutoProxyCreator#getEarlyBeanReference` 之å�Žï¼Œ5 个结构中的内容如下: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ---------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | | @@ -650,17 +650,17 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | service1 | - ÈÃÎÒÃÇÔٻص½ `getSingleton` ·½·¨£¬Ö´ÐÐÍê `singletonFactory.getObject()` ºó£¬µÃµ½µÄ `singletonObject` Ϊ + 让我们å†�回到 `getSingleton` 方法,执行完 `singletonFactory.getObject()` å�Žï¼Œå¾—到的 `singletonObject` 为 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-cf72a8ff3d91c3d2a4e300741ba7f0268e6.png) - ÕâÊÇÒ»¸ö´úÀí¶ÔÏ󣬲¢ÇÒ `service2` Ϊ `null`¡£ + 这是一个代ç�†å¯¹è±¡ï¼Œå¹¶ä¸” `service2` 为 `null`。 -7. ½ÓÏÂÀ´¾ÍÊÇ´¦Àí»º´æÁË£¬Ò»Ð© map µÄ put Óë remove ²Ù×÷£¬¾Í²»¶à˵ÁË¡£ +7. 接下æ�¥å°±æ˜¯å¤„ç�†ç¼“存了,一些 map çš„ put 与 remove æ“�作,就ä¸�多说了。 -`DefaultSingletonBeanRegistry#getSingleton(String, boolean)` ·½·¨Ö´ÐÐÍê³Éºó£¬5 ¸ö½á¹¹ÖеÄÄÚÈÝÈçÏ£º +`DefaultSingletonBeanRegistry#getSingleton(String, boolean)` 方法执行完æˆ�å�Žï¼Œ5 个结构中的内容如下: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ------------------ | | `singletonObjects` | | | `earlySingletonObjects` | service1 | @@ -668,53 +668,53 @@ protected Object getSingleton(String beanName, boolean allowEarlyReference) { | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | service1 | -#### 4.3 Ôٴλص½ `AbstractBeanFactory#doGetBean` +#### 4.3 å†�次回到 `AbstractBeanFactory#doGetBean` -Ö´ÐÐÍê `DefaultSingletonBeanRegistry#getSingleton(String, boolean)` ºó£¬ÎÒÃÇÔٻص½ `AbstractBeanFactory#doGetBean`£º +执行完 `DefaultSingletonBeanRegistry#getSingleton(String, boolean)` å�Žï¼Œæˆ‘们å†�回到 `AbstractBeanFactory#doGetBean`: ``` protected T doGetBean(final String name, @Nullable final Class requiredType, @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException { ... - // ¼ì²éÊÇ·ñÒѳõʼ»¯ + // 检查是å�¦å·²åˆ�始化 Object sharedInstance = getSingleton(beanName); - // 1\. Õâ´ÎÄÜ»ñÈ¡µ½¶ÔÏó£¬if ÀïÃæµÄ´úÂë»áÖ´ÐÐ + // 1\. 这次能获å�–到对象,if 里é�¢çš„代ç �会执行 if (sharedInstance != null && args == null) { - // 2\. ÕâÀïÈç¹ûÊÇÆÕͨBean µÄ»°£¬Ö±½Ó·µ»Ø£¬Èç¹ûÊÇ FactoryBean µÄ»°£¬·µ»ØËü´´½¨µÄÄǸöʵÀý¶ÔÏó - // ÕâÀïµÄbeanÊÇservice1µÄ´úÀí¶ÔÏó + // 2\. 这里如果是普通Bean çš„è¯�,直接返回,如果是 FactoryBean çš„è¯�,返回它创建的那个实例对象 + // 这里的bean是service1的代ç�†å¯¹è±¡ bean = getObjectForBeanInstance(sharedInstance, name, beanName, null); } else { - // ÕâÀïµÄ´úÂë²»»áÖ´Ðе½£¬¾Í²»·ÖÎöÁË + // 这里的代ç �ä¸�会执行到,就ä¸�分æž�了 ... } - // ´¦ÀíbeanµÄת»»²Ù×÷£¬ÕâÀï·µ»Øfalse£¬²»»áÖ´Ðе½ + // 处ç�†bean的转æ�¢æ“�作,这里返回false,ä¸�会执行到 if (requiredType != null && !requiredType.isInstance(bean)) { ... } - // 3\. ·µ»Ø´Ó`getSingleton(beanName)`µÃµ½µÄ¶ÔÏó + // 3\. 返回从`getSingleton(beanName)`得到的对象 return bean; } ``` -1. Õâ´ÎÄÜ»ñÈ¡µ½¶ÔÏó£¬if ÀïÃæµÄ´úÂë»áÖ´ÐУ» +1. 这次能获å�–到对象,if 里é�¢çš„代ç �会执行; -2. `service1` ²»ÊÇ `FactoryBean`£¬Óë `getSingleton(beanName)` µÃµ½µÄ¶ÔÏóÊÇͬһ¸ö¶ÔÏó£¬ÄÚÈÝÈçÏ£º +2. `service1` ä¸�是 `FactoryBean`,与 `getSingleton(beanName)` 得到的对象是å�Œä¸€ä¸ªå¯¹è±¡ï¼Œå†…容如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-0cd9c129bf2387d85a7bee4f4e135143f63.png) -3. ·µ»Ø´Ó `getSingleton(beanName)` µÃµ½µÄ¶ÔÏó£¬ÔÚ `getSingleton(beanName)` Öзµ»ØµÄ¶ÔÏó²»Îª¿Õºó£¬¾Í²»ÔÙÖ´ÐÐ bean µÄ´´½¨Á÷³ÌÁË£¬×îÖÕ·µ»ØµÄÊÇµÚ 2 ²½Öеõ½µÄ bean ÁË¡£ +3. 返回从 `getSingleton(beanName)` 得到的对象,在 `getSingleton(beanName)` 中返回的对象ä¸�为空å�Žï¼Œå°±ä¸�å†�执行 bean 的创建æµ�程了,最终返回的是第 2 步中得到的 bean 了。 -µ½ÁËÕâÀÎÒÃÇÖÕÓÚ»ñÈ¡µ½ÁË `service1` µÄ´úÀí¶ÔÏ󣬾¡¹Ü´úÀí¶ÔÏó¶ÔÓ¦µÄԭʼ¶ÔÏó²¢Ã»ÓÐÍê³ÉÒÀÀµ×¢È룬µ«ÎÒÃÇÒÀÈ»¿ÉÒÔ½øÐкóÐøµÄÁ÷³Ì£¬¼´»ñÈ¡µ½ `service1` µÄ´úÀí¶ÔÏóºó£¬`service2` ¾Í¿ÉÒÔ½øÐÐÒÀÀµ×¢È룬¼ÌÐø½ÓÏÂÀ´µÄÁ÷³ÌÁË¡£ +到了这里,我们终于获å�–到了 `service1` 的代ç�†å¯¹è±¡ï¼Œå°½ç®¡ä»£ç�†å¯¹è±¡å¯¹åº”的原始对象并没有完æˆ�ä¾�赖注入,但我们ä¾�ç„¶å�¯ä»¥è¿›è¡Œå�Žç»­çš„æµ�程,å�³èŽ·å�–到 `service1` 的代ç�†å¯¹è±¡å�Žï¼Œ`service2` å°±å�¯ä»¥è¿›è¡Œä¾�赖注入,继续接下æ�¥çš„æµ�程了。 -×îºó£¬ÎÒÃÇÔÙÀ´¿´¿´±¾½ÚÖ´ÐÐÍêÖ®ºó£¬5 ´ó½á¹¹ÖеÄÄÚÈÝ£º +最å�Žï¼Œæˆ‘们å†�æ�¥çœ‹çœ‹æœ¬èŠ‚æ‰§è¡Œå®Œä¹‹å�Žï¼Œ5 大结构中的内容: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -722,47 +722,47 @@ protected T doGetBean(final String name, @Nullable final Class requiredTy | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | service1 | -»ñÈ¡µ½ `service1` ºó£¬½ÓÏÂÀ´¾Í¼ÌÐø `service2` µÄ»ñÈ¡Á÷³ÌÁË¡£ +获å�–到 `service1` å�Žï¼ŒæŽ¥ä¸‹æ�¥å°±ç»§ç»­ `service2` 的获å�–æµ�程了。 -### 5 ¼ÌÐø `service2` µÄ»ñÈ¡Á÷³Ì +### 5 ç»§ç»­ `service2` 的获å�–æµ�程 -ÔÚµÚ 3 ½ÚÖУ¬ÒòΪ `service2` ÐèҪעÈë `service1`£¬²ÅÓÐÁËµÚ 4 ²¿·ÖµÄÔٴλñÈ¡ `service1` µÄÁ÷³Ì£¬×îÖÕÒ²³É¹¦µØ»ñÈ¡µ½ÁË `service1` µÄ´úÀí¶ÔÏó `service1$$EnhancerBySpringCGLIB`£¬Õâ²ÅÈà `service2` µÃÒÔÍê³ÉÒÀÀµ×¢Èë¡£ +在第 3 节中,因为 `service2` 需è¦�注入 `service1`,æ‰�有了第 4 部分的å†�次获å�– `service1` çš„æµ�程,最终也æˆ�功地获å�–到了 `service1` 的代ç�†å¯¹è±¡ `service1$$EnhancerBySpringCGLIB`,这æ‰�让 `service2` 得以完æˆ�ä¾�赖注入。 -½ÓÏÂÀ´£¬ÈÃÎÒÃÇÑÓÐø µÚ 3 ½Ú µÄÁ÷³Ì£¬»Øµ½ `AbstractAutowireCapableBeanFactory#doCreateBean`£¬¼ÌÐø `service2` µÄÁ÷³Ì¡£ +接下æ�¥ï¼Œè®©æˆ‘们延续 第 3 节 çš„æµ�程,回到 `AbstractAutowireCapableBeanFactory#doCreateBean`,继续 `service2` çš„æµ�程。 -#### 5.1 »Øµ½ `AbstractAutowireCapableBeanFactory#doCreateBean` +#### 5.1 回到 `AbstractAutowireCapableBeanFactory#doCreateBean` -´úÂëÈçÏ£º +代ç �如下: ``` protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args) throws BeanCreationException { - // ÉÏÃæµÄ´úÂëÔÚ 3.2 ÖÐÒѾ­·ÖÎö¹ýÁË£¬¾Í²»ÔÙ·ÖÎöÁË + // 上é�¢çš„代ç �在 3.2 中已ç»�分æž�过了,就ä¸�å†�分æž�了 ... Object exposedObject = bean; try { - // 1\. ¸ºÔðÊôÐÔ×°Åä, Ò²¾ÍÊÇÎÒÃdz£³£ËµµÄÒÀÀµ×¢Èë + // 1\. 负责属性装é…�, 也就是我们常常说的ä¾�赖注入 populateBean(beanName, mbd, instanceWrapper); - // 2\. ³õʼ»¯£¬ÔÚÕâÀï»á´¦Àí aop ²Ù×÷ + // 2\. åˆ�始化,在这里会处ç�† aop æ“�作 exposedObject = initializeBean(beanName, exposedObject, mbd); } catch (Throwable ex) { ... } - //ͬÑùµÄ£¬Èç¹û´æÔÚÑ­»·ÒÀÀµ + //å�Œæ ·çš„,如果存在循环ä¾�èµ– if (earlySingletonExposure) { - // 3\. ´Ó»º´æÖлñÈ¡ beanName ¶ÔÓ¦µÄbean + // 3\. 从缓存中获å�– beanName 对应的bean Object earlySingletonReference = getSingleton(beanName, false); - // 4\. earlySingletonReference Ϊ null£¬if ÀïÃæµÄÄÚÈݲ»»áÖ´ÐÐ + // 4\. earlySingletonReference 为 null,if 里é�¢çš„内容ä¸�会执行 if (earlySingletonReference != null) { ... } } - // Ê¡ÂÔ²»ÖØÒªµÄ´úÂë + // çœ�ç•¥ä¸�é‡�è¦�的代ç � ... return exposedObject; @@ -770,24 +770,24 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` -´úÂë˵Ã÷ÈçÏ£º +代ç �说明如下: -1. ´¦ÀíÒÀÀµ×¢È룬¾ÍÊÇÕâÀï´¥·¢ÁËµÚ 4 ²¿·ÖµÄÁ÷³Ì£¬Ö´ÐÐÍêµÃµ½µÄ `service2` ÈçÏ£º +1. 处ç�†ä¾�赖注入,就是这里触å�‘了第 4 部分的æµ�程,执行完得到的 `service2` 如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-b294a02be5431c0aa66e5f126a6c6abbb92.png) - ¿ÉÒÔ¿´µ½£¬´ËʱעÈëµ½ `service2` ÖÐµÄ `service1` ¾ÍÊÇ´úÀí¶ÔÏóÁË£» + å�¯ä»¥çœ‹åˆ°ï¼Œæ­¤æ—¶æ³¨å…¥åˆ° `service2` 中的 `service1` 就是代ç�†å¯¹è±¡äº†ï¼› -2. ³õʼ»¯£¬ÔÚÕâÀï»á´¦Àí aop ²Ù×÷£¬Ö´ÐÐ aop µÄ·½·¨Îª `AbstractAutoProxyCreator#postProcessAfterInitialization`£¬´úÂëÈçÏ£º +2. åˆ�始化,在这里会处ç�† aop æ“�作,执行 aop 的方法为 `AbstractAutoProxyCreator#postProcessAfterInitialization`,代ç �如下: ``` - // ´«ÈëµÄbeanΪservice2£¬beanNameΪ¡°service2¡± + // 传入的bean为service2,beanName为“service2â€� public Object postProcessAfterInitialization(@Nullable Object bean, String beanName) { if (bean != null) { Object cacheKey = getCacheKey(bean.getClass(), beanName); - // 1\. earlyProxyReferences Öв¢Ã»ÓÐ service2£¬ifÀïµÄ´úÂë»áÖ´Ðе½ + // 1\. earlyProxyReferences 中并没有 service2,if里的代ç �会执行到 if (this.earlyProxyReferences.remove(cacheKey) != bean) { - // 2\. ÔÚÕâÀï´¦Àíaop²Ù×÷ + // 2\. 在这里处ç�†aopæ“�作 return wrapIfNecessary(bean, beanName, cacheKey); } } @@ -796,9 +796,9 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` - ÒÔÉÏ´úÂëÏÈ´Ó `earlyProxyReferences` ÒÆ³ö `service2`£¬È»ºóÔÙÓë´«ÈëµÄ bean ×ö±È½Ï£¬¶ÔÕÕ×Å 5 ´ó½á¹¹ÖеÄÄÚÈÝ£¬ÎÒÃÇ·¢ÏÖ `service2` ²¢²»ÔÚ `earlyProxyReferences` ÖУ» + 以上代ç �先从 `earlyProxyReferences` 移出 `service2`,然å�Žå†�与传入的 bean å�šæ¯”è¾ƒï¼Œå¯¹ç…§ç�€ 5 大结构中的内容,我们å�‘现 `service2` å¹¶ä¸�在 `earlyProxyReferences` 中; - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -806,28 +806,28 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | service1 | - Òò´Ë£¬ÕâÀï·µ»Ø `null`£¬ÏÔÈ»²»µÈÓÚ´«ÈëµÄ bean£¬Òò´Ë if ÖеĴúÂë»áÖ´ÐУ¬`service2` ½øÐÐ aop¡£Ö´ÐÐÍêÕâÒ»²½ºó£¬µÃµ½µÄ `exposedObject` Ϊ£º + 因此,这里返回 `null`,显然ä¸�等于传入的 bean,因此 if 中的代ç �会执行,`service2` 进行 aop。执行完这一步å�Žï¼Œå¾—到的 `exposedObject` 为: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-d62ebdbb71b76ada963a01c9b8c84b88b00.png) - `service2` Ò²±ä³ÉÁË´úÀí¶ÔÏó£¬ÇÒÒÑÍê³ÉÁËÒÀÀµ×¢Èë¡£ + `service2` 也å�˜æˆ�了代ç�†å¯¹è±¡ï¼Œä¸”已完æˆ�了ä¾�赖注入。 -3. ´Ó»º´æÖлñÈ¡ beanName ¶ÔÓ¦µÄ bean£¬Ö´ÐеÄÊÇ `DefaultSingletonBeanRegistry#getSingleton(String, boolean)`£¬´úÂëÈçÏ£º +3. 从缓存中获å�– beanName 对应的 bean,执行的是 `DefaultSingletonBeanRegistry#getSingleton(String, boolean)`,代ç �如下: ``` /** * beanName: service2 - * allowEarlyReference£ºfalse + * allowEarlyReference:false */ protected Object getSingleton(String beanName, boolean allowEarlyReference) { - // 1\. ´ÓÒ»¼¶»º´æÖлñÈ¡ service2£¬»ñÈ¡²»µ½£¬·µ»Ønull + // 1\. 从一级缓存中获å�– service2,获å�–ä¸�到,返回null Object singletonObject = this.singletonObjects.get(beanName); - // 2\. ÅÐ¶Ï service2 ÊÇ·ñÔÚ´´½¨ÖУ¬·µ»Øtrue£¬Ö´ÐÐifÖеĴúÂë + // 2\. 判断 service2 是å�¦åœ¨åˆ›å»ºä¸­ï¼Œè¿”回true,执行if中的代ç � if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { synchronized (this.singletonObjects) { - // 3\. ´Ó¶þ¼¶»º´æÖлñÈ¡ service2£¬»ñÈ¡²»µ½£¬·µ»Ønull + // 3\. 从二级缓存中获å�– service2,获å�–ä¸�到,返回null singletonObject = this.earlySingletonObjects.get(beanName); - // 4\. ´Ëʱ´«ÈëµÄ allowEarlyReference Ϊfalse£¬if¿éµÄ´úÂë²»»áÖ´ÐÐ + // 4\. 此时传入的 allowEarlyReference 为false,ifå�—的代ç �ä¸�会执行 if (singletonObject == null && allowEarlyReference) { ... } @@ -838,9 +838,9 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` - ÎÒÃÇ»¹ÊÇÀ´¿´ Ò»ÑÛ 5 ´ó½á¹¹ÖеÄÄÚÈÝ£¬¶ÔÕâ¸ö·½·¨µÄÖ´ÐоÍһĿÁËÈ»ÁË£º + 我们还是æ�¥çœ‹ 一眼 5 大结构中的内容,对这个方法的执行就一目了然了: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -848,15 +848,15 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1, service2 | | `earlyProxyReferences` | service1 | - ·½·¨µÄÖ´ÐУ¬ÔÚ´úÂëÖÐÒѾ­×¢Ê͵úÜÃ÷°×ÁË£¬¾Í¶à˵ÁË£» + 方法的执行,在代ç �中已ç»�注释得很明白了,就多说了; -4. µÚ 3 ²½·µ»ØµÄ `earlySingletonReference` Ϊ null£¬if ÀïÃæµÄÄÚÈݲ»»áÖ´ÐС£ +4. 第 3 步返回的 `earlySingletonReference` 为 null,if 里é�¢çš„内容ä¸�会执行。 -µ½ÕâÀµÃµ½µÄ `service2` ¾Í·µ»ØÁË¡£ +到这里,得到的 `service2` 就返回了。 -#### 5.2 »Øµ½ `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` +#### 5.2 回到 `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` -µÃµ½ `service2` µÄ bean ºó£¬ÎÒÃǻص½ `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)`£¬¼ÌÐø `service2` µÄÁ÷³Ì£¬´úÂëÈçÏ£º +得到 `service2` çš„ bean å�Žï¼Œæˆ‘们回到 `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)`,继续 `service2` çš„æµ�程,代ç �如下: ``` public Object getSingleton(String beanName, ObjectFactory singletonFactory) { @@ -864,7 +864,7 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { synchronized (this.singletonObjects) { ... try { - // 1\. ÔÚÕâÀï½øÐÐbeanµÄ´´½¨ + // 1\. 在这里进行bean的创建 singletonObject = singletonFactory.getObject(); newSingleton = true; } @@ -873,12 +873,12 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { } finally { ... - // 2\. ´´½¨Íê³Éºó£¬×öһЩ¼ì²é²Ù×÷ - // ÕâÀï»á°Ñ service2 ´Ó singletonsCurrentlyInCreation ÒÆ³ý + // 2\. 创建完æˆ�å�Žï¼Œå�šä¸€äº›æ£€æŸ¥æ“�作 + // 这里会把 service2 从 singletonsCurrentlyInCreation 移除 afterSingletonCreation(beanName); } if (newSingleton) { - // 3\. ½«¸Ã¶ÔÏóÌí¼Óµ½ beanFactory ÖУ¬Õâ¸ö·½·¨»áɾ³ý¶þÈý¼¶»º´æ + // 3\. 将该对象添加到 beanFactory 中,这个方法会删除二三级缓存 addSingleton(beanName, singletonObject); } ... @@ -888,13 +888,13 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { ``` -˵Ã÷ÈçÏ£º +说明如下: -1. Àú¾­Ç§ÄÑÍòÏÕ£¬`singletonFactory.getObject()` ÖÕÓÚÖ´ÐÐÍêÁË£¬ÔÚÖî¶àÇúÕÛÖ®ºó£¬×îÖÕ»¹Êǵõ½ÁË `service2` µÄ´úÀí¶ÔÏó£» +1. 历ç»�å�ƒéš¾ä¸‡é™©ï¼Œ`singletonFactory.getObject()` 终于执行完了,在诸多曲折之å�Žï¼Œæœ€ç»ˆè¿˜æ˜¯å¾—到了 `service2` 的代ç�†å¯¹è±¡ï¼› -2. `service2` ´´½¨Íê³Éºó£¬¾Í»á½«Æä´Ó `singletonsCurrentlyInCreation` ÒÆ³ý£¬·½·¨±È½Ï¼òµ¥£¬¾Í²»¶à˵ÁË£¬ÕâÒ»²½µÃµ½µÄ 5 ´ó½á¹¹ÈçÏ£º +2. `service2` 创建完æˆ�å�Žï¼Œå°±ä¼šå°†å…¶ä»Ž `singletonsCurrentlyInCreation` 移除,方法比较简å�•,就ä¸�多说了,这一步得到的 5 大结构如下: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -902,16 +902,16 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | service1 | -3. ½Ó×Å£¬¾ÍÊÇ»º´æµÄ´¦Àí£¬·½·¨Îª `DefaultSingletonBeanRegistry#addSingleton`£º +3. 接ç�€ï¼Œå°±æ˜¯ç¼“存的处ç�†ï¼Œæ–¹æ³•为 `DefaultSingletonBeanRegistry#addSingleton`: ``` /* - * beanName£ºservice2 - * singletonObject£ºservice2$$EnhancerBySpringCGLIB(service2µÄ´úÀí¶ÔÏó) + * beanName:service2 + * singletonObject:service2$$EnhancerBySpringCGLIB(service2的代ç�†å¯¹è±¡) */ protected void addSingleton(String beanName, Object singletonObject) { synchronized (this.singletonObjects) { - // ¶ÔÈý¸ö»º´æ½øÐÐput¡¢remove²Ù×÷£¬×îÖÕÖ»ÔÚÒ»¼¶»º´æÖÐÓиöÔÏó + // 对三个缓存进行putã€�removeæ“�作,最终å�ªåœ¨ä¸€çº§ç¼“存中有该对象 this.singletonObjects.put(beanName, singletonObject); this.singletonFactories.remove(beanName); this.earlySingletonObjects.remove(beanName); @@ -921,9 +921,9 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { ``` - ·½·¨±È½Ï¼òµ¥£¬¾Í²»¶à˵ÁË£¬×îÖÕ 5 ´ó½á¹¹Îª£º + 方法比较简å�•,就ä¸�多说了,最终 5 大结构为: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | service2$$EnhancerBySpringCGLIB | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -931,13 +931,13 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | service1 | -µ½´Ë£¬`service2` »ñÈ¡Íê³É£¬×îÖÕ±£´æµ½ `singletonObjects` ÖÐµÄ bean Ϊ£º +到此,`service2` 获å�–完æˆ�,最终ä¿�存到 `singletonObjects` 中的 bean 为: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-763dad35376ed1d88086c45f01ee9c4cedd.png) -±¾½ÚµÄ×îºó£¬ÎÒÃÇÒ²À´¿´Ï 5 ¸ö½á¹¹ÖеÄÄÚÈÝ£º +本节的最å�Žï¼Œæˆ‘们也æ�¥çœ‹ä¸‹ 5 个结构中的内容: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | service2$$EnhancerBySpringCGLIB | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -945,50 +945,50 @@ public Object getSingleton(String beanName, ObjectFactory singletonFactory) { | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | service1 | -ÖÁ´Ë£¬`service2` »ñÈ¡Íê³É£¬½Ó×ÅÈÃÎÒÃǼÌÐø `service1` µÄ»ñÈ¡Á÷³Ì¡£ +至此,`service2` 获å�–完æˆ�,接ç�€è®©æˆ‘们继续 `service1` 的获å�–æµ�程。 -### 6 ¼ÌÐø `service1` µÄ»ñÈ¡Á÷³Ì +### 6 ç»§ç»­ `service1` 的获å�–æµ�程 -ÔÚµÚ 2 ½ÚÖУ¬ÒòΪ `servic1` ÐèҪעÈë `service2`£¬²ÅÓÐÁËµÚ 3 ½Ú»ñÈ¡ `service2` µÄÁ÷³Ì£¬È»ºóÓÖ¾­¹ýһϵÁеIJÙ×÷ºó£¬×îÖÕÔÚµÚ 5 ½Ú³É¹¦µØ»ñÈ¡µ½ÁË `service2` µÄ´úÀí¶ÔÏó `service2$$EnhancerBySpringCGLIB`£¬Õâ²ÅÈà `service2` µÃÒÔÍê³ÉÒÀÀµ×¢Èë¡£ +在第 2 节中,因为 `servic1` 需è¦�注入 `service2`,æ‰�有了第 3 节获å�– `service2` çš„æµ�程,然å�Žå�ˆç»�过一系列的æ“�作å�Žï¼Œæœ€ç»ˆåœ¨ç¬¬ 5 节æˆ�功地获å�–到了 `service2` 的代ç�†å¯¹è±¡ `service2$$EnhancerBySpringCGLIB`,这æ‰�让 `service2` 得以完æˆ�ä¾�赖注入。 -½ÓÏÂÀ´£¬ÈÃÎÒÃÇÑÓÐøµÚ 2 ½Ú£¬»Øµ½ `AbstractAutowireCapableBeanFactory#doCreateBean` ·½·¨£¬¼ÌÐø `service1` µÄÁ÷³Ì¡£ +接下æ�¥ï¼Œè®©æˆ‘们延续第 2 节,回到 `AbstractAutowireCapableBeanFactory#doCreateBean` 方法,继续 `service1` çš„æµ�程。 -#### 6.1 »Øµ½ `AbstractAutowireCapableBeanFactory#doCreateBean` +#### 6.1 回到 `AbstractAutowireCapableBeanFactory#doCreateBean` -´úÂëÈçÏ£º +代ç �如下: ``` protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args) throws BeanCreationException { - // ÉÏÃæµÄ´úÂëÔÚ 3.1 ÖÐÒѾ­·ÖÎö¹ýÁË£¬¾Í²»ÔÙ·ÖÎöÁË + // 上é�¢çš„代ç �在 3.1 中已ç»�分æž�过了,就ä¸�å†�分æž�了 ... Object exposedObject = bean; try { - // 1\. ¸ºÔðÊôÐÔ×°Åä, Ò²¾ÍÊÇÎÒÃdz£³£ËµµÄÒÀÀµ×¢Èë + // 1\. 负责属性装é…�, 也就是我们常常说的ä¾�赖注入 populateBean(beanName, mbd, instanceWrapper); - // 2\. ³õʼ»¯£¬ÔÚÕâÀï»á´¦Àí aop ²Ù×÷ + // 2\. åˆ�始化,在这里会处ç�† aop æ“�作 exposedObject = initializeBean(beanName, exposedObject, mbd); } catch (Throwable ex) { ... } - //ͬÑùµÄ£¬Èç¹û´æÔÚÑ­»·ÒÀÀµ + //å�Œæ ·çš„,如果存在循环ä¾�èµ– if (earlySingletonExposure) { - // 3\. ´Ó»º´æÖлñÈ¡ beanName ¶ÔÓ¦µÄbean + // 3\. 从缓存中获å�– beanName 对应的bean Object earlySingletonReference = getSingleton(beanName, false); - // 4\. earlySingletonReference ²»Îª null£¬if ÀïÃæµÄÄÚÈÝ»áÖ´ÐÐ + // 4\. earlySingletonReference ä¸�为 null,if 里é�¢çš„内容会执行 if (earlySingletonReference != null) { if (exposedObject == bean) { - // 5\. ½«·µ»ØµÄ¶ÔÏó¸³Öµ¸ø exposedObject£¬·µ»Ø¶ÔÏóΪ´úÀí¶ÔÏó + // 5\. 将返回的对象赋值给 exposedObject,返回对象为代ç�†å¯¹è±¡ exposedObject = earlySingletonReference; } } } - // Ê¡ÂÔ²»ÖØÒªµÄ´úÂë + // çœ�ç•¥ä¸�é‡�è¦�的代ç � ... return exposedObject; @@ -996,24 +996,24 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` -´úÂë˵Ã÷ÈçÏ£º +代ç �说明如下: -1. ´¦ÀíÒÀÀµ×¢È룬¾ÍÊÇÕâÀï´¥·¢ÁËµÚ 3 ½ÚµÄÁ÷³Ì£¬Ö´ÐÐÍêµÃµ½µÄ `service1` ÈçÏ£º +1. 处ç�†ä¾�赖注入,就是这里触å�‘了第 3 节的æµ�程,执行完得到的 `service1` 如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-3883285be5904e056bc517d35bfd44c47a0.png) - ¿ÉÒÔ¿´µ½£¬`service1` ÒѾ­Íê³ÉÁËÒÀÀµ×¢È룬ÇÒ´ËʱעÈëµ½ `service1` ÖÐµÄ `service2` ÒѾ­ÊÇ´úÀí¶ÔÏóÁË£¬²»¹ý `service1` ´Ëʱ»¹ÊÇԭʼ¶ÔÏó£¬ÎÒÃǼÌÐøÍùÏ¿´£» + å�¯ä»¥çœ‹åˆ°ï¼Œ`service1` å·²ç»�完æˆ�了ä¾�赖注入,且此时注入到 `service1` 中的 `service2` å·²ç»�是代ç�†å¯¹è±¡äº†ï¼Œä¸�过 `service1` 此时还是原始对象,我们继续往下看; -2. ³õʼ»¯£¬ÔÚÕâÀï»á´¦Àí aop ²Ù×÷£¬Ö´ÐÐ aop µÄ·½·¨Îª `AbstractAutoProxyCreator#postProcessAfterInitialization`£¬´úÂëÈçÏ£º +2. åˆ�始化,在这里会处ç�† aop æ“�作,执行 aop 的方法为 `AbstractAutoProxyCreator#postProcessAfterInitialization`,代ç �如下: ``` - // ´«ÈëµÄbeanΪservice1£¬beanNameΪ¡°service1¡± + // 传入的bean为service1,beanName为“service1â€� public Object postProcessAfterInitialization(@Nullable Object bean, String beanName) { if (bean != null) { Object cacheKey = getCacheKey(bean.getClass(), beanName); - // 1\. earlyProxyReferences ÖÐÓÐ service1£¬ifÀïµÄ´úÂë²»»áÖ´Ðе½ + // 1\. earlyProxyReferences 中有 service1,if里的代ç �ä¸�会执行到 if (this.earlyProxyReferences.remove(cacheKey) != bean) { - // 2\. ÔÚÕâÀï´¦Àíaop²Ù×÷£¬service1 ÒѾ­Ö´ÐйýaopÁË + // 2\. 在这里处ç�†aopæ“�作,service1 å·²ç»�执行过aop了 return wrapIfNecessary(bean, beanName, cacheKey); } } @@ -1022,9 +1022,9 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` - ÒÔÉÏ´úÂëÏÈ´Ó `earlyProxyReferences` ÒÆ³ö `service1`£¬È»ºóÔÙÓë´«ÈëµÄ bean ×ö±È½Ï£¬¶ÔÕÕ×Å 5 ´ó½á¹¹ÖеÄÄÚÈÝ£¬ÎÒÃÇ·¢ÏÖ `service1` ´Ëʱ¾ÍÔÚ `earlyProxyReferences` ÖУ» + 以上代ç �先从 `earlyProxyReferences` 移出 `service1`,然å�Žå†�与传入的 bean å�šæ¯”è¾ƒï¼Œå¯¹ç…§ç�€ 5 大结构中的内容,我们å�‘现 `service1` 此时就在 `earlyProxyReferences` 中; - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | service2$$EnhancerBySpringCGLIB | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -1032,9 +1032,9 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | service1 | - Òò´Ë£¬ÕâÀï»á·µ»Ø `service1`£¬if ÖеĴúÂë²»»áÖ´ÐС£Ö´ÐÐÍêÕâÒ»²½ºó£¬5 ¸ö½á¹¹ÖеÄÄÚÈÝΪ£º + 因此,这里会返回 `service1`,if 中的代ç �ä¸�会执行。执行完这一步å�Žï¼Œ5 个结构中的内容为: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | service2$$EnhancerBySpringCGLIB | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -1042,22 +1042,22 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | | -3. ´Ó»º´æÖлñÈ¡ beanName ¶ÔÓ¦µÄ bean£¬Ö´ÐеÄÊÇ `DefaultSingletonBeanRegistry#getSingleton(String, boolean)`£¬´úÂëÈçÏ£º +3. 从缓存中获å�– beanName 对应的 bean,执行的是 `DefaultSingletonBeanRegistry#getSingleton(String, boolean)`,代ç �如下: ``` /** * beanName: service1 - * allowEarlyReference£ºfalse + * allowEarlyReference:false */ protected Object getSingleton(String beanName, boolean allowEarlyReference) { - // 1\. ´ÓÒ»¼¶»º´æÖлñÈ¡ service1£¬»ñÈ¡²»µ½£¬·µ»Ønull + // 1\. 从一级缓存中获å�– service1,获å�–ä¸�到,返回null Object singletonObject = this.singletonObjects.get(beanName); - // 2\. ÅÐ¶Ï service1 ÊÇ·ñÔÚ´´½¨ÖУ¬·µ»Øtrue£¬Ö´ÐÐifÖеĴúÂë + // 2\. 判断 service1 是å�¦åœ¨åˆ›å»ºä¸­ï¼Œè¿”回true,执行if中的代ç � if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) { synchronized (this.singletonObjects) { - // 3\. ´Ó¶þ¼¶»º´æÖлñÈ¡ service1£¬ÄÜ»ñÈ¡µ½ + // 3\. 从二级缓存中获å�– service1,能获å�–到 singletonObject = this.earlySingletonObjects.get(beanName); - // 4\. singletonObject ²»Îªnull£¬if¿éµÄ´úÂë²»»áÖ´ÐÐ + // 4\. singletonObject ä¸�为null,ifå�—的代ç �ä¸�会执行 if (singletonObject == null && allowEarlyReference) { ... } @@ -1068,9 +1068,9 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ``` - ÎÒÃÇ¿´ Ò»ÑÛ 5 ´ó½á¹¹ÖеÄÄÚÈÝ£¬¶ÔÕâ¸ö·½·¨µÄÖ´ÐоÍһĿÁËÈ»ÁË£º + 我们看 一眼 5 大结构中的内容,对这个方法的执行就一目了然了: - | ½á¹¹ | ÄÚÈÝ | + | 结构 | 内容 | | ------------------------------- | ------------------------------- | | `singletonObjects` | service2$$EnhancerBySpringCGLIB | | `earlySingletonObjects` | service1$$EnhancerBySpringCGLIB | @@ -1078,23 +1078,23 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | service1 | | `earlyProxyReferences` | | - ·½·¨µÄÖ´ÐУ¬ÔÚ´úÂëÖÐÒѾ­×¢Ê͵úÜÃ÷°×ÁË£¬¾Í¶à˵ÁË£¬ÕâÒ»²½»á°Ñ `service1` µÄ´úÀí¶ÔÏ󷵻أ» + 方法的执行,在代ç �中已ç»�注释得很明白了,就多说了,这一步会把 `service1` 的代ç�†å¯¹è±¡è¿”回; -4. ÉÏÒ»²½µÃµ½µÄ `earlySingletonReference` Ϊ +4. 上一步得到的 `earlySingletonReference` 为 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-425636328820897c75890f01614d94fe9dd.png) - ´úÀí¶ÔÏóÒѾ­·µ»ØÀ´ÁË£¬¿ÉÒÔ¼ÌÐøÖ´ÐÐ if ¿éµÄ´úÂëÁË£» + 代ç�†å¯¹è±¡å·²ç»�返回æ�¥äº†ï¼Œå�¯ä»¥ç»§ç»­æ‰§è¡Œ if å�—的代ç �了; -5. ×îºóÒ»²½ÊǸ³Öµ²Ù×÷£¬½«·µ»ØµÄ¶ÔÏó¸³Öµ¸ø `exposedObject`£¬È»ºó·µ»Ø `exposedObject`£¬×îÖÕ·µ»ØµÄ¶ÔÏóΪ `service1` µÄ´úÀí¶ÔÏó¡£ +5. 最å�Žä¸€æ­¥æ˜¯èµ‹å€¼æ“�作,将返回的对象赋值给 `exposedObject`,然å�Žè¿”回 `exposedObject`,最终返回的对象为 `service1` 的代ç�†å¯¹è±¡ã€‚ -µ½ÁËÕâÒ»²½£¬`service1` µÄ´úÀí¶ÔÏóÒ²»ñÈ¡Íê³ÉÁË¡£ +到了这一步,`service1` 的代ç�†å¯¹è±¡ä¹ŸèŽ·å�–完æˆ�了。 -#### 6.2 »Øµ½ `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` +#### 6.2 回到 `DefaultSingletonBeanRegistry#getSingleton(String, ObjectFactory)` -ÕâÒ»²½µÄ²Ù×÷ÊÇÇåÀíһЩ»º´æ£¬¾Í²»ÔÙ·ÖÎöÁË£¬×îÖÕ 5 ¸ö½á¹¹ÖеÄÄÚÈÝÈçÏ£º +这一步的æ“�作是清ç�†ä¸€äº›ç¼“存,就ä¸�å†�分æž�了,最终 5 个结构中的内容如下: -| ½á¹¹ | ÄÚÈÝ | +| 结构 | 内容 | | ------------------------------- | ------------------------------------------------------------ | | `singletonObjects` | service2?????????????????????,???????1EnhancerBySpringCGLIB,service1" role="presentation">EnhancerBySpringCGLIB | | `earlySingletonObjects` | | @@ -1102,7 +1102,7 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb | `singletonsCurrentlyInCreation` | | | `earlyProxyReferences` | | -ͨ¹ýµ÷ÊÔ£¬²é¿´µÃµ½ `singletonObjects` ÖжÔÏóÈçÏ£º +通过调试,查看得到 `singletonObjects` 中对象如下: 1. service1 @@ -1112,12 +1112,12 @@ protected Object doCreateBean(final String beanName, final RootBeanDefinition mb ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-563d6e323ef8fc5e9fd02f7a938ddbac655.png) -¿ÉÒÔ¿´µ½£¬`singletonObjects` ÖÐÁ½Õß¶¼ÊÇ´úÀí¶ÔÏ󣬱˴Ë×¢ÈëµÄ£¬Ò²ÊÇ´úÀí¶ÔÏó£¬Ñ­»·ÒÀÀµµÃµ½Á˽â¾ö¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`singletonObjects` 中两者都是代ç�†å¯¹è±¡ï¼Œå½¼æ­¤æ³¨å…¥çš„,也是代ç�†å¯¹è±¡ï¼Œå¾ªçޝä¾�赖得到了解决。 -### 4\. ×ܽá +### 4\. 总结 -spring Ñ­»·ÒÀÀµµÄ·ÖÎöµ½ÕâÀï¾Í½áÊøÁË£¬Ñ­»·ÒÀÀµÓнâµÄºËÐÄÔÚÓÚ**¶ÔÏó¿ÉÒÔÌáǰ½øÐÐ aop**£¬spring ÕýÊÇÀûÓÃÕâÒ»µã£¬ÔÙÅäºÏ 5 ´ó½á¹¹´æ´¢±ØÒªµÄÐÅÏ¢£¬Ò»²½²½½â¾öÑ­»·ÒÀÀµÎÊÌâ¡£ +spring 循环ä¾�赖的分æž�到这里就结æ�Ÿäº†ï¼Œå¾ªçޝä¾�赖有解的核心在于**对象å�¯ä»¥æ��å‰�进行 aop**,spring 正是利用这一点,å†�é…�å�ˆ 5 大结构存储必è¦�的信æ�¯ï¼Œä¸€æ­¥æ­¥è§£å†³å¾ªçޝä¾�赖问题。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4815992](https://my.oschina.net/funcy/blog/4815992) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4815992](https://my.oschina.net/funcy/blog/4815992) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\233\221\345\220\254\345\231\250\346\263\250\350\247\243EventListener.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\233\221\345\220\254\345\231\250\346\263\250\350\247\243EventListener.md" index d83f8b5..1de2be5 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\233\221\345\220\254\345\231\250\346\263\250\350\247\243EventListener.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\233\221\345\220\254\345\231\250\346\263\250\350\247\243EventListener.md" @@ -1,8 +1,8 @@ -×î½üÔÚÊáÀí `BeanFactoryPostProcessor` ¹¦ÄÜʱ£¬·¢ÏÖÁË´¦Àíʼþ¼àÌýµÄÁíÒ»ÖÖ´¦Àí·½Ê½£ºÊ¹Óà `@EventListener` ×¢½â£¬´¦ÀíÀàµÄÊÇ `EventListenerMethodProcessor`£¬ÎÒÃÇÏÈ´ÓÒ»¸öʾÀý³ö·¢£¬ÔÙÖð²½·ÖÎö `@EventListener` µÄ´¦Àí¹ý³Ì¡£ +最近在梳ç�† `BeanFactoryPostProcessor` 功能时,å�‘现了处ç�†äº‹ä»¶ç›‘å�¬çš„å�¦ä¸€ç§�处ç�†æ–¹å¼�:使用 `@EventListener` 注解,处ç�†ç±»çš„æ˜¯ `EventListenerMethodProcessor`,我们先从一个示例出å�‘,å†�é€�步分æž� `@EventListener` 的处ç�†è¿‡ç¨‹ã€‚ -### 1. `@EventListener` ʹÓÃʾÀý +### 1. `@EventListener` 使用示例 -Ïȶ¨ÒåÒ»¸öʼþ£º +先定义一个事件: ``` public class MyApplicationEvent extends ApplicationEvent { @@ -16,25 +16,25 @@ public class MyApplicationEvent extends ApplicationEvent { ``` -ÔÙ×¼±¸Ò»¸öʼþ¼àÌýÆ÷£¬Õâ´ÎʹÓà `@EventListener` Ö¸¶¨¼àÌýÆ÷£º +å†�准备一个事件监å�¬å™¨ï¼Œè¿™æ¬¡ä½¿ç”¨ `@EventListener` 指定监å�¬å™¨ï¼š ``` @Configuration public class Demo08Config { /** - * ÕâÊǸöʼþ¼àÌýÆ÷ + * 这是个事件监å�¬å™¨ */ @EventListener(MyApplicationEvent.class) public void listener(MyApplicationEvent event) { - System.out.println("@EventListener¼àÌýµ½ÁËʼþ£º" + System.out.println("@EventListener监å�¬åˆ°äº†äº‹ä»¶ï¼š" + Thread.currentThread().getName() + " | " + event.getSource()); } } ``` -È»ºó·¢²¼Ê¼þ£º +ç„¶å�Žå�‘布事件: ``` @ComponentScan @@ -42,28 +42,28 @@ public class Demo08Main { public static void main(String[] args) { ApplicationContext context = new AnnotationConfigApplicationContext(Demo08Config.class); - // ·¢²¼Ê¼þ + // å�‘布事件 context.publishEvent(new MyApplicationEvent( - Thread.currentThread().getName() + " | ×Ô¶¨Òåʼþ ...")); + Thread.currentThread().getName() + " | 自定义事件 ...")); } } ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` -@EventListener¼àÌýµ½ÁËʼþ£ºmain | main | ×Ô¶¨Òåʼþ ... +@EventListener监å�¬åˆ°äº†äº‹ä»¶ï¼šmain | main | 自定义事件 ... ``` -¿ÉÒÔ¿´µ½£¬±» `@EventListener` ±ê¼ÇµÄ·½·¨È·ÊµÍê³ÉÁËʼþµÄ¼àÌý¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¢« `@EventListener` 标记的方法确实完æˆ�了事件的监å�¬ã€‚ -### 2. `@EventListener` ¸ÅÀÀ +### 2. `@EventListener` 概览 -ʹÓà `@EventListener` ÈÃÎÒÃÇÃâ³ýÁËʵÏÖ `ApplicationListener` ¾ÍÄÜʵÏÖʼþ¼àÌý£¬¼ò»¯ÁË´úÂëµÄ¿ª·¢¡£±¾½ÚÎÒÃÇÀ´¿´¿´ `@EventListener` ÄÜΪÎÒÃÇ×öЩʲô¡£ +使用 `@EventListener` 让我们å…�除了实现 `ApplicationListener` 就能实现事件监å�¬ï¼Œç®€åŒ–了代ç �的开å�‘。本节我们æ�¥çœ‹çœ‹ `@EventListener` 能为我们å�šäº›ä»€ä¹ˆã€‚ -`@EventListener` µÄ´úÂëÈçÏ£º +`@EventListener` 的代ç �如下: ``` @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) @@ -72,22 +72,22 @@ public class Demo08Main { public @interface EventListener { /** - * classes µÄ±ðÃû - * ÓÃÀ´Ö¸¶¨¼àÌýµÄʼþ£¬¿ÉÒÔͬʱ¼àÌý¶à¸öʼþ + * classes 的别å�� + * 用æ�¥æŒ‡å®šç›‘å�¬çš„事件,å�¯ä»¥å�Œæ—¶ç›‘å�¬å¤šä¸ªäº‹ä»¶ */ @AliasFor("classes") Class[] value() default {}; /** - * value µÄ±ðÃû - * ÓÃÀ´Ö¸¶¨¼àÌýµÄʼþ£¬¿ÉÒÔͬʱ¼àÌý¶à¸öʼþ + * value 的别å�� + * 用æ�¥æŒ‡å®šç›‘å�¬çš„事件,å�¯ä»¥å�Œæ—¶ç›‘å�¬å¤šä¸ªäº‹ä»¶ */ @AliasFor("value") Class[] classes() default {}; /** - * ¿ÉÒÔÖ¸¶¨Ò»¸öÌõ¼þ£¬Ìõ¼þ³ÉÁ¢Ê±·½·¨²Å»áÖ´ÐÐ - * Ö§³Öspring el ±í´ïʽ + * å�¯ä»¥æŒ‡å®šä¸€ä¸ªæ�¡ä»¶ï¼Œæ�¡ä»¶æˆ�立时方法æ‰�会执行 + * 支æŒ�spring el 表达å¼� */ String condition() default ""; @@ -95,18 +95,18 @@ public @interface EventListener { ``` -´Ó´úÂëÀ´¿´£¬`@EventListener` ÌṩÁËÁ½´ó¹¦ÄÜ£º +从代ç �æ�¥çœ‹ï¼Œ`@EventListener` æ��供了两大功能: -* Ö¸¶¨¼àÌýµÄʼþ£¬¿ÉÒÔÖ¸¶¨¶à¸öʼþ -* Ö¸¶¨Ò»¸öÌõ¼þ£¬Ìõ¼þ³ÉÁ¢Ê±·½·¨²Å»áÖ´ÐУ¬Ìõ¼þÖ§³Ö spring EL ±í´ïʽ +* 指定监å�¬çš„事件,å�¯ä»¥æŒ‡å®šå¤šä¸ªäº‹ä»¶ +* 指定一个æ�¡ä»¶ï¼Œæ�¡ä»¶æˆ�立时方法æ‰�会执行,æ�¡ä»¶æ”¯æŒ� spring EL 表达å¼� -Á˽â `@EventListener` ÌṩµÄ¹¦Äܺ󣬽ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ spring ÊÇÈçºÎ´¦ÀíÕâ¸ö×¢½âµÄ¡£ +了解 `@EventListener` æ��供的功能å�Žï¼ŒæŽ¥ä¸‹æ�¥æˆ‘们æ�¥çœ‹çœ‹ spring 是如何处ç�†è¿™ä¸ªæ³¨è§£çš„。 -### 3. `@EventListener` µÄ´¦Àí£º`EventListenerMethodProcessor` +### 3. `@EventListener` 的处ç�†ï¼š`EventListenerMethodProcessor` -ÎÄÕ¿ªÆª±ã˵¹ý£¬¹ØÓÚ `@EventListener` µÄ¹¦ÄÜ£¬ÎÒÊÇÔÚÊáÀí `BeanFactoryPostProcessor` ¹¦ÄÜʱ·¢Ïֵ쬵±Ê±·¢ÏÖ `BeanFactoryPostProcessor` µÄʵÏÖÀà `EventListenerMethodProcessor` »á´¦Àí `@EventListener` ×¢½â£¬½ÓÏÂÀ´¾Í´Ó´úÂë½Ç¶ÈÀ´·ÖÎö `EventListenerMethodProcessor` ´¦Àí `@EventListener` µÄÁ÷³Ì¡£ +文章开篇便说过,关于 `@EventListener` 的功能,我是在梳ç�† `BeanFactoryPostProcessor` 功能时å�‘现的,当时å�‘现 `BeanFactoryPostProcessor` 的实现类 `EventListenerMethodProcessor` 会处ç�† `@EventListener` 注解,接下æ�¥å°±ä»Žä»£ç �角度æ�¥åˆ†æž� `EventListenerMethodProcessor` 处ç�† `@EventListener` çš„æµ�程。 -Ê×ÏÈÎÒÃÇÀ´ÈÏʶÏ `EventListenerMethodProcessor`£º +首先我们æ�¥è®¤è¯†ä¸‹ `EventListenerMethodProcessor`: ``` public class EventListenerMethodProcessor @@ -116,24 +116,24 @@ public class EventListenerMethodProcessor ``` -ËüÖ÷ÒªÊÇʵÏÖÁËÁ½¸ö½Ó¿Ú£º +它主è¦�是实现了两个接å�£ï¼š -* `BeanFactoryPostProcessor`£º´óÃû¶¦¶¦µÄ `BeanFactoryPostProcessor` °¡£¬¿ÉÒÔ¶¨ÖÆ»¯ `BeanFactory` µÄһЩÐÐΪ£» -* `SmartInitializingSingleton`£º´¦Àíµ¥Àý bean µÄ³õʼ»¯²Ù×÷£¬Ö´ÐÐʱ»úÊÇÔÚ `bean` ³õʼ»¯Íê³ÉÖ®ºó¡£ +* `BeanFactoryPostProcessor`:大å��鼎鼎的 `BeanFactoryPostProcessor` 啊,å�¯ä»¥å®šåˆ¶åŒ– `BeanFactory` 的一些行为; +* `SmartInitializingSingleton`:处ç�†å�•例 bean çš„åˆ�始化æ“�作,执行时机是在 `bean` åˆ�始化完æˆ�之å�Žã€‚ -ÎÒÃÇÏÈÀ´¿´¿´Ëü¶Ô `BeanFactoryPostProcessor#postProcessBeanFactory` µÄʵÏÖ£º +我们先æ�¥çœ‹çœ‹å®ƒå¯¹ `BeanFactoryPostProcessor#postProcessBeanFactory` 的实现: ``` @Nullable private List eventListenerFactories; /** - * ÕâÊÇ BeanFactoryPostProcessor µÄ postProcessBeanFactory(...) ·½·¨. - * ÔÚÕâ¸ö·½·¨À½öÊÇ»ñÈ¡ÁË EventListenerFactory£¬È»ºó±£´æÔÚ eventListenerFactoriesÖÐ. - * spring ĬÈÏÌṩµÄ EventListenerFactory ÓÐÁ½¸ö£º - * 1\. DefaultEventListenerFactory£ºspring ĬÈ쵀 - * 2\. TransactionalEventListenerFactory£º´¦ÀíÊÂÎñ¼àÌýµÄ - * Õⲿ·Ö²¢Ã»ÓÐ×öʲô¡£ + * 这是 BeanFactoryPostProcessor çš„ postProcessBeanFactory(...) 方法. + * 在这个方法里,仅是获å�–了 EventListenerFactory,然å�Žä¿�存在 eventListenerFactories中. + * spring 默认æ��供的 EventListenerFactory 有两个: + * 1\. DefaultEventListenerFactory:spring 默认的 + * 2\. TransactionalEventListenerFactory:处ç�†äº‹åŠ¡ç›‘å�¬çš„ + * 这部分并没有å�šä»€ä¹ˆã€‚ */ @Override public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) { @@ -142,27 +142,27 @@ public class EventListenerMethodProcessor Map beans = beanFactory .getBeansOfType(EventListenerFactory.class, false, false); List factories = new ArrayList<>(beans.values()); - // ÅÅÐò + // 排åº� AnnotationAwareOrderComparator.sort(factories); this.eventListenerFactories = factories; } ``` -Õâ¸ö·½·¨»¹ÊDZȽϼòµ¥µÄ£¬¾ÍÖ»ÊÇ´ÓÈÝÆ÷ÖлñÈ¡ÁË `EventListenerFactory` ²¢¸³Öµ¸øÁË `eventListenerFactories`¡£ +这个方法还是比较简å�•的,就å�ªæ˜¯ä»Žå®¹å™¨ä¸­èŽ·å�–了 `EventListenerFactory` 并赋值给了 `eventListenerFactories`。 -`EventListenerFactory` µÄ¹¦ÄÜÊÇÓÃÀ´Éú³É `ApplicationListener`£¬ºóÃæÎÒÃÇ»á·ÖÎö spring ÊÇÈçºÎ°Ñ `@EventListener` ±ê¼ÇµÄ·½·¨×ª»»³É `ApplicationListener` ¶ÔÏóµÄ¡£´Ó´úÂëÀ´¿´£¬spring ÌṩµÄ `EventListenerFactory` ÓÐÁ½¸ö£º +`EventListenerFactory` 的功能是用æ�¥ç”Ÿæˆ� `ApplicationListener`,å�Žé�¢æˆ‘们会分æž� spring 是如何把 `@EventListener` 标记的方法转æ�¢æˆ� `ApplicationListener` 对象的。从代ç �æ�¥çœ‹ï¼Œspring æ��供的 `EventListenerFactory` 有两个: -* `DefaultEventListenerFactory`£ºspring ĬÈ쵀 -* `TransactionalEventListenerFactory`£º´¦ÀíÊÂÎñ¼àÌýµÄ +* `DefaultEventListenerFactory`:spring 默认的 +* `TransactionalEventListenerFactory`:处ç�†äº‹åŠ¡ç›‘å�¬çš„ -½ÓÏÂÀ´ÎÒÃÇÔÙÀ´¿´¿´Ëü¶Ô `SmartInitializingSingleton#afterSingletonsInstantiated()` µÄʵÏÖ£º +接下æ�¥æˆ‘们å†�æ�¥çœ‹çœ‹å®ƒå¯¹ `SmartInitializingSingleton#afterSingletonsInstantiated()` 的实现: ``` /** - * Õâ¸ö·½·¨ÊÇ SmartInitializingSingleton µÄ afterSingletonsInstantiated() ·½·¨. - * »áÔÚbean³õʼ»¯Íê³Éºóµ÷Óᣠ- * ÔÚÕâ¸ö·½·¨ÖУ¬Ö÷ÒªÊǽ«±ê¼ÇÁË @EventListener µÄ·½·¨×ª»»³É ApplicationListener ¶ÔÏ󣬲¢×¢²áµ½¼àÌýÆ÷ÖÐ + * 这个方法是 SmartInitializingSingleton çš„ afterSingletonsInstantiated() 方法. + * 会在beanåˆ�始化完æˆ�å�Žè°ƒç”¨ã€‚ + * 在这个方法中,主è¦�是将标记了 @EventListener 的方法转æ�¢æˆ� ApplicationListener 对象,并注册到监å�¬å™¨ä¸­ */ @Override public void afterSingletonsInstantiated() { @@ -173,8 +173,8 @@ public class EventListenerMethodProcessor if (!ScopedProxyUtils.isScopedTarget(beanName)) { Class type = null; try { - // »ñÈ¡ aop ´úÀí¶ÔÓ¦µÄÄ¿±êÀ࣬´Ó beanName ¶ÔÓ¦µÄ BeanDefinition ÖлñÈ¡. - // Èç¹û»ñÈ¡²»µ½£¬±íʾÊDz»ÊÇ´úÀí¶ÔÏó£¬Ê¹Óà beanFactory.getType(beanName) »ñÈ¡ + // 获å�– aop 代ç�†å¯¹åº”的目标类,从 beanName 对应的 BeanDefinition 中获å�–. + // 如果获å�–ä¸�到,表示是ä¸�是代ç�†å¯¹è±¡ï¼Œä½¿ç”¨ beanFactory.getType(beanName) 获å�– type = AutoProxyUtils.determineTargetClass(beanFactory, beanName); } catch (Throwable ex) { @@ -194,7 +194,7 @@ public class EventListenerMethodProcessor } } try { - // ¾ßÌåµÄ´¦Àí²Ù×÷ + // 具体的处ç�†æ“�作 processBean(beanName, type); } catch (Throwable ex) { @@ -207,17 +207,17 @@ public class EventListenerMethodProcessor ``` -Õâ¸ö·½·¨µÄÖ´ÐÐÁ÷³ÌÈçÏ£º +这个方法的执行æµ�程如下: -1. »ñÈ¡µ±Ç° `beanFactory` ÖеÄËùÓÐ `bean`£¬µ÷ÓõÄÊÇ `beanFactory.getBeanNamesForType(Object.class)` ·½·¨£¬×¢Òâ´«ÈëµÄ `class` ÊÇ `Object`£¬ÕâÑù¾ÍÄóöÁËËùÓÐµÄ `bean`£» -2. ±éÀúÕâЩ `bean`£¬¶Ôÿһ¸ö `bean`£¬Èç¹ûÊÇ´úÀí¶ÔÏó£¬Ôòµ÷Óà `AutoProxyUtils.determineTargetClass(beanFactory, beanName)` ·½·¨»ñÈ¡ÆäÄ¿±êÀ࣬ÎÒÃÇÖªµÀ×¢½âÊDz»Äܼ̳еģ¬Òª»ñÈ¡ `@EventListener` ±ê¼ÇµÄ·½·¨£¬ÐèÒª´ÓÄ¿±êÀàÈ¥»ñÈ¡£»Èç¹û²»ÊÇ´úÀí¶ÔÏó£¬ÔòÄ¿±êÀà¾ÍÊÇ `bean` ¶ÔÓ¦µÄÀࣻ -3. µ÷Óà `processBean(beanName, type)` ·½·¨½øÒ»²½´¦Àí. +1. 获å�–当å‰� `beanFactory` 中的所有 `bean`,调用的是 `beanFactory.getBeanNamesForType(Object.class)` 方法,注æ„�传入的 `class` 是 `Object`,这样就拿出了所有的 `bean`ï¼› +2. é��历这些 `bean`,对æ¯�一个 `bean`,如果是代ç�†å¯¹è±¡ï¼Œåˆ™è°ƒç”¨ `AutoProxyUtils.determineTargetClass(beanFactory, beanName)` 方法获å�–其目标类,我们知é�“注解是ä¸�能继承的,è¦�获å�– `@EventListener` 标记的方法,需è¦�从目标类去获å�–;如果ä¸�是代ç�†å¯¹è±¡ï¼Œåˆ™ç›®æ ‡ç±»å°±æ˜¯ `bean` 对应的类; +3. 调用 `processBean(beanName, type)` 方法进一步处ç�†. -¿´À´¹Ø¼üÊÇÔÚ `EventListenerMethodProcessor#processBean` ·½·¨ÁË£º +看æ�¥å…³é”®æ˜¯åœ¨ `EventListenerMethodProcessor#processBean` 方法了: ``` /** - * ´¦Àí bean£¬ Õâ¸ö·½·¨»á½« @EventListener ×¢½â±ê¼ÇµÄ·½·¨×ª»»Îª ApplicationListener ¶ÔÏ󣬲¢×¢²áµ½¼àÌýÆ÷. + * 处ç�† bean, 这个方法会将 @EventListener 注解标记的方法转æ�¢ä¸º ApplicationListener 对象,并注册到监å�¬å™¨. * @param beanName * @param targetType */ @@ -228,7 +228,7 @@ private void processBean(final String beanName, final Class targetType) { Map annotatedMethods = null; try { - // 1\. ÕÒµ½±ê¼Ç @EventListener µÄ·½·¨ + // 1\. 找到标记 @EventListener 的方法 annotatedMethods = MethodIntrospector.selectMethods(targetType, (MethodIntrospector.MetadataLookup) method -> AnnotatedElementUtils.findMergedAnnotation(method, EventListener.class)); @@ -245,27 +245,27 @@ private void processBean(final String beanName, final Class targetType) { Assert.state(context != null, "No ApplicationContext set"); List factories = this.eventListenerFactories; Assert.state(factories != null, "EventListenerFactory List not initialized"); - // 2\. ʹÓà EventListenerFactory À´²úÉú ApplicationListener ¶ÔÏó + // 2\. 使用 EventListenerFactory æ�¥äº§ç”Ÿ ApplicationListener 对象 for (Method method : annotatedMethods.keySet()) { for (EventListenerFactory factory : factories) { - // Åжϵ±Ç° EventListenerFactory ÊÇ·ñÖ§³Öµ±Ç°·½·¨ + // 判断当å‰� EventListenerFactory 是å�¦æ”¯æŒ�当å‰�方法 if (factory.supportsMethod(method)) { - // Èç¹ûÊÇ´úÀí¶ÔÏó£¬ÔòµÃµ½´úÀíÀàµÄ·½·¨ + // 如果是代ç�†å¯¹è±¡ï¼Œåˆ™å¾—到代ç�†ç±»çš„æ–¹æ³• Method methodToUse = AopUtils.selectInvocableMethod( method, context.getType(beanName)); - // Éú³É ApplicationListener£¬´«ÈëµÄÊÇ´úÀíÀàµÄ·½·¨ + // 生æˆ� ApplicationListener,传入的是代ç�†ç±»çš„æ–¹æ³• ApplicationListener applicationListener = factory .createApplicationListener(beanName, targetType, methodToUse); - // ³õʼ»¯²Ù×÷£¬ÕâÒ»²½Ö÷ÒªÊǶÔÌõ¼þÅÐ¶ÏÆ÷¸³Öµ£ºthis.evaluator + // åˆ�始化æ“�作,这一步主è¦�是对æ�¡ä»¶åˆ¤æ–­å™¨èµ‹å€¼ï¼šthis.evaluator if (applicationListener instanceof ApplicationListenerMethodAdapter) { ((ApplicationListenerMethodAdapter) applicationListener) .init(context, this.evaluator); } - // Ìí¼Óµ½¼àÌýÆ÷ÖУ¬±£´æ Listener ÊÇSet£¬»á×Ô¶¯È¥ÖØ + // 添加到监å�¬å™¨ä¸­ï¼Œä¿�å­˜ Listener 是Set,会自动去é‡� context.addApplicationListener(applicationListener); - // Âú×ãÆäÒ»£¬ºóÃæµÄ EventListenerFactory ¾Í²»»áÔÙÖ´ÐÐÁË£¬ - // ÕâÖÖʱºò¾Í»á·¢ÏÖ factories µÄ˳ÐòºÜÖØÒª - // ¿ÉÒÔÔÚ EventListenerFactory ÖÐÖ¸¶¨Ë³Ðò + // 满足其一,å�Žé�¢çš„ EventListenerFactory å°±ä¸�会å†�执行了, + // è¿™ç§�时候就会å�‘现 factories 的顺åº�很é‡�è¦� + // å�¯ä»¥åœ¨ EventListenerFactory 中指定顺åº� break; } } @@ -276,22 +276,22 @@ private void processBean(final String beanName, final Class targetType) { ``` -ÔÚ `processBean(...)` ·½·¨µÄ¹Ø¼ü´¦Àí¶¼×÷ÁË×¢ÊÍ£¬ÎÒÃÇÔÙ×ܽáÏ´¦ÀíÁ÷³Ì£º +在 `processBean(...)` 方法的关键处ç�†éƒ½ä½œäº†æ³¨é‡Šï¼Œæˆ‘们å†�总结下处ç�†æµ�程: -1. ÕÒµ½±ê¼Ç `@EventListener` µÄ·½·¨£¬ÕâÀïʹÓõÄÊÇ `MethodIntrospector#selectMethods(...)` ·½·¨½øÐвéÕÒ£¬Õâ¸ö·½·¨»á²éµ½µ±Ç°ÀàµÄ·½·¨¡¢Æä¸¸ÀàµÄ·½·¨ÒÔ¼°½Ó¿ÚµÄĬÈÏ·½·¨£¬Ò»Ö±µ½ Object Ϊֹ£¬ÕâЩ·½·¨ÖÐÈç¹û±ê¼ÇÁË `@EventListener`£¬¶¼»á±»ÕÒµ½£¬×îÖÕ»á°ÑÕÒµ½µÄËùÓз½·¨·Åµ½Ò»¸ö Map ÖУ» -2. ±éÀúÉÏÊöµÃµ½µÄ map£¬½«Ã¿¸ö·½·¨×ª»»Îª `ApplicationListener` ¶ÔÏó£¬ÔÙÌí¼Óµ½ `applicationContext` µÄ `ApplicationListener` ÖУ¬¾ßÌåÁ÷³ÌÈçÏ£º - 1. ±éÀúÇ°ÃæµÃµ½µÄ `EventListenerFactory`£» - 2. ±éÀúµ±Ç°µÄ `EventListenerFactory` ÊÇ·ñÖ§³Ö¸Ã·½·¨£¬Ö§³ÖÔò½øÐÐÏÂÒ»²½£¬²»Ö§³ÖÔò²»´¦Àí£» - 3. ¶ÔÓÚ´úÀí¶ÔÏó£¬ÕÒµ½µ±Ç°·½·¨µÄ´úÀí·½·¨£¬×îÖÕÖ´ÐеÄÒ²ÊÇ´úÀí·½·¨£» - 4. ´´½¨ `ApplicationListener` ¶ÔÏ󣬹¹Ôì·½·¨µÄ²ÎÊý»á´«Èë `method`£¬¶ÔÓÚ´úÀí¶ÔÏó£¬Õâ¸ö `method` ÊÇ´úÀí¶ÔÏóµÄ `method`£» - 5. ¶ÔÓÚ `ApplicationListenerMethodAdapter` ʵÀý£¬½øÐгõʼ»¯²Ù×÷£¬Ö÷ÒªÊǸ³Öµ£ºthis.evaluator£» - 6. ½«µÃµ½µÄ `ApplicationListener` Ìí¼Óµ½¼àÌýÆ÷ÖУ¬±£´æ `Listener` ÊÇÒ»¸ö `Set`£¬»á×Ô¶¯È¥ÖØ¡£ +1. 找到标记 `@EventListener` 的方法,这里使用的是 `MethodIntrospector#selectMethods(...)` 方法进行查找,这个方法会查到当å‰�类的方法ã€�其父类的方法以å�пޥå�£çš„默认方法,一直到 Object 为止,这些方法中如果标记了 `@EventListener`,都会被找到,最终会把找到的所有方法放到一个 Map 中; +2. é��历上述得到的 map,将æ¯�个方法转æ�¢ä¸º `ApplicationListener` 对象,å†�添加到 `applicationContext` çš„ `ApplicationListener` 中,具体æµ�程如下: + 1. é��历å‰�é�¢å¾—到的 `EventListenerFactory`ï¼› + 2. é��历当å‰�çš„ `EventListenerFactory` 是å�¦æ”¯æŒ�该方法,支æŒ�则进行下一步,ä¸�支æŒ�则ä¸�处ç�†ï¼› + 3. 对于代ç�†å¯¹è±¡ï¼Œæ‰¾åˆ°å½“å‰�方法的代ç�†æ–¹æ³•,最终执行的也是代ç�†æ–¹æ³•ï¼› + 4. 创建 `ApplicationListener` 对象,构造方法的å�‚数会传入 `method`,对于代ç�†å¯¹è±¡ï¼Œè¿™ä¸ª `method` 是代ç�†å¯¹è±¡çš„ `method`ï¼› + 5. 对于 `ApplicationListenerMethodAdapter` 实例,进行åˆ�始化æ“�作,主è¦�是赋值:this.evaluatorï¼› + 6. 将得到的 `ApplicationListener` 添加到监å�¬å™¨ä¸­ï¼Œä¿�å­˜ `Listener` 是一个 `Set`,会自动去é‡�。 -×ÛÉÏËùÊö£¬±» `@EventListener` ±ê¼ÇµÄ·½·¨Ö®ËùÒÔÄܶÔʼþ½øÐмàÌý£¬ÊÇÒòΪ spring ½«¸Ã·½·¨°ü×°³ÉÒ»¸ö `ApplicationListener` Ìí¼Óµ½¼àÌýÆ÷ÁË£¬Ö®ºóÕâ¸ö¼àÌýÆ÷¾Í¸úʵÏÖÁË `ApplicationListener` ½Ó¿ÚµÄ¼àÌýÆ÷Ò»ÑùÄܶÔʼþ½øÐмàÌýÁË¡£ +综上所述,被 `@EventListener` 标记的方法之所以能对事件进行监å�¬ï¼Œæ˜¯å› ä¸º spring 将该方法包装æˆ�一个 `ApplicationListener` 添加到监å�¬å™¨äº†ï¼Œä¹‹å�Žè¿™ä¸ªç›‘å�¬å™¨å°±è·Ÿå®žçŽ°äº† `ApplicationListener` 接å�£çš„监å�¬å™¨ä¸€æ ·èƒ½å¯¹äº‹ä»¶è¿›è¡Œç›‘å�¬äº†ã€‚ -### 5. `ApplicationListener` ¶ÔÏóµÄÉú³É +### 5. `ApplicationListener` 对象的生æˆ� -Ç°Ãæ·ÖÎöÁË `@EventListener` µÄ´¦ÀíÁ÷³Ì£¬±¾½Ú½«À´·ÖÎö `ApplicationListener` ¶ÔÏóµÄÉú³É£¬¶ÔÓ¦µÄ´úÂëΪ£º +å‰�é�¢åˆ†æž�了 `@EventListener` 的处ç�†æµ�程,本节将æ�¥åˆ†æž� `ApplicationListener` 对象的生æˆ�,对应的代ç �为: ``` // EventListenerMethodProcessor#processBean @@ -300,12 +300,12 @@ ApplicationListener applicationListener = factory ``` -Ç°ÃæÎÒÃǽéÉܹý spring ÌṩµÄ `EventListenerFactory` ÓÐÁ½¸ö£º +å‰�é�¢æˆ‘们介ç»�过 spring æ��供的 `EventListenerFactory` 有两个: -* `DefaultEventListenerFactory`£ºspring ĬÈ쵀 -* `TransactionalEventListenerFactory`£º´¦ÀíÊÂÎñ¼àÌýµÄ +* `DefaultEventListenerFactory`:spring 默认的 +* `TransactionalEventListenerFactory`:处ç�†äº‹åŠ¡ç›‘å�¬çš„ -½ÓÏÂÀ´ÎÒÃǾÍÀ´·ÖÎöÕâÁ½¸ö `EventListenerFactory`¡£ +接下æ�¥æˆ‘们就æ�¥åˆ†æž�这两个 `EventListenerFactory`。 #### 5.1 `DefaultEventListenerFactory` @@ -314,7 +314,7 @@ public class DefaultEventListenerFactory implements EventListenerFactory, Ordere ... /** - * ²»À¢ÊÇĬÈϵÄʵÏÖ£¬ÄÜÖ§³ÖËùÓеķ½·¨ + * ä¸�愧是默认的实现,能支æŒ�所有的方法 */ @Override public boolean supportsMethod(Method method) { @@ -322,7 +322,7 @@ public class DefaultEventListenerFactory implements EventListenerFactory, Ordere } /** - * ´´½¨²Ù×÷ + * 创建æ“�作 */ @Override public ApplicationListener createApplicationListener(String beanName, @@ -333,12 +333,12 @@ public class DefaultEventListenerFactory implements EventListenerFactory, Ordere ``` -¶ÔÒÔÉÏ´úÂë˵Ã÷ÈçÏ£º +对以上代ç �说明如下: -1. `DefaultEventListenerFactory` ÊÇ spring ÌṩµÄĬÈÏʵÏÖ£¬ÄÜÖ§³ÖËùÓбê¼ÇÁË `@EventListener` µÄ·½·¨£» -2. ´´½¨ `ApplicationListener` µÄ·½·¨ÊÇ `createApplicationListener`£¬Ëüµ÷ÓõÄÊÇ `ApplicationListenerMethodAdapter` µÄ¹¹Ôì·½·¨¡£ +1. `DefaultEventListenerFactory` 是 spring æ��供的默认实现,能支æŒ�所有标记了 `@EventListener` 的方法; +2. 创建 `ApplicationListener` 的方法是 `createApplicationListener`,它调用的是 `ApplicationListenerMethodAdapter` 的构造方法。 -ÎÒÃǼÌÐø¿´ `ApplicationListenerMethodAdapter`£º +我们继续看 `ApplicationListenerMethodAdapter`: ``` public class ApplicationListenerMethodAdapter implements GenericApplicationListener { @@ -347,7 +347,7 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe public ApplicationListenerMethodAdapter(String beanName, Class targetClass, Method method) { this.beanName = beanName; - // ´¦Àí·½·¨ + // 处ç�†æ–¹æ³• this.method = BridgeMethodResolver.findBridgedMethod(method); this.targetMethod = (!Proxy.isProxyClass(targetClass) ? AopUtils.getMostSpecificMethod(method, targetClass) : this.method); @@ -355,9 +355,9 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe EventListener ann = AnnotatedElementUtils .findMergedAnnotation(this.targetMethod, EventListener.class); - // ½âÎöÖ§³ÖµÄʼþ + // è§£æž�支æŒ�的事件 this.declaredEventTypes = resolveDeclaredEventTypes(method, ann); - // ×¢½âÖ¸¶¨µÄÌõ¼þ + // 注解指定的æ�¡ä»¶ this.condition = (ann != null ? ann.condition() : null); this.order = resolveOrder(this.targetMethod); } @@ -367,7 +367,7 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe ``` -`ApplicationListenerMethodAdapter` µÄ¹¹Ôì·½·¨¾ÍÊÇÒ»¶ÑµÄ¸³Öµ²Ù×÷£¬ÕâÀïÎÒÃÇÖØµãÀ´¹Ø×¢ÏÂʼþµÄ´¦Àí£º +`ApplicationListenerMethodAdapter` 的构造方法就是一堆的赋值æ“�作,这里我们é‡�点æ�¥å…³æ³¨ä¸‹äº‹ä»¶çš„处ç�†ï¼š ``` public class ApplicationListenerMethodAdapter implements GenericApplicationListener { @@ -375,11 +375,11 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe ... /** - * ½âÎö·½·¨ÄܼàÌýµÄʼþÀàÐÍ + * è§£æž�方法能监å�¬çš„事件类型 */ private static List resolveDeclaredEventTypes(Method method, @Nullable EventListener ann) { - // ·½·¨×î¶àÖ»ÄÜÓÐÒ»¸ö²ÎÊý£¬¼àÌýµÄʼþÀàÐÍÓÉ @EventListener Ö¸¶¨ + // 方法最多å�ªèƒ½æœ‰ä¸€ä¸ªå�‚数,监å�¬çš„事件类型由 @EventListener 指定 int count = method.getParameterCount(); if (count > 1) { throw new IllegalStateException( @@ -387,7 +387,7 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe } if (ann != null) { - // ʼþ¿ÉÒÔÖ¸¶¨¶à¸ö£¬»ñÈ¡µÄÊÇ classes ÊôÐÔÖµ + // 事件å�¯ä»¥æŒ‡å®šå¤šä¸ªï¼ŒèŽ·å�–的是 classes 属性值 Class[] classes = ann.classes(); if (classes.length > 0) { List types = new ArrayList<>(classes.length); @@ -408,14 +408,14 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe ``` -´Ó´úÂë¿ÉÒԵóöÈçϽáÂÛ£º +从代ç �å�¯ä»¥å¾—出如下结论: -1. ±» `@EventListener` ±ê¼ÇµÄ·½·¨£¬²ÎÊý×î¶àÖ»ÄÜÓÐÒ»¸ö -2. ·½·¨ÄܼàÌýµÄʼþ¿ÉÒÔÓжà¸ö£¬ÓÉ `@EventListener` Ö¸¶¨ +1. 被 `@EventListener` 标记的方法,å�‚数最多å�ªèƒ½æœ‰ä¸€ä¸ª +2. 方法能监å�¬çš„事件å�¯ä»¥æœ‰å¤šä¸ªï¼Œç”± `@EventListener` 指定 #### 5.2 `TransactionalEventListenerFactory` -½ÓÏÂÀ´ÎÒÃÇÔÙÀ´¿´¿´ `TransactionalEventListenerFactory`£º +接下æ�¥æˆ‘们å†�æ�¥çœ‹çœ‹ `TransactionalEventListenerFactory`: ``` public class TransactionalEventListenerFactory implements EventListenerFactory, Ordered { @@ -423,7 +423,7 @@ public class TransactionalEventListenerFactory implements EventListenerFactory, ... /** - * Ö»Ö§³Ö±ê¼ÇÁË @TransactionalEventListener ×¢½âµÄ·½·¨ + * å�ªæ”¯æŒ�标记了 @TransactionalEventListener 注解的方法 */ @Override public boolean supportsMethod(Method method) { @@ -431,7 +431,7 @@ public class TransactionalEventListenerFactory implements EventListenerFactory, } /** - * ´´½¨µÄ¶ÔÏóÊÇ ApplicationListenerMethodTransactionalAdapter + * 创建的对象是 ApplicationListenerMethodTransactionalAdapter */ @Override public ApplicationListener createApplicationListener(String beanName, @@ -442,59 +442,59 @@ public class TransactionalEventListenerFactory implements EventListenerFactory, ``` -´Ó´úÂëÀ´¿´£¬`TransactionalEventListenerFactory` Óë `DefaultEventListenerFactory` ²î±ðÈçÏ£º +从代ç �æ�¥çœ‹ï¼Œ`TransactionalEventListenerFactory` 与 `DefaultEventListenerFactory` 差别如下: -* `ApplicationListenerMethodTransactionalAdapter` Ö»Ö§³Ö±ê¼ÇÁË `@TransactionalEventListener` µÄ·½·¨£» -* ´´½¨µÄ `ApplicationListener` ʵ¼ÊÀàÐÍΪ `ApplicationListenerMethodTransactionalAdapter`¡£ +* `ApplicationListenerMethodTransactionalAdapter` å�ªæ”¯æŒ�标记了 `@TransactionalEventListener` 的方法; +* 创建的 `ApplicationListener` 实际类型为 `ApplicationListenerMethodTransactionalAdapter`。 -ÎÒÃÇÏÈÀ´¿´¿´ `@TransactionalEventListener` ÊǸöɶ£º +我们先æ�¥çœ‹çœ‹ `@TransactionalEventListener` 是个啥: ``` @Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented /** - * ±ê¼ÇÁË @EventListener ×¢½â + * 标记了 @EventListener 注解 */ @EventListener public @interface TransactionalEventListener { /** - * ÊÂÎñ´¦Àí + * 事务处ç�† */ TransactionPhase phase() default TransactionPhase.AFTER_COMMIT; /** - * ÊÂÎñ´¦Àí + * 事务处ç�† */ boolean fallbackExecution() default false; /** - * Ö¸¶¨¼àÌýʼþ + * 指定监å�¬äº‹ä»¶ */ @AliasFor(annotation = EventListener.class, attribute = "classes") Class[] value() default {}; /** - * Ö¸¶¨¼àÌýʼþ + * 指定监å�¬äº‹ä»¶ */ @AliasFor(annotation = EventListener.class, attribute = "classes") Class[] classes() default {}; /** - * Ö¸¶¨Ìõ¼þ + * 指定æ�¡ä»¶ */ String condition() default ""; } ``` -¿ÉÒÔ¿´µ½£¬Õâ¸ö×¢½â±ê¼ÇÁË `@EventListener`£¬Òò´Ë¾ßÓÐÓë `@EventListener` ÏàͬµÄ¹¦ÄÜ¡£ÁíÍ⣬Óë `@EventListener` Ïà±È£¬¶àÁËÁ½¸öÊôÐÔ£º`phase()` Óë `fallbackExecution()`£¬¿´À´ÊÇÓÃÀ´¿ØÖÆÊÂÎñµÄ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œè¿™ä¸ªæ³¨è§£æ ‡è®°äº† `@EventListener`,因此具有与 `@EventListener` 相å�Œçš„功能。å�¦å¤–,与 `@EventListener` 相比,多了两个属性:`phase()` 与 `fallbackExecution()`,看æ�¥æ˜¯ç”¨æ�¥æŽ§åˆ¶äº‹åŠ¡çš„ã€‚ -Á˽âÁË `TransactionalEventListener` Ö®ºó£¬ÎÒÃÇÔÙÀ´¿´¿´ `ApplicationListenerMethodTransactionalAdapter`£º +了解了 `TransactionalEventListener` 之å�Žï¼Œæˆ‘们å†�æ�¥çœ‹çœ‹ `ApplicationListenerMethodTransactionalAdapter`: ``` /** - * ¼Ì³ÐÁË ApplicationListenerMethodAdapter + * 继承了 ApplicationListenerMethodAdapter */ class ApplicationListenerMethodTransactionalAdapter extends ApplicationListenerMethodAdapter { ... @@ -503,9 +503,9 @@ class ApplicationListenerMethodTransactionalAdapter extends ApplicationListenerM public ApplicationListenerMethodTransactionalAdapter(String beanName, Class targetClass, Method method) { - // µ÷Óø¸ÀàµÄ·½·¨ + // 调用父类的方法 super(beanName, targetClass, method); - // ÕâÀïµÄ×¢½âÊÇ @TransactionalEventListener + // 这里的注解是 @TransactionalEventListener TransactionalEventListener ann = AnnotatedElementUtils .findMergedAnnotation(method, TransactionalEventListener.class); if (ann == null) { @@ -519,20 +519,20 @@ class ApplicationListenerMethodTransactionalAdapter extends ApplicationListenerM ``` -´Ó´úÂëÉÏÀ´¿´£¬`ApplicationListenerMethodTransactionalAdapter` ¼Ì³ÐÁË `ApplicationListenerMethodAdapter`£¬Æä¹¹Ôì·½·¨Ò²ÊÇÏȵ÷Óà `ApplicationListenerMethodAdapter` µÄ¹¹Ôì·½·¨£¬È»ºóÔÙ¸ø `annotation` ¸³Öµ¡£ +从代ç �上æ�¥çœ‹ï¼Œ`ApplicationListenerMethodTransactionalAdapter` 继承了 `ApplicationListenerMethodAdapter`,其构造方法也是先调用 `ApplicationListenerMethodAdapter` 的构造方法,然å�Žå†�ç»™ `annotation` 赋值。 -### 6\. ʼþ¼àÌý +### 6\. 事件监å�¬ -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´Ê¼þµÄ¼àÌý²Ù×÷¡£ +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹äº‹ä»¶çš„监å�¬æ“�作。 -#### 6.1 `ApplicationListenerMethodAdapter` ¼àÌýʼþ +#### 6.1 `ApplicationListenerMethodAdapter` 监å�¬äº‹ä»¶ -ÔÚÇ°ÃæµÄÎÄÕÂÖУ¬ÎÒÃÇÖªµÀ `ApplicationListener` Òª´¦ÀíÒ»¸öʼþ£¬±ØÐë°üº¬Á½¸ö²Ù×÷£º +在å‰�é�¢çš„æ–‡ç« ä¸­ï¼Œæˆ‘们知é�“ `ApplicationListener` è¦�处ç�†ä¸€ä¸ªäº‹ä»¶ï¼Œå¿…须包å�«ä¸¤ä¸ªæ“�作: -1. Åжϵ±Ç° `ApplicationListener` ÊÇ·ñÖ§³Öµ±Ç°Ê¼þ -2. Èç¹ûÖ§³Ö£¬Ôò½øÐÐʼþ´¦Àí +1. 判断当å‰� `ApplicationListener` 是å�¦æ”¯æŒ�当å‰�事件 +2. 如果支æŒ�,则进行事件处ç�† -ÎÒÃÇÀ´¿´¿´ `ApplicationListenerMethodAdapter` µÄÕâÁ½¸ö²Ù×÷£º +我们æ�¥çœ‹çœ‹ `ApplicationListenerMethodAdapter` 的这两个æ“�作: ``` public class ApplicationListenerMethodAdapter implements GenericApplicationListener { @@ -540,9 +540,9 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe ... /** - * µ±Ç° listener ÊÇ·ñÖ§³Ö´«ÈëµÄʼþ. - * ʹÓõķ½·¨ÊÇ ResolvableType#isAssignableFrom(ResolvableType)£¬¿ÉÒÔ½«¸Ã·½·¨¼òµ¥Àí½â - * ΪÊÇ¶Ô Class#isAssignableFrom ¹¦ÄܵÄÀ©Õ¹ + * 当å‰� listener 是å�¦æ”¯æŒ�传入的事件. + * 使用的方法是 ResolvableType#isAssignableFrom(ResolvableType),å�¯ä»¥å°†è¯¥æ–¹æ³•简å�•ç�†è§£ + * 为是对 Class#isAssignableFrom 功能的扩展 */ @Override public boolean supportsEventType(ResolvableType eventType) { @@ -562,7 +562,7 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe } /** - * ʼþ´¦Àí + * 事件处ç�† */ @Override public void onApplicationEvent(ApplicationEvent event) { @@ -570,14 +570,14 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe } public void processEvent(ApplicationEvent event) { - // ½âÎö²ÎÊý + // è§£æž�å�‚æ•° Object[] args = resolveArguments(event); - // shouldHandle£ºÅжÏÌõ¼þ£¬ÓÉ EventListener.condition() Ìṩ + // shouldHandle:判断æ�¡ä»¶ï¼Œç”± EventListener.condition() æ��ä¾› if (shouldHandle(event, args)) { - // ·´Éäµ÷Ó÷½·¨ + // å��射调用方法 Object result = doInvoke(args); if (result != null) { - // ´¦ÀíÖ´Ðнá¹û£¬½«·µ»ØµÄ½á¹ûµ±×÷ʼþ·¢²¼³öÈ¥ + // 处ç�†æ‰§è¡Œç»“果,将返回的结果当作事件å�‘布出去 handleResult(result); } else { @@ -590,36 +590,36 @@ public class ApplicationListenerMethodAdapter implements GenericApplicationListe ``` -¿ÉÒÔ¿´µ½£¬Åжϵ±Ç°µ±Ç° `ApplicationListener` ÊÇ·ñÖ§³Öµ±Ç°Ê¼þʱ£¬Ê¹ÓõÄÊÇ `ResolvableType#isAssignableFrom(ResolvableType)`£¬¹ØÓÚÕâ¸ö·½·¨±¾ÎIJ¢²»´òËãÉîÈë·ÖÎö£¬¿ÉÒÔ¼òµ¥µØ½«¸Ã·½·¨Àí½âΪÊÇ¶Ô `Class#isAssignableFrom` ¹¦ÄܵÄÀ©Õ¹¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œåˆ¤æ–­å½“å‰�当å‰� `ApplicationListener` 是å�¦æ”¯æŒ�当å‰�事件时,使用的是 `ResolvableType#isAssignableFrom(ResolvableType)`,关于这个方法本文并ä¸�打算深入分æž�,å�¯ä»¥ç®€å�•地将该方法ç�†è§£ä¸ºæ˜¯å¯¹ `Class#isAssignableFrom` 功能的扩展。 -`ApplicationListenerMethodAdapter` ´¦Àíʼþ¼àÌýµÄÁ÷³ÌÈçÏ£º +`ApplicationListenerMethodAdapter` 处ç�†äº‹ä»¶ç›‘å�¬çš„æµ�程如下: -1. ½âÎö²ÎÊý£¬½«´«ÈëµÄ `event` ת»»Îª·½·¨²ÎÊýÖоßÌåµÄÖµ -2. ͨ¹ý·´Éäµ÷Óñ» `@EventListener` ±ê¼ÇµÄ·½·¨ -3. ´¦Àí `@EventListener` ·½·¨µÄ·µ»Ø½á¹û£¬ÔÚ `handleResult(...)` ·½·¨Àï¿ÉÒÔ½«·µ»ØµÄ½á¹ûµ±×÷ʼþÔÙ·¢²¼³öÈ¥ +1. è§£æž�å�‚数,将传入的 `event` 转æ�¢ä¸ºæ–¹æ³•å�‚数中具体的值 +2. 通过å��射调用被 `@EventListener` 标记的方法 +3. 处ç�† `@EventListener` 方法的返回结果,在 `handleResult(...)` 方法里å�¯ä»¥å°†è¿”回的结果当作事件å†�å�‘布出去 -¹ØÓÚ `ApplicationListenerMethodAdapter` ´¦Àíʼþ¼àÌý¾Í·ÖÎöµ½ÕâÀïÁË¡£ +关于 `ApplicationListenerMethodAdapter` 处ç�†äº‹ä»¶ç›‘å�¬å°±åˆ†æž�到这里了。 -#### 6.2 `ApplicationListenerMethodTransactionalAdapter` ¼àÌýʼþ +#### 6.2 `ApplicationListenerMethodTransactionalAdapter` 监å�¬äº‹ä»¶ -`ApplicationListenerMethodTransactionalAdapter` µÄʼþ¼àÌý±È `ApplicationListenerMethodAdapter` Òª¼òµ¥Ò»Ð©£º +`ApplicationListenerMethodTransactionalAdapter` 的事件监å�¬æ¯” `ApplicationListenerMethodAdapter` è¦�简å�•一些: ``` /** - * ¼Ì³ÐÁË ApplicationListenerMethodAdapter + * 继承了 ApplicationListenerMethodAdapter */ class ApplicationListenerMethodTransactionalAdapter extends ApplicationListenerMethodAdapter { ... - // supportsEventType(...) Ò²ÊǼ̳Ð×ÔÄãÀàµÄ·½·¨£¬×ÔÉí²¢ÎÞʵÏÖ + // supportsEventType(...) 也是继承自你类的方法,自身并无实现 /** - * ʼþ´¦Àí + * 事件处ç�† */ @Override public void onApplicationEvent(ApplicationEvent event) { - // ´ó¸ÅÊÇÔÚ´¦ÀíÊÂÎñµÄ²Ù×÷£¬ºóÃæÓлú»áÔÙÑо¿ + // 大概是在处ç�†äº‹åŠ¡çš„æ“�作,å�Žé�¢æœ‰æœºä¼šå†�研究 if (TransactionSynchronizationManager.isSynchronizationActive() && TransactionSynchronizationManager.isActualTransactionActive()) { TransactionSynchronization transactionSynchronization @@ -627,11 +627,11 @@ class ApplicationListenerMethodTransactionalAdapter extends ApplicationListenerM TransactionSynchronizationManager.registerSynchronization(transactionSynchronization); } else if (this.annotation.fallbackExecution()) { - // µ÷ÓõÄÊǸ¸ÀàµÄ·½·¨ + // 调用的是父类的方法 processEvent(event); } else { - // Ö»ÊÇlog ´òÓ¡£¬Ê¡ÂÔ + // å�ªæ˜¯log 打å�°ï¼Œçœ�ç•¥ ... } } @@ -641,22 +641,22 @@ class ApplicationListenerMethodTransactionalAdapter extends ApplicationListenerM ``` -¶ÔÒÔÉÏ´úÂë˵Ã÷ÈçÏ£º +对以上代ç �说明如下: -1. `ApplicationListenerMethodTransactionalAdapter` ÊÇ `ApplicationListenerMethodAdapter` µÄ×ÓÀ࣬»á¼Ì³ÐÀ´×Ô `ApplicationListenerMethodAdapter` µÄ·½·¨ -2. `ApplicationListenerMethodTransactionalAdapter` ²¢Ã»ÓÐÖØÐ´ `supportsEventType(...)` ·½·¨£¬Òò´ËÒ²ÊÇʹÓà `ApplicationListenerMethodAdapter` µÄ `supportsEventType(...)` ·½·¨À´ÅжÏʼþµÄÖ§³ÖÇé¿ö -3. ÔÚ´¦Àíʼþʱ£¬`ApplicationListenerMethodTransactionalAdapter` »á½øÐÐÊÂÎñÏà¹ØµÄ´¦Àí£¬¾ßÌåµÄ´¦ÀíÂß¼­±¾ÎľͲ»ÉîÈëÁË +1. `ApplicationListenerMethodTransactionalAdapter` 是 `ApplicationListenerMethodAdapter` çš„å­�类,会继承æ�¥è‡ª `ApplicationListenerMethodAdapter` 的方法 +2. `ApplicationListenerMethodTransactionalAdapter` 并没有é‡�写 `supportsEventType(...)` 方法,因此也是使用 `ApplicationListenerMethodAdapter` çš„ `supportsEventType(...)` 方法æ�¥åˆ¤æ–­äº‹ä»¶çš„æ”¯æŒ�情况 +3. 在处ç�†äº‹ä»¶æ—¶ï¼Œ`ApplicationListenerMethodTransactionalAdapter` 会进行事务相关的处ç�†ï¼Œå…·ä½“的处ç�†é€»è¾‘本文就ä¸�深入了 -### 7\. ×ܽá +### 7\. 总结 -±¾ÎÄÖ÷Òª·ÖÎöÁË `@EventListener` µÄ´¦ÀíÁ÷³Ì£¬×ܽáÈçÏ£º +本文主è¦�分æž�了 `@EventListener` 的处ç�†æµ�程,总结如下: -1. `@EventListener` ¿ÉÒÔÖ¸¶¨¼àÌýµÄʼþ¡¢Ê¼þ´¦ÀíµÄÌõ¼þ -2. ´¦Àí `@EventListener` µÄÀàÊÇ `EventListenerMethodProcessor`£¬¸ÃÀà»á°Ñ±» `@EventListener` ±ê¼ÇµÄ·½·¨×ª»»³ÉÒ»¸ö `ApplicationListener` ¶ÔÏó£¬È»ºóÌí¼Óµ½ `ApplicationContext` µÄ¼àÌýÆ÷ÖÐ -3. ·½·¨×ª»»³É `ApplicationListener` ¶ÔÏóµÄ²Ù×÷ÓÉ `EventListenerFactory` Ìṩ£¬spring ÌṩÁËÁ½¸ö `EventListenerFactory`£º - * `DefaultEventListenerFactory`£ºspring ĬÈϵģ¬×ª»»³ÉµÄ `ApplicationListener` Ϊ `ApplicationListenerMethodAdapter` - * `TransactionalEventListenerFactory`£º´¦ÀíÊÂÎñ¼àÌýµÄ£¬×ª»»³ÉµÄ `ApplicationListener` Ϊ `ApplicationListenerMethodTransactionalAdapter` +1. `@EventListener` å�¯ä»¥æŒ‡å®šç›‘å�¬çš„事件ã€�事件处ç�†çš„æ�¡ä»¶ +2. 处ç�† `@EventListener` 的类是 `EventListenerMethodProcessor`,该类会把被 `@EventListener` 标记的方法转æ�¢æˆ�一个 `ApplicationListener` 对象,然å�Žæ·»åŠ åˆ° `ApplicationContext` 的监å�¬å™¨ä¸­ +3. 方法转æ�¢æˆ� `ApplicationListener` 对象的æ“�作由 `EventListenerFactory` æ��供,spring æ��供了两个 `EventListenerFactory`: + * `DefaultEventListenerFactory`:spring 默认的,转æ�¢æˆ�çš„ `ApplicationListener` 为 `ApplicationListenerMethodAdapter` + * `TransactionalEventListenerFactory`:处ç�†äº‹åŠ¡ç›‘å�¬çš„,转æ�¢æˆ�çš„ `ApplicationListener` 为 `ApplicationListenerMethodTransactionalAdapter` * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4926344](https://my.oschina.net/funcy/blog/4926344) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4926344](https://my.oschina.net/funcy/blog/4926344) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\273\204\345\220\210\346\263\250\350\247\243\347\232\204\345\244\204\347\220\206.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\273\204\345\220\210\346\263\250\350\247\243\347\232\204\345\244\204\347\220\206.md" index 57e42d1..c56f34f 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\273\204\345\220\210\346\263\250\350\247\243\347\232\204\345\244\204\347\220\206.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/Spring\346\272\220\347\240\201\345\210\206\346\236\220/Spring\351\207\215\350\246\201\346\234\272\345\210\266\346\216\242\347\247\230/Spring\346\216\242\347\247\230\344\271\213\347\273\204\345\220\210\346\263\250\350\247\243\347\232\204\345\244\204\347\220\206.md" @@ -1,13 +1,13 @@ -### 1\. ʲôÊÇ×éºÏ×¢½â£¿ +### 1\. 什么是组å�ˆæ³¨è§£ï¼Ÿ -ÔÚ spring ÖУ¬ÓÐÒ»ÀàÌØ±ðµÄ×¢½â£º×éºÏ×¢½â¡£¾ÙÀýÀ´Ëµ£¬springmvc ÖУ¬`@Controller` ×¢½âÓÃÀ´ÅäÖ÷ÃÎÊ·¾¶µÈ£¬`@ResponseBody` ×¢½âÓÃÀ´±íÃ÷²»×öÊÓͼäÖȾ£¬Ö±½Óչʾ·½·¨µÄÔËÐнá¹û£¨Ò»°ãÊÇת³É json ·µ»Ø£©£¬¶ø `@RestController` ×éºÏÁËÁ½ÕߵŦÄÜ£¬¿ÉÒÔÅäÖ÷ÃÎÊ·¾¶£¬Í¬Ê±Ò²¿ÉÒÔÖ±½Óչʾ·½·¨µÄÔËÐнá¹û£¬´úÂëÈçÏ£º +在 spring 中,有一类特别的注解:组å�ˆæ³¨è§£ã€‚举例æ�¥è¯´ï¼Œspringmvc 中,`@Controller` 注解用æ�¥é…�置访问路径等,`@ResponseBody` 注解用æ�¥è¡¨æ˜Žä¸�å�šè§†å›¾æ¸²æŸ“,直接展示方法的è¿�行结果(一般是转æˆ� json 返回),而 `@RestController` 组å�ˆäº†ä¸¤è€…的功能,å�¯ä»¥é…�置访问路径,å�Œæ—¶ä¹Ÿå�¯ä»¥ç›´æŽ¥å±•示方法的è¿�行结果,代ç �如下: ``` @Controller @ResponseBody public @interface RestController { /** - * ×¢½â±ðÃû + * 注解别å�� */ @AliasFor(annotation = Controller.class) String value() default ""; @@ -16,9 +16,9 @@ public @interface RestController { ``` -¿ÉÒÔ¿´µ½£¬`@RestController` Éϱê¼ÇÁËÁ½¸ö×¢½â£º`@Controller` Óë `@ResponseBody`£¬ÕâÑùËü¾ÍͬʱӵÓÐÁËÁ½ÕߵŦÄÜ¡£ +å�¯ä»¥çœ‹åˆ°ï¼Œ`@RestController` 上标记了两个注解:`@Controller` 与 `@ResponseBody`,这样它就å�Œæ—¶æ‹¥æœ‰äº†ä¸¤è€…的功能。 -ÔÙÀ´¿´Ò»¸öÀý×Ó£¬spring ÖУ¬ÎÒÃÇÔÚ±êʶһ¸öÀàΪ spring bean µÄʱºò£¬¿ÉÒÔÓõ½ÕâЩע½â£º`@Component`¡¢`@Repository`¡¢`@Service` µÈ£¬ÔÙ½øÒ»²½¿´Æä´úÂ룬·¢ÏÖ `@Repository`¡¢`@Service` Öж¼ÓÐ `@Component`£º +å†�æ�¥çœ‹ä¸€ä¸ªä¾‹å­�,spring 中,我们在标识一个类为 spring bean 的时候,å�¯ä»¥ç”¨åˆ°è¿™äº›æ³¨è§£ï¼š`@Component`ã€�`@Repository`ã€�`@Service` 等,å†�进一步看其代ç �,å�‘现 `@Repository`ã€�`@Service` 中都有 `@Component`: ``` @Component @@ -35,9 +35,9 @@ public @interface Service { ``` -Ò²¾ÍÊÇ˵£¬`@Repository`¡¢`@Service` ¶¼×éºÏÁË `@Component` µÄ¹¦ÄÜ£¡ +也就是说,`@Repository`ã€�`@Service` 都组å�ˆäº† `@Component` 的功能ï¼� -ʵ¼ÊÉÏ£¬Èç¹ûÎÒÃÇ×Ô¼ºÐ´Ò»¸ö×¢½â£¬ÏñÕâÑù£º +实际上,如果我们自己写一个注解,åƒ�这样: ``` @Target({ElementType.TYPE}) @@ -53,7 +53,7 @@ public @interface MyComponent { ``` -È»ºóÕâÑùʹÓ㺠+ç„¶å�Žè¿™æ ·ä½¿ç”¨ï¼š ``` @MyComponent("beanObj3") @@ -63,30 +63,30 @@ public class BeanObj3 { ``` -spring ÒÀÈ»»á°Ñ `BeanObj3` ³õʼ»¯Îª spring bean¡£ +spring ä¾�然会把 `BeanObj3` åˆ�始化为 spring bean。 -ÄÇô spring ÊÇÈçºÎ×öµ½ÕâÒ»²½µÄÄØ£¿Êµ¼ÊÉÏ£¬spring ÔÚ´¦Àí `@MyComponent` ʱ£¬»áÅжϸÃ×¢½âÖÐÊÇ·ñ°üº¬ `@Component` ×¢½â£¬Èç¹û°üº¬£¬¾Í»ñÈ¡¸Ã×¢½âµÄÅäÖã¬È»ºó°´ `@Component` µÄ´¦ÀíÂß¼­À´½øÐд¦Àí¡£ +那么 spring 是如何å�šåˆ°è¿™ä¸€æ­¥çš„呢?实际上,spring 在处ç�† `@MyComponent` 时,会判断该注解中是å�¦åŒ…å�« `@Component` 注解,如果包å�«ï¼Œå°±èŽ·å�–该注解的é…�置,然å�ŽæŒ‰ `@Component` 的处ç�†é€»è¾‘æ�¥è¿›è¡Œå¤„ç�†ã€‚ -ͬÑùµØ£¬spring ÔÚ´¦Àí `@RestController` ʱ£¬Èç¹ûµ±Ç°ÊÇ´¦Àí `@Controller` µÄÂß¼­£¬¾Í´Ó `@RestController` ÖлñÈ¡ `@Controller` µÄÅäÖÃÈ»ºó½øÐд¦Àí£¬Èç¹ûµ±Ç°ÊÇ´¦Àí `@ResponseBody` Âß¼­£¬¾Í´Ó `@RestController` ÖлñÈ¡ `@ResponseBody` µÄÅäÖÃÈ»ºó½øÐд¦Àí¡£ +å�Œæ ·åœ°ï¼Œspring 在处ç�† `@RestController` 时,如果当å‰�是处ç�† `@Controller` 的逻辑,就从 `@RestController` 中获å�– `@Controller` çš„é…�置然å�Žè¿›è¡Œå¤„ç�†ï¼Œå¦‚果当å‰�是处ç�† `@ResponseBody` 逻辑,就从 `@RestController` 中获å�– `@ResponseBody` çš„é…�置然å�Žè¿›è¡Œå¤„ç�†ã€‚ -### 2\. µÝ¹é»ñȡָ¶¨ÀàµÄËùÓÐ×¢½â +### 2\. 递归获å�–指定类的所有注解 -ÎÊÌâÓÖÀ´ÁË£º×éºÏ×¢½âÖеÄ×¢½âÒªÔõô»ñÈ¡ÄØ£¿ +问题å�ˆæ�¥äº†ï¼šç»„å�ˆæ³¨è§£ä¸­çš„æ³¨è§£è¦�怎么获å�–呢? -Èç¹û°´ÕÕ jdk ÌṩµÄ·½·¨£¬ÏñÕâÑù£º +如果按照 jdk æ��供的方法,åƒ�这样: ``` RestController annotation = BeanObj3.class.getAnnotation(MyComponent.class); ``` -µÃµ½µÄ `annotation` ±Ø¶¨Îª `null`£¬Ô­ÒòÊÇ `Class#getAnnotation` ·½·¨Ö»ÄÜ»ñÈ¡µ½ÀàÉÏÖ±½Ó³öÏÖµÄ×¢½â£¬`BeanObj3` ÊÇûÓÐÖ±½Ó³öÏÖ `@Component` µÄ£¬Òò´ËµÃµ½µÄ½á¹ûΪ null£¬°ì·¨Ò²ÐíÄãÒ²Ïëµ½ÁË£¬¾ÍÊǼÌÐøÍù϶ÁÈ¡ "×¢½âµÄ×¢½â"£¬ÓôúÂëʾÒâÏ£¬ÀàËÆÕâÑù£º +得到的 `annotation` 必定为 `null`,原因是 `Class#getAnnotation` 方法å�ªèƒ½èŽ·å�–到类上直接出现的注解,`BeanObj3` 是没有直接出现 `@Component` 的,因此得到的结果为 null,办法也许你也想到了,就是继续往下读å�– "注解的注解",用代ç �示æ„�下,类似这样: ``` public class AnnotationHandler { /** - * ´æ·ÅjdkÌṩµÄԪע½â + * 存放jdkæ��供的元注解 */ private static Set> metaAnnotations = new HashSet<>(); static { @@ -101,35 +101,35 @@ public class AnnotationHandler { } /** - * »ñÈ¡²Ù×÷£¬µÝ¹éµ÷Óà + * 获å�–æ“�作,递归调用 */ public static List> getAnnotations(Class cls) { - // ÓÃÀ´´æ·Å¸ÃÀàÉϵÄËùÓÐ×¢½â£¬°üÀ¨×¢½âµÄ×¢½â + // 用æ�¥å­˜æ”¾è¯¥ç±»ä¸Šçš„æ‰€æœ‰æ³¨è§£ï¼ŒåŒ…括注解的注解 List> list = new ArrayList<>(); - // µ÷Óà doGetAnnotations(...) »ñÈ¡ + // 调用 doGetAnnotations(...) 获å�– doGetAnnotations(list, cls); return list; } /** - * »ñȡע½âµÄ¾ßÌå²Ù×÷ + * 获å�–注解的具体æ“�作 */ private static void doGetAnnotations(List> list, Class cls) { - // »ñÈ¡ËùÓеÄ×¢½â + // 获å�–所有的注解 Annotation[] annotations = cls.getAnnotations(); if(annotations != null && annotations.length > 0) { for(Annotation annotation : annotations) { - // »ñȡע½âµÄÀàÐÍ + // 获å�–注解的类型 Class annotationType = annotation.annotationType(); - // ¹ýÂËjdkÌṩµÄԪע½â + // 过滤jdkæ��供的元注解 if(metaAnnotations.contains(annotationType)) { continue; } - // µÝ¹éµ÷Óà + // 递归调用 doGetAnnotations(list, annotationType); } } - // Èç¹ûÊÇ×¢½â£¬¾ÍÌí¼Óµ½ list ÖÐ + // 如果是注解,就添加到 list 中 if(cls.isAnnotation()) { list.add(cls); } @@ -138,20 +138,20 @@ public class AnnotationHandler { ``` -ÎÒÃÇÒª»ñÈ¡ `BeanObj3` ÉÏËùÓÐ×¢½â£¬¾Í¿ÉÒÔÕâÑù²Ù×÷ÁË£º +我们è¦�获å�– `BeanObj3` 上所有注解,就å�¯ä»¥è¿™æ ·æ“�作了: ``` -// µÃµ½ BeanObj3 ÉϵÄËùÓÐ×¢½â£¬°üÀ¨¡°×¢½âµÄ×¢½â¡± +// 得到 BeanObj3 上的所有注解,包括“注解的注解â€� List> list = AnnotationHandler.getAnnotations(BeanObj3.class); -// ÅÐ¶Ï BeanObj3 µÄ×¢½âÖÐÊÇ·ñ°üº¬ @Component +// 判断 BeanObj3 的注解中是å�¦åŒ…å�« @Component list.contains(Component.class); ``` -ÒÔÉÏ demo »¹ÊDZȽϴֲڣ¬Ê×ÏÈÊÇ jdk µÄԪע½â£¬ÕâÀïÖ»ÅųýÁËÈý¸ö£¬ÕâÈý¸ö¶¼ÊÇÔÚ `@Component` ÖгöÏֵ쬴¦Àí `@Component` Ö®ÉϵÄ×¢½â¶ÁÈ¡ÒѾ­×ã¹»ÁË£»Æä´ÎÒ²ÊÇ×îÖØÒªµÄ£¬¾ÍÊÇûÓлñȡע½âµÄÊý¾Ý¡£ÔÚ spring ÖУ¬×¢½â²¢²»Ö»ÊÇÒ»¸ö±ê¼Ç£¬»¹¿ÉÒÔ¶¨ÒåһϵÁÐÊýÁ¿£¬ÏñÕâÑù£º +以上 demo 还是比较粗糙,首先是 jdk 的元注解,这里å�ªæŽ’除了三个,这三个都是在 `@Component` 中出现的,处ç�† `@Component` 之上的注解读å�–å·²ç»�足够了;其次也是最é‡�è¦�的,就是没有获å�–注解的数æ�®ã€‚在 spring 中,注解并ä¸�å�ªæ˜¯ä¸€ä¸ªæ ‡è®°ï¼Œè¿˜å�¯ä»¥å®šä¹‰ä¸€ç³»åˆ—æ•°é‡�,åƒ�这样: ``` -// ¶¨Òå spring bean µÄÃû³ÆÎª beanObj3 +// 定义 spring bean çš„å��称为 beanObj3 @MyComponent("beanObj3") public class BeanObj3 { ... @@ -159,74 +159,74 @@ public class BeanObj3 { ``` -¶ø `AnnotationHandler` ²¢²»ÄÜ»ñÈ¡µ½×¢½âµÄÊý¾Ý£¡ +而 `AnnotationHandler` å¹¶ä¸�能获å�–到注解的数æ�®ï¼� -½ÓÏÂÀ´ÎÒÃÇÀ´¿´¿´ spring ÊÇÔõô×öµ½×¢½âÊý¾ÝµÄ¶ÁÈ¡µÄ¡£ +接下æ�¥æˆ‘们æ�¥çœ‹çœ‹ spring 是怎么å�šåˆ°æ³¨è§£æ•°æ�®çš„读å�–的。 -### 3\. spring ¶Áȡע½âÐÅÏ¢ +### 3\. spring 读å�–注解信æ�¯ -spring 5.2 ÖУ¬¶ÔÓÚ×¢½âÐÅÏ¢µÄ¶ÁÈ¡ÓÐÌṩÁËÈý¸öÀࣺ +spring 5.2 中,对于注解信æ�¯çš„读å�–有æ��供了三个类: -* `AnnotationMetadataReadingVisitor`£º×¢½âÊý¾ÝµÄ¶ÁÈ¡À࣬»ùÓÚ asm ʵÏÖ£¬²»¹ýÔÚ spring5.2 ÖÐÒѾ­·ÏÆú£¨±ê¼ÇÁË `@Deprecated`£©£¬½¨ÒéʹÓà `SimpleAnnotationMetadataReadingVisitor`£¬Òò´Ë±¾ÎIJ»×÷·ÖÎö -* `SimpleAnnotationMetadataReadingVisitor`£º×¢½âÊý¾ÝµÄ¶ÁÈ¡À࣬»ùÓÚ asm ʵÏÖ£¬spring 5.2 ÖÐÐÂÔöµÄÀ࣬ÓÃÓÚÌæ´ú `AnnotationMetadataReadingVisitor`£¬ÐèҪע½âµÄÊÇ£¬`SimpleAnnotationMetadataReadingVisitor` µÄ·ÃÎʼ¶±ðÊÇĬÈϵģ¬ÎÞ·¨ÔÚËùÔÚ°üÖ®Íâ·ÃÎÊ£¬Í¬Ê±ËüÒ²ÊÇ `final` µÄ£¬²»Äܱ»¼Ì³Ð£¬Òò´ËÎÒÃÇÎÞ·¨Ö±½Ó²Ù×÷Ëü£¬²»¹ý spring ÌṩÁËÒ»¸öÀࣺ`SimpleMetadataReaderFactory`£¬Í¨¹ýËü¾Í¿ÉÒÔʹÓà `SimpleAnnotationMetadataReadingVisitor` ÁË -* `StandardAnnotationMetadata`£º×¢½âÊý¾ÝµÄ¶ÁÈ¡À࣬»ùÓÚ·´ÉäʵÏÖ +* `AnnotationMetadataReadingVisitor`:注解数æ�®çš„读å�–类,基于 asm 实现,ä¸�过在 spring5.2 中已ç»�废弃(标记了 `@Deprecated`),建议使用 `SimpleAnnotationMetadataReadingVisitor`,因此本文ä¸�作分æž� +* `SimpleAnnotationMetadataReadingVisitor`:注解数æ�®çš„读å�–类,基于 asm 实现,spring 5.2 中新增的类,用于替代 `AnnotationMetadataReadingVisitor`,需è¦�注解的是,`SimpleAnnotationMetadataReadingVisitor` 的访问级别是默认的,无法在所在包之外访问,å�Œæ—¶å®ƒä¹Ÿæ˜¯ `final` 的,ä¸�能被继承,因此我们无法直接æ“�作它,ä¸�过 spring æ��供了一个类:`SimpleMetadataReaderFactory`,通过它就å�¯ä»¥ä½¿ç”¨ `SimpleAnnotationMetadataReadingVisitor` 了 +* `StandardAnnotationMetadata`:注解数æ�®çš„读å�–类,基于å��射实现 #### 3.1 `SimpleAnnotationMetadataReadingVisitor` -spring ²¢Ã»ÓÐÌṩֱ½Ó²Ù×÷ `SimpleAnnotationMetadataReadingVisitor` µÄ»ú»á£¬¶øÊÇ·â×°µ½ `SimpleMetadataReaderFactory` ÁË£¬ÎÒÃÇÏÈÀ´¿´¿´Õâ¸öÀࣺ +spring 并没有æ��供直接æ“�作 `SimpleAnnotationMetadataReadingVisitor` 的机会,而是å°�装到 `SimpleMetadataReaderFactory` 了,我们先æ�¥çœ‹çœ‹è¿™ä¸ªç±»ï¼š ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-f2926fbc022517409bfb6f6641c87a193c2.png) -¿ÉÒÔ¿´µ½£¬`SimpleMetadataReaderFactory` µÄÀàÖ÷Òª·ÖΪÁ½²¿·Ö£º +å�¯ä»¥çœ‹åˆ°ï¼Œ`SimpleMetadataReaderFactory` 的类主è¦�分为两部分: -1. ¹¹Ôì·½·¨ -2. ×ÊÔ´µÄ»ñÈ¡ +1. 构造方法 +2. 资æº�的获å�– -ÕâÀïÎÒÃÇÖ±½Ó¿´»ñÈ¡µÄ»ñÈ¡£¬Ò²¾ÍÊÇ `getMetadataReader(...)` ·½·¨£º +这里我们直接看获å�–的获å�–,也就是 `getMetadataReader(...)` 方法: -`getMetadataReader(Resource resource)`: ¸ù¾Ý `Resource` ¶ÁÈ¡Êý¾Ý `getMetadataReader(String className)`: ¸ù¾ÝÀàÃû¶ÁÈ¡Êý¾Ý£¬´«ÈëµÄÊÇÈ«ÏÞ¶¨ÀàÃû£¨¼´ ¡°°üÃû¡£ÀàÃû¡±£©£¬´Ó´úÂëÀ´¿´£¬Õâ¸öÀàÃû×îÖÕÒ²»áת»¯Îª `Resource`£¬È»ºóµ÷Óà `getMetadataReader(Resource)` ½øÐжÁÈ¡ +`getMetadataReader(Resource resource)`: æ ¹æ�® `Resource` 读å�–æ•°æ�® `getMetadataReader(String className)`: æ ¹æ�®ç±»å��读å�–æ•°æ�®ï¼Œä¼ å…¥çš„æ˜¯å…¨é™�定类å��(å�³ “包å��。类å��â€�),从代ç �æ�¥çœ‹ï¼Œè¿™ä¸ªç±»å��最终也会转化为 `Resource`,然å�Žè°ƒç”¨ `getMetadataReader(Resource)` 进行读å�– -ÕâÁ½¸ö·½·¨µÄ·µ»ØÖµ¶¼ÊÇ `MetadataReader`£¬ÕâÊǸöɶĨ£¿ÎÒÃǼÌÐøÍùÏ¿´. +这两个方法的返回值都是 `MetadataReader`,这是个啥呢?我们继续往下看. ##### `MetadataReader` -`MetadataReader` µÄ²¿·Ö·½·¨ÈçÏ£º +`MetadataReader` 的部分方法如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-4a1184918664e8a4bd363d6399ed4092692.png) -¿ÉÒÔ¿´µ½£¬ËüÊǸö½Ó¿Ú£¨ÕâÀï·µ»ØµÄ¾ßÌåÀàÐ;ÍÊÇ `SimpleMetadataReader` ÁË£©£¬ÀïÃæ¾Í 3 ¸ö·½·¨£º +å�¯ä»¥çœ‹åˆ°ï¼Œå®ƒæ˜¯ä¸ªæŽ¥å�£ï¼ˆè¿™é‡Œè¿”回的具体类型就是 `SimpleMetadataReader` 了),里é�¢å°± 3 个方法: -* `getResource()`: »ñÈ¡×ÊÔ´ -* `getClassMetadata()`: »ñÈ¡ÀàµÄÔªÊý¾Ý -* `getAnnotationMetadata()`: »ñȡע½âµÄÔªÊý¾Ý +* `getResource()`: 获å�–资æº� +* `getClassMetadata()`: 获å�–类的元数æ�® +* `getAnnotationMetadata()`: 获å�–注解的元数æ�® -ÓÉÓÚÊÇ»ñȡע½âµÄÐÅÏ¢£¬ÕâÀïÎÒÃÇÖ»¹Ø×¢ `getAnnotationMetadata()` ·½·¨£º +由于是获å�–注解的信æ�¯ï¼Œè¿™é‡Œæˆ‘们å�ªå…³æ³¨ `getAnnotationMetadata()` 方法: ``` AnnotationMetadata getAnnotationMetadata(); ``` -Õâ¸ö·½·¨·µ»ØµÄÊÇ `AnnotationMetadata`£¬ÕâÓÖÊǸöɶ£¿ +这个方法返回的是 `AnnotationMetadata`,这å�ˆæ˜¯ä¸ªå•¥ï¼Ÿ ##### `AnnotationMetadata` -ÏÈÀ´¿´¿´ËüµÄ·½·¨£º +å…ˆæ�¥çœ‹çœ‹å®ƒçš„æ–¹æ³•: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-fc19d57bbba3d70da04fd32e6eef511ad4f.png) -ÕâЩ·½·¨·ÖΪÁ½Àࣺ +这些方法分为两类: -* `getXxx(...)`£º¸ù¾Ý×¢½â»ñÈ¡¶ÔÓ¦µÄÐÅÏ¢ -* `hasXxx(...)`£ºÅжÏÊÇ·ñ°üº¬Ä³×¢½â +* `getXxx(...)`:根æ�®æ³¨è§£èŽ·å�–对应的信æ�¯ +* `hasXxx(...)`:判断是å�¦åŒ…å�«æŸ�注解 -Èç¹û½øÒ»²½¿´Õ⼸¸ö·½·¨µÄĬÈÏʵÏÖ£¬·¢ÏÖ¶¼µ÷Óà `getAnnotations()` ·½·¨£º +如果进一步看这几个方法的默认实现,å�‘现都调用 `getAnnotations()` 方法: ``` public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata { default Set getAnnotationTypes() { - // µ÷ÓÃÁË getAnnotations() + // 调用了 getAnnotations() return getAnnotations().stream() .filter(MergedAnnotation::isDirectlyPresent) .map(annotation -> annotation.getType().getName()) @@ -234,7 +234,7 @@ public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata } default Set getMetaAnnotationTypes(String annotationName) { - // µ÷ÓÃÁË getAnnotations() + // 调用了 getAnnotations() MergedAnnotation annotation = getAnnotations().get(annotationName, MergedAnnotation::isDirectlyPresent); if (!annotation.isPresent()) { @@ -247,7 +247,7 @@ public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata } default boolean hasAnnotation(String annotationName) { - // µ÷ÓÃÁË getAnnotations() + // 调用了 getAnnotations() return getAnnotations().isDirectlyPresent(annotationName); } @@ -256,13 +256,13 @@ public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata ``` -ÔÙ½øÒ»²½²é¿´ `getAnnotations()` ·½·¨£¬½øÈëÁË `AnnotatedTypeMetadata`£º +å†�进一步查看 `getAnnotations()` 方法,进入了 `AnnotatedTypeMetadata`: ``` public interface AnnotatedTypeMetadata { /** - * »ñȡע½â + * 获å�–注解 */ MergedAnnotations getAnnotations(); @@ -272,101 +272,101 @@ public interface AnnotatedTypeMetadata { ``` -ÕâÒ»Ñù¿´£¬Ëƺõ×¢½âµÃµ½µÄÖÕ¼«Àà¾ÍÊÇ `MergedAnnotations` ÁË£¿ÎÒÃǼÌÐøÌ½Ë÷¡£ +这一样看,似乎注解得到的终æž�类就是 `MergedAnnotations` 了?我们继续探索。 ##### `MergedAnnotations` -`MergedAnnotations` µÄ²¿·Ö×¢ÊÍÈçÏ£º +`MergedAnnotations` 的部分注释如下: > Provides access to a collection of merged annotations, usually obtained from a source such as a {@link Class} or {@link Method}. > -> Ìṩ¶Ô×éºÏ×¢½âµÄ¼¯ºÏµÄ·ÃÎÊ£¬ÕâЩע½âͨ³£ÊÇ´Ó Class »ò Method Ö®ÀàµÄÀ´Ô´»ñµÃµÄ¡£ +> æ��供对组å�ˆæ³¨è§£çš„集å�ˆçš„访问,这些注解通常是从 Class 或 Method 之类的æ�¥æº�获得的。 -¿´À´£¬`MergedAnnotations` ²ÅÊÇ×îÖÕµÄ×éºÏ×¢½âµÄ¼¯ºÏÁË£¬ÎÒÃÇÀ´¿´¿´ËüµÄ¼¸¸ö·½·¨£º +看æ�¥ï¼Œ`MergedAnnotations` æ‰�是最终的组å�ˆæ³¨è§£çš„集å�ˆäº†ï¼Œæˆ‘们æ�¥çœ‹çœ‹å®ƒçš„几个方法: ``` -// ÅжÏ×¢½âÊÇ·ñ´æÔÚ£¬»á´ÓËùÓеÄ×¢½âÖÐÅÐ¶Ï +// 判断注解是å�¦å­˜åœ¨ï¼Œä¼šä»Žæ‰€æœ‰çš„æ³¨è§£ä¸­åˆ¤æ–­ boolean isPresent(Class annotationType); -// ÅжÏ×¢½âÊÇ·ñ´æÔÚ£¬»á´ÓËùÓеÄ×¢½âÖÐÅжϣ¬ÓëÉÏÃæµÄ·½·¨²»Í¬µÄÊÇ£¬ÕâÀï´«ÈëµÄÊÇ×Ö·û´® +// 判断注解是å�¦å­˜åœ¨ï¼Œä¼šä»Žæ‰€æœ‰çš„æ³¨è§£ä¸­åˆ¤æ–­ï¼Œä¸Žä¸Šé�¢çš„æ–¹æ³•ä¸�å�Œçš„æ˜¯ï¼Œè¿™é‡Œä¼ å…¥çš„æ˜¯å­—符串 boolean isPresent(String annotationType); -// ÅжÏÖ±½Ó×¢½âÊÇ·ñ´æÔÚ£¬Ò²¾ÍÊÇÖ»Åжϵ±Ç°ÀàÉÏÓÐûÓиÃ×¢½â£¬²»ÅжÏ×¢½âµÄ×¢½â +// 判断直接注解是å�¦å­˜åœ¨ï¼Œä¹Ÿå°±æ˜¯å�ªåˆ¤æ–­å½“å‰�类上有没有该注解,ä¸�判断注解的注解 boolean isDirectlyPresent(Class annotationType); -// ¹¦ÄÜͬÉÏ£¬ÕâÀï´«ÈëµÄÀàÐÍÊÇ×Ö·û´®£¬¸ñʽΪ"°üÃû.ÀàÃû" +// 功能å�Œä¸Šï¼Œè¿™é‡Œä¼ å…¥çš„类型是字符串,格å¼�为"包å��.ç±»å��" boolean isDirectlyPresent(String annotationType); -// »ñȡע½â +// 获å�–注解 MergedAnnotation get(Class annotationType); -// »ñȡע½â£¬ÕâÀï´«ÈëµÄÀàÐÍÊÇ×Ö·û´®£¬¸ñʽΪ"°üÃû.ÀàÃû" +// 获å�–注解,这里传入的类型是字符串,格å¼�为"包å��.ç±»å��" MergedAnnotation get(String annotationType); ``` -´Ó·½·¨ÉÏ´óÖ¿ÉÒÔ¿´³ö£¬`MergedAnnotations` ÊÇ×éºÏ×¢½âµÄ¼¯ºÏ£¬ÌṩµÄ×¢½â¿ÉÒÔÅжÏijע½âÊÇ·ñ´æÔÚ£¬Ò²¿ÉÒÔ»ñÈ¡ÆäÖеÄij¸ö×¢½â¡£ +从方法上大致å�¯ä»¥çœ‹å‡ºï¼Œ`MergedAnnotations` 是组å�ˆæ³¨è§£çš„集å�ˆï¼Œæ��供的注解å�¯ä»¥åˆ¤æ–­æŸ�注解是å�¦å­˜åœ¨ï¼Œä¹Ÿå�¯ä»¥èŽ·å�–其中的æŸ�个注解。 ##### `MergedAnnotation` -`MergedAnnotations` ÊÇ×¢½âµÄ¼¯ºÏ£¬ÄÇÕâ¸ö¼¯ºÏÖзŵÄÊÇɶĨ£¿´ÓËüµÄ `get(...)` ·½·¨À´¿´£¬Ëü´æ·ÅµÄÊÇ `MergedAnnotation`£¬ÎÒÃÇÔÙÀ´¿´¿´ `MergedAnnotation` Ö§³ÖµÄ·½·¨£º +`MergedAnnotations` 是注解的集å�ˆï¼Œé‚£è¿™ä¸ªé›†å�ˆä¸­æ”¾çš„æ˜¯å•¥å‘¢ï¼Ÿä»Žå®ƒçš„ `get(...)` 方法æ�¥çœ‹ï¼Œå®ƒå­˜æ”¾çš„æ˜¯ `MergedAnnotation`,我们å†�æ�¥çœ‹çœ‹ `MergedAnnotation` 支æŒ�的方法: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a3a749f4546d63b49bfd25d2fc2c73dcb6f.png) -´ÓÒÔÉϵķ½·¨¿ÉÒÔ¿´µ½£¬`MergedAnnotation` ¾ÍÊÇ×¢½âµÄÊý¾Ý³éÏó£¬ËüÌṩÁ˷ḻµÄ api ÓÃÀ´»ñȡע½âµÄÊý¾Ý¡£ +从以上的方法å�¯ä»¥çœ‹åˆ°ï¼Œ`MergedAnnotation` 就是注解的数æ�®æŠ½è±¡ï¼Œå®ƒæ��供了丰富的 api 用æ�¥èŽ·å�–注解的数æ�®ã€‚ -##### ʹÓÃʾÀý +##### 使用示例 -ÏÂÃæÀ´¿´¸öʾÀý£º +下é�¢æ�¥çœ‹ä¸ªç¤ºä¾‹ï¼š ``` -// µÃµ½ SimpleMetadataReaderFactory ʵÀý£¬×îÖÕµ÷ÓõÄÊÇ SimpleAnnotationMetadataReadingVisitor À´¶ÁÈ¡ +// 得到 SimpleMetadataReaderFactory 实例,最终调用的是 SimpleAnnotationMetadataReadingVisitor æ�¥è¯»å�– SimpleMetadataReaderFactory readerFactory = new SimpleMetadataReaderFactory(); MetadataReader metadataReader = readerFactory.getMetadataReader(BeanObj3.class.getName()); AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata(); -// AnnotationMetadata ÌṩÁËÐí¶àµÄ²Ù×÷£¬ÖØµã¹Ø×¢×¢½âÏà¹ØµÄ +// AnnotationMetadata æ��供了许多的æ“�作,é‡�点关注注解相关的 Set annotationTypes = annotationMetadata.getAnnotationTypes(); System.out.println("-------------"); annotationTypes.forEach(type -> System.out.println(type)); System.out.println("-------------"); -// ÕâÀïÊÇÖ±½Ó»ñÈ¡£¬BeanObj3 ÉÏÖ±½Ó±ê¼Ç @MyComponentµÄ£¬·µ»ØµÄÊÇtrue +// 这里是直接获å�–,BeanObj3 上直接标记 @MyComponent的,返回的是true boolean exist1 = annotationMetadata.hasAnnotation(MyComponent.class.getName()); System.out.println("hasAnnotation @MyComponent:" + exist1); -// ÕâÀïÊÇÖ±½Ó»ñÈ¡£¬BeanObj3 ÉÏÊÇûÓÐÖ±½Ó±ê¼Ç @ComponentµÄ£¬·µ»ØµÄÊÇfalse +// 这里是直接获å�–,BeanObj3 上是没有直接标记 @Component的,返回的是false boolean exist2 = annotationMetadata.hasAnnotation(Component.class.getName()); System.out.println("hasAnnotation @Component:" + exist2); -// »ñÈ¡ MergedAnnotations +// 获å�– MergedAnnotations MergedAnnotations annotations = annotationMetadata.getAnnotations(); System.out.println("-------------"); annotations.forEach(annotationMergedAnnotation -> System.out.println(annotationMergedAnnotation)); System.out.println("-------------"); -// ÕâÀïÊÇÖ±½Ó»ñÈ¡£¬BeanObj3 ÉÏÊÇûÓÐÖ±½Ó±ê¼Ç @ComponentµÄ£¬·µ»ØµÄÊÇfalse +// 这里是直接获å�–,BeanObj3 上是没有直接标记 @Component的,返回的是false boolean directlyPresent = annotations.isDirectlyPresent(Component.class); System.out.println("directlyPresent Component:" + directlyPresent); -// ÅжÏÓÐûÓÐÕâ¸ö×¢½â£¬BeanObj3 ÉϵÄ@MyComponentÖУ¬±ê¼ÇÁË @Component µÄ£¬·µ»ØµÄÊÇtrue +// 判断有没有这个注解,BeanObj3 上的@MyComponent中,标记了 @Component 的,返回的是true boolean present = annotations.isPresent(Component.class); System.out.println("present Component:" + present); -// »ñÈ¡ @Component ×¢½â +// 获å�– @Component 注解 MergedAnnotation mergedAnnotation = annotations.get(Component.class); -// ÓÉÓÚ @MyComponent µÄ value() ¼ÓÁË @AliasFor(annotation = Component.class) -// Òò´ËÕâÀïµÃµ½µÄ value ÊÇ beanObj3 £¨BeanObj3ÀïÕâôָ¶¨µÄ£º@MyComponent("beanObj3")£© +// 由于 @MyComponent çš„ value() 加了 @AliasFor(annotation = Component.class) +// 因此这里得到的 value 是 beanObj3 (BeanObj3里这么指定的:@MyComponent("beanObj3")) String value = mergedAnnotation.getString("value"); System.out.println("Component value:" + value); -// ½« @Component µÄ×¢½âµÄÊý¾Ýת»»Îª AnnotationAttributes +// å°† @Component 的注解的数æ�®è½¬æ�¢ä¸º AnnotationAttributes AnnotationAttributes annotationAttributes = mergedAnnotation.asAnnotationAttributes(); System.out.println(annotationAttributes); ``` -ÔËÐУ¬½á¹ûÈçÏ£º +è¿�行,结果如下: ``` ------------- @@ -386,9 +386,9 @@ Component value:beanObj3 ``` -##### ²¹³ä£º`AnnotationAttributes` +##### 补充:`AnnotationAttributes` -²¹³ä˵Ã÷Ï `AnnotationAttributes`£º +补充说明下 `AnnotationAttributes`: ``` public class AnnotationAttributes extends LinkedHashMap { @@ -397,15 +397,15 @@ public class AnnotationAttributes extends LinkedHashMap { ``` -ËüʵÏÖÁË `LinkedHashMap`£¬ÌṩµÄ²¿·Ö·½·¨ÈçÏ£º +它实现了 `LinkedHashMap`,æ��供的部分方法如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-a8c8dc975790719c37a8e41a4b0067c517c.png) -´ÓÕâÀï²»ÄÑ¿´³ö£¬`AnnotationAttributes` ¾ÍÊǰüº¬×¢½âËùÓÐÊôÐÔÖµµÄ map£¬key ΪÊôÐÔÃû£¬value ΪÊôÐÔÖµ¡£ +从这里ä¸�难看出,`AnnotationAttributes` 就是包å�«æ³¨è§£æ‰€æœ‰å±žæ€§å€¼çš„ map,key 为属性å��,value 为属性值。 #### 3.2 `StandardAnnotationMetadata` -ÎÒÃǽÓ×ÅÀ´¿´¿´ `StandardAnnotationMetadata`: +我们接ç�€æ�¥çœ‹çœ‹ `StandardAnnotationMetadata`: ``` public class StandardAnnotationMetadata extends StandardClassMetadata @@ -428,58 +428,58 @@ public class StandardAnnotationMetadata extends StandardClassMetadata ``` -`StandardAnnotationMetadata` ʵÏÖÁË `AnnotationMetadata` ½Ó¿Ú£¬¶ÔÓÚ×¢½âµÄ²Ù×÷ÓëÉÏÃæ½éÉÜµÄ `AnnotationMetadata` ²¢ÎÞÌ«´óÇø±ð£¬ÕâÀï¾Í²»×¸ÊöÁË¡£ +`StandardAnnotationMetadata` 实现了 `AnnotationMetadata` 接å�£ï¼Œå¯¹äºŽæ³¨è§£çš„æ“�作与上é�¢ä»‹ç»�çš„ `AnnotationMetadata` 并无太大区别,这里就ä¸�赘述了。 -´Ó `StandardAnnotationMetadata` µÄ¹¹Ôì·½·¨À´¿´£¬ËüÒѾ­·ÏÆúÁË£¬ÈÃÎÒÃÇʹÓà `AnnotationMetadata#introspect(Class)` À´»ñÈ¡ `StandardAnnotationMetadata` µÄʵÀý£¬ÓÚÊÇ£¬ÎÒÃÇ¿ÉÒÔÏñÕâÑùÀ´²Ù×÷£º +从 `StandardAnnotationMetadata` 的构造方法æ�¥çœ‹ï¼Œå®ƒå·²ç»�废弃了,让我们使用 `AnnotationMetadata#introspect(Class)` æ�¥èŽ·å�– `StandardAnnotationMetadata` 的实例,于是,我们å�¯ä»¥åƒ�这样æ�¥æ“�作: ``` -// »ñÈ¡µ½µÄ annotationMetadata ʵ¼ÊÉÏÊÇ StandardAnnotationMetadata +// 获å�–到的 annotationMetadata 实际上是 StandardAnnotationMetadata AnnotationMetadata annotationMetadata = AnnotationMetadata.introspect(BeanObj3.class); -//----------- ÒÔÏÂÄÚÈÝÓëSimpleAnnotationMetadataReadingVisitor һģһÑù +//----------- 以下内容与SimpleAnnotationMetadataReadingVisitor 一模一样 -// AnnotationMetadata ÌṩÁËÐí¶àµÄ²Ù×÷£¬ÖØµã¹Ø×¢×¢½âÏà¹ØµÄ +// AnnotationMetadata æ��供了许多的æ“�作,é‡�点关注注解相关的 Set annotationTypes = annotationMetadata.getAnnotationTypes(); System.out.println("-------------"); annotationTypes.forEach(type -> System.out.println(type)); System.out.println("-------------"); -// ÕâÀïÊÇÖ±½Ó»ñÈ¡£¬BeanObj3 ÉÏÖ±½Ó±ê¼Ç @MyComponentµÄ£¬·µ»ØµÄÊÇtrue +// 这里是直接获å�–,BeanObj3 上直接标记 @MyComponent的,返回的是true boolean exist1 = annotationMetadata.hasAnnotation(MyComponent.class.getName()); System.out.println("hasAnnotation @MyComponent:" + exist1); -// ÕâÀïÊÇÖ±½Ó»ñÈ¡£¬BeanObj3 ÉÏÊÇûÓÐÖ±½Ó±ê¼Ç @ComponentµÄ£¬·µ»ØµÄÊÇfalse +// 这里是直接获å�–,BeanObj3 上是没有直接标记 @Component的,返回的是false boolean exist2 = annotationMetadata.hasAnnotation(Component.class.getName()); System.out.println("hasAnnotation @Component:" + exist2); -// »ñÈ¡ MergedAnnotations +// 获å�– MergedAnnotations MergedAnnotations annotations = annotationMetadata.getAnnotations(); System.out.println("-------------"); annotations.forEach(annotationMergedAnnotation -> System.out.println(annotationMergedAnnotation)); System.out.println("-------------"); -// ÕâÀïÊÇÖ±½Ó»ñÈ¡£¬BeanObj3 ÉÏÊÇûÓÐÖ±½Ó±ê¼Ç @ComponentµÄ£¬·µ»ØµÄÊÇfalse +// 这里是直接获å�–,BeanObj3 上是没有直接标记 @Component的,返回的是false boolean directlyPresent = annotations.isDirectlyPresent(Component.class); System.out.println("directlyPresent Component:" + directlyPresent); -// ÅжÏÓÐûÓÐÕâ¸ö×¢½â£¬BeanObj3 ÉϵÄ@MyComponentÖУ¬±ê¼ÇÁË @Component µÄ£¬·µ»ØµÄÊÇtrue +// 判断有没有这个注解,BeanObj3 上的@MyComponent中,标记了 @Component 的,返回的是true boolean present = annotations.isPresent(Component.class); System.out.println("present Component:" + present); -// »ñÈ¡ @Component ×¢½â +// 获å�– @Component 注解 MergedAnnotation mergedAnnotation = annotations.get(Component.class); -// ÓÉÓÚ @MyComponent µÄ value() ¼ÓÁË @AliasFor(annotation = Component.class) -// Òò´ËÕâÀïµÃµ½µÄ value ÊÇ beanObj3 £¨BeanObj3ÀïÕâôָ¶¨µÄ£º@MyComponent("beanObj3")£© +// 由于 @MyComponent çš„ value() 加了 @AliasFor(annotation = Component.class) +// 因此这里得到的 value 是 beanObj3 (BeanObj3里这么指定的:@MyComponent("beanObj3")) String value = mergedAnnotation.getString("value"); System.out.println("Component value:" + value); -// ½« @Component µÄ×¢½âµÄÊý¾Ýת»»Îª AnnotationAttributes +// å°† @Component 的注解的数æ�®è½¬æ�¢ä¸º AnnotationAttributes AnnotationAttributes annotationAttributes = mergedAnnotation.asAnnotationAttributes(); System.out.println(annotationAttributes); ``` -ÔËÐнá¹ûÈçÏ£º +è¿�行结果如下: ``` ------------- @@ -499,44 +499,44 @@ Component value:beanObj3 ``` -´ÓÉÏÃæµÄʾÀýÀ´¿´£¬ÎÒÃÇÀú¾­Ç§ÐÁÍò¿à£¬×îÖյõ½ÁË `MergedAnnotations`£¬È»ºóͨ¹ýËüÀ´ÅжÏ×¢½âÊÇ·ñ´æÔÚ¡¢»ñȡע½âµÄÖµ¡£ +从上é�¢çš„示例æ�¥çœ‹ï¼Œæˆ‘们历ç»�å�ƒè¾›ä¸‡è‹¦ï¼Œæœ€ç»ˆå¾—到了 `MergedAnnotations`,然å�Žé€šè¿‡å®ƒæ�¥åˆ¤æ–­æ³¨è§£æ˜¯å�¦å­˜åœ¨ã€�获å�–注解的值。 -#### 3.3 Á½ÕßµÄʹÓó¡¾° +#### 3.3 两者的使用场景 -`SimpleAnnotationMetadataReadingVisitor` Óë `StandardAnnotationMetadata` µÄÖ÷񻂿±ðÔÚÓÚ£¬`SimpleAnnotationMetadataReadingVisitor` ÊÇ»ùÓÚ asm µÄʵÏÖ£¬`StandardAnnotationMetadata` ÊÇ»ùÓÚ·´ÉäµÄʵÏÖ£¬ÄÇÎÒÃÇÔÚʹÓÃʱ£¬Ó¦¸ÃÒªÔõÃ´Ñ¡ÄØ£¿ +`SimpleAnnotationMetadataReadingVisitor` 与 `StandardAnnotationMetadata` 的主è¦�区别在于,`SimpleAnnotationMetadataReadingVisitor` 是基于 asm 的实现,`StandardAnnotationMetadata` 是基于å��射的实现,那我们在使用时,应该è¦�怎么选呢? -ÓÉÓÚ»ùÓÚ·´ÉäÊÇÒªÏȼÓÀà¼ÓÔØµ½ jvm Öеģ¬Òò´ËÎÒµÄÅжÏÊÇ£¬**Èç¹ûµ±Ç°ÀàûÓмÓÔØµ½ jvm ÖУ¬¾ÍʹÓà `SimpleAnnotationMetadataReadingVisitor`£¬Èç¹ûÀàÒѾ­¼ÓÔØµ½ jvm ÖÐÁË£¬Á½Õß½Ô¿ÉʹÓÃ**¡£ +由于基于å��射是è¦�先加类加载到 jvm 中的,因此我的判断是,**如果当å‰�类没有加载到 jvm 中,就使用 `SimpleAnnotationMetadataReadingVisitor`,如果类已ç»�加载到 jvm 中了,两者皆å�¯ä½¿ç”¨**。 -ÊÂʵÉÏ£¬ÔÚ spring °üɨÃè½×¶Î£¬¶ÁÈ¡ÀàÉϵÄ×¢½âʱ£¬Ê¹ÓõͼÊÇ `SimpleAnnotationMetadataReadingVisitor`£¬ÒòΪ´ËʱÀಢûÓмÓÔØµ½ jvm£¬Èç¹ûʹÓà `StandardAnnotationMetadata` ¶ÁÈ¡£¬¾Í»áµ¼ÖÂÀàÌáǰ¼ÓÔØ¡£ÀàÌáǰ¼ÓÔØÓÐʲôÎÊÌâÄØ£¿java ÀàÊǰ´Ðè¼ÓÔØµÄ£¬ÓеÄÀà¿ÉÄÜÔÚÕû¸ö jvm ÉúÃüÖÜÆÚÄÚ¶¼Ã»Óõ½£¬Èç¹ûÈ«¶¼¼ÓÔØÁË£¬¾Í°×°×ÀË·ÑÄÚ´æÁË¡£ +事实上,在 spring 包扫æ��阶段,读å�–类上的注解时,使用的都是 `SimpleAnnotationMetadataReadingVisitor`,因为此时类并没有加载到 jvm,如果使用 `StandardAnnotationMetadata` 读å�–,就会导致类æ��å‰�加载。类æ��å‰�加载有什么问题呢?java 类是按需加载的,有的类å�¯èƒ½åœ¨æ•´ä¸ª jvm 生命周期内都没用到,如果全都加载了,就白白浪费内存了。 -### 4\. spring ÌṩµÄ×¢½â¹¤¾ßÀà +### 4\. spring æ��供的注解工具类 -ÔÚÇ°ÃæµÄʾÀýÖУ¬ÎÒÃÇÊÇÕâÑù¶Áȡע½âµÄ£º +在å‰�é�¢çš„示例中,我们是这样读å�–注解的: ``` -// ¶ÁÈ¡ annotationMetadata£¬Ò²¿ÉÒÔʹÓà SimpleMetadataReaderFactory ¶ÁÈ¡ +// 读å�– annotationMetadata,也å�¯ä»¥ä½¿ç”¨ SimpleMetadataReaderFactory 读å�– AnnotationMetadata annotationMetadata = AnnotationMetadata.introspect(BeanObj3.class); MergedAnnotations annotations = annotationMetadata.getAnnotations(); -// ÅжÏ×¢½âÊÇ·ñ´æÔÚ +// 判断注解是å�¦å­˜åœ¨ boolean present = annotations.isPresent(Component.class); -// »ñȡע½âµÄÊôÐÔ +// 获å�–注解的属性 MergedAnnotation mergedAnnotation = annotations.get(Component.class); AnnotationAttributes annotationAttributes = mergedAnnotation.asAnnotationAttributes(); ``` -Ïà¶ÔÀ´Ëµ£¬»ñȡע½âµÄÊôÐÔ²½Öè±È½Ï¶à£¬´ÏÃ÷ÈçÄ㣬¾ÍÏëµ½¿ÉÒÔ½«ÕâЩ²½Öè·â×°µ½Ò»¸ö·½·¨ÖнøÐд¦Àí£¬spring Ò²ÊÇÕâô×öµÄ£¬Õâ¾ÍµÃ½éÉÜ spring ÖÐÓë×¢½âÏà¹ØµÄÁ½¸öÀࣺ`AnnotationUtils` Óë `AnnotatedElementUtils`¡£`AnnotationUtils` ÊÇÖ±½Ó»ñȡע½âµÄÖµ£¬²»»á´¦ÀíÊôÐÔ¸²¸Ç£¬¶ø `AnnotatedElementUtils` »á´¦ÀíÊôÐÔ¸²¸Ç¡£ +相对æ�¥è¯´ï¼ŒèŽ·å�–注解的属性步骤比较多,è�ªæ˜Žå¦‚你,就想到å�¯ä»¥å°†è¿™äº›æ­¥éª¤å°�装到一个方法中进行处ç�†ï¼Œspring 也是这么å�šçš„,这就得介ç»� spring 中与注解相关的两个类:`AnnotationUtils` 与 `AnnotatedElementUtils`。`AnnotationUtils` 是直接获å�–注解的值,ä¸�会处ç�†å±žæ€§è¦†ç›–,而 `AnnotatedElementUtils` 会处ç�†å±žæ€§è¦†ç›–。 -ʲôÊÇÊôÐÔ¸²¸ÇÄØ£¿ +什么是属性覆盖呢? -¾ÙÀýÀ´Ëµ£¬`@MyComponent` ³¤ÕâÑù£º +举例æ�¥è¯´ï¼Œ`@MyComponent` 长这样: ``` @Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented -// ×¢ÒâComponentÖ¸¶¨µÄÖµ£º123 +// 注æ„�Component指定的值:123 @Component("123") public @interface MyComponent { @@ -547,7 +547,7 @@ public @interface MyComponent { ``` -ÔÚ `@MyComponent` ×¢½âÖУ¬ÎÒÃÇÖ¸¶¨ÁË `@Component` µÄ `value` ֵΪ ¡°123¡±£¬È»ºóÓÖÕâôָ¶¨ `@MyComponent` µÄ `value` Öµ£º +在 `@MyComponent` 注解中,我们指定了 `@Component` çš„ `value` 值为 “123â€�,然å�Žå�ˆè¿™ä¹ˆæŒ‡å®š `@MyComponent` çš„ `value` 值: ``` @MyComponent("beanObj3") @@ -558,13 +558,13 @@ public class BeanObj3 { ``` -×îÖÕ spring ³õʼ»¯µÃµ½µÄ `BeanObj3` µÄÃû³ÆÊÇ `123` »¹ÊÇ `beanObj3` ÄØ£¿´ÓÎÒÃÇÉèÖà `@MyComponent` µÄ `value` Ϊ `beanObj3` À´Ëµ£¬µ±È»ÊÇÏ£Íû bean µÄÃû³ÆÎª `beanObj3`£¬¶ø×îÖÕ spring Ò²ÊÇÕâô×öµÄ£¬Õâ¾ÍÊÇÊôÐÔ¸²¸ÇÁË£º`@MyComponent` µÄ `value` ¸²¸ÇÁË `@Component` µÄ `value` Öµ¡£ +最终 spring åˆ�始化得到的 `BeanObj3` çš„å��称是 `123` 还是 `beanObj3` 呢?从我们设置 `@MyComponent` çš„ `value` 为 `beanObj3` æ�¥è¯´ï¼Œå½“然是希望 bean çš„å��称为 `beanObj3`,而最终 spring 也是这么å�šçš„,这就是属性覆盖了:`@MyComponent` çš„ `value` 覆盖了 `@Component` çš„ `value` 值。 -`AnnotationUtils`/`AnnotatedElementUtils` ÓëÉÏÃæ½éÉÜµÄ `SimpleAnnotationMetadataReadingVisitor`/`StandardAnnotationMetadata` ÊǺιØÏµÄØ£¿ +`AnnotationUtils`/`AnnotatedElementUtils` 与上é�¢ä»‹ç»�çš„ `SimpleAnnotationMetadataReadingVisitor`/`StandardAnnotationMetadata` 是何关系呢? -ÔÚÎÒÃÇʹÓà `SimpleAnnotationMetadataReadingVisitor`/`StandardAnnotationMetadata` ʱ£¬ÎÒÃÇÐèÒªµÃµ½ `MergedAnnotations` ÔÙ½øÐÐһϵÁвÙ×÷£¨ÅжÏ×¢½âÊÇ·ñ´æÔÚ¡¢»ñȡע½âµÄÊôÐÔÖµµÈ£©£¬Èç¹û½øÈë `AnnotationUtils`/`AnnotatedElementUtils` µÄÔ´Â룬¾Í»á·¢ÏÖËüÃǵÄÏà¹Ø·½·¨Ò²ÊDzÙ×÷ `MergedAnnotations` À࣬±ÈÈç»ñȡע½â£º +在我们使用 `SimpleAnnotationMetadataReadingVisitor`/`StandardAnnotationMetadata` 时,我们需è¦�得到 `MergedAnnotations` å†�进行一系列æ“�作(判断注解是å�¦å­˜åœ¨ã€�获å�–注解的属性值等),如果进入 `AnnotationUtils`/`AnnotatedElementUtils` çš„æº�ç �,就会å�‘现它们的相关方法也是æ“�作 `MergedAnnotations` 类,比如获å�–注解: -`AnnotationUtils#getAnnotation(AnnotatedElement, Class)` ·½·¨£º +`AnnotationUtils#getAnnotation(AnnotatedElement, Class)` 方法: ``` public static A getAnnotation(AnnotatedElement annotatedElement, @@ -573,7 +573,7 @@ public static A getAnnotation(AnnotatedElement annotatedE AnnotationsScanner.hasPlainJavaAnnotationsOnly(annotatedElement)) { return annotatedElement.getAnnotation(annotationType); } - // ͨ¹ý²Ù×÷ MergedAnnotations ½øÐлñÈ¡ + // 通过æ“�作 MergedAnnotations 进行获å�– return MergedAnnotations.from(annotatedElement, SearchStrategy.INHERITED_ANNOTATIONS, RepeatableContainers.none()) .get(annotationType).withNonMergedAttributes() @@ -582,7 +582,7 @@ public static A getAnnotation(AnnotatedElement annotatedE ``` -`AnnotatedElementUtils#getAllMergedAnnotations(AnnotatedElement, Class)` ·½·¨£º +`AnnotatedElementUtils#getAllMergedAnnotations(AnnotatedElement, Class)` 方法: ``` public static Set getAllMergedAnnotations( @@ -591,7 +591,7 @@ public static Set getAllMergedAnnotations( .collect(MergedAnnotationCollectors.toAnnotationSet()); } -// AnnotatedElementUtils#getAnnotations ·½·¨£¬Ò²ÊDzÙ×÷ MergedAnnotations µÄ·½·¨ +// AnnotatedElementUtils#getAnnotations 方法,也是æ“�作 MergedAnnotations 的方法 private static MergedAnnotations getAnnotations(AnnotatedElement element) { return MergedAnnotations.from(element, SearchStrategy.INHERITED_ANNOTATIONS, RepeatableContainers.none()); @@ -599,41 +599,41 @@ private static MergedAnnotations getAnnotations(AnnotatedElement element) { ``` -Òò´Ë£¬`AnnotationUtils`/`AnnotatedElementUtils` Óë `SimpleAnnotationMetadataReadingVisitor`/`StandardAnnotationMetadata` µ×²ã¶¼ÊDzÙ×÷ `MergedAnnotations` ÀàµÄ¡£ +因此,`AnnotationUtils`/`AnnotatedElementUtils` 与 `SimpleAnnotationMetadataReadingVisitor`/`StandardAnnotationMetadata` 底层都是æ“�作 `MergedAnnotations` 类的。 #### 4.1 `AnnotationUtils` -`AnnotationUtils` Ö§³ÖµÄ²¿·Ö·½·¨ÈçÏ£º +`AnnotationUtils` 支æŒ�的部分方法如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-51b0f496180a16d947b8f83285370cabd8f.png) -ÎÒÃÇÀ´Êµ¼ÊʹÓÃÏÂÕâЩ·½·¨£º +我们æ�¥å®žé™…使用下这些方法: ``` -// ÔÚ BeanObj3 »ñÈ¡ @Component +// 在 BeanObj3 获å�– @Component Annotation annotation = AnnotationUtils.getAnnotation(BeanObj3.class, Component.class); if(null == annotation) { - System.out.println("×¢½â²»´æÔÚ£¡"); + System.out.println("注解ä¸�存在ï¼�"); return; } System.out.println("annotation: " + annotation); -// »ñÈ¡ AnnotationAttributes +// 获å�– AnnotationAttributes AnnotationAttributes annotationAttributes = AnnotationUtils.getAnnotationAttributes(BeanObj3.class, annotation); System.out.println("AnnotationAttributes: " + annotationAttributes); -// »ñÈ¡ annotationAttributeMap +// 获å�– annotationAttributeMap Map annotationAttributeMap = AnnotationUtils.getAnnotationAttributes(annotation); System.out.println("annotationAttributeMap: " + annotationAttributeMap); -// »ñÈ¡valueµÄÖµ +// 获å�–value的值 Object value = AnnotationUtils.getValue(annotation, "value"); System.out.println("value: " + value); ``` -½á¹ûÈçÏ£º +结果如下: ``` annotation: @org.springframework.stereotype.Component(value=123) @@ -643,22 +643,22 @@ value: 123 ``` -´Ó½á¹ûÀ´¿´£¬Ö±½Óͨ¹ý `AnnotationUtils.getAnnotation(...)` Ò²ÊÇÄÜ»ñÈ¡µ½ `@Component` ×¢½âµÄ£¬¾¡¹Ü `BeanObj3` ²¢Ã»ÓÐÖ±½Ó±ê¼Ç `@Component`. ÐèҪעÒâµÄÊÇ£¬ÕâÑù»ñÈ¡µ½µÄ `@Component` µÄ `value` ÖµÊÇ "123"£¬²¢²»ÊÇ `@MyComponent` ÉèÖÃµÄ `beanObj3`£¬ÕâÒ²Ö¤Ã÷ÁË `AnnotationUtils` »ñÈ¡ÊôÐÔֵʱ²¢²»½øÐÐÊôÐÔ¸²¸Ç²Ù×÷¡£ +从结果æ�¥çœ‹ï¼Œç›´æŽ¥é€šè¿‡ `AnnotationUtils.getAnnotation(...)` 也是能获å�–到 `@Component` 注解的,尽管 `BeanObj3` 并没有直接标记 `@Component`. 需è¦�注æ„�的是,这样获å�–到的 `@Component` çš„ `value` 值是 "123",并ä¸�是 `@MyComponent` 设置的 `beanObj3`,这也è¯�明了 `AnnotationUtils` 获å�–属性值时并ä¸�进行属性覆盖æ“�作。 #### 4.2 `AnnotatedElementUtils` -`AnnotatedElementUtils` Ö§³ÖµÄ²¿·Ö·½·¨ÈçÏ£º +`AnnotatedElementUtils` 支æŒ�的部分方法如下: ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/up-9815fe697f5ccf14d3aa215952bfcbcc3ab.png) -¸ø¸öʾÀý°É£º +给个示例å�§ï¼š ``` -// 1\. ÅжÏÊÇ·ñÓÐ Component ×¢½â +// 1\. 判断是å�¦æœ‰ Component 注解 boolean result = AnnotatedElementUtils.hasAnnotation(BeanObj3.class, Component.class); System.out.println("hasAnnotation: " + result); -// 2\. »ñÈ¡ attributeMap£¬¿ÉÒÔ¿´µ½µÄÊÇ£¬»ñÈ¡ @Component Óë @MyComponent µÃµ½µÄ½á¹û²»Ò»Ñù +// 2\. 获å�– attributeMap,å�¯ä»¥çœ‹åˆ°çš„æ˜¯ï¼ŒèŽ·å�– @Component 与 @MyComponent 得到的结果ä¸�一样 // Component attributeMap: {value=[123]} MultiValueMap attributeMap1 = AnnotatedElementUtils .getAllAnnotationAttributes(BeanObj3.class, Component.class.getName()); @@ -668,24 +668,24 @@ MultiValueMap attributeMap2 = AnnotatedElementUtils .getAllAnnotationAttributes(BeanObj3.class, MyComponent.class.getName()); System.out.println("MyComponent attributeMap: " + attributeMap2); -// 3\. »ñÈ¡ËùÓÐµÄ @Component ×¢½â£¬value=beanObj3 +// 3\. 获å�–所有的 @Component 注解,value=beanObj3 Set mergedAnnotations = AnnotatedElementUtils .getAllMergedAnnotations(BeanObj3.class, Component.class); System.out.println("mergedAnnotations: " + mergedAnnotations); -// 4\. »ñÈ¡ÊôÐÔÖµ£¬{value=beanObj3} +// 4\. 获å�–属性值,{value=beanObj3} AnnotationAttributes attributes = AnnotatedElementUtils .getMergedAnnotationAttributes(BeanObj3.class, Component.class); System.out.println("attributes: " + attributes); -// 5\. »ñÈ¡ MyComponent ÉϵÄ×¢½â +// 5\. 获å�– MyComponent 上的注解 Set types = AnnotatedElementUtils .getMetaAnnotationTypes(BeanObj3.class, MyComponent.class); System.out.println("types: " + types); ``` -½á¹ûÈçÏ£º +结果如下: ``` hasAnnotation: true @@ -697,14 +697,14 @@ types: [org.springframework.stereotype.Component, org.springframework.stereotype ``` -´Ó´úÂëÀ´¿´£¬Ôڵõ½µÄ `Set` Óë `AnnotationAttributes` ÖУ¬ÊôÐÔÖµÒѾ­ºÏ²¢ÁË. +从代ç �æ�¥çœ‹ï¼Œåœ¨å¾—到的 `Set` 与 `AnnotationAttributes` 中,属性值已ç»�å�ˆå¹¶äº†. -ÔÚÑ¡ÔñʹÓà `AnnotationUtils` »¹ÊÇ `AnnotatedElementUtils` ʱ£¬¿ÉÒÔ¸ù¾ÝÒª²»ÒªÊôÐÔ¸²¸ÇÀ´Ñ¡Ôñ£¬Èç¹ûÐèÒª´¦ÀíÊôÐÔ¸²¸Ç£¬¾ÍʹÓà `AnnotatedElementUtils`£¬Èç¹û²»ÐèÒª£¬¾ÍʹÓà `AnnotationUtils` °É£¡ +在选择使用 `AnnotationUtils` 还是 `AnnotatedElementUtils` 时,å�¯ä»¥æ ¹æ�®è¦�ä¸�è¦�属性覆盖æ�¥é€‰æ‹©ï¼Œå¦‚果需è¦�处ç�†å±žæ€§è¦†ç›–,就使用 `AnnotatedElementUtils`,如果ä¸�需è¦�,就使用 `AnnotationUtils` å�§ï¼� -### 5\. ×ܽá +### 5\. 总结 -±¾ÎĽéÉÜÁË spring ´¦Àí×¢½âµÄ²Ù×÷£¬Ö÷Òª½éÉÜÁË `SimpleAnnotationMetadataReadingVisitor` Óë `StandardAnnotationMetadata` µÄÇø±ðÓëʹÓ÷½·¨¡£ÓÉÓÚÕâÁ½¸öÀàʹÓÃÆðÀ´²½Öè±È½Ï¶à£¬ÎÄÖÐÓÖ½éÉÜÁË spring ÌṩµÄÁ½¸ö¹¤¾ßÀࣺ`AnnotationUtils` Óë `AnnotatedElementUtils`£¬Èç¹ûÐèÒª´¦ÀíÊôÐÔ¸²¸Ç£¬ÐèҪʹÓà `AnnotatedElementUtils`£¬Èç¹û²»ÐèÒª£¬¾ÍʹÓà `AnnotationUtils`¡£ +本文介ç»�了 spring 处ç�†æ³¨è§£çš„æ“�作,主è¦�介ç»�了 `SimpleAnnotationMetadataReadingVisitor` 与 `StandardAnnotationMetadata` 的区别与使用方法。由于这两个类使用起æ�¥æ­¥éª¤æ¯”较多,文中å�ˆä»‹ç»�了 spring æ��供的两个工具类:`AnnotationUtils` 与 `AnnotatedElementUtils`,如果需è¦�处ç�†å±žæ€§è¦†ç›–,需è¦�使用 `AnnotatedElementUtils`,如果ä¸�需è¦�,就使用 `AnnotationUtils`。 * * * -_±¾ÎÄÔ­ÎÄÁ´½Ó£º[https://my.oschina.net/funcy/blog/4633161](https://my.oschina.net/funcy/blog/4633161) £¬ÏÞÓÚ×÷Õ߸öÈËˮƽ£¬ÎÄÖÐÄÑÃâÓдíÎóÖ®´¦£¬»¶Ó­Ö¸Õý£¡Ô­´´²»Ò×£¬ÉÌÒµ×ªÔØÇëÁªÏµ×÷Õß»ñµÃÊÚȨ£¬·ÇÉÌÒµ×ªÔØÇë×¢Ã÷³ö´¦¡£_ \ No newline at end of file +_本文原文链接:[https://my.oschina.net/funcy/blog/4633161](https://my.oschina.net/funcy/blog/4633161) ,é™�于作者个人水平,文中难å…�有错误之处,欢迎指正ï¼�原创ä¸�易,商业转载请è�”系作者获得授æ�ƒï¼Œé�žå•†ä¸šè½¬è½½è¯·æ³¨æ˜Žå‡ºå¤„。_ \ No newline at end of file diff --git "a/docs/cache/Redis\345\216\237\347\220\206\344\270\216\345\256\236\350\267\265\346\200\273\347\273\223.md" "b/docs/cache/Redis\345\216\237\347\220\206\344\270\216\345\256\236\350\267\265\346\200\273\347\273\223.md" index 6c9a602..fa8c1ce 100644 --- "a/docs/cache/Redis\345\216\237\347\220\206\344\270\216\345\256\236\350\267\265\346\200\273\347\273\223.md" +++ "b/docs/cache/Redis\345\216\237\347\220\206\344\270\216\345\256\236\350\267\265\346\200\273\347\273\223.md" @@ -434,13 +434,10 @@ redis事务的ACID特性 ③隔离性 - 事务的隔离性指的是,å�³ä½¿æ•°æ�®åº“中有多个事务并å�‘在执行,å�„个事务之间也ä¸�会互相影å“�,并且在并å�‘状æ€�下执行的事务和串行执行的事务产生的结果完全 - 相å�Œã€‚ - 因为redis使用å�•线程的方å¼�æ�¥æ‰§è¡Œäº‹åŠ¡(以å�Šäº‹åŠ¡é˜Ÿåˆ—ä¸­çš„å‘½ä»¤),并且æœ�务器ä¿�è¯�,在执行事务期间ä¸�会对事物进行中断,å› æ­¤,redis的事务总是以串行 - 的方å¼�è¿�行的,并且事务也总是具有隔离性的 + 事务的隔离性指的是,å�³ä½¿æ•°æ�®åº“中有多个事务并å�‘在执行,å�„个事务之间也ä¸�会互相影å“�,并且在并å�‘状æ€�下执行的事务和串行执行的事务产生的结果完全相å�Œã€‚ + 因为redis使用å�•线程的方å¼�æ�¥æ‰§è¡Œäº‹åŠ¡(以å�Šäº‹åŠ¡é˜Ÿåˆ—ä¸­çš„å‘½ä»¤),并且æœ�务器ä¿�è¯�,在执行事务期间ä¸�会对事物进行中断,å› æ­¤,redis的事务总是以串行的方å¼�è¿�行的,并且事务也总是具有隔离性的 â‘£æŒ�久性 事务的è€�久性指的是,当一个事务执行完毕时,执行这个事务所得的结果已ç»�被ä¿�æŒ�到永久存储介质里é�¢ã€‚ - 因为redis事务ä¸�过是简å�•的用队列包裹起æ�¥ä¸€ç»„redis命令,redis并没有为事务æ��供任何é¢�外的æŒ�久化功能,所以redis事务的è€�久性由redis使用的模å¼� - 决定 + 因为redis事务ä¸�过是简å�•的用队列包裹起æ�¥ä¸€ç»„redis命令,redis并没有为事务æ��供任何é¢�外的æŒ�久化功能,所以redis事务的è€�久性由redis使用的模å¼�决定 diff --git "a/docs/distributed/practice/\346\220\236\346\207\202\345\210\206\345\270\203\345\274\217\346\212\200\346\234\257\357\274\232\346\266\210\346\201\257\351\230\237\345\210\227\345\233\240\344\275\225\350\200\214\347\224\237.md" "b/docs/distributed/practice/\346\220\236\346\207\202\345\210\206\345\270\203\345\274\217\346\212\200\346\234\257\357\274\232\346\266\210\346\201\257\351\230\237\345\210\227\345\233\240\344\275\225\350\200\214\347\224\237.md" index b47f00d..85b7bcc 100644 --- "a/docs/distributed/practice/\346\220\236\346\207\202\345\210\206\345\270\203\345\274\217\346\212\200\346\234\257\357\274\232\346\266\210\346\201\257\351\230\237\345\210\227\345\233\240\344\275\225\350\200\214\347\224\237.md" +++ "b/docs/distributed/practice/\346\220\236\346\207\202\345\210\206\345\270\203\345\274\217\346\212\200\346\234\257\357\274\232\346\266\210\346\201\257\351\230\237\345\210\227\345\233\240\344\275\225\350\200\214\347\224\237.md" @@ -8,8 +8,8 @@ * [消æ�¯é˜Ÿåˆ—çš„æµ�派之争](#消æ�¯é˜Ÿåˆ—çš„æµ�派之争) * [MQ是什么](#mq是什么) * [MQçš„æµ�æ´¾](#mqçš„æµ�æ´¾) - * [有broker](#有broker) - * [æ— broker](#æ— broker) + * [有 Broker](#有-broker) + * [æ—  Broker](#æ— -broker) * [MQå�ªèƒ½å¼‚æ­¥å�—](#mqå�ªèƒ½å¼‚æ­¥å�—) * [总结](#总结) * [如何设计一个消æ�¯é˜Ÿåˆ—](#如何设计一个消æ�¯é˜Ÿåˆ—) @@ -127,41 +127,29 @@ Message Queue(MQ),消æ�¯é˜Ÿåˆ—中间件。很多人都说:MQ通过将消 ## MQçš„æµ�æ´¾ +列出功能表æ�¥æ¯”较MQ差异或者æ�¥ä¸€åœºâ€œMQ性能大比武â€�çš„å�šæ³•éƒ½æ˜¯æ¯”è¾ƒæ‰¯çš„ï¼Œé¦–å…ˆè¦�å�šçš„事情应该是分类。我ç�†è§£çš„MQ分为两个æµ�派。 +### 有 Broker -列出功能表æ�¥æ¯”较MQ差异或者æ�¥ä¸€åœºâ€œMQ性能大比武â€�çš„å�šæ³•éƒ½æ˜¯æ¯”è¾ƒæ‰¯çš„ï¼Œé¦–å…ˆè¦�å�šçš„事情应该是分类。我ç�†è§£çš„MQ分为两个æµ�æ´¾ +这个æµ�派通常有一å�°æœ�务器作为 Broker,所有的消æ�¯éƒ½é€šè¿‡å®ƒä¸­è½¬ã€‚生产者把消æ�¯å�‘é€�给它就结æ�Ÿè‡ªå·±çš„任务了,Broker 则把消æ�¯ä¸»åŠ¨æŽ¨é€�给消费者(或者消费者主动轮询)。 -### 有broker +#### é‡� Topic æµ� +kafkaã€�JMS 就属于这个æµ�派,生产者会å�‘é€� key 和数æ�®åˆ° Broker,由 Broker 比较 key 之å�Žå†³å®šç»™é‚£ä¸ªæ¶ˆè´¹è€…。这ç§�模å¼�是我们最常è§�的模å¼�,是我们对 MQ 最多的å�°è±¡ã€‚在这ç§�模å¼�下一个 topic 往往是一个比较大的概念,甚至一个系统中就å�¯èƒ½å�ªæœ‰ä¸€ä¸ª topic,topic æŸ�ç§�æ„�义上就是 queue,生产者å�‘é€� key 相当于说:“hi,把数æ�®æ”¾åˆ°è¿™ä¸ª key 的队列中â€�。 +![é‡� Topic æµ�](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230407220345.png) -这个æµ�派通常有一å�°æœ�务器作为Broker,所有的消æ�¯éƒ½é€šè¿‡å®ƒä¸­è½¬ã€‚生产者把消æ�¯å�‘é€�给它就结æ�Ÿè‡ªå·±çš„任务了,Broker则把消æ�¯ä¸»åŠ¨æŽ¨é€�给消费者(或者消费者主动轮询)。 +如上图所示,Broker 定义了三个队列,key1,key2,key3,生产者å�‘é€�æ•°æ�®çš„æ—¶å€™ä¼šå�‘é€� key1 å’Œ data,Broker 在推é€�æ•°æ�®çš„æ—¶å€™åˆ™æŽ¨é€� data(也å�¯èƒ½æŠŠ key 带上)。虽然架构一样但是 kafka 的性能è¦�比 jms 的性能ä¸�知é�“高到多少å€�,所以基本这ç§�类型的 MQ å�ªæœ‰ kafka 一ç§�备选方案。如果你需è¦�一æ�¡æš´åŠ›çš„æ•°æ�®æµ�(在乎性能而é�žç�µæ´»æ€§ï¼‰é‚£ä¹ˆ kafka 是最好的选择。 -* é‡�Topicæµ� +#### è½» Topic æµ� - kafkaã€�JMS就属于这个æµ�派,生产者会å�‘é€�key和数æ�®åˆ°Broker,由Broker比较key之å�Žå†³å®šç»™é‚£ä¸ªæ¶ˆè´¹è€…。这ç§�模å¼�是我们最常è§�的模å¼�,是我们对MQ最多的å�°è±¡ã€‚在这ç§�模å¼�下一个topic往往是一个比较大的概念,甚至一个系统中就å�¯èƒ½å�ªæœ‰ä¸€ä¸ªtopic,topicæŸ�ç§�æ„�义上就是queue,生产者å�‘é€�key相当于说:“hi,把数æ�®æ”¾åˆ°`key`的队列中â€�。 +è¿™ç§�的代表是 RabbitMQ(或者说是 AMQP)。生产者å�‘é€� key 和数æ�®ï¼Œæ¶ˆè´¹è€…定义订阅的队列,Broker 收到数æ�®ä¹‹å�Žä¼šé€šè¿‡ä¸€å®šçš„逻辑计算出 key 对应的队列,然å�ŽæŠŠæ•°æ�®äº¤ç»™é˜Ÿåˆ—。 +![è½» Topic æµ�](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230407220359.png) +注æ„�到了å�—?这ç§�模å¼�下解耦了 key å’Œ queue,在这ç§�架构中 queue 是é�žå¸¸è½»é‡�级的(在 RabbitMQ 中它的上é™�å�–决于你的内存),消费者关心的å�ªæ˜¯è‡ªå·±çš„ queue;生产者ä¸�必关心数æ�®æœ€ç»ˆç»™è°�å�ªè¦�指定 key 就行了,中间的那层映射在 AMQP 中å�« exchange(交æ�¢æœºï¼‰ã€‚AMQP 中有四ç§� exchange——Direct exchange:key 就等于 queueï¼›Fanout exchange:无视 key,给所有的 queue 都æ�¥ä¸€ä»½ï¼›Topic exchange:key å�¯ä»¥ç”¨â€œå®½å­—符â€�模糊匹é…� queue;最å�Žä¸€ä¸ªåŽ‰å®³äº† Headers exchange:无视 key,通过查看消æ�¯çš„头部元数æ�®æ�¥å†³å®šå�‘给那个 queue(AMQP 头部元数æ�®é�žå¸¸ä¸°å¯Œè€Œä¸”å�¯ä»¥è‡ªå®šä¹‰ï¼‰ã€‚è¿™ç§�结构的架构给通讯带æ�¥äº†å¾ˆå¤§çš„ç�µæ´»æ€§ï¼Œæˆ‘们能想到的通讯方å¼�都å�¯ä»¥ç”¨è¿™å››ç§� exchange 表达出æ�¥ã€‚如果你需è¦�一个ä¼�业数æ�®æ€»çº¿ï¼ˆåœ¨ä¹Žç�µæ´»æ€§ï¼‰é‚£ä¹ˆ RabbitMQ ç»�对的值得一用。 - - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230407220345.png) - -如上图所示,Broker定义了三个队列,key1,key2,key3,生产者å�‘é€�æ•°æ�®çš„æ—¶å€™ä¼šå�‘é€�key1å’Œdata,Broker在推é€�æ•°æ�®çš„æ—¶å€™åˆ™æŽ¨é€�data(也å�¯èƒ½æŠŠkey带上)。虽然架构一样但是kafka的性能è¦�比jms的性能ä¸�知é�“高到多少å€�,所以基本这ç§�类型的MQå�ªæœ‰kafka一ç§�备选方案。如果你需è¦�一æ�¡æš´åŠ›çš„æ•°æ�®æµ�(在乎性能而é�žç�µæ´»æ€§)那么kafka是最好的选择。 - -* è½»Topicæµ� - -è¿™ç§�的代表是RabbitMQ(或者说是AMQP)。生产者å�‘é€�key和数æ�®ï¼Œæ¶ˆè´¹è€…定义订阅的队列,Broker收到数æ�®ä¹‹å�Žä¼šé€šè¿‡ä¸€å®šçš„逻辑计算出key对应的队列,然å�ŽæŠŠæ•°æ�®äº¤ç»™é˜Ÿåˆ—。 - - - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230407220359.png) - - - -注æ„�到了å�—?这ç§�模å¼�下解耦了keyå’Œqueue,在这ç§�架构中queue是é�žå¸¸è½»é‡�级的(在RabbitMQ中它的上é™�å�–决于你的内存),消费者关心的å�ªæ˜¯è‡ªå·±çš„queue;生产者ä¸�必关心数æ�®æœ€ç»ˆç»™è°�å�ªè¦�指定key就行了,中间的那层映射在AMQP中å�«exchange(交æ�¢æœºï¼‰ã€‚AMQP中有四ç§�ç§�exchange——Direct exchange:key就等于queueï¼›Fanout exchange:无视key,给所有的queue都æ�¥ä¸€ä»½ï¼›Topic exchange:keyå�¯ä»¥ç”¨â€œå®½å­—符â€�模糊匹é…�queue;最å�Žä¸€ä¸ªåŽ‰å®³äº†Headers exchange:无视key,通过查看消æ�¯çš„头部元数æ�®æ�¥å†³å®šå�‘给那个queue(AMQP头部元数æ�®é�žå¸¸ä¸°å¯Œè€Œä¸”å�¯ä»¥è‡ªå®šä¹‰ï¼‰ã€‚è¿™ç§�结构的架构给通讯带æ�¥äº†å¾ˆå¤§çš„ç�µæ´»æ€§ï¼Œæˆ‘们能想到的通讯方å¼�都å�¯ä»¥ç”¨è¿™å››ç§�exchange表达出æ�¥ã€‚如果你需è¦�一个ä¼�业数æ�®æ€»çº¿ï¼ˆåœ¨ä¹Žç�µæ´»æ€§ï¼‰é‚£ä¹ˆRabbitMQç»�对的值得一用。 - -### æ— broker +### æ—  Broker @@ -347,27 +335,38 @@ Anyway,作为一个æˆ�熟的消æ�¯é˜Ÿåˆ—,应该尽é‡�在å�„个环节å‡�å°‘ 客户端å�Œæ­¥æœ�务端异步。 -``` -Future future = request(server);//server立刻返回futuresynchronized(future){while(!future.isDone()){ future.wait();//server处ç�†ç»“æ�Ÿå�Žä¼šnotify这个future,并修改isdone标志}}return future.get(); +```java +Future future = request(server); // server 立刻返回 future +synchronized (future) { + while (!future.isDone()) { + future.wait(); // server 处ç�†ç»“æ�Ÿå�Žä¼š notify 这个 future,并修改 isDone 标志 + } +} +return future.get(); ``` 客户端å�Œæ­¥æœ�务端å�Œæ­¥ã€‚ -``` +```java Result result = request(server); - ``` -客户端异步æœ�务端å�Œæ­¥(这里用线程池的方å¼�)。 +客户端异步æœ�务端å�Œæ­¥ï¼ˆè¿™é‡Œç”¨çº¿ç¨‹æ± çš„æ–¹å¼�)。 -``` -Future future = executor.submit(new Callable(){public void call(){ result = request(server);}})return future; +```java +Future future = executor.submit(new Callable() { + public Result call() { + return request(server); + } +}); +return future; ``` 客户端异步æœ�务端异步。 -``` -Future future = request(server);//server立刻返回future return future +```java +Future future = request(server); // server 立刻返回 future +return future; ``` 上é�¢è¯´äº†è¿™ä¹ˆå¤šï¼Œå…¶å®žæ˜¯æƒ³è®©å¤§å®¶è„±ç¦»ä¸¤ä¸ªè¯¯åŒºï¼š diff --git "a/docs/mq/kafka/\346\266\210\346\201\257\351\230\237\345\210\227kafka\350\257\246\350\247\243\357\274\232Kafka\346\236\266\346\236\204\344\273\213\347\273\215.md" "b/docs/mq/kafka/\346\266\210\346\201\257\351\230\237\345\210\227kafka\350\257\246\350\247\243\357\274\232Kafka\346\236\266\346\236\204\344\273\213\347\273\215.md" index 2d35efe..9da2cbe 100644 --- "a/docs/mq/kafka/\346\266\210\346\201\257\351\230\237\345\210\227kafka\350\257\246\350\247\243\357\274\232Kafka\346\236\266\346\236\204\344\273\213\347\273\215.md" +++ "b/docs/mq/kafka/\346\266\210\346\201\257\351\230\237\345\210\227kafka\350\257\246\350\247\243\357\274\232Kafka\346\236\266\346\236\204\344\273\213\347\273\215.md" @@ -2,12 +2,7 @@ Kafka中消æ�¯æ˜¯ä»¥topic进行分类的,Producer生产消æ�¯ï¼ŒConsumer消费消æ�¯ï¼Œéƒ½æ˜¯é�¢å�‘topic的。 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-b9d626794f6625526598db6627b780e7_720w.webp) - -
+**�程�以看�一�线:** Producer 把消��给�个 Topic → 消�真正�在该 Topic 的�一个 Partition(分区)上 → 分区对应一段�断追加的 log → Consumer 按自己记录的 offset 从 log 里接�读。 Topic是逻辑上的改�,Partition是物�上的概念,�个Partition对应�一个log文件,该log文件中存储的就是producer生产的数�,topic=N*partition;partition=log @@ -17,44 +12,16 @@ Producer生产的数�会被�断的追加到该log文件的末端,且�� Kafka文件存储也是通过本地�盘的方�存储的,主�是通过相应的log与index等文件�存具体的消�文件。 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-116ebd7dffd85595d69f080e5b5f6948_720w.webp) - -
+**�盘结构:** 一个分区在�盘上主�是一对对 `.index` + `.log`。`.log` 里按顺�追加真实消�;`.index` 里记「稀�的 offset → 在 log 里的�置�,用�加速查找,而�是��消�都建一个索引项。 生产者�断的�log文件追加消�文件,为了防止log文件过大导致定�效率低下,Kafka的log文件以1G为一个分界点,当.log文件大�超过1G的时候,此时会创建一个新的.log文件,�时为了快速定�大文件中消��置,Kafka采�了分片和索引的机制�加速定�。 -在kafka的存储log的地方,�文件的地方,会存在消费的�移�以�具体的分区信�,分区信�的�主�包括.index和.log文件组� - -
- - -![](https://pic3.zhimg.com/80/v2-c6de61f43ecbe58d4f3e7aa29541220e_720w.webp) - -
- -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-8345e4966d8c5274a1e74e29151bd9c6_720w.webp) - -
- -副本目的是为了备份,所以�一个分区存储在��的broker上,�当third-2存在当�机器kafka01上,实际上�kafka03中也有这个分区的文件(副本),分区中包�副本,�一个分区�以设置多个副本,副本中有一个是leader,其余为follower。 +在kafka的存储log的地方,�文件的地方,会存在消费的�移�以�具体的分区信�,分区信�的�主�包括.index和.log文件组�。 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-6e8de9e7dcbdac0b7bd424eaaf4f8568_720w.webp) - -
+**副本怎么摊在机器上:** �一个分区的数�会在�� Broker 上�放一份。例如分区 `third-2` 在 kafka01 上有一份,kafka03 上还有一份副本。一个分区�以设多个副本,其中 **一个 Leader�其余 Follower**;生产者写�消费者读都�� Leader,Follower �负责从 Leader �步,用�备份和故障切�。 如果.log文件超出大�,则会产生新的.log文件。如下所示: - - ``` 00000000000000000000.index 00000000000000000000.log @@ -62,44 +29,31 @@ Kafka文件存储也是通过本地�盘的方�存储的,主�是通过相 00000000000000170410.log 00000000000000239430.index 00000000000000239430.log - ``` - +文件�是该分段的起始 offset。上�三对文件表示:从 offset 0 开始的一段�从 170410 开始的一段�从 239430 开始的一段。 **此时如何快速定�数�,步骤:** +`.index` 文件存储的是消�的 offset 与在 `.log` 里的相对�置;`.log` 中存放的是真实的数�。 - -``` -.index文件存储的消�的offset+真实的起始�移�。.log中存放的是真实的数�。 - -``` - - - -首先通过二分查找.index文件到查找到当�消�具体的�移,如上图所示,查找为2,�现第二个文件为6,则定�到一个文件中。 然�通过第一个.index文件通过seek定�元素的�置3,定�到之�获�起始�移�+当�文件大�=总的�移�。 获�到总的�移�之�,直接定�到.log文件��快速获得当�消�大�。 +查找��消�时:先按分段起始 offset **二分**,�到对应的那一对 index/log(例如�找的 offset �在 0~170409 之间,就打开 `00000000000000000000.*`)。�在 `.index` 里 seek 到最接近的索引项,用「分段起始 offset + 索引给出的文件内�移�定�到 `.log` 里的字节�置,从而读出这�消�,而�必从头扫整个大文件。 ## 三. 生产者分区策略 -**分区的原因** 1\. 方便在集群中扩展:�个partition通过调整以适应它所在的机器,而一个Topic��以有多个partition组�,因此整个集群�以适应适�的数�。 2\. �以�高并�:以Partition为��进行读写。类似于多路。 +**分区的原因** 1 方便在集群中扩展:�个partition通过调整以适应它所在的机器,而一个Topic��以有多个partition组�,因此整个集群�以适应适�的数�。 2 �以�高并�:以Partition为��进行读写。类似于多路。 -**分区的原则** 1\. 指明partition(这里的指明是指第几个分区)的情况下,直接将指明的值作为partition的值 2\. 没有指明partition的情况下,但是存在值key,此时将key的hash值与topic的partition总数进行�余得到partition值 3\. 值与partition�无的情况下,第一次调用时�机生�一个整数,���次调用在这个整数上自增,将这个值与topic�用的partition总数�余得到partition值,�round-robin算法。 +**分区的原则** 1 指明partition(这里的指明是指第几个分区)的情况下,直接将指明的值作为partition的值 2 没有指明partition的情况下,但是存在值key,此时将key的hash值与topic的partition总数进行�余得到partition值 3 值与partition�无的情况下,第一次调用时�机生�一个整数,���次调用在这个整数上自增,将这个值与topic�用的partition总数�余得到partition值,�round-robin算法。 ## 四. 生产者ISR 为��producer��的数�能够��的��到指定的topic中,topic的�个partition收到producer��的数��,都需��producer��ackacknowledgement,如果producer收到ack就会进行下一轮的��,�则�新��数�。 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-409ea1af4f66bd2f44398850cc2ba9e2_720w.webp) - -
+**����的顺�:** Producer 把消�交给该分区的 Leader → Leader 写入本地 log → Follower 从 Leader 拉�并写入自己的 log → 达到约定的�步范围�,Leader �给 Producer 回 ack → Producer �认为这次���功,�则��。 **��ack的时机** 确�有follower与leader�步完�,leader���ack,这样�以��在leader挂掉之�,follower中�以选出新的leader(主�是确�follower中数��丢失) -**follower�步完�多少���ack** 1\. �数以上的follower�步完�,����ack 2\. 全部的follower�步完�,��以��ack +**follower�步完�多少���ack** 1 �数以上的follower�步完�,����ack 2 全部的follower�步完�,��以��ack ## 4.1 副本数��步策略 @@ -135,36 +89,21 @@ Kafka为用户�供了三���性级别,用户根���性和延迟的 1:producer等待broker的ack,partition的leader�盘�功�返回ack,如果在follower�步�功之�leader故障,那么将丢失数�。(�是leader�盘) -
- - -![](https://pic1.zhimg.com/80/v2-a219d261edd97432347f4edf5794e170_720w.webp) - -
+**ack=1 丢数�的典型路径:** Leader 已�盘并回了 ack,Follower 还没跟上;此时 Leader 宕机,新 Leader 从旧 Follower 里选,那��存在于已挂 Leader 上的消�就没了,而 Producer 以为已��功。 -1(all):producer等待broker的ack,partition的leader和ISR的follower全部�盘�功�返回ack,但是如果在follower�步完��,broker��ack之�,如果leader�生故障,会造�数���。(这里的数���是因为没有收到,所以继续��导致的数���) -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-c9741a10f418f7ea4eed929f0f266bbb_720w.webp) - -
+**ack=-1 ��的典型路径:** ISR 都已写上,但 ack 还没回到 Producer;Leader 挂了,Producer 超时��,新 Leader 上就会��一��样的业务数�。所以 -1 是「至少一次�,�是精确一次;精确一次���文幂等/事务。 producer返ack,0无�盘直接返,1�leader�盘然�返,-1全部�盘然�返 ## 六. 数�一致性问题 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-031d84a2012f64b122dd64ab67a4e52a_720w.webp) - -
+�个副本自己有一个 **LEO(Log End Offset)**:该副本 log 里下一��写入的�置,也就是目�最�一�的下一�。**HW(High Watermark,高水�)** 是消费者目�能读到的最大 offset,� ISR 里�副本 LEO 的最�值。HW 之�的数�副本间�能还没对�,所以�让消费者看�,��读到��会被截掉的�尾。 LEO(Log End Offset):�个副本最�的一个offset HW(High Watermark):高水�,指代消费者能�到的最大的offset,ISR队列中最�的LEO。 -**follower故障和leader故障** 1\. follower故障:follower�生故障�会被临时踢出ISR,等待该follower���,follower会读�本地�盘记录的上次的HW,并将log文件高于HW的部分截�掉,从HW开始�leader进行�步,等待该follower的LEO大于等于该partition的HW,�follower追上leader之�,就�以�新加入ISR了。 2\. leader故障:leader�生故障之�,会从ISR中选出一个新的leader,为了��多个副本之间的数�的一致性,其余的follower会先将�自的log文件高于HW的部分截掉,然�从新的leader中�步数�。 +**follower故障和leader故障** 1 follower故障:follower�生故障�会被临时踢出ISR,等待该follower���,follower会读�本地�盘记录的上次的HW,并将log文件高于HW的部分截�掉,从HW开始�leader进行�步,等待该follower的LEO大于等于该partition的HW,�follower追上leader之�,就�以�新加入ISR了。 2 leader故障:leader�生故障之�,会从ISR中选出一个新的leader,为了��多个副本之间的数�的一致性,其余的follower会先将�自的log文件高于HW的部分截掉,然�从新的leader中�步数�。 **这�能��副本之间的数�一致性,并�能��数��丢失或者���** @@ -192,22 +131,17 @@ push推的模�很难适应消费速率��的消费者,因为消��� pull模��足在于如果Kafka中没有数�,消费者�能会陷入循环之中 (因为消费者类似监�状�获�数�消费的),一直返回空数�,针对这一点,Kafka的消费者在消费数�时会传入一个时长�数timeout,如果当�没有数��供消费,consumer会等待一段时间之��返回,时长为timeout。 -## 8.1\. 分区分�策略 +## 8.1 分区分�策略 一个consumer group中有多个consumer,一个topic有多个partition,所以必然会涉�到partition的分�问题,�确定那个partition由那个consumer消费的问题。 -**Kafka的两�分�策略:** 1\. round-robin循环 2\. range +**Kafka的两�分�策略:** 1 round-robin循环 2 range **Round-Robin** 主�采用轮询的方�分�所有的分区,该策略主�实现的步骤: �设存在三个topic:t0/t1/t2,分别拥有1/2/3个分区,共有6个分区,分别为t0-0/t1-0/t1-1/t2-0/t2-1/t2-2,这里�设我们有三个Consumer,C0�C1�C2,订阅情况为C0:t0,C1:t0�t1,C2:t0/t1/t2。 此时round-robin采�的分�方�,则是按照分区的字典对分区和消费者进行排�,然�对分区进行循环�历,�到自己订阅的则消费,�则�下轮询下一个消费者。�按照分区轮询消费者,继而消�被消费。 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-21eed325191d7d72c9d4c39455c4cae5_720w.webp) - -
+**Round-Robin 在转什么:** 把所有分区排�一列,消费者也排�一列,分区�次问「当�这个 Consumer 订了这个 Topic ��——订了就分给它,没订就跳到下一个 Consumer,分区本身�丢,继续往下问。结果往往是订阅�最广的人(例�里的 C2)分到最多分区,压力��。 分区在循环�历消费者,自己被当�消费者订阅,则消�与消费者共��下(消�被消费),�则消费者�下消�继续�历(消�没有被消费)。轮询的方�会导致�个Consumer所承载的分区数��一致,从而导致�个Consumer压力��。上�的C2因为订阅的比较多,导致承�的压力也相对较大。 @@ -215,23 +149,13 @@ pull模��足在于如果Kafka中没有数�,消费者�能会陷入循 range按照topic一次进行分�,�消费者�历topic,t0,�有三个分区,�时有两个订阅了该topic的消费者,将这些分区和消费者按照字典�排列。 按照平�分�的方�计算�个Consumer会得到多少个分区,如果没有除尽,多出�的分区则按照字典�挨个分�给消费者。按照此方�以此分��一个topic给订阅的消费者,最�完�topic分区的分�。 -
- +**Range 在转什么:** �把所有 Topic 的分区混在一起轮询,而是 **�个 Topic �独切一刀**。例如 t0 的三个分区�两个订阅者,按�字排���一�(�除�尽多出�的)给 C0,剩下给 C1;�对 t1 ��样的事。所以�一个 Consumer 在�个 Topic 上都�能分到「���的那几片,多个 Topic 时也容易一头�沉。 -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-d642ed5512a4abdca9a8f35f2d27c277_720w.webp) - -
- -## 8.2\. 消费者offset的存储 +## 8.2 消费者offset的存储 由于Consumer在消费过程中�能会出现断电宕机等故障,Consumer��以�,需�从故障�的�置继续消费,所以Consumer需�实时记录自己消费到了那个offset,以便故障���继续消费。 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-f2a50fd7f054821e36a80b1f6d99ecb0_720w.webp) - -
+**记在哪:** 进度�是记在业务自己的数�库里(也�以,但默认�是)。Kafka 0.9 之�默认写在 **ZooKeeper**;0.9 之�默认写进集群内部 Topic **`__consumer_offsets`**。消费者组�Topic�分区�当� offset 作为一��交记录�在那里,���读回�从该 offset 接�拉。 Kafka0.9版本之�,consumer默认将offset�存在zookeeper中,从0.9版本之�,consumer默认将offset�存在kafka一个内置的topic中,该topic为__consumer_offsets @@ -245,21 +169,11 @@ Kafka0.9版本之�,consumer默认将offset�存在zookeeper中,从0.9版 NIC:Network Interface Controller网络接�控制器 -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-2807d010381d304949bf8cea16ba1744_720w.webp) +**传统读路径(四次拷�):** �盘 → 内核页缓存 → 用户�缓冲区 → 内核 socket 缓冲区 → 网�,��给消费者。�多一个消费者,��这几步往往��走一�。 -
+这是常规的读��作: 1 �作系统将数�从�盘文件中读�到内核空间的页�缓存 2 应用程�将数�从内核空间读入到用户空间缓冲区 3 应用程�将读到的数�写回内核空间并放入到socket缓冲区 4 �作系统将数�从socket缓冲区�制到网�接�,此时数�通过网络��给消费者 -这是常规的读��作: 1\. �作系统将数�从�盘文件中读�到内核空间的页�缓存 2\. 应用程�将数�从内核空间读入到用户空间缓冲区 3\. 应用程�将读到的数�写回内核空间并放入到socket缓冲区 4\. �作系统将数�从socket缓冲区�制到网�接�,此时数�通过网络��给消费者 - -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-390cbabdeaba6f9e79a8ba6f4d08d75f_720w.webp) - -
+**零拷�:** 数�进页缓存之�,��进用户�兜一圈,由内核直接把页缓存里的内容�给网�。多个订阅者�以共用�一份页缓存。 零拷�技术�用将�盘文件的数��制到页�缓存中一次,然�将数�从页�缓存直接��到网络中(��给��的订阅者时,都�以使用�一个页�缓存),从而��了���制的�作。 @@ -271,12 +185,7 @@ Kafka集群中有一个broker会被选举为Controller,负责管�集群broke **Partition的Leader的选举过程** -
- - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/v2-fc64ea72cba32e702b15344767bdace9_720w.webp) - -
+Broker 在 ZooKeeper 上注册;集群选出一个 **Controller**。�分区 Leader 挂了之�,由 Controller 看该分区的 ISR,从中指定新 Leader,并把结果写回 ZooKeeper / 通知其他 Broker。Follower 按新 Leader 截 HW 之�的 log ��步。选举�赖 ZK 上的集群元数�,�是消费者自己投票。 ## �. 事务 @@ -286,7 +195,7 @@ kafka从0.11版本开始引入了事务支�,事务�以��Kafka在Exactl 为了按跨分区跨会�的事务,需�引入一个全局唯一的Transaction ID,并将Producer获得的PID(�以�解为Producer ID)和Transaction ID进行绑定,这样当Producer��之�就�以通过正在进行的Transaction ID获得原�的PID。 -为了管�Transaction,Kafka引入了一个新的组件Transaction Coordinator,Producer就是通过有和Transaction Coordinator交互获得Transaction ID对应的任务状�,Transaction Coordinator还负责将事务信�写入内部的一个Topic中,这样�使整个�务��,由于事务状�得到�存,进行中的事务状��以��,从而继续进行。 +为了管�Transaction,Kafka引入了一个新的组件Transaction Coordinator,Producer就是通过有和Transaction Coordinator交互获得Transaction ID对应的任务状�,Transaction Coordinator还负责将事务信�写入内部的一个 Topic中,这样�使整个�务��,由于事务状�得到�存,进行中的事务状��以��,从而继续进行。 ## 10.2 Consumer事务 @@ -294,5 +203,5 @@ kafka从0.11版本开始引入了事务支�,事务�以��Kafka在Exactl ## �考文章 -https://blog.csdn.net/cao131502 -https://zhuanlan.zhihu.com/p/137811719 \ No newline at end of file +[https://blog.csdn.net/cao131502](https://blog.csdn.net/cao131502) +[https://zhuanlan.zhihu.com/p/137811719](https://zhuanlan.zhihu.com/p/137811719) From 1ec86f5a922fdf51310dc23168494e1592441595 Mon Sep 17 00:00:00 2001 From: wangj19 Date: Wed, 30 Sep 2026 15:01:55 +0800 Subject: [PATCH 4/4] 222 --- ...345\236\213JMM\346\200\273\347\273\223.md" | 175 ++--- ...345\255\230\346\250\241\345\236\213JMM.md" | 9 - ...232\204Starter\346\234\272\345\210\266.md" | 82 +-- ...30\345\214\226\345\274\200\345\247\213.md" | 690 +++++++++++------- 4 files changed, 565 insertions(+), 391 deletions(-) diff --git "a/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232Java\345\206\205\345\255\230\346\250\241\345\236\213JMM\346\200\273\347\273\223.md" "b/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232Java\345\206\205\345\255\230\346\250\241\345\236\213JMM\346\200\273\347\273\223.md" index cf8281c..a935d75 100644 --- "a/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232Java\345\206\205\345\255\230\346\250\241\345\236\213JMM\346\200\273\347\273\223.md" +++ "b/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232Java\345\206\205\345\255\230\346\250\241\345\236\213JMM\346\200\273\347\273\223.md" @@ -1,21 +1,21 @@ # 目录 - * [简介](#简介) - * [一�Java内存区域(JVM内存区域)](#一�java内存区域(jvm内存区域)) - * [二�Java内存模型](#二�java内存模型) - * [三�as-if-serial语义�happens-before原则](#三�as-if-serial语义�happens-before原则) - * [3.1 as-if-serial语义](#31-as-if-serial语义) - * [3.2 happens-before原则](#32-happens-before原则) - * [3.3 happens-before定义](#33-happens-before定义) - * [3.3 happens-before对比as-if-serial](#33-happens-before对比as-if-serial) - * [3.4 happens-before具体规则](#34-happens-before具体规则) - * [3.5 happens-before与JMM的关系图](#35-happens-before与jmm的关系图) - * [四�volatile��的内存语义](#四�volatile��的内存语义) - * [4.1 volatile的内存语义](#41-volatile的内存语义) - * [4.2 volatile内存语义的实现](#42-volatile内存语义的实现) - * [4.3 �的内存语义](#43-�的内存语义) - * [4.4 final域的内存语义](#44-final域的内存语义) - * [五�JMM是如何处�并�过程中的三大特性](#五�jmm是如何处�并�过程中的三大特性) - * [�考链接:](#�考链接:) +* [简介](#简介) +* [一�Java内存区域(JVM内存区域)](#一�java内存区域(jvm内存区域)) +* [二�Java内存模型](#二�java内存模型) +* [三�as-if-serial语义�happens-before原则](#三�as-if-serial语义�happens-before原则) +* [3.1 as-if-serial语义](#31-as-if-serial语义) +* [3.2 happens-before原则](#32-happens-before原则) +* [3.3 happens-before定义](#33-happens-before定义) +* [3.3 happens-before对比as-if-serial](#33-happens-before对比as-if-serial) +* [3.4 happens-before具体规则](#34-happens-before具体规则) +* [3.5 happens-before与JMM的关系图](#35-happens-before与jmm的关系图) +* [四�volatile��的内存语义](#四�volatile��的内存语义) +* [4.1 volatile的内存语义](#41-volatile的内存语义) +* [4.2 volatile内存语义的实现](#42-volatile内存语义的实现) +* [4.3 �的内存语义](#43-�的内存语义) +* [4.4 final域的内存语义](#44-final域的内存语义) +* [五�JMM是如何处�并�过程中的三大特性](#五�jmm是如何处�并�过程中的三大特性) +* [�考链接:](#�考链接:) 本文转自 https://www.cnblogs.com/kukri/p/9109639.html @@ -56,25 +56,25 @@ Java虚拟机在�行程�时会把其自动管�的内存划分为以上几 * 方法区(Method Area): - 方法区属于线程共享的内存区域,�称Non-Heap(�堆),主�用于存储已被虚拟机加载的类信��常��������时编译器编译�的代�等数�,根�Java 虚拟机规范的规定,当方法区无法满足内存分�需求时,将抛出OutOfMemoryError 异常。值得注�的是在方法区中存在一个��行时常�池(Runtime Constant Pool)的区域,它主�用于存放编译器生�的��字��和符�引用,这些内容将在类加载�存放到�行时常�池中,以便�续使用。 +方法区属于线程共享的内存区域,�称Non-Heap(�堆),主�用于存储已被虚拟机加载的类信��常��������时编译器编译�的代�等数�,根�Java 虚拟机规范的规定,当方法区无法满足内存分�需求时,将抛出OutOfMemoryError 异常。值得注�的是在方法区中存在一个��行时常�池(Runtime Constant Pool)的区域,它主�用于存放编译器生�的��字��和符�引用,这些内容将在类加载�存放到�行时常�池中,以便�续使用。 * JVM堆(Java Heap): - Java 堆也是属于线程共享的内存区域,它在虚拟机�动时创建,是Java 虚拟机所管�的内存中最大的一�,主�用于存放对象实例,几乎所有的对象实例都在这里分�内存,注�Java 堆是垃圾收集器管�的主�区域,因此很多时候也被称�GC 堆,如果在堆中没有内存完�实例分�,并且堆也无法�扩展时,将会抛出OutOfMemoryError 异常。 +Java 堆也是属于线程共享的内存区域,它在虚拟机�动时创建,是Java 虚拟机所管�的内存中最大的一�,主�用于存放对象实例,几乎所有的对象实例都在这里分�内存,注�Java 堆是垃圾收集器管�的主�区域,因此很多时候也被称�GC 堆,如果在堆中没有内存完�实例分�,并且堆也无法�扩展时,将会抛出OutOfMemoryError 异常。 * 程�计数器(Program Counter Register): - 属于线程�有的数�区域,是一��内存空间,主�代表当�线程所执行的字节�行�指示器。字节�解释器工作时,通过改�这个计数器的值�选�下一�需�执行的字节�指令,分支�循环�跳转�异常处��线程��等基础功能都需��赖这个计数器�完�。 +属于线程�有的数�区域,是一��内存空间,主�代表当�线程所执行的字节�行�指示器。字节�解释器工作时,通过改�这个计数器的值�选�下一�需�执行的字节�指令,分支�循环�跳转�异常处��线程��等基础功能都需��赖这个计数器�完�。 * 虚拟机栈(Java Virtual Machine Stacks): - 属于线程�有的数�区域,与线程�时创建,总数与线程关�,代表Java方法执行的内存模型。栈中��存基础数�类型和自定义对象的引用(�是对象),对象都存放在堆区中。�个方法执行时都会创建一个栈桢�存储方法的的��表��作数栈�动�链接方法�返回值�返回地�等信�。�个方法从调用直结�就对于一个栈桢在虚拟机栈中的入栈和出栈过程,如下(图有误,应该为栈桢): +属于线程�有的数�区域,与线程�时创建,总数与线程关�,代表Java方法执行的内存模型。栈中��存基础数�类型和自定义对象的引用(�是对象),对象都存放在堆区中。�个方法执行时都会创建一个栈桢�存储方法的的��表��作数栈�动�链接方法�返回值�返回地�等信�。�个方法从调用直结�就对于一个栈桢在虚拟机栈中的入栈和出栈过程,如下(图有误,应该为栈桢): ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230404195609.png) * 本地方法栈(Native Method Stacks): - 本地方法栈属于线程�有的数�区域,这部分主�与虚拟机用到的 Native 方法相关,一般情况下,我们无需关心此区域。 +本地方法栈属于线程�有的数�区域,这部分主�与虚拟机用到的 Native 方法相关,一般情况下,我们无需关心此区域。 ### 二�Java内存模型 @@ -96,13 +96,13 @@ Java内存模型(�Java Memory Model,简称JMM)本身是一�抽象的概念 * 主内存 - 主�存储的是Java实例对象以�线程之间的共享��,所有线程创建的实例对象都存放在主内存中,�管该实例对象是�员��还是方法中的本地��(也称局部��),当然也包括了共享的类信��常������。由于是共享数�区域,多�线程对�一个��进行访问�能会�现线程安全问题。 +主�存储的是Java实例对象以�线程之间的共享��,所有线程创建的实例对象都存放在主内存中,�管该实例对象是�员��还是方法中的本地��(也称局部��),当然也包括了共享的类信��常������。由于是共享数�区域,多�线程对�一个��进行访问�能会�现线程安全问题。 * 工作内存 - 有的书�中也称为本地内存,主�存储当�方法的所有本地��信�(工作内存中存储�主内存中的��副本拷�),�个线程�能访问自己的工作内存,�线程中的本地��对其它线程是���的,就算是两个线程执行的是�一段代�,它们也会�自在自己的工作内存中创建属于当�线程的本地��,当然也包括了字节�行�指示器�相关Native方法的信�。 - - 注�由于工作内存是�个线程的�有数�,线程间无法相互访问工作内存,因此存储在工作内存的数��存在线程安全问题。注�,工作内存是JMM的一个抽象概念,并�真实存在。 +有的书�中也称为本地内存,主�存储当�方法的所有本地��信�(工作内存中存储�主内存中的��副本拷�),�个线程�能访问自己的工作内存,�线程中的本地��对其它线程是���的,就算是两个线程执行的是�一段代�,它们也会�自在自己的工作内存中创建属于当�线程的本地��,当然也包括了字节�行�指示器�相关Native方法的信�。 + +注�由于工作内存是�个线程的�有数�,线程间无法相互访问工作内存,因此存储在工作内存的数��存在线程安全问题。注�,工作内存是JMM的一个抽象概念,并�真实存在。 弄清楚主内存和工作内存�,接了解一下主内存与工作内存的数�存储类型以��作方�,根�虚拟机规范,对于一个实例对象中的�员方法而言,如果方法中包�本地��是基本数�类型(boolean,byte,short,char,int,long,float,double),将直接存储在工作内存的帧栈结构中,但倘若本地��是引用类型,那么该��的引用会存储在功能内存的帧栈中,而对象实例将存储在主内存(共享数�区域,堆)中。    @@ -128,16 +128,14 @@ JMM也主�是通过控制主内存与�个线程的工作内存之间的交 �排�是指编译器和处�器为了优化程�性能而对指令�列进行�新排�的一�手段。as-if-serial语义的��是:�管怎么�排�(编译器和处�器为了�高并行度),(�线程)程�的执行结果�能被改�。编译器�runtime和处�器都必须�守as-if-serial语义。为了�守as-if-serial语义,编译器和处�器�会对存在数��赖关系的�作��排�,因为这��排�会改�执行结果。 -  但是,如果�作之间�存在数��赖关系,这些�作就�能被编译器和处�器�排�。 +但是,如果�作之间�存在数��赖关系,这些�作就�能被编译器和处�器�排�。 ### 3.2 happens-before原则 -  happens-before是JMM最核心的概念。对应Java程��说,�解happens-before是�解JMM的关键。 - -  设计JMM时,需�考虑两个关键因素: +  happens-before是JMM最核心的概念。对应Java程��说,�解happens-before是�解JMM的关键。设计JMM时,需�考虑两个关键因素: -* * 程�员对内存模型的使用。程�员希望内存模型易于�解�易于编程。程�员希望基于一个强内存模型�编写代�。 - * 编译器和处�器对内存模型的实现。编译器和处�器希望内存模型对它们的�缚越少越好,这样它们就�以�尽�能多的优化��高性能。编译器和处�器希望实现弱内存模型。 +* 程�员对内存模型的使用。程�员希望内存模型易于�解�易于编程。程�员希望基于一个强内存模型�编写代�。 +* 编译器和处�器对内存模型的实现。编译器和处�器希望内存模型对它们的�缚越少越好,这样它们就�以�尽�能多的优化��高性能。编译器和处�器希望实现弱内存模型。 但以上两点相互矛盾,所以JSR-133专家组在设计JMM时的核心膜表就是找到一个好的平衡点:一方�,为程�员�高足够强的内存��性��;�一方�,对编译器和处�器的�制尽�能地放�。 @@ -208,17 +206,16 @@ happens-before的概念最�由Leslie Lamport在其一篇影�深远的论文 * ��性。对一个volatiole��的读,总是能看到(任�线程)对这个volatile��最�的写入。 * 有�性。volatile关键字能�止指令�排�,所以volatile能在一定程度上��有�性。 +volatile关键字�止指令�排�有两层��: -   volatile关键字�止指令�排�有两层��: +  1)当程�执行到volatile��的读�作或者写�作时,在其��的�作的更改肯定全部已�进行,且结果已�对��的�作��;在其��的�作肯定还没有进行; -   1)当程�执行到volatile��的读�作或者写�作时,在其��的�作的更改肯定全部已�进行,且结果已�对��的�作��;在其��的�作肯定还没有进行; +  2)在进行指令优化时,�能将在对volatile��访问的语�放在其��执行,也�能把volatile����的语�放到其��执行。 -   2)在进行指令优化时,�能将在对volatile��访问的语�放在其��执行,也�能把volatile����的语�放到其��执行。 - -   �能上�说的比较绕,举个简�的例�: +  �能上�说的比较绕,举个简�的例�: ```` //x�y为�volatile�� //flag为volatile�� - x = 2; //语�1 +x = 2; //语�1 y = 0; //语�2 flag = true; //语�3 x = 4; //语�4 @@ -272,13 +269,13 @@ volatile写和读的内存语义总结总结: ```` class VolatileBarrierExample { int a; volatile int v1 = 1; volatile int v2 = 2; void readAndWrite() { int i = v1; //第一个volatile读 - int j = v2; // 第二个volatile读 - a = i + j; //普通写 - v1 = i + 1; // 第一个volatile写 - v2 = j * 2; //第二个 volatile写 - } +int j = v2; // 第二个volatile读 +a = i + j; //普通写 +v1 = i + 1; // 第一个volatile写 +v2 = j * 2; //第二个 volatile写 +} - … //其他方法 +… //其他方法 } ```` 针对readAndWrite()方法,编译器在生�字节�时�以�如下的优化: @@ -296,35 +293,36 @@ class VolatileBarrierExample { int a; volatile int v1 = 1; volatile int v2 = 2; 当一个��被定义为volatile之�,就�以��此��对所有线程的��性,�当一个线程修改了此��的值的时候,��新的值对于其他线程�说是�以立�得知的。�以�解�:对volatile��所有的写�作都能立刻被其他线程得知。但是这并�代表基于volatile��的�算在并�下是安全的,因为volatile�能��内存��性,�没有��对���作的原�性。比如下�的代�: -```` +````java / * - * �起20个线程,�个线程对race��进行10000次自增�作,如果代�能够正确并�, - * 则最终race的结果应为200000,但实际的�行结果��于200000。 - * - * @author Colin Wang */ +* �起20个线程,�个线程对race��进行10000次自增�作,如果代�能够正确并�, +* 则最终race的结果应为200000,但实际的�行结果��于200000。 +* +* @author Colin Wang */ public class Test { public static volatile int race = 0; public static void increase() { - race++; - } private static final int THREADS_COUNT = 20; public static void main(String[] args) { - - Thread[] threads = new Thread[THREADS_COUNT]; for (int i = 0; i < THREADS_COUNT; i++) { + race++; +} +private static final int THREADS_COUNT = 20; public static void main(String[] args) { - threads[i] = new Thread(new Runnable() { + Thread[] threads = new Thread[THREADS_COUNT]; for (int i = 0; i < THREADS_COUNT; i++) { - @Override public void run() { for (int i = 0; i < 10000; i++) { - increase(); - } - } - }); + threads[i] = new Thread(new Runnable() { + @Override public void run() { for (int i = 0; i < 10000; i++) { + increase(); + } + } +}); - threads[i].start(); - } while (Thread.activeCount() > 1) - Thread.yield(); +threads[i].start(); +} +while (Thread.activeCount() > 1) + Thread.yield(); - System.out.println(race); + System.out.println(race); - } +} } @@ -396,15 +394,15 @@ volatile一个使用场景是状��;还有�有一个线程写,其余线 ```` public class FinalTest { int i;//普通�� - final int j; static FinalExample obj; public FinalExample(){ - i = 1; - j = 2; - } public static void writer(){ - obj = new FinalExample(); - } public static void reader(){ - FinalExample object = obj;//读对象引用 - int a = object.i; int b = object.j; - } +final int j; static FinalExample obj; public FinalExample(){ +i = 1; +j = 2; +} public static void writer(){ +obj = new FinalExample(); +} public static void reader(){ +FinalExample object = obj;//读对象引用 +int a = object.i; int b = object.j; +} } ```` @@ -455,21 +453,24 @@ public class FinalTest { int i;//普通�� final域为引用类型,上�我们看到的final域是基础的数�类型,如果final域是引用类型呢? -```` +````java public class FinalReferenceTest { final int[] arrs;//final引用 - static FinalReferenceTest obj; public FinalReferenceTest(){ - arrs = new int[1];//1 - arrs[0] = 1;//2 - } public static void write0(){//A线程 +static FinalReferenceTest obj; public FinalReferenceTest(){ + arrs = new int[1];//1 + arrs[0] = 1;//2 + } + public static void write0(){//A线程 obj = new FinalReferenceTest();//3 - } public static void write1(){//线程B + } + public static void write1(){//线程B obj.arrs[0] = 2;//4 - } public static void reader(){//C线程 + } + public static void reader(){//C线程 if(obj!=null){//5 int temp =obj.arrs[0];//6 - } + } } } @@ -511,16 +512,16 @@ JMM是围绕这在并�过程中如何处�原�性���性和有�性 * 原�性: - Java中,对基本数�类型的读�和赋值�作是原�性�作,所谓原�性�作就是指这些�作是��中断的,��一定�完,�么就没有执行。比如: +Java中,对基本数�类型的读�和赋值�作是原�性�作,所谓原�性�作就是指这些�作是��中断的,��一定�完,�么就没有执行。比如: + +i = 2;j = i;i++;i = i + 1; - i = 2;j = i;i++;i = i + 1; +上�4个�作中,i=2是读��作,必定是原�性�作,j=i你以为是原�性�作,其实�,分为两步,一是读�i的值,然��赋值给j,这就是2步�作了,称�上原��作,i++和i = i + 1其实是等效的,读�i的值,加1,�写回主存,那就是3步�作了。所以上�的举例中,最�的值�能出现多�情况,就是因为满足�了原�性。 - 上�4个�作中,i=2是读��作,必定是原�性�作,j=i你以为是原�性�作,其实�,分为两步,一是读�i的值,然��赋值给j,这就是2步�作了,称�上原��作,i++和i = i + 1其实是等效的,读�i的值,加1,�写回主存,那就是3步�作了。所以上�的举例中,最�的值�能出现多�情况,就是因为满足�了原�性。 - - JMM�能��对�个volatile��的读/写具有原�性,但类似于volatile++这�符��作�具有原�性,这时候就必须借助于synchronized和Lock���整�代�的原�性了。线程在释放�之�,必然会把i的值刷回到主存的。 +JMM�能��对�个volatile��的读/写具有原�性,但类似于volatile++这�符��作�具有原�性,这时候就必须借助于synchronized和Lock���整�代�的原�性了。线程在释放�之�,必然会把i的值刷回到主存的。 * ��性:��性指当一个线程修改了共享��的值,其他线程能够立�得知这个修改。Java内存模型是通过在��修改�将新值�步回主内存,在��读��从主内存刷新��值这��赖主内存作为传递媒介的方��实现��性。 - + * 无论是普通��还是volatile��,它们的区别是:volatile的特殊规则��了新值能立��步到主内存,以��次使用�立�从主内存刷新。因为,�以说volatile��了多线程�作时��的��性,而普通���能��这一点。 * 除了volatile之外,java中还有2个关键字能实现��性,�synchronized和final(final修饰的��,线程安全级别最高)。�步�的��性是由“对一个��执行unlock�作之�,必须先把此���步回主内存中(执行store,write�作)�这�规则获得;而final关键字的��性是指:被final修饰的字段在构造器中一旦�始化完�,并且构造器没有把“this�的引用传递出去(this引用逃逸是一件很�险的事,其他线程有�能通过这个引用访问到“�始化了一��的对象),那么在其他线程中就能看到final字段的值。 diff --git "a/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232\346\267\261\345\205\245\347\220\206\350\247\243Java\345\206\205\345\255\230\346\250\241\345\236\213JMM.md" "b/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232\346\267\261\345\205\245\347\220\206\350\247\243Java\345\206\205\345\255\230\346\250\241\345\236\213JMM.md" index a9aad6e..85043e2 100644 --- "a/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232\346\267\261\345\205\245\347\220\206\350\247\243Java\345\206\205\345\255\230\346\250\241\345\236\213JMM.md" +++ "b/docs/Java/concurrency/Java\345\271\266\345\217\221\346\214\207\345\215\227\357\274\232\346\267\261\345\205\245\347\220\206\350\247\243Java\345\206\205\345\255\230\346\250\241\345\236\213JMM.md" @@ -133,11 +133,6 @@ Java 内存模型是一�规范,定义了很多东西: * 线程对��的所有�作都必须在本地内存中进行,而�能直接读写主内存。 * ��的线程之间无法直接访问对方本地内存中的��。 -看文字太枯燥了,我�画了一张图: - - - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230404190315.png) ## 3.3\. 线程间通信 @@ -145,10 +140,6 @@ Java 内存模型是一�规范,定义了很多东西: 如果两个线程都对一个共享��进行�作,共享���始值为 1,�个线程都��进行加 1,预期共享��的值为 3。在 JMM 规范下会有一系列的�作。 - -![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/20230404190335.png) - - 为了更好的控制主内存和本地内存的交互,Java 内存模型定义了八��作�实现: * lock:�定。作用于主内存的��,把一个��标识为一�线程独�状�。 diff --git "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" index 963dace..9366f7b 100644 --- "a/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" +++ "b/docs/Spring\345\205\250\345\256\266\346\241\266/SpringBoot/SpringBoot\347\232\204Starter\346\234\272\345\210\266.md" @@ -1,29 +1,31 @@ starter是SpringBoot中的一个新�明,它有效的�低了项目开�过程的��程度,对于简化开��作有��常好的效果。本文转载了一片文章,详细介�了spring boot stater是什么?它的作用是什么? -Spring Boot Starter是在SpringBoot组件中被�出�的一�概念,stackoverflow上�已�有人概括了这个starter是什么东西,想看完整的回答戳[这里](https://stackoverflow.com/a/28273660)(https://stackoverflow.com/questions/28273543/what-are-spring-boot-starter-jars/28273660#28273660) +Spring Boot Starter是在SpringBoot组件中被�出�的一�概念,stackoverflow上�已�有人概括了这个starter是什么东西,想看完整的回答戳[这里](https://stackoverflow.com/a/28273660)([https://stackoverflow.com/questions/28273543/what-are-spring-boot-starter-jars/28273660#28273660)](https://stackoverflow.com/questions/28273543/what-are-spring-boot-starter-jars/28273660#28273660)) ![](https://images2018.cnblogs.com/blog/697611/201804/697611-20180409110042391-1447358002.png) 大概��就是说starter是一�对�赖的synthesize(��),这是什么��呢?我�以举个例��说明。 -###   ? 传统的�法 +### ? 传统的�法 在没有starter之�,�如我想�在Spring中使用jpa,那我�能需��以下�作: -1. 在Maven中引入使用的数�库的�赖(�JDBC的jar) -2. 引入jpa的�赖 -3. 在xxx.xml中�置一些属性信� -4. ��的调试直到�以正常�行 +1. 在Maven中引入使用的数�库的�赖(�JDBC的jar) +2. 引入jpa的�赖 +3. 在xxx.xml中�置一些属性信� +4. ��的调试直到�以正常�行 -需�注�的是,这里�作在我们**_�次新建一个需�用到jpa的项目的时候都需���的�一次_**。也许你在第一次自己建立项目的时候是在Google上自己�索了一番,花了�天时间解决掉了��奇怪的问题之�,jpa终于能正常�行了。有些有�验的人会在OneNote上�把这次建立项目的过程给记录下�,包括�作的步骤以�需�用到的�置文件的内容,在下一次�创建jpa项目的时候,就�需��次去Google了,�需�照�笔记�,之��把所有的�置文件copy&paste就�以了。 +需�注�的是,这里�作在我们***�次新建一个需�用到jpa的项目的时候都需���的�一次***。也许你在第一次自己建立项目的时候是在Google上自己�索了一番,花了�天时间解决掉了��奇怪的问题之�,jpa终于能正常�行了。有些有�验的人会在OneNote上�把这次建立项目的过程给记录下�,包括�作的步骤以�需�用到的�置文件的内容,在下一次�创建jpa项目的时候,就�需��次去Google了,�需�照�笔记�,之��把所有的�置文件copy&paste就�以了。 �上�这样的�作也�算�行,事实上我们在没有starter之�都是这么干的,但是这样�有几个问题: -1. 如果过程比较��,这样一步步�作会增加出错的�能性 -2. ��地copy&paste�符�[Don’t repeat yourself](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)精神 -3. 在第一次�置的时候(尤其如果开�者比较�白),需�花费掉大�的时间 +1. 如果过程比较��,这样一步步�作会增加出错的�能性 +2. ��地copy&paste�符�[Don’t repeat yourself](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)精神 +3. 在第一次�置的时候(尤其如果开�者比较�白),需�花费掉大�的时间 -###   使用Spring Boot Starter��效率 + + +### 使用Spring Boot Starter��效率 starter的主�目的就是为了解决上�的这些问题。 @@ -55,31 +57,30 @@ SpringBoot中的starter是一��常��的机制,能够抛弃以��� 其实自定义starter很简�,大致需�以下5步: -1. 新建两个模�,命�规范: springboot自带的starter命�规范为spring-boot-starter-xxx, 自定义的starter命�规范为xxx-spring-boot-starter +1. 新建两个模�,命�规范: springboot自带的starter命�规范为spring-boot-starter-xxx, 自定义的starter命�规范为xxx-spring-boot-starter � xxx-spring-boot-autoconfigure:自动�置核心代� � xxx-spring-boot-starter:管��赖 如果�需�将自动�置代�和�赖项管�分离开�,则�以将它们组�到一个模�中。��过springboot官方建议将两个模�分开。 -2\. 引入spring-boot-autoconfigure�赖 -3\. 创建自定义的XXXProperties 类: 这个类的属性根�需�是�出现在�置文件中的。 -4\. 创建自定义的XXXAutoConfiguration类:这个类��置自动�置时的一些逻辑,�时也�让XXXProperties 类生效。 -5\. 创建自定义的spring.factories文件:在resources/META-INF创建一个spring.factories文件和spring-configuration-metadata.json,spring-configuration-metadata.json文件是用于在填写�置文件时的智能�示,�����,有的��示起�更�好。spring.factories用于导入自动�置类,必须�有 +2 引入spring-boot-autoconfigure�赖 +3 创建自定义的XXXProperties 类: 这个类的属性根�需�是�出现在�置文件中的。 +4 创建自定义的XXXAutoConfiguration类:这个类��置自动�置时的一些逻辑,�时也�让XXXProperties 类生效。 +5 创建自定义的spring.factories文件:在resources/META-INF创建一个spring.factories文件和spring-configuration-metadata.json,spring-configuration-metadata.json文件是用于在填写�置文件时的智能�示,�����,有的��示起�更�好。spring.factories用于导入自动�置类,必须�有 ## 实现 我这里为了方便就�创建一个模�了, -1. 创建一个模�,命�为spring-boot-starter-my-starter,对应pom文件 +1. 创建一个模�,命�为spring-boot-starter-my-starter,对应pom文件 ``` com.example spring-boot-starter-my-starter 1.0 my-starter -�制代� ``` -1. 引入spring-boot-autoconfigure�赖 我这里使用的spring-boot-autoconfigure版本是2.6.2 +1. 引入spring-boot-autoconfigure�赖 我这里使用的spring-boot-autoconfigure版本是2.6.2 ``` @@ -89,10 +90,9 @@ SpringBoot中的starter是一��常��的机制,能够抛弃以��� 2.6.2 -�制代� ``` -1. 创建自定义的XXXProperties 类 +1. 创建自定义的XXXProperties 类 ``` @ConfigurationProperties(prefix = "com.arron") @@ -108,7 +108,6 @@ public class MyStarterProperties { this.name = name; } } -�制代� ``` �创建一个MyStarterConfig用于读�MyStarterProperties 里的属性 @@ -132,10 +131,9 @@ public class MyStarterConfig { this.name = name; } } -�制代� ``` -1. 创建自定义的XXXAutoConfiguration类 +1. 创建自定义的XXXAutoConfiguration类 ``` @Configuration @@ -153,16 +151,14 @@ public class MyStarterAutoConfiguration { } } -�制代� ``` -1. 在resources/META-INF创建一个spring.factories文件 +1. 在resources/META-INF创建一个spring.factories文件 spring.factories ``` org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.myStarter.MyStarterAutoConfiguration -�制代� ``` spring-configuration-metadata.json @@ -186,16 +182,17 @@ spring-configuration-metadata.json } ] } -�制代� ``` + + ## 打包测试 找到如图maven,点击install,安装到本地 ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/image-20230416200527082.png) 然�新建一个项目导包进行测试,创建项目过程就�介�了。 -1. 引入�赖 +1. 引入�赖 ``` @@ -203,19 +200,17 @@ spring-configuration-metadata.json spring-boot-starter-my-starter 1.0 -�制代� ``` -1. �置文件添加属性: +1. �置文件添加属性: ``` com: arron: name: myname -�制代� ``` -1. �元测试: +1. �元测试: ``` @RunWith(SpringRunner.class) @@ -230,14 +225,12 @@ class RabbitmqApplicationTests { System.out.println(name); } } -�制代� ``` 控制�输出: ``` myname -�制代� ``` 至此,一个简�自定义的springboot starter就完�了。 @@ -246,17 +239,14 @@ myname 下�这些注解在自定义starter是�能会用到。 -* @Conditional:按照一定的�件进行判断,满足�件给容器注册bean -* @ConditionalOnMissingBean:给定的在bean�存在时,则实例化当�Bean -* @ConditionalOnProperty:�置文件中满足定义的属性则创建bean,�则�创建 -* @ConditionalOnBean:给定的在bean存在时,则实例化当�Bean -* @ConditionalOnClass: 当给定的类�在类路径上存在,则实例化当�Bean -* @ConditionalOnMissingClass :当给定的类�在类路径上�存在,则实例化当�Bean - - +- @Conditional:按照一定的�件进行判断,满足�件给容器注册bean +- @ConditionalOnMissingBean:给定的在bean�存在时,则实例化当�Bean +- @ConditionalOnProperty:�置文件中满足定义的属性则创建bean,�则�创建 +- @ConditionalOnBean:给定的在bean存在时,则实例化当�Bean +- @ConditionalOnClass: 当给定的类�在类路径上存在,则实例化当�Bean +- @ConditionalOnMissingClass :当给定的类�在类路径上�存在,则实例化当�Bean 作者:索�� -链接:https://juejin.cn/post/7127468724046528525 +链接:[https://juejin.cn/post/7127468724046528525](https://juejin.cn/post/7127468724046528525) ��:稀土掘金 -著作�归作者所有。商业转载请�系作者获得授�,�商业转载请注明出处。 - +著作�归作者所有。商业转载请�系作者获得授�,�商业转载请注明出处。 \ No newline at end of file diff --git "a/docs/database/\351\207\215\346\226\260\345\255\246\344\271\240MySQL\346\225\260\346\215\256\345\272\223\357\274\232\344\273\216\345\256\236\350\267\265sql\350\257\255\345\217\245\344\274\230\345\214\226\345\274\200\345\247\213.md" "b/docs/database/\351\207\215\346\226\260\345\255\246\344\271\240MySQL\346\225\260\346\215\256\345\272\223\357\274\232\344\273\216\345\256\236\350\267\265sql\350\257\255\345\217\245\344\274\230\345\214\226\345\274\200\345\247\213.md" index f3bd6d8..9aef75b 100644 --- "a/docs/database/\351\207\215\346\226\260\345\255\246\344\271\240MySQL\346\225\260\346\215\256\345\272\223\357\274\232\344\273\216\345\256\236\350\267\265sql\350\257\255\345\217\245\344\274\230\345\214\226\345\274\200\345\247\213.md" +++ "b/docs/database/\351\207\215\346\226\260\345\255\246\344\271\240MySQL\346\225\260\346\215\256\345\272\223\357\274\232\344\273\216\345\256\236\350\267\265sql\350\257\255\345\217\245\344\274\230\345\214\226\345\274\200\345\247\213.md" @@ -1,29 +1,28 @@ # 目录 -* [字段](#字段) -* [索引](#索引) -* [查询SQL](#查询sql) -* [引擎](#引擎) - * [MyISAM](#myisam) - * [InnoDB](#innodb) - * [0�自己写的海�数�sql优化实践](#0�自己写的海�数�sql优化实践) -* [mysql百万级分页优化](#mysql百万级分页优化) - * [普通分页](#普通分页) - * [优化分页](#优化分页) -* [总结](#总结) - +- [字段](#字段) +- [索引](#索引) +- [查询SQL](#查询sql) +- [引擎](#引擎) + - [MyISAM](#myisam) + - [InnoDB](#innodb) + - [0�自己写的海�数�sql优化实践](#0�自己写的海�数�sql优化实践) +- [mysql百万级分页优化](#mysql百万级分页优化) + - [普通分页](#普通分页) + - [优化分页](#优化分页) +- [总结](#总结) 本文转自互�网 本系列文章将整�到我在GitHub上的《Java�试指�》仓库,更多精彩内容请到我的仓库里查看 -> https://github.com/h2pl/Java-Tutorial +> [https://github.com/h2pl/Java-Tutorial](https://github.com/h2pl/Java-Tutorial) 喜欢的�麻烦点下Star哈 本也将整�到我的个人�客: -> www.how2playlife.com +> [www.how2playlife.com](http://www.how2playlife.com) 更多Java技术文章将陆续在微信公众��Java技术江湖】更新,敬请关注。 @@ -33,70 +32,55 @@ 如果对本系列文章有什么建议,或者是有什么疑问的�,也�以关注公众��Java技术江湖】�系作者,欢迎你�与本系列�文的创作和修订。 - - +--- -除��表数�未�会一直�断上涨,�则��一开始就考虑拆分,拆分会带�逻辑�部署��维的����度,一般以整型值为主的表在`�万级`以下,字符串为主的表在`五百万`以下是没有太大问题的。而事实上很多时候MySQL�表的性能�然有�少优化空间,甚至能正常支撑�万级以上的数��: - -## 字段 -* 尽�使用`TINYINT`�`SMALLINT`�`MEDIUM_INT`作为整数类型而�`INT`,如果�负则加上`UNSIGNED` -* `VARCHAR`的长度�分�真正需�的空间 +# 正文 -* 使用枚举或整数代替字符串类型 +除��表数�未�会一直�断上涨,�则��一开始就考虑拆分,拆分会带�逻辑�部署��维的����度,一般以整型值为主的表在`�万级`以下,字符串为主的表在`五百万`以下是没有太大问题的。而事实上很多时候MySQL�表的性能�然有�少优化空间,甚至能正常支撑�万级以上的数�� -* 尽�使用`TIMESTAMP`而�`DATETIME`, +## 字段 -* �表��有太多字段,建议在20以内 +- 尽�使用`TINYINT`�`SMALLINT`�`MEDIUM_INT`作为整数类型而�`INT`,如果�负则加上`UNSIGNED` +- `VARCHAR`的长度�分�真正需�的空间 +- 使用枚举或整数代替字符串类型 +- 尽�使用`TIMESTAMP`而�`DATETIME`, +- �表��有太多字段,建议在20以内 +- ��使用NULL字段,很难查询优化且�用�外索引空间 +- 用整型�存IP -* ��使用NULL字段,很难查询优化且�用�外索引空间 -* 用整型�存IP ## 索引 -* 索引并�是越多越好,�根�查询有针对性的创建,考虑在`WHERE`和`ORDER BY`命令上涉�的列建立索引,�根�`EXPLAIN`�查看是�用了索引还是全表扫� - -* 应尽���在`WHERE`��中对字段进行`NULL`值判断,�则将导致引擎放弃使用索引而进行全表扫� - -* 值分布很稀少的字段�适�建索引,例如"性别"这��有两三个值的字段 - -* 字符字段�建�缀索引 +- 索引并�是越多越好,�根�查询有针对性的创建,考虑在`WHERE`和`ORDER BY`命令上涉�的列建立索引,�根�`EXPLAIN`�查看是�用了索引还是全表扫� +- 应尽���在`WHERE`��中对字段进行`NULL`值判断,�则将导致引擎放弃使用索引而进行全表扫� +- 值分布很稀少的字段�适�建索引,例如"性别"这��有两三个值的字段 +- 字符字段�建�缀索引 +- 字符字段最好���主键 +- �用外键,由程���约� +- 尽��用`UNIQUE`,由程���约� +- 使用多列索引时主�顺�和查询�件��一致,�时删除�必�的�列索引 -* 字符字段最好���主键 -* �用外键,由程���约� - -* 尽��用`UNIQUE`,由程���约� - -* 使用多列索引时主�顺�和查询�件��一致,�时删除�必�的�列索引 ## 查询SQL -* �通过开�慢查询日志�找出较慢的SQL - -* ��列�算:`SELECT id WHERE age + 1 = 10`,任何对列的�作都将导致表扫�,它包括数�库教程函数�计算表达�等等,查询时�尽�能将�作移至等��边 - -* sql语�尽�能简�:一�sql�能在一个cpu�算;大语�拆�语�,�少�时间;一�大sql�以堵死整个库 - -* �用`SELECT *` - -* `OR`改写�`IN`:`OR`的效率是n级别,`IN`的效率是log(n)级别,in的个数建议控制在200以内 - -* �用函数和触�器,在应用程�实现 +- �通过开�慢查询日志�找出较慢的SQL +- ��列�算:`SELECT id WHERE age + 1 = 10`,任何对列的�作都将导致表扫�,它包括数�库教程函数�计算表达�等等,查询时�尽�能将�作移至等��边 +- sql语�尽�能简�:一�sql�能在一个cpu�算;大语�拆�语�,�少�时间;一�大sql�以堵死整个库 +- �用`SELECT *` +- `OR`改写�`IN`:`OR`的效率是n级别,`IN`的效率是log(n)级别,in的个数建议控制在200以内 +- �用函数和触�器,在应用程�实现 +- ��`%xxx`�查询 +- 少用`JOIN` +- 使用�类型进行比较,比如用`'123'`和`'123'`比,`123`和`123`比 +- 尽���在`WHERE`��中使用!=或<>�作符,�则将引擎放弃使用索引而进行全表扫� +- 对于连续数值,使用`BETWEEN`�用`IN`:`SELECT id FROM t WHERE num BETWEEN 1 AND 5` +- 列表数���拿全表,�使用`LIMIT`�分页,�页数�也��太大 -* ��`%xxx`�查询 -* 少用`JOIN` - -* 使用�类型进行比较,比如用`'123'`和`'123'`比,`123`和`123`比 - -* 尽���在`WHERE`��中使用!=或<>�作符,�则将引擎放弃使用索引而进行全表扫� - -* 对于连续数值,使用`BETWEEN`�用`IN`:`SELECT id FROM t WHERE num BETWEEN 1 AND 5` - -* 列表数���拿全表,�使用`LIMIT`�分页,�页数�也��太大 ## 引擎 @@ -106,35 +90,26 @@ MyISAM引擎是MySQL 5.1�之�版本的默认引擎,它的特点是: -* �支�行�,读�时对需�读到的所有表加�,写入时则对表加排它� - -* �支�事务 - -* �支�外键 - -* �支�崩溃�的安全�� - -* 在表有读�查询的�时,支�往表中�入新纪录 +- �支�行�,读�时对需�读到的所有表加�,写入时则对表加排它� +- �支�事务 +- �支�外键 +- �支�崩溃�的安全�� +- 在表有读�查询的�时,支�往表中�入新纪录 +- 支�`BLOB`和`TEXT`的�500个字符索引,支�全文索引 +- 支�延迟更新索引,�大��写入性能 +- 对于�会进行修改的表,支�压缩表,�大�少�盘空间�用 -* 支�`BLOB`和`TEXT`的�500个字符索引,支�全文索引 -* 支�延迟更新索引,�大��写入性能 - -* 对于�会进行修改的表,支�压缩表,�大�少�盘空间�用 ### InnoDB InnoDB在MySQL 5.5��为默认索引,它的特点是: -* 支�行�,采用MVCC�支�高并� - -* 支�事务 - -* 支�外键 - -* 支�崩溃�的安全�� - -* �支�全文索引 +- 支�行�,采用MVCC�支�高并� +- 支�事务 +- 支�外键 +- 支�崩溃�的安全�� +- �支�全文索引 总体�讲,MyISAM适�`SELECT`密集型的表,而InnoDB适�`INSERT`和`UPDATE`密集型的表 @@ -146,99 +121,181 @@ InnoDB在MySQL 5.5��为默认索引,它的特点是: > 有时候我们需�对大数�进行测试,本地一般没有那么多数�,就需�我们自己生�一些。下�会借助内存表的特点进行生�百万�测试数�。 -1. 创建一个临时内存表, �数��入的时候会比较快些 +1. 创建一个临时内存表, �数��入的时候会比较快些 SQL -``` --- 创建一个临时内存表DROP TABLE IF EXISTS `vote_record_memory`;CREATE TABLE `vote_record_memory` ( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `user_id` varchar(20) NOT NULL DEFAULT '', `vote_num` int(10) unsigned NOT NULL DEFAULT '0', `group_id` int(10) unsigned NOT NULL DEFAULT '0', `status` tinyint(2) unsigned NOT NULL DEFAULT '1', `create_time` datetime NOT NULL DEFAULT '0000-00-00 00:00:00', PRIMARY KEY (`id`), KEY `index_user_id` (`user_id`) USING HASH) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8; +```sql +DROP TABLE IF EXISTS `vote_record_memory`; +CREATE TABLE vote_record_memory ( + id int unsigned NOT NULL AUTO_INCREMENT, + user_id varchar(20) NOT NULL DEFAULT '', + vote_num int unsigned NOT NULL DEFAULT '0', + group_id int unsigned NOT NULL DEFAULT '0', + status tinyint unsigned NOT NULL DEFAULT '1', + create_time datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY (id), + KEY index_user_id (user_id) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; ``` -1. -- 创建一个普通表,用作模拟大数�的测试用例 +1. 创建一个普通表,用作模拟大数�的测试用例 SQL -``` -DROP TABLE IF EXISTS `vote_record`;CREATE TABLE `vote_record` ( `id` int(10) unsigned NOT NULL AUTO_INCREMENT, `user_id` varchar(20) NOT NULL DEFAULT '' COMMENT '用户Id', `vote_num` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '投票数', `group_id` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '用户组id 0-未激活用户 1-普通用户 2-vip用户 3-管�员用户', `status` tinyint(2) unsigned NOT NULL DEFAULT '1' COMMENT '状� 1-正常 2-已删除', `create_time` int(10) unsigned NOT NULL DEFAULT '0000-00-00 00:00:00' COMMENT '创建时间', PRIMARY KEY (`id`), KEY `index_user_id` (`user_id`) USING HASH COMMENT '用户ID哈希索引') ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='投票记录表'; +```sql +DROP TABLE IF EXISTS `vote_record`; +CREATE TABLE vote_record ( + id int unsigned NOT NULL AUTO_INCREMENT, + user_id varchar(20) NOT NULL DEFAULT '', + vote_num int unsigned NOT NULL DEFAULT '0', + group_id int unsigned NOT NULL DEFAULT '0', + status tinyint unsigned NOT NULL DEFAULT '1', + create_time datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY (id), + KEY index_user_id (user_id) +) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; ``` -1. 为了数�的�机性和真实性,我们需�创建一个�生�长度为n的�机字符串的函数。 +1. 为了数�的�机性和真实性,我们需�创建一个�生�长度为 n 的�机字符串的函数。 SQL -``` --- 创建生�长度为n的�机字符串的函数DELIMITER // -- 修改MySQL delimiter:'//'DROP FUNCTION IF EXISTS `rand_string` //SET NAMES utf8 //CREATE FUNCTION `rand_string` (n INT) RETURNS VARCHAR(255) CHARSET 'utf8'BEGIN DECLARE char_str varchar(100) DEFAULT 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'; DECLARE return_str varchar(255) DEFAULT ''; DECLARE i INT DEFAULT 0; WHILE i < n DO SET return_str = concat(return_str, substring(char_str, FLOOR(1 + RAND()*62), 1)); SET i = i+1; END WHILE; RETURN return_str;END // -``` - -1. 为了�作方便,我们�创建一个�入数�的存储过程 +```sql +-- 创建生�长度为 n 的�机字符串的函数 +-- 修改 MySQL delimiter 为 '//' +DELIMITER // +DROP FUNCTION IF EXISTS rand_string // +CREATE FUNCTION rand_string(n INT) +RETURNS VARCHAR(255) CHARSET utf8 +NO SQL +BEGIN + DECLARE char_str varchar(100) DEFAULT 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'; + DECLARE return_str varchar(255) DEFAULT ''; + DECLARE i INT DEFAULT 0; + WHILE i < n DO + SET return_str = concat(return_str, substring(char_str, FLOOR(1 + RAND() * 62), 1)); + SET i = i + 1; + END WHILE; + RETURN return_str; +END // +``` + +1. 为了�作方便,我们�创建一个�入数�的存储过程。 SQL -``` --- 创建�入数�的存储过程DROP PROCEDURE IF EXISTS `add_vote_record_memory` //CREATE PROCEDURE `add_vote_record_memory`(IN n INT)BEGIN DECLARE i INT DEFAULT 1; DECLARE vote_num INT DEFAULT 0; DECLARE group_id INT DEFAULT 0; DECLARE status TINYINT DEFAULT 1; WHILE i < n DO SET vote_num = FLOOR(1 + RAND() * 10000); SET group_id = FLOOR(0 + RAND()*3); SET status = FLOOR(1 + RAND()*2); INSERT INTO `vote_record_memory` VALUES (NULL, rand_string(20), vote_num, group_id, status, NOW()); SET i = i + 1; END WHILE;END //DELIMITER ; -- 改回默认的 MySQL delimiter:';' -``` - -1. 开始执行存储过程,等待生�数�(10W�生�大约需�40分钟) +```sql +-- 创建�入数�的存储过程 +-- 此时 delimiter �是 '//' +DROP PROCEDURE IF EXISTS add_vote_record_memory // +CREATE PROCEDURE add_vote_record_memory(IN n INT) +BEGIN + DECLARE i INT DEFAULT 1; + DECLARE vote_num INT DEFAULT 0; + DECLARE group_id INT DEFAULT 0; + DECLARE status TINYINT DEFAULT 1; + WHILE i < n DO + SET vote_num = FLOOR(1 + RAND() * 10000); + SET group_id = FLOOR(0 + RAND() * 3); + SET status = FLOOR(1 + RAND() * 2); + INSERT INTO vote_record_memory + VALUES (NULL, rand_string(20), vote_num, group_id, status, NOW()); + SET i = i + 1; + END WHILE; +END // +DELIMITER ; -- 改回默认的 MySQL delimiter:';' +``` + +1. 开始执行存储过程,等待生�数�(10 万�大约需� 40 分钟)。 SQL -``` --- 调用存储过程 生�100W�数�CALL add_vote_record_memory(1000000); +```sql +-- 调用存储过程,生� 10 万�数� +CALL add_vote_record_memory(100000); ``` -1. 查询内存表已生�记录(为了下步测试,目�仅生�了105645�) +1. 查询内存表已生�记录(为了下步测试,当时仅生�了 105645 �)。 SQL -``` -SELECT count(*) FROM `vote_record_memory`;-- count(*)-- 105646 +```sql +SELECT count(*) FROM vote_record_memory; +-- count(*) +-- 105646 ``` -1. 把数�从内存表�入到普通表中(10w�数�13s就�入完了) +1. 把数�从内存表�入到普通表中(10 万�大约 13 秒)。 SQL -``` -INSERT INTO vote_record SELECT * FROM `vote_record_memory`; +```sql +INSERT INTO vote_record +SELECT * FROM vote_record_memory; ``` -1. 查询普通表已的生�记录 +1. 查询普通表已生�的记录。 SQL -``` -SELECT count(*) FROM `vote_record`;-- count(*)-- 105646 +```sql +SELECT count(*) FROM vote_record; +-- count(*) +-- 105646 ``` -1. 如果一次性�入普通表太慢,�以分批�入,这就需�写个存储过程了: +1. 如果一次性�入普通表太慢,�以分批�入,这就需��写一个存储过程。 SQL -``` --- �数n是�次��入的�数-- lastid是已导入的最大idCREATE PROCEDURE `copy_data_from_tmp`(IN n INT)BEGIN DECLARE lastid INT DEFAULT 0; SELECT MAX(id) INTO lastid FROM `vote_record`; INSERT INTO `vote_record` SELECT * FROM `vote_record_memory` where id > lastid LIMIT n;END +```sql +-- �数 n 是�次��入的�数 +-- lastid 是已导入的最大 id +DELIMITER // +CREATE PROCEDURE copy_data_from_tmp(IN n INT) +BEGIN + DECLARE lastid INT DEFAULT 0; + SELECT MAX(id) INTO lastid FROM vote_record; + INSERT INTO vote_record + SELECT * FROM vote_record_memory + WHERE id > lastid + LIMIT n; +END// +DELIMITER ; ``` -1. 调用存储过程: +1. 调用存储过程。 SQL -``` --- 调用存储过程 �入60w�CALL copy_data_from_tmp(600000); +```sql +-- 调用存储过程,�入 6 万� +CALL copy_data_from_tmp(60000); ``` -SELECT * FROM vote_record; +```sql +SELECT * FROM vote_record; +``` 全表查询 建完表以�开�慢查询日志,具体�考下�的例�,然�学会用explain。windows慢日志的�置在c盘,�外,使用client工具也�以记录慢日志,所以�一定�用命令行�执行测试,�则大表数�在命令行中�显示的�常久。 -**1 全表扫�select * from vote_record** +**1. 全表扫�** + +```sql +SELECT * FROM vote_record; +``` -* * * +--- **慢日志** -SET timestamp=1529034398; select * from vote_record; +```sql +SET timestamp = 1529034398; +SELECT * FROM vote_record; +``` Time: 2018-06-15T03:52:58.804850Z @@ -250,75 +307,78 @@ Query_time: 3.166424 Lock_time: 0.000000 Rows_sent: 900500 Rows_examined: 999999 **explain执行计划** -```` -id select_type table partitions type possible_keys key key_len ref rows filtered Extra - -1 SIMPLE vote_record \N ALL \N \N \N \N 996507 100.00 \N -```` +```text +id select_type table partitions type possible_keys key key_len ref rows filtered Extra +1 SIMPLE vote_record \N ALL \N \N \N \N 996507 100.00 \N +``` 全表扫�耗时3秒多,用�到索引。 -```` -**2 select * from vote_record where vote_num > 1000** -```` +**2.** `vote_num` **大于 1000,此时还没有索引** + +```sql +SELECT * FROM vote_record WHERE vote_num > 1000; +``` -没有索引,所以相当于全表扫�,一样是3.5秒左� +没有索引,所以相当于全表扫�,一样是3.5秒左�。 -```` -**3 select * from vote_record where vote_num > 1000** -```` +**3. 加上** `vote_num` **索引��查�一�** -**加索引create** +```sql +CREATE INDEX vote ON vote_record(vote_num); +``` -```` -**CREATE INDEX vote ON vote_record(vote_num);** -```` +```sql +SELECT * FROM vote_record WHERE vote_num > 1000; +``` **explain查看执行计划** -```` -id select_type table partitions type possible_keys key key_len ref rows filtered Extra - -1 SIMPLE vote_record \N ALL votenum,vote \N \N \N 996507 50.00 Using where -```` +```text +id select_type table partitions type possible_keys key key_len ref rows filtered Extra +1 SIMPLE vote_record \N ALL votenum,vote \N \N \N 996507 50.00 Using where +``` -还是没用到索引,因为�符�最左�缀匹�。查询需�3.5秒左� +还是没用到索引,因为�符�最左�缀匹�。查询需�3.5秒左�。 -最�修改一下sql语� +最�修改一下sql语�: -```` +```sql EXPLAIN SELECT * FROM vote_record WHERE id > 0 AND vote_num > 1000; +``` -id select_type table partitions type possible_keys key key_len ref rows filtered Extra - -1 SIMPLE vote_record \N range PRIMARY,votenum,vote PRIMARY 4 \N 498253 50.00 Using where -```` +```text +id select_type table partitions type possible_keys key key_len ref rows filtered Extra +1 SIMPLE vote_record \N range PRIMARY,votenum,vote PRIMARY 4 \N 498253 50.00 Using where +``` -用到了索引,但是�用到了主键索引。�修改一次 +用到了索引,但是�用到了主键索引。�修改一次: -```` +```sql EXPLAIN SELECT * FROM vote_record WHERE id > 0 AND vote_num = 1000; +``` -id select_type table partitions type possible_keys key key_len ref rows filtered Extra - -1 SIMPLE vote_record \N index_merge PRIMARY,votenum,vote votenum,PRIMARY 8,4 \N 51 100.00 Using intersect(votenum,PRIMARY); Using where -```` +```text +id select_type table partitions type possible_keys key key_len ref rows filtered Extra +1 SIMPLE vote_record \N index_merge PRIMARY,votenum,vote votenum,PRIMARY 8,4 \N 51 100.00 Using intersect(votenum,PRIMARY); Using where +``` -用到了两个索引,votenum,PRIMARY。 +用到了两个索引,votenum�PRIMARY。 这是为什么呢。 -�看一个语� +�看一个语�: -```` -EXPLAIN SELECT * FROM vote_record WHERE id = 1000 AND vote_num > 1000 - -id select_type table partitions type possible_keys key key_len ref rows filtered Extra +```sql +EXPLAIN SELECT * FROM vote_record WHERE id = 1000 AND vote_num > 1000; +``` -1 SIMPLE vote_record \N const PRIMARY,votenum PRIMARY 4 const 1 100.00 \N -```` +```text +id select_type table partitions type possible_keys key key_len ref rows filtered Extra +1 SIMPLE vote_record \N const PRIMARY,votenum PRIMARY 4 const 1 100.00 \N +``` -也�有主键用到了索引。这是因为�有最左�缀索引�以用>或<,其他索引用<或者>会导致用�到索引。 +也�有主键用到了索引。这是因为�有最左�缀索引�以用大于或�于,其他索引上的范围�件会导致用�到索引。 下�是几个网上�考的例�: @@ -328,27 +388,40 @@ id select_type table partitions type possible_keys key key_len ref rows filtered 步骤1:设置慢查询日志的超时时间,先查看日志存放路径查询慢日志的地�,因为有慢查询的内容,就会到这个日志中: -show global variables like "%slow%"; +```sql +SHOW GLOBAL VARIABLES LIKE '%slow%'; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/318ac710c3fcf1b293f4a280bbb4642a951.jpg) 2.开�慢查询日志 -set global slow_query_log=on; +```sql +SET GLOBAL slow_query_log = ON; +``` 3.查看慢查询日志的设置时间,是�是自己需�的 -show global variables like "%long%"; +```sql +SHOW GLOBAL VARIABLES LIKE '%long%'; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/25c18a8fbb6cc43a48b554bde844191d75d.jpg) 4.如果�是自己想的时间,修改慢查询时间,��超过了以下的设置时间,查询的日志就会到刚刚的日志中,我设置查询时间超过1S就进入到慢查询日志中 -set global long_query_time=1; +```sql +SET GLOBAL long_query_time = 1; +``` 5.大数�已准备,进行数�的查询,xshell最好开两个窗�,一个查看日志,一个执行内容 -Sql查询语�:select sql_no_cache * from employees_tmp where first_name='Duangkaew' and gender='M' +```sql +SELECT SQL_NO_CACHE * +FROM employees_tmp +WHERE first_name = 'Duangkaew' + AND gender = 'M'; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/19fa580673fef04c767680a8010c444b786.jpg) @@ -374,9 +447,13 @@ Sql查询语�:select sql_no_cache * from employees_tmp where first_name='Dua 6.执行打�计划,主�是查看是�使用了索引等其他内容,主�就是在sql��加上explain 关键字 -```` -explain select sql_no_cache * from employees_tmp where first_name='Duangkaew' and gender='M'; -```` +```sql +EXPLAIN +SELECT SQL_NO_CACHE * +FROM employees_tmp +WHERE first_name = 'Duangkaew' + AND gender = 'M'; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/c15fd4c1db312050661a019557401f4b1cf.jpg) @@ -384,9 +461,9 @@ explain select sql_no_cache * from employees_tmp where first_name='Duangkaew' an 7.进行sql优化,建一个fist_name的索引,索引就是将你需�的数�先给筛选出�,这样就�以节�很多扫�时间 -```` -create index firstname on employees_tmp(first_name); -```` +```sql +CREATE INDEX firstname ON employees_tmp(first_name); +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/325f92967bec30c8fcec3376725d21ea9ad.jpg) @@ -394,17 +471,22 @@ create index firstname on employees_tmp(first_name); 8.查看建立的索引 -```` -show index from employees_tmp; -```` +```sql +SHOW INDEX FROM employees_tmp; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/240bdc203ec8db9c4e2f9a1715816dcf928.jpg) 9.在执行查询语�,查看语�的执行时间 -```` -select sql_no_cache * from employees_tmp where first_name='Duangkaew' and gender='M' -```` +```sql +SELECT SQL_NO_CACHE * +FROM employees_tmp +WHERE first_name = 'Duangkaew' + AND gender = 'M'; +``` + + ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/addc98d4a52648e09b8c29f773865cf00ba.jpg) @@ -412,33 +494,35 @@ select sql_no_cache * from employees_tmp where first_name='Duangkaew' and gender 10.删除已�有的索引,删除索引: -```` -drop index first_name on employees_tmp; -```` +```sql +DROP INDEX first_name ON employees_tmp; +``` 11.创建性别的索引(性别是�怎么好的索引方�,因为有很多��数�) -```` -create index index_gendar on employees_tmp(gender); -```` +```sql +CREATE INDEX index_gendar ON employees_tmp(gender); +``` 在执行sql语�查询数�,查看查询执行时间,没有创建比较优秀的索引,导致查询时间还�长了, -为嘛还�长了,这个我没有弄懂 - ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/d043c97d87b9fa6eb65f17b281db14d4df8.jpg) 12.我们在试试使用创建组�索引,使用性别和姓� -```` -alter table employees_tmp add index idx_union (first_name,gender); -```` +```sql +ALTER TABLE employees_tmp +ADD INDEX idx_union (first_name, gender); +``` 在执行sql查看sql数�的执行时间 -```` -select sql_no_cache * from employees_tmp where first_name='Duangkaew' and gender='M' -```` +```sql +SELECT SQL_NO_CACHE * +FROM employees_tmp +WHERE first_name = 'Duangkaew' + AND gender = 'M'; +``` 速度��了N多�啊 @@ -446,9 +530,9 @@ select sql_no_cache * from employees_tmp where first_name='Duangkaew' and gender 查看创建的索引 -```` -show index from employees_tmp; -```` +```sql +SHOW INDEX FROM employees_tmp; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/9704ee337b205ce64e31dbe4c12af495c5b.jpg) @@ -464,24 +548,35 @@ show index from employees_tmp; 课程表 -``` -create table Course( c_id int PRIMARY KEY, name varchar(10) ) +```sql +CREATE TABLE Course ( + c_id int PRIMARY KEY, + name varchar(10) +); ``` 数�100� 学生表: -``` -create table Student( id int PRIMARY KEY, name varchar(10) ) +```sql +CREATE TABLE Student ( + id int PRIMARY KEY, + name varchar(10) +); ``` 数�70000� 学生�绩表SC -``` -CREATE table SC( sc_id int PRIMARY KEY, s_id int, c_id int, score int ) +```sql +CREATE TABLE SC ( + sc_id int PRIMARY KEY, + s_id int, + c_id int, + score int +); ``` 数�70w� @@ -492,17 +587,31 @@ CREATE table SC( sc_id int PRIMARY KEY, s_id int, c_id int, scor 查询语�: -``` -select s.* from Student s where s.s_id in (select s_id from SC sc where sc.c_id = 0 and sc.score = 100 ) - +```sql +SELECT s.* +FROM Student s +WHERE s.s_id IN ( + SELECT s_id + FROM SC sc + WHERE sc.c_id = 0 + AND sc.score = 100 +); ``` 执行时间:30248.271s 晕,为什么这么慢,先�查看下查询计划: -``` -EXPLAIN select s.* from Student s where s.s_id in (select s_id from SC sc where sc.c_id = 0 and sc.score = 100 ) +```sql +EXPLAIN +SELECT s.* +FROM Student s +WHERE s.s_id IN ( + SELECT s_id + FROM SC sc + WHERE sc.c_id = 0 + AND sc.score = 100 +); ``` ![image](http://static.codeceo.com/images/2015/04/d70d7123827c0d988fdc69074a97105b.png "image") @@ -511,14 +620,12 @@ EXPLAIN select s.* from Student s where s.s_id in (select s_id from SC sc where 先给sc表的c_id和score建个索引 +```sql +CREATE INDEX sc_c_id_index ON SC(c_id); ``` -CREATE index sc_c_id_index on SC(c_id); - -``` - -``` -CREATE index sc_score_index on SC(score); +```sql +CREATE INDEX sc_score_index ON SC(score); ``` �次执行上述查询语�,时间为: 1.054s @@ -529,11 +636,23 @@ CREATE index sc_score_index on SC(score); 但是1s的时间还是太长了,还能进行优化�,仔细看执行计划: - 查看优化�的sql: -``` -SELECT `YSB`.`s`.`s_id` AS `s_id`, `YSB`.`s`.`name` AS `name`FROM `YSB`.`Student` `s`WHERE < in_optimizer > ( `YSB`.`s`.`s_id` ,< EXISTS > ( SELECT 1 FROM `YSB`.`SC` `sc` WHERE ( (`YSB`.`sc`.`c_id` = 0) AND (`YSB`.`sc`.`score` = 100) AND ( < CACHE > (`YSB`.`s`.`s_id`) = `YSB`.`sc`.`s_id` ) ) ) ) +```sql +SELECT + `YSB`.`s`.`s_id` AS `s_id`, + `YSB`.`s`.`name` AS `name` +FROM `YSB`.`Student` `s` +WHERE IN_OPTIMIZER( + `YSB`.`s`.`s_id`, + EXISTS ( + SELECT 1 + FROM `YSB`.`SC` `sc` + WHERE `YSB`.`sc`.`c_id` = 0 + AND `YSB`.`sc`.`score` = 100 + AND CACHE(`YSB`.`s`.`s_id`) = `YSB`.`sc`.`s_id` + ) +); ``` 补充:这里有网�问怎么查看优化�的语� @@ -546,18 +665,21 @@ SELECT `YSB`.`s`.`s_id` AS `s_id`, `YSB`.`s`.`name` AS `name`FROM `YSB` 按照我之�的想法,该sql的执行的顺�应该是先执行�查询 -``` -select s_id from SC sc where sc.c_id = 0 and sc.score = 100 - +```sql +SELECT s_id +FROM SC sc +WHERE sc.c_id = 0 + AND sc.score = 100; ``` 耗时:0.001s 然��执行 -``` -select s.* from Student s where s.s_id in(7,29,5000) - +```sql +SELECT s.* +FROM Student s +WHERE s.s_id IN (7, 29, 5000); ``` 耗时:0.001s @@ -568,8 +690,12 @@ mysql是先执行外层查询,�执行里层的查询,这样就�循环700 那么改用连接查询呢? -``` -SELECT s.* from Student s INNER JOIN SC sc on sc.s_id = s.s_id where sc.c_id=0 and sc.score=100 +```sql +SELECT s.* +FROM Student s +INNER JOIN SC sc ON sc.s_id = s.s_id +WHERE sc.c_id = 0 + AND sc.score = 100; ``` 这里为了�新分�连接查询的情况,先暂时删除索引sc_c_id_index,sc_score_index @@ -580,9 +706,13 @@ SELECT s.* from Student s INNER JOIN SC sc on sc.s_id = s.s_id where sc.c_id=0 这里有连表的情况出现,我猜想是�是�给sc表的s_id建立个索引 -CREATE index sc_s_id_index on SC(s_id); +```sql +CREATE INDEX sc_s_id_index ON SC(s_id); +``` -show index from SC +```sql +SHOW INDEX FROM SC; +``` 在执行连接查询 @@ -590,8 +720,15 @@ show index from SC 优化�的查询语�为: -``` -SELECT `YSB`.`s`.`s_id` AS `s_id`, `YSB`.`s`.`name` AS `name`FROM `YSB`.`Student` `s`JOIN `YSB`.`SC` `sc`WHERE ( ( `YSB`.`sc`.`s_id` = `YSB`.`s`.`s_id` ) AND (`YSB`.`sc`.`score` = 100) AND (`YSB`.`sc`.`c_id` = 0) ) +```sql +SELECT + `YSB`.`s`.`s_id` AS `s_id`, + `YSB`.`s`.`name` AS `name` +FROM `YSB`.`Student` `s` +JOIN `YSB`.`SC` `sc` +WHERE `YSB`.`sc`.`s_id` = `YSB`.`s`.`s_id` + AND `YSB`.`sc`.`score` = 100 + AND `YSB`.`sc`.`c_id` = 0; ``` 貌似是先�的连接查询,�执行的where过滤 @@ -600,13 +737,19 @@ SELECT `YSB`.`s`.`s_id` AS `s_id`, `YSB`.`s`.`name` AS `name`FROM `YSB` 这里是先�的where过滤,��连表,执行计划还�是固定的,那么我们先看下标准的sql执行顺�: - 正常情况下是先join�where过滤,但是我们这里的情况,如果先join,将会有70w�数���join��,因此先执行where 过滤是明智方案,现在为了排除mysql的查询优化,我自己写一�优化�的sql -``` -SELECT s.*FROM ( SELECT * FROM SC sc WHERE sc.c_id = 0 AND sc.score = 100 ) tINNER JOIN Student s ON t.s_id = s.s_id +```sql +SELECT s.* +FROM ( + SELECT * + FROM SC sc + WHERE sc.c_id = 0 + AND sc.score = 100 +) t +INNER JOIN Student s ON t.s_id = s.s_id; ``` �先执行sc表的过滤,�进行表连接,执行时间为:0.054s @@ -617,20 +760,25 @@ SELECT s.*FROM ( SELECT * FROM SC sc 先��sc�连表,这样效率就高多了,现在的问题是��sc的时候出现了扫�表,那么现在�以明确需�建立相关索引 +```sql +CREATE INDEX sc_c_id_index ON SC(c_id); ``` -CREATE index sc_c_id_index on SC(c_id); - -``` - -``` -CREATE index sc_score_index on SC(score); +```sql +CREATE INDEX sc_score_index ON SC(score); ``` �执行查询: -``` -SELECT s.*FROM ( SELECT * FROM SC sc WHERE sc.c_id = 0 AND sc.score = 100 ) tINNER JOIN Student s ON t.s_id = s.s_id +```sql +SELECT s.* +FROM ( + SELECT * + FROM SC sc + WHERE sc.c_id = 0 + AND sc.score = 100 +) t +INNER JOIN Student s ON t.s_id = s.s_id; ``` 执行时间为:0.001s,这个时间相当�谱,快了50� @@ -641,8 +789,12 @@ SELECT s.*FROM ( SELECT * FROM SC sc 那么��执行下sql -``` -SELECT s.* from Student s INNER JOIN SC sc on sc.s_id = s.s_id where sc.c_id=0 and sc.score=100 +```sql +SELECT s.* +FROM Student s +INNER JOIN SC sc ON sc.s_id = s.s_id +WHERE sc.c_id = 0 + AND sc.score = 100; ``` 执行时间0.001s @@ -667,15 +819,34 @@ SELECT s.* from Student s INNER JOIN SC sc on sc.s_id = s.s_id where sc.c_id=0 ## mysql百万级分页优化 + + ### 普通分页 数�分页在网页中�分多�,分页一般都是limit start,offset,然�根�页�page计算start - select * from user limit **1**,**20** +```sql +SELECT * +FROM user +LIMIT 1, 20; +``` 这�分页在几�万的时候分页效率就会比较低了,MySQL需�从头开始一直往�计算,这样大大影�效率 -SELECT * from user limit **100001**,**20**; //time **0**.151s explain SELECT * from user limit **100001**,**20**; +```sql +SELECT * +FROM user +LIMIT 100001, 20; +``` + +耗时 0.151s。 + +```sql +EXPLAIN +SELECT * +FROM user +LIMIT 100001, 20; +``` 我们�以用explain分�下语�,没有用到任何索引,MySQL执行的行数是16W+,于是我们�以想用到索引去实现分页 @@ -685,11 +856,34 @@ SELECT * from user limit **100001**,**20**; //time **0**.151s explain SELECT * f 使用主键索引�优化数�分页 - select * from user where id>(select id from user where id>=**100000** limit **1**) limit **20**; //time **0**.003s +```sql +SELECT * +FROM user +WHERE id > ( + SELECT id + FROM user + WHERE id >= 100000 + LIMIT 1 +) +LIMIT 20; +``` + +耗时 0.003s。 使用explain分�语�,MySQL这次扫�的行数是8W+,时间也大大缩短。 - explain select * from user where id>(select id from user where id>=**100000** limit **1**) limit **20**; +```sql +EXPLAIN +SELECT * +FROM user +WHERE id > ( + SELECT id + FROM user + WHERE id >= 100000 + LIMIT 1 +) +LIMIT 20; +``` ![](https://java-tutorial.oss-cn-shanghai.aliyuncs.com/05fffbffc5e3ef9add4719846ad53f25099.jpg) @@ -697,6 +891,4 @@ SELECT * from user limit **100001**,**20**; //time **0**.151s explain SELECT * f 在数��比较大的时候,我们尽�去利用索引�优化语�。上�的优化方法如果id�是主键索引,查询效率比第一�还�低点。我们�以先使用explain�分�语�,查看语�的执行顺�和执行性能。 - - -转载于:https://my.oschina.net/alicoder/blog/3097141 +转载于:[https://my.oschina.net/alicoder/blog/3097141](https://my.oschina.net/alicoder/blog/3097141) \ No newline at end of file