-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for image, binary, varbinary, and varbinary(max)
We now support decoding binary data with fixed, variable, and PLP length strategies. [resolves #3]
- Loading branch information
Showing
7 changed files
with
459 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| /* | ||
| * Copyright 2019 the original author or authors. | ||
| * | ||
| * 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 io.r2dbc.mssql.codec; | ||
|
|
||
| import io.netty.buffer.ByteBuf; | ||
| import io.netty.buffer.ByteBufAllocator; | ||
| import io.r2dbc.mssql.message.tds.Encode; | ||
| import io.r2dbc.mssql.message.type.Length; | ||
| import io.r2dbc.mssql.message.type.LengthStrategy; | ||
| import io.r2dbc.mssql.message.type.PlpLength; | ||
| import io.r2dbc.mssql.message.type.SqlServerType; | ||
| import io.r2dbc.mssql.message.type.TdsDataType; | ||
| import io.r2dbc.mssql.message.type.TypeInformation; | ||
| import io.r2dbc.mssql.message.type.TypeUtils; | ||
| import io.r2dbc.mssql.util.Assert; | ||
| import reactor.util.annotation.Nullable; | ||
|
|
||
| import java.nio.ByteBuffer; | ||
| import java.util.EnumSet; | ||
| import java.util.Set; | ||
|
|
||
| /** | ||
| * Codec for binary values that are represented as {@code byte[]} or {@link ByteBuffer}. | ||
| * | ||
| * <ul> | ||
| * <li>Server types: {@link SqlServerType#BINARY}, {@link SqlServerType#VARBINARY}, {@link SqlServerType#VARBINARYMAX}, and {@link SqlServerType#IMAGE}.</li> | ||
| * <li>Java type: {@code byte[]}, {@link ByteBuffer}</li> | ||
| * <li>Downcast: none</li> | ||
| * </ul> | ||
| * | ||
| * @author Mark Paluch | ||
| */ | ||
| public class BinaryCodec implements Codec<Object> { | ||
|
|
||
| /** | ||
| * Singleton instance. | ||
| */ | ||
| public static final BinaryCodec INSTANCE = new BinaryCodec(); | ||
|
|
||
| private static final Set<SqlServerType> SUPPORTED_TYPES = EnumSet.of(SqlServerType.BINARY, SqlServerType.VARBINARY, | ||
| SqlServerType.VARBINARYMAX, SqlServerType.IMAGE); | ||
|
|
||
| private BinaryCodec() { | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canEncode(Object value) { | ||
|
|
||
| Assert.requireNonNull(value, "Value must not be null"); | ||
|
|
||
| return value instanceof byte[] || value instanceof ByteBuffer; | ||
| } | ||
|
|
||
| @Override | ||
| public Encoded encode(ByteBufAllocator allocator, RpcParameterContext context, Object value) { | ||
|
|
||
| Assert.requireNonNull(allocator, "ByteBufAllocator must not be null"); | ||
| Assert.requireNonNull(context, "RpcParameterContext must not be null"); | ||
| Assert.requireNonNull(value, "Value must not be null"); | ||
|
|
||
| ByteBuf buffer; | ||
|
|
||
| if (value instanceof byte[]) { | ||
|
|
||
| byte[] bytes = (byte[]) value; | ||
| buffer = RpcEncoding.prepareBuffer(allocator, TdsDataType.BIGVARBINARY.getLengthStrategy(), SqlServerType.VARBINARY.getMaxLength(), bytes.length); | ||
| buffer.writeBytes(bytes); | ||
| } else { | ||
|
|
||
| ByteBuffer bytes = (ByteBuffer) value; | ||
| buffer = RpcEncoding.prepareBuffer(allocator, TdsDataType.BIGVARBINARY.getLengthStrategy(), SqlServerType.VARBINARY.getMaxLength(), bytes.remaining()); | ||
| buffer.writeBytes(bytes); | ||
| } | ||
|
|
||
| return new VarbinaryEncoded(TdsDataType.BIGVARBINARY, buffer); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canEncodeNull(Class<?> type) { | ||
|
|
||
| Assert.requireNonNull(type, "Type must not be null"); | ||
|
|
||
| // Accept subtypes of ByteBuffer | ||
| return type.isAssignableFrom(byte[].class) || ByteBuffer.class.isAssignableFrom(type); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| @Override | ||
| public Class<Object> getType() { | ||
| return (Class) byte[].class; | ||
| } | ||
|
|
||
| @Override | ||
| public Encoded encodeNull(ByteBufAllocator allocator) { | ||
|
|
||
| Assert.requireNonNull(allocator, "ByteBufAllocator must not be null"); | ||
|
|
||
| ByteBuf buffer = allocator.buffer(4); | ||
| Encode.uShort(buffer, SqlServerType.VARBINARY.getMaxLength()); | ||
| Encode.uShort(buffer, Length.USHORT_NULL); | ||
|
|
||
| return new VarbinaryEncoded(TdsDataType.BIGVARBINARY, buffer); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canDecode(Decodable decodable, Class<?> type) { | ||
|
|
||
| Assert.requireNonNull(decodable, "Decodable must not be null"); | ||
| Assert.requireNonNull(type, "Type must not be null"); | ||
|
|
||
| return SUPPORTED_TYPES.contains(decodable.getType().getServerType()) && canEncodeNull(type); | ||
| } | ||
|
|
||
| @Nullable | ||
| public Object decode(@Nullable ByteBuf buffer, Decodable decodable, Class<? extends Object> type) { | ||
|
|
||
| Assert.requireNonNull(decodable, "Decodable must not be null"); | ||
| Assert.requireNonNull(type, "Type must not be null"); | ||
|
|
||
| if (buffer == null) { | ||
| return null; | ||
| } | ||
|
|
||
| Length length; | ||
|
|
||
| if (decodable.getType().getLengthStrategy() == LengthStrategy.PARTLENTYPE) { | ||
|
|
||
| PlpLength plpLength = PlpLength.decode(buffer, decodable.getType()); | ||
| length = Length.of(Math.toIntExact(plpLength.getLength()), plpLength.isNull()); | ||
| } else { | ||
| length = Length.decode(buffer, decodable.getType()); | ||
| } | ||
|
|
||
| if (length.isNull()) { | ||
| return null; | ||
| } | ||
|
|
||
| return doDecode(buffer, length, decodable.getType(), type); | ||
| } | ||
|
|
||
| Object doDecode(ByteBuf buffer, Length length, TypeInformation type, Class<? extends Object> valueType) { | ||
|
|
||
| if (valueType.isAssignableFrom(byte[].class)) { | ||
|
|
||
| byte[] bytes = new byte[length.getLength()]; | ||
| buffer.readBytes(bytes); | ||
| return bytes; | ||
| } | ||
|
|
||
| ByteBuffer bytes = ByteBuffer.allocate(length.getLength()); | ||
| buffer.readBytes(bytes); | ||
| bytes.flip(); | ||
| return bytes; | ||
| } | ||
|
|
||
| static class VarbinaryEncoded extends RpcEncoding.HintedEncoded { | ||
|
|
||
| private static final String FORMAL_TYPE = SqlServerType.VARBINARY + "(" + TypeUtils.SHORT_VARTYPE_MAX_BYTES + ")"; | ||
|
|
||
| VarbinaryEncoded(TdsDataType dataType, ByteBuf value) { | ||
| super(dataType, SqlServerType.VARBINARY, value); | ||
| } | ||
|
|
||
| @Override | ||
| public String getFormalType() { | ||
| return FORMAL_TYPE; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.