Статьи

Диаграммы классов Maven Fluido Skin и Javadoc

Апрель 23, 2019
Я уже давно пользуюсь сайтами Maven и очень доволен этим. Мне не нравилось обновлять свои проекты после Maven 3, но это было нормально, Maven 3 принес много новых интересных вещей. Однако меня раздражали две вещи: отсутствие красивого и современного скина и просмотр Javadoc сложного кода. Мысль о создании собственного скина Maven даже приходила мне в голову, но у меня никогда не было времени читать об этом.

Но мир полон хороших и талантливых людей! Как ребята из 99soft . Они создали Maven Fluido Skin и пожертвовали его Apache Software Foundation . Он построен поверх Bootstrap Twitter и доступен из центрального репозитория Maven. Чтобы использовать его в своем проекте Maven, все, что вам нужно сделать, это добавить следующие параметры в ваш файл src / site / site.xml:

1
2
3
4
5
<skin>
    <groupId>org.apache.maven.skins</groupId>
    <artifactId>maven-fluido-skin</artifactId>
    <version>1.2.1</version>
</skin>

Вот список некоторых проектов, использующих скин Maven Fluido (надеюсь, в ближайшем будущем Apache Commons и другие проекты также примут этот скин по умолчанию):

Что касается просмотра Javadoc, то есть еще один хороший трюк: добавьте диаграммы классов. Я видел новый шаблон Javadoc в списке рассылки Apache Commons, но он находился в стадии разработки, поэтому сейчас я буду придерживаться диаграмм классов. Эти диаграммы генерируются, когда вы выполняете Javadoc или цели сайта, используя graphviz . И это еще не все. Вы можете нажать на классы диаграммы, так как они имеют ссылку на класс Java, на который они ссылаются.

Вы можете найти инструкции по настройке генерации диаграмм на веб-сайте Apache Maven или посмотреть примеры (я предпочитаю последнее). Но в основном вам понадобится установить graphviz и что-то вроде следующего фрагмента XML в вашем проекте pom.xml.

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.7</version>
    <configuration>
        <doclet>gr.spinellis.umlgraph.doclet.UmlGraphDoc</doclet>
        <docletArtifact>
            <groupId>gr.spinellis</groupId>
            <artifactId>UmlGraph</artifactId>
            <version>4.4</version>
        </docletArtifact>
        <additionalparam>
            -inferrel -inferdep -quiet -hide java.*
            -collpackages java.util.* -qualify
            -postfixpackage -nodefontsize 9
            -nodefontpackagesize 7
            -edgefontname 'Trebuchet MS'
            -nodefontabstractname 'Trebuchet MS'
            -nodefontclassabstractname
            'Trebuchet MS'
            -nodefontclassname 'Trebuchet MS'
            -nodefontname
            'Trebuchet MS'
            -nodefontpackagename 'Trebuchet MS'
            -nodefonttagname
            'Trebuchet MS'
        </additionalparam>
    </configuration>
</plugin>

Вот как выглядит диаграмма (источник: http://tap4j.org/apidocs/index.html ):

Повеселись! И не забудьте проверить, установлен ли на вашем компьютере CI также Graphviz, иначе у вас будет 404 на ваших страницах Javadoc.

Приятного кодирования и не забудьте поделиться!

Ссылка: Советы по сайту Maven: схемы классов Maven Fluido Skin и Javadoc от нашего партнера по JCG Бруно Киношита в блоге Kinoshita .

42
Share: