Přeskočit na hlavní obsah

Expanze proměnných – neobjevujte kolo

Možná jste už někdy řešili problém, jak nahradit proměnné jejich hodnotou třeba v konfiguračním souboru. Například ze vstupu

<app-config baseDir="${projectDirectory}">
 <timeout>${timeout}</timeout>
</app-config>
chceme ve výsledku dostat
<app-config baseDir="C:\Projects\MyApp">
 <timeout>30</timeout>
</app-config>

Asi vás napadne využít String.replaceAll(String, String) nebo v lepším případě přímo dvojice Pattern/Matcher a capturing groups. Proč ale znovu vymýšlet kolo, když knihovna Apache Commons Lang (která by mimochodem měla být standardní součástí každého netriviálního projektu) nabízí pro daný problém přesně ty třídy, které potřebujeme. Výchozím bodem je třída StrSubstitutor, která obsahuje i statické metody pro zjednodušení v nejpoužívanějších případech:

Map<String, Object> properties = new HashMap<String, Object>();
properties.put("animal", "dog");
properties.put("legs", new Integer(4));

System.out.println(
    StrSubstitutor.replace("The ${animal} has ${legs} legs.", properties));
//prints: The dog has 4 legs. 

StrSubstitutor zvládá nahrazovat i Java property (standardní i ty zadané jako argumenty JVM)

System.out.println(
    StrSubstitutor.replaceSystemProperties("Your OS is '${os.name}'"));
//prints: Your OS is 'Windows XP'

A nejsme vázáni ani zdrojem hodnot našich proměnných. Například, chceme-li expandovat na proměnné prostředí a property mají syntaxi proměnných ve Windows, není to vůbec složité. Stačí vlastní implementace abstraktní třídy StrLookup:

//Anonymous child of StrLookup class, which
//maps property names to environment variables in the system
public static final StrLookup ENV_VAR_LOOKUP = new StrLookup() {
    @Override public String lookup(final String key) {
        return System.getenv(key);
    }
};

//expands windows-like properties to system environment variables (e.g. %PATH%)
public static String expandBatch(final String textToExpand) {
    final StrSubstitutor batchSubstitutor = new StrSubstitutor(
        ENV_VAR_LOOKUP, "%", "%", StrSubstitutor.DEFAULT_ESCAPE);
    return batchSubstitutor.replace(textToExpand);
}

//used then
System.out.println(
    expandBatch("Windows is installed in '%WINDIR%'."));
//prints: Windows is installed in 'C:\WINNT'.

A připomenutí na závěr – neobjevujte znovu kolo – pro začátek si projděte API ke Commons Lang a nebojte se tuto knihovnu používat.

Komentáře

Tomáš píše…
Diky za pripomenuti kdyz jsem prochazeil to API tak jsem se pristihl kolik takovych podobnych metod jsem zbytecne napsali, kdyz uz jsou 3x a lepe napsany

Populární příspěvky z tohoto blogu

Three ways to redirect HTTP requests to HTTPs in WildFly and JBoss EAP

WildFly application server (and JBoss EAP) supports several simple ways how to redirect the communication from plain HTTP to TLS protected HTTPs. This article presents 3 ways. Two are on the application level and the last one is on the server level valid for requests to all deployments. 1. Request confidentiality in the deployment descriptor The first way is based on the Servlet specification. You need to specify which URLs should be protected in the web.xml deployment descriptor. It's the same approach as the one used for specifying which URLs require authentication/authorization. Just instead of requesting an assigned role, you request a transport-guarantee . Sample content of the WEB-INF/web.xml <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1...

Acegi - logujeme loginy

Používáte-li pro správu přístupu k vaší webové aplikaci framework Acegi, možná se vám bude hodit zaznamenávat uživatelské přístupy (platné loginy) někam do databáze. Zde je jeden ze způsobů jak se s tímto problémem vypořádat. Následující přiklad používá Hibernate a databázi Oracle. Nejdříve si připravím vlastní metodu pro zápis do databáze v DAO . Umístím ji do třídy cz.mujpackage.dao.UserDao , která rozšiřuje org.springframework.orm.hibernate3.support.HibernateDaoSupport a poskytuje metody pro správu uživatelů, rolí, apod. Pro zvýšení výkonu použiji v Hibernate SQLQuery namísto vytváření instance třídy modelu a jejího ukládání pomocí metody save(...) . /** * Adds log entry to table AUTH_LOG (Oracle database form - pk_sequence has to be configured) * @param aName username * @param aRemoteAddress remote address of request */ public void logAuthenticationSuccess(final String aName, final String aRemoteAddress) { final HibernateCallback callback = new HibernateCallback() { publ...

Jak na Excel 2 - Automation a JNI

První metoda pro práci s Excelem v Javě, kterou si v seriálu ukážeme je využití MS Automation. To znamená že budeme s Excelem pracovat stejným způsobem jako při psaní skriptů ve windows (viz Windows Scripting ). To sice přináší největší funkcionalitu, ale na druhé straně spoustu omezení spočívající v předpokladech, které musí aplikace splnit. Tuto metodu doporučuji pouze v případě, že chcete používat funkcionalitu, které se nedá docílit použitím jiných metod (viz Jak na Excel 1) - například spouštění maker. Co budeme muset splnit pro využití této metody? naše Java aplikace musí běžet na stroji s Windows, kde musí být nainstalovaný Excel musíme mít Java-COM bridge, t.j. nástroj který nám umožní v Javě pracovat s COM objekty, většinou nějakou knihovnu volající přes JNI funkce z MS Windows Existuje několik open source knihoven implementujících Java-COM bridge. Tyto knihovny pracují v některém ze dvou základních režimů (některé zvládají oba). První typ přístupu využívá vygenerovan...