Office Automation VS OpenXML SDK

Hej,

Dynamiczne generowanie dokumentów jest funkcjonalnością, którą czasem chcielibyśmy dodać w swoim programie. Jeśli np.: implementujemy aplikację wspomagającą redagowanie tekstu warto byłoby umożliwić eksport stworzonego dokumentu do formatu obsługiwanego przez Worda w celu dalszej edycji.

Kiedy już podejmiemy decyzję o dodaniu możliwości wygenerowania dokumentu, zaczniemy poszukiwać sposobu jego implementacji. Możliwości są różne i zależą od formatu pliku, który chcemy uzyskać. Wśród dostępnych rozwiązań warte uwagi wydaje się użycie mechanizmu automatyzacji udostępnianego przez pakiet Office lub stworzenie dokumentów w oparciu OpenXML SKD. W tym artykule postaram się przybliżyć zalety i wady każdego z nich. Będę się opierał na informacjach dotyczących głównie generowania dokumentów Worda, ponieważ z nim miałem głównie do czynienia :).

Automation for Office (Office Interop)

Jeśli posiadasz zainstalowany pakiet Office, możesz do generacji dokumentów wykorzystać API, które udostępnia np.: Word. Obsługa może wydawać się początkowo dość niewygodna, szczególnie ze względu na dużą ilość argumentów przyjmowanych przez poszczególne metody.

Już podczas nauki podstaw można zauważyć dużą analogię kolejnych metod do operacji wykonywanych przez użytkownika. Dzięki temu podczas implementacji rozwiązań można wykorzystywać do pomocy samego Worda :). Wystarczy nagrać makro realizujące daną funkcjonalność i przeczytać wygenerowany kod. Z jego pomocą znacznie łatwiej stworzyć odpowiedni własny kod w implementowanej aplikacji.

Wadą mechanizmu Office Automation jest wymóg posiadania pakietu Office na komputerze docelowym, na którym będzie uruchamiana nasza aplikacja. Nie twierdzę, że wadą jest posiadanie Office'a, bo sam go używam i zwykle podobają mi się jego możliwości. Niewygodne jest natomiast wymaganie posiadania pakietu przez osobę, która być może go nie ma, a chciałaby skorzystać z naszego programu. W takim przypadku zamiast kupić go, żeby używać naszej aplikacji, wybierze raczej alternatywę, która takiego wymogu nie posiada. Konieczność posiadania Office'a wynika z faktu, że posługując się Office Automation w swojej aplikacji, uruchamiamy tak naprawdę proces odpowiedniego programu z pakietu Office, który wykonuje kolejno operacje odpowiadające metodom wywoływanym z wnętrza programu.

Inną wadę może stanowić również nieduża szybkość działania, szczególnie podczas operacji na tabelach (wygenerowanie zaledwie kilkunastu stron z tabelami może zająć nawet kilka minut). Trzeba o tym pamiętać projektując sposób generowania (np.: używając szablonów i ograniczając liczbę operacji na tabelach), co może pozwolić na znaczne przyspieszenie szybkości działania. Istnieją również sposoby pozwalające zwiększyć wydajność tego mechanizmu np.: poprzez zmianę pewnych opcji konfiguracyjnych. W zależności od konkretnego przypadku szybkość nie musi więc być jego wadą.

Generowania dokumentów za pomocą Office Automation powinno się też (poza pewnymi uzasadnionymi przypadkami) unikać w aplikacjach serwerowych. Wymagany jest oczywiście zakup pakietu do zainstalowania na serwerze, jednak problem tkwi w braku przystosowania tej metody generacji dokumentów do środowiska serwerowego. Taki scenariusz użycia nie jest zalecany ani wspierany przez Microsoft. Z tego względu nawet w pełni działające rozwiązanie może np.: przestać poprawnie funkcjonować po aktualizacji systemu. Na tej stronie możemy zapoznać się z bardziej szczegółowymi informacjami o komplikacjach, które mogą wystąpić podczas używania Office Automation w środowisku serwerowym.

Zaletą implementacji rozwiązania w oparciu o ten mechanizm generacji dokumentów jest niewątpliwie zapewnienie zgodności z danym formatem pliku, a także dostępność wszystkich formatów obsługiwanych przez odpowiednią aplikację. Liczbę dostępnych formatów można zwiększyć np.: poprzez instalację odpowiedniego dodatku do Office'a, dostępnego na stronie Microsoftu uzyskujemy możliwość zapisu w formatach PDF i XPS.

OpenXML SDK

W pakiecie Office 2007 występujące we wcześniejszych wersjach domyślne formaty zapisu, jak *.doc, *.xls, *.ppt zostały zastąpione przez odpowiedniki z końcówką x (*.docx, *.xlsx, *.pptx). Różnica nie sprowadza się jednak tylko do dodania nowej literki na końcu rozszerzenia :P. W przeciwieństwie do swoich poprzedników nowe formaty są oparte na skompresowanym zestawie struktur XMLowych, co pozwala łatwo modyfikować je bez specjalnego API (są to archiwa ZIP, które można otworzyć np.: programem 7-zip dostępnym na łamach portalu) :). W celu ułatwienia programistom operowania na strukturach dokumentów wydane zostało OpenXML SDK, które dostarcza typowane klasy odpowiadające różnym elementom zawartym w pliku, jak tabele, nagłówki, style itp.

Ze strony Microsoftu pobrać można również narzędzie pozwalające na podgląd struktury wybranego dokumentu. Nawigując po jej drzewie możemy wyświetlać dokumentację poszczególnych elementów, odpowiadające mu poddrzewo w postaci XML, a także kod programu potrzebny do jego odtworzenia. Możemy więc np.: stworzyć dokument w Wordzie i zobaczyć jak został wygenerowany, aby później odwzorować taką strukturę podczas dynamicznej generacji.

Wadami, które zauważyłem przed czas korzystania z tego sposobu generacji dokumentów są czasem mylące informacje, które można znaleźć w sieci szukając rozwiązań konkretnych problemów wynikające być może z różnic pomiędzy SDK w wersji 1 oraz 2.

OpenXML SDK w wersji 2.0 oraz narzędzie umożliwiające podgląd dokumentów można pobrać ze strony Microsoftu. Ponadto z tej strony można pobrać oficjalnie udostępniony zestaw snippetów, które mogą dodatkowo ułatwić implementację w typowych przypadkach.

Podsumowanie

Moim zdaniem wygoda implementacji rozwiązań w obu przypadkach jest zbliżona, jednak XMLowa struktura w drugim przypadku pozwala łatwiej zapanować nad tworzonym dokumentem, co przemawia na korzyść tego rozwiązania.

OpenXML SDK może generować dokumenty szybko i nie wymaga zainstalowanego Office'a na komputerze, na którym nasz program będzie uruchamiany. Jego wadą jest możliwość wygenerowania dokumentów tylko w nowych formatach Office'a, formatach zgodnych z OpenXML (jak *.docx, *.xlsx oraz *.pptx).

Jeśli natomiast jednym z wymagań jest wygenerowanie dokumentów w starszym formacie i nie posiadamy odpowiedniego konwertera, Office Automation wydaje się być dobrym wyborem.

Możliwym rozwiązaniem jest również np.: wygenerowanie dokumentu za pomocą OpenXML SDK i późniejsze użycie Office Automation w celu konwersji gotowego już pliku do wybranego formatu.

Mam nadzieję, że informacje tu zebrane pomogą dokonać właściwego wyboru osobom, które chcą zawrzeć funkcjonalność związaną z generacją dokumentów w tworzonych przez siebie aplikacjach.

Pozdrawiam,

Łukasz