sonarjava api文档

转载

mob64ca13f9e726 2024-12-31 08:59:08

文章标签 sonarjava api文档数据库 java mysql 大数据 文章分类 Java 后端开发

sonarjava api文档_大数据

netbeans使用教程

介绍

Java 8出现了，人们所期待的革命终于发布了，我敢肯定，你们中的很多人都在想着同样的问题“我应该在项目中使用它吗？”。

好吧，几个月来我遇到了同样的问题，今天我想与您分享一个答案。很多方面都在影响这一决定，但是在这篇文章中，我想特别关注一个方面：

我可以继续与Java 8和NetBeans Platform进行持续集成吗？

主要问题是进行CI所需的工具的成熟度，以及将其与NetBeans平台的ant生成脚本集成起来有多容易。

幸运的是，我们发现这既可行又容易！

我还要感谢Alberto Requena Sanchez对本文的贡献。

技术环境

在以安全与质量为主要驱动力的项目中，CI至关重要。

因此，我从我的团队开始进行“概念验证”，以表明以下技术已准备就绪，可以协同工作：

Java 8，NetBeans 8.0和Ant
JUnit 4和Jacoco 0.7.1
詹金斯与声纳4.2

本文的范围是解释为使Java 8的CI服务器完全正常运行而安装和设置必要工具的所有步骤，请注意，该证明已在Windows 7的开发人员机器上完成，但很容易做到。在Linux服务器中也是如此。

下图以高层次显示了将在帖子中描述的体系结构。

<div>

持续集成图

Java 8，NetBeans 8.0和Ant

Java 8已发布，可在此处安装，安装，研究(推荐)并开始使用它！

我们正在使用NetBeans Platform 8.0创建模块化应用程序。该应用程序具有多层体系结构，其中每个层都是一个模块套件，而最终的可执行文件只是一组集成的套件。

我们正在使用Ant来构建我们的项目，但是如果您正在使用Maven ，则甚至可以简化该过程，因为可以通过使用Maven的插件来完成Jenkins中的Sonar集成。

JUnit 4和Jacoco 0.7.1

自然，我们在进行单元测试，因此，我们使用JUnit4。它在任何地方都可以很好地集成，尤其是在NetBeans中。

Jacoco是用于生成代码覆盖率的出色工具，并且从0.7.1版本开始，它完全支持Java 8。

詹金斯与声纳4.2

Jenkins是我们CI服务器的引擎，它将与上述所有技术集成在一起，没有任何问题。测试的版本是1.554。

声纳正在对代码进行所有质量分析。 4.2版与Java 8完全兼容。

将Sonar与Ant结合使用需要一个小型库，其中包含要集成到Jenkins中的目标。如果您使用的是Maven，则可以只安装Maven插件。

开始困惑

步骤1 – NetBeans

安装Java 8和NetBeans 8.0
创建一个包含几个模块，几个类和几个jUnit测试的模块套件
将代码提交到您的源代码版本管理服务器中
深入了解NetBeans的功能
在名为“ jacoco-0.7.1”的线束中创建一个文件夹，其中包含下载的jacoco jars
在名为“ sonar-ant-task”的线束中创建一个文件夹，并将其放入下载的声纳蚂蚁罐中
在名为sonar-jacoco-module.xml的工具中创建一个文件，并将以下代码粘贴到其中：

<?xml version="1.0" encoding="UTF-8"?>
<!--

-->
<project name="sonar-jacoco-module" basedir="." xmlns:jacoco="antlib:org.jacoco.ant" xmlns:sonar="antlib:org.sonar.ant">
<description>Builds the module suite otherSuite.</description>

<property name="jacoco.dir" location="${nbplatform.default.harness.dir}/jacoco-0.7.1"/>
<property name="result.exec.file" location="${jacoco.dir}/jacoco.exec"/>
<property name="build.test.results.dir" location="build/test/unit/results"/>

<property file="nbproject/project.properties"/>

<!-- Step 1: Import JaCoCo Ant tasks -->
<taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
<classpath path="${jacoco.dir}/jacocoant.jar"/>
</taskdef>

<!-- Target at the level of modules -->
<target name="-do-junit" depends="test-init">
<echo message="Doing testing for jacoco" />
<macrodef name="junit-impl">
<attribute name="test.type"/>
<attribute name="disable.apple.ui" default="false"/>
<sequential>
<jacoco:coverage destfile="${build.test.results.dir}/${code.name.base}_jacoco.exec">
<junit showoutput="true" fork="true" failureproperty="tests.failed" errorproperty="tests.failed" 
filtertrace="${test.filter.trace}" tempdir="${build.test.@{test.type}.results.dir}" timeout="${test.timeout}">
<batchtest todir="${build.test.@{test.type}.results.dir}">
<fileset dir="${build.test.@{test.type}.classes.dir}" includes="${test.includes}" excludes="${test.excludes}"/>
</batchtest>
<classpath refid="test.@{test.type}.run.cp"/>
<syspropertyset refid="test.@{test.type}.properties"/>
<jvmarg value="${test.bootclasspath.prepend.args}"/>
<jvmarg line="${test.run.args}"/>
<!--needed to have tests NOT to steal focus when running, works in latest apple jdk update only.-->
<sysproperty key="apple.awt.UIElement" value="@{disable.apple.ui}"/>
<formatter type="brief" usefile="false"/>
<formatter type="xml"/>
</junit>
</jacoco:coverage>
<copy file="${build.test.results.dir}/${code.name.base}_jacoco.exec" todir="${suite.dir}/build/coverage"/>
<!--
Copy the result of all the unit tests of all the modules into one common
folder at the level of the suite, so that sonar could find those files to
generate associated reports
-->
<copy todir="${suite.dir}/build/test-results">
<fileset dir="${build.test.results.dir}">
<include name="**/TEST*.xml"/>
</fileset>
</copy>
<fail if="tests.failed" unless="continue.after.failing.tests">Some tests failed; see details above.</fail>
</sequential>
</macrodef>
<junit-impl test.type="${run.test.type}" disable.apple.ui="${disable.apple.ui}"/>
</target>

</project>

该文件的范围是覆盖添加jacoco覆盖范围的do-junit任务，并复制套件构建中每个模块的单元测试结果，以便sonar可以一起找到所有模块以进行分析。

在名为sonar-jacoco-suite.xml的线束中创建一个文件，并将以下代码粘贴到其中

<?xml version="1.0" encoding="UTF-8"?>
<project name="sonar-jacoco-suite" basedir="." xmlns:jacoco="antlib:org.jacoco.ant" xmlns:sonar="antlib:org.sonar.ant">
<description>Builds the module suite otherSuite.</description>

<property name="jacoco.dir" location="${nbplatform.default.harness.dir}/jacoco-0.7.1"/>
<property name="result.exec.file" location="build/coverage"/>    

<!-- Define the SonarQube global properties (the most usual way is to pass these properties via the command line) -->
<property name="sonar.jdbc.url" value="jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8" />
<property name="sonar.jdbc.username" value="sonar" />
<property name="sonar.jdbc.password" value="sonar" />
<!-- Define the SonarQube project properties -->
<property name="sonar.projectKey" value="org.codehaus.sonar:example-java-ant" />
<property name="sonar.projectName" value="Simple Java Project analyzed with the SonarQube Ant Task" />
<property name="sonar.projectVersion" value="1.0" />
<property name="sonar.language" value="java" />
<!-- Load the project properties file for retrieving the modules of the suite -->
<property file="nbproject/project.properties"/>

<!-- Using Javascript functions to build the paths of the data source for sonar configuration -->
<script language="javascript"> 
<![CDATA[

// getting the value
modulesName = project.getProperty("modules");
modulesName = modulesName.replace(":",",");
res = modulesName.split(",");
srcModules = "";
binariesModules = "";
testModules = "";
//Build the paths  
for (var i=0; i<res.length; i++)
{
srcModules += res[i]+"/src,";
binariesModules += res[i]+"/build/classes,";
testModules += res[i]+"/test,";
}
//Remove the last comma
srcModules = srcModules.substring(0, srcModules.length - 1);
binariesModules = binariesModules.substring(0, binariesModules.length - 1);
testModules = testModules.substring(0, testModules.length - 1);
// store the result in a new properties
project.setProperty("srcModulesPath",srcModules);
project.setProperty("binariesModulesPath",binariesModules);
project.setProperty("testModulesPath",testModules);
]]>
</script>  
<!-- Display the values -->       
<property name="sonar.sources" value="${srcModulesPath}"/>
<property name="sonar.binaries" value="${binariesModulesPath}" />
<property name="sonar.tests" value="${testModulesPath}" />
<!-- Define where the coverage reports are located -->
<!-- Tells SonarQube to reuse existing reports for unit tests execution and coverage reports -->
<property name="sonar.dynamicAnalysis" value="reuseReports" />
<!-- Tells SonarQube where the unit tests execution reports are -->
<property name="sonar.junit.reportsPath" value="build/test-results" />
<!-- Tells SonarQube that the code coverage tool by unit tests is JaCoCo -->
<property name="sonar.java.coveragePlugin" value="jacoco" />
<!-- Tells SonarQube where the unit tests code coverage report is -->
<property name="sonar.jacoco.reportPath" value="${result.exec.file}/merged.exec" />
<!--  Step 1: Import JaCoCo Ant tasks  -->
<taskdef uri="antlib:org.jacoco.ant" resource="org/jacoco/ant/antlib.xml">
<classpath path="${jacoco.dir}/jacocoant.jar"/>
</taskdef>    
<target name="merge-coverage">        
<jacoco:merge destfile="${result.exec.file}/merged.exec">
<fileset dir="${result.exec.file}" includes="*.exec"/>
</jacoco:merge>
</target>

<target name="sonar">
<taskdef uri="antlib:org.sonar.ant" resource="org/sonar/ant/antlib.xml">
<!-- Update the following line, or put the "sonar-ant-task-*.jar" file in your "$HOME/.ant/lib" folder -->
<classpath path="${harness.dir}/sonar-ant-task-2.1/sonar-ant-task-2.1.jar" />
</taskdef>

<!-- Execute the SonarQube analysis -->
<sonar:sonar />
</target>

</project>

该文件的范围是在套件级别定义声纳配置和声纳任务。如果您使用声纳，则某些特殊的数据库或特殊的用户必须在此处更改配置。

定义的另一项任务是jacoco合并，该合并实际上将获取每个模块的所有生成的exec，并将它们合并为套件构建中的单个exec，以允许声纳进行分析。

用以下内容替换每个模块的build.xml的内容：

<description>Builds, tests, and runs the project com.infrabel.jacoco.</description>
<property file="nbproject/suite.properties"/>
<property file="${suite.dir}/nbproject/private/platform-private.properties"/>
<property file="${user.properties.file}"/>
<import file="${nbplatform.default.harness.dir}/sonar-jacoco-module.xml"/>
<import file="nbproject/build-impl.xml"/>

用以下内容替换每个套件的build.xml的内容：

<description>Builds the module suite otherSuite.</description>
<property file="nbproject/private/platform-private.properties"/>
<property file="${user.properties.file}"/>
<import file="${nbplatform.default.harness.dir}/sonar-jacoco-suite.xml"/>
<import file="nbproject/build-impl.xml"/>

步骤2 –詹金斯

在“管理Jenkins->管理插件”中，进入可用列表并安装(如果尚未存在)以下插件：

JaCoCo
水星或颠覆
声纳

如果您在防火墙或代理后面，并且在配置网络设置时遇到问题，可以随时从此处手动下载并安装它们。在这种情况下，请记住还要先下载每个插件的依赖项。

在“管理Jenkins->配置系统”中，检查是否正确安装了所有插件，请参见以下屏幕截图以获取示例(将文件夹替换为适合您的文件夹)：
<div>
<img alt="詹金斯-jdk1" src="https://s2.51cto.com/images/blog/202410/14133203_670cacd309cba17241.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_30,g_se,x_10,y_10,shadow_20,type_ZmFuZ3poZW5naGVpdGk=" width="640" height="197"> </div>
<div>
<img alt="詹金斯·杰克" src="https://s2.51cto.com/images/blog/202410/14133203_670cacd37559252759.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_30,g_se,x_10,y_10,shadow_20,type_ZmFuZ3poZW5naGVpdGk=" width="640" height="212"> </div>
<div>
<img alt="詹金斯-声纳-1" src="https://s2.51cto.com/images/blog/202410/14133203_670cacd3a218f53976.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_30,g_se,x_10,y_10,shadow_20,type_ZmFuZ3poZW5naGVpdGk=" width="640" height="186"> </div>
<div>
<img alt="詹金斯-声纳2" src="https://s2.51cto.com/images/blog/202410/14133203_670cacd3d32ae15989.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_30,g_se,x_10,y_10,shadow_20,type_ZmFuZ3poZW5naGVpdGk=" width="640" height="175"> </div>
创建一个新的自由样式项目，配置您的首选项的版本控制，然后在“构建”面板中添加以下三个“ Invoce Ant”任务：
<div>
<img alt="詹金斯配置" src="https://s2.51cto.com/images/blog/202410/14133204_670cacd4135f013797.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_30,g_se,x_10,y_10,shadow_20,type_ZmFuZ3poZW5naGVpdGk=" width="640" height="777"> </div>
最后，在“构建后操作”面板中添加一个新的“记录Jacoco覆盖率报告”，其配置如下：
<div>
<img alt="詹金斯·雅科科" src="https://s2.51cto.com/images/blog/202410/14133204_670cacd4406fa77732.png?x-oss-process=image/watermark,size_16,text_QDUxQ1RP5Y2a5a6i,color_FFFFFF,t_30,g_se,x_10,y_10,shadow_20,type_ZmFuZ3poZW5naGVpdGk=" width="640" height="336"> </div>

步骤3 –声纳

按照此脚本创建数据库，并选择运行此查询以使连接正常工作：

GRANT ALL PRIVILEGES ON 'sonar'.* TO 'sonar'@'localhost';

进入声纳的配置文件(sonar.properties)并启用MySQL，该文件位于安装的conf文件夹中

# Permissions to create tables, indices and triggers 
# must be granted to JDBC user.
# The schema must be created first.
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar

#----- MySQL 5.x
# Comment the embedded database and uncomment the following 
# line to use MySQL
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true