Welcome to GeoServer development. The project makes use of a number of resources:

https://github.com/geoserver/geoserver.github.io/wiki Wiki used for Proposals
https://github.com/geoserver/geoserver Github source code
https://osgeo-org.atlassian.net/projects/GEOS Jira issue tracker
GeoServer User Manual
GeoServer Developer Manual

Communication channels:

We have a number of build servers employed to assist with day to day activities:

https://build.geoserver.org/view/geoserver/ (main build server)
http://office.geo-solutions.it/jenkins/ (windows build server)

Notification email lists:

Question and answer:

License

For complete license information review LICENSE.txt.

GeoServer is free software and is licensed under the GNU General Public License:

Additionally:

Several files supporting GZIP compressions (GZIPFilter, GZIPResponseStream, GZIPResponseWrapper are provided using:

/* Copyright 2003 Jayson Falkner (jayson@jspinsider.com) This code is from "Servlets and JavaServer pages; the J2EE Web Tier",http://www.jspbook.com. You may freely use the code both commercially and non-commercially. If you like the code, please pick up a copy of
 * the book and help support the authors, development of more free code, and the JSP/Servlet/J2EE community. Modified by David Winslow <dwinslow@openplans.org>*/

SetCharacterEncodingFilter and RewindableInputStream makes use of code provided under Apache License Version 2.0.
UCSReader is provided using Apache License Version 1.1.
Snippets from the Prototype library (www.prototypejs.org) under a MIT license.
The build process will download jars from JAI ImageIO (BSD), Jetty (Jetty License), EMF (EPL), XSD (EPL). Several projects using the Apache License 2.0: Spring, Apache Commons, Log4j, Batik, Xerces.

Previous: GeoServer Developer Manual

Next: Tools

Git is a distributed version control system with a steep learning curve. Luckily there is lots of great documentation around. Before continuing developers should take the time to educate themselves about git. The following are good references:

On macOS using decomposed unicode paths, and a default APFS case-insensitive file system:

We recommend making these changes to --global (or --system) as they reflect the operating system and file system on your local machine.

Git is a distributed versioning system which means there is strictly no notion of a single central repository, but many distributed ones. For GeoServer these are:

Even though there are numerous copies of the repository they can all interoperate because they share a common history. This is the magic of git!

In order to interoperate with other repositories hosted on GitHub, a local repository must contain remote references to them. A local repository typically contains the following remote references:

A git repository contains a number of branches. These branches fall into three categories:

This section contains examples of workflows a developer will typically use on a daily basis. To follow these examples it is crucial to understand the phases that a changeset goes though in the git workflow. The lifecycle of a single changeset is:

There are many variations on this general workflow. For instance, it is common to make many local commits and then push them all up in batch to a remote repository. Also, for brevity multiple local commits may be squashed into a single final commit.

The content in this section is not intended to be a comprehensive introduction to git. There are many things not covered that are invaluable to day-to-day work with git. Some more useful info:

A step by step guide describing how to quickly get up and running with a GeoServer development environment. This guide assumes that all the necessary Tools are installed.

一步一步指导教程描述了如何快速上手搭建并运行GeoServer开发环境。本向导假设所有必须的工具都已经安装好了。

This guide is designed to get developers up and running as quick as possible. For a more comprehensive guide see the Maven Guide.

In this example we will pretend that your source code is in a directory called geoserver, but a more descriptive name is recommended.

#. Change directory to the root of the source tree and execute the maven build command:

In this example we will pretend that your source code is in a directory called geoserver, but a more descriptive name is recommended.

This guide is designed to get developers up and running as quick as possible. For a more comprehensive guide see the the Eclipse Guide.

In this example we will pretend that your source code is in a directory called geoserver, but a more descriptive name is recommended.

The Open Geospatial Consortium (OGC) defines of series of web protocols that all follow a similar design. The OGC Open Web Services (OWS) define a service using:

GeoServer provides a framework for accepting these requests and dispatching them to the appropriate implementation. The services are configured for the Dispatcher using a Spring applicationContext.xml file included in your jar.

Implementing a simple OWS service

This section explains How to Create a Simple GeoServer OWS service for GeoServer using the following scenario. The service should supply a capabilities document which advertises a single operation called “sayHello”. The result of a sayHello operation is the simple string “Hello World”.

Contents

Implementing a simple OWS service

Setup

The first step in creating our plug-in is setting up a maven project for it. The project will be called “hello”.

Create a new directory called hello anywhere on your file system.
Add a maven pom called pom.xml to the hello directory:

<?xml version="1.0" encoding="ISO-8859-1"?>
<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/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<!-- set parent pom to community pom -->
<parent>
    <groupId>org.geoserver</groupId>
    <artifactId>community</artifactId>
    <version>2.20-SNAPSHOT</version> <!-- change this to the proper GeoServer version -->
</parent>  

<groupId>org.geoserver</groupId>
<artifactId>hello</artifactId>
<packaging>jar</packaging>
<version>1.0</version>
<name>Hello World Service Module</name>

<!-- declare dependency on geoserver main -->
<dependencies>
    <dependency>
        <groupId>org.geoserver</groupId>
        <artifactId>gs-main</artifactId>
        <version>2.20-SNAPSHOT</version> <!-- change this to the proper GeoServer version -->
    </dependency>
</dependencies>

<repositories>
    <repository>
        <id>boundless</id>
        <name>Boundless Maven Repository</name>
        <url>https://repo.boundlessgeo.com/snapshot</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

</project>

Create a java source directory, src/main/java under the hello directory:

hello/
  + pom.xml
  + src/
    + main/
      + java/

Creating the Plug-in

A plug-in is a collection of extensions realized as spring beans. In this example the extension point of interest is a HelloWorld POJO (Plain Old Java Object).

Create a class called HelloWorld:

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class HelloWorld {

    public HelloWorld() {
        // Do nothing
    }

    public void sayHello(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.getOutputStream().write("Hello World".getBytes());
    }
}

The service is relatively simple. It provides a method sayHello(..) which takes a HttpServletRequest, and a HttpServletResponse. The parameter list for this function is automatically discovered by the org.geoserver.ows.Dispatcher.

Create an applicationContext.xml declaring the above class as a bean.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>
    <!-- Spring will reference the instance of the HelloWorld class
            by the id name "helloService" -->
    <bean id="helloService" class="HelloWorld"/>

    <!-- This creates a Service descriptor, which allows the org.geoserver.ows.Dispatcher
        to locate it. -->
    <bean id="helloService-1.0.0" class="org.geoserver.platform.Service">
    
        <!-- used to reference the service in the URL -->
        <constructor-arg index="0" value="hello"/>

        <!-- our actual service POJO defined previously -->
        <constructor-arg index="1" ref="helloService"/>

        <!-- a version number for this service -->
        <constructor-arg index="2" value="1.0.0"/>
            
        <!-- a list of functions for this service -->
        <constructor-arg index="3">
            <list>
                <value>sayHello</value>
            </list>
        </constructor-arg>
        
    </bean>
</beans>

At this point the hello project should look like the following:

hello/
  + pom.xml
  + src/
    + main/
      + java/
        + HelloWorld.java
        + applicationContext.xml

Trying it Out

Install the hello module:

[hello]% mvn install

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Hello World Service Module 1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ hello ---
[INFO] Deleting /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target
[INFO]
[INFO] --- cobertura-maven-plugin:2.6:clean (default) @ hello ---
[INFO]
[INFO] --- git-commit-id-plugin:2.0.4:revision (default) @ hello ---
[INFO] [GitCommitIdMojo] .git directory could not be found, skipping execution
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ hello ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] skip non existing resourceDirectory /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/src/main/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ hello ---
[INFO] Compiling 1 source file to /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ hello ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/src/test/java
[INFO] skip non existing resourceDirectory /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/src/test/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:testCompile (default-testCompile) @ hello ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.12.3:test (default-test) @ hello ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ hello ---
[INFO] Building jar: /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0.jar
[INFO]
[INFO] --- maven-jar-plugin:2.4:test-jar (default) @ hello ---
[WARNING] JAR will be empty - no content was marked for inclusion!
[INFO] Building jar: /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-tests.jar
[INFO]
[INFO] >>> maven-source-plugin:2.2.1:jar (attach-sources) > generate-sources @ hello >>>
[INFO]
[INFO] --- git-commit-id-plugin:2.0.4:revision (default) @ hello ---
[INFO] [GitCommitIdMojo] .git directory could not be found, skipping execution
[INFO]
[INFO] <<< maven-source-plugin:2.2.1:jar (attach-sources) < generate-sources @ hello <<<
[INFO]
[INFO] --- maven-source-plugin:2.2.1:jar (attach-sources) @ hello ---
[INFO] Building jar: /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-sources.jar
[INFO]
[INFO] >>> maven-source-plugin:2.2.1:test-jar (attach-sources) > generate-sources @ hello >>>
[INFO]
[INFO] --- git-commit-id-plugin:2.0.4:revision (default) @ hello ---
[INFO] [GitCommitIdMojo] .git directory could not be found, skipping execution
[INFO]
[INFO] <<< maven-source-plugin:2.2.1:test-jar (attach-sources) < generate-sources @ hello <<<
[INFO]
[INFO] --- maven-source-plugin:2.2.1:test-jar (attach-sources) @ hello ---
[INFO] No sources in project. Archive not created.
[INFO]
[INFO] --- maven-install-plugin:2.4:install (default-install) @ hello ---
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0.jar to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0.jar
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/pom.xml to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0.pom
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-tests.jar to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0-tests.jar
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-sources.jar to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0-sources.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.473 s
[INFO] Finished at: 2015-10-20T10:14:16+11:00
[INFO] Final Memory: 23M/589M
[INFO] ------------------------------------------------------------------------

Next we need to make sure hello-1.0.jar is included when we run GeoServer:
- If you are running a GeoServer in Tomcat, copy target/hello-1.0.jar into webapps/geoserver/WEB-INF/lib (just like we manually install extensions or community modules).
  
  Restart GeoServer to pick up the change.
- If running with Eclipse using maven eclipse plugin, the easiest approach is edit the web-app/pom.xml with the following dependency:
  <dependency> <groupId>org.geoserver</groupId> <artifactId>hello</artifactId> <version>1.0-SNAPSHOT</version> </dependency>
  After editing webapps/pom.xml we need run mvn eclipse:eclipse, and then from Eclipse right click on web-app project and Refresh for the IDE to notice the change.
- If and IDE like IntellJ, Eclipse M2 Maven plugin or NetBeans refresh the project so it picks up the changes to pom.xml
Restart GeoServer and visit:
```
http://<host>/geoserver/ows?request=sayHello&service=hello&version=1.0.0
```
request

the method we defined in our service

service

the name we passed to the Service descriptor in the applicationContext.xml

version

the version we passed to the Service descriptor in the applicationContext.xml

Note

A common pitfall is to bundle an extension without the applicationContext.xml file. If you receive the error message “No service: ( hello )” this is potentially the case. To ensure the file is present inspect the contents of the hello jar present in the target directory of the hello module.

Bundling with Web Module

An alternative to plugging into an existing installation is to build a complete GeoServer war that includes the custom hello plugin. To achieve this a new dependency is declared from the core web/app module on the new plugin project. This requires building GeoServer from sources.

Build GeoServer from sources as described here.
Install the hello module as above.

Edit web/app/pom.xml and add the following dependency:

<dependency>
    <groupId>org.geoserver</groupId>
    <artifactId>hello</artifactId>
    <version>1.0</version>
</dependency>

Install the web/app module

[web/app] mvn install

A GeoServer war including the hello extension should now be present in the target directory.

Note

To verify the plugin was bundled properly unpack geoserver.war and inspect the contents of the WEB-INF/lib directory and ensure the hello jar is present.

Running from Source

During development the most convenient way to work with the extension is to run it directly from sources.

Setup GeoServer in eclipse as described here.
Move the hello module into the GeoServer source tree under the community root module.

Edit the community/pom.xml and add a new profile:

<profile>
  <id>hello</id>
  <modules>
    <module>hello</module>
  </modules>
</profile>

If not already done, edit web/app/pom.xml and add the following dependency:

<dependency>
    <groupId>org.geoserver</groupId>
    <artifactId>hello</artifactId>
    <version>1.0</version>
</dependency>

From the root of the GeoServer source tree run the following maven command:

[src] mvn -P hello eclipse:eclipse

In eclipse import the new hello module and refresh all modules.
In the web-app module run the Start.java main class to start GeoServer.

Note

Ensure that the web-app module in eclipse depends on the newly imported hello module. This can be done by inspecting the web-app module properties and ensuring the hello module is a project dependency.

Previous: OWS Services Overview

Next: REST Services

maven 中心源地址更新为 https 的问题：https://www.v2ex.com/t/639199 直接重下github上的geoserver，重新加载pom.xml就可以了

导入geotools相关依赖有时候报红，或者下载不全，需要改settings.xml文件：link

Could not find artifact com.google.errorprone:javac:pom:9+181-r4173-1 in osgeo-releases (https://repo.osgeo.org/repository/release/)：mvn

GeoServer开发手册

Implementing a simple OWS service

Setup

Creating the Plug-in

Trying it Out

Bundling with Web Module

Running from Source