Создаем IT-продукты на заказ

За 5 лет мы создали продукты с топовыми e-commerce компаниями, ритейлом, банками и другими бизнесами по всему миру.

Специализируемся на SaaS-решениях на архитектуре микросервисов, делаем аналитику IT-проекта перед стартом.

Посмотрите, что говорят о нас клиенты и как комфортно мы стартуем проекты.

Для обсуждения проекта пишите на ceo@byndyusoft.com или звоните +7 (904) 305 5263

понедельник, 6 февраля 2012 г.

FluentOpenXml - Foxby

Foxby — это библиотека для работы с Word документами в формате OpenXml. Предназначена для генерации документов по шаблону и внесения изменений в существующие документы. С помощью неё вы сможете отказаться от работы с COM+ или редактирования OpenXML-дерева через OpenXML SDK и перейти к механизму построения структуры документа из метаэлементов в декларативном виде.

В классе решаемых задач: создание параграфов, создание и заполнение таблиц, списков, работа с изображениями, форматирование и т.п. Фактически библиотека является оберткой над OpenXML SDK с API в виде Fluent-интерфейса.

Преимущества использования

Мы сами используем эту библиотеку уже в двух проектах. Первая версия была написана Тимуром и зарождалась, как часть подсистемы проекта по работе с Word-документами, но в дальнейшем была вынесена в самостоятельный проект.

Можно выделить следующие преимущества:

  1. На сервере, где работает ваше приложение, не требуется установка Microsoft Office
  2. Нет проблемы с зависшими процессами Word
  3. Работает гораздо быстрее, чем COM+
  4. Создание и изменение документов не требует записи на жесткий диск, всё происходит в оперативной памяти
  5. Удобный Fluent API для работы с объектами Word
  6. Возможность построения своего метаязыка разметки документа

Установка

Последнюю версию можно установить через NuGet:

Исходный код и лицензия

Исходный код написан на .NET 4.0/C# и выложен на Google Code:fluent-openxml компанией IndyCode под лицензией LGPL.

Примеры использования

Ниже приведены примеры, с помощью которых можно будет начать работать с библиотекой.

Пример №1 - Hello Word!

private static void Main()
{
 using (var docxDocument = new DocxDocument(SimpleTemplate.EmptyWordFile))
 {
  var builder = new DocxDocumentBuilder(docxDocument);

  builder
   .Tag(SimpleTemplate.ContentTagName,
     x => x.Center.Paragraph(z => z.Bold.Text("Hello Word!")));

  File.WriteAllBytes(string.Format(@"D:\Word.docx"), docxDocument.ToArray());
 }
}

SimpleTemplate.EmptyWordFile это шаблон, который встроен в саму библиотеку. В шаблоне ничего нет, кроме тэгов для верхнего колонтитула, контента и нижнего колонтитула. Этот шаблон отлично подойдет для тестовых целей и генерации простых документов.

Вместо File.WriteAllBytes, который записывает файл на диск, массив байт можно передавать как FileResult, чтобы пользователь сразу получал сгенерированный документ.

Иерархия вложения должна помочь понять идеологию работы с библиотекой:

Пример №2 - Создадим договор

Очень часто требуется создать договор или счет-фактуру. Этот пример показывает типичный сценарий создания документа. Для простоты переменные берутся не из базы данных, а определяются переменными.

private static void Main()
{
 string customerName = "Иванов И.В.";
 string orderNumber = "4";
 string itemName1 = "Табуретка";
 string itemSumm1 = "5 000";
 string itemName2 = "Кран погрузочный";
 string itemSumm2 = "6 342";
 string summ = "11 342";

 using (var docxDocument = new DocxDocument(SimpleTemplate.EmptyWordFile))
 {
  var builder = new DocxDocumentBuilder(docxDocument);

  builder
   .Tag(SimpleTemplate.ContentTagName,
     x => x
     .Center.Paragraph(z => z.Bold.Text(string.Format("Договор №{0}", orderNumber)))
     .Right.Paragraph(string.Format("от {0} г.", DateTime.Now.ToString("dd MMMM yyyy")))
     .Left.Paragraph(string.Format("Я, {0}, покупаю:", customerName))
     .Table(t => t.Column("Товар", 70).Column("Цена, руб.", 30),
         r => r.Row(itemName1, itemSumm1)
         .Row(itemName2, itemSumm2)
         .Row(w => w.Right.Bold.Text("Итого:"), w => w.Center.Bold.Underlined.Text(summ))
     ));

  File.WriteAllBytes(string.Format(@"D:\Word.docx"), docxDocument.ToArray());
 }
}

Пример №3 - Изменяем созданный документ

Сценарий:

  • Создаем документ за подписью Иванова К.И.
  • Отправляем документ на согласование
  • Электронный документ возвращают и говорят, что подписывать должен Петров А.И.
  • Меняем подписывающего в документе
private static void Main()
{
 using (var docxDocument = new DocxDocument(SimpleTemplate.EmptyWordFile))
 {
  var builder = new DocxDocumentBuilder(docxDocument);

  builder
   .Tag(SimpleTemplate.ContentTagName,
     x => x.Left.Paragraph("Договор на оказание услуг...")
      .Right.Paragraph(z => z.Placeholder("SIGNER_NAME", "Иванов К.И.")));

  File.WriteAllBytes(string.Format(@"D:\Word.docx"), docxDocument.ToArray());
 }

 using (var docxDocument = new DocxDocument(File.ReadAllBytes(@"D:\Word.docx")))
 {
  var builder = new DocxDocumentBuilder(docxDocument);

  builder
   .Placeholder("SIGNER_NAME", x => x.Text("Петров А.И."));

  File.WriteAllBytes(string.Format(@"D:\Word.docx"), docxDocument.ToArray());
 }
}

Пример №4 - Создаем документ "с нуля"

private static void Main()
{
 using (var docxDocument = new DocxDocument())
 {
  docxDocument.AddOpenCloseTag("CONTENT");

  var builder = new DocxDocumentBuilder(docxDocument);

  builder
   .Tag("CONTENT", x => x.Left.Paragraph("Договор на оказание услуг..."));

  File.WriteAllBytes(string.Format(@"D:\Word.docx"), docxDocument.ToArray());
 }
}

Пример №5 - Модульные тесты

К библиотеке написано довольно много модульных тестов, с помощью которых вы сможете еще лучше понять сценарии работы системы. Скачать исходный код с тестами можно с Google Code:fluent-openxml.

Плюшки

Александр Зайцев поразвлекался и сделал довольно интересную реализацию:

builder
 .Tag("CONTENT", x => x.Paragraph("Жирный ".Bold() + "Курсив ".Italic() + "Подчеркнутый ".Underlined() + "Нормальный"));

Такой способ можно использовать для текста, как альтернативу свойства Bold.

Обратная связь

Эта библиотека может быть лучше и работать различными специфическими ситуациями, если вы дадите нам обратную связь.


Ссылки

Оригинал моей статьи на Хабре

Видео и слайды с конференции DotNetConf: Анонс OpenSource библиотеки для создания и изменения документов в формате OpenXml через Fluent-интерфейс

33 комментария:

  1. Очень интересная библиотека. Возьму на заметку.
    Практически все преимущества принадлежат OpenXML, а сюда просто скопированы?

    ОтветитьУдалить
  2. Почему не Open XML SDK (http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=5124)

    ОтветитьУдалить
  3. > Почему не Open XML SDK?
    Наверное из-за её "мощности" :) Сам написал небольшую обертку над этой библиотекой, чтобы было проще работать. А у этих ребят свой подход к упрощению. Глянем!

    ОтветитьУдалить
  4. @Мурадов Мурад @orsol

    Работать с OpenXML SDK напрямую очень сложно. Попробуйте сделать примеры из статьи на OpenXML SDK и сравните по читаемости кода и сложности реализации.

    ОтветитьУдалить
  5. @ShurikEv

    Можно ваше решение где-нибудь глянуть?

    ОтветитьУдалить
  6. @Александр
    К сожалению, его нет в открытом доступе. Да и оно скорее всего "часть подсистемы проекта по работе с Word-документами", точнее с документами Office и решает только узкий спектр задач, которого вполне достаточно. Конечно хочется вывести библиотеку на новый уровень, да хвастаться пока не чем :)

    ОтветитьУдалить
  7. @ShurikEv

    Если выложите, то напишите мне пожалуйста, будет интересно посмотреть :)

    ОтветитьУдалить
  8. А что делать, если требуется сохранение файлов в формат .doc (бинарный формат) ? есть ли способ не использовать COM ?

    ОтветитьУдалить
  9. @Дмитрий

    К сожалению, нет. Возможно есть платные библиотеки, которые разобрали внутренний формат DOC-файлов, но я таких не видел.

    ОтветитьУдалить
  10. Спасибо за статью! Очень полезная вещь, особо радует работа с таблицами

    ОтветитьУдалить
  11. @Nikita Govorov

    Разверните, пожалуйста, вопрос.

    ОтветитьУдалить
  12. Я боюсь, что технология COM+ мало имеет отношения к генерации документов.

    ОтветитьУдалить
  13. @Nikita Govorov

    А вы как работаете с DOC-файлами?

    ОтветитьУдалить
  14. @Nikita Govorov

    Ну да. А какие еще есть варианты?

    Вы очень немногословны :)

    ОтветитьУдалить
  15. Я хотел намекнуть, о то что COM+ это не то что вы имели ввиду. :)

    ОтветитьУдалить
  16. @Nikita Govorov

    А в чем ошибка? Видимо я не в теме.

    ОтветитьУдалить
  17. @Дмитрий

    http://bytescout.com/products/developer/documentsdk/index.html

    ОтветитьУдалить
  18. @Nikita Govorov

    Я правильно понял, что Microsoft.Office.Interop это COM объекты, а не COM+?

    ОтветитьУдалить
  19. @Nikita Govorov

    Вы бы сэкономили 12 комментариев, если написали это первым предложением.

    ОтветитьУдалить
  20. Два вопроса:
    1) Что вы будете делать, если понадобится генерировать файлы именно в старом, бинарном формате (.doc) ?
    2) Не реализовывали ли вы подобный функционал для Excel ? если да, то хочется посмотреть исходники

    ОтветитьУдалить
  21. 1) Формат .doc признан самим Microsoft устаревшим, он неудобен, не является открытым четким стандартом и кроме того, даже в таком старичке как MS Word 2003 проблема просмотра и редактирования документов в формате .docx решается установкой SP3 и т.н. Compatibility Pack, поэтому задача генерации документов в формате .doc в принципе не стоит.
    2) В текущей версии Foxby реализована поддержка Excel, но при этом она весьма ограничена, т.к. продиктована возникшей перед нами необходимостью. Соответственно если у вас есть feature request по конкретным вопросам работы с .xlsx-файлами, то вы можете написать нам в github'овский раздел issues: https://github.com/IndyCode/Foxby/issues

    ОтветитьУдалить
  22. в болге оч нехватает кнопчки  "твитнуть статейку" ((

    ОтветитьУдалить
  23. сори, нашел.. очень спратанная...

    ОтветитьУдалить
  24. Добавил большие кнопки для расшаривания. Спасибо!

    ОтветитьУдалить
  25. Прикрутите ещё ODF, здорово будет :)

    ОтветитьУдалить

Создаем IT-продукты на заказ

За 5 лет мы создали продукты с топовыми e-commerce компаниями, ритейлом, банками и другими бизнесами по всему миру.

Специализируемся на SaaS-решениях на архитектуре микросервисов, делаем аналитику IT-проекта перед стартом.

Посмотрите, что говорят о нас клиенты и как комфортно мы стартуем проекты.

Для обсуждения проекта пишите на ceo@byndyusoft.com или звоните +7 (904) 305 5263