Отож, визначимо цілі нашого проекту :
- Отримаувати заміри виконання методі задопомогою анотацій
- Керувати історією викликів мотода
- Отримувати результат в наступних форматах : String, JSON, HTML
Проект унас буде збиратися Apache Maven'ом, для імплементації АОР використаємо AspectJ а тести напишемо на JUnit.
Отже, створюємо наш проект командою : "mvn archetype:create -DgroupId=org.ar.stat4j -DartifactId=Stat4J" з цього бидно архітектуру пакетів а також горду назву "Stat4J" (типу заявка на світове визнання 8-D ).
Додаємо залежності в pom.xml :
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectj.version}</version>
</dependency>
</dependencies>
Створюємо пакет "org.ar.stat4j.annotations" і додаємо в в нього клас "Stat4JPoint.java", це і буде наша анотація котру ставитимемо над методом котрий будемо заміряти. Відкриваємо клас і пишемо в ньому настйпний код :
@Target(ElementType.METHOD)
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>${aspectj.version}</version>
</dependency>
</dependencies>
Створюємо пакет "org.ar.stat4j.annotations" і додаємо в в нього клас "Stat4JPoint.java", це і буде наша анотація котру ставитимемо над методом котрий будемо заміряти. Відкриваємо клас і пишемо в ньому настйпний код :
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Stat4JPoint {
}
@Target - місце над яким можна буде декларувати дану анотацію , у нашому випадку це методи.
@Retention - як довго дана анотація буде зберігатися над анотованим типом, у нашому випадку напротязі усього виконання аплікації.
@interface - вказує що даний клас є анотацією
Отже тепер ми маємо анотацію яка буде вказувати на методи котрі нам треба заміряти, залишилось тільки відслідковувати коли під час виконання аплікацію будуть викликатися анотовані цією анотацією методи. Для цього нам і потрібне АОР.
Створюємо пакет "org.ar.stat4j.aspects" і додаємо туди наш аспект "Stat4JAsp.aj". Даний аспект повинен спрацьовувати коли буде викликано будь який метод анотований нашою анотацією. Для цього в середену аспекту пишемо :
@Around - вказує що даний аспект має виконатись навколо методу , тобто не перед чи після а саме навко методу (іншими словами його обгортаємо) а як аргумент ми передаємо умову при якій даний аспект повинен виконатись : * - будь який ретурн тип , * - будь яка назва методу , (..) - будь яка кількість аргументів, && - а також , @annotation(<type>) - анотація типу <type>.
Тепер у нас є анотація і аспект який її відслідковуватиме.
Залишилось лише додати плагін до bild секції в pom.xml який під час компіляції проекту зробить всю ту "магію" яка називається АОР (Обгорне анотовані методи своєю іпмлементацією). Плагін має виглядати так :
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${aj.mvn.pg.version}</version>
<executions>
<execution>
<goals>
<goal>compile</goal><!-- to weave all your main classes -->
<goal>test-compile</goal><!-- to weave all your test classes -->
}
@Target - місце над яким можна буде декларувати дану анотацію , у нашому випадку це методи.
@Retention - як довго дана анотація буде зберігатися над анотованим типом, у нашому випадку напротязі усього виконання аплікації.
@interface - вказує що даний клас є анотацією
Отже тепер ми маємо анотацію яка буде вказувати на методи котрі нам треба заміряти, залишилось тільки відслідковувати коли під час виконання аплікацію будуть викликатися анотовані цією анотацією методи. Для цього нам і потрібне АОР.
Створюємо пакет "org.ar.stat4j.aspects" і додаємо туди наш аспект "Stat4JAsp.aj". Даний аспект повинен спрацьовувати коли буде викликано будь який метод анотований нашою анотацією. Для цього в середену аспекту пишемо :
@Aspectpublic class Stat4JAsp {
@Around("execution(* *(..)) &&@annotation(org.ar.stat4j.annotations.Stat4JPoint)") public Object around(ProceedingJoinPoint point) throws Throwable {
}
}
@Aspect - вказує AspectJ плагіну (який ми пізніше додато до конфігурації мавена) , що даний клас є аспектом.@Around - вказує що даний аспект має виконатись навколо методу , тобто не перед чи після а саме навко методу (іншими словами його обгортаємо) а як аргумент ми передаємо умову при якій даний аспект повинен виконатись : * - будь який ретурн тип , * - будь яка назва методу , (..) - будь яка кількість аргументів, && - а також , @annotation(<type>) - анотація типу <type>.
Тепер у нас є анотація і аспект який її відслідковуватиме.
Залишилось лише додати плагін до bild секції в pom.xml який під час компіляції проекту зробить всю ту "магію" яка називається АОР (Обгорне анотовані методи своєю іпмлементацією). Плагін має виглядати так :
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>aspectj-maven-plugin</artifactId>
<version>${aj.mvn.pg.version}</version>
<executions>
<execution>
<goals>
<goal>compile</goal><!-- to weave all your main classes -->
<goal>test-compile</goal><!-- to weave all your test classes -->
</goals>
</execution>
</executions>
<configuration>
<sources>
<source>
<basedir>src/main/java/org/ar/stat4j/aspects</basedir>
<includes>
<include>**/*.aj</include>
</includes>
</source>
</sources>
<complianceLevel>1.8</complianceLevel>
<outxml>false</outxml>
<verbose>true</verbose>
<showWeaveInfo>true</showWeaveInfo>
<source>1.8</source>
<target>1.8</target>
</configuration></plugin>
В даній конфігурації важливо вірно вказати пакет в якому знаходяться ваші аспекти а також версію джави (у нашому випадку 1.8).
Пробуємо білдати наш проект : mvn clean install , і якщо бачимо :
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
public class Stat4J {
</execution>
</executions>
<configuration>
<sources>
<source>
<basedir>src/main/java/org/ar/stat4j/aspects</basedir>
<includes>
<include>**/*.aj</include>
</includes>
</source>
</sources>
<complianceLevel>1.8</complianceLevel>
<outxml>false</outxml>
<verbose>true</verbose>
<showWeaveInfo>true</showWeaveInfo>
<source>1.8</source>
<target>1.8</target>
</configuration></plugin>
В даній конфігурації важливо вірно вказати пакет в якому знаходяться ваші аспекти а також версію джави (у нашому випадку 1.8).
Пробуємо білдати наш проект : mvn clean install , і якщо бачимо :
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
тоді усе гаразд.
Тепер давайте зробимо власне нашу утиліту яка буде відповідати за початок заміру, кінець а також вивід статистики. Створюємо в пакеті "org.ar.stat4j" класс Stat4J.java і зробимо його синглтоном щоб там де він буде використовуватись він завжди був єдиним на всю систему.
private static Stat4J instance;
private Stat4J() {}
private Stat4J() {}
public static Stat4J instance() {
if (instance == null) {
synchronized (Stat4J.class) {
if (instance == null) {
instance = new Stat4J();
}
}
}
}
return instance;
}
}
Point.java
public class Point implements Comparable<Point>{
}
}
Тепер, маючи головний клас нашої утиліти створюємо пакет "org.ar.atat4j.data" і додаємо два класи , перший для зберігання усієї статистики , а другий для зберігання статистики конкретно по одному виклику метода :
Statistic.java
public class Statistic {
Statistic.java
public class Statistic {
private List<Point> stats = new ArrayList<>();
...
}
...
}
Point.java
public class Point implements Comparable<Point>{
public static final int NANO_IN_MILIS = 1000000;
private long startTrack;
private long finishTrack;
...
}
Також додаємо метод який розпочинатиме та закічнуватиме заміри :
public Point startTrack(String componentName, String pointName) {
public void stopTrack(Point point) {
private long startTrack;
private long finishTrack;
...
}
Тепер навчимо клас Statistic.java обраховувати інформацію про свої заміри :
(приклад наводжу на одному з методів, повна версія буде доступна за посилання в кінці поста)
public long getMaxExecutionTimeInNano(){
(приклад наводжу на одному з методів, повна версія буде доступна за посилання в кінці поста)
public long getMaxExecutionTimeInNano(){
if(!stats.isEmpty()) {
Collections.sort(stats);
return stats.get(stats.size()-1).executionTimeInNanoseconds();
}
return stats.get(stats.size()-1).executionTimeInNanoseconds();
}
return 0;
}
}
Маючи об'єкт статистики і всю інформацію про виклики методу додамо мапу в головний об'єкт нашої утиліти котра за іменем класу зберігатиме іншу мапу , яка в свою чергу за іменем методу зберігатиме об'єкт статистики :
Stat4J.java
...
Stat4J.java
...
private Map<String, Map<String, Statistic>> records;
...
...
Також додаємо метод який розпочинатиме та закічнуватиме заміри :
public Point startTrack(String componentName, String pointName) {
Point point = new Point(System.nanoTime());
if (!records.containsKey(componentName)) {
if (!records.containsKey(componentName)) {
Statistic statistic = new Statistic();
statistic.getPoints().add(point);
Map<String, Statistic> pointToStat = new HashMap<>();
pointToStat.put(pointName, statistic);
records.put(componentName, pointToStat);
} else if (!records.get(componentName).containsKey(pointName)) {
Statistic statistic = new Statistic();
statistic.getPoints().add(point);
records.get(componentName).put(pointName, statistic);
} else {
records.get(componentName).get(pointName).getPoints().add(point);
}
return point;
}Перший if ініціалізує цілу групу замірів відштовхуєчись від імені класу. Другий if інішіалізує групу замірів на базі методів у випадку якщо група класу вже ініціалізована. А третій if спрацює якщо група класу і методі уже є , тоді тільки додасть новий замір.
statistic.getPoints().add(point);
Map<String, Statistic> pointToStat = new HashMap<>();
pointToStat.put(pointName, statistic);
records.put(componentName, pointToStat);
} else if (!records.get(componentName).containsKey(pointName)) {
Statistic statistic = new Statistic();
statistic.getPoints().add(point);
records.get(componentName).put(pointName, statistic);
} else {
records.get(componentName).get(pointName).getPoints().add(point);
}
return point;
}Перший if ініціалізує цілу групу замірів відштовхуєчись від імені класу. Другий if інішіалізує групу замірів на базі методів у випадку якщо група класу вже ініціалізована. А третій if спрацює якщо група класу і методі уже є , тоді тільки додасть новий замір.
point.finish(System.nanoTime());
}
У випадку якщо наш метод нічого не повертає , ми всеодно повинні повертати Object як результат виконання методу так як на даному етапі аспект нічого про сам метод не знає.
public static final String COMPONENT_OUTPUT = "%1s.%2s:\tCall times: %3s,\tMax: %4s (ns)\t|\t%5s(ms),\tMin: %6s(ns)\t|\t%7s(ms),\tAvr: %8s(ns)\t|\t%9s(ms);\n";
public static final String POINT_OUTPUT = "\t\t%1s:\tExecution date:
return strBld.toString();
}
StringBuilder strBld = new StringBuilder();
і відповідно сам тест :
public class Point4JAspTest {
}
Для зупинки заміру просто проставляємо поточну дату (час закінчення) в точку заміру .
Маючи все вище написане залишаться оновити наш аспект і в його тілі вказати що перш ніж виконати метод ми повинні розпочати замір а далі виконати метод і після цього закінчити замір:
Point statisticPoint = Stat4J.instance().startTrack(point.getTarget().getClass().getCanonicalName(), MethodSignature.class.cast(point.getSignature()).getMethod().getName());
Маючи все вище написане залишаться оновити наш аспект і в його тілі вказати що перш ніж виконати метод ми повинні розпочати замір а далі виконати метод і після цього закінчити замір:
Point statisticPoint = Stat4J.instance().startTrack(point.getTarget().getClass().getCanonicalName(), MethodSignature.class.cast(point.getSignature()).getMethod().getName());
Object result = point.proceed();
Stat4J.instance().stopTrack(statisticPoint);
return result;
return result;
У випадку якщо наш метод нічого не повертає , ми всеодно повинні повертати Object як результат виконання методу так як на даному етапі аспект нічого про сам метод не знає.
Компілюємо аплікацію і впевнюємось що унас все зроблено вірно.
Залишилось вивестинаш результат. Для цього створюємо пакет "org.ar.stat4j.printers" і додаємо в нього клас "StringPriner,java". Він повинен приймати наші об"єкти статистики та примати аргументом параметр що буде вказувати треба нам історія викликів методу чи ні .
Ось код цього прінтера :
public class StringPrinter implements Printer{
public static final String COMPONENT_OUTPUT = "%1s.%2s:\tCall times: %3s,\tMax: %4s (ns)\t|\t%5s(ms),\tMin: %6s(ns)\t|\t%7s(ms),\tAvr: %8s(ns)\t|\t%9s(ms);\n";
public static final String POINT_OUTPUT = "\t\t%1s:\tExecution date:
%2s,\tExecution time: %3s\t(ns)|\t%4s(ms);\n";
public static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("MM.dd.yy HH:mm:ss.SSS");
public static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("MM.dd.yy HH:mm:ss.SSS");
@Override
public String print(Map<String, Map<String, Statistic>> statistic, boolean history){
final StringBuilder strBld = new StringBuilder();
statistic.forEach((componentName, points) -> points.forEach((pointName, stats)
public String print(Map<String, Map<String, Statistic>> statistic, boolean history){
final StringBuilder strBld = new StringBuilder();
statistic.forEach((componentName, points) -> points.forEach((pointName, stats)
-> strBld.append(generateComponentStatistic(componentName, pointName, stats,
history))));
history))));
return strBld.toString();
}
private String generateComponentStatistic(String componentName, String pointName, Statistic statistic, boolean history) {
StringBuilder strBld = new StringBuilder();
strBld.append(String.format(COMPONENT_OUTPUT, componentName, pointName,
statistic.getPointSize(), statistic.getMaxExecutionTimeInNano(),
statistic.getMaxExecutionTimeInMili(),
statistic.getMinExecutionTimeInNano(),
statistic.getMinExecutionTimeInMili(),
statistic.getAverageExecutionTimeInNano(),
statistic.getAverageExecutionTimeInMili()));
if (history && statistic.getPoints().size() > 1) {
statistic.getPointSize(), statistic.getMaxExecutionTimeInNano(),
statistic.getMaxExecutionTimeInMili(),
statistic.getMinExecutionTimeInNano(),
statistic.getMinExecutionTimeInMili(),
statistic.getAverageExecutionTimeInNano(),
statistic.getAverageExecutionTimeInMili()));
if (history && statistic.getPoints().size() > 1) {
statistic.getPoints().forEach((statPoint) ->
strBld.append(String.format(POINT_OUTPUT,pointName,
DATE_FORMAT.format(statPoint.getExecutionDate()),
statPoint.executionTimeInNanoseconds(),
statPoint.executionTimeInMiliseconds())));
}
strBld.append(String.format(POINT_OUTPUT,pointName,
DATE_FORMAT.format(statPoint.getExecutionDate()),
statPoint.executionTimeInNanoseconds(),
statPoint.executionTimeInMiliseconds())));
}
return strBld.toString();
}
}
Тепер потрібно додати метод в головний клас утиліти для виводу статистики який буде приймати аргументом тип прінтера (String, JSON, HTML) і вмикання / вимикання історії викликів :
private final StringPrinter stringPrinter = new StringPrinter();
...
Тепер потрібно додати метод в головний клас утиліти для виводу статистики який буде приймати аргументом тип прінтера (String, JSON, HTML) і вмикання / вимикання історії викликів :
private final StringPrinter stringPrinter = new StringPrinter();
...
public String getStatistic(OutputFormatType outputFormatType, boolean history){
switch(outputFormatType){
case STRING:
return stringPrinter.print(records,history);
...
...
}
}
Після цього напишемо тестовий склас методи якого нічого не робитимуть але зупинятимуть потік на якийсь час, і заанотуємо ці методи щоб виміряти їх час виконання :
public class PerformanceTestObject {
@Stat4JPoint
public void method2MS() throws InterruptedException {
Після цього напишемо тестовий склас методи якого нічого не робитимуть але зупинятимуть потік на якийсь час, і заанотуємо ці методи щоб виміряти їх час виконання :
public class PerformanceTestObject {
@Stat4JPoint
public void method2MS() throws InterruptedException {
Thread.sleep(2);
}
}
@Stat4JPoint
public void method25MS() throws InterruptedException {
public void method25MS() throws InterruptedException {
Thread.sleep(25);
}
}
@Stat4JPoint
public int method155MS() throws InterruptedException {
public int method155MS() throws InterruptedException {
Thread.sleep(155);
return 155;
}
return 155;
}
@Stat4JPoint
public void method1Sec() throws InterruptedException {
public void method1Sec() throws InterruptedException {
Thread.sleep(1000);
}
}
}
}
і відповідно сам тест :
@Test
public void testPerformanceMeassuringStringOutput() throws InterruptedException { PerformanceTestObject performanceTestObject = new PerformanceTestObject();
public void testPerformanceMeassuringStringOutput() throws InterruptedException { PerformanceTestObject performanceTestObject = new PerformanceTestObject();
performanceTestObject.method2MS();
performanceTestObject.method25MS();
performanceTestObject.method25MS();
performanceTestObject.method25MS();
performanceTestObject.method25MS();
performanceTestObject.method25MS();
performanceTestObject.method25MS();
performanceTestObject.method25MS();
performanceTestObject.method1Sec();
performanceTestObject.method155MS();
performanceTestObject.method1Sec();
performanceTestObject.method155MS();
System.out.println(Stat4J.instance().
getStatistic(Stat4J.OutputFormatType.STRING,true));
}
}
}
}
Запускаємо та дивимось результат :
org.ar.sta4j.PerformanceTestObject.method25MS: Call times: 4, Max: 30011694(ns) | 30(ms), Min: 27759291(ns) | 27(ms), Avr: 28949879(ns) | 28(ms);
method25MS: Execution date: 03.03.76 14:58:04.321, Execution time: 27759291 (ns)| 27(ms);
method25MS: Execution date: 03.03.76 07:00:38.850, Execution time: 28609810 (ns)| 28(ms);
method25MS: Execution date: 03.02.76 14:27:54.968, Execution time: 29418723 (ns)| 29(ms);
method25MS: Execution date: 03.02.76 22:38:51.322, Execution time: 30011694 (ns)| 30(ms);
org.ar.sta4j.PerformanceTestObject.method2MS: Call times: 1, Max: 3253797(ns) | 3(ms), Min: 3253797(ns) | 3(ms), Avr: 3253797(ns) | 3(ms);
org.ar.sta4j.PerformanceTestObject.method1Sec: Call times: 1, Max: 1002833335(ns) | 1002(ms), Min: 1002833335(ns) | 1002(ms), Avr: 1002833335(ns) | 1002(ms);
org.ar.sta4j.PerformanceTestObject.method155MS: Call times: 1, Max: 162245276(ns) | 162(ms), Min: 162245276(ns) | 162(ms), Avr: 162245276(ns) | 162(ms);
Ось і все. Прінтери для JSON та HTML формату не став тут викладати заради економії часу проте все чого тут не вистачає ви зможене знайти тут.
Очікую ваші відгуки та пропозиції щодо даної утиліти.
П.С. Надіюсь було цікаво.
org.ar.sta4j.PerformanceTestObject.method25MS: Call times: 4, Max: 30011694(ns) | 30(ms), Min: 27759291(ns) | 27(ms), Avr: 28949879(ns) | 28(ms);
method25MS: Execution date: 03.03.76 14:58:04.321, Execution time: 27759291 (ns)| 27(ms);
method25MS: Execution date: 03.03.76 07:00:38.850, Execution time: 28609810 (ns)| 28(ms);
method25MS: Execution date: 03.02.76 14:27:54.968, Execution time: 29418723 (ns)| 29(ms);
method25MS: Execution date: 03.02.76 22:38:51.322, Execution time: 30011694 (ns)| 30(ms);
org.ar.sta4j.PerformanceTestObject.method2MS: Call times: 1, Max: 3253797(ns) | 3(ms), Min: 3253797(ns) | 3(ms), Avr: 3253797(ns) | 3(ms);
org.ar.sta4j.PerformanceTestObject.method1Sec: Call times: 1, Max: 1002833335(ns) | 1002(ms), Min: 1002833335(ns) | 1002(ms), Avr: 1002833335(ns) | 1002(ms);
org.ar.sta4j.PerformanceTestObject.method155MS: Call times: 1, Max: 162245276(ns) | 162(ms), Min: 162245276(ns) | 162(ms), Avr: 162245276(ns) | 162(ms);
Ось і все. Прінтери для JSON та HTML формату не став тут викладати заради економії часу проте все чого тут не вистачає ви зможене знайти тут.
Очікую ваші відгуки та пропозиції щодо даної утиліти.
П.С. Надіюсь було цікаво.
