property
是 java 實現的 property 框架。
特點
-
優雅地進行屬性文件的讀取和更新
-
寫入屬性文件后屬性不亂序
-
靈活定義編碼信息
-
使用 OO 的方式操作 property 文件
-
支持多級對象引用
變更日誌
快速開始
環境依賴
Maven 3.x
Jdk 1.7+
Maven 引入依賴
<dependency>
<groupId>com.github.houbb</groupId>
<artifactId>property</artifactId>
<version>0.0.4</version>
</dependency>
入門案例
讀取屬性
PropertyBs.getInstance("read.properties").get("hello");
read.properties 為文件路徑，hello 為存在的屬性值名稱。
讀取屬性指定默認值
final String value = PropertyBs.getInstance("read.properties")
.getOrDefault("hello2", "default");
read.properties 為文件路徑，hello2 為不存在的屬性值名稱，default 為屬性不存在時返回的默認值。
設置屬性
PropertyBs.getInstance("writeAndFlush.properties").setAndFlush("hello", "world-set");
writeAndFlush.properties 為文件路徑，hello 為需要設置的屬性信息。
引導類方法概覽
| 序號 |
方法 |
說明 |
| 1 |
getInstance(propertyPath) |
獲取指定屬性文件路徑的引導類實例 |
| 2 |
charset(charset) |
指定文件編碼，默認為 UTF-8 |
| 3 |
get(key) |
獲取 key 對應的屬性值 |
| 4 |
getOrDefault(key, defaultValue) |
獲取 key 對應的屬性值，不存在則返回 defaultValue |
| 5 |
set(key, value) |
設置值（內存） |
| 6 |
remove(key) |
移除值（內存） |
| 7 |
flush() |
刷新內存變更到當前文件磁盤 |
| 9 |
flush(path) |
刷新內存變更到指定文件磁盤 |
| 10 |
set(map) |
設置 map 信息到內存 |
| 11 |
set(bean) |
設置 bean 對象信息到內存 |
| 12 |
asMap() |
返回內存中屬性信息，作為 Map 返回 |
| 13 |
asBean(bean) |
返回內存中屬性信息到 bean 對象中 |
對象
簡介
我們希望操作 property 可以想操作對象一樣符合 OO 的思想。
設置值
User user = new User();
user.setName("hello");
user.setHobby("hobby");
final long time = 1574147668411L;
user.setBirthday(new Date(time));
PropertyBs propertyBs = PropertyBs.getInstance("setBean.properties")
.set(user);
Assert.assertEquals("hobby", propertyBs.get("myHobby"));
Assert.assertEquals("1574147668411", propertyBs.get("birthday"));
讀取值
PropertyBs propertyBs = PropertyBs.getInstance("setBean.properties"
.set("myHobby", "play")
.set("birthday", "1574147668411");
User user = new User();
propertyBs.asBean(user);
Assert.assertEquals("play", user.getHobby());
Assert.assertEquals(1574147668411L, user.getBirthday().getTime());
對象定義
public class User {
private String name;
@PropertyField("myHobby")
private String hobby;
@PropertyField(converter = DateValueConverter.class)
private Date birthday;
}
@PropertyField 註解
| 序號 |
屬性 |
默認值 |
說明 |
| 1 |
value |
當前字段名稱 |
對應的 property 屬性名稱 |
| 2 |
converter |
默認轉換實現 DefaultValueConverter |
對當前字段進行屬性的轉換處理 |
自定義轉換類
這個就是我們針對 Date 類型，自己實現的處理類型。
實現如下：
public class DateValueConverter implements IValueConverter {
@Override
public Object fieldValue(String value, IFieldValueContext context) {
return new Date(Long.parseLong(value));
}
@Override
public String propertyValue(Object value, IPropertyValueContext context) {
Date date = (Date)value;
return date.getTime()+"";
}
}
集合
說明
有時候一個屬性可能是集合或者數組，這裏暫時給出比較簡單的實現。
將字段值直接根據逗號分隔，作為屬性值。
測試案例
UserArrayCollection userArrayCollection = buildUser();
PropertyBs propertyBs = PropertyBs.getInstance("setBeanArrayCollection.properties")
.set(userArrayCollection);
Assert.assertEquals("array,collection", propertyBs.get("alias"));
Assert.assertEquals("array,collection", propertyBs.get("hobbies"));
對象定義
public class UserArrayCollection {
private List<String> alias;
private String[] hobbies;
}
暫時只支持 String 類型，不想做的過於複雜。
後期將考慮添加各種類型的支持。
多級對象
說明
有時候我們在一個對象中會引用其他對象，比如 對象 a 中包含對象 b。
這裏採用 a.b.c 這種方式作為屬性的 key, 更加符合使用的習慣。
測試案例
設置
Book book = new Book();
book.name("《海底兩萬里》").price("12.34");
UserEntry user = new UserEntry();
user.name("海倫").book(book).age("10");
PropertyBs propertyBs = PropertyBs.getInstance("setBeanEntry.properties")
.set(user);
Assert.assertEquals("海倫", propertyBs.get("name"));
Assert.assertEquals("10", propertyBs.get("age"));
Assert.assertEquals("《海底兩萬里》", propertyBs.get("book.name"));
Assert.assertEquals("12.34", propertyBs.get("book.price"));
讀取
Map<String, String> map = new HashMap<>();
map.put("name", "海倫");
map.put("age", "10");
map.put("book.name", "《海底兩萬里》");
map.put("book.price", "12.34");
UserEntry userEntry = new UserEntry();
PropertyBs.getInstance("setBeanEntry.properties")
.set(map)
.asBean(userEntry);
Assert.assertEquals("UserEntry{name='海倫', age=10, book=Book{name='《海底兩萬里》', price=12.34}}",
userEntry.toString());
對象定義
public class UserEntry {
private String name;
private String age;
@PropertyEntry
private Book book;
}
public class Book {
private String name;
private String price;
}
@PropertyEntry 說明
@PropertyEntry 註解用來標識一個字段是否採用多級對象的方式表示。
這個註解只有一個屬性，就是 value()，可以用來給當前字段指定一個別稱，和 @PropertyField 別稱類似。
後續特性
本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理
【其他文章推薦】
※帶您來了解什麼是 USB CONNECTOR ?
※自行創業 缺乏曝光? 下一步"網站設計"幫您第一時間規劃公司的門面形象
※如何讓商品強力曝光呢? 網頁設計公司幫您建置最吸引人的網站，提高曝光率!!
※綠能、環保無空污,成為電動車最新代名詞，目前市場使用率逐漸普及化
※廣告預算用在刀口上，網站設計公司幫您達到更多曝光效益
※試算大陸海運運費!
