Используем процессор шаблонов. NVelocity.

В этой статье я расскажу о том, как можно решить проблему создания представлений для моделей, используя NVelocity. Классическая задача программиста: имея бизнес объект(Model) необходимо построить для него представление(View). При решении подобной задачи, требуется помнить о том, что для конкретной модели может быть несколько представлений, в то время, как модель даже о них и не догадывается. На сегодняшний день существует несколько известных View Engine:

• System.Web.Mvc.WebFormViewEngine
• Brail
• NDjango
• NHaml
• NVelocity
• Spark View Engine

Использование каждого, это дело вкуса (сравнение), но в этой статье я хотел бы поделиться опытом использования мною NVelocity в своем проекте. Скачать NVelocity можно как отдельно в виде библиотеки, так и в составе СastleProject. Последнее идет полной сборкой и добавляет в Visual Studio поддержку intellisense. После того как вы установили NVelocity, необходимо добавить в проекте reference, это сделает доступным следующие пространства имен:

using NVelocity;

using NVelocity.App;

using NVelocity.Context;

Подготовительная часть пройдена. Вернемся к нашему проекту и озвучим постановку задачи: дан источник данных, возвращающий коллекцию элементов типа Person, оформленный в виде статического метода:

static Person[] GetFriends()

{

    Person[] group =

    {

        new Person { Name = "Илья",    Age = 24, IsMale = true },

        new Person { Name = "Алексей", Age = 22, IsMale = true },

        new Person { Name = "Наталья", Age = 25, IsMale = false },

        new Person { Name = "Борис", Age = 23, IsMale = true }

    };

    return group;

}

Где тип Person описывается следующим классом:

class Person

{

    // Имя

    public String Name { get; set; }

    // Возраст

    public int Age { get; set; }

    // Пол

    public bool IsMale { get; set; }

}

Для данной модели(коллекция, возвращаемая методом GetFriends()) необходимо создать представление в виде следующего XML файла:

<?xml version="1.0" encoding="utf-8"?>

 

<group name="Друзья">

    <person

        name="ИЛЬЯ"

        age="24"

        gender="м" />

    <person

        name="АЛЕКСЕЙ"

        age="22"

        gender="м" />

    <person

        name="НАТАЛЬЯ"

        age="25"

        gender="ж" />

    <person

        name="БОРИС"

        age="23"

        gender="м" />

</group>

Приступаем выполнению, и первое что делаем, это пишем шаблон(Template). Шаблон реализуется на интуитивно понятном языке Velocity Template Language (VTL). Для этого добавим в проект файл xmlTemplate.vm со следующим содержимым:

## Инициализация локальных переменных

#set($male = "м")

#set($female = "ж")

## Шаблон

<?xml version="1.0" encoding="utf-8"?>

 

<group name="$groupName">

#foreach( $person in $group)

    <person    

        name="$person.Name.ToUpper()"

        age="$person.Age"

        gender="#if($person.IsMale)$male#else$female#end" />

#end

</group>

Самое главное мы реализовали, осталось лишь выполнить инициализацию нашего View Engine, указать ему шаблон, подсунуть модель и получить на выходе готовое представление:

static void Main(string[] args)

{

    // Получим модель

    Person[] group = GetFriends();

 

    // Инициализируем ViewEngine.             

    Velocity.Init();

 

    // Инициализируем контекст моделью.

    VelocityContext context = new VelocityContext();

    context.Put("groupName", "Друзья");

    context.Put("group", group);

 

    using (StringWriter writer = new StringWriter())

    {

        // Используя шаблон, построим отображение модели.

        Velocity.MergeTemplate

            (

            @"xmlTemplate.vm",

            Encoding.UTF8.WebName,

            context,

            writer

            );

 

        Console.WriteLine(writer.GetStringBuilder().ToString());

    }

    Console.ReadKey();

}

Преимущества данного подхода заключается в том, что мы можем изменять шаблон (xmlTemplate.vm) и при этом не трогая(!) исходный код. Во-вторых, исходный код программы при таком подходе лишен громоздких, формирующих представление модели, конструкций. В-третьих, получившийся шаблон не зависит ни от платформы, ни от языка на котором реализован сам движок.