'template'에 해당되는 글 1건

  1. 2010/01/28 StringTemplate 소개 (1)
2010/01/28 01:22

StringTemplate 소개

Mail 발송 삽질을 하다가 StringBuilder가 너무 보기 싫어 File을 이용해 메일 템플릿을 구현할 작정으로 검색을 해보았습니다. 스트링 관련 검색을 하다보니 벨로시티도 나오고 하다가 유독 StringTemplate이 괜찮다는 문구를 보고 찾아 들어갔습니다. 진짜 문자열 템플릿 엔진이더군요.

방식은 간단합니다. 파일을 읽고, 문자열을 대체한다. 물론 우아 하게 대체를 합니다. 그래도 짧은 시간안에 StringBuilder 와 "...." + "..."+를 갈아 치우게 되었습니다.

일단 잡다한 미사어구는 집어 치우고 예제들어갑니다.
예제는 String = ""; 이지만 실제는 File기반으로 쓰는경우가 더 많겠지요.



StringTemplate template = null;


// setAttrubte로 값을 넣습니다.

template = new StringTemplate("안녕하세요. 저는 $name$입니다.");

template.setAttribute("name", "lee,jaeil");

System.out.println(template.toString());


간단하게 StringTemplate를 생성하고, 대체할 문자는 $$를 씁니다. 형식이 틀리다면 에러를 냅니다.
setAttribute로 추가를 하고, toString()해주면 원하는 결과가 나옵니다.



StringTemplateGroup group = new StringTemplateGroup("mygroup", "특정폴더");

template = group.getInstanceOf("basic");

System.out.println(template.toString());


특정폴더에 basic.st라는 템플릿 파일을 읽어들입니다. 당연히 syntax는 모두 동일합니다.


static class User {

private String name;

private int age;

private String job;

public User(String name, int age, String job) {

super();

this.name = name;

this.age = age;

this.job = job;

}

public String getName() {

return name;

}

public int getAge() {

return age;

}

public String getJob() {

return job;

}

public String toString() {

return String.format("{name : %s, age : %s, job :%s}", name, age, job);

}

}


User me = new User("lee,jaeil", 19, "student");

template = new StringTemplate("안녕하세요. 저는 $user.name$이고 $user.age$살이고 $user.job$입니다.");

template.setAttribute("user", me);

System.out.println(template.toString());


내장객체가 아닌 유저가 만든 객체도 넣습니다. 물론 이게 안되면 말이 안되죠. 접근은 .을 씁니다.
사실은 객체의 toString()메소드를 출력하는것입니다. String, int boolean 모두 toString을 뽑아냅니다.

template = new StringTemplate("$user$");

template.setAttribute("user", users);

System.out.println(template.toString());




//  map도 지원합니다.

HashMap hm = new HashMap();

hm.put("name", "lee,jaeil");

hm.put("age", 19);

hm.put("job", "student");

template = new StringTemplate("안녕하세요. 저는 $user.name$이고 $user.age$살이고 $user.job$입니다.");

template.setAttribute("user", hm);

System.out.println(template.toString());

물론 Map도 지원합니다.


// Multi Values일 경우 이여 붙히지만, 구분자를 둘수 있습니다.

// Collection도 됩니다.

User[] users = new User[] {

new User("lee, jaeil", 19, "student")

, new User("seo,hyunju", 18, "student")

};

template = new StringTemplate("안녕하세요. $users; separator=\", \"$ 입니다.");

template.setAttribute("users", users);

System.out.println(template.toString());

배열일경우 연달아 출력하고 $$에 ;를 이용해서 args를 줄수있습니다. 배열일경우 separator를 인식합니다. 값은 꼭 ""를 사용해야합니다.


// Group을 정하고 다른 Template을 include  합니다.

// Group을 정해야 다른 템플릿을 사용가능합니다.

StringTemplateGroup group = new StringTemplateGroup("mygroup", "/Users/jilee/Documents/workspace-sts-2.2.1.RELEASE/StringTemplateSample/sample");

template = group.getInstanceOf("basic");

System.out.println(template.toString());

특정 폴더 이하를 group으로 묶을수 있습니다. basic.st와 bold.st를 그위치에 지정합니다.

basic.st

안녕하세요. $bold(it="test")$  입니다.


bold.st

<b>$it$</b>


bold라는 템플릿을 인클루드합니다. it는 템플릿이 args를 받을수 있는데 기본 변수 이름이 it입니다.

// 템플릿 파일을 property에 : 로 접근하여 사용할수 있습니다.

template = new StringTemplate(group, "안녕하세요. 저는 $user.name:bold()$이고 $user.age$살이고 $user.job:bold()$입니다.");

template.setAttribute("user", me);

System.out.println(template.toString());

템플릿Include를 이용해서 다양한 기능을 구사 할수 있습니다. :접근자를 이용해서 bold템플릿을 치환하고 그 값은 $it$로 받게 되어 <b></b>를 끼워 넣을수 있습니다.
간단한 템플릿을 구성하면
<html>
<head>$head()$</head>
<body>
<div>
$content()$
</div>
<div>
$footer()$
</div>
</body>
</html>

위와 같은 식으로 group으로 묶은 폴더 밑에 head.st, conten.st, footer.st를 구성할수 있습니다.


// 반복된값을 출력합니다.

// :{}를 사용합니다. :{ 와 | 사이의 이름으로 각각의 객체를 받습니다.

template = new StringTemplate("$users:{u | <ul><li>$u.name$,  $u.age$, $u.job$</li></ul>}; separator=\"\n\"$");

template.setAttribute("users", users);

System.out.println(template.toString());

Table에서 row값출력을 구현할수 있습니다. jstl의 foreach보다 훨씬 간단하지만, 그래서 햇갈렸습니다. :{}접근자를 이용해서 u라는 인스턴스로 각각의 값을 받아 users갯수만큼 그려주게 됩니다. 마찬가지로 ;를 이용해 separator를 줄수 있습니다.



// 조건문을 사용

template = new StringTemplate("$if(users)$ $users:{u | <ul><li>$u$</li></ul>}; separator=\"\n\"$ $endif$");

//template.setAttribute("users", users);

System.out.println(template.toString());

$if(...) ...값이 존재하거나 size 0보다 크다,  boolean true일때 참이게 됩니다.



//$를 쓰고 싶다면 \를 사용

template = new StringTemplate("\\$ $\\n$ $\\t$ $\\r$");

System.out.println(template.toString());


//주석도 사용할수 있음

template = new StringTemplate("$! this is a comment !$ ");

System.out.println(template.toString());

뭐 이건 알아두면 좋구요. $값이 중요한 시그니처임으로 템플릿에서는 \값을 이용해야 출력할수 있습니다.


마지막으로 가장중요한 Format에 대하 알아보겠습니다.

static class StringRender implements AttributeRenderer {

@Override

public String toString(Object o) {

return o.toString();

}

@Override

public String toString(Object o, String formatName) {

if("escape".equals(formatName)) {

String s = o.toString();

return s.replaceAll("<", "&lt;").replaceAll(">", "&gt;");

}

return toString(o);

}

}

static class DateRender implements AttributeRenderer {


@Override

public String toString(Object o) {

return o.toString();

}


@Override

public String toString(Object o, String formatName) {

if("simple".equals(formatName)) {

return new SimpleDateFormat("yyyy-MM-dd").format(o);

}

return toString(o);

}

}

처음에 당황스러운게 html에서 중요한 specialchars를 변환하는 내장기능이 없었습니다. 문서를 보니 해당 도메인마다 적절하게 구현 해주면 되는것이더군요. 특정객체를 선언하고 formatName을 다르게 받아 여러가지 포맷팅을 가능하게 해줍니다. 

// AttributeRenderer를 이용하여 포맷을 결정한다.

template = new StringTemplate("Today date is $currentTime; format=\"simple\"$ $html; format=\"escape\"$");

template.registerRenderer(String.class, new StringRender());

template.registerRenderer(Date.class, new DateRender());

template.setAttribute("currentTime", new Date());

template.setAttribute("html", "<a href=\"\">test</a>");

System.out.println(template.toString());



기본적인 StringTemplate기능을 소개해봤습니다. 저는 몰랐지만, www.jGuru.com에서 쓰던 Template엔진을 라이브러리로 제공한것이라고 하더군요. 다음번에는 MVC모델에 직접 적용해봐야겠습니다.

참고자료


예제파일을 추가했습니다.
BasicUsage.java


Trackback 2 Comment 1