Czy kiedykolwiek potrzebowali Państwo schematu dla Apache Ant?

Ostatnio miałem problemy z plikami konfiguracyjnymi Ant dla projektu programistycznego, nad którym pracowałem. Edytowałem jeden z nich w programie XMLSpy, ale nie otrzymywałem podpowiedzi ani automatycznego uzupełniania kodu, ponieważ do mojego skryptu nie został przypisany żaden schemat.

Wydało się, że to prosty problem, więc wyruszyłem w poszukiwaniu odpowiedniej schematu.

Szybko znalazłem na Stack Overflow pytanie, w którym ktoś szukał dokładnie tego samego. Okazało się, że odpowiedź brzmi: nie istnieje żadna definicja schematu ani DTD dla Anta. Powód jest prosty: oprócz trudności związanych z stworzeniem elastycznego i kompleksowego modelu rdzenia Anta, taki schemat musiałby uwzględniać wszystkie zewnętrzne zadania.

Od razu przypomniałem sobie, że byłem tutaj już wcześniej, kilka lat temu, ale tym razem pomyślałem, że wykorzystam funkcję generowania schematów w programie XMLSpy, aby spróbować coś z tym zrobić

Jeśli nie zostanie opracowany oficjalny schemat, można użyć programu XMLSpy, aby szybko stworzyć własny, który będzie obejmował konkretne funkcje i zadania, z których korzystasz. W miarę korzystania z większej liczby funkcji, dodawanie ich do pliku XSD jest stosunkowo prostym zadaniem, a w zamian otrzymujesz doskonałe wsparcie podczas edycji i pomoc w walidacji.

XMLSpy może generować schematy na podstawie zestawu plików XML. Działa to w następujący sposób: najpierw tworzysz projekt, wybierając opcję "Nowy projekt" w menu "Projekt". Upewnij się, że okno "Projekt" jest otwarte; jeśli nie, użyj menu "Okno", aby je otworzyć. Następnie dodaj swoje pliki Ant do folderu wewnątrz projektu, klikając prawym przyciskiem myszy na folder i wybierając opcję "Dodaj pliki".

Po dodaniu plików, kliknij prawym przyciskiem myszy na folderze i wybierz opcję "Generuj DTD/Schemat".

Mój projekt zawiera dziesiątki skryptów Ant, więc mamy dość szeroki zakres zastosowań Anta w procesie tworzenia oprogramowania. Oznacza to, że program XMLSpy będzie mógł zobaczyć wszystkie różne sposoby, w jakie wykorzystujemy Ant, i wygeneruje schemat, który obejmie wszystko, co do tej pory zrobiliśmy z wykorzystaniem Anta.

Generowanie schematu było bardzo proste. Mimo to, choć XMLSpy doskonale radzi sobie z generowaniem modeli, podanie mu 60 plików Ant z pewnością skutkuje powstaniem rozbudowanego schematu. Można zobaczyć moje ustawienia w oknie dialogowym "Generuj schemat" na tym zrzucie ekranu. Najważniejsze dla mnie było uzyskanie globalnych typów danych oraz kilku wyliczeń, co miało uprościć rozszerzanie schematu.

Zanim przystąpiłem do ulepszania nowego schematu XSD, musiałem zdecydować, jaki cel chcę osiągnąć dzięki temu projektowi.

Ant jest bardzo elastyczny i pozwala na używanie różnych typów danych w atrybutach, a wiele zewnętrznych zadań nie jest zdefiniowanych w przestrzeniach nazw. Nie potrzebowałem idealnego schematu, tylko taki, który byłby pomocny w tym projekcie. Moją intencją było stworzenie bardzo elastycznego schematu, który pozwoliłby programowi XMLSpy oferować funkcje wspomagające podczas edycji plików Ant, co przyspieszyłoby pracę.

W dłuższej perspektywie być może będziemy chcieli wprowadzić pewne udoskonalenia, aby ułatwić nam pisanie spójnych i poprawnych plików Ant, ale to jest kwestia przyszłości. Na razie chciałem jedynie stworzyć bardzo prosty prototyp.

Biorąc to pod uwagę, zacząłem upraszczać wygenerowany schemat. XMLSpy generuje pliki XSD, które obejmują wszystkie możliwe przypadki bardzo szczegółowo. Otrzymałem technicznie poprawny schemat, ale taki, który był nieco bardziej szczegółowy, niż chciałem lub potrzebowałem. Jednak w widoku XSD wystarczyło kilka minut przesuwania elementów i łączenia zbędnych gałęzi, aby uzyskać bardzo prosty model.

Pierwszym potwierdzeniem sukcesu było moment, w którym udało mi się zweryfikować wszystkie około 60 plików Ant w odniesieniu do mojej uproszczonej definicji XSD. Po dodaniu kilku elementów, które przypadkowo usunąłem podczas porządkowania, wszystko zaczęło działać. Kliknąłem prawym przyciskiem myszy na folderze projektu i wybrałem opcję "zweryfikuj wszystko". Cały proces weryfikacji przebiegł błyskawicznie, w ciągu zaledwie 5 sekund.

Drugim ważnym aspektem było korzystanie z pomocy kontekstowej w programie XMLSpy podczas tworzenia nowego pliku Ant. Szybko zdałem sobie sprawę, że z czasem będzie trzeba dodawać coraz więcej nowych elementów, w miarę jak będziemy wykorzystywać nowe zadania i funkcje. Na przykład, odkryłem, że muszę dodać element sysproperty do junit, ponieważ wcześniej go nie używaliśmy.

Dodawanie pojedynczych elementów lub atrybutów jest proste w widoku schematu, i z czasem będziemy musieli robić to coraz rzadziej.

Ogólnie rzecz biorąc, dla moich prostych potrzeb, stworzenie schematu Ant okazało się małym, ale satysfakcjonującym osiągnięciem.

Jeśli chcieliby Państwo wykorzystać mój bardzo prosty schemat jako punkt wyjścia do stworzenia własnego, proszę, mogą Państwo go pobrać tutaj: pobierz go tutaj. Dajcie mi znać, jak się u Was sprawdza.