成都java程序員學習：一個bug來理解Spring單例

這是由一個真實的bug引起的，bug產生的原因就是忽略了Spring Bean的單例模式。來，先看一段簡單的代碼。

public class TestService {

private String callback = "https://ip.com/token={token}";

public String getCallback() {

Random random = new Random();

int number = random.nextInt(100);

System.out.println("本次隨機數為：" + number);

callback = callback.replace("{token}", String.valueOf(number));

return callback;

}

public static void main(String[] args) {

TestService testService = new TestService();

while (true) {

Scanner reader = new Scanner(System.in);

int number = reader.nextInt();

if (number > 0) {

String url = testService.getCallback();

System.out.println(url);

}

}

}

}

callback是一個帶有一個回調地址，參數 token是不確定的。

getCallback方法每次調用，會隨機生成一個100以內的數字，然后將 callback中的{token}替換為這個隨機數字，最后的格式就像這樣的：

https://ip.com/token=88

然后在 main方法中接收控制臺輸入，每次輸入的數字大于0，調用 getCallback方法，然后輸出 url。

相信各位都能輕易的看出這段程序的輸出。

執行程序之后，不管你輸入多少次數字，最后輸出的 callback都是第一次的那個。

雖然每次生成的隨機數都變了，但是 callback沒變。

其實就是單例

有同學說，你過分了啊，這我能不知道為啥嗎?

main方法只創建了一個TestService實例，在第一次調用 getCallback方法的時候，callback這個字符串就被修改成 https://ip.com/token=89了，所以，之后不管你再調用多少次，都不會執行 replace動作了，因為 callback中已經沒有 {token}這一段了。

TestService 在整個程序執行過程中就是一個單例，所以，在 callback第一次被修改后，后面再執行

callback.replace("{token}", String.valueOf(number));

的動作，拿到的 callback中就已經沒有 {token}了，所以說，不會有替換的動作。

當然，這只是用最簡單的程序說明單例中的這個問題，真正的項目中想用單例的話，還要借助于單例設計模式實現。

回到那個 bug

有個弟弟在做微信服務號的開發，微信服務號或者訂閱號中有個access_token的概念，這是所有請求的憑證，有效期2個小時，到期之前要進行刷新。

他是這樣設計的，在項目啟動的時候立即調用微信接口獲取access_token，然后寫了一個定時任務每1個小時刷新一次，獲取來的access_token放到redis和數據庫中，當調用微信服務號其他接口的時候，在redis中獲取access_token并拼接到接口地址中。

開發調試的時候一起順利，看上去非常完美。

問題出現了

當項目部署到測試環境測試的時候，問題出現了。項目剛發版的時候，測試都正常，但是過一段時間，就會出現錯誤，查看日志的時候，發現是微信服務號的接口返回了錯誤碼，意思就是 access_token已過期，需要重新獲取。

弟弟第一時間懷疑是定時任務出現了問題，但是通過日志和數據庫中的更新時間，發現定時任務是完全沒有問題的，刷新 access_token的時間和定時任務是完全吻合的，說明已經及時刷新了。

我讓他用 redis 或數據庫中的access_token去調一下服務號接口，看看是不是也有同樣的過期問題。

結果一試，redis 中存的是沒問題的，可以正常使用。

那徹底排除是定時任務的問題了，問題的癥結應該就出在兩個地方：

1、在獲取 redis 中的access_token的過程;

2、將獲取到的 access_token拼接到請求接口 URL 上發生了錯誤;

到這里就很好判斷了，他把從 redis 拿到的access_token和最后拼接好的 URL 都輸出到日志中一看，果然，兩個是不一致的。

從 redis 取出的確實是最新可用的 access_token ，但是拼接到接口 URL 上之后，發現是另外一個。那就確定是拿到的 access_token 是沒問題的，但是最后拼接到 URL 卻有問題。這時，弟弟仔細檢查了代碼，然后徹底蒙了。

既然問題出在哪兒已經確定了，那就分析那段代碼就好了。

項目整體采用的是 Spring Boot，代碼很簡單，就是在一個 Controller 中調用 Service 中的一個方法。大致 demo 是這樣的。

@RestController

@RequestMapping(value = "test")

public class TestController {

@Autowired

private TestService testService;

@GetMapping(value = "call")

public Object getCallback() {

return testService.getCallback();

}

}

@Service

public class TestService {

private String callback = "https://ip.com/token={token}";

public String getCallback() {

Random random = new Random();

int number = random.nextInt(100);

System.out.println("本次隨機數為：" + number);

callback = callback.replace("{token}", String.valueOf(number));

return callback;

}

}

看到這里，各位肯定已經發現問題原因了。雖然有多次請求，但因為 Spring Bean 默認是單例模式，所以實際上和前面演示的那個控制臺程序是類似的，從頭到尾都只有一個 TestService 實例，所以只有第一次能將{token}替換成真正的access_token。

對應到實際的服務號場景中，在第一次調用這個接口時，從 redis 拿到 access_token拼接到具體的 URL中是沒問題的，但是一旦這個access_token過期(1小時后)，再次請求這個接口就會出現 access_token過期的問題。

這里違反了 Spring 單例模式的一個點，那就是 Spring 單例模式，不適合存儲有狀態的值，比如這里的 callback就是個有狀態的值，它應該隨著定時任務的進行，獲取到不同的值。

關于 Spring 或 Spring Boot 工作流程的介紹可以閱讀文末的兩篇文章，其中包括 Bean 實例化過程。

修改建議

如何解決這個問題呢?

其實很簡單，不讓callback每次調用發生變化就可以了，每次拼接 URL 的時候，先將 callback賦給一個局部變量，然后在這個變量上操作就好了。

public String getCallback() {

Random random = new Random();

int number = random.nextInt(100);

System.out.println("本次隨機數為：" + number);

String tempCallback = callback;

tempCallback = tempCallback.replace("{token}", String.valueOf(number));

return tempCallback;

}

另外，說到 Spring 單例模式，Spring 本身還支持其他幾種模式，與單例模式對應的就是 prototype模式，這種模式是每個請求都重新生成實例。所以，如果你確定這個 Controller 和 Service 可以不用單例模式，可以加上 @Scope(value = "prototype")注解。

@RestController

@RequestMapping(value = "test")

@Scope(value = "prototype")

public class TestController {

@Autowired

private TestService testService;

@GetMapping(value = "call")

public Object getCallback() {

return testService.getCallback();

}

}

@Service

@Scope(value = "prototype")

public class TestService {

private String callback = "https://ip.com/token={token}";

public String getCallback() {

Random random = new Random();

int number = random.nextInt(100);

System.out.println("本次隨機數為：" + number);

callback = callback.replace("{token}", String.valueOf(number));

return callback;

}

}

這樣一來，每次都是新的實例，自然就不存在那個問題了。