CodeBuilder

CodeBuilder — это простой в использовании и лёгкий инструмент для генерации кода на основе физической модели базы данных. Поддерживает C#, Java, Ruby, PHP и XML.

Содержание

• Особенности;
• Руководство пользователя;
  • Системные требования;
  • Быстрый старт;
  • Создание шаблонов кода;
  • Конфигурация;
• Для разработчиков;
  • Среда разработки и выполнения;
  • Архитектура;
• Часто задаваемые вопросы.

Особенности а. Поддержка импорта структуры таблиц базы данных из PowderDesigner12+ (PDM), SQLserver 2000/2005/2008, Oracle или MySQL 5. б. Использование шаблонов Velocity для генерации кода.

Руководство пользователя

Системные требования

а. Windows 7 или более поздняя версия. б. .NET Framework 4.0 или более поздняя версия (необязательно).

Быстрый старт

1. Установите программу. Можно скачать двоичный исполняемый файл с сайта разработчика, а затем распаковать его.
2. Настройте источник данных. Дважды щёлкните на файле codebuilder.exe в папке CodeBuilder, чтобы запустить приложение. Затем в меню выберите «Инструменты → Конфигурация источника данных». Добавьте нужные источники данных и нажмите «ОК».
3. Импортируйте таблицы и представления из источника данных. В меню выберите «Файл → Экспорт из источника данных → Выбрать конкретную базу данных», после чего подождите несколько секунд, пока не отобразятся все таблицы и представления текущей базы данных.
4. Сгенерируйте код: а. Выберите все или некоторые таблицы и представления. б. Укажите нужный язык программирования (C#, Java, Ruby, PHP или XML). в. Задайте корневое пространство имён (например, com.easytoolsoft.codebuilder). г. Установите префикс для таблиц, автора и версию (эти параметры необязательны). д. Выберите один или несколько шаблонов кода. Пользовательские шаблоны создаются по инструкции в разделе «Создание шаблонов кода». е. Если вы хотите удалить префиксы перед именами таблиц при генерации кода или использовать стиль именования CamelCase (например, таблица с именем easy_tools_soft будет преобразована в EasyToolsSoft), отметьте соответствующие опции. ж. Нажмите кнопку «Сгенерировать», чтобы выполнить генерацию кода, затем перейдите в каталог сгенерированных файлов.

Создание шаблонов кода

1. Создайте текстовый файл в формате UTF-8. Используйте язык Velocity для вставки содержимого, которое требуется в шаблоне, из объекта TDO.

2. Объект TDO (Template Data Object) содержит следующие свойства: | Свойство | Тип | Описание | | --- | --- | --- | | Name | string | Имя шаблона данных | | Language | string | Язык программирования (например, csharp, java, ruby, php, xml и т. д.) | | Database | string | База данных (например, mysql5, sqlserver2000, 2005, 2008, oracle и т. д.) | | Package | string | Пространство имён или пакет (например, com.easytoolsoft) | | TablePrefix | string | Префикс таблицы (например, cb_table) | | Author | string | Автор кода | | Version | string | Версия кода | | TemplateEngine | string | Название движка шаблонов, по умолчанию nvelocity | | TemplateName | string | Отображаемое имя шаблона (например, example.java.nv) | | Prefix | string | Префикс шаблона | | Suffix | string | Суффикс шаблона | | Encoding | string | Кодировка сгенерированного файла кода (например, utf8, utf7, ascii и т. д.) | | TemplateFileName | string | Имя файла шаблона (например, example.java.nv) | | CodeFileName | string | Сгенерированное имя файла кода (например, Example.java) | | IsOmitTablePrefix | bool | Указывать ли префикс таблицы при генерации кода (например, убрать «cb» из «cb_table») | | IsCamelCaseName | bool | Использовать ли стиль именования CamelCase (например, преобразовать «cb_table» в CbTable) | | ModelObject | object | Модель объекта, соответствующая таблице или представлению базы данных. Свойства см. ниже.

3. Модель объекта (ModelObject) имеет следующие свойства: | Свойство | Тип | Описание | | --- | --- | --- | | Id | string | Идентификатор таблицы или представления в базе данных (например, cb_table) | | DisplayName | string | Отображаемый текст, по умолчанию значение свойства Name | | Name | string | Имя таблицы или представления, написанное заглавными буквами в стиле CamelCase (например, CbTable для cb_table) | | OriginalName | string | Исходное имя таблицы или представления (например, cb_table) | | Comment | string | Комментарий к таблице или представлению в базе данных | | MetaTypeName | string | Тип метаданных: table или view | | Columns | Dictionary[string, Column] | Все столбцы таблицы или представления | | PrimaryKeys | Dictionary[string, Column] | Первичные ключи таблицы | | Keys | Dictionary[string, Column] | Непервичные ключи таблицы |

4. Столбец (Column) имеет следующие свойства: | Свойство | Тип | Описание | | --- | --- | --- | | Id | string | Идентификатор столбца в таблице или представлении (например, first_name) | | DisplayName | string | Отображаемый текст, по умолчанию значение свойства Name | | Name | string | Имя столбца, написанное заглавными буквами в стиле CamelCase (например, FirstName для first_name) | | LowerCamelName | string | Имя столбца, записанное строчными буквами в стиле CamelCase (например, firstName для first_name) | | OriginalName | string | Оригинальное имя столбца (например, first_name) | | Comment | string | Комментарий столбца | | DataType | string | Тип данных столбца в базе данных (например, int, bigint, varchar и т. д.) | | DefaultValue | string | Значение по умолчанию для столбца в базе данных | | LanguageType | string | Тип данных языка программирования, соответствующий типу данных столбца (например, C# int, long, string и т. д.) | | LanguageDefaultValue | string | Значение по умолчанию для столбца на языке программирования | | Length | int | Длина типа данных столбца | | Ordinal | int | Порядковый номер столбца в таблице | | IsAutoIncremented | bool | Является ли столбец автоматически увеличивающимся | | IsNullable | bool | Может ли столбец быть пустым | | IsComputed | bool | Вычисляемый ли это столбец | | HasDefault | bool | Есть ли у столбца значение по умолчанию | | MetaTypeName | string | Метатип данных, значение «column» |

5. Добавьте созданный шаблон кода в список шаблонов CodeBuilder.

6. Шаблоны можно добавить, удалить или изменить в настройках программы.

Конфигурация

Управление источниками данных

Управление шаблонами

Управление языками программирования

Сопоставление типов данных

Прочее

Для разработчиков

Среда разработки и выполнения

а. Visual Studio 2010 или SharpDevelop 4.1 и выше. б. Microsoft .NET 4.0 или Mono .NET 2.10 и выше. в. NUnit 2.5 и выше. г. Moq 3 и выше. д. Velocity.

Архитектура

Часто задаваемые вопросы