Supports configurable compression level #3567
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /* | ||
| * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package reactor.netty.http.server; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import io.netty.handler.codec.compression.Brotli; | ||
| import io.netty.handler.codec.compression.BrotliOptions; | ||
| import io.netty.handler.codec.compression.CompressionOptions; | ||
| import io.netty.handler.codec.compression.DeflateOptions; | ||
| import io.netty.handler.codec.compression.GzipOptions; | ||
| import io.netty.handler.codec.compression.SnappyOptions; | ||
| import io.netty.handler.codec.compression.StandardCompressionOptions; | ||
| import io.netty.handler.codec.compression.Zstd; | ||
| import io.netty.handler.codec.compression.ZstdOptions; | ||
| import io.netty.util.internal.ObjectUtil; | ||
|
|
||
| /** | ||
| * HTTP Compression configuration builder for the {@link SimpleCompressionHandler}. | ||
| * | ||
| * @author raccoonback | ||
| */ | ||
| public final class HttpCompressionSettingsSpec { | ||
|
|
||
| private final GzipOptions gzipOptions; | ||
| private final DeflateOptions deflateOptions; | ||
| private final SnappyOptions snappyOptions; | ||
| private BrotliOptions brotliOptions; | ||
| private ZstdOptions zstdOptions; | ||
|
There was a problem hiding this comment. Compression settings supported by Netty. |
||
|
|
||
| private HttpCompressionSettingsSpec() { | ||
| gzipOptions = StandardCompressionOptions.gzip(); | ||
| deflateOptions = StandardCompressionOptions.deflate(); | ||
| snappyOptions = StandardCompressionOptions.snappy(); | ||
|
|
||
| if (Brotli.isAvailable()) { | ||
| brotliOptions = StandardCompressionOptions.brotli(); | ||
| } | ||
|
|
||
| if (Zstd.isAvailable()) { | ||
| zstdOptions = StandardCompressionOptions.zstd(); | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. The |
||
|
|
||
| private HttpCompressionSettingsSpec(Build build) { | ||
| gzipOptions = build.gzipOptions; | ||
| deflateOptions = build.gzipOptions; | ||
| snappyOptions = StandardCompressionOptions.snappy(); | ||
|
|
||
| if (Brotli.isAvailable()) { | ||
| brotliOptions = StandardCompressionOptions.brotli(); | ||
| } | ||
|
|
||
| if (Zstd.isAvailable() && build.zstdOptions != null) { | ||
| zstdOptions = build.zstdOptions; | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. Initializes to each compression setting entered by the Builder. |
||
|
|
||
| /** | ||
| * Creates a builder for {@link HttpCompressionSettingsSpec}. | ||
| * | ||
| * @return a new {@link HttpCompressionSettingsSpec.Builder} | ||
| */ | ||
| public static Builder builder() { | ||
| return new Build(); | ||
| } | ||
|
|
||
| static HttpCompressionSettingsSpec provideDefault() { | ||
| return new HttpCompressionSettingsSpec(); | ||
| } | ||
|
|
||
| CompressionOptions[] adaptToOptions() { | ||
| List<CompressionOptions> options = new ArrayList<>(); | ||
| options.add(this.gzipOptions); | ||
| options.add(this.deflateOptions); | ||
| options.add(this.snappyOptions); | ||
|
|
||
| if (brotliOptions != null) { | ||
| options.add(this.brotliOptions); | ||
| } | ||
|
|
||
| if (zstdOptions != null) { | ||
| options.add(this.zstdOptions); | ||
| } | ||
|
|
||
| return options.toArray(new CompressionOptions[0]); | ||
| } | ||
|
There was a problem hiding this comment. Adapts to the type to be provided to the constructor argument of Netty's |
||
|
|
||
| public interface Builder { | ||
|
|
||
| /** | ||
| * Build a new {@link HttpCompressionSettingsSpec}. | ||
| * | ||
| * @return a new {@link HttpCompressionSettingsSpec} | ||
| */ | ||
| HttpCompressionSettingsSpec build(); | ||
|
|
||
| /** | ||
| * Sets the gzip compression level. | ||
| * | ||
| * @return a new {@link HttpCompressionSettingsSpec.Builder} | ||
| */ | ||
| Builder gzip(int compressionLevel); | ||
|
There was a problem hiding this comment. @raccoonback If in the future you need to extend the configuration API with There was a problem hiding this comment. @violetagg The reason why For now, we’ve chosen to rely on default values without exposing these settings directly to users. However, we’ve considered the need for extensibility in future requirements. If it becomes necessary to make Builder gzip(int compressionLevel);
Builder gzip(int compressionLevel, int windowBits);
Builder gzip(int compressionLevel, int windowBits, int memoryLevel);
// ...Additionally, if required, we can extend the API to provide these as optional settings while maintaining the default values. Let me know your thoughts, and I’ll adjust the design accordingly. There was a problem hiding this comment. Mmm ... method overloading is not something that I would like to see in the API. Can we use a similar approach to Netty's There was a problem hiding this comment. @violetagg |
||
|
|
||
| /** | ||
| * Sets the deflate compression level. | ||
| * | ||
| * @return a new {@link HttpCompressionSettingsSpec.Builder} | ||
| */ | ||
| Builder deflate(int compressionLevel); | ||
|
|
||
| /** | ||
| * Sets the zstd compression level. | ||
| * | ||
| * @return a new {@link HttpCompressionSettingsSpec.Builder} | ||
| */ | ||
| Builder zstd(int compressionLevel); | ||
| } | ||
|
|
||
| private static final class Build implements Builder { | ||
|
|
||
| GzipOptions gzipOptions = StandardCompressionOptions.gzip(); | ||
| DeflateOptions deflateOptions = StandardCompressionOptions.deflate(); | ||
| ZstdOptions zstdOptions; | ||
|
|
||
| private static final int DEFLATE_DEFAULT_WINDOW_BITS = 15; | ||
| private static final int DEFLATE_DEFAULT_MEMORY_LEVEL = 8; | ||
| private static final int ZSTD_DEFAULT_COMPRESSION_LEVEL = 3; | ||
| private static final int ZSTD_DEFAULT_BLOCK_SIZE = 65536; | ||
| private static final int ZSTD_MAX_BLOCK_SIZE = 1 << ZSTD_DEFAULT_COMPRESSION_LEVEL + 7 + 15; | ||
|
|
||
| @Override | ||
| public HttpCompressionSettingsSpec build() { | ||
| return new HttpCompressionSettingsSpec(this); | ||
| } | ||
|
|
||
| @Override | ||
| public Builder gzip(int compressionLevel) { | ||
| ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel"); | ||
|
|
||
| gzipOptions = StandardCompressionOptions.gzip(compressionLevel, DEFLATE_DEFAULT_WINDOW_BITS, DEFLATE_DEFAULT_MEMORY_LEVEL); | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public Builder deflate(int compressionLevel) { | ||
| ObjectUtil.checkInRange(compressionLevel, 0, 9, "compressionLevel"); | ||
|
|
||
| this.deflateOptions = StandardCompressionOptions.deflate(compressionLevel, DEFLATE_DEFAULT_WINDOW_BITS, DEFLATE_DEFAULT_MEMORY_LEVEL); | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public Builder zstd(int compressionLevel) { | ||
| if (!Zstd.isAvailable()) { | ||
| throw new IllegalStateException("Unable to set compression level on zstd."); | ||
| } | ||
| ObjectUtil.checkInRange(compressionLevel, -7, 22, "compressionLevel"); | ||
|
|
||
| this.zstdOptions = StandardCompressionOptions.zstd(compressionLevel, ZSTD_DEFAULT_BLOCK_SIZE, ZSTD_MAX_BLOCK_SIZE); | ||
| return this; | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. A builder that takes each compression setting as input from the user. |
||
| } | ||
|
There was a problem hiding this comment. Defines a spec for configuring HTTP compression. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apply the configured compression settings.