使用@Value為靜態(tài)變量導入并使用導入的靜態(tài)變量進行初始化方式
更新時間：2023年02月13日 10:17:53 作者：思影影思
這篇文章主要介紹了使用@Value為靜態(tài)變量導入并使用導入的靜態(tài)變量進行初始化方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
1 問題描述
在南京出差時，在開始開發(fā)，自己把一些相對緊密聯(lián)系的不變得配置放進一個類中，這些字段為static的，待交付時，由于這些配置也要是可以通過配置文件進行配置的，因此無形之中就引入了一個問題。
即使用@Value對靜態(tài)變量進行導入的問題。并且還有一種更加復雜的情形，即需要在生成相關的Bean時，需要進行一些資源的初始化，在當時自己結結實實的踩了一把坑。
在項目開始時TomcatConfig類是如下的：
public class TomcatConfig {
public static String ip = "192.168.1.112";
public static int port=8080;
public static String username=admin;
public static String password=admin;
}
但在交付之前，要把這些配置值放入配置文件，例如application.properties
tomcat.ip=10.30.102.111 tomcat.port=8080 tomcat.username=admin tomcat.password=admin
并且要在該類再開始時通過HTTP調用，使用這些參數(shù)進行一次初始化。
2 問題結構
2.1 服務方
可以理解自己開發(fā)的模塊依賴于其他的模塊，模塊之間通過HTTP通信獲取數(shù)據(jù)和狀態(tài)?？梢酝ㄟ^Spring Boot起一個程序提供一個對外的接口，即相當于提供服務。
這就是服務提供的類。
該程序所在的服務器ip和端口即上邊已經(jīng)寫進配置文件的ip和端口。
package com.wisely.ch6_2_3.controller;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.wisely.ch6_2_3.config.TomcatSetting;
import lombok.extern.java.Log;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.UUID;
/**
* 測試注入
*
* @Owner:
* @Time: 2019/3/31-16:29
*/
@RestController
@Log
public class TestValue {
@Autowired
private TomcatSetting serverConfig;
@RequestMapping(value = "/getImg",produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public String getImgeLoc() {
log.info("Enter getImgeLoc");
System.out.println("-- Handling --");
String fileName = UUID.randomUUID().toString()+".jpg";
JSONObject result = new JSONObject();
result.put("imgUrl", serverConfig.getUrl()+"/"+fileName);
System.out.println("-- over --");
return result.toJSONString();
}
@RequestMapping("/getmapping")
public String service(@RequestParam("username") String username, @RequestParam("password") String password) {
if (!username.equals("admin") ||!password.equals("admin")) {
JSONObject res = new JSONObject();
res.put("state", -1);
res.put("msg", "fail");
return res.toJSONString();
}
JSONObject result = new JSONObject();
result.put("state", 0);
result.put("msg", "success");
JSONObject data = new JSONObject();
data.put("aaa", "bbb");
data.put("ccc", "ddd");
result.put("data", data);
return result.toJSONString();
}
}
2.2 客戶方
由于之前寫的代碼是硬編碼，肯定要重構這部分的代碼，@Value可以靈活的實現(xiàn)注入，但通過在互聯(lián)網(wǎng)上查詢相關的頁面可以得到如下的知識：
- SpringBoot中使用@Value()只能給普通變量注入值，不能直接給靜態(tài)變量賦值,并且@Value使用設值函數(shù)為成員注入值。
- 為了給靜態(tài)變量注入值，需要使用特殊的語法
2.2.1核心類 TomcatConfig
package com.example.staticvalue.config;
import com.alibaba.fastjson.JSONObject;
import com.example.staticvalue.HttpClientUtil.HttpClientUtil;
import com.fasterxml.jackson.databind.util.JSONPObject;
import lombok.Getter;
import lombok.extern.java.Log;
import org.apache.http.protocol.HTTP;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.Map;
/**
* tomcat配置
*
* @Owner:
* @Time: 2019/3/31-19:25
*/
@Component
@Log
public class TomcatConfig {
@Getter
private static String ip;
@Getter
private static int port;
@Getter
private static String username;
@Getter
private static String password;
private static JSONObject data = new JSONObject();
# 在靜態(tài)初始化塊中調用set()是無效的，因為此時ip等變量尚未注入。應該是在該Bean已經(jīng)生成了，即ip，port，usernam，password已經(jīng)注入之后再調用set()這樣才有效。
static {
log.info("靜態(tài)化塊");
log.info("TomcatConfig.ip: "+ TomcatConfig.ip);
~~~~try {
~~set();~~
~~} catch (Exception e) {~~
~~e.printStackTrace();~~
}~~~~
}
@Value("${tomcat.ip}")
public void setIp(String ip) {
TomcatConfig.ip = ip;
}
@Value("${tomcat.password}")
public void setPassword(String password) {
TomcatConfig.password = password;
}
@Value("${tomcat.port}")
public void setPort(int port) {
TomcatConfig.port = port;
}
@Value("${tomcat.username}")
public void setUsername(String username) {
TomcatConfig.username = username;
}
// 注意該函數(shù)應在類外進行調用，比如set()可以放置在其他標注了雷瑟@Componet的Bean類中，這樣可以保證在TomcatConfig的bean已經(jīng)生成。
public static void set() throws Exception {
log.info("Enter set");
log.info("TomcatConfig.ip: "+ TomcatConfig.ip);
String accessUrl = "http://"+getIp()+":"+getPort()+"/getmapping?";
accessUrl += "username="+username+"&"+"password="+password;
log.info("accessUrl = "+accessUrl);
String result = HttpClientUtil.postJson(accessUrl, "{}");
JSONObject ret = JSONObject.parseObject(result);
if (ret.getIntValue("state") == 0) {
data = ret.getJSONObject("data");
}
}
}
注意：set()方法完成了類似初始化的工作，即通過調用一次http請求，填充了static成員data的值。
set()的調用不可以放在本類的靜態(tài)環(huán)境下，尤其在war包運行在tomcat之下更是這樣，在jar包中set()函數(shù)的調用放在靜態(tài)函數(shù)main之中是有效的。
這可以通過日志進行證明，如果是war包跑在tomcat環(huán)境下，若為如下代碼：
public static void main(String[] args) throws Exception{
log.info("Enter main");
SpringApplication.run(StaticvalueApplication.class, args);
log.info("after run");
TomcatConfig.set();
log.info("after set");
}
程序會僅執(zhí)行到after run日志打印，不會執(zhí)行TomcatConfig.set()的調用，切記，切記
如果真的是在war包跑在tomcat下，可以使用如下的方式解決，可以把TomcatConfig.set()的調用放在其他Bean類的靜態(tài)初始化塊中。
2.2.2 項目結構
2.2.3輔助類HttpClientUtil
package com.example.staticvalue.HttpClientUtil;
import org.apache.http.HttpEntity;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.CharArrayBuffer;
import org.apache.http.util.EntityUtils;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
/**
* 輔助類，使用http獲取數(shù)據(jù)
*
* @Owner:
* @Time: 2019/3/31-19:49
*/
public class HttpClientUtil {
public static String postJson(String url,String jsonString) throws Exception
{
String result = null;
CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost post = new HttpPost(url);
CloseableHttpResponse response = null;
try {
post.setEntity(new ByteArrayEntity(jsonString.getBytes("UTF-8")));
post.setHeader("Content-Type","application/json" );
response = httpClient.execute(post);
if(response != null && response.getStatusLine().getStatusCode() == 200)
{
HttpEntity entity = response.getEntity();
result = entityToString(entity);
}
return result;
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}finally {
try {
httpClient.close();
if(response != null)
{
response.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}
private static String entityToString(HttpEntity entity) throws IOException {
String result = null;
if(entity != null)
{
long lenth = entity.getContentLength();
if(lenth != -1 && lenth < 2048)
{
result = EntityUtils.toString(entity,"UTF-8");
}else {
InputStreamReader reader1 = new InputStreamReader(entity.getContent(), "UTF-8");
CharArrayBuffer buffer = new CharArrayBuffer(2048);
char[] tmp = new char[1024];
int l;
while((l = reader1.read(tmp)) != -1) {
buffer.append(tmp, 0, l);
}
result = buffer.toString();
}
}
return result;
}
}
2.2.4 啟動類
package com.example.staticvalue;
import com.example.staticvalue.config.TomcatConfig;
import lombok.extern.java.Log;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@Log
public class StaticvalueApplication {
public static void main(String[] args) throws Exception{
log.info("Enter main");
SpringApplication.run(StaticvalueApplication.class, args);
log.info("after run");
//在Jar包中運行時，下句是可以生效的，但在war包運行在tomcat中時，TomcatConfig。set(）以及之后的語句不會執(zhí)行。把Tomcat.set()放在某個Bean的靜態(tài)初始化塊中即可
TomcatConfig.set();
log.info("after set");
}
}
2.2.5 TaskService
package com.example.staticvalue.service;
import com.example.staticvalue.config.TomcatConfig;
import lombok.extern.java.Log;
import org.springframework.stereotype.Component;
/**
* 任務類
*
* @Owner:
* @Time: 2019/3/31-19:39
*/
@Component
@Log
public class TaskService {
static {
try {
log.info("TaskService： before set");
TomcatConfig.set();
log.info("TaskService： after set");
} catch (Exception e) {
e.printStackTrace();
}
}
}
3總結
上述注入靜態(tài)變量的主要原因是靜態(tài)變量因為一些遺留的原因，為了解決硬編碼的問題而引入的，至于在靜態(tài)變量通過@Value注入時同時在該類中進行初始化，則是非常不優(yōu)雅的一種編程風格，這種初始化的方式更加建議放置在類似開機自啟動的應用程序中，在Spring Boot中也確實有這樣的實現(xiàn)場景。
即CommandLineRunner接口，實現(xiàn)該接口的類必須實現(xiàn)run()方法，而該方法會在所有Bean均已正確生成之后開始執(zhí)行。
關于CommandLineRunner，可以參考CommandLineRunner或者ApplicationRunner接口，至于這種用法，改天再來寫一篇闡述的文章吧。
總結
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
SpringCloud創(chuàng)建多模塊項目的實現(xiàn)示例
,Spring Cloud作為一個強大的微服務框架,提供了豐富的功能和組件,本文主要介紹了SpringCloud創(chuàng)建多模塊項目的實現(xiàn)示例,具有一定的參考價值,感興趣的可以了解一下2024-02-02
池化并不是什么新鮮的技術，它更像一種軟件設計模式，主要功能是緩存一組已經(jīng)初始化的對象，以供隨時可以使用。本文將為大家詳細講講Java中對象池的實現(xiàn)，需要的可以參考一下2022-07-07
對于 ThreadLocal 我們都不陌生，它的作用如同它的名字用于存放線程本地變量，這篇文章主要介紹了為什么?ThreadLocal?可以做到線程隔離,需要的朋友可以參考下2022-07-07
java鏈式創(chuàng)建json對象的實現(xiàn)
本文主要介紹了java中如何通過最簡單的方式實現(xiàn)鏈式創(chuàng)建json對象，解決創(chuàng)建json代碼臃腫的問題，具有一定的參考價值，感興趣的小伙伴們可以參考一下2022-02-02
java8 stream的多字段排序實現(xiàn)(踩坑)
這篇文章主要介紹了java8 stream的多字段排序實現(xiàn)(踩坑)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-03-03
SpringBoot實現(xiàn)無感刷新Token的項目實踐
token刷新是前端安全中必要的一部分,本文就來介紹一下SpringBoot實現(xiàn)無感刷新Token的項目實踐,具有一定的參考價值,感興趣的可以了解一下2024-03-03
這篇文章主要介紹了spring基于注解配置實現(xiàn)事務控制操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要介紹了Java使用正則表達式驗證用戶名和密碼的方法，本文給大家介紹的非常詳細，具有一定的參考借鑒價值,需要的朋友可以參考下2019-09-09
這篇文章主要介紹了Java對象序列化操作,簡單描述了Java序列化相關概念、原理并結合實例形式總結分析了常見序列化操作相關定于與使用技巧,需要的朋友可以參考下2018-09-09
本篇文章主要介紹了Spring MVC 文件上傳的示例代碼，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-09-09