com.jfinal.kit.Prop Maven / Gradle / Ivy
Show all versions of jfinal Show documentation
/**
* Copyright (c) 2011-2023, James Zhan 詹波 ([email protected]).
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.jfinal.kit;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Properties;
import com.jfinal.core.Const;
/**
* Prop. Prop can load properties file from CLASSPATH or File object.
*/
public class Prop {
protected Properties properties;
/**
* 支持 new Prop().appendIfExists(...)
*/
public Prop() {
properties = new Properties();
}
/**
* Prop constructor.
* @see #Prop(String, String)
*/
public Prop(String fileName) {
this(fileName, Const.DEFAULT_ENCODING);
}
/**
* Prop constructor
*
* Example:
* Prop prop = new Prop("my_config.txt", "UTF-8");
* String userName = prop.get("userName");
*
* prop = new Prop("com/jfinal/file_in_sub_path_of_classpath.txt", "UTF-8");
* String value = prop.get("key");
*
* @param fileName the properties file's name in classpath or the sub directory of classpath
* @param encoding the encoding
*/
public Prop(String fileName, String encoding) {
InputStream inputStream = null;
try {
inputStream = getClassLoader().getResourceAsStream(fileName); // properties.load(Prop.class.getResourceAsStream(fileName));
if (inputStream == null) {
throw new IllegalArgumentException("Properties file not found in classpath: " + fileName);
}
properties = new Properties();
properties.load(new InputStreamReader(inputStream, encoding));
} catch (IOException e) {
throw new RuntimeException("Error loading properties file.", e);
}
finally {
if (inputStream != null) try {inputStream.close();} catch (IOException e) {LogKit.error(e.getMessage(), e);}
}
}
private ClassLoader getClassLoader() {
ClassLoader ret = Thread.currentThread().getContextClassLoader();
return ret != null ? ret : getClass().getClassLoader();
}
/**
* Prop constructor.
* @see #Prop(File, String)
*/
public Prop(File file) {
this(file, Const.DEFAULT_ENCODING);
}
/**
* Prop constructor
*
* Example:
* Prop prop = new Prop(new File("/var/config/my_config.txt"), "UTF-8");
* String userName = prop.get("userName");
*
* @param file the properties File object
* @param encoding the encoding
*/
public Prop(File file, String encoding) {
if (file == null) {
throw new IllegalArgumentException("File can not be null.");
}
if (!file.isFile()) {
throw new IllegalArgumentException("File not found : " + file.getName());
}
InputStream inputStream = null;
try {
inputStream = new FileInputStream(file);
properties = new Properties();
properties.load(new InputStreamReader(inputStream, encoding));
} catch (IOException e) {
throw new RuntimeException("Error loading properties file.", e);
}
finally {
if (inputStream != null) try {inputStream.close();} catch (IOException e) {LogKit.error(e.getMessage(), e);}
}
}
public Prop append(Prop prop) {
if (prop == null) {
throw new IllegalArgumentException("prop can not be null");
}
properties.putAll(prop.getProperties());
return this;
}
public Prop append(String fileName, String encoding) {
return append(new Prop(fileName, encoding));
}
public Prop append(String fileName) {
return append(fileName, Const.DEFAULT_ENCODING);
}
public Prop appendIfExists(String fileName, String encoding) {
try {
return append(new Prop(fileName, encoding));
} catch (Exception e) {
return this;
}
}
public Prop appendIfExists(String fileName) {
return appendIfExists(fileName, Const.DEFAULT_ENCODING);
}
public Prop append(File file, String encoding) {
return append(new Prop(file, encoding));
}
public Prop append(File file) {
return append(file, Const.DEFAULT_ENCODING);
}
public Prop appendIfExists(File file, String encoding) {
if (file.isFile()) {
append(new Prop(file, encoding));
}
return this;
}
public Prop appendIfExists(File file) {
return appendIfExists(file, Const.DEFAULT_ENCODING);
}
public String get(String key) {
// 下面这行代码只要 key 存在，就不会返回 null。未给定 value 或者给定一个或多个空格都将返回 ""
String value = properties.getProperty(key);
return value != null && value.length() != 0 ? value.trim() : null;
}
public String get(String key, String defaultValue) {
String value = properties.getProperty(key);
return value != null && value.length() != 0 ? value.trim() : defaultValue;
}
public Integer getInt(String key) {
return getInt(key, null);
}
public Integer getInt(String key, Integer defaultValue) {
String value = properties.getProperty(key);
if (value != null) {
return Integer.parseInt(value.trim());
}
return defaultValue;
}
public Long getLong(String key) {
return getLong(key, null);
}
public Long getLong(String key, Long defaultValue) {
String value = properties.getProperty(key);
if (value != null) {
return Long.parseLong(value.trim());
}
return defaultValue;
}
public Double getDouble(String key) {
return getDouble(key, null);
}
public Double getDouble(String key, Double defaultValue) {
String value = properties.getProperty(key);
if (value != null) {
return Double.parseDouble(value.trim());
}
return defaultValue;
}
public Boolean getBoolean(String key) {
return getBoolean(key, null);
}
public Boolean getBoolean(String key, Boolean defaultValue) {
String value = properties.getProperty(key);
if (value != null) {
value = value.toLowerCase().trim();
if ("true".equals(value)) {
return true;
} else if ("false".equals(value)) {
return false;
}
throw new RuntimeException("The value can not parse to Boolean : " + value);
}
return defaultValue;
}
public boolean containsKey(String key) {
return properties.containsKey(key);
}
public boolean isEmpty() {
return properties.isEmpty();
}
public boolean notEmpty() {
return ! properties.isEmpty();
}
public Properties getProperties() {
return properties;
}
}